skapi-js 2.2.6-beta.3 → 2.2.6-beta.4

package/dist/skapi.d.mts

@@ -1,3 +1,14 @@
+declare class SkapiError extends Error {
+    code: string | number;
+    /** The underlying Error, or the flat TicketError body of a failed ticket consumption (consumeTicket). */
+    cause: Error | TicketError;
+    constructor(error: any, options?: {
+        name?: string;
+        code?: string;
+        cause?: Error | TicketError;
+    });
+}
+
 type Condition = 'gt' | 'gte' | 'lt' | 'lte' | 'eq' | '>' | '>=' | '<' | '<=' | '=';
 type RTCReceiverParams = {
     ice?: string;
@@ -558,6 +569,48 @@ type ProgressCallback = (e: {
     failed?: File[];
     abort: () => void;
 }) => void;
+/** One file of an uploadFiles() call that storage did not accept. */
+type FileUploadError = {
+    /** The File as it was given: the same object that is listed in `failed`. */
+    file: File;
+    /** The file's name. */
+    name: string;
+    /**
+     * Why it was not stored. `code` is the storage error code ('AccessDenied', 'EntityTooLarge' ...),
+     * or 'NETWORK_ERROR', 'TIMEOUT' (see UploadFilesParams.timeout), 'ABORTED' (the progress callback's
+     * abort()), 'TOO_MANY_REQUESTS', or 'UPLOAD_FAILED' when storage gave no code. `cause` holds the raw
+     * response or rejection, when there was one.
+     */
+    error: SkapiError;
+};
+/** What uploadFiles() resolves with. */
+type UploadFilesResult = {
+    /** Files that are stored. */
+    completed: File[];
+    /** Files storage did not accept. */
+    failed: File[];
+    /** Why each file in `failed` was not stored, one entry per file in the same order. Empty when every file was stored. */
+    errors: FileUploadError[];
+    /** Endpoint of every file, in the order they were given, whether or not it was stored. */
+    bin_endpoints: string[];
+};
+type UploadFilesParams = {
+    /** Record ID of the record to attach the files to. */
+    record_id: string;
+    /** Callback for upload progress. Useful when building a progress bar. */
+    progress?: ProgressCallback;
+    /**
+     * Milliseconds one file's upload may take. A file that takes longer is aborted and counted as failed with
+     * the code 'TIMEOUT'; the next file is then uploaded. Every file gets the full time. Omitted or 0: no limit.
+     */
+    timeout?: number;
+    /**
+     * Reject at the first file storage does not accept, with that file's error (a SkapiError, see FileUploadError),
+     * instead of resolving with it listed in `failed` and `errors`. The files stored before it stay stored.
+     * Default false.
+     */
+    throwOnFileError?: boolean;
+};
 type FetchOptions = {
     /** Maximum number of records to fetch per call */
     limit?: number;
@@ -1212,6 +1265,7 @@ type Types_DelRecordQuery = DelRecordQuery;
 type Types_EncryptionOptions = EncryptionOptions;
 type Types_FetchOptions = FetchOptions;
 type Types_FileInfo = FileInfo;
+type Types_FileUploadError = FileUploadError;
 type Types_Form<T> = Form<T>;
 type Types_GetRecordQuery = GetRecordQuery;
 type Types_Index = Index;
@@ -1242,12 +1296,14 @@ type Types_TicketReceipt = TicketReceipt;
 type Types_TicketResponseCondition = TicketResponseCondition;
 type Types_TicketSignatureCondition = TicketSignatureCondition;
 type Types_UniqueId = UniqueId;
+type Types_UploadFilesParams = UploadFilesParams;
+type Types_UploadFilesResult = UploadFilesResult;
 type Types_UserAttributes = UserAttributes;
 type Types_UserProfile = UserProfile;
 type Types_UserPublic = UserPublic;
 type Types_WebSocketMessage = WebSocketMessage;
 declare namespace Types {
-  export type { Types_BinaryFile as BinaryFile, Types_Condition as Condition, Types_Connection as Connection, Types_ConnectionInfo as ConnectionInfo, Types_DatabaseResponse as DatabaseResponse, Types_DelRecordQuery as DelRecordQuery, Types_EncryptionOptions as EncryptionOptions, Types_FetchOptions as FetchOptions, Types_FileInfo as FileInfo, Types_Form as Form, Types_GetRecordQuery as GetRecordQuery, Types_Index as Index, Types_Newsletter as Newsletter, Types_NewsletterGroup as NewsletterGroup, Types_PostRecordConfig as PostRecordConfig, Types_ProgressCallback as ProgressCallback, Types_RTCConnector as RTCConnector, Types_RTCConnectorParams as RTCConnectorParams, Types_RTCEvent as RTCEvent, Types_RTCReceiverParams as RTCReceiverParams, Types_RTCResolved as RTCResolved, Types_RealtimeCallback as RealtimeCallback, Types_RecordData as RecordData, Types_RecordEncryptionInfo as RecordEncryptionInfo, Types_RequestHistory as RequestHistory, Types_Subscription as Subscription, Types_Table as Table, Types_Tag as Tag, Types_Ticket as Ticket, Types_TicketAction as TicketAction, Types_TicketCondition as TicketCondition, Types_TicketConditionOperator as TicketConditionOperator, Types_TicketConditionRow as TicketConditionRow, Types_TicketError as TicketError, Types_TicketErrorCode as TicketErrorCode, Types_TicketReceipt as TicketReceipt, Types_TicketResponseCondition as TicketResponseCondition, Types_TicketSignatureCondition as TicketSignatureCondition, Types_UniqueId as UniqueId, Types_UserAttributes as UserAttributes, Types_UserProfile as UserProfile, Types_UserPublic as UserPublic, Types_WebSocketMessage as WebSocketMessage };
+  export type { Types_BinaryFile as BinaryFile, Types_Condition as Condition, Types_Connection as Connection, Types_ConnectionInfo as ConnectionInfo, Types_DatabaseResponse as DatabaseResponse, Types_DelRecordQuery as DelRecordQuery, Types_EncryptionOptions as EncryptionOptions, Types_FetchOptions as FetchOptions, Types_FileInfo as FileInfo, Types_FileUploadError as FileUploadError, Types_Form as Form, Types_GetRecordQuery as GetRecordQuery, Types_Index as Index, Types_Newsletter as Newsletter, Types_NewsletterGroup as NewsletterGroup, Types_PostRecordConfig as PostRecordConfig, Types_ProgressCallback as ProgressCallback, Types_RTCConnector as RTCConnector, Types_RTCConnectorParams as RTCConnectorParams, Types_RTCEvent as RTCEvent, Types_RTCReceiverParams as RTCReceiverParams, Types_RTCResolved as RTCResolved, Types_RealtimeCallback as RealtimeCallback, Types_RecordData as RecordData, Types_RecordEncryptionInfo as RecordEncryptionInfo, Types_RequestHistory as RequestHistory, Types_Subscription as Subscription, Types_Table as Table, Types_Tag as Tag, Types_Ticket as Ticket, Types_TicketAction as TicketAction, Types_TicketCondition as TicketCondition, Types_TicketConditionOperator as TicketConditionOperator, Types_TicketConditionRow as TicketConditionRow, Types_TicketError as TicketError, Types_TicketErrorCode as TicketErrorCode, Types_TicketReceipt as TicketReceipt, Types_TicketResponseCondition as TicketResponseCondition, Types_TicketSignatureCondition as TicketSignatureCondition, Types_UniqueId as UniqueId, Types_UploadFilesParams as UploadFilesParams, Types_UploadFilesResult as UploadFilesResult, Types_UserAttributes as UserAttributes, Types_UserProfile as UserProfile, Types_UserPublic as UserPublic, Types_WebSocketMessage as WebSocketMessage };
 }
 
 declare function terminatePendingRequests(): void;
@@ -2881,19 +2937,14 @@ declare class Skapi {
         endpoints: string | string[];
     }): Promise<RecordData[]>;
     /**
-     * Uploads files to an existing record and returns completed and failed results.
+     * Uploads files to an existing record. Resolves with the files stored (`completed`), the files storage did not accept (`failed`) and why (`errors`, one entry per failed file with a SkapiError that carries the storage code).
+     * `timeout` (milliseconds) aborts a file that takes longer and counts it as failed with the code 'TIMEOUT'; by default a file has no time limit.
+     * `throwOnFileError` rejects at the first file that fails, with that file's error, instead of resolving; the files stored before it stay stored.
      * @param fileList Files or form event containing files.
      * @param params Request parameters.
-     * @returns A promise that resolves to Promise<{ completed: File[], failed: File[], bin_endpoints: string[] }>.
+     * @returns A promise that resolves to Promise<UploadFilesResult>.
      */
-    uploadFiles(fileList: FormData | HTMLFormElement | SubmitEvent, params: {
-        record_id: string;
-        progress?: ProgressCallback;
-    }): Promise<{
-        completed: File[];
-        failed: File[];
-        bin_endpoints: string[];
-    }>;
+    uploadFiles(fileList: FormData | HTMLFormElement | SubmitEvent, params: UploadFilesParams): Promise<UploadFilesResult>;
     /**
      * Calls the mock endpoint for testing request and error handling flows.
      * @param data Data payload for the request.
@@ -3159,15 +3210,4 @@ declare class Skapi {
     bulkPostRecords(config: PostRecordConfig[]): Promise<RecordData[]>;
 }
 
-declare class SkapiError extends Error {
-    code: string | number;
-    /** The underlying Error, or the flat TicketError body of a failed ticket consumption (consumeTicket). */
-    cause: Error | TicketError;
-    constructor(error: any, options?: {
-        name?: string;
-        code?: string;
-        cause?: Error | TicketError;
-    });
-}
-
-export { type BinaryFile, type Condition, type Connection, type ConnectionInfo, type DatabaseResponse, type DelRecordQuery, type FetchOptions, type FileInfo, type Form, type GetRecordQuery, type Index, type Newsletter, type NewsletterGroup, type PostRecordConfig, type ProgressCallback, type RTCConnector, type RTCConnectorParams, type RTCEvent, type RTCReceiverParams, type RTCResolved, type RealtimeCallback, type RecordData, Skapi, SkapiError, type Subscription, type Table, type Tag, type Ticket, type TicketAction, type TicketCondition, type TicketConditionOperator, type TicketConditionRow, type TicketError, type TicketErrorCode, type TicketReceipt, type TicketResponseCondition, type TicketSignatureCondition, Types, type UniqueId, type UserAttributes, type UserProfile, type UserPublic, type WebSocketMessage };
+export { type BinaryFile, type Condition, type Connection, type ConnectionInfo, type DatabaseResponse, type DelRecordQuery, type FetchOptions, type FileInfo, type FileUploadError, type Form, type GetRecordQuery, type Index, type Newsletter, type NewsletterGroup, type PostRecordConfig, type ProgressCallback, type RTCConnector, type RTCConnectorParams, type RTCEvent, type RTCReceiverParams, type RTCResolved, type RealtimeCallback, type RecordData, Skapi, SkapiError, type Subscription, type Table, type Tag, type Ticket, type TicketAction, type TicketCondition, type TicketConditionOperator, type TicketConditionRow, type TicketError, type TicketErrorCode, type TicketReceipt, type TicketResponseCondition, type TicketSignatureCondition, Types, type UniqueId, type UploadFilesParams, type UploadFilesResult, type UserAttributes, type UserProfile, type UserPublic, type WebSocketMessage };

