@gadgetinc/dateilager 0.1.0-rc.1

package/README.md

@@ -0,0 +1 @@
+# DateiLager JS Client

package/dist/cjs/binary-client.d.ts

@@ -0,0 +1,89 @@
+/**
+ * Options for {@link DateiLagerBinaryClient}.
+ */
+export interface DateiLagerBinaryClientOptions {
+    /**
+     * The address of the dateilager server.
+     */
+    server: string | {
+        /**
+         * The host of the dateilager server.
+         */
+        host: string;
+        /**
+         * The port of the dateilager server.
+         */
+        port: number;
+    };
+    /**
+     * The token that will be sent as authorization metadata to the dateilager server.
+     */
+    token: string | (() => Promise<string>);
+    /**
+     * The path to the dateilager-client executable.
+     *
+     * @default "dateilager-client"
+     */
+    command?: string;
+    /**
+     * The default number of milliseconds to wait before terminating the process.
+     *
+     * @default Infinity
+     */
+    timeout?: number;
+    /**
+     * Whether the dateilager binary client should enable tracing.
+     *
+     * @default false
+     */
+    tracing?: boolean;
+    /**
+     * Logging configuration.
+     */
+    logger?: {
+        /**
+         * The log level to pass to the dateilager binary client.
+         */
+        level: "debug" | "info" | "warn" | "error";
+        /**
+         * The function that will be called when the dateilager binary client logs something.
+         */
+        log: (level: "debug" | "info" | "warn" | "error", msg: string, fields: Record<string, unknown>) => void;
+    };
+}
+/**
+ * A version of the DateiLager client that uses the compiled binary client instead of the Javascript one.
+ *
+ * Useful for working directly with a real filesystem instead of in memory objects.
+ */
+export declare class DateiLagerBinaryClient {
+    /**
+     * @param  options An object with {@link DateiLagerBinaryClientOptions options}.
+     */
+    constructor(options: DateiLagerBinaryClientOptions);
+    /**
+     * Update objects in a project based on the differences in a local directory.
+     *
+     * @param    project         The id of the project.
+     * @param    directory       The path of the directory to send updates from.
+     * @param    options         Object of options.
+     * @param    options.timeout Number of milliseconds to wait before terminating the process.
+     * @returns                  The latest project id or `null` if the latest version was already checked out.
+     */
+    update(project: bigint, directory: string, options?: {
+        timeout: number;
+    }): Promise<bigint | null>;
+    /**
+     * Rebuild the local filesystem.
+     *
+     * @param    project         The id of the project.
+     * @param    to              The version of the project to rebuild the filesystem to.
+     * @param    directory       The path of the directory to rebuild the filesystem at.
+     * @param    options         Object of options.
+     * @param    options.timeout Number of milliseconds to wait before terminating the process.
+     * @returns                  The latest project id or `null` if the latest version was already checked out.
+     */
+    rebuild(project: bigint, to: bigint | null, directory: string, options?: {
+        timeout: number;
+    }): Promise<bigint | null>;
+}

package/dist/cjs/binary-client.js

