hazo_files 2.1.1 → 3.1.0

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+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';
 
@@ -2871,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>);
 }
 
@@ -3319,6 +3318,22 @@ interface ProbeResult {
     /** Free-form detail for logging. */
     message?: string;
 }
+/**
+ * A single entry returned by `FileStorageProvider.list()`.
+ *
+ * `path` is the same logical namespace used by `put`/`get` — callers can pass
+ * it directly back to those methods without any transformation.
+ */
+interface FileEntry {
+    /** Logical path within the provider (same namespace as put/get). */
+    path: StoragePath;
+    /** Bare filename or directory name (the last segment of `path`). */
+    name: string;
+    /** Size in bytes. 0 for directories. */
+    size: number;
+    /** True when this entry represents a directory. */
+    isDirectory: boolean;
+}
 /**
  * Storage provider abstraction. Every method MUST be idempotent at the
  * data-content level — re-invoking put with identical body is allowed.
@@ -3333,6 +3348,36 @@ interface FileStorageProvider {
     getSignedUrl(path: StoragePath, opts?: SignedUrlOpts): Promise<string>;
     /** Used by validation cron + onboarding step 2. */
     probe(): Promise<ProbeResult>;
+    /**
+     * List all entries (files and sub-directories) under a logical path prefix.
+     * Results are recursive — all descendants are included.
+     * Returns an empty array when the prefix does not exist.
+     */
+    list(prefix: StoragePath): Promise<FileEntry[]>;
+    /**
+     * Move bytes from `from` to `to`, creating any intermediate directories.
+     * The source is removed on success.
+     * Throws with a message containing "Not found" when `from` does not exist.
+     */
+    move(from: StoragePath, to: StoragePath): Promise<void>;
+    /**
+     * Rename a file or directory.  `to` is the full new logical path.
+     * Implementations may delegate to `move`.
+     * Throws with a message containing "Not found" when `from` does not exist.
+     */
+    rename(from: StoragePath, to: StoragePath): Promise<void>;
+}
+declare class StorageCollisionExhausted extends Error {
+    attempts: number;
+    lastPath: StoragePath;
+    constructor(attempts: number, lastPath: StoragePath);
+}
+declare class StorageNotConfigured extends Error {
+    constructor();
+}
+declare class StorageUnavailable extends Error {
+    reason: ProbeResult["error"];
+    constructor(reason: ProbeResult["error"], message: string);
 }
 
 interface WriteWithCollisionOpts {
@@ -3371,4 +3416,82 @@ 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 };
+interface AppFileServerOpts {
+    /** Filesystem root. All paths are resolved relative to this. */
+    root: string;
+    /** HMAC secret used to sign download URLs. */
+    hmac_secret: string;
+    /** Default signed-URL TTL in seconds. */
+    default_ttl_seconds?: number;
+}
+declare class AppFileServerProvider implements FileStorageProvider {
+    readonly provider_tag: "app_file_server";
+    private readonly root;
+    private readonly secret;
+    private readonly default_ttl;
+    constructor(opts: AppFileServerOpts);
+    private resolve;
+    put(path: string, body: Buffer | Readable, opts?: PutOpts): Promise<PutResult>;
+    get(path: string): Promise<Buffer>;
+    delete(path: string): Promise<void>;
+    exists(path: string): Promise<boolean>;
+    getSignedUrl(path: string, opts?: SignedUrlOpts): Promise<string>;
+    /** Verify a token produced by `getSignedUrl`. Used by the `/api/files/serve` route. */
+    verifySignedUrl(token: string, path: string): boolean;
+    probe(): Promise<ProbeResult>;
+    list(prefix: string): Promise<FileEntry[]>;
+    private walkDir;
+    move(from: string, to: string): Promise<void>;
+    rename(from: string, to: string): Promise<void>;
+}
+
+declare class InMemoryProvider implements FileStorageProvider {
+    readonly provider_tag: "in_memory";
+    private readonly store;
+    put(path: string, body: Buffer | Readable, opts?: PutOpts): Promise<PutResult>;
+    get(path: string): Promise<Buffer>;
+    delete(path: string): Promise<void>;
+    exists(path: string): Promise<boolean>;
+    getSignedUrl(path: string, _opts?: SignedUrlOpts): Promise<string>;
+    probe(): Promise<ProbeResult>;
+    list(prefix: string): Promise<FileEntry[]>;
+    move(from: string, to: string): Promise<void>;
+    rename(from: string, to: string): Promise<void>;
+    /** Test-only escape hatch — exposes the internal store for assertions. */
+    snapshot(): Map<string, Buffer>;
+}
+
+interface DrivePathCache {
+    lookup(key: string): Promise<string | null>;
+    write(key: string, folder_id: string): Promise<void>;
+    invalidate(key: string): Promise<void>;
+}
+interface GoogleDriveOpts {
+    /** Raw JSON keyfile contents (decoded from GOOGLE_SERVICE_ACCOUNT_JSON env var). */
+    service_account_json: string;
+    /** Target Shared Drive ID. */
+    shared_drive_id: string;
+    /** Lazy folder-ID cache, scoped per Hazodocs org. */
+    path_cache: DrivePathCache;
+}
+declare class GoogleDriveProvider implements FileStorageProvider {
+    readonly provider_tag: "gdrive";
+    private readonly drive;
+    private readonly driveId;
+    private readonly cache;
+    constructor(opts: GoogleDriveOpts);
+    probe(): Promise<ProbeResult>;
+    put(path: string, body: Buffer | Readable, opts?: PutOpts): Promise<PutResult>;
+    get(path: string): Promise<Buffer>;
+    delete(path: string): Promise<void>;
+    exists(path: string): Promise<boolean>;
+    getSignedUrl(path: string, _opts?: SignedUrlOpts): Promise<string>;
+    list(prefix: string): Promise<FileEntry[]>;
+    move(from: string, to: string): Promise<void>;
+    rename(from: string, to: string): Promise<void>;
+    private resolvePath;
+    private findChild;
+    private lookupFileId;
+}
+
+export { ALL_SYSTEM_VARIABLES, type AddExtractionOptions, type AddRefOptions, type AppFileServerOpts, AppFileServerProvider, type AuthCallbacks, AuthenticationError, type CleanupOrphanedOptions, ConfigurationError, type ContentTagConfig, type CreateFolderOptions, type CrudServiceLike, DEFAULT_DATE_FORMATS, type DatabaseSchemaDefinition, type DatabaseTrackingConfig, DirectoryExistsError, DirectoryNotEmptyError, DirectoryNotFoundError, type DownloadOptions, type DrivePathCache, DropboxAuth, type DropboxAuthCallbacks, type DropboxAuthConfig, type DropboxConfig, DropboxModule, type DropboxTokenData, type ExtractionData, type ExtractionOptions, type ExtractionResult, type FileBrowserState, type FileDataStructure, type FileEntry, 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 FileStorageProvider, type FileSystemItem, FileTooLargeError, type FileWithRefs, type FileWithStatus, type FindOrphanedOptions, type FolderItem, type GeneratedNameResult, type GoogleAuthConfig, GoogleDriveAuth, type GoogleDriveConfig, GoogleDriveModule, type GoogleDriveOpts, GoogleDriveProvider, 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, InMemoryProvider, 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 ProbeResult, type ProgressCallback, type PutOpts, type PutResult, type RemoveExtractionOptions, type RemoveRefsCriteria, type RenameOptions, SYSTEM_COUNTER_VARIABLES, SYSTEM_DATE_VARIABLES, SYSTEM_FILE_VARIABLES, type SignedUrlOpts, StorageCollisionExhausted, type StorageModule, StorageNotConfigured, type StoragePath, type StorageProvider, StorageUnavailable, 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 };