@meistrari/vault-sdk 1.0.1 → 1.2.0

package/dist/index.d.mts

@@ -14,6 +14,15 @@ declare class APIKeyAuthStrategy implements AuthStrategy {
     constructor(apiKey: string);
 }
 
+declare class FetchError extends Error {
+    readonly message: string;
+    readonly url: string;
+    readonly method: string;
+    readonly response: Response;
+    constructor(message: string, url: string, method: string, response: Response);
+    static from(url: string, method: string, response: Response): Promise<FetchError>;
+}
+
 type VaultConfig = {
     vaultUrl: string;
     authStrategy: AuthStrategy;
@@ -76,12 +85,18 @@ declare class VaultFile {
      * @param params.method - The method to use for the fetch
      * @param params.path - The path to fetch
      * @param params.body - The body of the request
+     * @param params.signal - The signal to abort the request
      * @returns The response from the vault
      * @throws {FetchError} If the fetch fails
      */
     private _fetch;
     /**
      * Creates a new file in the vault.
+     * @param metadata - The metadata for creating a file
+     * @param metadata.size - The size of the file
+     * @param metadata.mimeType - The mime type of the file
+     * @param options - The options for the request
+     * @param options.signal - The signal to abort the request
      *
      * @returns The metadata of the file
      * @throws {Error} If the file ID is not set
@@ -95,6 +110,9 @@ declare class VaultFile {
      * @param params.reference - The reference to the file in the vault
      * @param params.config - The configuration for the VaultFile
      * @param params.download - Whether to download the file content (default: false)
+     * @param options - The options for the request
+     * @param options.signal - The signal to abort the request
+     *
      * @returns A new VaultFile instance
      *
      * @example
@@ -128,6 +146,8 @@ declare class VaultFile {
         reference: string;
         config: VaultConfig;
         download?: boolean;
+    }, options?: {
+        signal?: AbortSignal;
     }): Promise<VaultFile>;
     /**
      * Creates a new VaultFile instance from given content.
@@ -137,6 +157,9 @@ declare class VaultFile {
      * @param params.content - The content of the file
      * @param params.config - The configuration for the VaultFile
      * @param params.upload - Whether to upload the file (default: false)
+     * @param options - The options for the request
+     * @param options.signal - The signal to abort the request
+     *
      * @returns A new VaultFile instance
      *
      * @example
@@ -174,15 +197,21 @@ declare class VaultFile {
         content: Blob | File;
         config: VaultConfig;
         upload?: boolean;
+    }, options?: {
+        signal?: AbortSignal;
     }): Promise<VaultFile>;
     /**
      * Populates the metadata of the file instance.
+     * @param options - The options for the request
+     * @param options.signal - The signal to abort the request
      *
      * @returns The file instance
      * @throws {Error} If the file ID is not set
      * @throws {FetchError} If the metadata fetch fails
      */
-    populateMetadata(): Promise<this | undefined>;
+    populateMetadata(options?: {
+        signal?: AbortSignal;
+    }): Promise<this | undefined>;
     /**
      * Gets the vault reference for this file.
      *
@@ -192,49 +221,77 @@ declare class VaultFile {
     getVaultReference(): string;
     /**
      * Fetches the metadata of the file.
+     * @param options - The options for the request
+     * @param options.signal - The signal to abort the request
      *
      * @returns The metadata of the file
      * @throws {Error} If the file ID is not set
      * @throws {FetchError} If the metadata fetch fails
      */
-    getFileMetadata(): Promise<FileMetadata>;
+    getFileMetadata(options?: {
+        signal?: AbortSignal;
+    }): Promise<FileMetadata>;
     /**
      * Fetches a upload URL for the file.
+     * @param options - The options for the request
+     * @param options.signal - The signal to abort the request
      *
      * @returns The upload URL for the file
      * @throws {Error} If the vault service returns an invalid response
      * @throws {FetchError} If the upload URL fetch fails
      */
-    getUploadUrl(): Promise<URL>;
+    getUploadUrl(options?: {
+        signal?: AbortSignal;
+    }): Promise<URL>;
     /**
      * Fetches a download URL for the file.
+     * @param options - The options for the request
+     * @param options.signal - The signal to abort the request
      *
      * @returns The download URL for the file
      * @throws {Error} If the vault service returns an invalid response
      * @throws {Error} If not file ID, name or content is set
      * @throws {FetchError} If the download URL fetch fails
      */
-    getDownloadUrl(): Promise<URL>;
+    getDownloadUrl(options?: {
+        signal?: AbortSignal;
+    }): Promise<URL>;
     /**
      * Uploads a file to the vault.
      *
      * @example
      * ```ts
      * const file = new File(['content'], 'document.txt')
-     * const vaultFile = await VaultFile.fromBlob('document.txt', file, { vaultUrl, authStrategy })
+     * const vaultFile = await VaultFile.fromContent({
+     *     name: 'document.txt',
+     *     content: file,
+     *     config: {
+     *         vaultUrl,
+     *         authStrategy,
+     *     },
+     * })
      * await vaultFile.upload(file)
      * ```
      *
      * @param file - The file to upload to the vault. If not provided, the file content will be taken from the `content` property.
+     * @param url - The URL to upload the file to. If not provided, the upload URL will be fetched from the vault.
+     * @param options - The options for the request
+     * @param options.signal - The signal to abort the request
+     *
      * @throws {FetchError} If the upload fails
      * @throws {Error} If the file content is not set and no file is provided
      * @returns Promise that resolves when upload is complete
      */
-    upload(file?: Blob, url?: string): Promise<void>;
+    upload(file?: Blob, url?: string, options?: {
+        signal?: AbortSignal;
+    }): Promise<void>;
     /**
      * Downloads a file from the vault.
      *
      * @param responseType - The type of the response
+     * @param options - The options for the request
+     * @param options.signal - The signal to abort the request
+     *
      * @returns The response from the vault
      *
      * @example
@@ -243,22 +300,22 @@ declare class VaultFile {
      * const content = await vaultFile.download()
      * ```
      */
-    download(responseType?: 'blob'): Promise<Blob>;
-    download(responseType: 'base64'): Promise<string>;
-}
-
-declare class FetchError extends Error {
-    readonly message: string;
-    readonly url: string;
-    readonly method: string;
-    readonly response: Response;
-    constructor(message: string, url: string, method: string, response: Response);
-    static from(url: string, method: string, response: Response): Promise<FetchError>;
+    download(responseType?: 'blob', options?: {
+        signal?: AbortSignal;
+    }): Promise<Blob>;
+    download(responseType: 'base64', options?: {
+        signal?: AbortSignal;
+    }): Promise<string>;
 }
 
 declare function vaultClient(config: VaultConfig): {
-    createFromContent: (name: string, content: Blob | File) => Promise<VaultFile>;
-    createFromReference: (reference: string) => Promise<VaultFile>;
+    createFromContent: (name: string, content: Blob | File, options?: {
+        signal?: AbortSignal;
+    }) => Promise<VaultFile>;
+    createFromReference: (reference: string, options?: {
+        signal?: AbortSignal;
+    }) => Promise<VaultFile>;
 };
 
-export { APIKeyAuthStrategy, type AuthStrategy, DataTokenAuthStrategy, FetchError, type VaultConfig, VaultFile, vaultClient };
+export { APIKeyAuthStrategy, DataTokenAuthStrategy, FetchError, VaultFile, vaultClient };
+export type { AuthStrategy, VaultConfig };

package/dist/index.d.ts

@@ -14,6 +14,15 @@ declare class APIKeyAuthStrategy implements AuthStrategy {
     constructor(apiKey: string);
 }
 
+declare class FetchError extends Error {
+    readonly message: string;
+    readonly url: string;
+    readonly method: string;
+    readonly response: Response;
+    constructor(message: string, url: string, method: string, response: Response);
+    static from(url: string, method: string, response: Response): Promise<FetchError>;
+}
+
 type VaultConfig = {
     vaultUrl: string;
     authStrategy: AuthStrategy;
@@ -76,12 +85,18 @@ declare class VaultFile {
      * @param params.method - The method to use for the fetch
      * @param params.path - The path to fetch
      * @param params.body - The body of the request
+     * @param params.signal - The signal to abort the request
      * @returns The response from the vault
      * @throws {FetchError} If the fetch fails
      */
     private _fetch;
     /**
      * Creates a new file in the vault.
+     * @param metadata - The metadata for creating a file
+     * @param metadata.size - The size of the file
+     * @param metadata.mimeType - The mime type of the file
+     * @param options - The options for the request
+     * @param options.signal - The signal to abort the request
      *
      * @returns The metadata of the file
      * @throws {Error} If the file ID is not set
@@ -95,6 +110,9 @@ declare class VaultFile {
      * @param params.reference - The reference to the file in the vault
      * @param params.config - The configuration for the VaultFile
      * @param params.download - Whether to download the file content (default: false)
+     * @param options - The options for the request
+     * @param options.signal - The signal to abort the request
+     *
      * @returns A new VaultFile instance
      *
      * @example
@@ -128,6 +146,8 @@ declare class VaultFile {
         reference: string;
         config: VaultConfig;
         download?: boolean;
+    }, options?: {
+        signal?: AbortSignal;
     }): Promise<VaultFile>;
     /**
      * Creates a new VaultFile instance from given content.
@@ -137,6 +157,9 @@ declare class VaultFile {
      * @param params.content - The content of the file
      * @param params.config - The configuration for the VaultFile
      * @param params.upload - Whether to upload the file (default: false)
+     * @param options - The options for the request
+     * @param options.signal - The signal to abort the request
+     *
      * @returns A new VaultFile instance
      *
      * @example
@@ -174,15 +197,21 @@ declare class VaultFile {
         content: Blob | File;
         config: VaultConfig;
         upload?: boolean;
+    }, options?: {
+        signal?: AbortSignal;
     }): Promise<VaultFile>;
     /**
      * Populates the metadata of the file instance.
+     * @param options - The options for the request
+     * @param options.signal - The signal to abort the request
      *
      * @returns The file instance
      * @throws {Error} If the file ID is not set
      * @throws {FetchError} If the metadata fetch fails
      */
-    populateMetadata(): Promise<this | undefined>;
+    populateMetadata(options?: {
+        signal?: AbortSignal;
+    }): Promise<this | undefined>;
     /**
      * Gets the vault reference for this file.
      *
@@ -192,49 +221,77 @@ declare class VaultFile {
     getVaultReference(): string;
     /**
      * Fetches the metadata of the file.
+     * @param options - The options for the request
+     * @param options.signal - The signal to abort the request
      *
      * @returns The metadata of the file
      * @throws {Error} If the file ID is not set
      * @throws {FetchError} If the metadata fetch fails
      */
-    getFileMetadata(): Promise<FileMetadata>;
+    getFileMetadata(options?: {
+        signal?: AbortSignal;
+    }): Promise<FileMetadata>;
     /**
      * Fetches a upload URL for the file.
+     * @param options - The options for the request
+     * @param options.signal - The signal to abort the request
      *
      * @returns The upload URL for the file
      * @throws {Error} If the vault service returns an invalid response
      * @throws {FetchError} If the upload URL fetch fails
      */
-    getUploadUrl(): Promise<URL>;
+    getUploadUrl(options?: {
+        signal?: AbortSignal;
+    }): Promise<URL>;
     /**
      * Fetches a download URL for the file.
+     * @param options - The options for the request
+     * @param options.signal - The signal to abort the request
      *
      * @returns The download URL for the file
      * @throws {Error} If the vault service returns an invalid response
      * @throws {Error} If not file ID, name or content is set
      * @throws {FetchError} If the download URL fetch fails
      */
-    getDownloadUrl(): Promise<URL>;
+    getDownloadUrl(options?: {
+        signal?: AbortSignal;
+    }): Promise<URL>;
     /**
      * Uploads a file to the vault.
      *
      * @example
      * ```ts
      * const file = new File(['content'], 'document.txt')
-     * const vaultFile = await VaultFile.fromBlob('document.txt', file, { vaultUrl, authStrategy })
+     * const vaultFile = await VaultFile.fromContent({
+     *     name: 'document.txt',
+     *     content: file,
+     *     config: {
+     *         vaultUrl,
+     *         authStrategy,
+     *     },
+     * })
      * await vaultFile.upload(file)
      * ```
      *
      * @param file - The file to upload to the vault. If not provided, the file content will be taken from the `content` property.
+     * @param url - The URL to upload the file to. If not provided, the upload URL will be fetched from the vault.
+     * @param options - The options for the request
+     * @param options.signal - The signal to abort the request
+     *
      * @throws {FetchError} If the upload fails
      * @throws {Error} If the file content is not set and no file is provided
      * @returns Promise that resolves when upload is complete
      */
-    upload(file?: Blob, url?: string): Promise<void>;
+    upload(file?: Blob, url?: string, options?: {
+        signal?: AbortSignal;
+    }): Promise<void>;
     /**
      * Downloads a file from the vault.
      *
      * @param responseType - The type of the response
+     * @param options - The options for the request
+     * @param options.signal - The signal to abort the request
+     *
      * @returns The response from the vault
      *
      * @example
@@ -243,22 +300,22 @@ declare class VaultFile {
      * const content = await vaultFile.download()
      * ```
      */
-    download(responseType?: 'blob'): Promise<Blob>;
-    download(responseType: 'base64'): Promise<string>;
-}
-
-declare class FetchError extends Error {
-    readonly message: string;
-    readonly url: string;
-    readonly method: string;
-    readonly response: Response;
-    constructor(message: string, url: string, method: string, response: Response);
-    static from(url: string, method: string, response: Response): Promise<FetchError>;
+    download(responseType?: 'blob', options?: {
+        signal?: AbortSignal;
+    }): Promise<Blob>;
+    download(responseType: 'base64', options?: {
+        signal?: AbortSignal;
+    }): Promise<string>;
 }
 
 declare function vaultClient(config: VaultConfig): {
-    createFromContent: (name: string, content: Blob | File) => Promise<VaultFile>;
-    createFromReference: (reference: string) => Promise<VaultFile>;
+    createFromContent: (name: string, content: Blob | File, options?: {
+        signal?: AbortSignal;
+    }) => Promise<VaultFile>;
+    createFromReference: (reference: string, options?: {
+        signal?: AbortSignal;
+    }) => Promise<VaultFile>;
 };
 
-export { APIKeyAuthStrategy, type AuthStrategy, DataTokenAuthStrategy, FetchError, type VaultConfig, VaultFile, vaultClient };
+export { APIKeyAuthStrategy, DataTokenAuthStrategy, FetchError, VaultFile, vaultClient };
+export type { AuthStrategy, VaultConfig };