@legit-sdk/core 0.1.10 → 0.2.0

package/dist/index.d.ts

@@ -16,7 +16,7 @@ type FileHandleDelegate = {
     /**
      * @returns a unique number per subfs
      */
-    close: (fh: CompositFsFileHandle) => void;
+    close: (fh: CompositFsFileHandle) => Promise<void>;
     dataSync: (fh: CompositFsFileHandle) => Promise<void>;
     read: (fh: CompositFsFileHandle, buffer: Buffer | Uint8Array, offset: number, length: number, position: number) => Promise<TFileHandleReadResult>;
     appendFile: (fh: CompositFsFileHandle, data: TData, options?: IAppendFileOptions | string) => Promise<void>;
@@ -79,7 +79,8 @@ interface ICompositFsFileHandle {
  * wrap the filehandle in a SubFsFileHandle and forward all operations to there origin filesystem
  */
 declare class CompositFsFileHandle implements ICompositFsFileHandle {
-    private delegate;
+    delegate: FileHandleDelegate;
+    private compositeFs;
     get fsType(): number;
     private _subFsFileDescriptor;
     get subFsFileDescriptor(): number;
@@ -89,6 +90,7 @@ declare class CompositFsFileHandle implements ICompositFsFileHandle {
     realize(compositeFd: number): void;
     constructor(args: {
         fs: FileHandleDelegate;
+        compositeFs: CompositeFs;
         subFsFileDescriptor: number;
         parentFsFileDescriptors: number[];
     });
@@ -184,16 +186,18 @@ declare class CompositeFs {
     subFilesystems: CompositeSubFs[];
     parentFs: CompositeFs | undefined;
     name: string;
+    defaultBranch: string;
     pathToFileDescriptors: Map<
     /** path */
     string, number[]>;
     openFileHandles: Map<number, CompositFsFileHandle>;
     private getNextFileDescriptor;
-    constructor({ name, parentFs, storageFs, gitRoot, }: {
+    constructor({ name, parentFs, storageFs, gitRoot, defaultBranch, }: {
         name: string;
         parentFs: CompositeFs | undefined;
         storageFs: typeof nodeFs | undefined;
         gitRoot: string;
+        defaultBranch?: string;
     });
     getFilehandle(fd: number): CompositFsFileHandle | undefined;
     setEphemeralFilesSubFs(subFs: CompositeSubFs): void;
@@ -504,10 +508,15 @@ type VirtualFile = {
 interface VirtualFileArgs {
     cacheFs: IFs;
     filePath: string;
-    fs: CompositeFs;
     gitRoot: string;
     nodeFs?: any;
     pathParams: any;
+    author: {
+        name: string;
+        email: string;
+        date: number;
+        timezoneOffset: number;
+    };
 }
 type VirtualFileDefinition = {
     type: string;
@@ -525,6 +534,7 @@ type VirtualFileDefinition = {
     mkdir: (args: VirtualFileArgs & {
         options?: nodeFs.MakeDirectoryOptions | nodeFs.Mode | null;
     }) => Promise<void>;
+    rmdir?: (args: VirtualFileArgs) => Promise<void>;
 };
 
 /**
@@ -633,8 +643,16 @@ declare class GitSubFs extends BaseCompositeSubFs implements CompositeSubFs {
     private openFh;
     private virtualFiles;
     private legitFileNames;
-    constructor({ parentFs, gitRoot, virtualFiles, }: {
+    storageFs: CompositeFs;
+    getAuthor(): Promise<{
+        name: string;
+        email: string;
+        date: number;
+        timezoneOffset: number;
+    }>;
+    constructor({ parentFs, gitStorageFs, gitRoot, virtualFiles, }: {
         parentFs: CompositeFs;
+        gitStorageFs: CompositeFs;
         gitRoot: string;
         virtualFiles?: VirtualFileDefinition[];
     });
@@ -727,6 +745,7 @@ declare class GitSubFs extends BaseCompositeSubFs implements CompositeSubFs {
     rename(oldPath: PathLike, newPath: PathLike): Promise<void>;
     fchmod(fh: CompositFsFileHandle, mode: TMode): Promise<void>;
     unlink(path: PathLike): Promise<void>;
+    rmdir(path: PathLike, ...args: any[]): Promise<void>;
     fileType(): number;
 }
 
@@ -738,29 +757,82 @@ type Operation = {
 };
 declare const gitBranchOperationsVirtualFile: VirtualFileDefinition;
 
-declare function initLegitFs(storageFs: typeof nodeFs, gitRoot: string): Promise<CompositeFs>;
+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: typeof nodeFs, gitRoot: string): CompositeFs;
+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 createGitSyncService: ({ fs, gitRepoPath, originPrefix, corsProxy, user, password, }: {
+declare const createLegitSyncService: ({ fs, gitRepoPath, serverUrl, auth, anonymousBranch, }: {
     fs: FsClient;
     gitRepoPath: string;
-    originPrefix: string;
-    corsProxy?: string | undefined;
-    user: string;
-    password: string;
+    serverUrl?: string;
+    auth: LegitAuth;
+    anonymousBranch: string;
 }) => {
-    clone: (url: string) => Promise<void>;
     start: () => void;
     stop: () => void;
+    isRunning: () => boolean;
+    loadBranch: (branch: string) => Promise<void>;
+    sequentialPush: (branchesToPush: string[]) => Promise<void>;
 };
 
 type FileAccess = {
     fileSave: typeof fileSave;
 };
-declare function getLegitFsAccess(legitFs: ReturnType<typeof openLegitFs>): Promise<FileAccess & {
+declare function getLegitFsAccess(legitFs: Awaited<ReturnType<typeof openLegitFs>>): Promise<FileAccess & {
     openFile: (filePath: string) => Promise<FileWithHandle>;
 }>;
 
@@ -777,5 +849,5 @@ type HistoryItem = {
     author: User;
 };
 
-export { CompositeFs, EphemeralSubFs, GitSubFs, HiddenFileSubFs, PassThroughSubFs, createGitSyncService, getLegitFsAccess, gitBranchOperationsVirtualFile, initLegitFs, openLegitFs };
+export { CompositeFs, EphemeralSubFs, GitSubFs, HiddenFileSubFs, PassThroughSubFs, createLegitSyncService, getLegitFsAccess, gitBranchOperationsVirtualFile, initMemFSLegitFs, openLegitFs };
 export type { HistoryItem, Operation, User };