@visulima/storage 1.0.0-alpha.15 → 1.0.0-alpha.16

package/dist/metrics/opentelemetry-metrics.d.ts

@@ -1,55 +0,0 @@
-/**
- * OpenTelemetry Metrics implementation for storage operations.
- *
- * Provides counters, timers, and gauges using OpenTelemetry Metrics API.
- * This allows integration with any OpenTelemetry-compatible observability backend
- * (Prometheus, Datadog, New Relic, etc.).
- * @example
- * ```typescript
- * import { metrics } from "@opentelemetry/api";
- * import { OpenTelemetryMetrics } from "@visulima/storage/metrics";
- * import { S3Storage } from "@visulima/storage/provider/aws";
- *
- * // Initialize OpenTelemetry (typically done once in your app)
- * const meter = metrics.getMeter("@visulima/storage", "1.0.0");
- *
- * // Create metrics instance
- * const storageMetrics = new OpenTelemetryMetrics(meter);
- *
- * // Use with storage
- * const storage = new S3Storage({
- *     bucket: "my-bucket",
- *     metrics: storageMetrics,
- * });
- * ```
- */
-import type { Meter } from "@opentelemetry/api";
-import type { Metrics } from "../utils/types.d.ts";
-/**
- * OpenTelemetry-based metrics implementation.
- */
-declare class OpenTelemetryMetrics implements Metrics {
-    private readonly meter;
-    private readonly counters;
-    private readonly histograms;
-    private readonly gauges;
-    /**
-     * Creates a new OpenTelemetryMetrics instance.
-     * @param meter OpenTelemetry Meter instance. If not provided, uses the default meter.
-     * @throws {Error} If \@opentelemetry/api is not installed
-     */
-    constructor(meter?: Meter);
-    /**
-     * Increment a counter metric.
-     */
-    increment(name: string, value?: number, attributes?: Record<string, string | number>): void;
-    /**
-     * Record a duration/timing metric in milliseconds.
-     */
-    timing(name: string, duration: number, attributes?: Record<string, string | number>): void;
-    /**
-     * Set a gauge metric value.
-     */
-    gauge(name: string, value: number, attributes?: Record<string, string | number>): void;
-}
-export default OpenTelemetryMetrics;

package/dist/openapi/rest.d.ts

@@ -1,7 +0,0 @@
-import type { OpenAPIV3 } from "openapi-types";
-declare const swaggerSpec: (origin: string, path: string, options: {
-    supportedTransformerFormat?: string[];
-    tags?: string[] | undefined;
-    transformer?: boolean | "audio" | "video" | "image";
-}) => Partial<OpenAPIV3.Document>;
-export default swaggerSpec;

package/dist/openapi/shared.d.ts

@@ -1,13 +0,0 @@
-import type { OpenAPIV3 } from "openapi-types";
-type TransformType = boolean | "audio" | "video" | "image";
-declare const getOrganizedTransformationParameters: (transform?: TransformType, format?: string[]) => {
-    groups: Record<string, string[]>;
-    parameters: OpenAPIV3.ParameterObject[];
-};
-export { getOrganizedTransformationParameters };
-export declare const sharedGet: (operationId: string, tags: string[] | undefined, transform?: TransformType, transformerFormat?: string[]) => OpenAPIV3.OperationObject;
-export declare const sharedGetMeta: (operationId: string, tags: string[] | undefined) => OpenAPIV3.OperationObject;
-export declare const sharedErrorSchemaObject: Record<string, OpenAPIV3.NonArraySchemaObject>;
-export declare const sharedFileMetaSchemaObject: Record<string, OpenAPIV3.NonArraySchemaObject>;
-export declare const sharedFileMetaExampleObject: Record<string, OpenAPIV3.ExampleObject>;
-export declare const sharedGetList: (operationId: string, tags: string[] | undefined) => OpenAPIV3.OperationObject;

package/dist/openapi/transform.d.ts

