@compassdigital/sdk.typescript 3.0.0-beta.21 → 3.0.0-beta.3

package/manifest.json

@@ -2,107 +2,128 @@
     "services": [
         {
             "name": "payment",
-            "swagger": "https://api.compassdigital.org/dev/payment/swagger.json"
+            "swagger": "https://api.compassdigital.org/dev/payment/swagger.json",
+            "output": "src/payment.ts"
         },
         {
             "name": "order",
-            "swagger": "https://api.compassdigital.org/dev/order/swagger.json"
+            "swagger": "https://api.compassdigital.org/dev/order/swagger.json",
+            "output": "src/order.ts"
         },
         {
             "name": "location",
-            "swagger": "https://api.compassdigital.org/dev/location/swagger.json"
+            "swagger": "https://api.compassdigital.org/dev/location/swagger.json",
+            "output": "src/location.ts"
         },
         {
             "name": "shoppingcart",
-            "swagger": "https://api.compassdigital.org/dev/shoppingcart/swagger.json"
+            "swagger": "https://api.compassdigital.org/dev/shoppingcart/swagger.json",
+            "output": "src/shoppingcart.ts"
         },
         {
             "name": "partner",
-            "swagger": "https://api.compassdigital.org/dev/partner/swagger.json"
+            "swagger": "https://api.compassdigital.org/dev/partner/swagger.json",
+            "output": "src/partner.ts"
         },
         {
             "name": "email",
-            "swagger": "https://api.compassdigital.org/dev/email/swagger.json"
+            "swagger": "https://api.compassdigital.org/dev/email/swagger.json",
+            "output": "src/email.ts"
         },
         {
             "name": "task",
-            "swagger": "https://api.compassdigital.org/dev/task/swagger.json"
+            "swagger": "https://api.compassdigital.org/dev/task/swagger.json",
+            "output": "src/task.ts"
         },
         {
             "name": "kds",
-            "swagger": "https://api.compassdigital.org/dev/kds/swagger.json"
+            "swagger": "https://api.compassdigital.org/dev/kds/swagger.json",
+            "output": "src/kds.ts"
         },
         {
             "name": "mealplan",
-            "swagger": "https://api.compassdigital.org/dev/mealplan/swagger.json"
+            "swagger": "https://api.compassdigital.org/dev/mealplan/swagger.json",
+            "output": "src/mealplan.ts"
         },
         {
             "name": "datalake",
-            "swagger": "https://api.compassdigital.org/dev/datalake/swagger.json"
+            "swagger": "https://api.compassdigital.org/dev/datalake/swagger.json",
+            "output": "src/datalake.ts"
         },
         {
             "name": "promo",
-            "swagger": "https://api.compassdigital.org/dev/promo/swagger.json"
+            "swagger": "https://api.compassdigital.org/dev/promo/swagger.json",
+            "output": "src/promo.ts"
         },
         {
             "name": "dh",
-            "swagger": "https://api.compassdigital.org/dev/dh/swagger.json"
+            "swagger": "https://api.compassdigital.org/dev/dh/swagger.json",
+            "output": "src/dh.ts"
         },
         {
             "name": "config",
-            "swagger": "https://api.compassdigital.org/dev/config/swagger.json"
+            "swagger": "https://api.compassdigital.org/dev/config/swagger.json",
+            "output": "src/config.ts"
         },
         {
             "name": "announcement",
-            "swagger": "https://api.compassdigital.org/dev/announcement/swagger.json"
+            "swagger": "https://api.compassdigital.org/dev/announcement/swagger.json",
+            "output": "src/announcement.ts"
         },
         {
             "name": "report",
-            "swagger": "https://api.compassdigital.org/dev/report/swagger.json"
+            "swagger": "https://api.compassdigital.org/dev/report/swagger.json",
+            "output": "src/report.ts"
         },
         {
             "name": "user",
-            "swagger": "https://api.compassdigital.org/dev/user/swagger.json"
+            "swagger": "https://api.compassdigital.org/dev/user/swagger.json",
+            "output": "src/user.ts"
         },
         {
             "name": "loyalty",
-            "swagger": "https://api.compassdigital.org/dev/loyalty/swagger.json"
+            "swagger": "https://api.compassdigital.org/dev/loyalty/swagger.json",
+            "output": "src/loyalty.ts"
         },
         {
             "name": "brand",
-            "swagger": "https://api.compassdigital.org/dev/brand/swagger.json"
+            "swagger": "https://api.compassdigital.org/dev/brand/swagger.json",
+            "output": "src/brand.ts"
         },
         {
             "name": "calendar",
-            "swagger": "https://api.compassdigital.org/dev/calendar/swagger.json"
+            "swagger": "https://api.compassdigital.org/dev/calendar/swagger.json",
+            "output": "src/calendar.ts"
         },
         {
             "name": "delivery",
-            "swagger": "https://api.compassdigital.org/dev/delivery/swagger.json"
+            "swagger": "https://api.compassdigital.org/dev/delivery/swagger.json",
+            "output": "src/delivery.ts"
         },
         {
             "name": "schedule",
-            "swagger": "https://api.compassdigital.org/dev/schedule/swagger.json"
+            "swagger": "https://api.compassdigital.org/dev/schedule/swagger.json",
+            "output": "src/schedule.ts"
         },
         {
             "name": "vote",
-            "swagger": "https://api.compassdigital.org/dev/vote/swagger.json"
+            "swagger": "https://api.compassdigital.org/dev/vote/swagger.json",
+            "output": "src/vote.ts"
         },
         {
             "name": "file",
-            "swagger": "https://api.compassdigital.org/dev/file/swagger.json"
+            "swagger": "https://api.compassdigital.org/dev/file/swagger.json",
+            "output": "src/file.ts"
         },
         {
             "name": "message",
-            "swagger": "https://api.compassdigital.org/dev/message/swagger.json"
+            "swagger": "https://api.compassdigital.org/dev/message/swagger.json",
+            "output": "src/message.ts"
         },
         {
             "name": "logger",
-            "swagger": "https://api.compassdigital.org/dev/logger/swagger.json"
-        },
-        {
-            "name": "menu",
-            "swagger": "https://api.compassdigital.org/dev/menu/swagger.json"
+            "swagger": "https://api.compassdigital.org/dev/logger/swagger.json",
+            "output": "src/logger.ts"
         }
     ]
 }

