@epilot/file-client 1.8.0 → 1.9.0

package/dist/definition.js

@@ -1 +1 @@
-(()=>{"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(240));i.default=r.default},240: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:verify":{"post":{"operationId":"verifyCustomDownloadUrl","requestBody":{"content":{"application/json":{}}}}},"/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={},t=function t(n){var r=i[n];if(void 0!==r)return r.exports;var o=i[n]={exports:{}};return e[n].call(o.exports,o,o.exports,t),o.exports}(914),n=exports;for(var r in t)n[r]=t[r];t.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();
+(()=>{"use strict";var e={914:function(e,i,r){var t=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(i,"__esModule",{value:!0});var n=t(r(240));i.default=n.default},240: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:verify":{"post":{"operationId":"verifyCustomDownloadUrl","requestBody":{"content":{"application/json":{}}}}},"/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"}},"/v1/files/{id}/public/links":{"post":{"operationId":"generatePublicLink","parameters":[{"name":"id","in":"path","required":true}]},"get":{"operationId":"getAllPublicLinksForFile","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/files/public/links/{id}/{filename}":{"get":{"operationId":"accessPublicLink","parameters":[{"name":"id","in":"path","required":true},{"name":"filename","in":"path","required":true}]},"delete":{"operationId":"revokePublicLink","parameters":[{"name":"id","in":"path","required":true}]}}},"components":{},"servers":[{"url":"https://file.sls.epilot.io"}]}')}},i={},r=function r(t){var n=i[t];if(void 0!==n)return n.exports;var o=i[t]={exports:{}};return e[t].call(o.exports,o,o.exports,r),o.exports}(914),t=exports;for(var n in r)t[n]=r[n];r.__esModule&&Object.defineProperty(t,"__esModule",{value:!0})})();

package/dist/openapi-runtime.json

@@ -214,6 +214,55 @@
       "delete": {
         "operationId": "deleteSession"
       }
+    },
+    "/v1/files/{id}/public/links": {
+      "post": {
+        "operationId": "generatePublicLink",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true
+          }
+        ]
+      },
+      "get": {
+        "operationId": "getAllPublicLinksForFile",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true
+          }
+        ]
+      }
+    },
+    "/v1/files/public/links/{id}/{filename}": {
+      "get": {
+        "operationId": "accessPublicLink",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true
+          },
+          {
+            "name": "filename",
+            "in": "path",
+            "required": true
+          }
+        ]
+      },
+      "delete": {
+        "operationId": "revokePublicLink",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true
+          }
+        ]
+      }
     }
   },
   "components": {},

package/dist/openapi.d.ts

@@ -137,6 +137,24 @@ declare namespace Components {
             EntitySlug;
             _tags?: string[];
         }
+        export interface PublicLink {
+            /**
+             * ID of the public link
+             * example:
+             * 3ef5c6d9-818d-45e6-8efb-b1de59079a1c
+             */
+            id?: string;
+            /**
+             * Public link of the file
+             * example:
+             * https://file.sls.epilot.io/v1/files/public/links/3ef5c6d9-818d-45e6-8efb-b1de59079a1c
+             */
+            link?: string;
+            /**
+             * The most recent timestamp when the file was accessed
+             */
+            last_accessed_at?: string;
+        }
         export interface S3Reference {
             /**
              * example:
@@ -217,6 +235,40 @@ declare namespace Components {
     }
 }
 declare namespace Paths {
+    namespace AccessPublicLink {
+        namespace Parameters {
+            /**
+             * Name of the file
+             * example:
+             * invoice-2023-12.pdf
+             */
+            export type Filename = string;
+            /**
+             * Id of the publicly generated link
+             * example:
+             * 13d22918-36bd-4227-9ad4-2cb978788c8d
+             */
+            export type Id = string;
+        }
+        export interface PathParameters {
+            id: /**
+             * Id of the publicly generated link
+             * example:
+             * 13d22918-36bd-4227-9ad4-2cb978788c8d
+             */
+            Parameters.Id;
+            filename: /**
+             * Name of the file
+             * example:
+             * invoice-2023-12.pdf
+             */
+            Parameters.Filename;
+        }
+        namespace Responses {
+            export interface $302 {
+            }
+        }
+    }
     namespace DeleteFile {
         export type RequestBody = Components.Schemas.DeleteFilePayload;
         namespace Responses {
@@ -291,6 +343,48 @@ declare namespace Paths {
             }
         }
     }
