@frogbotai/protocol 0.0.0-stage → 0.34.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 FrogBot
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,21 @@
-# Temporary Holding Version
+# @frogbotai/protocol
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The types-only contract shared by the [FrogBot](https://github.com/frogbotai/frogbot) server and its clients: turn states, turn error codes, the chat manifest, channel thread references and option colors.
+
+It has no dependencies and no runtime code. `frogbot` and `@frogbotai/ui` both import these types, so a client can implement the chat contract without installing the server.
+
+## Installation
+
+```bash
+pnpm add @frogbotai/protocol
+```
+
+## Usage
+
+```ts
+import type { ChatManifest, TurnState } from '@frogbotai/protocol';
+
+export const idle: TurnState = 'idle';
+
+export const manifest: ChatManifest = { defaultAgent: 'assistant', agents: [], transcribe: false };
+```

package/dist/agents.d.ts

@@ -0,0 +1,22 @@
+import type { ModelModality } from './ai.js';
+export type AgentProfile = {
+    name?: string;
+    avatar?: string;
+    description?: string;
+};
+export type AgentReasoningOption = {
+    key: string;
+    label: string;
+};
+/** One agent in the chat manifest. `TModel` narrows model ids to an app's generated union. */
+export type AgentManifestEntry<TModel extends string = string> = {
+    slug: string;
+    label: string;
+    source: 'config' | 'collection';
+    defaultModel: TModel;
+    models: TModel[];
+    names?: Partial<Record<TModel, string>>;
+    reasoning?: Partial<Record<TModel, AgentReasoningOption[]>>;
+    inputs?: Partial<Record<TModel, ModelModality[]>>;
+};
+//# sourceMappingURL=agents.d.ts.map

package/dist/agents.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"agents.d.ts","sourceRoot":"","sources":["../src/agents.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE7C,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,8FAA8F;AAC9F,MAAM,MAAM,kBAAkB,CAAC,MAAM,SAAS,MAAM,GAAG,MAAM,IAAI;IAC/D,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,QAAQ,GAAG,YAAY,CAAC;IAChC,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,KAAK,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACxC,SAAS,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,oBAAoB,EAAE,CAAC,CAAC,CAAC;IAC5D,MAAM,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC;CACnD,CAAC"}

package/dist/agents.js

@@ -0,0 +1,3 @@
+/** One agent in the chat manifest. `TModel` narrows model ids to an app's generated union. */ export { };
+
+//# sourceMappingURL=agents.js.map

package/dist/agents.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/agents.ts"],"names":[],"mappings":"AAaA,4FAA4F,GAC5F,WASE","file":"agents.js"}

package/dist/ai.d.ts

@@ -0,0 +1,2 @@
+export type ModelModality = 'text' | 'image' | 'audio' | 'video' | 'pdf';
+//# sourceMappingURL=ai.d.ts.map

package/dist/ai.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ai.d.ts","sourceRoot":"","sources":["../src/ai.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,KAAK,CAAC"}

package/dist/ai.js

@@ -0,0 +1,3 @@
+export { };
+
+//# sourceMappingURL=ai.js.map

package/dist/ai.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/ai.ts"],"names":[],"mappings":"AAAA,WAAyE","file":"ai.js"}

package/dist/channels.d.ts

@@ -0,0 +1,6 @@
+/** The channel conversation a chat mirrors. `TThread` is the channel's serialized thread. */
+export type ChannelThreadReference<TThread = unknown> = {
+    account: string;
+    thread: TThread;
+};
+//# sourceMappingURL=channels.d.ts.map

package/dist/channels.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"channels.d.ts","sourceRoot":"","sources":["../src/channels.ts"],"names":[],"mappings":"AAAA,6FAA6F;AAC7F,MAAM,MAAM,sBAAsB,CAAC,OAAO,GAAG,OAAO,IAAI;IACtD,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,OAAO,CAAC;CACjB,CAAC"}

package/dist/channels.js

@@ -0,0 +1,3 @@
+/** The channel conversation a chat mirrors. `TThread` is the channel's serialized thread. */ export { };
+
+//# sourceMappingURL=channels.js.map

package/dist/channels.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/channels.ts"],"names":[],"mappings":"AAAA,2FAA2F,GAC3F,WAGE","file":"channels.js"}

package/dist/chat.d.ts

