@appxiom/web 0.1.10 → 0.1.11

package/README.md

@@ -4,6 +4,7 @@ The official client-side JavaScript SDK for Appxiom. Use this package to initial
 
 ## Table of Contents
 
+- [Before You Begin](#before-you-begin)
 - [Installation](#installation)
 - [Quick Start](#quick-start)
 - [Vite](#vite)
@@ -12,6 +13,15 @@ The official client-side JavaScript SDK for Appxiom. Use this package to initial
 - [Public API](#public-api)
 - [Error Types](#error-types)
 
+## Before You Begin
+
+1. Register for an Appxiom account at [appxiom.com](https://www.appxiom.com/) and log in to the dashboard.
+2. Use the `+` at the top left corner to create an app.
+3. Link your web application to Appxiom using the domain (eg: app.xyz.com) in the settings page. No PORT needs to be provided.
+4. Copy the APP KEY and PLATFORM KEY from the Appxiom dashboard.
+5. Integrate the Appxiom Web package into your application as mentioned in installation section.
+6. Test your integration to ensure monitoring and reporting are working as expected.
+
 ## Installation
 
 ```bash
@@ -54,6 +64,8 @@ const ax: AX = await init(
 
 `@appxiom/web` includes a WebAssembly binary. During local development, exclude the package from Vite dependency optimization so Vite preserves the binary's source-relative URL:
 
+### JavaScript
+
 ```javascript
 import { defineConfig } from 'vite';
 
@@ -64,6 +76,18 @@ export default defineConfig({
 });
 ```
 
+### TypeScript
+
+```typescript
+import { defineConfig } from 'vite';
+
+export default defineConfig({
+  optimizeDeps: {
+    exclude: ['@appxiom/web'],
+  },
+});
+```
+
 After adding this setting, clear Vite's optimized-dependency cache and restart the development server:
 
 ```bash

package/ax_web_core/ax_web_core.d.ts

@@ -93,6 +93,11 @@ export function log_event(type_id: number, info: any): Promise<void>;
  */
 export function log_event_activity(name: string, details: any): Promise<void>;
 
+/**
+ * Add Lifecycle Activity
+ */
+export function log_lifecycle_activity(name: string, details: any): Promise<void>;
+
 /**
  * Log resource load error
  */
@@ -148,14 +153,15 @@ export interface InitOutput {
     readonly log_activity: (a: number, b: number, c: number) => number;
     readonly log_event: (a: number, b: number) => number;
     readonly log_event_activity: (a: number, b: number, c: number) => number;
+    readonly log_lifecycle_activity: (a: number, b: number, c: number) => number;
     readonly log_resource_load_error: (a: number, b: number, c: number) => number;
     readonly report_custom_issue: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => number;
     readonly report_error: (a: number) => number;
     readonly set_custom_id: (a: number, b: number) => number;
     readonly start_goal: (a: number, b: number) => number;
     readonly __wasm_bindgen_func_elem_458: (a: number, b: number, c: number) => void;
-    readonly __wasm_bindgen_func_elem_1038: (a: number, b: number, c: number, d: number) => void;
-    readonly __wasm_bindgen_func_elem_1095: (a: number, b: number, c: number, d: number) => void;
+    readonly __wasm_bindgen_func_elem_1042: (a: number, b: number, c: number, d: number) => void;
+    readonly __wasm_bindgen_func_elem_1099: (a: number, b: number, c: number, d: number) => void;
     readonly __wasm_bindgen_func_elem_455: (a: number, b: number, c: number) => void;
     readonly __wasm_bindgen_func_elem_461: (a: number, b: number, c: number) => void;
     readonly __wasm_bindgen_func_elem_461_4: (a: number, b: number, c: number) => void;

package/ax_web_core/ax_web_core.js

@@ -274,6 +274,19 @@ export function log_event_activity(name, details) {
     return takeObject(ret);
 }
 
+/**
+ * Add Lifecycle Activity
+ * @param {string} name
+ * @param {any} details
+ * @returns {Promise<void>}
+ */
+export function log_lifecycle_activity(name, details) {
+    const ptr0 = passStringToWasm0(name, wasm.__wbindgen_export, wasm.__wbindgen_export2);
+    const len0 = WASM_VECTOR_LEN;
+    const ret = wasm.log_lifecycle_activity(ptr0, len0, addHeapObject(details));
+    return takeObject(ret);
+}
+
 /**
  * Log resource load error
  * @param {string} url
@@ -745,7 +758,7 @@ function __wbg_get_imports() {
                     const a = state0.a;
                     state0.a = 0;
                     try {
-                        return __wasm_bindgen_func_elem_1095(a, state0.b, arg0, arg1);
+                        return __wasm_bindgen_func_elem_1099(a, state0.b, arg0, arg1);
                     } finally {
                         state0.a = a;
                     }
@@ -775,7 +788,7 @@ function __wbg_get_imports() {
                     const a = state0.a;
                     state0.a = 0;
                     try {
-                        return __wasm_bindgen_func_elem_1095(a, state0.b, arg0, arg1);
+                        return __wasm_bindgen_func_elem_1099(a, state0.b, arg0, arg1);
                     } finally {
                         state0.a = a;
                     }
@@ -1025,7 +1038,7 @@ function __wbg_get_imports() {
         }, arguments); },
         __wbindgen_cast_0000000000000001: function(arg0, arg1) {
             // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [Externref], shim_idx: 51, ret: Result(Unit), inner_ret: Some(Result(Unit)) }, mutable: true }) -> Externref`.
-            const ret = makeMutClosure(arg0, arg1, __wasm_bindgen_func_elem_1038);
+            const ret = makeMutClosure(arg0, arg1, __wasm_bindgen_func_elem_1042);
             return addHeapObject(ret);
         },
         __wbindgen_cast_0000000000000002: function(arg0, arg1) {
@@ -1123,10 +1136,10 @@ function __wasm_bindgen_func_elem_450(arg0, arg1, arg2) {
     }
 }
 
-function __wasm_bindgen_func_elem_1038(arg0, arg1, arg2) {
+function __wasm_bindgen_func_elem_1042(arg0, arg1, arg2) {
     try {
         const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
-        wasm.__wasm_bindgen_func_elem_1038(retptr, arg0, arg1, addHeapObject(arg2));
+        wasm.__wasm_bindgen_func_elem_1042(retptr, arg0, arg1, addHeapObject(arg2));
         var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
         var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
         if (r1) {
@@ -1137,8 +1150,8 @@ function __wasm_bindgen_func_elem_1038(arg0, arg1, arg2) {
     }
 }
 
-function __wasm_bindgen_func_elem_1095(arg0, arg1, arg2, arg3) {
-    wasm.__wasm_bindgen_func_elem_1095(arg0, arg1, addHeapObject(arg2), addHeapObject(arg3));
+function __wasm_bindgen_func_elem_1099(arg0, arg1, arg2, arg3) {
+    wasm.__wasm_bindgen_func_elem_1099(arg0, arg1, addHeapObject(arg2), addHeapObject(arg3));
 }
 
 function __wasm_bindgen_func_elem_458(arg0, arg1, arg2) {

package/ax_web_core/ax_web_core_bg.wasm.d.ts

@@ -27,14 +27,15 @@ export const leakanalyzer_track_instance: (a: number, b: number) => number;
 export const log_activity: (a: number, b: number, c: number) => number;
 export const log_event: (a: number, b: number) => number;
 export const log_event_activity: (a: number, b: number, c: number) => number;
+export const log_lifecycle_activity: (a: number, b: number, c: number) => number;
 export const log_resource_load_error: (a: number, b: number, c: number) => number;
 export const report_custom_issue: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => number;
 export const report_error: (a: number) => number;
 export const set_custom_id: (a: number, b: number) => number;
 export const start_goal: (a: number, b: number) => number;
 export const __wasm_bindgen_func_elem_458: (a: number, b: number, c: number) => void;
-export const __wasm_bindgen_func_elem_1038: (a: number, b: number, c: number, d: number) => void;
-export const __wasm_bindgen_func_elem_1095: (a: number, b: number, c: number, d: number) => void;
+export const __wasm_bindgen_func_elem_1042: (a: number, b: number, c: number, d: number) => void;
+export const __wasm_bindgen_func_elem_1099: (a: number, b: number, c: number, d: number) => void;
 export const __wasm_bindgen_func_elem_455: (a: number, b: number, c: number) => void;
 export const __wasm_bindgen_func_elem_461: (a: number, b: number, c: number) => void;
 export const __wasm_bindgen_func_elem_461_4: (a: number, b: number, c: number) => void;

package/core/ax.js

@@ -69,6 +69,10 @@ export default class AX {
     // - 2 -> Fatal
     reportCustomIssue(title, description, severity, data = {}, stacktrace = null) {
         if (this.wasm && this.wasm.report_custom_issue) {
+            // if the stacktrace is not provided, generate one
+            if (!stacktrace) {
+                stacktrace = new Error('Custom issue stacktrace.').stack ?? null;
+            }
             this.wasm.report_custom_issue(title, description, severity, data, stacktrace);
         }
     }
@@ -93,4 +97,22 @@ export default class AX {
             this.wasm.log_event_activity(name, properties);
         }
     }
+
+    // Raise a test issue using the reportCustomIssue method
+    raiseTestIssue() {
+        const data = {
+            source: 'ax-sdk-test',
+            test: true,
+            timestamp: Date.now(),
+        };
+        const stack = new Error('Test issue generated by the AX SDK.').stack ?? null;
+
+        this.reportCustomIssue(
+            'Test Issue',
+            'This is a test issue generated by the AX SDK.',
+            1, // Major severity
+            data,
+            stack
+        );
+    }
 }

package/event/ax-event.js

@@ -14,7 +14,7 @@ function reportExit() {
 
 // Track page load
 window.addEventListener("load", () => {
-  AX.instance.wasm.log_event_activity("Page Load", {
+  AX.instance.wasm.log_lifecycle_activity("Page Load", {
     url: location.href,
     referrer: document.referrer,
     userAgent: navigator.userAgent,
@@ -49,7 +49,7 @@ window.addEventListener("load", () => {
 // Track SPA route changes (if using a SPA framework)
 // This is a generic example; you may need to adapt it based on your SPA framework.
 window.addEventListener("popstate", () => {
-  AX.instance.wasm.log_event_activity("SPA Route Change", {
+  AX.instance.wasm.log_lifecycle_activity("SPA Route Change", {
     url: location.href,
     ts: Date.now(),
   });
@@ -57,7 +57,7 @@ window.addEventListener("popstate", () => {
 
 // Track hash changes for SPA routing
 window.addEventListener("hashchange", () => {
-  AX.instance.wasm.log_event_activity("Hash Change", {
+  AX.instance.wasm.log_lifecycle_activity("Hash Change", {
     url: location.href,
     ts: Date.now(),
   });
@@ -69,7 +69,7 @@ window.addEventListener("hashchange", () => {
   const originalReplaceState = history.replaceState;
 
   history.pushState = function (...args) {
-    AX.instance.wasm.log_event_activity("SPA Route Change (pushState)", {
+    AX.instance.wasm.log_lifecycle_activity("SPA Route Change (pushState)", {
       url: location.href,
       ts: Date.now(),
     });
@@ -82,7 +82,7 @@ window.addEventListener("hashchange", () => {
   };
 
   history.replaceState = function (...args) {
-    AX.instance.wasm.log_event_activity("SPA Route Change (replaceState)", {
+    AX.instance.wasm.log_lifecycle_activity("SPA Route Change (replaceState)", {
       url: location.href,
       ts: Date.now(),
     });

package/package.json

@@ -4,7 +4,7 @@
   "license": "SEE LICENSE IN LICENSE",
   "author": "BasilGregory Software Labs Private Limited",
   "homepage": "https://www.appxiom.com",
-  "version": "0.1.10",
+  "version": "0.1.11",
   "publishConfig": {
     "access": "public"
   },