pinecall-protocol 0.1.0__tar.gz

pinecall_protocol-0.1.0/.gitignore

@@ -0,0 +1,14 @@
+.venv/
+__pycache__/
+.pytest_cache/
+.ruff_cache/
+node_modules/
+dist/
+
+# The decision page is this laptop's engineering notes, not documentation: on disk, out of every clone.
+docs/decision.md
+
+# Ruby
+Gemfile.lock
+pkg/
+.bundle/

pinecall_protocol-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

pinecall_protocol-0.1.0/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.

pinecall_protocol-0.1.0/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.5
+Name: pinecall-protocol
+Version: 0.1.0
+Summary: The Pinecall wire: pydantic models generated from the protocol schema
+Author-email: Bernardo Castro <me@bernardocastro.dev>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.12
+Requires-Dist: pydantic<3,>=2.7
+Description-Content-Type: text/markdown
+
+# pinecall-protocol
+
+The Python side of the Pinecall wire: pydantic v2 models, the event and command registries and
+the codec, generated from the schema one directory up. Never edited by hand; see `../README.md`.

pinecall_protocol-0.1.0/README.md

@@ -0,0 +1,4 @@
+# pinecall-protocol
+
+The Python side of the Pinecall wire: pydantic v2 models, the event and command registries and
+the codec, generated from the schema one directory up. Never edited by hand; see `../README.md`.

pinecall_protocol-0.1.0/pinecall_protocol/__init__.py

@@ -0,0 +1,41 @@
+"""Generated from schema/ by `python generate`. Never edited by hand."""
+
+from pinecall_protocol._base import ProtocolError, WireModel
+from pinecall_protocol.codec import (
+    command_of,
+    decode_entries,
+    decode_entry,
+    encode,
+    event_of,
+)
+from pinecall_protocol.envelope import Command, Entry
+from pinecall_protocol.registry import (
+    COMMANDS,
+    EPHEMERAL_EVENTS,
+    EVENTS,
+    PRODUCES,
+    TERMINAL_EVENT,
+    CommandType,
+    EventType,
+)
+from pinecall_protocol.state import State
+
+__all__ = [
+    "COMMANDS",
+    "EPHEMERAL_EVENTS",
+    "EVENTS",
+    "PRODUCES",
+    "TERMINAL_EVENT",
+    "Command",
+    "CommandType",
+    "Entry",
+    "EventType",
+    "ProtocolError",
+    "State",
+    "WireModel",
+    "command_of",
+    "decode_entries",
+    "decode_entry",
+    "encode",
+    "event_of",
+]

pinecall_protocol-0.1.0/pinecall_protocol/_base.py

@@ -0,0 +1,13 @@
+"""The base every wire model shares: unknown keys are refused; a field builds by name or alias."""
+
+from pydantic import BaseModel, ConfigDict
+
+
+class WireModel(BaseModel):
+    """A shape on the wire. extra=forbid is the schema's additionalProperties: false."""
+
+    model_config = ConfigDict(extra="forbid", validate_by_name=True, validate_by_alias=True)
+
+
+class ProtocolError(ValueError):
+    """A message did not match the protocol: unknown type, bad shape, a seq out of order."""

pinecall_protocol-0.1.0/pinecall_protocol/_version.py

@@ -0,0 +1,4 @@
+"""The one place the version lives; hatch reads it from here at build time."""
+
+# 0.0.0 means "unreleased". The number is the maintainer's call and is never bumped from code.
+__version__ = "0.1.0"

pinecall_protocol-0.1.0/pinecall_protocol/codec.py

