@visulima/storage 1.0.0-alpha.1 → 1.0.0-alpha.3

package/dist/packem_shared/update-size-CCGm6i1J.js

@@ -0,0 +1,8 @@
+const updateSize = (file, size) => {
+  if (size < file.size) {
+    file.size = size;
+  }
+  return file;
+};
+
+export { updateSize as u };

package/dist/packem_shared/validator-BeX_lJet.js

@@ -0,0 +1,78 @@
+import { ErrorMap } from './ERRORS-D0apMqnc.js';
+
+class ValidationError extends Error {
+  code;
+  statusCode;
+  body;
+  headers;
+  name = "ValidationError";
+  /**
+   * Creates a new ValidationError instance.
+   * @param code Machine-readable error code
+   * @param statusCode HTTP status code for the error
+   * @param body Error response body (string or structured object)
+   * @param headers HTTP headers to include in error response
+   */
+  constructor(code, statusCode, body, headers) {
+    const message = typeof body === "string" ? body : body?.message || "Validation error";
+    super(message);
+    this.code = code;
+    this.statusCode = statusCode;
+    this.body = body;
+    this.headers = headers;
+  }
+}
+
+const capitalize = (s) => s && s[0].toUpperCase() + s.slice(1);
+const toResponse = (response) => {
+  if (!Array.isArray(response)) {
+    return response;
+  }
+  const [statusCode, body, headers] = response;
+  return { body, headers, statusCode };
+};
+class Validator {
+  /**
+   * Creates a new Validator instance.
+   * @param prefix Prefix for generated error codes (default: "ValidationError")
+   */
+  constructor(prefix = "ValidationError") {
+    this.prefix = prefix;
+  }
+  validators = {};
+  /**
+   * Adds validation rules to the validator.
+   * Each rule must include an `isValid` function.
+   * @param config Validation configuration object
+   * @throws TypeError if any validator is missing the isValid function
+   */
+  add(config) {
+    Object.entries(config).forEach(([key, validator]) => {
+      const code = `${this.prefix}${capitalize(key)}`;
+      this.validators[code] = { ...this.validators[code], ...validator };
+      if (typeof this.validators[code].isValid !== "function") {
+        throw new TypeError('Validation config "isValid" is missing, or it is not a function!');
+      }
+    });
+  }
+  /**
+   * Verifies an object against all configured validation rules.
+   * Throws ValidationError on first validation failure.
+   * @param t Object to validate
+   * @throws ValidationError if validation fails
+   */
+  async verify(t) {
+    for (const [code, validator] of Object.entries(this.validators)) {
+      const isValid = await validator.isValid(t);
+      if (!isValid) {
+        const errorResponse = validator.response || (code in ErrorMap ? ErrorMap[code] : ErrorMap.UnknownError);
+        const response = toResponse(errorResponse);
+        const { body, headers, message, statusCode } = response;
+        throw new ValidationError(code, statusCode, body || message, headers);
+      }
+    }
+  }
+}
+const isValidationError = (error) => error.name === "ValidationError";
+
+export { ValidationError as V, Validator as a, isValidationError as i };

package/dist/packem_shared/waitForStorage-Cscw85sx.js

@@ -0,0 +1,18 @@
+const waitForStorage = async (storage, timeoutMs = 5e3) => {
+  if (storage.isReady) {
+    return;
+  }
+  const startTime = Date.now();
+  while (!storage.isReady && Date.now() - startTime < timeoutMs) {
+    await new Promise((resolve) => {
+      setTimeout(() => {
+        resolve();
+      }, 100);
+    });
+  }
+  if (!storage.isReady) {
+    throw new Error("Storage initialization timeout");
+  }
+};
+
+export { waitForStorage };

package/dist/packem_shared/wasabi-DIyflHSd.js

@@ -0,0 +1,21 @@
+const wasabi = (parameters) => {
+  const { accessKeyId, region, secretAccessKey } = parameters ?? {
+    accessKeyId: process.env.AWS_ACCESS_KEY_ID || process.env.WASABI_ACCESS_KEY_ID || process.env.WASABI_ACCESS_KEY,
+    region: process.env.AWS_REGION || process.env.WASABI_REGION,
+    secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY || process.env.WASABI_SECRET_ACCESS_KEY || process.env.WASABI_SECRET_KEY
+  };
+  if (!region || !accessKeyId || !secretAccessKey) {
+    throw new Error("Missing required parameters for Wasabi client.");
+  }
+  return {
+    apiVersion: "2006-03-01",
+    credentials: {
+      accessKeyId,
+      secretAccessKey
+    },
+    endpoint: `https://s3.${region}.wasabisys.com`,
+    region
+  };
+};
+
+export { wasabi as default };

