@vryzel/file-next 0.4.0

package/dist/index.d.cts

@@ -0,0 +1,131 @@
+import { b as FileSystemConfig, C as CreateFileSystemOptions, a as FileSystem, S as S3CompatibleAdapter, c as S3Key, R as Result, M as MetadataStore } from './filesystem-BbZJLy4A.cjs';
+export { d as CopyInput, e as CopyOutput, f as CreateNodeInput, g as Credentials, D as DeleteInput, h as DeleteNodeInput, i as DeleteOutput, E as ExistsInput, j as ExistsOutput, F as FileNode, G as GetMetadataInput, k as GetMetadataOutput, l as GetNodeInput, m as GetPathInput, n as GetPathOutput, o as GetPublicUrlInput, p as GetPublicUrlOutput, L as ListChildrenInput, q as ListChildrenOutput, r as ListInput, s as ListOutput, t as MoveInput, u as MoveNodeInput, v as MoveOutput, N as NodeKind, P as Path, w as Prefix, x as PresignedDownloadInput, y as PresignedDownloadOutput, z as PresignedUploadInput, A as PresignedUploadOutput, B as R2Config, H as ReadInput, I as ReadOutput, J as ReconcileResult, K as S3Config, O as SearchInput, Q as SetMetadataInput, V as SetMetadataOutput, W as StatInput, X as StatOutput, T as TenantId, Y as UpdateMetadataInput, U as UserId, Z as WriteInput, _ as WriteOutput, $ as andThen, a0 as asPath, a1 as asPrefix, a2 as asS3Key, a3 as asTenantId, a4 as asUserId, a5 as assertPath, a6 as assertPrefix, a7 as assertS3Key, a8 as assertTenantId, a9 as assertUserId, aa as err, ab as map, ac as mapErr, ad as ok, ae as parseFileSystemConfig, af as unwrap, ag as unwrapOr } from './filesystem-BbZJLy4A.cjs';
+import { FileSystemError } from './errors/index.cjs';
+export { FILE_SYSTEM_ERROR_CODES, FileSystemErrorCode, FileSystemErrorJson, FileSystemErrorOptions, RETRYABLE_BY_CODE, fromAws, fromPg, fromSqlite } from './errors/index.cjs';
+import { ClassValue } from 'clsx';
+export { A as AuthContext, w as withAuth } from './with-auth-BueIpNZ7.cjs';
+import 'zod';
+
+/**
+ Merge Tailwind CSS classes with conflict resolution.
+ Mirrors shadcn/ui's `cn` utility so consumers get a familiar DX.
+ */
+declare function cn(...inputs: ClassValue[]): string;
+
+declare const createFileSystem: (config: FileSystemConfig, options?: CreateFileSystemOptions) => FileSystem;
+declare const createMemoryFileSystem: (options?: CreateFileSystemOptions) => FileSystem;
+
+/**
+ * Tenant prefix wrapper — rewrites every key/prefix so one bucket
+ * can hold many tenants without the rest of the library knowing.
+ *
+ * Metadata stores the tenant-relative key (usually the node UUID).
+ * The wrapper prepends `t/{tenantId}/` on the way in and strips it
+ * on the way out.
+ */
+
+declare const tenantPrefix: (tenantId: string) => string;
+declare const prefixAdapter: (adapter: S3CompatibleAdapter, prefix: string) => S3CompatibleAdapter;
+
+/**
+ * Return the memoized `FileSystem` for the current process, building
+ * it from `FILE_NEXT_*` env vars on first call.
+ */
+declare const getFileSystem: () => FileSystem;
+
+/** A single object stored in the in-memory backend. */
+interface MemoryObject {
+    readonly body: Uint8Array;
+    readonly contentType: string;
+    readonly userMetadata: Readonly<Record<string, string>>;
+    readonly createdAt: Date;
+    readonly updatedAt: Date;
+}
+/** Public snapshot of the store. Tests use this to assert on state. */
+interface MemoryStoreSnapshot {
+    /** Map from S3 key to the stored object. */
+    readonly objects: ReadonlyMap<S3Key, MemoryObject>;
+    /** Monotonic counter used to fabricate fake etags. */
+    readonly etagCounter: number;
+}
+/** Options for `createMemoryAdapter`. */
+interface MemoryAdapterOptions {
+    /** Default content type when the caller doesn't supply one. Default: `application/octet-stream`. */
+    readonly defaultContentType?: string;
+    /** Whether to validate the single-PUT size cap. Default: true. */
+    readonly enforceSizeLimit?: boolean;
+    /**
+     * Override the single-PUT size cap. Default: `MAX_SINGLE_PUT_SIZE`
+     * (5 GB). Lower this in tests so you don't need to allocate 5+ GB
+     * of memory just to assert the cap.
+     */
+    readonly maxSinglePutSize?: number;
+    /**
+     * Optional bucket name for `getPublicUrl` fabrication. The
+     * default `"in-memory"` keeps the URLs short and obviously fake.
+     */
+    readonly bucket?: string;
+}
+/**
+ * Create a fresh in-memory adapter. The returned adapter is a
+ * closure over a private `Map`; you can read the current state
+ * via the `.store()` method.
+ */
+declare function createMemoryAdapter(options?: MemoryAdapterOptions): S3CompatibleAdapter & {
+    readonly store: () => MemoryStoreSnapshot;
+};
+
+/**
+ * Display-name rules for files and folders.
+ *
+ * Metadata `path` is `parentPath + "/" + name`. A raw `/` in `name`
+ * would split the tree. S3 keys are UUIDs, so the bucket is unaffected;
+ * the store still has to keep names as a single path segment.
+ *
+ * 255 matches the common POSIX/Windows filename cap.
+ */
+
+declare const NODE_NAME_MAX_LENGTH = 255;
+declare function normalizeNodeName(raw: string): Result<string, FileSystemError>;
+
+declare const createMemoryStore: () => MetadataStore;
+
+interface SqliteStoreOptions {
+    /**
+     * SQLite file path, or ":memory:" for a private in-memory
+     * database. Use ":memory:" in tests; a real path in apps so
+     * the file tree survives restarts.
+     */
+    readonly path: string;
+    /**
+     * Run schema migrations on construction. Default: true.
+     * Set false when sharing a DB across multiple stores (each
+     * instance would otherwise re-run the idempotent CREATE).
+     */
+    readonly runMigrations?: boolean;
+}
+declare const createSqliteStore: (options: SqliteStoreOptions) => MetadataStore;
+
+interface PostgresStoreOptions {
+    /**
+     * A libpq connection string. Example:
+     *   postgres://user:pass@localhost:5432/dbname
+     */
+    readonly connectionString: string;
+    /**
+     * Postgres schema (namespace). Defaults to "public".
+     * Use a dedicated schema per tenant in shared clusters.
+     */
+    readonly schema?: string;
+    /**
+     * Run schema migrations on construction. Default: true.
+     */
+    readonly runMigrations?: boolean;
+    /**
+     * Max pool size. Defaults to 10.
+     */
+    readonly maxPoolSize?: number;
+}
+declare const createPostgresStore: (options: PostgresStoreOptions) => MetadataStore;
+
+export { CreateFileSystemOptions, FileSystem, FileSystemConfig, FileSystemError, type MemoryAdapterOptions, type MemoryStoreSnapshot, MetadataStore, NODE_NAME_MAX_LENGTH, type PostgresStoreOptions, Result, S3CompatibleAdapter, S3Key, type SqliteStoreOptions, cn, createFileSystem, createMemoryAdapter, createMemoryFileSystem, createMemoryStore, createPostgresStore, createSqliteStore, getFileSystem, normalizeNodeName, prefixAdapter, tenantPrefix };

