@gadgetinc/dateilager 0.3.4 → 0.3.6

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

@@ -131,12 +131,37 @@ export declare class DateiLagerGrpcClient {
      * This method assumes that it is always a one way clone from source to target, it does not take into account
      * the changes that have occurred in the `target` project.
      *
-     * @param source      The source project.
-     * @param target      The target project.
-     * @param version     The version of the source project to clone up to.
-     * @returns           The new version number of the target project
+     * @param source  The source project.
+     * @param target  The target project.
+     * @param version The version of the source project to clone up to.
+     * @returns         The new version number of the target project.
      */
     cloneToProject(source: bigint, target: bigint, version: bigint): Promise<CloneToProjectResponse>;
+    /**
+     * GC project.
+     *
+     * @param project The project to GC.
+     * @param keep    The amount of versions since the latest that should be kept.
+     * @param from    The starting version to GC from.
+     * @returns         The amount of objects that were GC'd.
+     */
+    gcProject(project: bigint, keep: bigint, from?: bigint): Promise<bigint>;
+    /**
+     * GC random projects.
+     *
+     * @param sample The percentage of projects to sample from.
+     * @param keep   The amount of versions since the latest that should be kept.
+     * @param from   The starting version to GC from.
+     * @returns        The amount of objects that were GC'd.
+     */
+    gcRandomProjects(sample: number, keep: bigint, from?: bigint): Promise<bigint>;
+    /**
+     * GC contents.
+     *
+     * @param sample The percentage of projects to sample from.
+     * @returns        The amount of objects that were GC'd.
+     */
+    gcContents(sample: number): Promise<bigint>;
 }
 /**
  * Used to send a stream of objects to update.

package/dist/cjs/grpc-client.js

@@ -231,10 +231,10 @@ class DateiLagerGrpcClient {
      * This method assumes that it is always a one way clone from source to target, it does not take into account
      * the changes that have occurred in the `target` project.
      *
-     * @param source      The source project.
-     * @param target      The target project.
-     * @param version     The version of the source project to clone up to.
-     * @returns           The new version number of the target project
+     * @param source  The source project.
+     * @param target  The target project.
+     * @param version The version of the source project to clone up to.
+     * @returns         The new version number of the target project.
      */
     async cloneToProject(source, target, version) {
         return await (0, telemetry_1.trace)("dateilager-grpc-client.clone-to-project", {
@@ -248,6 +248,50 @@ class DateiLagerGrpcClient {
             return call.response;
         });
     }
+    /**
+     * GC project.
+     *
+     * @param project The project to GC.
+     * @param keep    The amount of versions since the latest that should be kept.
+     * @param from    The starting version to GC from.
+     * @returns         The amount of objects that were GC'd.
+     */
+    async gcProject(project, keep, from) {
+        const call = await this._client.gcProject({
+            project: project,
+            keepVersions: keep,
+            fromVersion: from,
+        });
+        return call.response.count;
+    }
+    /**
+     * GC random projects.
+     *
+     * @param sample The percentage of projects to sample from.
+     * @param keep   The amount of versions since the latest that should be kept.
+     * @param from   The starting version to GC from.
+     * @returns        The amount of objects that were GC'd.
+     */
+    async gcRandomProjects(sample, keep, from) {
+        const call = await this._client.gcRandomProjects({
+            sample: sample,
+            keepVersions: keep,
+            fromVersion: from,
+        });
+        return call.response.count;
+    }
+    /**
+     * GC contents.
+     *
+     * @param sample The percentage of projects to sample from.
+     * @returns        The amount of objects that were GC'd.
+     */
+    async gcContents(sample) {
+        const call = await this._client.gcContents({
+            sample: sample,
+        });
+        return call.response.count;
+    }
 }
 exports.DateiLagerGrpcClient = DateiLagerGrpcClient;
 /**

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

@@ -1 +1 @@
-{"version":3,"file":"grpc-client.js","sourceRoot":"","sources":["../../src/grpc-client.ts"],"names":[],"mappings":";;;AACA,2CAA0E;AAE1E,4CAA8E;AAC9E,gEAA4D;AAE5D,+BAAgD;AAChD,oDAAqD;AAErD,oDAA6C;AA6C7C;;;;;GAKG;AACH,MAAa,oBAAoB;IAU/B;;;;;OAKG;IACH,YAAmB,OAAoC;QAfvD,gBAAgB;QAChB;;;;;WAAmC;QAEnC,gBAAgB;QAChB;;;;;WAA2C;QAE3C,gBAAgB;QAChB;;;;;WAA2D;QASzD,MAAM,OAAO,GAAG,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,CAAC;QAEnH,IAAI,CAAC,UAAU,GAAG,IAAI,8BAAa,CAAC;YAClC,IAAI,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;YAC3G,kBAAkB,EAAE,qBAAW,CAAC,yBAAyB,CACvD,4BAAkB,CAAC,SAAS,EAAE,EAC9B,qBAAW,CAAC,2BAA2B,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE;gBACtD,OAAO,EAAE;qBACN,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;oBACd,MAAM,IAAI,GAAG,IAAI,kBAAQ,EAAE,CAAC;oBAC5B,IAAI,CAAC,GAAG,CAAC,eAAe,EAAE,UAAU,KAAK,EAAE,CAAC,CAAC;oBAC7C,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBACvB,CAAC,CAAC;qBACD,KAAK,CAAC,QAAQ,CAAC,CAAC;YACrB,CAAC,CAAC,CACH;YACD,aAAa,EAAE,OAAO,CAAC,iBAAiB;SACzC,CAAC,CAAC;QAEH,IAAI,CAAC,OAAO,GAAG,IAAI,uBAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE7C,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,UAAU,YAAY,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,UAAoC,CAAC;IACtI,CAAC;IAED;;OAEG;IACI,KAAK;QACV,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;IAC1B,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,UAAU,CAAC,OAAe,EAAE,YAAsB,EAAE,QAAiB;QAChF,MAAM,IAAA,iBAAK,EACT,oCAAoC,EACpC;YACE,UAAU,EAAE;gBACV,YAAY,EAAE,MAAM,CAAC,OAAO,CAAC;gBAC7B,kBAAkB,EAAE,YAAY;gBAChC,aAAa,EAAE,MAAM,CAAC,QAAQ,CAAC;aAChC;SACF,EACD,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAC3F,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,aAAa,CAAC,OAAe;QACxC,MAAM,IAAA,iBAAK,EACT,uCAAuC,EACvC;YACE,UAAU,EAAE;gBACV,YAAY,EAAE,MAAM,CAAC,OAAO,CAAC;aAC9B;SACF,EACD,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAClE,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACI,KAAK,CAAC,CAAC,WAAW,CACvB,OAAe,EACf,IAAY,EACZ,UAAoB,EAAE,EACtB,IAAa,EACb,EAAW;QAEX,MAAM,aAAa,GAAG,aAAU,CAAC,MAAM,EAAE,CAAC;QAC1C,MAAM,IAAI,GAAG,kBAAM,CAAC,SAAS,CAC3B,qCAAqC,EACrC;YACE,UAAU,EAAE;gBACV,YAAY,EAAE,MAAM,CAAC,OAAO,CAAC;gBAC7B,SAAS,EAAE,IAAI;gBACf,YAAY,EAAE,OAAO;gBACrB,iBAAiB,EAAE,MAAM,CAAC,IAAI,CAAC;gBAC/B,eAAe,EAAE,MAAM,CAAC,EAAE,CAAC;aAC5B;SACF,EACD,aAAa,CACd,CAAC;QAEF,IAAI;YACF,MAAM,IAAI,GAAG,aAAU,CAAC,IAAI,CAAC,WAAQ,CAAC,OAAO,CAAC,aAAa,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,CACvE,IAAI,CAAC,OAAO,CAAC,GAAG,CACd;gBACE,OAAO;gBACP,WAAW,EAAE,IAAI;gBACjB,SAAS,EAAE,EAAE;gBACb,OAAO,EAAE;oBACP;wBACE,IAAI;wBACJ,OAAO;wBACP,QAAQ,EAAE,IAAI;qBACf;iBACF;aACF,EACD,IAAI,CAAC,WAAW,EAAE,CACnB,CACF,CAAC;YAEF,IAAI,KAAK,EAAE,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE;gBAC3C,IAAI,QAAQ,CAAC,MAAM,EAAE;oBACnB,MAAM,QAAQ,CAAC,MAAM,CAAC;iBACvB;aACF;YAED,MAAM,IAAI,CAAC,MAAM,CAAC;SACnB;gBAAS;YACR,IAAI,CAAC,GAAG,EAAE,CAAC;SACZ;IACH,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,SAAS,CAAC,OAAe,EAAE,IAAY;QAClD,OAAO,MAAM,IAAA,iBAAK,EAChB,mCAAmC,EACnC;YACE,UAAU,EAAE;gBACV,YAAY,EAAE,MAAM,CAAC,OAAO,CAAC;gBAC7B,SAAS,EAAE,IAAI;aAChB;SACF,EACD,KAAK,IAAI,EAAE;YACT,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAC3B;gBACE,OAAO;gBACP,OAAO,EAAE;oBACP;wBACE,IAAI;wBACJ,QAAQ,EAAE,KAAK;wBACf,OAAO,EAAE,EAAE;qBACZ;iBACF;aACF,EACD,IAAI,CAAC,WAAW,EAAE,CACnB,CAAC;YAEF,IAAI,MAA0B,CAAC;YAC/B,IAAI,KAAK,EAAE,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE;gBAC3C,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;aAC1B;YAED,MAAM,IAAI,CAAC,MAAM,CAAC;YAElB,OAAO,MAAM,CAAC;QAChB,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,aAAa,CAAC,OAAe;QAClC,MAAM,aAAa,GAAG,aAAU,CAAC,MAAM,EAAE,CAAC;QAC1C,MAAM,IAAI,GAAG,kBAAM,CAAC,SAAS,CAC3B,uCAAuC,EACvC;YACE,UAAU,EAAE;gBACV,YAAY,EAAE,MAAM,CAAC,OAAO,CAAC;aAC9B;SACF,EACD,aAAa,CACd,CAAC;QAEF,MAAM,IAAI,GAAG,aAAU,CAAC,IAAI,CAAC,WAAQ,CAAC,OAAO,CAAC,aAAa,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QAEnH,OAAO,IAAI,iBAAiB,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,YAAY,CAAC,OAAe,EAAE,GAAW;QACpD,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAC3C,MAAM,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACvB,OAAO,MAAM,MAAM,CAAC,QAAQ,EAAE,CAAC;IACjC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,oBAAoB;QAC/B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;QACjE,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;IAChC,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,2BAA2B,CAAC,QAAmB;QAC1D,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,cAAc,CAAC,MAAc,EAAE,MAAc,EAAE,OAAe;QACzE,OAAO,MAAM,IAAA,iBAAK,EAChB,yCAAyC,EACzC;YACE,UAAU,EAAE;gBACV,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC;gBAC3B,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC;gBAC3B,YAAY,EAAE,MAAM,CAAC,OAAO,CAAC;aAC9B;SACF,EACD,KAAK,IAAI,EAAE;YACT,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;YAChG,OAAO,IAAI,CAAC,QAAQ,CAAC;QACvB,CAAC,CACF,CAAC;IACJ,CAAC;CACF;AA5RD,oDA4RC;AAED;;;;GAIG;AACH,MAAM,iBAAiB;IAUrB,YAAmB,OAAe,EAAE,IAAwD,EAAE,IAAU;QATxG,gBAAgB;QAChB;;;;;WAAkC;QAElC,gBAAgB;QAChB;;;;;WAA2E;QAE3E,gBAAgB;QAChB;;;;;WAA6B;QAG3B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,IAAI,CAAC,GAAW;QAC3B,IAAI;YACF,MAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC;gBAC7B,OAAO,EAAE,IAAI,CAAC,QAAQ;gBACtB,MAAM,EAAE,GAAG;aACZ,CAAC,CAAC;SACJ;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;YACjB,MAAM,GAAG,CAAC;SACX;IACH,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,QAAQ;QACnB,IAAI;YACF,MAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;YACrC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;YAC3C,OAAO,QAAQ,CAAC,OAAO,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;SAC1D;gBAAS;YACR,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;SAClB;IACH,CAAC;CACF;AAED,MAAM,OAAO,GAAG,IAAI,kBAAW,EAAE,CAAC;AAElC;;;;;GAKG;AACH,SAAgB,aAAa,CAAC,OAAe;IAC3C,OAAO,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AACjC,CAAC;AAFD,sCAEC;AAED,MAAM,OAAO,GAAG,IAAI,kBAAW,EAAE,CAAC;AAElC;;;;;GAKG;AACH,SAAgB,aAAa,CAAC,KAA6B;IACzD,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC/B,CAAC;AAFD,sCAEC","sourcesContent":["import type { ClientOptions } from \"@grpc/grpc-js\";\nimport { ChannelCredentials, credentials, Metadata } from \"@grpc/grpc-js\";\nimport type { Span } from \"@opentelemetry/api\";\nimport { context as contextAPI, trace as traceAPI } from \"@opentelemetry/api\";\nimport { GrpcTransport } from \"@protobuf-ts/grpc-transport\";\nimport type { ClientStreamingCall, RpcOptions } from \"@protobuf-ts/runtime-rpc\";\nimport { TextDecoder, TextEncoder } from \"util\";\nimport { trace, tracer } from \"./internal/telemetry\";\nimport type { CloneToProjectResponse, Objekt, Project, UpdateRequest, UpdateResponse } from \"./pb/fs_pb\";\nimport { FsClient } from \"./pb/fs_pb.client\";\n\nexport type { Objekt, Project };\n\n/**\n * Options for {@link DateiLagerGrpcClient}.\n */\nexport interface DateiLagerGrpcClientOptions {\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   * Options that will be passed to the underlying grpc client constructor.\n   *\n   * @see ClientOptions\n   */\n  grpcClientOptions?: ClientOptions;\n\n  /**\n   * Options that will be passed to every remote procedure call.\n   *\n   * @see RpcOptions\n   */\n  rpcOptions?: RpcOptions | (() => RpcOptions | undefined);\n}\n\n/**\n * A client class for interacting with DateiLager's GRPC API.\n *\n * The DateiLager API surface area is as minimal as possible;\n * convenience functions, such as getObject, should be implemented within the client.\n */\nexport class DateiLagerGrpcClient {\n  /** @internal */\n  private readonly _client: FsClient;\n\n  /** @internal */\n  private readonly _transport: GrpcTransport;\n\n  /** @internal */\n  private readonly _rpcOptions: () => RpcOptions | undefined;\n\n  /**\n   * The library used to interact with GRPC creates connections lazily, this constructor will not\n   * raise an error even if there is no service running at {@link DateiLagerGrpcClientOptions.server server}.\n   *\n   * @param options Grpc client options.\n   */\n  public constructor(options: DateiLagerGrpcClientOptions) {\n    const tokenFn = typeof options.token === \"string\" ? () => Promise.resolve(options.token as string) : options.token;\n\n    this._transport = new GrpcTransport({\n      host: typeof options.server === \"string\" ? options.server : `${options.server.host}:${options.server.port}`,\n      channelCredentials: credentials.combineChannelCredentials(\n        ChannelCredentials.createSsl(),\n        credentials.createFromMetadataGenerator((_, callback) => {\n          tokenFn()\n            .then((token) => {\n              const meta = new Metadata();\n              meta.add(\"authorization\", `Bearer ${token}`);\n              callback(null, meta);\n            })\n            .catch(callback);\n        })\n      ),\n      clientOptions: options.grpcClientOptions,\n    });\n\n    this._client = new FsClient(this._transport);\n\n    this._rpcOptions = options.rpcOptions instanceof Function ? options.rpcOptions : () => options.rpcOptions as RpcOptions | undefined;\n  }\n\n  /**\n   * Close the underlying GRPC client.\n   */\n  public close(): void {\n    this._transport.close();\n  }\n\n  /**\n   * Create a new project.\n   *\n   * @param project      The id of the project.\n   * @param packPatterns The paths to pack.\n   * @param template     The id of the project to start from.\n   */\n  public async newProject(project: bigint, packPatterns: string[], template?: bigint): Promise<void> {\n    await trace(\n      \"dateilager-grpc-client.new-project\",\n      {\n        attributes: {\n          \"dl.project\": String(project),\n          \"dl.pack_patterns\": packPatterns,\n          \"dl.template\": String(template),\n        },\n      },\n      () => this._client.newProject({ id: project, packPatterns, template }, this._rpcOptions())\n    );\n  }\n\n  /**\n   * Delete a project.\n   *\n   * @param project The id of the project.\n   */\n  public async deleteProject(project: bigint): Promise<void> {\n    await trace(\n      \"dateilager-grpc-client.delete-project\",\n      {\n        attributes: {\n          \"dl.project\": String(project),\n        },\n      },\n      () => this._client.deleteProject({ project }, this._rpcOptions())\n    );\n  }\n\n  /**\n   * List objects.\n   *\n   * @param project The id of the project.\n   * @param path    The path to list objects under.\n   * @param ignores The paths under {@link path} to ignore.\n   * @param from    The project version to start from.\n   * @param to      The project version to end at.\n   * @returns         A stream of objects.\n   * @yields           An object from the stream.\n   * @example\n   * for await (const object of client.listObjects(1n, \"\")) {\n   *   console.log(\"[listObjects] path: \" + object.path);\n   *   console.log(\"[listObjects] content:\\n\" + object.content);\n   * }\n   */\n  public async *listObjects(\n    project: bigint,\n    path: string,\n    ignores: string[] = [],\n    from?: bigint,\n    to?: bigint\n  ): AsyncGenerator<Objekt, void> {\n    const parentContext = contextAPI.active();\n    const span = tracer.startSpan(\n      \"dateilager-grpc-client.list-objects\",\n      {\n        attributes: {\n          \"dl.project\": String(project),\n          \"dl.path\": path,\n          \"dl.ignores\": ignores,\n          \"dl.from_version\": String(from),\n          \"dl.to_version\": String(to),\n        },\n      },\n      parentContext\n    );\n\n    try {\n      const call = contextAPI.with(traceAPI.setSpan(parentContext, span), () =>\n        this._client.get(\n          {\n            project,\n            fromVersion: from,\n            toVersion: to,\n            queries: [\n              {\n                path,\n                ignores,\n                isPrefix: true,\n              },\n            ],\n          },\n          this._rpcOptions()\n        )\n      );\n\n      for await (const response of call.responses) {\n        if (response.object) {\n          yield response.object;\n        }\n      }\n\n      await call.status;\n    } finally {\n      span.end();\n    }\n  }\n\n  /**\n   * Get an object.\n   *\n   * @param project The id of the project.\n   * @param path    The path of the object.\n   * @returns         The object at the given path or undefined if it does not exist.\n   */\n  public async getObject(project: bigint, path: string): Promise<Objekt | undefined> {\n    return await trace(\n      \"dateilager-grpc-client.get-object\",\n      {\n        attributes: {\n          \"dl.project\": String(project),\n          \"dl.path\": path,\n        },\n      },\n      async () => {\n        const call = this._client.get(\n          {\n            project,\n            queries: [\n              {\n                path,\n                isPrefix: false,\n                ignores: [],\n              },\n            ],\n          },\n          this._rpcOptions()\n        );\n\n        let object: Objekt | undefined;\n        for await (const response of call.responses) {\n          object = response.object;\n        }\n\n        await call.status;\n\n        return object;\n      }\n    );\n  }\n\n  /**\n   * Update objects.\n   *\n   * @param project The id of the project.\n   * @returns         An {@link UpdateInputStream} to send objects to update.\n   */\n  public updateObjects(project: bigint): UpdateInputStream {\n    const parentContext = contextAPI.active();\n    const span = tracer.startSpan(\n      \"dateilager-grpc-client.update-objects\",\n      {\n        attributes: {\n          \"dl.project\": String(project),\n        },\n      },\n      parentContext\n    );\n\n    const call = contextAPI.with(traceAPI.setSpan(parentContext, span), () => this._client.update(this._rpcOptions()));\n\n    return new UpdateInputStream(project, call, span);\n  }\n\n  /**\n   * Update an object.\n   *\n   * @param project The id of the project.\n   * @param obj     The object to update.\n   * @returns         The latest project version or `null` if something went wrong.\n   */\n  public async updateObject(project: bigint, obj: Objekt): Promise<bigint | null> {\n    const stream = this.updateObjects(project);\n    await stream.send(obj);\n    return await stream.complete();\n  }\n\n  /**\n   * Snapshot the current state of the dateilager server.\n   *\n   * @returns All the projects on the dateilager server.\n   * @throws If the dateilager server's DL_ENV environment variable is PROD.\n   * @see DateiLagerGrpcClient.resetToSnapshotInDevOrTests\n   */\n  public async snapshotInDevOrTests(): Promise<Project[]> {\n    const call = await this._client.snapshot({}, this._rpcOptions());\n    return call.response.projects;\n  }\n\n  /**\n   * Reset the given projects to their respective versions and delete any remaining projects.\n   * If no projects are provided, delete all projects.\n   *\n   * @param projects The projects to reset.\n   * @throws If the dateilager server's DL_ENV environment variable is PROD.\n   * @see DateiLagerGrpcClient.snapshotInDevOrTests\n   */\n  public async resetToSnapshotInDevOrTests(projects: Project[]): Promise<void> {\n    await this._client.reset({ projects }, this._rpcOptions());\n  }\n\n  /**\n   * Clones the `source` projects changes (from `fromVersion` up to `toVersion`) to the `target` project.\n   * This method assumes that it is always a one way clone from source to target, it does not take into account\n   * the changes that have occurred in the `target` project.\n   *\n   * @param source      The source project.\n   * @param target      The target project.\n   * @param version     The version of the source project to clone up to.\n   * @returns           The new version number of the target project\n   */\n  public async cloneToProject(source: bigint, target: bigint, version: bigint): Promise<CloneToProjectResponse> {\n    return await trace(\n      \"dateilager-grpc-client.clone-to-project\",\n      {\n        attributes: {\n          \"dl.source\": String(source),\n          \"dl.target\": String(target),\n          \"dl.version\": String(version),\n        },\n      },\n      async () => {\n        const call = await this._client.cloneToProject({ source, target, version }, this._rpcOptions());\n        return call.response;\n      }\n    );\n  }\n}\n\n/**\n * Used to send a stream of objects to update.\n *\n * @see DateiLagerGrpcClient.updateObjects\n */\nclass UpdateInputStream {\n  /** @internal */\n  private readonly _project: bigint;\n\n  /** @internal */\n  private readonly _call: ClientStreamingCall<UpdateRequest, UpdateResponse>;\n\n  /** @internal */\n  private readonly _span: Span;\n\n  public constructor(project: bigint, call: ClientStreamingCall<UpdateRequest, UpdateResponse>, span: Span) {\n    this._project = project;\n    this._call = call;\n    this._span = span;\n  }\n\n  /**\n   * Send an object to update.\n   *\n   * @param obj The object to update.\n   */\n  public async send(obj: Objekt): Promise<void> {\n    try {\n      await this._call.requests.send({\n        project: this._project,\n        object: obj,\n      });\n    } catch (err) {\n      this._span.end();\n      throw err;\n    }\n  }\n\n  /**\n   * Complete the update request.\n   *\n   * @returns The latest project version or `null` if something went wrong.\n   */\n  public async complete(): Promise<bigint | null> {\n    try {\n      await this._call.requests.complete();\n      const response = await this._call.response;\n      return response.version != -1n ? response.version : null;\n    } finally {\n      this._span.end();\n    }\n  }\n}\n\nconst encoder = new TextEncoder();\n\n/**\n * Encode string object contents as an array of bytes.\n *\n * @param content The string to encode.\n * @returns         The encoded content as an array of bytes.\n */\nexport function encodeContent(content: string): Uint8Array {\n  return encoder.encode(content);\n}\n\nconst decoder = new TextDecoder();\n\n/**\n * Decode an array of bytes as an object's string contents.\n *\n * @param bytes The array of bytes to decode.\n * @returns       The bytes decoded into a string.\n */\nexport function decodeContent(bytes: Uint8Array | undefined): string {\n  return decoder.decode(bytes);\n}\n"]}
+{"version":3,"file":"grpc-client.js","sourceRoot":"","sources":["../../src/grpc-client.ts"],"names":[],"mappings":";;;AACA,2CAA0E;AAE1E,4CAA8E;AAC9E,gEAA4D;AAE5D,+BAAgD;AAChD,oDAAqD;AAErD,oDAA6C;AA6C7C;;;;;GAKG;AACH,MAAa,oBAAoB;IAU/B;;;;;OAKG;IACH,YAAmB,OAAoC;QAfvD,gBAAgB;QAChB;;;;;WAAmC;QAEnC,gBAAgB;QAChB;;;;;WAA2C;QAE3C,gBAAgB;QAChB;;;;;WAA2D;QASzD,MAAM,OAAO,GAAG,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,CAAC;QAEnH,IAAI,CAAC,UAAU,GAAG,IAAI,8BAAa,CAAC;YAClC,IAAI,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;YAC3G,kBAAkB,EAAE,qBAAW,CAAC,yBAAyB,CACvD,4BAAkB,CAAC,SAAS,EAAE,EAC9B,qBAAW,CAAC,2BAA2B,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE;gBACtD,OAAO,EAAE;qBACN,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;oBACd,MAAM,IAAI,GAAG,IAAI,kBAAQ,EAAE,CAAC;oBAC5B,IAAI,CAAC,GAAG,CAAC,eAAe,EAAE,UAAU,KAAK,EAAE,CAAC,CAAC;oBAC7C,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBACvB,CAAC,CAAC;qBACD,KAAK,CAAC,QAAQ,CAAC,CAAC;YACrB,CAAC,CAAC,CACH;YACD,aAAa,EAAE,OAAO,CAAC,iBAAiB;SACzC,CAAC,CAAC;QAEH,IAAI,CAAC,OAAO,GAAG,IAAI,uBAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE7C,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,UAAU,YAAY,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,UAAoC,CAAC;IACtI,CAAC;IAED;;OAEG;IACI,KAAK;QACV,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;IAC1B,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,UAAU,CAAC,OAAe,EAAE,YAAsB,EAAE,QAAiB;QAChF,MAAM,IAAA,iBAAK,EACT,oCAAoC,EACpC;YACE,UAAU,EAAE;gBACV,YAAY,EAAE,MAAM,CAAC,OAAO,CAAC;gBAC7B,kBAAkB,EAAE,YAAY;gBAChC,aAAa,EAAE,MAAM,CAAC,QAAQ,CAAC;aAChC;SACF,EACD,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAC3F,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,aAAa,CAAC,OAAe;QACxC,MAAM,IAAA,iBAAK,EACT,uCAAuC,EACvC;YACE,UAAU,EAAE;gBACV,YAAY,EAAE,MAAM,CAAC,OAAO,CAAC;aAC9B;SACF,EACD,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAClE,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACI,KAAK,CAAC,CAAC,WAAW,CACvB,OAAe,EACf,IAAY,EACZ,UAAoB,EAAE,EACtB,IAAa,EACb,EAAW;QAEX,MAAM,aAAa,GAAG,aAAU,CAAC,MAAM,EAAE,CAAC;QAC1C,MAAM,IAAI,GAAG,kBAAM,CAAC,SAAS,CAC3B,qCAAqC,EACrC;YACE,UAAU,EAAE;gBACV,YAAY,EAAE,MAAM,CAAC,OAAO,CAAC;gBAC7B,SAAS,EAAE,IAAI;gBACf,YAAY,EAAE,OAAO;gBACrB,iBAAiB,EAAE,MAAM,CAAC,IAAI,CAAC;gBAC/B,eAAe,EAAE,MAAM,CAAC,EAAE,CAAC;aAC5B;SACF,EACD,aAAa,CACd,CAAC;QAEF,IAAI;YACF,MAAM,IAAI,GAAG,aAAU,CAAC,IAAI,CAAC,WAAQ,CAAC,OAAO,CAAC,aAAa,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,CACvE,IAAI,CAAC,OAAO,CAAC,GAAG,CACd;gBACE,OAAO;gBACP,WAAW,EAAE,IAAI;gBACjB,SAAS,EAAE,EAAE;gBACb,OAAO,EAAE;oBACP;wBACE,IAAI;wBACJ,OAAO;wBACP,QAAQ,EAAE,IAAI;qBACf;iBACF;aACF,EACD,IAAI,CAAC,WAAW,EAAE,CACnB,CACF,CAAC;YAEF,IAAI,KAAK,EAAE,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE;gBAC3C,IAAI,QAAQ,CAAC,MAAM,EAAE;oBACnB,MAAM,QAAQ,CAAC,MAAM,CAAC;iBACvB;aACF;YAED,MAAM,IAAI,CAAC,MAAM,CAAC;SACnB;gBAAS;YACR,IAAI,CAAC,GAAG,EAAE,CAAC;SACZ;IACH,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,SAAS,CAAC,OAAe,EAAE,IAAY;QAClD,OAAO,MAAM,IAAA,iBAAK,EAChB,mCAAmC,EACnC;YACE,UAAU,EAAE;gBACV,YAAY,EAAE,MAAM,CAAC,OAAO,CAAC;gBAC7B,SAAS,EAAE,IAAI;aAChB;SACF,EACD,KAAK,IAAI,EAAE;YACT,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAC3B;gBACE,OAAO;gBACP,OAAO,EAAE;oBACP;wBACE,IAAI;wBACJ,QAAQ,EAAE,KAAK;wBACf,OAAO,EAAE,EAAE;qBACZ;iBACF;aACF,EACD,IAAI,CAAC,WAAW,EAAE,CACnB,CAAC;YAEF,IAAI,MAA0B,CAAC;YAC/B,IAAI,KAAK,EAAE,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE;gBAC3C,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;aAC1B;YAED,MAAM,IAAI,CAAC,MAAM,CAAC;YAElB,OAAO,MAAM,CAAC;QAChB,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,aAAa,CAAC,OAAe;QAClC,MAAM,aAAa,GAAG,aAAU,CAAC,MAAM,EAAE,CAAC;QAC1C,MAAM,IAAI,GAAG,kBAAM,CAAC,SAAS,CAC3B,uCAAuC,EACvC;YACE,UAAU,EAAE;gBACV,YAAY,EAAE,MAAM,CAAC,OAAO,CAAC;aAC9B;SACF,EACD,aAAa,CACd,CAAC;QAEF,MAAM,IAAI,GAAG,aAAU,CAAC,IAAI,CAAC,WAAQ,CAAC,OAAO,CAAC,aAAa,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QAEnH,OAAO,IAAI,iBAAiB,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,YAAY,CAAC,OAAe,EAAE,GAAW;QACpD,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAC3C,MAAM,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACvB,OAAO,MAAM,MAAM,CAAC,QAAQ,EAAE,CAAC;IACjC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,oBAAoB;QAC/B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;QACjE,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;IAChC,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,2BAA2B,CAAC,QAAmB;QAC1D,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,cAAc,CAAC,MAAc,EAAE,MAAc,EAAE,OAAe;QACzE,OAAO,MAAM,IAAA,iBAAK,EAChB,yCAAyC,EACzC;YACE,UAAU,EAAE;gBACV,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC;gBAC3B,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC;gBAC3B,YAAY,EAAE,MAAM,CAAC,OAAO,CAAC;aAC9B;SACF,EACD,KAAK,IAAI,EAAE;YACT,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;YAChG,OAAO,IAAI,CAAC,QAAQ,CAAC;QACvB,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,SAAS,CAAC,OAAe,EAAE,IAAY,EAAE,IAAa;QACjE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;YACxC,OAAO,EAAE,OAAO;YAChB,YAAY,EAAE,IAAI;YAClB,WAAW,EAAE,IAAI;SAClB,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;IAC7B,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,gBAAgB,CAAC,MAAc,EAAE,IAAY,EAAE,IAAa;QACvE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC;YAC/C,MAAM,EAAE,MAAM;YACd,YAAY,EAAE,IAAI;YAClB,WAAW,EAAE,IAAI;SAClB,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,UAAU,CAAC,MAAc;QACpC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC;YACzC,MAAM,EAAE,MAAM;SACf,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;IAC7B,CAAC;CACF;AA3UD,oDA2UC;AAED;;;;GAIG;AACH,MAAM,iBAAiB;IAUrB,YAAmB,OAAe,EAAE,IAAwD,EAAE,IAAU;QATxG,gBAAgB;QAChB;;;;;WAAkC;QAElC,gBAAgB;QAChB;;;;;WAA2E;QAE3E,gBAAgB;QAChB;;;;;WAA6B;QAG3B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,IAAI,CAAC,GAAW;QAC3B,IAAI;YACF,MAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC;gBAC7B,OAAO,EAAE,IAAI,CAAC,QAAQ;gBACtB,MAAM,EAAE,GAAG;aACZ,CAAC,CAAC;SACJ;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;YACjB,MAAM,GAAG,CAAC;SACX;IACH,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,QAAQ;QACnB,IAAI;YACF,MAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;YACrC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;YAC3C,OAAO,QAAQ,CAAC,OAAO,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;SAC1D;gBAAS;YACR,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;SAClB;IACH,CAAC;CACF;AAED,MAAM,OAAO,GAAG,IAAI,kBAAW,EAAE,CAAC;AAElC;;;;;GAKG;AACH,SAAgB,aAAa,CAAC,OAAe;IAC3C,OAAO,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AACjC,CAAC;AAFD,sCAEC;AAED,MAAM,OAAO,GAAG,IAAI,kBAAW,EAAE,CAAC;AAElC;;;;;GAKG;AACH,SAAgB,aAAa,CAAC,KAA6B;IACzD,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC/B,CAAC;AAFD,sCAEC","sourcesContent":["import type { ClientOptions } from \"@grpc/grpc-js\";\nimport { ChannelCredentials, credentials, Metadata } from \"@grpc/grpc-js\";\nimport type { Span } from \"@opentelemetry/api\";\nimport { context as contextAPI, trace as traceAPI } from \"@opentelemetry/api\";\nimport { GrpcTransport } from \"@protobuf-ts/grpc-transport\";\nimport type { ClientStreamingCall, RpcOptions } from \"@protobuf-ts/runtime-rpc\";\nimport { TextDecoder, TextEncoder } from \"util\";\nimport { trace, tracer } from \"./internal/telemetry\";\nimport type { CloneToProjectResponse, Objekt, Project, UpdateRequest, UpdateResponse } from \"./pb/fs_pb\";\nimport { FsClient } from \"./pb/fs_pb.client\";\n\nexport type { Objekt, Project };\n\n/**\n * Options for {@link DateiLagerGrpcClient}.\n */\nexport interface DateiLagerGrpcClientOptions {\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   * Options that will be passed to the underlying grpc client constructor.\n   *\n   * @see ClientOptions\n   */\n  grpcClientOptions?: ClientOptions;\n\n  /**\n   * Options that will be passed to every remote procedure call.\n   *\n   * @see RpcOptions\n   */\n  rpcOptions?: RpcOptions | (() => RpcOptions | undefined);\n}\n\n/**\n * A client class for interacting with DateiLager's GRPC API.\n *\n * The DateiLager API surface area is as minimal as possible;\n * convenience functions, such as getObject, should be implemented within the client.\n */\nexport class DateiLagerGrpcClient {\n  /** @internal */\n  private readonly _client: FsClient;\n\n  /** @internal */\n  private readonly _transport: GrpcTransport;\n\n  /** @internal */\n  private readonly _rpcOptions: () => RpcOptions | undefined;\n\n  /**\n   * The library used to interact with GRPC creates connections lazily, this constructor will not\n   * raise an error even if there is no service running at {@link DateiLagerGrpcClientOptions.server server}.\n   *\n   * @param options Grpc client options.\n   */\n  public constructor(options: DateiLagerGrpcClientOptions) {\n    const tokenFn = typeof options.token === \"string\" ? () => Promise.resolve(options.token as string) : options.token;\n\n    this._transport = new GrpcTransport({\n      host: typeof options.server === \"string\" ? options.server : `${options.server.host}:${options.server.port}`,\n      channelCredentials: credentials.combineChannelCredentials(\n        ChannelCredentials.createSsl(),\n        credentials.createFromMetadataGenerator((_, callback) => {\n          tokenFn()\n            .then((token) => {\n              const meta = new Metadata();\n              meta.add(\"authorization\", `Bearer ${token}`);\n              callback(null, meta);\n            })\n            .catch(callback);\n        })\n      ),\n      clientOptions: options.grpcClientOptions,\n    });\n\n    this._client = new FsClient(this._transport);\n\n    this._rpcOptions = options.rpcOptions instanceof Function ? options.rpcOptions : () => options.rpcOptions as RpcOptions | undefined;\n  }\n\n  /**\n   * Close the underlying GRPC client.\n   */\n  public close(): void {\n    this._transport.close();\n  }\n\n  /**\n   * Create a new project.\n   *\n   * @param project      The id of the project.\n   * @param packPatterns The paths to pack.\n   * @param template     The id of the project to start from.\n   */\n  public async newProject(project: bigint, packPatterns: string[], template?: bigint): Promise<void> {\n    await trace(\n      \"dateilager-grpc-client.new-project\",\n      {\n        attributes: {\n          \"dl.project\": String(project),\n          \"dl.pack_patterns\": packPatterns,\n          \"dl.template\": String(template),\n        },\n      },\n      () => this._client.newProject({ id: project, packPatterns, template }, this._rpcOptions())\n    );\n  }\n\n  /**\n   * Delete a project.\n   *\n   * @param project The id of the project.\n   */\n  public async deleteProject(project: bigint): Promise<void> {\n    await trace(\n      \"dateilager-grpc-client.delete-project\",\n      {\n        attributes: {\n          \"dl.project\": String(project),\n        },\n      },\n      () => this._client.deleteProject({ project }, this._rpcOptions())\n    );\n  }\n\n  /**\n   * List objects.\n   *\n   * @param project The id of the project.\n   * @param path    The path to list objects under.\n   * @param ignores The paths under {@link path} to ignore.\n   * @param from    The project version to start from.\n   * @param to      The project version to end at.\n   * @returns         A stream of objects.\n   * @yields           An object from the stream.\n   * @example\n   * for await (const object of client.listObjects(1n, \"\")) {\n   *   console.log(\"[listObjects] path: \" + object.path);\n   *   console.log(\"[listObjects] content:\\n\" + object.content);\n   * }\n   */\n  public async *listObjects(\n    project: bigint,\n    path: string,\n    ignores: string[] = [],\n    from?: bigint,\n    to?: bigint\n  ): AsyncGenerator<Objekt, void> {\n    const parentContext = contextAPI.active();\n    const span = tracer.startSpan(\n      \"dateilager-grpc-client.list-objects\",\n      {\n        attributes: {\n          \"dl.project\": String(project),\n          \"dl.path\": path,\n          \"dl.ignores\": ignores,\n          \"dl.from_version\": String(from),\n          \"dl.to_version\": String(to),\n        },\n      },\n      parentContext\n    );\n\n    try {\n      const call = contextAPI.with(traceAPI.setSpan(parentContext, span), () =>\n        this._client.get(\n          {\n            project,\n            fromVersion: from,\n            toVersion: to,\n            queries: [\n              {\n                path,\n                ignores,\n                isPrefix: true,\n              },\n            ],\n          },\n          this._rpcOptions()\n        )\n      );\n\n      for await (const response of call.responses) {\n        if (response.object) {\n          yield response.object;\n        }\n      }\n\n      await call.status;\n    } finally {\n      span.end();\n    }\n  }\n\n  /**\n   * Get an object.\n   *\n   * @param project The id of the project.\n   * @param path    The path of the object.\n   * @returns         The object at the given path or undefined if it does not exist.\n   */\n  public async getObject(project: bigint, path: string): Promise<Objekt | undefined> {\n    return await trace(\n      \"dateilager-grpc-client.get-object\",\n      {\n        attributes: {\n          \"dl.project\": String(project),\n          \"dl.path\": path,\n        },\n      },\n      async () => {\n        const call = this._client.get(\n          {\n            project,\n            queries: [\n              {\n                path,\n                isPrefix: false,\n                ignores: [],\n              },\n            ],\n          },\n          this._rpcOptions()\n        );\n\n        let object: Objekt | undefined;\n        for await (const response of call.responses) {\n          object = response.object;\n        }\n\n        await call.status;\n\n        return object;\n      }\n    );\n  }\n\n  /**\n   * Update objects.\n   *\n   * @param project The id of the project.\n   * @returns         An {@link UpdateInputStream} to send objects to update.\n   */\n  public updateObjects(project: bigint): UpdateInputStream {\n    const parentContext = contextAPI.active();\n    const span = tracer.startSpan(\n      \"dateilager-grpc-client.update-objects\",\n      {\n        attributes: {\n          \"dl.project\": String(project),\n        },\n      },\n      parentContext\n    );\n\n    const call = contextAPI.with(traceAPI.setSpan(parentContext, span), () => this._client.update(this._rpcOptions()));\n\n    return new UpdateInputStream(project, call, span);\n  }\n\n  /**\n   * Update an object.\n   *\n   * @param project The id of the project.\n   * @param obj     The object to update.\n   * @returns         The latest project version or `null` if something went wrong.\n   */\n  public async updateObject(project: bigint, obj: Objekt): Promise<bigint | null> {\n    const stream = this.updateObjects(project);\n    await stream.send(obj);\n    return await stream.complete();\n  }\n\n  /**\n   * Snapshot the current state of the dateilager server.\n   *\n   * @returns All the projects on the dateilager server.\n   * @throws If the dateilager server's DL_ENV environment variable is PROD.\n   * @see DateiLagerGrpcClient.resetToSnapshotInDevOrTests\n   */\n  public async snapshotInDevOrTests(): Promise<Project[]> {\n    const call = await this._client.snapshot({}, this._rpcOptions());\n    return call.response.projects;\n  }\n\n  /**\n   * Reset the given projects to their respective versions and delete any remaining projects.\n   * If no projects are provided, delete all projects.\n   *\n   * @param projects The projects to reset.\n   * @throws If the dateilager server's DL_ENV environment variable is PROD.\n   * @see DateiLagerGrpcClient.snapshotInDevOrTests\n   */\n  public async resetToSnapshotInDevOrTests(projects: Project[]): Promise<void> {\n    await this._client.reset({ projects }, this._rpcOptions());\n  }\n\n  /**\n   * Clones the `source` projects changes (from `fromVersion` up to `toVersion`) to the `target` project.\n   * This method assumes that it is always a one way clone from source to target, it does not take into account\n   * the changes that have occurred in the `target` project.\n   *\n   * @param source  The source project.\n   * @param target  The target project.\n   * @param version The version of the source project to clone up to.\n   * @returns         The new version number of the target project.\n   */\n  public async cloneToProject(source: bigint, target: bigint, version: bigint): Promise<CloneToProjectResponse> {\n    return await trace(\n      \"dateilager-grpc-client.clone-to-project\",\n      {\n        attributes: {\n          \"dl.source\": String(source),\n          \"dl.target\": String(target),\n          \"dl.version\": String(version),\n        },\n      },\n      async () => {\n        const call = await this._client.cloneToProject({ source, target, version }, this._rpcOptions());\n        return call.response;\n      }\n    );\n  }\n\n  /**\n   * GC project.\n   *\n   * @param project The project to GC.\n   * @param keep    The amount of versions since the latest that should be kept.\n   * @param from    The starting version to GC from.\n   * @returns         The amount of objects that were GC'd.\n   */\n  public async gcProject(project: bigint, keep: bigint, from?: bigint): Promise<bigint> {\n    const call = await this._client.gcProject({\n      project: project,\n      keepVersions: keep,\n      fromVersion: from,\n    });\n    return call.response.count;\n  }\n\n  /**\n   * GC random projects.\n   *\n   * @param sample The percentage of projects to sample from.\n   * @param keep   The amount of versions since the latest that should be kept.\n   * @param from   The starting version to GC from.\n   * @returns        The amount of objects that were GC'd.\n   */\n  public async gcRandomProjects(sample: number, keep: bigint, from?: bigint): Promise<bigint> {\n    const call = await this._client.gcRandomProjects({\n      sample: sample,\n      keepVersions: keep,\n      fromVersion: from,\n    });\n    return call.response.count;\n  }\n\n  /**\n   * GC contents.\n   *\n   * @param sample The percentage of projects to sample from.\n   * @returns        The amount of objects that were GC'd.\n   */\n  public async gcContents(sample: number): Promise<bigint> {\n    const call = await this._client.gcContents({\n      sample: sample,\n    });\n    return call.response.count;\n  }\n}\n\n/**\n * Used to send a stream of objects to update.\n *\n * @see DateiLagerGrpcClient.updateObjects\n */\nclass UpdateInputStream {\n  /** @internal */\n  private readonly _project: bigint;\n\n  /** @internal */\n  private readonly _call: ClientStreamingCall<UpdateRequest, UpdateResponse>;\n\n  /** @internal */\n  private readonly _span: Span;\n\n  public constructor(project: bigint, call: ClientStreamingCall<UpdateRequest, UpdateResponse>, span: Span) {\n    this._project = project;\n    this._call = call;\n    this._span = span;\n  }\n\n  /**\n   * Send an object to update.\n   *\n   * @param obj The object to update.\n   */\n  public async send(obj: Objekt): Promise<void> {\n    try {\n      await this._call.requests.send({\n        project: this._project,\n        object: obj,\n      });\n    } catch (err) {\n      this._span.end();\n      throw err;\n    }\n  }\n\n  /**\n   * Complete the update request.\n   *\n   * @returns The latest project version or `null` if something went wrong.\n   */\n  public async complete(): Promise<bigint | null> {\n    try {\n      await this._call.requests.complete();\n      const response = await this._call.response;\n      return response.version != -1n ? response.version : null;\n    } finally {\n      this._span.end();\n    }\n  }\n}\n\nconst encoder = new TextEncoder();\n\n/**\n * Encode string object contents as an array of bytes.\n *\n * @param content The string to encode.\n * @returns         The encoded content as an array of bytes.\n */\nexport function encodeContent(content: string): Uint8Array {\n  return encoder.encode(content);\n}\n\nconst decoder = new TextDecoder();\n\n/**\n * Decode an array of bytes as an object's string contents.\n *\n * @param bytes The array of bytes to decode.\n * @returns       The bytes decoded into a string.\n */\nexport function decodeContent(bytes: Uint8Array | undefined): string {\n  return decoder.decode(bytes);\n}\n"]}

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

