keyring-chatbot-agent-sdk 1.0.0

package/dist/lib.d.ts

@@ -0,0 +1,164 @@
+import { JSX } from 'react/jsx-runtime';
+
+export declare interface Account {
+    address: string;
+    chainId: number | string;
+}
+
+/**
+ * `ChatWidget` is the main entry point for embedding the Keyring AI chat assistant
+ * into your dApp. It renders a floating chat button that opens a full-featured
+ * chat modal with AI-powered responses, token/NFT lookups, and on-chain transaction support.
+ *
+ * @example
+ * ```tsx
+ * import { ChatWidget } from '@keyringpro/chatbot-agent-sdk';
+ *
+ * function App() {
+ *   const { account, sendTransaction } = useWallet(); // your wallet hook
+ *
+ *   return (
+ *     <ChatWidget
+ *       account={{ address: account.address, chainId: account.chainId }}
+ *       onTransaction={sendTransaction}
+ *       language="en"
+ *       position="bottom-right"
+ *       theme={{ primaryColor: '#6366f1', buttonSize: 56 }}
+ *       rpcUrls={{ 1: 'https://mainnet.infura.io/v3/YOUR_KEY' }}
+ *     />
+ *   );
+ * }
+ * ```
+ *
+ * @param position   - Corner to anchor the widget. `'bottom-right'` (default) or `'bottom-left'`.
+ * @param theme      - Visual customisation: `primaryColor` (hex/CSS), `buttonSize` (px), `zIndex`.
+ * @param defaultOpen - If `true`, the chat modal is open on first render. Defaults to `false`.
+ * @param onOpen     - Callback fired when the chat modal opens.
+ * @param onClose    - Callback fired when the chat modal closes.
+ * @param account    - Connected wallet info (`address` + `chainId`). Pass `undefined` when not connected.
+ * @param onTransaction - **Required for on-chain actions.** Receives an unsigned transaction object
+ *                        and must return a promise that resolves to `{ status, transactionHash?, error? }`.
+ *                        The widget uses this to sign & broadcast swap / send transactions.
+ * @param language   - UI language: `'en'` (English, default), `'ja'` (Japanese), `'cn'` (Chinese).
+ * @param rpcUrls    - Optional map of `chainId → RPC URL`. When provided, these URLs take priority
+ *                     over the built-in defaults for balance queries and fee estimation.
+ *                     e.g. `{ 1: 'https://...', 137: 'https://...' }`
+ */
+export declare const ChatWidget: ({ position, theme, defaultOpen, onOpen, onClose, account, onTransaction, language, rpcUrls, }: ChatWidgetProps) => JSX.Element | null;
+
+/** Alias kept for backwards-compatibility */
+export declare type ChatWidgetLanguage = Language;
+
+export declare interface ChatWidgetProps {
+    position?: 'bottom-right' | 'bottom-left';
+    theme?: ChatWidgetTheme;
+    defaultOpen?: boolean;
+    onOpen?: () => void;
+    onClose?: () => void;
+    account?: Account;
+    onTransaction?: (tx: Transaction) => Promise<TransactionResult>;
+    language?: ChatWidgetLanguage;
+    rpcUrls?: Record<number, string>;
+}
+
+export declare interface ChatWidgetTheme {
+    primaryColor?: string;
+    buttonSize?: number;
+    zIndex?: number;
+    modalChatStyle?: React.CSSProperties;
+    offset?: {
+        x: number;
+        y: number;
+    };
+}
+
+export declare interface Config {
+    position?: 'bottom-right' | 'bottom-left';
+    theme?: ChatWidgetTheme;
+    apiUrl?: string;
+    apiKey?: string;
+    /** Override RPC endpoint per chainId. Key = chainId, value = RPC URL. */
+    rpcUrls?: Record<number | string, string>;
+    [key: string]: unknown;
+}
+
+export declare type Language = 'en' | 'ja' | 'cn';
+
+export declare interface Message {
+    id: string;
+    text: string;
+    sender: 'user' | 'bot';
+    timestamp: Date;
+    replyTo?: {
+        id: string;
+        text: string;
+        sender: 'user' | 'bot';
+    };
+    buttons?: MessageButton[];
+    actionData?: {
+        action: string;
+        parameters: Record<string, string>;
+        status?: 'pending' | 'submitted' | 'success' | 'fail' | 'idle';
+        tokenInfo?: MessageTokenInfo;
+        nftInfo?: MessageNftInfo;
+    };
+    typeChat?: TypeChat;
+}
+
+export declare interface MessageButton {
+    id: string;
+    text: string;
+    value: string;
+    action?: string;
+    extraData?: Record<string, unknown>;
+    fullWidth?: boolean;
+}
+
+declare interface MessageNftInfo {
+    name: string;
+    image?: string;
+    tokenId: string;
+    contractAddress: string;
+    tokenStandard?: string;
+}
+
+export declare interface MessageTokenInfo {
+    symbol: string;
+    name: string;
+    balance: string;
+    balanceFormatted: string;
+    usdValue?: number;
+    usdPrice?: number;
+    decimals: number;
+    logo?: string;
+    contractAddress: string;
+}
+
+export declare interface Transaction {
+    from: string;
+    to: string;
+    data: string;
+    value: string;
+    gasLimit?: string;
+    gasPrice?: string;
+    maxFeePerGas?: string;
+    maxPriorityFeePerGas?: string;
+    nonce?: number;
+    chainId?: number | string;
+}
+
+export declare interface TransactionResult {
+    status: 'success' | 'fail';
+    transactionHash?: string;
+    error?: string;
+}
+
+/**
+ * Shared public types for the Keyring Chatbot Agent SDK.
+ * Import from this file when consuming the SDK in a dApp.
+ */
+export declare type TransactionStatus = 'pending' | 'process' | 'success' | 'fail';
+
+declare type TypeChat = 'web3' | 'normal';
+
+export { }

