@compassdigital/sdk.typescript 3.0.0-beta.10

package/.editorconfig

@@ -0,0 +1,10 @@
+# https://editorconfig.org
+root = true
+
+[*]
+indent_style = tab
+indent_size = 4
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+end_of_line = lf

package/README.md

@@ -0,0 +1,40 @@
+# @compassdigital/sdk.typescript
+
+Compass Digital Labs TypeScript SDK
+
+## Install
+
+```
+$ npm install --save @compassdigital/sdk.typescript@latest
+```
+
+## Example Client Usage
+
+``` typescript
+import { ServiceClient } from "@compassdigital/sdk.typescript";
+
+const api = new ServiceClient({ stage: "dev" });
+
+async function main() {
+    const task = await api.get_task(task_id);
+}
+```
+
+## Example Server Usage
+
+``` typescript
+import Provider from "@compassdigital/provider";
+import { GetTaskRequest, GetTaskResponse } from "@compassdigital/sdk.typescript/task";
+
+const provider = new Provider({ type: "payment" });
+
+provider.on<GetTaskRequest, GetTaskResponse>("get_task", function (req, next): void {
+    // ...
+})
+```
+
+## Code Gen
+
+1. Add new services to `manifest.json`.
+2. Run `npm run gen`.
+

package/gen.ts

