@or-sdk/files 3.9.0 → 3.10.0

package/dist/types/types/upload-files.d.ts

@@ -1,55 +1,18 @@
 import type { AxiosProgressEvent } from 'axios';
 import type { ReadStream } from 'node:fs';
-import type { Timestamp } from './ttl';
+import type { DateTime } from './ttl';
 export type { AxiosProgressEvent };
 export type RequestOptions = {
-    /** Signal from AbortController to abort active request */
     signal?: AbortSignal;
 };
 export type UploadBaseParams = {
-    /**
-     * Name of the file
-     * @example 'my_file.json'
-     */
     fileName: string;
-    /**
-     * File path prefix
-     * @example If fine name is 'my_file.json' and prefix is 'path/to/file/' the result file path is:
-     * 'path/to/file/my_file.json'
-     *
-     * @example If fine name is 'my_file.json' and prefix is 'name_prefix_' the result file path is:
-     * 'name_prefix_my_file.json'
-     */
     prefix?: string;
-    /**
-     * [MIME type](https://www.iana.org/assignments/media-types/media-types.xhtml)
-     * of the file.
-     * @default 'binary/octet-stream'
-     * @example 'application/json'
-     */
     contentType?: string;
-    /** Max size of the file in bytes */
     maxFileSize?: number;
-    /**
-     * Custom cache control setting for a file
-     *
-     * Examples:
-     * - `max-age=<seconds>`
-     * Specifies the maximum time (in seconds) a resource is considered fresh.
-     * For example, max-age=86400 means the resource is cached for 1 day.
-     * - `no-cache`
-     * Force to validate with the origin server before serving a cached copy.
-     * Useful for content that changes frequently.
-     */
     cacheControl?: string;
     rewriteMode?: 'rewrite' | 'prevent-rewrite';
-    /** Datetime when file should expire and be deleted */
-    expiresAt?: Timestamp;
-    /**
-     * If `true` after upload file would be publicly available by it's URL.
-     * If `false` access to file is possible only via temporary signed URL to a file.
-     * @default false
-     */
+    expiresAt?: DateTime;
     isPublic?: boolean;
 };
 export type UploadUrlProps = UploadBaseParams;
@@ -77,48 +40,22 @@ export type UploadFields = {
     'X-Amz-Security-Token': string;
     'cache-control'?: string;
 };
-/** Buffer and ReadStream only supported in Node.js */
 export type FileModel = File | Blob | Buffer | ReadStream;
-/** Allows to use string as a file value */
-export type ExtendedFileModel = FileModel | string;
+export type ExtendedFileModel = FileModel | string | Uint8Array;
 export type UploadFileBaseParams = UploadBaseParams & {
-    /** File contents */
     fileContent: ExtendedFileModel;
-    /** Callback function to be called with upload progress events */
     onUploadProgress?: (event: ProgressEvent | AxiosProgressEvent) => void;
-    /** Size of the file in bytes. Helpful when file is an instance of ReadStream in Node.js */
     knownLength?: number;
-    /** If `true` method will wait after file upload until file system will update to include file */
     waitTillFileAddedInDb?: boolean;
 };
 export type UploadFileProps = UploadFileBaseParams;
-/** Optional config for uploading files */
 export type UploadFileOptions = RequestOptions & {
-    /**
-     * Maximum wait time for update of the data base in milliseconds.
-     * @default 60_000
-     */
     waitForDatabaseUpdateTimeout?: number;
-    /**
-     * Interval between checking if database was updated in milliseconds.
-     * @default 2_000
-     */
     waitForDatabaseUpdatePollInterval?: number;
 };
 export type UploadToSignedUrlParameters = Pick<UploadFileProps, 'fileName' | 'fileContent' | 'contentType' | 'cacheControl' | 'knownLength' | 'onUploadProgress'> & {
     signedUrl: UploadUrlResponse;
 };
