@cloudcommerce/api 1.0.0-alpha.8 → 2.0.1

package/src/api.ts

@@ -0,0 +1,298 @@
+import type {
+  ResourceOpQuery,
+  Endpoint,
+  Config,
+  ResponseBody,
+  RequestBody,
+  ErrorBody,
+} from '../types.d';
+
+declare global {
+  /* eslint-disable no-var, vars-on-top */
+  // @ts-ignore
+  var $apiMergeConfig: Partial<Config> | undefined;
+  // eslint-disable-next-line
+  var __apiCache: Record<string, {
+    timestamp: number,
+    res: Response & { data: any },
+  }>;
+  /* eslint-enable no-var */
+}
+if (!globalThis.__apiCache) {
+  globalThis.__apiCache = {};
+}
+
+const _env = (
+  (typeof process === 'object' && process?.env)
+  || globalThis
+) as Record<string, any>;
+
+class ApiError extends Error {
+  config: Config;
+  response?: Response & { data?: ErrorBody };
+  statusCode?: number;
+  data?: ErrorBody;
+  isTimeout: boolean;
+  constructor(
+    config: Config,
+    response?: ApiError['response'],
+    msg?: string,
+    isTimeout: boolean = false,
+  ) {
+    if (response) {
+      super(response.statusText);
+      this.data = response.data;
+      this.statusCode = response.status;
+    } else {
+      super(msg || 'Request error');
+    }
+    this.config = config;
+    this.response = response;
+    this.isTimeout = isTimeout;
+  }
+}
+
+const def = {
+  middleware(config: Config) {
+    const headers: Headers | Record<string, string> = { ...config.headers };
+    if (!config.isNoAuth) {
+      if (config.accessToken) {
+        // eslint-disable-next-line dot-notation
+        headers['Authorization'] = `Bearer ${config.accessToken}`;
+      } else {
+        const authenticationId = config.authenticationId || _env.ECOM_AUTHENTICATION_ID;
+        const apiKey = config.apiKey || _env.ECOM_API_KEY;
+        if (authenticationId && apiKey) {
+          const rawAuth = `${authenticationId}:${apiKey}`;
+          const base64Auth = typeof Buffer === 'function'
+            ? Buffer.from(rawAuth).toString('base64') : btoa(rawAuth);
+          // eslint-disable-next-line dot-notation
+          headers['Authorization'] = `Basic ${base64Auth}`;
+        }
+      }
+    }
+    let url = config.baseUrl || _env.API_BASE_URL || 'https://ecomplus.io/v2';
+    const { endpoint, params } = config;
+    if (
+      endpoint !== 'login'
+      && endpoint !== 'authenticate'
+      && endpoint !== 'ask-auth-callback'
+      && endpoint !== 'check-username'
+    ) {
+      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}`;
+      }
+    }
+    url += `/${endpoint}`;
+    if (typeof params === 'string') {
+      url += `?${params}`;
+    } else {
+      const paramsObj: Exclude<typeof params, string> = params || {};
+      (['fields', 'sort'] as const)
+        .forEach((param) => {
+          const value = config[param];
+          if (value && !paramsObj[param]) {
+            paramsObj[param] = value.join(',');
+          }
+        });
+      (['limit', 'offset', 'count', 'buckets', 'concise', 'verbose'] as const)
+        .forEach((param) => {
+          const value = config[param];
+          if (value && !paramsObj[param]) {
+            paramsObj[param] = value;
+          }
+        });
+      if (Object.keys(paramsObj).length) {
+        const searchParams = new URLSearchParams();
+        Object.keys(paramsObj).forEach((key) => {
+          const values = paramsObj[key];
+          if (Array.isArray(values)) {
+            values.forEach((value: string | number) => {
+              // https://github.com/microsoft/TypeScript/issues/32951
+              searchParams.append(key, value as string);
+            });
+          } else if (values !== undefined) {
+            searchParams.append(key, values as string);
+          }
+        });
+        url += `?${searchParams.toString()}`;
+      }
+    }
+    return { url, headers };
+  },
+};
+
+const setMiddleware = (middleware: typeof def.middleware) => {
+  def.middleware = middleware;
+};
+
+const api = async <T extends Config & { body?: any, data?: any }>(
+  requestConfig: T,
+  _retries = 0,
+): Promise<Response & {
+  config: Config,
+  data: ResponseBody<T>,
+}> => {
+  const config = globalThis.$apiMergeConfig
+    ? { ...globalThis.$apiMergeConfig, ...requestConfig }
+    : requestConfig;
+  const { url, headers } = def.middleware(config);
+  const {
+    method = 'get',
+    timeout = 20000,
+    maxRetries = 3,
+    cacheMaxAge = 600000, // 10 minutes
+  } = config;
+  const canCache = method === 'get' && config.canCache;
+  let cacheKey: string | undefined;
+  if (canCache) {
+    cacheKey = `${url}${JSON.stringify(headers)}`;
+    const cached = globalThis.__apiCache[cacheKey];
+    if (cached && Date.now() - cached.timestamp <= cacheMaxAge) {
+      return { ...cached.res, config };
+    }
+  }
+  const bodyObject = config.body || config.data;
+  let body: string | undefined;
+  if (bodyObject) {
+    body = JSON.stringify(bodyObject);
+    headers['Content-Type'] = 'application/json';
+  }
+
+  const abortController = new AbortController();
+  let isTimeout = false;
+  const timer = setTimeout(() => {
+    abortController.abort();
+    isTimeout = true;
+  }, timeout);
+  let response: Response & { data?: any } | undefined;
+  try {
+    response = await (config.fetch || fetch)(url, {
+      method,
+      headers,
+      body,
+      signal: abortController.signal,
+    });
+  } catch (err: any) {
+    let msg = err.message;
+    if (err.cause) {
+      msg += ` - ${err.cause}`;
+    }
+    throw new ApiError(config, response, msg, isTimeout);
+  }
+  clearTimeout(timer);
+
+  if (response) {
+    if (response.ok) {
+      const res = {
+        ...response,
+        data: await response.json(),
+      };
+      if (canCache && cacheKey) {
+        globalThis.__apiCache[cacheKey] = {
+          timestamp: Date.now(),
+          res,
+        };
+      }
+      return { ...res, config };
+    }
+    const { status } = response;
+    if (maxRetries < _retries && (status === 429 || status >= 500)) {
+      const retryAfter = response.headers.get('retry-after');
+      return new Promise((resolve, reject) => {
+        setTimeout(() => {
+          api(requestConfig, _retries + 1).then(resolve).catch(reject);
+        }, (retryAfter && parseInt(retryAfter, 10) * 1000) || 5000);
+      });
+    }
+  }
+  try {
+    response.data = await response?.json() as ErrorBody;
+  } catch (e) {
+    //
+  }
+  throw new ApiError(config, response);
+};
+
+type AbstractedConfig = Omit<Config, 'endpoint' | 'method'>;
+
+const get = <E extends Endpoint, C extends AbstractedConfig>(
+  endpoint: E,
+  config?: C,
+): Promise<Response & {
+  config: Config,
+  data: ResponseBody<C & { endpoint: E }>,
+}> => {
+  // @ts-ignore
+  return api({ ...config, endpoint });
+};
+
+const post = <E extends Endpoint, C extends AbstractedConfig>(
+  endpoint: E,
+  body: RequestBody<{ endpoint: E, method: 'post' }>,
+  config?: E extends 'login' | 'authenticate' ? AbstractedConfig : C,
+) => {
+  return api({
+    ...config,
+    method: 'post',
+    endpoint,
+    body,
+  });
+};
+
+const put = <E extends Exclude<Endpoint, ResourceOpQuery>, C extends AbstractedConfig>(
+  endpoint: E,
+  body: RequestBody<{ endpoint: E, method: 'put' }>,
+  config?: C,
+) => {
+  return api({
+    ...config,
+    method: 'put',
+    endpoint,
+    body,
+  });
+};
+
+const patch = (endpoint: Endpoint, body: any, config?: AbstractedConfig) => api({
+  ...config,
+  method: 'patch',
+  endpoint,
+  body,
+});
+
+const del = (endpoint: Endpoint, config?: AbstractedConfig) => 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,
+  ApiError,
+};
+
+export type ApiEndpoint = Endpoint;
+
+export type ApiConfig = Config;
+
+export type ApiErrorBody = ErrorBody;

package/tests/index.test.ts

@@ -0,0 +1,82 @@
+import { test, expect } from 'vitest';
+import api, { type ApiError } from '../src/api';
+
+const productId = '618041aa239b7206d3fc06de' as string & { length: 24 };
+test('Read product and typecheck SKU', async () => {
+  const { data } = await api({
+    storeId: 1056,
+    endpoint: `products/${productId}`,
+  });
+  if (data.sku === '123') {
+    console.log('\\o/');
+  }
+  expect(data.sku).toBeTypeOf('string');
+  expect(data._id).toBe(productId);
+});
+
+test('404 with different Store ID from env', async () => {
+  process.env.ECOM_STORE_ID = '1011';
+  try {
+    const { data } = await api.get(`products/${productId}`);
+    console.log(data);
+    throw new Error('Should have thrown not found');
+  } catch (err: any) {
+    const error = err as ApiError;
+    expect(error.statusCode).toBe(404);
+    expect(error.response?.status).toBe(404);
+  }
+});
+
+test('List categories and typecheck result', async () => {
+  const { data } = await api.get('categories', {
+    fields: ['name'] as const,
+  });
+  if (!data.result.length) {
+    console.log('Any category found');
+  }
+  expect(Array.isArray(data.result)).toBe(true);
+  expect(data.result[0].name).toBeTypeOf('string');
+  // @ts-ignore
+  expect(data.result[0].slug).toBeTypeOf('undefined');
+  expect(data.meta).toBeTypeOf('object');
+  expect(data.meta.offset).toBeTypeOf('number');
+  const { data: data2 } = await api.get('categories', {
+    limit: 1,
+  });
+  expect(data2.result.length).toBe(1);
+  const { data: data3 } = await api.get('categories', {
+    params: {
+      slug: 'this-slug-doesnt-exists-123',
+    },
+  });
+  expect(data3.result.length).toBe(0);
+});
+
+test('401 trying to list API events', async () => {
+  try {
+    const { data } = await api.get('events/orders');
+    console.log(data);
+    console.log(data.result[0].modified_fields);
+    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);
+  }
+});
+
+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);
+  }
+});

package/tsconfig.json

@@ -1,101 +1,6 @@
 {
+  "extends": "../../tsconfig.json",
   "compilerOptions": {
-    /* Visit https://aka.ms/tsconfig.json to read more about this file */
-
-    /* Projects */
-    // "incremental": true,                              /* Enable incremental compilation */
-    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
-    // "tsBuildInfoFile": "./",                          /* Specify the folder for .tsbuildinfo incremental compilation files. */
-    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects */
-    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
-    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
-
-    /* Language and Environment */
-    "target": "es2021",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
-    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
-    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
-    // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
-    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
-    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
-    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
-    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
-    // "reactNamespace": "",                             /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
-    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
-    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
-
-    /* Modules */
-    "module": "es2020",                                  /* Specify what module code is generated. */
-    // "rootDir": "lib/app/src",                         /* Specify the root folder within your source files. */
-    "moduleResolution": "node",                          /* Specify how TypeScript looks up a file from a given module specifier. */
-    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
-    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
-    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
-    // "typeRoots": ["lib/app/src/@types"],              /* Specify multiple folders that act like `./node_modules/@types`. */
-    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
-    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
-    "resolveJsonModule": true,                           /* Enable importing .json files */
-    // "noResolve": true,                                /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */
-
-    /* JavaScript Support */
-    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
-    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
-    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */
-
-    /* Emit */
-    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
-    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
-    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
-    "sourceMap": true,                                   /* Create source map files for emitted JavaScript files. */
-    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
-    "outDir": "dist",                                    /* Specify an output folder for all emitted files. */
-    "removeComments": false,                             /* Disable emitting comments. */
-    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
-    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
-    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types */
-    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
-    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
-    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
-    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
-    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
-    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
-    "newLine": "lf",                                     /* Set the newline character for emitting files. */
-    // "stripInternal": true,                            /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
-    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like `__extends` in compiled output. */
-    "noEmitOnError": true,                               /* Disable emitting files if any type checking errors are reported. */
-    // "preserveConstEnums": true,                       /* Disable erasing `const enum` declarations in generated code. */
-    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
-    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
-
-    /* Interop Constraints */
-    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
-    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
-    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */
-    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
-    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
-
-    /* Type Checking */
-    "strict": true,                                      /* Enable all strict type-checking options. */
-    "noImplicitAny": false,                              /* Enable error reporting for expressions and declarations with an implied `any` type.. */
-    // "strictNullChecks": true,                         /* When type checking, take into account `null` and `undefined`. */
-    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
-    // "strictBindCallApply": true,                      /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
-    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
-    // "noImplicitThis": true,                           /* Enable error reporting when `this` is given the type `any`. */
-    // "useUnknownInCatchVariables": true,               /* Type catch clause variables as 'unknown' instead of 'any'. */
-    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
-    // "noUnusedLocals": true,                           /* Enable error reporting when a local variables aren't read. */
-    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read */
-    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
-    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
-    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
-    // "noUncheckedIndexedAccess": true,                 /* Include 'undefined' in index signature results */
-    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
-    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type */
-    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
-    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
-
-    /* Completeness */
-    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
-    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+    "declaration": true
   }
 }

package/types/applications.d.ts

@@ -0,0 +1,180 @@
+/* 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.
+ */
+
+/**
+ * Installed API extension app
+ */
+export interface Applications {
+  /**
+   * Application ID (ObjectID) [auto]
+   */
+  _id: string & { length: 24 };
+  /**
+   * When object was seted (POST/PUT), date and time in ISO 8601 standard representation [auto]
+   */
+  created_at: string;
+  /**
+   * When was it last changed, date and time in ISO 8601 standard representation [auto]
+   */
+  updated_at: string;
+  /**
+   * ID of store [auto]
+   */
+  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?: {
+    calculate_shipping?: Module;
+    list_payments?: Module1;
+    apply_discount?: Module2;
+    create_transaction?: Module3;
+    checkout_done?: Module4;
+  };
+  /**
+   * 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;
+    };
+  };
+  /**
+   * Application object data, schema free
+   */
+  data?: {
+    [k: string]: any;
+  };
+  /**
+   * Application private data, available only with authentication
+   */
+  hidden_data?: {
+    [k: string]: any;
+  };
+  /**
+   * Flags to associate additional info
+   *
+   * @maxItems 10
+   */
+  flags?: string[];
+  /**
+   * Optional notes with additional info about this user
+   */
+  notes?: string;
+}
+/**
+ * Triggered to calculate shipping options, must return calculated values and times
+ */
+export interface Module {
+  /**
+   * 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
+ */
+export interface Module1 {
+  /**
+   * 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
+ */
+export interface Module2 {
+  /**
+   * 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
+ */
+export interface Module3 {
+  /**
+   * 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
+ */
+export interface Module4 {
+  /**
+   * Whether current app is enabled to handle the module requests
+   */
+  enabled: boolean;
+  /**
+   * URL to receive POST request of respective module
+   */
+  endpoint: string;
+}