@interactive-inc/docs-client 1.0.20 → 1.1.1

package/build/doc-file-system-DEmPPJPE.d.ts

@@ -0,0 +1,205 @@
+import { D as DocFileSystemInterface, a as DocPathSystem } from './doc-file-system.interface-C5vpYrOL.js';
+
+/**
+ * Read-only file system interface for document operations
+ */
+interface DocFileSystemReadInterface {
+    /**
+     * Read file content at the specified path
+     */
+    readFile(relativePath: string): Promise<string | null | Error>;
+    /**
+     * Get file name from path
+     */
+    readFileName(relativePath: string): string;
+    /**
+     * Get file extension from path
+     */
+    readFileExtension(relativePath: string): string;
+    /**
+     * Get directory path where the file exists
+     */
+    readFileDirectory(relativePath: string): string;
+    /**
+     * Get list of entries in directory
+     */
+    readDirectoryFileNames(relativePath?: string): Promise<string[] | Error>;
+    /**
+     * Get list of file paths in directory
+     */
+    readDirectoryFilePaths(relativePath: string): Promise<string[] | Error>;
+    /**
+     * Check if path is a directory
+     */
+    isDirectory(relativePath: string): Promise<boolean>;
+    /**
+     * Check if path is a file
+     */
+    isFile(relativePath: string): Promise<boolean>;
+    /**
+     * Check if file or directory exists
+     */
+    exists(relativePath: string): Promise<boolean>;
+    /**
+     * Check if directory exists
+     */
+    directoryExists(relativePath: string): Promise<boolean>;
+    /**
+     * Check if file exists
+     */
+    fileExists(relativePath: string): Promise<boolean>;
+    /**
+     * Get base path
+     */
+    getBasePath(): string;
+    /**
+     * Convert relative path to absolute path
+     */
+    resolve(relativePath: string): string;
+    /**
+     * Get file size in bytes
+     */
+    getFileSize(relativePath: string): Promise<number | Error>;
+    /**
+     * Get file last modified time
+     */
+    getFileUpdatedTime(relativePath: string): Promise<Date | Error>;
+    /**
+     * Get file creation time
+     */
+    getFileCreatedTime(relativePath: string): Promise<Date | Error>;
+}
+
+/**
+ * Write-only file system interface for document operations
+ */
+interface DocFileSystemWriteInterface {
+    /**
+     * Write content to file at the specified path (creates directory if needed)
+     */
+    writeFile(relativePath: string, content: string): Promise<Error | null>;
+    /**
+     * Delete file at the specified path
+     */
+    deleteFile(relativePath: string): Promise<Error | null>;
+    /**
+     * Create directory
+     */
+    createEmptyDirectory(relativePath: string): Promise<Error | null>;
+    /**
+     * Create directory if it doesn't exist
+     */
+    createDirectory(relativePath: string): Promise<Error | null>;
+    /**
+     * Copy file
+     */
+    copyFile(sourcePath: string, destinationPath: string): Promise<Error | null>;
+    /**
+     * Move file
+     */
+    moveFile(sourcePath: string, destinationPath: string): Promise<Error | null>;
+}
+
+type Props = {
+    basePath: string;
+    pathSystem?: DocPathSystem;
+    reader: DocFileSystemReadInterface;
+    writer: DocFileSystemWriteInterface;
+};
+/**
+ * File system wrapper with dependency injection for read/write operations
+ */
+declare class DocFileSystem implements DocFileSystemInterface {
+    protected readonly reader: DocFileSystemReadInterface;
+    protected readonly writer: DocFileSystemWriteInterface;
+    protected readonly basePath: string;
+    protected readonly pathSystem: DocPathSystem;
+    constructor(props: Props);
+    /**
+     * Read file content at the specified path
+     */
+    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<Error | null>;
+    /**
+     * Delete file at the specified path
+     */
+    deleteFile(relativePath: string): Promise<Error | null>;
+    /**
+     * Get file name from path
+     */
+    readFileName(relativePath: string): string;
+    /**
+     * Get file extension from path
+     */
+    readFileExtension(relativePath: string): string;
+    /**
+     * Get directory path where the file exists
+     */
+    readFileDirectory(relativePath: string): string;
+    /**
+     * Get list of entries in directory
+     */
+    readDirectoryFileNames(relativePath?: string): Promise<string[] | Error>;
+    readDirectoryFilePaths(relativePath: string): Promise<string[] | Error>;
+    /**
+     * Check if path is a directory
+     */
+    isDirectory(relativePath: string): Promise<boolean>;
+    /**
+     * Check if path is a file
+     */
+    isFile(relativePath: string): Promise<boolean>;
+    /**
+     * Check if file or directory exists
+     */
+    exists(relativePath: string): Promise<boolean>;
+    /**
+     * Check if directory exists
+     */
+    directoryExists(relativePath: string): Promise<boolean>;
+    /**
+     * Check if file exists
+     */
+    fileExists(relativePath: string): Promise<boolean>;
+    /**
+     * Get base path
+     */
+    getBasePath(): string;
+    /**
+     * Convert relative path to absolute path
+     */
+    resolve(relativePath: string): string;
+    /**
+     * Create directory
+     */
+    createEmptyDirectory(relativePath: string): Promise<Error | null>;
+    /**
+     * Get file size in bytes
+     */
+    getFileSize(relativePath: string): Promise<number | Error>;
+    /**
+     * Create directory if it doesn't exist
+     */
+    createDirectory(relativePath: string): Promise<Error | null>;
+    /**
+     * Copy file
+     */
+    copyFile(sourcePath: string, destinationPath: string): Promise<Error | null>;
+    /**
+     * Move file
+     */
+    moveFile(sourcePath: string, destinationPath: string): Promise<Error | null>;
+    /**
+     * Get file last modified time
+     */
+    getFileUpdatedTime(relativePath: string): Promise<Date | Error>;
+    /**
+     * Get file creation time
+     */
+    getFileCreatedTime(relativePath: string): Promise<Date | Error>;
+}
+
+export { DocFileSystem as D, type DocFileSystemReadInterface as a, type DocFileSystemWriteInterface as b };

