@swissspidy/belay-core 0.0.0-stage → 0.1.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,48 @@
-# Temporary Holding Version
+# @swissspidy/belay-core
 
-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.
+Answer AI tasks with a small on-device model, and call a cloud model only for the inputs it is
+unsure about. `@swissspidy/belay-core` has the task, the cascade, confidence handling, calibration files,
+cloud adapters and savings telemetry. It has no runtime dependencies.
+
+Pair it with [`@swissspidy/belay-web`](https://www.npmjs.com/package/@swissspidy/belay-web) for the on-device runners
+(Chrome's Classifier and Prompt APIs), and calibrate the threshold on your own data with
+[`@swissspidy/belay-calibrate`](https://www.npmjs.com/package/@swissspidy/belay-calibrate).
+
+> **Status:** experimental (0.x). The API may change between minor versions.
+
+## Install
+
+```sh
+npm install @swissspidy/belay-core @swissspidy/belay-web
+```
+
+## Usage
+
+```ts
+import { task, fetchAdapter } from '@swissspidy/belay-core';
+import { classifierApi } from '@swissspidy/belay-web';
+
+const triage = task({
+  name: 'ticket-triage',
+  schema: { type: 'categorical', options: ['bug', 'billing', 'feature', 'other'] as const },
+  local: classifierApi(),
+  cloud: fetchAdapter({ url: '/api/belay' }), // your backend calls the LLM
+  threshold: 0.8, // or: calibration: '/belay.calibration.json'
+});
+
+const result = await triage.run(ticketText, { signal });
+// { value: 'billing', confidence: 0.93, source: 'local', escalationReason: null, ... }
+```
+
+The local answer is accepted if and only if `confidence >= threshold`. Otherwise the task
+escalates to the cloud, subject to your privacy policy (`redact`, `consent`, or `never`).
+
+## Documentation
+
+See the [project README](https://github.com/swissspidy/belay#readme) for schemas, confidence,
+privacy, cloud adapters, calibration and telemetry, and the
+[ADRs](https://github.com/swissspidy/belay/tree/main/docs/adr) for the design decisions.
+
+## License
+
+Apache-2.0

package/dist/calibration.d.ts

@@ -0,0 +1,11 @@
+import type { CalibrationFile } from './types.js';
+export declare const CALIBRATION_VERSION = 1;
+/**
+ * Validates an unknown value as a v1 calibration file. When `task` is given, also checks
+ * that the file belongs to that task. Throws `BelayError('invalid-calibration')`.
+ */
+export declare function parseCalibration(data: unknown, task?: string): CalibrationFile;
+/** Threshold for a local top label: the per-label override if present, else the global one. */
+export declare function thresholdFor(calibration: Pick<CalibrationFile, 'threshold' | 'thresholds'>, label?: string): number;
+export declare function loadCalibration(source: CalibrationFile | string | URL | (() => Promise<CalibrationFile>), task?: string): Promise<CalibrationFile>;
+//# sourceMappingURL=calibration.d.ts.map

package/dist/calibration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"calibration.d.ts","sourceRoot":"","sources":["../src/calibration.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAElD,eAAO,MAAM,mBAAmB,IAAI,CAAC;AAOrC;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,eAAe,CA2B9E;AAED,+FAA+F;AAC/F,wBAAgB,YAAY,CAAC,WAAW,EAAE,IAAI,CAAC,eAAe,EAAE,WAAW,GAAG,YAAY,CAAC,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAKnH;AAED,wBAAsB,eAAe,CACnC,MAAM,EAAE,eAAe,GAAG,MAAM,GAAG,GAAG,GAAG,CAAC,MAAM,OAAO,CAAC,eAAe,CAAC,CAAC,EACzE,IAAI,CAAC,EAAE,MAAM,GACZ,OAAO,CAAC,eAAe,CAAC,CAU1B"}

package/dist/calibration.js

@@ -0,0 +1,68 @@
+import { BelayError } from './errors.js';
+export const CALIBRATION_VERSION = 1;
+const isNum = (v) => typeof v === 'number' && Number.isFinite(v);
+const isProb = (v) => isNum(v) && v >= 0 && v <= 1;
+/** A threshold above 1 keeps nothing local: every run escalates. */
+const isThreshold = (v) => isNum(v) && v >= 0;
+/**
+ * Validates an unknown value as a v1 calibration file. When `task` is given, also checks
+ * that the file belongs to that task. Throws `BelayError('invalid-calibration')`.
+ */
+export function parseCalibration(data, task) {
+    const fail = (msg) => {
+        throw new BelayError('invalid-calibration', `Invalid calibration file: ${msg}`);
+    };
+    if (!data || typeof data !== 'object')
+        fail('not an object');
+    const c = data;
+    if (c.version !== CALIBRATION_VERSION)
+        fail(`unsupported version ${String(c.version)}`);
+    if (typeof c.task !== 'string')
+        fail('missing task');
+    if (task !== undefined && c.task !== task)
+        fail(`file is for task "${c.task}", not "${task}"`);
+    if (typeof c.schemaFingerprint !== 'string')
+        fail('missing schemaFingerprint');
+    if (!isThreshold(c.threshold))
+        fail('threshold must be a number ≥ 0');
+    if (c.thresholds !== undefined) {
+        if (typeof c.thresholds !== 'object' || c.thresholds === null)
+            fail('thresholds must be an object');
+        for (const [label, t] of Object.entries(c.thresholds)) {
+            if (!isThreshold(t))
+                fail(`thresholds["${label}"] must be a number ≥ 0`);
+        }
+    }
+    if (!c.expected || !isProb(c.expected.localShare) || !isProb(c.expected.accuracy)) {
+        fail('expected.accuracy and expected.localShare must be numbers in [0, 1]');
+    }
+    if (!Array.isArray(c.curve))
+        fail('curve must be an array');
+    if (!c.confidenceHistogram || !Array.isArray(c.confidenceHistogram.edges) || !Array.isArray(c.confidenceHistogram.counts)) {
+        fail('confidenceHistogram must have edges and counts');
+    }
+    else if (c.confidenceHistogram.edges.length !== c.confidenceHistogram.counts.length + 1) {
+        fail('confidenceHistogram.edges must have one more entry than counts');
+    }
+    return c;
+}
+/** Threshold for a local top label: the per-label override if present, else the global one. */
+export function thresholdFor(calibration, label) {
+    if (label !== undefined && calibration.thresholds && Object.hasOwn(calibration.thresholds, label)) {
+        return calibration.thresholds[label];
+    }
+    return calibration.threshold;
+}
+export async function loadCalibration(source, task) {
+    if (typeof source === 'function')
+        return parseCalibration(await source(), task);
+    if (typeof source === 'string' || source instanceof URL) {
+        const res = await fetch(source);
+        if (!res.ok) {
+            throw new BelayError('invalid-calibration', `Failed to fetch calibration ${String(source)}: HTTP ${res.status}`);
+        }
+        return parseCalibration(await res.json(), task);
+    }
+    return parseCalibration(source, task);
+}
+//# sourceMappingURL=calibration.js.map

package/dist/calibration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"calibration.js","sourceRoot":"","sources":["../src/calibration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAGzC,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC;AAErC,MAAM,KAAK,GAAG,CAAC,CAAU,EAAe,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;AACvF,MAAM,MAAM,GAAG,CAAC,CAAU,EAAe,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACzE,oEAAoE;AACpE,MAAM,WAAW,GAAG,CAAC,CAAU,EAAe,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAEpE;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAAC,IAAa,EAAE,IAAa;IAC3D,MAAM,IAAI,GAAG,CAAC,GAAW,EAAS,EAAE;QAClC,MAAM,IAAI,UAAU,CAAC,qBAAqB,EAAE,6BAA6B,GAAG,EAAE,CAAC,CAAC;IAClF,CAAC,CAAC;IACF,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ;QAAE,IAAI,CAAC,eAAe,CAAC,CAAC;IAC7D,MAAM,CAAC,GAAG,IAAgC,CAAC;IAC3C,IAAI,CAAC,CAAC,OAAO,KAAK,mBAAmB;QAAE,IAAI,CAAC,uBAAuB,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACxF,IAAI,OAAO,CAAC,CAAC,IAAI,KAAK,QAAQ;QAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IACrD,IAAI,IAAI,KAAK,SAAS,IAAI,CAAC,CAAC,IAAI,KAAK,IAAI;QAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC,IAAI,WAAW,IAAI,GAAG,CAAC,CAAC;IAC/F,IAAI,OAAO,CAAC,CAAC,iBAAiB,KAAK,QAAQ;QAAE,IAAI,CAAC,2BAA2B,CAAC,CAAC;IAC/E,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;QAAE,IAAI,CAAC,gCAAgC,CAAC,CAAC;IACtE,IAAI,CAAC,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;QAC/B,IAAI,OAAO,CAAC,CAAC,UAAU,KAAK,QAAQ,IAAI,CAAC,CAAC,UAAU,KAAK,IAAI;YAAE,IAAI,CAAC,8BAA8B,CAAC,CAAC;QACpG,KAAK,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,UAAoB,CAAC,EAAE,CAAC;YAChE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;gBAAE,IAAI,CAAC,eAAe,KAAK,yBAAyB,CAAC,CAAC;QAC3E,CAAC;IACH,CAAC;IACD,IAAI,CAAC,CAAC,CAAC,QAAQ,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QAClF,IAAI,CAAC,qEAAqE,CAAC,CAAC;IAC9E,CAAC;IACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC;QAAE,IAAI,CAAC,wBAAwB,CAAC,CAAC;IAC5D,IAAI,CAAC,CAAC,CAAC,mBAAmB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,mBAAmB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,mBAAmB,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1H,IAAI,CAAC,gDAAgD,CAAC,CAAC;IACzD,CAAC;SAAM,IAAI,CAAC,CAAC,mBAAmB,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,mBAAmB,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1F,IAAI,CAAC,gEAAgE,CAAC,CAAC;IACzE,CAAC;IACD,OAAO,CAAoB,CAAC;AAC9B,CAAC;AAED,+FAA+F;AAC/F,MAAM,UAAU,YAAY,CAAC,WAA8D,EAAE,KAAc;IACzG,IAAI,KAAK,KAAK,SAAS,IAAI,WAAW,CAAC,UAAU,IAAI,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,UAAU,EAAE,KAAK,CAAC,EAAE,CAAC;QAClG,OAAO,WAAW,CAAC,UAAU,CAAC,KAAK,CAAE,CAAC;IACxC,CAAC;IACD,OAAO,WAAW,CAAC,SAAS,CAAC;AAC/B,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,MAAyE,EACzE,IAAa;IAEb,IAAI,OAAO,MAAM,KAAK,UAAU;QAAE,OAAO,gBAAgB,CAAC,MAAM,MAAM,EAAE,EAAE,IAAI,CAAC,CAAC;IAChF,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,YAAY,GAAG,EAAE,CAAC;QACxD,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,CAAC;QAChC,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;YACZ,MAAM,IAAI,UAAU,CAAC,qBAAqB,EAAE,+BAA+B,MAAM,CAAC,MAAM,CAAC,UAAU,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;QACnH,CAAC;QACD,OAAO,gBAAgB,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,CAAC;IAClD,CAAC;IACD,OAAO,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AACxC,CAAC"}

package/dist/cloud.d.ts

@@ -0,0 +1,37 @@
+import type { CloudRequest, CloudRunner, CloudUsage, TaskSchema } from './types.js';
+export type CloudFn<S extends TaskSchema = TaskSchema> = (request: CloudRequest<S>, options: {
+    signal?: AbortSignal;
+    /** Report the call's token usage, so calibration and `savingsMeter()` can measure its cost. */
+    reportUsage: (usage: CloudUsage | CloudUsage[]) => void;
+}) => Promise<unknown>;
+/**
+ * Wraps a plain async function as a cloud runner. The function returns the raw output:
+ * the bare value, the `{ value }` wrapper, or a JSON string of either. The task validates it.
+ * Token usage goes through `reportUsage`, since the output itself may be a `{ value }` object.
+ *
+ * ```ts
+ * cloudAdapter(async ({ instruction, input, jsonSchema }, { signal }) => {
+ *   const res = await fetch('/api/classify', { method: 'POST', body: JSON.stringify({ instruction, input, jsonSchema }), signal });
+ *   return res.json();
+ * });
+ * ```
+ */
+export declare function cloudAdapter<S extends TaskSchema = TaskSchema>(fn: CloudFn<S>, options?: {
+    id?: string;
+}): CloudRunner<S>;
+export interface FetchAdapterOptions<S extends TaskSchema = TaskSchema> {
+    /** Your backend endpoint. Never put provider API keys in the browser. */
+    url: string | URL;
+    headers?: Record<string, string>;
+    /** Builds the request body. Defaults to the JSON-serialized request (functions dropped). */
+    body?: (request: CloudRequest<S>) => unknown;
+    /** Extracts the output from the parsed JSON response. Defaults to the whole response. */
+    select?: (json: unknown) => unknown;
+    /** Extracts token usage from the parsed JSON response, if your backend passes it through. */
+    usage?: (json: unknown) => CloudUsage | CloudUsage[] | undefined;
+    id?: string;
+    fetch?: typeof fetch;
+}
+/** A cloud runner that POSTs the request as JSON to your endpoint. */
+export declare function fetchAdapter<S extends TaskSchema = TaskSchema>(options: FetchAdapterOptions<S>): CloudRunner<S>;
+//# sourceMappingURL=cloud.d.ts.map

package/dist/cloud.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cloud.d.ts","sourceRoot":"","sources":["../src/cloud.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAe,YAAY,EAAE,WAAW,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAEjG,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,UAAU,GAAG,UAAU,IAAI,CACvD,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,EACxB,OAAO,EAAE;IACP,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,+FAA+F;IAC/F,WAAW,EAAE,CAAC,KAAK,EAAE,UAAU,GAAG,UAAU,EAAE,KAAK,IAAI,CAAC;CACzD,KACE,OAAO,CAAC,OAAO,CAAC,CAAC;AAEtB;;;;;;;;;;;GAWG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,UAAU,GAAG,UAAU,EAC5D,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC,EACd,OAAO,GAAE;IAAE,EAAE,CAAC,EAAE,MAAM,CAAA;CAAO,GAC5B,WAAW,CAAC,CAAC,CAAC,CAShB;AAED,MAAM,WAAW,mBAAmB,CAAC,CAAC,SAAS,UAAU,GAAG,UAAU;IACpE,yEAAyE;IACzE,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,4FAA4F;IAC5F,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC;IAC7C,yFAAyF;IACzF,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,OAAO,CAAC;IACpC,6FAA6F;IAC7F,KAAK,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,UAAU,GAAG,UAAU,EAAE,GAAG,SAAS,CAAC;IACjE,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;CACtB;AAED,sEAAsE;AACtE,wBAAgB,YAAY,CAAC,CAAC,SAAS,UAAU,GAAG,UAAU,EAAE,OAAO,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAmB/G"}

package/dist/cloud.js

@@ -0,0 +1,43 @@
+/**
+ * Wraps a plain async function as a cloud runner. The function returns the raw output:
+ * the bare value, the `{ value }` wrapper, or a JSON string of either. The task validates it.
+ * Token usage goes through `reportUsage`, since the output itself may be a `{ value }` object.
+ *
+ * ```ts
+ * cloudAdapter(async ({ instruction, input, jsonSchema }, { signal }) => {
+ *   const res = await fetch('/api/classify', { method: 'POST', body: JSON.stringify({ instruction, input, jsonSchema }), signal });
+ *   return res.json();
+ * });
+ * ```
+ */
+export function cloudAdapter(fn, options = {}) {
+    return {
+        id: options.id ?? 'cloud',
+        async run(request, opts) {
+            let usage;
+            const value = await fn(request, { ...opts, reportUsage: (u) => void (usage = u) });
+            return usage ? { value, usage } : { value };
+        },
+    };
+}
+/** A cloud runner that POSTs the request as JSON to your endpoint. */
+export function fetchAdapter(options) {
+    const doFetch = options.fetch ?? globalThis.fetch.bind(globalThis);
+    return cloudAdapter(async (request, { signal, reportUsage }) => {
+        const body = options.body ? options.body(request) : request;
+        const res = await doFetch(options.url, {
+            method: 'POST',
+            headers: { 'content-type': 'application/json', ...options.headers },
+            body: JSON.stringify(body),
+            ...(signal ? { signal } : {}),
+        });
+        if (!res.ok)
+            throw new Error(`Cloud endpoint responded with HTTP ${res.status}`);
+        const json = await res.json();
+        const usage = options.usage?.(json);
+        if (usage)
+            reportUsage(usage);
+        return options.select ? options.select(json) : json;
+    }, { id: options.id ?? 'fetch' });
+}
+//# sourceMappingURL=cloud.js.map

package/dist/cloud.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cloud.js","sourceRoot":"","sources":["../src/cloud.ts"],"names":[],"mappings":"AAWA;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,YAAY,CAC1B,EAAc,EACd,OAAO,GAAoB,EAAE;IAE7B,OAAO;QACL,EAAE,EAAE,OAAO,CAAC,EAAE,IAAI,OAAO;QACzB,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI;YACrB,IAAI,KAA4C,CAAC;YACjD,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE,GAAG,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC;YACnF,OAAO,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC;QAC9C,CAAC;KACF,CAAC;AACJ,CAAC;AAgBD,sEAAsE;AACtE,MAAM,UAAU,YAAY,CAAoC,OAA+B;IAC7F,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,IAAI,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACnE,OAAO,YAAY,CACjB,KAAK,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,WAAW,EAAE,EAAE,EAAE;QACzC,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;QAC5D,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE;YACrC,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE;YACnE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YAC1B,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAC9B,CAAC,CAAC;QACH,IAAI,CAAC,GAAG,CAAC,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,sCAAsC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;QACjF,MAAM,IAAI,GAAY,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;QACvC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,KAAK;YAAE,WAAW,CAAC,KAAK,CAAC,CAAC;QAC9B,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACtD,CAAC,EACD,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,IAAI,OAAO,EAAE,CAC9B,CAAC;AACJ,CAAC"}

package/dist/confidence.d.ts

@@ -0,0 +1,22 @@
+import type { ProbabilityEntry } from './types.js';
+/** Probability of the top option: the confidence signal for classifier tasks. */
+export declare function topProbability(probabilities: readonly ProbabilityEntry[]): number;
+export interface ConfidenceSignals {
+    /** Whether the output passed schema validation. */
+    valid: boolean;
+    /** Confidence reported by the local runner itself, if any. */
+    runner?: number | undefined;
+    /** P(correct) from the classifier-as-judge, if any. */
+    judge?: number | undefined;
+}
+/**
+ * Combines the signals into one confidence (ADR 0001, "Confidence signal"):
+ *
+ * - schema validation is a hard gate: an invalid output has confidence 0;
+ * - with only one of `runner` / `judge`, that value is the confidence;
+ * - with both, the minimum (the more pessimistic signal wins);
+ * - with neither, `undefined`: the task cannot decide and reports a configuration error.
+ */
+export declare function combineConfidence(signals: ConfidenceSignals): number | undefined;
+export declare function clamp01(n: number): number;
+//# sourceMappingURL=confidence.d.ts.map

package/dist/confidence.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"confidence.d.ts","sourceRoot":"","sources":["../src/confidence.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAEnD,iFAAiF;AACjF,wBAAgB,cAAc,CAAC,aAAa,EAAE,SAAS,gBAAgB,EAAE,GAAG,MAAM,CAIjF;AAED,MAAM,WAAW,iBAAiB;IAChC,mDAAmD;IACnD,KAAK,EAAE,OAAO,CAAC;IACf,8DAA8D;IAC9D,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,uDAAuD;IACvD,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5B;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,iBAAiB,GAAG,MAAM,GAAG,SAAS,CAKhF;AAED,wBAAgB,OAAO,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAGzC"}

package/dist/confidence.js

@@ -0,0 +1,30 @@
+/** Probability of the top option: the confidence signal for classifier tasks. */
+export function topProbability(probabilities) {
+    let top = 0;
+    for (const p of probabilities)
+        if (p.probability > top)
+            top = p.probability;
+    return clamp01(top);
+}
+/**
+ * Combines the signals into one confidence (ADR 0001, "Confidence signal"):
+ *
+ * - schema validation is a hard gate: an invalid output has confidence 0;
+ * - with only one of `runner` / `judge`, that value is the confidence;
+ * - with both, the minimum (the more pessimistic signal wins);
+ * - with neither, `undefined`: the task cannot decide and reports a configuration error.
+ */
+export function combineConfidence(signals) {
+    if (!signals.valid)
+        return 0;
+    const values = [signals.runner, signals.judge].filter((v) => typeof v === 'number');
+    if (values.length === 0)
+        return undefined;
+    return clamp01(Math.min(...values));
+}
+export function clamp01(n) {
+    if (Number.isNaN(n))
+        return 0;
+    return n < 0 ? 0 : n > 1 ? 1 : n;
+}
+//# sourceMappingURL=confidence.js.map

package/dist/confidence.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"confidence.js","sourceRoot":"","sources":["../src/confidence.ts"],"names":[],"mappings":"AAEA,iFAAiF;AACjF,MAAM,UAAU,cAAc,CAAC,aAA0C;IACvE,IAAI,GAAG,GAAG,CAAC,CAAC;IACZ,KAAK,MAAM,CAAC,IAAI,aAAa;QAAE,IAAI,CAAC,CAAC,WAAW,GAAG,GAAG;YAAE,GAAG,GAAG,CAAC,CAAC,WAAW,CAAC;IAC5E,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC;AACtB,CAAC;AAWD;;;;;;;GAOG;AACH,MAAM,UAAU,iBAAiB,CAAC,OAA0B;IAC1D,IAAI,CAAC,OAAO,CAAC,KAAK;QAAE,OAAO,CAAC,CAAC;IAC7B,MAAM,MAAM,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAe,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC;IACjG,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IAC1C,OAAO,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;AACtC,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,CAAS;IAC/B,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QAAE,OAAO,CAAC,CAAC;IAC9B,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACnC,CAAC"}

package/dist/cost.d.ts

@@ -0,0 +1,60 @@
+import type { BelayEvent, CloudUsage, PriceTable, TokenPrices } from './types.js';
+/** Normalizes a runner's usage report to a list of per-model parts. */
+export declare function usageParts(usage: CloudUsage | readonly CloudUsage[] | undefined): CloudUsage[];
+/**
+ * Cost of one cloud call from its token usage. Prices are per million tokens. A price table is
+ * keyed by the model id the provider reports, so a call that a fallback model served is priced
+ * at that model's rates. Throws when a model has no price: guessing would make every saving wrong.
+ */
+export declare function costOf(usage: CloudUsage | readonly CloudUsage[], prices: PriceTable | TokenPrices): number;
+export interface SavingsMeterOptions {
+    /** Per-token prices, to measure the cost of each cloud call from the usage its runner reports. */
+    prices?: PriceTable | TokenPrices;
+    /**
+     * Cost of one cloud call, used when calls report no usage, and to value the calls the cascade
+     * avoided before any cloud call has been measured. A calibration file's `cost.cloudPerRun` fits.
+     */
+    cloudPerRun?: number;
+    currency?: string;
+}
+export interface SavingsSummary {
+    currency: string | null;
+    runs: number;
+    /** Answered on device because the local confidence met the threshold. */
+    local: number;
+    /** Answered by the cloud runner. */
+    cloud: number;
+    /** Answered on device only because escalation was blocked (policy, consent, cloud error). */
+    blocked: number;
+    /** Spent on cloud calls: measured where usage was reported, otherwise `cloudPerRun` each. */
+    cloudSpend: number | null;
+    /** Mean cost of one cloud call (measured when possible). */
+    costPerCloudRun: number | null;
+    /** What the `local` runs would have cost in the cloud: `local × costPerCloudRun`. */
+    saved: number | null;
+    /** `saved / (saved + cloudSpend)`: the share of the cloud-only bill the cascade avoided. */
+    savedShare: number | null;
+    /** How many cloud calls were priced from reported usage. */
+    measuredCalls: number;
+}
+export interface SavingsMeter {
+    /** Pass as the task's `onEvent` (or call it from yours). */
+    readonly onEvent: (event: BelayEvent) => void;
+    /** Totals so far, for all tasks or one. */
+    summary(task?: string): SavingsSummary;
+    reset(): void;
+}
+/**
+ * Counts what the cascade saves in production. Only runs that stayed on device because the
+ * local answer was confident count as saved; runs kept local because escalation was blocked
+ * are reported separately. Unmeasured calls, and the value of avoided ones, use the mean
+ * measured cost per call, falling back to `cloudPerRun`.
+ *
+ * ```ts
+ * const meter = savingsMeter({ prices, cloudPerRun: calibration.cost?.cloudPerRun });
+ * const triage = task({ ..., onEvent: meter.onEvent });
+ * meter.summary(); // { runs, local, cloud, cloudSpend, saved, savedShare, ... }
+ * ```
+ */
+export declare function savingsMeter(options?: SavingsMeterOptions): SavingsMeter;
+//# sourceMappingURL=cost.d.ts.map

package/dist/cost.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cost.d.ts","sourceRoot":"","sources":["../src/cost.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAElF,uEAAuE;AACvE,wBAAgB,UAAU,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,UAAU,EAAE,GAAG,SAAS,GAAG,UAAU,EAAE,CAG9F;AAUD;;;;GAIG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,UAAU,EAAE,EAAE,MAAM,EAAE,UAAU,GAAG,WAAW,GAAG,MAAM,CAW1G;AAED,MAAM,WAAW,mBAAmB;IAClC,kGAAkG;IAClG,MAAM,CAAC,EAAE,UAAU,GAAG,WAAW,CAAC;IAClC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,yEAAyE;IACzE,KAAK,EAAE,MAAM,CAAC;IACd,oCAAoC;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,6FAA6F;IAC7F,OAAO,EAAE,MAAM,CAAC;IAChB,6FAA6F;IAC7F,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,4DAA4D;IAC5D,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,qFAAqF;IACrF,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,4FAA4F;IAC5F,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,4DAA4D;IAC5D,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,YAAY;IAC3B,4DAA4D;IAC5D,QAAQ,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,CAAC;IAC9C,2CAA2C;IAC3C,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC;IACvC,KAAK,IAAI,IAAI,CAAC;CACf;AAWD;;;;;;;;;;;GAWG;AACH,wBAAgB,YAAY,CAAC,OAAO,GAAE,mBAAwB,GAAG,YAAY,CAoD5E"}