+    namespace GeneratePublicLink {
+        namespace Parameters {
+            export type Id = /**
+             * example:
+             * ef7d985c-2385-44f4-9c71-ae06a52264f8
+             */
+            Components.Schemas.FileEntityId;
+        }
+        export interface PathParameters {
+            id: Parameters.Id;
+        }
+        namespace Responses {
+            /**
+             * example:
+             * https://file.sls.epilot.io/v1/files/public/links/3ef5c6d9-818d-45e6-8efb-b1de59079a1c/invoice-2023-12.pdf
+             */
+            export type $201 = string;
+        }
+    }
+    namespace GetAllPublicLinksForFile {
+        namespace Parameters {
+            /**
+             * ID of the file entity
+             * example:
+             * 13d22918-36bd-4227-9ad4-2cb978788c8d
+             */
+            export type Id = string;
+        }
+        export interface PathParameters {
+            id: /**
+             * ID of the file entity
+             * example:
+             * 13d22918-36bd-4227-9ad4-2cb978788c8d
+             */
+            Parameters.Id;
+        }
+        namespace Responses {
+            export interface $200 {
+                results?: Components.Schemas.PublicLink[];
+            }
+        }
+    }
     namespace GetSession {
         namespace Responses {
             export interface $200 {
@@ -364,6 +458,31 @@ declare namespace Paths {
             h?: Parameters.H;
         }
     }
+    namespace RevokePublicLink {
+        namespace Parameters {
+            /**
+             * Id of the publicly generated link
+             * example:
+             * 13d22918-36bd-4227-9ad4-2cb978788c8d
+             */
+            export type Id = string;
+        }
+        export interface PathParameters {
+            id: /**
+             * Id of the publicly generated link
+             * example:
+             * 13d22918-36bd-4227-9ad4-2cb978788c8d
+             */
+            Parameters.Id;
+        }
+        namespace Responses {
+            /**
+             * example:
+             * https://file.sls.epilot.io/v1/files/public/links/3ef5c6d9-818d-45e6-8efb-b1de59079a1c
+             */
+            export type $204 = string;
+        }
+    }
     namespace SaveFile {
         export type RequestBody = Components.Schemas.SaveFilePayload;
         namespace Responses {
@@ -613,6 +732,47 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.DeleteSession.Responses.$200>
+  /**
+   * getAllPublicLinksForFile - getAllPublicLinksForFile
+   * 
+   * Not yet implemented; This API would fetches all the public links that are previously generated for a file
+   */
+  'getAllPublicLinksForFile'(
+    parameters?: Parameters<Paths.GetAllPublicLinksForFile.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetAllPublicLinksForFile.Responses.$200>
+  /**
+   * generatePublicLink - generatePublicLink
+   * 
+   * Generates a public link to access the private files
+   * 
+   */
+  'generatePublicLink'(
+    parameters?: Parameters<Paths.GeneratePublicLink.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GeneratePublicLink.Responses.$201>
+  /**
+   * accessPublicLink - accessPublicLink
+   * 
+   * Redirects to a accessible signed url for the respective file associated to the public link
+   */
+  'accessPublicLink'(
+    parameters?: Parameters<Paths.AccessPublicLink.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<any>
+  /**
+   * revokePublicLink - revokePublicLink
+   * 
+   * Not yet implemented; This operation would revokes a given public link by ID
+   */
+  'revokePublicLink'(
+    parameters?: Parameters<Paths.RevokePublicLink.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.RevokePublicLink.Responses.$204>
 }
 
 export interface PathsDictionary {
@@ -794,6 +954,51 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.DeleteSession.Responses.$200>
   }
+  ['/v1/files/{id}/public/links']: {
+    /**
+     * generatePublicLink - generatePublicLink
+     * 
+     * Generates a public link to access the private files
+     * 
+     */
+    'post'(
+      parameters?: Parameters<Paths.GeneratePublicLink.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GeneratePublicLink.Responses.$201>
+    /**
+     * getAllPublicLinksForFile - getAllPublicLinksForFile
+     * 
+     * Not yet implemented; This API would fetches all the public links that are previously generated for a file
+     */
+    'get'(
+      parameters?: Parameters<Paths.GetAllPublicLinksForFile.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetAllPublicLinksForFile.Responses.$200>
+  }
+  ['/v1/files/public/links/{id}/{filename}']: {
+    /**
+     * accessPublicLink - accessPublicLink
+     * 
+     * Redirects to a accessible signed url for the respective file associated to the public link
+     */
+    'get'(
+      parameters?: Parameters<Paths.AccessPublicLink.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<any>
+    /**
+     * revokePublicLink - revokePublicLink
+     * 
+     * Not yet implemented; This operation would revokes a given public link by ID
+     */
+    'delete'(
+      parameters?: Parameters<Paths.RevokePublicLink.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.RevokePublicLink.Responses.$204>
+  }
 }
 
 export type Client = OpenAPIClient<OperationMethods, PathsDictionary>

package/dist/openapi.json

@@ -688,6 +688,153 @@
           }
         }
       }
+    },
+    "/v1/files/{id}/public/links": {
+      "post": {
+        "operationId": "generatePublicLink",
+        "summary": "generatePublicLink",
+        "description": "Generates a public link to access the private files\n",
+        "tags": [
+          "files"
+        ],
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "$ref": "#/components/schemas/FileEntityId"
+            }
+          }
+        ],
+        "responses": {
+          "201": {
+            "description": "Returns the public link which can be used to access the file later",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "string",
+                  "example": "https://file.sls.epilot.io/v1/files/public/links/3ef5c6d9-818d-45e6-8efb-b1de59079a1c/invoice-2023-12.pdf"
+                }
+              }
+            }
+          }
+        }
+      },
+      "get": {
+        "operationId": "getAllPublicLinksForFile",
+        "summary": "getAllPublicLinksForFile",
+        "description": "Not yet implemented; This API would fetches all the public links that are previously generated for a file",
+        "x-not-implemented": true,
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "description": "ID of the file entity",
+              "example": "13d22918-36bd-4227-9ad4-2cb978788c8d"
+            }
+          }
+        ],
+        "tags": [
+          "files"
+        ],
+        "responses": {
+          "200": {
+            "description": "Public links of a file retrieved successfully",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "results": {
+                      "type": "array",
+                      "items": {
+                        "$ref": "#/components/schemas/PublicLink"
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v1/files/public/links/{id}/{filename}": {
+      "get": {
+        "operationId": "accessPublicLink",
+        "summary": "accessPublicLink",
+        "security": [],
+        "description": "Redirects to a accessible signed url for the respective file associated to the public link",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "description": "Id of the publicly generated link",
+              "example": "13d22918-36bd-4227-9ad4-2cb978788c8d"
+            }
+          },
+          {
+            "name": "filename",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "description": "Name of the file",
+              "example": "invoice-2023-12.pdf"
+            }
+          }
+        ],
+        "tags": [
+          "files"
+        ],
+        "responses": {
+          "302": {
+            "description": "Redirect to signed URL where the caller can access the file"
+          }
+        }
+      },
+      "delete": {
+        "operationId": "revokePublicLink",
+        "summary": "revokePublicLink",
+        "security": [],
+        "description": "Not yet implemented; This operation would revokes a given public link by ID",
+        "x-not-implemented": true,
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "description": "Id of the publicly generated link",
+              "example": "13d22918-36bd-4227-9ad4-2cb978788c8d"
+            }
+          }
+        ],
+        "tags": [
+          "files"
+        ],
+        "responses": {
+          "204": {
+            "description": "Revokes a public link successfully.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "string",
+                  "example": "https://file.sls.epilot.io/v1/files/public/links/3ef5c6d9-818d-45e6-8efb-b1de59079a1c"
+                }
+              }
+            }
+          }
+        }
+      }
     }
   },
   "components": {
@@ -1006,13 +1153,29 @@
         "required": [
           "entity_id"
         ]
+      },
+      "PublicLink": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "ID of the public link",
+            "example": "3ef5c6d9-818d-45e6-8efb-b1de59079a1c"
+          },
+          "link": {
+            "type": "string",
+            "description": "Public link of the file",
+            "example": "https://file.sls.epilot.io/v1/files/public/links/3ef5c6d9-818d-45e6-8efb-b1de59079a1c"
+          },
+          "last_accessed_at": {
+            "type": "string",
+            "description": "The most recent timestamp when the file was accessed"
+          }
+        }
       }
     }
   },
   "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.8.0",
+  "version": "1.9.0",
   "description": "Client library for the epilot File API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -65,7 +65,7 @@
     "openapicmd": "^1.16.2",
     "ts-jest": "^26.5.0",
     "ts-loader": "^8.0.14",
-    "ts-node": "^9.1.1",
+    "ts-node": "^10.9.1",
     "typescript": "^4.1.3",
     "webpack": "^5.18.0",
     "webpack-cli": "^4.4.0"