@@ -0,0 +1,52 @@
+"""JSON in, models out, and back. The only file that touches a key name: aliases, by_alias."""
+
+from typing import Any
+
+from pydantic import TypeAdapter, ValidationError
+
+from pinecall_protocol._base import ProtocolError, WireModel
+from pinecall_protocol.envelope import Command, Entry
+from pinecall_protocol.registry import COMMANDS, EVENTS
+
+_LOG: TypeAdapter[list[Entry]] = TypeAdapter(list[Entry])
+
+
+def decode_entry(raw: dict[str, Any]) -> Entry:
+    """One log line from decoded JSON. A bad shape is a ProtocolError."""
+    return _validate(Entry, raw, "entry")
+
+
+def decode_entries(text: str) -> list[Entry]:
+    """A whole log from a JSON array text, in the order it came."""
+    try:
+        return _LOG.validate_json(text)
+    except ValidationError as error:
+        raise ProtocolError(f"log: {error}") from error
+
+
+def event_of(entry: Entry) -> WireModel:
+    """The entry's data as the model its type names. Unknown type or bad shape: ProtocolError."""
+    model = EVENTS.get(entry.type)
+    if model is None:
+        raise ProtocolError(f"unknown event type: {entry.type}")
+    return _validate(model, entry.data, entry.type)
+
+
+def command_of(command: Command) -> WireModel:
+    """The command's data as the model its type names. Unknown type or bad shape: ProtocolError."""
+    model = COMMANDS.get(command.type)
+    if model is None:
+        raise ProtocolError(f"unknown command type: {command.type}")
+    return _validate(model, command.data, command.type)
+
+
+def encode(model: WireModel) -> dict[str, Any]:
+    """A model as it goes on the wire: wire key names, absent fields absent, JSON-ready values."""
+    return model.model_dump(mode="json", by_alias=True, exclude_unset=True)
+
+
+def _validate[T: WireModel](model: type[T], raw: dict[str, Any], what: str) -> T:
+    try:
+        return model.model_validate(raw)
+    except ValidationError as error:
+        raise ProtocolError(f"{what}: {error}") from error

pinecall_protocol-0.1.0/pinecall_protocol/commands.py

