@poe-platform/safe-fs 0.1.727 → 0.1.729

package/dist/safe-fs/fs/memory/index.d.ts

@@ -1,62 +1,49 @@
-import type { AppendFileOptions, CopyFileOptions, DirectoryEntry, EntryComparison, FileReadHandle, FileResizeHandle, FileStat, FileSystem, FsOptions, RenameOptions, MkdirOptions, ReadDirectoryOptions, ReadFileOptions, ReadStreamOptions, RemoveOptions, FileDescriptor, OpenFileOptions, OpenReadFileOptions, OpenResizeFileOptions, WriteFileOptions, ConditionalWriteFileOptions, ConditionalRemoveFileOptions, ConditionalRemoveEntryOptions, CreateStagedFileOptions, FileStaging, PublishStagedFileOptions, PrepareDirectoryOptions, StagedFileContent } from "../../contracts/filesystem.js";
+import type { AppendFileOptions, CopyFileOptions, DirectoryEntry, EntryComparison, FileReadHandle, FileResizeHandle, FileStat, FileSystem, FileSystemCapabilities, FsOptions, ChmodOptions, RenameOptions, MkdirOptions, ReadDirectoryOptions, ReadFileOptions, ReadStreamOptions, RemoveOptions, FileDescriptor, OpenFileOptions, OpenReadFileOptions, OpenResizeFileOptions, WriteFileOptions, ConditionalWriteFileOptions, ConditionalRemoveFileOptions, ConditionalRemoveEntryOptions, ConditionalRemoveEntryReceiptOptions, CreateStagedFileOptions, FileStaging, FileStagingEntry, FileStagingResolution, PublishStagedFileOptions, PrepareDirectoryOptions, StagedFileContent } from "../../contracts/filesystem.js";
 import type { ByteSource } from "../../contracts/io.js";
+import { MemoryAllocation } from "./ledger.js";
 import { type MemoryFileSystemOptions } from "./limits.js";
 export { defaultMemoryFileSystemLimits, type MemoryFileSystemLimits, type MemoryFileSystemOptions } from "./limits.js";