package/dist/skapi.d.ts

@@ -1,3 +1,14 @@
+declare class SkapiError extends Error {
+    code: string | number;
+    /** The underlying Error, or the flat TicketError body of a failed ticket consumption (consumeTicket). */
+    cause: Error | TicketError;
+    constructor(error: any, options?: {
+        name?: string;
+        code?: string;
+        cause?: Error | TicketError;
+    });
+}
+
 type Condition = 'gt' | 'gte' | 'lt' | 'lte' | 'eq' | '>' | '>=' | '<' | '<=' | '=';
 type RTCReceiverParams = {
     ice?: string;
@@ -558,6 +569,48 @@ type ProgressCallback = (e: {
     failed?: File[];
     abort: () => void;
 }) => void;
+/** One file of an uploadFiles() call that storage did not accept. */
+type FileUploadError = {
+    /** The File as it was given: the same object that is listed in `failed`. */
+    file: File;
+    /** The file's name. */
+    name: string;
+    /**
+     * Why it was not stored. `code` is the storage error code ('AccessDenied', 'EntityTooLarge' ...),
+     * or 'NETWORK_ERROR', 'TIMEOUT' (see UploadFilesParams.timeout), 'ABORTED' (the progress callback's
+     * abort()), 'TOO_MANY_REQUESTS', or 'UPLOAD_FAILED' when storage gave no code. `cause` holds the raw
+     * response or rejection, when there was one.
+     */
+    error: SkapiError;
+};
+/** What uploadFiles() resolves with. */
+type UploadFilesResult = {
+    /** Files that are stored. */
+    completed: File[];
+    /** Files storage did not accept. */
+    failed: File[];
+    /** Why each file in `failed` was not stored, one entry per file in the same order. Empty when every file was stored. */
+    errors: FileUploadError[];
+    /** Endpoint of every file, in the order they were given, whether or not it was stored. */
+    bin_endpoints: string[];
+};
+type UploadFilesParams = {
+    /** Record ID of the record to attach the files to. */
+    record_id: string;
+    /** Callback for upload progress. Useful when building a progress bar. */
+    progress?: ProgressCallback;
+    /**
+     * Milliseconds one file's upload may take. A file that takes longer is aborted and counted as failed with
+     * the code 'TIMEOUT'; the next file is then uploaded. Every file gets the full time. Omitted or 0: no limit.
+     */
+    timeout?: number;
+    /**
+     * Reject at the first file storage does not accept, with that file's error (a SkapiError, see FileUploadError),
+     * instead of resolving with it listed in `failed` and `errors`. The files stored before it stay stored.
+     * Default false.
+     */
+    throwOnFileError?: boolean;
+};
 type FetchOptions = {
     /** Maximum number of records to fetch per call */
     limit?: number;
@@ -1212,6 +1265,7 @@ type Types_DelRecordQuery = DelRecordQuery;
 type Types_EncryptionOptions = EncryptionOptions;
 type Types_FetchOptions = FetchOptions;
 type Types_FileInfo = FileInfo;
+type Types_FileUploadError = FileUploadError;
 type Types_Form<T> = Form<T>;
 type Types_GetRecordQuery = GetRecordQuery;
 type Types_Index = Index;
@@ -1242,12 +1296,14 @@ type Types_TicketReceipt = TicketReceipt;
 type Types_TicketResponseCondition = TicketResponseCondition;
 type Types_TicketSignatureCondition = TicketSignatureCondition;
 type Types_UniqueId = UniqueId;
+type Types_UploadFilesParams = UploadFilesParams;
+type Types_UploadFilesResult = UploadFilesResult;
 type Types_UserAttributes = UserAttributes;
 type Types_UserProfile = UserProfile;
 type Types_UserPublic = UserPublic;
 type Types_WebSocketMessage = WebSocketMessage;
 declare namespace Types {
-  export type { Types_BinaryFile as BinaryFile, Types_Condition as Condition, Types_Connection as Connection, Types_ConnectionInfo as ConnectionInfo, Types_DatabaseResponse as DatabaseResponse, Types_DelRecordQuery as DelRecordQuery, Types_EncryptionOptions as EncryptionOptions, Types_FetchOptions as FetchOptions, Types_FileInfo as FileInfo, Types_Form as Form, Types_GetRecordQuery as GetRecordQuery, Types_Index as Index, Types_Newsletter as Newsletter, Types_NewsletterGroup as NewsletterGroup, Types_PostRecordConfig as PostRecordConfig, Types_ProgressCallback as ProgressCallback, Types_RTCConnector as RTCConnector, Types_RTCConnectorParams as RTCConnectorParams, Types_RTCEvent as RTCEvent, Types_RTCReceiverParams as RTCReceiverParams, Types_RTCResolved as RTCResolved, Types_RealtimeCallback as RealtimeCallback, Types_RecordData as RecordData, Types_RecordEncryptionInfo as RecordEncryptionInfo, Types_RequestHistory as RequestHistory, Types_Subscription as Subscription, Types_Table as Table, Types_Tag as Tag, Types_Ticket as Ticket, Types_TicketAction as TicketAction, Types_TicketCondition as TicketCondition, Types_TicketConditionOperator as TicketConditionOperator, Types_TicketConditionRow as TicketConditionRow, Types_TicketError as TicketError, Types_TicketErrorCode as TicketErrorCode, Types_TicketReceipt as TicketReceipt, Types_TicketResponseCondition as TicketResponseCondition, Types_TicketSignatureCondition as TicketSignatureCondition, Types_UniqueId as UniqueId, Types_UserAttributes as UserAttributes, Types_UserProfile as UserProfile, Types_UserPublic as UserPublic, Types_WebSocketMessage as WebSocketMessage };
+  export type { Types_BinaryFile as BinaryFile, Types_Condition as Condition, Types_Connection as Connection, Types_ConnectionInfo as ConnectionInfo, Types_DatabaseResponse as DatabaseResponse, Types_DelRecordQuery as DelRecordQuery, Types_EncryptionOptions as EncryptionOptions, Types_FetchOptions as FetchOptions, Types_FileInfo as FileInfo, Types_FileUploadError as FileUploadError, Types_Form as Form, Types_GetRecordQuery as GetRecordQuery, Types_Index as Index, Types_Newsletter as Newsletter, Types_NewsletterGroup as NewsletterGroup, Types_PostRecordConfig as PostRecordConfig, Types_ProgressCallback as ProgressCallback, Types_RTCConnector as RTCConnector, Types_RTCConnectorParams as RTCConnectorParams, Types_RTCEvent as RTCEvent, Types_RTCReceiverParams as RTCReceiverParams, Types_RTCResolved as RTCResolved, Types_RealtimeCallback as RealtimeCallback, Types_RecordData as RecordData, Types_RecordEncryptionInfo as RecordEncryptionInfo, Types_RequestHistory as RequestHistory, Types_Subscription as Subscription, Types_Table as Table, Types_Tag as Tag, Types_Ticket as Ticket, Types_TicketAction as TicketAction, Types_TicketCondition as TicketCondition, Types_TicketConditionOperator as TicketConditionOperator, Types_TicketConditionRow as TicketConditionRow, Types_TicketError as TicketError, Types_TicketErrorCode as TicketErrorCode, Types_TicketReceipt as TicketReceipt, Types_TicketResponseCondition as TicketResponseCondition, Types_TicketSignatureCondition as TicketSignatureCondition, Types_UniqueId as UniqueId, Types_UploadFilesParams as UploadFilesParams, Types_UploadFilesResult as UploadFilesResult, Types_UserAttributes as UserAttributes, Types_UserProfile as UserProfile, Types_UserPublic as UserPublic, Types_WebSocketMessage as WebSocketMessage };
 }
 
 declare function terminatePendingRequests(): void;
@@ -2881,19 +2937,14 @@ declare class Skapi {
         endpoints: string | string[];
     }): Promise<RecordData[]>;
     /**
-     * Uploads files to an existing record and returns completed and failed results.
+     * Uploads files to an existing record. Resolves with the files stored (`completed`), the files storage did not accept (`failed`) and why (`errors`, one entry per failed file with a SkapiError that carries the storage code).
+     * `timeout` (milliseconds) aborts a file that takes longer and counts it as failed with the code 'TIMEOUT'; by default a file has no time limit.
+     * `throwOnFileError` rejects at the first file that fails, with that file's error, instead of resolving; the files stored before it stay stored.
      * @param fileList Files or form event containing files.
      * @param params Request parameters.
-     * @returns A promise that resolves to Promise<{ completed: File[], failed: File[], bin_endpoints: string[] }>.
+     * @returns A promise that resolves to Promise<UploadFilesResult>.
      */
-    uploadFiles(fileList: FormData | HTMLFormElement | SubmitEvent, params: {
-        record_id: string;
-        progress?: ProgressCallback;
-    }): Promise<{
-        completed: File[];
-        failed: File[];
-        bin_endpoints: string[];
-    }>;
+    uploadFiles(fileList: FormData | HTMLFormElement | SubmitEvent, params: UploadFilesParams): Promise<UploadFilesResult>;
     /**
      * Calls the mock endpoint for testing request and error handling flows.
      * @param data Data payload for the request.
@@ -3159,15 +3210,4 @@ declare class Skapi {
     bulkPostRecords(config: PostRecordConfig[]): Promise<RecordData[]>;
 }
 
-declare class SkapiError extends Error {
-    code: string | number;
-    /** The underlying Error, or the flat TicketError body of a failed ticket consumption (consumeTicket). */
-    cause: Error | TicketError;
-    constructor(error: any, options?: {
-        name?: string;
-        code?: string;
-        cause?: Error | TicketError;
-    });
-}
-
-export { type BinaryFile, type Condition, type Connection, type ConnectionInfo, type DatabaseResponse, type DelRecordQuery, type FetchOptions, type FileInfo, type Form, type GetRecordQuery, type Index, type Newsletter, type NewsletterGroup, type PostRecordConfig, type ProgressCallback, type RTCConnector, type RTCConnectorParams, type RTCEvent, type RTCReceiverParams, type RTCResolved, type RealtimeCallback, type RecordData, Skapi, SkapiError, type Subscription, type Table, type Tag, type Ticket, type TicketAction, type TicketCondition, type TicketConditionOperator, type TicketConditionRow, type TicketError, type TicketErrorCode, type TicketReceipt, type TicketResponseCondition, type TicketSignatureCondition, Types, type UniqueId, type UserAttributes, type UserProfile, type UserPublic, type WebSocketMessage };
+export { type BinaryFile, type Condition, type Connection, type ConnectionInfo, type DatabaseResponse, type DelRecordQuery, type FetchOptions, type FileInfo, type FileUploadError, type Form, type GetRecordQuery, type Index, type Newsletter, type NewsletterGroup, type PostRecordConfig, type ProgressCallback, type RTCConnector, type RTCConnectorParams, type RTCEvent, type RTCReceiverParams, type RTCResolved, type RealtimeCallback, type RecordData, Skapi, SkapiError, type Subscription, type Table, type Tag, type Ticket, type TicketAction, type TicketCondition, type TicketConditionOperator, type TicketConditionRow, type TicketError, type TicketErrorCode, type TicketReceipt, type TicketResponseCondition, type TicketSignatureCondition, Types, type UniqueId, type UploadFilesParams, type UploadFilesResult, type UserAttributes, type UserProfile, type UserPublic, type WebSocketMessage };