@or-sdk/files 3.11.2-beta.4096.0 → 3.11.2-beta.4097.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.
|
@@ -1,16 +1,6 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* - `Date` valid date instance
|
|
3
|
-
* - `number` amount of milliseconds since midnight Jan 1 1970 UTC (aka UNIX timestamp in milliseconds)
|
|
4
|
-
* - `string` valid Date string that represents datetime
|
|
5
|
-
* */
|
|
6
1
|
export type DateTime = Date | number | string;
|
|
7
2
|
export type NormalizeDateOptions = {
|
|
8
|
-
/** Message of the error to throw if input is invalid date */
|
|
9
3
|
errorMessage?: string;
|
|
10
|
-
/**
|
|
11
|
-
* If `true` check that date is in the future, otherwise do not check
|
|
12
|
-
* @default true
|
|
13
|
-
*/
|
|
14
4
|
validateFutureDate?: boolean;
|
|
15
5
|
};
|
|
16
6
|
//# sourceMappingURL=ttl.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ttl.d.ts","sourceRoot":"","sources":["../../../src/types/ttl.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"ttl.d.ts","sourceRoot":"","sources":["../../../src/types/ttl.ts"],"names":[],"mappings":"AAKA,MAAM,MAAM,QAAQ,GAAG,IAAI,GAAG,MAAM,GAAG,MAAM,CAAC;AAE9C,MAAM,MAAM,oBAAoB,GAAG;IAEjC,YAAY,CAAC,EAAE,MAAM,CAAC;IAMtB,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B,CAAA"}
|
|
@@ -4,49 +4,13 @@ import type { ReadStream } from 'node:fs';
|
|
|
4
4
|
import type { DateTime } from './ttl';
|
|
5
5
|
export type { AxiosProgressEvent };
|
|
6
6
|
export type UploadBaseParams = {
|
|
7
|
-
/**
|
|
8
|
-
* Name of the file
|
|
9
|
-
* @example 'my_file.json'
|
|
10
|
-
*/
|
|
11
7
|
fileName: string;
|
|
12
|
-
/**
|
|
13
|
-
* File path prefix
|
|
14
|
-
* @example If fine name is 'my_file.json' and prefix is 'path/to/file/' the result file path is:
|
|
15
|
-
* 'path/to/file/my_file.json'
|
|
16
|
-
*
|
|
17
|
-
* @example If fine name is 'my_file.json' and prefix is 'name_prefix_' the result file path is:
|
|
18
|
-
* 'name_prefix_my_file.json'
|
|
19
|
-
*/
|
|
20
8
|
prefix?: string;
|
|
21
|
-
/**
|
|
22
|
-
* [MIME type](https://www.iana.org/assignments/media-types/media-types.xhtml)
|
|
23
|
-
* of the file.
|
|
24
|
-
* @default 'binary/octet-stream'
|
|
25
|
-
* @example 'application/json'
|
|
26
|
-
*/
|
|
27
9
|
contentType?: string;
|
|
28
|
-
/** Max size of the file in bytes */
|
|
29
10
|
maxFileSize?: number;
|
|
30
|
-
/**
|
|
31
|
-
* Custom cache control setting for a file
|
|
32
|
-
*
|
|
33
|
-
* Examples:
|
|
34
|
-
* - `max-age=<seconds>`
|
|
35
|
-
* Specifies the maximum time (in seconds) a resource is considered fresh.
|
|
36
|
-
* For example, max-age=86400 means the resource is cached for 1 day.
|
|
37
|
-
* - `no-cache`
|
|
38
|
-
* Force to validate with the origin server before serving a cached copy.
|
|
39
|
-
* Useful for content that changes frequently.
|
|
40
|
-
*/
|
|
41
11
|
cacheControl?: string;
|
|
42
12
|
rewriteMode?: 'rewrite' | 'prevent-rewrite';
|
|
43
|
-
/** Datetime when file should expire and be deleted */
|
|
44
13
|
expiresAt?: DateTime;
|
|
45
|
-
/**
|
|
46
|
-
* If `true` after upload file would be publicly available by it's URL.
|
|
47
|
-
* If `false` access to file is possible only via temporary signed URL to a file.
|
|
48
|
-
* @default false
|
|
49
|
-
*/
|
|
50
14
|
isPublic?: boolean;
|
|
51
15
|
};
|
|
52
16
|
export type UploadUrlProps = UploadBaseParams;
|
|
@@ -59,11 +23,8 @@ export type GetUploadUrlDataPayload = Omit<UploadUrlProps, 'expiresAt' | 'fileNa
|
|
|
59
23
|
ttl?: string;
|
|
60
24
|
};
|
|
61
25
|
export type UploadUrlResponse = {
|
|
62
|
-
/** URL for uploading of the file */
|
|
63
26
|
url: string;
|
|
64
|
-
/** URL for downloading the file once it will be uploaded */
|
|
65
27
|
downloadUrl: string;
|
|
66
|
-
/** Additional FormData fields and headers for uploading the file */
|
|
67
28
|
fields: UploadFields;
|
|
68
29
|
};
|
|
69
30
|
export type UploadFields = {
|
|
@@ -77,32 +38,17 @@ export type UploadFields = {
|
|
|
77
38
|
'X-Amz-Security-Token': string;
|
|
78
39
|
'cache-control'?: string;
|
|
79
40
|
};
|
|
80
|
-
/** Buffer and ReadStream only supported in Node.js */
|
|
81
41
|
export type FileModel = File | Blob | Buffer | ReadStream;
|
|
82
|
-
/** Allows to use a string or Uint8Array<ArrayBuffer> as a file value */
|
|
83
42
|
export type ExtendedFileModel = FileModel | string | Uint8Array;
|
|
84
43
|
export type UploadFileBaseParams = UploadBaseParams & {
|
|
85
|
-
/** File contents */
|
|
86
44
|
fileContent: ExtendedFileModel;
|
|
87
|
-
/** Callback function to be called with upload progress events */
|
|
88
45
|
onUploadProgress?: (event: ProgressEvent | AxiosProgressEvent) => void;
|
|
89
|
-
/** Size of the file in bytes. Helpful when file is an instance of ReadStream in Node.js */
|
|
90
46
|
knownLength?: number;
|
|
91
|
-
/** If `true` method will wait after file upload until file system will update to include file */
|
|
92
47
|
waitTillFileAddedInDb?: boolean;
|
|
93
48
|
};
|
|
94
49
|
export type UploadFileProps = UploadFileBaseParams;
|
|
95
|
-
/** Optional config for uploading files */
|
|
96
50
|
export type UploadFileOptions = RequestOptions & {
|
|
97
|
-
/**
|
|
98
|
-
* Maximum wait time for update of the data base in milliseconds.
|
|
99
|
-
* @default 60_000
|
|
100
|
-
*/
|
|
101
51
|
waitForDatabaseUpdateTimeout?: number;
|
|
102
|
-
/**
|
|
103
|
-
* Interval between checking if database was updated in milliseconds.
|
|
104
|
-
* @default 2_000
|
|
105
|
-
*/
|
|
106
52
|
waitForDatabaseUpdatePollInterval?: number;
|
|
107
53
|
};
|
|
108
54
|
export type UploadToSignedUrlParameters = Pick<UploadFileProps, 'fileName' | 'fileContent' | 'contentType' | 'cacheControl' | 'knownLength' | 'onUploadProgress'> & {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"upload-files.d.ts","sourceRoot":"","sources":["../../../src/types/upload-files.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AACnD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAChD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAE1C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAEtC,YAAY,EAAE,kBAAkB,EAAE,CAAC;AAEnC,MAAM,MAAM,gBAAgB,GAAG;
|
|
1
|
+
{"version":3,"file":"upload-files.d.ts","sourceRoot":"","sources":["../../../src/types/upload-files.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AACnD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAChD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAE1C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAEtC,YAAY,EAAE,kBAAkB,EAAE,CAAC;AAEnC,MAAM,MAAM,gBAAgB,GAAG;IAK7B,QAAQ,EAAE,MAAM,CAAC;IAUjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAQhB,WAAW,CAAC,EAAE,MAAM,CAAC;IAGrB,WAAW,CAAC,EAAE,MAAM,CAAC;IAarB,YAAY,CAAC,EAAE,MAAM,CAAC;IAGtB,WAAW,CAAC,EAAE,SAAS,GAAG,iBAAiB,CAAC;IAG5C,SAAS,CAAC,EAAE,QAAQ,CAAC;IAOrB,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;IAE9B,GAAG,EAAE,MAAM,CAAC;IAGZ,WAAW,EAAE,MAAM,CAAC;IAGpB,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;AAGF,MAAM,MAAM,SAAS,GAAG,IAAI,GAAG,IAAI,GAAG,MAAM,GAAG,UAAU,CAAC;AAE1D,MAAM,MAAM,iBAAiB,GAAG,SAAS,GAAG,MAAM,GAAG,UAAU,CAAC;AAEhE,MAAM,MAAM,oBAAoB,GAAG,gBAAgB,GAAG;IAEpD,WAAW,EAAE,iBAAiB,CAAC;IAG/B,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,aAAa,GAAG,kBAAkB,KAAK,IAAI,CAAC;IAGvE,WAAW,CAAC,EAAE,MAAM,CAAC;IAGrB,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC,CAAA;AAED,MAAM,MAAM,eAAe,GAAG,oBAAoB,CAAC;AAGnD,MAAM,MAAM,iBAAiB,GAAG,cAAc,GAAG;IAK/C,4BAA4B,CAAC,EAAE,MAAM,CAAC;IAMtC,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;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
|
@@ -5,53 +5,17 @@ export type * from './types/upload-files';
|
|
|
5
5
|
export type * from './types/ttl';
|
|
6
6
|
export type { Token };
|
|
7
7
|
export type FilesConfigBase = {
|
|
8
|
-
/**
|
|
9
|
-
* token
|
|
10
|
-
*/
|
|
11
8
|
token: Token;
|
|
12
|
-
/**
|
|
13
|
-
* Account ID for cross-account requests (super admin only)
|
|
14
|
-
*/
|
|
15
9
|
accountId?: string;
|
|
16
10
|
};
|
|
17
11
|
export type FilesConfigWithDiscovery = FilesConfigBase & {
|
|
18
|
-
/**
|
|
19
|
-
* URL of OneReach service discovery API.
|
|
20
|
-
*
|
|
21
|
-
* Allows to fetch URLs of needed API's instead of defining them in the constructor.
|
|
22
|
-
*
|
|
23
|
-
* @example 'https://discovery.<env>.api.onereach.ai'
|
|
24
|
-
*/
|
|
25
12
|
discoveryUrl: string;
|
|
26
|
-
/**
|
|
27
|
-
* Direct service url, can be used to avoid discovery api call
|
|
28
|
-
*
|
|
29
|
-
* Not needed if {@link FilesConfig.discoveryUrl} is defined.
|
|
30
|
-
*
|
|
31
|
-
* @example 'https://files-api.svc.<env>.api.onereach.ai'
|
|
32
|
-
*/
|
|
33
13
|
filesApiUrl?: never;
|
|
34
|
-
/** @deprecated Use {@link FilesConfig.filesApiUrl} instead */
|
|
35
14
|
serviceUrl?: never;
|
|
36
15
|
};
|
|
37
16
|
export type FilesConfigWithExplicitUrls = FilesConfigBase & {
|
|
38
|
-
/**
|
|
39
|
-
* Direct service url, can be used to avoid discovery api call
|
|
40
|
-
*
|
|
41
|
-
* Not needed if {@link FilesConfig.discoveryUrl} is defined.
|
|
42
|
-
*
|
|
43
|
-
* @example 'https://files-api.svc.<env>.api.onereach.ai'
|
|
44
|
-
*/
|
|
45
17
|
filesApiUrl: string;
|
|
46
|
-
/** @deprecated Use {@link FilesConfig.filesApiUrl} instead */
|
|
47
18
|
serviceUrl?: string;
|
|
48
|
-
/**
|
|
49
|
-
* URL of OneReach service discovery API.
|
|
50
|
-
*
|
|
51
|
-
* Not needed if {@link FilesConfig.filesApiUrl} is defined.
|
|
52
|
-
*
|
|
53
|
-
* @example 'https://discovery.<env>.api.onereach.ai'
|
|
54
|
-
*/
|
|
55
19
|
discoveryUrl?: never;
|
|
56
20
|
};
|
|
57
21
|
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,cAAc,EAAE,MAAM,cAAc,CAAC;AAE1D,YAAY,EAAE,cAAc,EAAE,CAAC;AAE/B,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,cAAc,EAAE,MAAM,cAAc,CAAC;AAE1D,YAAY,EAAE,cAAc,EAAE,CAAC;AAE/B,mBAAmB,sBAAsB,CAAC;AAC1C,mBAAmB,sBAAsB,CAAC;AAC1C,mBAAmB,aAAa,CAAC;AAEjC,YAAY,EAAE,KAAK,EAAE,CAAC;AAEtB,MAAM,MAAM,eAAe,GAAG;IAI5B,KAAK,EAAE,KAAK,CAAC;IAKb,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG,eAAe,GAAG;IAQvD,YAAY,EAAE,MAAM,CAAC;IASrB,WAAW,CAAC,EAAE,KAAK,CAAC;IAGpB,UAAU,CAAC,EAAE,KAAK,CAAC;CACpB,CAAA;AAED,MAAM,MAAM,2BAA2B,GAAG,eAAe,GAAG;IAQ1D,WAAW,EAAE,MAAM,CAAC;IAGpB,UAAU,CAAC,EAAE,MAAM,CAAC;IASpB,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.11.2-beta.
|
|
3
|
+
"version": "3.11.2-beta.4097.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.44.1-beta.
|
|
24
|
+
"@or-sdk/base": "^0.44.1-beta.4097.0",
|
|
25
25
|
"form-data": "4.0.4",
|
|
26
26
|
"typescript-memoize": "^1.1.1"
|
|
27
27
|
},
|