cloudcommerce 0.0.2 → 0.0.5

package/{.eslintrc.js → .eslintrc.cjs}

@@ -1,7 +1,7 @@
 module.exports = {
   env: {
     browser: true,
-    es2021: true,
+    es2020: true,
     node: true,
   },
   extends: [
@@ -9,7 +9,7 @@ module.exports = {
     'airbnb-base',
   ],
   parserOptions: {
-    ecmaVersion: 12,
+    ecmaVersion: 2020,
     parser: '@typescript-eslint/parser',
     sourceType: 'module',
   },
@@ -21,10 +21,10 @@ module.exports = {
     '**/dist',
   ],
   rules: {
-    'no-param-reassign': 'warn',
     'no-await-in-loop': 'warn',
     'no-shadow': 'warn',
-    'no-underscore-dangle': 'warn',
+    'no-param-reassign': 'warn',
+    'no-underscore-dangle': 'off',
     'no-continue': 'off',
     'import/extensions': [
       'error',

package/.github/renovate.json

@@ -8,5 +8,6 @@
   "labels": [
     "dependencies"
   ],
-  "dependencyDashboard": false
+  "dependencyDashboard": false,
+  "ignoreDeps": ["node", "pnpm"]
 }

package/CHANGELOG.md

@@ -2,6 +2,40 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [0.0.5](https://github.com/ecomplus/cloud-commerce/compare/v0.0.4...v0.0.5) (2022-06-16)
+
+
+### Features
+
+* **api:** Error object (not 2xx) includes `statusCode` property (as Fastify errors) ([a9681f2](https://github.com/ecomplus/cloud-commerce/commit/a9681f23ceb9b007f90e95351ca133fdac865f1b))
+
+
+### Bug Fixes
+
+* **api:** Config object is optional on abstracted method functions ([2eebbe7](https://github.com/ecomplus/cloud-commerce/commit/2eebbe771971b5ac87b85f6068a36d7e1f647aba))
+* **api:** Resolve with resource type on read without method (get is default) ([52b1a9b](https://github.com/ecomplus/cloud-commerce/commit/52b1a9b7cb48210b155ac620eaa6b3c8d95d681e))
+
+### [0.0.4](https://github.com/ecomplus/cloud-commerce/compare/v0.0.3...v0.0.4) (2022-06-15)
+
+
+### Bug Fixes
+
+* **api:** Fix adding `:storeId` to default API base URL ([d424760](https://github.com/ecomplus/cloud-commerce/commit/d4247602168078acc0b05f5d1bbf5980f636bd71))
+* **api:** No `procedures` and `triggers` resources on Store API v2 (remove from default types) ([66281d4](https://github.com/ecomplus/cloud-commerce/commit/66281d41f25a707fabda2233d2404724ba6b53f4))
+
+### [0.0.3](https://github.com/ecomplus/cloud-commerce/compare/v0.0.2...v0.0.3) (2022-06-14)
+
+
+### Features
+
+* **api:** Add `timeout` req option with 20s default ([9544225](https://github.com/ecomplus/cloud-commerce/commit/954422567d1e77c95522e7c02758cb4fda6cbfd0))
+* **api:** Set response body type for each resource on read by id ([7330537](https://github.com/ecomplus/cloud-commerce/commit/733053770cd62a7f07ee6753e06b461e168e25da))
+
+
+### Bug Fixes
+
+* **api:** Fix success payload with full fetch response object ([083b51d](https://github.com/ecomplus/cloud-commerce/commit/083b51da0864c040b323b26d5635b574bbbb26bf))
+
 ### [0.0.2](https://github.com/ecomplus/cloud-commerce/compare/v0.0.2-alpha.0...v0.0.2) (2022-06-11)
 
 ### [0.0.2-alpha.0](https://github.com/ecomplus/cloud-commerce/compare/v1.0.0-alpha.8...v0.0.2-alpha.0) (2022-06-11)

package/README.md

@@ -1,11 +1,11 @@
 # E-Com Plus Open Cloud Commerce
 
 Open fair-code eCommerce platform to use on top of headless commerce APIs, it includes:
-- High performant Astro PWA & Jamstack storefront;
+- High performant [Astro](https://astro.build/) + [Vue](https://vuejs.org/) PWA & Jamstack storefront;
 - Storefront CMS and page builder;
 - Integrations for payments, shipping, ERPs, CRMs and others.
 
-Easy deployment on Firebase, plug & play with [E-Com Plus APIs](https://developers.e-com.plus/).
+Easy deployment on [Firebase](https://firebase.google.com/), plug & play with **[E-Com Plus APIs](https://developers.e-com.plus/)**.
 
 ## Concepts
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cloudcommerce",
-  "version": "0.0.2",
+  "version": "0.0.5",
   "description": "Open fair-code headless commerce platform: API-first, microservices based, event driven and cloud native",
   "main": "src/index.js",
   "author": "E-Com Club Softwares para E-commerce <ti@e-com.club>",
@@ -12,7 +12,8 @@
   "scripts": {
     "postinstall": "husky install",
     "build": "turbo run build",
-    "release": "pnpm build && standard-version --commit-all",
+    "test": "turbo run test",
+    "release": "pnpm build && pnpm test && standard-version --commit-all",
     "postpublish": "zx scripts/release.mjs --publish"
   },
   "standard-version": {
@@ -24,18 +25,21 @@
     "@commitlint/cli": "^17.0.2",
     "@commitlint/config-conventional": "^17.0.2",
     "@commitlint/rules": "^17.0.0",
-    "@types/node": "^17.0.41",
-    "@typescript-eslint/eslint-plugin": "^5.27.1",
-    "@typescript-eslint/parser": "^5.27.1",
+    "@types/node": "^17.0.42",
+    "@typescript-eslint/eslint-plugin": "^5.28.0",
+    "@typescript-eslint/parser": "^5.28.0",
     "esbuild": "^0.14.43",
     "eslint": "^8.17.0",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-vue": "^9.1.0",
+    "eslint-plugin-vue": "^9.1.1",
     "husky": "^8.0.1",
+    "node-fetch": "^3.2.6",
     "standard-version": "^9.5.0",
     "turbo": "^1.2.16",
     "typescript": "^4.7.3",
-    "zx": "^6.2.4"
+    "vite": "^2.9.12",
+    "vitest": "^0.15.1",
+    "zx": "^6.2.5"
   }
 }

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

@@ -0,0 +1,134 @@
+import type { Endpoint, Config, ResponseBody } from './types';
+declare const def: {
+    middleware(config: Config): string;
+};
+declare const setMiddleware: (middleware: (config: Config) => string) => void;
+declare const api: {
+    <T extends Config>(config: T): Promise<Response & {
+        config: Config;
+        data: ResponseBody<T>;
+    }>;
+    get: <E extends Endpoint, C extends AbstractedConfig>(endpoint: E, config?: C | undefined) => Promise<Response & {
+        config: Config;
+        data: {
+            endpoint: E;
+        } extends infer T_1 ? T_1 extends {
+            endpoint: E;
+        } ? T_1 extends Config & {
+            method?: "get" | undefined;
+            endpoint: `products/${string}`;
+        } ? import("./types").Products : T_1 extends Config & {
+            method?: "get" | undefined;
+            endpoint: `categories/${string}`;
+        } ? import("./types").Categories : T_1 extends Config & {
+            method?: "get" | undefined;
+            endpoint: `brands/${string}`;
+        } ? import("./types").Brands : T_1 extends Config & {
+            method?: "get" | undefined;
+            endpoint: `collections/${string}`;
+        } ? import("./types").Collections : T_1 extends Config & {
+            method?: "get" | undefined;
+            endpoint: `grids/${string}`;
+        } ? import("./types").Grids : T_1 extends Config & {
+            method?: "get" | undefined;
+            endpoint: `carts/${string}`;
+        } ? import("./types").Carts : T_1 extends Config & {
+            method?: "get" | undefined;
+            endpoint: `orders/${string}`;
+        } ? import("./types").Orders : T_1 extends Config & {
+            method?: "get" | undefined;
+            endpoint: `customers/${string}`;
+        } ? import("./types").Customers : T_1 extends Config & {
+            method?: "get" | undefined;
+            endpoint: `stores/${string}`;
+        } ? import("./types").Stores : T_1 extends Config & {
+            method?: "get" | undefined;
+            endpoint: `applications/${string}`;
+        } ? import("./types").Applications : any : never : never;
+    }>;
+    post: (endpoint: Endpoint, config?: AbstractedConfig) => Promise<Response & {
+        config: Config;
+        data: {
+            _id: string & {
+                length: 24;
+            };
+        };
+    }>;
+    put: (endpoint: Endpoint, config?: AbstractedConfig) => Promise<Response & {
+        config: Config;
+        data: null;
+    }>;
+    patch: (endpoint: Endpoint, config?: AbstractedConfig) => Promise<Response & {
+        config: Config;
+        data: null;
+    }>;
+    del: (endpoint: Endpoint, config?: AbstractedConfig) => Promise<Response & {
+        config: Config;
+        data: null;
+    }>;
+    delete: (endpoint: Endpoint, config?: AbstractedConfig) => Promise<Response & {
+        config: Config;
+        data: null;
+    }>;
+};
+declare type AbstractedConfig = Omit<Config, 'endpoint' | 'method'>;
+declare const get: <E extends Endpoint, C extends AbstractedConfig>(endpoint: E, config?: C | undefined) => Promise<Response & {
+    config: Config;
+    data: {
+        endpoint: E;
+    } extends infer T_1 ? T_1 extends {
+        endpoint: E;
+    } ? T_1 extends Config & {
+        method?: "get" | undefined;
+        endpoint: `products/${string}`;
+    } ? import("./types").Products : T_1 extends Config & {
+        method?: "get" | undefined;
+        endpoint: `categories/${string}`;
+    } ? import("./types").Categories : T_1 extends Config & {
+        method?: "get" | undefined;
+        endpoint: `brands/${string}`;
+    } ? import("./types").Brands : T_1 extends Config & {
+        method?: "get" | undefined;
+        endpoint: `collections/${string}`;
+    } ? import("./types").Collections : T_1 extends Config & {
+        method?: "get" | undefined;
+        endpoint: `grids/${string}`;
+    } ? import("./types").Grids : T_1 extends Config & {
+        method?: "get" | undefined;
+        endpoint: `carts/${string}`;
+    } ? import("./types").Carts : T_1 extends Config & {
+        method?: "get" | undefined;
+        endpoint: `orders/${string}`;
+    } ? import("./types").Orders : T_1 extends Config & {
+        method?: "get" | undefined;
+        endpoint: `customers/${string}`;
+    } ? import("./types").Customers : T_1 extends Config & {
+        method?: "get" | undefined;
+        endpoint: `stores/${string}`;
+    } ? import("./types").Stores : T_1 extends Config & {
+        method?: "get" | undefined;
+        endpoint: `applications/${string}`;
+    } ? import("./types").Applications : any : never : never;
+}>;
+declare const post: (endpoint: Endpoint, config?: AbstractedConfig) => Promise<Response & {
+    config: Config;
+    data: {
+        _id: string & {
+            length: 24;
+        };
+    };
+}>;
+declare const put: (endpoint: Endpoint, config?: AbstractedConfig) => Promise<Response & {
+    config: Config;
+    data: null;
+}>;
+declare const patch: (endpoint: Endpoint, config?: AbstractedConfig) => Promise<Response & {
+    config: Config;
+    data: null;
+}>;
+declare const del: (endpoint: Endpoint, config?: AbstractedConfig) => Promise<Response & {
+    config: Config;
+    data: null;
+}>;
+export default api;
+export { setMiddleware, get, post, put, patch, del, };

package/packages/api/lib/index.js

@@ -0,0 +1,89 @@
+// @ts-ignore
+const env = (typeof window === 'object' && window)
+    || (typeof process === 'object' && process && process.env)
+    || {};
+const def = {
+  middleware(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');
+    }
+    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(config.params)}`;
+      }
+    }
+    return `${url}/${config.endpoint}`;
+  },
+};
+// eslint-disable-next-line no-unused-vars
+const setMiddleware = (middleware) => {
+  def.middleware = middleware;
+};
+const api = async (config) => {
+  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 = new Error(response.statusText);
+  error.config = config;
+  error.response = response;
+  error.statusCode = response.status;
+  throw error;
+};
+const get = (endpoint, config) => api({ ...config, endpoint });
+const post = (endpoint, config) => api({
+  ...config,
+  method: 'post',
+  endpoint,
+});
+const put = (endpoint, config) => api({
+  ...config,
+  method: 'put',
+  endpoint,
+});
+const patch = (endpoint, config) => api({
+  ...config,
+  method: 'patch',
+  endpoint,
+});
+const del = (endpoint, config) => api({
+  ...config,
+  method: 'delete',
+  endpoint,
+});
+api.get = get;
+api.post = post;
+api.put = put;
+api.patch = patch;
+api.del = del;
+api.delete = del;
+
+export default api;
+
+export {
+  setMiddleware, get, post, put, patch, del,
+};
+// # sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,aAAa;AACb,MAAM,GAAG,GAA8B,CAAC,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC;OACxE,CAAC,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC;OACvD,EAAE,CAAC;AAER,MAAM,GAAG,GAAG;IACV,UAAU,CAAC,MAAc;QACvB,IAAI,GAAG,GAAG,MAAM,CAAC,OAAO,IAAI,GAAG,CAAC,YAAY,IAAI,wBAAwB,CAAC;QACzE,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,IAAI,GAAG,CAAC,aAAa,CAAC;QACpD,IAAI,CAAC,OAAO,EAAE;YACZ,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;SAC/E;QACD,GAAG,IAAI,KAAK,OAAO,EAAE,CAAC;QACtB,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,IAAI,GAAG,CAAC,SAAS,CAAC;QAC1C,IAAI,IAAI,EAAE;YACR,GAAG,IAAI,SAAS,IAAI,EAAE,CAAC;SACxB;QACD,IAAI,MAAM,CAAC,MAAM,EAAE;YACjB,IAAI,OAAO,MAAM,CAAC,MAAM,KAAK,QAAQ,EAAE;gBACrC,GAAG,IAAI,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;aAC5B;iBAAM;gBACL,uDAAuD;gBACvD,GAAG,IAAI,IAAI,IAAI,eAAe,CAAC,MAAM,CAAC,MAAgC,CAAC,EAAE,CAAC;aAC3E;SACF;QACD,OAAO,GAAG,GAAG,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;IACrC,CAAC;CACF,CAAC;AAEF,0CAA0C;AAC1C,MAAM,aAAa,GAAG,CAAC,UAAiC,EAAE,EAAE;IAC1D,GAAG,CAAC,UAAU,GAAG,UAAU,CAAC;AAC9B,CAAC,CAAC;AAEF,MAAM,GAAG,GAAG,KAAK,EAAoB,MAAS,EAG3C,EAAE;IACH,MAAM,GAAG,GAAG,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IACnC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;IACpD,MAAM,eAAe,GAAG,IAAI,eAAe,EAAE,CAAC;IAC9C,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,eAAe,CAAC,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IACjE,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;QAChC,MAAM;QACN,OAAO;QACP,MAAM,EAAE,eAAe,CAAC,MAAM;KAC/B,CAAC,CAAC;IACH,YAAY,CAAC,KAAK,CAAC,CAAC;IACpB,IAAI,QAAQ,CAAC,EAAE,EAAE;QACf,OAAO;YACL,GAAG,QAAQ;YACX,MAAM;YACN,IAAI,EAAE,MAAM,QAAQ,CAAC,IAAI,EAAE;SAC5B,CAAC;KACH;IACD,MAAM,KAAK,GAAQ,IAAI,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;IAClD,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC;IACtB,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC1B,KAAK,CAAC,UAAU,GAAG,QAAQ,CAAC,MAAM,CAAC;IACnC,MAAM,KAAK,CAAC;AACd,CAAC,CAAC;AAIF,MAAM,GAAG,GAAG,CACV,QAAW,EACX,MAAU,EAIT,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;AAEnC,MAAM,IAAI,GAAG,CAAC,QAAkB,EAAE,MAAyB,EAAE,EAAE,CAAC,GAAG,CAAC;IAClE,GAAG,MAAM;IACT,MAAM,EAAE,MAAM;IACd,QAAQ;CACT,CAAC,CAAC;AAEH,MAAM,GAAG,GAAG,CAAC,QAAkB,EAAE,MAAyB,EAAE,EAAE,CAAC,GAAG,CAAC;IACjE,GAAG,MAAM;IACT,MAAM,EAAE,KAAK;IACb,QAAQ;CACT,CAAC,CAAC;AAEH,MAAM,KAAK,GAAG,CAAC,QAAkB,EAAE,MAAyB,EAAE,EAAE,CAAC,GAAG,CAAC;IACnE,GAAG,MAAM;IACT,MAAM,EAAE,OAAO;IACf,QAAQ;CACT,CAAC,CAAC;AAEH,MAAM,GAAG,GAAG,CAAC,QAAkB,EAAE,MAAyB,EAAE,EAAE,CAAC,GAAG,CAAC;IACjE,GAAG,MAAM;IACT,MAAM,EAAE,QAAQ;IAChB,QAAQ;CACT,CAAC,CAAC;AAEH,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC;AACd,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC;AAChB,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC;AACd,GAAG,CAAC,KAAK,GAAG,KAAK,CAAC;AAClB,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC;AACd,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC;AAEjB,eAAe,GAAG,CAAC;AAEnB,OAAO,EACL,aAAa,EACb,GAAG,EACH,IAAI,EACJ,GAAG,EACH,KAAK,EACL,GAAG,GACJ,CAAC"}

package/packages/api/lib/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/lib/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;
+}