package/dist/packem_shared/xhrOpenApiSpec-DS17brnx.js

@@ -0,0 +1,264 @@
+import { createHash } from 'node:crypto';
+import { createPaginationMetaSchemaObject, createPaginationSchemaObject } from '@visulima/pagination';
+import { sharedGetList, sharedGet, sharedGetMeta, sharedFileMetaSchemaObject, sharedErrorSchemaObject, sharedFileMetaExampleObject } from './sharedGet-Cpo7QUyu.js';
+
+const swaggerSpec = (origin, path, options) => {
+  const { supportedTransformerFormat, tags, transformer } = { tags: ["Multipart"], transformer: false, ...options };
+  const pathHash = createHash("sha256").update(path).digest("base64");
+  return {
+    components: {
+      examples: sharedFileMetaExampleObject,
+      parameters: {
+        UploadIDinPath: {
+          description: "Upload ID",
+          in: "path",
+          name: "id",
+          schema: {
+            type: "string"
+          }
+        }
+      },
+      responses: {
+        404: {
+          content: {
+            "application/json": {
+              example: {
+                error: {
+                  code: "FileNotFound",
+                  message: "Not found"
+                }
+              },
+              schema: {
+                $ref: "#/components/schemas/Error"
+              }
+            }
+          },
+          description: "Not Found"
+        }
+      },
+      schemas: {
+        ...createPaginationSchemaObject(
+          "FileMetaPagination",
+          {
+            $ref: "#/components/schemas/PaginationMeta"
+          },
+          "#/components/schemas/PaginationMeta"
+        ),
+        ...createPaginationMetaSchemaObject("PaginationMeta"),
+        ...sharedErrorSchemaObject,
+        ...sharedFileMetaSchemaObject
+      }
+    },
+    paths: {
+      [`${path.replace(/\/$/, "")}/{id}/metadata`]: {
+        get: sharedGetMeta(`${pathHash}MultipartGetFileMeta`, tags)
+      },
+      [`${path.replace(/\/$/, "")}/{id}`]: {
+        delete: {
+          description: "Cancel upload",
+          operationId: `${pathHash}MultipartCancel`,
+          parameters: [
+            {
+              $ref: "#/components/parameters/UploadIDinPath"
+            }
+          ],
+          responses: {
+            204: {
+              description: "No Content"
+            }
+          },
+          summary: "Cancel upload",
+          tags
+        },
+        get: sharedGet(`${pathHash}TusGetFile`, tags, transformer, supportedTransformerFormat)
+      },
+      [path.trimEnd()]: {
+        get: sharedGetList(`${pathHash}MultipartGetList`, tags),
+        post: {
+          description: "Create upload",
+          operationId: `${pathHash}MultipartCreate`,
+          requestBody: {
+            content: {
+              "multipart/form-data": {
+                schema: {
+                  properties: {
+                    file: {
+                      description: "File to upload",
+                      format: "binary",
+                      type: "string"
+                    },
+                    metadata: {
+                      description: "JSON stringifies metadata",
+                      example: '{ "name": "video.mp4", "mimeType": "video/mp4", "size": 741, "lastModified": 1631750105530 }',
+                      type: "string"
+                    }
+                  },
+                  type: "object"
+                }
+              }
+            },
+            description: "Upload Metadata",
+            required: false
+          },
+          responses: {
+            200: {
+              description: "The file already exists, send a resume request",
+              headers: {
+                ETag: {
+                  description: "Upload ETag",
+                  schema: {
+                    example: "d41d8cd98f00b204e9800998ecf8427e",
+                    type: "string"
+                  }
+                },
+                Location: {
+                  description: "Resumable URI",
+                  schema: {
+                    // eslint-disable-next-line no-secrets/no-secrets
+                    example: `${origin}/files?uploadType=Upload&upload_id=2b62dbec20048158af963572fbdf89c6`,
+                    format: "uri",
+                    type: "string"
+                  }
+                },
+                "X-Upload-Expires": {
+                  description: "Upload expiration date",
+                  schema: {
+                    example: "2021-08-25T11:12:26.635Z",
+                    format: "date-time",
+                    type: "string"
+                  }
+                }
+              }
+            },
+            201: {
+              description: "Upload accepted, send the file contents",
+              headers: {
+                ETag: {
+                  description: "Upload ETag",
+                  schema: {
+                    example: "d41d8cd98f00b204e9800998ecf8427e",
+                    type: "string"
+                  }
+                },
+                Location: {
+                  description: "Resumable URI",
+                  schema: {
+                    // eslint-disable-next-line no-secrets/no-secrets
+                    example: `${origin}/files?uploadType=Upload&upload_id=2b62dbec20048158af963572fbdf89c6`,
+                    format: "uri",
+                    type: "string"
+                  }
+                },
+                "X-Upload-Expires": {
+                  description: "Upload expiration date",
+                  schema: {
+                    example: "2021-08-25T11:12:26.635Z",
+                    format: "date-time",
+                    type: "string"
+                  }
+                }
+              }
+            },
+            400: {
+              content: {
+                "application/json": {
+                  example: {
+                    error: {
+                      code: "InvalidFileName",
+                      message: "Invalid file name",
+                      name: "ValidationError"
+                    }
+                  },
+                  schema: {
+                    $ref: "#/components/schemas/Error"
+                  }
+                }
+              },
+              description: "Bad Request"
+            },
+            413: {
+              content: {
+                "application/json": {
+                  example: {
+                    error: {
+                      code: "RequestEntityTooLarge",
+                      message: "Request entity too large",
+                      name: "ValidationError"
+                    }
+                  },
+                  schema: {
+                    $ref: "#/components/schemas/Error"
+                  }
+                }
+              },
+              description: "Request Entity Too Large"
+            },
+            415: {
+              content: {
+                "application/json": {
+                  example: {
+                    error: {
+                      code: "UnsupportedMediaType",
+                      message: "Unsupported media type",
+                      name: "ValidationError"
+                    }
+                  },
+                  schema: {
+                    $ref: "#/components/schemas/Error"
+                  }
+                }
+              },
+              description: "Unsupported Media Type"
+            },
+            423: {
+              content: {
+                "application/json": {
+                  example: {
+                    error: {
+                      code: "FileLocked",
+                      message: "File locked"
+                    }
+                  },
+                  schema: {
+                    $ref: "#/components/schemas/Error"
+                  }
+                }
+              },
+              description: "File locked"
+            },
+            500: {
+              content: {
+                "application/json": {
+                  example: {
+                    error: {
+                      code: "GenericUploadError",
+                      message: "Generic Upload Error"
+                    }
+                  },
+                  schema: {
+                    $ref: "#/components/schemas/Error"
+                  }
+                }
+              },
+              description: "Internal Server Error"
+            },
+            default: {
+              content: {
+                "application/json": {
+                  schema: {
+                    $ref: "#/components/schemas/Error"
+                  }
+                }
+              },
+              description: "Error"
+            }
+          },
+          summary: "Create upload",
+          tags
+        }
+      }
+    }
+  };
+};
+
+export { swaggerSpec as default };

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

