cloudcommerce 0.0.2 → 0.0.5

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

@@ -0,0 +1,120 @@
+/* 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 Stores {
+  _id: string;
+  created_at: string;
+  updated_at: string;
+  store_id: number;
+  /**
+   * Store name
+   */
+  name: string;
+  /**
+   * Simple description of store
+   */
+  description?: string;
+  /**
+   * ID of store main segment, get options and IDs at /segments.json
+   */
+  segment_id: number;
+  /**
+   * Responsible person or organization document type
+   */
+  doc_type: 'CPF' | 'CNPJ';
+  /**
+   * Responsible person or organization document number (only numbers)
+   */
+  doc_number: string;
+  /**
+   * Municipal or state registration if exists
+   */
+  inscription_type?: 'State' | 'Municipal';
+  /**
+   * Municipal or state registration number (with characters) if exists
+   */
+  inscription_number?: string;
+  /**
+   * Registered company name or responsible fullname
+   */
+  corporate_name: string;
+  /**
+   * Full registered address of company
+   */
+  address?: string;
+  /**
+   * Financial contact phone
+   */
+  phone?: string;
+  /**
+   * Name of company representative for commercial contact
+   */
+  representant_name?: string;
+  /**
+   * Email address of company representative
+   */
+  representant_email?: string;
+  /**
+   * Public email address for news and general contact
+   */
+  contact_email?: string;
+  /**
+   * Email address to receive notifications, invoices and vouchers
+   */
+  financial_email: string;
+  /**
+   * Image link to shop's 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;
+  };
+  /**
+   * Preferred sales channel domain name, with subdomain if any
+   */
+  domain?: string;
+  /**
+   * Preferred shop homepage link (full URI)
+   */
+  homepage?: string;
+  /**
+   * Main colors to compose shop's visual identity
+   */
+  brand_colors?: {
+    /**
+     * Primary color RGB code with #
+     */
+    primary?: string;
+    /**
+     * Secondary color RGB code with #
+     */
+    secondary?: string;
+  };
+  /**
+   * Public contact phone
+   */
+  contact_phone?: string;
+  /**
+   * Secondary public contact phone, commonly a cell phone number
+   */
+  contact_cellphone?: string;
+  sales_channels?: {
+    channel_id: string;
+    type?: 'ecommerce' | 'mobile' | 'pos' | 'button' | 'social' | 'chatbot' | 'live';
+    title?: string;
+  }[];
+}

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

@@ -0,0 +1,39 @@
+import type { Products } from './types/products';
+import type { Categories } from './types/categories';
+import type { Brands } from './types/brands';
+import type { Collections } from './types/collections';
+import type { Grids } from './types/grids';
+import type { Carts } from './types/carts';
+import type { Orders } from './types/orders';
+import type { Customers } from './types/customers';
+import type { Stores } from './types/stores';
+import type { Applications } from './types/applications';
+declare type Resource = 'products' | 'categories' | 'brands' | 'collections' | 'grids' | 'carts' | 'orders' | 'customers' | 'stores' | 'applications';
+declare type ResourceId = string & {
+    length: 24;
+};
+declare type ResourceAndId = `${Resource}/${ResourceId}`;
+declare type Endpoint = Resource | ResourceAndId | `${ResourceAndId}/${string}`;
+declare type Method = 'get' | 'post' | 'put' | 'patch' | 'delete';
+declare type Config = {
+    baseUrl?: string;
+    storeId?: number;
+    lang?: string;
+    method?: Method;
+    endpoint: Endpoint;
+    params?: Record<string, string | number>;
+    headers?: Record<string, string>;
+    timeout?: number;
+};
+declare type ReadConfig<endpoint> = Config & {
+    method?: 'get';
+    endpoint: endpoint;
+};
+declare type ResponseBody<T> = T extends Config & {
+    method: 'post';
+} ? {
+    _id: ResourceId;
+} : T extends Config & {
+    method: 'put' | 'patch' | 'delete';
+} ? null : T extends ReadConfig<`products/${ResourceId}`> ? Products : T extends ReadConfig<`categories/${ResourceId}`> ? Categories : T extends ReadConfig<`brands/${ResourceId}`> ? Brands : T extends ReadConfig<`collections/${ResourceId}`> ? Collections : T extends ReadConfig<`grids/${ResourceId}`> ? Grids : T extends ReadConfig<`carts/${ResourceId}`> ? Carts : T extends ReadConfig<`orders/${ResourceId}`> ? Orders : T extends ReadConfig<`customers/${ResourceId}`> ? Customers : T extends ReadConfig<`stores/${ResourceId}`> ? Stores : T extends ReadConfig<`applications/${ResourceId}`> ? Applications : any;
+export type { Products, Categories, Brands, Collections, Grids, Carts, Orders, Customers, Stores, Applications, Resource, ResourceAndId, Endpoint, Method, Config, ResponseBody, };

