@mostly-good-metrics/javascript 0.2.0 → 0.4.1

package/src/types.ts

@@ -134,6 +134,11 @@ export interface MGMEvent {
    */
   name: string;
 
+  /**
+   * Unique client-generated ID for deduplication.
+   */
+  client_event_id: string;
+
   /**
    * ISO8601 timestamp when the event occurred.
    */
@@ -159,6 +164,11 @@ export interface MGMEvent {
    */
   appVersion?: string;
 
+  /**
+   * The app build number (separate from version).
+   */
+  appBuildNumber?: string;
+
   /**
    * The OS version string.
    */
@@ -169,6 +179,21 @@ export interface MGMEvent {
    */
   environment: string;
 
+  /**
+   * The device manufacturer (e.g., "Apple", "Samsung").
+   */
+  deviceManufacturer?: string;
+
+  /**
+   * The user's locale (e.g., "en-US").
+   */
+  locale?: string;
+
+  /**
+   * The user's timezone (e.g., "America/New_York").
+   */
+  timezone?: string;
+
   /**
    * Custom properties attached to this event.
    */
@@ -182,10 +207,14 @@ export interface MGMEvent {
 export interface MGMEventContext {
   platform: Platform;
   appVersion?: string;
+  appBuildNumber?: string;
   osVersion?: string;
   userId?: string;
   sessionId?: string;
   environment: string;
+  deviceManufacturer?: string;
+  locale?: string;
+  timezone?: string;
 }
 
 /**

package/src/utils.test.ts

@@ -5,6 +5,8 @@ import {
   validateEventName,
   sanitizeProperties,
   resolveConfiguration,
+  getLocale,
+  getTimezone,
 } from './utils';
 import { Constraints, DefaultConfiguration, MGMError } from './types';
 
@@ -237,3 +239,32 @@ describe('resolveConfiguration', () => {
     expect(config.maxStoredEvents).toBe(Constraints.MIN_STORED_EVENTS);
   });
 });
+
+describe('getLocale', () => {
+  it('should return a non-empty string', () => {
+    const locale = getLocale();
+    expect(typeof locale).toBe('string');
+    expect(locale.length).toBeGreaterThan(0);
+  });
+
+  it('should return a locale-like string (e.g., en, en-US)', () => {
+    const locale = getLocale();
+    // Locale should be something like "en", "en-US", "fr-FR", etc.
+    expect(locale).toMatch(/^[a-z]{2}(-[A-Z]{2})?$/i);
+  });
+});
+
+describe('getTimezone', () => {
+  it('should return a string', () => {
+    const timezone = getTimezone();
+    expect(typeof timezone).toBe('string');
+  });
+
+  it('should return a valid IANA timezone or empty string', () => {
+    const timezone = getTimezone();
+    // Should be empty or a valid IANA timezone like "America/New_York" or "UTC"
+    if (timezone) {
+      expect(timezone).toMatch(/^([A-Za-z_]+\/[A-Za-z_]+|UTC)$/);
+    }
+  });
+});

package/src/utils.ts

@@ -310,3 +310,24 @@ export function getDeviceModel(): string {
 export function delay(ms: number): Promise<void> {
   return new Promise((resolve) => setTimeout(resolve, ms));
 }
+
+/**
+ * Get the user's locale.
+ */
+export function getLocale(): string {
+  if (typeof navigator !== 'undefined') {
+    return navigator.language || 'en';
+  }
+  return 'en';
+}
+
+/**
+ * Get the user's timezone.
+ */
+export function getTimezone(): string {
+  try {
+    return Intl.DateTimeFormat().resolvedOptions().timeZone || '';
+  } catch {
+    return '';
+  }
+}