cloudcommerce 0.0.23 → 0.0.26

package/packages/api/lib/types/products.d.ts

@@ -10,6 +10,9 @@ export interface Products {
   created_at: string;
   updated_at: string;
   store_id: number;
+  /**
+   * @maxItems 10
+   */
   channel_ids?: string[];
   /**
    * Product unique reference code
@@ -102,6 +105,8 @@ export interface Products {
   };
   /**
    * Tags related with product for internal search
+   *
+   * @maxItems 200
    */
   keywords?: string[];
   /**
@@ -268,6 +273,8 @@ export interface Products {
   warranty?: string;
   /**
    * List of product brands
+   *
+   * @maxItems 100
    */
   brands?: {
     /**
@@ -319,6 +326,8 @@ export interface Products {
   }[];
   /**
    * List of product categories
+   *
+   * @maxItems 100
    */
   categories?: {
     /**
@@ -407,6 +416,8 @@ export interface Products {
   google_product_category_id?: number;
   /**
    * Grids for specifications and variations
+   *
+   * @maxItems 200
    */
   grids?: {
     /**
@@ -445,6 +456,8 @@ export interface Products {
   specifications?: {
     /**
      * Attribute to tell users the energy efficiency class of your product
+     *
+     * @maxItems 1
      */
     energy_efficiency_class?: {
       /**
@@ -476,6 +489,8 @@ export interface Products {
     }[];
     /**
      * Attribute to set the demographic that your product is designed for
+     *
+     * @maxItems 1
      */
     age_group?: {
       /**
@@ -507,6 +522,8 @@ export interface Products {
     }[];
     /**
      * Specify for what gender your product is designed
+     *
+     * @maxItems 1
      */
     gender?: {
       /**
@@ -538,6 +555,8 @@ export interface Products {
     }[];
     /**
      * Attribute to describe the main fabric or material that your product is made of
+     *
+     * @maxItems 1
      */
     material?: {
       /**
@@ -569,6 +588,8 @@ export interface Products {
     }[];
     /**
      * Attribute to describe the pattern or graphic printed on your product
+     *
+     * @maxItems 1
      */
     pattern?: {
       /**
@@ -600,6 +621,8 @@ export interface Products {
     }[];
     /**
      * Attribute to describe the standardized size of your product
+     *
+     * @maxItems 1
      */
     size?: {
       /**
@@ -631,6 +654,8 @@ export interface Products {
     }[];
     /**
      * Attribute to describe the cut of your product
+     *
+     * @maxItems 1
      */
     size_type?: {
       /**
@@ -662,6 +687,8 @@ export interface Products {
     }[];
     /**
      * Which country's sizing system your product uses
+     *
+     * @maxItems 1
      */
     size_system?: {
       /**
@@ -724,6 +751,9 @@ export interface Products {
     /**
      * Custom product attributes, grid as property name (such as 'Model' and 'Voltage')
      *
+     * @minItems 1
+     * @maxItems 30
+     *
      * This interface was referenced by `undefined`'s JSON-Schema definition
      * via the `patternProperty` "^.{2,70}$".
      */
@@ -769,6 +799,8 @@ export interface Products {
   };
   /**
    * List of product images
+   *
+   * @maxItems 50
    */
   pictures?: (
     | {
@@ -783,6 +815,8 @@ export interface Products {
   )[];
   /**
    * List of videos related to your product
+   *
+   * @maxItems 30
    */
   videos?: {
     /**
@@ -796,6 +830,8 @@ export interface Products {
   }[];
   /**
    * List of product customization fields
+   *
+   * @maxItems 100
    */
   customizations?: (
     | {
@@ -807,6 +843,8 @@ export interface Products {
   )[];
   /**
    * Product variations list
+   *
+   * @maxItems 3000
    */
   variations?: {
     /**
@@ -848,6 +886,8 @@ export interface Products {
     mpn?: string;
     /**
      * List of product NCM codes
+     *
+     * @maxItems 10
      */
     ncm?: string[];
     /**
@@ -943,6 +983,8 @@ export interface Products {
     specifications: {
       /**
        * Attribute to describe the main fabric or material that your product is made of
+       *
+       * @maxItems 1
        */
       material?: {
         /**
@@ -974,6 +1016,8 @@ export interface Products {
       }[];
       /**
        * Attribute to describe the pattern or graphic printed on your product
+       *
+       * @maxItems 1
        */
       pattern?: {
         /**
@@ -1005,6 +1049,8 @@ export interface Products {
       }[];
       /**
        * Attribute to describe the standardized size of your product
+       *
+       * @maxItems 1
        */
       size?: {
         /**
@@ -1067,6 +1113,9 @@ export interface Products {
       /**
        * Custom variation attributes, grid as property name (such as 'Model' and 'Voltage')
        *
+       * @minItems 1
+       * @maxItems 6
+       *
        * This interface was referenced by `undefined`'s JSON-Schema definition
        * via the `patternProperty` "^.{2,70}$".
        */
@@ -1116,11 +1165,15 @@ export interface Products {
     picture_id?: string;
     /**
      * Flags to associate additional info
+     *
+     * @maxItems 10
      */
     flags?: string[];
   }[];
   /**
    * If this product is a kit, set its composition
+   *
+   * @maxItems 100
    */
   kit_composition?: {
     /**
@@ -1167,6 +1220,8 @@ export interface Products {
   parent_item_id?: string;
   /**
    * Lists of related products
+   *
+   * @maxItems 30
    */
   related_products?: {
     /**
@@ -1179,6 +1234,8 @@ export interface Products {
     relation_type?: 'common_characteristics' | 'common_orders' | 'manual' | 'other';
     /**
      * List of products
+     *
+     * @maxItems 100
      */
     product_ids: string[];
     /**
@@ -1204,14 +1261,20 @@ export interface Products {
   total_sold?: number;
   /**
    * List of product GTIN codes
+   *
+   * @maxItems 10
    */
   gtin?: string[];
   /**
    * List of product MPN codes
+   *
+   * @maxItems 10
    */
   mpn?: string[];
   /**
    * List of product NCM codes
+   *
+   * @maxItems 10
    */
   ncm?: string[];
   /**
@@ -1237,6 +1300,8 @@ export interface Products {
   };
   /**
    * List of custom attributes
+   *
+   * @maxItems 100
    */
   metafields?: {
     /**
@@ -1256,6 +1321,8 @@ export interface Products {
   }[];
   /**
    * List of custom attributes
+   *
+   * @maxItems 100
    */
   hidden_metafields?: {
     /**
@@ -1275,6 +1342,8 @@ export interface Products {
   }[];
   /**
    * Flags to associate additional info
+   *
+   * @maxItems 10
    */
   flags?: string[];
   /**

package/packages/api/lib/types/stores.d.ts

@@ -112,6 +112,9 @@ export interface Stores {
    * Secondary public contact phone, commonly a cell phone number
    */
   contact_cellphone?: string;
+  /**
+   * @maxItems 30
+   */
   sales_channels?: {
     channel_id: string;
     type?: 'ecommerce' | 'mobile' | 'pos' | 'button' | 'social' | 'chatbot' | 'live';

package/packages/api/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@cloudcommerce/api",
   "type": "module",
-  "version": "0.0.23",
+  "version": "0.0.26",
   "description": "E-Com Plus Cloud Commerce APIs client/adapter",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

package/packages/api/src/types/applications.d.ts

@@ -46,97 +46,13 @@ export interface Applications {
    * Modules handled by this app
    */
   modules?: {
-    /**
-     * Triggered after each term searched on storefront
-     */
-    term_searched?: {
-      /**
-       * Whether current app is enabled to handle the module requests
-       */
-      enabled: boolean;
-      /**
-       * URL to receive POST request of respective module
-       */
-      endpoint: string;
-    };
-    /**
-     * Triggered after each cart saves on storefront, just before checkout
-     */
-    cart_confirmed?: {
-      /**
-       * Whether current app is enabled to handle the module requests
-       */
-      enabled: boolean;
-      /**
-       * URL to receive POST request of respective module
-       */
-      endpoint: string;
-    };
-    /**
-     * Triggered to calculate shipping options, must return calculated values and times
-     */
-    calculate_shipping?: {
-      /**
-       * Whether current app is enabled to handle the module requests
-       */
-      enabled: boolean;
-      /**
-       * URL to receive POST request of respective module
-       */
-      endpoint: string;
-    };
-    /**
-     * Triggered when listing payments, must return available methods
-     */
-    list_payments?: {
-      /**
-       * Whether current app is enabled to handle the module requests
-       */
-      enabled: boolean;
-      /**
-       * URL to receive POST request of respective module
-       */
-      endpoint: string;
-    };
-    /**
-     * Triggered to validate and apply discout value, must return discount and conditions
-     */
-    apply_discount?: {
-      /**
-       * Whether current app is enabled to handle the module requests
-       */
-      enabled: boolean;
-      /**
-       * URL to receive POST request of respective module
-       */
-      endpoint: string;
-    };
-    /**
-     * Triggered when order is being closed, must create payment transaction and return info
-     */
-    create_transaction?: {
-      /**
-       * Whether current app is enabled to handle the module requests
-       */
-      enabled: boolean;
-      /**
-       * URL to receive POST request of respective module
-       */
-      endpoint: string;
-    };
-    /**
-     * Triggered after each order created from storefront, could return custom fields
-     */
-    checkout_done?: {
-      /**
-       * Whether current app is enabled to handle the module requests
-       */
-      enabled: boolean;
-      /**
-       * URL to receive POST request of respective module
-       */
-      endpoint: string;
-    };
+    term_searched?: Module;
+    cart_confirmed?: Module1;
+    calculate_shipping?: Module2;
+    list_payments?: Module3;
+    apply_discount?: Module4;
+    create_transaction?: Module5;
+    checkout_done?: Module6;
   };
   /**
    * Configuration options for staff on admin dashboard, saved on app data
@@ -199,6 +115,8 @@ export interface Applications {
   };
   /**
    * Flags to associate additional info
+   *
+   * @maxItems 10
    */
   flags?: string[];
   /**
@@ -206,3 +124,94 @@ export interface Applications {
    */
   notes?: string;
 }
+/**
+ * Triggered after each term searched on storefront
+ */
+export interface Module {
+  /**
+   * Whether current app is enabled to handle the module requests
+   */
+  enabled: boolean;
+  /**
+   * URL to receive POST request of respective module
+   */
+  endpoint: string;
+}
+/**
+ * Triggered after each cart saves on storefront, just before checkout
+ */
+export interface Module1 {
+  /**
+   * Whether current app is enabled to handle the module requests
+   */
+  enabled: boolean;
+  /**
+   * URL to receive POST request of respective module
+   */
+  endpoint: string;
+}
+/**
+ * Triggered to calculate shipping options, must return calculated values and times
+ */
+export interface Module2 {
+  /**
+   * Whether current app is enabled to handle the module requests
+   */
+  enabled: boolean;
+  /**
+   * URL to receive POST request of respective module
+   */
+  endpoint: string;
+}
+/**
+ * Triggered when listing payments, must return available methods
+ */
+export interface Module3 {
+  /**
+   * Whether current app is enabled to handle the module requests
+   */
+  enabled: boolean;
+  /**
+   * URL to receive POST request of respective module
+   */
+  endpoint: string;
+}
+/**
+ * Triggered to validate and apply discout value, must return discount and conditions
+ */
+export interface Module4 {
+  /**
+   * Whether current app is enabled to handle the module requests
+   */
+  enabled: boolean;
+  /**
+   * URL to receive POST request of respective module
+   */
+  endpoint: string;
+}
+/**
+ * Triggered when order is being closed, must create payment transaction and return info
+ */
+export interface Module5 {
+  /**
+   * Whether current app is enabled to handle the module requests
+   */
+  enabled: boolean;
+  /**
+   * URL to receive POST request of respective module
+   */
+  endpoint: string;
+}
+/**
+ * Triggered after each order created from storefront, could return custom fields
+ */
+export interface Module6 {
+  /**
+   * Whether current app is enabled to handle the module requests
+   */
+  enabled: boolean;
+  /**
+   * URL to receive POST request of respective module
+   */
+  endpoint: string;
+}

package/packages/api/src/types/authentications.d.ts

@@ -9,6 +9,9 @@ export interface Authentications {
   _id: string;
   created_at: string;
   updated_at: string;
+  /**
+   * @maxItems 500
+   */
   store_ids: number[];
   /**
    * Simple username for identification, only numbers and lowercase letters
@@ -52,6 +55,8 @@ export interface Authentications {
   };
   /**
    * List of dashboard cards chosen by user
+   *
+   * @maxItems 40
    */
   panel_cards?: {
     /**
@@ -76,6 +81,9 @@ export interface Authentications {
       resource: 'products' | 'categories' | 'brands' | 'collections' | 'grids' | 'customers' | 'carts' | 'orders';
       /**
        * Aggregation pipeline
+       *
+       * @minItems 1
+       * @maxItems 50
        */
       pipeline: {
         [k: string]: unknown;
@@ -88,6 +96,8 @@ export interface Authentications {
   edit_storefront?: boolean;
   /**
    * Flags to associate additional info
+   *
+   * @maxItems 10
    */
   flags?: string[];
   /**

package/packages/api/src/types/brands.d.ts

@@ -10,6 +10,9 @@ export interface Brands {
   created_at: string;
   updated_at: string;
   store_id: number;
+  /**
+   * @maxItems 10
+   */
   channel_ids?: string[];
   /**
    * Brand full name
@@ -95,6 +98,8 @@ export interface Brands {
   };
   /**
    * List of brand images
+   *
+   * @maxItems 50
    */
   pictures?: {
     /**
@@ -120,6 +125,8 @@ export interface Brands {
   }[];
   /**
    * List of custom attributes
+   *
+   * @maxItems 100
    */
   metafields?: {
     /**
@@ -139,6 +146,8 @@ export interface Brands {
   }[];
   /**
    * Flags to associate additional info
+   *
+   * @maxItems 10
    */
   flags?: string[];
   /**

package/packages/api/src/types/carts.d.ts

@@ -68,6 +68,8 @@ export interface Carts {
   affiliate_code?: string;
   /**
    * List of customers associated with this cart
+   *
+   * @maxItems 3000
    */
   customers?: string[];
   /**
@@ -76,6 +78,8 @@ export interface Carts {
   other_customers?: boolean;
   /**
    * Products composing the cart
+   *
+   * @maxItems 3000
    */
   items: {
     /**
@@ -125,6 +129,8 @@ export interface Carts {
     };
     /**
      * Item customization fields
+     *
+     * @maxItems 100
      */
     customizations?: {
       /**
@@ -184,6 +190,8 @@ export interface Carts {
       price?: number;
       /**
        * Current kit composition
+       *
+       * @maxItems 100
        */
       composition?: {
         /**
@@ -251,6 +259,8 @@ export interface Carts {
     final_price?: number;
     /**
      * Flags to associate additional info
+     *
+     * @maxItems 10
      */
     flags?: string[];
   }[];
@@ -260,10 +270,14 @@ export interface Carts {
   subtotal?: number;
   /**
    * List of orders completed with this cart
+   *
+   * @maxItems 3000
    */
   orders?: string[];
   /**
    * List of custom attributes
+   *
+   * @maxItems 100
    */
   metafields?: {
     /**
@@ -283,6 +297,8 @@ export interface Carts {
   }[];
   /**
    * Flags to associate additional info
+   *
+   * @maxItems 10
    */
   flags?: string[];
   /**

package/packages/api/src/types/categories.d.ts

@@ -10,6 +10,9 @@ export interface Categories {
   created_at: string;
   updated_at: string;
   store_id: number;
+  /**
+   * @maxItems 10
+   */
   channel_ids?: string[];
   /**
    * Category full name
@@ -129,6 +132,8 @@ export interface Categories {
   };
   /**
    * List of category images
+   *
+   * @maxItems 50
    */
   pictures?: {
     /**
@@ -162,6 +167,8 @@ export interface Categories {
   google_product_category_id?: number;
   /**
    * List of custom attributes
+   *
+   * @maxItems 100
    */
   metafields?: {
     /**
@@ -181,6 +188,8 @@ export interface Categories {
   }[];
   /**
    * Flags to associate additional info
+   *
+   * @maxItems 10
    */
   flags?: string[];
   /**

package/packages/api/src/types/collections.d.ts

@@ -77,6 +77,8 @@ export interface Collections {
   };
   /**
    * List of collection products
+   *
+   * @maxItems 3000
    */
   products?: string[];
   /**
@@ -98,6 +100,8 @@ export interface Collections {
   };
   /**
    * List of collection images
+   *
+   * @maxItems 50
    */
   pictures?: {
     /**
@@ -123,6 +127,8 @@ export interface Collections {
   }[];
   /**
    * List of custom attributes
+   *
+   * @maxItems 100
    */
   metafields?: {
     /**
@@ -142,6 +148,8 @@ export interface Collections {
   }[];
   /**
    * Flags to associate additional info
+   *
+   * @maxItems 10
    */
   flags?: string[];
   /**