package/build/doc-file-system.interface-C5vpYrOL.d.ts

@@ -0,0 +1,135 @@
+/**
+ * Path operations system
+ */
+declare class DocPathSystem {
+    readonly separator = "/";
+    /**
+     * Join paths
+     */
+    join(...paths: string[]): string;
+    /**
+     * Get filename with extension
+     */
+    basename(path: string, ext?: string): string;
+    /**
+     * Get directory name
+     */
+    dirname(path: string): string;
+    /**
+     * Get extension
+     */
+    extname(path: string): string;
+    /**
+     * Calculate relative path
+     */
+    relative(from: string, to: string): string;
+    /**
+     * Convert to absolute path
+     */
+    resolve(...paths: string[]): string;
+    /**
+     * Normalize path
+     */
+    normalize(path: string): string;
+    /**
+     * Check if path is absolute
+     */
+    isAbsolute(path: string): boolean;
+}
+
+/**
+ * Interface for DocFileSystem class
+ * Defines all public methods available in DocFileSystem
+ */
+interface DocFileSystemInterface {
+    /**
+     * Read file content at the specified path
+     */
+    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<Error | null>;
+    /**
+     * Delete file at the specified path
+     */
+    deleteFile(relativePath: string): Promise<Error | null>;
+    /**
+     * Get file name from path
+     */
+    readFileName(relativePath: string): string;
+    /**
+     * Get file extension from path
+     */
+    readFileExtension(relativePath: string): string;
+    /**
+     * Get directory path where the file exists
+     */
+    readFileDirectory(relativePath: string): string;
+    /**
+     * Get list of entries in directory
+     */
+    readDirectoryFileNames(relativePath?: string): Promise<string[] | Error>;
+    /**
+     * Get list of file paths in directory
+     */
+    readDirectoryFilePaths(relativePath: string): Promise<string[] | Error>;
+    /**
+     * Check if path is a directory
+     */
+    isDirectory(relativePath: string): Promise<boolean>;
+    /**
+     * Check if path is a file
+     */
+    isFile(relativePath: string): Promise<boolean>;
+    /**
+     * Check if file or directory exists
+     */
+    exists(relativePath: string): Promise<boolean>;
+    /**
+     * Check if directory exists
+     */
+    directoryExists(relativePath: string): Promise<boolean>;
+    /**
+     * Check if file exists
+     */
+    fileExists(relativePath: string): Promise<boolean>;
+    /**
+     * Get base path
+     */
+    getBasePath(): string;
+    /**
+     * Convert relative path to absolute path
+     */
+    resolve(relativePath: string): string;
+    /**
+     * Create directory
+     */
+    createEmptyDirectory(relativePath: string): Promise<Error | null>;
+    /**
+     * Get file size in bytes
+     */
+    getFileSize(relativePath: string): Promise<number | Error>;
+    /**
+     * Create directory if it doesn't exist
+     */
+    createDirectory(relativePath: string): Promise<Error | null>;
+    /**
+     * Copy file
+     */
+    copyFile(sourcePath: string, destinationPath: string): Promise<Error | null>;
+    /**
+     * Move file
+     */
+    moveFile(sourcePath: string, destinationPath: string): Promise<Error | null>;
+    /**
+     * Get file last modified time
+     */
+    getFileUpdatedTime(relativePath: string): Promise<Date | Error>;
+    /**
+     * Get file creation time
+     */
+    getFileCreatedTime(relativePath: string): Promise<Date | Error>;
+}
+
+export { type DocFileSystemInterface as D, DocPathSystem as a };

