@pinecall/protocol 0.5.0 → 0.6.1

package/dist/generated/codec.d.ts

@@ -46,7 +46,7 @@ export type Snake<T> = T extends readonly (infer Item)[] ? Snake<Item>[] : T ext
 } : T;
 /** The keys whose values belong to the app (its state, a tool's arguments, a map it named): never renamed below them. */
 export declare const OPAQUE_KEYS: Set<string>;
-export type OpaqueKey = "app_state" | "arguments" | "attributes" | "data" | "input" | "metadata" | "output" | "parameters" | "prompt" | "result" | "state";
+export type OpaqueKey = "app_state" | "arguments" | "attributes" | "data" | "facts" | "input" | "metadata" | "output" | "parameters" | "prompt" | "result" | "state";
 /** Rename every key from snake_case to camelCase, deep. Values are never touched. */
 export declare function toCamel<T>(value: T): Camel<T>;
 /** Rename every key from camelCase to snake_case, deep. Values are never touched. */

package/dist/generated/codec.js

@@ -37,7 +37,7 @@ export function isCommandType(type) {
     return Object.hasOwn(COMMAND_SCHEMAS, type);
 }
 /** The keys whose values belong to the app (its state, a tool's arguments, a map it named): never renamed below them. */
-export const OPAQUE_KEYS = new Set(["app_state", "arguments", "attributes", "data", "input", "metadata", "output", "parameters", "prompt", "result", "state"]);
+export const OPAQUE_KEYS = new Set(["app_state", "arguments", "attributes", "data", "facts", "input", "metadata", "output", "parameters", "prompt", "result", "state"]);
 /** Rename every key from snake_case to camelCase, deep. Values are never touched. */
 export function toCamel(value) {
     return renameKeys(value, camelCase);

package/dist/generated/commands.d.ts

@@ -8,8 +8,8 @@ export declare const AgentConfigureSchema: z.ZodObject<{
         prompt: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
             name: z.ZodString;
             region: z.ZodEnum<{
-                static: "static";
                 dynamic: "dynamic";
+                static: "static";
             }>;
         }, z.core.$strict>>>>;
         language: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -46,10 +46,6 @@ export declare const AgentConfigureSchema: z.ZodObject<{
         knowledge: z.ZodOptional<z.ZodNullable<z.ZodObject<{
             path: z.ZodString;
             text: z.ZodString;
-            mode: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
-                retrieved: "retrieved";
-                whole: "whole";
-            }>>>;
         }, z.core.$strict>>>;
         docs: z.ZodOptional<z.ZodNullable<z.ZodObject<{
             base: z.ZodString;
@@ -72,9 +68,9 @@ export declare const AgentConfigureSchema: z.ZodObject<{
             description: z.ZodString;
             parameters: z.ZodRecord<z.ZodString, z.ZodUnknown>;
             side_effect: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+                irreversible: "irreversible";
                 read: "read";
                 write: "write";
-                irreversible: "irreversible";
             }>>>;
             confirm: z.ZodOptional<z.ZodNullable<z.ZodString>>;
             pii: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
@@ -84,9 +80,9 @@ export declare const AgentConfigureSchema: z.ZodObject<{
         state_fields: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
             name: z.ZodString;
             visibility: z.ZodEnum<{
+                pii: "pii";
                 public: "public";
                 tenant: "tenant";
-                pii: "pii";
             }>;
         }, z.core.$strict>>>>;
         events: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
@@ -260,8 +256,8 @@ export type PromptSet = z.infer<typeof PromptSetSchema>;
 export declare const RoomInviteSchema: z.ZodObject<{
     to: z.ZodString;
     kind: z.ZodEnum<{
-        sip: "sip";
         participant: "participant";
+        sip: "sip";
     }>;
 }, z.core.$strict>;
 export type RoomInvite = z.infer<typeof RoomInviteSchema>;
@@ -286,8 +282,8 @@ export declare const SessionConfigureSchema: z.ZodObject<{
         prompt: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
             name: z.ZodString;
             region: z.ZodEnum<{
-                static: "static";
                 dynamic: "dynamic";
+                static: "static";
             }>;
         }, z.core.$strict>>>>;
         language: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -324,10 +320,6 @@ export declare const SessionConfigureSchema: z.ZodObject<{
         knowledge: z.ZodOptional<z.ZodNullable<z.ZodObject<{
             path: z.ZodString;
             text: z.ZodString;
-            mode: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
-                retrieved: "retrieved";
-                whole: "whole";
-            }>>>;
         }, z.core.$strict>>>;
         docs: z.ZodOptional<z.ZodNullable<z.ZodObject<{
             base: z.ZodString;
@@ -350,9 +342,9 @@ export declare const SessionConfigureSchema: z.ZodObject<{
             description: z.ZodString;
             parameters: z.ZodRecord<z.ZodString, z.ZodUnknown>;
             side_effect: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+                irreversible: "irreversible";
                 read: "read";
                 write: "write";
-                irreversible: "irreversible";
             }>>>;
             confirm: z.ZodOptional<z.ZodNullable<z.ZodString>>;
             pii: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
@@ -362,9 +354,9 @@ export declare const SessionConfigureSchema: z.ZodObject<{
         state_fields: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
             name: z.ZodString;
             visibility: z.ZodEnum<{
+                pii: "pii";
                 public: "public";
                 tenant: "tenant";
-                pii: "pii";
             }>;
         }, z.core.$strict>>>>;
         events: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
@@ -422,9 +414,9 @@ export declare const ToolsSetSchema: z.ZodObject<{
         description: z.ZodString;
         parameters: z.ZodRecord<z.ZodString, z.ZodUnknown>;
         side_effect: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+            irreversible: "irreversible";
             read: "read";
             write: "write";
-            irreversible: "irreversible";
         }>>>;
         confirm: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         pii: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;

package/dist/generated/defs.d.ts

@@ -30,32 +30,31 @@ export declare const EnvSchema: z.ZodEnum<{
 export type Env = z.infer<typeof EnvSchema>;
 /**
  * What a console may ask of the process standing in the agent's directory, relayed by the gateway:
- * a written call to the class mounted there (chat), a simulated caller from its personas, its
- * goldens and a suite of them, its knowledge folder pushed or its golden asked, its memory
+ * a written call to the class mounted there (chat), a simulated caller put on the class it holds,
+ * its goldens and a suite of them, its knowledge folder pushed or its golden asked, its memory
  * goldens, a call promoted to a candidate file, the drift of the last two windows, and the
  * reproductions a broken run left on that disk. Everything else a console needs is a door of the
  * gateway.
  */
 export declare const DevVerbSchema: z.ZodEnum<{
+    "chat.end": "chat.end";
     "chat.roster": "chat.roster";
-    "chat.start": "chat.start";
     "chat.say": "chat.say";
-    "chat.end": "chat.end";
-    "simulate.roster": "simulate.roster";
-    "simulate.start": "simulate.start";
+    "chat.start": "chat.start";
+    "drift.read": "drift.read";
     "goldens.roster": "goldens.roster";
     "goldens.run": "goldens.run";
-    "knowledge.roster": "knowledge.roster";
-    "knowledge.push": "knowledge.push";
     "knowledge.eval": "knowledge.eval";
-    "memory.roster": "memory.roster";
+    "knowledge.push": "knowledge.push";
+    "knowledge.roster": "knowledge.roster";
     "memory.eval": "memory.eval";
     "memory.extraction": "memory.extraction";
+    "memory.roster": "memory.roster";
     "promote.roster": "promote.roster";
     "promote.write": "promote.write";
-    "drift.read": "drift.read";
-    "reproductions.roster": "reproductions.roster";
     "reproductions.read": "reproductions.read";
+    "reproductions.roster": "reproductions.roster";
+    "simulate.start": "simulate.start";
 }>;
 export type DevVerb = z.infer<typeof DevVerbSchema>;
 /**
@@ -65,25 +64,25 @@ export type DevVerb = z.infer<typeof DevVerbSchema>;
  * both are nobody's fault and neither is an error.
  */
 export declare const EndReasonSchema: z.ZodEnum<{
-    caller_hung_up: "caller_hung_up";
     agent_hung_up: "agent_hung_up";
-    supervisor_ended: "supervisor_ended";
-    transferred: "transferred";
-    no_answer: "no_answer";
+    app_detached: "app_detached";
     busy: "busy";
+    caller_hung_up: "caller_hung_up";
     dial_failed: "dial_failed";
-    timeout: "timeout";
     drained: "drained";
-    app_detached: "app_detached";
     error: "error";
+    no_answer: "no_answer";
+    supervisor_ended: "supervisor_ended";
+    timeout: "timeout";
+    transferred: "transferred";
 }>;
 export type EndReason = z.infer<typeof EndReasonSchema>;
 /** Whose action ended the call. platform covers timeouts, errors and a drained worker. */
 export declare const EndedBySchema: z.ZodEnum<{
     agent: "agent";
     caller: "caller";
-    supervisor: "supervisor";
     platform: "platform";
+    supervisor: "supervisor";
 }>;
 export type EndedBy = z.infer<typeof EndedBySchema>;
 /**
@@ -92,9 +91,9 @@ export type EndedBy = z.infer<typeof EndedBySchema>;
  * nobody asked it — no model was reachable inside the call's judging budget.
  */
 export declare const ScoreVerdictSchema: z.ZodEnum<{
-    held: "held";
     broken: "broken";
     deferred: "deferred";
+    held: "held";
     skipped: "skipped";
 }>;
 export type ScoreVerdict = z.infer<typeof ScoreVerdictSchema>;
@@ -113,8 +112,8 @@ export type TransferMode = z.infer<typeof TransferModeSchema>;
  * written by the app.
  */
 export declare const PromptRegionSchema: z.ZodEnum<{
-    static: "static";
     dynamic: "dynamic";
+    static: "static";
 }>;
 export type PromptRegion = z.infer<typeof PromptRegionSchema>;
 /**
@@ -146,8 +145,8 @@ export type PlatformTool = z.infer<typeof PlatformToolSchema>;
 export declare const PromptBlockSpecSchema: z.ZodObject<{
     name: z.ZodString;
     region: z.ZodEnum<{
-        static: "static";
         dynamic: "dynamic";
+        static: "static";
     }>;
 }, z.core.$strict>;
 export type PromptBlockSpec = z.infer<typeof PromptBlockSpecSchema>;
@@ -156,9 +155,9 @@ export type PromptBlockSpec = z.infer<typeof PromptBlockSpecSchema>;
  * session's own.
  */
 export declare const UserStateSchema: z.ZodEnum<{
+    away: "away";
     listening: "listening";
     speaking: "speaking";
-    away: "away";
 }>;
 export type UserState = z.infer<typeof UserStateSchema>;
 /**
@@ -166,10 +165,10 @@ export type UserState = z.infer<typeof UserStateSchema>;
  * caller, generating, or playing audio.
  */
 export declare const AgentStateSchema: z.ZodEnum<{
+    idle: "idle";
+    initializing: "initializing";
     listening: "listening";
     speaking: "speaking";
-    initializing: "initializing";
-    idle: "idle";
     thinking: "thinking";
 }>;
 export type AgentState = z.infer<typeof AgentStateSchema>;
@@ -181,25 +180,25 @@ export type AgentState = z.infer<typeof AgentStateSchema>;
 export declare const ParticipantKindSchema: z.ZodEnum<{
     agent: "agent";
     caller: "caller";
-    supervisor: "supervisor";
     listener: "listener";
     sip: "sip";
+    supervisor: "supervisor";
 }>;
 export type ParticipantKind = z.infer<typeof ParticipantKindSchema>;
 /** What a track carries: a microphone's audio, a camera's video, or a screen share. */
 export declare const TrackKindSchema: z.ZodEnum<{
     audio: "audio";
-    video: "video";
     screen: "screen";
+    video: "video";
 }>;
 export type TrackKind = z.infer<typeof TrackKindSchema>;
 /** Where a track comes from, as livekit's TrackSource names it, in lower case. */
 export declare const TrackSourceSchema: z.ZodEnum<{
-    unknown: "unknown";
-    microphone: "microphone";
     camera: "camera";
+    microphone: "microphone";
     screen_share: "screen_share";
     screen_share_audio: "screen_share_audio";
+    unknown: "unknown";
 }>;
 export type TrackSource = z.infer<typeof TrackSourceSchema>;
 /**
@@ -216,9 +215,9 @@ export type EventSource = z.infer<typeof EventSourceSchema>;
  * (tenant, the default for a field never declared), or nobody without masking (pii).
  */
 export declare const VisibilitySchema: z.ZodEnum<{
+    pii: "pii";
     public: "public";
     tenant: "tenant";
-    pii: "pii";
 }>;
 export type Visibility = z.infer<typeof VisibilitySchema>;
 /**
@@ -272,9 +271,9 @@ export declare const ToolSpecSchema: z.ZodObject<{
     description: z.ZodString;
     parameters: z.ZodRecord<z.ZodString, z.ZodUnknown>;
     side_effect: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+        irreversible: "irreversible";
         read: "read";
         write: "write";
-        irreversible: "irreversible";
     }>>>;
     confirm: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     pii: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
@@ -312,9 +311,9 @@ export type MemoryFact = z.infer<typeof MemoryFactSchema>;
  */
 export declare const MemoryOpSchema: z.ZodObject<{
     op: z.ZodEnum<{
+        forget: "forget";
         recall: "recall";
         remember: "remember";
-        forget: "forget";
     }>;
     contact: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     query: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -349,12 +348,12 @@ export declare const CostRowSchema: z.ZodObject<{
     provider: z.ZodString;
     model: z.ZodString;
     unit: z.ZodEnum<{
-        input_tokens: "input_tokens";
-        cached_input_tokens: "cached_input_tokens";
+        audio_seconds: "audio_seconds";
         cache_creation_tokens: "cache_creation_tokens";
-        output_tokens: "output_tokens";
+        cached_input_tokens: "cached_input_tokens";
         characters: "characters";
-        audio_seconds: "audio_seconds";
+        input_tokens: "input_tokens";
+        output_tokens: "output_tokens";
         requests: "requests";
         session_seconds: "session_seconds";
     }>;
@@ -384,12 +383,12 @@ export declare const CostSchema: z.ZodObject<{
         provider: z.ZodString;
         model: z.ZodString;
         unit: z.ZodEnum<{
-            input_tokens: "input_tokens";
-            cached_input_tokens: "cached_input_tokens";
+            audio_seconds: "audio_seconds";
             cache_creation_tokens: "cache_creation_tokens";
-            output_tokens: "output_tokens";
+            cached_input_tokens: "cached_input_tokens";
             characters: "characters";
-            audio_seconds: "audio_seconds";
+            input_tokens: "input_tokens";
+            output_tokens: "output_tokens";
             requests: "requests";
             session_seconds: "session_seconds";
         }>;
@@ -437,9 +436,9 @@ export type Pronunciation = z.infer<typeof PronunciationSchema>;
 export declare const StateFieldSpecSchema: z.ZodObject<{
     name: z.ZodString;
     visibility: z.ZodEnum<{
+        pii: "pii";
         public: "public";
         tenant: "tenant";
-        pii: "pii";
     }>;
 }, z.core.$strict>;
 export type StateFieldSpec = z.infer<typeof StateFieldSpecSchema>;
@@ -455,14 +454,10 @@ export declare const EventSpecSchema: z.ZodObject<{
     }>>;
 }, z.core.$strict>;
 export type EventSpec = z.infer<typeof EventSpecSchema>;
-/** One file of knowledge, sent whole: its path as the tenant keeps it, and its text. */
+/** One file of a base, as a push sends it: its path as the tenant keeps it, and its text. */
 export declare const KnowledgeFileSchema: z.ZodObject<{
     path: z.ZodString;
     text: z.ZodString;
-    mode: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
-        retrieved: "retrieved";
-        whole: "whole";
-    }>>>;
 }, z.core.$strict>;
 export type KnowledgeFile = z.infer<typeof KnowledgeFileSchema>;
 /**
@@ -513,16 +508,18 @@ export declare const MemoryConfigSchema: z.ZodObject<{
 }, z.core.$strict>;
 export type MemoryConfig = z.infer<typeof MemoryConfigSchema>;
 /**
- * What an app declares about its agent: the voice, the models, the language, the greeting, the
- * tools, and who may see and send what. Every field is optional so a configure can change one
- * thing.
+ * What an app declares about its agent: the prompt's layout, the language, the tools, whether it
+ * searches its bases itself, and who may see and send what. Every field is optional so a configure
+ * can change one thing. The environment — voice, models, greeting, hangup, turn, says, hears,
+ * knowledge, docs, memory — is the world's, set in the agent's settings, and no longer read off
+ * this declaration.
  */
 export declare const AgentConfigSchema: z.ZodObject<{
     prompt: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
         name: z.ZodString;
         region: z.ZodEnum<{
-            static: "static";
             dynamic: "dynamic";
+            static: "static";
         }>;
     }, z.core.$strict>>>>;
     language: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -559,10 +556,6 @@ export declare const AgentConfigSchema: z.ZodObject<{
     knowledge: z.ZodOptional<z.ZodNullable<z.ZodObject<{
         path: z.ZodString;
         text: z.ZodString;
-        mode: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
-            retrieved: "retrieved";
-            whole: "whole";
-        }>>>;
     }, z.core.$strict>>>;
     docs: z.ZodOptional<z.ZodNullable<z.ZodObject<{
         base: z.ZodString;
@@ -585,9 +578,9 @@ export declare const AgentConfigSchema: z.ZodObject<{
         description: z.ZodString;
         parameters: z.ZodRecord<z.ZodString, z.ZodUnknown>;
         side_effect: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+            irreversible: "irreversible";
             read: "read";
             write: "write";
-            irreversible: "irreversible";
         }>>>;
         confirm: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         pii: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
@@ -597,9 +590,9 @@ export declare const AgentConfigSchema: z.ZodObject<{
     state_fields: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
         name: z.ZodString;
         visibility: z.ZodEnum<{
+            pii: "pii";
             public: "public";
             tenant: "tenant";
-            pii: "pii";
         }>;
     }, z.core.$strict>>>>;
     events: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{

package/dist/generated/defs.js

@@ -18,13 +18,13 @@ export const DirectionSchema = z.enum(["inbound", "outbound"]);
 export const EnvSchema = z.enum(["production", "sandbox"]);
 /**
  * What a console may ask of the process standing in the agent's directory, relayed by the gateway:
- * a written call to the class mounted there (chat), a simulated caller from its personas, its
- * goldens and a suite of them, its knowledge folder pushed or its golden asked, its memory
+ * a written call to the class mounted there (chat), a simulated caller put on the class it holds,
+ * its goldens and a suite of them, its knowledge folder pushed or its golden asked, its memory
  * goldens, a call promoted to a candidate file, the drift of the last two windows, and the
  * reproductions a broken run left on that disk. Everything else a console needs is a door of the
  * gateway.
  */
-export const DevVerbSchema = z.enum(["chat.roster", "chat.start", "chat.say", "chat.end", "simulate.roster", "simulate.start", "goldens.roster", "goldens.run", "knowledge.roster", "knowledge.push", "knowledge.eval", "memory.roster", "memory.eval", "memory.extraction", "promote.roster", "promote.write", "drift.read", "reproductions.roster", "reproductions.read"]);
+export const DevVerbSchema = z.enum(["chat.roster", "chat.start", "chat.say", "chat.end", "simulate.start", "goldens.roster", "goldens.run", "knowledge.roster", "knowledge.push", "knowledge.eval", "memory.roster", "memory.eval", "memory.extraction", "promote.roster", "promote.write", "drift.read", "reproductions.roster", "reproductions.read"]);
 /**
  * Why the call is over. Who hung up, what failed before anybody could, drained: the platform took
  * the worker down (a deploy, a stop) with the call still on it, or app_detached: the app holding
@@ -258,11 +258,10 @@ export const EventSpecSchema = z.strictObject({
     name: z.string(),
     from: z.array(EventSourceSchema),
 });
-/** One file of knowledge, sent whole: its path as the tenant keeps it, and its text. */
+/** One file of a base, as a push sends it: its path as the tenant keeps it, and its text. */
 export const KnowledgeFileSchema = z.strictObject({
     path: z.string(),
     text: z.string(),
-    mode: z.enum(["retrieved", "whole"]).nullish(),
 });
 /**
  * The knowledge base the agent answers from, and how its chunks reach the model. It is named by
@@ -305,9 +304,11 @@ export const MemoryConfigSchema = z.strictObject({
     forget: z.array(z.string()).nullish(),
 });
 /**
- * What an app declares about its agent: the voice, the models, the language, the greeting, the
- * tools, and who may see and send what. Every field is optional so a configure can change one
- * thing.
+ * What an app declares about its agent: the prompt's layout, the language, the tools, whether it
+ * searches its bases itself, and who may see and send what. Every field is optional so a configure
+ * can change one thing. The environment — voice, models, greeting, hangup, turn, says, hears,
+ * knowledge, docs, memory — is the world's, set in the agent's settings, and no longer read off
+ * this declaration.
  */
 export const AgentConfigSchema = z.strictObject({
     prompt: z.array(PromptBlockSpecSchema).nullish(),