@interactive-inc/docs-client 1.0.0 → 1.0.2

package/build/index.d.ts

@@ -55,11 +55,11 @@ declare class DocFileSystem {
     /**
      * Read file content at the specified path
      */
-    readFile(relativePath: string): Promise<string | null>;
+    readFile(relativePath: string): Promise<string | null | Error>;
     /**
      * Write content to file at the specified path (creates directory if needed)
      */
-    writeFile(relativePath: string, content: string): Promise<void>;
+    writeFile(relativePath: string, content: string): Promise<Error | null>;
     /**
      * Delete file at the specified path
      */
@@ -79,8 +79,8 @@ declare class DocFileSystem {
     /**
      * Get list of entries in directory
      */
-    readDirectoryFileNames(relativePath?: string): Promise<string[]>;
-    readDirectoryFilePaths(relativePath: string): Promise<string[]>;
+    readDirectoryFileNames(relativePath?: string): Promise<string[] | Error>;
+    readDirectoryFilePaths(relativePath: string): Promise<string[] | Error>;
     /**
      * Check if path is a directory
      */
@@ -112,31 +112,31 @@ declare class DocFileSystem {
     /**
      * Create directory
      */
-    createDirectory(relativePath: string): Promise<void>;
+    createDirectory(relativePath: string): Promise<Error | null>;
     /**
      * Get file size in bytes
      */
-    getFileSize(relativePath: string): Promise<number>;
+    getFileSize(relativePath: string): Promise<number | Error>;
     /**
      * Create directory if it doesn't exist
      */
-    ensureDirectoryExists(relativePath: string): Promise<void>;
+    ensureDirectoryExists(relativePath: string): Promise<Error | null>;
     /**
      * Copy file
      */
-    copyFile(sourcePath: string, destinationPath: string): Promise<void>;
+    copyFile(sourcePath: string, destinationPath: string): Promise<Error | null>;
     /**
      * Move file
      */
-    moveFile(sourcePath: string, destinationPath: string): Promise<void>;
+    moveFile(sourcePath: string, destinationPath: string): Promise<Error | null>;
     /**
      * Get file last modified time
      */
-    getFileModifiedTime(relativePath: string): Promise<Date>;
+    getFileModifiedTime(relativePath: string): Promise<Date | Error>;
     /**
      * Get file creation time
      */
-    getFileCreatedTime(relativePath: string): Promise<Date>;
+    getFileCreatedTime(relativePath: string): Promise<Date | Error>;
 }
 
 /**
@@ -307,12 +307,12 @@ declare class DocFileMdReference<T extends DocCustomSchema> {
     /**
      * Write entity
      */
-    write(entity: DocFileMdEntity<T>): Promise<null>;
-    writeText(text: string): Promise<void>;
+    write(entity: DocFileMdEntity<T>): Promise<Error | null>;
+    writeText(text: string): Promise<Error | null>;
     /**
      * Create new file with default content
      */
-    writeDefault(): Promise<void>;
+    writeDefault(): Promise<Error | null>;
     /**
      * Delete file
      */
@@ -320,11 +320,11 @@ declare class DocFileMdReference<T extends DocCustomSchema> {
     /**
      * Copy file
      */
-    copyTo(destinationPath: string): Promise<void>;
+    copyTo(destinationPath: string): Promise<Error | null>;
     /**
      * Move file
      */
-    moveTo(destinationPath: string): Promise<void>;
+    moveTo(destinationPath: string): Promise<Error | null>;
     /**
      * Move file to archive and return new reference
      */
@@ -336,15 +336,15 @@ declare class DocFileMdReference<T extends DocCustomSchema> {
     /**
      * Get file size in bytes
      */
-    size(): Promise<number>;
+    size(): Promise<number | Error>;
     /**
      * Get file last modified time
      */
-    lastModified(): Promise<Date>;
+    lastModified(): Promise<Date | Error>;
     /**
      * Get file creation time
      */
-    createdAt(): Promise<Date>;
+    createdAt(): Promise<Date | Error>;
     directory(): DocDirectoryReference<T>;
     /**
      * Get relation based on schema
@@ -422,15 +422,15 @@ declare class DocFileUnknownReference {
     /**
      * Write content to file
      */
-    writeContent(content: string): Promise<void>;
+    writeContent(content: string): Promise<Error | null>;
     /**
      * Write entity
      */
-    write(entity: DocFileUnknownEntity): Promise<void>;
+    write(entity: DocFileUnknownEntity): Promise<Error | null>;
     /**
      * Write raw content
      */
-    writeRaw(content: string): Promise<void>;
+    writeRaw(content: string): Promise<Error | null>;
     /**
      * Delete file
      */
@@ -442,23 +442,23 @@ declare class DocFileUnknownReference {
     /**
      * Copy file
      */
-    copyTo(destinationPath: string): Promise<void>;
+    copyTo(destinationPath: string): Promise<Error | null>;
     /**
      * Move file
      */
-    moveTo(destinationPath: string): Promise<void>;
+    moveTo(destinationPath: string): Promise<Error | null>;
     /**
      * Get file size in bytes
      */
-    size(): Promise<number>;
+    size(): Promise<number | Error>;
     /**
      * Get file last modified time
      */
-    lastModified(): Promise<Date>;
+    lastModified(): Promise<Date | Error>;
     /**
      * Get file creation time
      */
-    createdAt(): Promise<Date>;
+    createdAt(): Promise<Date | Error>;
     /**
      * Move file to archive and return new reference
      */
@@ -1172,15 +1172,15 @@ declare class DocFileRelationReference {
      * Full path
      */
     get fullPath(): string;
-    read(): Promise<DocRelationValue | null>;
+    read(): Promise<DocRelationValue | Error | null>;
     /**
      * Read list of relation files
      */
-    readFiles(): Promise<DocRelationFileValue[]>;
+    readFiles(): Promise<DocRelationFileValue[] | Error>;
     /**
      * Read single relation file
      */
-    readFile(filePath: string): Promise<DocRelationFileValue | null>;
+    readFile(filePath: string): Promise<DocRelationFileValue | Error | null>;
     /**
      * Check if file exists
      */
@@ -1188,15 +1188,15 @@ declare class DocFileRelationReference {
     /**
      * Get list of file names (without extension)
      */
-    readSlugs(): Promise<string[]>;
+    readSlugs(): Promise<string[] | Error>;
     /**
      * Get file count
      */
-    count(): Promise<number>;
+    count(): Promise<number | Error>;
     /**
      * Check if empty
      */
-    isEmpty(): Promise<boolean>;
+    isEmpty(): Promise<boolean | Error>;
 }
 
 /**
@@ -1416,7 +1416,7 @@ declare class DocFileIndexReference<T extends DocCustomSchema> {
     get filePath(): string;
     get fileFullPath(): string;
     get durectoryPath(): string;
-    read(): Promise<DocFileIndexEntity<T>>;
+    read(): Promise<DocFileIndexEntity<T> | Error>;
     /**
      * Read file content
      */
@@ -1424,15 +1424,15 @@ declare class DocFileIndexReference<T extends DocCustomSchema> {
     /**
      * Write content to file
      */
-    writeContent(content: string): Promise<void>;
+    writeContent(content: string): Promise<Error | null>;
     /**
      * Write entity
      */
-    write(entity: DocFileIndexEntity<T>): Promise<void>;
+    write(entity: DocFileIndexEntity<T>): Promise<Error | null>;
     /**
      * Create new file with default content
      */
-    writeDefault(): Promise<null>;
+    writeDefault(): Promise<Error | null>;
     /**
      * Delete file
      */
@@ -1441,20 +1441,20 @@ declare class DocFileIndexReference<T extends DocCustomSchema> {
      * Check if file exists
      */
     exists(): Promise<boolean>;
-    relations(): Promise<DocFileRelationReference[]>;
-    readRelations(): Promise<DocRelationValue[]>;
+    relations(): Promise<DocFileRelationReference[] | Error>;
+    readRelations(): Promise<DocRelationValue[] | Error>;
     /**
      * Get file size in bytes
      */
-    size(): Promise<number>;
+    size(): Promise<number | Error>;
     /**
      * Get last modified date
      */
-    lastModified(): Promise<Date>;
+    lastModified(): Promise<Date | Error>;
     /**
      * Get file creation date
      */
-    createdAt(): Promise<Date>;
+    createdAt(): Promise<Date | Error>;
     /**
      * Move file to archive and return new reference
      */
@@ -1490,25 +1490,25 @@ declare class DocDirectoryReference<T extends DocCustomSchema> {
     get indexFileName(): string;
     get indexFilePath(): string;
     get archiveDirectoryName(): string;
-    fileNames(): Promise<string[]>;
-    archivedFileNames(): Promise<string[]>;
-    filesGenerator(): AsyncGenerator<DocFileMdReference<T> | DocFileUnknownReference, void, unknown>;
-    mdFilesGenerator(): AsyncGenerator<DocFileMdReference<T>, void, unknown>;
-    files(): Promise<(DocFileMdReference<T> | DocFileUnknownReference)[]>;
-    mdFiles(): Promise<DocFileMdReference<T>[]>;
+    fileNames(): Promise<string[] | Error>;
+    archivedFileNames(): Promise<string[] | Error>;
+    filesGenerator(): AsyncGenerator<DocFileMdReference<T> | DocFileUnknownReference | Error, void, unknown>;
+    mdFilesGenerator(): AsyncGenerator<DocFileMdReference<T> | Error, void, unknown>;
+    files(): Promise<(DocFileMdReference<T> | DocFileUnknownReference)[] | Error>;
+    mdFiles(): Promise<DocFileMdReference<T>[] | Error>;
     file<FileName extends string>(fileName: FileName): InferReference<FileName, T>;
     mdFile(fileName: string): DocFileMdReference<T>;
-    readFiles(): Promise<(DocFileMdEntity<T> | DocFileUnknownEntity)[]>;
-    readMdFiles(): Promise<DocFileMdEntity<T>[]>;
-    readUnknownFiles(): Promise<DocFileUnknownEntity[]>;
+    readFiles(): Promise<(DocFileMdEntity<T> | DocFileUnknownEntity)[] | Error>;
+    readMdFiles(): Promise<DocFileMdEntity<T>[] | Error>;
+    readUnknownFiles(): Promise<DocFileUnknownEntity[] | Error>;
     /**
      * Get list of subdirectory names
      */
-    directoryNames(): Promise<string[]>;
+    directoryNames(): Promise<string[] | Error>;
     /**
      * Get subdirectory references
      */
-    directories(): Promise<DocDirectoryReference<T>[]>;
+    directories(): Promise<DocDirectoryReference<T>[] | Error>;
     /**
      * Get single subdirectory reference
      */
@@ -1611,7 +1611,7 @@ declare class DocFileTreeSystem {
     /**
      * Build file tree recursively
      */
-    buildFileTree(directoryPath?: string): Promise<DocTreeNodeValue[]>;
+    buildFileTree(directoryPath?: string): Promise<DocTreeNodeValue[] | Error>;
     /**
      * Create file node
      */
@@ -1631,7 +1631,7 @@ declare class DocFileTreeSystem {
     /**
      * Build directory tree recursively (directories only)
      */
-    buildDirectoryTree(directoryPath?: string): Promise<DocTreeDirectoryNodeValue[]>;
+    buildDirectoryTree(directoryPath?: string): Promise<DocTreeDirectoryNodeValue[] | Error>;
     /**
      * Create directory node for directory tree
      */
@@ -1715,7 +1715,7 @@ declare class DocClient {
 /**
  * In-memory file system for testing
  */
-declare class DocFileSystemDebug extends DocFileSystem {
+declare class DocFileSystemMock extends DocFileSystem {
     private files;
     private readonly _pathSystem;
     constructor(props: {
@@ -1726,33 +1726,37 @@ declare class DocFileSystemDebug extends DocFileSystem {
      * PathSystem accessor (for testing)
      */
     getPathSystem(): DocPathSystem;
+    /**
+     * Create instance (mock data is automatically loaded)
+     */
+    static create(basePath?: string): DocFileSystemMock;
     /**
      * Factory method for testing
      */
     static createWithFiles(props: {
         basePath?: string;
         fileContents?: Record<string, string>;
-    }): DocFileSystemDebug;
-    readFile(filePath: string): Promise<string | null>;
-    writeFile(filePath: string, content: string): Promise<void>;
+    }): DocFileSystemMock;
+    readFile(filePath: string): Promise<string | null | Error>;
+    writeFile(filePath: string, content: string): Promise<Error | null>;
     deleteFile(filePath: string): Promise<Error | null>;
     exists(filePath: string): Promise<boolean>;
-    copyFile(source: string, destination: string): Promise<void>;
-    moveFile(source: string, destination: string): Promise<void>;
+    copyFile(source: string, destination: string): Promise<Error | null>;
+    moveFile(source: string, destination: string): Promise<Error | null>;
     readDirectory(directoryPath: string): Promise<string[]>;
     readDirectoryRecursive(directoryPath: string): Promise<string[]>;
-    readDirectoryFilePaths(directoryPath: string): Promise<string[]>;
-    createDirectory(_directoryPath: string): Promise<void>;
+    readDirectoryFilePaths(directoryPath: string): Promise<string[] | Error>;
+    createDirectory(_directoryPath: string): Promise<Error | null>;
     deleteDirectory(directoryPath: string): Promise<void>;
-    getFileSize(filePath: string): Promise<number>;
-    getFileModifiedTime(filePath: string): Promise<Date>;
-    getFileCreatedTime(filePath: string): Promise<Date>;
+    getFileSize(filePath: string): Promise<number | Error>;
+    getFileModifiedTime(filePath: string): Promise<Date | Error>;
+    getFileCreatedTime(filePath: string): Promise<Date | Error>;
     isDirectory(relativePath: string): Promise<boolean>;
     isFile(relativePath: string): Promise<boolean>;
     /**
      * Get list of entries in directory
      */
-    readDirectoryFileNames(directoryPath?: string): Promise<string[]>;
+    readDirectoryFileNames(directoryPath?: string): Promise<string[] | Error>;
     /**
      * Check if directory exists
      */
@@ -1764,7 +1768,7 @@ declare class DocFileSystemDebug extends DocFileSystem {
     /**
      * Create directory if it doesn't exist
      */
-    ensureDirectoryExists(_relativePath: string): Promise<void>;
+    ensureDirectoryExists(_relativePath: string): Promise<Error | null>;
     /**
      * Clear all files
      */
@@ -1791,6 +1795,27 @@ declare class DocFileSystemDebug extends DocFileSystem {
     setupTestFiles(files: Record<string, string>): void;
 }
 
+/**
+ * Mock path system for testing
+ */
+declare class DocPathSystemMock extends DocPathSystem {
+    private readonly _separator;
+    constructor(separator?: string);
+    join(...paths: string[]): string;
+    basename(path: string, ext?: string): string;
+    dirname(path: string): string;
+    extname(path: string): string;
+    relative(from: string, to: string): string;
+    resolve(...paths: string[]): string;
+    normalize(path: string): string;
+    isAbsolute(path: string): boolean;
+    get sep(): string;
+    /**
+     * Set custom separator for testing
+     */
+    static createWithSeparator(separator: string): DocPathSystemMock;
+}
+
 /**
  * Schema builder
  * Build schemas in a chain style
@@ -1939,4 +1964,4 @@ declare const docCustomSchemaField: {
     };
 };
 
-export { type BaseFieldValueType, type DetectFileType, DocClient, type DocClientConfig, type DocCustomSchema, type DocCustomSchemaField, type DocCustomSchemaFieldBoolean, type DocCustomSchemaFieldMultiNumber, type DocCustomSchemaFieldMultiRelation, type DocCustomSchemaFieldMultiSelectNumber, type DocCustomSchemaFieldMultiSelectText, type DocCustomSchemaFieldMultiText, type DocCustomSchemaFieldNumber, type DocCustomSchemaFieldRelation, type DocCustomSchemaFieldSelectNumber, type DocCustomSchemaFieldSelectText, type DocCustomSchemaFieldText, type DocDirectory, DocDirectoryReference, type DocFieldTypeLiteral, type DocFile, type DocFileEntity, type DocFileIndex, type DocFileIndexContent, DocFileIndexEntity, type DocFileIndexMeta, DocFileIndexReference, type DocFileIndexSchema, type DocFileIndexSchemaField, type DocFileMd, type DocFileMdContent, DocFileMdEntity, type DocFileMdMeta, DocFileMdReference, type DocFilePath, DocFileRelationReference, DocFileSystem, DocFileSystemDebug, DocFileTreeSystem, type DocFileUnknown, DocFileUnknownEntity, DocFileUnknownReference, DocMarkdownSystem, type DocMetaField, type DocMetaFieldBoolean, type DocMetaFieldMultiBoolean, type DocMetaFieldMultiNumber, type DocMetaFieldMultiRelation, type DocMetaFieldMultiSelectNumber, type DocMetaFieldMultiSelectText, type DocMetaFieldMultiText, type DocMetaFieldNumber, type DocMetaFieldRelation, type DocMetaFieldSelectNumber, type DocMetaFieldSelectText, type DocMetaFieldText, type DocMetaFieldType, type DocMetaFieldTypeBoolean, type DocMetaFieldTypeNumber, type DocMetaFieldTypeRelation, type DocMetaFieldTypeSelectNumber, type DocMetaFieldTypeSelectText, type DocMetaFieldTypeText, DocPathSystem, type DocRelation, type DocRelationField, type DocRelationFile, DocSchemaBuilder, type DocSchemaFieldBoolean, type DocSchemaFieldMultiNumber, type DocSchemaFieldMultiRelation, type DocSchemaFieldMultiSelectNumber, type DocSchemaFieldMultiSelectText, type DocSchemaFieldMultiText, type DocSchemaFieldNumber, type DocSchemaFieldRelation, type DocSchemaFieldSelectNumber, type DocSchemaFieldSelectText, type DocSchemaFieldText, type DocSchemaRelationFieldUnion, type DocTreeDirectoryNode, type DocTreeFileNode, type DocTreeNode, type Equals, type ExtractFieldType, type ExtractIndexFieldType, type ExtractRequired, type FieldValueType, type GetIndexFieldType, type GetIndexFieldValueType, type GetValueType, type InferDocFileMd, type InferReference, type MultiRelationKeys, type OptionalKeys, type RecordKey, type RelationKeys, type RequiredKeys, type SchemaToValueType, assertType, defaultTestConfig, defineSchema, docCustomSchemaField, expectType, zDocClientConfig, zDocFileIndexSchemaField, zDocFilePath, zDocFileUnknown, zDocMetaField, zDocMetaFieldBoolean, zDocMetaFieldMultiBoolean, zDocMetaFieldMultiNumber, zDocMetaFieldMultiRelation, zDocMetaFieldMultiSelectNumber, zDocMetaFieldMultiSelectText, zDocMetaFieldMultiText, zDocMetaFieldNumber, zDocMetaFieldRelation, zDocMetaFieldSelectNumber, zDocMetaFieldSelectText, zDocMetaFieldText, zDocMetaFieldType, zDocMetaFieldTypeBoolean, zDocMetaFieldTypeNumber, zDocMetaFieldTypeRelation, zDocMetaFieldTypeSelectNumber, zDocMetaFieldTypeSelectText, zDocMetaFieldTypeText, zDocRelation, zDocRelationField, zDocRelationFile, zDocSchemaFieldBoolean, zDocSchemaFieldMultiNumber, zDocSchemaFieldMultiRelation, zDocSchemaFieldMultiSelectNumber, zDocSchemaFieldMultiSelectText, zDocSchemaFieldMultiText, zDocSchemaFieldNumber, zDocSchemaFieldRelation, zDocSchemaFieldSelectNumber, zDocSchemaFieldSelectText, zDocSchemaFieldText };
+export { type BaseFieldValueType, type DetectFileType, DocClient, type DocClientConfig, type DocCustomSchema, type DocCustomSchemaField, type DocCustomSchemaFieldBoolean, type DocCustomSchemaFieldMultiNumber, type DocCustomSchemaFieldMultiRelation, type DocCustomSchemaFieldMultiSelectNumber, type DocCustomSchemaFieldMultiSelectText, type DocCustomSchemaFieldMultiText, type DocCustomSchemaFieldNumber, type DocCustomSchemaFieldRelation, type DocCustomSchemaFieldSelectNumber, type DocCustomSchemaFieldSelectText, type DocCustomSchemaFieldText, type DocDirectory, DocDirectoryReference, type DocFieldTypeLiteral, type DocFile, type DocFileEntity, type DocFileIndex, type DocFileIndexContent, DocFileIndexEntity, type DocFileIndexMeta, DocFileIndexReference, type DocFileIndexSchema, type DocFileIndexSchemaField, type DocFileMd, type DocFileMdContent, DocFileMdEntity, type DocFileMdMeta, DocFileMdReference, type DocFilePath, DocFileRelationReference, DocFileSystem, DocFileSystemMock, DocFileTreeSystem, type DocFileUnknown, DocFileUnknownEntity, DocFileUnknownReference, DocMarkdownSystem, type DocMetaField, type DocMetaFieldBoolean, type DocMetaFieldMultiBoolean, type DocMetaFieldMultiNumber, type DocMetaFieldMultiRelation, type DocMetaFieldMultiSelectNumber, type DocMetaFieldMultiSelectText, type DocMetaFieldMultiText, type DocMetaFieldNumber, type DocMetaFieldRelation, type DocMetaFieldSelectNumber, type DocMetaFieldSelectText, type DocMetaFieldText, type DocMetaFieldType, type DocMetaFieldTypeBoolean, type DocMetaFieldTypeNumber, type DocMetaFieldTypeRelation, type DocMetaFieldTypeSelectNumber, type DocMetaFieldTypeSelectText, type DocMetaFieldTypeText, DocPathSystem, DocPathSystemMock, type DocRelation, type DocRelationField, type DocRelationFile, DocSchemaBuilder, type DocSchemaFieldBoolean, type DocSchemaFieldMultiNumber, type DocSchemaFieldMultiRelation, type DocSchemaFieldMultiSelectNumber, type DocSchemaFieldMultiSelectText, type DocSchemaFieldMultiText, type DocSchemaFieldNumber, type DocSchemaFieldRelation, type DocSchemaFieldSelectNumber, type DocSchemaFieldSelectText, type DocSchemaFieldText, type DocSchemaRelationFieldUnion, type DocTreeDirectoryNode, type DocTreeFileNode, type DocTreeNode, type Equals, type ExtractFieldType, type ExtractIndexFieldType, type ExtractRequired, type FieldValueType, type GetIndexFieldType, type GetIndexFieldValueType, type GetValueType, type InferDocFileMd, type InferReference, type MultiRelationKeys, type OptionalKeys, type RecordKey, type RelationKeys, type RequiredKeys, type SchemaToValueType, assertType, defaultTestConfig, defineSchema, docCustomSchemaField, expectType, zDocClientConfig, zDocFileIndexSchemaField, zDocFilePath, zDocFileUnknown, zDocMetaField, zDocMetaFieldBoolean, zDocMetaFieldMultiBoolean, zDocMetaFieldMultiNumber, zDocMetaFieldMultiRelation, zDocMetaFieldMultiSelectNumber, zDocMetaFieldMultiSelectText, zDocMetaFieldMultiText, zDocMetaFieldNumber, zDocMetaFieldRelation, zDocMetaFieldSelectNumber, zDocMetaFieldSelectText, zDocMetaFieldText, zDocMetaFieldType, zDocMetaFieldTypeBoolean, zDocMetaFieldTypeNumber, zDocMetaFieldTypeRelation, zDocMetaFieldTypeSelectNumber, zDocMetaFieldTypeSelectText, zDocMetaFieldTypeText, zDocRelation, zDocRelationField, zDocRelationFile, zDocSchemaFieldBoolean, zDocSchemaFieldMultiNumber, zDocSchemaFieldMultiRelation, zDocSchemaFieldMultiSelectNumber, zDocSchemaFieldMultiSelectText, zDocSchemaFieldMultiText, zDocSchemaFieldNumber, zDocSchemaFieldRelation, zDocSchemaFieldSelectNumber, zDocSchemaFieldSelectText, zDocSchemaFieldText };