@pinecall/agents 0.9.20

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 2026 Pinecall
+
+   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

@@ -0,0 +1,121 @@
+# @pinecall/agents
+
+Build voice and chat agents as TypeScript classes. Fields are the agent's state, `@tool`
+methods are what the model can call, docstrings are the prompt, and `render()` describes the
+current turn.
+
+```tsx
+export default class ClinicaNorte extends Agent {
+  stage: Stages<"identify" | "choose" | "book"> = "identify";
+  patient?: Patient | undefined;
+  slot?: Slot | undefined;
+
+  /** Busca al paciente por nombre y teléfono. Pide los dos antes de llamarla. */
+  @tool({ stage: "identify", pii: ["name", "phone"] })
+  async findPatient(name: string, phone: string): Promise<Patient | null> {
+    this.patient = await this.agenda().find(name, phone);
+    if (this.patient) this.stage = "choose";
+    return this.patient ?? null;
+  }
+
+  /** The prompt as a function of state: the only part that changes between turns. */
+  override render() {
+    return (
+      <>
+        {this.stage === "identify" && <p>Saluda y pide nombre y teléfono.</p>}
+        {this.patient && <p>Hablas con {this.patient.name}, ya en la ficha.</p>}
+      </>
+    );
+  }
+}
+```
+
+The same agent answers the web, WhatsApp and the phone, and remembers a customer across them.
+Audio, rooms, the call log and tenants are handled by the
+[Pinecall runtime](https://github.com/pinecall/runtime), which this package talks to over a
+WebSocket.
+
+## Install
+
+```bash
+npm i @pinecall/agents pinecall   # the framework, and the CLI that runs what you write in it
+```
+
+The CLI is its own package, [`pinecall`](https://github.com/pinecall/cli): it never loads this
+one, it starts the agents of your project through `@pinecall/agents/serve`, which is why both are
+dependencies of the project. It needs a gateway: use Pinecall's hosted one, or run your own with
+[`pip install pinecall`](https://github.com/pinecall/runtime) (see
+[from-zero](https://github.com/pinecall/runtime/blob/main/docs/from-zero.md)).
+
+## Quick start
+
+```bash
+pnpm install
+npm i -g pinecall            # the CLI; the example takes the framework from this checkout
+cd examples/clinica-norte
+pinecall link                # sign in through the browser; writes your key to ./.env
+pinecall chat                # talk to the agent in this terminal
+pinecall start               # run the agent (this is the process you deploy)
+pinecall console             # open the sandbox console
+pinecall test                # run the goldens
+```
+
+Other useful verbs: `pinecall prompt --state <file>` prints the exact prompt a state produces
+(`--channel web --medium text` for the one a written chat gets);
+`pinecall docs push` uploads a knowledge base and `pinecall docs attach <base>` gives it to the
+agent; `pinecall deploy` runs the project on the box instead of your own server, with
+`pinecall secrets` for what it is started with ([docs/deploying.md](https://github.com/pinecall/cli/blob/main/docs/deploying.md)). Every verb runs against the sandbox unless `--prod` is given. The CLI reads `PINECALL_KEY`
+and `PINECALL_URL` from the environment or the project's `.env`. Full reference:
+[docs/the-cli.md](https://github.com/pinecall/cli/blob/main/docs/the-cli.md).
+
+A project holds one or more agents: `agents/<name>/agent.tsx` and their tests in
+`test/<name>/`. Voice, model, language, greeting, knowledge and the documents an agent searches
+are per-world settings, not class fields or files in the repository: `pinecall agent set
+--language es` is how the agent's calls come to be in Spanish. Running in production on your own server:
+[docs/production.md](docs/production.md).
+
+## Development
+
+```bash
+pnpm test          # the framework, from sources
+pnpm lint          # tsc over src and test
+scripts/build      # the published build (dist/)
+scripts/check      # build, lint, test — what CI runs
+```
+
+`package.json` exports point at `src/` and `publishConfig` switches them to `dist/` on publish,
+so tests and the example run from sources with no build step.
+
+| `src/` | |
+|---|---|
+| `agent/` | the `Agent` class, `@tool`, `@render`, `@state`, stages, hooks |
+| `views/` | JSX-to-text rendering and the prompt's named blocks |
+| `call/` | the live call as a value, reduced from log entries |
+| `client/` | `@pinecall/agents/client`: the WebSocket client and the wire, nothing else |
+| `runtime/` | the bridge between the class and the wire |
+| `serve/` | `@pinecall/agents/serve`: the entry the CLI starts an agent with, `start` and `prompt` |
+
+`test/the-imports.test.ts` enforces which directory may import which. The public exports are
+`@pinecall/agents`, `@pinecall/agents/client`, `@pinecall/agents/serve`, `@pinecall/agents/wire` and
+`@pinecall/agents/tsconfig.tenant.json`, pinned by
+`test/index.test.ts` and `test/client/index.test.ts`.
+
+The wire is the runtime's, kept in `src/wire/`; the runtime's golden call log, in
+`test/wire/golden/`, is how this package and the runtime are checked to fold a log identically.
+
+## Documentation
+
+| | |
+|---|---|
+| [docs/tutorial.md](docs/tutorial.md) | from an empty directory to an agent with knowledge and memory |
+| [docs/writing-an-agent.md](docs/writing-an-agent.md) | state, tools, stages, channels, knowledge, memory, hooks |
+| [docs/the-prompt.md](docs/the-prompt.md) | how the prompt is built and cached |
+| [docs/testing-an-agent.md](docs/testing-an-agent.md) | unit tests, goldens, personas, replays, scores |
+| [the CLI](https://github.com/pinecall/cli/blob/main/docs/the-cli.md) | every verb, in the `pinecall` repo |
+| [docs/worlds-and-teams.md](docs/worlds-and-teams.md) | keys, sandbox and production, teams |
+| [docs/production.md](docs/production.md) | running an agent on your own server |
+| [ARCHITECTURE.md](ARCHITECTURE.md) | the package file by file |
+
+## License
+
+[Apache-2.0](LICENSE), including its patent grant. No CLA.

package/dist/agent/accepts.d.ts

@@ -0,0 +1,31 @@
+/** `static events`: the external events a class accepts, and from which senders. */
+/** Event sender: the tenant's backend (`app`) or a participant's browser. */
+export type EventSource = "app" | "participant";
+/** One accepted event. Only senders listed in `from` reach the hook. */
+export interface EventDecl {
+    from: EventSource[];
+}
+/** A class's event declarations, e.g. `{ "cart.changed": { from: ["app"] } }`. */
+export type EventDeclarations = Record<string, EventDecl>;
+/** One declaration as carried in `AgentConfig.events`. */
+export interface EventSpec {
+    name: string;
+    from: EventSource[];
+}
+/** Event metadata: sender, participant identity if any, and log sequence number. */
+export interface EventMeta {
+    source: EventSource;
+    identity?: string;
+    seq: number;
+}
+/**
+ * Every event the class declares, parents first. A subclass redeclaring a name replaces its
+ * senders instead of merging them.
+ */
+export declare function eventsOf(ctor: Function): EventSpec[];
+/**
+ * Whether the class accepts `name` from `source`. The gateway checks this too; the runtime
+ * rechecks because a replayed log must not run a hook on an undeclared event.
+ */
+export declare function accepts(ctor: Function, name: string, source: EventSource): boolean;
+//# sourceMappingURL=accepts.d.ts.map

package/dist/agent/accepts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"accepts.d.ts","sourceRoot":"","sources":["../../src/agent/accepts.ts"],"names":[],"mappings":"AAAA,oFAAoF;AAEpF,6EAA6E;AAC7E,MAAM,MAAM,WAAW,GAAG,KAAK,GAAG,aAAa,CAAC;AAEhD,wEAAwE;AACxE,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,WAAW,EAAE,CAAC;CACrB;AAED,kFAAkF;AAClF,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;AAE1D,0DAA0D;AAC1D,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,WAAW,EAAE,CAAC;CACrB;AAED,oFAAoF;AACpF,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,WAAW,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,QAAQ,GAAG,SAAS,EAAE,CAWpD;AAED;;;GAGG;AAEH,wBAAgB,OAAO,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,GAAG,OAAO,CAGlF"}

package/dist/agent/accepts.js

@@ -0,0 +1,27 @@
+/** `static events`: the external events a class accepts, and from which senders. */
+/**
+ * Every event the class declares, parents first. A subclass redeclaring a name replaces its
+ * senders instead of merging them.
+ */
+export function eventsOf(ctor) {
+    const merged = new Map();
+    const chain = [];
+    for (let step = ctor; typeof step === "function"; step = Object.getPrototypeOf(step)) {
+        chain.unshift(step);
+    }
+    for (const step of chain) {
+        const own = Object.getOwnPropertyDescriptor(step, "events")?.value;
+        for (const [name, decl] of Object.entries(own ?? {}))
+            merged.set(name, [...decl.from]);
+    }
+    return [...merged].map(([name, from]) => ({ name, from }));
+}
+/**
+ * Whether the class accepts `name` from `source`. The gateway checks this too; the runtime
+ * rechecks because a replayed log must not run a hook on an undeclared event.
+ */
+export function accepts(ctor, name, source) {
+    const declared = eventsOf(ctor).find((spec) => spec.name === name);
+    return declared !== undefined && declared.from.includes(source);
+}
+//# sourceMappingURL=accepts.js.map

package/dist/agent/accepts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"accepts.js","sourceRoot":"","sources":["../../src/agent/accepts.ts"],"names":[],"mappings":"AAAA,oFAAoF;AA0BpF;;;GAGG;AACH,MAAM,UAAU,QAAQ,CAAC,IAAc;IACrC,MAAM,MAAM,GAAG,IAAI,GAAG,EAAyB,CAAC;IAChD,MAAM,KAAK,GAAe,EAAE,CAAC;IAC7B,KAAK,IAAI,IAAI,GAAoB,IAAI,EAAE,OAAO,IAAI,KAAK,UAAU,EAAE,IAAI,GAAG,MAAM,CAAC,cAAc,CAAC,IAAI,CAAoB,EAAE,CAAC;QACzH,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACtB,CAAC;IACD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,GAAG,GAAG,MAAM,CAAC,wBAAwB,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,KAAsC,CAAC;QACpG,KAAK,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,IAAI,EAAE,CAAC;YAAE,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACzF,CAAC;IACD,OAAO,CAAC,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;AAC7D,CAAC;AAED;;;GAGG;AAEH,MAAM,UAAU,OAAO,CAAC,IAAc,EAAE,IAAY,EAAE,MAAmB;IACvE,MAAM,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;IACnE,OAAO,QAAQ,KAAK,SAAS,IAAI,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AAClE,CAAC"}

package/dist/agent/agent.d.ts

@@ -0,0 +1,151 @@
+/** The Agent base class: its fields are the state, and every assignment is a change with an author. */
+import { type ToolSpec } from "./tools.js";
+import type { Child } from "../views/jsx-runtime.js";
+import type { CallWorld } from "../call/call.js";
+import type { Knowledge } from "./knowledge.js";
+import type { EventDeclarations, EventMeta } from "./accepts.js";
+import { type Visibility } from "./visibility.js";
+import type { Call, MemoryOp } from "./lifecycle.js";
+import { type LastCall, type Snapshot } from "./state.js";
+export declare const CONFIG_FIELDS: readonly ["phone", "whatsapp", "web", "channelRules"];
+/** One field assignment, as the log and the console read it. */
+export interface Change {
+    seq: number;
+    field: string;
+    prev: unknown;
+    next: unknown;
+    author: string;
+    at: number;
+}
+export type ChangeListener = (change: Change) => void;
+/** A named entry the agent wrote to the call's log. */
+export interface LogEntry {
+    seq: number;
+    name: string;
+    data?: unknown;
+    at: number;
+}
+export type LogListener = (entry: LogEntry) => void;
+/** An external event, as in-process observers receive it after the hook. */
+export interface EventHeard {
+    name: string;
+    data: Record<string, unknown>;
+    meta: EventMeta;
+}
+export type EventListener = (heard: EventHeard) => void;
+/** Per-agent framework state, kept off the instance's own fields. */
+export interface Internals {
+    changes: Change[];
+    log: LogEntry[];
+    logListeners: Set<LogListener>;
+    listeners: Set<ChangeListener>;
+    eventListeners: Set<EventListener>;
+    seq: number;
+    sealed: boolean;
+    target: object;
+    /** Set by the bridge at start(), never by the app. */
+    call: CallWorld | null;
+    /** Source for `last(contact)`, from `mount({ last })`. */
+    last: LastCall | null;
+    /** Facts memory recalled for this call, read by `remembers(text)`. */
+    recalled: string[];
+}
+/**
+ * Base class for every agent. The constructor returns a Proxy, so `this.patient = row` records
+ * a change with its author and sequence number.
+ */
+export declare class Agent {
+    constructor();
+    /** The class description, as an alternative to a JSDoc comment. */
+    static doc?: string;
+    /**
+     * `false` leaves the `<channel>` block out of the prompt: how to write for a voice, a website's
+     * chat or WhatsApp. A config field, never state.
+     */
+    channelRules?: boolean;
+    /**
+     * Knowledge bases attached to this agent (`pinecall docs attach`), searched from a tool:
+     * `await this.knowledge.search("horarios", { k: 3 })`. The gateway runs and logs the search.
+     */
+    get knowledge(): Knowledge;
+    /** External events this class accepts, and from whom. */
+    static events?: EventDeclarations;
+    /** Field visibility as a map, as an alternative to `@state`. */
+    static visibility?: Record<string, Visibility>;
+    /** The class docstring, as the model reads it. */
+    doc(): string | undefined;
+    /**
+     * The per-turn part of the prompt, rendered from the current state. It is the dynamic block and
+     * the last thing the model reads. Renders nothing by default.
+     */
+    render(): Child;
+    /**
+     * Whether memory recalled a fact for this call containing `text` (the fact or its key word).
+     * Returns false until the runtime has recalled anything.
+     */
+    remembers(text: string): boolean;
+    /** Every tool this agent declares, whether or not the current state shows it. */
+    tools(): ToolSpec[];
+    /** The tools a model may call right now: the ones whose `when(state)` holds. */
+    visibleTools(): ToolSpec[];
+    /** Replace the change log with a one-sentence summary; the state is kept. */
+    collapse(summary: string): void;
+    /** Restore the whole state from a snapshot, e.g. in `onCall` for a returning caller. */
+    restore(state: Snapshot): void;
+    /**
+     * Overwrite only the fields `state` names, keeping the rest. Unlike `restore`, which replaces the
+     * whole state and clears fields the snapshot omits.
+     */
+    startIn(state: Snapshot): void;
+    /** The snapshot this contact's last call left. Requires `mount(Class, { pc, last })`. */
+    last(contact: string): Promise<Snapshot | null>;
+    /** Append a named entry to the call's log. */
+    log(name: string, data?: unknown): void;
+    /**
+     * The call being served. A getter, not a field, so it never enters a snapshot; a subclass field
+     * named `call` is refused at its first write. Throws when no call is being served.
+     */
+    get call(): CallWorld;
+    /** Speak `text` verbatim now. Resolves true once the turn is delivered. */
+    say(text: string, options?: {
+        allowInterruptions?: boolean;
+    }): Promise<boolean>;
+    /** Make the model speak now, guided by instructions the caller does not hear. Resolves like `say`. */
+    reply(instructions: string, options?: {
+        allowInterruptions?: boolean;
+    }): Promise<boolean>;
+    /** Subscribe in-process to state changes or events. Returns an unsubscribe function. */
+    on(type: "state", listener: ChangeListener): () => void;
+    on(type: "event", listener: EventListener): () => void;
+    /** Called when a declared external event arrives. State writes here are authored by the event. */
+    onEvent(_name: string, _data: Record<string, unknown>, _meta: EventMeta): unknown;
+    /** Called when a call starts. State writes here are authored by the hook. */
+    onCall(_call: Call): unknown;
+    /** Called when the call ends. */
+    onEnd(_call: Call): unknown;
+    /** Called when memory is written; override to persist the ops. */
+    onMemory(_ops: MemoryOp[], _call: Call): unknown;
+}
+/** The framework's bookkeeping for an agent; throws if `agent` is not one. */
+export declare function internalsOf(agent: object): Internals;
+/** Start recording changes. Assignments before this (field initializers) are the baseline. */
+export declare function seal<T extends object>(agent: T): T;
+/** Every change this agent has recorded, oldest first. */
+export declare function changes(agent: object): readonly Change[];
+/** Listen to field assignments. Returns an unsubscribe function. */
+export declare function onChange(agent: object, listener: ChangeListener): () => void;
+/** Everything this agent logged, oldest first. */
+export declare function logOf(agent: object): readonly LogEntry[];
+/** Listen to log entries. Returns an unsubscribe function. */
+export declare function onLog(agent: object, listener: LogListener): () => void;
+/** Whether a name is one of CONFIG_FIELDS rather than a piece of state. */
+export declare function isConfigField(name: string): boolean;
+/** Set the store `last(contact)` reads. Called by the bridge at start(). */
+export declare function setLast(agent: object, source: LastCall | null): void;
+/** Set the call being served. Called by the bridge at start(). */
+export declare function setCall(agent: object, call: CallWorld | null): void;
+/** Record recalled facts and their key words, from the call's `memory.ops` entries. */
+export declare function recalled(agent: object, words: readonly string[]): void;
+/** Notify in-process observers of an event after its hook ran. */
+export declare function emitEvent(agent: object, heard: EventHeard): void;
+//# sourceMappingURL=agent.d.ts.map

package/dist/agent/agent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"agent.d.ts","sourceRoot":"","sources":["../../src/agent/agent.ts"],"names":[],"mappings":"AAAA,uGAAuG;AAIvG,OAAO,EAAkC,KAAK,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3E,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,KAAK,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACjE,OAAO,EAAmB,KAAK,UAAU,EAAE,MAAM,iBAAiB,CAAC;AACnE,OAAO,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,EAA+B,KAAK,QAAQ,EAAE,KAAK,QAAQ,EAAE,MAAM,YAAY,CAAC;AAKvF,eAAO,MAAM,aAAa,YAAI,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,cAAc,CAAU,CAAC;AAKnF,gEAAgE;AAChE,MAAM,WAAW,MAAM;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,MAAM,cAAc,GAAG,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;AAEtD,uDAAuD;AACvD,MAAM,WAAW,QAAQ;IACvB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,MAAM,WAAW,GAAG,CAAC,KAAK,EAAE,QAAQ,KAAK,IAAI,CAAC;AAEpD,4EAA4E;AAC5E,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9B,IAAI,EAAE,SAAS,CAAC;CACjB;AAED,MAAM,MAAM,aAAa,GAAG,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,CAAC;AAExD,qEAAqE;AACrE,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,GAAG,EAAE,QAAQ,EAAE,CAAC;IAChB,YAAY,EAAE,GAAG,CAAC,WAAW,CAAC,CAAC;IAC/B,SAAS,EAAE,GAAG,CAAC,cAAc,CAAC,CAAC;IAC/B,cAAc,EAAE,GAAG,CAAC,aAAa,CAAC,CAAC;IACnC,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,sDAAsD;IACtD,IAAI,EAAE,SAAS,GAAG,IAAI,CAAC;IACvB,0DAA0D;IAC1D,IAAI,EAAE,QAAQ,GAAG,IAAI,CAAC;IACtB,sEAAsE;IACtE,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAID;;;GAGG;AACH,qBAAa,KAAK;IAChB,cAsCC;IAED,mEAAmE;IACnE,MAAM,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACK,YAAY,CAAC,EAAE,OAAO,CAAC;IAE/B;;;OAGG;IACH,IAAI,SAAS,IAAI,SAAS,CAGzB;IAED,yDAAyD;IACzD,MAAM,CAAC,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAElC,gEAAgE;IAChE,MAAM,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAE/C,kDAAkD;IAClD,GAAG,IAAI,MAAM,GAAG,SAAS,CAExB;IAED;;;OAGG;IACH,MAAM,IAAI,KAAK,CAEd;IAED;;;OAGG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAI/B;IAED,iFAAiF;IACjF,KAAK,IAAI,QAAQ,EAAE,CAElB;IAED,gFAAgF;IAChF,YAAY,IAAI,QAAQ,EAAE,CAEzB;IAED,6EAA6E;IAC7E,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAE9B;IAED,wFAAwF;IACxF,OAAO,CAAC,KAAK,EAAE,QAAQ,GAAG,IAAI,CAE7B;IAED;;;OAGG;IACH,OAAO,CAAC,KAAK,EAAE,QAAQ,GAAG,IAAI,CAE7B;IAED,yFAAyF;IACzF,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,CAQ9C;IAED,8CAA8C;IAC9C,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,GAAG,IAAI,CAMtC;IAED;;;OAGG;IACH,IAAI,IAAI,IAAI,SAAS,CASpB;IAED,2EAA2E;IAC3E,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,kBAAkB,CAAC,EAAE,OAAO,CAAA;KAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAElF;IAED,sGAAsG;IACtG,KAAK,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,kBAAkB,CAAC,EAAE,OAAO,CAAA;KAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAE5F;IAED,wFAAwF;IACxF,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,cAAc,GAAG,MAAM,IAAI,CAAC;IACxD,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,aAAa,GAAG,MAAM,IAAI,CAAC;IAQvD,kGAAkG;IAClG,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,KAAK,EAAE,SAAS,GAAG,OAAO,CAEhF;IAED,6EAA6E;IAC7E,MAAM,CAAC,KAAK,EAAE,IAAI,GAAG,OAAO,CAE3B;IAED,iCAAiC;IACjC,KAAK,CAAC,KAAK,EAAE,IAAI,GAAG,OAAO,CAE1B;IAED,kEAAkE;IAClE,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,IAAI,GAAG,OAAO,CAE/C;CACF;AAED,8EAA8E;AAC9E,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAIpD;AAED,8FAA8F;AAC9F,wBAAgB,IAAI,CAAC,CAAC,SAAS,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAGlD;AAED,0DAA0D;AAC1D,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,MAAM,EAAE,CAExD;AAED,oEAAoE;AACpE,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,GAAG,MAAM,IAAI,CAI5E;AAED,kDAAkD;AAClD,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,QAAQ,EAAE,CAExD;AAED,8DAA8D;AAC9D,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW,GAAG,MAAM,IAAI,CAItE;AAED,2EAA2E;AAC3E,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEnD;AAED,4EAA4E;AAC5E,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,GAAG,IAAI,GAAG,IAAI,CAEpE;AAED,kEAAkE;AAClE,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,GAAG,IAAI,GAAG,IAAI,CAEnE;AAED,uFAAuF;AACvF,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI,CAMtE;AAED,kEAAkE;AAClE,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,IAAI,CAEhE"}