Merge pull request #105 from epilot-dev/update-file-client-with-new-spec

Update file client with new spec
epilot-dev · Sep 21, 2023 · 4b09c2a · 4b09c2a
2 parents 12d25c4 + d526c98
commit 4b09c2a
Show file tree

Hide file tree

Showing 5 changed files with 437 additions and 13 deletions.
diff --git a/clients/file-client/package-lock.json b/clients/file-client/package-lock.json
diff --git a/clients/file-client/package.json b/clients/file-client/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@epilot/file-client",
-  "version": "1.7.1",
+  "version": "1.7.2",
   "description": "Client library for the epilot File API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

diff --git a/clients/file-client/src/openapi-runtime.json b/clients/file-client/src/openapi-runtime.json
@@ -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": {},

diff --git a/clients/file-client/src/openapi.d.ts b/clients/file-client/src/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 {
@@ -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>