@primexperts.co/pulse-agent 5.7.0 → 5.7.2

package/LICENSE

@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

package/README.md

@@ -81,7 +81,7 @@ Use these values in your widget config:
 | API base URL | `https://pulse.service.primexperts.co.za` | Yes | Use the API URL shown by your Pulse environment. |
 | Website origin | `https://www.example.com` | Required for production | Add the exact site origin where the widget will run. |
 
-You usually do not need a widget token. Pulse Agent resolves it automatically from your organization slug; when an application key is configured, the agent also sends it for app-aware deployments and reporting context.
+You usually do not need a widget token. Pulse Agent resolves it automatically from your organization slug; when an application key is configured, the agent also sends it for app-aware deployments and reporting context.
 ## Configuration Keys
 
 | Option | Type | Default | Description |
@@ -140,23 +140,23 @@ PULSE_AGENT_WIDGET_TOKEN=
 
 Leave `PULSE_AGENT_WIDGET_TOKEN` unset unless Pulse Support explicitly gives you one. It is not the `app_*` key.
 
-## Heroku Config Vars
+## Deployment Environment Variables
 
-Set these in Heroku under Settings -> Config Vars, or with the Heroku CLI:
+Set the same values in whatever platform you deploy on. The host should provide them as environment variables during build or at runtime, and your app should expose them to the browser through a runtime config file or server-rendered bootstrap.
 