package/dist/vite.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="31.88" height="32" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 257"><defs><linearGradient id="IconifyId1813088fe1fbc01fb466" x1="-.828%" x2="57.636%" y1="7.652%" y2="78.411%"><stop offset="0%" stop-color="#41D1FF"></stop><stop offset="100%" stop-color="#BD34FE"></stop></linearGradient><linearGradient id="IconifyId1813088fe1fbc01fb467" x1="43.376%" x2="50.316%" y1="2.242%" y2="89.03%"><stop offset="0%" stop-color="#FFEA83"></stop><stop offset="8.333%" stop-color="#FFDD35"></stop><stop offset="100%" stop-color="#FFA800"></stop></linearGradient></defs><path fill="url(#IconifyId1813088fe1fbc01fb466)" d="M255.153 37.938L134.897 252.976c-2.483 4.44-8.862 4.466-11.382.048L.875 37.958c-2.746-4.814 1.371-10.646 6.827-9.67l120.385 21.517a6.537 6.537 0 0 0 2.322-.004l117.867-21.483c5.438-.991 9.574 4.796 6.877 9.62Z"></path><path fill="url(#IconifyId1813088fe1fbc01fb467)" d="M185.432.063L96.44 17.501a3.268 3.268 0 0 0-2.634 3.014l-5.474 92.456a3.268 3.268 0 0 0 3.997 3.378l24.777-5.718c2.318-.535 4.413 1.507 3.936 3.838l-7.361 36.047c-.495 2.426 1.782 4.5 4.151 3.78l15.304-4.649c2.372-.72 4.652 1.36 4.15 3.788l-11.698 56.621c-.732 3.542 3.979 5.473 5.943 2.437l1.313-2.028l72.516-144.72c1.215-2.423-.88-5.186-3.54-4.672l-25.505 4.922c-2.396.462-4.435-1.77-3.759-4.114l16.646-57.705c.677-2.35-1.37-4.583-3.769-4.113Z"></path></svg>