@@ -0,0 +1,12 @@
+import type { AgentManifestEntry, AgentProfile } from './agents.js';
+export type TurnState = 'idle' | 'running' | 'awaiting';
+export type TurnErrorCode = 'already-settled' | 'call-not-found' | 'channel-chat' | 'forbidden' | 'invalid-output' | 'not-awaiting' | 'not-found' | 'not-queued' | 'pending-calls' | 'selection-unavailable' | 'turn-in-progress' | 'write-conflict';
+/** What the chat UI loads from a backend before it renders: its agents and features. */
+export type ChatManifest<TModel extends string = string> = {
+    defaultAgent: string;
+    agents: (AgentManifestEntry<TModel> & {
+        profile?: AgentProfile;
+    })[];
+    transcribe: boolean;
+};
+//# sourceMappingURL=chat.d.ts.map

package/dist/chat.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"chat.d.ts","sourceRoot":"","sources":["../src/chat.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAEpE,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,SAAS,GAAG,UAAU,CAAC;AAExD,MAAM,MAAM,aAAa,GACrB,iBAAiB,GACjB,gBAAgB,GAChB,cAAc,GACd,WAAW,GACX,gBAAgB,GAChB,cAAc,GACd,WAAW,GACX,YAAY,GACZ,eAAe,GACf,uBAAuB,GACvB,kBAAkB,GAClB,gBAAgB,CAAC;AAErB,wFAAwF;AACxF,MAAM,MAAM,YAAY,CAAC,MAAM,SAAS,MAAM,GAAG,MAAM,IAAI;IACzD,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,CAAC,kBAAkB,CAAC,MAAM,CAAC,GAAG;QAAE,OAAO,CAAC,EAAE,YAAY,CAAA;KAAE,CAAC,EAAE,CAAC;IACpE,UAAU,EAAE,OAAO,CAAC;CACrB,CAAC"}

package/dist/chat.js

@@ -0,0 +1,3 @@
+/** What the chat UI loads from a backend before it renders: its agents and features. */ export { };
+
+//# sourceMappingURL=chat.js.map

package/dist/chat.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/chat.ts"],"names":[],"mappings":"AAkBA,sFAAsF,GACtF,WAIE","file":"chat.js"}

package/dist/fields.d.ts

@@ -0,0 +1,2 @@
+export type OptionColor = 'gray' | 'blue' | 'cyan' | 'teal' | 'green' | 'yellow' | 'orange' | 'red' | 'pink' | 'purple';
+//# sourceMappingURL=fields.d.ts.map

package/dist/fields.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fields.d.ts","sourceRoot":"","sources":["../src/fields.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,WAAW,GACrB,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,GAAG,KAAK,GAAG,MAAM,GAAG,QAAQ,CAAC"}

package/dist/fields.js

@@ -0,0 +1,3 @@
+export { };
+
+//# sourceMappingURL=fields.js.map

package/dist/fields.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/fields.ts"],"names":[],"mappings":"AAAA,WACgG","file":"fields.js"}

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export type { AgentManifestEntry, AgentProfile, AgentReasoningOption } from './agents.js';
+export type { ModelModality } from './ai.js';
+export type { ChannelThreadReference } from './channels.js';
+export type { ChatManifest, TurnErrorCode, TurnState } from './chat.js';
+export type { OptionColor } from './fields.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,kBAAkB,EAAE,YAAY,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAC1F,YAAY,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAC7C,YAAY,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAC;AAC5D,YAAY,EAAE,YAAY,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACxE,YAAY,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC"}

package/dist/index.js

@@ -0,0 +1,3 @@
+export { };
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":"AAIA,WAA+C","file":"index.js"}

package/package.json

@@ -1,6 +1,38 @@
 {
   "name": "@frogbotai/protocol",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.34.0",
+  "description": "Types-only contract shared by the FrogBot server and its clients.",
+  "license": "MIT",
+  "author": "Colby Gilbert",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/frogbotai/frogbot.git",
+    "directory": "packages/protocol"
+  },
+  "homepage": "https://github.com/frogbotai/frogbot#readme",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "devDependencies": {
+    "typescript": "6.0.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "node ../../scripts/build-package.mjs",
+    "clean": "rm -rf dist",
+    "typecheck": "tsc --noEmit"
+  }
 }