@@ -0,0 +1,353 @@
+
+import fs from "fs";
+import {
+  analyse,
+  load,
+  Schema,
+  Printer,
+  DocumentDetails,
+  OperationDetails,
+  isMethod,
+} from "@icholy/openapi-ts";
+import prettier from "prettier";
+import path from "path";
+import ejs from "ejs";
+
+interface Manifest {
+  services: ManifestService[];
+}
+
+interface ManifestService {
+  name: string; // service name
+  swagger: string; // swagger url or file
+}
+
+interface ClientImport {
+  path: string;
+  name: string;
+}
+
+interface MethodParam {
+  name: string;
+  type: string;
+  required: boolean;
+  description: string;
+}
+
+interface ClientMethod {
+  comment: string;
+  name: string;
+  params: MethodParam[];
+  args: string[];
+  response: string;
+}
+
+/**
+ * The method and path combined into snake and pascal style names.
+ */
+ interface OperationName {
+  snake: string;  // used for method names
+  pascal: string; // used for type names
+}
+
+/**
+ * This is a mapping between "${method} ${path}" and the default
+ * operationId.
+ */
+const operationIDs : Record<string, string> = {
+  "get /location/group/{id}/deliverydestination": "get_location_group_deliverydestinations",
+  "get /location/search":                         "get_location_search",
+  "get /promo":                                   "get_promos",
+  "get /schedule":                                "get_schedules",
+  "get /brand":                                   "get_brands",
+  "get /announcement/resource":                   "get_resources"
+};
+
+class CodeGenerator {
+
+  private imports: ClientImport[] = [];
+  private methods: ClientMethod[] = [];
+
+  async generate(manifest: Manifest): Promise<void> {
+    // generate service types
+    for (const service of manifest.services) {
+      const print = new Printer();
+      console.log(`reading: ${service.swagger}`);
+      const doc = await load(service.swagger);
+      const details = analyse(doc);
+      this.transform(details, print, service);
+      const code = prettier.format(print.code(), { parser: "typescript", printWidth: 100 });
+      const filename = path.join("src", `${service.name}.ts`);
+      fs.writeFileSync(filename, code);
+    }
+    // generate client
+    const print = new Printer();
+    // client imports
+    const imports: Record<string, string[]> = {};
+    for (const _import of this.imports) {
+      imports[_import.path] ??= [];
+      imports[_import.path].push(_import.name);
+    }
+    for (const [path, names] of Object.entries(imports)) {
+      print.import(path, names);
+      print.blank();
+    }
+    // client methods
+    const template = fs.readFileSync("template.ejs", "utf-8");
+    print.raw(ejs.render(template, { methods: this.methods }));
+    const code = prettier.format(print.code(), { parser: "typescript", printWidth: 100 });
+    const filename = path.join("src", "index.ts");
+    fs.writeFileSync(filename, code);
+  }
+
+  /**
+   * Add an import that the client will need.
+   */
+  private addImport(service: ManifestService, name: string): void {
+    this.imports.push({
+      name,
+      path: `./${service.name}`,
+    });
+  }
+
+  /**
+   * Generate typescript code from the document details.
+   */
+  private transform(doc: DocumentDetails, print: Printer, service: ManifestService): void {
+    // definitions
+    for (const [name, schema] of Object.entries(doc.definitions)) {
+      print.schema(schema, name);
+      print.blank();
+    }
+    // routes
+    for (const op of doc.operations) {
+      const { params, path } = op;
+      for (const skipped of params.skipped) {
+        console.warn("SKIPPED", skipped);
+      }
+      // add missing path parameters
+      for (const name of this.findPathParams(path)) {
+        if (!params.path.properties[name]) {
+          params.path.setProperty(name, new Schema("string", {
+            required: true,
+            description: "TODO: add parameter to swagger.json",
+          }));
+        }
+      }
+      // make all path parameters required and valid path types.
+      for (const param of Object.values(params.path.properties)) {
+        if (!param.required) {
+          param.required = true;
+          if (param.description) {
+            param.description += "; ";
+          }
+          param.description += "TODO: mark parameter as required in swagger";
+        }
+        if (param.isRef() || param.type === "object") {
+          if (param.description) {
+            param.description += "; ";
+          }
+          param.description += `TODO: cannot use ${param.type} as path parameter`;
+          param.type = "string";
+        }
+      }
+      const name = this.inferName(op, service);
+      let comment = `${op.method.toUpperCase()} ${path}`;
+      if (op.obj.summary) {
+        comment += ` - ${op.obj.summary}`;
+      }
+
+      print.comment(comment);
+      print.blank();
+      // path parameters
+      if (!params.path.isEmpty()) {
+        const pathT = `${name.pascal}Path`;
+        print.schema(params.path, pathT);
+        print.blank();
+      }
+      // query parameters
+      const queryT = `${name.pascal}Query`;
+      if (!params.query.isEmpty()) {
+        this.addImport(service, queryT);
+        print.schema(params.query, queryT);
+        print.blank();
+      }
+      // body
+      const bodyT = `${name.pascal}Body`;
+      if (!params.body.isEmpty()) {
+        this.addImport(service, bodyT);
+        print.schema(params.body, bodyT);
+        print.blank();
+      }
+      // response
+      const responseT = `${name.pascal}Response`;
+      this.addImport(service, responseT);
+      print.schema(params.response, responseT);
+      print.blank();
+      // server request
+      const requestT = `${name.pascal}Request`;
+      print.schema(this.toRequestSchema(name, op), requestT);
+      print.blank();
+
+      // method parameters
+      const method: ClientMethod = {
+        comment: comment,
+        name: name.snake,
+        params:[],
+        args: [`"${service.name}"`, `"${name.snake}"`, `"${op.method}"`],
+        response: responseT,
+      }
+      // turn the path into a template string and add the 
+      // corresponding method parameters.
+      let pathexpr = "`" + path + "`";
+      for (const name of this.findPathParams(path)) {
+        const schema = params.path.properties[name];
+        method.params.push({
+          name: name,
+          type: Printer.type(schema),
+          required: true,
+          description: schema.description,
+        });
+        pathexpr = pathexpr.replace(`{${name}}`, "${" + name + "}");
+      }
+      method.args.push(pathexpr);
+      // if there's a body, make that a parameter too.
+      if (!params.body.isEmpty()) {
+        method.params.push({
+          name: "body",
+          type: bodyT,
+          required: true,
+          description: params.body.description,
+        });
+        method.args.push("body");
+      } else {
+        method.args.push("null");
+      }
+      // build the options type.
+      const options = new Schema("empty");
+      if (!params.query.isEmpty()) {
+        const query = new Schema(queryT);
+        if (params.query.hasRequired()) {
+          query.required = true;
+          options.required = true;
+        }
+        options.setProperty("query", query);
+      }
+      options.merge(new Schema("RequestOptions"));
+      method.params.push({
+        name: "options",
+        type: Printer.type(options),
+        required: options.required,
+        description: "additional request options",
+      });
+      method.args.push("options");
+      this.methods.push(method);
+    }
+  }
+
+  /**
+   * Infer the operation name from the method and parameter.
+   * These are a bunch of dirty hacks to make the generated names consistent.
+   */
+  private inferName(op: OperationDetails, service: ManifestService): OperationName {
+    let { method, path } = op;
+    let path_segments: string[] = [];
+    // use the operationId from our collection if we have one.
+    // TODO: update the swagger.json definitions so we don't need to do this.
+    let operationID: string | undefined = operationIDs[`${op.method} ${op.path}`];
+    if (!operationID) {
+      operationID = op.obj.operationId;
+    }
+    if (operationID) {
+      const parts = operationID.split("_");
+      if (parts.length > 1) {
+        // replace common operationId values with the canonical ones.
+        if (parts[0] === "create") {
+          parts[0] = "post";
+        }
+        if (parts[0] === "update") {
+          parts[0] = "put";
+        }
+        if (parts[0] === "remove") {
+          parts[0] = "delete";
+        }
+        if (parts[0] === "find") {
+          parts[0] = "get";
+        }
+        if (!isMethod(parts[0])) {
+          parts.unshift(method);
+        }
+        if (parts[0] === method) {
+          parts.shift(); // remove the method
+          if (!parts[0].startsWith(service.name)) {
+            parts.unshift(service.name);
+          }
+          path_segments = parts;
+        }
+      }
+      if (parts.length > 1 && parts[0] === method) {
+        parts.shift(); // remove the method
+        if (!parts[0].startsWith(service.name)) {
+          parts.unshift(service.name);
+        }
+        path_segments = parts;
+      }
+    }
+    // combined the path & method into a name.
+    if (path_segments.length === 0) {
+      if (path.endsWith(".json")) {
+        path = path.slice(0, -5);
+      }
+      path_segments = path.split("/").filter(segment => {
+        return segment != "" && !segment.includes("{");
+      });
+    }
+    const parts = [method.toLowerCase(), ...path_segments];
+    return {
+      snake: parts.join("_"),
+      pascal: parts.map(s => s.charAt(0).toUpperCase() + s.substr(1)).join(''),
+    };
+  }
+
+  /**
+   * Find all the path parameter names.
+   */
+  private findPathParams(path: string): string[] {
+    const matches = path.matchAll(/{[^}]*}/g);
+    return Array.from(matches).map((match) => {
+      return match[0].slice(1, -1);
+    });
+  }
+
+  /**
+   * Create a Response type by combining the Query, Path, and Body types.
+   */
+  private toRequestSchema(name: OperationName, details: OperationDetails): Schema {
+    const request = new Schema("empty");
+    if (!details.params.body.isEmpty()) {
+      const body = new Schema(`${name.pascal}Body`);
+      body.required = true;
+      request.setProperty("body", body);
+    }
+    if (!details.params.query.isEmpty()) {
+      request.merge(new Schema(`${name.pascal}Query`));
+    }
+    if (!details.params.path.isEmpty()) {
+      request.merge(new Schema(`${name.pascal}Path`));
+    }
+    return request;
+  }
+}
+
+
+
+/**
+ * Main entry point.
+ */
+async function main() {
+  const manifest: Manifest = JSON.parse(await fs.promises.readFile("manifest.json", "utf-8"));
+  const gen = new CodeGenerator();
+  await gen.generate(manifest);
+}
+
+main();

