@holonograph/client 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Precision Innovations LLC
+
+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

@@ -0,0 +1,103 @@
+# @holonograph/client
+
+The TypeScript HTTP client for a **Holonograph lens**.
+
+A Holonograph lens sits in front of your LLM calls and turns every call into a
+longitudinal, gradeable record. This package is the client you integrate into
+your application: it sends messages through the lens over HTTP and reports the
+scored outcome of each call back to it. Nothing else — no engine, no model
+keys, no server. The lens does the work; this is the wire to reach it.
+
+## Install
+
+```sh
+npm install @holonograph/client
+```
+
+The package is a single self-contained ES module with **no runtime
+dependencies**. It targets Node 18+ and any runtime with a global `fetch`.
+
+## Quickstart
+
+```ts
+import { HolonographClient } from '@holonograph/client';
+
+const client = new HolonographClient({
+  // Where your running lens is reachable.
+  endpoint: 'http://127.0.0.1:8080',
+  // Optional bearer token, if the lens requires one.
+  token: process.env.HOLONOGRAPH_TOKEN,
+  // Optional run mode, forwarded on every request.
+  runMode: 'production',
+  // Pinned into every evaluation event this client produces.
+  lensVersion: 'lv_2026_07_01',
+  substrate: {
+    lensVersion: 'lv_2026_07_01',
+    lightSourceIdentifier: 'anthropic/claude/4',
+    runMode: 'production',
+    provenance: 'production',
+    operatorColumns: {},
+  },
+});
+
+// 1. Send a message through the lens.
+const handle = await client.messages.create({
+  surfaceId: 'support.triage',
+  messages: [{ role: 'user', content: 'My order never arrived.' }],
+});
+
+// Read the model's output off the returned handle.
+const result = handle.result;
+
+// 2. Score the call however you like, then report the outcome back to the lens.
+await handle.reportOutcome({
+  dimensions: [
+    {
+      dimensionId: 'is_actionable',
+      passed: true,
+      expected: 'a concrete next step',
+      actual: 'offered to open a replacement order',
+    },
+  ],
+});
+```
+
+That is the whole loop: **`messages.create()` → score → `reportOutcome()`**. The
+lens assembles and stores the evaluation event; over time those events become
+the longitudinal record you query and visualize.
+
+## What it speaks
+
+The client talks to a lens over plain HTTP under the `/holonograph/*` path
+space (plus the lens's event and availability endpoints). Requests carry
+`x-holonograph-*` headers for correlation and run mode. You never construct
+these by hand — the client does.
+
+Errors from the lens surface as `HolonographHttpError`, which carries the HTTP
+status, an error code, and any details the lens returned.
+
+## API surface
+
+- **`HolonographClient`** — construct with an `endpoint` (plus optional `token`
+  / `runMode`) and the `lensVersion` + `substrate` to pin into every event.
+  - `client.messages.create(request)` — send a message; returns a handle.
+  - `handle.reportOutcome(outcome)` — commit the scored outcome.
+  - `handle.gradeObserver(...)` — attach grades to a cross-vendor observer call
+    before reporting, when the lens returned observer records.
+  - `client.contract.register(contract)` — publish a surface contract to the lens.
+  - `client.availability.mark(request)` — write availability markers.
+  - `client.callDirectly(request)` — escape hatch for the full request shape.
+- **`HttpTransport`** — the underlying transport, exposed for advanced use.
+- **`HolonographHttpError`** and the typed error classes for the grading and
+  availability flows.
+
+Everything is fully typed; the package ships its own type declarations.
+
+## Requirements
+
+This client does nothing on its own — it needs a **running Holonograph lens** to
+connect to. Point `endpoint` at your lens and you are set.
+
+## License
+
+MIT