@visulima/storage 1.0.0-alpha.25 → 1.0.0-alpha.27

package/dist/storage/azure/index.js

@@ -1 +1 @@
-import{default as a}from"../../packem_shared/AzureFile-BKHru1zB.js";import{default as o}from"../../packem_shared/AzureSMetaStorage-BqA4jUDJ.js";import{default as u}from"../../packem_shared/AzureStorage-BKUjCymW.js";export{a as AzureFile,o as AzureSMetaStorage,u as AzureStorage};
+import{default as a}from"../../packem_shared/AzureFile-Dgj2Tef4.js";import{default as o}from"../../packem_shared/AzureSMetaStorage-DV2tNjKh.js";import{default as u}from"../../packem_shared/AzureStorage-BVYMFEBP.js";export{a as AzureFile,o as AzureSMetaStorage,u as AzureStorage};

package/dist/storage/box/index.d.ts

@@ -0,0 +1,186 @@
+import { F as File, L as LocalMetaStorageOptions, l as BaseStorageOptions, M as MetaStorage, e as FileInit, f as FilePart, g as FileQuery, a as FileReturn, B as BaseStorage } from "../../packem_shared/storage.d-Cr6f2lac.js";
+import 'node:stream';
+import { L as LocalMetaStorage } from "../../packem_shared/local-meta-storage.d-B5R1nswK.js";
+import { BoxClient } from 'box-typescript-sdk-gen';
+import 'node:crypto';
+import 'node:http';
+import 'lru-cache';
+declare class BoxFile extends File {
+  boxFileId?: string;
+  eTag?: string;
+  publicUrl?: string;
+}
+declare class BoxMetaStorage extends LocalMetaStorage<BoxFile> {
+  constructor(config?: LocalMetaStorageOptions);
+}
+interface BoxOAuthOptions {
+  /**
+  * Box application client ID.
+  */
+  clientId: string;
+  /**
+  * Box application client secret.
+  */
+  clientSecret: string;
+  /**
+  * Long-lived refresh token previously obtained via Box's authorization
+  * code flow. The adapter seeds the SDK's in-memory token storage with
+  * this value; the SDK exchanges it for a fresh access token on first
+  * use and re-refreshes when the access token expires.
+  */
+  refreshToken: string;
+}
+interface BoxCcgOptions {
+  /**
+  * Box application client ID.
+  */
+  clientId: string;
+  /**
+  * Box application client secret.
+  */
+  clientSecret: string;
+  /**
+  * Pass `enterpriseId` to authenticate as the service account, or `userId`
+  * to authenticate as a managed/app user. At least one is required.
+  */
+  enterpriseId?: string;
+  /**
+  * Pass `userId` to authenticate as a managed/app user.
+  */
+  userId?: string;
+}
+type BoxJwtOptions = {
+  configFilePath: string;
+} | {
+  configJsonString: string;
+};
+interface BoxStorageOptions extends BaseStorageOptions {
+  /**
+  * Server-side Client Credentials Grant. Mutually exclusive with
+  * `developerToken`, `oauth`, and `jwt`.
+  */
+  ccg?: BoxCcgOptions;
+  /**
+  * Pre-built `BoxClient`. Escape hatch for callers that already wire
+  * auth themselves (e.g. with a custom `NetworkSession`, proxy config,
+  * or downscoped tokens).
+  */
+  client?: BoxClient;
+  /**
+  * Default expiry, in seconds, advertised to callers of `getReadUrl()`.
+  * Box does not document a hard maximum for download URLs (they are
+  * short-lived by API design); this value is forwarded as documentation
+  * only — the actual lifetime is decided by Box. Defaults to 3600.
+  */
+  defaultUrlExpiresIn?: number;
+  /**
+  * Static developer token from the Box developer console. Useful for
+  * scripts and trying the adapter; production apps should use OAuth,
+  * CCG, or JWT instead. Mutually exclusive with `oauth`, `ccg`, `jwt`.
+  */
+  developerToken?: string;
+  /**
+  * JWT Server Authentication, configured via the JSON blob from Box's
+  * developer console. Mutually exclusive with the other auth modes.
+  */
+  jwt?: BoxJwtOptions;
+  /**
+  * Configure metafiles storage. Defaults to local tmp directory.
+  */
+  metaStorageConfig?: LocalMetaStorageOptions;
+  /**
+  * OAuth2 user-app flow seeded with a refresh token. Mutually exclusive
+  * with `developerToken`, `ccg`, and `jwt`.
+  */
+  oauth?: BoxOAuthOptions;
+  /**
+  * When `true`, `getReadUrl` creates (or reuses) an `open`-access shared
+  * link instead of a short-lived signed download URL. Public shared links
+  * may be restricted on Box Business or Enterprise plans; the adapter
+  * surfaces Box's `access_denied_insufficient_permissions` error
+  * unmodified in that case.
+  */
+  publicByDefault?: boolean;
+  /**
+  * Logical "bucket root" — virtual keys live under this Box folder ID.
+  * Use `"0"` (the default) to anchor at the user's root folder. The
+  * folder must already exist; intermediate subfolders are auto-created
+  * on upload.
+  */
+  rootFolderId?: string;
+}
+/**
+* Box storage backend.
+*
+* Routes virtual keys onto Box folder/file IDs under `rootFolderId`. Uploads
+* use `uploads.uploadFile` / `uploads.uploadFileVersion` up to 50 MB and
+* switch to the chunked-upload session API above that threshold. Subfolders
+* along a key's path are auto-created on first write.
+*
+* **Auth precedence**:
+* 1. `client` (pre-built `BoxClient`)
+* 2. `developerToken` (static, from Box developer console)
+* 3. `oauth` (refresh-token seeded — `clientId` + `clientSecret` + `refreshToken`)
+* 4. `ccg` (Client Credentials Grant — `clientId` + `clientSecret` + `enterpriseId` or `userId`)
+* 5. `jwt` (JWT Server Auth — `configJsonString` or `configFilePath`)
+* 6. Env fallback: `BOX_DEVELOPER_TOKEN`
+*
+* **Limitations**:
+* - `metadata` is not supported on the unified API — Box exposes file metadata
+*   via classifications and metadata templates. Use `storage.raw.fileMetadata.*`
+*   directly if you need them.
+* - `cacheControl` is not supported (Box does not expose HTTP cache headers
+*   on file content).
+* - `getUploadUrl` is not supported — Box uploads require a multipart `POST`
+*   with both an `attributes` JSON part and the file bytes part, which doesn't
+*   fit the PUT-with-raw-body presigned-URL contract.
+* - `responseContentDisposition` is not supported on signed download URLs.
+* - `write()` buffers the full part body in memory before choosing between
+*   the simple-upload and chunked-upload paths. Each request handler runs
+*   independently, so concurrent multi-GB writes are bounded by the host's
+*   available memory.
+*/
+declare class BoxStorage extends BaseStorage<BoxFile> {
+  static override readonly name: string;
+  override checksumTypes: string[];
+  protected meta: MetaStorage<BoxFile>;
+  private readonly authHandle;
+  private readonly client;
+  private readonly fileIdCache;
+  private readonly folderIdCache;
+  private readonly publicByDefault;
+  private readonly rootFolderId;
+  constructor(config: BoxStorageOptions);
+  override get raw(): BoxClient;
+  create(config: FileInit): Promise<BoxFile>;
+  write(part: FilePart | FileQuery | BoxFile): Promise<BoxFile>;
+  delete({
+    id
+  }: FileQuery): Promise<BoxFile>;
+  get({
+    id
+  }: FileQuery): Promise<FileReturn>;
+  copy(name: string, destination: string): Promise<BoxFile>;
+  move(name: string, destination: string): Promise<BoxFile>;
+  override list(limit?: number): Promise<BoxFile[]>;
+  override getReadUrl(key: string, options?: {
+    expiresIn?: number;
+    responseContentDisposition?: string;
+    responseContentType?: string;
+  }): Promise<string>;
+  override getUploadUrl(_key: string, _options?: {
+    contentLength?: number;
+    contentType?: string;
+    expiresIn?: number;
+  }): Promise<string>;
+  private findChildByName;
+  private folderCacheKey;
+  private resolveFolderId;
+  private resolveFileId;
+  private resolveExistingFileForUpload;
+  private performUpload;
+  private ensureSharedLink;
+  private fetchSharedLinkUrl;
+  private internalOnComplete;
+}
+export { type BoxCcgOptions, BoxFile, type BoxJwtOptions, BoxMetaStorage, type BoxOAuthOptions, BoxStorage, type BoxStorageOptions };

