@epilot/file-client 1.6.0 → 1.7.0

package/dist/definition.js

@@ -1 +1 @@
-!function(e,t){for(var i in t)e[i]=t[i];t.__esModule&&Object.defineProperty(e,"__esModule",{value:!0})}(exports,(()=>{"use strict";var e={914:function(e,t,i){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var n=r(i(946));t.default=n.default},946: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: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:previewS3":{"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":{}}}}}},"components":{},"servers":[{"url":"https://file.sls.epilot.io"}]}')}},t={};return function i(r){if(t[r])return t[r].exports;var n=t[r]={exports:{}};return e[r].call(n.exports,n,n.exports,i),n.exports}(914)})());
+!function(e,i){for(var t in i)e[t]=i[t];i.__esModule&&Object.defineProperty(e,"__esModule",{value:!0})}(exports,(()=>{"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(946));i.default=r.default},946: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":{"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":{"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":{}}}}}},"components":{},"servers":[{"url":"https://file.sls.epilot.io"}]}')}},i={};return function t(n){if(i[n])return i[n].exports;var r=i[n]={exports:{}};return e[n].call(r.exports,r,r.exports,t),r.exports}(914)})());

package/dist/openapi-runtime.json

@@ -61,6 +61,16 @@
         ]
       }
     },
+    "/v1/files/download": {
+      "post": {
+        "operationId": "downloadFiles",
+        "requestBody": {
+          "content": {
+            "application/json": {}
+          }
+        }
+      }
+    },
     "/v1/files:downloadS3": {
       "post": {
         "operationId": "downloadS3File",
@@ -106,6 +116,34 @@
         ]
       }
     },