package/dist/index.d.ts

@@ -0,0 +1,131 @@
+import { b as FileSystemConfig, C as CreateFileSystemOptions, a as FileSystem, S as S3CompatibleAdapter, c as S3Key, R as Result, M as MetadataStore } from './filesystem-D1Jjx3md.js';
+export { d as CopyInput, e as CopyOutput, f as CreateNodeInput, g as Credentials, D as DeleteInput, h as DeleteNodeInput, i as DeleteOutput, E as ExistsInput, j as ExistsOutput, F as FileNode, G as GetMetadataInput, k as GetMetadataOutput, l as GetNodeInput, m as GetPathInput, n as GetPathOutput, o as GetPublicUrlInput, p as GetPublicUrlOutput, L as ListChildrenInput, q as ListChildrenOutput, r as ListInput, s as ListOutput, t as MoveInput, u as MoveNodeInput, v as MoveOutput, N as NodeKind, P as Path, w as Prefix, x as PresignedDownloadInput, y as PresignedDownloadOutput, z as PresignedUploadInput, A as PresignedUploadOutput, B as R2Config, H as ReadInput, I as ReadOutput, J as ReconcileResult, K as S3Config, O as SearchInput, Q as SetMetadataInput, V as SetMetadataOutput, W as StatInput, X as StatOutput, T as TenantId, Y as UpdateMetadataInput, U as UserId, Z as WriteInput, _ as WriteOutput, $ as andThen, a0 as asPath, a1 as asPrefix, a2 as asS3Key, a3 as asTenantId, a4 as asUserId, a5 as assertPath, a6 as assertPrefix, a7 as assertS3Key, a8 as assertTenantId, a9 as assertUserId, aa as err, ab as map, ac as mapErr, ad as ok, ae as parseFileSystemConfig, af as unwrap, ag as unwrapOr } from './filesystem-D1Jjx3md.js';
+import { FileSystemError } from './errors/index.js';
+export { FILE_SYSTEM_ERROR_CODES, FileSystemErrorCode, FileSystemErrorJson, FileSystemErrorOptions, RETRYABLE_BY_CODE, fromAws, fromPg, fromSqlite } from './errors/index.js';
+import { ClassValue } from 'clsx';
+export { A as AuthContext, w as withAuth } from './with-auth-yfezt7YS.js';
+import 'zod';
+
+/**
+ Merge Tailwind CSS classes with conflict resolution.
+ Mirrors shadcn/ui's `cn` utility so consumers get a familiar DX.
+ */
+declare function cn(...inputs: ClassValue[]): string;
+
+declare const createFileSystem: (config: FileSystemConfig, options?: CreateFileSystemOptions) => FileSystem;
+declare const createMemoryFileSystem: (options?: CreateFileSystemOptions) => FileSystem;
+
+/**
+ * Tenant prefix wrapper — rewrites every key/prefix so one bucket
+ * can hold many tenants without the rest of the library knowing.
+ *
+ * Metadata stores the tenant-relative key (usually the node UUID).
+ * The wrapper prepends `t/{tenantId}/` on the way in and strips it
+ * on the way out.
+ */
+
+declare const tenantPrefix: (tenantId: string) => string;
+declare const prefixAdapter: (adapter: S3CompatibleAdapter, prefix: string) => S3CompatibleAdapter;
+
+/**
+ * Return the memoized `FileSystem` for the current process, building
+ * it from `FILE_NEXT_*` env vars on first call.
+ */
+declare const getFileSystem: () => FileSystem;
+
+/** A single object stored in the in-memory backend. */
+interface MemoryObject {
+    readonly body: Uint8Array;
+    readonly contentType: string;
+    readonly userMetadata: Readonly<Record<string, string>>;
+    readonly createdAt: Date;
+    readonly updatedAt: Date;
+}
+/** Public snapshot of the store. Tests use this to assert on state. */
+interface MemoryStoreSnapshot {
+    /** Map from S3 key to the stored object. */
+    readonly objects: ReadonlyMap<S3Key, MemoryObject>;
+    /** Monotonic counter used to fabricate fake etags. */
+    readonly etagCounter: number;
+}
+/** Options for `createMemoryAdapter`. */
+interface MemoryAdapterOptions {
+    /** Default content type when the caller doesn't supply one. Default: `application/octet-stream`. */
+    readonly defaultContentType?: string;
+    /** Whether to validate the single-PUT size cap. Default: true. */
+    readonly enforceSizeLimit?: boolean;
+    /**
+     * Override the single-PUT size cap. Default: `MAX_SINGLE_PUT_SIZE`
+     * (5 GB). Lower this in tests so you don't need to allocate 5+ GB
+     * of memory just to assert the cap.
+     */
+    readonly maxSinglePutSize?: number;
+    /**
+     * Optional bucket name for `getPublicUrl` fabrication. The
+     * default `"in-memory"` keeps the URLs short and obviously fake.
+     */
+    readonly bucket?: string;
+}
+/**
+ * Create a fresh in-memory adapter. The returned adapter is a
+ * closure over a private `Map`; you can read the current state
+ * via the `.store()` method.
+ */
+declare function createMemoryAdapter(options?: MemoryAdapterOptions): S3CompatibleAdapter & {
+    readonly store: () => MemoryStoreSnapshot;
+};
+
+/**
+ * Display-name rules for files and folders.
+ *
+ * Metadata `path` is `parentPath + "/" + name`. A raw `/` in `name`
+ * would split the tree. S3 keys are UUIDs, so the bucket is unaffected;
+ * the store still has to keep names as a single path segment.
+ *
+ * 255 matches the common POSIX/Windows filename cap.
+ */
+
+declare const NODE_NAME_MAX_LENGTH = 255;
+declare function normalizeNodeName(raw: string): Result<string, FileSystemError>;
+
+declare const createMemoryStore: () => MetadataStore;
+
+interface SqliteStoreOptions {
+    /**
+     * SQLite file path, or ":memory:" for a private in-memory
+     * database. Use ":memory:" in tests; a real path in apps so
+     * the file tree survives restarts.
+     */
+    readonly path: string;
+    /**
+     * Run schema migrations on construction. Default: true.
+     * Set false when sharing a DB across multiple stores (each
+     * instance would otherwise re-run the idempotent CREATE).
+     */
+    readonly runMigrations?: boolean;
+}
+declare const createSqliteStore: (options: SqliteStoreOptions) => MetadataStore;
+
+interface PostgresStoreOptions {
+    /**
+     * A libpq connection string. Example:
+     *   postgres://user:pass@localhost:5432/dbname
+     */
+    readonly connectionString: string;
+    /**
+     * Postgres schema (namespace). Defaults to "public".
+     * Use a dedicated schema per tenant in shared clusters.
+     */
+    readonly schema?: string;
+    /**
+     * Run schema migrations on construction. Default: true.
+     */
+    readonly runMigrations?: boolean;
+    /**
+     * Max pool size. Defaults to 10.
+     */
+    readonly maxPoolSize?: number;
+}
+declare const createPostgresStore: (options: PostgresStoreOptions) => MetadataStore;
+
+export { CreateFileSystemOptions, FileSystem, FileSystemConfig, FileSystemError, type MemoryAdapterOptions, type MemoryStoreSnapshot, MetadataStore, NODE_NAME_MAX_LENGTH, type PostgresStoreOptions, Result, S3CompatibleAdapter, S3Key, type SqliteStoreOptions, cn, createFileSystem, createMemoryAdapter, createMemoryFileSystem, createMemoryStore, createPostgresStore, createSqliteStore, getFileSystem, normalizeNodeName, prefixAdapter, tenantPrefix };