@@ -1,3 +0,0 @@
-import type { OpenAPIV3 } from "openapi-types";
-declare const swaggerSpec: (path?: string, tags?: string[] | undefined) => Partial<OpenAPIV3.Document>;
-export default swaggerSpec;

package/dist/openapi/tus.d.ts

@@ -1,7 +0,0 @@
-import type { OpenAPIV3 } from "openapi-types";
-declare const swaggerSpec: (path: string, options: {
-    supportedTransformerFormat?: string[];
-    tags?: string[] | undefined;
-    transformer?: boolean | "audio" | "video" | "image";
-}) => Partial<OpenAPIV3.Document>;
-export default swaggerSpec;

package/dist/openapi/xhr.d.ts

@@ -1,7 +0,0 @@
-import type { OpenAPIV3 } from "openapi-types";
-declare const swaggerSpec: (origin: string, path: string, options: {
-    supportedTransformerFormat?: string[];
-    tags?: string[] | undefined;
-    transformer?: boolean | "audio" | "video" | "image";
-}) => Partial<OpenAPIV3.Document>;
-export default swaggerSpec;

package/dist/storage/aws/clients/backblaze.d.ts

@@ -1,12 +0,0 @@
-import type { S3ClientConfig } from "@aws-sdk/client-s3";
-import type { CreateBackblazeClientParameters } from "./types.d.ts";
-/**
- * Create a Backblaze B2 client, compatible with the S3 API.
- *
- * Optionally, you can omit the parameters and use the following environment variables:
- * - `B2_REGION`
- * - `B2_APP_KEY_ID`
- * - `B2_APP_KEY`
- */
-export declare const backblaze: (parameters?: CreateBackblazeClientParameters) => S3ClientConfig;
-export default backblaze;

package/dist/storage/aws/clients/cloudflare.d.ts

@@ -1,13 +0,0 @@
-import type { S3ClientConfig } from "@aws-sdk/client-s3";
-import type { CreateCloudflareClientParameters } from "./types.d.ts";
-/**
- * Create a Cloudflare R2 client, compatible with the S3 API.
- *
- * Optionally, you can omit the parameters and use the following environment variables:
- * - `CLOUDFLARE_ACCOUNT_ID`
- * - `AWS_ACCESS_KEY_ID`
- * - `AWS_SECRET_ACCESS_KEY`
- * - `CLOUDFLARE_JURISDICTION`
- */
-export declare const cloudflare: (parameters?: CreateCloudflareClientParameters) => S3ClientConfig;
-export default cloudflare;

package/dist/storage/aws/clients/digital-ocean.d.ts

@@ -1,12 +0,0 @@
-import type { S3ClientConfig } from "@aws-sdk/client-s3";
-import type { CreateDigitalOceanClientParameters } from "./types.d.ts";
-/**
- * Create a DigitalOcean Spaces client, compatible with the S3 API.
- *
- * Optionally, you can omit the parameters and use the following environment variables:
- * - `SPACES_REGION`
- * - `SPACES_KEY`
- * - `SPACES_SECRET`
- */
-declare const digitalOcean: (parameters?: CreateDigitalOceanClientParameters) => S3ClientConfig;
-export default digitalOcean;

package/dist/storage/aws/clients/minio.d.ts

@@ -1,13 +0,0 @@
-import type { S3ClientConfig } from "@aws-sdk/client-s3";
-import type { CreateMinioClientParameters } from "./types.d.ts";
-/**
- * Create a Minio client, compatible with the S3 API.
- *
- * Optionally, you can omit the parameters and use the following environment variables:
- * - `AWS_REGION`
- * - `AWS_ACCESS_KEY_ID`
- * - `AWS_SECRET_ACCESS_KEY`
- * - `MINIO_ENDPOINT`
- */
-declare const minio: (parameters?: CreateMinioClientParameters) => S3ClientConfig;
-export default minio;

package/dist/storage/aws/clients/tigris.d.ts

