@cloudcommerce/api 0.14.0 → 0.15.0

package/{lib/types → types}/orders.d.ts

@@ -339,7 +339,7 @@ export interface Orders {
     /**
      * Shipping line ID (ObjectID) [auto]
      */
-    _id?: string;
+    _id?: string & { length: 24 };
     from: Address;
     to: Address1;
     /**
@@ -388,7 +388,7 @@ export interface Orders {
       /**
        * Application ID (ObjectID)
        */
-      _id?: string;
+      _id?: string & { length: 24 };
       /**
        * Name of shipping method shown to customers
        */
@@ -688,7 +688,7 @@ export interface Orders {
     /**
      * Transaction ID (ObjectID) [auto]
      */
-    _id?: string;
+    _id?: string & { length: 24 };
     /**
      * Date and time of transaction creation, in ISO 8601 standard representation [auto]
      */
@@ -789,7 +789,7 @@ export interface Orders {
       /**
        * Application ID (ObjectID)
        */
-      _id?: string;
+      _id?: string & { length: 24 };
       /**
        * Name of payment method shown to customers
        */
@@ -1062,7 +1062,7 @@ export interface Orders {
     /**
      * Payment status ID (ObjectID) [auto]
      */
-    _id?: string;
+    _id?: string & { length: 24 };
     /**
      * ID of transaction related with this event
      */
@@ -1108,11 +1108,11 @@ export interface Orders {
     /**
      * Fulfillment status ID (ObjectID) [auto]
      */
-    _id?: string;
+    _id?: string & { length: 24 };
     /**
      * ID of shipping line related with this event
      */
-    shipping_line_id?: string;
+    shipping_line_id?: string & { length: 24 };
     /**
      * Date and time of the event, in ISO 8601 standard representation [auto]
      */
@@ -1154,15 +1154,15 @@ export interface Orders {
     /**
      * Order item ID (ObjectID) [auto]
      */
-    _id?: string;
+    _id?: string & { length: 24 };
     /**
      * Product ID
      */
-    product_id: string;
+    product_id: string & { length: 24 };
     /**
      * ID to specify the variation added to cart, if product has variations
      */
-    variation_id?: string;
+    variation_id?: string & { length: 24 };
     /**
      * Product or variation unique reference code
      */
@@ -1197,7 +1197,7 @@ export interface Orders {
         /**
          * Option ID (ObjectID) if it was predefined (not custom value created by customer)
          */
-        _id?: string;
+        _id?: string & { length: 24 };
         /**
          * Option text value displayed for the client
          */
@@ -1254,7 +1254,7 @@ export interface Orders {
         /**
          * Selected variation ID (ObjectID) if any
          */
-        variation_id?: string;
+        variation_id?: string & { length: 24 };
         /**
          * Kit item quantity
          */
@@ -1320,7 +1320,7 @@ export interface Orders {
       /**
        * Application ID (ObjectID)
        */
-      _id?: string;
+      _id?: string & { length: 24 };
       /**
        * Name of the discount rule, can be the coupon or campaign name
        */

package/{lib/types → types}/products.d.ts

@@ -280,7 +280,7 @@ export interface Products {
     /**
      * Brand ID (ObjectID)
      */
-    _id?: string;
+    _id?: string & { length: 24 };
     /**
      * Brand name
      */
@@ -333,7 +333,7 @@ export interface Products {
     /**
      * Category ID (ObjectID)
      */
-    _id?: string;
+    _id?: string & { length: 24 };
     /**
      * Category name
      */
@@ -366,7 +366,7 @@ export interface Products {
       /**
        * Parent category ID (ObjectID)
        */
-      _id?: string;
+      _id?: string & { length: 24 };
       /**
        * Parent category name
        */
@@ -423,7 +423,7 @@ export interface Products {
     /**
      * Grid ID (ObjectID)
      */
-    _id?: string;
+    _id?: string & { length: 24 };
     /**
      * Grid title
      */
@@ -806,7 +806,7 @@ export interface Products {
     /**
      * Picture ID (ObjectID) [auto]
      */
-    _id?: string;
+    _id?: string & { length: 24 };
     /**
      * Tag to identify object, use only lowercase letters, digits and underscore
      */
@@ -853,7 +853,7 @@ export interface Products {
     /**
      * Variation ID (ObjectID) [auto]
      */
-    _id?: string;
+    _id?: string & { length: 24 };
     /**
      * Item unique reference code
      */
@@ -1165,7 +1165,7 @@ export interface Products {
     /**
      * ID of one of the preferred product picture for this variation
      */
-    picture_id?: string;
+    picture_id?: string & { length: 24 };
     /**
      * Flags to associate additional info
      *
@@ -1215,12 +1215,12 @@ export interface Products {
     /**
      * Optional variation ID (ObjectID) if `has_variations` is true
      */
-    variation_id?: string;
+    variation_id?: string & { length: 24 };
   }[];
   /**
    * Parent product ID, if this product is contained or represented by another
    */
-  parent_item_id?: string;
+  parent_item_id?: string & { length: 24 };
   /**
    * Lists of related products
    *
@@ -1240,7 +1240,7 @@ export interface Products {
      *
      * @maxItems 100
      */
-    product_ids: string[];
+    product_ids: Array<string & { length: 24 }>;
     /**
      * Tag to identify object, use only lowercase letters, digits and underscore
      */

package/{src/types.ts → types.d.ts}

@@ -23,20 +23,24 @@ type Resource = 'products'
   | 'authentications';
 
 type ResourceId = string & { length: 24 };
-
 type ResourceAndId = `${Resource}/${ResourceId}`;
-
+type ResourceAndFind = ResourceAndId | `${Resource}/${string}:${string}`;
 type ResourceOpQuery = Resource | `${Resource}?${string}`;
 
+type SearchOpQuery = 'search/v1'
+  | `search/v1?${string}`
+  | 'search/_els'
+  | `search/_els?${string}`;
+
 type EventsEndpoint = `events/${Resource}`
   | `events/${ResourceAndId}`
   | 'events/me';
 
 type Endpoint = ResourceOpQuery
-  | ResourceAndId
-  | `${ResourceAndId}/${string}`
+  | ResourceAndFind
+  | `${ResourceAndFind}/${string}`
   | `slugs/${string}`
-  | 'search/v1'
+  | SearchOpQuery
   | EventsEndpoint
   | 'login'
   | 'authenticate'
@@ -57,6 +61,14 @@ type Config = {
   lang?: string,
   method?: Method,
   endpoint: Endpoint,
+  fields?: readonly string[],
+  sort?: readonly string[],
+  limit?: number,
+  offset?: number,
+  count?: boolean,
+  buckets?: boolean,
+  verbose?: boolean,
+  concise?: boolean,
   params?: Record<string, string | number | boolean | string[] | number[]> | string,
   headers?: Headers | Record<string, string>,
   timeout?: number,
@@ -72,33 +84,156 @@ type BaseListResultMeta = {
   fields: Array<string>,
 };
 
-type ListResultDocs<Document extends any> = Array<Partial<Document> & { _id: ResourceId }>;
-type ProductsList = ListResultDocs<Products>;
-type CategoriesList = ListResultDocs<Categories>;
-type BrandsList = ListResultDocs<Brands>;
-type CollectionsList = ListResultDocs<Collections>;
-type GridsList = ListResultDocs<Grids>;
-type CartsList = ListResultDocs<Carts>;
-type OrdersList = ListResultDocs<Orders>;
-type CustomersList = ListResultDocs<Customers>;
-type StoresList = ListResultDocs<Stores>;
-type ApplicationsList = ListResultDocs<Applications>;
-type AuthenticationsList = ListResultDocs<Authentications>;
+type DocField<T extends string> = T extends `${infer U}.${string}` ? U : T;
+type ListResultDocs<
+  Document extends Record<string, any>,
+  Fields extends string[] | '*' = '*',
+> = Array<Omit<(
+  Fields extends '*' ? Partial<Document> :
+  Pick<Document, Extract<keyof Document, DocField<Fields[number]>>>
+), '_id'> & { _id: ResourceId }>;
+
+type DefaultProductsFields = [
+  'sku',
+  'slug',
+];
+type ProductsList<Fields extends null | string[] | '*' = '*'> =
+  ListResultDocs<Products, Fields extends null ? DefaultProductsFields : Fields>;
+
+type DefaultCategoriesFields = [
+  'name',
+  'slug',
+  'parent',
+  'icon',
+  'pictures.0',
+];
+type CategoriesList<Fields extends null | string[] | '*' = '*'> =
+  ListResultDocs<Categories, Fields extends null ? DefaultCategoriesFields : Fields>;
+
+type DefaultBrandsFields = [
+  'name',
+  'slug',
+  'logo',
+  'pictures.0',
+];
+type BrandsList<Fields extends null | string[] | '*' = '*'> =
+  ListResultDocs<Brands, Fields extends null ? DefaultBrandsFields : Fields>;
+
+type DefaultCollectionsFields = [
+  'name',
+  'slug',
+  'products',
+  'pictures.0',
+];
+type CollectionsList<Fields extends null | string[] | '*' = '*'> =
+  ListResultDocs<Collections, Fields extends null ? DefaultCollectionsFields : Fields>;
+
+type DefaultGridsFields = [
+  'title',
+  'grid_id',
+  'options.text',
+  'options.colors',
+];
+type GridsList<Fields extends null | string[] | '*' = '*'> =
+  ListResultDocs<Grids, Fields extends null ? DefaultGridsFields : Fields>;
+
+type DefaultCartsFields = [
+  'available',
+  'completed',
+  'permalink',
+  'status',
+  'customers',
+  'other_customers',
+  'items.product_id',
+  'items.sku',
+  'items.name',
+  'items.quantity',
+  'items.final_price',
+  'subtotal',
+];
+type CartsList<Fields extends null | string[] | '*' = '*'> =
+  ListResultDocs<Carts, Fields extends null ? DefaultCartsFields : Fields>;
+
+type DefaultOrdersFields = [
+  'channel_id',
+  'number',
+  'code',
+  'status',
+  'financial_status.updated_at',
+  'financial_status.current',
+  'fulfillment_status.updated_at',
+  'fulfillment_status.current',
+  'amount',
+  'payment_method_label',
+  'shipping_method_label',
+  'buyers._id',
+  'buyers.main_email',
+  'buyers.display_name',
+  'items.product_id',
+  'items.sku',
+  'items.name',
+  'items.quantity',
+];
+type OrdersList<Fields extends null | string[] | '*' = '*'> =
+  ListResultDocs<Orders, Fields extends null ? DefaultOrdersFields : Fields>;
+
+type DefaultCustomersFields = [
+  'state',
+  'enabled',
+  'login',
+  'status',
+  'main_email',
+  'accepts_marketing',
+  'display_name',
+  'orders_count',
+  'orders_total_value',
+];
+type CustomersList<Fields extends null | string[] | '*' = '*'> =
+  ListResultDocs<Customers, Fields extends null ? DefaultCustomersFields : Fields>;
+
+type DefaultStoresFields = [
+  'store_id',
+  'name',
+  'domain',
+];
+type StoresList<Fields extends null | string[] | '*' = '*'> =
+  ListResultDocs<Stores, Fields extends null ? DefaultStoresFields : Fields>;
+
+type DefaultApplicationsFields = [
+  'app_id',
+  'title',
+  'state',
+  'version',
+  'type',
+];
+type ApplicationsList<Fields extends null | string[] | '*' = '*'> =
+  ListResultDocs<Applications, Fields extends null ? DefaultApplicationsFields : Fields>;
+
+type DefaultAuthenticationsFields = [
+  'username',
+  'email',
+  'app',
+];
+type AuthenticationsList<Fields extends null | string[] | '*' = '*'> =
+  ListResultDocs<Authentications, Fields extends null ? DefaultAuthenticationsFields : Fields>;
 
 type ListEndpoint<TResource extends Resource> = TResource | `${TResource}?${string}`;
-type ResourceListResult<TEndpoint extends ResourceOpQuery> = {
+type ResourceListResult<
+  TEndpoint extends ResourceOpQuery,
+  Fields extends string[] | null = TEndpoint extends Resource ? null : '*',
+> = {
   result:
-    TEndpoint extends ListEndpoint<'products'> ? ProductsList :
-    TEndpoint extends ListEndpoint<'categories'> ? CategoriesList :
-    TEndpoint extends ListEndpoint<'brands'> ? BrandsList :
-    TEndpoint extends ListEndpoint<'collections'> ? CollectionsList :
-    TEndpoint extends ListEndpoint<'grids'> ? GridsList :
-    TEndpoint extends ListEndpoint<'carts'> ? CartsList :
-    TEndpoint extends ListEndpoint<'orders'> ? OrdersList :
-    TEndpoint extends ListEndpoint<'customers'> ? CustomersList :
-    TEndpoint extends ListEndpoint<'stores'> ? StoresList :
-    TEndpoint extends ListEndpoint<'applications'> ? ApplicationsList :
-    TEndpoint extends ListEndpoint<'authentications'> ? AuthenticationsList :
+    TEndpoint extends ListEndpoint<'products'> ? ProductsList<Fields> :
+    TEndpoint extends ListEndpoint<'categories'> ? CategoriesList<Fields> :
+    TEndpoint extends ListEndpoint<'brands'> ? BrandsList<Fields> :
+    TEndpoint extends ListEndpoint<'collections'> ? CollectionsList<Fields> :
+    TEndpoint extends ListEndpoint<'grids'> ? GridsList<Fields> :
+    TEndpoint extends ListEndpoint<'carts'> ? CartsList<Fields> :
+    TEndpoint extends ListEndpoint<'orders'> ? OrdersList<Fields> :
+    TEndpoint extends ListEndpoint<'customers'> ? CustomersList<Fields> :
+    TEndpoint extends ListEndpoint<'stores'> ? StoresList<Fields> :
+    TEndpoint extends ListEndpoint<'applications'> ? ApplicationsList<Fields> :
+    TEndpoint extends ListEndpoint<'authentications'> ? AuthenticationsList<Fields> :
     never,
   meta: BaseListResultMeta & {
     count?: number,
@@ -110,6 +245,83 @@ type ResourceListResult<TEndpoint extends ResourceOpQuery> = {
   },
 };
 
+interface SearchProducts extends Products {
+  has_variations: boolean;
+  _score: number;
+}
+type DefaultSearchFields = [
+  'sku',
+  'name',
+  'slug',
+  'available',
+  'visible',
+  'price',
+  'base_price',
+  'quantity',
+  'min_quantity',
+  'inventory',
+  'measurement',
+  'condition',
+  'warranty',
+  'pictures.normal',
+  'has_variations',
+];
+
+type SearchItem<Fields extends null | string[] | '*' = '*'> = Omit<(
+  Fields extends '*' ? Partial<SearchProducts> :
+  Pick<
+    SearchProducts,
+    Extract<keyof SearchProducts,
+      DocField<Fields extends null ? DefaultSearchFields[number] : Fields[number]>>
+  >
+), '_id' | '_score'> & {
+  _id: ResourceId,
+  _score: number,
+};
+
+type SearchResult<
+  TEndpoint extends SearchOpQuery | 'v1' | 'els',
+  Fields extends string[] | null = TEndpoint extends 'search/v1' | 'v1' ? null : '*',
+> =
+  TEndpoint extends 'search/v1' | `search/v1?${string}` | 'v1' ? {
+    result: SearchItem<Fields>[],
+    meta: BaseListResultMeta & {
+      count?: number,
+      sort: Array<{
+        field: string,
+        order: 1 | -1,
+      }>,
+      query: { [key: string]: any },
+      buckets?: {
+        prices?: Array<{
+          min: null | number,
+          max: null | number,
+          avg: null | number,
+          count: number,
+        }>,
+        'brands/name'?: {
+          [key: string]: number,
+        },
+        'categories/name'?: {
+          [key: string]: number,
+        },
+        specs?: {
+          [key: string]: number,
+        },
+      },
+    },
+  } :
+  TEndpoint extends 'search/_els' | `search/_els?${string}` | 'els' ? {
+    hits: {
+      hits: SearchItem<'*'>[],
+      total: number,
+      max_score: null,
+    },
+    aggregations: Record<string, any>,
+    took: number,
+  } :
+  never;
+
 type EventFieldsByEndpoint<TEndpoint extends EventsEndpoint> =
   TEndpoint extends `events/${Resource}` ? {
     resource_id: ResourceId,
@@ -141,7 +353,14 @@ type EventsResult<TEndpoint extends EventsEndpoint> = {
   meta: BaseListResultMeta,
 };
 
-type ResponseBody<TConfig extends Config> =
+type ResponseBody<
+  TConfig extends Config,
+  ListFields extends string[] | null = TConfig['endpoint'] extends Resource
+    ? TConfig['params']['fields'] extends string ? '*'
+      : TConfig['fields'] extends readonly string[] ? TConfig['fields']
+      : null
+    : '*',
+> =
   TConfig['method'] extends 'post' ?
     TConfig['endpoint'] extends 'login' ? { _id: ResourceId, store_ids: number[], api_key: string } :
     TConfig['endpoint'] extends 'authenticate' ? { my_id: string, access_token: string, expires: string } :
@@ -160,7 +379,8 @@ type ResponseBody<TConfig extends Config> =
   TConfig['endpoint'] extends `stores/${ResourceId}` ? Stores :
   TConfig['endpoint'] extends `applications/${ResourceId}` ? Applications :
   TConfig['endpoint'] extends `authentications/${ResourceId}` ? Authentications :
-  TConfig['endpoint'] extends ResourceOpQuery ? ResourceListResult<TConfig['endpoint']> :
+  TConfig['endpoint'] extends ResourceOpQuery ? ResourceListResult<TConfig['endpoint'], ListFields> :
+  TConfig['endpoint'] extends SearchOpQuery ? SearchResult<TConfig['endpoint'], ListFields> :
   TConfig['endpoint'] extends EventsEndpoint ? EventsResult<TConfig['endpoint']> :
   any;
 
@@ -245,11 +465,14 @@ export type {
   Resource,
   ResourceId,
   ResourceAndId,
+  ResourceAndFind,
   ResourceOpQuery,
   Endpoint,
   Method,
   Config,
   ResourceListResult,
+  SearchItem,
+  SearchResult,
   EventsResult,
   ResponseBody,
   RequestBody,

package/types.ts

@@ -1,2 +1,2 @@
 /* eslint-disable */
-export * from './lib/types.d';
+export * from './types.d';

package/lib/types/brands.d.ts

@@ -1,157 +0,0 @@
-/* tslint:disable */
-/**
- * This file was automatically generated by json-schema-to-typescript.
- * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and run json-schema-to-typescript to regenerate this file.
- */
-
-export interface Brands {
-  _id: string & { length: 24 };
-  created_at: string;
-  updated_at: string;
-  store_id: number;
-  /**
-   * @maxItems 10
-   */
-  channel_ids?: string[];
-  /**
-   * Brand full name
-   */
-  name: string;
-  /**
-   * Slug to complete page URL, starting with number or lowercase letter
-   */
-  slug?: string;
-  /**
-   * Short brand description in plain text
-   */
-  short_description?: string;
-  /**
-   * Full brand description, may use HTML tags
-   */
-  body_html?: string;
-  /**
-   * Full brand description, plain text only
-   */
-  body_text?: string;
-  /**
-   * Title tag for page SEO
-   */
-  meta_title?: string;
-  /**
-   * Meta description tag for page SEO
-   */
-  meta_description?: string;
-  /**
-   * Text translations for internationalization
-   */
-  i18n?: {
-    /**
-     * Language specific text fields
-     *
-     * This interface was referenced by `undefined`'s JSON-Schema definition
-     * via the `patternProperty` "^[a-z]{2}(_[a-z]{2})?$".
-     */
-    [k: string]: {
-      /**
-       * Brand full name
-       */
-      name?: string;
-      /**
-       * Short brand description in plain text
-       */
-      short_description?: string;
-      /**
-       * Full brand description, may use HTML tags
-       */
-      body_html?: string;
-      /**
-       * Full brand description, plain text only
-       */
-      body_text?: string;
-      /**
-       * Title tag for page SEO
-       */
-      meta_title?: string;
-      /**
-       * Meta description tag for page SEO
-       */
-      meta_description?: string;
-    };
-  };
-  /**
-   * Brand logo
-   */
-  logo?: {
-    /**
-     * Image link
-     */
-    url: string;
-    /**
-     * Image size (width x height) in px, such as 100x50 (100px width, 50px height)
-     */
-    size?: string;
-    /**
-     * Alternative text, HTML alt tag (important for SEO)
-     */
-    alt?: string;
-  };
-  /**
-   * List of brand images
-   *
-   * @maxItems 50
-   */
-  pictures?: {
-    /**
-     * Picture ID (ObjectID) [auto]
-     */
-    _id?: string;
-    /**
-     * Tag to identify object, use only lowercase letters, digits and underscore
-     */
-    tag?: string;
-    /**
-     * Image link
-     */
-    url: string;
-    /**
-     * Image size (width x height) in px, such as 100x50 (100px width, 50px height)
-     */
-    size?: string;
-    /**
-     * Alternative text, HTML alt tag (important for SEO)
-     */
-    alt?: string;
-  }[];
-  /**
-   * List of custom attributes
-   *
-   * @maxItems 100
-   */
-  metafields?: {
-    /**
-     * String to help distinguish who (or which app) created and can use the metafield
-     */
-    namespace?: string;
-    /**
-     * Field name
-     */
-    field?: string;
-    /**
-     * Custom property value
-     */
-    value: {
-      [k: string]: unknown;
-    };
-  }[];
-  /**
-   * Flags to associate additional info
-   *
-   * @maxItems 10
-   */
-  flags?: string[];
-  /**
-   * Optional notes with additional info about this brand
-   */
-  notes?: string;
-}