@epilot/document-client 0.1.0

package/README.md

@@ -0,0 +1,43 @@
+# `@epilot/document-client`
+
+API Client for epilot Document API.
+
+Uses [`openapi-client-axios`](https://github.com/anttiviljami/openapi-client-axios)
+
+## Getting Started
+
+Install the package:
+
+```bash
+npm install --save-dev @epilot/document-client
+```
+
+Import the package:
+
+```typescript
+import { getClient } from '@epilot/document-client';
+```
+
+Use the client:
+```typescript
+// get typed client
+const client = await getClient();
+
+// call an operation
+const res = await client.generateDocument(null, {});
+```
+
+## 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.API_URL;
+client.defaults.headers['authorization'] = `Bearer ${token}`;
+```
+
+## API Docs:
+
+https://docs.api.epilot.io/document

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 n=r(o(279));t.default=n.default},279:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"Document API","version":"0.1.0"},"tags":[{"name":"documents","description":"Documents"}],"security":[{"EpilotAuth":[]}],"paths":{"/v1/documents:generate":{"post":{"operationId":"generateDocument","summary":"generateDocument","description":"Generates document using given context entity and document template.\\n\\nUses [Template Variable API](https://docs.api.staging.epilot.io/template-variables) to replace variables in the document\\n","tags":["documents"],"requestBody":{"description":"Document template and context entity","content":{"application/json":{"schema":{"type":"object","properties":{"template_document":{"type":"object","properties":{"s3ref":{"$ref":"#/components/schemas/S3Reference"}}},"context_entity_id":{"type":"string","example":"bcd0aab9-b544-42b0-8bfb-6d449d02eacc"}}}}}},"responses":{"200":{"description":"Generated document output","content":{"application/json":{"schema":{"type":"object","properties":{"preview_url":{"description":"Pre-signed S3 GET URL for preview","type":"string","example":"https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/my-template.pdf"},"output_document":{"type":"object","properties":{"s3ref":{"$ref":"#/components/schemas/S3Reference"}},"example":{"s3ref":{"bucket":"document-api-preview-prod","key":"preview/my-template.pdf"}}}}}}}}}}}},"components":{"securitySchemes":{"EpilotAuth":{"type":"http","scheme":"bearer","description":"Epilot Bearer Token"}},"schemas":{"S3Reference":{"type":"object","properties":{"bucket":{"type":"string","example":"document-api-prod"},"key":{"type":"string","example":"uploads/my-template.pdf"}},"required":["bucket","key"]}}}}')}},t={};return function o(r){if(t[r])return t[r].exports;var n=t[r]={exports:{}};return e[r].call(n.exports,n,n.exports,o),n.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,97 @@
+/* eslint-disable */
+import {
+  OpenAPIClient,
+  Parameters,
+  UnknownParamsObject,
+  OperationResponse,
+  AxiosRequestConfig,
+} from 'openapi-client-axios'; 
+
+declare namespace Components {
+  namespace Schemas {
+    export interface S3Reference {
+      /**
+       * example:
+       * document-api-prod
+       */
+      bucket: string;
+      /**
+       * example:
+       * uploads/my-template.pdf
+       */
+      key: string;
+    }
+  }
+}
+declare namespace Paths {
+  namespace GenerateDocument {
+    export interface RequestBody {
+      template_document?: {
+        s3ref?: Components.Schemas.S3Reference;
+      };
+      /**
+       * example:
+       * bcd0aab9-b544-42b0-8bfb-6d449d02eacc
+       */
+      context_entity_id?: string;
+    }
+    namespace Responses {
+      export interface $200 {
+        /**
+         * Pre-signed S3 GET URL for preview
+         * example:
+         * https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/my-template.pdf
+         */
+        preview_url?: string;
+        /**
+         * example:
+         * {
+         *   "s3ref": {
+         *     "bucket": "document-api-preview-prod",
+         *     "key": "preview/my-template.pdf"
+         *   }
+         * }
+         */
+        output_document?: {
+          s3ref?: Components.Schemas.S3Reference;
+        };
+      }
+    }
+  }
+}
+
+export interface OperationMethods {
+  /**
+   * generateDocument - generateDocument
+   * 
+   * Generates document using given context entity and document template.
+   * 
+   * Uses [Template Variable API](https://docs.api.staging.epilot.io/template-variables) to replace variables in the document
+   * 
+   */
+  'generateDocument'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.GenerateDocument.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GenerateDocument.Responses.$200>
+}
+
+export interface PathsDictionary {
+  ['/v1/documents:generate']: {
+    /**
+     * generateDocument - generateDocument
+     * 
+     * Generates document using given context entity and document template.
+     * 
+     * Uses [Template Variable API](https://docs.api.staging.epilot.io/template-variables) to replace variables in the document
+     * 
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.GenerateDocument.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GenerateDocument.Responses.$200>
+  }
+}
+
+export type Client = OpenAPIClient<OperationMethods, PathsDictionary>

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@epilot/document-client",
+  "version": "0.1.0",
+  "description": "API Client for epilot document API",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "test": "jest",
+    "typescript": "tsc",
+    "bundle-definition": "webpack",
+    "openapi": "openapi read --json ../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",
+    "prepublishOnly": "npm run build"
+  },
+  "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,97 @@
+/* eslint-disable */
+import {
+  OpenAPIClient,
+  Parameters,
+  UnknownParamsObject,
+  OperationResponse,
+  AxiosRequestConfig,
+} from 'openapi-client-axios'; 
+
+declare namespace Components {
+  namespace Schemas {
+    export interface S3Reference {
+      /**
+       * example:
+       * document-api-prod
+       */
+      bucket: string;
+      /**
+       * example:
+       * uploads/my-template.pdf
+       */
+      key: string;
+    }
+  }
+}
+declare namespace Paths {
+  namespace GenerateDocument {
+    export interface RequestBody {
+      template_document?: {
+        s3ref?: Components.Schemas.S3Reference;
+      };
+      /**
+       * example:
+       * bcd0aab9-b544-42b0-8bfb-6d449d02eacc
+       */
+      context_entity_id?: string;
+    }
+    namespace Responses {
+      export interface $200 {
+        /**
+         * Pre-signed S3 GET URL for preview
+         * example:
+         * https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/my-template.pdf
+         */
+        preview_url?: string;
+        /**
+         * example:
+         * {
+         *   "s3ref": {
+         *     "bucket": "document-api-preview-prod",
+         *     "key": "preview/my-template.pdf"
+         *   }
+         * }
+         */
+        output_document?: {
+          s3ref?: Components.Schemas.S3Reference;
+        };
+      }
+    }
+  }
+}
+
+export interface OperationMethods {
+  /**
+   * generateDocument - generateDocument
+   * 
+   * Generates document using given context entity and document template.
+   * 
+   * Uses [Template Variable API](https://docs.api.staging.epilot.io/template-variables) to replace variables in the document
+   * 
+   */
+  'generateDocument'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.GenerateDocument.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GenerateDocument.Responses.$200>
+}
+
+export interface PathsDictionary {
+  ['/v1/documents:generate']: {
+    /**
+     * generateDocument - generateDocument
+     * 
+     * Generates document using given context entity and document template.
+     * 
+     * Uses [Template Variable API](https://docs.api.staging.epilot.io/template-variables) to replace variables in the document
+     * 
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.GenerateDocument.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GenerateDocument.Responses.$200>
+  }
+}
+
+export type Client = OpenAPIClient<OperationMethods, PathsDictionary>