chore: more types cleanup

Author: maxakuru

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() {

src/routes/content/adobe-commerce/types.d.ts

@@ -0,0 +1,125 @@
+export interface Product {
+    name: string;
+    sku: string;
+    addToCartAllowed: boolean;
+    inStock: boolean | null;
+    shortDescription?: string;
+    metaDescription?: string;
+    metaKeyword?: string;
+    metaTitle?: string;
+    description?: string;
+    images: Image[];
+    prices: Prices;
+    attributes: Attribute[];
+    options: ProductOption[];
+    url?: string;
+    urlKey?: string;
+    externalId?: string;
+    variants?: Variant[]; // variants exist on products in helix commerce but not on magento
+    specialToDate?: string;
+    rating?: Rating;
+    links?: Link[];
+
+    // Coming only from Catalog Service at the time of writing:
+    lastModifiedAt?: string;
+
+    // not handled currently:
+    externalParentId?: string;
+    variantSku?: string;
+    optionUIDs?: string[];
+
+    // internal use:
+    attributeMap: Record<string, string>;
+}
+
+export interface Variant {
+    sku: string;
+    name: string;
+    description?: string;
+    url: string;
+    inStock: boolean;
+    images: Image[];
+    prices: Pick<Prices, 'regular' | 'final'>;
+    selections: string[];
+    attributes: Attribute[];
+    externalId: string;
+    specialToDate?: string;
+    gtin?: string;
+    rating?: Rating;
+
+    // internal use:
+    attributeMap: Record<string, string>;
+}
+
+interface Rating {
+    // number of ratings
+    count?: number;
+    // number of reviews
+    reviews?: number;
+    // rating value
+    value: number | string;
+    // range of ratings, highest
+    best?: number | string;
+    // range of ratings, lowest
+    worst?: number | string;
+}
+
+interface Link {
+    types: string[];
+    sku: string;
+    urlKey: string;
+    prices: Prices;
+}
+
+interface Image {
+    url: string;
+    label: string;
+    roles: string[];
+}
+
+interface Price {
+    amount?: number;
+    currency?: string;
+    maximumAmount?: number;
+    minimumAmount?: number;
+    variant?: 'default' | 'strikethrough';
+}
+
+interface Prices {
+    regular: Price;
+    final: Price;
+    visible: boolean;
+}
+
+export interface ProductOption {
+    id: string;
+    type: 'text' | 'image' | 'color' | 'dropdown';
+    typename:
+    | 'ProductViewOptionValueProduct'
+    | 'ProductViewOptionValueSwatch'
+    | 'ProductViewOptionValueConfiguration';
+    label: string;
+    required: boolean;
+    multiple: boolean;
+    items: OptionValue[];
+}
+
+interface OptionValue {
+    id: string;
+    label: string;
+    inStock: boolean;
+    value: string;
+    selected: boolean;
+    type: string;
+    product?: {
+        name: string;
+        sku: string;
+        prices?: Prices;
+    };
+}
+
+interface Attribute {
+    name: string;
+    label: string;
+    value: string;
+}

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

@@ -12,6 +12,12 @@
 
 import { pruneUndefined } from '../../../utils/product.js';
 
+/**
+ * @typedef {import('./types.d.ts').Product} Product
+ * @typedef {import('./types.d.ts').Variant} Variant
+ * @typedef {import('./types.d.ts').Rating} Rating
+ */
+
 /**
  * This function combines an array of strings with interpolated
  * parameters to create a GraphQL query string.

src/types.d.ts

@@ -272,132 +272,6 @@ declare global {
     executionContext: ExecutionContext;
   }
 
-  export interface Product {
-    name: string;
-    sku: string;
-    addToCartAllowed: boolean;
-    inStock: boolean | null;
-    shortDescription?: string;
-    metaDescription?: string;
-    metaKeyword?: string;
-    metaTitle?: string;
-    description?: string;
-    images: Image[];
-    prices: Prices;
-    attributes: Attribute[];
-    options: ProductOption[];
-    url?: string;
-    urlKey?: string;
-    externalId?: string;
-    variants?: Variant[]; // variants exist on products in helix commerce but not on magento
-    specialToDate?: string;
-    rating?: Rating;
-    links?: Link[];
-
-    // Coming only from Catalog Service at the time of writing:
-    lastModifiedAt?: string;
-
-    // not handled currently:
-    externalParentId?: string;
-    variantSku?: string;
-    optionUIDs?: string[];
-
-    // internal use:
-    attributeMap: Record<string, string>;
-  }
-
-  export interface Variant {
-    sku: string;
-    name: string;
-    description?: string;
-    url: string;
-    inStock: boolean;
-    images: Image[];
-    prices: Pick<Prices, 'regular' | 'final'>;
-    selections: string[];
-    attributes: Attribute[];
-    externalId: string;
-    specialToDate?: string;
-    gtin?: string;
-    rating?: Rating;
-
-    // internal use:
-    attributeMap: Record<string, string>;
-  }
-
-  interface Rating {
-    // number of ratings
-    count?: number;
-    // number of reviews
-    reviews?: number;
-    // rating value
-    value: number | string;
-    // range of ratings, highest
-    best?: number | string;
-    // range of ratings, lowest
-    worst?: number | string;
-  }
-
-  interface Link {
-    types: string[];
-    sku: string;
-    urlKey: string;
-    prices: Prices;
-  }
-
-  interface Image {
-    url: string;
-    label: string;
-    roles: string[];
-  }
-
-  interface Price {
-    amount?: number;
-    currency?: string;
-    maximumAmount?: number;
-    minimumAmount?: number;
-    variant?: 'default' | 'strikethrough';
-  }
-
-  interface Prices {
-    regular: Price;
-    final: Price;
-    visible: boolean;
-  }
-
-  export interface ProductOption {
-    id: string;
-    type: 'text' | 'image' | 'color' | 'dropdown';
-    typename:
-    | 'ProductViewOptionValueProduct'
-    | 'ProductViewOptionValueSwatch'
-    | 'ProductViewOptionValueConfiguration';
-    label: string;
-    required: boolean;
-    multiple: boolean;
-    items: OptionValue[];
-  }
-
-  interface OptionValue {
-    id: string;
-    label: string;
-    inStock: boolean;
-    value: string;
-    selected: boolean;
-    type: string;
-    product?: {
-      name: string;
-      sku: string;
-      prices?: Prices;
-    };
-  }
-
-  interface Attribute {
-    name: string;
-    label: string;
-    value: string;
-  }
-
   interface BatchResult {
     sku: string;
     status: number;