pinecall 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 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,134 @@
+# pinecall
+
+Write an agent as a class. Its fields are what it remembers, its `@tool` methods are what the
+model may do, its docstrings are the prompt, and its `render()` is what it says about right now.
+
+```tsx
+export default class ClinicaNorte extends Agent {
+  phone = "+34910000000";
+  language = "es";
+
+  stage: Stages<"identify" | "choose" | "book"> = "identify";
+  patient?: Patient;
+  slot?: Slot;
+
+  /** Busca al paciente por nombre y teléfono. Pide los dos antes de llamarla. */
+  @tool({ stage: "identify" })
+  async findPatient(name: string, phone: string): Promise<Patient | null> {
+    this.patient = await agenda.find(name, phone);
+    if (this.patient) this.stage = "choose";
+    return this.patient;
+  }
+
+  /** El prompt como función del estado: lo único que cambia entre dos turnos. */
+  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>}
+      </>
+    );
+  }
+}
+```
+
+One class, three doors: the same agent answers the web, WhatsApp and the telephone, and
+remembers the customer across them. What does the real time — the audio, the rooms, the log,
+the tenants — is `pinecall/runtime`, a Python distribution this package never imports and only
+ever talks to over a socket.
+
+```
+npm install pinecall
+```
+
+## Five minutes
+
+```
+pnpm install                       nothing to build: the checkout runs from its sources
+cd examples/clinica-norte
+pnpm exec pinecall chat            the agent in this terminal, and a prompt against it
+pnpm exec pinecall prompt --state test/prompts/states.json   the exact prompt a state produces
+pnpm exec pinecall run             the app: the process you deploy
+pnpm exec pinecall knowledge push  ./knowledge/docs to the gateway, under the agent's name
+pnpm exec pinecall test            ring 1: the goldens, through the app in this process
+                                   `run` prints the console's URL: the gateway serves the page,
+                                   and the code in the URL signs this browser in, once
+```
+
+A tenant that installed `pinecall` from npm has it on the PATH and writes `pinecall run`.
+
+Working on the framework itself:
+
+```
+pnpm test          the framework and the console, in two vitest projects, from the sources
+pnpm lint          tsc over src and test, then over the console against the DOM
+scripts/build      what is published: dist/, and the console bundle inside it
+scripts/check      build, then lint, then test — what CI runs
+```
+
+`package.json` exports point at `src/`, and `publishConfig` swaps them for `dist/` at publish
+time. So a checkout — this one, and every example in it — imports the framework's sources
+through `node_modules` like any package, and there is no build between a change and a test.
+
+## The map
+
+`src/` is the package. Six directories, and the import table in `test/the-imports.test.ts` is
+what keeps them apart — a directory earns its place there by having a line. What each one is,
+file by file, is [ARCHITECTURE.md](ARCHITECTURE.md).
+
+| directory | what it is |
+|---|---|
+| `agent/` | the class a tenant extends: the Proxy, `@tool`, `@render`, `@state`, the stages, the hooks |
+| `views/` | the JSX-to-text runtime, and the prompt as named blocks in two regions |
+| `call/` | the live call as a value: the room, the turns, the verbs. Reduced from entries |
+| `client/` | `pinecall/client` — the socket, and nothing above it. Knows only the wire |
+| `runtime/` | the bridge: what the class does, become what the wire sees |
+| `cli/` | `pinecall <verb>`, and under `cli/ui/console/` the page one of them serves |
+
+Beside it:
+
+| | |
+|---|---|
+| `examples/` | `clinica-norte` and `tienda-sur`: two tenants, written as a customer writes one |
+| `test/` | mirrors `src/`, plus the three that pin the shape: the tree, the imports, the surface |
+
+## The three doors out of this package
+
+- `pinecall` — the framework: the class, the JSX-to-text runtime, the call, and `mount()`.
+- `pinecall/client` — the socket alone, for an app that decides for itself what to answer.
+- `pinecall/tsconfig.tenant.json` — the compiler flags an agent needs, so a tenant writes none.
+
+`test/index.test.ts` and `test/client/index.test.ts` pin the first two by name. Adding an export
+means editing a list on purpose, which is the point.
+
+## Where the rest is
+
+| | |
+|---|---|
+| [ARCHITECTURE.md](ARCHITECTURE.md) | what this package is, file by file: the entities, the bridge, the CLI, the console, the import table, and where LiveKit is and is not |
+| the runtime's `docs/from-zero.md` | **self-hosting**: a runtime of your own, from nothing, through to this clinic answering — every command run, every output what came back |
+| [docs/tutorial.md](docs/tutorial.md) | from an empty directory to an agent that answers from your documents and remembers who called |
+| [docs/writing-an-agent.md](docs/writing-an-agent.md) | the class: state, tools, stages, channels, knowledge · docs · memory, hooks, events |
+| [docs/the-prompt.md](docs/the-prompt.md) | the prompt: named blocks in two regions, `render()`, where what a lookup found lands, and where a rule belongs |
+| [docs/testing-an-agent.md](docs/testing-an-agent.md) | the five rings: unit tests, goldens, personas, one call replayed, the score every call gets |
+| [docs/testing-memory-and-knowledge.md](docs/testing-memory-and-knowledge.md) | memory's own goldens, the index's, and why a call has no retrieval score |
+| [docs/the-cli.md](docs/the-cli.md) | every verb, what it needs, and where its key comes from |
+| [docs/worlds-and-teams.md](docs/worlds-and-teams.md) | from the sign-up to the deploy: the two worlds, what is yours and what is the org's, the team and its seats |
+| [CHANGELOG.md](CHANGELOG.md) · [CLAUDE.md](CLAUDE.md) | what changed · the working agreement |
+
+## The wire
+
+`@pinecall/protocol` is generated from JSON Schema in `pinecall/protocol` and committed there,
+so nothing here runs a generator. `pnpm-workspace.yaml` names that checkout as a workspace
+package until it is published, and that package exports its sources the same way. The golden call log comes from the same package, which is how a
+log folded here and a log folded in Python are proved to be the same log.
+
+## License
+
+[Apache-2.0](LICENSE). Use it, change it, run it in production, sell what you build with it —
+commercially or not, on your own box or somebody else's. The licence carries an explicit patent
+grant, which is why it is the one this stack uses (LiveKit's is the same). There is no NOTICE
+file, so nothing has to be reproduced downstream beyond the licence itself, and there is no CLA:
+a patch is yours and stays under the same terms.
+
+`pinecall` on npm, `pinecall/client` beside it. `@pinecall/protocol` is Apache-2.0 too.

package/dist/agent/accepts.d.ts

@@ -0,0 +1,32 @@
+/** `static events`: the outside facts this class accepts, and from whom. */
+/** Where an outside fact came from: the tenant's backend, or a participant's browser. */
+export type EventSource = "app" | "participant";
+/** One event the class accepts. `from` is who may send it; nobody else ever reaches the hook. */
+export interface EventDecl {
+    from: EventSource[];
+}
+/** The class's declaration, as the tenant writes it: `{ "cart.changed": { from: ["app"] } }`. */
+export type EventDeclarations = Record<string, EventDecl>;
+/** One declaration in the shape AgentConfig.events carries it. */
+export interface EventSpec {
+    name: string;
+    from: EventSource[];
+}
+/** What arrived with an event: who sent it, which participant if any, and its place in the log. */
+export interface EventMeta {
+    source: EventSource;
+    identity?: string;
+    seq: number;
+}
+/**
+ * Every event this class declares, parents first — a subclass adding one keeps the parent's, and
+ * redeclaring a name replaces it whole rather than merging two lists of senders.
+ */
+export declare function eventsOf(ctor: Function): EventSpec[];
+/**
+ * Whether this class accepts `name` from `source`. The gateway asks the same question before the
+ * event touches the log; the runtime asks it again because a log can be replayed and a hook that
+ * runs on an undeclared name is a hook the tenant never agreed to.
+ */
+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,4EAA4E;AAE5E,yFAAyF;AACzF,MAAM,MAAM,WAAW,GAAG,KAAK,GAAG,aAAa,CAAC;AAEhD,iGAAiG;AACjG,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,WAAW,EAAE,CAAC;CACrB;AAED,iGAAiG;AACjG,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;AAE1D,kEAAkE;AAClE,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,WAAW,EAAE,CAAC;CACrB;AAED,mGAAmG;AACnG,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;;;;GAIG;AACH,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,28 @@
+/** `static events`: the outside facts this class accepts, and from whom. */
+/**
+ * Every event this class declares, parents first — a subclass adding one keeps the parent's, and
+ * redeclaring a name replaces it whole rather than merging two lists of senders.
+ */
+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 this class accepts `name` from `source`. The gateway asks the same question before the
+ * event touches the log; the runtime asks it again because a log can be replayed and a hook that
+ * runs on an undeclared name is a hook the tenant never agreed to.
+ */
+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,4EAA4E;AA0B5E;;;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;;;;GAIG;AACH,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,189 @@
+/** The Agent base class: its fields are the state, and every assignment is a change with an author. */
+import type { DocsMode } from "@pinecall/protocol";
+import { type ToolSpec } from "./tools.js";
+import type { Child } from "../views/jsx-runtime.js";
+import type { CallWorld } from "../call/call.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", "voice", "greeting", "says", "hears", "llm", "language", "knowledge", "docs", "memory", "hangup"];
+/** 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;
+/** One named fact the agent put in the call's log. */
+export interface LogEntry {
+    seq: number;
+    name: string;
+    data?: unknown;
+    at: number;
+}
+export type LogListener = (entry: LogEntry) => void;
+/** One outside fact, as an in-process observer reads it after the hook has had it. */
+export interface EventHeard {
+    name: string;
+    data: Record<string, unknown>;
+    meta: EventMeta;
+}
+export type EventListener = (heard: EventHeard) => void;
+/**
+ * What `docs` says: the knowledge base the agent answers from, by the name it was pushed under
+ * (`pinecall knowledge push --base <name>`), and how its chunks reach the model. The bare string
+ * form `docs = "clinica-norte"` is the base alone, with every other setting the runtime's.
+ */
+export interface DocsDeclaration {
+    base: string;
+    mode?: DocsMode;
+    k?: number;
+    minScore?: number;
+}
+/**
+ * What `greeting` says: how the agent opens a call, before the caller has said anything. Exactly
+ * one of the two, because there are only two ways to open one — `say` are the words themselves,
+ * read out as written, and `reply` is what the model is told before it finds its own. The bare
+ * string form `greeting = "Clínica Norte, buenos días."` is the words. A class that declares
+ * nothing waits for the caller.
+ */
+export interface GreetingDeclaration {
+    say?: string;
+    reply?: string;
+    allowInterruptions?: boolean;
+}
+/**
+ * What `hangup` says: that the model may end the call itself, and when, in your own words. A class
+ * that declares nothing cannot hang up — only the caller and a supervisor end a call. The tool is
+ * livekit's own `end_call`, and it is hidden while the agent is greeting.
+ */
+export interface HangupDeclaration {
+    when?: string;
+}
+/** What `memory` says: what to keep about a contact across calls, in the tenant's words, and what never to. */
+export interface MemoryDeclaration {
+    remember?: string[];
+    forget?: string[];
+}
+/** Everything the framework knows about one live agent, 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;
+    /** The call this instance is serving, set by the bridge at start() and never by the app. */
+    call: CallWorld | null;
+    /** Where `last(contact)` reads from: `mount({ last })`, per mounted agent and never a global. */
+    last: LastCall | null;
+    /** What memory has recalled about this caller so far, as `remembers(text)` reads it. Per call. */
+    recalled: string[];
+}
+/**
+ * The base every app agent extends. The constructor hands back a Proxy, so a plain
+ * `this.patient = row` inside a tool is the whole state API: one change, one author, one seq.
+ */
+export declare class Agent {
+    constructor();
+    /** The class docstring, when the app prefers to say it out loud instead of in a JSDoc. */
+    static doc?: string;
+    /** The outside facts this class accepts, and from whom: `static events = {...}`. */
+    static events?: EventDeclarations;
+    /** Who may see a field, for a class that would rather write a map than a `@state`. */
+    static visibility?: Record<string, Visibility>;
+    /** What this agent is, as the model reads it: the class's own docstring. */
+    doc(): string | undefined;
+    /**
+     * The prompt as a function of the state: what to do about THIS turn, in the class's own words.
+     * It is the whole dynamic region and the last thing the model reads. The base renders nothing,
+     * so a class that says nothing about the turn sends an empty block.
+     */
+    render(): Child;
+    /**
+     * Whether memory has already told this call something about the caller under those words — the
+     * word a fact was filed under, or the fact itself. The runtime supplies the facts; before it has
+     * recalled anything this answers false, which is exactly what a caller nobody has met looks like.
+     */
+    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[];
+    /** Drop the change log and keep one sentence in its place; the state itself stays. */
+    collapse(summary: string): void;
+    /** Put the agent back to a snapshot — the move `onCall` makes when a caller comes back. */
+    restore(state: Snapshot): void;
+    /**
+     * Start the agent in the state a case describes: the fields it names, written over the ones the
+     * agent already has — on a fresh instance, the ones the class gave itself. A goldens case names
+     * what it is about and nothing else, so `restore` is the wrong door for it: a snapshot is a
+     * WHOLE state, and restoring one clears every field it leaves out.
+     */
+    startIn(state: Snapshot): void;
+    /** What this contact left behind last time. Wired per mount: `mount(Class, { pc, last })`. */
+    last(contact: string): Promise<Snapshot | null>;
+    /** Put a named fact in the call's log, for the console and for whatever reads it after. */
+    log(name: string, data?: unknown): void;
+    /**
+     * The call being served right now. It is a getter on the base class, not a field, so it never
+     * looks like state and never reaches a snapshot; a class that declares its own `call` field is
+     * refused at the first write, because there is only one thing that name can mean here.
+     */
+    get call(): CallWorld;
+    /** Say this, word for word, now. Resolves true when the turn it lands as arrived. */
+    say(text: string, options?: {
+        allowInterruptions?: boolean;
+    }): Promise<boolean>;
+    /** Make the model speak now, guided by words the caller never hears. Resolves like `say`. */
+    reply(instructions: string, options?: {
+        allowInterruptions?: boolean;
+    }): Promise<boolean>;
+    /** Watch this agent from inside the tenant's own process: every state change, or every event. */
+    on(type: "state", listener: ChangeListener): () => void;
+    on(type: "event", listener: EventListener): () => void;
+    /** An outside fact the class declared arrived. Override it; writes here are authored by it. */
+    onEvent(_name: string, _data: Record<string, unknown>, _meta: EventMeta): unknown;
+    /** A call started. Override it; assigning state here is authored by the hook, not by nobody. */
+    onCall(_call: Call): unknown;
+    /** The call ended. Override it to write anything the call is worth writing. */
+    onEnd(_call: Call): unknown;
+    /** Memory was written. Override it to send the ops wherever the tenant keeps them. */
+    onMemory(_ops: MemoryOp[], _call: Call): unknown;
+}
+/** The framework's bookkeeping for one agent, or a clear error if this is not an agent. */
+export declare function internalsOf(agent: object): Internals;
+/**
+ * Close the declaration and start recording. Everything assigned before this — the field
+ * initializers that give the state its shape — is the baseline, not a change.
+ */
+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[];
+/** Hear every field assignment as it happens; the returned function stops listening. */
+export declare function onChange(agent: object, listener: ChangeListener): () => void;
+/** Everything this agent logged, oldest first. */
+export declare function logOf(agent: object): readonly LogEntry[];
+/** Hear every logged fact as it happens; the returned function stops listening. */
+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;
+/** Hand this instance the store its `last(contact)` reads. The bridge does this at start(). */
+export declare function setLast(agent: object, source: LastCall | null): void;
+/** Hand this instance the call it is serving. The bridge does this once, at start(). */
+export declare function setCall(agent: object, call: CallWorld | null): void;
+/**
+ * Hand this instance what memory has recalled about the caller: every fact, and the word it was
+ * filed under. The bridge does this from the call's own `memory.ops` entries, so `remembers(text)`
+ * answers with what the runtime actually found and never with a guess.
+ */
+export declare function recalled(agent: object, words: readonly string[]): void;
+/** Tell the in-process observers about an event the hook has just been given. */
+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,KAAK,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAGnD,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,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,YACxB,OAAO,EACP,UAAU,EACV,KAAK,EACL,OAAO,EACP,UAAU,EACV,MAAM,EACN,OAAO,EACP,KAAK,EACL,UAAU,EACV,WAAW,EACX,MAAM,EACN,QAAQ,EACR,QAAQ,CACA,CAAC;AAMX,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,sDAAsD;AACtD,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,sFAAsF;AACtF,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;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,mBAAmB;IAClC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,+GAA+G;AAC/G,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,+FAA+F;AAC/F,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,4FAA4F;IAC5F,IAAI,EAAE,SAAS,GAAG,IAAI,CAAC;IACvB,iGAAiG;IACjG,IAAI,EAAE,QAAQ,GAAG,IAAI,CAAC;IACtB,kGAAkG;IAClG,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAID;;;GAGG;AACH,qBAAa,KAAK;IAChB,cA0CC;IAED,0FAA0F;IAC1F,MAAM,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IAEpB,oFAAoF;IACpF,MAAM,CAAC,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAElC,sFAAsF;IACtF,MAAM,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAE/C,4EAA4E;IAC5E,GAAG,IAAI,MAAM,GAAG,SAAS,CAExB;IAED;;;;OAIG;IACH,MAAM,IAAI,KAAK,CAEd;IAED;;;;OAIG;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,sFAAsF;IACtF,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAE9B;IAED,2FAA2F;IAC3F,OAAO,CAAC,KAAK,EAAE,QAAQ,GAAG,IAAI,CAE7B;IAED;;;;;OAKG;IACH,OAAO,CAAC,KAAK,EAAE,QAAQ,GAAG,IAAI,CAE7B;IAED,8FAA8F;IAC9F,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,CAQ9C;IAED,2FAA2F;IAC3F,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,GAAG,IAAI,CAMtC;IAED;;;;OAIG;IACH,IAAI,IAAI,IAAI,SAAS,CASpB;IAED,qFAAqF;IACrF,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,kBAAkB,CAAC,EAAE,OAAO,CAAA;KAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAElF;IAED,6FAA6F;IAC7F,KAAK,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,kBAAkB,CAAC,EAAE,OAAO,CAAA;KAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAE5F;IAED,iGAAiG;IACjG,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,+FAA+F;IAC/F,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,KAAK,EAAE,SAAS,GAAG,OAAO,CAEhF;IAED,gGAAgG;IAChG,MAAM,CAAC,KAAK,EAAE,IAAI,GAAG,OAAO,CAE3B;IAED,+EAA+E;IAC/E,KAAK,CAAC,KAAK,EAAE,IAAI,GAAG,OAAO,CAE1B;IAED,sFAAsF;IACtF,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,IAAI,GAAG,OAAO,CAE/C;CACF;AAED,2FAA2F;AAC3F,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAIpD;AAED;;;GAGG;AACH,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,wFAAwF;AACxF,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,mFAAmF;AACnF,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,+FAA+F;AAC/F,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,GAAG,IAAI,GAAG,IAAI,CAEpE;AAED,wFAAwF;AACxF,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,GAAG,IAAI,GAAG,IAAI,CAEnE;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI,CAMtE;AAED,iFAAiF;AACjF,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,IAAI,CAEhE"}