-```bash
-heroku config:set PULSE_AGENT_SLUG=your-organization-slug
-heroku config:set PULSE_AGENT_APP_KEY=app_your_public_application_key
-heroku config:set PULSE_AGENT_API_BASE_URL=https://pulse.service.primexperts.co.za
-heroku config:set PULSE_AGENT_TITLE=Support
-heroku config:set PULSE_AGENT_ENVIRONMENT=production
-heroku config:set PULSE_AGENT_ERROR_MONITORING=true
-heroku config:set PULSE_AGENT_CAPTURE_UNHANDLED_ERRORS=true
-heroku config:set PULSE_AGENT_CAPTURE_UNHANDLED_REJECTIONS=true
-heroku config:set PULSE_AGENT_CAPTURE_FETCH_ERRORS=true
+```env
+PULSE_AGENT_SLUG=your-organization-slug
+PULSE_AGENT_APP_KEY=app_your_public_application_key
+PULSE_AGENT_API_BASE_URL=https://pulse.service.primexperts.co.za
+PULSE_AGENT_TITLE=Support
+PULSE_AGENT_ENVIRONMENT=production
+PULSE_AGENT_ERROR_MONITORING=true
+PULSE_AGENT_CAPTURE_UNHANDLED_ERRORS=true
+PULSE_AGENT_CAPTURE_UNHANDLED_REJECTIONS=true
+PULSE_AGENT_CAPTURE_FETCH_ERRORS=true
 ```
 
-If your app uses a `runtime-config.js` file, make sure Heroku serves that file from environment values at request time or regenerates it during build/startup.
+If your app uses a `runtime-config.js` file, generate that file from environment values at request time, build time, or startup depending on how your host serves assets.
 
 ## Required Code Structure
 
@@ -172,7 +172,7 @@ Structure your app so `createPulseAgent(...)` runs:
 
 Do not initialize Pulse Agent inside frequently re-rendered child components, route components that mount repeatedly, button click handlers, or server-only files. If the root component can unmount, keep the returned handle and call `agent.destroy()` during cleanup.
 
-For error monitoring, timing matters: errors that happen before `createPulseAgent(...)` runs cannot be captured by Pulse Agent. If you want broad coverage, load runtime config first and initialize Pulse Agent before bootstrapping the rest of the application where your framework allows it.
+For error monitoring, timing matters: errors that happen before `createPulseAgent(...)` runs cannot be captured by Pulse Agent. If you want broad coverage, load runtime config first and initialize Pulse Agent before bootstrapping the rest of the application where your framework allows it.
 ## Runtime Config Pattern
 
 A common production-safe pattern is to load `/runtime-config.js` before your app bundle:
@@ -334,7 +334,7 @@ Pulse Agent is a browser widget, so it uses standard browser networking APIs to
 - `EventSource` keeps the chat connected for realtime replies.
 - Optional `fetch` wrapping reports failed website requests only when `errorMonitoring` and `captureFetchErrors` are enabled.
 
-The package does not run install scripts, does not start background processes, does not open arbitrary sockets, and does not use Node filesystem or shell APIs at runtime. Network calls are made from the visitor's browser after the website initializes `createPulseAgent(...)`, and they target the configured `apiBaseUrl` plus optional WhatsApp links when configured.
+The package does not run install scripts, does not start background processes, does not open arbitrary sockets, and does not use Node filesystem or shell APIs at runtime. Network calls are made from the visitor's browser after the website initializes `createPulseAgent(...)`, and they target the configured `apiBaseUrl` plus optional WhatsApp links when configured.
 ## Error Monitoring
 
 Error monitoring is opt-in. Installing the package does not capture anything until `errorMonitoring: true` is passed to `createPulseAgent`.
@@ -400,10 +400,10 @@ Admin setup endpoints are separate and should remain authenticated.
 - One package for webchat and optional browser error monitoring.
 - Framework-agnostic browser integration.
 - Works with npm or a script tag.
-- Supports runtime configuration, which is useful for Heroku, Docker, static hosting, and multi-environment deployments.
+- Supports runtime configuration for static hosting, server-rendered apps, containerized apps, and other multi-environment deployments.
 - Uses the organization `slug`, plus `appKey` when available, so users do not need to handle internal widget tokens.
-- Supports visitor profile capture, history loading, transcript email requests, SSE replies, WhatsApp launcher/contact path where configured, manual open/close, and manual exception reporting.
-- Supports operational workflows verified in the Pulse source: assignment, status/priority updates, internal notes, follow-ups, customer profiles, tags, notifications, activity logs, exports, and dashboard KPIs.
+- Supports visitor profile capture, history loading, transcript email requests, SSE replies, WhatsApp launcher/contact path where configured, manual open/close, and manual exception reporting.
+- Supports operational workflows verified in the Pulse source: assignment, status/priority updates, internal notes, follow-ups, customer profiles, tags, notifications, activity logs, exports, and dashboard KPIs.
 - Supports role-based team operation: admins manage setup and assignment, while agents work assigned conversations.
 
 ## Limitations
@@ -475,4 +475,5 @@ Confirm all of the following:
 - `errorMonitoring: true` is present in runtime config.
 - The widget successfully resolves a widget token.
 - The error happens after `createPulseAgent(...)` runs.
-- The browser can post to `/api/pulse/public/webchat/{widgetToken}/errors`.
+- The browser can post to `/api/pulse/public/webchat/{widgetToken}/errors`.
+

package/docs/IMPLEMENTATION-GUIDE.md

@@ -91,7 +91,7 @@ Pulse Agent is a browser widget, so it uses standard browser networking APIs to
 - `EventSource` keeps the chat connected for realtime replies.
 - Optional `fetch` wrapping reports failed website requests only when `errorMonitoring` and `captureFetchErrors` are enabled.
 
-The package does not run install scripts, does not start background processes, does not open arbitrary sockets, and does not use Node filesystem or shell APIs at runtime. Network calls are made from the visitor's browser after the website initializes `createPulseAgent(...)`, and they target the configured `apiBaseUrl` plus optional WhatsApp links when configured.
+The package does not run install scripts, does not start background processes, does not open arbitrary sockets, and does not use Node filesystem or shell APIs at runtime. Network calls are made from the visitor's browser after the website initializes `createPulseAgent(...)`, and they target the configured `apiBaseUrl` plus optional WhatsApp links when configured.
 ## 5. Error Monitoring Configuration
 
 Error monitoring is off by default. Enable it explicitly:
@@ -143,7 +143,7 @@ try {
 
 ## 6. Environment Variable Names
 
-Use these names in Heroku, Docker, CI, or your hosting platform:
+Use these names in your platform environment, secret store, or deployment settings:
 
 ```env
 PULSE_AGENT_SLUG=acme-support
