hazo_files 2.0.0 → 2.1.1

package/CHANGE_LOG.md

@@ -5,6 +5,49 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 2.1.1 — 2026-05-24
+
+**Docs + housekeeping** — no API changes.
+
+- README: added documentation for `NamingTemplate`, `writeWithCollisionRetry`, and the pure `addRef`/`removeRef`/`countRefs` helpers introduced in 2.1.0.
+- `.gitignore`: untracked test-app runtime artifacts (`data/`, `logs/`, `tsconfig.tsbuildinfo`, `*.tgz`).
+
+## 2.1.0 — 2026-05-24
+
+**Additive** — no breaking changes from 2.0.x.
+
+- `NamingTemplate` DSL with formatters (`slug`, `pad:N`, `upper`, `lower`, `truncate:N`, `date:FMT`). 200-char cap; sanitises `/\:*?"<>|` → `_`; throws on missing variable; dotted-path resolution. Formatters `pad` and `truncate` throw on missing/NaN arg; `date` throws on empty value.
+- `writeWithCollisionRetry` helper with 999-attempt cap; throws `StorageCollisionExhausted`. Renders the `{index}` variable per attempt.
+- Reference tracking helpers: `addRef` / `removeRef` / `countRefs` over `{ file_refs, ref_count }`. Idempotent on same `ref_id`; soft-tombstone via `removed_at`.
+
+### Migration from 2.0.x
+
+No required changes. Existing imports continue to work. Use the new helpers to compute filenames and track usage references.
+
+## 2.0.1 (2026-05-23)
+
+### Added
+
+- **`FileStorageProvider` interface** (`hazo_files/server`) — lightweight storage abstraction with `put`, `get`, `delete`, `exists`, `getSignedUrl`, and `probe` methods. Complements the existing `StorageModule`/`FileManager` stack for simpler use cases that don't need folder trees or metadata tracking.
+- **`AppFileServerProvider`** (`hazo_files/server`) — local-filesystem provider with HMAC-SHA256-signed download URLs. Constructor options: `root` (filesystem root), `hmac_secret`, and `default_ttl_seconds` (default 300s). Includes `verifySignedUrl(token, path)` for use in the `/api/files/serve` API route. Path traversal is blocked at the `resolve()` layer.
+- **`InMemoryProvider`** (`hazo_files/testing`) — in-memory `FileStorageProvider` backed by a `Map<string, Buffer>`. Intended for unit tests. `getSignedUrl` returns a `data:` URL so tests never need a real HTTP server. Includes `snapshot()` escape hatch for assertions.
+- **`GoogleDriveProvider`** (`hazo_files/server`) — service-account Google Drive provider for Shared Drives. Accepts `service_account_json`, `shared_drive_id`, and a `DrivePathCache` for lazy folder-ID resolution. Unlike `GoogleDriveModule` (which uses OAuth), this provider is designed for server-side use with a GCP service account.
+- **`hazo_files/testing` subpath export** — re-exports `InMemoryProvider` for use in test suites without pulling in server-only modules.
+- **Error classes**: `StorageCollisionExhausted`, `StorageNotConfigured`, `StorageUnavailable` — exported from `hazo_files/server`.
+- **Types**: `PutOpts`, `PutResult`, `SignedUrlOpts`, `ProbeResult`, `DrivePathCache` — exported from `hazo_files/server`.
+
+### Breaking changes from 1.x
+None. All additions are new exports; existing `FileManager`/`TrackedFileManager` API is unchanged.
+
+## 2.0.0 (2026-05-22)
+
+### Changed
+
+- **`googleapis` and `mime-types` promoted to direct `dependencies`** (previously optional peer deps) — the package now bundles them so consumers no longer need to install them separately for Google Drive or MIME detection. This is a major bump because it changes the transitive dependency surface for all consumers.
+
+### Not breaking
+The public API is identical to 1.6.0. No migration required.
+
 ## 1.6.0 (2026-05-21)
 
 ### Added

package/README.md

@@ -7,6 +7,10 @@ A powerful, modular file management package for Node.js and React applications w
 
 ## Features
 
