@cloudcommerce/api 0.0.27 → 0.0.28

package/src/types/customers.d.ts

@@ -9,7 +9,7 @@
  * Customer object model
  */
 export interface Customers {
-  _id: string;
+  _id: string & { length: 24 };
   created_at: string;
   updated_at: string;
   store_id: number;
@@ -365,7 +365,7 @@ export interface Customers {
     /**
      * Order ID (ObjectID)
      */
-    _id: string;
+    _id: string & { length: 24 };
     /**
      * When order was saved, date and time in ISO 8601 standard representation
      */

package/src/types/grids.d.ts

@@ -6,7 +6,7 @@
  */
 
 export interface Grids {
-  _id: string;
+  _id: string & { length: 24 };
   created_at: string;
   updated_at: string;
   store_id: number;

package/src/types/orders.d.ts

@@ -9,7 +9,7 @@
  * Order object model
  */
 export interface Orders {
-  _id: string;
+  _id: string & { length: 24 };
   created_at: string;
   updated_at: string;
   store_id: number;
@@ -229,7 +229,7 @@ export interface Orders {
     /**
      * Customer ID (ObjectID)
      */
-    _id: string;
+    _id: string & { length: 24 };
     /**
      * Customer language two letter code, sometimes with region, e.g. 'pt_br', 'fr', 'en_us'
      */
@@ -1229,7 +1229,7 @@ export interface Orders {
       /**
        * Kit product ID (ObjectID)
        */
-      _id: string;
+      _id: string & { length: 24 };
       /**
        * Kit product full name
        */
@@ -1251,7 +1251,7 @@ export interface Orders {
         /**
          * Product ID (ObjectID)
          */
-        _id: string;
+        _id: string & { length: 24 };
         /**
          * Selected variation ID (ObjectID) if any
          */
@@ -1345,7 +1345,7 @@ export interface Orders {
     /**
      * Subscription order ID (ObjectID)
      */
-    _id: string;
+    _id: string & { length: 24 };
     /**
      * Subscription order number
      */

package/src/types/products.d.ts

@@ -6,7 +6,7 @@
  */
 
 export interface Products {
-  _id: string;
+  _id: string & { length: 24 };
   created_at: string;
   updated_at: string;
   store_id: number;
@@ -1179,7 +1179,7 @@ export interface Products {
     /**
      * Product ID (ObjectID)
      */
-    _id: string;
+    _id: string & { length: 24 };
     /**
      * Product quantity
      */

package/src/types/stores.d.ts

@@ -6,7 +6,7 @@
  */
 
 export interface Stores {
-  _id: string;
+  _id: string & { length: 24 };
   created_at: string;
   updated_at: string;
   store_id: number;

package/src/types.ts

@@ -8,6 +8,7 @@ import type { Orders } from './types/orders';
 import type { Customers } from './types/customers';
 import type { Stores } from './types/stores';
 import type { Applications } from './types/applications';
+import type { Authentications } from './types/authentications';
 
 type Resource = 'products'
   | 'categories'
@@ -18,17 +19,20 @@ type Resource = 'products'
   | 'orders'
   | 'customers'
   | 'stores'
-  | 'applications';
+  | 'applications'
+  | 'authentications';
 
 type ResourceId = string & { length: 24 };
 
 type ResourceAndId = `${Resource}/${ResourceId}`;
 
+type ResourceOpQuery = Resource | `${Resource}?${string}`;
+
 type EventsEndpoint = `events/${Resource}`
   | `events/${ResourceAndId}`
   | 'events/me';
 
-type Endpoint = Resource
+type Endpoint = ResourceOpQuery
   | ResourceAndId
   | `${ResourceAndId}/${string}`
   | `slugs/${string}`
@@ -38,7 +42,7 @@ type Endpoint = Resource
   | 'authenticate'
   | 'ask-auth-callback'
   | 'check-username'
-  | `$aggregate/${Exclude<Resource, 'stores' | 'applications'>}`
+  | `$aggregate/${Exclude<Resource, 'stores' | 'applications' | 'authentications'>}`
   | `schemas/${Resource}`;
 
 type Method = 'get' | 'post' | 'put' | 'patch' | 'delete';
@@ -46,11 +50,14 @@ type Method = 'get' | 'post' | 'put' | 'patch' | 'delete';
 type Config = {
   baseUrl?: string,
   storeId?: number,
+  accessToken?: string,
+  authenticationId?: string,
+  apiKey?: string,
   lang?: string,
   method?: Method,
   endpoint: Endpoint,
   params?: Record<string, string | number>,
-  headers?: Record<string, string>,
+  headers?: Headers | Record<string, string>,
   timeout?: number,
   maxRetries?: number,
   fetch?: typeof fetch,
@@ -62,18 +69,21 @@ type BaseListResultMeta = {
   fields: Array<string>,
 };
 
-type ResourceListResult<TResource extends Resource> = {
+type ListEndpoint<TResource extends Resource> = TResource | `${TResource}?${string}`;
+
+type ResourceListResult<TEndpoint extends ResourceOpQuery> = {
   result:
-    TResource extends 'products' ? Products[] :
-    TResource extends 'categories' ? Categories[] :
-    TResource extends 'brands' ? Brands[] :
-    TResource extends 'collections' ? Collections[] :
-    TResource extends 'grids' ? Grids[] :
-    TResource extends 'carts' ? Carts[] :
-    TResource extends 'orders' ? Orders[] :
-    TResource extends 'customers' ? Customers[] :
-    TResource extends 'stores' ? Stores[] :
-    TResource extends 'applications' ? Applications[] :
+    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,
   meta: BaseListResultMeta & {
     count?: number,
@@ -117,9 +127,13 @@ type EventsResult<TEndpoint extends EventsEndpoint> = {
 };
 
 type ResponseBody<TConfig extends Config> =
-  TConfig['method'] extends 'post' ? { _id: ResourceId } :
+  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 } :
+    { _id: ResourceId } :
   TConfig['method'] extends 'put' | 'patch' | 'delete' ? null :
   // method?: 'get'
+  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 :
@@ -130,10 +144,33 @@ type ResponseBody<TConfig extends Config> =
   TConfig['endpoint'] extends `customers/${ResourceId}` ? Customers :
   TConfig['endpoint'] extends `stores/${ResourceId}` ? Stores :
   TConfig['endpoint'] extends `applications/${ResourceId}` ? Applications :
-  TConfig['endpoint'] extends Resource ? ResourceListResult<TConfig['endpoint']> :
+  TConfig['endpoint'] extends `authentications/${ResourceId}` ? Authentications :
+  TConfig['endpoint'] extends ResourceOpQuery ? ResourceListResult<TConfig['endpoint']> :
   TConfig['endpoint'] extends EventsEndpoint ? EventsResult<TConfig['endpoint']> :
   any;
 
+type DocSchema<Document extends any> =
+  Omit<Document, '_id' | 'store_id' | 'store_ids' | 'created_at' | 'updated_at'>;
+
+type SetDocEndpoint<TResource extends Resource> = TResource | `${TResource}/${ResourceId}`;
+
+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> :
+  any;
+
 export type {
   Products,
   Categories,
@@ -147,8 +184,10 @@ export type {
   Applications,
   Resource,
   ResourceAndId,
+  ResourceOpQuery,
   Endpoint,
   Method,
   Config,
   ResponseBody,
+  RequestBody,
 };

package/tests/index.test.ts

@@ -52,3 +52,19 @@ test('401 trying to list API events', async () => {
     expect(error.response?.status).toBe(401);
   }
 });
+
+test('401 to create category and body typecheck', async () => {
+  try {
+    const { data } = await api.post('categories', {
+      name: 'Test category',
+    }, {
+      accessToken: 'invalid',
+    });
+    console.log(data._id);
+    throw new Error('Should have thrown unauthorized');
+  } catch (err: any) {
+    const error = err as ApiError;
+    expect(error.statusCode).toBe(401);
+    expect(error.response?.status).toBe(401);
+  }
+});