@@ -0,0 +1,208 @@
+"""Generated from schema/commands/: one model per command."""
+
+from typing import Any, Literal
+
+from pydantic import Field
+
+from pinecall_protocol._base import WireModel
+from pinecall_protocol.defs import AgentConfig, Contact, Route, Supervisor, ToolSpec, TransferMode
+from pinecall_protocol.verbs import Verb
+
+
+# Declare or change what the agent is: voice, models, language, greeting, the full tool list. Only
+# the fields sent change.
+class AgentConfigure(WireModel):
+    """Declare or change what the agent is."""
+
+    config: AgentConfig
+
+
+# The gateway answers agent.registered, or error.
+class AgentRegister(WireModel):
+    """The app's first message: this socket speaks for this agent and answers these doors."""
+
+    routes: list[Route]
+    sdk: str | None = None
+    takes_unclaimed: bool = True
+
+
+# Make the model speak now, guided by an instruction it reads and the caller never hears: 'tell them
+# a slot at 10:15 just opened'. On livekit's session.generate_reply; the sibling of agent.say, which
+# speaks verbatim. The reply lands as turn.agent.
+class AgentReply(WireModel):
+    """Make the model speak now, guided by an instruction it reads and the caller never hears."""
+
+    instructions: str
+    allow_interruptions: bool | None = None
+
+
+# Make the agent say this text now, verbatim, outside the model's turn: a greeting, a read-back, a
+# system notice. The reply lands as turn.agent.
+class AgentSay(WireModel):
+    """Make the agent say this text now, verbatim, outside the model's turn."""
+
+    text: str
+    allow_interruptions: bool | None = None
+
+
+# The new call's log opens with call.dialing; call.started follows when the far end answers.
+class CallDial(WireModel):
+    """Place an outbound call as this agent."""
+
+    to: str
+    from_: str | None = Field(None, alias="from")
+    caller: Contact | None = None
+    metadata: dict[str, Any] | None = None
+
+
+class CallDtmf(WireModel):
+    """Send touch tones down the line, for an IVR on the far end."""
+
+    digits: str
+
+
+# Hand the agent a fact from the tenant's backend: a slot freed, an order shipped, a payment
+# confirmed. Lands as event.received with source app. The agent must have declared the name in its
+# events with app among the senders, or the gateway answers error and nothing touches the log.
+class CallEvent(WireModel):
+    """Hand the agent a fact from the tenant's backend."""
+
+    name: str
+    data: dict[str, Any]
+
+
+# call.ended follows with reason agent_hung_up.
+class CallHangup(WireModel):
+    """End the call from the app's side."""
+
+    reason: str | None = None
+
+
+class CallHold(WireModel):
+    """Put the caller on hold: they hear hold audio, the agent hears nothing."""
+
+
+# It gets a seq like everything else and lands as custom.
+class CallLog(WireModel):
+    """Write a line of the app's own into the call's log."""
+
+    name: str
+    data: dict[str, Any]
+
+
+class CallMute(WireModel):
+    """Mute the agent: it keeps listening and thinking, produces no audio."""
+
+
+# call.transferred says whether it worked.
+class CallTransfer(WireModel):
+    """Send the caller to another number."""
+
+    to: str
+    mode: TransferMode
+
+
+class CallUnhold(WireModel):
+    """Take the caller off hold."""
+
+
+class CallUnmute(WireModel):
+    """Unmute the agent."""
+
+
+# Why the verb did not run, in the words the console shows: the status it travels under, and the
+# sentence.
+class DevRefusal(WireModel):
+    """Why the verb did not run, in the words the console shows."""
+
+    status: int
+    detail: str
+
+
+class DevAnswer(WireModel):
+    """What came of one dev.request, named by its id."""
+
+    id: str
+    result: dict[str, Any] | None = None
+    refused: DevRefusal | None = None
+
+
+# Silence a participant for the rest of the call: their audio leaves the room, for everyone in it.
+# Lands as track.unpublished for their microphone. There is no unmute; a leg that must speak again
+# is invited again.
+class ParticipantMute(WireModel):
+    """Silence a participant for the rest of the call."""
+
+    identity: str
+
+
+# Lands as participant.left with reason participant_removed. Removing the caller ends the call.
+class ParticipantRemove(WireModel):
+    """Put a participant out of the room."""
+
+    identity: str
+
+
+class Ping(WireModel):
+    """Is the socket alive? The gateway answers pong."""
+
+
+# The name must be one of the agent's declared blocks, or one of the default four; anything else is
+# refused with the name.
+class PromptSet(WireModel):
+    """Rewrite one block of the prompt, whole, by name."""
+
+    name: str
+    text: str
+
+
+# A second SIP leg dialed to a number is the warm path: the agent stays on with the caller while the
+# other side answers. Lands as participant.joined when they arrive, or error when they do not.
+class RoomInvite(WireModel):
+    """Bring somebody else into the call's room."""
+
+    to: str
+    kind: Literal["sip", "participant"]
+
+
+# Push a payload to a browser in the room over the DataChannel: a card to render, a form to open.
+# Lands as room.sent with the size, never the payload. The widget listens on pinecall.ui; a topic of
+# the tenant's own reaches the tenant's own page code.
+class RoomSend(WireModel):
+    """Push a payload to a browser in the room over the DataChannel."""
+
+    topic: str
+    data: dict[str, Any]
+    to: str | None = None
+
+
+# Set up this one call before the first turn: the app's initial state, and any config that differs
+# from the agent's defaults for this caller.
+class SessionConfigure(WireModel):
+    """Set up this one call before the first turn."""
+
+    state: dict[str, Any] | None = None
+    config: AgentConfig | None = None
+
+
+# The platform logs state.changed and re-renders.
+class StateSet(WireModel):
+    """The app's state changed and this is all of it."""
+
+    state: dict[str, Any]
+    changed: list[str] | None = None
+
+
+class SupervisorVerb(WireModel):
+    """One supervise verb, from the human the door named."""
+
+    by: Supervisor
+    verb: Verb
+
+
+# The full list was declared in agent.configure; this is the subset whose when allows them in this
+# state.
+class ToolsSet(WireModel):
+    """The tools the model may see now."""
+
+    tools: list[ToolSpec]