@epilot/customer-portal-client 0.1.0

package/README.md

@@ -0,0 +1,43 @@
+# `@epilot/customer-portal-client`
+
+API Client for epilot customer-portal API.
+
+Uses [`openapi-client-axios`](https://github.com/anttiviljami/openapi-client-axios)
+
+## Getting Started
+
+Install the package:
+
+```bash
+npm install --save-dev @epilot/customer-portal-client
+```
+
+Import the package:
+
+```typescript
+import { getClient } from '@epilot/customer-portal-client';
+```
+
+Use the client:
+```typescript
+// get typed client
+const client = await getClient();
+
+// call an operation
+const res = await client.testAuth();
+```
+
+## BaseURL & Authorization
+
+To pass an authorization header and set up the API url, you can use axios
+defaults:
+
+```typescript
+const client = getClient();
+client.defaults.baseURL = config.CUSTOMER_PORTAL_API;
+client.defaults.headers['authorization'] = `Bearer ${token}`;
+```
+
+## API Docs:
+
+https://docs.api.epilot.io/

package/dist/client.d.ts

@@ -0,0 +1 @@
+export declare const getClient: () => import("openapi-client-axios").OpenAPIClient<import("./openapi").OperationMethods, import("./openapi").PathsDictionary>;

package/dist/client.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getClient = void 0;
+var openapi_client_axios_1 = __importDefault(require("openapi-client-axios"));
+var definition_1 = __importDefault(require("./definition"));
+var getClient = function () {
+    var api = new openapi_client_axios_1.default({ definition: definition_1.default, quick: true });
+    return api.initSync();
+};
+exports.getClient = getClient;
+//# sourceMappingURL=client.js.map

package/dist/definition.d.ts

@@ -0,0 +1,3 @@
+import type { Document } from 'openapi-client-axios';
+declare const _default: Document;
+export default _default;

package/dist/definition.js

@@ -0,0 +1 @@
+!function(e,t){for(var o in t)e[o]=t[o];t.__esModule&&Object.defineProperty(e,"__esModule",{value:!0})}(exports,(()=>{"use strict";var e={914:function(e,t,o){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var i=r(o(279));t.default=i.default},279:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"Customer Portal API","description":"Backend for epilot end customer portals","version":"1.0.0"},"tags":[{"name":"mock","description":"Mock endpoints"},{"name":"auth","description":"Auth endpoints"}],"security":[{"CustomerPortalAuth":[]},{"AsOrganization":[]},{"AsBrand":[]},{"AsCustomer":[]}],"paths":{"/v1/customer-portal/public/mock":{"get":{"operationId":"mockPublicOperation","summary":"mockPublicOperation","description":"Mock response from OAS definition","tags":["mock"],"security":[],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"hello":{"type":"string","example":"world"}},"required":["hello"]}}}}}}},"/v1/customer-portal/mock":{"get":{"operationId":"mockOperation","summary":"mockOperation","description":"Mock response from OAS definition","tags":["mock"],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"hello":{"type":"string","example":"world"}},"required":["hello"]}}}}}}},"/v1/customer-portal/auth":{"get":{"operationId":"testAuth","summary":"testAuth","description":"Return auth context","tags":["auth"],"responses":{"200":{"description":"ok"}}}},"/v1/customer-portal/admin/auth":{"get":{"operationId":"testAdminAuth","summary":"testAdminAuth","description":"Return auth context","tags":["auth"],"security":[{"EpilotAuth":[]},{"AsOrganization":[]}],"responses":{"200":{"description":"ok"}}}}},"components":{"securitySchemes":{"CustomerPortalAuth":{"type":"http","scheme":"bearer","description":"Customer Portal Cognito Token"},"EpilotAuth":{"type":"http","scheme":"bearer","description":"Epilot Bearer Token"},"AsOrganization":{"type":"apiKey","in":"header","name":"x-ivy-org-id","description":"Set organization id as internal user"},"AsBrand":{"type":"apiKey","in":"header","name":"x-ivy-brand-id","description":"Set brand id as internal user"},"AsContact":{"type":"apiKey","in":"header","name":"x-contact-id","description":"Set contact id as internal user"}},"schemas":{"HelloWorldObject":{"type":"object","properties":{"hello":{"type":"string","example":"world"}},"required":["hello"]}}}}')}},t={};return function o(r){if(t[r])return t[r].exports;var i=t[r]={exports:{}};return e[r].call(i.exports,i,i.exports,o),i.exports}(914)})());

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './client';
+export type { Client, Components, Paths, PathsDictionary, OperationMethods } from './openapi';
+export type { OpenAPIClient, OpenAPIClientAxios, Document } from 'openapi-client-axios';