+- **`FileStorageProvider` Interface**: Lightweight `put/get/delete/exists/getSignedUrl/probe` abstraction for simpler use cases
+- **`AppFileServerProvider`**: Local filesystem + HMAC-signed download URLs — no cloud account required
+- **`GoogleDriveProvider`**: Service-account Google Drive for Shared Drives with lazy path-cache
+- **`InMemoryProvider`**: Zero-dependency in-memory store for unit tests (via `hazo_files/testing`)
 - **Multiple Storage Providers**: Local filesystem, Google Drive, and Dropbox support out of the box
 - **Modular Architecture**: Easily add custom storage providers
 - **Unified API**: Single consistent interface across all storage providers
@@ -72,6 +76,17 @@ For the background-upload sonner toast bridge (optional):
 npm install sonner            # Toast notifications for background upload pipelines
 ```
 
+### Subpath exports
+
+| Import | Contents |
+|--------|---------|
+| `hazo_files` | Core types, utilities, naming helpers |
+| `hazo_files/ui` | React components (FileBrowser, NamingRuleConfigurator, etc.) |
+| `hazo_files/server` | Server-only: FileManager, TrackedFileManager, FileStorageProvider providers, schema exports |
+| `hazo_files/background-upload` | Framework-agnostic UploadManager pipeline engine |
+| `hazo_files/background-upload/react` | React bindings for background uploads |
+| `hazo_files/testing` | `InMemoryProvider` — import in test suites, safe to use without `server-only` |
+
 ### Tailwind CSS v4 Setup (Required for UI Components)
 
 If you're using Tailwind CSS v4 with the UI components, you must add a `@source` directive to your CSS file to ensure Tailwind scans the package's files for utility classes.
@@ -1549,6 +1564,117 @@ import type {
 } from 'hazo_files';
 ```
 
+### Pure Reference Helpers (v2.1.0)
+
+Functional helpers for manipulating `{ file_refs, ref_count }` objects without a database. Useful for in-memory state management or building your own persistence layer.
+
+```typescript
+import { addRef, removeRef, countRefs } from 'hazo_files';
+import type { FileWithRefs, FileRef } from 'hazo_files';
+
+// addRef — idempotent on same ref_id; returns updated object
+const updated = addRef(file, {
+  ref_id: 'ref-123',
+  ref_type: 'form_field',
+  ref_source: 'form-abc',
+  created_at: new Date().toISOString(),
+});
+// updated.ref_count === countRefs(updated)
+
+// removeRef — soft-tombstones by setting removed_at; returns updated object
+const released = removeRef(file, 'ref-123', new Date().toISOString());
+// released.ref_count decremented; original ref_id still present with removed_at set
+
+// countRefs — count active (non-tombstoned) references
+const active = countRefs(file); // number
+```
+
+These helpers are **pure functions** — they never write to a database. Pair them with `TrackedFileManager.addRef` / `removeRef` when you need DB persistence.
+
+## Naming Templates (v2.1.0)
+
+`NamingTemplate` is a lightweight DSL for generating filenames and folder paths from string templates with variable substitution and pipe formatters.
+
+### Basic Usage
+
+```typescript
+import { NamingTemplate } from 'hazo_files';
+
+const name = NamingTemplate.render(
+  '{client_name|slug}_{date|date:YYYY-MM-DD}_{index|pad:3}.pdf',
+  { client_name: 'Acme Corp', date: '2026-05-24T00:00:00Z', index: 7 }
+);
+// → "acme-corp_2026-05-24_007.pdf"
+```
+
+### Template Syntax
+
+- **`{variable}`** — substitutes `variable` from the vars object
+- **`{variable|formatter}`** — applies a formatter after substitution
+- **`{variable|formatter:arg}`** — formatter with argument
+- **`{obj.nested.key}`** — dotted-path resolution into nested objects
+- Output is capped at **200 characters**; `/\:*?"<>|` are sanitised to `_`
+
+### Formatters
+
+| Formatter | Example | Description |
+|---|---|---|
+| `slug` | `{name\|slug}` | Lowercase, replace non-alphanumeric with `-`, strip leading/trailing `-` |
+| `upper` | `{code\|upper}` | Uppercase |
+| `lower` | `{code\|lower}` | Lowercase |
+| `pad:N` | `{index\|pad:3}` | Zero-pad to N digits (7 → `007`) |
+| `truncate:N` | `{title\|truncate:20}` | Trim to N characters |
+| `date:FMT` | `{ts\|date:YYYY-MM-DD}` | Format ISO date string; tokens: `YYYY`, `MM`, `DD`, `HH`, `mm`, `ss` |
+
+### Error Conditions
+
+- Missing variable → throws `Error: missing variable: <name>`
+- `pad` / `truncate` without numeric arg → throws
+- `date` formatter on empty/invalid value → throws
+- Unknown formatter → throws
+
+## Collision-Safe Writes (v2.1.0)
+
+`writeWithCollisionRetry` writes a file to any `FileStorageProvider`, automatically incrementing an `{index}` variable in the template until a free path is found.
+
+### Usage
+
+```typescript
+import { writeWithCollisionRetry, StorageCollisionExhausted } from 'hazo_files';
+
+try {
+  const result = await writeWithCollisionRetry({
+    provider,          // FileStorageProvider
+    template: '{client|slug}_{date|date:YYYY-MM-DD}_{index|pad:3}.pdf',
+    vars: { client: 'Acme Corp', date: new Date().toISOString() },
+    body: pdfBuffer,
+    path_prefix: 'uploads/forms',   // optional — prepended to rendered name
+    max_attempts: 999,              // optional, default 999
+    put_opts: { metadata: { ... } } // optional extra PutOpts (ifNotExists always set)
+  });
+
+  console.log(result.logical_path);
+  // → "uploads/forms/acme-corp_2026-05-24_001.pdf"
+  //   (or _002, _003, … if earlier slots were taken)
+} catch (err) {
+  if (err instanceof StorageCollisionExhausted) {
+    // All 999 attempts collided
+    console.error(`Could not write after ${err.attempts} attempts`);
+  }
+  throw err;
+}
+```
+
+### How It Works
+
+1. Renders the template with `{ ...vars, index: 1 }` for the first attempt
+2. Calls `provider.put(path, body, { ifNotExists: true })`
+3. If the file exists, increments `index` and retries
+4. Returns `PutResult & { logical_path: string }` on the first successful write
+5. Throws `StorageCollisionExhausted` if all attempts are exhausted
+
+The `{index}` variable is **automatically injected** — you don't need to supply it in `vars`.
+
 ## File Change Detection
 
 Detect file content changes using fast xxHash hashing.
