@epilot/document-client 0.7.1-alpha → 0.8.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 epilot GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/package.json

@@ -1,18 +1,19 @@
 {
   "name": "@epilot/document-client",
-  "version": "0.7.1-alpha",
+  "version": "0.8.0",
   "description": "API Client for epilot document API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
-    "test": "jest --passWithNoTests",
+    "test": "jest",
     "typescript": "tsc",
     "bundle-definition": "webpack",
     "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/document.yaml",
     "typegen": "echo '/* eslint-disable */' > src/openapi.d.ts && typegen ./src/openapi.json >> src/openapi.d.ts",
-    "build": "npm run openapi && npm run typegen && npm run typescript && npm run bundle-definition",
-    "lint": "../../node_modules/eslint/bin/eslint.js src",
-    "prepublishOnly": "npm run build"
+    "build": "tsc && npm run bundle-definition",
+    "build:watch": "npm run build && tsc -w",
+    "release-alpha": "npm version prerelease --preid alpha",
+    "lint": "../../node_modules/eslint/bin/eslint.js src"
   },
   "files": [
     "*.js",
@@ -29,28 +30,30 @@
   "author": "epilot GmbH",
   "license": "UNLICENSED",
   "peerDependencies": {
-    "axios": "^0.25.0"
+    "axios": "^1.6.2"
   },
   "dependencies": {
     "buffer": "^6.0.3",
     "https-browserify": "^1.0.0",
-    "openapi-client-axios": "^6.0.0",
+    "openapi-client-axios": "^7.5.1",
     "stream-http": "^3.1.1",
     "url": "^0.11.0",
     "util": "^0.12.3"
   },
   "devDependencies": {
     "@types/jest": "^26.0.20",
+    "axios": "^1.6.2",
     "copy-webpack-plugin": "^7.0.0",
     "jest": "^26.6.3",
     "json-loader": "^0.5.7",
     "openapi-client-axios-typegen": "^7.4.1",
-    "openapicmd": "^1.6.2",
+    "openapicmd": "^1.16.2",
     "ts-jest": "^26.5.0",
     "ts-loader": "^8.0.14",
-    "ts-node": "^10.8.2",
-    "typescript": "^4.7.4",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.1.3",
     "webpack": "^5.18.0",
     "webpack-cli": "^4.4.0"
-  }
+  },
+  "gitHead": "87e13b737363092db3b30c32df8e0507f7348697"
 }

package/src/openapi.d.ts

