@epilot/file-client 1.1.1 → 1.1.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/definition.js +1 -1
- package/dist/openapi.d.ts +26 -12
- package/package.json +1 -1
- package/src/openapi.d.ts +26 -12
package/dist/definition.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
!function(e,t){for(var i in t)e[i]=t[i];t.__esModule&&Object.defineProperty(e,"__esModule",{value:!0})}(exports,(()=>{"use strict";var e={914:function(e,t,i){var a=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var n=a(i(279));t.default=n.default},279:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"File API","version":"0.1.0","description":"File Upload and Management for epilot SaaS"},"tags":[{"name":"files","description":"Files"}],"security":[{"EpilotAuth":[]},{"AsOrganization":[]}],"paths":{"/v1/files/public/upload":{"post":{"operationId":"uploadFilePublic","summary":"uploadFilePublic","security":[],"description":"Create pre-signed S3 URL to upload a file to keep temporarily (one week).\\n\\nUse the createFile operation to store file file permanently.\\n","tags":["files"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadFilePayload"}}}},"responses":{"201":{"description":"Pre-signed URL for POST / PUT upload","content":{"application/json":{"schema":{"type":"object","properties":{"
|
|
1
|
+
!function(e,t){for(var i in t)e[i]=t[i];t.__esModule&&Object.defineProperty(e,"__esModule",{value:!0})}(exports,(()=>{"use strict";var e={914:function(e,t,i){var a=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var n=a(i(279));t.default=n.default},279:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"File API","version":"0.1.0","description":"File Upload and Management for epilot SaaS"},"tags":[{"name":"files","description":"Files"}],"security":[{"EpilotAuth":[]},{"AsOrganization":[]}],"paths":{"/v1/files/public/upload":{"post":{"operationId":"uploadFilePublic","summary":"uploadFilePublic","security":[],"description":"Create pre-signed S3 URL to upload a file to keep temporarily (one week).\\n\\nUse the createFile operation to store file file permanently.\\n","tags":["files"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadFilePayload"}}}},"responses":{"201":{"description":"Pre-signed URL for POST / PUT upload","content":{"application/json":{"schema":{"type":"object","properties":{"s3ref":{"allOf":[{"$ref":"#/components/schemas/S3Reference"},{"example":{"bucket":"epilot-files-prod","key":"123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"}}]},"upload_url":{"type":"string","format":"url","example":"https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123"}}}}}}}}},"/v1/files/upload":{"post":{"operationId":"uploadFile","summary":"uploadFile","description":"Create pre-signed S3 URL to upload a file to keep temporarily (one week).\\n\\nUse the createFile operation to store file file permanently.\\n","tags":["files"],"parameters":[{"name":"file_entity_id","in":"query","description":"file entity id","schema":{"$ref":"#/components/schemas/FileEntityId"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadFilePayload","type":"object"}}}},"responses":{"201":{"description":"Pre-signed URL for POST / PUT upload","content":{"application/json":{"schema":{"type":"object","properties":{"s3ref":{"allOf":[{"$ref":"#/components/schemas/S3Reference"},{"example":{"bucket":"epilot-files-prod","key":"123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"}}]},"upload_url":{"type":"string","format":"url","example":"https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123"},"public_url":{"description":"Returned only if file is permanent i.e. file_entity_id is passed","type":"string","format":"url","example":"https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"}}}}}}}}},"/v1/files":{"post":{"operationId":"saveFile","summary":"saveFile","description":"Create / Update a permanent File entity\\n\\nMakes file object permanent\\n\\nSaves metadata to file entity\\n","tags":["files"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveFilePayload"}}}},"responses":{"201":{"description":"Created File Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileEntity"}}}}}}},"/v1/files/{id}/download":{"get":{"operationId":"downloadFile","summary":"downloadFile","description":"Generate pre-signed download S3 url for a file","tags":["files"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FileEntityId"}},{"name":"version","in":"query","description":"index of file version","schema":{"type":"integer","default":0}},{"name":"attachment","in":"query","description":"Controls the Content-Disposition header to control browser behaviour. Set to true to trigger download.","schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"Generated thumbnail image","content":{"application/json":{"schema":{"type":"object","properties":{"download_url":{"type":"string","format":"uri","example":"https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123"}}}}}}}}},"/v1/files/{id}/preview":{"get":{"operationId":"previewFile","summary":"previewFile","description":"Generate thumbnail preview for a file entity","tags":["files"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FileEntityId"}},{"name":"version","in":"query","description":"index of file version","schema":{"type":"integer","default":0}},{"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":{}}}}}},"/v1/files:previewS3":{"post":{"operationId":"previewS3File","summary":"previewS3File","description":"Generate thumbnail preview from an s3 reference for a file entity","tags":["files"],"parameters":[{"name":"w","in":"query","description":"width","schema":{"type":"integer"}},{"name":"h","in":"query","description":"height","schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/S3Reference"}}}},"responses":{"200":{"description":"Generated thumbnail image","content":{"image/png":{},"image/jpeg":{}}}}}},"/v1/files/delete":{"delete":{"operationId":"deleteFile","summary":"deleteFile","description":"Delete file entity","tags":["files"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteFilePayload"}}}},"responses":{"200":{"description":"File delete response"}}}}},"components":{"securitySchemes":{"EpilotAuth":{"type":"http","scheme":"bearer","description":"Epilot Bearer Token"},"AsOrganization":{"type":"apiKey","in":"header","name":"x-ivy-org-id","description":"Set organization id when using internal auth"}},"schemas":{"FileEntityId":{"type":"string","example":"ef7d985c-2385-44f4-9c71-ae06a52264f8"},"FileEntity":{"type":"object","properties":{"_id":{"$ref":"#/components/schemas/FileEntityId"},"filename":{"type":"string","example":"document.pdf"},"access_control":{"type":"string","default":"private","enum":["private","public-read"]},"public_url":{"type":"string","format":"url","example":"https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"},"versions":{"type":"array","items":{"type":"object","properties":{"s3ref":{"$ref":"#/components/schemas/S3Reference"}}}}}},"UploadFilePayload":{"type":"object","properties":{"filename":{"type":"string","example":"document.pdf"},"mime_type":{"description":"MIME type of file","type":"string","example":"application/pdf","default":"application/octet-stream"}},"required":["filename"]},"SaveFilePayload":{"type":"object","properties":{"s3ref":{"$ref":"#/components/schemas/S3Reference"},"file_entity_id":{"type":"string","description":"if passed, adds a new version to existing file entity"},"file_type":{"type":"string","enum":["document","document_template","text","image","video","audio","spreadsheet","presentation","font","archive","application","unknown"]},"filename":{"type":"string","example":"document.pdf"},"_tags":{"type":"array","items":{"type":"string"}},"access_control":{"type":"string","default":"private","enum":["private","public-read"]}},"required":["s3ref"]},"DeleteFilePayload":{"type":"object","properties":{"s3ref":{"$ref":"#/components/schemas/S3Reference"}},"required":["s3ref"]},"S3Reference":{"type":"object","properties":{"bucket":{"type":"string","example":"epilot-files-prod"},"key":{"type":"string","example":"123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"}},"required":["bucket","key"]},"FileItem":{"allOf":[{"$ref":"#/components/schemas/S3Reference"},{"type":"object","properties":{"filename":{"type":"string","example":"document.pdf"},"size_bytes":{"type":"integer","example":1234},"mime_type":{"type":"string","example":"image/jpeg"}}}]}}}}')}},t={};return function i(a){if(t[a])return t[a].exports;var n=t[a]={exports:{}};return e[a].call(n.exports,n,n.exports,i),n.exports}(914)})());
|
package/dist/openapi.d.ts
CHANGED
|
@@ -19,7 +19,12 @@ declare namespace Components {
|
|
|
19
19
|
* document.pdf
|
|
20
20
|
*/
|
|
21
21
|
filename?: string;
|
|
22
|
-
access_control?: "private" | "public";
|
|
22
|
+
access_control?: "private" | "public-read";
|
|
23
|
+
/**
|
|
24
|
+
* example:
|
|
25
|
+
* https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
|
|
26
|
+
*/
|
|
27
|
+
public_url?: string; // url
|
|
23
28
|
versions?: {
|
|
24
29
|
s3ref?: S3Reference;
|
|
25
30
|
}[];
|
|
@@ -74,13 +79,14 @@ declare namespace Components {
|
|
|
74
79
|
* if passed, adds a new version to existing file entity
|
|
75
80
|
*/
|
|
76
81
|
file_entity_id?: string;
|
|
82
|
+
file_type?: "document" | "document_template" | "text" | "image" | "video" | "audio" | "spreadsheet" | "presentation" | "font" | "archive" | "application" | "unknown";
|
|
77
83
|
/**
|
|
78
84
|
* example:
|
|
79
85
|
* document.pdf
|
|
80
86
|
*/
|
|
81
87
|
filename?: string;
|
|
82
88
|
_tags?: string[];
|
|
83
|
-
access_control?: "private" | "public";
|
|
89
|
+
access_control?: "private" | "public-read";
|
|
84
90
|
}
|
|
85
91
|
export interface UploadFilePayload {
|
|
86
92
|
/**
|
|
@@ -103,6 +109,7 @@ declare namespace Paths {
|
|
|
103
109
|
}
|
|
104
110
|
namespace DownloadFile {
|
|
105
111
|
namespace Parameters {
|
|
112
|
+
export type Attachment = boolean;
|
|
106
113
|
export type Id = Components.Schemas.FileEntityId;
|
|
107
114
|
export type Version = number;
|
|
108
115
|
}
|
|
@@ -111,6 +118,7 @@ declare namespace Paths {
|
|
|
111
118
|
}
|
|
112
119
|
export interface QueryParameters {
|
|
113
120
|
version?: Parameters.Version;
|
|
121
|
+
attachment?: Parameters.Attachment;
|
|
114
122
|
}
|
|
115
123
|
namespace Responses {
|
|
116
124
|
export interface $200 {
|
|
@@ -165,11 +173,6 @@ declare namespace Paths {
|
|
|
165
173
|
export type RequestBody = Components.Schemas.UploadFilePayload;
|
|
166
174
|
namespace Responses {
|
|
167
175
|
export interface $201 {
|
|
168
|
-
/**
|
|
169
|
-
* example:
|
|
170
|
-
* https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
|
|
171
|
-
*/
|
|
172
|
-
upload_url?: string; // url
|
|
173
176
|
/**
|
|
174
177
|
* example:
|
|
175
178
|
* {
|
|
@@ -189,6 +192,17 @@ declare namespace Paths {
|
|
|
189
192
|
*/
|
|
190
193
|
key: string;
|
|
191
194
|
};
|
|
195
|
+
/**
|
|
196
|
+
* example:
|
|
197
|
+
* https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
|
|
198
|
+
*/
|
|
199
|
+
upload_url?: string; // url
|
|
200
|
+
/**
|
|
201
|
+
* Returned only if file is permanent i.e. file_entity_id is passed
|
|
202
|
+
* example:
|
|
203
|
+
* https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
|
|
204
|
+
*/
|
|
205
|
+
public_url?: string; // url
|
|
192
206
|
}
|
|
193
207
|
}
|
|
194
208
|
}
|
|
@@ -196,11 +210,6 @@ declare namespace Paths {
|
|
|
196
210
|
export type RequestBody = Components.Schemas.UploadFilePayload;
|
|
197
211
|
namespace Responses {
|
|
198
212
|
export interface $201 {
|
|
199
|
-
/**
|
|
200
|
-
* example:
|
|
201
|
-
* https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
|
|
202
|
-
*/
|
|
203
|
-
upload_url?: string; // url
|
|
204
213
|
/**
|
|
205
214
|
* example:
|
|
206
215
|
* {
|
|
@@ -220,6 +229,11 @@ declare namespace Paths {
|
|
|
220
229
|
*/
|
|
221
230
|
key: string;
|
|
222
231
|
};
|
|
232
|
+
/**
|
|
233
|
+
* example:
|
|
234
|
+
* https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
|
|
235
|
+
*/
|
|
236
|
+
upload_url?: string; // url
|
|
223
237
|
}
|
|
224
238
|
}
|
|
225
239
|
}
|
package/package.json
CHANGED
package/src/openapi.d.ts
CHANGED
|
@@ -19,7 +19,12 @@ declare namespace Components {
|
|
|
19
19
|
* document.pdf
|
|
20
20
|
*/
|
|
21
21
|
filename?: string;
|
|
22
|
-
access_control?: "private" | "public";
|
|
22
|
+
access_control?: "private" | "public-read";
|
|
23
|
+
/**
|
|
24
|
+
* example:
|
|
25
|
+
* https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
|
|
26
|
+
*/
|
|
27
|
+
public_url?: string; // url
|
|
23
28
|
versions?: {
|
|
24
29
|
s3ref?: S3Reference;
|
|
25
30
|
}[];
|
|
@@ -74,13 +79,14 @@ declare namespace Components {
|
|
|
74
79
|
* if passed, adds a new version to existing file entity
|
|
75
80
|
*/
|
|
76
81
|
file_entity_id?: string;
|
|
82
|
+
file_type?: "document" | "document_template" | "text" | "image" | "video" | "audio" | "spreadsheet" | "presentation" | "font" | "archive" | "application" | "unknown";
|
|
77
83
|
/**
|
|
78
84
|
* example:
|
|
79
85
|
* document.pdf
|
|
80
86
|
*/
|
|
81
87
|
filename?: string;
|
|
82
88
|
_tags?: string[];
|
|
83
|
-
access_control?: "private" | "public";
|
|
89
|
+
access_control?: "private" | "public-read";
|
|
84
90
|
}
|
|
85
91
|
export interface UploadFilePayload {
|
|
86
92
|
/**
|
|
@@ -103,6 +109,7 @@ declare namespace Paths {
|
|
|
103
109
|
}
|
|
104
110
|
namespace DownloadFile {
|
|
105
111
|
namespace Parameters {
|
|
112
|
+
export type Attachment = boolean;
|
|
106
113
|
export type Id = Components.Schemas.FileEntityId;
|
|
107
114
|
export type Version = number;
|
|
108
115
|
}
|
|
@@ -111,6 +118,7 @@ declare namespace Paths {
|
|
|
111
118
|
}
|
|
112
119
|
export interface QueryParameters {
|
|
113
120
|
version?: Parameters.Version;
|
|
121
|
+
attachment?: Parameters.Attachment;
|
|
114
122
|
}
|
|
115
123
|
namespace Responses {
|
|
116
124
|
export interface $200 {
|
|
@@ -165,11 +173,6 @@ declare namespace Paths {
|
|
|
165
173
|
export type RequestBody = Components.Schemas.UploadFilePayload;
|
|
166
174
|
namespace Responses {
|
|
167
175
|
export interface $201 {
|
|
168
|
-
/**
|
|
169
|
-
* example:
|
|
170
|
-
* https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
|
|
171
|
-
*/
|
|
172
|
-
upload_url?: string; // url
|
|
173
176
|
/**
|
|
174
177
|
* example:
|
|
175
178
|
* {
|
|
@@ -189,6 +192,17 @@ declare namespace Paths {
|
|
|
189
192
|
*/
|
|
190
193
|
key: string;
|
|
191
194
|
};
|
|
195
|
+
/**
|
|
196
|
+
* example:
|
|
197
|
+
* https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
|
|
198
|
+
*/
|
|
199
|
+
upload_url?: string; // url
|
|
200
|
+
/**
|
|
201
|
+
* Returned only if file is permanent i.e. file_entity_id is passed
|
|
202
|
+
* example:
|
|
203
|
+
* https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
|
|
204
|
+
*/
|
|
205
|
+
public_url?: string; // url
|
|
192
206
|
}
|
|
193
207
|
}
|
|
194
208
|
}
|
|
@@ -196,11 +210,6 @@ declare namespace Paths {
|
|
|
196
210
|
export type RequestBody = Components.Schemas.UploadFilePayload;
|
|
197
211
|
namespace Responses {
|
|
198
212
|
export interface $201 {
|
|
199
|
-
/**
|
|
200
|
-
* example:
|
|
201
|
-
* https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
|
|
202
|
-
*/
|
|
203
|
-
upload_url?: string; // url
|
|
204
213
|
/**
|
|
205
214
|
* example:
|
|
206
215
|
* {
|
|
@@ -220,6 +229,11 @@ declare namespace Paths {
|
|
|
220
229
|
*/
|
|
221
230
|
key: string;
|
|
222
231
|
};
|
|
232
|
+
/**
|
|
233
|
+
* example:
|
|
234
|
+
* https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
|
|
235
|
+
*/
|
|
236
|
+
upload_url?: string; // url
|
|
223
237
|
}
|
|
224
238
|
}
|
|
225
239
|
}
|