hazo_files 2.0.1 → 3.0.0

package/dist/index.d.ts

@@ -1,3 +1,6 @@
+import { HazoAuthError, HazoConfigError, HazoConflictError, HazoNotFoundError, HazoValidationError, HazoExternalError } from 'hazo_core';
+export { HazoError as HazoFilesError } from 'hazo_core';
+import { Readable } from 'node:stream';
 import { OAuth2Client } from 'google-auth-library';
 
 /**
@@ -396,7 +399,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 +483,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 +881,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
      */
@@ -2870,46 +2873,43 @@ declare function registerModule(provider: StorageProvider, factory: ModuleFactor
 
 /**
  * Custom error classes for hazo_files
+ * All errors extend the appropriate hazo_core subclass.
  */
-declare class HazoFilesError extends Error {
-    code: string;
-    details?: Record<string, unknown> | undefined;
-    constructor(message: string, code: string, details?: Record<string, unknown> | undefined);
-}
-declare class FileNotFoundError extends HazoFilesError {
+
+declare class FileNotFoundError extends HazoNotFoundError {
     constructor(path: string);
 }
-declare class DirectoryNotFoundError extends HazoFilesError {
+declare class DirectoryNotFoundError extends HazoNotFoundError {
     constructor(path: string);
 }
-declare class FileExistsError extends HazoFilesError {
+declare class FileExistsError extends HazoConflictError {
     constructor(path: string);
 }
-declare class DirectoryExistsError extends HazoFilesError {
+declare class DirectoryExistsError extends HazoConflictError {
     constructor(path: string);
 }
-declare class DirectoryNotEmptyError extends HazoFilesError {
+declare class DirectoryNotEmptyError extends HazoConflictError {
     constructor(path: string);
 }
-declare class PermissionDeniedError extends HazoFilesError {
+declare class PermissionDeniedError extends HazoAuthError {
     constructor(path: string, operation: string);
 }
-declare class InvalidPathError extends HazoFilesError {
+declare class InvalidPathError extends HazoValidationError {
     constructor(path: string, reason: string);
 }
-declare class FileTooLargeError extends HazoFilesError {
+declare class FileTooLargeError extends HazoValidationError {
     constructor(path: string, size: number, maxSize: number);
 }
-declare class InvalidExtensionError extends HazoFilesError {
+declare class InvalidExtensionError extends HazoValidationError {
     constructor(path: string, extension: string, allowedExtensions: string[]);
 }
-declare class AuthenticationError extends HazoFilesError {
+declare class AuthenticationError extends HazoAuthError {
     constructor(provider: string, message: string);
 }
-declare class ConfigurationError extends HazoFilesError {
+declare class ConfigurationError extends HazoConfigError {
     constructor(message: string);
 }
-declare class OperationError extends HazoFilesError {
+declare class OperationError extends HazoExternalError {
     constructor(operation: string, message: string, details?: Record<string, unknown>);
 }
 
@@ -3256,24 +3256,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 +3284,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, 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 };