package/package.json

@@ -1,33 +1,24 @@
 {
   "name": "@compassdigital/sdk.typescript",
-  "version": "3.0.0-beta.21",
+  "version": "3.0.0-beta.3",
   "description": "Compass Digital Labs TypeScript SDK",
   "type": "commonjs",
-  "bin": "./bin/index.js",
   "main": "./lib/index.js",
-  "types": "./lib/index.d.ts",
   "exports": {
     ".": "./lib/index.js",
     "./*": "./lib/*"
   },
   "typesVersions": {
     "*": {
-      "lib/index.js": [
-        "lib/index.d.ts"
-      ],
       "*": [
         "lib/*"
       ]
     }
   },
-  "jest": {
-    "preset": "ts-jest",
-    "testEnvironment": "node"
-  },
   "scripts": {
-    "test": "jest",
-    "gen": "ts-node gen.ts --manifest ./manifest.json && tsc",
-    "prepare": "rimraf ./lib && tsc && tsc --esModuleInterop --outDir ./bin gen.ts"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "gen": "npx ts-node gen.ts && npx tsc",
+    "prepare": "npx tsc"
   },
   "author": "",
   "license": "ISC",
@@ -37,15 +28,10 @@
   "devDependencies": {
     "@icholy/openapi-ts": "^2.5.1",
     "@types/ejs": "^3.1.0",
-    "@types/jest": "^27.0.1",
     "@types/node": "^16.7.2",
     "@types/prettier": "^2.3.2",
     "ejs": "^3.1.6",
-    "jest": "^27.1.0",
     "prettier": "^2.3.2",
-    "rimraf": "^3.0.2",
-    "ts-jest": "^27.0.5",
-    "ts-node": "^10.2.1",
-    "yargs": "^17.1.1"
+    "ts-node": "^10.2.1"
   }
 }

