@hyve-sdk/js 1.3.3 → 1.3.4

package/README.md

@@ -165,9 +165,7 @@ await client.sendTelemetry(
   'attack',                        // Event sub-action (optional)
   {                                // Event details - auto-stringified (optional)
     button: 'attack-btn',
-    screenPosition: { x: 100, y: 200 }
-  },
-  {                                // Custom data - auto-stringified (optional)
+    screenPosition: { x: 100, y: 200 },
     damage: 100,
     targetId: 'enemy-123',
     weaponType: 'sword',
@@ -190,7 +188,8 @@ await client.sendTelemetry(
 
 **Features:**
 - Automatically includes `session_id` and `game_id` from client
-- Objects in `event_details` and `custom_data` are auto-stringified to JSON
+- Objects in `event_details` are auto-stringified to JSON
+- Validates `event_details` is valid JSON before sending (returns false if invalid)
 - All events tied to authenticated user identity
 
 ## API Integration
@@ -772,7 +771,7 @@ uiLogger.debug('Button clicked');
 - `getInventoryItem(itemId)` - Get specific inventory item
 
 ### Telemetry
-- `sendTelemetry(location, category, action, subCategory?, subAction?, details?, customData?, platformId?)` - Send JWT-authenticated analytics event (uses game ID from URL)
+- `sendTelemetry(location, category, action, subCategory?, subAction?, details?, platformId?)` - Send JWT-authenticated analytics event (uses game ID from URL)
 - `updateTelemetryConfig(config)` - Update telemetry settings
 
 ### Ads
@@ -841,6 +840,14 @@ bun run build
 
 For complete documentation and examples, visit [https://docs.hyve.gg](https://docs.hyve.gg)
 
+### Additional Guides
+
+- [Telemetry Guide](./docs/TELEMETRY.md) - Best practices, validation rules, and examples for event tracking
+- [Billing Integration](./docs/BILLING_INTEGRATION.md) - Platform-aware billing with Stripe and In-App Purchases
+- [Billing Migration Guide](./docs/BILLING_MIGRATION_GUIDE.md) - Upgrading from older billing implementations
+- [Ads Integration](./docs/ads.md) - Google H5 Games Ads integration
+- [Native Bridge](./docs/NATIVE_BRIDGE.md) - React Native WebView communication
+
 ## License
 
 MIT

package/dist/index.d.mts

@@ -33,8 +33,6 @@ interface TelemetryEvent {
     event_details?: Record<string, any> | string | null;
     /** Mapping details as JSON string or object (optional) */
     mapping_details?: Record<string, any> | string | null;
-    /** Custom data as JSON string or object (optional) */
-    custom_data?: Record<string, any> | string | null;
 }
 /**
  * Additional telemetry data that can be passed with events
@@ -425,11 +423,10 @@ declare class HyveClient {
      * @param eventSubCategory Optional sub-category
      * @param eventSubAction Optional sub-action
      * @param eventDetails Optional event details (object or JSON string)
-     * @param customData Optional custom data (object or JSON string)
      * @param platformId Optional platform identifier
      * @returns Promise resolving to boolean indicating success
      */
-    sendTelemetry(eventLocation: string, eventCategory: string, eventAction: string, eventSubCategory?: string | null, eventSubAction?: string | null, eventDetails?: Record<string, any> | string | null, customData?: Record<string, any> | null, platformId?: string | null): Promise<boolean>;
+    sendTelemetry(eventLocation: string, eventCategory: string, eventAction: string, eventSubCategory?: string | null, eventSubAction?: string | null, eventDetails?: Record<string, any> | string | null, platformId?: string | null): Promise<boolean>;
     /**
      * Makes an authenticated API call using the JWT token
      * @param endpoint API endpoint path (will be appended to base URL)

package/dist/index.d.ts

@@ -33,8 +33,6 @@ interface TelemetryEvent {
     event_details?: Record<string, any> | string | null;
     /** Mapping details as JSON string or object (optional) */
     mapping_details?: Record<string, any> | string | null;
-    /** Custom data as JSON string or object (optional) */
-    custom_data?: Record<string, any> | string | null;
 }
 /**
  * Additional telemetry data that can be passed with events
@@ -425,11 +423,10 @@ declare class HyveClient {
      * @param eventSubCategory Optional sub-category
      * @param eventSubAction Optional sub-action
      * @param eventDetails Optional event details (object or JSON string)
-     * @param customData Optional custom data (object or JSON string)
      * @param platformId Optional platform identifier
      * @returns Promise resolving to boolean indicating success
      */
-    sendTelemetry(eventLocation: string, eventCategory: string, eventAction: string, eventSubCategory?: string | null, eventSubAction?: string | null, eventDetails?: Record<string, any> | string | null, customData?: Record<string, any> | null, platformId?: string | null): Promise<boolean>;
+    sendTelemetry(eventLocation: string, eventCategory: string, eventAction: string, eventSubCategory?: string | null, eventSubAction?: string | null, eventDetails?: Record<string, any> | string | null, platformId?: string | null): Promise<boolean>;
     /**
      * Makes an authenticated API call using the JWT token
      * @param endpoint API endpoint path (will be appended to base URL)

package/dist/index.js

@@ -1398,10 +1398,17 @@ var HyveClient = class {
     logger.info("HyveClient Initialized");
     logger.info("==========================================");
     logger.info("Session ID:", this.sessionId);
-    logger.info("Environment:", this.telemetryConfig.isDev ? "DEVELOPMENT" : "PRODUCTION", `(${envSource})`);
+    logger.info(
+      "Environment:",
+      this.telemetryConfig.isDev ? "DEVELOPMENT" : "PRODUCTION",
+      `(${envSource})`
+    );
     logger.info("API Base URL:", this.apiBaseUrl);
     logger.info("Ads enabled:", this.adsService.isEnabled());
-    logger.info("Billing configured:", Object.keys(this.billingConfig).length > 0);
+    logger.info(
+      "Billing configured:",
+      Object.keys(this.billingConfig).length > 0
+    );
     logger.debug("Config:", {
       isDev: this.telemetryConfig.isDev,
       hasCustomApiUrl: !!config?.apiBaseUrl,
@@ -1472,11 +1479,10 @@ var HyveClient = class {
    * @param eventSubCategory Optional sub-category
    * @param eventSubAction Optional sub-action
    * @param eventDetails Optional event details (object or JSON string)
-   * @param customData Optional custom data (object or JSON string)
    * @param platformId Optional platform identifier
    * @returns Promise resolving to boolean indicating success
    */
-  async sendTelemetry(eventLocation, eventCategory, eventAction, eventSubCategory, eventSubAction, eventDetails, customData, platformId) {
+  async sendTelemetry(eventLocation, eventCategory, eventAction, eventSubCategory, eventSubAction, eventDetails, platformId) {
     if (!this.jwtToken) {
       logger.error("JWT token required. Call authenticateFromUrl first.");
       return false;
@@ -1486,6 +1492,19 @@ var HyveClient = class {
       return false;
     }
     try {
+      if (eventDetails) {
+        try {
+          if (typeof eventDetails === "string") {
+            JSON.parse(eventDetails);
+          } else if (typeof eventDetails === "object") {
+            JSON.stringify(eventDetails);
+          }
+        } catch (validationError) {
+          logger.error("Invalid JSON in eventDetails:", validationError);
+          logger.error("eventDetails value:", eventDetails);
+          return false;
+        }
+      }
       const toJsonString = (data) => {
         if (!data) return null;
         return typeof data === "string" ? data : JSON.stringify(data);
@@ -1499,11 +1518,10 @@ var HyveClient = class {
         event_action: eventAction,
         event_sub_category: eventSubCategory || null,
         event_sub_action: eventSubAction || null,
-        event_details: toJsonString(eventDetails),
-        custom_data: toJsonString(customData)
+        event_details: toJsonString(eventDetails)
       };
       logger.debug("Sending telemetry event:", telemetryEvent);
-      const telemetryUrl = `${this.apiBaseUrl}/api/v1/telemetry/send`;
+      const telemetryUrl = `${this.apiBaseUrl}/api/v1/analytics/send`;
       const response = await fetch(telemetryUrl, {
         method: "POST",
         headers: {

package/dist/index.mjs

@@ -1358,10 +1358,17 @@ var HyveClient = class {
     logger.info("HyveClient Initialized");
     logger.info("==========================================");
     logger.info("Session ID:", this.sessionId);
-    logger.info("Environment:", this.telemetryConfig.isDev ? "DEVELOPMENT" : "PRODUCTION", `(${envSource})`);
+    logger.info(
+      "Environment:",
+      this.telemetryConfig.isDev ? "DEVELOPMENT" : "PRODUCTION",
+      `(${envSource})`
+    );
     logger.info("API Base URL:", this.apiBaseUrl);
     logger.info("Ads enabled:", this.adsService.isEnabled());
-    logger.info("Billing configured:", Object.keys(this.billingConfig).length > 0);
+    logger.info(
+      "Billing configured:",
+      Object.keys(this.billingConfig).length > 0
+    );
     logger.debug("Config:", {
       isDev: this.telemetryConfig.isDev,
       hasCustomApiUrl: !!config?.apiBaseUrl,
@@ -1432,11 +1439,10 @@ var HyveClient = class {
    * @param eventSubCategory Optional sub-category
    * @param eventSubAction Optional sub-action
    * @param eventDetails Optional event details (object or JSON string)
-   * @param customData Optional custom data (object or JSON string)
    * @param platformId Optional platform identifier
    * @returns Promise resolving to boolean indicating success
    */
-  async sendTelemetry(eventLocation, eventCategory, eventAction, eventSubCategory, eventSubAction, eventDetails, customData, platformId) {
+  async sendTelemetry(eventLocation, eventCategory, eventAction, eventSubCategory, eventSubAction, eventDetails, platformId) {
     if (!this.jwtToken) {
       logger.error("JWT token required. Call authenticateFromUrl first.");
       return false;
@@ -1446,6 +1452,19 @@ var HyveClient = class {
       return false;
     }
     try {
+      if (eventDetails) {
+        try {
+          if (typeof eventDetails === "string") {
+            JSON.parse(eventDetails);
+          } else if (typeof eventDetails === "object") {
+            JSON.stringify(eventDetails);
+          }
+        } catch (validationError) {
+          logger.error("Invalid JSON in eventDetails:", validationError);
+          logger.error("eventDetails value:", eventDetails);
+          return false;
+        }
+      }
       const toJsonString = (data) => {
         if (!data) return null;
         return typeof data === "string" ? data : JSON.stringify(data);
@@ -1459,11 +1478,10 @@ var HyveClient = class {
         event_action: eventAction,
         event_sub_category: eventSubCategory || null,
         event_sub_action: eventSubAction || null,
-        event_details: toJsonString(eventDetails),
-        custom_data: toJsonString(customData)
+        event_details: toJsonString(eventDetails)
       };
       logger.debug("Sending telemetry event:", telemetryEvent);
-      const telemetryUrl = `${this.apiBaseUrl}/api/v1/telemetry/send`;
+      const telemetryUrl = `${this.apiBaseUrl}/api/v1/analytics/send`;
       const response = await fetch(telemetryUrl, {
         method: "POST",
         headers: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyve-sdk/js",
-  "version": "1.3.3",
+  "version": "1.3.4",
   "description": "Hyve SDK - TypeScript wrapper for Hyve game server integration",
   "private": false,
   "publishConfig": {