@@ -1,12 +0,0 @@
-import type { S3ClientConfig } from "@aws-sdk/client-s3";
-import type { CreateTigrisClientParameters } from "./types.d.ts";
-/**
- * Create a Tigris client, compatible with the S3 API.
- *
- * Optionally, you can omit the parameters and use the following environment variables:
- * - `AWS_ACCESS_KEY_ID`
- * - `AWS_SECRET_ACCESS_KEY`
- * - `TIGRIS_ENDPOINT`
- */
-declare const tigris: (parameters?: CreateTigrisClientParameters) => S3ClientConfig;
-export default tigris;

package/dist/storage/aws/clients/types.d.ts

@@ -1,95 +0,0 @@
-export type CreateCloudflareClientParameters = {
-    /**
-     * Cloudflare R2 access key ID.
-     */
-    accessKeyId: string;
-    /**
-     * Cloudflare account ID.
-     */
-    accountId: string;
-    /**
-     * The jurisdiction where the data is stored.
-     *
-     * Only use this if you created your R2 bucket using a jurisdiction.
-     */
-    jurisdiction?: "eu" | "fedramp";
-    /**
-     * Cloudflare R2 secret access key.
-     */
-    secretAccessKey: string;
-};
-export type CreateMinioClientParameters = {
-    /**
-     * Minio access key ID.
-     */
-    accessKeyId: string;
-    /**
-     * Minio endpoint.
-     */
-    endpoint: string;
-    /**
-     * Minio region.
-     */
-    region: string;
-    /**
-     * Minio secret access key.
-     */
-    secretAccessKey: string;
-};
-export type CreateBackblazeClientParameters = {
-    /**
-     * Backblaze B2 application key.
-     */
-    applicationKey: string;
-    /**
-     * Backblaze B2 application key ID.
-     */
-    applicationKeyId: string;
-    /**
-     * Backblaze B2 region.
-     */
-    region: string;
-};
-export type CreateWasabiClientParameters = {
-    /**
-     * Wasabi access key ID.
-     */
-    accessKeyId: string;
-    /**
-     * Wasabi region.
-     */
-    region: string;
-    /**
-     * Wasabi secret access key.
-     */
-    secretAccessKey: string;
-};
-export type CreateDigitalOceanClientParameters = {
-    /**
-     * DigitalOcean Spaces key.
-     */
-    key: string;
-    /**
-     * DigitalOcean Spaces region.
-     */
-    region: string;
-    /**
-     * DigitalOcean Spaces secret.
-     */
-    secret: string;
-};
-export type CreateTigrisClientParameters = {
-    /**
-     * Tigris access key ID.
-     */
-    accessKeyId: string;
-    /**
-     * Tigris endpoint.
-     * @default `https://t3.storage.dev`
-     */
-    endpoint?: string;
-    /**
-     * Tigris secret access key.
-     */
-    secretAccessKey: string;
-};

package/dist/storage/aws/clients/wasabi.d.ts

@@ -1,12 +0,0 @@
-import type { S3ClientConfig } from "@aws-sdk/client-s3";
-import type { CreateWasabiClientParameters } from "./types.d.ts";
-/**
- * Create a Wasabi client, compatible with the S3 API.
- *
- * Optionally, you can omit the parameters and use the following environment variables:
- * - `WASABI_REGION`
- * - `AWS_ACCESS_KEY_ID`
- * - `AWS_SECRET_ACCESS_KEY`
- */
-declare const wasabi: (parameters?: CreateWasabiClientParameters) => S3ClientConfig;
-export default wasabi;

package/dist/storage/aws/s3-base-storage.d.ts