@@ -0,0 +1,125 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DateiLagerBinaryClient = void 0;
+const api_1 = require("@opentelemetry/api");
+const execa_1 = __importDefault(require("execa"));
+const promises_1 = __importDefault(require("fs/promises"));
+const readline_1 = __importDefault(require("readline"));
+const telemetry_1 = require("./internal/telemetry");
+/**
+ * A version of the DateiLager client that uses the compiled binary client instead of the Javascript one.
+ *
+ * Useful for working directly with a real filesystem instead of in memory objects.
+ */
+class DateiLagerBinaryClient {
+    /**
+     * @param  options An object with {@link DateiLagerBinaryClientOptions options}.
+     */
+    constructor(options) {
+        /** @internal */
+        Object.defineProperty(this, "_options", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this._options = {
+            server: typeof options.server === "string" ? options.server : `${options.server.host}:${options.server.port}`,
+            token: typeof options.token === "string" ? () => Promise.resolve(options.token) : options.token,
+            command: options.command ?? "dateilager-client",
+            timeout: options.timeout ?? Infinity,
+            tracing: options.tracing ?? false,
+            logger: options.logger,
+        };
+    }
+    /**
+     * Update objects in a project based on the differences in a local directory.
+     *
+     * @param    project         The id of the project.
+     * @param    directory       The path of the directory to send updates from.
+     * @param    options         Object of options.
+     * @param    options.timeout Number of milliseconds to wait before terminating the process.
+     * @returns                  The latest project id or `null` if the latest version was already checked out.
+     */
+    async update(project, directory, options) {
+        return await (0, telemetry_1.trace)("dateilager-binary-client.update", {
+            attributes: {
+                "dl.project": String(project),
+                "dl.directory": directory,
+            },
+        }, async () => {
+            const result = await this._call("update", project, directory, ["-dir", directory], options);
+            if (result.stdout == "-1") {
+                return null;
+            }
+            return BigInt(result.stdout);
+        });
+    }
+    /**
+     * Rebuild the local filesystem.
+     *
+     * @param    project         The id of the project.
+     * @param    to              The version of the project to rebuild the filesystem to.
+     * @param    directory       The path of the directory to rebuild the filesystem at.
+     * @param    options         Object of options.
+     * @param    options.timeout Number of milliseconds to wait before terminating the process.
+     * @returns                  The latest project id or `null` if the latest version was already checked out.
+     */
+    async rebuild(project, to, directory, options) {
+        return await (0, telemetry_1.trace)("dateilager-binary-client.rebuild", {
+            attributes: {
+                "dl.project": String(project),
+                "dl.to": String(to),
+                "dl.directory": directory,
+            },
+        }, async () => {
+            await promises_1.default.mkdir(directory, { recursive: true });
+            const args = ["-dir", directory];
+            if (to) {
+                args.push("-to", String(to));
+            }
+            const result = await this._call("rebuild", project, directory, args, options);
+            if (result.stdout == "-1") {
+                return null;
+            }
+            return BigInt(result.stdout);
+        });
+    }
+    /** @internal */
+    async _call(method, project, cwd, args, options) {
+        const baseArgs = [method, "-project", String(project), "-server", this._options.server, "-encoding", "json"];
+        if (this._options.logger) {
+            baseArgs.push("-log", this._options.logger.level);
+        }
+        if (this._options.tracing) {
+            const carrier = {};
+            api_1.propagation.inject(api_1.context.active(), carrier);
+            const otelContext = JSON.stringify(carrier);
+            baseArgs.push("-tracing", "-otel-context", otelContext);
+        }
+        const subprocess = (0, execa_1.default)(this._options.command, baseArgs.concat(args), {
+            cwd,
+            timeout: options?.timeout ?? this._options.timeout,
+            env: { DL_TOKEN: await this._options.token() },
+        });
+        if (this._options.logger && subprocess.stderr) {
+            readline_1.default.createInterface(subprocess.stderr).on("line", (line) => {
+                try {
+                    // we purposefully extract and ignore the `ts` field
+                    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+                    const { level, msg, ts, ...fields } = JSON.parse(line);
+                    this._options.logger?.log(level, msg, fields);
+                }
+                catch (error) {
+                    this._options.logger?.log("warn", "failed to log line", { error, line });
+                }
+            });
+        }
+        return subprocess;
+    }
+}
+exports.DateiLagerBinaryClient = DateiLagerBinaryClient;
+//# sourceMappingURL=binary-client.js.map

package/dist/cjs/binary-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"binary-client.js","sourceRoot":"","sources":["../../src/binary-client.ts"],"names":[],"mappings":";;;;;;AAAA,4CAA0D;AAE1D,kDAA0B;AAC1B,2DAA6B;AAC7B,wDAAgC;AAChC,oDAA6C;AAiE7C;;;;GAIG;AACH,MAAa,sBAAsB;IAIjC;;OAEG;IACH,YAAmB,OAAsC;QANzD,gBAAgB;QAChB;;;;;WAA0B;QAMxB,IAAI,CAAC,QAAQ,GAAG;YACd,MAAM,EAAE,OAAO,OAAO,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE;YAC7G,KAAK,EAAE,OAAO,OAAO,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,KAAe,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK;YACzG,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,mBAAmB;YAC/C,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,QAAQ;YACpC,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,KAAK;YACjC,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,MAAM,CAAC,OAAe,EAAE,SAAiB,EAAE,OAA6B;QACnF,OAAO,MAAM,IAAA,iBAAK,EAChB,iCAAiC,EACjC;YACE,UAAU,EAAE;gBACV,YAAY,EAAE,MAAM,CAAC,OAAO,CAAC;gBAC7B,cAAc,EAAE,SAAS;aAC1B;SACF,EACD,KAAK,IAAI,EAAE;YACT,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;YAE5F,IAAI,MAAM,CAAC,MAAM,IAAI,IAAI,EAAE;gBACzB,OAAO,IAAI,CAAC;aACb;YAED,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC/B,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,OAAO,CAAC,OAAe,EAAE,EAAiB,EAAE,SAAiB,EAAE,OAA6B;QACvG,OAAO,MAAM,IAAA,iBAAK,EAChB,kCAAkC,EAClC;YACE,UAAU,EAAE;gBACV,YAAY,EAAE,MAAM,CAAC,OAAO,CAAC;gBAC7B,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC;gBACnB,cAAc,EAAE,SAAS;aAC1B;SACF,EACD,KAAK,IAAI,EAAE;YACT,MAAM,kBAAE,CAAC,KAAK,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAE/C,MAAM,IAAI,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;YACjC,IAAI,EAAE,EAAE;gBACN,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;aAC9B;YAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;YAC9E,IAAI,MAAM,CAAC,MAAM,IAAI,IAAI,EAAE;gBACzB,OAAO,IAAI,CAAC;aACb;YAED,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC/B,CAAC,CACF,CAAC;IACJ,CAAC;IAED,gBAAgB;IACR,KAAK,CAAC,KAAK,CACjB,MAA4B,EAC5B,OAAe,EACf,GAAW,EACX,IAAc,EACd,OAA6B;QAE7B,MAAM,QAAQ,GAAG,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC;QAE7G,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE;YACxB,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;SACnD;QAED,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE;YACzB,MAAM,OAAO,GAAG,EAAE,CAAC;YACnB,iBAAW,CAAC,MAAM,CAAC,aAAO,CAAC,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;YAC9C,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;YAE5C,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE,eAAe,EAAE,WAAW,CAAC,CAAC;SACzD;QAED,MAAM,UAAU,GAAG,IAAA,eAAK,EAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;YACrE,GAAG;YACH,OAAO,EAAE,OAAO,EAAE,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO;YAClD,GAAG,EAAE,EAAE,QAAQ,EAAE,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,EAAE;SAC/C,CAAC,CAAC;QAEH,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,IAAI,UAAU,CAAC,MAAM,EAAE;YAC7C,kBAAQ,CAAC,eAAe,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;gBAC9D,IAAI;oBACF,oDAAoD;oBACpD,6DAA6D;oBAC7D,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,EAAE,GAAG,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAKpD,CAAC;oBAEF,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;iBAC/C;gBAAC,OAAO,KAAK,EAAE;oBACd,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,oBAAoB,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;iBAC1E;YACH,CAAC,CAAC,CAAC;SACJ;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;CACF;AAvID,wDAuIC","sourcesContent":["import { context, propagation } from \"@opentelemetry/api\";\nimport type { ExecaReturnValue } from \"execa\";\nimport execa from \"execa\";\nimport fs from \"fs/promises\";\nimport readline from \"readline\";\nimport { trace } from \"./internal/telemetry\";\n\n/**\n * Options for {@link DateiLagerBinaryClient}.\n */\nexport interface DateiLagerBinaryClientOptions {\n  /**\n   * The address of the dateilager server.\n   */\n  server:\n    | string\n    | {\n        /**\n         * The host of the dateilager server.\n         */\n        host: string;\n\n        /**\n         * The port of the dateilager server.\n         */\n        port: number;\n      };\n\n  /**\n   * The token that will be sent as authorization metadata to the dateilager server.\n   */\n  token: string | (() => Promise<string>);\n\n  /**\n   * The path to the dateilager-client executable.\n   *\n   * @default \"dateilager-client\"\n   */\n  command?: string;\n\n  /**\n   * The default number of milliseconds to wait before terminating the process.\n   *\n   * @default Infinity\n   */\n  timeout?: number;\n\n  /**\n   * Whether the dateilager binary client should enable tracing.\n   *\n   * @default false\n   */\n  tracing?: boolean;\n\n  /**\n   * Logging configuration.\n   */\n  logger?: {\n    /**\n     * The log level to pass to the dateilager binary client.\n     */\n    level: \"debug\" | \"info\" | \"warn\" | \"error\";\n\n    /**\n     * The function that will be called when the dateilager binary client logs something.\n     */\n    log: (level: \"debug\" | \"info\" | \"warn\" | \"error\", msg: string, fields: Record<string, unknown>) => void;\n  };\n}\n\n/**\n * A version of the DateiLager client that uses the compiled binary client instead of the Javascript one.\n *\n * Useful for working directly with a real filesystem instead of in memory objects.\n */\nexport class DateiLagerBinaryClient {\n  /** @internal */\n  private readonly _options;\n\n  /**\n   * @param  options An object with {@link DateiLagerBinaryClientOptions options}.\n   */\n  public constructor(options: DateiLagerBinaryClientOptions) {\n    this._options = {\n      server: typeof options.server === \"string\" ? options.server : `${options.server.host}:${options.server.port}`,\n      token: typeof options.token === \"string\" ? () => Promise.resolve(options.token as string) : options.token,\n      command: options.command ?? \"dateilager-client\",\n      timeout: options.timeout ?? Infinity,\n      tracing: options.tracing ?? false,\n      logger: options.logger,\n    };\n  }\n\n  /**\n   * Update objects in a project based on the differences in a local directory.\n   *\n   * @param    project         The id of the project.\n   * @param    directory       The path of the directory to send updates from.\n   * @param    options         Object of options.\n   * @param    options.timeout Number of milliseconds to wait before terminating the process.\n   * @returns                  The latest project id or `null` if the latest version was already checked out.\n   */\n  public async update(project: bigint, directory: string, options?: { timeout: number }): Promise<bigint | null> {\n    return await trace(\n      \"dateilager-binary-client.update\",\n      {\n        attributes: {\n          \"dl.project\": String(project),\n          \"dl.directory\": directory,\n        },\n      },\n      async () => {\n        const result = await this._call(\"update\", project, directory, [\"-dir\", directory], options);\n\n        if (result.stdout == \"-1\") {\n          return null;\n        }\n\n        return BigInt(result.stdout);\n      }\n    );\n  }\n\n  /**\n   * Rebuild the local filesystem.\n   *\n   * @param    project         The id of the project.\n   * @param    to              The version of the project to rebuild the filesystem to.\n   * @param    directory       The path of the directory to rebuild the filesystem at.\n   * @param    options         Object of options.\n   * @param    options.timeout Number of milliseconds to wait before terminating the process.\n   * @returns                  The latest project id or `null` if the latest version was already checked out.\n   */\n  public async rebuild(project: bigint, to: bigint | null, directory: string, options?: { timeout: number }): Promise<bigint | null> {\n    return await trace(\n      \"dateilager-binary-client.rebuild\",\n      {\n        attributes: {\n          \"dl.project\": String(project),\n          \"dl.to\": String(to),\n          \"dl.directory\": directory,\n        },\n      },\n      async () => {\n        await fs.mkdir(directory, { recursive: true });\n\n        const args = [\"-dir\", directory];\n        if (to) {\n          args.push(\"-to\", String(to));\n        }\n\n        const result = await this._call(\"rebuild\", project, directory, args, options);\n        if (result.stdout == \"-1\") {\n          return null;\n        }\n\n        return BigInt(result.stdout);\n      }\n    );\n  }\n\n  /** @internal */\n  private async _call(\n    method: \"update\" | \"rebuild\",\n    project: bigint,\n    cwd: string,\n    args: string[],\n    options?: { timeout: number }\n  ): Promise<ExecaReturnValue> {\n    const baseArgs = [method, \"-project\", String(project), \"-server\", this._options.server, \"-encoding\", \"json\"];\n\n    if (this._options.logger) {\n      baseArgs.push(\"-log\", this._options.logger.level);\n    }\n\n    if (this._options.tracing) {\n      const carrier = {};\n      propagation.inject(context.active(), carrier);\n      const otelContext = JSON.stringify(carrier);\n\n      baseArgs.push(\"-tracing\", \"-otel-context\", otelContext);\n    }\n\n    const subprocess = execa(this._options.command, baseArgs.concat(args), {\n      cwd,\n      timeout: options?.timeout ?? this._options.timeout,\n      env: { DL_TOKEN: await this._options.token() },\n    });\n\n    if (this._options.logger && subprocess.stderr) {\n      readline.createInterface(subprocess.stderr).on(\"line\", (line) => {\n        try {\n          // we purposefully extract and ignore the `ts` field\n          // eslint-disable-next-line @typescript-eslint/no-unused-vars\n          const { level, msg, ts, ...fields } = JSON.parse(line) as {\n            [key: string]: unknown;\n            level: \"debug\" | \"info\" | \"warn\" | \"error\";\n            msg: string;\n            ts: string | number;\n          };\n\n          this._options.logger?.log(level, msg, fields);\n        } catch (error) {\n          this._options.logger?.log(\"warn\", \"failed to log line\", { error, line });\n        }\n      });\n    }\n\n    return subprocess;\n  }\n}\n"]}