+interface Metadata {
+    revision: number;
+    mode: number;
+    ino: number;
+    nlink: number;
+    atimeMs: number;
+    mtimeMs: number;
+    ctimeMs: number;
+    birthtimeMs: number;
+    references: number;
+}
+interface FileNode extends Metadata {
+    type: "file";
+    byteLength: number;
+    view: Uint8Array | undefined;
+    data: Uint8Array;
+    allocation: MemoryAllocation;
+}
+export interface ConditionalMutationBinding {
+    readonly path: string;
+    readonly parent: FileStat;
+    readonly expected: FileStat;
+    readonly ancestors: readonly FileStagingEntry[];
+}
+export declare function bindConditionalMutation<Result>(identityScope: object | symbol | undefined, binding: ConditionalMutationBinding, action: () => Promise<Result>): Promise<Result>;
 export declare class MemoryFileSystem implements FileSystem {
-    readonly capabilities: Readonly<{
-        read: true;
-        stat: true;
-        readdir: true;
-        realpath: true;
-        access: true;
-        open: true;
-        write: true;
-        append: true;
-        exclusiveCreate: true;
-        explicitDirectories: true;
-        implicitDirectories: false;
-        mkdir: true;
-        recursiveMkdir: true;
-        remove: true;
-        removeDirectory: true;
-        recursiveRemove: true;
-        rename: true;
-        atomicRenameNoReplace: true;
-        copy: true;
-        exclusiveCopy: true;
-        readlink: true;
-        truncate: true;
-        streamingAppend: true;
-        randomAccessWrite: true;
-        readOnly: false;
-        symlinks: true;
-        hardlinks: true;
-        permissions: true;
-        timestamps: true;
-        atomicRename: true;
-        atomicFileStaging: true;
-        atomicStagingAncestry: true;
-        atomicFileMutation: true;
-        atomicEntryRemoval: true;
-        atomicTreeRemoval: true;
-        atomicDirectoryMetadata: true;
-        streamingRead: true;
-        retainedRead: true;
-        readonly retainedResize: boolean;
-        streamingWrite: true;
-        readonly descriptorWriteStream: boolean;
-    }>;
+    capabilitiesFor?: NonNullable<FileSystem["capabilitiesFor"]>;
+    readonly capabilities: FileSystemCapabilities;
     private readonly identityScope;
     private nextInode;
     private readonly ledger;
     private readonly root;
     private totalBytes;
+    symlinkCount: number;
     constructor(options?: MemoryFileSystemOptions);
     compareEntry(path: string, peer: FileSystem, peerPath: string, options?: FsOptions): Promise<EntryComparison>;
     canonicalizeMissingTarget(path: string, options?: FsOptions): string | undefined;
     confineExtraction(roots: readonly string[], options?: FsOptions): Promise<FileSystem>;
     private metadata;
     private directory;
+    private addDirectoryNode;
     private addNode;
     private releaseNode;
     private releaseReference;
@@ -68,10 +55,12 @@ export declare class MemoryFileSystem implements FileSystem {
     private mode;
     private integer;
     private changed;
+    private resolveNode;
     private resolve;
     private file;
     private entry;
     private terminalDot;
+    private directoryNlink;
     private snapshot;
     private bytes;
     private allocate;
@@ -80,15 +69,25 @@ export declare class MemoryFileSystem implements FileSystem {
     private openWrite;
     private writeData;
     private writeAt;
+    writeMemoryFileFast(path: string, data: Uint8Array, append: boolean, mode: number): void;
+    writeMemoryFileInDirFast(dirPrefix: string, name: string, data: Uint8Array, append: boolean, mode: number): void;
     readFile(path: string, options?: ReadFileOptions): Promise<Uint8Array>;
     private expectEntry;
     private stagingLocations;
     createStagedFile(directoryPath: string, name: string, content: StagedFileContent, options: CreateStagedFileOptions): Promise<FileStaging>;
-    publishStagedFile(staging: FileStaging, destination: string, options: PublishStagedFileOptions): Promise<void>;
+    private retainStagingCleanup;
+    prepareDirectoryAncestry(ancestors: readonly FileStagingEntry[], options?: FsOptions): Promise<() => true>;
+    prepareStagingResolution(path: string, options?: FsOptions): Promise<FileStagingResolution>;
+    private verifyDirectoryAncestry;
+    publishStagedFile(receipt: FileStaging, destination: string, options: PublishStagedFileOptions): Promise<void>;
     removeStagedFile(staging: FileStaging, options?: FsOptions): Promise<void>;
+    private removeStagingLocations;
     prepareDirectory(path: string, options: PrepareDirectoryOptions): Promise<FileStat>;
     writeFileConditional(path: string, data: Uint8Array, options: ConditionalWriteFileOptions): Promise<FileStat>;
-    removeEntryConditional(path: string, options: ConditionalRemoveEntryOptions): Promise<void>;
+    removeEntryConditional(path: string, options: ConditionalRemoveEntryOptions & {
+        readonly returnRemainingStat?: false | undefined;
+    }): Promise<void>;
+    removeEntryConditional(path: string, options: ConditionalRemoveEntryReceiptOptions): Promise<void | FileStat>;
     removeFileConditional(path: string, options: ConditionalRemoveFileOptions): Promise<void>;
     removeTreeConditional(path: string, options: ConditionalRemoveEntryOptions): Promise<void>;
     writeFile(path: string, data: Uint8Array, options?: WriteFileOptions): Promise<void>;
@@ -98,7 +97,7 @@ export declare class MemoryFileSystem implements FileSystem {
     readdir(path: string, options?: ReadDirectoryOptions): Promise<DirectoryEntry[]>;
     mkdir(path: string, options?: MkdirOptions): Promise<void>;
     rmdir(path: string, options?: FsOptions): Promise<void>;
-    rm(path: string, options?: RemoveOptions): Promise<void>;
+    rm(path: string, options?: RemoveOptions & Partial<ConditionalMutationBinding>): Promise<void>;
     private removeLocation;
     unlink(path: string, options?: FsOptions): Promise<void>;
     rename(source: string, destination: string, options?: RenameOptions): Promise<void>;
@@ -108,7 +107,7 @@ export declare class MemoryFileSystem implements FileSystem {
     readlink(path: string, options?: FsOptions): Promise<string>;
     symlink(target: string, path: string, options?: FsOptions): Promise<void>;
     link(existingPath: string, newPath: string, options?: FsOptions): Promise<void>;
-    chmod(path: string, mode: number, options?: FsOptions): Promise<void>;
+    chmod(path: string, mode: number, options?: ChmodOptions): Promise<void>;
     utimes(path: string, atimeMs: number, mtimeMs: number, options?: FsOptions): Promise<void>;
     truncate(path: string, length?: number, options?: FsOptions): Promise<void>;
     private resizeNode;
@@ -118,3 +117,26 @@ export declare class MemoryFileSystem implements FileSystem {
     writeStream(path: string, source: ByteSource, options?: WriteFileOptions): Promise<void>;
 }
 export declare function createMemoryFileSystem(options?: MemoryFileSystemOptions | Readonly<Record<string, unknown>>): MemoryFileSystem;
+export declare class MemoryRedirectHandle {
+    readonly fs: MemoryFileSystem;
+    readonly path: string;
+    readonly node: FileNode;
+    readonly append: boolean;
+    position: number;
+    closed: boolean;
+    constructor(fs: MemoryFileSystem, path: string, node: FileNode, append: boolean);
+    writeSync(chunk: Uint8Array, signal?: AbortSignal): void;
+    close(): void;
+}
+export declare function tryOpenMemoryRedirectHandleSync(filesystem: FileSystem, path: string, append: boolean, mode: number, signal?: AbortSignal): MemoryRedirectHandle | undefined;
+export declare function utf8ByteLength(value: string): number;
+export declare function isCleanAbsolutePath(path: string): boolean;
+export declare function tryResolveMemoryDevicePath(filesystem: FileSystem, path: string, resizeCreate?: boolean): string | undefined;
+export declare function tryReadMemoryFileViewSync(filesystem: FileSystem, path: string, maxBytes?: number, signal?: AbortSignal): Uint8Array | undefined;
+export declare function tryGetMemoryDirectoryEntryNamesSync(filesystem: FileSystem, path: string): ReadonlyMap<string, {
+    readonly type: "file" | "directory" | "symlink";
+}> | undefined;
+export declare function tryWriteMemoryFileSync(filesystem: FileSystem, path: string, data: Uint8Array, append: boolean, mode: number, signal?: AbortSignal): boolean;
+export declare function tryMkdirMemorySync(filesystem: FileSystem, path: string, recursive: boolean, mode: number, signal?: AbortSignal): boolean;
+export declare function tryRmRfMemorySync(filesystem: FileSystem, path: string, signal?: AbortSignal): boolean;
+export declare function tryWriteMemoryFileInDirSync(filesystem: FileSystem, dirPrefix: string, name: string, data: Uint8Array, append: boolean, mode: number, signal?: AbortSignal): boolean;