@@ -131,12 +131,37 @@ export declare class DateiLagerGrpcClient {
      * This method assumes that it is always a one way clone from source to target, it does not take into account
      * the changes that have occurred in the `target` project.
      *
-     * @param source      The source project.
-     * @param target      The target project.
-     * @param version     The version of the source project to clone up to.
-     * @returns           The new version number of the target project
+     * @param source  The source project.
+     * @param target  The target project.
+     * @param version The version of the source project to clone up to.
+     * @returns         The new version number of the target project.
      */
     cloneToProject(source: bigint, target: bigint, version: bigint): Promise<CloneToProjectResponse>;
+    /**
+     * GC project.
+     *
+     * @param project The project to GC.
+     * @param keep    The amount of versions since the latest that should be kept.
+     * @param from    The starting version to GC from.
+     * @returns         The amount of objects that were GC'd.
+     */
+    gcProject(project: bigint, keep: bigint, from?: bigint): Promise<bigint>;
+    /**
+     * GC random projects.
+     *
+     * @param sample The percentage of projects to sample from.
+     * @param keep   The amount of versions since the latest that should be kept.
+     * @param from   The starting version to GC from.
+     * @returns        The amount of objects that were GC'd.
+     */
+    gcRandomProjects(sample: number, keep: bigint, from?: bigint): Promise<bigint>;
+    /**
+     * GC contents.
+     *
+     * @param sample The percentage of projects to sample from.
+     * @returns        The amount of objects that were GC'd.
+     */
+    gcContents(sample: number): Promise<bigint>;
 }
 /**
  * Used to send a stream of objects to update.

package/dist/esm/grpc-client.js

@@ -228,10 +228,10 @@ export class DateiLagerGrpcClient {
      * This method assumes that it is always a one way clone from source to target, it does not take into account
      * the changes that have occurred in the `target` project.
      *
-     * @param source      The source project.
-     * @param target      The target project.
-     * @param version     The version of the source project to clone up to.
-     * @returns           The new version number of the target project
+     * @param source  The source project.
+     * @param target  The target project.
+     * @param version The version of the source project to clone up to.
+     * @returns         The new version number of the target project.
      */
     async cloneToProject(source, target, version) {
         return await trace("dateilager-grpc-client.clone-to-project", {
@@ -245,6 +245,50 @@ export class DateiLagerGrpcClient {
             return call.response;
         });
     }
+    /**
+     * GC project.
+     *
+     * @param project The project to GC.
+     * @param keep    The amount of versions since the latest that should be kept.
+     * @param from    The starting version to GC from.
+     * @returns         The amount of objects that were GC'd.
+     */
+    async gcProject(project, keep, from) {
+        const call = await this._client.gcProject({
+            project: project,
+            keepVersions: keep,
+            fromVersion: from,
+        });
+        return call.response.count;
+    }
+    /**
+     * GC random projects.
+     *
+     * @param sample The percentage of projects to sample from.
+     * @param keep   The amount of versions since the latest that should be kept.
+     * @param from   The starting version to GC from.
+     * @returns        The amount of objects that were GC'd.
+     */
+    async gcRandomProjects(sample, keep, from) {
+        const call = await this._client.gcRandomProjects({
+            sample: sample,
+            keepVersions: keep,
+            fromVersion: from,
+        });
+        return call.response.count;
+    }
+    /**
+     * GC contents.
+     *
+     * @param sample The percentage of projects to sample from.
+     * @returns        The amount of objects that were GC'd.
+     */
+    async gcContents(sample) {
+        const call = await this._client.gcContents({
+            sample: sample,
+        });
+        return call.response.count;
+    }
 }
 /**
  * Used to send a stream of objects to update.

package/dist/esm/grpc-client.js.map

@@ -1 +1 @@
-{"version":3,"file":"grpc-client.js","sourceRoot":"","sources":["../../src/grpc-client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAE1E,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,KAAK,IAAI,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9E,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAE5D,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,MAAM,CAAC;AAChD,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAErD,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AA6C7C;;;;;GAKG;AACH,MAAM,OAAO,oBAAoB;IAU/B;;;;;OAKG;IACH,YAAmB,OAAoC;QAfvD,gBAAgB;QAChB;;;;;WAAmC;QAEnC,gBAAgB;QAChB;;;;;WAA2C;QAE3C,gBAAgB;QAChB;;;;;WAA2D;QASzD,MAAM,OAAO,GAAG,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,CAAC;QAEnH,IAAI,CAAC,UAAU,GAAG,IAAI,aAAa,CAAC;YAClC,IAAI,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;YAC3G,kBAAkB,EAAE,WAAW,CAAC,yBAAyB,CACvD,kBAAkB,CAAC,SAAS,EAAE,EAC9B,WAAW,CAAC,2BAA2B,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE;gBACtD,OAAO,EAAE;qBACN,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;oBACd,MAAM,IAAI,GAAG,IAAI,QAAQ,EAAE,CAAC;oBAC5B,IAAI,CAAC,GAAG,CAAC,eAAe,EAAE,UAAU,KAAK,EAAE,CAAC,CAAC;oBAC7C,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBACvB,CAAC,CAAC;qBACD,KAAK,CAAC,QAAQ,CAAC,CAAC;YACrB,CAAC,CAAC,CACH;YACD,aAAa,EAAE,OAAO,CAAC,iBAAiB;SACzC,CAAC,CAAC;QAEH,IAAI,CAAC,OAAO,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE7C,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,UAAU,YAAY,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,UAAoC,CAAC;IACtI,CAAC;IAED;;OAEG;IACI,KAAK;QACV,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;IAC1B,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,UAAU,CAAC,OAAe,EAAE,YAAsB,EAAE,QAAiB;QAChF,MAAM,KAAK,CACT,oCAAoC,EACpC;YACE,UAAU,EAAE;gBACV,YAAY,EAAE,MAAM,CAAC,OAAO,CAAC;gBAC7B,kBAAkB,EAAE,YAAY;gBAChC,aAAa,EAAE,MAAM,CAAC,QAAQ,CAAC;aAChC;SACF,EACD,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAC3F,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,aAAa,CAAC,OAAe;QACxC,MAAM,KAAK,CACT,uCAAuC,EACvC;YACE,UAAU,EAAE;gBACV,YAAY,EAAE,MAAM,CAAC,OAAO,CAAC;aAC9B;SACF,EACD,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAClE,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACI,KAAK,CAAC,CAAC,WAAW,CACvB,OAAe,EACf,IAAY,EACZ,UAAoB,EAAE,EACtB,IAAa,EACb,EAAW;QAEX,MAAM,aAAa,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;QAC1C,MAAM,IAAI,GAAG,MAAM,CAAC,SAAS,CAC3B,qCAAqC,EACrC;YACE,UAAU,EAAE;gBACV,YAAY,EAAE,MAAM,CAAC,OAAO,CAAC;gBAC7B,SAAS,EAAE,IAAI;gBACf,YAAY,EAAE,OAAO;gBACrB,iBAAiB,EAAE,MAAM,CAAC,IAAI,CAAC;gBAC/B,eAAe,EAAE,MAAM,CAAC,EAAE,CAAC;aAC5B;SACF,EACD,aAAa,CACd,CAAC;QAEF,IAAI;YACF,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,aAAa,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,CACvE,IAAI,CAAC,OAAO,CAAC,GAAG,CACd;gBACE,OAAO;gBACP,WAAW,EAAE,IAAI;gBACjB,SAAS,EAAE,EAAE;gBACb,OAAO,EAAE;oBACP;wBACE,IAAI;wBACJ,OAAO;wBACP,QAAQ,EAAE,IAAI;qBACf;iBACF;aACF,EACD,IAAI,CAAC,WAAW,EAAE,CACnB,CACF,CAAC;YAEF,IAAI,KAAK,EAAE,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE;gBAC3C,IAAI,QAAQ,CAAC,MAAM,EAAE;oBACnB,MAAM,QAAQ,CAAC,MAAM,CAAC;iBACvB;aACF;YAED,MAAM,IAAI,CAAC,MAAM,CAAC;SACnB;gBAAS;YACR,IAAI,CAAC,GAAG,EAAE,CAAC;SACZ;IACH,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,SAAS,CAAC,OAAe,EAAE,IAAY;QAClD,OAAO,MAAM,KAAK,CAChB,mCAAmC,EACnC;YACE,UAAU,EAAE;gBACV,YAAY,EAAE,MAAM,CAAC,OAAO,CAAC;gBAC7B,SAAS,EAAE,IAAI;aAChB;SACF,EACD,KAAK,IAAI,EAAE;YACT,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAC3B;gBACE,OAAO;gBACP,OAAO,EAAE;oBACP;wBACE,IAAI;wBACJ,QAAQ,EAAE,KAAK;wBACf,OAAO,EAAE,EAAE;qBACZ;iBACF;aACF,EACD,IAAI,CAAC,WAAW,EAAE,CACnB,CAAC;YAEF,IAAI,MAA0B,CAAC;YAC/B,IAAI,KAAK,EAAE,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE;gBAC3C,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;aAC1B;YAED,MAAM,IAAI,CAAC,MAAM,CAAC;YAElB,OAAO,MAAM,CAAC;QAChB,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,aAAa,CAAC,OAAe;QAClC,MAAM,aAAa,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;QAC1C,MAAM,IAAI,GAAG,MAAM,CAAC,SAAS,CAC3B,uCAAuC,EACvC;YACE,UAAU,EAAE;gBACV,YAAY,EAAE,MAAM,CAAC,OAAO,CAAC;aAC9B;SACF,EACD,aAAa,CACd,CAAC;QAEF,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,aAAa,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QAEnH,OAAO,IAAI,iBAAiB,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,YAAY,CAAC,OAAe,EAAE,GAAW;QACpD,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAC3C,MAAM,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACvB,OAAO,MAAM,MAAM,CAAC,QAAQ,EAAE,CAAC;IACjC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,oBAAoB;QAC/B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;QACjE,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;IAChC,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,2BAA2B,CAAC,QAAmB;QAC1D,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,cAAc,CAAC,MAAc,EAAE,MAAc,EAAE,OAAe;QACzE,OAAO,MAAM,KAAK,CAChB,yCAAyC,EACzC;YACE,UAAU,EAAE;gBACV,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC;gBAC3B,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC;gBAC3B,YAAY,EAAE,MAAM,CAAC,OAAO,CAAC;aAC9B;SACF,EACD,KAAK,IAAI,EAAE;YACT,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;YAChG,OAAO,IAAI,CAAC,QAAQ,CAAC;QACvB,CAAC,CACF,CAAC;IACJ,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,iBAAiB;IAUrB,YAAmB,OAAe,EAAE,IAAwD,EAAE,IAAU;QATxG,gBAAgB;QAChB;;;;;WAAkC;QAElC,gBAAgB;QAChB;;;;;WAA2E;QAE3E,gBAAgB;QAChB;;;;;WAA6B;QAG3B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,IAAI,CAAC,GAAW;QAC3B,IAAI;YACF,MAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC;gBAC7B,OAAO,EAAE,IAAI,CAAC,QAAQ;gBACtB,MAAM,EAAE,GAAG;aACZ,CAAC,CAAC;SACJ;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;YACjB,MAAM,GAAG,CAAC;SACX;IACH,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,QAAQ;QACnB,IAAI;YACF,MAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;YACrC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;YAC3C,OAAO,QAAQ,CAAC,OAAO,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;SAC1D;gBAAS;YACR,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;SAClB;IACH,CAAC;CACF;AAED,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;AAElC;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,OAAe;IAC3C,OAAO,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AACjC,CAAC;AAED,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;AAElC;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,KAA6B;IACzD,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC/B,CAAC","sourcesContent":["import type { ClientOptions } from \"@grpc/grpc-js\";\nimport { ChannelCredentials, credentials, Metadata } from \"@grpc/grpc-js\";\nimport type { Span } from \"@opentelemetry/api\";\nimport { context as contextAPI, trace as traceAPI } from \"@opentelemetry/api\";\nimport { GrpcTransport } from \"@protobuf-ts/grpc-transport\";\nimport type { ClientStreamingCall, RpcOptions } from \"@protobuf-ts/runtime-rpc\";\nimport { TextDecoder, TextEncoder } from \"util\";\nimport { trace, tracer } from \"./internal/telemetry\";\nimport type { CloneToProjectResponse, Objekt, Project, UpdateRequest, UpdateResponse } from \"./pb/fs_pb\";\nimport { FsClient } from \"./pb/fs_pb.client\";\n\nexport type { Objekt, Project };\n\n/**\n * Options for {@link DateiLagerGrpcClient}.\n */\nexport interface DateiLagerGrpcClientOptions {\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   * Options that will be passed to the underlying grpc client constructor.\n   *\n   * @see ClientOptions\n   */\n  grpcClientOptions?: ClientOptions;\n\n  /**\n   * Options that will be passed to every remote procedure call.\n   *\n   * @see RpcOptions\n   */\n  rpcOptions?: RpcOptions | (() => RpcOptions | undefined);\n}\n\n/**\n * A client class for interacting with DateiLager's GRPC API.\n *\n * The DateiLager API surface area is as minimal as possible;\n * convenience functions, such as getObject, should be implemented within the client.\n */\nexport class DateiLagerGrpcClient {\n  /** @internal */\n  private readonly _client: FsClient;\n\n  /** @internal */\n  private readonly _transport: GrpcTransport;\n\n  /** @internal */\n  private readonly _rpcOptions: () => RpcOptions | undefined;\n\n  /**\n   * The library used to interact with GRPC creates connections lazily, this constructor will not\n   * raise an error even if there is no service running at {@link DateiLagerGrpcClientOptions.server server}.\n   *\n   * @param options Grpc client options.\n   */\n  public constructor(options: DateiLagerGrpcClientOptions) {\n    const tokenFn = typeof options.token === \"string\" ? () => Promise.resolve(options.token as string) : options.token;\n\n    this._transport = new GrpcTransport({\n      host: typeof options.server === \"string\" ? options.server : `${options.server.host}:${options.server.port}`,\n      channelCredentials: credentials.combineChannelCredentials(\n        ChannelCredentials.createSsl(),\n        credentials.createFromMetadataGenerator((_, callback) => {\n          tokenFn()\n            .then((token) => {\n              const meta = new Metadata();\n              meta.add(\"authorization\", `Bearer ${token}`);\n              callback(null, meta);\n            })\n            .catch(callback);\n        })\n      ),\n      clientOptions: options.grpcClientOptions,\n    });\n\n    this._client = new FsClient(this._transport);\n\n    this._rpcOptions = options.rpcOptions instanceof Function ? options.rpcOptions : () => options.rpcOptions as RpcOptions | undefined;\n  }\n\n  /**\n   * Close the underlying GRPC client.\n   */\n  public close(): void {\n    this._transport.close();\n  }\n\n  /**\n   * Create a new project.\n   *\n   * @param project      The id of the project.\n   * @param packPatterns The paths to pack.\n   * @param template     The id of the project to start from.\n   */\n  public async newProject(project: bigint, packPatterns: string[], template?: bigint): Promise<void> {\n    await trace(\n      \"dateilager-grpc-client.new-project\",\n      {\n        attributes: {\n          \"dl.project\": String(project),\n          \"dl.pack_patterns\": packPatterns,\n          \"dl.template\": String(template),\n        },\n      },\n      () => this._client.newProject({ id: project, packPatterns, template }, this._rpcOptions())\n    );\n  }\n\n  /**\n   * Delete a project.\n   *\n   * @param project The id of the project.\n   */\n  public async deleteProject(project: bigint): Promise<void> {\n    await trace(\n      \"dateilager-grpc-client.delete-project\",\n      {\n        attributes: {\n          \"dl.project\": String(project),\n        },\n      },\n      () => this._client.deleteProject({ project }, this._rpcOptions())\n    );\n  }\n\n  /**\n   * List objects.\n   *\n   * @param project The id of the project.\n   * @param path    The path to list objects under.\n   * @param ignores The paths under {@link path} to ignore.\n   * @param from    The project version to start from.\n   * @param to      The project version to end at.\n   * @returns         A stream of objects.\n   * @yields           An object from the stream.\n   * @example\n   * for await (const object of client.listObjects(1n, \"\")) {\n   *   console.log(\"[listObjects] path: \" + object.path);\n   *   console.log(\"[listObjects] content:\\n\" + object.content);\n   * }\n   */\n  public async *listObjects(\n    project: bigint,\n    path: string,\n    ignores: string[] = [],\n    from?: bigint,\n    to?: bigint\n  ): AsyncGenerator<Objekt, void> {\n    const parentContext = contextAPI.active();\n    const span = tracer.startSpan(\n      \"dateilager-grpc-client.list-objects\",\n      {\n        attributes: {\n          \"dl.project\": String(project),\n          \"dl.path\": path,\n          \"dl.ignores\": ignores,\n          \"dl.from_version\": String(from),\n          \"dl.to_version\": String(to),\n        },\n      },\n      parentContext\n    );\n\n    try {\n      const call = contextAPI.with(traceAPI.setSpan(parentContext, span), () =>\n        this._client.get(\n          {\n            project,\n            fromVersion: from,\n            toVersion: to,\n            queries: [\n              {\n                path,\n                ignores,\n                isPrefix: true,\n              },\n            ],\n          },\n          this._rpcOptions()\n        )\n      );\n\n      for await (const response of call.responses) {\n        if (response.object) {\n          yield response.object;\n        }\n      }\n\n      await call.status;\n    } finally {\n      span.end();\n    }\n  }\n\n  /**\n   * Get an object.\n   *\n   * @param project The id of the project.\n   * @param path    The path of the object.\n   * @returns         The object at the given path or undefined if it does not exist.\n   */\n  public async getObject(project: bigint, path: string): Promise<Objekt | undefined> {\n    return await trace(\n      \"dateilager-grpc-client.get-object\",\n      {\n        attributes: {\n          \"dl.project\": String(project),\n          \"dl.path\": path,\n        },\n      },\n      async () => {\n        const call = this._client.get(\n          {\n            project,\n            queries: [\n              {\n                path,\n                isPrefix: false,\n                ignores: [],\n              },\n            ],\n          },\n          this._rpcOptions()\n        );\n\n        let object: Objekt | undefined;\n        for await (const response of call.responses) {\n          object = response.object;\n        }\n\n        await call.status;\n\n        return object;\n      }\n    );\n  }\n\n  /**\n   * Update objects.\n   *\n   * @param project The id of the project.\n   * @returns         An {@link UpdateInputStream} to send objects to update.\n   */\n  public updateObjects(project: bigint): UpdateInputStream {\n    const parentContext = contextAPI.active();\n    const span = tracer.startSpan(\n      \"dateilager-grpc-client.update-objects\",\n      {\n        attributes: {\n          \"dl.project\": String(project),\n        },\n      },\n      parentContext\n    );\n\n    const call = contextAPI.with(traceAPI.setSpan(parentContext, span), () => this._client.update(this._rpcOptions()));\n\n    return new UpdateInputStream(project, call, span);\n  }\n\n  /**\n   * Update an object.\n   *\n   * @param project The id of the project.\n   * @param obj     The object to update.\n   * @returns         The latest project version or `null` if something went wrong.\n   */\n  public async updateObject(project: bigint, obj: Objekt): Promise<bigint | null> {\n    const stream = this.updateObjects(project);\n    await stream.send(obj);\n    return await stream.complete();\n  }\n\n  /**\n   * Snapshot the current state of the dateilager server.\n   *\n   * @returns All the projects on the dateilager server.\n   * @throws If the dateilager server's DL_ENV environment variable is PROD.\n   * @see DateiLagerGrpcClient.resetToSnapshotInDevOrTests\n   */\n  public async snapshotInDevOrTests(): Promise<Project[]> {\n    const call = await this._client.snapshot({}, this._rpcOptions());\n    return call.response.projects;\n  }\n\n  /**\n   * Reset the given projects to their respective versions and delete any remaining projects.\n   * If no projects are provided, delete all projects.\n   *\n   * @param projects The projects to reset.\n   * @throws If the dateilager server's DL_ENV environment variable is PROD.\n   * @see DateiLagerGrpcClient.snapshotInDevOrTests\n   */\n  public async resetToSnapshotInDevOrTests(projects: Project[]): Promise<void> {\n    await this._client.reset({ projects }, this._rpcOptions());\n  }\n\n  /**\n   * Clones the `source` projects changes (from `fromVersion` up to `toVersion`) to the `target` project.\n   * This method assumes that it is always a one way clone from source to target, it does not take into account\n   * the changes that have occurred in the `target` project.\n   *\n   * @param source      The source project.\n   * @param target      The target project.\n   * @param version     The version of the source project to clone up to.\n   * @returns           The new version number of the target project\n   */\n  public async cloneToProject(source: bigint, target: bigint, version: bigint): Promise<CloneToProjectResponse> {\n    return await trace(\n      \"dateilager-grpc-client.clone-to-project\",\n      {\n        attributes: {\n          \"dl.source\": String(source),\n          \"dl.target\": String(target),\n          \"dl.version\": String(version),\n        },\n      },\n      async () => {\n        const call = await this._client.cloneToProject({ source, target, version }, this._rpcOptions());\n        return call.response;\n      }\n    );\n  }\n}\n\n/**\n * Used to send a stream of objects to update.\n *\n * @see DateiLagerGrpcClient.updateObjects\n */\nclass UpdateInputStream {\n  /** @internal */\n  private readonly _project: bigint;\n\n  /** @internal */\n  private readonly _call: ClientStreamingCall<UpdateRequest, UpdateResponse>;\n\n  /** @internal */\n  private readonly _span: Span;\n\n  public constructor(project: bigint, call: ClientStreamingCall<UpdateRequest, UpdateResponse>, span: Span) {\n    this._project = project;\n    this._call = call;\n    this._span = span;\n  }\n\n  /**\n   * Send an object to update.\n   *\n   * @param obj The object to update.\n   */\n  public async send(obj: Objekt): Promise<void> {\n    try {\n      await this._call.requests.send({\n        project: this._project,\n        object: obj,\n      });\n    } catch (err) {\n      this._span.end();\n      throw err;\n    }\n  }\n\n  /**\n   * Complete the update request.\n   *\n   * @returns The latest project version or `null` if something went wrong.\n   */\n  public async complete(): Promise<bigint | null> {\n    try {\n      await this._call.requests.complete();\n      const response = await this._call.response;\n      return response.version != -1n ? response.version : null;\n    } finally {\n      this._span.end();\n    }\n  }\n}\n\nconst encoder = new TextEncoder();\n\n/**\n * Encode string object contents as an array of bytes.\n *\n * @param content The string to encode.\n * @returns         The encoded content as an array of bytes.\n */\nexport function encodeContent(content: string): Uint8Array {\n  return encoder.encode(content);\n}\n\nconst decoder = new TextDecoder();\n\n/**\n * Decode an array of bytes as an object's string contents.\n *\n * @param bytes The array of bytes to decode.\n * @returns       The bytes decoded into a string.\n */\nexport function decodeContent(bytes: Uint8Array | undefined): string {\n  return decoder.decode(bytes);\n}\n"]}
+{"version":3,"file":"grpc-client.js","sourceRoot":"","sources":["../../src/grpc-client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAE1E,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,KAAK,IAAI,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9E,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAE5D,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,MAAM,CAAC;AAChD,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAErD,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AA6C7C;;;;;GAKG;AACH,MAAM,OAAO,oBAAoB;IAU/B;;;;;OAKG;IACH,YAAmB,OAAoC;QAfvD,gBAAgB;QAChB;;;;;WAAmC;QAEnC,gBAAgB;QAChB;;;;;WAA2C;QAE3C,gBAAgB;QAChB;;;;;WAA2D;QASzD,MAAM,OAAO,GAAG,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,CAAC;QAEnH,IAAI,CAAC,UAAU,GAAG,IAAI,aAAa,CAAC;YAClC,IAAI,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;YAC3G,kBAAkB,EAAE,WAAW,CAAC,yBAAyB,CACvD,kBAAkB,CAAC,SAAS,EAAE,EAC9B,WAAW,CAAC,2BAA2B,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE;gBACtD,OAAO,EAAE;qBACN,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;oBACd,MAAM,IAAI,GAAG,IAAI,QAAQ,EAAE,CAAC;oBAC5B,IAAI,CAAC,GAAG,CAAC,eAAe,EAAE,UAAU,KAAK,EAAE,CAAC,CAAC;oBAC7C,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBACvB,CAAC,CAAC;qBACD,KAAK,CAAC,QAAQ,CAAC,CAAC;YACrB,CAAC,CAAC,CACH;YACD,aAAa,EAAE,OAAO,CAAC,iBAAiB;SACzC,CAAC,CAAC;QAEH,IAAI,CAAC,OAAO,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE7C,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,UAAU,YAAY,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,UAAoC,CAAC;IACtI,CAAC;IAED;;OAEG;IACI,KAAK;QACV,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;IAC1B,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,UAAU,CAAC,OAAe,EAAE,YAAsB,EAAE,QAAiB;QAChF,MAAM,KAAK,CACT,oCAAoC,EACpC;YACE,UAAU,EAAE;gBACV,YAAY,EAAE,MAAM,CAAC,OAAO,CAAC;gBAC7B,kBAAkB,EAAE,YAAY;gBAChC,aAAa,EAAE,MAAM,CAAC,QAAQ,CAAC;aAChC;SACF,EACD,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAC3F,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,aAAa,CAAC,OAAe;QACxC,MAAM,KAAK,CACT,uCAAuC,EACvC;YACE,UAAU,EAAE;gBACV,YAAY,EAAE,MAAM,CAAC,OAAO,CAAC;aAC9B;SACF,EACD,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAClE,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACI,KAAK,CAAC,CAAC,WAAW,CACvB,OAAe,EACf,IAAY,EACZ,UAAoB,EAAE,EACtB,IAAa,EACb,EAAW;QAEX,MAAM,aAAa,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;QAC1C,MAAM,IAAI,GAAG,MAAM,CAAC,SAAS,CAC3B,qCAAqC,EACrC;YACE,UAAU,EAAE;gBACV,YAAY,EAAE,MAAM,CAAC,OAAO,CAAC;gBAC7B,SAAS,EAAE,IAAI;gBACf,YAAY,EAAE,OAAO;gBACrB,iBAAiB,EAAE,MAAM,CAAC,IAAI,CAAC;gBAC/B,eAAe,EAAE,MAAM,CAAC,EAAE,CAAC;aAC5B;SACF,EACD,aAAa,CACd,CAAC;QAEF,IAAI;YACF,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,aAAa,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,CACvE,IAAI,CAAC,OAAO,CAAC,GAAG,CACd;gBACE,OAAO;gBACP,WAAW,EAAE,IAAI;gBACjB,SAAS,EAAE,EAAE;gBACb,OAAO,EAAE;oBACP;wBACE,IAAI;wBACJ,OAAO;wBACP,QAAQ,EAAE,IAAI;qBACf;iBACF;aACF,EACD,IAAI,CAAC,WAAW,EAAE,CACnB,CACF,CAAC;YAEF,IAAI,KAAK,EAAE,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE;gBAC3C,IAAI,QAAQ,CAAC,MAAM,EAAE;oBACnB,MAAM,QAAQ,CAAC,MAAM,CAAC;iBACvB;aACF;YAED,MAAM,IAAI,CAAC,MAAM,CAAC;SACnB;gBAAS;YACR,IAAI,CAAC,GAAG,EAAE,CAAC;SACZ;IACH,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,SAAS,CAAC,OAAe,EAAE,IAAY;QAClD,OAAO,MAAM,KAAK,CAChB,mCAAmC,EACnC;YACE,UAAU,EAAE;gBACV,YAAY,EAAE,MAAM,CAAC,OAAO,CAAC;gBAC7B,SAAS,EAAE,IAAI;aAChB;SACF,EACD,KAAK,IAAI,EAAE;YACT,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAC3B;gBACE,OAAO;gBACP,OAAO,EAAE;oBACP;wBACE,IAAI;wBACJ,QAAQ,EAAE,KAAK;wBACf,OAAO,EAAE,EAAE;qBACZ;iBACF;aACF,EACD,IAAI,CAAC,WAAW,EAAE,CACnB,CAAC;YAEF,IAAI,MAA0B,CAAC;YAC/B,IAAI,KAAK,EAAE,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE;gBAC3C,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;aAC1B;YAED,MAAM,IAAI,CAAC,MAAM,CAAC;YAElB,OAAO,MAAM,CAAC;QAChB,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,aAAa,CAAC,OAAe;QAClC,MAAM,aAAa,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;QAC1C,MAAM,IAAI,GAAG,MAAM,CAAC,SAAS,CAC3B,uCAAuC,EACvC;YACE,UAAU,EAAE;gBACV,YAAY,EAAE,MAAM,CAAC,OAAO,CAAC;aAC9B;SACF,EACD,aAAa,CACd,CAAC;QAEF,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,aAAa,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QAEnH,OAAO,IAAI,iBAAiB,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,YAAY,CAAC,OAAe,EAAE,GAAW;QACpD,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAC3C,MAAM,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACvB,OAAO,MAAM,MAAM,CAAC,QAAQ,EAAE,CAAC;IACjC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,oBAAoB;QAC/B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;QACjE,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;IAChC,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,2BAA2B,CAAC,QAAmB;QAC1D,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,cAAc,CAAC,MAAc,EAAE,MAAc,EAAE,OAAe;QACzE,OAAO,MAAM,KAAK,CAChB,yCAAyC,EACzC;YACE,UAAU,EAAE;gBACV,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC;gBAC3B,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC;gBAC3B,YAAY,EAAE,MAAM,CAAC,OAAO,CAAC;aAC9B;SACF,EACD,KAAK,IAAI,EAAE;YACT,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;YAChG,OAAO,IAAI,CAAC,QAAQ,CAAC;QACvB,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,SAAS,CAAC,OAAe,EAAE,IAAY,EAAE,IAAa;QACjE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;YACxC,OAAO,EAAE,OAAO;YAChB,YAAY,EAAE,IAAI;YAClB,WAAW,EAAE,IAAI;SAClB,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;IAC7B,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,gBAAgB,CAAC,MAAc,EAAE,IAAY,EAAE,IAAa;QACvE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC;YAC/C,MAAM,EAAE,MAAM;YACd,YAAY,EAAE,IAAI;YAClB,WAAW,EAAE,IAAI;SAClB,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,UAAU,CAAC,MAAc;QACpC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC;YACzC,MAAM,EAAE,MAAM;SACf,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;IAC7B,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,iBAAiB;IAUrB,YAAmB,OAAe,EAAE,IAAwD,EAAE,IAAU;QATxG,gBAAgB;QAChB;;;;;WAAkC;QAElC,gBAAgB;QAChB;;;;;WAA2E;QAE3E,gBAAgB;QAChB;;;;;WAA6B;QAG3B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,IAAI,CAAC,GAAW;QAC3B,IAAI;YACF,MAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC;gBAC7B,OAAO,EAAE,IAAI,CAAC,QAAQ;gBACtB,MAAM,EAAE,GAAG;aACZ,CAAC,CAAC;SACJ;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;YACjB,MAAM,GAAG,CAAC;SACX;IACH,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,QAAQ;QACnB,IAAI;YACF,MAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;YACrC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;YAC3C,OAAO,QAAQ,CAAC,OAAO,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;SAC1D;gBAAS;YACR,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;SAClB;IACH,CAAC;CACF;AAED,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;AAElC;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,OAAe;IAC3C,OAAO,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AACjC,CAAC;AAED,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;AAElC;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,KAA6B;IACzD,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC/B,CAAC","sourcesContent":["import type { ClientOptions } from \"@grpc/grpc-js\";\nimport { ChannelCredentials, credentials, Metadata } from \"@grpc/grpc-js\";\nimport type { Span } from \"@opentelemetry/api\";\nimport { context as contextAPI, trace as traceAPI } from \"@opentelemetry/api\";\nimport { GrpcTransport } from \"@protobuf-ts/grpc-transport\";\nimport type { ClientStreamingCall, RpcOptions } from \"@protobuf-ts/runtime-rpc\";\nimport { TextDecoder, TextEncoder } from \"util\";\nimport { trace, tracer } from \"./internal/telemetry\";\nimport type { CloneToProjectResponse, Objekt, Project, UpdateRequest, UpdateResponse } from \"./pb/fs_pb\";\nimport { FsClient } from \"./pb/fs_pb.client\";\n\nexport type { Objekt, Project };\n\n/**\n * Options for {@link DateiLagerGrpcClient}.\n */\nexport interface DateiLagerGrpcClientOptions {\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   * Options that will be passed to the underlying grpc client constructor.\n   *\n   * @see ClientOptions\n   */\n  grpcClientOptions?: ClientOptions;\n\n  /**\n   * Options that will be passed to every remote procedure call.\n   *\n   * @see RpcOptions\n   */\n  rpcOptions?: RpcOptions | (() => RpcOptions | undefined);\n}\n\n/**\n * A client class for interacting with DateiLager's GRPC API.\n *\n * The DateiLager API surface area is as minimal as possible;\n * convenience functions, such as getObject, should be implemented within the client.\n */\nexport class DateiLagerGrpcClient {\n  /** @internal */\n  private readonly _client: FsClient;\n\n  /** @internal */\n  private readonly _transport: GrpcTransport;\n\n  /** @internal */\n  private readonly _rpcOptions: () => RpcOptions | undefined;\n\n  /**\n   * The library used to interact with GRPC creates connections lazily, this constructor will not\n   * raise an error even if there is no service running at {@link DateiLagerGrpcClientOptions.server server}.\n   *\n   * @param options Grpc client options.\n   */\n  public constructor(options: DateiLagerGrpcClientOptions) {\n    const tokenFn = typeof options.token === \"string\" ? () => Promise.resolve(options.token as string) : options.token;\n\n    this._transport = new GrpcTransport({\n      host: typeof options.server === \"string\" ? options.server : `${options.server.host}:${options.server.port}`,\n      channelCredentials: credentials.combineChannelCredentials(\n        ChannelCredentials.createSsl(),\n        credentials.createFromMetadataGenerator((_, callback) => {\n          tokenFn()\n            .then((token) => {\n              const meta = new Metadata();\n              meta.add(\"authorization\", `Bearer ${token}`);\n              callback(null, meta);\n            })\n            .catch(callback);\n        })\n      ),\n      clientOptions: options.grpcClientOptions,\n    });\n\n    this._client = new FsClient(this._transport);\n\n    this._rpcOptions = options.rpcOptions instanceof Function ? options.rpcOptions : () => options.rpcOptions as RpcOptions | undefined;\n  }\n\n  /**\n   * Close the underlying GRPC client.\n   */\n  public close(): void {\n    this._transport.close();\n  }\n\n  /**\n   * Create a new project.\n   *\n   * @param project      The id of the project.\n   * @param packPatterns The paths to pack.\n   * @param template     The id of the project to start from.\n   */\n  public async newProject(project: bigint, packPatterns: string[], template?: bigint): Promise<void> {\n    await trace(\n      \"dateilager-grpc-client.new-project\",\n      {\n        attributes: {\n          \"dl.project\": String(project),\n          \"dl.pack_patterns\": packPatterns,\n          \"dl.template\": String(template),\n        },\n      },\n      () => this._client.newProject({ id: project, packPatterns, template }, this._rpcOptions())\n    );\n  }\n\n  /**\n   * Delete a project.\n   *\n   * @param project The id of the project.\n   */\n  public async deleteProject(project: bigint): Promise<void> {\n    await trace(\n      \"dateilager-grpc-client.delete-project\",\n      {\n        attributes: {\n          \"dl.project\": String(project),\n        },\n      },\n      () => this._client.deleteProject({ project }, this._rpcOptions())\n    );\n  }\n\n  /**\n   * List objects.\n   *\n   * @param project The id of the project.\n   * @param path    The path to list objects under.\n   * @param ignores The paths under {@link path} to ignore.\n   * @param from    The project version to start from.\n   * @param to      The project version to end at.\n   * @returns         A stream of objects.\n   * @yields           An object from the stream.\n   * @example\n   * for await (const object of client.listObjects(1n, \"\")) {\n   *   console.log(\"[listObjects] path: \" + object.path);\n   *   console.log(\"[listObjects] content:\\n\" + object.content);\n   * }\n   */\n  public async *listObjects(\n    project: bigint,\n    path: string,\n    ignores: string[] = [],\n    from?: bigint,\n    to?: bigint\n  ): AsyncGenerator<Objekt, void> {\n    const parentContext = contextAPI.active();\n    const span = tracer.startSpan(\n      \"dateilager-grpc-client.list-objects\",\n      {\n        attributes: {\n          \"dl.project\": String(project),\n          \"dl.path\": path,\n          \"dl.ignores\": ignores,\n          \"dl.from_version\": String(from),\n          \"dl.to_version\": String(to),\n        },\n      },\n      parentContext\n    );\n\n    try {\n      const call = contextAPI.with(traceAPI.setSpan(parentContext, span), () =>\n        this._client.get(\n          {\n            project,\n            fromVersion: from,\n            toVersion: to,\n            queries: [\n              {\n                path,\n                ignores,\n                isPrefix: true,\n              },\n            ],\n          },\n          this._rpcOptions()\n        )\n      );\n\n      for await (const response of call.responses) {\n        if (response.object) {\n          yield response.object;\n        }\n      }\n\n      await call.status;\n    } finally {\n      span.end();\n    }\n  }\n\n  /**\n   * Get an object.\n   *\n   * @param project The id of the project.\n   * @param path    The path of the object.\n   * @returns         The object at the given path or undefined if it does not exist.\n   */\n  public async getObject(project: bigint, path: string): Promise<Objekt | undefined> {\n    return await trace(\n      \"dateilager-grpc-client.get-object\",\n      {\n        attributes: {\n          \"dl.project\": String(project),\n          \"dl.path\": path,\n        },\n      },\n      async () => {\n        const call = this._client.get(\n          {\n            project,\n            queries: [\n              {\n                path,\n                isPrefix: false,\n                ignores: [],\n              },\n            ],\n          },\n          this._rpcOptions()\n        );\n\n        let object: Objekt | undefined;\n        for await (const response of call.responses) {\n          object = response.object;\n        }\n\n        await call.status;\n\n        return object;\n      }\n    );\n  }\n\n  /**\n   * Update objects.\n   *\n   * @param project The id of the project.\n   * @returns         An {@link UpdateInputStream} to send objects to update.\n   */\n  public updateObjects(project: bigint): UpdateInputStream {\n    const parentContext = contextAPI.active();\n    const span = tracer.startSpan(\n      \"dateilager-grpc-client.update-objects\",\n      {\n        attributes: {\n          \"dl.project\": String(project),\n        },\n      },\n      parentContext\n    );\n\n    const call = contextAPI.with(traceAPI.setSpan(parentContext, span), () => this._client.update(this._rpcOptions()));\n\n    return new UpdateInputStream(project, call, span);\n  }\n\n  /**\n   * Update an object.\n   *\n   * @param project The id of the project.\n   * @param obj     The object to update.\n   * @returns         The latest project version or `null` if something went wrong.\n   */\n  public async updateObject(project: bigint, obj: Objekt): Promise<bigint | null> {\n    const stream = this.updateObjects(project);\n    await stream.send(obj);\n    return await stream.complete();\n  }\n\n  /**\n   * Snapshot the current state of the dateilager server.\n   *\n   * @returns All the projects on the dateilager server.\n   * @throws If the dateilager server's DL_ENV environment variable is PROD.\n   * @see DateiLagerGrpcClient.resetToSnapshotInDevOrTests\n   */\n  public async snapshotInDevOrTests(): Promise<Project[]> {\n    const call = await this._client.snapshot({}, this._rpcOptions());\n    return call.response.projects;\n  }\n\n  /**\n   * Reset the given projects to their respective versions and delete any remaining projects.\n   * If no projects are provided, delete all projects.\n   *\n   * @param projects The projects to reset.\n   * @throws If the dateilager server's DL_ENV environment variable is PROD.\n   * @see DateiLagerGrpcClient.snapshotInDevOrTests\n   */\n  public async resetToSnapshotInDevOrTests(projects: Project[]): Promise<void> {\n    await this._client.reset({ projects }, this._rpcOptions());\n  }\n\n  /**\n   * Clones the `source` projects changes (from `fromVersion` up to `toVersion`) to the `target` project.\n   * This method assumes that it is always a one way clone from source to target, it does not take into account\n   * the changes that have occurred in the `target` project.\n   *\n   * @param source  The source project.\n   * @param target  The target project.\n   * @param version The version of the source project to clone up to.\n   * @returns         The new version number of the target project.\n   */\n  public async cloneToProject(source: bigint, target: bigint, version: bigint): Promise<CloneToProjectResponse> {\n    return await trace(\n      \"dateilager-grpc-client.clone-to-project\",\n      {\n        attributes: {\n          \"dl.source\": String(source),\n          \"dl.target\": String(target),\n          \"dl.version\": String(version),\n        },\n      },\n      async () => {\n        const call = await this._client.cloneToProject({ source, target, version }, this._rpcOptions());\n        return call.response;\n      }\n    );\n  }\n\n  /**\n   * GC project.\n   *\n   * @param project The project to GC.\n   * @param keep    The amount of versions since the latest that should be kept.\n   * @param from    The starting version to GC from.\n   * @returns         The amount of objects that were GC'd.\n   */\n  public async gcProject(project: bigint, keep: bigint, from?: bigint): Promise<bigint> {\n    const call = await this._client.gcProject({\n      project: project,\n      keepVersions: keep,\n      fromVersion: from,\n    });\n    return call.response.count;\n  }\n\n  /**\n   * GC random projects.\n   *\n   * @param sample The percentage of projects to sample from.\n   * @param keep   The amount of versions since the latest that should be kept.\n   * @param from   The starting version to GC from.\n   * @returns        The amount of objects that were GC'd.\n   */\n  public async gcRandomProjects(sample: number, keep: bigint, from?: bigint): Promise<bigint> {\n    const call = await this._client.gcRandomProjects({\n      sample: sample,\n      keepVersions: keep,\n      fromVersion: from,\n    });\n    return call.response.count;\n  }\n\n  /**\n   * GC contents.\n   *\n   * @param sample The percentage of projects to sample from.\n   * @returns        The amount of objects that were GC'd.\n   */\n  public async gcContents(sample: number): Promise<bigint> {\n    const call = await this._client.gcContents({\n      sample: sample,\n    });\n    return call.response.count;\n  }\n}\n\n/**\n * Used to send a stream of objects to update.\n *\n * @see DateiLagerGrpcClient.updateObjects\n */\nclass UpdateInputStream {\n  /** @internal */\n  private readonly _project: bigint;\n\n  /** @internal */\n  private readonly _call: ClientStreamingCall<UpdateRequest, UpdateResponse>;\n\n  /** @internal */\n  private readonly _span: Span;\n\n  public constructor(project: bigint, call: ClientStreamingCall<UpdateRequest, UpdateResponse>, span: Span) {\n    this._project = project;\n    this._call = call;\n    this._span = span;\n  }\n\n  /**\n   * Send an object to update.\n   *\n   * @param obj The object to update.\n   */\n  public async send(obj: Objekt): Promise<void> {\n    try {\n      await this._call.requests.send({\n        project: this._project,\n        object: obj,\n      });\n    } catch (err) {\n      this._span.end();\n      throw err;\n    }\n  }\n\n  /**\n   * Complete the update request.\n   *\n   * @returns The latest project version or `null` if something went wrong.\n   */\n  public async complete(): Promise<bigint | null> {\n    try {\n      await this._call.requests.complete();\n      const response = await this._call.response;\n      return response.version != -1n ? response.version : null;\n    } finally {\n      this._span.end();\n    }\n  }\n}\n\nconst encoder = new TextEncoder();\n\n/**\n * Encode string object contents as an array of bytes.\n *\n * @param content The string to encode.\n * @returns         The encoded content as an array of bytes.\n */\nexport function encodeContent(content: string): Uint8Array {\n  return encoder.encode(content);\n}\n\nconst decoder = new TextDecoder();\n\n/**\n * Decode an array of bytes as an object's string contents.\n *\n * @param bytes The array of bytes to decode.\n * @returns       The bytes decoded into a string.\n */\nexport function decodeContent(bytes: Uint8Array | undefined): string {\n  return decoder.decode(bytes);\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gadgetinc/dateilager",
-  "version": "0.3.4",
+  "version": "0.3.6",
   "homepage": "https://github.com/gadget-inc/dateilager",
   "bugs": "https://github.com/gadget-inc/dateilager/issues",
   "repository": {