@legit-sdk/core 0.2.1 → 0.2.2

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import { fileSave, FileWithHandle } from 'browser-fs-access';
 import * as nodeFs from 'node:fs';
 import { MakeDirectoryOptions, Mode } from 'node:fs';
 import * as memfs_lib_node_types_misc_js from 'memfs/lib/node/types/misc.js';
@@ -6,11 +7,29 @@ import { IAppendFileOptions, IStatOptions, IReadFileOptions, IWriteFileOptions,
 import { PathLike as PathLike$1 } from 'fs';
 import { IFs } from 'memfs';
 import { FsClient } from 'isomorphic-git';
-import { fileSave, FileWithHandle } from 'browser-fs-access';
+
+type LegitUser = {
+    type: string;
+    id: string;
+    name: string;
+    email: string;
+};
+type LegitAuth = {
+    getUser: () => Promise<{
+        type: string;
+        id: string;
+        name: string;
+        email: string;
+    }>;
+    signInAnonymously: () => Promise<void>;
+    getMaxAccessTokenForBranch: (branchId: string) => Promise<string | undefined>;
+    addAccessToken: (token: string) => Promise<void>;
+};
 
 type CompositeSubFsDir = Pick<IDir, "path" | "close" | "read" | typeof Symbol.asyncIterator>;
 
 type FileHandleDelegate = {
+    name: string;
     fileType: () => number;
     open: (filePath: string, flags: string, mode?: number) => Promise<CompositFsFileHandle>;
     /**
@@ -31,6 +50,7 @@ type FileHandleDelegate = {
 };
 
 type CompositeSubFs = Pick<typeof nodeFs.promises, 'access' | 'link' | 'readdir' | 'readlink' | 'unlink' | 'rename' | 'rmdir' | 'symlink'> & {
+    name: string;
     readFile(path: nodeFs.PathLike | IFileHandle, options?: IReadFileOptions | string): Promise<TDataOut>;
     stat(path: nodeFs.PathLike, opts?: IStatOptions & {
         bigint?: false;
@@ -125,6 +145,23 @@ declare class CompositeFsDir {
     get path(): string;
 }
 
+type FsOperationLogger = (args: {
+    fsName: string;
+    fd?: CompositFsFileHandle | undefined;
+    path: string;
+    operation: string;
+    operationArgs: any;
+}) => Promise<void>;
+declare const createFsOperationFileLogger: (fs: {
+    writeFile: (path: string, data: string) => Promise<void>;
+}) => (args: {
+    fsName: string;
+    fd?: CompositFsFileHandle | undefined;
+    path: string;
+    operation: string;
+    operationArgs: any;
+}) => Promise<void>;
+
 /**
  *
  * The CompositFs handles distribution of file operations to its sub filesystems and keeps track of open file handles.
@@ -191,6 +228,7 @@ declare class CompositeFs {
     /** path */
     string, number[]>;
     openFileHandles: Map<number, CompositFsFileHandle>;
+    logOperation: FsOperationLogger | undefined;
     private getNextFileDescriptor;
     constructor({ name, parentFs, storageFs, gitRoot, defaultBranch, }: {
         name: string;
@@ -199,6 +237,8 @@ declare class CompositeFs {
         gitRoot: string;
         defaultBranch?: string;
     });
+    setLoggger(logger: FsOperationLogger | undefined): void;
+    logOperationOnFileDescsriptor(fd: CompositFsFileHandle, operation: string, args: any): Promise<void>;
     getFilehandle(fd: number): CompositFsFileHandle | undefined;
     setEphemeralFilesSubFs(subFs: CompositeSubFs): void;
     setHiddenFilesSubFs(subFs: CompositeSubFs): void;
@@ -263,11 +303,62 @@ declare class CompositeFs {
     } | BufferEncoding | null): Promise<void>;
 }
 
+declare function openLegitFsWithMemoryFs(props?: Parameters<typeof openLegitFs>[0]): Promise<CompositeFs & {
+    auth: LegitAuth;
+    sync: {
+        start: () => void;
+        stop: () => void;
+        isRunning: () => boolean;
+        loadBranch: (branch: string) => Promise<void>;
+        sequentialPush: (branchesToPush: string[]) => Promise<void>;
+    };
+    setLogger(logger: FsOperationLogger | undefined): void;
+    push: (branches: string[]) => Promise<void>;
+    shareCurrentBranch: () => Promise<string>;
+    setCurrentBranch: (branch: string) => Promise<void>;
+    getCurrentBranch: () => Promise<string>;
+}>;
+/**
+ * Creates and configures a LegitFs instance with CompositeFs, GitSubFs, HiddenFileSubFs, and EphemeralSubFs.
+ */
+declare function openLegitFs({ storageFs, gitRoot, anonymousBranch, showKeepFiles, initialAuthor, serverUrl, publicKey, }: {
+    storageFs: typeof nodeFs;
+    gitRoot: string;
+    anonymousBranch?: string;
+    showKeepFiles?: boolean;
+    initialAuthor?: LegitUser;
+    serverUrl?: string;
+    publicKey?: string;
+}): Promise<CompositeFs & {
+    auth: LegitAuth;
+    sync: {
+        start: () => void;
+        stop: () => void;
+        isRunning: () => boolean;
+        loadBranch: (branch: string) => Promise<void>;
+        sequentialPush: (branchesToPush: string[]) => Promise<void>;
+    };
+    setLogger(logger: FsOperationLogger | undefined): void;
+    push: (branches: string[]) => Promise<void>;
+    shareCurrentBranch: () => Promise<string>;
+    setCurrentBranch: (branch: string) => Promise<void>;
+    getCurrentBranch: () => Promise<string>;
+}>;
+
+type FileAccess = {
+    fileSave: typeof fileSave;
+};
+declare function getLegitFsAccess(legitFs: Awaited<ReturnType<typeof openLegitFs>>): Promise<FileAccess & {
+    openFile: (filePath: string) => Promise<FileWithHandle>;
+}>;
+
 declare abstract class BaseCompositeSubFs implements CompositeSubFs {
     protected toStr(p: any): string;
     protected compositFs: CompositeFs;
     protected gitRoot: string;
-    constructor({ parentFs, gitRoot, }: {
+    name: string;
+    constructor({ name, parentFs, gitRoot, }: {
+        name: string;
         parentFs: CompositeFs;
         gitRoot: string;
     });
@@ -343,7 +434,8 @@ declare abstract class BaseCompositeSubFs implements CompositeSubFs {
  */
 declare class HiddenFileSubFs extends BaseCompositeSubFs {
     private ig;
-    constructor({ parentFs, gitRoot, hiddenFiles, }: {
+    constructor({ name, parentFs, gitRoot, hiddenFiles, }: {
+        name: string;
         parentFs: CompositeFs;
         gitRoot: string;
         hiddenFiles: string[];
@@ -381,7 +473,8 @@ declare class EphemeralSubFs extends BaseCompositeSubFs {
     private ig;
     patterns: string[];
     private normalizePath;
-    constructor({ parentFs, gitRoot, ephemeralPatterns, }: {
+    constructor({ name, parentFs, gitRoot, ephemeralPatterns, }: {
+        name: string;
         parentFs: CompositeFs;
         gitRoot: string;
         ephemeralPatterns: string[];
@@ -441,7 +534,8 @@ declare class PassThroughSubFs extends BaseCompositeSubFs {
     private openFh;
     private memFs;
     private targetFs;
-    constructor({ parentFs, gitRoot, }: {
+    constructor({ name, parentFs, gitRoot, }: {
+        name: string;
         parentFs: CompositeFs;
         gitRoot: string;
     });
@@ -650,7 +744,8 @@ declare class GitSubFs extends BaseCompositeSubFs implements CompositeSubFs {
         date: number;
         timezoneOffset: number;
     }>;
-    constructor({ parentFs, gitStorageFs, gitRoot, virtualFiles, }: {
+    constructor({ name, parentFs, gitStorageFs, gitRoot, virtualFiles, }: {
+        name: string;
         parentFs: CompositeFs;
         gitStorageFs: CompositeFs;
         gitRoot: string;
@@ -757,70 +852,13 @@ type Operation = {
 };
 declare const gitBranchOperationsVirtualFile: VirtualFileDefinition;
 
-type LegitUser = {
-    type: string;
-    id: string;
-    name: string;
-    email: string;
-};
-type LegitAuth = {
-    getUser: () => Promise<{
-        type: string;
-        id: string;
-        name: string;
-        email: string;
-    }>;
-    signInAnonymously: () => Promise<void>;
-    getMaxAccessTokenForBranch: (branchId: string) => Promise<string | undefined>;
-    addAccessToken: (token: string) => Promise<void>;
-};
-
-declare function initMemFSLegitFs(): Promise<CompositeFs & {
-    auth: LegitAuth;
-    sync: {
-        start: () => void;
-        stop: () => void;
-        isRunning: () => boolean;
-        loadBranch: (branch: string) => Promise<void>;
-        sequentialPush: (branchesToPush: string[]) => Promise<void>;
-    };
-    push: (branches: string[]) => Promise<void>;
-    shareCurrentBranch: () => Promise<string>;
-    setCurrentBranch: (branch: string) => Promise<void>;
-    getCurrentBranch: () => Promise<string>;
-}>;
-/**
- * Creates and configures a LegitFs instance with CompositeFs, GitSubFs, HiddenFileSubFs, and EphemeralSubFs.
- */
-declare function openLegitFs({ storageFs, gitRoot, anonymousBranch, showKeepFiles, initialAuthor, serverUrl, publicKey, }: {
-    storageFs: typeof nodeFs;
-    gitRoot: string;
-    anonymousBranch?: string;
-    showKeepFiles?: boolean;
-    initialAuthor?: LegitUser;
-    serverUrl?: string;
-    publicKey?: string;
-}): Promise<CompositeFs & {
-    auth: LegitAuth;
-    sync: {
-        start: () => void;
-        stop: () => void;
-        isRunning: () => boolean;
-        loadBranch: (branch: string) => Promise<void>;
-        sequentialPush: (branchesToPush: string[]) => Promise<void>;
-    };
-    push: (branches: string[]) => Promise<void>;
-    shareCurrentBranch: () => Promise<string>;
-    setCurrentBranch: (branch: string) => Promise<void>;
-    getCurrentBranch: () => Promise<string>;
-}>;
-
-declare const createLegitSyncService: ({ fs, gitRepoPath, serverUrl, auth, anonymousBranch, }: {
+declare const createLegitSyncService: ({ fs, gitRepoPath, serverUrl, auth, anonymousBranch, authHeaderPrefix, }: {
     fs: FsClient;
     gitRepoPath: string;
     serverUrl?: string;
     auth: LegitAuth;
     anonymousBranch: string;
+    authHeaderPrefix?: string;
 }) => {
     start: () => void;
     stop: () => void;
@@ -829,13 +867,6 @@ declare const createLegitSyncService: ({ fs, gitRepoPath, serverUrl, auth, anony
     sequentialPush: (branchesToPush: string[]) => Promise<void>;
 };
 
-type FileAccess = {
-    fileSave: typeof fileSave;
-};
-declare function getLegitFsAccess(legitFs: Awaited<ReturnType<typeof openLegitFs>>): Promise<FileAccess & {
-    openFile: (filePath: string) => Promise<FileWithHandle>;
-}>;
-
 type User = {
     name: string;
     email: string;
@@ -849,5 +880,5 @@ type HistoryItem = {
     author: User;
 };
 
-export { CompositeFs, EphemeralSubFs, GitSubFs, HiddenFileSubFs, PassThroughSubFs, createLegitSyncService, getLegitFsAccess, gitBranchOperationsVirtualFile, initMemFSLegitFs, openLegitFs };
-export type { HistoryItem, Operation, User };
+export { CompositeFs, EphemeralSubFs, GitSubFs, HiddenFileSubFs, PassThroughSubFs, createFsOperationFileLogger, createLegitSyncService, getLegitFsAccess, gitBranchOperationsVirtualFile, openLegitFs, openLegitFsWithMemoryFs };
+export type { FsOperationLogger, HistoryItem, Operation, User };