@epilot/file-client 1.8.0-rc1 → 1.8.0-rc2

package/dist/definition.js

@@ -1 +1 @@
-!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: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":{"post":{"operationId":"getSession"},"delete":{"operationId":"deleteSession"}}},"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)})());
+!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: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"}}},"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

@@ -198,7 +198,7 @@
       }
     },
     "/v1/files/session": {
-      "post": {
+      "get": {
         "operationId": "getSession"
       },
       "delete": {

package/dist/openapi.d.ts

@@ -9,6 +9,21 @@ import type {
 
 declare namespace Components {
     namespace Schemas {
+        export interface CommonSaveFilePayload {
+            [name: string]: any;
+            /**
+             * 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";
+            /**
+             * example:
+             * document.pdf
+             */
+            filename?: string;
+            _tags?: string[];
+            access_control?: "private" | "public-read";
+        }
         export interface DeleteFilePayload {
             s3ref: S3Reference;
         }
@@ -105,9 +120,8 @@ declare namespace Components {
              */
             key: string;
         }
-        export interface SaveFilePayload {
+        export interface SaveCustomFilePayload {
             [name: string]: any;
-            s3ref: S3Reference;
             /**
              * if passed, adds a new version to existing file entity
              */
@@ -120,6 +134,27 @@ declare namespace Components {
             filename?: string;
             _tags?: string[];
             access_control?: "private" | "public-read";
+            /**
+             * Custom external download url used for the file
+             */
+            custom_download_url: string; // url
+        }
+        export type SaveFilePayload = SaveS3FilePayload | SaveCustomFilePayload;
+        export interface SaveS3FilePayload {
+            [name: string]: any;
+            /**
+             * 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";
+            /**
+             * example:
+             * document.pdf
+             */
+            filename?: string;
+            _tags?: string[];
+            access_control?: "private" | "public-read";
+            s3ref: S3Reference;
         }
         export interface UploadFilePayload {
             /**
@@ -668,7 +703,7 @@ export interface PathsDictionary {
      * Allows using preview urls directly in img src for private files using cookie authentication.
      * 
      */
-    'post'(
+    'get'(
       parameters?: Parameters<UnknownParamsObject> | null,
       data?: any,
       config?: AxiosRequestConfig  

package/dist/openapi.json

@@ -157,6 +157,38 @@
             "application/json": {
               "schema": {
                 "$ref": "#/components/schemas/SaveFilePayload"
+              },
+              "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
+                  }
+                }
               }
             }
           }
@@ -574,7 +606,7 @@
       }
     },
     "/v1/files/session": {
-      "post": {
+      "get": {
         "operationId": "getSession",
         "summary": "getSession",
         "description": "Start a browser session by setting passed Authorization token in a server side cookie.\n\nAllows using preview urls directly in img src for private files using cookie authentication.\n",
@@ -724,12 +756,9 @@
           ]
         }
       },
-      "SaveFilePayload": {
+      "CommonSaveFilePayload": {
         "type": "object",
         "properties": {
-          "s3ref": {
-            "$ref": "#/components/schemas/S3Reference"
-          },
           "file_entity_id": {
             "type": "string",
             "description": "if passed, adds a new version to existing file entity"
@@ -770,9 +799,54 @@
             ]
           }
         },
-        "additionalProperties": true,
-        "required": [
-          "s3ref"
+        "additionalProperties": true
+      },
+      "SaveS3FilePayload": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/CommonSaveFilePayload"
+          },
+          {
+            "type": "object",
+            "properties": {
+              "s3ref": {
+                "$ref": "#/components/schemas/S3Reference"
+              }
+            },
+            "required": [
+              "s3ref"
+            ]
+          }
+        ]
+      },
+      "SaveCustomFilePayload": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/CommonSaveFilePayload"
+          },
+          {
+            "type": "object",
+            "properties": {
+              "custom_download_url": {
+                "description": "Custom external download url used for the file",
+                "type": "string",
+                "format": "url"
+              }
+            },
+            "required": [
+              "custom_download_url"
+            ]
+          }
+        ]
+      },
+      "SaveFilePayload": {
+        "anyOf": [
+          {
+            "$ref": "#/components/schemas/SaveS3FilePayload"
+          },
+          {
+            "$ref": "#/components/schemas/SaveCustomFilePayload"
+          }
         ]
       },
       "DeleteFilePayload": {

package/package.json

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