package/packages/api/lib/types.js

@@ -0,0 +1,2 @@
+export {};
+// # sourceMappingURL=types.js.map

package/packages/api/lib/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/packages/api/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@cloudcommerce/api",
-  "version": "0.0.2",
+  "version": "0.0.5",
   "description": "E-Com Plus Cloud Commerce APIs client/adapter",
-  "main": "dist/index.js",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ecomplus/cloud-commerce.git",
@@ -15,6 +16,7 @@
   },
   "homepage": "https://github.com/ecomplus/cloud-commerce/tree/main/packages/api#readme",
   "scripts": {
-    "build": "tsc --build"
+    "build": "sh scripts/build.sh",
+    "test": "tsc -p ../../tsconfig.test.json && vitest run"
   }
 }

package/packages/api/scripts/build.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+rm -rf lib
+tsc --outDir lib
+cp -r src/types lib/
+npx eslint --rule 'max-len: off' --ext .js lib --fix

package/packages/api/src/index.ts

@@ -1,27 +1,4 @@
-type Resource = 'products'
-  | 'categories'
-  | 'brands'
-  | 'collections'
-  | 'grids'
-  | 'carts'
-  | 'orders'
-  | 'customers'
-  | 'stores'
-  | 'applications';
-
-type Endpoint = Resource | `${Resource}/${string}`;
-
-type Method = 'get' | 'post' | 'put' | 'patch' | 'delete';
-
-type ReqOptions = {
-  baseUrl?: string,
-  storeId?: number,
-  lang?: string,
-  method: Method,
-  endpoint: Endpoint,
-  params?: Record<string, string | number>,
-  headers?: Record<string, string>,
-};
+import type { Endpoint, Config, ResponseBody } from './types';
 
 // @ts-ignore
 const env: { [key: string]: string } = (typeof window === 'object' && window)
