hazo_files 1.3.0 → 1.3.1

package/dist/index.d.mts

@@ -542,7 +542,52 @@ interface MetadataLogger {
     error?(message: string, data?: Record<string, unknown>): void;
 }
 /**
- * Minimal CRUD service interface (compatible with hazo_connect CrudService)
+ * Minimal CRUD service interface compatible with hazo_connect CrudService.
+ *
+ * This interface is a structural subset of hazo_connect's CrudService,
+ * allowing you to pass a hazo_connect CrudService directly without any adapter.
+ *
+ * @example Using with hazo_connect
+ * ```typescript
+ * import { createHazoConnect, createCrudService } from 'hazo_connect/server';
+ * import {
+ *   createFileMetadataService,
+ *   HAZO_FILES_TABLE_SCHEMA
+ * } from 'hazo_files';
+ * import type { FileMetadataRecord } from 'hazo_files';
+ *
+ * // 1. Create database table during app setup
+ * await db.run(HAZO_FILES_TABLE_SCHEMA.sqlite.ddl);
+ * for (const idx of HAZO_FILES_TABLE_SCHEMA.sqlite.indexes) {
+ *   await db.run(idx);
+ * }
+ *
+ * // 2. Create hazo_connect CRUD service
+ * const adapter = createHazoConnect({
+ *   type: 'sqlite',
+ *   database_path: './data.db'
+ * });
+ * const crud = createCrudService<FileMetadataRecord>(
+ *   adapter,
+ *   HAZO_FILES_TABLE_SCHEMA.tableName
+ * );
+ *
+ * // 3. Pass directly to hazo_files - NO ADAPTER NEEDED
+ * const metadataService = createFileMetadataService(crud);
+ *
+ * // 4. Use the service
+ * await metadataService.addExtraction(
+ *   '/documents/report.pdf',
+ *   'local',
+ *   { summary: 'Quarterly report' },
+ *   { source: 'gpt-4' }
+ * );
+ * ```
+ *
+ * @remarks
+ * The hazo_connect CrudService has additional methods (findById, query)
+ * that are not used by FileMetadataService, making this interface
+ * a compatible subset.
  */
 interface CrudServiceLike<T> {
     list(configure?: (qb: unknown) => unknown): Promise<T[]>;
@@ -788,6 +833,112 @@ declare function generateSampleConfig(): string;
  */
 declare function saveConfig(config: HazoFilesConfig, configPath?: string): Promise<void>;
 
+/**
+ * Database Schema Exports for hazo_files
+ *
+ * Provides DDL statements for creating the hazo_files table in different databases.
+ * Consuming applications can use these to set up their database schema.
+ *
+ * @example
+ * ```typescript
+ * import { HAZO_FILES_TABLE_SCHEMA } from 'hazo_files';
+ *
+ * // For SQLite
+ * await db.run(HAZO_FILES_TABLE_SCHEMA.sqlite.ddl);
+ * for (const idx of HAZO_FILES_TABLE_SCHEMA.sqlite.indexes) {
+ *   await db.run(idx);
+ * }
+ *
+ * // For PostgreSQL
+ * await client.query(HAZO_FILES_TABLE_SCHEMA.postgres.ddl);
+ * for (const idx of HAZO_FILES_TABLE_SCHEMA.postgres.indexes) {
+ *   await client.query(idx);
+ * }
+ * ```
+ */
+/**
+ * Column definitions for the hazo_files table
+ */
+interface HazoFilesColumnDefinitions {
+    /** Primary key (UUID) */
+    id: 'TEXT' | 'UUID';
+    /** File or folder name */
+    filename: 'TEXT';
+    /** MIME type for files, 'folder' for directories */
+    file_type: 'TEXT';
+    /** Custom metadata as JSON string */
+    file_data: 'TEXT';
+    /** ISO timestamp when record was created */
+    created_at: 'TEXT' | 'TIMESTAMP';
+    /** ISO timestamp of last modification */
+    changed_at: 'TEXT' | 'TIMESTAMP';
+    /** Virtual path in storage */
+    file_path: 'TEXT';
+    /** Storage provider type ('local' | 'google_drive') */
+    storage_type: 'TEXT';
+}
+/**
+ * Schema definition for a specific database type
+ */
+interface DatabaseSchemaDefinition {
+    /** CREATE TABLE statement */
+    ddl: string;
+    /** CREATE INDEX statements */
+    indexes: string[];
+}
+/**
+ * Complete schema definition for hazo_files table
+ */
+interface HazoFilesTableSchema {
+    /** Default table name */
+    tableName: string;
+    /** SQLite-specific DDL */
+    sqlite: DatabaseSchemaDefinition;
+    /** PostgreSQL-specific DDL */
+    postgres: DatabaseSchemaDefinition;
+    /** Column names for reference */
+    columns: readonly string[];
+}
+/**
+ * Default table name for hazo_files metadata
+ */
+declare const HAZO_FILES_DEFAULT_TABLE_NAME = "hazo_files";
+/**
+ * DDL schema for the hazo_files table.
+ *
+ * Use these DDL statements to create the required database table
+ * in consuming applications.
+ *
+ * @example Using with hazo_connect
+ * ```typescript
+ * import { createHazoConnect, createCrudService } from 'hazo_connect/server';
+ * import { createFileMetadataService, HAZO_FILES_TABLE_SCHEMA } from 'hazo_files';
+ * import type { FileMetadataRecord } from 'hazo_files';
+ *
+ * // 1. Create table during app setup
+ * await db.run(HAZO_FILES_TABLE_SCHEMA.sqlite.ddl);
+ * for (const idx of HAZO_FILES_TABLE_SCHEMA.sqlite.indexes) {
+ *   await db.run(idx);
+ * }
+ *
+ * // 2. Create hazo_connect CRUD service
+ * const adapter = createHazoConnect({ type: 'sqlite', database_path: './data.db' });
+ * const crud = createCrudService<FileMetadataRecord>(adapter, HAZO_FILES_TABLE_SCHEMA.tableName);
+ *
+ * // 3. Pass directly to hazo_files - no adapter needed!
+ * const metadataService = createFileMetadataService(crud);
+ * ```
+ */
+declare const HAZO_FILES_TABLE_SCHEMA: HazoFilesTableSchema;
+/**
+ * Get DDL for a custom table name
+ *
+ * @param tableName - Custom table name to use
+ * @param dbType - Database type ('sqlite' | 'postgres')
+ * @returns DDL and index statements with the custom table name
+ */
+declare function getSchemaForTable(tableName: string, dbType: 'sqlite' | 'postgres'): DatabaseSchemaDefinition;
+
 /**
  * Common utility functions
  */
@@ -1461,4 +1612,4 @@ declare function updateExtractionById(fileData: FileDataStructure, id: string, n
     mergeStrategy?: 'shallow' | 'deep';
 }): OperationResult<FileDataStructure>;
 