package/dist/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./client"), exports);
+//# sourceMappingURL=index.js.map

package/dist/openapi.d.ts

@@ -0,0 +1,128 @@
+/* eslint-disable */
+import {
+  OpenAPIClient,
+  Parameters,
+  UnknownParamsObject,
+  OperationResponse,
+  AxiosRequestConfig,
+} from 'openapi-client-axios'; 
+
+declare namespace Components {
+  namespace Schemas {
+    export interface HelloWorldObject {
+      /**
+       * example:
+       * world
+       */
+      hello: string;
+    }
+  }
+}
+declare namespace Paths {
+  namespace MockOperation {
+    namespace Responses {
+      export type $200 = Components.Schemas.HelloWorldObject;
+    }
+  }
+  namespace MockPublicOperation {
+    namespace Responses {
+      export type $200 = Components.Schemas.HelloWorldObject;
+    }
+  }
+}
+
+export interface OperationMethods {
+  /**
+   * mockPublicOperation - mockPublicOperation
+   * 
+   * Mock response from OAS definition
+   */
+  'mockPublicOperation'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.MockPublicOperation.Responses.$200>
+  /**
+   * mockOperation - mockOperation
+   * 
+   * Mock response from OAS definition
+   */
+  'mockOperation'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.MockOperation.Responses.$200>
+  /**
+   * testAuth - testAuth
+   * 
+   * Return auth context
+   */
+  'testAuth'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<any>
+  /**
+   * testAdminAuth - testAdminAuth
+   * 
+   * Return auth context
+   */
+  'testAdminAuth'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<any>
+}
+
+export interface PathsDictionary {
+  ['/v1/customer-portal/public/mock']: {
+    /**
+     * mockPublicOperation - mockPublicOperation
+     * 
+     * Mock response from OAS definition
+     */
+    'get'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.MockPublicOperation.Responses.$200>
+  }
+  ['/v1/customer-portal/mock']: {
+    /**
+     * mockOperation - mockOperation
+     * 
+     * Mock response from OAS definition
+     */
+    'get'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.MockOperation.Responses.$200>
+  }
+  ['/v1/customer-portal/auth']: {
+    /**
+     * testAuth - testAuth
+     * 
+     * Return auth context
+     */
+    'get'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<any>
+  }
+  ['/v1/customer-portal/admin/auth']: {
+    /**
+     * testAdminAuth - testAdminAuth
+     * 
+     * Return auth context
+     */
+    'get'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<any>
+  }
+}
+
+export type Client = OpenAPIClient<OperationMethods, PathsDictionary>

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@epilot/customer-portal-client",
+  "version": "0.1.0",
+  "description": "API Client for epilot customer-portal API",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "test": "jest",
+    "typescript": "tsc",
+    "bundle-definition": "webpack",
+    "openapi": "openapi read --json --dereference --bundle ../lambda/ApiHandlerFunction/openapi.yml > src/openapi.json",
+    "typegen": "echo '/* eslint-disable */' > src/openapi.d.ts && typegen ../lambda/ApiHandlerFunction/openapi.yml >> src/openapi.d.ts",
+    "build": "npm run openapi && npm run typegen && npm run typescript && npm run bundle-definition",
+    "eslint": "../node_modules/.bin/eslint -c ../.eslintrc.yml"
+  },
+  "files": [
+    "*.js",
+    "*.d.ts",
+    "**/*.js",
+    "**/*.d.ts",
+    "!*.test.*",
+    "!**/*.test.*",
+    "!node_modules",
+    "!src",
+    "!*.config.js"
+  ],
+  "keywords": [],
+  "author": "epilot GmbH",
+  "license": "UNLICENSED",
+  "peerDependencies": {
+    "axios": "^0.21.1"
+  },
+  "dependencies": {
+    "buffer": "^6.0.3",
+    "https-browserify": "^1.0.0",
+    "openapi-client-axios": "^3.13.1",
+    "stream-http": "^3.1.1",
+    "url": "^0.11.0",
+    "util": "^0.12.3"
+  },
+  "devDependencies": {
+    "@types/jest": "^26.0.20",
+    "axios": "^0.21.1",
+    "copy-webpack-plugin": "^7.0.0",
+    "jest": "^26.6.3",
+    "json-loader": "^0.5.7",
+    "openapi-client-axios-typegen": "^3.13.1",
+    "openapicmd": "^1.6.2",
+    "ts-jest": "^26.5.0",
+    "ts-loader": "^8.0.14",
+    "ts-node": "^9.1.1",
+    "typescript": "^4.1.3",
+    "webpack": "^5.18.0",
+    "webpack-cli": "^4.4.0"
+  }
+}

