@epilot/file-client 1.10.0 → 1.11.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/dist/definition.js

@@ -1 +1 @@
-(()=>{"use strict";var e={914:function(e,i,r){var t=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(i,"__esModule",{value:!0});var n=t(r(240));i.default=n.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"paths":{"/v1/files/public/upload":{"post":{"operationId":"uploadFilePublic","requestBody":{"content":{"application/json":{}}}}},"/v1/files/upload":{"post":{"operationId":"uploadFile","parameters":[{"name":"file_entity_id","in":"query"}],"requestBody":{"content":{"application/json":{}}}}},"/v1/files":{"post":{"operationId":"saveFile","requestBody":{"content":{"application/json":{}}}}},"/v1/files/{id}/download":{"get":{"operationId":"downloadFile","parameters":[{"name":"id","in":"path","required":true},{"name":"version","in":"query"},{"name":"attachment","in":"query"}]}},"/v1/files/download:verify":{"post":{"operationId":"verifyCustomDownloadUrl","requestBody":{"content":{"application/json":{}}}}},"/v1/files:downloadFiles":{"post":{"operationId":"downloadFiles","requestBody":{"content":{"application/json":{}}}}},"/v1/files:downloadS3":{"post":{"operationId":"downloadS3File","parameters":[{"name":"s3_key","in":"query","required":true},{"name":"s3_bucket","in":"query","required":true},{"name":"attachment","in":"query"}]}},"/v1/files/{id}/preview":{"get":{"operationId":"previewFile","parameters":[{"name":"id","in":"path","required":true},{"name":"version","in":"query"},{"name":"w","in":"query"},{"name":"h","in":"query"}]}},"/v1/files/public/{id}/preview":{"get":{"operationId":"previewPublicFile","parameters":[{"name":"id","in":"path","required":true},{"name":"version","in":"query"},{"name":"w","in":"query"},{"name":"h","in":"query"},{"name":"org_id","in":"query"}]}},"/v1/files:previewS3":{"get":{"operationId":"previewS3FileGet","parameters":[{"name":"key","in":"query","required":true},{"name":"bucket","in":"query","required":true},{"name":"w","in":"query"},{"name":"h","in":"query"}]},"post":{"operationId":"previewS3File","parameters":[{"name":"w","in":"query"},{"name":"h","in":"query"}],"requestBody":{"content":{"application/json":{}}}}},"/v1/files/delete":{"delete":{"operationId":"deleteFile","requestBody":{"content":{"application/json":{}}}}},"/v1/files/session":{"get":{"operationId":"getSession"},"delete":{"operationId":"deleteSession"}},"/v1/files/{id}/public/links":{"post":{"operationId":"generatePublicLink","parameters":[{"name":"id","in":"path","required":true}]},"get":{"operationId":"getAllPublicLinksForFile","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/files/public/links/{id}/{filename}":{"get":{"operationId":"accessPublicLink","parameters":[{"name":"id","in":"path","required":true},{"name":"filename","in":"path","required":true}]},"delete":{"operationId":"revokePublicLink","parameters":[{"name":"id","in":"path","required":true}]}}},"components":{},"servers":[{"url":"https://file.sls.epilot.io"}]}')}},i={},r=function r(t){var n=i[t];if(void 0!==n)return n.exports;var o=i[t]={exports:{}};return e[t].call(o.exports,o,o.exports,r),o.exports}(914),t=exports;for(var n in r)t[n]=r[n];r.__esModule&&Object.defineProperty(t,"__esModule",{value:!0})})();
+(()=>{"use strict";var e={914:function(e,i,t){var n=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(i,"__esModule",{value:!0});var r=n(t(240));i.default=r.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"paths":{"/v1/files/public/upload":{"post":{"operationId":"uploadFilePublic","requestBody":{"content":{"application/json":{}}}}},"/v1/files/upload":{"post":{"operationId":"uploadFile","parameters":[{"name":"file_entity_id","in":"query"}],"requestBody":{"content":{"application/json":{}}}}},"/v1/files":{"post":{"operationId":"saveFile","requestBody":{"content":{"application/json":{}}}}},"/v1/files/{id}/download":{"get":{"operationId":"downloadFile","parameters":[{"name":"id","in":"path","required":true},{"name":"version","in":"query"},{"name":"attachment","in":"query"}]}},"/v1/files/download:verify":{"post":{"operationId":"verifyCustomDownloadUrl","requestBody":{"content":{"application/json":{}}}}},"/v1/files:downloadFiles":{"post":{"operationId":"downloadFiles","requestBody":{"content":{"application/json":{}}}}},"/v1/files:downloadS3":{"post":{"operationId":"downloadS3File","parameters":[{"name":"s3_key","in":"query","required":true},{"name":"s3_bucket","in":"query","required":true},{"name":"attachment","in":"query"}]}},"/v1/files/{id}/preview":{"get":{"operationId":"previewFile","parameters":[{"name":"id","in":"path","required":true},{"name":"version","in":"query"},{"name":"w","in":"query"},{"name":"h","in":"query"}]}},"/v1/files/public/{id}/preview":{"get":{"operationId":"previewPublicFile","parameters":[{"name":"id","in":"path","required":true},{"name":"version","in":"query"},{"name":"w","in":"query"},{"name":"h","in":"query"},{"name":"org_id","in":"query"}]}},"/v1/files:previewS3":{"get":{"operationId":"previewS3FileGet","parameters":[{"name":"key","in":"query","required":true},{"name":"bucket","in":"query","required":true},{"name":"w","in":"query"},{"name":"h","in":"query"}]},"post":{"operationId":"previewS3File","parameters":[{"name":"w","in":"query"},{"name":"h","in":"query"}],"requestBody":{"content":{"application/json":{}}}}},"/v1/files/delete":{"delete":{"operationId":"deleteFile","requestBody":{"content":{"application/json":{}}}}},"/v1/files/session":{"get":{"operationId":"getSession"},"delete":{"operationId":"deleteSession"}},"/v1/files/{id}/public/links":{"post":{"operationId":"generatePublicLink","parameters":[{"name":"id","in":"path","required":true}]},"get":{"operationId":"getAllPublicLinksForFile","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/files/public/links/{id}/{filename}":{"get":{"operationId":"accessPublicLink","parameters":[{"name":"id","in":"path","required":true},{"name":"filename","in":"path","required":true}]}},"/v1/files/public/links/{id}":{"delete":{"operationId":"revokePublicLink","parameters":[{"name":"id","in":"path","required":true}]}},"/v2/files/upload":{"post":{"operationId":"uploadFileV2","parameters":[{"name":"file_entity_id","in":"query"}],"requestBody":{"content":{"application/json":{}}}}},"/v2/files":{"post":{"operationId":"saveFileV2","requestBody":{"content":{"application/json":{}}}}}},"components":{},"servers":[{"url":"https://file.sls.epilot.io"}]}')}},i={},t=function t(n){var r=i[n];if(void 0!==r)return r.exports;var o=i[n]={exports:{}};return e[n].call(o.exports,o,o.exports,t),o.exports}(914),n=exports;for(var r in t)n[r]=t[r];t.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();

package/dist/openapi-runtime.json

@@ -252,7 +252,9 @@
             "required": true
           }
         ]
-      },
+      }
+    },
+    "/v1/files/public/links/{id}": {
       "delete": {
         "operationId": "revokePublicLink",
         "parameters": [
@@ -263,6 +265,32 @@
           }
         ]
       }
+    },
+    "/v2/files/upload": {
+      "post": {
+        "operationId": "uploadFileV2",
+        "parameters": [
+          {
+            "name": "file_entity_id",
+            "in": "query"
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {}
+          }
+        }
+      }
+    },
+    "/v2/files": {
+      "post": {
+        "operationId": "saveFileV2",
+        "requestBody": {
+          "content": {
+            "application/json": {}
+          }
+        }
+      }
     }
   },
   "components": {},

package/dist/openapi.d.ts

@@ -137,6 +137,38 @@ declare namespace Components {
             EntitySlug;
             _tags?: string[];
         }
+        export interface FileUpload {
+            /**
+             * example:
+             * {
+             *   "bucket": "epilot-files-prod",
+             *   "key": "123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"
+             * }
+             */
+            s3ref?: {
+                /**
+                 * example:
+                 * epilot-files-prod
+                 */
+                bucket: string;
+                /**
+                 * example:
+                 * 123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
+                 */
+                key: string;
+            };
+            /**
+             * example:
+             * https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
+             */
+            upload_url?: string; // url
+            /**
+             * Returned only if file is permanent i.e. file_entity_id is passed
+             * example:
+             * https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
+             */
+            public_url?: string; // url
+        }
         export interface PublicLink {
             /**
              * ID of the public link
@@ -191,6 +223,37 @@ declare namespace Components {
             custom_download_url: string; // uri
         }
         export type SaveFilePayload = SaveS3FilePayload | SaveCustomFilePayload;
+        export interface SaveFilePayloadV2 {
+            [name: string]: any;
+            s3ref: {
+                /**
+                 * example:
+                 * epilot-files-prod
+                 */
+                bucket: string;
+                /**
+                 * example:
+                 * 123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
+                 */
+                key: string;
+            };
+            /**
+             * example:
+             * document.pdf
+             */
+            filename: string;
+            /**
+             * if passed, adds a new version to existing file entity
+             */
+            file_entity_id?: string;
+            document_type?: "document" | "document_template" | "text" | "image" | "video" | "audio" | "spreadsheet" | "presentation" | "font" | "archive" | "application" | "unknown";
+            _tags?: string[];
+            access_control?: "private" | "public-read";
+            /**
+             * Custom external download url used for the file
+             */
+            custom_download_url?: string; // uri
+        }
         export interface SaveS3FilePayload {
             [name: string]: any;
             /**
@@ -223,6 +286,16 @@ declare namespace Components {
              * application/pdf
              */
             mime_type?: string;
+            /**
+             * Allows passing in custom metadata for the file, expects key-value pairs of string type
+             * example:
+             * {
+             *   "color": "blue"
+             * }
+             */
+            metadata?: {
+                [name: string]: string;
+            };
         }
         export interface VerifyCustomDownloadUrlPayload {
             /**
@@ -489,6 +562,12 @@ declare namespace Paths {
             export type $201 = Components.Schemas.FileEntity;
         }
     }
+    namespace SaveFileV2 {
+        export type RequestBody = Components.Schemas.SaveFilePayloadV2;
+        namespace Responses {
+            export type $201 = Components.Schemas.FileEntity;
+        }
+    }
     namespace UploadFile {
         namespace Parameters {
             export type FileEntityId = /**
@@ -567,6 +646,22 @@ declare namespace Paths {
             }
         }
     }
+    namespace UploadFileV2 {
+        namespace Parameters {
+            export type FileEntityId = /**
+             * example:
+             * ef7d985c-2385-44f4-9c71-ae06a52264f8
+             */
+            Components.Schemas.FileEntityId;
+        }
+        export interface QueryParameters {
+            file_entity_id?: Parameters.FileEntityId;
+        }
+        export type RequestBody = Components.Schemas.UploadFilePayload;
+        namespace Responses {
+            export type $201 = Components.Schemas.FileUpload;
+        }
+    }
     namespace VerifyCustomDownloadUrl {
         export type RequestBody = Components.Schemas.VerifyCustomDownloadUrlPayload;
         namespace Responses {
@@ -773,6 +868,34 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.RevokePublicLink.Responses.$204>
+  /**
+   * uploadFileV2 - uploadFileV2
+   * 
+   * Create pre-signed S3 URL to upload a file to keep temporarily (one week). - v2
+   * 
+   * Use the createFile operation to store file file permanently.
+   * 
+   */
+  'uploadFileV2'(
+    parameters?: Parameters<Paths.UploadFileV2.QueryParameters> | null,
+    data?: Paths.UploadFileV2.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.UploadFileV2.Responses.$201>
+  /**
+   * saveFileV2 - saveFileV2
+   * 
+   * Create / Update a permanent File entity
+   * 
+   * Makes file object permanent
+   * 
+   * Saves metadata to file entity
+   * 
+   */
+  'saveFileV2'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.SaveFileV2.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.SaveFileV2.Responses.$201>
 }
 
 export interface PathsDictionary {
@@ -988,6 +1111,8 @@ export interface PathsDictionary {
       data?: any,
       config?: AxiosRequestConfig  
     ): OperationResponse<any>
+  }
+  ['/v1/files/public/links/{id}']: {
     /**
      * revokePublicLink - revokePublicLink
      * 
@@ -999,6 +1124,38 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.RevokePublicLink.Responses.$204>
   }
+  ['/v2/files/upload']: {
+    /**
+     * uploadFileV2 - uploadFileV2
+     * 
+     * Create pre-signed S3 URL to upload a file to keep temporarily (one week). - v2
+     * 
+     * Use the createFile operation to store file file permanently.
+     * 
+     */
+    'post'(
+      parameters?: Parameters<Paths.UploadFileV2.QueryParameters> | null,
+      data?: Paths.UploadFileV2.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.UploadFileV2.Responses.$201>
+  }
+  ['/v2/files']: {
+    /**
+     * saveFileV2 - saveFileV2
+     * 
+     * Create / Update a permanent File entity
+     * 
+     * Makes file object permanent
+     * 
+     * Saves metadata to file entity
+     * 
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.SaveFileV2.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.SaveFileV2.Responses.$201>
+  }
 }
 
 export type Client = OpenAPIClient<OperationMethods, PathsDictionary>

package/dist/openapi.json

@@ -799,7 +799,9 @@
             "description": "Redirect to signed URL where the caller can access the file"
           }
         }
-      },
+      }
+    },
+    "/v1/files/public/links/{id}": {
       "delete": {
         "operationId": "revokePublicLink",
         "summary": "revokePublicLink",
@@ -835,6 +837,131 @@
           }
         }
       }
+    },
+    "/v2/files/upload": {
+      "post": {
+        "operationId": "uploadFileV2",
+        "summary": "uploadFileV2",
+        "description": "Create pre-signed S3 URL to upload a file to keep temporarily (one week). - v2\n\nUse the createFile operation to store file file permanently.\n",
+        "tags": [
+          "files"
+        ],
+        "parameters": [
+          {
+            "name": "file_entity_id",
+            "in": "query",
+            "description": "file entity id",
+            "schema": {
+              "$ref": "#/components/schemas/FileEntityId"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/UploadFilePayload",
+                "type": "object"
+              }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "description": "Pre-signed URL for POST / PUT upload",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/FileUpload"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v2/files": {
+      "post": {
+        "operationId": "saveFileV2",
+        "summary": "saveFileV2",
+        "description": "Create / Update a permanent File entity\n\nMakes file object permanent\n\nSaves metadata to file entity\n",
+        "tags": [
+          "files"
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/SaveFilePayloadV2"
+              },
+              "examples": {
+                "S3File": {
+                  "description": "Standard epilot file entity with S3 Ref",
+                  "value": {
+                    "file_entity_id": "string",
+                    "document_type": "document",
+                    "filename": "document.pdf",
+                    "_tags": [
+                      "string"
+                    ],
+                    "access_control": "private",
+                    "s3ref": {
+                      "bucket": "epilot-files-prod",
+                      "key": "123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"
+                    }
+                  }
+                },
+                "CustomFile": {
+                  "description": "Custom file entity with custom download url",
+                  "value": {
+                    "file_entity_id": "string",
+                    "document_type": "document",
+                    "filename": "document.pdf",
+                    "_tags": [
+                      "string"
+                    ],
+                    "access_control": "private",
+                    "custom_download_url": "https://some-api-url.com/download?file_id=123",
+                    "shared_with_end_customer": true
+                  }
+                },
+                "CustomFileWithRelations": {
+                  "description": "Custom file entity with custom download url",
+                  "value": {
+                    "file_entity_id": "string",
+                    "document_type": "document",
+                    "filename": "document.pdf",
+                    "_tags": [
+                      "string"
+                    ],
+                    "access_control": "private",
+                    "custom_download_url": "https://some-api-url.com/download?file_id=123",
+                    "shared_with_end_customer": true,
+                    "relations": [
+                      {
+                        "entity_id": "77a1e0cc-7b92-4d41-8cce-eefd317ec004",
+                        "_schema": "contact"
+                      }
+                    ]
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "description": "Created File Entity",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/FileEntity"
+                }
+              }
+            }
+          }
+        }
+      }
     }
   },
   "components": {
@@ -943,12 +1070,55 @@
             "type": "string",
             "example": "application/pdf",
             "default": "application/octet-stream"
+          },
+          "metadata": {
+            "type": "object",
+            "additionalProperties": {
+              "anyOf": [
+                {
+                  "type": "string"
+                }
+              ]
+            },
+            "example": {
+              "color": "blue"
+            },
+            "description": "Allows passing in custom metadata for the file, expects key-value pairs of string type"
           }
         },
         "required": [
           "filename"
         ]
       },
+      "FileUpload": {
+        "type": "object",
+        "properties": {
+          "s3ref": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/S3Reference"
+              },
+              {
+                "example": {
+                  "bucket": "epilot-files-prod",
+                  "key": "123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"
+                }
+              }
+            ]
+          },
+          "upload_url": {
+            "type": "string",
+            "format": "url",
+            "example": "https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123"
+          },
+          "public_url": {
+            "description": "Returned only if file is permanent i.e. file_entity_id is passed",
+            "type": "string",
+            "format": "url",
+            "example": "https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"
+          }
+        }
+      },
       "DownloadFilesPayload": {
         "type": "array",
         "items": {
@@ -1068,6 +1238,77 @@
           }
         ]
       },
+      "SaveFilePayloadV2": {
+        "type": "object",
+        "properties": {
+          "s3ref": {
+            "type": "object",
+            "properties": {
+              "bucket": {
+                "type": "string",
+                "example": "epilot-files-prod"
+              },
+              "key": {
+                "type": "string",
+                "example": "123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"
+              }
+            },
+            "required": [
+              "bucket",
+              "key"
+            ]
+          },
+          "filename": {
+            "type": "string",
+            "example": "document.pdf"
+          },
+          "file_entity_id": {
+            "type": "string",
+            "description": "if passed, adds a new version to existing file entity"
+          },
+          "document_type": {
+            "type": "string",
+            "enum": [
+              "document",
+              "document_template",
+              "text",
+              "image",
+              "video",
+              "audio",
+              "spreadsheet",
+              "presentation",
+              "font",
+              "archive",
+              "application",
+              "unknown"
+            ]
+          },
+          "_tags": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "access_control": {
+            "type": "string",
+            "default": "private",
+            "enum": [
+              "private",
+              "public-read"
+            ]
+          },
+          "custom_download_url": {
+            "description": "Custom external download url used for the file",
+            "type": "string",
+            "format": "uri"
+          }
+        },
+        "additionalProperties": true,
+        "required": [
+          "s3ref",
+          "filename"
+        ]
+      },
       "DeleteFilePayload": {
         "type": "object",
         "properties": {
@@ -1180,4 +1421,4 @@
       "url": "https://file.sls.epilot.io"
     }
   ]
-}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/file-client",
-  "version": "1.10.0",
+  "version": "1.11.0",
   "description": "Client library for the epilot File API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -70,5 +70,5 @@
     "webpack": "^5.18.0",
     "webpack-cli": "^4.4.0"
   },
-  "gitHead": "39426e86cfb320fa3227dc03f60ee6a10848e7c7"
-}
+  "gitHead": "25f84cc5cd8614b24fd23343697d70946768682f"
+}