@@ -1866,6 +1992,152 @@ try {
 }
 ```
 
+## FileStorageProvider (v2 Provider API)
+
+v2 introduces a slimmer storage abstraction — `FileStorageProvider` — that sits alongside (not replacing) the existing `FileManager`/`StorageModule` stack. Use it when you don't need folder trees, metadata tracking, or naming conventions, and just want put/get/signed-URL semantics.
+
+### Interface
+
+```typescript
+import type { FileStorageProvider } from 'hazo_files/server';
+
+interface FileStorageProvider {
+  put(path: string, body: Buffer | Readable, opts?: PutOpts): Promise<PutResult>;
+  get(path: string): Promise<Buffer | Readable>;
+  delete(path: string): Promise<void>;
+  exists(path: string): Promise<boolean>;
+  getSignedUrl(path: string, opts?: SignedUrlOpts): Promise<string>;
+  probe(): Promise<ProbeResult>;
+}
+```
+
+### AppFileServerProvider
+
+Local filesystem with HMAC-signed download URLs. Ideal for self-hosted apps where files are served through an API route.
+
+```typescript
+import { AppFileServerProvider } from 'hazo_files/server';
+
+const provider = new AppFileServerProvider({
+  root: './storage',          // filesystem root
+  hmac_secret: process.env.FILE_HMAC_SECRET!,
+  default_ttl_seconds: 300,   // default 5 min
+});
+
+// Store a file
+const result = await provider.put('uploads/report.pdf', buffer, {
+  contentType: 'application/pdf',
+});
+// { provider: 'app_file_server', native_id: 'uploads/report.pdf', size: 12345 }
+
+// Generate a signed URL (expires in 5 min)
+const url = await provider.getSignedUrl('uploads/report.pdf');
+// '/api/files/serve/1748080800.ABC123.../uploads/report.pdf'
+```
+
+#### Serving signed URLs (Next.js API route)
+
+```typescript
+// app/api/files/serve/[...token]/route.ts
+import { NextRequest, NextResponse } from 'next/server';
+import { AppFileServerProvider } from 'hazo_files/server';
+
+const provider = new AppFileServerProvider({
+  root: './storage',
+  hmac_secret: process.env.FILE_HMAC_SECRET!,
+});
+
+export async function GET(
+  _req: NextRequest,
+  { params }: { params: { token: string[] } }
+) {
+  // token = ['<exp>.<sig>', 'uploads', 'report.pdf']
+  const [token, ...pathParts] = params.token;
+  const filePath = pathParts.join('/');
+
+  if (!provider.verifySignedUrl(token, filePath)) {
+    return new NextResponse('Forbidden', { status: 403 });
+  }
+
+  const buf = await provider.get(filePath) as Buffer;
+  return new NextResponse(buf, {
+    headers: { 'Content-Type': 'application/octet-stream' },
+  });
+}
+```
+
+### GoogleDriveProvider
+
+Service-account Google Drive for Shared Drives. No OAuth flow — configure a GCP service account with Shared Drive access.
+
+```typescript
+import { GoogleDriveProvider } from 'hazo_files/server';
+import type { DrivePathCache } from 'hazo_files/server';
+
+// Implement the path cache (e.g., backed by your hazo_connect adapter)
+const pathCache: DrivePathCache = {
+  lookup: async (key) => redis.get(`gdrive:${key}`),
+  write:  async (key, id) => redis.set(`gdrive:${key}`, id),
+  invalidate: async (key) => redis.del(`gdrive:${key}`),
+};
+
+const provider = new GoogleDriveProvider({
+  service_account_json: process.env.GOOGLE_SERVICE_ACCOUNT_JSON!,
+  shared_drive_id: 'your-shared-drive-id',
+  path_cache: pathCache,
+});
+
+// Upload a file (folders are created lazily)
+const result = await provider.put('2026/ACME/invoice.pdf', buffer, {
+  contentType: 'application/pdf',
+});
+// { provider: 'gdrive', native_id: '<drive-file-id>', size: 12345 }
+
+// Check connectivity
+const health = await provider.probe();
+// { ok: true } or { ok: false, error: 'drive_not_shared', message: '...' }
+```
+
+**Note**: `getSignedUrl` for Google Drive returns a native `drive.google.com/uc?id=...` link, which requires the viewer to have Drive access. For public unauthenticated downloads, use `AppFileServerProvider` instead or implement your own proxy.
+
+### InMemoryProvider (testing)
+
+Import from the dedicated `hazo_files/testing` subpath — keeps server-only modules out of your test bundle.
+
+```typescript
+import { InMemoryProvider } from 'hazo_files/testing';
+
+const store = new InMemoryProvider();
+
+await store.put('docs/readme.txt', Buffer.from('hello'));
+const buf = await store.get('docs/readme.txt');
+console.log(buf.toString()); // 'hello'
+
+// Test helper: inspect internal state
+const snap = store.snapshot();
+console.log([...snap.keys()]); // ['docs/readme.txt']
+
+// getSignedUrl returns a data: URL — no HTTP server needed
+const url = await store.getSignedUrl('docs/readme.txt');
+// 'data:application/octet-stream;base64,aGVsbG8='
+```
+
+### Provider Errors
+
+```typescript
+import {
+  StorageCollisionExhausted,
+  StorageNotConfigured,
+  StorageUnavailable,
+} from 'hazo_files/server';
+
+// StorageCollisionExhausted — thrown when put with ifNotExists keeps colliding
+// StorageNotConfigured     — thrown when provider config is absent
+// StorageUnavailable       — wraps a ProbeResult error for runtime checks
+```
+
+---
+
 ## Extending with Custom Storage Providers
 
 See [docs/ADDING_MODULES.md](docs/ADDING_MODULES.md) for a complete guide on creating custom storage modules.

package/dist/index.d.mts

@@ -1,3 +1,4 @@
+import { Readable } from 'node:stream';
 import { OAuth2Client } from 'google-auth-library';
 
 /**
@@ -396,7 +397,7 @@ type FileRefVisibility = 'public' | 'private' | 'internal';
  * A reference from an entity to a file.
  * Multiple entities can reference the same file.
  */
-interface FileRef {
+interface FileRef$1 {
     /** Unique ID for this reference */
     ref_id: string;
     /** Type of entity referencing the file (e.g., 'form_field', 'chat_message') */
@@ -480,7 +481,7 @@ interface FileWithStatus {
     /** Full metadata record (V2) */
     record: FileMetadataRecordV2;
     /** Parsed file references */
-    refs: FileRef[];
+    refs: FileRef$1[];
     /** Whether the file has zero references */
     is_orphaned: boolean;
 }
@@ -878,7 +879,7 @@ declare class FileMetadataService {
     /**
      * Get all references for a file
      */
-    getRefs(fileId: string): Promise<FileRef[] | null>;
+    getRefs(fileId: string): Promise<FileRef$1[] | null>;
     /**
      * Get a file with its status and parsed refs
      */
@@ -3256,24 +3257,24 @@ declare function generateRefId(): string;
  * Parse a JSON string into FileRef array.
  * Returns empty array on invalid input.
  */
-declare function parseFileRefs(json: string | null | undefined): FileRef[];
+declare function parseFileRefs(json: string | null | undefined): FileRef$1[];
 /**
  * Serialize FileRef array to JSON string
  */
-declare function stringifyFileRefs(refs: FileRef[]): string;
+declare function stringifyFileRefs(refs: FileRef$1[]): string;
 /**
  * Create a FileRef from AddRefOptions
  */
-declare function createFileRef(options: AddRefOptions): FileRef;
+declare function createFileRef(options: AddRefOptions): FileRef$1;
 /**
  * Remove a ref by ref_id (immutable)
  */
-declare function removeRefFromArray(refs: FileRef[], refId: string): FileRef[];
+declare function removeRefFromArray(refs: FileRef$1[], refId: string): FileRef$1[];
 /**
  * Remove refs matching criteria from array (immutable).
  * All specified criteria fields must match (AND semantics).
  */
-declare function removeRefsByCriteriaFromArray(refs: FileRef[], criteria: Omit<RemoveRefsCriteria, 'file_id' | 'scope_id'>): FileRef[];
+declare function removeRefsByCriteriaFromArray(refs: FileRef$1[], criteria: Omit<RemoveRefsCriteria, 'file_id' | 'scope_id'>): FileRef$1[];
 /**
  * Safely cast a FileMetadataRecord to FileMetadataRecordV2.
  * Missing V2 fields are defaulted.
@@ -3284,4 +3285,90 @@ declare function toV2Record(record: FileMetadataRecord): FileMetadataRecordV2;
  */
 declare function buildFileWithStatus(record: FileMetadataRecord): FileWithStatus;
 
-export { ALL_SYSTEM_VARIABLES, type AddExtractionOptions, type AddRefOptions, type AuthCallbacks, AuthenticationError, type CleanupOrphanedOptions, ConfigurationError, type ContentTagConfig, type CreateFolderOptions, type CrudServiceLike, DEFAULT_DATE_FORMATS, type DatabaseSchemaDefinition, type DatabaseTrackingConfig, DirectoryExistsError, DirectoryNotEmptyError, DirectoryNotFoundError, type DownloadOptions, DropboxAuth, type DropboxAuthCallbacks, type DropboxAuthConfig, type DropboxConfig, DropboxModule, type DropboxTokenData, type ExtractionData, type ExtractionOptions, type ExtractionResult, type FileBrowserState, type FileDataStructure, FileExistsError, type FileInfo, type FileItem, FileManager, type FileManagerOptions, type FileMetadataInput, type FileMetadataRecord, type FileMetadataRecordV2, FileMetadataService, type FileMetadataServiceOptions, type FileMetadataUpdate, FileNotFoundError, type FileRef, type FileRefVisibility, type FileStatus, type FileSystemItem, FileTooLargeError, type FileWithStatus, type FindOrphanedOptions, type FolderItem, type GeneratedNameResult, type GoogleAuthConfig, GoogleDriveAuth, type GoogleDriveConfig, GoogleDriveModule, HAZO_FILES_DEFAULT_TABLE_NAME, HAZO_FILES_MIGRATION_V2, HAZO_FILES_MIGRATION_V3, HAZO_FILES_NAMING_DEFAULT_TABLE_NAME, HAZO_FILES_NAMING_TABLE_SCHEMA, HAZO_FILES_TABLE_SCHEMA, type HazoFilesColumnDefinitions, type HazoFilesConfig, HazoFilesError, type HazoFilesMigrationV2, type HazoFilesMigrationV3, type HazoFilesNamingColumnDefinitions, type HazoFilesNamingTableSchema, type HazoFilesTableSchema, type HazoLLMInstance, InvalidExtensionError, InvalidPathError, LLMExtractionService, type LLMFactory, type LLMFactoryConfig, type LLMProvider, type ListNamingConventionsOptions, type ListOptions, type LocalStorageConfig, LocalStorageModule, type MetadataLogger, type MigrationExecutor, type MigrationSchemaDefinition, type MoveOptions, type NameGenerationOptions, type NamingConventionInput, type NamingConventionRecord, NamingConventionService, type NamingConventionServiceOptions, type NamingConventionType, type NamingConventionUpdate, type NamingRuleConfiguratorProps, type NamingRuleHistoryEntry, type NamingRuleSchema, type NamingVariable, OperationError, type OperationResult, type ParsedNamingConvention, type PatternSegment, PermissionDeniedError, type ProgressCallback, type RemoveExtractionOptions, type RemoveRefsCriteria, type RenameOptions, SYSTEM_COUNTER_VARIABLES, SYSTEM_DATE_VARIABLES, SYSTEM_FILE_VARIABLES, type StorageModule, type StorageProvider, type TokenData, TrackedFileManager, type TrackedFileManagerFullOptions, type TrackedFileManagerOptions, type TrackedUploadOptions, type TreeNode, type UploadExtractOptions, type UploadExtractResult, UploadExtractService, type UploadOptions, type UploadWithRefOptions, type UseNamingRuleActions, type UseNamingRuleReturn, type UseNamingRuleState, type VariableCategory, addExtractionToFileData, backfillV2Defaults, buildFileWithStatus, clearExtractions, clonePattern, computeFileHash, computeFileHashFromStream, computeFileHashSync, computeFileInfo, createAndInitializeModule, createDropboxAuth, createDropboxModule, createEmptyFileDataStructure, createEmptyNamingRuleSchema, createFileItem, createFileManager, createFileMetadataService, createFileRef, createFolderItem, createGoogleDriveAuth, createGoogleDriveModule, createInitializedFileManager, createInitializedTrackedFileManager, createLLMExtractionService, createLiteralSegment, createLocalModule, createModule, createNamingConventionService, createTrackedFileManager, createUploadExtractService, createVariableSegment, deepMerge, errorResult, filterItems, formatBytes, formatCounter, formatDateToken, generateExtractionId, generateId, generatePreviewName, generateRefId, generateSampleConfig, generateSegmentId, getBaseName, getBreadcrumbs, getDirName, getExtension, getExtensionFromMime, getExtractionById, getExtractionCount, getExtractions, getFileCategory, getFileMetadataValues, getMergedData, getMigrationForTable, getMigrationV3ForTable, getMimeType, getNameWithoutExtension, getNamingSchemaForTable, getParentPath, getPathSegments, getRegisteredProviders, getRelativePath, getSchemaForTable, getSystemVariablePreviewValues, hasExtension, hasExtractionStructure, hasFileContentChanged, hashesEqual, hazo_files_generate_file_name, hazo_files_generate_folder_name, isAudio, isChildPath, isCounterVariable, isDateVariable, isDocument, isFile, isFileMetadataVariable, isFolder, isImage, isPreviewable, isProviderRegistered, isText, isVideo, joinPath, loadConfig, loadConfigAsync, migrateToV2, migrateToV3, normalizePath, parseConfig, parseFileData, parseFileRefs, parsePatternString, patternToString, recalculateMergedData, registerModule, removeExtractionById, removeExtractionByIndex, removeRefFromArray, removeRefsByCriteriaFromArray, sanitizeFilename, saveConfig, sortItems, stringifyFileData, stringifyFileRefs, successResult, toV2Record, updateExtractionById, validateExtractionData, validateFileDataStructure, validateNamingRuleSchema, validatePath };
+declare class NamingTemplate {
+    static render(template: string, vars: Record<string, unknown>): string;
+}
+
+type StoragePath = string;
+interface PutOpts {
+    /** Reject if the target path already exists (atomic). */
+    ifNotExists?: boolean;
+    /** Hint for content-type; provider may sniff if absent. */
+    contentType?: string;
+    /** Free-form key/value metadata persisted with the file when supported. */
+    metadata?: Record<string, string>;
+}
+interface PutResult {
+    /** Provider tag — `"app_file_server"`, `"gdrive"`, `"in_memory"`. */
+    provider: string;
+    /** Provider-native identifier (path for app-server; file ID for GDrive). */
+    native_id: string;
+    /** Size in bytes of the persisted body. */
+    size: number;
+}
+interface SignedUrlOpts {
+    /** Seconds the URL is valid for. */
+    ttl_seconds?: number;
+    /** Suggested download filename (Content-Disposition). */
+    filename_hint?: string;
+}
+interface ProbeResult {
+    ok: boolean;
+    /** Machine-readable error tag when ok=false. */
+    error?: "drive_not_shared" | "write_denied" | "invalid_id" | "transient" | "config_missing";
+    /** Free-form detail for logging. */
+    message?: string;
+}
+/**
+ * Storage provider abstraction. Every method MUST be idempotent at the
+ * data-content level — re-invoking put with identical body is allowed.
+ *
+ * Paths are logical; providers translate to native identifiers internally.
+ */
+interface FileStorageProvider {
+    put(path: StoragePath, body: Buffer | Readable, opts?: PutOpts): Promise<PutResult>;
+    get(path: StoragePath): Promise<Buffer | Readable>;
+    delete(path: StoragePath): Promise<void>;
+    exists(path: StoragePath): Promise<boolean>;
+    getSignedUrl(path: StoragePath, opts?: SignedUrlOpts): Promise<string>;
+    /** Used by validation cron + onboarding step 2. */
+    probe(): Promise<ProbeResult>;
+}
+
+interface WriteWithCollisionOpts {
+    provider: FileStorageProvider;
+    template: string;
+    vars: Record<string, unknown>;
+    body: Buffer;
+    /** Prefix to mount the rendered filename under, e.g. `"folders/abc123"`. */
+    path_prefix?: string;
+    /** Max attempts. Default 999. */
+    max_attempts?: number;
+    /** Extra opts passed to provider.put (ifNotExists is always forced true). */
+    put_opts?: Omit<PutOpts, "ifNotExists">;
+}
+declare function writeWithCollisionRetry(opts: WriteWithCollisionOpts): Promise<PutResult & {
+    logical_path: string;
+}>;
+
+interface FileRef {
+    ref_id: string;
+    ref_type: string;
+    ref_source: string;
+    form_id?: string;
+    field_id?: string;
+    message_id?: string;
+    document_id?: string;
+    created_at: string;
+    removed_at?: string;
+}
+interface FileWithRefs {
+    file_refs: FileRef[];
+    ref_count: number;
+}
+
+declare function addRef<T extends FileWithRefs>(file: T, ref: FileRef): T;
+declare function removeRef<T extends FileWithRefs>(file: T, ref_id: string, removed_at: string): T;
+declare function countRefs(file: Pick<FileWithRefs, "file_refs">): number;
+
+export { ALL_SYSTEM_VARIABLES, type AddExtractionOptions, type AddRefOptions, type AuthCallbacks, AuthenticationError, type CleanupOrphanedOptions, ConfigurationError, type ContentTagConfig, type CreateFolderOptions, type CrudServiceLike, DEFAULT_DATE_FORMATS, type DatabaseSchemaDefinition, type DatabaseTrackingConfig, DirectoryExistsError, DirectoryNotEmptyError, DirectoryNotFoundError, type DownloadOptions, DropboxAuth, type DropboxAuthCallbacks, type DropboxAuthConfig, type DropboxConfig, DropboxModule, type DropboxTokenData, type ExtractionData, type ExtractionOptions, type ExtractionResult, type FileBrowserState, type FileDataStructure, FileExistsError, type FileInfo, type FileItem, FileManager, type FileManagerOptions, type FileMetadataInput, type FileMetadataRecord, type FileMetadataRecordV2, FileMetadataService, type FileMetadataServiceOptions, type FileMetadataUpdate, FileNotFoundError, type FileRef$1 as FileRef, type FileRefVisibility, type FileStatus, type FileSystemItem, FileTooLargeError, type FileWithRefs, type FileWithStatus, type FindOrphanedOptions, type FolderItem, type GeneratedNameResult, type GoogleAuthConfig, GoogleDriveAuth, type GoogleDriveConfig, GoogleDriveModule, HAZO_FILES_DEFAULT_TABLE_NAME, HAZO_FILES_MIGRATION_V2, HAZO_FILES_MIGRATION_V3, HAZO_FILES_NAMING_DEFAULT_TABLE_NAME, HAZO_FILES_NAMING_TABLE_SCHEMA, HAZO_FILES_TABLE_SCHEMA, type HazoFilesColumnDefinitions, type HazoFilesConfig, HazoFilesError, type HazoFilesMigrationV2, type HazoFilesMigrationV3, type HazoFilesNamingColumnDefinitions, type HazoFilesNamingTableSchema, type HazoFilesTableSchema, type HazoLLMInstance, InvalidExtensionError, InvalidPathError, LLMExtractionService, type LLMFactory, type LLMFactoryConfig, type LLMProvider, type ListNamingConventionsOptions, type ListOptions, type LocalStorageConfig, LocalStorageModule, type MetadataLogger, type MigrationExecutor, type MigrationSchemaDefinition, type MoveOptions, type NameGenerationOptions, type NamingConventionInput, type NamingConventionRecord, NamingConventionService, type NamingConventionServiceOptions, type NamingConventionType, type NamingConventionUpdate, type NamingRuleConfiguratorProps, type NamingRuleHistoryEntry, type NamingRuleSchema, NamingTemplate, type NamingVariable, OperationError, type OperationResult, type ParsedNamingConvention, type PatternSegment, PermissionDeniedError, type ProgressCallback, type RemoveExtractionOptions, type RemoveRefsCriteria, type RenameOptions, SYSTEM_COUNTER_VARIABLES, SYSTEM_DATE_VARIABLES, SYSTEM_FILE_VARIABLES, type StorageModule, type StorageProvider, type TokenData, TrackedFileManager, type TrackedFileManagerFullOptions, type TrackedFileManagerOptions, type TrackedUploadOptions, type TreeNode, type UploadExtractOptions, type UploadExtractResult, UploadExtractService, type UploadOptions, type UploadWithRefOptions, type UseNamingRuleActions, type UseNamingRuleReturn, type UseNamingRuleState, type VariableCategory, type WriteWithCollisionOpts, addExtractionToFileData, addRef, backfillV2Defaults, buildFileWithStatus, clearExtractions, clonePattern, computeFileHash, computeFileHashFromStream, computeFileHashSync, computeFileInfo, countRefs, createAndInitializeModule, createDropboxAuth, createDropboxModule, createEmptyFileDataStructure, createEmptyNamingRuleSchema, createFileItem, createFileManager, createFileMetadataService, createFileRef, createFolderItem, createGoogleDriveAuth, createGoogleDriveModule, createInitializedFileManager, createInitializedTrackedFileManager, createLLMExtractionService, createLiteralSegment, createLocalModule, createModule, createNamingConventionService, createTrackedFileManager, createUploadExtractService, createVariableSegment, deepMerge, errorResult, filterItems, formatBytes, formatCounter, formatDateToken, generateExtractionId, generateId, generatePreviewName, generateRefId, generateSampleConfig, generateSegmentId, getBaseName, getBreadcrumbs, getDirName, getExtension, getExtensionFromMime, getExtractionById, getExtractionCount, getExtractions, getFileCategory, getFileMetadataValues, getMergedData, getMigrationForTable, getMigrationV3ForTable, getMimeType, getNameWithoutExtension, getNamingSchemaForTable, getParentPath, getPathSegments, getRegisteredProviders, getRelativePath, getSchemaForTable, getSystemVariablePreviewValues, hasExtension, hasExtractionStructure, hasFileContentChanged, hashesEqual, hazo_files_generate_file_name, hazo_files_generate_folder_name, isAudio, isChildPath, isCounterVariable, isDateVariable, isDocument, isFile, isFileMetadataVariable, isFolder, isImage, isPreviewable, isProviderRegistered, isText, isVideo, joinPath, loadConfig, loadConfigAsync, migrateToV2, migrateToV3, normalizePath, parseConfig, parseFileData, parseFileRefs, parsePatternString, patternToString, recalculateMergedData, registerModule, removeExtractionById, removeExtractionByIndex, removeRef, removeRefFromArray, removeRefsByCriteriaFromArray, sanitizeFilename, saveConfig, sortItems, stringifyFileData, stringifyFileRefs, successResult, toV2Record, updateExtractionById, validateExtractionData, validateFileDataStructure, validateNamingRuleSchema, validatePath, writeWithCollisionRetry };