@gymmymac/bob-widget 3.1.3 → 3.1.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +36 -8
- package/dist/index.js +57 -15
- package/dist/index.mjs +13015 -3906
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,7 +2,28 @@
|
|
|
2
2
|
|
|
3
3
|
AI-powered automotive parts assistant widget for integration into partner websites.
|
|
4
4
|
|
|
5
|
-
**Current Version:** 3.1.
|
|
5
|
+
**Current Version:** 3.1.7
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## 🚨 IMPORTANT: Read Before Installing
|
|
10
|
+
|
|
11
|
+
**CARFIX Team:** Before integrating Bob, you MUST read the following documentation:
|
|
12
|
+
|
|
13
|
+
### 📖 Required Reading
|
|
14
|
+
|
|
15
|
+
| Document | Description |
|
|
16
|
+
|----------|-------------|
|
|
17
|
+
| **[BOB-DOCUMENTATION.md](./BOB-DOCUMENTATION.md)** | **Complete integration guide** - Contains CARFIX-specific installation steps, container height calculations (144px offset), forensic cleanup process, and verification tests. **START HERE.** |
|
|
18
|
+
| **[CHANGELOG.md](./CHANGELOG.md)** | Version history and release notes |
|
|
19
|
+
|
|
20
|
+
### ⚠️ Critical Installation Notes
|
|
21
|
+
|
|
22
|
+
1. **Forensic Cleanup Required**: If upgrading from v3.0.x, you MUST run the cleanup script in BOB-DOCUMENTATION.md Section 10 before installing
|
|
23
|
+
2. **Container Height**: Bob requires `height: calc(100dvh - 144px - env(safe-area-inset-bottom, 0px))` to display correctly with CARFIX header/footer
|
|
24
|
+
3. **HTTPS Required**: Push-to-Talk (PTT) requires HTTPS - will be disabled on HTTP connections
|
|
25
|
+
|
|
26
|
+
---
|
|
6
27
|
|
|
7
28
|
## Quick Start
|
|
8
29
|
|
|
@@ -14,24 +35,27 @@ import { BobStandalone } from '@gymmymac/bob-widget';
|
|
|
14
35
|
sessionToken={sessionToken}
|
|
15
36
|
onAddToCart={(item) => addToCart(item)}
|
|
16
37
|
onNavigate={(url) => router.push(url)}
|
|
38
|
+
onCheckout={(url) => window.location.href = url}
|
|
17
39
|
/>
|
|
18
40
|
```
|
|
19
41
|
|
|
20
42
|
**That's it!** Bob auto-configures from the database.
|
|
21
43
|
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
📖 **[Full Documentation](./BOB-DOCUMENTATION.md)** - Complete integration guide, props reference, behaviour guidelines, and troubleshooting.
|
|
25
|
-
|
|
26
|
-
📋 **[Changelog](./CHANGELOG.md)** - Version history and release notes.
|
|
44
|
+
---
|
|
27
45
|
|
|
28
46
|
## Installation
|
|
29
47
|
|
|
30
48
|
```bash
|
|
31
|
-
npm install @gymmymac/bob-widget@^3.1.
|
|
49
|
+
npm install @gymmymac/bob-widget@^3.1.7
|
|
32
50
|
```
|
|
33
51
|
|
|
34
|
-
## What's New in v3.1.
|
|
52
|
+
## What's New in v3.1.6
|
|
53
|
+
|
|
54
|
+
- 📚 **Documentation Update**: Corrected CARFIX layout measurements (144px total offset)
|
|
55
|
+
- 🔧 **Installation Guide**: Added comprehensive 6-phase forensic cleanup process
|
|
56
|
+
- 📐 **Container Height**: Updated formula for notched device support
|
|
57
|
+
|
|
58
|
+
## What's New in v3.1.0+
|
|
35
59
|
|
|
36
60
|
- 🎯 **BobStandalone** - Auto-configures from database (4 lines to integrate)
|
|
37
61
|
- 🗄️ **Partner Config System** - All settings in `bob_partners` table
|
|
@@ -47,6 +71,10 @@ Only requires:
|
|
|
47
71
|
|
|
48
72
|
All other dependencies are bundled.
|
|
49
73
|
|
|
74
|
+
## Support
|
|
75
|
+
|
|
76
|
+
For integration issues, check the troubleshooting section in [BOB-DOCUMENTATION.md](./BOB-DOCUMENTATION.md#11-troubleshooting-reference).
|
|
77
|
+
|
|
50
78
|
## License
|
|
51
79
|
|
|
52
80
|
MIT
|