package/lib/announcement.d.ts

@@ -0,0 +1,76 @@
+export interface Error {
+    code?: number;
+    message?: string;
+}
+export interface Success {
+    success?: boolean;
+}
+export interface Announcement {
+    id?: string;
+    name?: string;
+    type?: string;
+    key?: string;
+    app?: string;
+    is_global?: boolean;
+    allowed_resources?: string[];
+    position?: number;
+    active?: boolean;
+    info?: {
+        en?: Announcement_info;
+        fr?: Announcement_info;
+    };
+    date?: any;
+    [index: string]: any;
+}
+export interface Announcements {
+    announcements?: Announcement[];
+}
+export interface Announcement_info {
+    image_url?: string;
+    title?: string;
+    description?: string;
+    sub_text?: string;
+    button_text?: string;
+}
+export declare type PostAnnouncementBody = Announcement;
+export declare type PostAnnouncementResponse = Announcement;
+export interface PostAnnouncementRequest {
+    body: PostAnnouncementBody;
+}
+export interface GetAnnouncementResourcePath {
+    id: string;
+}
+export interface GetAnnouncementResourceQuery {
+    allowed_resource_id?: string;
+    disabled?: boolean;
+}
+export declare type GetAnnouncementResourceResponse = Announcements;
+export interface GetAnnouncementResourceRequest extends GetAnnouncementResourceQuery, GetAnnouncementResourcePath {
+}
+export interface GetAnnouncementResourcesQuery {
+    disabled?: boolean;
+}
+export declare type GetAnnouncementResourcesResponse = Announcements;
+export interface GetAnnouncementResourcesRequest extends GetAnnouncementResourcesQuery {
+}
+export interface GetAnnouncementPath {
+    id: string;
+}
+export declare type GetAnnouncementResponse = Announcement;
+export interface GetAnnouncementRequest extends GetAnnouncementPath {
+}
+export interface PutAnnouncementPath {
+    id: string;
+}
+export declare type PutAnnouncementBody = Announcement;
+export declare type PutAnnouncementResponse = Announcement;
+export interface PutAnnouncementRequest extends PutAnnouncementPath {
+    body: PutAnnouncementBody;
+}
+export interface DeleteAnnouncementPath {
+    id: string;
+}
+export declare type DeleteAnnouncementResponse = Success;
+export interface DeleteAnnouncementRequest extends DeleteAnnouncementPath {
+}
+//# sourceMappingURL=announcement.d.ts.map