-export { ALL_SYSTEM_VARIABLES, type AddExtractionOptions, type AuthCallbacks, AuthenticationError, ConfigurationError, type CrudServiceLike, DEFAULT_DATE_FORMATS, type DatabaseTrackingConfig, DirectoryExistsError, DirectoryNotEmptyError, DirectoryNotFoundError, type DownloadOptions, type ExtractionData, type FileBrowserState, type FileDataStructure, FileExistsError, type FileItem, FileManager, type FileManagerOptions, type FileMetadataInput, type FileMetadataRecord, FileMetadataService, type FileMetadataServiceOptions, type FileMetadataUpdate, FileNotFoundError, type FileSystemItem, FileTooLargeError, type FolderItem, type GeneratedNameResult, type GoogleAuthConfig, GoogleDriveAuth, type GoogleDriveConfig, GoogleDriveModule, type HazoFilesConfig, HazoFilesError, InvalidExtensionError, InvalidPathError, type ListOptions, type LocalStorageConfig, LocalStorageModule, type MetadataLogger, type MoveOptions, type NameGenerationOptions, type NamingRuleConfiguratorProps, type NamingRuleHistoryEntry, type NamingRuleSchema, type NamingVariable, OperationError, type OperationResult, type PatternSegment, PermissionDeniedError, type ProgressCallback, type RemoveExtractionOptions, type RenameOptions, SYSTEM_COUNTER_VARIABLES, SYSTEM_DATE_VARIABLES, SYSTEM_FILE_VARIABLES, type StorageModule, type StorageProvider, type TokenData, TrackedFileManager, type TrackedFileManagerFullOptions, type TrackedFileManagerOptions, type TreeNode, type UploadOptions, type UseNamingRuleActions, type UseNamingRuleReturn, type UseNamingRuleState, type VariableCategory, addExtractionToFileData, clearExtractions, clonePattern, createAndInitializeModule, createEmptyFileDataStructure, createEmptyNamingRuleSchema, createFileItem, createFileManager, createFileMetadataService, createFolderItem, createGoogleDriveAuth, createGoogleDriveModule, createInitializedFileManager, createInitializedTrackedFileManager, createLiteralSegment, createLocalModule, createModule, createTrackedFileManager, createVariableSegment, deepMerge, errorResult, filterItems, formatBytes, formatCounter, formatDateToken, generateExtractionId, generateId, generatePreviewName, generateSampleConfig, generateSegmentId, getBaseName, getBreadcrumbs, getDirName, getExtension, getExtensionFromMime, getExtractionById, getExtractionCount, getExtractions, getFileCategory, getFileMetadataValues, getMergedData, getMimeType, getNameWithoutExtension, getParentPath, getPathSegments, getRegisteredProviders, getRelativePath, getSystemVariablePreviewValues, hasExtension, hasExtractionStructure, 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, normalizePath, parseConfig, parseFileData, parsePatternString, patternToString, recalculateMergedData, registerModule, removeExtractionById, removeExtractionByIndex, sanitizeFilename, saveConfig, sortItems, stringifyFileData, successResult, updateExtractionById, validateExtractionData, validateFileDataStructure, validateNamingRuleSchema, validatePath };
+export { ALL_SYSTEM_VARIABLES, type AddExtractionOptions, type AuthCallbacks, AuthenticationError, ConfigurationError, type CrudServiceLike, DEFAULT_DATE_FORMATS, type DatabaseSchemaDefinition, type DatabaseTrackingConfig, DirectoryExistsError, DirectoryNotEmptyError, DirectoryNotFoundError, type DownloadOptions, type ExtractionData, type FileBrowserState, type FileDataStructure, FileExistsError, type FileItem, FileManager, type FileManagerOptions, type FileMetadataInput, type FileMetadataRecord, FileMetadataService, type FileMetadataServiceOptions, type FileMetadataUpdate, FileNotFoundError, type FileSystemItem, FileTooLargeError, type FolderItem, type GeneratedNameResult, type GoogleAuthConfig, GoogleDriveAuth, type GoogleDriveConfig, GoogleDriveModule, HAZO_FILES_DEFAULT_TABLE_NAME, HAZO_FILES_TABLE_SCHEMA, type HazoFilesColumnDefinitions, type HazoFilesConfig, HazoFilesError, type HazoFilesTableSchema, InvalidExtensionError, InvalidPathError, type ListOptions, type LocalStorageConfig, LocalStorageModule, type MetadataLogger, type MoveOptions, type NameGenerationOptions, type NamingRuleConfiguratorProps, type NamingRuleHistoryEntry, type NamingRuleSchema, type NamingVariable, OperationError, type OperationResult, type PatternSegment, PermissionDeniedError, type ProgressCallback, type RemoveExtractionOptions, type RenameOptions, SYSTEM_COUNTER_VARIABLES, SYSTEM_DATE_VARIABLES, SYSTEM_FILE_VARIABLES, type StorageModule, type StorageProvider, type TokenData, TrackedFileManager, type TrackedFileManagerFullOptions, type TrackedFileManagerOptions, type TreeNode, type UploadOptions, type UseNamingRuleActions, type UseNamingRuleReturn, type UseNamingRuleState, type VariableCategory, addExtractionToFileData, clearExtractions, clonePattern, createAndInitializeModule, createEmptyFileDataStructure, createEmptyNamingRuleSchema, createFileItem, createFileManager, createFileMetadataService, createFolderItem, createGoogleDriveAuth, createGoogleDriveModule, createInitializedFileManager, createInitializedTrackedFileManager, createLiteralSegment, createLocalModule, createModule, createTrackedFileManager, createVariableSegment, deepMerge, errorResult, filterItems, formatBytes, formatCounter, formatDateToken, generateExtractionId, generateId, generatePreviewName, generateSampleConfig, generateSegmentId, getBaseName, getBreadcrumbs, getDirName, getExtension, getExtensionFromMime, getExtractionById, getExtractionCount, getExtractions, getFileCategory, getFileMetadataValues, getMergedData, getMimeType, getNameWithoutExtension, getParentPath, getPathSegments, getRegisteredProviders, getRelativePath, getSchemaForTable, getSystemVariablePreviewValues, hasExtension, hasExtractionStructure, 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, normalizePath, parseConfig, parseFileData, parsePatternString, patternToString, recalculateMergedData, registerModule, removeExtractionById, removeExtractionByIndex, sanitizeFilename, saveConfig, sortItems, stringifyFileData, successResult, updateExtractionById, validateExtractionData, validateFileDataStructure, validateNamingRuleSchema, validatePath };