@@ -187,7 +187,7 @@ Structure your app so `createPulseAgent(...)` runs:
 
 Do not initialize Pulse Agent inside frequently re-rendered child components, route components that mount repeatedly, button click handlers, or server-only files. If the root component can unmount, keep the returned handle and call `agent.destroy()` during cleanup.
 
-For error monitoring, timing matters: errors that happen before `createPulseAgent(...)` runs cannot be captured by Pulse Agent. If you want broad coverage, load runtime config first and initialize Pulse Agent before bootstrapping the rest of the application where your framework allows it.
+For error monitoring, timing matters: errors that happen before `createPulseAgent(...)` runs cannot be captured by Pulse Agent. If you want broad coverage, load runtime config first and initialize Pulse Agent before bootstrapping the rest of the application where your framework allows it.
 ## 7. Runtime Config Setup
 
 Frontend bundles usually cannot read platform environment variables directly at runtime. Use a runtime config file generated from environment variables.
@@ -240,23 +240,23 @@ if (pulseAgentConfig?.slug) {
 }
 ```
 
-## 8. Heroku Setup
+## 8. Deployment Setup
 
-Set config vars:
+Set the same values in your host environment, secret store, or deployment settings. The exact mechanism depends on your platform, but the goal is the same: make the values available to the server or build pipeline, then expose them to the browser through a runtime config file or equivalent bootstrap.
 
-```bash
-heroku config:set PULSE_AGENT_SLUG=acme-support
-heroku config:set PULSE_AGENT_APP_KEY=app_your_public_application_key
-heroku config:set PULSE_AGENT_API_BASE_URL=https://pulse.service.primexperts.co.za
-heroku config:set PULSE_AGENT_TITLE=Acme Support
-heroku config:set PULSE_AGENT_ENVIRONMENT=production
-heroku config:set PULSE_AGENT_ERROR_MONITORING=true
-heroku config:set PULSE_AGENT_CAPTURE_UNHANDLED_ERRORS=true
-heroku config:set PULSE_AGENT_CAPTURE_UNHANDLED_REJECTIONS=true
-heroku config:set PULSE_AGENT_CAPTURE_FETCH_ERRORS=true
+```env
+PULSE_AGENT_SLUG=acme-support
+PULSE_AGENT_APP_KEY=app_your_public_application_key
+PULSE_AGENT_API_BASE_URL=https://pulse.service.primexperts.co.za
+PULSE_AGENT_TITLE=Acme Support
+PULSE_AGENT_ENVIRONMENT=production
+PULSE_AGENT_ERROR_MONITORING=true
+PULSE_AGENT_CAPTURE_UNHANDLED_ERRORS=true
+PULSE_AGENT_CAPTURE_UNHANDLED_REJECTIONS=true
+PULSE_AGENT_CAPTURE_FETCH_ERRORS=true
 ```
 
-If your app uses a generated `public/runtime-config.js`, run the generator during build or startup. If your app serves `/runtime-config.js` from Node/Express, read `process.env` and emit the config response at request time.
+If you generate a runtime config file, make sure the host serves it from environment values at request time or rebuilds it during startup.
 
 ## 9. Framework Notes
 
@@ -300,7 +300,7 @@ These endpoints are public by design for website visitors. Admin setup endpoints
 - One small browser package for chat and optional error reporting.
 - No visitor login required.
 - No need for customers to manage internal widget tokens.
-- Supports runtime config for Heroku and similar platforms.
+- Supports runtime config for static hosting, server-rendered apps, containerized apps, and other multi-environment deployments.
 - Works with npm, module bundlers, or a CDN script tag.
 - Supports multiple frontend frameworks.
 - Uses standard browser APIs: `fetch`, `EventSource`, and DOM events.
@@ -356,4 +356,6 @@ Check organization slug, app key, and whether Webchat is enabled for the selecte
 
 ### Resolve returns 401 or 403
 
-Check whether the public resolve route is accessible and whether the app key is valid.
+Check whether the public resolve route is accessible and whether the app key is valid.
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@primexperts.co/pulse-agent",
-  "version": "5.7.0",
+  "version": "5.7.2",
   "description": "Embeddable Pulse floating chat agent widget.",
   "type": "module",
   "main": "./dist/index.js",