package/src/openapi.d.ts

@@ -0,0 +1,128 @@
+/* eslint-disable */
+import {
+  OpenAPIClient,
+  Parameters,
+  UnknownParamsObject,
+  OperationResponse,
+  AxiosRequestConfig,
+} from 'openapi-client-axios'; 
+
+declare namespace Components {
+  namespace Schemas {
+    export interface HelloWorldObject {
+      /**
+       * example:
+       * world
+       */
+      hello: string;
+    }
+  }
+}
+declare namespace Paths {
+  namespace MockOperation {
+    namespace Responses {
+      export type $200 = Components.Schemas.HelloWorldObject;
+    }
+  }
+  namespace MockPublicOperation {
+    namespace Responses {
+      export type $200 = Components.Schemas.HelloWorldObject;
+    }
+  }
+}
+
+export interface OperationMethods {
+  /**
+   * mockPublicOperation - mockPublicOperation
+   * 
+   * Mock response from OAS definition
+   */
+  'mockPublicOperation'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.MockPublicOperation.Responses.$200>
+  /**
+   * mockOperation - mockOperation
+   * 
+   * Mock response from OAS definition
+   */
+  'mockOperation'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.MockOperation.Responses.$200>
+  /**
+   * testAuth - testAuth
+   * 
+   * Return auth context
+   */
+  'testAuth'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<any>
+  /**
+   * testAdminAuth - testAdminAuth
+   * 
+   * Return auth context
+   */
+  'testAdminAuth'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<any>
+}
+
+export interface PathsDictionary {
+  ['/v1/customer-portal/public/mock']: {
+    /**
+     * mockPublicOperation - mockPublicOperation
+     * 
+     * Mock response from OAS definition
+     */
+    'get'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.MockPublicOperation.Responses.$200>
+  }
+  ['/v1/customer-portal/mock']: {
+    /**
+     * mockOperation - mockOperation
+     * 
+     * Mock response from OAS definition
+     */
+    'get'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.MockOperation.Responses.$200>
+  }
+  ['/v1/customer-portal/auth']: {
+    /**
+     * testAuth - testAuth
+     * 
+     * Return auth context
+     */
+    'get'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<any>
+  }
+  ['/v1/customer-portal/admin/auth']: {
+    /**
+     * testAdminAuth - testAdminAuth
+     * 
+     * Return auth context
+     */
+    'get'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<any>
+  }
+}
+
+export type Client = OpenAPIClient<OperationMethods, PathsDictionary>