@harny/sdk 0.0.1-alpha.1 → 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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,63 +1,75 @@
-# @harny/sdk
+# Harny TypeScript SDK
 
-**A scoring engine that rates your AI's vibes on a scale of 1–100. Harness engineering makes it HARNY.**
+Harny gives each person your app's AI serves a private memory that keeps up when facts change. This package is the TypeScript client for Node: ingest timestamped text, check its status, delete it when required, and recall current facts with evidence.
 
-## Install
+#1 on BEAM at 128K tokens, the public benchmark for long-term memory in agents. [Results and methodology](https://harny.ai/benchmarks)
 
-```bash
+Documentation: [Quickstart](https://harny.ai/docs/memory-api/quickstart) · [Memory API overview](https://harny.ai/docs/memory-api/overview)
+
+## Installation
+
+```
 npm install @harny/sdk
 ```
 
-## Quick Start
+Requires Node.js 20+.
+
+## Key
 
-```js
-const harny = require("@harny/sdk");
+Sign up at [console.harny.ai](https://console.harny.ai/signup) and create an app key. Keep it on the server as `HARNY_API_KEY` and pass it to the client as `apiKey`.
 
-// Quick vibe check — no input needed
-const result = harny.vibeCheck();
-harny.print(result);
+## Quickstart
 
-// Full evaluation
-const result = harny.score({
-  prompt: "Explain quantum computing using interpretive dance metaphors",
-  reasoning: "Let me think step by step about how qubits are like dancers...",
-  result: "Imagine each qubit as a dancer spinning in superposition..."
-});
+```typescript
+import { HarnyClient } from "@harny/sdk";
 
-console.log(result.score);    // 73.42
-console.log(result.reaction); // "my GPU is getting warm and it's not the cooling fan."
-console.log(result.verdict);  // "Dangerously Harny"
+const harny = new HarnyClient({ apiKey: process.env.HARNY_API_KEY });
+await harny.provisionUser("demo-user", "demo@example.com"); // add each person once; repeating it is safe
+const receipt = await harny.ingestDataPoint(
+  { content: "Budget for the Acme pilot moved to 40k.", timestamp: "2026-07-28T16:00:00Z" },
+  { user: "demo-user" },
+);
+await harny.waitForIngestion(receipt.ingestionId, { user: "demo-user" });
+const page = await harny.recall("What is the Acme pilot budget?", { user: "demo-user" });
+console.log(page.results[0].content);
 ```
 
-## What It Scores
+`user` names the person; each recall returns that person's memory and nothing from anyone else's.
 
-All inputs are **optional**. Provide whatever you have:
+## Methods
 
-| Input | What It Measures |
-|-------|-----------------|
-| `prompt` | The instruction given to the AI |
-| `reasoning` | Chain-of-thought, scratchpad, reasoning traces |
-| `result` | The AI's final output |
+- `ingestDataPoint(point, { user?, idempotencyKey? })` — send one fact with the time it happened: `{ content, id?, label?, timestamp?, metadata?, audience? }`. Returns `{ ingestionId, sourceId, status }`. The same `id` with changed content replaces the old memory.
+- `ingestBatch(items, { user?, idempotencyKey? })` — send 1 to 1,000 facts at once.
+- `getIngestion(id, { user? })` / `waitForIngestion(id, { user?, timeoutMs?, pollMs? })` — `processing`, `completed` or `failed`. `nothingNew` is true when the send added nothing new.
+- `recall(query, { user?, level?, maxTokens?, limit?, sort?, queryTimestamp?, occurredFrom?, occurredTo? })` — ranked, dated facts for a question. `level` is `low`, `medium`, `high` or `extra-high`; `maxTokens` sets a ceiling instead. The response carries `results`, `asOf` and `usedEvidenceTokens`.
+- `deleteDataPoint(sourceId)`, `deleteDataPoints(ids)`, `deleteIngestion(id)` — remove a fact, or a whole send, and the memories that rest only on it.
+- `getUsage()` — this month's usage for the app.
 
-## Score Guide
+For agents, the client also has `provisionUser`, `assembleContext` and an `Agent` loop. See the [agent harness overview](https://harny.ai/docs/agent-harness/overview).
+
+## Errors
+
+```typescript
+import { HarnyError } from "@harny/sdk";
+
+try {
+  await harny.recall("What is the Acme pilot budget?", { user: "demo-user" });
+} catch (err) {
+  if (err instanceof HarnyError) {
+    console.log(err.statusCode, err.errorCode, err.recoveryHint, err.retryAfterS);
+  }
+}
+```
 
-| Score | Verdict |
-|-------|---------|
-| 1–15 | Completely Unharny |
-| 16–25 | Mildly Stale |
-| 26–35 | Room Temperature |
-| 36–45 | Slightly Prompted |
-| 46–55 | Moderately Harny |
-| 56–65 | Respectably Harny |
-| 66–75 | Dangerously Harny |
-| 76–85 | Weapons-Grade Harny |
-| 86–95 | Catastrophically Harny |
-| 96–100 | Beyond Harny — Transcendent |
+`statusCode` is 0 when nothing reached Harny (timeout or network); every other value is the HTTP status.
 
-## Links
+## Where next
 
-- [harny.ai](https://harny.ai)
+- [Quickstart](https://harny.ai/docs/memory-api/quickstart) in cURL, Python and TypeScript
+- [Memory API overview](https://harny.ai/docs/memory-api/overview)
+- [MCP server](https://harny.ai/docs/mcp/overview) for Claude, Cursor, VS Code and other MCP clients
+- [support@harny.ai](mailto:support@harny.ai)
 
 ## License
 
-MIT
+Apache-2.0.

package/dist/cjs/agent/adapters.d.ts

@@ -0,0 +1,167 @@
+/**
+ * Model adapters: three wire styles, configured entirely from a roster entry.
+ *
+ * The loop speaks one neutral shape (messages, tool specs, tool calls). An
+ * adapter translates it to one wire style and back:
+ *
+ * - `chat_completions`: the widely shared chat-completions request shape.
+ * - `messages`: the messages request shape with content blocks.
+ * - `generate_content`: the generate-content shape with function declarations.
+ *
+ * Which provider speaks which style, the base URL, the auth header, any fixed
+ * headers and any extra request-body fields (a pin to one host on a provider
+ * that routes to many) all come from the roster entry, so no provider or model
+ * name is written here and a new provider on an existing style is a roster edit.
+ *
+ * Within one run, the model's own assistant turns are replayed in the native
+ * form the provider returned (some providers require their reasoning or
+ * signature fields back on the next call), with one repair: a tool call whose
+ * arguments are not a JSON object is replayed with `{}` (the loop has already
+ * answered it as invalid), because some hosts refuse the whole request
+ * otherwise. Across runs the session store keeps plain text and action notes
+ * only, so a conversation survives a change of preset or provider.
+ *
+ * A model that thinks before it answers (`thinking_always_on` in its roster
+ * entry; the agent never switches thinking off) spends part of the answer
+ * limit thinking. Its adapter gives every call at least the entry's
+ * `answer_room_tokens`; only the tokens the model uses are billed, and the
+ * thinking itself is never capped. A turn the provider stopped at the limit,
+ * or before it finished for another documented reason, is marked `cutOff`.
+ */
+import type { ResolvedModel } from "./roster.js";
+export interface ToolSpec {
+    readonly name: string;
+    readonly description: string;
+    readonly parameters: Record<string, unknown>;
+}
+export interface ToolCall {
+    readonly id: string;
+    readonly name: string;
+    /** `null` when the model's arguments were not a JSON object (see `parseError`). */
+    readonly arguments: Record<string, unknown> | null;
+    readonly parseError?: string | null;
+}
+export interface ToolResult {
+    readonly callId: string;
+    readonly name: string;
+    readonly content: string;
+    readonly isError?: boolean;
+}
+export declare class Usage {
+    inputTokens: number;
+    outputTokens: number;
+    constructor(inputTokens?: number, outputTokens?: number);
+    get totalTokens(): number;
+    add(other: Usage): void;
+}
+export type MessageRole = "user" | "assistant" | "tool_results";
+/**
+ * One neutral message. `native` holds a provider's own assistant turn.
+ *
+ * A `tool_results` message may carry `text`: the loop's own words to the model
+ * after the results (the closing turn at the step limit), sent in the same
+ * turn as the results so user and model turns keep alternating.
+ */
+export declare class Message {
+    readonly role: MessageRole;
+    readonly text: string;
+    readonly toolCalls: ToolCall[];
+    readonly results: ToolResult[];
+    readonly native: unknown;
+    readonly nativeStyle: string | null;
+    constructor(init: {
+        role: MessageRole;
+        text?: string;
+        toolCalls?: ToolCall[];
+        results?: ToolResult[];
+        native?: unknown;
+        nativeStyle?: string | null;
+    });
+}
+export declare class ModelTurn {
+    readonly text: string;
+    readonly toolCalls: ToolCall[];
+    readonly usage: Usage;
+    readonly stop: string;
+    readonly native: unknown;
+    constructor(text: string, toolCalls: ToolCall[], usage: Usage, stop: string, native?: unknown);
+    /** The provider stopped this turn before it finished: text and tool calls may be incomplete. */
+    get cutOff(): boolean;
+    /** Stopped at the answer limit (the common case of `cutOff`). */
+    get atAnswerLimit(): boolean;
+}
+/** The model provider refused or failed the call (after retries). */
+export declare class ModelProviderError extends Error {
+    readonly statusCode: number | null;
+    constructor(message: string, statusCode?: number | null);
+}
+export interface CompleteRequest {
+    system: string;
+    messages: Message[];
+    tools: ToolSpec[];
+    maxOutputTokens: number;
+    /** Aborts the call (the run's time ran out). */
+    signal?: AbortSignal | null;
+}
+export interface ModelAdapter {
+    readonly provider: string;
+    readonly model: string;
+    readonly style: string;
+    complete(request: CompleteRequest): Promise<ModelTurn>;
+}
+export interface AdapterOptions {
+    /** A `fetch` to use instead of the global one (tests, proxies). */
+    fetch?: typeof fetch;
+    /** Per-call timeout. Default 60 seconds. */
+    timeoutMs?: number;
+}
+declare abstract class HttpAdapter implements ModelAdapter {
+    abstract readonly style: string;
+    readonly provider: string;
+    readonly model: string;
+    /** The answer limit a model that always thinks gets at least (`null`: no floor). */
+    readonly answerRoomTokens: number | null;
+    protected readonly base: string;
+    private readonly auth;
+    private readonly fixedHeaders;
+    protected readonly maxTokensParam: string;
+    private readonly extraBody;
+    private readonly fetchImpl;
+    private readonly timeoutMs;
+    constructor(resolved: ResolvedModel, options?: AdapterOptions);
+    /** The caller's limit, raised to the roster's answer room for a model that always thinks. */
+    protected answerLimit(requested: number): number;
+    /** The roster entry's extra fields, added where the adapter set nothing. */
+    protected withExtra(body: Record<string, unknown>): Record<string, unknown>;
+    private headers;
+    protected post(url: string, body: Record<string, unknown>, signal?: AbortSignal | null): Promise<Record<string, unknown>>;
+    abstract complete(request: CompleteRequest): Promise<ModelTurn>;
+}
+/** `[arguments, error]`: an object, or `null` with the reason it is not one. */
+export declare function parseArguments(raw: unknown): [Record<string, unknown> | null, string | null];
+/**
+ * The model's own turn, safe to send back: a tool call whose arguments are not
+ * a JSON object is replayed with `{}`. Valid arguments go back byte for byte;
+ * the stored turn is never changed.
+ */
+export declare function replayable(native: unknown): unknown;
+export declare class ChatCompletionsAdapter extends HttpAdapter {
+    readonly style = "chat_completions";
+    private wireMessages;
+    complete(request: CompleteRequest): Promise<ModelTurn>;
+}
+export declare class MessagesAdapter extends HttpAdapter {
+    readonly style = "messages";
+    private wireMessages;
+    complete(request: CompleteRequest): Promise<ModelTurn>;
+}
+/** Reduce a JSON schema to the subset function declarations accept. */
+export declare function declarationSchema(schema: unknown): unknown;
+export declare class GenerateContentAdapter extends HttpAdapter {
+    readonly style = "generate_content";
+    private wireContents;
+    complete(request: CompleteRequest): Promise<ModelTurn>;
+}
+/** The adapter for a resolved roster entry's wire style. */
+export declare function buildAdapter(resolved: ResolvedModel, options?: AdapterOptions): ModelAdapter;
+export {};