@reveldigital/player-client 1.0.13 → 1.0.15

package/lib/interfaces/config.interface.d.ts

@@ -1,34 +1,152 @@
+/**
+ * Interface representing configuration settings and events for the Revel Digital system.
+ *
+ * This interface defines the structure for configuration-related communication
+ * between gadgets and the player, particularly during design-time configuration
+ * and preference management operations.
+ *
+ * Configuration events are typically used when:
+ * - Opening configuration dialogs in the CMS
+ * - Applying preference changes from configuration UI
+ * - Communicating between parent and child windows during config operations
+ *
+ * ```typescript
+ * // Handle configuration events
+ * this.client.onPostMessage$.subscribe((config: IConfig) => {
+ *   if (config.type === ConfigType.ApplyConfig) {
+ *     this.applyPreferences(config.prefs);
+ *   }
+ * });
+ * ```
+ *
+ * @export
+ * @interface IConfig
+ * @since 1.0.0
+ */
 export interface IConfig {
     /**
-     * Preferences
+     * Dictionary of preference key-value pairs containing configuration settings.
      *
-     * @type {any}
+     * This object contains all the preference values that have been configured
+     * for the gadget. The keys correspond to preference names defined in the
+     * gadget's configuration schema, and values can be of any type.
      *
-     * @memberof IConfig
+     * ```typescript
+     * const config: IConfig = {
+     *   prefs: {
+     *     'title': 'My Gadget Title',
+     *     'backgroundColor': '#ff0000',
+     *     'refreshInterval': 30,
+     *     'showBorder': true,
+     *     'apiEndpoint': 'https://api.example.com/data'
+     *   },
+     *   type: ConfigType.ApplyConfig,
+     *   isOpener: false
+     * };
+     * ```
      */
     prefs: IDictionary<any>;
     /**
-     * Config type
+     * The type of configuration operation being performed.
      *
-     * @type {ConfigType}
+     * Indicates whether this is a request to open configuration UI
+     * or an instruction to apply new configuration values.
      *
-     * @memberof IConfig
+     * @see ConfigType enum for available values
      */
     type: ConfigType;
     /**
-     * Is this event triggered by the opener
+     * Indicates if this configuration event originated from a popup window opener.
      *
-     * @type {boolean}
+     * When true, this suggests the configuration change originated from a popup
+     * configuration window and may need to be propagated to the parent window.
+     * This is used internally for handling window communication during config operations.
      *
-     * @memberof IConfig
+     * ```typescript
+     * if (config.isOpener) {
+     *   // Propagate config changes from popup to parent window
+     *   window.parent.postMessage(configData, '*');
+     * }
+     * ```
      */
     isOpener: boolean;
 }
+/**
+ * Generic dictionary interface for key-value pairs.
+ *
+ * This interface provides a flexible way to represent objects with
+ * string keys and values of any type. It's commonly used for configuration
+ * preferences, command arguments, and other dynamic data structures.
+ *
+ * @template T - The type of values stored in the dictionary
+ *
+ * ```typescript
+ * // String dictionary
+ * const stringPrefs: IDictionary<string> = {
+ *   'title': 'My Title',
+ *   'description': 'My Description'
+ * };
+ *
+ * // Mixed type dictionary
+ * const mixedPrefs: IDictionary<any> = {
+ *   'title': 'My Title',
+ *   'count': 42,
+ *   'enabled': true
+ * };
+ * ```
+ *
+ * @export
+ * @interface IDictionary
+ */
 export interface IDictionary<T> {
     [Key: string]: T;
 }
