@appxiom/4react 0.1.15 → 0.1.16
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 +35 -0
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
- [Before You Begin](#before-you-begin)
|
|
8
8
|
- [Requirements](#requirements)
|
|
9
9
|
- [Installation](#installation)
|
|
10
|
+
- [Test Integration](#test-integration)
|
|
10
11
|
- [Quick Start](#quick-start)
|
|
11
12
|
- [TypeScript](#typescript)
|
|
12
13
|
- [Automatic React Instrumentation](#automatic-react-instrumentation)
|
|
@@ -39,6 +40,40 @@ Install the React integration and React. `@appxiom/web` is installed automatical
|
|
|
39
40
|
npm install @appxiom/4react react
|
|
40
41
|
```
|
|
41
42
|
|
|
43
|
+
## Test Integration
|
|
44
|
+
|
|
45
|
+
After installation, validate that your SDK is connected properly by triggering a temporary test issue from the initialized client. Call the helper method `#sym:raiseTestIssue` once in a safe debug path or temporary validation flow:
|
|
46
|
+
|
|
47
|
+
### JavaScript
|
|
48
|
+
|
|
49
|
+
```javascript
|
|
50
|
+
const ax = await init(
|
|
51
|
+
'YOUR_APP_KEY',
|
|
52
|
+
'YOUR_PLATFORM_KEY',
|
|
53
|
+
'YOUR_APP_VERSION',
|
|
54
|
+
'YOUR_BUILD_IDENTIFIER',
|
|
55
|
+
);
|
|
56
|
+
|
|
57
|
+
ax.raiseTestIssue();
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### TypeScript
|
|
61
|
+
|
|
62
|
+
```typescript
|
|
63
|
+
import init, { type AXReact } from '@appxiom/4react';
|
|
64
|
+
|
|
65
|
+
const ax: AXReact = await init(
|
|
66
|
+
'YOUR_APP_KEY',
|
|
67
|
+
'YOUR_PLATFORM_KEY',
|
|
68
|
+
'YOUR_APP_VERSION',
|
|
69
|
+
'YOUR_BUILD_IDENTIFIER',
|
|
70
|
+
);
|
|
71
|
+
|
|
72
|
+
ax.raiseTestIssue();
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
This creates a custom issue with a payload and stack trace so you can confirm the issue is being reported in the Appxiom dashboard. After successful validation, remove the call and any temporary debug trigger so the test issue is not left in production code.
|
|
76
|
+
|
|
42
77
|
## Quick Start
|
|
43
78
|
|
|
44
79
|
Initialize the SDK once from browser-only application startup code. Retain the returned `ax` instance to call its public API elsewhere in your application.
|
package/package.json
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
"license": "UNLICENSED",
|
|
5
5
|
"author": "BasilGregory Software Labs Private Limited",
|
|
6
6
|
"homepage": "https://www.appxiom.com",
|
|
7
|
-
"version": "0.1.
|
|
7
|
+
"version": "0.1.16",
|
|
8
8
|
"publishConfig": {
|
|
9
9
|
"access": "public"
|
|
10
10
|
},
|
|
@@ -39,7 +39,7 @@
|
|
|
39
39
|
"main": "index.js",
|
|
40
40
|
"module": "index.js",
|
|
41
41
|
"dependencies": {
|
|
42
|
-
"@appxiom/web": "^0.1.
|
|
42
|
+
"@appxiom/web": "^0.1.12"
|
|
43
43
|
},
|
|
44
44
|
"devDependencies": {
|
|
45
45
|
"typescript": "^5.9.3"
|