@@ -0,0 +1,12 @@
+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

@@ -0,0 +1,13 @@
+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

@@ -0,0 +1,12 @@
+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/index.d.ts

@@ -0,0 +1,6 @@
+export { default as backblaze } from "./backblaze.d.ts";
+export { default as cloudflare } from "./cloudflare.d.ts";
+export { default as digitalOcean } from "./digital-ocean.d.ts";
+export { default as minio } from "./minio.d.ts";
+export { default as tigris } from "./tigris.d.ts";
+export { default as wasabi } from "./wasabi.d.ts";

package/dist/storage/aws/clients/index.js

@@ -0,0 +1,6 @@
+export { backblaze } from '../../../packem_shared/backblaze-BlMnIcBC.js';
+export { cloudflare } from '../../../packem_shared/cloudflare-Bi1q8wXE.js';
+export { default as digitalOcean } from '../../../packem_shared/digitalOcean-CWQRJM3L.js';
+export { default as minio } from '../../../packem_shared/minio-C2YBZQOw.js';
+export { default as tigris } from '../../../packem_shared/tigris-Hac8TKnX.js';
+export { default as wasabi } from '../../../packem_shared/wasabi-DIyflHSd.js';

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

@@ -0,0 +1,13 @@
+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

@@ -0,0 +1,12 @@
+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

@@ -0,0 +1,95 @@
+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

@@ -0,0 +1,12 @@
+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/index.d.ts

@@ -0,0 +1,4 @@
+export { default as S3File } from "./s3-file.d.ts";
+export { default as S3MetaStorage } from "./s3-meta-storage.d.ts";
+export { default as S3Storage } from "./s3-storage.d.ts";
+export type { AwsError, AWSErrorV2, S3MetaStorageOptions, S3StorageOptions } from "./types.d.ts";

package/dist/storage/aws/index.js

@@ -0,0 +1,3 @@
+export { default as S3File } from '../../packem_shared/S3File-DZiyk9Qt.js';
+export { default as S3MetaStorage } from '../../packem_shared/S3MetaStorage-Dz9aDabA.js';
+export { default as S3Storage } from '../../packem_shared/S3Storage-DHmTk-hU.js';