package/dist/storage/box/index.js

@@ -0,0 +1 @@
+import{default as a}from"../../packem_shared/BoxFile-Be0S4N1L.js";import{default as r}from"../../packem_shared/BoxMetaStorage-BUe5Qmqe.js";import{default as x}from"../../packem_shared/BoxStorage-CgC81_So.js";export{a as BoxFile,r as BoxMetaStorage,x as BoxStorage};

package/dist/storage/bunny/index.d.ts

@@ -0,0 +1,116 @@
+import { F as File, L as LocalMetaStorageOptions, l as BaseStorageOptions, M as MetaStorage, e as FileInit, f as FilePart, g as FileQuery, a as FileReturn, B as BaseStorage } from "../../packem_shared/storage.d-Cr6f2lac.js";
+import 'node:stream';
+import { L as LocalMetaStorage } from "../../packem_shared/local-meta-storage.d-B5R1nswK.js";
+import * as BunnyStorageSDK from '@bunny.net/storage-sdk';
+import 'node:crypto';
+import 'node:http';
+import 'lru-cache';
+declare class BunnyFile extends File {
+  /**
+  * SHA-256 checksum reported by Bunny Storage (when present on the
+  * stored object).
+  */
+  bunnyChecksum?: string;
+  /**
+  * Server-side path within the Storage Zone (always prefixed with `/`).
+  */
+  bunnyPath?: string;
+}
+declare class BunnyMetaStorage extends LocalMetaStorage<BunnyFile> {
+  constructor(config?: LocalMetaStorageOptions);
+}
+/**
+* Bunny Storage region code. Mirrors the SDK's `StorageRegion` enum values
+* (e.g. `"de"`, `"ny"`, `"syd"`).
+*/
+type BunnyStorageRegion = `${BunnyStorageSDK.regions.StorageRegion}`;
+/**
+* A connected Bunny Storage zone produced by
+* `BunnyStorageSDK.zone.connect_with_accesskey(...)`.
+*/
+type BunnyStorageClient = ReturnType<typeof BunnyStorageSDK.zone.connect_with_accesskey>;
+interface BunnyStorageOptions extends BaseStorageOptions {
+  /**
+  * Bunny Storage zone password / API access key. Falls back to
+  * `BUNNY_STORAGE_ACCESS_KEY`, then `BUNNY_ACCESS_KEY`, then the
+  * SDK-documented `STORAGE_ACCESS_KEY`. Ignored when `client` is supplied.
+  */
+  accessKey?: string;
+  /**
+  * Pre-built `StorageZone` instance. Use this to share an instance across
+  * adapters or inject test stubs. Mutually exclusive with `zone` /
+  * `accessKey` / `region`.
+  */
+  client?: BunnyStorageClient;
+  /**
+  * Configure metafiles storage for resumable-upload bookkeeping.
+  */
+  metaStorageConfig?: LocalMetaStorageOptions;
+  /**
+  * Origin used to build URLs from `getReadUrl`, typically a Bunny Pull
+  * Zone or custom CDN hostname in front of the Storage Zone. When unset,
+  * `getReadUrl` throws because the Storage API requires an `AccessKey`
+  * header and has no signed-read URL primitive.
+  */
+  publicBaseUrl?: string;
+  /**
+  * Primary Bunny Storage region. Pass one of
+  * `BunnyStorageSDK.regions.StorageRegion.*`, e.g. `"de"`, `"ny"`, `"syd"`.
+  * Falls back to `BUNNY_STORAGE_REGION`, then `STORAGE_REGION`. Ignored
+  * when `client` is supplied.
+  */
+  region?: BunnyStorageRegion;
+  /**
+  * Bunny Storage zone name. Falls back to `BUNNY_STORAGE_ZONE`, then the
+  * SDK-documented `STORAGE_ZONE`. Ignored when `client` is supplied.
+  */
+  zone?: string;
+}
+/**
+* Bunny Storage backend.
+*
+* Uses `@bunny.net/storage-sdk`. Writes go through the Storage API with an `AccessKey` header; reads either go through `data()` (server-side fetch) or, when a public Pull Zone is configured, through `publicBaseUrl`.
+*
+* **Limitations** (mirroring files-sdk PR #21):
+*
+* - No native server-side `copy` — implemented as download + re-upload.
+* - No `signedUploadUrl` / presigned PUT — Bunny has no such primitive.
+* - `getReadUrl` requires `publicBaseUrl` (Pull Zone / CDN hostname) and returns an unsigned URL — Bunny has no signed-read URL primitive, so `expiresIn` is accepted for parity with other adapters but ignored.
+* - `getReadUrl` rejects `responseContentDisposition` — no override exists on Bunny Storage / Pull Zone URLs.
+* - `list` is non-recursive: `BunnyStorageSDK.file.list(client, "/")` returns only the immediate children of the zone root. Directory entries are filtered out client-side; the adapter does not descend.
+*/
+declare class BunnyStorage extends BaseStorage<BunnyFile> {
+  static override readonly name: string;
+  override checksumTypes: string[];
+  protected meta: MetaStorage<BunnyFile>;
+  private readonly client;
+  private readonly publicBaseUrl;
+  private readonly zoneName;
+  constructor(config: BunnyStorageOptions);
+  override get raw(): BunnyStorageClient;
+  /** Name of the connected Bunny Storage zone. */
+  get zone(): string;
+  create(config: FileInit): Promise<BunnyFile>;
+  write(part: FilePart | FileQuery | BunnyFile): Promise<BunnyFile>;
+  delete({
+    id
+  }: FileQuery): Promise<BunnyFile>;
+  get({
+    id
+  }: FileQuery): Promise<FileReturn>;
+  copy(name: string, destination: string): Promise<BunnyFile>;
+  move(name: string, destination: string): Promise<BunnyFile>;
+  override list(limit?: number): Promise<BunnyFile[]>;
+  override getReadUrl(key: string, options?: {
+    expiresIn?: number;
+    responseContentDisposition?: string;
+    responseContentType?: string;
+  }): Promise<string>;
+  override getUploadUrl(_key: string, _options?: {
+    contentLength?: number;
+    contentType?: string;
+    expiresIn?: number;
+  }): Promise<string>;
+  private internalOnComplete;
+}
+export { BunnyFile, BunnyMetaStorage, BunnyStorage, type BunnyStorageClient, type BunnyStorageOptions, type BunnyStorageRegion };