+    "/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": {
       "post": {
         "operationId": "previewS3File",

package/dist/openapi.d.ts

@@ -12,6 +12,19 @@ declare namespace Components {
         export interface DeleteFilePayload {
             s3ref: S3Reference;
         }
+        export type DownloadFilesPayload = {
+            id: /**
+             * example:
+             * ef7d985c-2385-44f4-9c71-ae06a52264f8
+             */
+            FileEntityId;
+            /**
+             * File version
+             * example:
+             * 0
+             */
+            version?: number;
+        }[];
         export interface FileEntity {
             _id?: /**
              * example:
@@ -158,6 +171,19 @@ declare namespace Paths {
             }
         }
     }
+    namespace DownloadFiles {
+        export type RequestBody = Components.Schemas.DownloadFilesPayload;
+        namespace Responses {
+            export type $200 = {
+                /**
+                 * example:
+                 * https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
+                 */
+                download_url?: string; // uri
+                file_entity_id?: string; // uuid
+            }[];
+        }
+    }
     namespace DownloadS3File {
         namespace Parameters {
             export type Attachment = boolean;
@@ -199,6 +225,28 @@ declare namespace Paths {
             h?: Parameters.H;
         }
     }
+    namespace PreviewPublicFile {
+        namespace Parameters {
+            export type H = number;
+            export type Id = /**
+             * example:
+             * ef7d985c-2385-44f4-9c71-ae06a52264f8
+             */
+            Components.Schemas.FileEntityId;
+            export type OrgId = string;
+            export type Version = number;
+            export type W = number;
+        }
+        export interface PathParameters {
+            id: Parameters.Id;
+        }
+        export interface QueryParameters {
+            version?: Parameters.Version;
+            w?: Parameters.W;
+            h?: Parameters.H;
+            org_id?: Parameters.OrgId;
+        }
+    }
     namespace PreviewS3File {
         namespace Parameters {
             export type H = number;
@@ -348,6 +396,16 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.DownloadFile.Responses.$200>
+  /**
+   * downloadFiles - downloadFiles
+   * 
+   * Generate pre-signed download S3 urls for multiple files
+   */
+  'downloadFiles'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.DownloadFiles.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.DownloadFiles.Responses.$200>
   /**
    * downloadS3File - downloadS3File
    * 
@@ -368,6 +426,16 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<any>
+  /**
+   * previewPublicFile - previewPublicFile
+   * 
+   * Generate thumbnail preview for a public file entity
+   */
+  'previewPublicFile'(
+    parameters?: Parameters<Paths.PreviewPublicFile.PathParameters & Paths.PreviewPublicFile.QueryParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<any>
   /**
    * previewS3File - previewS3File
    * 
@@ -450,6 +518,18 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.DownloadFile.Responses.$200>
   }
+  ['/v1/files/download']: {
+    /**
+     * downloadFiles - downloadFiles
+     * 
+     * Generate pre-signed download S3 urls for multiple files
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.DownloadFiles.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.DownloadFiles.Responses.$200>
+  }
   ['/v1/files:downloadS3']: {
     /**
      * downloadS3File - downloadS3File
@@ -474,6 +554,18 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<any>
   }
+  ['/v1/files/public/{id}/preview']: {
+    /**
+     * previewPublicFile - previewPublicFile
+     * 
+     * Generate thumbnail preview for a public file entity
+     */
+    'get'(
+      parameters?: Parameters<Paths.PreviewPublicFile.PathParameters & Paths.PreviewPublicFile.QueryParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<any>
+  }
   ['/v1/files:previewS3']: {
     /**
      * previewS3File - previewS3File

package/dist/openapi.json

@@ -225,6 +225,51 @@
         }
       }
     },
+    "/v1/files/download": {
+      "post": {
+        "operationId": "downloadFiles",
+        "summary": "downloadFiles",
+        "description": "Generate pre-signed download S3 urls for multiple files",
+        "tags": [
+          "files"
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/DownloadFilesPayload"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Generated download urls",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "properties": {
+                      "download_url": {
+                        "type": "string",
+                        "format": "uri",
+                        "example": "https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123"
+                      },
+                      "file_entity_id": {
+                        "type": "string",
+                        "format": "uuid"
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/v1/files:downloadS3": {
       "post": {
         "operationId": "downloadS3File",
@@ -335,6 +380,69 @@
         }
       }
     },
+    "/v1/files/public/{id}/preview": {
+      "get": {
+        "operationId": "previewPublicFile",
+        "summary": "previewPublicFile",
+        "description": "Generate thumbnail preview for a public file entity",
+        "security": [],
+        "tags": [
+          "files"
+        ],
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "$ref": "#/components/schemas/FileEntityId"
+            }
+          },
+          {
+            "name": "version",
+            "in": "query",
+            "description": "index of file version",
+            "schema": {
+              "type": "integer",
+              "default": 0
+            }
+          },
+          {
+            "name": "w",
+            "in": "query",
+            "description": "width",
+            "schema": {
+              "type": "integer"
+            }
+          },
+          {
+            "name": "h",
+            "in": "query",
+            "description": "height",
+            "schema": {
+              "type": "integer"
+            }
+          },
+          {
+            "name": "org_id",
+            "in": "query",
+            "description": "Org id",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Generated thumbnail image for a public file",
+            "content": {
+              "image/png": {},
+              "image/jpeg": {}
+            }
+          }
+        }
+      }
+    },
     "/v1/files:previewS3": {
       "post": {
         "operationId": "previewS3File",
@@ -503,6 +611,25 @@
           "filename"
         ]
       },
+      "DownloadFilesPayload": {
+        "type": "array",
+        "items": {
+          "type": "object",
+          "properties": {
+            "id": {
+              "$ref": "#/components/schemas/FileEntityId"
+            },
+            "version": {
+              "type": "integer",
+              "description": "File version",
+              "example": 0
+            }
+          },
+          "required": [
+            "id"
+          ]
+        }
+      },
       "SaveFilePayload": {
         "type": "object",
         "properties": {
@@ -609,9 +736,6 @@
     }
   },
   "servers": [
-    {
-      "url": "https://file.sls.epilot.io"
-    },
     {
       "url": "https://file.sls.epilot.io"
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/file-client",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "Client library for the epilot File API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",