@@ -0,0 +1,296 @@
+/* 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: {
+                /**
+                 * Document original filename
+                 * example:
+                 * my-template-{{order.order_number}}.docx
+                 */
+                filename?: string;
+                s3ref?: Components.Schemas.S3Reference;
+            };
+            /**
+             * Entity to use for variable context
+             * example:
+             * bcd0aab9-b544-42b0-8bfb-6d449d02eacc
+             */
+            context_entity_id?: string;
+            /**
+             * User Id for variable context
+             * example:
+             * 100321
+             */
+            user_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-OR-001.pdf
+                 */
+                preview_url?: string;
+                /**
+                 * example:
+                 * {
+                 *   "s3ref": {
+                 *     "bucket": "document-api-preview-prod",
+                 *     "key": "preview/my-template.pdf"
+                 *   }
+                 * }
+                 */
+                output_document?: {
+                    /**
+                     * Generated document filename
+                     * example:
+                     * my-template-OR-001.pdf
+                     */
+                    filename?: string;
+                    s3ref?: Components.Schemas.S3Reference;
+                };
+            }
+        }
+    }
+    namespace GenerateDocumentV2 {
+        namespace Parameters {
+            export type JobId = string;
+            export type Mode = "partial_generation" | "full_generation";
+        }
+        export interface QueryParameters {
+            job_id?: Parameters.JobId;
+            mode?: Parameters.Mode;
+        }
+        export interface RequestBody {
+            /**
+             * Language to use for variables
+             */
+            language?: string;
+            /**
+             * Input template document
+             */
+            template_document: {
+                /**
+                 * Document original filename
+                 * example:
+                 * my-template-{{order.order_number}}.docx
+                 */
+                filename?: string;
+                s3ref?: Components.Schemas.S3Reference;
+            };
+            /**
+             * Entity to use for variable context
+             * example:
+             * bcd0aab9-b544-42b0-8bfb-6d449d02eacc
+             */
+            context_entity_id?: string;
+            /**
+             * User Id for variable context
+             * example:
+             * 100321
+             */
+            user_id?: string;
+            /**
+             * Custom values for variables in the template. Takes the higher precedence than others.
+             */
+            variable_payload?: {
+                additionalProperties?: string;
+            };
+        }
+        namespace Responses {
+            export interface $200 {
+                job_id?: string; // uuid
+                /**
+                 * Status of the job
+                 */
+                job_status?: "STARTED" | "PROCESSING" | "SUCCESS" | "FAILED";
+                /**
+                 * A message explaining the progress
+                 */
+                message?: string;
+                pdf_output?: {
+                    /**
+                     * Pre-signed S3 GET URL for PDF preview
+                     * example:
+                     * https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/my-template-OR-001.pdf
+                     */
+                    preview_url?: string;
+                    /**
+                     * example:
+                     * {
+                     *   "s3ref": {
+                     *     "bucket": "document-api-preview-prod",
+                     *     "key": "preview/my-template.pdf"
+                     *   }
+                     * }
+                     */
+                    output_document?: {
+                        /**
+                         * Generated document filename for PDF
+                         * example:
+                         * my-template-OR-001.pdf
+                         */
+                        filename?: string;
+                        s3ref?: Components.Schemas.S3Reference;
+                    };
+                };
+                docx_output?: {
+                    /**
+                     * Pre-signed S3 GET URL for DOCX preview
+                     * example:
+                     * https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/my-template-OR-001.docx
+                     */
+                    preview_url?: string;
+                    /**
+                     * example:
+                     * {
+                     *   "s3ref": {
+                     *     "bucket": "document-api-preview-prod",
+                     *     "key": "preview/my-template.docx"
+                     *   }
+                     * }
+                     */
+                    output_document?: {
+                        /**
+                         * Generated document filename for DOCX
+                         * example:
+                         * my-template-OR-001.docx
+                         */
+                        filename?: string;
+                        s3ref?: Components.Schemas.S3Reference;
+                    };
+                };
+                /**
+                 * List of variables and its corresponding replaced values from the document template
+                 */
+                variable_payload?: {
+                    additionalProperties?: string;
+                };
+            }
+        }
+    }
+}
+
+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>
+  /**
+   * generateDocumentV2 - generateDocumentV2
+   * 
+   * Builds document generated from input document with variables.
+   * 
+   * Supported input document types:
+   * - .docx
+   * 
+   * Supported output document types:
+   * - .pdf
+   * - .docx but limited to only text based variables
+   * 
+   * Uses [Template Variables API](https://docs.epilot.io/api/template-variables) to replace variables in the document.
+   * 
+   */
+  'generateDocumentV2'(
+    parameters?: Parameters<Paths.GenerateDocumentV2.QueryParameters> | null,
+    data?: Paths.GenerateDocumentV2.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GenerateDocumentV2.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>
+  }
+  ['/v2/documents:generate']: {
+    /**
+     * generateDocumentV2 - generateDocumentV2
+     * 
+     * Builds document generated from input document with variables.
+     * 
+     * Supported input document types:
+     * - .docx
+     * 
+     * Supported output document types:
+     * - .pdf
+     * - .docx but limited to only text based variables
+     * 
+     * Uses [Template Variables API](https://docs.epilot.io/api/template-variables) to replace variables in the document.
+     * 
+     */
+    'post'(
+      parameters?: Parameters<Paths.GenerateDocumentV2.QueryParameters> | null,
+      data?: Paths.GenerateDocumentV2.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GenerateDocumentV2.Responses.$200>
+  }
+}
+
+export type Client = OpenAPIClient<OperationMethods, PathsDictionary>