@epilot/file-client 1.7.0 → 1.8.0-rc1

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":{"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)})());

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": {
+      "post": {
+        "operationId": "getSession"
+      },
+      "delete": {
+        "operationId": "deleteSession"
+      }
     }
   },
   "components": {},

package/dist/openapi.d.ts

@@ -144,6 +144,12 @@ declare namespace Paths {
             }
         }
     }
+    namespace DeleteSession {
+        namespace Responses {
+            export interface $200 {
+            }
+        }
+    }
     namespace DownloadFile {
         namespace Parameters {
             export type Attachment = boolean;
@@ -205,6 +211,12 @@ declare namespace Paths {
             }
         }
     }
+    namespace GetSession {
+        namespace Responses {
+            export interface $200 {
+            }
+        }
+    }
     namespace PreviewFile {
         namespace Parameters {
             export type H = number;
@@ -258,6 +270,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 +462,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 +492,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 +577,7 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.DownloadFile.Responses.$200>
   }
-  ['/v1/files/download']: {
+  ['/v1/files:downloadFiles']: {
     /**
      * downloadFiles - downloadFiles
      * 
@@ -567,6 +626,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 +659,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.
+     * 
+     */
+    'post'(
+      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": {
@@ -225,7 +232,7 @@
         }
       }
     },
-    "/v1/files/download": {
+    "/v1/files:downloadFiles": {
       "post": {
         "operationId": "downloadFiles",
         "summary": "downloadFiles",
@@ -444,6 +451,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 +572,34 @@
           }
         }
       }
+    },
+    "/v1/files/session": {
+      "post": {
+        "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,6 +609,12 @@
         "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": {

package/package.json

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