@webority/chat-react 0.0.0-stage → 0.21.0

package/dist/types/useChat.d.ts

@@ -0,0 +1,69 @@
+export type ChatTurnError = {
+    code: string;
+    /**
+     * Written for the person.
+     */
+    message: string;
+    resetsAtUtc: string | null;
+};
+export type ChatTurn = {
+    /**
+     * Local key; for a reopened conversation, the stored message's id.
+     */
+    id: string;
+    question: string;
+    /**
+     * What is shown: the streamed text, then the reply of record.
+     */
+    answer: string;
+    streaming: boolean;
+    error: ChatTurnError | null;
+    actions: import('./client.js').SupportAction[];
+    /**
+     * The stored reply's id; rating needs it.
+     */
+    messageId: string | null;
+    rating: "Up" | "Down" | null;
+    ratingNote: string | null;
+};
+/**
+ * The chat's state and actions, with no store of its own: it lives in the component that calls
+ * it. Call `reset()` when the signed-in person or account changes so nothing of one person's chat
+ * shows to the next. An answer still streaming is cancelled on `reset`, `newConversation`,
+ * `openConversation` and unmount.
+ *
+ * @param {object} options
+ * @param {import('./client.js').ChatClient} options.client From `createChatClient`.
+ * @param {any} [options.pageContext] Sent with each question; read at the moment of sending.
+ * @returns {{
+ *   turns: ChatTurn[],
+ *   conversationId: string|null,
+ *   messagesLeftToday: number|null,
+ *   streaming: boolean,
+ *   loading: boolean,
+ *   loadError: ChatTurnError|null,
+ *   submit: (message: string) => Promise<void>,
+ *   openConversation: (id: string) => Promise<void>,
+ *   newConversation: () => void,
+ *   rate: (turnId: string, rating: "Up"|"Down", note?: string) => Promise<void>,
+ *   refreshAllowance: () => Promise<void>,
+ *   reset: () => void
+ * }}
+ */
+export declare function useChat({ client, pageContext }: {
+    client: import('./client.js').ChatClient;
+    pageContext?: any;
+}): {
+    turns: ChatTurn[];
+    conversationId: string | null;
+    messagesLeftToday: number | null;
+    streaming: boolean;
+    loading: boolean;
+    loadError: ChatTurnError | null;
+    submit: (message: string) => Promise<void>;
+    openConversation: (id: string) => Promise<void>;
+    newConversation: () => void;
+    rate: (turnId: string, rating: "Up" | "Down", note?: string) => Promise<void>;
+    refreshAllowance: () => Promise<void>;
+    reset: () => void;
+};

package/package.json

@@ -1,6 +1,61 @@
 {
   "name": "@webority/chat-react",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.21.0",
+  "description": "Webority AI assistant for React portals: a streaming chat client, a store-agnostic chat hook, and the launcher, panel, thread, rating and support action card, built on @webority/ui-react.",
+  "license": "SEE LICENSE IN LICENSE",
+  "type": "module",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Webority/webority-ui.git",
+    "directory": "packages/chat-react"
+  },
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/chat-react.js",
+  "module": "./dist/chat-react.js",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "default": "./dist/chat-react.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "sideEffects": false,
+  "peerDependencies": {
+    "bootstrap": "5.3.3",
+    "react": "^19.0.0",
+    "react-bootstrap": "^2.10.0",
+    "react-dom": "^19.0.0",
+    "@webority/ui-react": "0.21.0"
+  },
+  "devDependencies": {
+    "@testing-library/dom": "10.4.2",
+    "@testing-library/jest-dom": "7.0.1",
+    "@testing-library/react": "^16.3.0",
+    "@testing-library/user-event": "^14.6.1",
+    "@types/react": "^19.2.17",
+    "@vitejs/plugin-react": "^6.0.1",
+    "@vitest/coverage-v8": "5.0.1",
+    "bootstrap": "5.3.3",
+    "jsdom": "30.1.1",
+    "react": "^19.2.6",
+    "react-bootstrap": "^2.10.6",
+    "react-dom": "^19.2.6",
+    "typescript": "^7.0.2",
+    "vite": "^8.0.12",
+    "vitest": "5.0.1",
+    "@webority/ui-react": "0.21.0"
+  },
+  "scripts": {
+    "build": "vite build && tsc -p tsconfig.json",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage"
+  }
 }