chore: types cleanup (#82)

* chore: cleanup types

* chore: more types cleanup

* chore: fix tests

Author: maxakuru

src/index.js

@@ -15,7 +15,7 @@ import { resolveConfig } from './utils/config.js';
 import handlers from './routes/index.js';
 
 /**
- * @param {import("@cloudflare/workers-types/experimental").Request} req
+ * @param {import("@cloudflare/workers-types").Request} req
  */
 async function parseData(req) {
   if (['GET', 'HEAD', 'OPTIONS'].includes(req.method)) {
@@ -41,7 +41,7 @@ async function parseData(req) {
 
 /**
  * @param {import("@cloudflare/workers-types/experimental").ExecutionContext} eCtx
- * @param {import("@cloudflare/workers-types/experimental").Request} req
+ * @param {import("@cloudflare/workers-types").Request} req
  * @param {Env} env
  * @returns {Promise<Context>}
  */
@@ -72,7 +72,7 @@ export async function makeContext(eCtx, req, env) {
 
 export default {
   /**
-   * @param {import("@cloudflare/workers-types/experimental").Request} request
+   * @param {import("@cloudflare/workers-types").Request} request
    * @param {Env} env
    * @param {import("@cloudflare/workers-types/experimental").ExecutionContext} eCtx
    * @returns {Promise<Response>}

src/routes/auth/fetch.js

@@ -14,7 +14,7 @@ import { assertAuthorization } from '../../utils/auth.js';
 import { errorResponse } from '../../utils/http.js';
 
 /**
- * @param {Context} ctx
+ * @type {RouteHandler}
  */
 export default async function fetch(ctx) {
   const { config } = ctx;

src/routes/auth/handler.js

@@ -16,16 +16,7 @@ import update from './update.js';
 import rotate from './rotate.js';
 
 /**
- * @type {Record<
- *  string,
- *  Record<
- *    string,
- *    (
- *      ctx: Context,
- *      req: import("@cloudflare/workers-types/experimental").Request
- *    ) => Promise<Response>
- *  >
- * >}
+ * @type {Record<string, Record<string, RouteHandler>>}
  */
 const handlers = {
   token: {
@@ -36,9 +27,7 @@ const handlers = {
 };
 
 /**
- * @param {Context} ctx
- * @param {import("@cloudflare/workers-types/experimental").Request} req
- * @returns {Promise<Response>}
+ * @type {RouteHandler}
  */
 export default async function handler(ctx, req) {
   const {

src/routes/auth/rotate.js

@@ -15,7 +15,7 @@ import { errorResponse } from '../../utils/http.js';
 import { updateToken } from './update.js';
 
 /**
- * @param {Context} ctx
+ * @type {RouteHandler}
  */
 export default async function rotate(ctx) {
   const { data } = ctx;

src/routes/auth/update.js

@@ -33,7 +33,7 @@ export async function updateToken(ctx, token = generateToken()) {
 }
 
 /**
- * @param {Context} ctx
+ * @type {RouteHandler}
  */
 export default async function update(ctx) {
   const { data } = ctx;

src/routes/catalog/StorageClient.js

@@ -115,7 +115,7 @@ export default class StorageClient {
         }
 
         // Attempt to save the product
-        const putResponse = await env.CATALOG_BUCKET.put(key, body, {
+        await env.CATALOG_BUCKET.put(key, body, {
           httpMetadata: { contentType: 'application/json' },
           customMetadata,
         });
@@ -136,7 +136,6 @@ export default class StorageClient {
          */
         const result = {
           sku,
-          status: putResponse.status,
           message: 'Product saved successfully.',
           ...adminResponse.paths,
         };
@@ -203,7 +202,7 @@ export default class StorageClient {
           };
         }
         const { customMetadata } = productHead;
-        const deleteProductResponse = await env.CATALOG_BUCKET.delete(productKey);
+        await env.CATALOG_BUCKET.delete(productKey);
 
         const { urlKey } = customMetadata;
         if (urlKey) {
@@ -217,7 +216,6 @@ export default class StorageClient {
          */
         const result = {
           sku,
-          status: deleteProductResponse?.status,
           message: 'Product deleted successfully.',
           ...adminResponse.paths,
         };

src/routes/catalog/fetch.js

@@ -13,9 +13,7 @@
 import StorageClient from './StorageClient.js';
 
 /**
- * Handles a GET request for a product.
- * @param {Context} ctx - The context object containing request information and utilities.
- * @returns {Promise<Response>} - A promise that resolves to the product response.
+ * @type {RouteHandler}
  */
 export default async function fetch(ctx) {
   const { sku } = ctx.config;

src/routes/catalog/handler.js

@@ -17,17 +17,7 @@ import update from './update.js';
 import remove from './remove.js';
 
 /**
- * @type {Record<
- *    string,
- *    Record<
- *      string,
- *      (
- *        ctx: Context,
- *        req: import("@cloudflare/workers-types/experimental").Request
- *      ) => Promise<Response>
- *    >
- *  >
- * }
+ * @type {Record<string, Record<string, RouteHandler>>}
  */
 const handlers = {
   lookup: {
@@ -47,10 +37,7 @@ const handlers = {
 };
 
 /**
- * Handles productbus requests.
- * @param {Context} ctx - The context object containing request information and utilities.
- * @param {import("@cloudflare/workers-types/experimental").Request} request - The request object.
- * @returns {Promise<Response>} - A promise that resolves to the catalog response.
+ * @type {RouteHandler}
  */
 export default async function handler(ctx, request) {
   const {

src/routes/catalog/lookup.js

@@ -13,9 +13,7 @@
 import StorageClient from './StorageClient.js';
 
 /**
- * Handles a product lookup request.
- * @param {Context} ctx - The context object.
- * @returns {Promise<Response>} - A promise that resolves to the product response.
+ * @type {RouteHandler}
  */
 export default async function lookup(ctx) {
   const {

src/routes/catalog/remove.js

@@ -15,9 +15,7 @@ import { errorResponse, errorWithResponse } from '../../utils/http.js';
 import StorageClient from './StorageClient.js';
 
 /**
- * Handles a DELETE request for a product.
- * @param {Context} ctx - The context object containing request information and utilities.
- * @returns {Promise<Response>} - A promise that resolves to the product response.
+ * @type {RouteHandler}
  */
 export default async function remove(ctx) {
   const { log, config } = ctx;

src/routes/catalog/update.js

@@ -15,10 +15,9 @@ import { errorResponse } from '../../utils/http.js';
 import StorageClient from './StorageClient.js';
 import { assertAuthorization } from '../../utils/auth.js';
 import { extractAndReplaceImages } from '../../utils/media.js';
+
 /**
- * Handles a PUT request to update a product.
- * @param {Context} ctx - The context object containing request information and utilities.
- * @returns {Promise<Response>} - A promise that resolves to the product response.
+ * @type {RouteHandler}
  */
 export default async function update(ctx) {
   const { config, log, data } = ctx;

src/routes/config/handler.js

@@ -17,8 +17,7 @@ import { updateToken } from '../auth/update.js';
 import ConfigSchema from '../../schemas/Config.js';
 
 /**
- * @param {Context} ctx
- * @returns {Promise<Response>}
+ * @type {RouteHandler}
  */
 export default async function configHandler(ctx) {
   const { method } = ctx.info;

src/routes/content/adobe-commerce/index.js

@@ -212,8 +212,7 @@ function lookupProductSKU(urlkey, config) {
 }
 
 /**
- * @param {Context} ctx
- * @returns {Promise<Response>}
+ * @type {RouteHandler}
  */
 export default async function handler(ctx) {
   const { config } = ctx;

src/routes/content/adobe-commerce/queries/cs-product.js

@@ -18,6 +18,10 @@ import {
   forceImagesHTTPS,
 } from '../util.js';
 
+/**
+ * @typedef {import('../types.d.ts').Product} Product
+ */
+
 function extractMinMaxPrice(data) {
   let minPrice = data.priceRange?.minimum ?? data.price;
   let maxPrice = data.priceRange?.maximum ?? data.price;

src/routes/content/adobe-commerce/queries/cs-variants.js

@@ -18,6 +18,8 @@ import {
   forceImagesHTTPS,
 } from '../util.js';
 
+/**
+ * @typedef {import('../types.d.ts').Variant} Variant
 /**
  * @param {Config} config
  * @param {any} variants

src/routes/content/adobe-commerce/templates/html/HTMLTemplate.js

@@ -15,6 +15,16 @@
 import { findProductImage } from '../../util.js';
 import jsonTemplateFromContext from '../json/index.js';
 
+/**
+ * @typedef {import('../../types.d.ts').Product} Product
+ * @typedef {import('../../types.d.ts').Variant} Variant
+ * @typedef {import('../../types.d.ts').Image} Image
+ * @typedef {import('../../types.d.ts').Attribute} Attribute
+ * @typedef {import('../../types.d.ts').OptionValue} OptionValue
+ * @typedef {import('../../types.d.ts').Prices} Prices
+ * @typedef {import('../../types.d.ts').ProductOption} ProductOption
+ */
+
 export class HTMLTemplate {
   /**
    * Create a meta tag with a name attribute

src/routes/content/adobe-commerce/templates/html/index.js

@@ -13,6 +13,11 @@
 import { HTMLTemplate } from './HTMLTemplate.js';
 import OVERRIDES from './overrides/index.js';
 
+/**
+ * @typedef {import('../../types.d.ts').Product} Product
+ * @typedef {import('../../types.d.ts').Variant} Variant
+ */
+
 /**
  * @param {Context} ctx
  * @param {Product} product

src/routes/content/adobe-commerce/templates/html/overrides/wilson-ecommerce--wilson.js

@@ -12,6 +12,11 @@
 
 import { HTMLTemplate } from '../HTMLTemplate.js';
 
+/**
+ * @typedef {import('../../../types.d.ts').Product} Product
+ * @typedef {import('../../../types.d.ts').Variant} Variant
+ */
+
 export default class extends HTMLTemplate {
   /**
    * @param {Context} ctx

src/routes/content/adobe-commerce/templates/json/JSONTemplate.js

@@ -15,6 +15,11 @@
 import { pruneUndefined } from '../../../../../utils/product.js';
 import { findProductImage } from '../../util.js';
 
+/**
+ * @typedef {import('../../types.d.ts').Product} Product
+ * @typedef {import('../../types.d.ts').Variant} Variant
+ */
+
 export class JSONTemplate {
   /** @type {Context} */
   ctx = undefined;

src/routes/content/adobe-commerce/templates/json/index.js

@@ -13,6 +13,11 @@
 import { JSONTemplate } from './JSONTemplate.js';
 import OVERRIDES from './overrides/index.js';
 
+/**
+ * @typedef {import('../../types.d.ts').Product} Product
+ * @typedef {import('../../types.d.ts').Variant} Variant
+ */
+
 /**
  * @param {Context} ctx
  * @param {Product} product

src/routes/content/adobe-commerce/templates/json/overrides/thepixel--bul-eds.js

@@ -12,6 +12,11 @@
 
 import { JSONTemplate } from '../JSONTemplate.js';
 
+/**
+ * @typedef {import('../../../types.d.ts').Product} Product
+ * @typedef {import('../../../types.d.ts').Variant} Variant
+ */
+
 export default class extends JSONTemplate {
   /**
    * @param {Variant} [variant]

src/routes/content/adobe-commerce/templates/json/overrides/visualcomfort--adobe-edge.js

@@ -12,6 +12,11 @@
 
 import { JSONTemplate } from '../JSONTemplate.js';
 
+/**
+ * @typedef {import('../../../types.d.ts').Product} Product
+ * @typedef {import('../../../types.d.ts').Variant} Variant
+ */
+
 export default class extends JSONTemplate {
   // eslint-disable-next-line class-methods-use-this
   renderBrand() {

src/routes/content/adobe-commerce/templates/json/overrides/wilson-ecommerce--wilson.js

@@ -12,6 +12,11 @@
 
 import { JSONTemplate } from '../JSONTemplate.js';
 
+/**
+ * @typedef {import('../../../types.d.ts').Product} Product
+ * @typedef {import('../../../types.d.ts').Variant} Variant
+ */
+
 export default class extends JSONTemplate {
   // eslint-disable-next-line class-methods-use-this
   renderBrand() {