+/**
+ * Enumeration of configuration operation types.
+ *
+ * Defines the different types of configuration-related operations
+ * that can be performed between gadgets and the player environment.
+ *
+ * @export
+ * @enum ConfigType
+ * @since 1.0.0
+ */
 export declare enum ConfigType {
+    /**
+     * Request to open the configuration interface.
+     *
+     * This type indicates that the configuration UI should be displayed,
+     * typically in response to a user action or system event.
+     *
+     * ```typescript
+     * // Trigger config UI opening
+     * const openConfigEvent: IConfig = {
+     *   prefs: {},
+     *   type: ConfigType.OpenConfig,
+     *   isOpener: false
+     * };
+     * ```
+     */
     OpenConfig = "openConfig",
+    /**
+     * Instruction to apply new configuration values.
+     *
+     * This type indicates that the provided preferences should be
+     * applied to the gadget's configuration, typically after the
+     * user has made changes in the configuration UI.
+     *
+     * ```typescript
+     * // Apply new configuration
+     * const applyConfigEvent: IConfig = {
+     *   prefs: {
+     *     'title': 'Updated Title',
+     *     'interval': 60
+     *   },
+     *   type: ConfigType.ApplyConfig,
+     *   isOpener: true
+     * };
+     * ```
+     */
     ApplyConfig = "applyConfig"
 }
 //# sourceMappingURL=config.interface.d.ts.map

