@primexperts.co/pulse-agent 5.7.0 → 5.7.1
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/LICENSE +1 -1
- package/README.md +5 -5
- package/docs/IMPLEMENTATION-GUIDE.md +2 -2
- package/package.json +1 -1
package/LICENSE
CHANGED
|
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
|
18
18
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
19
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
20
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
-
SOFTWARE.
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -81,7 +81,7 @@ Use these values in your widget config:
|
|
|
81
81
|
| API base URL | `https://pulse.service.primexperts.co.za` | Yes | Use the API URL shown by your Pulse environment. |
|
|
82
82
|
| Website origin | `https://www.example.com` | Required for production | Add the exact site origin where the widget will run. |
|
|
83
83
|
|
|
84
|
-
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.
|
|
84
|
+
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.
|
|
85
85
|
## Configuration Keys
|
|
86
86
|
|
|
87
87
|
| Option | Type | Default | Description |
|
|
@@ -172,7 +172,7 @@ Structure your app so `createPulseAgent(...)` runs:
|
|
|
172
172
|
|
|
173
173
|
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.
|
|
174
174
|
|
|
175
|
-
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.
|
|
175
|
+
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.
|
|
176
176
|
## Runtime Config Pattern
|
|
177
177
|
|
|
178
178
|
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
|
|
|
334
334
|
- `EventSource` keeps the chat connected for realtime replies.
|
|
335
335
|
- Optional `fetch` wrapping reports failed website requests only when `errorMonitoring` and `captureFetchErrors` are enabled.
|
|
336
336
|
|
|
337
|
-
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.
|
|
337
|
+
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.
|
|
338
338
|
## Error Monitoring
|
|
339
339
|
|
|
340
340
|
Error monitoring is opt-in. Installing the package does not capture anything until `errorMonitoring: true` is passed to `createPulseAgent`.
|
|
@@ -402,8 +402,8 @@ Admin setup endpoints are separate and should remain authenticated.
|
|
|
402
402
|
- Works with npm or a script tag.
|
|
403
403
|
- Supports runtime configuration, which is useful for Heroku, Docker, static hosting, and multi-environment deployments.
|
|
404
404
|
- Uses the organization `slug`, plus `appKey` when available, so users do not need to handle internal widget tokens.
|
|
405
|
-
- Supports visitor profile capture, history loading, transcript email requests, SSE replies, WhatsApp launcher/contact path where configured, manual open/close, and manual exception reporting.
|
|
406
|
-
- 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.
|
|
405
|
+
- Supports visitor profile capture, history loading, transcript email requests, SSE replies, WhatsApp launcher/contact path where configured, manual open/close, and manual exception reporting.
|
|
406
|
+
- 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.
|
|
407
407
|
- Supports role-based team operation: admins manage setup and assignment, while agents work assigned conversations.
|
|
408
408
|
|
|
409
409
|
## Limitations
|
|
@@ -91,7 +91,7 @@ Pulse Agent is a browser widget, so it uses standard browser networking APIs to
|
|
|
91
91
|
- `EventSource` keeps the chat connected for realtime replies.
|
|
92
92
|
- Optional `fetch` wrapping reports failed website requests only when `errorMonitoring` and `captureFetchErrors` are enabled.
|
|
93
93
|
|
|
94
|
-
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.
|
|
94
|
+
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.
|
|
95
95
|
## 5. Error Monitoring Configuration
|
|
96
96
|
|
|
97
97
|
Error monitoring is off by default. Enable it explicitly:
|
|
@@ -187,7 +187,7 @@ Structure your app so `createPulseAgent(...)` runs:
|
|
|
187
187
|
|
|
188
188
|
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.
|
|
189
189
|
|
|
190
|
-
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.
|
|
190
|
+
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.
|
|
191
191
|
## 7. Runtime Config Setup
|
|
192
192
|
|
|
193
193
|
Frontend bundles usually cannot read platform environment variables directly at runtime. Use a runtime config file generated from environment variables.
|