package/src/{interface/announcement.ts → announcement.ts}

@@ -1,5 +1,3 @@
-// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
-
 export interface Error {
   code?: number;
   message?: string;

package/src/base.ts

@@ -2,245 +2,14 @@
 import fetch from "cross-fetch";
 
 export interface RequestOptions {
-  // environment to make requests to
   stage?: string;
-  // authentication token
-  token?: string;
-  // additional headers
   headers?: Record<string, string>;
-  // log all requests and responses
+  token?: string;
   debug?: boolean;
-  // the number of times to retry a request
   retry?: number;
-  // make requests against this base url
-  // note: the stage property is ignored if base_url is set
   base_url?: string;
-  // intercept outgoing http requests
-  intercept?: InterceptFn;
-}
-
-/**
- * The request data provided to intercept
- * functions.
- */
-export interface RequestData {
-  name: string;
-  service: string;
-  url: string;
-  method: string;
-  headers: Record<string, string>;
-  body?: string;
-}
-
-/**
- * The response data expected from
- * intercept functions.
- */
-export interface ResponseData {
-  ok: boolean;
-  status: number;
-  body: string;
-  err?: any; // network error
-}
-
-/**
- * A function that performs an https request.
- */
-export type FetchFn = (req: RequestData) => Promise<ResponseData>;
-
-/**
- * A function that intercepts an http request and returns a response.
- */
-export type InterceptFn = (req: RequestData, fetch: FetchFn) => Promise<ResponseData>;
-
-/**
- * We have to re-implement the promise methods instead of just existing
- * the existing Promise class due to: https://github.com/microsoft/TypeScript/issues/15202
- */
-export class ResponsePromise<T> implements Promise<T> {
-
-  /**
-   * Implements Promise interface.
-   */
-  [Symbol.toStringTag] = "[object ResponsePromise]";
-
-  constructor(private promise: Promise<T>) {}
-
-  /**
-   * Implements Promise interface.
-   */
-  then<TResult1 = T, TResult2 = never>(
-    onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null,
-    onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null
-  ): ResponsePromise<TResult1 | TResult2> {
-    return new ResponsePromise(this.promise.then(onfulfilled, onrejected));
-  }
-
-  /**
-   * Implements Promise interface.
-   */
-  catch<TResult = never>(
-    onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | null
-  ): ResponsePromise<T | TResult> {
-    return new ResponsePromise(this.promise.catch(onrejected));
-  }
-
-  /**
-   * Implements Promise interface.
-   */
-  finally(onfinally?: (() => void) | null): ResponsePromise<T> {
-    return new ResponsePromise(this.promise.finally(onfinally));
-  }
-
-  /**
-   * Returns a promise that resolves to null if http status code
-   * or service error code matches one of the provided codes.
-   * If no codes are specified, all codes are ignored.
-   */
-  ignore(...codes: number[]): ResponsePromise<T | null> {
-    return new ResponsePromise(ServiceError.ignore(codes, this.promise));
-  }
-
-  /**
-   * Returns a promise that resolves to either the response body
-   * or a ServiceError.
-   */
-  combine(...codes: number[]): Promise<EitherResponse<T>> {
-    return new ResponsePromise(ServiceError.combine<T>(codes, this.promise));
-  }
-}
-
-/**
- * Either a response body or a service error.
- */
-export type EitherResponse<T> = { ok: true; data: T; err: null } | { ok: false; data: null, err: ServiceError; };
-
-/**
- * This is a hack to make captureStackTrace visible.
- */
-interface ErrorConstructor {
-  captureStackTrace?(target: object, constructorOpt?: Function): void;
-}
-
-/**
- * An error returned from an api service.
- */
-export class ServiceError extends Error {
-  constructor(
-    public status: number, // http status
-    public code: number,   // service error code
-    message: string        // service error message
-  ) {
-    super(message);
-    this.name = `ServiceError(${code})`;
-
-    // TODO: remove this if we change compilation target > es5
-    Object.setPrototypeOf(this, ServiceError.prototype);
-  }
-
-  /**
-   * Returns the http status code from err.
-   * If err isn't an instance of ServiceError, -1 is returned.
-   */
-  static status(err: any): number {
-    if (err instanceof ServiceError) {
-      return err.status;
-    }
-    return -1;
-  }
-
-  /**
-   * Returns the service error code from err.
-   * If err isn't an instance of ServiceError, -1 is returned.
-   */
-  static code(err: any): number {
-    if (err instanceof ServiceError) {
-      return err.code;
-    }
-    return -1;
-  }
-
-  /**
-   * Returns a promise that resolves to null if http status code
-   * or service error code matches one of the provided codes.
-   * If no codes are specified, all codes are ignored.
-   */
-  static async ignore<T>(codes: number[], response: Promise<T>): Promise<T | null> {
-    try {
-      return await response;
-    } catch (err) {
-      if (err instanceof ServiceError) {
-        if (codes.length === 0) {
-          return null;
-        }
-        for (const code of codes) {
-          if (err.status === code || err.code === code) {
-            return null;
-          }
-        }
-      }
-      throw err;
-    }
-  }
-
-  /**
-   * Returns a promise that resolves to either T or a ServiceError.
-   */
-  static async combine<T>(codes: number[], response: Promise<T>): Promise<EitherResponse<T>> {
-    try {
-      const data = await response;
-      return { ok: true, data, err: null };
-    } catch (err) {
-      if (err instanceof ServiceError) {
-        if (codes.length === 0) {
-          return { ok: false, data: null, err }
-        }
-        for (const code of codes) {
-          if (err.status === code || err.code === code) {
-            return { ok: false, data: null, err };
-          }
-        }
-      }
-      throw err;
-    }
-  }
-
-  /**
-   * Constructs a ServiceError from the provided response data.
-   */
-  static from_res(res: ResponseData): ServiceError {
-    let message = res.body;
-    let code = res.status;
-    if (res.err) {
-      // network error
-      if (res.err instanceof Error) {
-        message = res.err.message;
-      } else {
-        message = "Network Error";
-      }
-      code = 0;
-    } else {
-      try {
-        let data = JSON.parse(res.body);
-        if (data.code && (data.message || data.error)) {
-          code = data.code;
-          message = data.message || data.error;
-        }
-      } catch (_) {}
-    }
-    const err = new ServiceError(res.status, code, message);
-    // override the stack trace so that it doesn't include the from_res helper.
-    if (Error.captureStackTrace) {
-      Error.captureStackTrace(err, ServiceError.from_res);
-    }
-    return err;
-  }
 }
 
-/**
- * BaseServiceClient contains the logic for executing http requests.
- * This class is meant to be extended by the generated code.
- */
 export abstract class BaseServiceClient {
   private options: RequestOptions;
 
@@ -271,127 +40,45 @@ export abstract class BaseServiceClient {
     return url;
   }
 
-  /**
-   * Perform the http request or pass it to the intercept function
-   * if one was configured.
-   */
-  private async fetch(req: RequestData, options?: RequestOptions): Promise<ResponseData> {
-    if (options?.intercept) {
-      return options.intercept(req, this.fetch.bind(this));
-    }
-    try {
-      const res = await fetch(req.url, {
-        method: req.method,
-        body: req.body,
-        headers: req.headers,
-      });
-      return {
-        ok: res.ok,
-        status: res.status,
-        body: await res.text(),
-      };
-    } catch (err) {
-      return {
-        ok: false,
-        status: 0,
-        body: "",
-        err: err,
-      }
-    }
-  }
-
-  /**
-   * Returns true if the status code represents a transient error
-   * or it's a network error.
-   */
-  private should_retry(res: ResponseData): boolean {
-    if (res.err) {
-      return true;
-    }
-    switch (res.status) {
-      case 408: // timeout
-      case 413: // too large
-      case 429: // too many requests
-      case 500: // generic error response
-      case 502: // invalid upstream response
-      case 503: // service unavailable
-      case 504: // gateway timeout
-      case 522: // tcp connection timeout
-        return true;
-      default:
-        return false;
-    }
-  }
-
-  /**
-   * Returns the merged options.
-   */
-  private get_options(options: RequestOptions): RequestOptions {
-    return {
-      ...this.options,
-      ...options,
-      headers: {
-        ...this.options.headers,
-        ...options.headers,
-      }
-    };
-  }
-
-  /**
-   * A delegate to _request that wraps the response in a ResponsePromise.
-   */
-  protected request(
-    service: string,
-    name: string,
-    method: string,
-    route: string,
-    body: any,
-    options: { query?: any } & RequestOptions = {}
-  ): ResponsePromise<any> {
-    const promise = this._request(service, name, method, route, body, options);
-    return new ResponsePromise(promise);
+  private is_4xx(res: Response): boolean {
+    return 400 <= res.status && res.status < 500;
   }
 
-  /**
-   * The main logic for fulfilling a request as perscribed by
-   * the request options.
-   */
-  private async _request(
-    service: string,
-    name: string,
+  protected async request(
     method: string,
     route: string,
     body: any,
     options: { query?: any } & RequestOptions = {}
   ): Promise<any> {
-    options = this.get_options(options);
+    options = { ...this.options, ...options };
     const url = this.build_url(route, options, options.query ?? {});
-    const headers = Object.assign({
-      "User-Agent": "CDL/ServiceClient"
-    }, options.headers);
+    const headers = Object.assign({}, options.headers);
     if (options.token) {
       headers["Authorization"] = `Bearer ${options.token}`;
     }
-    const req: RequestData = { name, service, url, method, headers };
+    const req: RequestInit = {
+      method: method,
+      headers: headers,
+    };
     if (body) {
       req.body = JSON.stringify(body);
     }
     if (options.debug) {
       console.log(`REQ(${method.toUpperCase()})`, url, JSON.stringify(req, null, 2));
     }
-    const res = await this.fetch(req, options);
+    const res = await fetch(url, req);
     if (!res.ok) {
-      const err = ServiceError.from_res(res);
+      const text = await res.text();
       if (options.debug) {
-        console.log(`ERR(${res.status})`, url, err.message);
+        console.log(`ERR(${res.status})`, url, text);
       }
-      if (typeof options.retry === "number" && options.retry > 0 && this.should_retry(res)) {
+      if (typeof options.retry === "number" && options.retry > 0 && !this.is_4xx(res)) {
         options.retry--;
-        return this.request(service, name, method, route, body, options);
+        return this.request(method, route, body, options);
       }
-      throw err;
+      throw new Error(text);
     }
-    const data = res.body ? JSON.parse(res.body) : res.body;
+    const data = await res.json();
     if (options.debug) {
       console.log(`RES(${res.status})`, url, JSON.stringify(data, null, 2));
     }

package/src/{interface/brand.ts → brand.ts}

@@ -1,5 +1,3 @@
-// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
-
 export interface Brand {
   // brand
   id?: string;

package/src/{interface/calendar.ts → calendar.ts}

@@ -1,5 +1,3 @@
-// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
-
 export interface Error {
   message?: string;
   code?: number;

package/src/{interface/config.ts → config.ts}

@@ -1,5 +1,3 @@
-// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
-
 export type CreateConfig = any;
 
 export interface Config {

package/src/{interface/datalake.ts → datalake.ts}

@@ -1,5 +1,3 @@
-// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
-
 export interface Error {
   error?: string;
   code?: number;

package/src/{interface/delivery.ts → delivery.ts}

@@ -1,5 +1,3 @@
-// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
-
 export interface Error {
   code?: number;
   message?: string;

package/src/{interface/dh.ts → dh.ts}

@@ -1,5 +1,3 @@
-// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
-
 export interface Error {
   error?: string;
   code?: number;

package/src/email.ts

@@ -0,0 +1,4 @@
+export interface Error {
+  message?: string;
+  code?: number;
+}

package/src/{interface/file.ts → file.ts}

@@ -1,5 +1,3 @@
-// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
-
 export interface Error {
   message?: string;
   code?: number;