package/package.json

@@ -0,0 +1,101 @@
+{
+  "name": "keyring-chatbot-agent-sdk",
+  "version": "1.0.0",
+  "private": false,
+  "description": "A React chat widget SDK with floating button and modal",
+  "keywords": [
+    "react",
+    "chat",
+    "widget",
+    "sdk",
+    "chat-widget"
+  ],
+  "homepage": "https://bitbucket.org/bacoorteam/keyring-chatbot-agent-sdk#readme",
+  "bugs": {
+    "url": "https://bitbucket.org/bacoorteam/keyring-chatbot-agent-sdk/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@bitbucket.org/bacoorteam/keyring-chatbot-agent-sdk.git"
+  },
+  "license": "ISC",
+  "author": "",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/lib.d.ts",
+      "import": "./dist/chat-widget.es.js",
+      "require": "./dist/chat-widget.umd.js",
+      "default": "./dist/chat-widget.es.js"
+    },
+    "./web-component": {
+      "import": "./dist/chat-widget-wc.es.js",
+      "require": "./dist/chat-widget-wc.umd.js",
+      "default": "./dist/chat-widget-wc.es.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/chat-widget.umd.js",
+  "types": "./dist/lib.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "dev": "vite",
+    "build": "yarn build:react && yarn build:wc",
+    "build:react": "tsc -b && vite build --mode development",
+    "build:wc": "BUILD_TARGET=web-component vite build --mode development",
+    "build:production": "yarn build:react:production && yarn build:wc:production",
+    "build:react:production": "tsc -b && vite build",
+    "build:wc:production": "BUILD_TARGET=web-component vite build",
+    "watch": "chokidar 'src/**/*.{ts,tsx,css,json}' -c 'yarn build:react'",
+    "watch:production": "chokidar 'src/**/*.{ts,tsx,css,json}' -c 'yarn build:react:production'",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "format": "prettier --write \"src/**/*.{ts,tsx,css,json}\"",
+    "preview": "vite preview"
+  },
+  "dependencies": {
+    "@solana/web3.js": "^1.98.4",
+    "@types/react-syntax-highlighter": "^15.5.13",
+    "bignumber.js": "^9.3.1",
+    "lodash": "^4.17.23",
+    "react-device-detect": "^2.2.3",
+    "react-syntax-highlighter": "^16.1.0",
+    "remark-gfm": "^4.0.1",
+    "viem": "^2.45.1"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.39.1",
+    "@types/lodash": "^4.17.23",
+    "@types/node": "^24.10.1",
+    "@types/react": "^19.2.5",
+    "@types/react-dom": "^19.2.3",
+    "@types/uuid": "^10.0.0",
+    "@vitejs/plugin-react": "^5.1.1",
+    "chokidar-cli": "^3.0.0",
+    "eslint": "^9.39.1",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.5",
+    "eslint-plugin-react-hooks": "^7.0.1",
+    "eslint-plugin-react-refresh": "^0.4.24",
+    "globals": "^16.5.0",
+    "prettier": "^3.8.1",
+    "react": "^19.2.0",
+    "react-dom": "^19.2.0",
+    "terser": "^5.46.0",
+    "typescript": "~5.9.3",
+    "typescript-eslint": "^8.46.4",
+    "vite": "^7.2.4",
+    "vite-plugin-css-injected-by-js": "^3.5.2",
+    "vite-plugin-dts": "^4.5.4"
+  },
+  "peerDependencies": {
+    "react": "^17.0.0 || ^18.0.0 || ^19.0.0",
+    "react-dom": "^17.0.0 || ^18.0.0 || ^19.0.0"
+  },
+  "module": "./dist/chat-widget.es.js",
+  "sideEffects": [
+    "**/*.css"
+  ]
+}