@epilot/document-client 0.1.1 → 0.3.0

package/dist/client.d.ts

@@ -1 +1,2 @@
-export declare const getClient: () => import("openapi-client-axios").OpenAPIClient<import("./openapi").OperationMethods, import("./openapi").PathsDictionary>;
+import { Client } from './openapi';
+export declare const getClient: () => Client;

package/dist/definition.js

@@ -1 +1 @@
-!function(e,t){for(var n in t)e[n]=t[n];t.__esModule&&Object.defineProperty(e,"__esModule",{value:!0})}(exports,(()=>{"use strict";var e={914:function(e,t,n){var o=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var p=o(n(279));t.default=p.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"},"language":{"type":"string","enum":["en","de"],"example":"en"}}}}}},"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 n(o){if(t[o])return t[o].exports;var p=t[o]={exports:{}};return e[o].call(p.exports,p,p.exports,n),p.exports}(914)})());
+!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 n=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var r=n(o(279));t.default=r.default},279:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"Document API","version":"1.0.0","description":"Generate documents with epilot data\\n\\n[Feature Documentation](https://docs.epilot.io/docs/files/document-generation)\\n"},"tags":[{"name":"Documents","description":"Document Generation"}],"security":[{"EpilotAuth":[]}],"paths":{"/v1/documents:generate":{"post":{"operationId":"generateDocument","summary":"generateDocument","description":"Builds document generated from input document with variables.\\n\\nSupported input document types:\\n- .docx\\n\\nSupported output document types:\\n- .pdf\\n\\nUses [Template Variables API](https://docs.epilot.io/api/template-variables) to replace variables in the document.\\n","tags":["Documents"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"language":{"type":"string","default":"en","example":"de","description":"Language to use"},"template_document":{"description":"Input template document","type":"object","properties":{"s3ref":{"$ref":"#/components/schemas/S3Reference"}}},"context_entity_id":{"type":"string","description":"Entity to use for variable context","example":"bcd0aab9-b544-42b0-8bfb-6d449d02eacc"}},"required":["template_document"]}}}},"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":"Authorization header with epilot OAuth2 bearer token","bearerFormat":"JWT"}},"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(n){if(t[n])return t[n].exports;var r=t[n]={exports:{}};return e[n].call(r.exports,r,r.exports,o),r.exports}(914)})());

package/dist/index.js

@@ -1,7 +1,11 @@
 "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]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/dist/openapi.d.ts

@@ -1,5 +1,5 @@
 /* eslint-disable */
-import {
+import type {
   OpenAPIClient,
   Parameters,
   UnknownParamsObject,
@@ -8,70 +8,81 @@ import {
 } 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;
+    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;
-      /**
-       * example:
-       * en
-       */
-      language?: "en" | "de";
-    }
-    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;
-        };
-      }
+    namespace GenerateDocument {
+        export interface RequestBody {
+            /**
+             * Language to use
+             * example:
+             * de
+             */
+            language?: string;
+            /**
+             * Input template document
+             */
+            template_document: {
+                s3ref?: Components.Schemas.S3Reference;
+            };
+            /**
+             * Entity to use for variable context
+             * 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.
+   * Builds document generated from input document with variables.
+   * 
+   * Supported input document types:
+   * - .docx
    * 
-   * Uses [Template Variable API](https://docs.api.staging.epilot.io/template-variables) to replace variables in the document
+   * Supported output document types:
+   * - .pdf
+   * 
+   * Uses [Template Variables API](https://docs.epilot.io/api/template-variables) to replace variables in the document.
    * 
    */
   'generateDocument'(
@@ -86,9 +97,15 @@ export interface PathsDictionary {
     /**
      * generateDocument - generateDocument
      * 
-     * Generates document using given context entity and document template.
+     * Builds document generated from input document with variables.
+     * 
+     * Supported input document types:
+     * - .docx
+     * 
+     * Supported output document types:
+     * - .pdf
      * 
-     * Uses [Template Variable API](https://docs.api.staging.epilot.io/template-variables) to replace variables in the document
+     * Uses [Template Variables API](https://docs.epilot.io/api/template-variables) to replace variables in the document.
      * 
      */
     'post'(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/document-client",
-  "version": "0.1.1",
+  "version": "0.3.0",
   "description": "API Client for epilot document API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -29,23 +29,23 @@
   "author": "epilot GmbH",
   "license": "UNLICENSED",
   "peerDependencies": {
-    "axios": "^0.21.1"
+    "axios": "^0.25.0"
   },
   "dependencies": {
     "buffer": "^6.0.3",
     "https-browserify": "^1.0.0",
-    "openapi-client-axios": "^3.13.1",
+    "openapi-client-axios": "^5.1.2",
     "stream-http": "^3.1.1",
     "url": "^0.11.0",
     "util": "^0.12.3"
   },
   "devDependencies": {
     "@types/jest": "^26.0.20",
-    "axios": "^0.21.1",
+    "axios": "^0.25.0",
     "copy-webpack-plugin": "^7.0.0",
     "jest": "^26.6.3",
     "json-loader": "^0.5.7",
-    "openapi-client-axios-typegen": "^3.13.1",
+    "openapi-client-axios-typegen": "^5.0.2",
     "openapicmd": "^1.6.2",
     "ts-jest": "^26.5.0",
     "ts-loader": "^8.0.14",

package/src/openapi.d.ts

@@ -0,0 +1,119 @@
+/* eslint-disable */
+import type {
+  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 {
+            /**
+             * Language to use
+             * example:
+             * de
+             */
+            language?: string;
+            /**
+             * Input template document
+             */
+            template_document: {
+                s3ref?: Components.Schemas.S3Reference;
+            };
+            /**
+             * Entity to use for variable context
+             * 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
+   * 
+   * Builds document generated from input document with variables.
+   * 
+   * Supported input document types:
+   * - .docx
+   * 
+   * Supported output document types:
+   * - .pdf
+   * 
+   * Uses [Template Variables API](https://docs.epilot.io/api/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
+     * 
+     * Builds document generated from input document with variables.
+     * 
+     * Supported input document types:
+     * - .docx
+     * 
+     * Supported output document types:
+     * - .pdf
+     * 
+     * Uses [Template Variables API](https://docs.epilot.io/api/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>