package/dist/index.d.ts

@@ -542,7 +542,52 @@ interface MetadataLogger {
     error?(message: string, data?: Record<string, unknown>): void;
 }
 /**
- * Minimal CRUD service interface (compatible with hazo_connect CrudService)
+ * Minimal CRUD service interface compatible with hazo_connect CrudService.
+ *
+ * This interface is a structural subset of hazo_connect's CrudService,
+ * allowing you to pass a hazo_connect CrudService directly without any adapter.
+ *
+ * @example Using with hazo_connect
+ * ```typescript
+ * import { createHazoConnect, createCrudService } from 'hazo_connect/server';
+ * import {
+ *   createFileMetadataService,
+ *   HAZO_FILES_TABLE_SCHEMA
+ * } from 'hazo_files';
+ * import type { FileMetadataRecord } from 'hazo_files';
+ *
+ * // 1. Create database table during app setup
+ * await db.run(HAZO_FILES_TABLE_SCHEMA.sqlite.ddl);
+ * for (const idx of HAZO_FILES_TABLE_SCHEMA.sqlite.indexes) {
+ *   await db.run(idx);
+ * }
+ *
+ * // 2. Create hazo_connect CRUD service
+ * const adapter = createHazoConnect({
+ *   type: 'sqlite',
+ *   database_path: './data.db'
+ * });
+ * const crud = createCrudService<FileMetadataRecord>(
+ *   adapter,
+ *   HAZO_FILES_TABLE_SCHEMA.tableName
+ * );
+ *
+ * // 3. Pass directly to hazo_files - NO ADAPTER NEEDED
+ * const metadataService = createFileMetadataService(crud);
+ *
+ * // 4. Use the service
+ * await metadataService.addExtraction(
+ *   '/documents/report.pdf',
+ *   'local',
+ *   { summary: 'Quarterly report' },
+ *   { source: 'gpt-4' }
+ * );
+ * ```
+ *
+ * @remarks
+ * The hazo_connect CrudService has additional methods (findById, query)
+ * that are not used by FileMetadataService, making this interface
+ * a compatible subset.
  */
 interface CrudServiceLike<T> {
     list(configure?: (qb: unknown) => unknown): Promise<T[]>;
@@ -788,6 +833,112 @@ declare function generateSampleConfig(): string;
  */
 declare function saveConfig(config: HazoFilesConfig, configPath?: string): Promise<void>;
 
+/**
+ * Database Schema Exports for hazo_files
+ *
+ * Provides DDL statements for creating the hazo_files table in different databases.
+ * Consuming applications can use these to set up their database schema.
+ *
+ * @example
+ * ```typescript
+ * import { HAZO_FILES_TABLE_SCHEMA } from 'hazo_files';
+ *
+ * // For SQLite
+ * await db.run(HAZO_FILES_TABLE_SCHEMA.sqlite.ddl);
+ * for (const idx of HAZO_FILES_TABLE_SCHEMA.sqlite.indexes) {
+ *   await db.run(idx);
+ * }
+ *
+ * // For PostgreSQL
+ * await client.query(HAZO_FILES_TABLE_SCHEMA.postgres.ddl);
+ * for (const idx of HAZO_FILES_TABLE_SCHEMA.postgres.indexes) {
+ *   await client.query(idx);
+ * }
+ * ```
+ */
+/**
+ * Column definitions for the hazo_files table
+ */
+interface HazoFilesColumnDefinitions {
+    /** Primary key (UUID) */
+    id: 'TEXT' | 'UUID';
+    /** File or folder name */
+    filename: 'TEXT';
+    /** MIME type for files, 'folder' for directories */
+    file_type: 'TEXT';
+    /** Custom metadata as JSON string */
+    file_data: 'TEXT';
+    /** ISO timestamp when record was created */
+    created_at: 'TEXT' | 'TIMESTAMP';
+    /** ISO timestamp of last modification */
+    changed_at: 'TEXT' | 'TIMESTAMP';
+    /** Virtual path in storage */
+    file_path: 'TEXT';
+    /** Storage provider type ('local' | 'google_drive') */
+    storage_type: 'TEXT';
+}
+/**
+ * Schema definition for a specific database type
+ */
+interface DatabaseSchemaDefinition {
+    /** CREATE TABLE statement */
+    ddl: string;
+    /** CREATE INDEX statements */
+    indexes: string[];
+}
+/**
+ * Complete schema definition for hazo_files table
+ */
+interface HazoFilesTableSchema {
+    /** Default table name */
+    tableName: string;
+    /** SQLite-specific DDL */
+    sqlite: DatabaseSchemaDefinition;
+    /** PostgreSQL-specific DDL */
+    postgres: DatabaseSchemaDefinition;
+    /** Column names for reference */
+    columns: readonly string[];
+}
+/**
+ * Default table name for hazo_files metadata
+ */
+declare const HAZO_FILES_DEFAULT_TABLE_NAME = "hazo_files";
+/**
+ * DDL schema for the hazo_files table.
+ *
+ * Use these DDL statements to create the required database table
+ * in consuming applications.
+ *
+ * @example Using with hazo_connect
+ * ```typescript
+ * import { createHazoConnect, createCrudService } from 'hazo_connect/server';
+ * import { createFileMetadataService, HAZO_FILES_TABLE_SCHEMA } from 'hazo_files';
+ * import type { FileMetadataRecord } from 'hazo_files';
+ *
+ * // 1. Create table during app setup
+ * await db.run(HAZO_FILES_TABLE_SCHEMA.sqlite.ddl);
+ * for (const idx of HAZO_FILES_TABLE_SCHEMA.sqlite.indexes) {
+ *   await db.run(idx);
+ * }
+ *
+ * // 2. Create hazo_connect CRUD service
+ * const adapter = createHazoConnect({ type: 'sqlite', database_path: './data.db' });
+ * const crud = createCrudService<FileMetadataRecord>(adapter, HAZO_FILES_TABLE_SCHEMA.tableName);
+ *
+ * // 3. Pass directly to hazo_files - no adapter needed!
+ * const metadataService = createFileMetadataService(crud);
+ * ```
+ */
+declare const HAZO_FILES_TABLE_SCHEMA: HazoFilesTableSchema;
+/**
+ * Get DDL for a custom table name
+ *
+ * @param tableName - Custom table name to use
+ * @param dbType - Database type ('sqlite' | 'postgres')
+ * @returns DDL and index statements with the custom table name
+ */
+declare function getSchemaForTable(tableName: string, dbType: 'sqlite' | 'postgres'): DatabaseSchemaDefinition;
+
 /**
  * Common utility functions
  */
@@ -1461,4 +1612,4 @@ declare function updateExtractionById(fileData: FileDataStructure, id: string, n
     mergeStrategy?: 'shallow' | 'deep';
 }): OperationResult<FileDataStructure>;
 