@@ -1,248 +0,0 @@
-import { Readable } from "node:stream";
-import type { RetryConfig } from "../../utils/retry.d.ts";
-import { createRetryWrapper } from "../../utils/retry.d.ts";
-import type MetaStorage from "../meta-storage.d.ts";
-import { BaseStorage } from "../storage.d.ts";
-import type { File, FileInit, FilePart, FileQuery, FileReturn } from "../utils/index.d.ts";
-/**
- * Part interface for multipart uploads.
- */
-export interface Part {
-    ETag?: string;
-    PartNumber: number;
-    Size?: number;
-}
-/**
- * Base file type for S3-compatible storage.
- */
-export interface S3CompatibleFile extends File {
-    Parts?: Part[];
-    partSize?: number;
-    partsUrls?: string[];
-    UploadId?: string;
-    uri?: string;
-}
-/**
- * S3 API operations interface that must be implemented by concrete storage classes.
- */
-export interface S3ApiOperations {
-    abortMultipartUpload: (params: {
-        Bucket: string;
-        Key: string;
-        UploadId: string;
-    }) => Promise<void>;
-    checkBucketAccess: (params: {
-        Bucket: string;
-    }) => Promise<void>;
-    completeMultipartUpload: (params: {
-        Bucket: string;
-        Key: string;
-        Parts: {
-            ETag: string;
-            PartNumber: number;
-        }[];
-        UploadId: string;
-    }) => Promise<{
-        ETag?: string;
-        Location: string;
-    }>;
-    copyObject: (params: {
-        Bucket: string;
-        CopySource: string;
-        Key: string;
-        StorageClass?: string;
-    }) => Promise<void>;
-    createMultipartUpload: (params: {
-        ACL?: string;
-        Bucket: string;
-        ContentType?: string;
-        Key: string;
-        Metadata?: Record<string, string>;
-    }) => Promise<{
-        UploadId: string;
-    }>;
-    deleteObject: (params: {
-        Bucket: string;
-        Key: string;
-    }) => Promise<void>;
-    getObject: (params: {
-        Bucket: string;
-        Key: string;
-    }) => Promise<{
-        Body?: ReadableStream | Readable;
-        ContentLength?: number;
-        ContentType?: string;
-        ETag?: string;
-        Expires?: Date;
-        LastModified?: Date;
-        Metadata?: Record<string, string>;
-    }>;
-    getPresignedUrl: (params: {
-        Bucket: string;
-        expiresIn: number;
-        Key: string;
-        PartNumber: number;
-        UploadId: string;
-    }) => Promise<string>;
-    headObject: (params: {
-        Bucket: string;
-        Key: string;
-    }) => Promise<{
-        ContentLength?: number;
-        ContentType?: string;
-        ETag?: string;
-        Expires?: Date;
-        LastModified?: Date;
-        Metadata?: Record<string, string>;
-    }>;
-    listObjectsV2: (params: {
-        Bucket: string;
-        ContinuationToken?: string;
-        MaxKeys?: number;
-    }) => Promise<{
-        Contents?: {
-            Key?: string;
-            LastModified?: Date;
-        }[];
-        IsTruncated?: boolean;
-        NextContinuationToken?: string;
-    }>;
-    listParts: (params: {
-        Bucket: string;
-        Key: string;
-        UploadId: string;
-    }) => Promise<{
-        Parts?: Part[];
-    }>;
-    uploadPart: (params: {
-        Body: Readable | ReadableStream | Uint8Array;
-        Bucket: string;
-        ContentLength?: number;
-        ContentMD5?: string;
-        Key: string;
-        PartNumber: number;
-        UploadId: string;
-    }) => Promise<{
-        ETag: string;
-    }>;
-}
-/**
- * Base class for S3-compatible storage implementations.
- * Contains all shared business logic for S3 operations.
- * @template TFile The file type used by this storage backend.
- */
-export declare abstract class S3BaseStorage<TFile extends S3CompatibleFile = S3CompatibleFile> extends BaseStorage<TFile> {
-    checksumTypes: string[];
-    protected bucket: string;
-    protected meta: MetaStorage<TFile>;
-    /**
-     * S3 multipart upload does not allow more than 10000 parts.
-     */
-    protected readonly MAX_PARTS = 10000;
-    protected readonly partSize: number;
-    protected readonly retry: ReturnType<typeof createRetryWrapper>;
-    /**
-     * Abstract method to get S3 API operations implementation.
-     */
-    protected abstract getS3Api(): S3ApiOperations;
-    /**
-     * Abstract method to get the file class constructor.
-     */
-    protected abstract getFileClass(): new (config: FileInit) => TFile;
-    /**
-     * Abstract method to get ACL value.
-     */
-    protected abstract getAcl(): string | undefined;
-    /**
-     * Abstract method for access check.
-     */
-    protected abstract accessCheck(maxWaitTime?: number): Promise<void>;
-    constructor(config: {
-        bucket: string;
-        clientDirectUpload?: boolean;
-        expiration?: {
-            maxAge?: string;
-        };
-        filename?: (file: TFile) => string;
-        logger?: BaseStorage<TFile>["logger"];
-        metaStorage?: MetaStorage<TFile>;
-        metaStorageConfig?: unknown;
-        partSize?: number | string;
-        retryConfig?: RetryConfig;
-    });
-    /**
-     * Creates a new S3 multipart upload.
-     */
-    create(config: FileInit): Promise<TFile>;
-    /**
-     * Writes data to an S3 multipart upload.
-     */
-    write(part: FilePart | FileQuery | TFile): Promise<TFile>;
-    /**
-     * Deletes an upload and its metadata.
-     */
-    delete({ id }: FileQuery): Promise<TFile>;
-    /**
-     * Copies an upload file to a new location.
-     */
-    copy(name: string, destination: string, options?: {
-        storageClass?: string;
-    }): Promise<TFile>;
-    /**
-     * Moves an upload file to a new location.
-     */
-    move(name: string, destination: string): Promise<TFile>;
-    /**
-     * Lists files in the bucket.
-     */
-    list(limit?: number): Promise<TFile[]>;
-    /**
-     * Checks if a file exists by verifying both metadata and the actual S3 object.
-     * Returns true only if both the metadata and the S3 object exist.
-     * @param query File query containing the file ID to check.
-     * @returns Promise resolving to true if both metadata and S3 object exist, false otherwise.
-     */
-    exists({ id }: FileQuery): Promise<boolean>;
-    /**
-     * Gets an uploaded file by ID.
-     */
-    get({ id }: FileQuery): Promise<FileReturn>;
-    /**
-     * Gets file stream (abstract - must be implemented by subclasses due to stream differences).
-     */
-    abstract getStream(query: FileQuery): Promise<{
-        headers?: Record<string, string>;
-        size?: number;
-        stream: Readable;
-    }>;
-    /**
-     * Builds presigned URLs for client uploads.
-     */
-    protected buildPresigned(file: TFile): Promise<TFile>;
-    /**
-     * Gets presigned URLs for all parts.
-     */
-    protected getPartsPresignedUrls(file: TFile): Promise<string[]>;
-    /**
-     * Gets parts for a multipart upload.
-     */
-    protected getParts(file: TFile): Promise<Part[]>;
-    /**
-     * Completes a multipart upload.
-     */
-    protected completeMultipartUpload(file: TFile): Promise<{
-        ETag?: string;
-        Location: string;
-    }>;
-    /**
-     * Aborts a multipart upload.
-     */
-    protected abortMultipartUpload(file: TFile): Promise<void>;
-    /**
-     * Internal onComplete handler.
-     */
-    protected internalOnComplete: (file: TFile) => Promise<[{
-        ETag?: string;
-        Location: string;
-    }, TFile]>;
-}

