@cpajs/cpa 0.0.0-stage → 0.0.1-alpha-2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 akarachen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,143 @@
-# Temporary Holding Version
+# @cpajs/cpa
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Run the official [CLIProxyAPI](https://github.com/router-for-me/CLIProxyAPI) (CPA) from Node.js or Bun, and
+manage any CPA instance with a hand-written, typed client for its native **v8 management API**.
+
+- `@cpajs/cpa/server` locates the bundled binary, writes the config, starts the process, waits until it is ready,
+  streams logs and stops it.
+- `@cpajs/cpa/client` is a `fetch`-based client for `/v8/management`, with types derived from the CPA source. It can
+  connect to local or remote instances.
+- Prebuilt CPA binaries for 23 platforms come through `optionalDependencies`, so `npm install` is all that is
+  needed.
+
+Bundled CLIProxyAPI: **v8.0.43**. See [docs/compatibility.md](docs/compatibility.md) for platforms and versions,
+and [docs/api-coverage.md](docs/api-coverage.md) for every route.
+
+```sh
+npm install @cpajs/cpa
+```
+
+## Start a server
+
+```ts
+import { startServer } from '@cpajs/cpa/server';
+
+const server = await startServer({
+  stateDir: './.cpa',                 // omit for a temporary directory that is removed on stop
+  managementKey: process.env.CPA_MANAGEMENT_KEY,
+  config: {                           // native v8 config, typed as CpaConfig
+    access: { 'api-keys': ['sk-my-model-key'] },
+    routing: { strategy: 'fill-first' },
+  },
+  onLog: ({ stream, line }) => console.log(`[cpa ${stream}] ${line}`),
+});
+
+console.log(server.origin);  // http://127.0.0.1:40123  (a free port is picked by default)
+console.log(server.baseUrl); // http://127.0.0.1:40123/v1 for OpenAI-compatible SDKs
+
+await server.stop();
+```
+
+- `config` and `configPath` are mutually exclusive.
+  - `config` is written to `<stateDir>/config.yaml` on every start. Credentials go to `<stateDir>/auths` unless
+    `oauth.auth-dir` is set. The server binds `127.0.0.1` unless you pass `host` or set `server.host`.
+  - `configPath` hands an existing file to CPA unchanged. CPA may rewrite it, for example to hash
+    `management.secret-key`. The file must set a fixed port, because CPA does not report the port it picks.
+- `startServer` resolves only once `/healthz` answers. It rejects with `CpaStartError` on early exit, port
+  conflict, timeout (`startupTimeoutMs`, default 30 s) or `signal` abort. In every failure case the process is
+  stopped and the temporary directory removed.
+- `stop()` is idempotent: it sends SIGTERM and then SIGKILL after `stopTimeoutMs` (default 10 s). On Windows Node
+  can only terminate forcefully. `server.exited` settles however the process ends.
+- `managementKey` is passed through `MANAGEMENT_PASSWORD`, so it never touches disk. Upstream treats that
+  variable as also allowing remote management. The key, config secrets and `redact` values are masked in logs and
+  errors.
+- `binaryPath` overrides the bundled binary. `args` adds CLI flags, for example `['-local-model']`.
+
+## Manage a server
+
+```ts
+import { createClient, CpaHttpError } from '@cpajs/cpa/client';
+
+const client = createClient({
+  baseUrl: 'http://127.0.0.1:8317',     // a path prefix behind a reverse proxy is kept
+  managementKey: process.env.CPA_MANAGEMENT_KEY!,
+  timeoutMs: 15_000,
+});
+
+const { data: config, etag } = await client.config.get();
+await client.config.patch({ routing: { strategy: 'round-robin' } }, { ifMatch: etag });
+await client.config.set('routing/retry/request-retry', 2);
+
+const { files } = await client.credentials.list();
+await client.credentials.upload({ name: 'codex-me.json', content: credentialJson });
+
+const login = await client.oauth.start({ provider: 'claude' });
+console.log('open', login.url);
+await client.oauth.waitForCompletion(login.state);
+
+try {
+  await client.config.getPath('does/not/exist');
+} catch (error) {
+  if (error instanceof CpaHttpError) console.log(error.status, error.errorCode); // 404 'not_found'
+}
+```
+
+| Group | Routes |
+| --- | --- |
+| `config` | `/config`, `/config.yaml`, `/config/*path`, with ETag / `If-Match` |
+| `credentials` | list, upload (raw or multipart), delete, models, download, status, fields, refresh, SIWC status |
+| `oauth` | auth URL, status / wait, cancel, callback, Vertex import, SIWC bind |
+| `logs` | main log with cursor, clear, error logs, request logs |
+| `usage` | API-key counters, usage queue (destructive pop) |
+| `routing` | cooldown reset, model definitions |
+| `requests` | server-side `api-call` |
+| `plugins` | list, delete, store, install, quota |
+| `server` | `/healthz`, version headers, latest release |
+
+Every method takes `{ signal, timeoutMs, headers }`. Errors:
+
+- `CpaHttpError` for a non-2xx response. It carries `status`, the raw `body`, parsed `data`, and `errorCode` /
+  `errorMessage`.
+- `CpaNetworkError` when the request fails.
+- `CpaTimeoutError` when the request times out.
+- `CpaAbortError` when your `signal` aborts the request.
+- `CpaResponseError` when a 2xx response has a malformed body.
+
+A 207 partial result resolves normally. Use `client.request()` for anything without a typed method.
+
+### Model API
+
+The management key and model API keys are different things. Model requests go to `server.baseUrl` or
+`client.modelBaseUrl` with a key from `access.api-keys`:
+
+```ts
+import OpenAI from 'openai';
+const openai = new OpenAI({ baseURL: server.baseUrl, apiKey: 'sk-my-model-key' });
+```
+
+## Development
+
+```sh
+pnpm install
+pnpm typecheck && pnpm test                       # unit tests (mocked fetch + a fake CPA process)
+node scripts/build-binary.ts --target linux-x64-musl
+CPA_BINARY=dist-bin/linux-x64-musl/cli-proxy-api pnpm test:e2e   # contract tests against real CPA
+```
+
+Release tooling, all in `scripts/` and run directly with Node's type stripping:
+
+| Script | Purpose |
+| --- | --- |
+| `fetch-source.ts` | Clone the pinned CPA tag and verify the commit. |
+| `build-binary.ts` | Build one or more targets, with the same CGO/plugin split as upstream. |
+| `verify-binary.ts` | Check format, CPU, static linking and the glibc baseline; `--smoke` starts the binary. |
+| `assemble-packages.ts` | Create the `@cpajs/*` platform packages. |
+| `pack.ts` | Produce the tarballs. |
+| `install-test.ts` | Install the tarballs through a local registry with npm, pnpm or bun, and run them. |
+| `trust-publishers.ts` | Configure npm trusted publishing for all packages (run locally after the first publish). |
+
+`.github/workflows/release.yml` runs these steps across the whole platform matrix and publishes on `v*` tags through npm trusted publishing (OIDC). Prerelease versions such as `0.0.1-alpha-1` go to a matching dist-tag (`alpha`). `trust-publishers.ts` configures trusted publishing for every package; npm only allows this once a package exists, so the very first release needs a temporary `NPM_TOKEN` secret.
+
+## License
+
+MIT. The bundled CLIProxyAPI binaries are MIT licensed by their authors; each platform package ships their LICENSE.

package/dist/client/errors.d.ts

@@ -0,0 +1,70 @@
+/** Base class for every error thrown by the client. */
+export declare class CpaClientError extends Error {
+    readonly name: string;
+    readonly method: string;
+    readonly url: string;
+    constructor(message: string, request: {
+        method: string;
+        url: string;
+    }, options?: {
+        cause?: unknown;
+    });
+}
+/**
+ * The server answered with a non-2xx status.
+ *
+ * `body` is the raw response text. `data` is the parsed JSON body when there
+ * was one; CPA errors usually look like `{ "error": "<code>", "message"?: "..." }`.
+ */
+export declare class CpaHttpError extends CpaClientError {
+    readonly name = "CpaHttpError";
+    readonly status: number;
+    readonly statusText: string;
+    readonly headers: Headers;
+    readonly body: string;
+    readonly data: unknown;
+    constructor(request: {
+        method: string;
+        url: string;
+    }, response: {
+        status: number;
+        statusText: string;
+        headers: Headers;
+    }, body: string);
+    /** The `error` field of a CPA error body, e.g. `"not_found"` or `"invalid management key"`. */
+    get errorCode(): string | undefined;
+    /** The `message` field of a CPA error body, when present. */
+    get errorMessage(): string | undefined;
+}
+/** The request could not be sent or the response could not be read. */
+export declare class CpaNetworkError extends CpaClientError {
+    readonly name = "CpaNetworkError";
+}
+/** The request exceeded its timeout. */
+export declare class CpaTimeoutError extends CpaClientError {
+    readonly name = "CpaTimeoutError";
+    readonly timeoutMs: number;
+    constructor(request: {
+        method: string;
+        url: string;
+    }, timeoutMs: number, options?: {
+        cause?: unknown;
+    });
+}
+/** The caller's AbortSignal was aborted. `cause` is the signal's reason. */
+export declare class CpaAbortError extends CpaClientError {
+    readonly name = "CpaAbortError";
+}
+/** A 2xx response body did not match the expected format (e.g. invalid JSON). */
+export declare class CpaResponseError extends CpaClientError {
+    readonly name = "CpaResponseError";
+    readonly status: number;
+    readonly body: string;
+    constructor(message: string, request: {
+        method: string;
+        url: string;
+    }, status: number, body: string, options?: {
+        cause?: unknown;
+    });
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/client/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/client/errors.ts"],"names":[],"mappings":"AAAA,uDAAuD;AACvD,qBAAa,cAAe,SAAQ,KAAK;IACvC,SAAkB,IAAI,EAAE,MAAM,CAAoB;IAClD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IAErB,YAAY,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,EAAE,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,EAInG;CACF;AAED;;;;;GAKG;AACH,qBAAa,YAAa,SAAQ,cAAc;IAC9C,SAAkB,IAAI,kBAAkB;IACxC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IAEvB,YACE,OAAO,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,EACxC,QAAQ,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE,EAClE,IAAI,EAAE,MAAM,EAUb;IAED,+FAA+F;IAC/F,IAAI,SAAS,IAAI,MAAM,GAAG,SAAS,CAGlC;IAED,6DAA6D;IAC7D,IAAI,YAAY,IAAI,MAAM,GAAG,SAAS,CAGrC;CACF;AAED,uEAAuE;AACvE,qBAAa,eAAgB,SAAQ,cAAc;IACjD,SAAkB,IAAI,qBAAqB;CAC5C;AAED,wCAAwC;AACxC,qBAAa,eAAgB,SAAQ,cAAc;IACjD,SAAkB,IAAI,qBAAqB;IAC3C,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B,YAAY,OAAO,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,EAGrG;CACF;AAED,4EAA4E;AAC5E,qBAAa,aAAc,SAAQ,cAAc;IAC/C,SAAkB,IAAI,mBAAmB;CAC1C;AAED,iFAAiF;AACjF,qBAAa,gBAAiB,SAAQ,cAAc;IAClD,SAAkB,IAAI,sBAAsB;IAC5C,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB,YAAY,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,EAIjI;CACF"}

package/dist/client/errors.js

@@ -0,0 +1,91 @@
+/** Base class for every error thrown by the client. */
+export class CpaClientError extends Error {
+    name = 'CpaClientError';
+    method;
+    url;
+    constructor(message, request, options) {
+        super(message, options);
+        this.method = request.method;
+        this.url = request.url;
+    }
+}
+/**
+ * The server answered with a non-2xx status.
+ *
+ * `body` is the raw response text. `data` is the parsed JSON body when there
+ * was one; CPA errors usually look like `{ "error": "<code>", "message"?: "..." }`.
+ */
+export class CpaHttpError extends CpaClientError {
+    name = 'CpaHttpError';
+    status;
+    statusText;
+    headers;
+    body;
+    data;
+    constructor(request, response, body) {
+        const data = parseJsonOrUndefined(body);
+        const detail = describeErrorBody(data) ?? (body.trim().slice(0, 200) || response.statusText);
+        super(`${request.method} ${request.url} failed with ${response.status}${detail ? `: ${detail}` : ''}`, request);
+        this.status = response.status;
+        this.statusText = response.statusText;
+        this.headers = response.headers;
+        this.body = body;
+        this.data = data;
+    }
+    /** The `error` field of a CPA error body, e.g. `"not_found"` or `"invalid management key"`. */
+    get errorCode() {
+        const value = this.data?.error;
+        return typeof value === 'string' ? value : undefined;
+    }
+    /** The `message` field of a CPA error body, when present. */
+    get errorMessage() {
+        const value = this.data?.message;
+        return typeof value === 'string' ? value : undefined;
+    }
+}
+/** The request could not be sent or the response could not be read. */
+export class CpaNetworkError extends CpaClientError {
+    name = 'CpaNetworkError';
+}
+/** The request exceeded its timeout. */
+export class CpaTimeoutError extends CpaClientError {
+    name = 'CpaTimeoutError';
+    timeoutMs;
+    constructor(request, timeoutMs, options) {
+        super(`${request.method} ${request.url} timed out after ${timeoutMs} ms`, request, options);
+        this.timeoutMs = timeoutMs;
+    }
+}
+/** The caller's AbortSignal was aborted. `cause` is the signal's reason. */
+export class CpaAbortError extends CpaClientError {
+    name = 'CpaAbortError';
+}
+/** A 2xx response body did not match the expected format (e.g. invalid JSON). */
+export class CpaResponseError extends CpaClientError {
+    name = 'CpaResponseError';
+    status;
+    body;
+    constructor(message, request, status, body, options) {
+        super(message, request, options);
+        this.status = status;
+        this.body = body;
+    }
+}
+function parseJsonOrUndefined(text) {
+    if (!text)
+        return undefined;
+    try {
+        return JSON.parse(text);
+    }
+    catch {
+        return undefined;
+    }
+}
+function describeErrorBody(data) {
+    if (typeof data !== 'object' || data === null)
+        return undefined;
+    const { error, message } = data;
+    const parts = [error, message].filter((v) => typeof v === 'string' && v !== '');
+    return parts.length ? parts.join(': ') : undefined;
+}
+//# sourceMappingURL=errors.js.map

package/dist/client/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/client/errors.ts"],"names":[],"mappings":"AAAA,uDAAuD;AACvD,MAAM,OAAO,cAAe,SAAQ,KAAK;IACrB,IAAI,GAAW,gBAAgB,CAAC;IACzC,MAAM,CAAS;IACf,GAAG,CAAS;IAErB,YAAY,OAAe,EAAE,OAAwC,EAAE,OAA6B;QAClG,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IACzB,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,OAAO,YAAa,SAAQ,cAAc;IAC5B,IAAI,GAAG,cAAc,CAAC;IAC/B,MAAM,CAAS;IACf,UAAU,CAAS;IACnB,OAAO,CAAU;IACjB,IAAI,CAAS;IACb,IAAI,CAAU;IAEvB,YACE,OAAwC,EACxC,QAAkE,EAClE,IAAY;QAEZ,MAAM,IAAI,GAAG,oBAAoB,CAAC,IAAI,CAAC,CAAC;QACxC,MAAM,MAAM,GAAG,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC7F,KAAK,CAAC,GAAG,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,GAAG,gBAAgB,QAAQ,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,KAAK,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;QAChH,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;QAC9B,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC;QACtC,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC;QAChC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,+FAA+F;IAC/F,IAAI,SAAS;QACX,MAAM,KAAK,GAAI,IAAI,CAAC,IAAwC,EAAE,KAAK,CAAC;QACpE,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;IACvD,CAAC;IAED,6DAA6D;IAC7D,IAAI,YAAY;QACd,MAAM,KAAK,GAAI,IAAI,CAAC,IAA0C,EAAE,OAAO,CAAC;QACxE,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;IACvD,CAAC;CACF;AAED,uEAAuE;AACvE,MAAM,OAAO,eAAgB,SAAQ,cAAc;IAC/B,IAAI,GAAG,iBAAiB,CAAC;CAC5C;AAED,wCAAwC;AACxC,MAAM,OAAO,eAAgB,SAAQ,cAAc;IAC/B,IAAI,GAAG,iBAAiB,CAAC;IAClC,SAAS,CAAS;IAE3B,YAAY,OAAwC,EAAE,SAAiB,EAAE,OAA6B;QACpG,KAAK,CAAC,GAAG,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,GAAG,oBAAoB,SAAS,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAC5F,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;CACF;AAED,4EAA4E;AAC5E,MAAM,OAAO,aAAc,SAAQ,cAAc;IAC7B,IAAI,GAAG,eAAe,CAAC;CAC1C;AAED,iFAAiF;AACjF,MAAM,OAAO,gBAAiB,SAAQ,cAAc;IAChC,IAAI,GAAG,kBAAkB,CAAC;IACnC,MAAM,CAAS;IACf,IAAI,CAAS;IAEtB,YAAY,OAAe,EAAE,OAAwC,EAAE,MAAc,EAAE,IAAY,EAAE,OAA6B;QAChI,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QACjC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AAED,SAAS,oBAAoB,CAAC,IAAY;IACxC,IAAI,CAAC,IAAI;QAAE,OAAO,SAAS,CAAC;IAC5B,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,SAAS,iBAAiB,CAAC,IAAa;IACtC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI;QAAE,OAAO,SAAS,CAAC;IAChE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,IAA8C,CAAC;IAC1E,MAAM,KAAK,GAAG,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAe,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;IAC7F,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACrD,CAAC"}

package/dist/client/index.d.ts

@@ -0,0 +1,46 @@
+import { ConfigResource } from './resources/config.ts';
+import { CredentialsResource } from './resources/credentials.ts';
+import { LogsResource } from './resources/logs.ts';
+import { OAuthResource } from './resources/oauth.ts';
+import { PluginsResource } from './resources/plugins.ts';
+import { RequestsResource } from './resources/requests.ts';
+import { RoutingResource } from './resources/routing.ts';
+import { ServerResource } from './resources/server.ts';
+import { UsageResource } from './resources/usage.ts';
+import { type ClientOptions, type RawRequest, type TransportResponse } from './transport.ts';
+export { CpaAbortError, CpaClientError, CpaHttpError, CpaNetworkError, CpaResponseError, CpaTimeoutError, } from './errors.ts';
+export type { ClientOptions, FetchLike, Query, QueryValue, RawRequest, RequestOptions, ResponseType, TransportResponse } from './transport.ts';
+export type { ConfigPath, ConfigWriteOptions, ConfigWriteResult, Versioned } from './resources/config.ts';
+export type { CredentialContent, CredentialFile, CredentialSelector } from './resources/credentials.ts';
+export type { DownloadedFile } from './resources/download.ts';
+export type { WaitForOAuthOptions } from './resources/oauth.ts';
+export { ConfigResource, CredentialsResource, LogsResource, OAuthResource, PluginsResource, RequestsResource, RoutingResource, ServerResource, UsageResource, };
+export type * from './types/index.ts';
+/** Typed client for the CLIProxyAPI v8 management API (`/v8/management`). */
+export declare class CpaClient {
+    #private;
+    readonly config: ConfigResource;
+    readonly credentials: CredentialsResource;
+    readonly oauth: OAuthResource;
+    readonly logs: LogsResource;
+    readonly usage: UsageResource;
+    readonly routing: RoutingResource;
+    readonly requests: RequestsResource;
+    readonly plugins: PluginsResource;
+    readonly server: ServerResource;
+    constructor(options: ClientOptions);
+    /** Server root URL this client talks to. */
+    get baseUrl(): URL;
+    /**
+     * OpenAI-compatible model API base URL (`<baseUrl>/v1`), for existing SDKs.
+     * Authenticate those requests with a model API key from `access.api-keys`,
+     * not with the management key.
+     */
+    get modelBaseUrl(): string;
+    /** Escape hatch for routes without a typed method. `path` is relative to `/v8/management`. */
+    request<T = unknown>(request: RawRequest): Promise<TransportResponse<T>>;
+}
+export declare function createClient(options: ClientOptions): CpaClient;
+/** `<baseUrl>/v1`, keeping any path prefix. */
+export declare function modelApiBaseUrl(baseUrl: string | URL): string;
+//# sourceMappingURL=index.d.ts.map

package/dist/client/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAa,KAAK,aAAa,EAAE,KAAK,UAAU,EAAE,KAAK,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAExG,OAAO,EACL,aAAa,EACb,cAAc,EACd,YAAY,EACZ,eAAe,EACf,gBAAgB,EAChB,eAAe,GAChB,MAAM,aAAa,CAAC;AACrB,YAAY,EAAE,aAAa,EAAE,SAAS,EAAE,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,cAAc,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAC/I,YAAY,EAAE,UAAU,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAC1G,YAAY,EAAE,iBAAiB,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AACxG,YAAY,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,YAAY,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAChE,OAAO,EACL,cAAc,EACd,mBAAmB,EACnB,YAAY,EACZ,aAAa,EACb,eAAe,EACf,gBAAgB,EAChB,eAAe,EACf,cAAc,EACd,aAAa,GACd,CAAC;AACF,mBAAmB,kBAAkB,CAAC;AAEtC,6EAA6E;AAC7E,qBAAa,SAAS;;IAEpB,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;IAChC,QAAQ,CAAC,WAAW,EAAE,mBAAmB,CAAC;IAC1C,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC;IAC9B,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAC5B,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC;IAC9B,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC;IAClC,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC;IACpC,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC;IAClC,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;IAEhC,YAAY,OAAO,EAAE,aAAa,EAWjC;IAED,4CAA4C;IAC5C,IAAI,OAAO,IAAI,GAAG,CAEjB;IAED;;;;OAIG;IACH,IAAI,YAAY,IAAI,MAAM,CAEzB;IAED,8FAA8F;IAC9F,OAAO,CAAC,CAAC,GAAG,OAAO,EAAE,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAEvE;CACF;AAED,wBAAgB,YAAY,CAAC,OAAO,EAAE,aAAa,GAAG,SAAS,CAE9D;AAED,+CAA+C;AAC/C,wBAAgB,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,GAAG,MAAM,CAM7D"}

package/dist/client/index.js

@@ -0,0 +1,65 @@
+import { ConfigResource } from './resources/config.js';
+import { CredentialsResource } from './resources/credentials.js';
+import { LogsResource } from './resources/logs.js';
+import { OAuthResource } from './resources/oauth.js';
+import { PluginsResource } from './resources/plugins.js';
+import { RequestsResource } from './resources/requests.js';
+import { RoutingResource } from './resources/routing.js';
+import { ServerResource } from './resources/server.js';
+import { UsageResource } from './resources/usage.js';
+import { Transport } from './transport.js';
+export { CpaAbortError, CpaClientError, CpaHttpError, CpaNetworkError, CpaResponseError, CpaTimeoutError, } from './errors.js';
+export { ConfigResource, CredentialsResource, LogsResource, OAuthResource, PluginsResource, RequestsResource, RoutingResource, ServerResource, UsageResource, };
+/** Typed client for the CLIProxyAPI v8 management API (`/v8/management`). */
+export class CpaClient {
+    #transport;
+    config;
+    credentials;
+    oauth;
+    logs;
+    usage;
+    routing;
+    requests;
+    plugins;
+    server;
+    constructor(options) {
+        this.#transport = new Transport(options);
+        this.config = new ConfigResource(this.#transport);
+        this.credentials = new CredentialsResource(this.#transport);
+        this.oauth = new OAuthResource(this.#transport);
+        this.logs = new LogsResource(this.#transport);
+        this.usage = new UsageResource(this.#transport);
+        this.routing = new RoutingResource(this.#transport);
+        this.requests = new RequestsResource(this.#transport);
+        this.plugins = new PluginsResource(this.#transport);
+        this.server = new ServerResource(this.#transport);
+    }
+    /** Server root URL this client talks to. */
+    get baseUrl() {
+        return this.#transport.baseUrl;
+    }
+    /**
+     * OpenAI-compatible model API base URL (`<baseUrl>/v1`), for existing SDKs.
+     * Authenticate those requests with a model API key from `access.api-keys`,
+     * not with the management key.
+     */
+    get modelBaseUrl() {
+        return modelApiBaseUrl(this.#transport.baseUrl);
+    }
+    /** Escape hatch for routes without a typed method. `path` is relative to `/v8/management`. */
+    request(request) {
+        return this.#transport.request(request);
+    }
+}
+export function createClient(options) {
+    return new CpaClient(options);
+}
+/** `<baseUrl>/v1`, keeping any path prefix. */
+export function modelApiBaseUrl(baseUrl) {
+    const url = new URL(baseUrl);
+    url.pathname = `${url.pathname.replace(/\/+$/, '')}/v1`;
+    url.search = '';
+    url.hash = '';
+    return url.toString();
+}
+//# sourceMappingURL=index.js.map

package/dist/client/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,SAAS,EAA+D,MAAM,gBAAgB,CAAC;AAExG,OAAO,EACL,aAAa,EACb,cAAc,EACd,YAAY,EACZ,eAAe,EACf,gBAAgB,EAChB,eAAe,GAChB,MAAM,aAAa,CAAC;AAMrB,OAAO,EACL,cAAc,EACd,mBAAmB,EACnB,YAAY,EACZ,aAAa,EACb,eAAe,EACf,gBAAgB,EAChB,eAAe,EACf,cAAc,EACd,aAAa,GACd,CAAC;AAGF,6EAA6E;AAC7E,MAAM,OAAO,SAAS;IACX,UAAU,CAAY;IACtB,MAAM,CAAiB;IACvB,WAAW,CAAsB;IACjC,KAAK,CAAgB;IACrB,IAAI,CAAe;IACnB,KAAK,CAAgB;IACrB,OAAO,CAAkB;IACzB,QAAQ,CAAmB;IAC3B,OAAO,CAAkB;IACzB,MAAM,CAAiB;IAEhC,YAAY,OAAsB;QAChC,IAAI,CAAC,UAAU,GAAG,IAAI,SAAS,CAAC,OAAO,CAAC,CAAC;QACzC,IAAI,CAAC,MAAM,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAClD,IAAI,CAAC,WAAW,GAAG,IAAI,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC5D,IAAI,CAAC,KAAK,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAChD,IAAI,CAAC,IAAI,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC9C,IAAI,CAAC,KAAK,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAChD,IAAI,CAAC,OAAO,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACpD,IAAI,CAAC,QAAQ,GAAG,IAAI,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACtD,IAAI,CAAC,OAAO,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACpD,IAAI,CAAC,MAAM,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACpD,CAAC;IAED,4CAA4C;IAC5C,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACH,IAAI,YAAY;QACd,OAAO,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAClD,CAAC;IAED,8FAA8F;IAC9F,OAAO,CAAc,OAAmB;QACtC,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAI,OAAO,CAAC,CAAC;IAC7C,CAAC;CACF;AAED,MAAM,UAAU,YAAY,CAAC,OAAsB;IACjD,OAAO,IAAI,SAAS,CAAC,OAAO,CAAC,CAAC;AAChC,CAAC;AAED,+CAA+C;AAC/C,MAAM,UAAU,eAAe,CAAC,OAAqB;IACnD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC;IAC7B,GAAG,CAAC,QAAQ,GAAG,GAAG,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,KAAK,CAAC;IACxD,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC;IAChB,GAAG,CAAC,IAAI,GAAG,EAAE,CAAC;IACd,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC;AACxB,CAAC"}

package/dist/client/resources/config.d.ts

@@ -0,0 +1,61 @@
+import type { JsonValue } from '../types/common.ts';
+import type { CpaConfig } from '../types/config.ts';
+import { type RequestOptions, type Transport } from '../transport.ts';
+/** A value together with the ETag of the config file it was read from or written to. */
+export interface Versioned<T> {
+    data: T;
+    /** Strong ETag of the on-disk file. Pass it as `ifMatch` for optimistic concurrency. */
+    etag: string | undefined;
+}
+export interface ConfigWriteOptions extends RequestOptions {
+    /**
+     * Only write if the file still has this ETag (or `*`). A mismatch fails with
+     * a 412 `CpaHttpError` (`errorCode === 'precondition_failed'`).
+     *
+     * Writing a plaintext `management.secret-key` makes CPA rewrite the file
+     * with a bcrypt hash a few seconds later, so read again before the next
+     * conditional write.
+     */
+    ifMatch?: string | undefined;
+}
+export interface ConfigWriteResult {
+    status: 'ok';
+    'config-version': 8;
+}
+/**
+ * A config path: `'routing/retry'` or `['routing', 'retry']`. Segments are
+ * dash-case YAML keys; list indices are not addressable (lists are replaced whole).
+ */
+export type ConfigPath = string | readonly string[];
+/** `/v8/management/config*`: the native configuration document. */
+export declare class ConfigResource {
+    #private;
+    constructor(transport: Transport);
+    /**
+     * The whole config as JSON, migrated to v8 in memory. TURN `username` and
+     * `credential` are removed and `auth_index` is added to API keys; writing it
+     * back is still safe. Use {@link getYaml} for a lossless copy.
+     */
+    get(options?: RequestOptions): Promise<Versioned<CpaConfig>>;
+    /** Replaces the whole document. Omitted sections are deleted. */
+    replace(config: CpaConfig, options?: ConfigWriteOptions): Promise<Versioned<ConfigWriteResult>>;
+    /**
+     * Deep-merges into the document. Objects merge key by key; arrays and
+     * scalars replace. `null` is stored as null, it does not delete — use
+     * {@link delete} to remove a key.
+     */
+    patch(partial: CpaConfig, options?: ConfigWriteOptions): Promise<Versioned<ConfigWriteResult>>;
+    /** The config file as YAML, with comments and without redaction. */
+    getYaml(options?: RequestOptions): Promise<Versioned<string>>;
+    /** Replaces the whole document with YAML (JSON is accepted too). */
+    replaceYaml(yaml: string, options?: ConfigWriteOptions): Promise<Versioned<ConfigWriteResult>>;
+    /** Reads one node, e.g. `getPath('server/port')`. A missing node is a 404 `CpaHttpError`. */
+    getPath<T = JsonValue>(path: ConfigPath, options?: RequestOptions): Promise<Versioned<T>>;
+    /** Replaces or creates one node. Missing parent objects are created. */
+    set(path: ConfigPath, value: JsonValue, options?: ConfigWriteOptions): Promise<Versioned<ConfigWriteResult>>;
+    /** Deep-merges into one node (see {@link patch}). */
+    patchPath(path: ConfigPath, value: JsonValue, options?: ConfigWriteOptions): Promise<Versioned<ConfigWriteResult>>;
+    /** Removes one node and any parents left empty. A missing node is a 404 `CpaHttpError`. */
+    delete(path: ConfigPath, options?: ConfigWriteOptions): Promise<Versioned<ConfigWriteResult>>;
+}
+//# sourceMappingURL=config.d.ts.map

package/dist/client/resources/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../../src/client/resources/config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAc,KAAK,cAAc,EAAE,KAAK,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAElF,wFAAwF;AACxF,MAAM,WAAW,SAAS,CAAC,CAAC;IAC1B,IAAI,EAAE,CAAC,CAAC;IACR,wFAAwF;IACxF,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;CAC1B;AAED,MAAM,WAAW,kBAAmB,SAAQ,cAAc;IACxD;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC9B;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,IAAI,CAAC;IACb,gBAAgB,EAAE,CAAC,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,SAAS,MAAM,EAAE,CAAC;AAgBpD,mEAAmE;AACnE,qBAAa,cAAc;;IAGzB,YAAY,SAAS,EAAE,SAAS,EAE/B;IAiBD;;;;OAIG;IACH,GAAG,CAAC,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAE/D;IAED,iEAAiE;IACjE,OAAO,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,GAAE,kBAAuB,GAAG,OAAO,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC,CAElG;IAED;;;;OAIG;IACH,KAAK,CAAC,OAAO,EAAE,SAAS,EAAE,OAAO,GAAE,kBAAuB,GAAG,OAAO,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC,CAEjG;IAED,oEAAoE;IACpE,OAAO,CAAC,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAEhE;IAED,oEAAoE;IACpE,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,kBAAuB,GAAG,OAAO,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC,CAEjG;IAED,6FAA6F;IAC7F,OAAO,CAAC,CAAC,GAAG,SAAS,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAE5F;IAED,wEAAwE;IACxE,GAAG,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,GAAE,kBAAuB,GAAG,OAAO,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC,CAE/G;IAED,qDAAqD;IACrD,SAAS,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,GAAE,kBAAuB,GAAG,OAAO,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC,CAErH;IAED,2FAA2F;IAC3F,MAAM,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,GAAE,kBAAuB,GAAG,OAAO,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC,CAEhG;CACF"}

package/dist/client/resources/config.js

@@ -0,0 +1,80 @@
+import { encodePath } from '../transport.js';
+function withIfMatch(options) {
+    const { ifMatch, ...rest } = options;
+    if (ifMatch === undefined)
+        return rest;
+    const headers = new Headers(rest.headers);
+    headers.set('If-Match', ifMatch);
+    return { ...rest, headers };
+}
+function nodePath(path) {
+    const encoded = encodePath(path, 'config path');
+    if (encoded === '')
+        throw new TypeError('config path must not be empty; use the whole-document methods instead.');
+    return `/config/${encoded}`;
+}
+/** `/v8/management/config*`: the native configuration document. */
+export class ConfigResource {
+    #t;
+    constructor(transport) {
+        this.#t = transport;
+    }
+    async #read(path, responseType, options) {
+        const res = await this.#t.request({ ...options, method: 'GET', path, responseType });
+        return { data: res.data, etag: res.headers.get('ETag') ?? undefined };
+    }
+    async #write(method, path, body, options) {
+        const res = await this.#t.request({
+            ...withIfMatch(options),
+            method,
+            path,
+            ...(body === undefined ? {} : 'json' in body ? { json: body.json } : { body: body.yaml, contentType: 'application/yaml' }),
+        });
+        return { data: res.data, etag: res.headers.get('ETag') ?? undefined };
+    }
+    /**
+     * The whole config as JSON, migrated to v8 in memory. TURN `username` and
+     * `credential` are removed and `auth_index` is added to API keys; writing it
+     * back is still safe. Use {@link getYaml} for a lossless copy.
+     */
+    get(options = {}) {
+        return this.#read('/config', 'json', options);
+    }
+    /** Replaces the whole document. Omitted sections are deleted. */
+    replace(config, options = {}) {
+        return this.#write('PUT', '/config', { json: config }, options);
+    }
+    /**
+     * Deep-merges into the document. Objects merge key by key; arrays and
+     * scalars replace. `null` is stored as null, it does not delete — use
+     * {@link delete} to remove a key.
+     */
+    patch(partial, options = {}) {
+        return this.#write('PATCH', '/config', { json: partial }, options);
+    }
+    /** The config file as YAML, with comments and without redaction. */
+    getYaml(options = {}) {
+        return this.#read('/config.yaml', 'text', options);
+    }
+    /** Replaces the whole document with YAML (JSON is accepted too). */
+    replaceYaml(yaml, options = {}) {
+        return this.#write('PUT', '/config.yaml', { yaml }, options);
+    }
+    /** Reads one node, e.g. `getPath('server/port')`. A missing node is a 404 `CpaHttpError`. */
+    getPath(path, options = {}) {
+        return this.#read(nodePath(path), 'json', options);
+    }
+    /** Replaces or creates one node. Missing parent objects are created. */
+    set(path, value, options = {}) {
+        return this.#write('PUT', nodePath(path), { json: value }, options);
+    }
+    /** Deep-merges into one node (see {@link patch}). */
+    patchPath(path, value, options = {}) {
+        return this.#write('PATCH', nodePath(path), { json: value }, options);
+    }
+    /** Removes one node and any parents left empty. A missing node is a 404 `CpaHttpError`. */
+    delete(path, options = {}) {
+        return this.#write('DELETE', nodePath(path), undefined, options);
+    }
+}
+//# sourceMappingURL=config.js.map

package/dist/client/resources/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/client/resources/config.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAuC,MAAM,iBAAiB,CAAC;AAgClF,SAAS,WAAW,CAAC,OAA2B;IAC9C,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC;IACrC,IAAI,OAAO,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IACvC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC1C,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IACjC,OAAO,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,CAAC;AAC9B,CAAC;AAED,SAAS,QAAQ,CAAC,IAAgB;IAChC,MAAM,OAAO,GAAG,UAAU,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;IAChD,IAAI,OAAO,KAAK,EAAE;QAAE,MAAM,IAAI,SAAS,CAAC,wEAAwE,CAAC,CAAC;IAClH,OAAO,WAAW,OAAO,EAAE,CAAC;AAC9B,CAAC;AAED,mEAAmE;AACnE,MAAM,OAAO,cAAc;IAChB,EAAE,CAAY;IAEvB,YAAY,SAAoB;QAC9B,IAAI,CAAC,EAAE,GAAG,SAAS,CAAC;IACtB,CAAC;IAED,KAAK,CAAC,KAAK,CAAI,IAAY,EAAE,YAA6B,EAAE,OAAuB;QACjF,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,OAAO,CAAI,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC,CAAC;QACxF,OAAO,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,SAAS,EAAE,CAAC;IACxE,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,MAAc,EAAE,IAAY,EAAE,IAAsD,EAAE,OAA2B;QAC5H,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,OAAO,CAAoB;YACnD,GAAG,WAAW,CAAC,OAAO,CAAC;YACvB,MAAM;YACN,IAAI;YACJ,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC;SAC3H,CAAC,CAAC;QACH,OAAO,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,SAAS,EAAyC,CAAC;IAC/G,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAC,OAAO,GAAmB,EAAE;QAC9B,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC;IAED,iEAAiE;IACjE,OAAO,CAAC,MAAiB,EAAE,OAAO,GAAuB,EAAE;QACzD,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,OAAkB,EAAE,OAAO,GAAuB,EAAE;QACxD,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAED,oEAAoE;IACpE,OAAO,CAAC,OAAO,GAAmB,EAAE;QAClC,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAED,oEAAoE;IACpE,WAAW,CAAC,IAAY,EAAE,OAAO,GAAuB,EAAE;QACxD,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,cAAc,EAAE,EAAE,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED,6FAA6F;IAC7F,OAAO,CAAgB,IAAgB,EAAE,OAAO,GAAmB,EAAE;QACnE,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAED,wEAAwE;IACxE,GAAG,CAAC,IAAgB,EAAE,KAAgB,EAAE,OAAO,GAAuB,EAAE;QACtE,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;IAED,qDAAqD;IACrD,SAAS,CAAC,IAAgB,EAAE,KAAgB,EAAE,OAAO,GAAuB,EAAE;QAC5E,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;IAED,2FAA2F;IAC3F,MAAM,CAAC,IAAgB,EAAE,OAAO,GAAuB,EAAE;QACvD,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;CACF"}