-export { ALL_SYSTEM_VARIABLES, type AddExtractionOptions, type AuthCallbacks, AuthenticationError, ConfigurationError, type CrudServiceLike, DEFAULT_DATE_FORMATS, type DatabaseTrackingConfig, DirectoryExistsError, DirectoryNotEmptyError, DirectoryNotFoundError, type DownloadOptions, type ExtractionData, type FileBrowserState, type FileDataStructure, FileExistsError, type FileItem, FileManager, type FileManagerOptions, type FileMetadataInput, type FileMetadataRecord, FileMetadataService, type FileMetadataServiceOptions, type FileMetadataUpdate, FileNotFoundError, type FileSystemItem, FileTooLargeError, type FolderItem, type GeneratedNameResult, type GoogleAuthConfig, GoogleDriveAuth, type GoogleDriveConfig, GoogleDriveModule, type HazoFilesConfig, HazoFilesError, InvalidExtensionError, InvalidPathError, type ListOptions, type LocalStorageConfig, LocalStorageModule, type MetadataLogger, type MoveOptions, type NameGenerationOptions, type NamingRuleConfiguratorProps, type NamingRuleHistoryEntry, type NamingRuleSchema, type NamingVariable, OperationError, type OperationResult, type PatternSegment, PermissionDeniedError, type ProgressCallback, type RemoveExtractionOptions, type RenameOptions, SYSTEM_COUNTER_VARIABLES, SYSTEM_DATE_VARIABLES, SYSTEM_FILE_VARIABLES, type StorageModule, type StorageProvider, type TokenData, TrackedFileManager, type TrackedFileManagerFullOptions, type TrackedFileManagerOptions, type TreeNode, type UploadOptions, type UseNamingRuleActions, type UseNamingRuleReturn, type UseNamingRuleState, type VariableCategory, addExtractionToFileData, clearExtractions, clonePattern, createAndInitializeModule, createEmptyFileDataStructure, createEmptyNamingRuleSchema, createFileItem, createFileManager, createFileMetadataService, createFolderItem, createGoogleDriveAuth, createGoogleDriveModule, createInitializedFileManager, createInitializedTrackedFileManager, createLiteralSegment, createLocalModule, createModule, createTrackedFileManager, createVariableSegment, deepMerge, errorResult, filterItems, formatBytes, formatCounter, formatDateToken, generateExtractionId, generateId, generatePreviewName, generateSampleConfig, generateSegmentId, getBaseName, getBreadcrumbs, getDirName, getExtension, getExtensionFromMime, getExtractionById, getExtractionCount, getExtractions, getFileCategory, getFileMetadataValues, getMergedData, getMimeType, getNameWithoutExtension, getParentPath, getPathSegments, getRegisteredProviders, getRelativePath, getSystemVariablePreviewValues, hasExtension, hasExtractionStructure, 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, normalizePath, parseConfig, parseFileData, parsePatternString, patternToString, recalculateMergedData, registerModule, removeExtractionById, removeExtractionByIndex, sanitizeFilename, saveConfig, sortItems, stringifyFileData, successResult, updateExtractionById, validateExtractionData, validateFileDataStructure, validateNamingRuleSchema, validatePath };
+export { ALL_SYSTEM_VARIABLES, type AddExtractionOptions, type AuthCallbacks, AuthenticationError, ConfigurationError, type CrudServiceLike, DEFAULT_DATE_FORMATS, type DatabaseSchemaDefinition, type DatabaseTrackingConfig, DirectoryExistsError, DirectoryNotEmptyError, DirectoryNotFoundError, type DownloadOptions, type ExtractionData, type FileBrowserState, type FileDataStructure, FileExistsError, type FileItem, FileManager, type FileManagerOptions, type FileMetadataInput, type FileMetadataRecord, FileMetadataService, type FileMetadataServiceOptions, type FileMetadataUpdate, FileNotFoundError, type FileSystemItem, FileTooLargeError, type FolderItem, type GeneratedNameResult, type GoogleAuthConfig, GoogleDriveAuth, type GoogleDriveConfig, GoogleDriveModule, HAZO_FILES_DEFAULT_TABLE_NAME, HAZO_FILES_TABLE_SCHEMA, type HazoFilesColumnDefinitions, type HazoFilesConfig, HazoFilesError, type HazoFilesTableSchema, InvalidExtensionError, InvalidPathError, type ListOptions, type LocalStorageConfig, LocalStorageModule, type MetadataLogger, type MoveOptions, type NameGenerationOptions, type NamingRuleConfiguratorProps, type NamingRuleHistoryEntry, type NamingRuleSchema, type NamingVariable, OperationError, type OperationResult, type PatternSegment, PermissionDeniedError, type ProgressCallback, type RemoveExtractionOptions, type RenameOptions, SYSTEM_COUNTER_VARIABLES, SYSTEM_DATE_VARIABLES, SYSTEM_FILE_VARIABLES, type StorageModule, type StorageProvider, type TokenData, TrackedFileManager, type TrackedFileManagerFullOptions, type TrackedFileManagerOptions, type TreeNode, type UploadOptions, type UseNamingRuleActions, type UseNamingRuleReturn, type UseNamingRuleState, type VariableCategory, addExtractionToFileData, clearExtractions, clonePattern, createAndInitializeModule, createEmptyFileDataStructure, createEmptyNamingRuleSchema, createFileItem, createFileManager, createFileMetadataService, createFolderItem, createGoogleDriveAuth, createGoogleDriveModule, createInitializedFileManager, createInitializedTrackedFileManager, createLiteralSegment, createLocalModule, createModule, createTrackedFileManager, createVariableSegment, deepMerge, errorResult, filterItems, formatBytes, formatCounter, formatDateToken, generateExtractionId, generateId, generatePreviewName, generateSampleConfig, generateSegmentId, getBaseName, getBreadcrumbs, getDirName, getExtension, getExtensionFromMime, getExtractionById, getExtractionCount, getExtractions, getFileCategory, getFileMetadataValues, getMergedData, getMimeType, getNameWithoutExtension, getParentPath, getPathSegments, getRegisteredProviders, getRelativePath, getSchemaForTable, getSystemVariablePreviewValues, hasExtension, hasExtractionStructure, 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, normalizePath, parseConfig, parseFileData, parsePatternString, patternToString, recalculateMergedData, registerModule, removeExtractionById, removeExtractionByIndex, sanitizeFilename, saveConfig, sortItems, stringifyFileData, successResult, updateExtractionById, validateExtractionData, validateFileDataStructure, validateNamingRuleSchema, validatePath };