@@ -29,28 +6,26 @@ const env: { [key: string]: string } = (typeof window === 'object' && window)
   || {};
 
 const def = {
-  middleware(options: ReqOptions) {
-    let url = options.baseUrl || env.API_BASE_URL || 'https://ecomplus.io/v2';
-    if (!url) {
-      const storeId = options.storeId || env.ECOM_STORE_ID;
-      if (!storeId) {
-        throw new Error('`storeId` must be set in options or `ECOM_STORE_ID` env var');
-      }
-      url += `/:${storeId}`;
-      const lang = options.lang || env.ECOM_LANG;
-      if (lang) {
-        url += `,lang:${lang}`;
-      }
+  middleware(config: Config) {
+    let url = config.baseUrl || env.API_BASE_URL || 'https://ecomplus.io/v2';
+    const storeId = config.storeId || env.ECOM_STORE_ID;
+    if (!storeId) {
+      throw new Error('`storeId` must be set in config or `ECOM_STORE_ID` env var');
     }
-    if (options.params) {
-      if (typeof options.params === 'string') {
-        url += `?${options.params}`;
+    url += `/:${storeId}`;
+    const lang = config.lang || env.ECOM_LANG;
+    if (lang) {
+      url += `,lang:${lang}`;
+    }
+    if (config.params) {
+      if (typeof config.params === 'string') {
+        url += `?${config.params}`;
       } else {
         // https://github.com/microsoft/TypeScript/issues/32951
-        url += `?${new URLSearchParams(options.params as Record<string, string>)}`;
+        url += `?${new URLSearchParams(config.params as Record<string, string>)}`;
       }
     }
-    return `${url}/${options.endpoint}`;
+    return `${url}/${config.endpoint}`;
   },
 };
 
@@ -59,50 +34,76 @@ const setMiddleware = (middleware: typeof def.middleware) => {
   def.middleware = middleware;
 };
 
-const callApi = (options: ReqOptions) => {
-  const url = def.middleware(options);
-  const { method, headers } = options;
-  return fetch(url, { method, headers });
+const api = async <T extends Config>(config: T): Promise<Response & {
+  config: Config,
+  data: ResponseBody<T>,
+}> => {
+  const url = def.middleware(config);
+  const { method, headers, timeout = 20000 } = config;
+  const abortController = new AbortController();
+  const timer = setTimeout(() => abortController.abort(), timeout);
+  const response = await fetch(url, {
+    method,
+    headers,
+    signal: abortController.signal,
+  });
+  clearTimeout(timer);
+  if (response.ok) {
+    return {
+      ...response,
+      config,
+      data: await response.json(),
+    };
+  }
+  const error: any = new Error(response.statusText);
+  error.config = config;
+  error.response = response;
+  error.statusCode = response.status;
+  throw error;
 };
 
-const get = (endpoint: Endpoint, options: Exclude<ReqOptions, 'method'>) => callApi({
-  ...options,
-  method: 'get',
-  endpoint,
-});
+type AbstractedConfig = Omit<Config, 'endpoint' | 'method'>;
 
-const post = (endpoint: Endpoint, options: Exclude<ReqOptions, 'method'>) => callApi({
-  ...options,
+const get = <E extends Endpoint, C extends AbstractedConfig>(
+  endpoint: E,
+  config?: C,
+): Promise<Response & {
+  config: Config,
+  data: ResponseBody<{ endpoint: E }>,
+}> => api({ ...config, endpoint });
+
+const post = (endpoint: Endpoint, config?: AbstractedConfig) => api({
+  ...config,
   method: 'post',
   endpoint,
 });
 
-const put = (endpoint: Endpoint, options: Exclude<ReqOptions, 'method'>) => callApi({
-  ...options,
+const put = (endpoint: Endpoint, config?: AbstractedConfig) => api({
+  ...config,
   method: 'put',
   endpoint,
 });
 
-const patch = (endpoint: Endpoint, options: Exclude<ReqOptions, 'method'>) => callApi({
-  ...options,
+const patch = (endpoint: Endpoint, config?: AbstractedConfig) => api({
+  ...config,
   method: 'patch',
   endpoint,
 });
 
-const del = (endpoint: Endpoint, options: Exclude<ReqOptions, 'method'>) => callApi({
-  ...options,
+const del = (endpoint: Endpoint, config?: AbstractedConfig) => api({
+  ...config,
   method: 'delete',
   endpoint,
 });
 
-callApi.get = get;
-callApi.post = post;
-callApi.put = put;
-callApi.patch = patch;
-callApi.del = del;
-callApi.delete = del;
+api.get = get;
+api.post = post;
+api.put = put;
+api.patch = patch;
+api.del = del;
+api.delete = del;
 
-export default callApi;
+export default api;
 
 export {
   setMiddleware,
@@ -112,10 +113,3 @@ export {
   patch,
   del,
 };
-
-export type {
-  Resource,
-  Endpoint,
-  Method,
-  ReqOptions,
-};

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

@@ -0,0 +1,208 @@
+/* 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 Applications {
+  _id: string;
+  created_at: string;
+  updated_at: string;
+  store_id: number;
+  /**
+   * ID of application on marketplace
+   */
+  app_id: number;
+  /**
+   * The working state of this app in the shop
+   */
+  state?: 'inactive' | 'active' | 'test';
+  /**
+   * App title
+   */
+  title: string;
+  /**
+   * App unique slug on marketplace, only lowercase letters, numbers and hyphen
+   */
+  slug?: string;
+  /**
+   * Whether this app is paid
+   */
+  paid?: boolean;
+  /**
+   * Installed application version, semver e.g. 1.0.0
+   */
+  version: string;
+  /**
+   * When app installation was updated, date and time in ISO 8601 standard representation
+   */
+  version_date?: string;
+  /**
+   * Type of app
+   */
+  type: 'dashboard' | 'storefront' | 'external';
+  /**
+   * 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;
+    };
+  };
+  /**
+   * Configuration options for staff on admin dashboard, saved on app data
+   */
+  admin_settings?: {
+    /**
+     * Configuration field object, property name same as saved on data object
+     *
+     * This interface was referenced by `undefined`'s JSON-Schema definition
+     * via the `patternProperty` "^[a-z0-9_]{2,30}$".
+     */
+    [k: string]: {
+      /**
+       * JSON Schema (https://json-schema.org/specification.html) for field model
+       */
+      schema: {
+        [k: string]: unknown;
+      };
+      /**
+       * Whether the field value is private, saved in `hidden_data`
+       */
+      hide?: boolean;
+    };
+  };
+  /**
+   * Link to client side script (JS) to load on storefront
+   */
+  storefront_script_uri?: string;
+  /**
+   * Endpoint that receives POST back with authentication credentials, must be HTTPS
+   */
+  auth_callback_uri?: string;
+  /**
+   * If this app uses authentication, list the needed permissions
+   */
+  auth_scope?: {
+    /**
+     * Special scope to read authentications
+     */
+    authentications?: 'GET'[];
+    /**
+     * Requested resource, cannot be 'applications', 'authentications' or '$update' here
+     *
+     * This interface was referenced by `undefined`'s JSON-Schema definition
+     * via the `patternProperty` "^([$]?(?!app|aut|upd)([a-z][a-z0-9/_]{1,60}[^/]))$".
+     */
+    [k: string]: ('all' | 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE')[];
+  };
+  /**
+   * Application object data, schema free
+   */
+  data?: {
+    [k: string]: unknown;
+  };
+  /**
+   * Application private data, available only with authentication
+   */
+  hidden_data?: {
+    [k: string]: unknown;
+  };
+  /**
+   * Flags to associate additional info
+   */
+  flags?: string[];
+  /**
+   * Optional notes with additional info about this user
+   */
+  notes?: string;
+}

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

@@ -0,0 +1,97 @@
+/* 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 Authentications {
+  _id: string;
+  created_at: string;
+  updated_at: string;
+  store_ids: number[];
+  /**
+   * Simple username for identification, only numbers and lowercase letters
+   */
+  username: string;
+  /**
+   * User language two letter code, sometimes with region, eg.: pt_br, fr, en_us
+   */
+  locale?: string;
+  /**
+   * User email address
+   */
+  email?: string;
+  /**
+   * User full name
+   */
+  name?: string;
+  /**
+   * User phone number
+   */
+  phone?: string;
+  /**
+   * MD5 hash generated with the user's password
+   */
+  pass_md5_hash?: string;
+  /**
+   * API key as a random 128 bytes hexadecimal number
+   */
+  api_key?: string;
+  /**
+   * Collection of resources allowed to user, each resource uri as object property
+   */
+  permissions?: {
+    /**
+     * Resource/Subresources/Third-level/ID
+     *
+     * This interface was referenced by `undefined`'s JSON-Schema definition
+     * via the `patternProperty` "^(([^/_][a-z0-9/_@:$+]{1,60}[^/])|[*])$".
+     */
+    [k: string]: ('all' | 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE')[];
+  };
+  /**
+   * List of dashboard cards chosen by user
+   */
+  panel_cards?: {
+    /**
+     * Unique identifier, card name using only lowercase, numbers and underscore
+     */
+    card_id: string;
+    /**
+     * Card title
+     */
+    title?: string;
+    /**
+     * Card text, usually a brief description
+     */
+    paragraph?: string;
+    /**
+     * Custom card calling MongoDB aggregate
+     */
+    custom_aggregation?: {
+      /**
+       * API resource
+       */
+      resource: 'products' | 'categories' | 'brands' | 'collections' | 'grids' | 'customers' | 'carts' | 'orders';
+      /**
+       * Aggregation pipeline
+       */
+      pipeline: {
+        [k: string]: unknown;
+      }[];
+    };
+  }[];
+  /**
+   * Whether the user is able to use builder and file manager to edit storefront
+   */
+  edit_storefront?: boolean;
+  /**
+   * Flags to associate additional info
+   */
+  flags?: string[];
+  /**
+   * Optional notes with additional info about this user
+   */
+  notes?: string;
+}