@confidencesystemsinc/sdk 1.2.4 → 1.2.5

package/README.md

@@ -1,54 +1,103 @@
-# React + TypeScript + Vite
-
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
-
-Currently, two official plugins are available:
-
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
-
-## Expanding the ESLint configuration
-
-If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
-
-```js
-export default tseslint.config({
-  extends: [
-    // Remove ...tseslint.configs.recommended and replace with this
-    ...tseslint.configs.recommendedTypeChecked,
-    // Alternatively, use this for stricter rules
-    ...tseslint.configs.strictTypeChecked,
-    // Optionally, add this for stylistic rules
-    ...tseslint.configs.stylisticTypeChecked,
-  ],
-  languageOptions: {
-    // other options...
-    parserOptions: {
-      project: ['./tsconfig.node.json', './tsconfig.app.json'],
-      tsconfigRootDir: import.meta.dirname,
-    },
-  },
-})
+# Confidence Playbook Component Library
+
+This package provides a set of React components and utilities for embedding and managing Confidence Playbooks in your application. All exports are available from the `ConfidencePlaybook` module, with several specialized subcomponents for different integration scenarios.
+
+---
+
+## Exports
+
+### 1. `ConfidencePlaybook`
+
+The main component for rendering a playbook instance by its ID.
+
+**Props:**
+- `playbookInstanceId` (string \| number): The unique instance ID of the playbook to display.
+- `playbookMode` ("list" \| "card"): Display mode for tasks.
+- `playbookStyle` (object, optional): White-label and overlay style configuration.
+
+**Example:**
+```tsx
+<ConfidencePlaybook
+  playbookInstanceId={12345}
+  playbookMode="list"
+  playbookStyle={{
+    overlay: { position: "right", size: { width: 500 } },
+    whiteLabel: { primaryColor: "#007BFF" },
+  }}
+/>
 ```
 
-You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
-
-```js
-// eslint.config.js
-import reactX from 'eslint-plugin-react-x'
-import reactDom from 'eslint-plugin-react-dom'
-
-export default tseslint.config({
-  plugins: {
-    // Add the react-x and react-dom plugins
-    'react-x': reactX,
-    'react-dom': reactDom,
-  },
-  rules: {
-    // other rules...
-    // Enable its recommended typescript rules
-    ...reactX.configs['recommended-typescript'].rules,
-    ...reactDom.configs.recommended.rules,
-  },
-})
+---
+
+### 2. `ConfidencePlaybook.AutoInstantiated`
+
+Automatically initiates a playbook for a given user/email and playbook template, then renders the playbook UI once ready.
+
+**Props:**
+- `email` (string): The user's email to initiate the playbook for.
+- `playbookId` (string): The playbook template ID.
+- `playbookMode` ("list" \| "card"): Display mode for tasks.
+
+**Example:**
+```tsx
+<ConfidencePlaybook.AutoInstantiated
+  email="user@example.com"
+  playbookId="YOUR_PLAYBOOK_ID"
+  playbookMode="list"
+/>
 ```
+
+---
+
+### 3. `ConfidencePlaybook.WithInstantiateButton`
+
+Renders a button that, when clicked, prompts the user for their email and then instantiates and displays the playbook.
+
+**Props:**
+- `playbookId` (string): The playbook template ID.
+- `playbookMode` ("list" \| "card", optional): Display mode for tasks (default: "list").
+- `playbookStyle` (object, optional): White-label and overlay style configuration.
+- `btnLabel` (string, optional): Button label (default: "Start Playbook").
+
+**Example:**
+```tsx
+<ConfidencePlaybook.WithInstantiateButton
+  playbookId="YOUR_PLAYBOOK_ID"
+  btnLabel="Start Playbook"
+  playbookMode="card"
+  playbookStyle={{
+    overlay: { position: "right", size: { width: 500 } },
+    whiteLabel: { primaryColor: "#007BFF" },
+  }}
+/>
+```
+
+---
+
+### 4. `ConfidencePlaybook.View`
+
+A lower-level component for rendering a playbook UI given a playbook object. Useful for advanced scenarios or custom data sources.
+
+**Props:**
+- `playbook` (Playbook): The playbook data object.
+- `playbookMode` ("list" \| "card"): Display mode for tasks.
+- `onTaskButtonClick` (function): Handler for task button actions.
+- `playbookStyle` (object, optional): White-label and overlay style configuration.
+
+**Example:**
+```tsx
+<ConfidencePlaybook.View
+  playbook={playbookData}
+  playbookMode="list"
+  onTaskButtonClick={async (btn, taskId) => {
+    // handle action
+  }}
+/>
+```
+
+---
+
+## Notes
+- All components are styled with TailwindCSS and scoped under `.confidence-ui`.
+- For more details on the `playbookStyle` prop and available options, see the source code or type definitions.
+- These exports are designed for flexibility: use the high-level components for quick integration, or the lower-level `View` for custom scenarios.

package/dist/components/playbook/confidence-playbook.d.ts

@@ -35,10 +35,11 @@ export declare const ConfidencePlaybook: {
         onTaskButtonClick: (btn: TaskButton, taskId: number) => Promise<void>;
         playbookStyle?: ConfidencePlaybookStyleConfiguration;
     }) => import("react/jsx-runtime").JSX.Element;
-    AutoInstantiated: ({ email, playbookId, playbookMode, }: {
+    AutoInstantiated: ({ email, playbookId, playbookMode, playbookStyle, }: {
         email: string;
         playbookId: string;
         playbookMode: "list" | "card";
+        playbookStyle?: ConfidencePlaybookStyleConfiguration;
     }) => import("react/jsx-runtime").JSX.Element;
     WithInstantiateButton: ({ playbookId, playbookMode, playbookStyle, btnLabel, }: {
         playbookId: string;