@statewalker/webrun-files-rpc 0.0.0-stage → 0.1.1

package/dist/client.d.ts

@@ -0,0 +1,45 @@
+import type { FileInfo, FileStats, FilesApi, ListOptions, ReadOptions } from "@statewalker/webrun-files";
+import type { FilesRpc } from "./types.js";
+export interface FilesRpcClientOptions {
+    /** The server's methods, through any transport (a stub, a proxy, the server itself). */
+    rpc: FilesRpc;
+    /** Bytes per chunk written. Default 256 KiB (keep it at most the server's `maxChunkSize`). */
+    chunkSize?: number;
+    /** Chunk requests kept in flight while reading. Default 4 (below the server's `window`). */
+    readAhead?: number;
+    /** Chunks sent and not yet acknowledged while writing. Default 4. */
+    writeAhead?: number;
+    /** Listing page size. Default 256. */
+    pageSize?: number;
+}
+/** A FilesApi whose every call goes through a FilesRpc; content moves in keyed chunks. */
+export declare class FilesRpcClient implements FilesApi {
+    #private;
+    constructor(options: FilesRpcClientOptions);
+    /**
+     * Asks for chunks 0, 1, 2, … keeping `readAhead` requests in flight, and yields them in key
+     * order whatever order the answers come in.
+     */
+    read(path: string, options?: ReadOptions): AsyncIterable<Uint8Array>;
+    /**
+     * Sends chunks of `chunkSize` bytes keyed 0, 1, 2, … with up to `writeAhead` unacknowledged,
+     * then `closeWrite` with their count; any failure aborts the write.
+     */
+    write(path: string, content: Iterable<Uint8Array> | AsyncIterable<Uint8Array>): Promise<void>;
+    /**
+     * Adds `content` to the end of `path` (creating it if it does not exist), streamed as `write`
+     * streams. The server appends through the served FilesApi's own `append`, or emulates it.
+     */
+    append(path: string, content: Iterable<Uint8Array> | AsyncIterable<Uint8Array>): Promise<void>;
+    mkdir(path: string): Promise<void>;
+    /** Pages of `pageSize`, each asked after the last path of the one before. */
+    list(path: string, options?: ListOptions): AsyncIterable<FileInfo>;
+    stats(path: string): Promise<FileStats | undefined>;
+    exists(path: string): Promise<boolean>;
+    remove(path: string): Promise<boolean>;
+    move(source: string, target: string): Promise<boolean>;
+    copy(source: string, target: string): Promise<boolean>;
+}
+/** A FilesApi over a FilesRpc. */
+export declare function newFilesRpcClient(options: FilesRpcClientOptions): FilesRpcClient;
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,QAAQ,EACR,SAAS,EACT,QAAQ,EACR,WAAW,EACX,WAAW,EACZ,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EAAE,QAAQ,EAAc,MAAM,YAAY,CAAC;AAEvD,MAAM,WAAW,qBAAqB;IACpC,wFAAwF;IACxF,GAAG,EAAE,QAAQ,CAAC;IACd,8FAA8F;IAC9F,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,4FAA4F;IAC5F,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,qEAAqE;IACrE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,sCAAsC;IACtC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAyCD,0FAA0F;AAC1F,qBAAa,cAAe,YAAW,QAAQ;;IAO7C,YAAY,OAAO,EAAE,qBAAqB,EAMzC;IAED;;;OAGG;IACI,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB,GAAG,aAAa,CAAC,UAAU,CAAC,CA4C9E;IAED;;;OAGG;IACG,KAAK,CACT,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,GAAG,aAAa,CAAC,UAAU,CAAC,GACxD,OAAO,CAAC,IAAI,CAAC,CAEf;IAED;;;OAGG;IACG,MAAM,CACV,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,GAAG,aAAa,CAAC,UAAU,CAAC,GACxD,OAAO,CAAC,IAAI,CAAC,CAEf;IAsCK,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAEvC;IAED,6EAA6E;IACtE,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB,GAAG,aAAa,CAAC,QAAQ,CAAC,CAY5E;IAED,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC,CAElD;IACD,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAErC;IACD,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAErC;IACD,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAErD;IACD,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAErD;CACF;AAED,kCAAkC;AAClC,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,qBAAqB,GAAG,cAAc,CAEhF"}

package/dist/errors.d.ts

@@ -0,0 +1,13 @@
+import type { FilesRpcErrorCode } from "./types.js";
+/**
+ * An error of the protocol itself. The code also leads the message (`UNKNOWN_STREAM: …`), since
+ * a structured clone keeps an error's name and message but not its other properties:
+ * `errorCode(e)` reads it back on the other side of a transport.
+ */
+export declare class FilesRpcError extends Error {
+    readonly code: FilesRpcErrorCode;
+    constructor(code: FilesRpcErrorCode, message: string);
+}
+/** The FilesRpcError code of an error, also after it crossed a transport; undefined otherwise. */
+export declare function errorCode(e: unknown): FilesRpcErrorCode | undefined;
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAEpD;;;;GAIG;AACH,qBAAa,aAAc,SAAQ,KAAK;IACtC,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAC;IACjC,YAAY,IAAI,EAAE,iBAAiB,EAAE,OAAO,EAAE,MAAM,EAInD;CACF;AAED,kGAAkG;AAClG,wBAAgB,SAAS,CAAC,CAAC,EAAE,OAAO,GAAG,iBAAiB,GAAG,SAAS,CAMnE"}