@cloudcommerce/api 0.0.108 → 0.0.110

package/lib/types.d.ts

@@ -42,8 +42,11 @@ declare type BaseListResultMeta = {
     fields: Array<string>;
 };
 declare type ListEndpoint<TResource extends Resource> = TResource | `${TResource}?${string}`;
+declare type ListResultDocs<Document extends any> = Array<Partial<Document> & {
+    _id: ResourceId;
+}>;
 declare type ResourceListResult<TEndpoint extends ResourceOpQuery> = {
-    result: TEndpoint extends ListEndpoint<'products'> ? Products[] : TEndpoint extends ListEndpoint<'categories'> ? Categories[] : TEndpoint extends ListEndpoint<'brands'> ? Brands[] : TEndpoint extends ListEndpoint<'collections'> ? Collections[] : TEndpoint extends ListEndpoint<'grids'> ? Grids[] : TEndpoint extends ListEndpoint<'carts'> ? Carts[] : TEndpoint extends ListEndpoint<'orders'> ? Orders[] : TEndpoint extends ListEndpoint<'customers'> ? Customers[] : TEndpoint extends ListEndpoint<'stores'> ? Stores[] : TEndpoint extends ListEndpoint<'applications'> ? Applications[] : TEndpoint extends ListEndpoint<'authentications'> ? Authentications[] : never;
+    result: TEndpoint extends ListEndpoint<'products'> ? ListResultDocs<Products> : TEndpoint extends ListEndpoint<'categories'> ? ListResultDocs<Categories> : TEndpoint extends ListEndpoint<'brands'> ? ListResultDocs<Brands> : TEndpoint extends ListEndpoint<'collections'> ? ListResultDocs<Collections> : TEndpoint extends ListEndpoint<'grids'> ? ListResultDocs<Grids> : TEndpoint extends ListEndpoint<'carts'> ? ListResultDocs<Carts> : TEndpoint extends ListEndpoint<'orders'> ? ListResultDocs<Orders> : TEndpoint extends ListEndpoint<'customers'> ? ListResultDocs<Customers> : TEndpoint extends ListEndpoint<'stores'> ? ListResultDocs<Stores> : TEndpoint extends ListEndpoint<'applications'> ? ListResultDocs<Applications> : TEndpoint extends ListEndpoint<'authentications'> ? ListResultDocs<Authentications> : never;
     meta: BaseListResultMeta & {
         count?: number;
         sort: Array<{
@@ -92,8 +95,19 @@ declare type ResponseBody<TConfig extends Config> = TConfig['method'] extends 'p
     _id: ResourceId;
 } : TConfig['method'] extends 'put' | 'patch' | 'delete' ? null : TConfig['endpoint'] extends `${string}/${ResourceId}/${string}` ? any : TConfig['endpoint'] extends `products/${ResourceId}` ? Products : TConfig['endpoint'] extends `categories/${ResourceId}` ? Categories : TConfig['endpoint'] extends `brands/${ResourceId}` ? Brands : TConfig['endpoint'] extends `collections/${ResourceId}` ? Collections : TConfig['endpoint'] extends `grids/${ResourceId}` ? Grids : TConfig['endpoint'] extends `carts/${ResourceId}` ? Carts : TConfig['endpoint'] extends `orders/${ResourceId}` ? Orders : TConfig['endpoint'] extends `customers/${ResourceId}` ? Customers : 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 EventsEndpoint ? EventsResult<TConfig['endpoint']> : any;
 declare type DocSchema<Document extends any> = Omit<Document, '_id' | 'store_id' | 'store_ids' | 'created_at' | 'updated_at'>;
+declare type CustomerSet = DocSchema<Customers>;
+declare type OrderSet = DocSchema<Orders>;
+declare type CartSet = DocSchema<Carts>;
+declare type ProductSet = DocSchema<Products>;
+declare type CategorySet = DocSchema<Categories>;
+declare type BrandSet = DocSchema<Brands>;
+declare type CollectionSet = DocSchema<Collections>;
+declare type GridSet = DocSchema<Grids>;
+declare type StoreSet = DocSchema<Stores>;
+declare type ApplicationSet = DocSchema<Applications>;
+declare type AuthenticationSet = DocSchema<Authentications>;
 declare type SetDocEndpoint<TResource extends Resource> = TResource | `${TResource}/${ResourceId}`;
-declare type RequestBody<TConfig extends Config> = TConfig['method'] extends undefined | 'get' | 'delete' ? undefined : TConfig['method'] extends 'patch' ? any : TConfig['endpoint'] extends SetDocEndpoint<'products'> ? DocSchema<Products> : TConfig['endpoint'] extends SetDocEndpoint<'categories'> ? DocSchema<Categories> : TConfig['endpoint'] extends SetDocEndpoint<'brands'> ? DocSchema<Brands> : TConfig['endpoint'] extends SetDocEndpoint<'collections'> ? DocSchema<Collections> : TConfig['endpoint'] extends SetDocEndpoint<'grids'> ? DocSchema<Grids> : TConfig['endpoint'] extends SetDocEndpoint<'carts'> ? DocSchema<Carts> : TConfig['endpoint'] extends SetDocEndpoint<'orders'> ? DocSchema<Orders> : TConfig['endpoint'] extends SetDocEndpoint<'customers'> ? DocSchema<Customers> : TConfig['endpoint'] extends SetDocEndpoint<'stores'> ? DocSchema<Stores> : TConfig['endpoint'] extends SetDocEndpoint<'applications'> ? DocSchema<Applications> : TConfig['endpoint'] extends SetDocEndpoint<'authentications'> ? DocSchema<Authentications> : any;
+declare type RequestBody<TConfig extends Config> = TConfig['method'] extends undefined | 'get' | 'delete' ? undefined : TConfig['method'] extends 'patch' ? any : TConfig['endpoint'] extends SetDocEndpoint<'products'> ? ProductSet : TConfig['endpoint'] extends SetDocEndpoint<'categories'> ? CategorySet : TConfig['endpoint'] extends SetDocEndpoint<'brands'> ? BrandSet : TConfig['endpoint'] extends SetDocEndpoint<'collections'> ? CollectionSet : TConfig['endpoint'] extends SetDocEndpoint<'grids'> ? GridSet : TConfig['endpoint'] extends SetDocEndpoint<'carts'> ? CartSet : TConfig['endpoint'] extends SetDocEndpoint<'orders'> ? OrderSet : TConfig['endpoint'] extends SetDocEndpoint<'customers'> ? CustomerSet : TConfig['endpoint'] extends SetDocEndpoint<'stores'> ? StoreSet : TConfig['endpoint'] extends SetDocEndpoint<'applications'> ? ApplicationSet : TConfig['endpoint'] extends SetDocEndpoint<'authentications'> ? AuthenticationSet : any;
 declare type ErrorBody = {
     status: number;
     error_code: number;
@@ -104,4 +118,4 @@ declare type ErrorBody = {
     };
     more_info?: string;
 };
-export type { Products, Categories, Brands, Collections, Grids, Carts, Orders, Customers, Stores, Applications, Authentications, Resource, ResourceId, ResourceAndId, ResourceOpQuery, Endpoint, Method, Config, ResourceListResult, EventsResult, ResponseBody, RequestBody, ErrorBody, };
+export type { Products, Categories, Brands, Collections, Grids, Carts, Orders, Customers, Stores, Applications, Authentications, ProductSet, CategorySet, BrandSet, CollectionSet, GridSet, CartSet, OrderSet, CustomerSet, StoreSet, ApplicationSet, AuthenticationSet, Resource, ResourceId, ResourceAndId, ResourceOpQuery, Endpoint, Method, Config, ResourceListResult, EventsResult, ResponseBody, RequestBody, ErrorBody, };

package/package.json

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

package/src/types.ts

@@ -73,20 +73,20 @@ type BaseListResultMeta = {
 };
 
 type ListEndpoint<TResource extends Resource> = TResource | `${TResource}?${string}`;
-
+type ListResultDocs<Document extends any> = Array<Partial<Document> & { _id: ResourceId }>;
 type ResourceListResult<TEndpoint extends ResourceOpQuery> = {
   result:
-    TEndpoint extends ListEndpoint<'products'> ? Products[] :
-    TEndpoint extends ListEndpoint<'categories'> ? Categories[] :
-    TEndpoint extends ListEndpoint<'brands'> ? Brands[] :
-    TEndpoint extends ListEndpoint<'collections'> ? Collections[] :
-    TEndpoint extends ListEndpoint<'grids'> ? Grids[] :
-    TEndpoint extends ListEndpoint<'carts'> ? Carts[] :
-    TEndpoint extends ListEndpoint<'orders'> ? Orders[] :
-    TEndpoint extends ListEndpoint<'customers'> ? Customers[] :
-    TEndpoint extends ListEndpoint<'stores'> ? Stores[] :
-    TEndpoint extends ListEndpoint<'applications'> ? Applications[] :
-    TEndpoint extends ListEndpoint<'authentications'> ? Authentications[] :
+    TEndpoint extends ListEndpoint<'products'> ? ListResultDocs<Products> :
+    TEndpoint extends ListEndpoint<'categories'> ? ListResultDocs<Categories> :
+    TEndpoint extends ListEndpoint<'brands'> ? ListResultDocs<Brands> :
+    TEndpoint extends ListEndpoint<'collections'> ? ListResultDocs<Collections> :
+    TEndpoint extends ListEndpoint<'grids'> ? ListResultDocs<Grids> :
+    TEndpoint extends ListEndpoint<'carts'> ? ListResultDocs<Carts> :
+    TEndpoint extends ListEndpoint<'orders'> ? ListResultDocs<Orders> :
+    TEndpoint extends ListEndpoint<'customers'> ? ListResultDocs<Customers> :
+    TEndpoint extends ListEndpoint<'stores'> ? ListResultDocs<Stores> :
+    TEndpoint extends ListEndpoint<'applications'> ? ListResultDocs<Applications> :
+    TEndpoint extends ListEndpoint<'authentications'> ? ListResultDocs<Authentications> :
     never,
   meta: BaseListResultMeta & {
     count?: number,
@@ -154,6 +154,17 @@ type ResponseBody<TConfig extends Config> =
 
 type DocSchema<Document extends any> =
   Omit<Document, '_id' | 'store_id' | 'store_ids' | 'created_at' | 'updated_at'>;
+type CustomerSet = DocSchema<Customers>;
+type OrderSet = DocSchema<Orders>;
+type CartSet = DocSchema<Carts>;
+type ProductSet = DocSchema<Products>;
+type CategorySet = DocSchema<Categories>;
+type BrandSet = DocSchema<Brands>;
+type CollectionSet = DocSchema<Collections>;
+type GridSet = DocSchema<Grids>;
+type StoreSet = DocSchema<Stores>;
+type ApplicationSet = DocSchema<Applications>;
+type AuthenticationSet = DocSchema<Authentications>;
 
 type SetDocEndpoint<TResource extends Resource> = TResource | `${TResource}/${ResourceId}`;
 
@@ -161,17 +172,17 @@ type RequestBody<TConfig extends Config> =
   TConfig['method'] extends undefined | 'get' | 'delete' ? undefined :
   TConfig['method'] extends 'patch' ? any : // TODO: partial body
   // method: 'post' | 'put'
-  TConfig['endpoint'] extends SetDocEndpoint<'products'> ? DocSchema<Products> :
-  TConfig['endpoint'] extends SetDocEndpoint<'categories'> ? DocSchema<Categories> :
-  TConfig['endpoint'] extends SetDocEndpoint<'brands'> ? DocSchema<Brands> :
-  TConfig['endpoint'] extends SetDocEndpoint<'collections'> ? DocSchema<Collections> :
-  TConfig['endpoint'] extends SetDocEndpoint<'grids'> ? DocSchema<Grids> :
-  TConfig['endpoint'] extends SetDocEndpoint<'carts'> ? DocSchema<Carts> :
-  TConfig['endpoint'] extends SetDocEndpoint<'orders'> ? DocSchema<Orders> :
-  TConfig['endpoint'] extends SetDocEndpoint<'customers'> ? DocSchema<Customers> :
-  TConfig['endpoint'] extends SetDocEndpoint<'stores'> ? DocSchema<Stores> :
-  TConfig['endpoint'] extends SetDocEndpoint<'applications'> ? DocSchema<Applications> :
-  TConfig['endpoint'] extends SetDocEndpoint<'authentications'> ? DocSchema<Authentications> :
+  TConfig['endpoint'] extends SetDocEndpoint<'products'> ? ProductSet :
+  TConfig['endpoint'] extends SetDocEndpoint<'categories'> ? CategorySet :
+  TConfig['endpoint'] extends SetDocEndpoint<'brands'> ? BrandSet :
+  TConfig['endpoint'] extends SetDocEndpoint<'collections'> ? CollectionSet :
+  TConfig['endpoint'] extends SetDocEndpoint<'grids'> ? GridSet :
+  TConfig['endpoint'] extends SetDocEndpoint<'carts'> ? CartSet :
+  TConfig['endpoint'] extends SetDocEndpoint<'orders'> ? OrderSet :
+  TConfig['endpoint'] extends SetDocEndpoint<'customers'> ? CustomerSet :
+  TConfig['endpoint'] extends SetDocEndpoint<'stores'> ? StoreSet :
+  TConfig['endpoint'] extends SetDocEndpoint<'applications'> ? ApplicationSet :
+  TConfig['endpoint'] extends SetDocEndpoint<'authentications'> ? AuthenticationSet :
   any;
 
 type ErrorBody = {
@@ -197,6 +208,17 @@ export type {
   Stores,
   Applications,
   Authentications,
+  ProductSet,
+  CategorySet,
+  BrandSet,
+  CollectionSet,
+  GridSet,
+  CartSet,
+  OrderSet,
+  CustomerSet,
+  StoreSet,
+  ApplicationSet,
+  AuthenticationSet,
   Resource,
   ResourceId,
   ResourceAndId,