@interactive-inc/docs-client 1.0.20 → 1.1.0

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

@@ -0,0 +1,173 @@
+import { D as DocFileSystem, a as DocPathSystem, b as DocFileSystemReadInterface, c as DocFileSystemWriteInterface } from './doc-file-system-BQAOBIO-.js';
+import { Octokit } from '@octokit/rest';
+
+type GitHubProps = {
+    owner: string;
+    repo: string;
+    basePath: string;
+    branch?: string;
+    token: string;
+    pathSystem?: DocPathSystem;
+};
+/**
+ * GitHub repository file system using Octokit with separate read/write components
+ */
+declare class DocFileSystemOctokit extends DocFileSystem {
+    private readonly owner;
+    private readonly repo;
+    private readonly branch;
+    constructor(props: GitHubProps);
+    /**
+     * Get repository information
+     */
+    getRepositoryInfo(): {
+        owner: string;
+        repo: string;
+        branch: string;
+    };
+}
+
+type Props$1 = {
+    owner: string;
+    repo: string;
+    basePath: string;
+    branch?: string;
+    token: string;
+    pathSystem?: DocPathSystem;
+};
+type FileCache = {
+    sha: string;
+    content: string;
+    size: number;
+    modifiedTime?: string;
+};
+/**
+ * GitHub repository read-only file system using Octokit
+ */
+declare class DocFileSystemOctokitRead implements DocFileSystemReadInterface {
+    protected readonly octokit: Octokit;
+    protected readonly owner: string;
+    protected readonly repo: string;
+    protected readonly branch: string;
+    protected readonly pathSystem: DocPathSystem;
+    protected readonly basePath: string;
+    protected fileCache: Map<string, FileCache>;
+    constructor(props: Props$1);
+    /**
+     * Read file content from GitHub repository
+     */
+    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
+     */
+    getFileModifiedTime(relativePath: string): Promise<Date | Error>;
+    /**
+     * Get file creation time (first commit)
+     */
+    getFileCreatedTime(relativePath: string): Promise<Date | Error>;
+    /**
+     * Get cached SHA for a file
+     */
+    getCachedSha(relativePath: string): string | undefined;
+}
+
+type Props = {
+    owner: string;
+    repo: string;
+    basePath: string;
+    branch?: string;
+    token: string;
+    pathSystem?: DocPathSystem;
+    reader?: DocFileSystemReadInterface;
+};
+/**
+ * GitHub repository write-only file system using Octokit
+ */
+declare class DocFileSystemOctokitWrite implements DocFileSystemWriteInterface {
+    private readonly octokit;
+    private readonly owner;
+    private readonly repo;
+    private readonly basePath;
+    private readonly branch;
+    private readonly pathSystem;
+    private readonly reader?;
+    constructor(props: Props);
+    /**
+     * Write content to file in GitHub repository
+     */
+    writeFile(relativePath: string, content: string): Promise<Error | null>;
+    /**
+     * Delete file from GitHub repository
+     */
+    deleteFile(relativePath: string): Promise<Error | null>;
+    /**
+     * Create directory by creating a .gitkeep file
+     */
+    createDirectory(relativePath: string): Promise<Error | null>;
+    /**
+     * Create directory if it doesn't exist
+     */
+    ensureDirectoryExists(relativePath: string): Promise<Error | null>;
+    /**
+     * Copy file to new location
+     */
+    copyFile(sourcePath: string, destinationPath: string): Promise<Error | null>;
+    /**
+     * Move file to new location
+     */
+    moveFile(sourcePath: string, destinationPath: string): Promise<Error | null>;
+}
+
+export { DocFileSystemOctokit, DocFileSystemOctokitRead, DocFileSystemOctokitWrite };