package/dist/storage/aws/s3-client-adapter.d.ts

@@ -1,110 +0,0 @@
-import { Readable } from "node:stream";
-import type { S3Client } from "@aws-sdk/client-s3";
-import type { Part, S3ApiOperations } from "./s3-base-storage.d.ts";
-type ReadableStream = globalThis.ReadableStream;
-/**
- * Adapter that wraps AWS SDK S3Client to implement S3ApiOperations interface.
- */
-declare class S3ClientAdapter implements S3ApiOperations {
-    private readonly client;
-    constructor(client: S3Client, _bucket: string);
-    createMultipartUpload(params: {
-        ACL?: string;
-        Bucket: string;
-        ContentType?: string;
-        Key: string;
-        Metadata?: Record<string, string>;
-    }): Promise<{
-        UploadId: string;
-    }>;
-    uploadPart(params: {
-        Body: Readable | ReadableStream | Uint8Array;
-        Bucket: string;
-        ContentLength?: number;
-        ContentMD5?: string;
-        Key: string;
-        PartNumber: number;
-        UploadId: string;
-    }): Promise<{
-        ETag: string;
-    }>;
-    completeMultipartUpload(params: {
-        Bucket: string;
-        Key: string;
-        Parts: {
-            ETag: string;
-            PartNumber: number;
-        }[];
-        UploadId: string;
-    }): Promise<{
-        ETag?: string;
-        Location: string;
-    }>;
-    abortMultipartUpload(params: {
-        Bucket: string;
-        Key: string;
-        UploadId: string;
-    }): Promise<void>;
-    listParts(params: {
-        Bucket: string;
-        Key: string;
-        UploadId: string;
-    }): Promise<{
-        Parts?: Part[];
-    }>;
-    getObject(params: {
-        Bucket: string;
-        Key: string;
-    }): Promise<{
-        Body?: ReadableStream | Readable;
-        ContentLength?: number;
-        ContentType?: string;
-        ETag?: string;
-        Expires?: Date;
-        LastModified?: Date;
-        Metadata?: Record<string, string>;
-    }>;
-    headObject(params: {
-        Bucket: string;
-        Key: string;
-    }): Promise<{
-        ContentLength?: number;
-        ContentType?: string;
-        ETag?: string;
-        Expires?: Date;
-        LastModified?: Date;
-    }>;
-    deleteObject(params: {
-        Bucket: string;
-        Key: string;
-    }): Promise<void>;
-    copyObject(params: {
-        Bucket: string;
-        CopySource: string;
-        Key: string;
-        StorageClass?: string;
-    }): Promise<void>;
-    listObjectsV2(params: {
-        Bucket: string;
-        ContinuationToken?: string;
-        MaxKeys?: number;
-    }): Promise<{
-        Contents?: {
-            Key?: string;
-            LastModified?: Date;
-        }[];
-        IsTruncated?: boolean;
-        NextContinuationToken?: string;
-    }>;
-    getPresignedUrl(params: {
-        Bucket: string;
-        expiresIn: number;
-        Key: string;
-        PartNumber: number;
-        UploadId: string;
-    }): Promise<string>;
-    checkBucketAccess(params: {
-        Bucket: string;
-    }): Promise<void>;
-}
-export default S3ClientAdapter;

package/dist/storage/aws/s3-file.d.ts

@@ -1,10 +0,0 @@
-import { File } from "../utils/index.d.ts";
-import type { Part } from "./s3-base-storage.d.ts";
-declare class S3File extends File {
-    Parts?: Part[];
-    UploadId?: string;
-    uri?: string;
-    partsUrls?: string[];
-    partSize?: number;
-}
-export default S3File;

package/dist/storage/aws/s3-meta-storage.d.ts

@@ -1,15 +0,0 @@
-import MetaStorage from "../meta-storage.d.ts";
-import type { File } from "../utils/index.d.ts";
-import type { S3MetaStorageOptions } from "./types.d.ts";
-declare class S3MetaStorage<T extends File = File> extends MetaStorage<T> {
-    config: S3MetaStorageOptions;
-    private readonly bucket;
-    private readonly client;
-    constructor(config: S3MetaStorageOptions);
-    get(id: string): Promise<T>;
-    touch(id: string, file: T): Promise<T>;
-    delete(id: string): Promise<void>;
-    save(id: string, file: T): Promise<T>;
-    private accessCheck;
-}
-export default S3MetaStorage;