-export type UploadToSignedUrlParameters2 = {
-    signedUrl: UploadUrlResponse;
-    file: FileModel;
-    fileName: string;
-    cacheControl?: string;
-    /** Size of the file in bytes. Helpful when file is an instance of ReadStream in Node.js */
-    knownLength?: number;
-    contentType?: string;
-    signal?: AbortSignal;
-    onUploadProgress?: (event: ProgressEvent | AxiosProgressEvent) => void;
-};
 export type UploadFilePropsLegacy = Pick<UploadFileProps, 'prefix' | 'cacheControl' | 'isPublic' | 'rewriteMode' | 'maxFileSize' | 'knownLength' | 'waitTillFileAddedInDb'> & {
     name: string;
     fileModel: ExtendedFileModel;

package/dist/types/types/upload-files.d.ts.map

@@ -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;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"}
+{"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,QAAQ,EAAE,MAAM,OAAO,CAAC;AAEtC,YAAY,EAAE,kBAAkB,EAAE,CAAC;AAEnC,MAAM,MAAM,cAAc,GAAG;IAE3B,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB,CAAA;AAED,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

@@ -4,53 +4,17 @@ export type * from './types/upload-files';
 export type * from './types/ttl';
 export type { Token };
 export type FilesConfigBase = {
-    /**
-     * token
-     */
     token: Token;
-    /**
-     * Account ID for cross-account requests (super admin only)
-     */
     accountId?: string;
 };
 export type FilesConfigWithDiscovery = FilesConfigBase & {
-    /**
-     * URL of OneReach service discovery API.
-     *
-     * Allows to fetch URLs of needed API's instead of defining them in the constructor.
-     *
-     * @example 'https://discovery.<env>.api.onereach.ai'
-     */
     discoveryUrl: string;
-    /**
-     * Direct service url, can be used to avoid discovery api call
-     *
-     * Not needed if {@link FilesConfig.discoveryUrl} is defined.
-     *
-     * @example 'https://files-api.svc.<env>.api.onereach.ai'
-     */
     filesApiUrl?: never;
-    /** @deprecated Use {@link FilesConfig.filesApiUrl} instead */
     serviceUrl?: never;
 };
 export type FilesConfigWithExplicitUrls = FilesConfigBase & {
-    /**
-     * Direct service url, can be used to avoid discovery api call
-     *
-     * Not needed if {@link FilesConfig.discoveryUrl} is defined.
-     *
-     * @example 'https://files-api.svc.<env>.api.onereach.ai'
-     */
     filesApiUrl: string;
-    /** @deprecated Use {@link FilesConfig.filesApiUrl} instead */
     serviceUrl?: string;
-    /**
-     * URL of OneReach service discovery API.
-     *
-     * Not needed if {@link FilesConfig.filesApiUrl} is defined.
-     *
-     * @example 'https://discovery.<env>.api.onereach.ai'
-     */
     discoveryUrl?: never;
 };
 export type FilesConfig = FilesConfigWithDiscovery | FilesConfigWithExplicitUrls;

package/dist/types/types.d.ts.map

@@ -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;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"}
+{"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;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

@@ -1,6 +1,6 @@
 {
   "name": "@or-sdk/files",
-  "version": "3.9.0",
+  "version": "3.10.0",
   "license": "Apache-2.0",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -32,5 +32,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "ce62679c119c54ef41fd0d8f7084c563c3b21b24"
+  "gitHead": "480349cb6b36e66aea6b9b63b93ed61c95497f94"
 }

package/src/Files.ts

@@ -9,13 +9,15 @@ import type {
   FileItem,
   FileItemSelect,
   FileModel,
-  FilesConfig,
+  FilesConfigWithDiscovery,
+  FilesConfigWithExplicitUrls,
   GetItemsQuery,
   GetSystemFileUploadUrlParams,
   GetUploadUrlDataPayload,
+  NormalizeDateOptions,
   RequestOptions,
   SearchQuery,
-  Timestamp,
+  DateTime,
   UploadFileOptions,
   UploadFileProps,
   UploadFilePropsLegacy,
@@ -28,8 +30,14 @@ import type {
 } from './types';
 import { isNode } from './utils';
 
+const defaultContentType = 'application/octet-stream';
+
 export class Files extends Base {
-  constructor(params: FilesConfig) {
+  /** Service-Discovery API allows to fetch URLs for required services automatically on bootstrap */
+  constructor(params: FilesConfigWithDiscovery);
+  /** Providing URLs for APIs explicitly allows to reduce initial delay by avoiding extra calls to discovery service */
+  constructor(params: FilesConfigWithExplicitUrls);
+  constructor(params: FilesConfigWithDiscovery | FilesConfigWithExplicitUrls) {
     const { token, accountId, discoveryUrl, filesApiUrl, serviceUrl } = params;
 
     super({
@@ -65,13 +73,14 @@ export class Files extends Base {
    * @param key the file path, example: /data/images/second.png
    * @returns Folder record
    */
-  async getFolder(key: string): Promise<FileItem> {
+  async getFolder(key: string, options?: RequestOptions): Promise<FileItem> {
     return await this.callApiV2({
       method: 'get',
       route: 'folders/find-one',
       params: {
         key,
       },
+      signal: options?.signal,
     });
   }
 
@@ -80,13 +89,8 @@ export class Files extends Base {
    * @param key the name of folder
    * @returns total folder size in bytes
    */
-  async getFolderSize(key: string): Promise<number> {
-    const { size } = await this.callApiV2<{ size: number; }>({
-      method: 'get',
-      route: 'folders/find-one',
-      params: { key },
-    });
-
+  async getFolderSize(key: string, options?: RequestOptions): Promise<number> {
+    const { size } = await this.getFolder(key, options);
     return size;
   }
 
@@ -129,11 +133,12 @@ export class Files extends Base {
     return [...folders, ...files];
   }
 
-  async getFoldersList(treePrefix: string) {
+  async getFoldersList(treePrefix: string, options?: RequestOptions) {
     return await this.callApiV2<FileItem[]>({
       method: 'GET',
       route: 'folders/search',
       params: { prefix: treePrefix },
+      signal: options?.signal,
     });
   }
 
@@ -158,11 +163,7 @@ export class Files extends Base {
 
       isPublic
         ? [] as FileItem[]
-        : this.callApiV2<FileItem[]>({
-          method: 'GET',
-          route: 'folders/search',
-          params: queryParams,
-        }),
+        : this.getFoldersList(term),
     ]);
 
     return [...files, ...folders];
@@ -171,10 +172,11 @@ export class Files extends Base {
   /**
    * Create ROOT folder
    */
-  async createRootFolder(): Promise<void> {
+  async createRootFolder(options?: RequestOptions): Promise<void> {
     await this.callApiV2({
       method: 'post',
       route: 'folders/root',
+      signal: options?.signal,
     });
   }
 
@@ -182,11 +184,12 @@ export class Files extends Base {
    * Create new folder
    * @param folderName should have folder path + folder name, example: /main/New folder
    */
-  async createFolder(folderName: string): Promise<void> {
+  async createFolder(folderName: string, options?: RequestOptions): Promise<void> {
     await this.callApiV2({
       method: 'post',
       route: 'folders',
       data: { key: folderName },
+      signal: options?.signal,
     });
   }
 
@@ -285,11 +288,12 @@ export class Files extends Base {
    * Delete folder
    * @param key folder name
    */
-  async deleteFolder(key: string): Promise<void> {
+  async deleteFolder(key: string, options?: RequestOptions): Promise<void> {
     await this.callApiV2({
       method: 'delete',
       route: 'folders',
       params: { key },
+      signal: options?.signal,
     });
   }
 
@@ -320,7 +324,14 @@ export class Files extends Base {
    */
   public async getUploadUrlV2(
     /** Details of the file to be uploaded */
-    { fileName, prefix, contentType, isPublic = false, expiresAt, ...data }: UploadUrlProps,
+    {
+      fileName,
+      prefix,
+      contentType = defaultContentType,
+      isPublic = false,
+      expiresAt,
+      ...data
+    }: UploadUrlProps,
 
     /** Additional request options */
     options?: RequestOptions,
@@ -329,7 +340,7 @@ export class Files extends Base {
     const reqData: GetUploadUrlDataPayload = {
       ...data,
       key: fileKey,
-      contentType: contentType ?? this.defaultContentType,
+      contentType,
     };
     const signal = options?.signal;
 
@@ -360,7 +371,7 @@ export class Files extends Base {
       fileName,
       prefix,
       fileContent,
-      contentType,
+      contentType = defaultContentType,
       expiresAt,
       isPublic = false,
       rewriteMode,
@@ -436,7 +447,7 @@ export class Files extends Base {
       fileName,
       prefix,
       fileContent,
-      contentType,
+      contentType = defaultContentType,
       cacheControl = 'max-age=3600',
       expiresAt,
       knownLength,
@@ -472,13 +483,29 @@ export class Files extends Base {
     return signedUrl.downloadUrl;
   }
 
+  /**
+   * Delete system file
+   * @param path file path
+   */
+  public async deleteSystemFile(path: string, options?: RequestOptions): Promise<void> {
+    await this.callApiV2({
+      method: 'delete',
+      route: 'system-file',
+      params: { key: path },
+      signal: options?.signal,
+    });
+  }
+
   /** Get signed URL params for uploading of system file */
-  protected async getSystemFileUploadUrl(
-    params: GetSystemFileUploadUrlParams,
+  private async getSystemFileUploadUrl(
+    {
+      fileName,
+      prefix,
+      cacheControl,
+      expiresAt,
+    }: GetSystemFileUploadUrlParams,
     options?: RequestOptions,
   ): Promise<UploadUrlResponse> {
-    const { fileName, prefix, cacheControl, expiresAt } = params;
-
     return await this.callApiV2<UploadUrlResponse>({
       method: 'post',
       route: 'system-file',
@@ -492,18 +519,6 @@ export class Files extends Base {
     });
   }
 
-  /**
-   * Delete system file
-   * @param path file path
-   */
-  public async deleteSystemFile(path: string): Promise<void> {
-    await this.callApiV2({
-      method: 'delete',
-      route: 'system-file',
-      params: { key: path },
-    });
-  }
-
   // -----------------------
   // --- Files TTL logic ---
   // -----------------------
@@ -512,16 +527,17 @@ export class Files extends Base {
    * Set ttl for a specific file or folder
    * @param key file or folder path
    * @param isPublic `false` for folders, `true` or `false` for files
-   * @param ttl number which represents milliseconds
+   * @param expiresAt when file should expire and be deleted
    */
-  async addTtl(key: string, isPublic: boolean, ttl: number): Promise<void> {
+  async addTtl(key: string, isPublic: boolean, expiresAt: DateTime): Promise<void> {
+    // TODO: convert to new format
     return this.callApiV2({
       method: 'post',
       route: 'ttl-files',
       data: {
         key,
         isPublic,
-        ttl: new Date(ttl).toISOString(),
+        ttl: this.normalizeDate(expiresAt).toISOString(),
       },
     });
   }
@@ -530,16 +546,17 @@ export class Files extends Base {
    * Update ttl for a specific file or folder
    * @param key file or folder path
    * @param isPublic false for folders, true or false for files
-   * @param newTtl number which represents milliseconds
+   * @param newExpiresAt when file should expire and be deleted
    */
-  async updateTtl(key: string, isPublic: boolean, newTtl: number): Promise<void> {
+  async updateTtl(key: string, isPublic: boolean, newExpiresAt: DateTime): Promise<void> {
+    // TODO: convert to new format
     return this.callApiV2({
       method: 'patch',
       route: 'ttl-files',
       data: {
         key,
         isPublic,
-        newTtl: new Date(newTtl).toISOString(),
+        newTtl: this.normalizeDate(newExpiresAt).toISOString(),
       },
     });
   }
@@ -565,7 +582,7 @@ export class Files extends Base {
     fileName,
     fileContent,
     cacheControl,
-    contentType,
+    contentType = defaultContentType,
     knownLength,
     onUploadProgress,
   }: UploadToSignedUrlParameters, options?: RequestOptions) {
@@ -619,7 +636,7 @@ export class Files extends Base {
   }
 
   private getFormDataHeaders(formData: FormDataNode | FormData): Record<string, string> {
-    return ('getHeaders' in formData)
+    return ('getHeaders' in formData && typeof formData.getHeaders === 'function')
       ? formData.getHeaders()
       : {};
   }
@@ -630,9 +647,19 @@ export class Files extends Base {
       return isNode ? Buffer.from(bytes) : new Blob([bytes]);
     }
 
+    if (fileContent instanceof Uint8Array) {
+      const bytes = fileContent as Uint8Array;
+      return isNode
+        ? Buffer.from(bytes)
+        : new Blob([bytes.buffer as ArrayBuffer]);
+    }
+
     return fileContent;
   }
 
+  private normalizeDate(input: undefined, options?: NormalizeDateOptions): undefined;
+  private normalizeDate(input: DateTime, options?: NormalizeDateOptions): Date;
+  private normalizeDate(input: DateTime | undefined, options?: NormalizeDateOptions): Date | undefined;
   /**
    * Get Date instance from input that represents date
    *
@@ -641,20 +668,22 @@ export class Files extends Base {
    * @returns Date instance represented by input
    * @throws If input is invalid date
    */
-  private normalizeDate(input: Timestamp | undefined, errorMessage?: string): Date | undefined {
+  private normalizeDate(input: DateTime | undefined, options?: NormalizeDateOptions): Date | undefined {
     if (input == undefined) return undefined;
 
+    const { errorMessage, validateFutureDate = true } = options ?? {};
+
     const date = input instanceof Date ? input : new Date(input);
 
-    if (isNaN(date.getTime())) throw new Error(errorMessage ?? 'Invalid date input');
+    if (isNaN(date.getTime())) {
+      throw new Error(errorMessage ?? 'Invalid date input');
+    } else if (validateFutureDate && Date.now() > date.getTime()) {
+      throw new Error(errorMessage ?? 'Date must be a future date');
+    }
 
     return date;
   }
 
-  private get defaultContentType() {
-    return 'binary/octet-stream';
-  }
-
   // --------------------------
   // --- Deprecated methods ---
   // --------------------------

package/src/types/ttl.ts

@@ -3,4 +3,15 @@
  * - `number` amount of milliseconds since midnight Jan 1 1970 UTC (aka UNIX timestamp in milliseconds)
  * - `string` valid Date string that represents datetime
  * */
-export type Timestamp = Date | number | string;
+export type DateTime = Date | number | string;
+
+export type NormalizeDateOptions = {
+  /** Message of the error to throw if input is invalid date */
+  errorMessage?: string;
+
+  /**
+   * If `true` check that date is in the future, otherwise do not check
+   * @default true
+   */
+  validateFutureDate?: boolean;
+}

package/src/types/upload-files.ts

@@ -1,7 +1,7 @@
 import type { AxiosProgressEvent } from 'axios';
 import type { ReadStream } from 'node:fs';
 
-import type { Timestamp } from './ttl';
+import type { DateTime } from './ttl';
 
 export type { AxiosProgressEvent };
 
@@ -55,7 +55,7 @@ export type UploadBaseParams = {
   rewriteMode?: 'rewrite' | 'prevent-rewrite';
 
   /** Datetime when file should expire and be deleted */
-  expiresAt?: Timestamp;
+  expiresAt?: DateTime;
 
   /**
    * If `true` after upload file would be publicly available by it's URL.
@@ -78,8 +78,13 @@ export type GetUploadUrlDataPayload = Omit<UploadUrlProps, 'expiresAt' | 'fileNa
 };
 
 export type UploadUrlResponse = {
+  /** URL for uploading of the file */
   url: string;
+
+  /** URL for downloading the file once it will be uploaded */
   downloadUrl: string;
+
+  /** Additional FormData fields and headers for uploading the file */
   fields: UploadFields;
 };
 
@@ -97,8 +102,8 @@ export type UploadFields = {
 
 /** Buffer and ReadStream only supported in Node.js */
 export type FileModel = File | Blob | Buffer | ReadStream;
-/** Allows to use string as a file value */
-export type ExtendedFileModel = FileModel | string;
+/** Allows to use a string or Uint8Array<ArrayBuffer> as a file value */
+export type ExtendedFileModel = FileModel | string | Uint8Array;
 
 export type UploadFileBaseParams = UploadBaseParams & {
   /** File contents */
@@ -138,18 +143,6 @@ export type UploadToSignedUrlParameters = Pick<
   signedUrl: UploadUrlResponse;
 }
 
-export type UploadToSignedUrlParameters2 = {
-  signedUrl: UploadUrlResponse;
-  file: FileModel;
-  fileName: string;
-  cacheControl?: string;
-  /** Size of the file in bytes. Helpful when file is an instance of ReadStream in Node.js */
-  knownLength?: number;
-  contentType?: string;
-  signal?: AbortSignal;
-  onUploadProgress?: (event: ProgressEvent | AxiosProgressEvent) => void;
-}
-
 // -------- deprecated ----------
 export type UploadFilePropsLegacy = Pick<
   UploadFileProps,