package/dist/cjs/grpc-client.d.ts

@@ -0,0 +1,163 @@
+import type { ClientOptions } from "@grpc/grpc-js";
+import type { Span } from "@opentelemetry/api";
+import type { ClientStreamingCall, RpcOptions } from "@protobuf-ts/runtime-rpc";
+import type { Objekt, Project, UpdateRequest, UpdateResponse } from "./pb/fs_pb";
+/**
+ * Options for {@link DateiLagerGrpcClient}.
+ */
+export interface DateiLagerGrpcClientOptions {
+    /**
+     * The address of the dateilager server.
+     */
+    server: string | {
+        /**
+         * The host of the dateilager server.
+         */
+        host: string;
+        /**
+         * The port of the dateilager server.
+         */
+        port: number;
+    };
+    /**
+     * The token that will be sent as authorization metadata to the dateilager server.
+     */
+    token: string | (() => Promise<string>);
+    /**
+     * Options that will be passed to the underlying grpc client constructor.
+     *
+     * @see ClientOptions
+     */
+    grpcClientOptions?: ClientOptions;
+    /**
+     * Options that will be passed to every remote procedure call.
+     *
+     * @see RpcOptions
+     */
+    rpcOptions?: RpcOptions | (() => RpcOptions | undefined);
+}
+/**
+ * A client class for interacting with DateiLager's GRPC API.
+ *
+ * The DateiLager API surface area is as minimal as possible;
+ * convenience functions, such as getObject, should be implemented within the client.
+ */
+export declare class DateiLagerGrpcClient {
+    /**
+     * The library used to interact with GRPC creates connections lazily, this constructor will not
+     * raise an error even if there is no service running at {@link DateiLagerGrpcClientOptions.server server}.
+     *
+     * @param  options Grpc client options.
+     */
+    constructor(options: DateiLagerGrpcClientOptions);
+    /**
+     * Close the underlying GRPC client.
+     */
+    close(): void;
+    /**
+     * Create a new project.
+     *
+     * @param  project      The id of the project.
+     * @param  packPatterns The paths to pack.
+     * @param  template     The id of the project to start from.
+     */
+    newProject(project: bigint, packPatterns: string[], template?: bigint): Promise<void>;
+    /**
+     * Delete a project.
+     *
+     * @param  project The id of the project.
+     */
+    deleteProject(project: bigint): Promise<void>;
+    /**
+     * List objects.
+     *
+     * @param    project The id of the project.
+     * @param    path    The path to list objects under.
+     * @param    ignores The paths under {@link path} to ignore.
+     * @param    from    The project version to start from.
+     * @param    to      The project version to end at.
+     * @returns          A stream of objects.
+     * @yields           An object from the stream.
+     * @example
+     * for await (const object of client.listObjects(1n, "")) {
+     *   console.log("[listObjects] path: " + object.path);
+     *   console.log("[listObjects] content:\n" + object.content);
+     * }
+     */
+    listObjects(project: bigint, path: string, ignores?: string[], from?: bigint, to?: bigint): AsyncGenerator<Objekt, void>;
+    /**
+     * Get an object.
+     *
+     * @param    project The id of the project.
+     * @param    path    The path of the object.
+     * @returns          The object at the given path or undefined if it does not exist.
+     */
+    getObject(project: bigint, path: string): Promise<Objekt | undefined>;
+    /**
+     * Update objects.
+     *
+     * @param    project The id of the project.
+     * @returns          An {@link UpdateInputStream} to send objects to update.
+     */
+    updateObjects(project: bigint): UpdateInputStream;
+    /**
+     * Update an object.
+     *
+     * @param    project The id of the project.
+     * @param    obj     The object to update.
+     * @returns          The new project version.
+     */
+    updateObject(project: bigint, obj: Objekt): Promise<bigint | null>;
+    /**
+     * Snapshot the current state of the dateilager server.
+     *
+     * @returns  All the projects on the dateilager server.
+     * @throws If the dateilager server's DL_ENV environment variable is PROD.
+     * @see DateiLagerGrpcClient.resetToSnapshotInDevOrTests
+     */
+    snapshotInDevOrTests(): Promise<Project[]>;
+    /**
+     * Reset the given projects to their respective versions and delete any remaining projects.
+     * If no projects are provided, delete all projects.
+     *
+     * @param  projects The projects to reset.
+     * @throws If the dateilager server's DL_ENV environment variable is PROD.
+     * @see DateiLagerGrpcClient.snapshotInDevOrTests
+     */
+    resetToSnapshotInDevOrTests(projects: Project[]): Promise<void>;
+}
+/**
+ * Used to send a stream of objects to update.
+ *
+ * @see DateiLagerGrpcClient.updateObjects
+ */
+declare class UpdateInputStream {
+    constructor(project: bigint, call: ClientStreamingCall<UpdateRequest, UpdateResponse>, span: Span);
+    /**
+     * Send an object to update.
+     *
+     * @param  obj The object to update.
+     */
+    send(obj: Objekt): Promise<void>;
+    /**
+     * Complete the update request.
+     *
+     * @returns  The new project version.
+     */
+    complete(): Promise<bigint | null>;
+}
+/**
+ * Encode string object contents as an array of bytes.
+ *
+ * @param    content The string to encode.
+ * @returns          The encoded content as an array of bytes.
+ */
+export declare function encodeContent(content: string): Uint8Array;
+/**
+ * Decode an array of bytes as an object's string contents.
+ *
+ * @param    bytes The array of bytes to decode.
+ * @returns        The bytes decoded into a string.
+ */
+export declare function decodeContent(bytes: Uint8Array | undefined): string;
+export {};