package/lib/announcement.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"announcement.d.ts","sourceRoot":"","sources":["../src/announcement.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,KAAK;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,OAAO;IACtB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,YAAY;IAE3B,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB,IAAI,CAAC,EAAE;QACL,EAAE,CAAC,EAAE,iBAAiB,CAAC;QACvB,EAAE,CAAC,EAAE,iBAAiB,CAAC;KACxB,CAAC;IACF,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB;AAED,MAAM,WAAW,aAAa;IAC5B,aAAa,CAAC,EAAE,YAAY,EAAE,CAAC;CAChC;AAED,MAAM,WAAW,iBAAiB;IAChC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAID,oBAAY,oBAAoB,GAAG,YAAY,CAAC;AAEhD,oBAAY,wBAAwB,GAAG,YAAY,CAAC;AAEpD,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,oBAAoB,CAAC;CAC5B;AAID,MAAM,WAAW,2BAA2B;IAE1C,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,4BAA4B;IAE3C,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,oBAAY,+BAA+B,GAAG,aAAa,CAAC;AAE5D,MAAM,WAAW,8BACf,SAAQ,4BAA4B,EAClC,2BAA2B;CAAG;AAIlC,MAAM,WAAW,6BAA6B;IAC5C,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,oBAAY,gCAAgC,GAAG,aAAa,CAAC;AAE7D,MAAM,WAAW,+BAAgC,SAAQ,6BAA6B;CAAG;AAIzF,MAAM,WAAW,mBAAmB;IAElC,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,oBAAY,uBAAuB,GAAG,YAAY,CAAC;AAEnD,MAAM,WAAW,sBAAuB,SAAQ,mBAAmB;CAAG;AAItE,MAAM,WAAW,mBAAmB;IAElC,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,oBAAY,mBAAmB,GAAG,YAAY,CAAC;AAE/C,oBAAY,uBAAuB,GAAG,YAAY,CAAC;AAEnD,MAAM,WAAW,sBAAuB,SAAQ,mBAAmB;IACjE,IAAI,EAAE,mBAAmB,CAAC;CAC3B;AAID,MAAM,WAAW,sBAAsB;IAErC,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,oBAAY,0BAA0B,GAAG,OAAO,CAAC;AAEjD,MAAM,WAAW,yBAA0B,SAAQ,sBAAsB;CAAG"}

