@snf/access-qa-bot 2.3.1-beta.1 → 2.4.1

package/README.md

@@ -149,12 +149,14 @@ function MyApp() {
 | `welcome` | string | - | Welcome message |
 | `userEmail` | string | - | User's email (pre-populates ticket forms when logged in) |
 | `userName` | string | - | User's display name (pre-populates ticket forms when logged in) |
-| `username` | string | - | User's username/ACCESS ID (pre-populates ticket forms when logged in) |
+| `accessId` | string | - | User's ACCESS ID (pre-populates ticket forms when logged in) |
 
 ### Standalone Javascript
 
+**Recommended approach** - use the self-contained standalone bundle:
+
 ```html
-<script src="https://unpkg.com/@snf/access-qa-bot@2.x/dist/access-qa-bot.standalone.js"></script>
+<script src="https://unpkg.com/@snf/access-qa-bot@2.4.0/dist/access-qa-bot.standalone.js"></script>
 
 <div id="qa-bot"></div>
 
@@ -168,6 +170,8 @@ qaBot({
 </script>
 ```
 
+> **Note**: Early versions (v0.1.x) supported a "three files" CDN approach using `/build/` directory files. This approach is no longer supported as the build architecture changed from auto-executing scripts to library exports. Use the standalone bundle above instead.
+
 #### Programmatic Control
 
 When using the JavaScript API in plain HTML/JS (requires standalone bundle), you get a controller object with imperative methods:
@@ -204,7 +208,7 @@ botController.destroy();
 | `welcome` | string | - | Welcome message |
 | `userEmail` | string | - | User's email (pre-populates ticket forms when logged in) |
 | `userName` | string | - | User's display name (pre-populates ticket forms when logged in) |
-| `username` | string | - | User's username/ACCESS ID (pre-populates ticket forms when logged in) |
+| `accessId` | string | - | User's ACCESS ID (pre-populates ticket forms when logged in) |
 
 > **More Examples**: See `index.html` in this repository for examples including login state management, embedded mode, and programmatic control. Run the react app to see the same in a react context.
 
@@ -254,6 +258,23 @@ This creates the distribution files in the `dist/` directory:
 - `access-qa-bot.umd.cjs` (UMD/CommonJS) 
 - `access-qa-bot.standalone.js` (Standalone version)
 
+### Build Directory
+
+The package includes both `/dist/` and `/build/` directories:
+
+- **`/dist/`**: Library files for npm consumers and CDN usage
+  - `access-qa-bot.js` (ES module for React apps)
+  - `access-qa-bot.umd.cjs` (CommonJS)
+  - `access-qa-bot.standalone.js` (Self-contained for plain HTML)
+
+- **`/build/`**: React app build files
+  - **Not for standalone CDN usage** (use `/dist/access-qa-bot.standalone.js` instead)
+  - Required for shadow DOM implementations that need to import CSS directly
+  - Example: `import qaStyle from '@snf/access-qa-bot/build/static/css/main.css?inline'`
+  - Maintained for backward compatibility with existing integrations
+
+Both directories are published to npm to support different integration patterns.
+
 ### NPM Beta Release
 
 To release a beta version:
@@ -380,7 +401,7 @@ npm install @snf/access-qa-bot@beta
 - Removed unused helper functions (`getCurrentPriority`, `getCurrentAccessId`)
 - Cleaned up debug console statements for production
 - Added markdown renderer plugin alongside HTML renderer
-- Improved build configuration and excluded build directory from version control
+- Improved build configuration and updated build directory handling
 
 #### 📚 Documentation
 - Updated README with comprehensive feature list and integration examples