package/dist/storage/bunny/index.js

@@ -0,0 +1 @@
+import{default as t}from"../../packem_shared/BunnyFile-Dotl-lO9.js";import{default as r}from"../../packem_shared/BunnyMetaStorage-D0mT6veJ.js";import{default as n}from"../../packem_shared/BunnyStorage-Bl4usdVT.js";export{t as BunnyFile,r as BunnyMetaStorage,n as BunnyStorage};

package/dist/storage/dropbox/index.d.ts

@@ -0,0 +1,129 @@
+import { F as File, L as LocalMetaStorageOptions, l as BaseStorageOptions, M as MetaStorage, e as FileInit, f as FilePart, g as FileQuery, a as FileReturn, B as BaseStorage } from "../../packem_shared/storage.d-Cr6f2lac.js";
+import 'node:stream';
+import { L as LocalMetaStorage } from "../../packem_shared/local-meta-storage.d-B5R1nswK.js";
+import { Dropbox } from 'dropbox';
+import 'node:crypto';
+import 'node:http';
+import 'lru-cache';
+declare class DropboxFile extends File {
+  path?: string;
+  publicUrl?: string;
+  rev?: string;
+}
+declare class DropboxMetaStorage extends LocalMetaStorage<DropboxFile> {
+  constructor(config?: LocalMetaStorageOptions);
+}
+interface DropboxStorageOptions extends BaseStorageOptions {
+  /**
+  * Static or dynamic access token. Pass a string for a one-shot token, or
+  * a function returning a fresh token on each call. The adapter does not
+  * cache the result of a callable — your callable is responsible for
+  * caching/refresh.
+  */
+  accessToken?: string | (() => string | Promise<string>);
+  /**
+  * Dropbox app key (client_id). Required when `refreshToken` is set.
+  */
+  appKey?: string;
+  /**
+  * Dropbox app secret (client_secret). Required for confidential clients.
+  */
+  appSecret?: string;
+  /**
+  * Pre-built `Dropbox` client. Escape hatch for callers that already wire
+  * auth themselves (e.g. with team-space `pathRoot`, custom headers, or a
+  * shared `DropboxAuth`).
+  */
+  client?: Dropbox;
+  /**
+  * Default expiry, in seconds, for temporary download links from
+  * `getReadUrl()`. Capped at 14400 (4 hours, the Dropbox maximum).
+  * Defaults to 3600 (1 hour).
+  */
+  defaultUrlExpiresIn?: number;
+  /**
+  * Configure metafiles storage. Defaults to local tmp directory.
+  */
+  metaStorageConfig?: LocalMetaStorageOptions;
+  /**
+  * When `true`, `getReadUrl` creates a public shared link instead of a
+  * temporary 4-hour link. The link is rewritten to `?dl=1` so it serves
+  * raw bytes directly.
+  */
+  publicByDefault?: boolean;
+  /**
+  * OAuth2 refresh token. When set, the adapter exchanges it for fresh
+  * access tokens at `https://api.dropboxapi.com/oauth2/token` and caches
+  * them until ~60s before expiry. Requires `appKey` (PKCE) or `appKey` +
+  * `appSecret` (confidential client).
+  */
+  refreshToken?: string;
+  /**
+  * Logical "bucket root" — virtual keys live under this folder path. Must
+  * already exist; the adapter does not create folders. Path is normalized:
+  * leading slash is added, trailing slashes stripped. Defaults to account
+  * root.
+  */
+  rootFolderPath?: string;
+}
+/**
+* Dropbox storage backend.
+*
+* Routes virtual keys onto Dropbox paths under `rootFolderPath`. Uploads use
+* the simple `filesUpload` endpoint up to 150 MB and switch to chunked
+* upload sessions above that threshold.
+*
+* **Auth precedence** (same model as files-sdk's Dropbox adapter):
+* 1. `client` (pre-built `Dropbox`)
+* 2. `accessToken` (string or `() => string | Promise&lt;string>`)
+* 3. `refreshToken` + `appKey` (+ optional `appSecret`)
+* 4. Env fallback: `DROPBOX_ACCESS_TOKEN`, or `DROPBOX_REFRESH_TOKEN` +
+*    `DROPBOX_APP_KEY` (+ optional `DROPBOX_APP_SECRET`)
+*
+* **Limitations**:
+* - `metadata` and `cacheControl` are not supported (Dropbox files have no
+*   native arbitrary-metadata field, and no HTTP cache-header overrides).
+* - `getUploadUrl` is not supported — Dropbox's `files/get_temporary_upload_link`
+*   requires a `POST` with raw body, which doesn't fit a presigned-PUT contract.
+* - `responseContentDisposition` is not supported on signed URLs.
+*/
+declare class DropboxStorage extends BaseStorage<DropboxFile> {
+  static override readonly name: string;
+  override checksumTypes: string[];
+  protected meta: MetaStorage<DropboxFile>;
+  private readonly authHandle;
+  private readonly client;
+  private readonly defaultUrlExpiresIn;
+  private readonly publicByDefault;
+  private readonly rootFolderPath;
+  constructor(config: DropboxStorageOptions);
+  override get raw(): Dropbox;
+  create(config: FileInit): Promise<DropboxFile>;
+  write(part: FilePart | FileQuery | DropboxFile): Promise<DropboxFile>;
+  delete({
+    id
+  }: FileQuery): Promise<DropboxFile>;
+  get({
+    id
+  }: FileQuery): Promise<FileReturn>;
+  copy(name: string, destination: string): Promise<DropboxFile>;
+  move(name: string, destination: string): Promise<DropboxFile>;
+  override list(limit?: number): Promise<DropboxFile[]>;
+  override getReadUrl(key: string, options?: {
+    expiresIn?: number;
+    responseContentDisposition?: string;
+    responseContentType?: string;
+  }): Promise<string>;
+  override getUploadUrl(_key: string, _options?: {
+    contentLength?: number;
+    contentType?: string;
+    expiresIn?: number;
+  }): Promise<string>;
+  private keyToPath;
+  private pathToKey;
+  private uploadSimple;
+  private uploadSession;
+  private createPublicSharedLink;
+  private internalOnComplete;
+}
+export { DropboxFile, DropboxMetaStorage, DropboxStorage, type DropboxStorageOptions };

package/dist/storage/dropbox/index.js

@@ -0,0 +1 @@
+import{default as e}from"../../packem_shared/DropboxFile-BGVG2kXM.js";import{default as t}from"../../packem_shared/DropboxMetaStorage-CICuUZ1n.js";import{default as p}from"../../packem_shared/DropboxStorage-CPjhDN5B.js";export{e as DropboxFile,t as DropboxMetaStorage,p as DropboxStorage};