package/lib/announcement.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=announcement.js.map

package/lib/announcement.js.map

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

package/lib/base.d.ts

@@ -0,0 +1,55 @@
+export interface RequestOptions {
+    stage?: string;
+    token?: string;
+    headers?: Record<string, string>;
+    debug?: boolean;
+    retry?: number;
+    base_url?: string;
+    intercept?: InterceptFn;
+}
+export interface RequestData {
+    name: string;
+    service: string;
+    url: string;
+    method: string;
+    headers: Record<string, string>;
+    body?: string;
+}
+export interface ResponseData {
+    ok: boolean;
+    status: number;
+    body: string;
+}
+export declare type FetchFn = (req: RequestData) => Promise<ResponseData>;
+export declare type InterceptFn = (req: RequestData, fetch: FetchFn) => Promise<ResponseData>;
+export declare type ServiceRequestOptions = Omit<RequestOptions, "allow">;
+export interface ServiceClientOptions extends ServiceRequestOptions {
+    services?: Record<string, ServiceRequestOptions>;
+    methods?: Record<string, ServiceRequestOptions>;
+}
+export declare class ServiceError extends Error {
+    status: number;
+    code: number;
+    constructor(status: number, // http status
+    code: number, // service error code
+    message: string);
+    static status(err: any): number;
+    static code(err: any): number;
+    static ignore<T>(codes: number[], response: Promise<T>): Promise<T | null>;
+    static from_res(res: ResponseData): ServiceError;
+}
+export declare abstract class BaseServiceClient {
+    private options;
+    constructor(options?: ServiceClientOptions);
+    /**
+     * Combine the route and query parameters into a full url.
+     */
+    private build_url;
+    private fetch;
+    private is_4xx;
+    private get_options;
+    protected request(service: string, name: string, method: string, route: string, body: any, options?: {
+        query?: any;
+    } & RequestOptions): Promise<any>;
+}
+//# sourceMappingURL=base.d.ts.map

package/lib/base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../src/base.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,cAAc;IAE7B,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEjC,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB,KAAK,CAAC,EAAE,MAAM,CAAC;IAGf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,SAAS,CAAC,EAAE,WAAW,CAAC;CACzB;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,OAAO,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CACd;AAED,oBAAY,OAAO,GAAG,CAAC,GAAG,EAAE,WAAW,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC;AAElE,oBAAY,WAAW,GAAG,CAAC,GAAG,EAAE,WAAW,EAAE,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC;AAEtF,oBAAY,qBAAqB,GAAG,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;AAElE,MAAM,WAAW,oBAAqB,SAAQ,qBAAqB;IACjE,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;IACjD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;CACjD;AAED,qBAAa,YAAa,SAAQ,KAAK;IAE5B,MAAM,EAAE,MAAM;IACd,IAAI,EAAE,MAAM;gBADZ,MAAM,EAAE,MAAM,EAAE,cAAc;IAC9B,IAAI,EAAE,MAAM,EAAI,qBAAqB;IAC5C,OAAO,EAAE,MAAM;IASjB,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,GAAG,MAAM;IAO/B,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,MAAM;WAOhB,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAehF,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,YAAY,GAAG,YAAY;CAYjD;AAED,8BAAsB,iBAAiB;IACrC,OAAO,CAAC,OAAO,CAAuB;gBAE1B,OAAO,CAAC,EAAE,oBAAoB;IAI1C;;OAEG;IACH,OAAO,CAAC,SAAS;YAoBH,KAAK;IAgBnB,OAAO,CAAC,MAAM;IAId,OAAO,CAAC,WAAW;cAiBH,OAAO,CACrB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,GAAG,EACT,OAAO,GAAE;QAAE,KAAK,CAAC,EAAE,GAAG,CAAA;KAAE,GAAG,cAAmB,GAC7C,OAAO,CAAC,GAAG,CAAC;CAkChB"}