package/lib/interfaces/config.interface.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.interface.d.ts","sourceRoot":"","sources":["../../../../../projects/reveldigital/player-client/src/lib/interfaces/config.interface.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,OAAO;IAEpB;;;;;;OAMG;IACH,KAAK,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC;IAExB;;;;;;OAMG;IACH,IAAI,EAAE,UAAU,CAAC;IAEjB;;;;;;OAMG;IACH,QAAQ,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,WAAW,CAAC,CAAC;IAC1B,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,CAAC;CACpB;AAED,oBAAY,UAAU;IAClB,UAAU,eAAe;IACzB,WAAW,gBAAgB;CAC9B"}
+{"version":3,"file":"config.interface.d.ts","sourceRoot":"","sources":["../../../../../projects/reveldigital/player-client/src/lib/interfaces/config.interface.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,WAAW,OAAO;IAEpB;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC;IAExB;;;;;;;OAOG;IACH,IAAI,EAAE,UAAU,CAAC;IAEjB;;;;;;;;;;;;;OAaG;IACH,QAAQ,EAAE,OAAO,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC;IAC1B,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,CAAC;CACpB;AAED;;;;;;;;;GASG;AACH,oBAAY,UAAU;IAClB;;;;;;;;;;;;;;OAcG;IACH,UAAU,eAAe;IAEzB;;;;;;;;;;;;;;;;;;OAkBG;IACH,WAAW,gBAAgB;CAC9B"}

package/lib/interfaces/device.interface.d.ts

@@ -1,51 +1,139 @@
 import { ILocation } from "./location.interface";
+/**
+ * Interface representing a Revel Digital player device with comprehensive details.
+ *
+ * This interface defines the complete information available about a device
+ * running the Revel Digital player software. It includes identification,
+ * configuration, hardware details, and location information as configured
+ * in the Revel Digital CMS.
+ *
+ * Device information is used for:
+ * - Content customization based on device capabilities
+ * - Location-based content delivery
+ * - Analytics and reporting segmentation
+ * - Remote device management and targeting
+ * - Timezone and localization operations
+ *
+ * ```typescript
+ * // Get and use device information
+ * const device = await this.client.getDevice();
+ *
+ * if (device) {
+ *   // Customize content based on device type
+ *   if (device.deviceType === 'android') {
+ *     this.enableTouchInteractions();
+ *   }
+ *
+ *   // Use location for content filtering
+ *   if (device.location?.country === 'US') {
+ *     this.loadUSContent();
+ *   }
+ *
+ *   // Check device tags for special configurations
+ *   if (device.tags.includes('kiosk')) {
+ *     this.enableKioskMode();
+ *   }
+ * }
+ * ```
+ *
+ * @export
+ * @interface IDevice
+ * @since 1.0.0
+ */
 export interface IDevice {
     /**
-     * Device name
+     * The human-readable name assigned to this device.
      *
-     * @type {string}
+     * This is the display name configured in the Revel Digital CMS
+     * for easy identification and management of the device.
+     *
+     * "Lobby Display", "Conference Room Screen", "Kiosk #1"
      */
     name: string;
     /**
-     * Device key
+     * The unique registration key identifying this device.
+     *
+     * This is the primary unique identifier for the device within
+     * the Revel Digital system. It's used for device authentication,
+     * remote command targeting, and system operations.
      *
-     * @type {string}
+     * "ABCD-1234-EFGH-5678"
      */
     registrationKey: string;
     /**
-     * Device type
+     * The type/platform of the device hardware.
+     *
+     * Indicates the operating system or platform type of the device,
+     * which can be used to enable platform-specific features or content.
      *
-     * @type {string}
+     * "windows", "android", "linux", "chromeos"
      */
     deviceType: string;
     /**
-     * Entered service date
+     * The date when this device was first registered and entered service.
      *
-     * @type {Date}
+     * This timestamp indicates when the device was initially set up
+     * and began operating within the Revel Digital system.
      */
     enteredService: Date;
     /**
-     * Language code
+     * The language/locale code configured for this device.
      *
-     * @type {string}
+     * Used for internationalization and localization of content.
+     * May be undefined if not specifically configured.
+     *
+     * "en-US", "fr-FR", "de-DE", "ja-JP"
      */
     langCode?: string;
     /**
-     * Time zone
+     * The timezone identifier assigned to this device.
+     *
+     * Defines the local timezone for time-sensitive operations
+     * and content scheduling. May be undefined if not configured.
      *
-     * @type {string}
+     * "America/New_York", "Europe/London", "Asia/Tokyo"
      */
     timeZone?: string;
     /**
-     * Device properties
+     * Array of descriptive tags associated with this device.
      *
-     * @type {Array<string>}
+     * Tags provide a flexible way to categorize and group devices
+     * for management, content targeting, and operational purposes.
+     * Tags are typically derived from the device description field
+     * in the CMS (split by newlines).
+     *
+     * ```typescript
+     * // Common tag examples
+     * tags: ["kiosk", "lobby", "interactive"]
+     * tags: ["conference-room", "building-a", "floor-2"]
+     * tags: ["retail", "storefront", "promotional"]
+     *
+     * // Check for specific capabilities
+     * if (device.tags.includes('touch-enabled')) {
+     *   this.enableTouchFeatures();
+     * }
+     * ```
      */
     tags: Array<string>;
     /**
-     * Device location
+     * Geographic location information for this device.
+     *
+     * Contains detailed location data including coordinates, address,
+     * and administrative divisions. This information can be used for
+     * location-based content delivery, analytics, and regional customization.
+     * May be undefined if location information is not configured.
+     *
+     * @see ILocation interface for detailed location properties
+     *
+     * ```typescript
+     * if (device.location) {
+     *   const { city, state, country } = device.location;
+     *   console.log(`Device located in ${city}, ${state}, ${country}`);
      *
-     * @type {ILocation}
+     *   // Use for weather, news, or regional content
+     *   this.loadLocalContent(device.location);
+     * }
+     * ```
      */
     location?: ILocation;
 }

package/lib/interfaces/device.interface.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"device.interface.d.ts","sourceRoot":"","sources":["../../../../../projects/reveldigital/player-client/src/lib/interfaces/device.interface.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAEjD,MAAM,WAAW,OAAO;IAEpB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,cAAc,EAAE,IAAI,CAAC;IAErB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAC;CACxB"}
+{"version":3,"file":"device.interface.d.ts","sourceRoot":"","sources":["../../../../../projects/reveldigital/player-client/src/lib/interfaces/device.interface.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAEjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,MAAM,WAAW,OAAO;IAEpB;;;;;;;OAOG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;;OAQG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;;;;OAOG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,cAAc,EAAE,IAAI,CAAC;IAErB;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAC;CACxB"}

package/lib/interfaces/event-properties.interface.d.ts

@@ -1,10 +1,134 @@
+/**
+ * Interface representing flexible properties for analytics events.
+ *
+ * This interface defines a flexible structure for attaching custom properties
+ * and metadata to analytics events. It allows gadgets to provide rich contextual
+ * information alongside event tracking for detailed analytics and reporting.
+ *
+ * Event properties are used to:
+ * - Provide context and metadata for analytics events
+ * - Enable detailed filtering and segmentation in reports
+ * - Track custom business metrics and KPIs
+ * - Debug and troubleshoot gadget behavior
+ * - Correlate events across user sessions and devices
+ *
+ * ```typescript
+ * // Simple properties
+ * const simpleProps: IEventProperties = {
+ *   action: 'button_click',
+ *   buttonId: 'submit'
+ * };
+ *
+ * // Rich event data
+ * const detailedProps: IEventProperties = {
+ *   // User interaction details
+ *   action: 'content_interaction',
+ *   interactionType: 'swipe',
+ *   direction: 'left',
+ *
+ *   // Performance metrics
+ *   loadTime: 1250,
+ *   renderTime: 85,
+ *
+ *   // Business context
+ *   contentId: 'promo-2023-12',
+ *   contentType: 'advertisement',
+ *   campaign: 'holiday-sales',
+ *
+ *   // Technical details
+ *   deviceInfo: {
+ *     screenWidth: 1920,
+ *     screenHeight: 1080,
+ *     userAgent: 'RevelDigital/1.0'
+ *   },
+ *
+ *   // Timestamps and session data
+ *   timestamp: new Date().toISOString(),
+ *   sessionId: 'sess-abc123',
+ *   userId: 'user-456',
+ *
+ *   // Custom business metrics
+ *   conversionValue: 29.99,
+ *   category: 'electronics',
+ *   tags: ['featured', 'sale', 'popular']
+ * };
+ *
+ * // Track events with properties
+ * this.client.track('user_interaction', simpleProps);
+ * this.client.track('content_viewed', detailedProps);
+ * ```
+ *
+ * @export
+ * @interface IEventProperties
+ * @since 1.0.0
+ */
 export interface IEventProperties {
     /**
-     * Event properties
+     * Flexible key-value pairs for event metadata and context.
      *
-     * @type {any}
+     * This index signature allows any string key to be associated with
+     * any value type, providing maximum flexibility for event properties.
      *
-     * @memberof IEventProperties
+     * ## Common Property Categories:
+     *
+     * **User Interaction Properties:**
+     * - `action`: Type of action performed (click, swipe, scroll, etc.)
+     * - `element`: UI element identifier
+     * - `coordinates`: Mouse/touch coordinates
+     * - `duration`: Time spent on action
+     *
+     * **Content Properties:**
+     * - `contentId`: Unique content identifier
+     * - `contentType`: Type of content (video, image, text, etc.)
+     * - `contentTitle`: Human-readable content title
+     * - `contentUrl`: Source URL if applicable
+     *
+     * **Performance Properties:**
+     * - `loadTime`: Time to load content (milliseconds)
+     * - `renderTime`: Time to render content (milliseconds)
+     * - `errorCount`: Number of errors encountered
+     * - `retryCount`: Number of retry attempts
+     *
+     * **Session Properties:**
+     * - `sessionId`: Current user session identifier
+     * - `userId`: User identifier if available
+     * - `deviceId`: Device identifier
+     * - `timestamp`: Event timestamp
+     *
+     * **Business Properties:**
+     * - `campaign`: Marketing campaign identifier
+     * - `category`: Business category or classification
+     * - `value`: Monetary or business value
+     * - `conversion`: Conversion tracking information
+     *
+     * ```typescript
+     * // User interaction tracking
+     * {
+     *   action: 'video_play',
+     *   videoId: 'vid-123',
+     *   videoTitle: 'Product Demo',
+     *   playPosition: 0,
+     *   quality: 'HD'
+     * }
+     *
+     * // Performance monitoring
+     * {
+     *   operation: 'api_call',
+     *   endpoint: '/api/content',
+     *   responseTime: 245,
+     *   statusCode: 200,
+     *   cacheHit: true
+     * }
+     *
+     * // Business metrics
+     * {
+     *   event: 'conversion',
+     *   conversionType: 'signup',
+     *   value: 0,
+     *   source: 'qr_code',
+     *   campaign: 'spring2023'
+     * }
+     * ```
      */
     [key: string]: any;
 }

package/lib/interfaces/event-properties.interface.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"event-properties.interface.d.ts","sourceRoot":"","sources":["../../../../../projects/reveldigital/player-client/src/lib/interfaces/event-properties.interface.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,gBAAgB;IAE7B;;;;;;OAMG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB"}
+{"version":3,"file":"event-properties.interface.d.ts","sourceRoot":"","sources":["../../../../../projects/reveldigital/player-client/src/lib/interfaces/event-properties.interface.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+DG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkEG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB"}

package/lib/interfaces/location.interface.d.ts

@@ -1,58 +1,187 @@
+/**
+ * Interface representing comprehensive geographical and address information for a device location.
+ *
+ * This interface defines the complete location data structure used throughout
+ * the Revel Digital system for device positioning, content localization,
+ * and geographic analytics. Location information enables:
+ *
+ * - **Geographic Content Targeting**: Deliver region-specific content
+ * - **Localization**: Adjust language, currency, and cultural content
+ * - **Analytics Segmentation**: Group and analyze by geographic regions
+ * - **Weather Integration**: Display local weather conditions
+ * - **Distance Calculations**: Proximity-based features and routing
+ * - **Compliance**: Regional regulatory and legal requirements
+ *
+ * ```typescript
+ * // Access device location information
+ * const device = await this.client.getDevice();
+ *
+ * if (device?.location) {
+ *   const location = device.location;
+ *
+ *   // Display local information
+ *   console.log(`Device located at: ${location.address}`);
+ *   console.log(`${location.city}, ${location.state} ${location.postalCode}`);
+ *   console.log(`${location.country}`);
+ *
+ *   // Use coordinates for mapping
+ *   this.showOnMap(location.latitude, location.longitude);
+ *
+ *   // Load region-specific content
+ *   if (location.country === 'US') {
+ *     this.loadUSContent();
+ *   } else if (location.country === 'CA') {
+ *     this.loadCanadianContent();
+ *   }
+ *
+ *   // City-specific customization
+ *   switch (location.city) {
+ *     case 'New York':
+ *       this.enableSubwayAlerts();
+ *       break;
+ *     case 'London':
+ *       this.showTubeStatus();
+ *       break;
+ *   }
+ * }
+ * ```
+ *
+ * @export
+ * @interface ILocation
+ * @since 1.0.0
+ */
 export interface ILocation {
     /**
-     * Latitude
+     * Geographic latitude coordinate in decimal degrees.
      *
-     * @type {number}
+     * Represents the north-south position on Earth's surface.
+     * Positive values indicate northern hemisphere, negative values
+     * indicate southern hemisphere.
      *
-     * @memberof ILocation
+     * ```typescript
+     * // Examples of latitude values:
+     * // 40.7128 (New York City)
+     * // 51.5074 (London)
+     * // -33.8688 (Sydney)
+     * // 35.6762 (Tokyo)
+     *
+     * const lat = location.latitude;
+     * const hemisphere = lat >= 0 ? 'Northern' : 'Southern';
+     * console.log(`Location is in the ${hemisphere} hemisphere`);
+     * ```
      */
     latitude: number;
     /**
-     * Longitude
+     * Geographic longitude coordinate in decimal degrees.
+     *
+     * Represents the east-west position on Earth's surface.
+     * Positive values indicate eastern hemisphere, negative values
+     * indicate western hemisphere.
      *
-     * @type {number}
+     * ```typescript
+     * // Examples of longitude values:
+     * // -74.0060 (New York City)
+     * // -0.1278 (London)
+     * // 151.2093 (Sydney)
+     * // 139.6503 (Tokyo)
      *
-     * @memberof ILocation
+     * const lng = location.longitude;
+     * const hemisphere = lng >= 0 ? 'Eastern' : 'Western';
+     * console.log(`Location is in the ${hemisphere} hemisphere`);
+     *
+     * // Calculate distance between two points
+     * const distance = this.calculateDistance(
+     *   location.latitude, location.longitude,
+     *   otherLat, otherLng
+     * );
+     * ```
      */
     longitude: number;
     /**
-     * City
+     * City name where the device is located.
      *
-     * @type {string}
+     * The municipal or city-level administrative division.
+     * Used for city-specific content, local services, and
+     * urban area customizations.
      *
-     * @memberof ILocation
+     * "New York", "London", "Tokyo", "Sydney"
      */
     city: string;
     /**
-     * State
+     * State, province, or regional administrative division.
      *
-     * @type {string}
+     * The sub-national administrative unit such as state (US),
+     * province (Canada), or region (EU). Format varies by country.
      *
-     * @memberof ILocation
+     * "California", "Ontario", "Bavaria", "New South Wales"
      */
     state: string;
     /**
-     * Address
+     * Full street address of the device location.
+     *
+     * Complete physical address including street number, street name,
+     * and any additional address components. Used for precise location
+     * identification and delivery purposes.
      *
-     * @type {string}
+     * ```typescript
+     * // Typical address formats:
+     * // "123 Main Street, Suite 456"
+     * // "1600 Pennsylvania Avenue NW"
+     * // "10 Downing Street"
+     * // "1-1-1 Chiyoda"
      *
-     * @memberof ILocation
+     * if (location.address) {
+     *   console.log(`Full address: ${location.address}`);
+     *   this.displayAddressOnMap(location.address);
+     * }
+     * ```
      */
     address: string;
     /**
-     * Country
+     * Country name or country code.
      *
-     * @type {string}
+     * The nation-state where the device is located. May be provided
+     * as full country name or standardized country code (ISO 3166).
+     * Used for country-specific content, legal compliance, and
+     * international customizations.
      *
-     * @memberof ILocation
+     * ```typescript
+     * // Country name formats:
+     * // "United States", "Canada", "United Kingdom", "Japan"
+     * // Or country codes:
+     * // "US", "CA", "GB", "JP"
+     *
+     * // Handle different formats
+     * const countryCode = location.country.length === 2
+     *   ? location.country
+     *   : this.getCountryCode(location.country);
+     *
+     * this.loadCountrySpecificContent(countryCode);
+     * ```
      */
     country: string;
     /**
-     * Postal code
+     * Postal or ZIP code for the location.
+     *
+     * The postal delivery code used by the local postal service.
+     * Format varies by country (ZIP codes in US, postal codes in Canada/UK, etc.).
+     * Used for local delivery, regional targeting, and demographic analysis.
+     *
+     * ```typescript
+     * // Postal code formats by country:
+     * // US: "90210", "10001-1234"
+     * // Canada: "K1A 0A6", "M5V 3L9"
+     * // UK: "SW1A 1AA", "M1 1AA"
+     * // Germany: "10115", "80331"
      *
-     * @type {string}
+     * // Use for regional content targeting
+     * if (location.postalCode.startsWith('90')) {
+     *   this.loadLosAngelesContent();
+     * }
      *
-     * @memberof ILocation
+     * // Validate postal code format
+     * const isValidUS = /^\d{5}(-\d{4})?$/.test(location.postalCode);
+     * ```
      */
     postalCode: string;
 }

package/lib/interfaces/location.interface.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"location.interface.d.ts","sourceRoot":"","sources":["../../../../../projects/reveldigital/player-client/src/lib/interfaces/location.interface.ts"],"names":[],"mappings":"AACA,MAAM,WAAW,SAAS;IACtB;;;;;;OAMG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;;;OAMG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;;OAMG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;OAMG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;;OAMG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;;OAMG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;;OAMG;IACH,UAAU,EAAE,MAAM,CAAC;CACtB"}
+{"version":3,"file":"location.interface.d.ts","sourceRoot":"","sources":["../../../../../projects/reveldigital/player-client/src/lib/interfaces/location.interface.ts"],"names":[],"mappings":"AACA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,MAAM,WAAW,SAAS;IACtB;;;;;;;;;;;;;;;;;;OAkBG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;;;;OAQG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;OAOG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;;;;;;;;;;;;;;;OAmBG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,UAAU,EAAE,MAAM,CAAC;CACtB"}