@cloudcommerce/api 0.0.2 → 0.0.3

package/.turbo/turbo-build.log

@@ -1,5 +1,8 @@
-@cloudcommerce/api:build: cache hit, replaying output 77c93922e43c4ac3
+@cloudcommerce/api:build: cache hit, replaying output c6ecc3b3745374a3
 @cloudcommerce/api:build: 
-@cloudcommerce/api:build: > @cloudcommerce/api@0.0.2-alpha.0 build /home/leo/code/ecomplus/cloud-commerce/packages/api
-@cloudcommerce/api:build: > tsc --build
+@cloudcommerce/api:build: > @cloudcommerce/api@0.0.2 build /home/leo/code/ecomplus/cloud-commerce/packages/api
+@cloudcommerce/api:build: > zx scripts/build.mjs
 @cloudcommerce/api:build: 
+@cloudcommerce/api:build: $ rm -rf dist
+@cloudcommerce/api:build: $ tsc -p ../../tsconfig.json --outDir dist --declaration
+@cloudcommerce/api:build: $ cp -r src/types dist/

package/.turbo/turbo-test.log

@@ -0,0 +1,5 @@
+@cloudcommerce/api:test: cache hit, replaying output 8753ebb5d2a206b8
+@cloudcommerce/api:test: 
+@cloudcommerce/api:test: > @cloudcommerce/api@0.0.2 test /home/leo/code/ecomplus/cloud-commerce/packages/api
+@cloudcommerce/api:test: > tsc --noEmit --noImplicitAny
+@cloudcommerce/api:test: 

package/dist/index.d.ts

@@ -0,0 +1,65 @@
+import type { Endpoint, Config, ResponseBody } from './types';
+declare const def: {
+    middleware(config: Config): string;
+};
+declare const setMiddleware: (middleware: (config: Config) => string) => void;
+declare const callApi: {
+    <T extends Config>(config: T): Promise<Response & {
+        config: Config;
+        data: ResponseBody<T>;
+    }>;
+    get: (endpoint: Endpoint, config: Exclude<Config, 'method'>) => Promise<Response & {
+        config: Config;
+        data: any;
+    }>;
+    post: (endpoint: Endpoint, config: Exclude<Config, 'method'>) => Promise<Response & {
+        config: Config;
+        data: {
+            _id: string & {
+                length: 24;
+            };
+        };
+    }>;
+    put: (endpoint: Endpoint, config: Exclude<Config, 'method'>) => Promise<Response & {
+        config: Config;
+        data: null;
+    }>;
+    patch: (endpoint: Endpoint, config: Exclude<Config, 'method'>) => Promise<Response & {
+        config: Config;
+        data: null;
+    }>;
+    del: (endpoint: Endpoint, config: Exclude<Config, 'method'>) => Promise<Response & {
+        config: Config;
+        data: null;
+    }>;
+    delete: (endpoint: Endpoint, config: Exclude<Config, 'method'>) => Promise<Response & {
+        config: Config;
+        data: null;
+    }>;
+};
+declare const get: (endpoint: Endpoint, config: Exclude<Config, 'method'>) => Promise<Response & {
+    config: Config;
+    data: any;
+}>;
+declare const post: (endpoint: Endpoint, config: Exclude<Config, 'method'>) => Promise<Response & {
+    config: Config;
+    data: {
+        _id: string & {
+            length: 24;
+        };
+    };
+}>;
+declare const put: (endpoint: Endpoint, config: Exclude<Config, 'method'>) => Promise<Response & {
+    config: Config;
+    data: null;
+}>;
+declare const patch: (endpoint: Endpoint, config: Exclude<Config, 'method'>) => Promise<Response & {
+    config: Config;
+    data: null;
+}>;
+declare const del: (endpoint: Endpoint, config: Exclude<Config, 'method'>) => Promise<Response & {
+    config: Config;
+    data: null;
+}>;
+export default callApi;
+export { setMiddleware, get, post, put, patch, del, };

package/dist/index.js

