@octavus/react 0.0.6

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2025 Octavus AI
+
+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/dist/index.d.ts

@@ -0,0 +1,55 @@
+import { OctavusChatOptions, UIMessage, ChatStatus, UserMessageInput } from '@octavus/client-sdk';
+export * from '@octavus/client-sdk';
+export { ChatStatus, OctavusChatOptions, UserMessageInput } from '@octavus/client-sdk';
+
+interface UseOctavusChatReturn {
+    /** All messages including the currently streaming one */
+    messages: UIMessage[];
+    /** Current status of the chat */
+    status: ChatStatus;
+    /** Error if status is 'error' */
+    error: Error | null;
+    /**
+     * Trigger the agent and optionally add a user message to the chat.
+     *
+     * @param triggerName - The trigger name defined in the agent's protocol.yaml
+     * @param input - Input parameters for the trigger (variable substitutions)
+     * @param options.userMessage - If provided, adds a user message to the chat before triggering
+     */
+    send: (triggerName: string, input?: Record<string, unknown>, options?: {
+        userMessage?: UserMessageInput;
+    }) => Promise<void>;
+    /** Stop the current streaming and finalize any partial message */
+    stop: () => void;
+}
+/**
+ * React hook for interacting with Octavus agents.
+ * Provides chat state management and streaming support.
+ *
+ * @example
+ * ```tsx
+ * function Chat({ sessionId }) {
+ *   const { messages, status, send } = useOctavusChat({
+ *     onTrigger: (triggerName, input) =>
+ *       fetch('/api/trigger', {
+ *         method: 'POST',
+ *         body: JSON.stringify({ sessionId, triggerName, input }),
+ *       }),
+ *   });
+ *
+ *   return (
+ *     <div>
+ *       {messages.map((msg) => (
+ *         <Message key={msg.id} message={msg} />
+ *       ))}
+ *       <button onClick={() => send('user-message', { USER_MESSAGE: 'Hello' })}>
+ *         Send
+ *       </button>
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+declare function useOctavusChat(options: OctavusChatOptions): UseOctavusChatReturn;
+
+export { type UseOctavusChatReturn, useOctavusChat };

package/dist/index.js

@@ -0,0 +1,36 @@
+// src/hooks/use-octavus-chat.ts
+import { useRef, useCallback, useSyncExternalStore } from "react";
+import {
+  OctavusChat
+} from "@octavus/client-sdk";
+function useOctavusChat(options) {
+  const chatRef = useRef(null);
+  chatRef.current ??= new OctavusChat(options);
+  const chat = chatRef.current;
+  const subscribe = useCallback((callback) => chat.subscribe(callback), [chat]);
+  const getMessagesSnapshot = useCallback(() => chat.messages, [chat]);
+  const getStatusSnapshot = useCallback(() => chat.status, [chat]);
+  const getErrorSnapshot = useCallback(() => chat.error, [chat]);
+  const messages = useSyncExternalStore(subscribe, getMessagesSnapshot, getMessagesSnapshot);
+  const status = useSyncExternalStore(subscribe, getStatusSnapshot, getStatusSnapshot);
+  const error = useSyncExternalStore(subscribe, getErrorSnapshot, getErrorSnapshot);
+  const send = useCallback(
+    (triggerName, input, sendOptions) => chat.send(triggerName, input, sendOptions),
+    [chat]
+  );
+  const stop = useCallback(() => chat.stop(), [chat]);
+  return {
+    messages,
+    status,
+    error,
+    send,
+    stop
+  };
+}
+
+// src/index.ts
+export * from "@octavus/client-sdk";
+export {
+  useOctavusChat
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/hooks/use-octavus-chat.ts","../src/index.ts"],"sourcesContent":["'use client';\n\nimport { useRef, useCallback, useSyncExternalStore } from 'react';\nimport {\n  OctavusChat,\n  type OctavusChatOptions,\n  type ChatStatus,\n  type UserMessageInput,\n  type UIMessage,\n} from '@octavus/client-sdk';\n\nexport type { OctavusChatOptions, ChatStatus, UserMessageInput };\n\nexport interface UseOctavusChatReturn {\n  /** All messages including the currently streaming one */\n  messages: UIMessage[];\n  /** Current status of the chat */\n  status: ChatStatus;\n  /** Error if status is 'error' */\n  error: Error | null;\n  /**\n   * Trigger the agent and optionally add a user message to the chat.\n   *\n   * @param triggerName - The trigger name defined in the agent's protocol.yaml\n   * @param input - Input parameters for the trigger (variable substitutions)\n   * @param options.userMessage - If provided, adds a user message to the chat before triggering\n   */\n  send: (\n    triggerName: string,\n    input?: Record<string, unknown>,\n    options?: { userMessage?: UserMessageInput },\n  ) => Promise<void>;\n  /** Stop the current streaming and finalize any partial message */\n  stop: () => void;\n}\n\n/**\n * React hook for interacting with Octavus agents.\n * Provides chat state management and streaming support.\n *\n * @example\n * ```tsx\n * function Chat({ sessionId }) {\n *   const { messages, status, send } = useOctavusChat({\n *     onTrigger: (triggerName, input) =>\n *       fetch('/api/trigger', {\n *         method: 'POST',\n *         body: JSON.stringify({ sessionId, triggerName, input }),\n *       }),\n *   });\n *\n *   return (\n *     <div>\n *       {messages.map((msg) => (\n *         <Message key={msg.id} message={msg} />\n *       ))}\n *       <button onClick={() => send('user-message', { USER_MESSAGE: 'Hello' })}>\n *         Send\n *       </button>\n *     </div>\n *   );\n * }\n * ```\n */\nexport function useOctavusChat(options: OctavusChatOptions): UseOctavusChatReturn {\n  const chatRef = useRef<OctavusChat | null>(null);\n\n  // Create chat instance once (stable reference)\n  chatRef.current ??= new OctavusChat(options);\n\n  const chat = chatRef.current;\n\n  // Subscribe to all state changes using useSyncExternalStore\n  // This provides automatic re-renders when state changes and proper SSR support\n  const subscribe = useCallback((callback: () => void) => chat.subscribe(callback), [chat]);\n\n  // Snapshot getters\n  const getMessagesSnapshot = useCallback(() => chat.messages, [chat]);\n  const getStatusSnapshot = useCallback(() => chat.status, [chat]);\n  const getErrorSnapshot = useCallback(() => chat.error, [chat]);\n\n  // Use useSyncExternalStore for each piece of state\n  // This hook is available in React 18+ and handles:\n  // - Subscription management\n  // - Proper re-rendering on state changes\n  // - SSR hydration (server snapshot)\n  const messages = useSyncExternalStore(subscribe, getMessagesSnapshot, getMessagesSnapshot);\n  const status = useSyncExternalStore(subscribe, getStatusSnapshot, getStatusSnapshot);\n  const error = useSyncExternalStore(subscribe, getErrorSnapshot, getErrorSnapshot);\n\n  // Stable method references\n  const send = useCallback(\n    (\n      triggerName: string,\n      input?: Record<string, unknown>,\n      sendOptions?: { userMessage?: UserMessageInput },\n    ) => chat.send(triggerName, input, sendOptions),\n    [chat],\n  );\n\n  const stop = useCallback(() => chat.stop(), [chat]);\n\n  return {\n    messages,\n    status,\n    error,\n    send,\n    stop,\n  };\n}\n","export {\n  useOctavusChat,\n  type UseOctavusChatReturn,\n  type OctavusChatOptions,\n  type ChatStatus,\n  type UserMessageInput,\n} from './hooks/use-octavus-chat';\n\n// Re-export everything from client-sdk so consumers only need @octavus/react\nexport * from '@octavus/client-sdk';\n"],"mappings":";AAEA,SAAS,QAAQ,aAAa,4BAA4B;AAC1D;AAAA,EACE;AAAA,OAKK;AAuDA,SAAS,eAAe,SAAmD;AAChF,QAAM,UAAU,OAA2B,IAAI;AAG/C,UAAQ,YAAY,IAAI,YAAY,OAAO;AAE3C,QAAM,OAAO,QAAQ;AAIrB,QAAM,YAAY,YAAY,CAAC,aAAyB,KAAK,UAAU,QAAQ,GAAG,CAAC,IAAI,CAAC;AAGxF,QAAM,sBAAsB,YAAY,MAAM,KAAK,UAAU,CAAC,IAAI,CAAC;AACnE,QAAM,oBAAoB,YAAY,MAAM,KAAK,QAAQ,CAAC,IAAI,CAAC;AAC/D,QAAM,mBAAmB,YAAY,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC;AAO7D,QAAM,WAAW,qBAAqB,WAAW,qBAAqB,mBAAmB;AACzF,QAAM,SAAS,qBAAqB,WAAW,mBAAmB,iBAAiB;AACnF,QAAM,QAAQ,qBAAqB,WAAW,kBAAkB,gBAAgB;AAGhF,QAAM,OAAO;AAAA,IACX,CACE,aACA,OACA,gBACG,KAAK,KAAK,aAAa,OAAO,WAAW;AAAA,IAC9C,CAAC,IAAI;AAAA,EACP;AAEA,QAAM,OAAO,YAAY,MAAM,KAAK,KAAK,GAAG,CAAC,IAAI,CAAC;AAElD,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;;;ACpGA,cAAc;","names":[]}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@octavus/react",
+  "version": "0.0.6",
+  "description": "React bindings for Octavus agents",
+  "license": "MIT",
+  "author": "Octavus AI <hello@octavus.ai>",
+  "keywords": [
+    "octavus",
+    "ai",
+    "agents",
+    "sdk",
+    "react",
+    "streaming"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@octavus/client-sdk": "^0.0.6"
+  },
+  "peerDependencies": {
+    "react": ">=18.0.0"
+  },
+  "devDependencies": {
+    "@types/react": "^19.0.0",
+    "react": "^19.0.0",
+    "tsup": "^8.3.5",
+    "typescript": "^5.6.3"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "lint": "eslint src/ --max-warnings 0",
+    "lint:fix": "eslint src/ --max-warnings 0 --fix",
+    "type-check": "tsc --noEmit",
+    "clean": "rm -rf dist .turbo"
+  }
+}