@gadgetinc/dateilager 0.4.4 → 0.4.5

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

@@ -94,9 +94,11 @@ export declare class DateiLagerBinaryClient {
      * @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.
+     * @param options.ignores The paths to ignore when rebuilding the FS.
      * @returns                 The latest project version or `null` if something went wrong.
      */
     rebuild(project: bigint, to: bigint | null, directory: string, options?: {
         timeout: number;
+        ignores: string[];
     }): Promise<bigint | null>;
 }

package/dist/cjs/binary-client.js

@@ -75,6 +75,7 @@ class DateiLagerBinaryClient {
      * @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.
+     * @param options.ignores The paths to ignore when rebuilding the FS.
      * @returns                 The latest project version or `null` if something went wrong.
      */
     async rebuild(project, to, directory, options) {
@@ -90,6 +91,9 @@ class DateiLagerBinaryClient {
             if (to) {
                 args.push("--to", String(to));
             }
+            if (options?.ignores) {
+                args.push("--ignores", options.ignores.join(","));
+            }
             const result = await this._call("rebuild", project, directory, args, options);
             if (result.stdout == "-1") {
                 return null;

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

@@ -1 +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;AAiF7C;;;;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,EACL,OAAO,OAAO,CAAC,OAAO,KAAK,QAAQ;gBACjC,CAAC,CAAC;oBACE,MAAM,EAAE,OAAO,CAAC,OAAO;oBACvB,OAAO,EAAE,OAAO,CAAC,OAAO;iBACzB;gBACH,CAAC,CAAC;oBACE,MAAM,EAAE,CAAC;oBACT,OAAO,EAAE,CAAC;oBACV,GAAG,OAAO,CAAC,OAAO;iBACnB;YACP,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,OAAO,EAAE,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;YAE7F,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,OAAO,EAAE,SAAS,CAAC,CAAC;YAClC,IAAI,EAAE,EAAE;gBACN,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;aAC/B;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,WAAW,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,gBAAgB,EAAE,MAAM,CAAC,CAAC;QAEpH,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE;YACxB,QAAQ,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;SAC1D;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,WAAW,EAAE,gBAAgB,EAAE,WAAW,CAAC,CAAC;SAC3D;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,CAAC,MAAM,CAAC;YAC1D,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;AAjJD,wDAiJC","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 any command.\n   *\n   * @default 0 No timeout.\n   */\n  timeout?:\n    | number\n    | {\n        /**\n         * The default number of milliseconds to wait before terminating the update command.\n         *\n         * @default 0 No timeout.\n         */\n        update?: number;\n\n        /**\n         * The default number of milliseconds to wait before terminating the rebuild command.\n         *\n         * @default 0 No timeout.\n         */\n        rebuild?: number;\n      };\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:\n        typeof options.timeout === \"number\"\n          ? {\n              update: options.timeout,\n              rebuild: options.timeout,\n            }\n          : {\n              update: 0,\n              rebuild: 0,\n              ...options.timeout,\n            },\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 version or `null` if something went wrong.\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 version or `null` if something went wrong.\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, \"--log-encoding\", \"json\"];\n\n    if (this._options.logger) {\n      baseArgs.push(\"--log-level\", 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[method],\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"]}
+{"version":3,"file":"binary-client.js","sourceRoot":"","sources":["../../src/binary-client.ts"],"names":[],"mappings":";;;;;;AAAA,4CAA0D;AAE1D,kDAA0B;AAC1B,2DAA6B;AAC7B,wDAAgC;AAChC,oDAA6C;AAiF7C;;;;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,EACL,OAAO,OAAO,CAAC,OAAO,KAAK,QAAQ;gBACjC,CAAC,CAAC;oBACE,MAAM,EAAE,OAAO,CAAC,OAAO;oBACvB,OAAO,EAAE,OAAO,CAAC,OAAO;iBACzB;gBACH,CAAC,CAAC;oBACE,MAAM,EAAE,CAAC;oBACT,OAAO,EAAE,CAAC;oBACV,GAAG,OAAO,CAAC,OAAO;iBACnB;YACP,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,OAAO,EAAE,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;YAE7F,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;;;;;;;;;;OAUG;IACI,KAAK,CAAC,OAAO,CAClB,OAAe,EACf,EAAiB,EACjB,SAAiB,EACjB,OAAgD;QAEhD,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,OAAO,EAAE,SAAS,CAAC,CAAC;YAClC,IAAI,EAAE,EAAE;gBACN,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;aAC/B;YAED,IAAI,OAAO,EAAE,OAAO,EAAE;gBACpB,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;aACnD;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,WAAW,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,gBAAgB,EAAE,MAAM,CAAC,CAAC;QAEpH,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE;YACxB,QAAQ,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;SAC1D;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,WAAW,EAAE,gBAAgB,EAAE,WAAW,CAAC,CAAC;SAC3D;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,CAAC,MAAM,CAAC;YAC1D,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;AA3JD,wDA2JC","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 any command.\n   *\n   * @default 0 No timeout.\n   */\n  timeout?:\n    | number\n    | {\n        /**\n         * The default number of milliseconds to wait before terminating the update command.\n         *\n         * @default 0 No timeout.\n         */\n        update?: number;\n\n        /**\n         * The default number of milliseconds to wait before terminating the rebuild command.\n         *\n         * @default 0 No timeout.\n         */\n        rebuild?: number;\n      };\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:\n        typeof options.timeout === \"number\"\n          ? {\n              update: options.timeout,\n              rebuild: options.timeout,\n            }\n          : {\n              update: 0,\n              rebuild: 0,\n              ...options.timeout,\n            },\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 version or `null` if something went wrong.\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   * @param options.ignores The paths to ignore when rebuilding the FS.\n   * @returns                 The latest project version or `null` if something went wrong.\n   */\n  public async rebuild(\n    project: bigint,\n    to: bigint | null,\n    directory: string,\n    options?: { timeout: number; ignores: string[] }\n  ): 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        if (options?.ignores) {\n          args.push(\"--ignores\", options.ignores.join(\",\"));\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, \"--log-encoding\", \"json\"];\n\n    if (this._options.logger) {\n      baseArgs.push(\"--log-level\", 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[method],\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/esm/binary-client.d.ts

@@ -94,9 +94,11 @@ export declare class DateiLagerBinaryClient {
      * @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.
+     * @param options.ignores The paths to ignore when rebuilding the FS.
      * @returns                 The latest project version or `null` if something went wrong.
      */
     rebuild(project: bigint, to: bigint | null, directory: string, options?: {
         timeout: number;
+        ignores: string[];
     }): Promise<bigint | null>;
 }

package/dist/esm/binary-client.js

@@ -69,6 +69,7 @@ export class DateiLagerBinaryClient {
      * @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.
+     * @param options.ignores The paths to ignore when rebuilding the FS.
      * @returns                 The latest project version or `null` if something went wrong.
      */
     async rebuild(project, to, directory, options) {
@@ -84,6 +85,9 @@ export class DateiLagerBinaryClient {
             if (to) {
                 args.push("--to", String(to));
             }
+            if (options?.ignores) {
+                args.push("--ignores", options.ignores.join(","));
+            }
             const result = await this._call("rebuild", project, directory, args, options);
             if (result.stdout == "-1") {
                 return null;

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

@@ -1 +1 @@
-{"version":3,"file":"binary-client.js","sourceRoot":"","sources":["../../src/binary-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAE1D,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,MAAM,aAAa,CAAC;AAC7B,OAAO,QAAQ,MAAM,UAAU,CAAC;AAChC,OAAO,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAiF7C;;;;GAIG;AACH,MAAM,OAAO,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,EACL,OAAO,OAAO,CAAC,OAAO,KAAK,QAAQ;gBACjC,CAAC,CAAC;oBACE,MAAM,EAAE,OAAO,CAAC,OAAO;oBACvB,OAAO,EAAE,OAAO,CAAC,OAAO;iBACzB;gBACH,CAAC,CAAC;oBACE,MAAM,EAAE,CAAC;oBACT,OAAO,EAAE,CAAC;oBACV,GAAG,OAAO,CAAC,OAAO;iBACnB;YACP,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,KAAK,CAChB,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,OAAO,EAAE,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;YAE7F,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,KAAK,CAChB,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,EAAE,CAAC,KAAK,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAE/C,MAAM,IAAI,GAAG,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;YAClC,IAAI,EAAE,EAAE;gBACN,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;aAC/B;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,WAAW,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,gBAAgB,EAAE,MAAM,CAAC,CAAC;QAEpH,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE;YACxB,QAAQ,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;SAC1D;QAED,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE;YACzB,MAAM,OAAO,GAAG,EAAE,CAAC;YACnB,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;YAC9C,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;YAE5C,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,gBAAgB,EAAE,WAAW,CAAC,CAAC;SAC3D;QAED,MAAM,UAAU,GAAG,KAAK,CAAC,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,CAAC,MAAM,CAAC;YAC1D,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,QAAQ,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","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 any command.\n   *\n   * @default 0 No timeout.\n   */\n  timeout?:\n    | number\n    | {\n        /**\n         * The default number of milliseconds to wait before terminating the update command.\n         *\n         * @default 0 No timeout.\n         */\n        update?: number;\n\n        /**\n         * The default number of milliseconds to wait before terminating the rebuild command.\n         *\n         * @default 0 No timeout.\n         */\n        rebuild?: number;\n      };\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:\n        typeof options.timeout === \"number\"\n          ? {\n              update: options.timeout,\n              rebuild: options.timeout,\n            }\n          : {\n              update: 0,\n              rebuild: 0,\n              ...options.timeout,\n            },\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 version or `null` if something went wrong.\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 version or `null` if something went wrong.\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, \"--log-encoding\", \"json\"];\n\n    if (this._options.logger) {\n      baseArgs.push(\"--log-level\", 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[method],\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"]}
+{"version":3,"file":"binary-client.js","sourceRoot":"","sources":["../../src/binary-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAE1D,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,MAAM,aAAa,CAAC;AAC7B,OAAO,QAAQ,MAAM,UAAU,CAAC;AAChC,OAAO,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAiF7C;;;;GAIG;AACH,MAAM,OAAO,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,EACL,OAAO,OAAO,CAAC,OAAO,KAAK,QAAQ;gBACjC,CAAC,CAAC;oBACE,MAAM,EAAE,OAAO,CAAC,OAAO;oBACvB,OAAO,EAAE,OAAO,CAAC,OAAO;iBACzB;gBACH,CAAC,CAAC;oBACE,MAAM,EAAE,CAAC;oBACT,OAAO,EAAE,CAAC;oBACV,GAAG,OAAO,CAAC,OAAO;iBACnB;YACP,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,KAAK,CAChB,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,OAAO,EAAE,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;YAE7F,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;;;;;;;;;;OAUG;IACI,KAAK,CAAC,OAAO,CAClB,OAAe,EACf,EAAiB,EACjB,SAAiB,EACjB,OAAgD;QAEhD,OAAO,MAAM,KAAK,CAChB,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,EAAE,CAAC,KAAK,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAE/C,MAAM,IAAI,GAAG,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;YAClC,IAAI,EAAE,EAAE;gBACN,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;aAC/B;YAED,IAAI,OAAO,EAAE,OAAO,EAAE;gBACpB,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;aACnD;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,WAAW,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,gBAAgB,EAAE,MAAM,CAAC,CAAC;QAEpH,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE;YACxB,QAAQ,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;SAC1D;QAED,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE;YACzB,MAAM,OAAO,GAAG,EAAE,CAAC;YACnB,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;YAC9C,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;YAE5C,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,gBAAgB,EAAE,WAAW,CAAC,CAAC;SAC3D;QAED,MAAM,UAAU,GAAG,KAAK,CAAC,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,CAAC,MAAM,CAAC;YAC1D,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,QAAQ,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","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 any command.\n   *\n   * @default 0 No timeout.\n   */\n  timeout?:\n    | number\n    | {\n        /**\n         * The default number of milliseconds to wait before terminating the update command.\n         *\n         * @default 0 No timeout.\n         */\n        update?: number;\n\n        /**\n         * The default number of milliseconds to wait before terminating the rebuild command.\n         *\n         * @default 0 No timeout.\n         */\n        rebuild?: number;\n      };\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:\n        typeof options.timeout === \"number\"\n          ? {\n              update: options.timeout,\n              rebuild: options.timeout,\n            }\n          : {\n              update: 0,\n              rebuild: 0,\n              ...options.timeout,\n            },\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 version or `null` if something went wrong.\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   * @param options.ignores The paths to ignore when rebuilding the FS.\n   * @returns                 The latest project version or `null` if something went wrong.\n   */\n  public async rebuild(\n    project: bigint,\n    to: bigint | null,\n    directory: string,\n    options?: { timeout: number; ignores: string[] }\n  ): 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        if (options?.ignores) {\n          args.push(\"--ignores\", options.ignores.join(\",\"));\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, \"--log-encoding\", \"json\"];\n\n    if (this._options.logger) {\n      baseArgs.push(\"--log-level\", 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[method],\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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gadgetinc/dateilager",
-  "version": "0.4.4",
+  "version": "0.4.5",
   "homepage": "https://github.com/gadget-inc/dateilager",
   "bugs": "https://github.com/gadget-inc/dateilager/issues",
   "repository": {
@@ -24,11 +24,10 @@
     "README.md"
   ],
   "scripts": {
-    "build": "rm -rf dist && npx tsc --project tsconfig.cjs.json && npx tsc --project tsconfig.esm.json",
-    "fmt": "npx prettier --write . && npx eslint --fix .",
-    "lint": "npx prettier --check . && npx eslint .",
-    "test": "DL_SKIP_SSL_VERIFICATION=1 NODE_EXTRA_CA_CERTS=\"$(mkcert -CAROOT)/rootCA.pem\" npx jest",
-    "typecheck": "npx tsc --project tsconfig.eslint.json && npx tsc --project spec/tsconfig.json"
+    "build": "rm -rf dist && tsc --project tsconfig.cjs.json && tsc --project tsconfig.esm.json",
+    "fmt": "prettier --write . && eslint --fix .",
+    "lint": "prettier --check . && eslint . && tsc --project tsconfig.eslint.json && tsc --project spec/tsconfig.json",
+    "test": "DL_SKIP_SSL_VERIFICATION=1 NODE_EXTRA_CA_CERTS=\"$(mkcert -CAROOT)/rootCA.pem\" jest"
   },
   "dependencies": {
     "@grpc/grpc-js": "^1.7.0",