@@ -3,62 +3,80 @@ const env = (typeof window === 'object' && window)
     || (typeof process === 'object' && process && process.env)
     || {};
 const def = {
-    middleware(options) {
-        let url = options.baseUrl || env.API_BASE_URL || 'https://ecomplus.io/v2';
+    middleware(config) {
+        let url = config.baseUrl || env.API_BASE_URL || 'https://ecomplus.io/v2';
         if (!url) {
-            const storeId = options.storeId || env.ECOM_STORE_ID;
+            const storeId = config.storeId || env.ECOM_STORE_ID;
             if (!storeId) {
-                throw new Error('`storeId` must be set in options or `ECOM_STORE_ID` env var');
+                throw new Error('`storeId` must be set in config or `ECOM_STORE_ID` env var');
             }
             url += `/:${storeId}`;
-            const lang = options.lang || env.ECOM_LANG;
+            const lang = config.lang || env.ECOM_LANG;
             if (lang) {
                 url += `,lang:${lang}`;
             }
         }
-        if (options.params) {
-            if (typeof options.params === 'string') {
-                url += `?${options.params}`;
+        if (config.params) {
+            if (typeof config.params === 'string') {
+                url += `?${config.params}`;
             }
             else {
                 // https://github.com/microsoft/TypeScript/issues/32951
-                url += `?${new URLSearchParams(options.params)}`;
+                url += `?${new URLSearchParams(config.params)}`;
             }
         }
-        return `${url}/${options.endpoint}`;
+        return `${url}/${config.endpoint}`;
     },
 };
 // eslint-disable-next-line no-unused-vars
 const setMiddleware = (middleware) => {
     def.middleware = middleware;
 };
-const callApi = (options) => {
-    const url = def.middleware(options);
-    const { method, headers } = options;
-    return fetch(url, { method, headers });
+const callApi = 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;
+    throw error;
 };
-const get = (endpoint, options) => callApi({
-    ...options,
+const get = (endpoint, config) => callApi({
+    ...config,
     method: 'get',
     endpoint,
 });
-const post = (endpoint, options) => callApi({
-    ...options,
+const post = (endpoint, config) => callApi({
+    ...config,
     method: 'post',
     endpoint,
 });
-const put = (endpoint, options) => callApi({
-    ...options,
+const put = (endpoint, config) => callApi({
+    ...config,
     method: 'put',
     endpoint,
 });
-const patch = (endpoint, options) => callApi({
-    ...options,
+const patch = (endpoint, config) => callApi({
+    ...config,
     method: 'patch',
     endpoint,
 });
-const del = (endpoint, options) => callApi({
-    ...options,
+const del = (endpoint, config) => callApi({
+    ...config,
     method: 'delete',
     endpoint,
 });

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAyBA,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,OAAmB;QAC5B,IAAI,GAAG,GAAG,OAAO,CAAC,OAAO,IAAI,GAAG,CAAC,YAAY,IAAI,wBAAwB,CAAC;QAC1E,IAAI,CAAC,GAAG,EAAE;YACR,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,GAAG,CAAC,aAAa,CAAC;YACrD,IAAI,CAAC,OAAO,EAAE;gBACZ,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAC;aAChF;YACD,GAAG,IAAI,KAAK,OAAO,EAAE,CAAC;YACtB,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,GAAG,CAAC,SAAS,CAAC;YAC3C,IAAI,IAAI,EAAE;gBACR,GAAG,IAAI,SAAS,IAAI,EAAE,CAAC;aACxB;SACF;QACD,IAAI,OAAO,CAAC,MAAM,EAAE;YAClB,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,QAAQ,EAAE;gBACtC,GAAG,IAAI,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;aAC7B;iBAAM;gBACL,uDAAuD;gBACvD,GAAG,IAAI,IAAI,IAAI,eAAe,CAAC,OAAO,CAAC,MAAgC,CAAC,EAAE,CAAC;aAC5E;SACF;QACD,OAAO,GAAG,GAAG,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;IACtC,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,OAAO,GAAG,CAAC,OAAmB,EAAE,EAAE;IACtC,MAAM,GAAG,GAAG,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IACpC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IACpC,OAAO,KAAK,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;AACzC,CAAC,CAAC;AAEF,MAAM,GAAG,GAAG,CAAC,QAAkB,EAAE,OAAsC,EAAE,EAAE,CAAC,OAAO,CAAC;IAClF,GAAG,OAAO;IACV,MAAM,EAAE,KAAK;IACb,QAAQ;CACT,CAAC,CAAC;AAEH,MAAM,IAAI,GAAG,CAAC,QAAkB,EAAE,OAAsC,EAAE,EAAE,CAAC,OAAO,CAAC;IACnF,GAAG,OAAO;IACV,MAAM,EAAE,MAAM;IACd,QAAQ;CACT,CAAC,CAAC;AAEH,MAAM,GAAG,GAAG,CAAC,QAAkB,EAAE,OAAsC,EAAE,EAAE,CAAC,OAAO,CAAC;IAClF,GAAG,OAAO;IACV,MAAM,EAAE,KAAK;IACb,QAAQ;CACT,CAAC,CAAC;AAEH,MAAM,KAAK,GAAG,CAAC,QAAkB,EAAE,OAAsC,EAAE,EAAE,CAAC,OAAO,CAAC;IACpF,GAAG,OAAO;IACV,MAAM,EAAE,OAAO;IACf,QAAQ;CACT,CAAC,CAAC;AAEH,MAAM,GAAG,GAAG,CAAC,QAAkB,EAAE,OAAsC,EAAE,EAAE,CAAC,OAAO,CAAC;IAClF,GAAG,OAAO;IACV,MAAM,EAAE,QAAQ;IAChB,QAAQ;CACT,CAAC,CAAC;AAEH,OAAO,CAAC,GAAG,GAAG,GAAG,CAAC;AAClB,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;AACpB,OAAO,CAAC,GAAG,GAAG,GAAG,CAAC;AAClB,OAAO,CAAC,KAAK,GAAG,KAAK,CAAC;AACtB,OAAO,CAAC,GAAG,GAAG,GAAG,CAAC;AAClB,OAAO,CAAC,MAAM,GAAG,GAAG,CAAC;AAErB,eAAe,OAAO,CAAC;AAEvB,OAAO,EACL,aAAa,EACb,GAAG,EACH,IAAI,EACJ,GAAG,EACH,KAAK,EACL,GAAG,GACJ,CAAC"}
+{"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,IAAI,CAAC,GAAG,EAAE;YACR,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,IAAI,GAAG,CAAC,aAAa,CAAC;YACpD,IAAI,CAAC,OAAO,EAAE;gBACZ,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;aAC/E;YACD,GAAG,IAAI,KAAK,OAAO,EAAE,CAAC;YACtB,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,IAAI,GAAG,CAAC,SAAS,CAAC;YAC1C,IAAI,IAAI,EAAE;gBACR,GAAG,IAAI,SAAS,IAAI,EAAE,CAAC;aACxB;SACF;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,OAAO,GAAG,KAAK,EAAoB,MAAS,EAG/C,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,MAAM,KAAK,CAAC;AACd,CAAC,CAAC;AAEF,MAAM,GAAG,GAAG,CAAC,QAAkB,EAAE,MAAiC,EAAE,EAAE,CAAC,OAAO,CAAC;IAC7E,GAAG,MAAM;IACT,MAAM,EAAE,KAAK;IACb,QAAQ;CACT,CAAC,CAAC;AAEH,MAAM,IAAI,GAAG,CAAC,QAAkB,EAAE,MAAiC,EAAE,EAAE,CAAC,OAAO,CAAC;IAC9E,GAAG,MAAM;IACT,MAAM,EAAE,MAAM;IACd,QAAQ;CACT,CAAC,CAAC;AAEH,MAAM,GAAG,GAAG,CAAC,QAAkB,EAAE,MAAiC,EAAE,EAAE,CAAC,OAAO,CAAC;IAC7E,GAAG,MAAM;IACT,MAAM,EAAE,KAAK;IACb,QAAQ;CACT,CAAC,CAAC;AAEH,MAAM,KAAK,GAAG,CAAC,QAAkB,EAAE,MAAiC,EAAE,EAAE,CAAC,OAAO,CAAC;IAC/E,GAAG,MAAM;IACT,MAAM,EAAE,OAAO;IACf,QAAQ;CACT,CAAC,CAAC;AAEH,MAAM,GAAG,GAAG,CAAC,QAAkB,EAAE,MAAiC,EAAE,EAAE,CAAC,OAAO,CAAC;IAC7E,GAAG,MAAM;IACT,MAAM,EAAE,QAAQ;IAChB,QAAQ;CACT,CAAC,CAAC;AAEH,OAAO,CAAC,GAAG,GAAG,GAAG,CAAC;AAClB,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;AACpB,OAAO,CAAC,GAAG,GAAG,GAAG,CAAC;AAClB,OAAO,CAAC,KAAK,GAAG,KAAK,CAAC;AACtB,OAAO,CAAC,GAAG,GAAG,GAAG,CAAC;AAClB,OAAO,CAAC,MAAM,GAAG,GAAG,CAAC;AAErB,eAAe,OAAO,CAAC;AAEvB,OAAO,EACL,aAAa,EACb,GAAG,EACH,IAAI,EACJ,GAAG,EACH,KAAK,EACL,GAAG,GACJ,CAAC"}

package/dist/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/dist/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;
+}

package/dist/types/brands.d.ts

@@ -0,0 +1,148 @@
+/* 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;
+  created_at: string;
+  updated_at: string;
+  store_id: number;
+  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
+   */
+  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
+   */
+  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
+   */
+  flags?: string[];
+  /**
+   * Optional notes with additional info about this brand
+   */
+  notes?: string;
+}