@or-sdk/files 3.8.3-beta.3996.0 → 3.9.0
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/CHANGELOG.md +9 -0
- package/dist/types/Files.d.ts +153 -2
- package/dist/types/Files.d.ts.map +1 -1
- package/dist/types/types/upload-files.d.ts +53 -0
- package/dist/types/types/upload-files.d.ts.map +1 -1
- package/dist/types/types.d.ts +36 -0
- package/dist/types/types.d.ts.map +1 -1
- package/package.json +4 -3
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,15 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [3.9.0](https://gitlab.internal.onereach.io/onereach/platform/or-sdk-next/compare/@or-sdk/files@3.8.2...@or-sdk/files@3.9.0) (2026-02-24)
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
### Features
|
|
10
|
+
|
|
11
|
+
* **deployer:** Add methods 'fetchFlowLogsChunk' and 'fetchAllFlowLogs' to fetch flow logs ([6b70992](https://gitlab.internal.onereach.io/onereach/platform/or-sdk-next/commit/6b70992ce3d1e4f308db69df700528f6eeffafcf))
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
6
15
|
## [3.8.2](https://gitlab.internal.onereach.io/onereach/platform/or-sdk-next/compare/@or-sdk/files@3.8.1...@or-sdk/files@3.8.2) (2026-01-15)
|
|
7
16
|
|
|
8
17
|
**Note:** Version bump only for package @or-sdk/files
|
package/dist/types/Files.d.ts
CHANGED
|
@@ -2,38 +2,189 @@ import { Base } from '@or-sdk/base';
|
|
|
2
2
|
import type { FileItem, FileItemSelect, FilesConfig, GetSystemFileUploadUrlParams, RequestOptions, UploadFileOptions, UploadFileProps, UploadFilePropsLegacy, UploadSystemFileParams, UploadSystemFileParamsLegacy, UploadUrlProps, UploadUrlPropsLegacy, UploadUrlResponse } from './types';
|
|
3
3
|
export declare class Files extends Base {
|
|
4
4
|
constructor(params: FilesConfig);
|
|
5
|
+
/**
|
|
6
|
+
* Get one file full data
|
|
7
|
+
* @param isPublic does this file public or private
|
|
8
|
+
* @param prefix the file path, example: /data/images/second.png
|
|
9
|
+
* @param attributes select specific props from FileItem. Example: 'key, isBoolean, size'
|
|
10
|
+
* @returns object with: file, headData and url for downloading
|
|
11
|
+
*/
|
|
5
12
|
getFile(prefix: string, isPublic: boolean, attributes?: string): Promise<FileItem>;
|
|
13
|
+
/**
|
|
14
|
+
* Get one folder full data
|
|
15
|
+
* @param key the file path, example: /data/images/second.png
|
|
16
|
+
* @returns Folder record
|
|
17
|
+
*/
|
|
6
18
|
getFolder(key: string): Promise<FileItem>;
|
|
19
|
+
/**
|
|
20
|
+
* Get folder size
|
|
21
|
+
* @param key the name of folder
|
|
22
|
+
* @returns total folder size in bytes
|
|
23
|
+
*/
|
|
7
24
|
getFolderSize(key: string): Promise<number>;
|
|
25
|
+
/**
|
|
26
|
+
* Get list of public/private FileItems from api
|
|
27
|
+
* @param treePrefix the folder path where GET FileItems, for Root use ''
|
|
28
|
+
* @param isPublic does this file public or private, undefined for both types
|
|
29
|
+
* @returns list of FileItem records
|
|
30
|
+
*/
|
|
8
31
|
getItemsList(treePrefix: string, isPublic?: boolean): Promise<FileItem[]>;
|
|
32
|
+
/**
|
|
33
|
+
* Get list of public/private FileItems from api
|
|
34
|
+
* @param treePrefix the folder path where GET FileItems, for Root use ''
|
|
35
|
+
* @param isPublic does this file public or private, undefined for both types
|
|
36
|
+
* @param attributes select specific props from FileItem. Example: 'key, isBoolean, size'
|
|
37
|
+
* @returns list of FileItemSelect
|
|
38
|
+
*/
|
|
9
39
|
getItemsList(treePrefix: string, isPublic?: boolean, attributes?: string): Promise<FileItemSelect[]>;
|
|
10
40
|
getFoldersList(treePrefix: string): Promise<FileItem[]>;
|
|
41
|
+
/**
|
|
42
|
+
* Se list of public/private FileItems from api with specific prefix
|
|
43
|
+
* @param term the folder/file path where search will be done
|
|
44
|
+
* @param isPublic does this file public or private, undefined for both types
|
|
45
|
+
* @returns list of FileItems
|
|
46
|
+
*/
|
|
11
47
|
search(term: string, isPublic?: boolean): Promise<FileItem[]>;
|
|
48
|
+
/**
|
|
49
|
+
* Create ROOT folder
|
|
50
|
+
*/
|
|
12
51
|
createRootFolder(): Promise<void>;
|
|
52
|
+
/**
|
|
53
|
+
* Create new folder
|
|
54
|
+
* @param folderName should have folder path + folder name, example: /main/New folder
|
|
55
|
+
*/
|
|
13
56
|
createFolder(folderName: string): Promise<void>;
|
|
57
|
+
/**
|
|
58
|
+
* Rename exist file
|
|
59
|
+
* @param key old file name
|
|
60
|
+
* @param newKey new file name
|
|
61
|
+
* @param isPublic does this file public or private
|
|
62
|
+
* @param abortSignal signal to cancel file renaming
|
|
63
|
+
*/
|
|
14
64
|
renameFile(key: string, newKey: string, isPublic: boolean, abortSignal?: AbortSignal): Promise<void>;
|
|
65
|
+
/**
|
|
66
|
+
* Duplicate file
|
|
67
|
+
* @param key target file name
|
|
68
|
+
* @param newKey new file name
|
|
69
|
+
* @param isPublic does this file public or private
|
|
70
|
+
*/
|
|
15
71
|
duplicateFile(key: string, newKey: string, isPublic: boolean): Promise<void>;
|
|
72
|
+
/**
|
|
73
|
+
* Change file privacy
|
|
74
|
+
* @param key file name
|
|
75
|
+
* @param newPrivacy new file privacy
|
|
76
|
+
* @param isPublic does this file public or private
|
|
77
|
+
*/
|
|
16
78
|
changePrivacy(key: string, newPrivacy: 'private' | 'public', isPublic: boolean): Promise<void>;
|
|
79
|
+
/**
|
|
80
|
+
* Delete file
|
|
81
|
+
* @param key file name
|
|
82
|
+
* @param isPublic does this file public or private
|
|
83
|
+
* @param abortSignal signal to cancel file renaming
|
|
84
|
+
*/
|
|
17
85
|
deleteFile(key: string, isPublic: boolean, abortSignal?: AbortSignal): Promise<void>;
|
|
86
|
+
/**
|
|
87
|
+
* Delete folder
|
|
88
|
+
* @param key folder name
|
|
89
|
+
*/
|
|
18
90
|
deleteFolder(key: string): Promise<void>;
|
|
91
|
+
/**
|
|
92
|
+
* Get a link to download file, example: for preview
|
|
93
|
+
* @param key folder name
|
|
94
|
+
* @param isPublic does this file public or private
|
|
95
|
+
* @param expireMs how long PRIVATE file link will be accessible in milliseconds
|
|
96
|
+
* @param checkFileExist check that file exists in database
|
|
97
|
+
* @returns file url
|
|
98
|
+
*/
|
|
19
99
|
getDownloadUrl(key: string, isPublic: boolean, expireMs?: number, checkFileExist?: boolean): Promise<string>;
|
|
20
|
-
|
|
100
|
+
/**
|
|
101
|
+
* Get a link for uploading specific file, JUST FOR INNER USE
|
|
102
|
+
* @returns URL for uploading a file with additional header Fields
|
|
103
|
+
*/
|
|
104
|
+
getUploadUrlV2(
|
|
105
|
+
/** Details of the file to be uploaded */
|
|
106
|
+
{ fileName, prefix, contentType, isPublic, expiresAt, ...data }: UploadUrlProps,
|
|
107
|
+
/** Additional request options */
|
|
108
|
+
options?: RequestOptions): Promise<UploadUrlResponse>;
|
|
109
|
+
/**
|
|
110
|
+
* Upload the file to File service
|
|
111
|
+
*
|
|
112
|
+
* @returns URL of the uploaded file into Files
|
|
113
|
+
*/
|
|
21
114
|
uploadFileV2({ fileName, prefix, fileContent, contentType, expiresAt, isPublic, rewriteMode, maxFileSize, knownLength, cacheControl, waitTillFileAddedInDb, onUploadProgress, }: UploadFileProps, { signal, waitForDatabaseUpdateTimeout, waitForDatabaseUpdatePollInterval, }?: UploadFileOptions): Promise<string>;
|
|
115
|
+
/**
|
|
116
|
+
* Upload system file to S3 bucket, will not affect total size for user storage
|
|
117
|
+
*/
|
|
22
118
|
uploadSystemFileV3({ fileName, prefix, fileContent, contentType, cacheControl, expiresAt, knownLength, onUploadProgress, }: UploadSystemFileParams, options?: RequestOptions): Promise<string>;
|
|
119
|
+
/** Get signed URL params for uploading of system file */
|
|
23
120
|
protected getSystemFileUploadUrl(params: GetSystemFileUploadUrlParams, options?: RequestOptions): Promise<UploadUrlResponse>;
|
|
121
|
+
/**
|
|
122
|
+
* Delete system file
|
|
123
|
+
* @param path file path
|
|
124
|
+
*/
|
|
24
125
|
deleteSystemFile(path: string): Promise<void>;
|
|
126
|
+
/**
|
|
127
|
+
* Set ttl for a specific file or folder
|
|
128
|
+
* @param key file or folder path
|
|
129
|
+
* @param isPublic `false` for folders, `true` or `false` for files
|
|
130
|
+
* @param ttl number which represents milliseconds
|
|
131
|
+
*/
|
|
25
132
|
addTtl(key: string, isPublic: boolean, ttl: number): Promise<void>;
|
|
133
|
+
/**
|
|
134
|
+
* Update ttl for a specific file or folder
|
|
135
|
+
* @param key file or folder path
|
|
136
|
+
* @param isPublic false for folders, true or false for files
|
|
137
|
+
* @param newTtl number which represents milliseconds
|
|
138
|
+
*/
|
|
26
139
|
updateTtl(key: string, isPublic: boolean, newTtl: number): Promise<void>;
|
|
140
|
+
/**
|
|
141
|
+
* Delete ttl for a specific file or folder
|
|
142
|
+
* @param key file or folder path
|
|
143
|
+
* @param isPublic false for folders, true or false for files
|
|
144
|
+
*/
|
|
27
145
|
deleteTtl(key: string, isPublic: boolean): Promise<void>;
|
|
28
146
|
private uploadToSignedUrl;
|
|
29
147
|
private formDataFactory;
|
|
30
148
|
private getFormDataHeaders;
|
|
31
149
|
private normalizeFileModel;
|
|
150
|
+
/**
|
|
151
|
+
* Get Date instance from input that represents date
|
|
152
|
+
*
|
|
153
|
+
* @param input input to normalize
|
|
154
|
+
* @param errorMessage error message to throw if input is invalid date
|
|
155
|
+
* @returns Date instance represented by input
|
|
156
|
+
* @throws If input is invalid date
|
|
157
|
+
*/
|
|
32
158
|
private normalizeDate;
|
|
33
159
|
private get defaultContentType();
|
|
160
|
+
/**
|
|
161
|
+
* Upload the file to File service
|
|
162
|
+
*
|
|
163
|
+
* @returns URL of the uploaded file into Files
|
|
164
|
+
* @deprecated Use {@link uploadFileV2} instead
|
|
165
|
+
*/
|
|
34
166
|
uploadFile({ name, prefix, fileModel, type, isPublic, rewriteMode, maxFileSize, knownLength, cacheControl, ttl, waitTillFileAddedInDb, abortSignal, progress, }: UploadFilePropsLegacy, signal?: AbortSignal): Promise<string>;
|
|
35
|
-
|
|
167
|
+
/**
|
|
168
|
+
* Get a link for uploading specific file, JUST FOR INNER USE
|
|
169
|
+
* @returns uploading Url with different header Fields
|
|
170
|
+
* @deprecated Use {@link getUploadUrlV2} instead
|
|
171
|
+
*/
|
|
172
|
+
getUploadUrl(
|
|
173
|
+
/** Details of the file to be uploaded */
|
|
174
|
+
params: UploadUrlPropsLegacy, isPublic?: boolean, ttl?: number, abortSignal?: AbortSignal): Promise<UploadUrlResponse>;
|
|
175
|
+
/**
|
|
176
|
+
* Upload system file to S3 bucket, will not affect total size for user storage
|
|
177
|
+
* @param prefix prefix inside the system folder
|
|
178
|
+
* @param file file for uploading
|
|
179
|
+
* @param cacheControl cache settings
|
|
180
|
+
* @param abortSignal signal to cancel uploading
|
|
181
|
+
* @deprecated use {@link uploadSystemFileV3} instead
|
|
182
|
+
*/
|
|
36
183
|
uploadSystemFile(prefix: string, file: File, cacheControl?: string, abortSignal?: AbortSignal): Promise<string>;
|
|
184
|
+
/**
|
|
185
|
+
* Upload system file to S3 bucket, will not affect total size for user storage
|
|
186
|
+
* @deprecated Use {@link uploadSystemFileV3} instead
|
|
187
|
+
*/
|
|
37
188
|
uploadSystemFileV2({ fileName, prefix, file, contentType, cacheControl, ttl, knownLength, abortSignal, }: UploadSystemFileParamsLegacy): Promise<string>;
|
|
38
189
|
}
|
|
39
190
|
//# sourceMappingURL=Files.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Files.d.ts","sourceRoot":"","sources":["../../src/Files.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAMpC,OAAO,KAAK,EAEV,QAAQ,EACR,cAAc,EAEd,WAAW,EAEX,4BAA4B,EAE5B,cAAc,EAGd,iBAAiB,EACjB,eAAe,EACf,qBAAqB,EACrB,sBAAsB,EACtB,4BAA4B,EAE5B,cAAc,EACd,oBAAoB,EACpB,iBAAiB,EAClB,MAAM,SAAS,CAAC;AAGjB,qBAAa,KAAM,SAAQ,IAAI;gBACjB,MAAM,EAAE,WAAW;
|
|
1
|
+
{"version":3,"file":"Files.d.ts","sourceRoot":"","sources":["../../src/Files.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAMpC,OAAO,KAAK,EAEV,QAAQ,EACR,cAAc,EAEd,WAAW,EAEX,4BAA4B,EAE5B,cAAc,EAGd,iBAAiB,EACjB,eAAe,EACf,qBAAqB,EACrB,sBAAsB,EACtB,4BAA4B,EAE5B,cAAc,EACd,oBAAoB,EACpB,iBAAiB,EAClB,MAAM,SAAS,CAAC;AAGjB,qBAAa,KAAM,SAAQ,IAAI;gBACjB,MAAM,EAAE,WAAW;IAY/B;;;;;;OAMG;IACG,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAYxF;;;;OAIG;IACG,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAU/C;;;;OAIG;IACG,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAUjD;;;;;OAKG;IACG,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAC/E;;;;;;OAMG;IACG,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IAyBpG,cAAc,CAAC,UAAU,EAAE,MAAM;IAQvC;;;;;OAKG;IACG,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAyBnE;;OAEG;IACG,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC;IAOvC;;;OAGG;IACG,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQrD;;;;;;OAMG;IACG,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,WAAW,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAa1G;;;;;OAKG;IACG,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IA6BlF;;;;;OAKG;IACG,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,GAAG,QAAQ,EAAE,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAYpG;;;;;OAKG;IACG,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,WAAW,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAY1F;;;OAGG;IACG,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ9C;;;;;;;OAOG;IACG,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,SAAW,EAAE,cAAc,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;IAapH;;;OAGG;IACU,cAAc;IACzB,yCAAyC;IACzC,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,QAAgB,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,EAAE,cAAc;IAEvF,iCAAiC;IACjC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,iBAAiB,CAAC;IA0B7B;;;;OAIG;IACU,YAAY,CACvB,EACE,QAAQ,EACR,MAAM,EACN,WAAW,EACX,WAAW,EACX,SAAS,EACT,QAAgB,EAChB,WAAW,EACX,WAAW,EACX,WAAW,EACX,YAAyB,EACzB,qBAAqB,EACrB,gBAAgB,GACjB,EAAE,eAAe,EAClB,EACE,MAAM,EACN,4BAAqC,EACrC,iCAAyC,GAC1C,GAAE,iBAAsB,GACxB,OAAO,CAAC,MAAM,CAAC;IAqDlB;;OAEG;IACU,kBAAkB,CAC7B,EACE,QAAQ,EACR,MAAM,EACN,WAAW,EACX,WAAW,EACX,YAA6B,EAC7B,SAAS,EACT,WAAW,EACX,gBAAgB,GACjB,EAAE,sBAAsB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC;IA6BlB,yDAAyD;cACzC,sBAAsB,CACpC,MAAM,EAAE,4BAA4B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,iBAAiB,CAAC;IAgB7B;;;OAGG;IACU,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAY1D;;;;;OAKG;IACG,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAYxE;;;;;OAKG;IACG,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAY9E;;;;OAIG;IACG,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;YAWhD,iBAAiB;YAiDjB,eAAe;IAS7B,OAAO,CAAC,kBAAkB;IAM1B,OAAO,CAAC,kBAAkB;IAS1B;;;;;;;OAOG;IACH,OAAO,CAAC,aAAa;IAUrB,OAAO,KAAK,kBAAkB,GAE7B;IAMD;;;;;OAKG;IACU,UAAU,CACrB,EACE,IAAI,EACJ,MAAM,EACN,SAAS,EACT,IAAI,EACJ,QAAgB,EAChB,WAAW,EACX,WAAW,EACX,WAAW,EACX,YAAyB,EACzB,GAAG,EACH,qBAAqB,EACrB,WAAW,EACX,QAAQ,GACT,EAAE,qBAAqB,EACxB,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,MAAM,CAAC;IAoBlB;;;;OAIG;IACU,YAAY;IACvB,yCAAyC;IACzC,MAAM,EAAE,oBAAoB,EAC5B,QAAQ,CAAC,EAAE,OAAO,EAClB,GAAG,CAAC,EAAE,MAAM,EACZ,WAAW,CAAC,EAAE,WAAW,GACxB,OAAO,CAAC,iBAAiB,CAAC;IAa7B;;;;;;;OAOG;IACU,gBAAgB,CAC3B,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,IAAI,EACV,YAAY,SAAiB,EAC7B,WAAW,CAAC,EAAE,WAAW,GACxB,OAAO,CAAC,MAAM,CAAC;IAalB;;;OAGG;IACU,kBAAkB,CAAC,EAC9B,QAAQ,EACR,MAAM,EACN,IAAI,EACJ,WAAW,EACX,YAA6B,EAC7B,GAAG,EACH,WAAW,EACX,WAAW,GACZ,EAAE,4BAA4B,GAAG,OAAO,CAAC,MAAM,CAAC;CAclD"}
|
|
@@ -3,16 +3,53 @@ import type { ReadStream } from 'node:fs';
|
|
|
3
3
|
import type { Timestamp } from './ttl';
|
|
4
4
|
export type { AxiosProgressEvent };
|
|
5
5
|
export type RequestOptions = {
|
|
6
|
+
/** Signal from AbortController to abort active request */
|
|
6
7
|
signal?: AbortSignal;
|
|
7
8
|
};
|
|
8
9
|
export type UploadBaseParams = {
|
|
10
|
+
/**
|
|
11
|
+
* Name of the file
|
|
12
|
+
* @example 'my_file.json'
|
|
13
|
+
*/
|
|
9
14
|
fileName: string;
|
|
15
|
+
/**
|
|
16
|
+
* File path prefix
|
|
17
|
+
* @example If fine name is 'my_file.json' and prefix is 'path/to/file/' the result file path is:
|
|
18
|
+
* 'path/to/file/my_file.json'
|
|
19
|
+
*
|
|
20
|
+
* @example If fine name is 'my_file.json' and prefix is 'name_prefix_' the result file path is:
|
|
21
|
+
* 'name_prefix_my_file.json'
|
|
22
|
+
*/
|
|
10
23
|
prefix?: string;
|
|
24
|
+
/**
|
|
25
|
+
* [MIME type](https://www.iana.org/assignments/media-types/media-types.xhtml)
|
|
26
|
+
* of the file.
|
|
27
|
+
* @default 'binary/octet-stream'
|
|
28
|
+
* @example 'application/json'
|
|
29
|
+
*/
|
|
11
30
|
contentType?: string;
|
|
31
|
+
/** Max size of the file in bytes */
|
|
12
32
|
maxFileSize?: number;
|
|
33
|
+
/**
|
|
34
|
+
* Custom cache control setting for a file
|
|
35
|
+
*
|
|
36
|
+
* Examples:
|
|
37
|
+
* - `max-age=<seconds>`
|
|
38
|
+
* Specifies the maximum time (in seconds) a resource is considered fresh.
|
|
39
|
+
* For example, max-age=86400 means the resource is cached for 1 day.
|
|
40
|
+
* - `no-cache`
|
|
41
|
+
* Force to validate with the origin server before serving a cached copy.
|
|
42
|
+
* Useful for content that changes frequently.
|
|
43
|
+
*/
|
|
13
44
|
cacheControl?: string;
|
|
14
45
|
rewriteMode?: 'rewrite' | 'prevent-rewrite';
|
|
46
|
+
/** Datetime when file should expire and be deleted */
|
|
15
47
|
expiresAt?: Timestamp;
|
|
48
|
+
/**
|
|
49
|
+
* If `true` after upload file would be publicly available by it's URL.
|
|
50
|
+
* If `false` access to file is possible only via temporary signed URL to a file.
|
|
51
|
+
* @default false
|
|
52
|
+
*/
|
|
16
53
|
isPublic?: boolean;
|
|
17
54
|
};
|
|
18
55
|
export type UploadUrlProps = UploadBaseParams;
|
|
@@ -40,17 +77,32 @@ export type UploadFields = {
|
|
|
40
77
|
'X-Amz-Security-Token': string;
|
|
41
78
|
'cache-control'?: string;
|
|
42
79
|
};
|
|
80
|
+
/** Buffer and ReadStream only supported in Node.js */
|
|
43
81
|
export type FileModel = File | Blob | Buffer | ReadStream;
|
|
82
|
+
/** Allows to use string as a file value */
|
|
44
83
|
export type ExtendedFileModel = FileModel | string;
|
|
45
84
|
export type UploadFileBaseParams = UploadBaseParams & {
|
|
85
|
+
/** File contents */
|
|
46
86
|
fileContent: ExtendedFileModel;
|
|
87
|
+
/** Callback function to be called with upload progress events */
|
|
47
88
|
onUploadProgress?: (event: ProgressEvent | AxiosProgressEvent) => void;
|
|
89
|
+
/** Size of the file in bytes. Helpful when file is an instance of ReadStream in Node.js */
|
|
48
90
|
knownLength?: number;
|
|
91
|
+
/** If `true` method will wait after file upload until file system will update to include file */
|
|
49
92
|
waitTillFileAddedInDb?: boolean;
|
|
50
93
|
};
|
|
51
94
|
export type UploadFileProps = UploadFileBaseParams;
|
|
95
|
+
/** Optional config for uploading files */
|
|
52
96
|
export type UploadFileOptions = RequestOptions & {
|
|
97
|
+
/**
|
|
98
|
+
* Maximum wait time for update of the data base in milliseconds.
|
|
99
|
+
* @default 60_000
|
|
100
|
+
*/
|
|
53
101
|
waitForDatabaseUpdateTimeout?: number;
|
|
102
|
+
/**
|
|
103
|
+
* Interval between checking if database was updated in milliseconds.
|
|
104
|
+
* @default 2_000
|
|
105
|
+
*/
|
|
54
106
|
waitForDatabaseUpdatePollInterval?: number;
|
|
55
107
|
};
|
|
56
108
|
export type UploadToSignedUrlParameters = Pick<UploadFileProps, 'fileName' | 'fileContent' | 'contentType' | 'cacheControl' | 'knownLength' | 'onUploadProgress'> & {
|
|
@@ -61,6 +113,7 @@ export type UploadToSignedUrlParameters2 = {
|
|
|
61
113
|
file: FileModel;
|
|
62
114
|
fileName: string;
|
|
63
115
|
cacheControl?: string;
|
|
116
|
+
/** Size of the file in bytes. Helpful when file is an instance of ReadStream in Node.js */
|
|
64
117
|
knownLength?: number;
|
|
65
118
|
contentType?: string;
|
|
66
119
|
signal?: AbortSignal;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"upload-files.d.ts","sourceRoot":"","sources":["../../../src/types/upload-files.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAChD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAE1C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAEvC,YAAY,EAAE,kBAAkB,EAAE,CAAC;AAEnC,MAAM,MAAM,cAAc,GAAG;
|
|
1
|
+
{"version":3,"file":"upload-files.d.ts","sourceRoot":"","sources":["../../../src/types/upload-files.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAChD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAE1C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAEvC,YAAY,EAAE,kBAAkB,EAAE,CAAC;AAEnC,MAAM,MAAM,cAAc,GAAG;IAC3B,0DAA0D;IAC1D,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,oCAAoC;IACpC,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;;;;;OAUG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAGtB,WAAW,CAAC,EAAE,SAAS,GAAG,iBAAiB,CAAC;IAE5C,sDAAsD;IACtD,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,gBAAgB,CAAC;AAE9C,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,cAAc,EAAE,WAAW,GAAG,UAAU,GAAG,QAAQ,GAAG,UAAU,CAAC,GAAG;IAC1G,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG,IAAI,CAAC,cAAc,EAAE,WAAW,GAAG,UAAU,GAAG,QAAQ,GAAG,UAAU,CAAC,GAAG;IAC7G,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,CAAC;IACpB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,YAAY,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;IACrB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,sBAAsB,EAAE,MAAM,CAAC;IAC/B,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,sDAAsD;AACtD,MAAM,MAAM,SAAS,GAAG,IAAI,GAAG,IAAI,GAAG,MAAM,GAAG,UAAU,CAAC;AAC1D,2CAA2C;AAC3C,MAAM,MAAM,iBAAiB,GAAG,SAAS,GAAG,MAAM,CAAC;AAEnD,MAAM,MAAM,oBAAoB,GAAG,gBAAgB,GAAG;IACpD,oBAAoB;IACpB,WAAW,EAAE,iBAAiB,CAAC;IAE/B,iEAAiE;IACjE,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,aAAa,GAAG,kBAAkB,KAAK,IAAI,CAAC;IAEvE,2FAA2F;IAC3F,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,iGAAiG;IACjG,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC,CAAA;AAED,MAAM,MAAM,eAAe,GAAG,oBAAoB,CAAC;AAEnD,0CAA0C;AAC1C,MAAM,MAAM,iBAAiB,GAAG,cAAc,GAAG;IAC/C;;;OAGG;IACH,4BAA4B,CAAC,EAAE,MAAM,CAAC;IAEtC;;;OAGG;IACH,iCAAiC,CAAC,EAAE,MAAM,CAAC;CAC5C,CAAA;AAED,MAAM,MAAM,2BAA2B,GAAG,IAAI,CAC5C,eAAe,EACf,UAAU,GAAG,aAAa,GAAG,aAAa,GAAG,cAAc,GAAG,aAAa,GAAG,kBAAkB,CACjG,GAAG;IACF,SAAS,EAAE,iBAAiB,CAAC;CAC9B,CAAA;AAED,MAAM,MAAM,4BAA4B,GAAG;IACzC,SAAS,EAAE,iBAAiB,CAAC;IAC7B,IAAI,EAAE,SAAS,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,2FAA2F;IAC3F,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,aAAa,GAAG,kBAAkB,KAAK,IAAI,CAAC;CACxE,CAAA;AAGD,MAAM,MAAM,qBAAqB,GAAG,IAAI,CACtC,eAAe,EACb,QAAQ,GACR,cAAc,GACd,UAAU,GACV,aAAa,GACb,aAAa,GACb,aAAa,GACb,uBAAuB,CAC1B,GAAG;IACF,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,iBAAiB,CAAC;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,aAAa,GAAG,kBAAkB,KAAK,IAAI,CAAC;IAC/D,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B,CAAA"}
|
package/dist/types/types.d.ts
CHANGED
|
@@ -4,17 +4,53 @@ export type * from './types/upload-files';
|
|
|
4
4
|
export type * from './types/ttl';
|
|
5
5
|
export type { Token };
|
|
6
6
|
export type FilesConfigBase = {
|
|
7
|
+
/**
|
|
8
|
+
* token
|
|
9
|
+
*/
|
|
7
10
|
token: Token;
|
|
11
|
+
/**
|
|
12
|
+
* Account ID for cross-account requests (super admin only)
|
|
13
|
+
*/
|
|
8
14
|
accountId?: string;
|
|
9
15
|
};
|
|
10
16
|
export type FilesConfigWithDiscovery = FilesConfigBase & {
|
|
17
|
+
/**
|
|
18
|
+
* URL of OneReach service discovery API.
|
|
19
|
+
*
|
|
20
|
+
* Allows to fetch URLs of needed API's instead of defining them in the constructor.
|
|
21
|
+
*
|
|
22
|
+
* @example 'https://discovery.<env>.api.onereach.ai'
|
|
23
|
+
*/
|
|
11
24
|
discoveryUrl: string;
|
|
25
|
+
/**
|
|
26
|
+
* Direct service url, can be used to avoid discovery api call
|
|
27
|
+
*
|
|
28
|
+
* Not needed if {@link FilesConfig.discoveryUrl} is defined.
|
|
29
|
+
*
|
|
30
|
+
* @example 'https://files-api.svc.<env>.api.onereach.ai'
|
|
31
|
+
*/
|
|
12
32
|
filesApiUrl?: never;
|
|
33
|
+
/** @deprecated Use {@link FilesConfig.filesApiUrl} instead */
|
|
13
34
|
serviceUrl?: never;
|
|
14
35
|
};
|
|
15
36
|
export type FilesConfigWithExplicitUrls = FilesConfigBase & {
|
|
37
|
+
/**
|
|
38
|
+
* Direct service url, can be used to avoid discovery api call
|
|
39
|
+
*
|
|
40
|
+
* Not needed if {@link FilesConfig.discoveryUrl} is defined.
|
|
41
|
+
*
|
|
42
|
+
* @example 'https://files-api.svc.<env>.api.onereach.ai'
|
|
43
|
+
*/
|
|
16
44
|
filesApiUrl: string;
|
|
45
|
+
/** @deprecated Use {@link FilesConfig.filesApiUrl} instead */
|
|
17
46
|
serviceUrl?: string;
|
|
47
|
+
/**
|
|
48
|
+
* URL of OneReach service discovery API.
|
|
49
|
+
*
|
|
50
|
+
* Not needed if {@link FilesConfig.filesApiUrl} is defined.
|
|
51
|
+
*
|
|
52
|
+
* @example 'https://discovery.<env>.api.onereach.ai'
|
|
53
|
+
*/
|
|
18
54
|
discoveryUrl?: never;
|
|
19
55
|
};
|
|
20
56
|
export type FilesConfig = FilesConfigWithDiscovery | FilesConfigWithExplicitUrls;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAE1C,mBAAmB,sBAAsB,CAAC;AAC1C,mBAAmB,sBAAsB,CAAC;AAC1C,mBAAmB,aAAa,CAAC;AAEjC,YAAY,EAAE,KAAK,EAAE,CAAC;AAEtB,MAAM,MAAM,eAAe,GAAG;
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAE1C,mBAAmB,sBAAsB,CAAC;AAC1C,mBAAmB,sBAAsB,CAAC;AAC1C,mBAAmB,aAAa,CAAC;AAEjC,YAAY,EAAE,KAAK,EAAE,CAAC;AAEtB,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;IAEb;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG,eAAe,GAAG;IACvD;;;;;;OAMG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC;IAEpB,8DAA8D;IAC9D,UAAU,CAAC,EAAE,KAAK,CAAC;CACpB,CAAA;AAED,MAAM,MAAM,2BAA2B,GAAG,eAAe,GAAG;IAC1D;;;;;;OAMG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB,8DAA8D;IAC9D,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,wBAAwB,GAAG,2BAA2B,CAAC;AAEjF,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,OAAO,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,IAAI,GAAG,IAAI,CAAC;IACvB,SAAS,EAAE,IAAI,GAAG,IAAI,CAAC;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,IAAI,GAAG,IAAI,CAAC;IAC1B,GAAG,EAAE,IAAI,GAAG,IAAI,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IACxB,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IAC3B,GAAG,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,KAAK,EAAE,QAAQ,EAAE,CAAC;CACnB,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@or-sdk/files",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.9.0",
|
|
4
4
|
"license": "Apache-2.0",
|
|
5
5
|
"main": "dist/cjs/index.js",
|
|
6
6
|
"module": "dist/esm/index.js",
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
"dev": "pnpm build:watch:esm"
|
|
22
22
|
},
|
|
23
23
|
"dependencies": {
|
|
24
|
-
"@or-sdk/base": "^0.
|
|
24
|
+
"@or-sdk/base": "^0.43.0",
|
|
25
25
|
"form-data": "4.0.4",
|
|
26
26
|
"typescript-memoize": "^1.1.1"
|
|
27
27
|
},
|
|
@@ -31,5 +31,6 @@
|
|
|
31
31
|
},
|
|
32
32
|
"publishConfig": {
|
|
33
33
|
"access": "public"
|
|
34
|
-
}
|
|
34
|
+
},
|
|
35
|
+
"gitHead": "ce62679c119c54ef41fd0d8f7084c563c3b21b24"
|
|
35
36
|
}
|