@epilot/file-client 1.7.0 → 1.7.2

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/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)})());
+!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

@@ -61,7 +61,7 @@
         ]
       }
     },
-    "/v1/files/download": {
+    "/v1/files:downloadFiles": {
       "post": {
         "operationId": "downloadFiles",
         "requestBody": {
@@ -145,6 +145,29 @@
       }
     },
     "/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": [
@@ -173,6 +196,14 @@
           }
         }
       }
+    },
+    "/v1/files/session": {
+      "get": {
+        "operationId": "getSession"
+      },
+      "delete": {
+        "operationId": "deleteSession"
+      }
     }
   },
   "components": {},

package/dist/openapi.d.ts

@@ -9,6 +9,25 @@ 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";
+            /**
+             * List of entities to relate the file to
+             */
+            relations?: FileRelationItem[];
+        }
         export interface DeleteFilePayload {
             s3ref: S3Reference;
         }
@@ -25,6 +44,17 @@ declare namespace Components {
              */
             version?: number;
         }[];
+        /**
+         * example:
+         * ef7d985c-2385-44f4-9c71-ae06a52264f8
+         */
+        export type EntityId = string;
+        /**
+         * URL-friendly identifier for the entity schema
+         * example:
+         * contact
+         */
+        export type EntitySlug = string;
         export interface FileEntity {
             _id?: /**
              * example:
@@ -93,6 +123,20 @@ declare namespace Components {
              */
             mime_type?: string;
         }
+        export interface FileRelationItem {
+            entity_id: /**
+             * example:
+             * ef7d985c-2385-44f4-9c71-ae06a52264f8
+             */
+            EntityId;
+            _schema?: /**
+             * URL-friendly identifier for the entity schema
+             * example:
+             * contact
+             */
+            EntitySlug;
+            _tags?: string[];
+        }
         export interface S3Reference {
             /**
              * example:
@@ -105,9 +149,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 +163,35 @@ declare namespace Components {
             filename?: string;
             _tags?: string[];
             access_control?: "private" | "public-read";
+            /**
+             * List of entities to relate the file to
+             */
+            relations?: FileRelationItem[];
+            /**
+             * 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";
+            /**
+             * List of entities to relate the file to
+             */
+            relations?: FileRelationItem[];
+            s3ref: S3Reference;
         }
         export interface UploadFilePayload {
             /**
@@ -144,6 +216,12 @@ declare namespace Paths {
             }
         }
     }
+    namespace DeleteSession {
+        namespace Responses {
+            export interface $200 {
+            }
+        }
+    }
     namespace DownloadFile {
         namespace Parameters {
             export type Attachment = boolean;
@@ -205,6 +283,12 @@ declare namespace Paths {
             }
         }
     }
+    namespace GetSession {
+        namespace Responses {
+            export interface $200 {
+            }
+        }
+    }
     namespace PreviewFile {
         namespace Parameters {
             export type H = number;
@@ -258,6 +342,20 @@ declare namespace Paths {
         }
         export type RequestBody = Components.Schemas.S3Reference;
     }
+    namespace PreviewS3FileGet {
+        namespace Parameters {
+            export type Bucket = string;
+            export type H = number;
+            export type Key = string;
+            export type W = number;
+        }
+        export interface QueryParameters {
+            key: Parameters.Key;
+            bucket: Parameters.Bucket;
+            w?: Parameters.W;
+            h?: Parameters.H;
+        }
+    }
     namespace SaveFile {
         export type RequestBody = Components.Schemas.SaveFilePayload;
         namespace Responses {
@@ -436,6 +534,16 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<any>
+  /**
+   * previewS3FileGet - previewS3FileGet
+   * 
+   * Get thumbnail preview from an s3 reference for a file entity
+   */
+  'previewS3FileGet'(
+    parameters?: Parameters<Paths.PreviewS3FileGet.QueryParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<any>
   /**
    * previewS3File - previewS3File
    * 
@@ -456,6 +564,29 @@ export interface OperationMethods {
     data?: Paths.DeleteFile.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.DeleteFile.Responses.$200>
+  /**
+   * getSession - getSession
+   * 
+   * Start a browser session by setting passed Authorization token in a server side cookie.
+   * 
+   * Allows using preview urls directly in img src for private files using cookie authentication.
+   * 
+   */
+  'getSession'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetSession.Responses.$200>
+  /**
+   * deleteSession - deleteSession
+   * 
+   * End browser session by deleting token cookie
+   */
+  'deleteSession'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.DeleteSession.Responses.$200>
 }
 
 export interface PathsDictionary {
@@ -518,7 +649,7 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.DownloadFile.Responses.$200>
   }
-  ['/v1/files/download']: {
+  ['/v1/files:downloadFiles']: {
     /**
      * downloadFiles - downloadFiles
      * 
@@ -567,6 +698,16 @@ export interface PathsDictionary {
     ): OperationResponse<any>
   }
   ['/v1/files:previewS3']: {
+    /**
+     * previewS3FileGet - previewS3FileGet
+     * 
+     * Get thumbnail preview from an s3 reference for a file entity
+     */
+    'get'(
+      parameters?: Parameters<Paths.PreviewS3FileGet.QueryParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<any>
     /**
      * previewS3File - previewS3File
      * 
@@ -590,6 +731,31 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.DeleteFile.Responses.$200>
   }
+  ['/v1/files/session']: {
+    /**
+     * getSession - getSession
+     * 
+     * Start a browser session by setting passed Authorization token in a server side cookie.
+     * 
+     * Allows using preview urls directly in img src for private files using cookie authentication.
+     * 
+     */
+    'get'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetSession.Responses.$200>
+    /**
+     * deleteSession - deleteSession
+     * 
+     * End browser session by deleting token cookie
+     */
+    'delete'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.DeleteSession.Responses.$200>
+  }
 }
 
 export type Client = OpenAPIClient<OperationMethods, PathsDictionary>

package/dist/openapi.json

@@ -8,12 +8,19 @@
   "tags": [
     {
       "name": "files",
-      "description": "Files"
+      "description": "Files API"
+    },
+    {
+      "name": "session",
+      "description": "Session API for cookie authentication"
     }
   ],
   "security": [
     {
       "EpilotAuth": []
+    },
+    {
+      "CookieAuth": []
     }
   ],
   "paths": {
@@ -150,6 +157,58 @@
             "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
+                  }
+                },
+                "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"
+                      }
+                    ]
+                  }
+                }
               }
             }
           }