package/dist/index.js

@@ -44,6 +44,8 @@ __export(index_exports, {
   FileTooLargeError: () => FileTooLargeError,
   GoogleDriveAuth: () => GoogleDriveAuth,
   GoogleDriveModule: () => GoogleDriveModule,
+  HAZO_FILES_DEFAULT_TABLE_NAME: () => HAZO_FILES_DEFAULT_TABLE_NAME,
+  HAZO_FILES_TABLE_SCHEMA: () => HAZO_FILES_TABLE_SCHEMA,
   HazoFilesError: () => HazoFilesError,
   InvalidExtensionError: () => InvalidExtensionError,
   InvalidPathError: () => InvalidPathError,
@@ -101,6 +103,7 @@ __export(index_exports, {
   getPathSegments: () => getPathSegments,
   getRegisteredProviders: () => getRegisteredProviders,
   getRelativePath: () => getRelativePath,
+  getSchemaForTable: () => getSchemaForTable,
   getSystemVariablePreviewValues: () => getSystemVariablePreviewValues,
   hasExtension: () => hasExtension,
   hasExtractionStructure: () => hasExtractionStructure,
@@ -2856,6 +2859,66 @@ async function createInitializedTrackedFileManager(options) {
   return manager;
 }
 
+// src/schema/index.ts
+var HAZO_FILES_DEFAULT_TABLE_NAME = "hazo_files";
+var HAZO_FILES_TABLE_SCHEMA = {
+  tableName: HAZO_FILES_DEFAULT_TABLE_NAME,
+  sqlite: {
+    ddl: `CREATE TABLE IF NOT EXISTS hazo_files (
+  id TEXT PRIMARY KEY,
+  filename TEXT NOT NULL,
+  file_type TEXT NOT NULL,
+  file_data TEXT DEFAULT '{}',
+  created_at TEXT NOT NULL,
+  changed_at TEXT NOT NULL,
+  file_path TEXT NOT NULL,
+  storage_type TEXT NOT NULL
+)`,
+    indexes: [
+      "CREATE INDEX IF NOT EXISTS idx_hazo_files_path ON hazo_files (file_path)",
+      "CREATE INDEX IF NOT EXISTS idx_hazo_files_storage ON hazo_files (storage_type)",
+      "CREATE UNIQUE INDEX IF NOT EXISTS idx_hazo_files_path_storage ON hazo_files (file_path, storage_type)"
+    ]
+  },
+  postgres: {
+    ddl: `CREATE TABLE IF NOT EXISTS hazo_files (
+  id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
+  filename TEXT NOT NULL,
+  file_type TEXT NOT NULL,
+  file_data TEXT DEFAULT '{}',
+  created_at TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
+  changed_at TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
+  file_path TEXT NOT NULL,
+  storage_type TEXT NOT NULL
+)`,
+    indexes: [
+      "CREATE INDEX IF NOT EXISTS idx_hazo_files_path ON hazo_files (file_path)",
+      "CREATE INDEX IF NOT EXISTS idx_hazo_files_storage ON hazo_files (storage_type)",
+      "CREATE UNIQUE INDEX IF NOT EXISTS idx_hazo_files_path_storage ON hazo_files (file_path, storage_type)"
+    ]
+  },
+  columns: [
+    "id",
+    "filename",
+    "file_type",
+    "file_data",
+    "created_at",
+    "changed_at",
+    "file_path",
+    "storage_type"
+  ]
+};
+function getSchemaForTable(tableName, dbType) {
+  const schema = HAZO_FILES_TABLE_SCHEMA[dbType];
+  const defaultName = HAZO_FILES_TABLE_SCHEMA.tableName;
+  return {
+    ddl: schema.ddl.replace(new RegExp(defaultName, "g"), tableName),
+    indexes: schema.indexes.map(
+      (idx) => idx.replace(new RegExp(defaultName, "g"), tableName)
+    )
+  };
+}
+
 // src/common/naming-utils.ts
 var DEFAULT_DATE_FORMATS = [
   "YYYY",
@@ -3192,6 +3255,8 @@ function generatePreviewName(pattern, userVariables, options = {}) {
   FileTooLargeError,
   GoogleDriveAuth,
   GoogleDriveModule,
+  HAZO_FILES_DEFAULT_TABLE_NAME,
+  HAZO_FILES_TABLE_SCHEMA,
   HazoFilesError,
   InvalidExtensionError,
   InvalidPathError,
@@ -3249,6 +3314,7 @@ function generatePreviewName(pattern, userVariables, options = {}) {
   getPathSegments,
   getRegisteredProviders,
   getRelativePath,
+  getSchemaForTable,
   getSystemVariablePreviewValues,
   hasExtension,
   hasExtractionStructure,

package/dist/index.mjs

@@ -2710,6 +2710,66 @@ async function createInitializedTrackedFileManager(options) {
   return manager;
 }
 
+// src/schema/index.ts
+var HAZO_FILES_DEFAULT_TABLE_NAME = "hazo_files";
+var HAZO_FILES_TABLE_SCHEMA = {
+  tableName: HAZO_FILES_DEFAULT_TABLE_NAME,
+  sqlite: {
+    ddl: `CREATE TABLE IF NOT EXISTS hazo_files (
+  id TEXT PRIMARY KEY,
+  filename TEXT NOT NULL,
+  file_type TEXT NOT NULL,
+  file_data TEXT DEFAULT '{}',
+  created_at TEXT NOT NULL,
+  changed_at TEXT NOT NULL,
+  file_path TEXT NOT NULL,
+  storage_type TEXT NOT NULL
+)`,
+    indexes: [
+      "CREATE INDEX IF NOT EXISTS idx_hazo_files_path ON hazo_files (file_path)",
+      "CREATE INDEX IF NOT EXISTS idx_hazo_files_storage ON hazo_files (storage_type)",
+      "CREATE UNIQUE INDEX IF NOT EXISTS idx_hazo_files_path_storage ON hazo_files (file_path, storage_type)"
+    ]
+  },
+  postgres: {
+    ddl: `CREATE TABLE IF NOT EXISTS hazo_files (
+  id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
+  filename TEXT NOT NULL,
+  file_type TEXT NOT NULL,
+  file_data TEXT DEFAULT '{}',
+  created_at TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
+  changed_at TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
+  file_path TEXT NOT NULL,
+  storage_type TEXT NOT NULL
+)`,
+    indexes: [
+      "CREATE INDEX IF NOT EXISTS idx_hazo_files_path ON hazo_files (file_path)",
+      "CREATE INDEX IF NOT EXISTS idx_hazo_files_storage ON hazo_files (storage_type)",
+      "CREATE UNIQUE INDEX IF NOT EXISTS idx_hazo_files_path_storage ON hazo_files (file_path, storage_type)"
+    ]
+  },
+  columns: [
+    "id",
+    "filename",
+    "file_type",
+    "file_data",
+    "created_at",
+    "changed_at",
+    "file_path",
+    "storage_type"
+  ]
+};
+function getSchemaForTable(tableName, dbType) {
+  const schema = HAZO_FILES_TABLE_SCHEMA[dbType];
+  const defaultName = HAZO_FILES_TABLE_SCHEMA.tableName;
+  return {
+    ddl: schema.ddl.replace(new RegExp(defaultName, "g"), tableName),
+    indexes: schema.indexes.map(
+      (idx) => idx.replace(new RegExp(defaultName, "g"), tableName)
+    )
+  };
+}
+
 // src/common/naming-utils.ts
 var DEFAULT_DATE_FORMATS = [
   "YYYY",
@@ -3045,6 +3105,8 @@ export {
   FileTooLargeError,
   GoogleDriveAuth,
   GoogleDriveModule,
+  HAZO_FILES_DEFAULT_TABLE_NAME,
+  HAZO_FILES_TABLE_SCHEMA,
   HazoFilesError,
   InvalidExtensionError,
   InvalidPathError,
@@ -3102,6 +3164,7 @@ export {
   getPathSegments,
   getRegisteredProviders,
   getRelativePath,
+  getSchemaForTable,
   getSystemVariablePreviewValues,
   hasExtension,
   hasExtractionStructure,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hazo_files",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "File management including integration to cloud files",
   "main": "dist/index.js",
   "module": "dist/index.mjs",