package/build/file-system-json.d.ts

@@ -0,0 +1,224 @@
+import { z } from 'zod';
+import { a as DocPathSystem } from './doc-file-system.interface-C5vpYrOL.js';
+import { D as DocFileSystem, a as DocFileSystemReadInterface, b as DocFileSystemWriteInterface } from './doc-file-system-DEmPPJPE.js';
+
+declare const zJsonDocumentData$2: z.ZodRecord<z.ZodString, z.ZodString>;
+type JsonDocumentData$2 = z.infer<typeof zJsonDocumentData$2>;
+type JsonProps = {
+    data?: JsonDocumentData$2 | unknown;
+    basePath?: string;
+    pathSystem?: DocPathSystem;
+    onDataChange?: (data: JsonDocumentData$2) => void;
+};
+/**
+ * JSON-based file system with separate read/write components
+ */
+declare class DocFileSystemJson extends DocFileSystem {
+    private readonly jsonReader;
+    private readonly jsonWriter;
+    constructor(props?: JsonProps);
+    /**
+     * Get the current JSON data
+     */
+    getData(): JsonDocumentData$2;
+    /**
+     * Update the entire JSON data
+     */
+    setData(data: JsonDocumentData$2 | unknown): Error | null;
+    /**
+     * Clear all data
+     */
+    clear(): void;
+    /**
+     * Get all file paths in the JSON data
+     */
+    getAllFilePaths(): string[];
+    /**
+     * Get the raw JSON data (read-only copy)
+     */
+    getRawData(): JsonDocumentData$2;
+    /**
+     * Create from docs-to-json format
+     */
+    static fromDocsToJson(data: Record<string, string> | unknown, options?: Omit<JsonProps, "data">): DocFileSystemJson;
+    /**
+     * Export to docs-to-json format
+     */
+    toDocsToJson(): Record<string, string>;
+}
+
+declare const zJsonDocumentData$1: z.ZodRecord<z.ZodString, z.ZodString>;
+type JsonDocumentData$1 = z.infer<typeof zJsonDocumentData$1>;
+type Props$1 = {
+    data: JsonDocumentData$1 | unknown;
+    basePath?: string;
+    pathSystem?: DocPathSystem;
+};
+/**
+ * JSON-based read-only file system implementation
+ */
+declare class DocFileSystemJsonRead implements DocFileSystemReadInterface {
+    private readonly data;
+    private readonly basePath;
+    private readonly pathSystem;
+    constructor(props: Props$1);
+    /**
+     * Read file content from JSON data
+     */
+    readFile(relativePath: string): Promise<string | null | Error>;
+    /**
+     * Get file name from path
+     */
+    readFileName(relativePath: string): string;
+    /**
+     * Get file extension from path
+     */
+    readFileExtension(relativePath: string): string;
+    /**
+     * Get directory path where the file exists
+     */
+    readFileDirectory(relativePath: string): string;
+    /**
+     * Get list of file names in directory
+     */
+    readDirectoryFileNames(relativePath?: string): Promise<string[] | Error>;
+    /**
+     * Get list of file paths in directory
+     */
+    readDirectoryFilePaths(relativePath: string): Promise<string[] | Error>;
+    /**
+     * Check if path is a directory
+     */
+    isDirectory(relativePath: string): Promise<boolean>;
+    /**
+     * Check if path is a file
+     */
+    isFile(relativePath: string): Promise<boolean>;
+    /**
+     * Check if file or directory exists
+     */
+    exists(relativePath: string): Promise<boolean>;
+    /**
+     * Check if directory exists
+     */
+    directoryExists(relativePath: string): Promise<boolean>;
+    /**
+     * Check if file exists
+     */
+    fileExists(relativePath: string): Promise<boolean>;
+    /**
+     * Get base path
+     */
+    getBasePath(): string;
+    /**
+     * Convert relative path to absolute path
+     */
+    resolve(relativePath: string): string;
+    /**
+     * Get file size in bytes
+     */
+    getFileSize(relativePath: string): Promise<number | Error>;
+    /**
+     * Get file last modified time (not available for JSON data)
+     */
+    getFileUpdatedTime(_relativePath: string): Promise<Date | Error>;
+    /**
+     * Get file creation time (not available for JSON data)
+     */
+    getFileCreatedTime(_relativePath: string): Promise<Date | Error>;
+    /**
+     * Get all file paths in the JSON data
+     */
+    getAllFilePaths(): string[];
+    /**
+     * Get the raw JSON data
+     */
+    getRawData(): JsonDocumentData$1;
+    /**
+     * Normalize path by removing leading/trailing slashes
+     */
+    private normalizePath;
+    /**
+     * Check if a file path is within a directory
+     */
+    private isFileInDirectory;
+    /**
+     * Get the relative part of a file path from a directory
+     */
+    private getRelativePartFromDirectory;
+}
+
+declare const zJsonDocumentData: z.ZodRecord<z.ZodString, z.ZodString>;
+type JsonDocumentData = z.infer<typeof zJsonDocumentData>;
+type Props = {
+    data?: JsonDocumentData | unknown;
+    basePath?: string;
+    pathSystem?: DocPathSystem;
+    reader?: DocFileSystemReadInterface;
+    onDataChange?: (data: JsonDocumentData) => void;
+};
+/**
+ * JSON-based write-only file system implementation
+ */
+declare class DocFileSystemJsonWrite implements DocFileSystemWriteInterface {
+    private data;
+    private readonly basePath;
+    private readonly pathSystem;
+    private readonly reader?;
+    private readonly onDataChange?;
+    constructor(props?: Props);
+    /**
+     * Write content to JSON data
+     */
+    writeFile(relativePath: string, content: string): Promise<Error | null>;
+    /**
+     * Delete file from JSON data
+     */
+    deleteFile(relativePath: string): Promise<Error | null>;
+    /**
+     * Create directory (creates a placeholder entry)
+     */
+    createEmptyDirectory(relativePath: string): Promise<Error | null>;
+    /**
+     * Create directory if it doesn't exist
+     */
+    createDirectory(relativePath: string): Promise<Error | null>;
+    /**
+     * Copy file within JSON data
+     */
+    copyFile(sourcePath: string, destinationPath: string): Promise<Error | null>;
+    /**
+     * Move file within JSON data
+     */
+    moveFile(sourcePath: string, destinationPath: string): Promise<Error | null>;
+    /**
+     * Get the current JSON data
+     */
+    getData(): JsonDocumentData;
+    /**
+     * Update the entire JSON data
+     */
+    setData(data: JsonDocumentData | unknown): Error | null;
+    /**
+     * Clear all data
+     */
+    clear(): void;
+    /**
+     * Get all file paths in the JSON data
+     */
+    getAllFilePaths(): string[];
+    /**
+     * Normalize path by removing leading/trailing slashes
+     */
+    private normalizePath;
+    /**
+     * Check if directory exists in data
+     */
+    private directoryExistsInData;
+    /**
+     * Notify data change callback
+     */
+    private notifyDataChange;
+}
+
+export { DocFileSystemJson, DocFileSystemJsonRead, DocFileSystemJsonWrite };