@@ -225,7 +284,7 @@
         }
       }
     },
-    "/v1/files/download": {
+    "/v1/files:downloadFiles": {
       "post": {
         "operationId": "downloadFiles",
         "summary": "downloadFiles",
@@ -444,6 +503,59 @@
       }
     },
     "/v1/files:previewS3": {
+      "get": {
+        "operationId": "previewS3FileGet",
+        "summary": "previewS3FileGet",
+        "description": "Get thumbnail preview from an s3 reference for a file entity",
+        "tags": [
+          "files"
+        ],
+        "parameters": [
+          {
+            "name": "key",
+            "in": "query",
+            "description": "s3 key",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "bucket",
+            "in": "query",
+            "description": "s3 bucket",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "w",
+            "in": "query",
+            "description": "width",
+            "schema": {
+              "type": "integer"
+            }
+          },
+          {
+            "name": "h",
+            "in": "query",
+            "description": "height",
+            "schema": {
+              "type": "integer"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Generated thumbnail image",
+            "content": {
+              "image/png": {},
+              "image/jpeg": {}
+            }
+          }
+        }
+      },
       "post": {
         "operationId": "previewS3File",
         "summary": "previewS3File",
@@ -512,6 +624,34 @@
           }
         }
       }
+    },
+    "/v1/files/session": {
+      "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",
+        "tags": [
+          "session"
+        ],
+        "responses": {
+          "200": {
+            "description": "Session started successfully"
+          }
+        }
+      },
+      "delete": {
+        "operationId": "deleteSession",
+        "summary": "deleteSession",
+        "description": "End browser session by deleting token cookie",
+        "tags": [
+          "session"
+        ],
+        "responses": {
+          "200": {
+            "description": "Session deleted successfully"
+          }
+        }
+      }
     }
   },
   "components": {
@@ -521,9 +661,24 @@
         "scheme": "bearer",
         "description": "Authorization header with epilot OAuth2 bearer token",
         "bearerFormat": "JWT"
+      },
+      "CookieAuth": {
+        "type": "apiKey",
+        "in": "cookie",
+        "name": "token",
+        "description": "Cookie with epilot OAuth2 token"
       }
     },
     "schemas": {
+      "EntityId": {
+        "type": "string",
+        "example": "ef7d985c-2385-44f4-9c71-ae06a52264f8"
+      },
+      "EntitySlug": {
+        "description": "URL-friendly identifier for the entity schema",
+        "type": "string",
+        "example": "contact"
+      },
       "FileEntityId": {
         "type": "string",
         "example": "ef7d985c-2385-44f4-9c71-ae06a52264f8"
@@ -630,12 +785,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"
@@ -674,11 +826,63 @@
               "private",
               "public-read"
             ]
+          },
+          "relations": {
+            "type": "array",
+            "description": "List of entities to relate the file to",
+            "items": {
+              "$ref": "#/components/schemas/FileRelationItem"
+            }
           }
         },
-        "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": {
@@ -732,10 +936,33 @@
             }
           }
         ]
+      },
+      "FileRelationItem": {
+        "type": "object",
+        "properties": {
+          "entity_id": {
+            "$ref": "#/components/schemas/EntityId"
+          },
+          "_schema": {
+            "$ref": "#/components/schemas/EntitySlug"
+          },
+          "_tags": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          }
+        },
+        "required": [
+          "entity_id"
+        ]
       }
     }
   },
   "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.7.0",
+  "version": "1.7.2",
   "description": "Client library for the epilot File API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",