@clickview/player 0.0.4-rc.1 → 0.0.4-rc.2

package/dist/libs/analytics/src/clients/CollectionApiClient.d.ts

@@ -36,9 +36,6 @@ export declare class CollectionApiClient {
     private getEventData;
     private extractData;
     private getUserData;
-    /**
-     * Until region is added to the user Auth claims, we use countryCode to obtain region.
-     */
     private getRegion;
     private getPlatformMetadata;
     private getEventMetadata;

package/dist/libs/analytics/src/constants/Regions.d.ts

@@ -3,4 +3,5 @@ export declare const Regions: {
     CvApSoutheast1: Region;
     CvApSoutheast2: Region;
     CvEuWest1: Region;
+    CvNaWest1: Region;
 };

package/dist/libs/analytics/src/enums/CountryCode.d.ts

@@ -1,5 +1,6 @@
 export declare enum CountryCode {
     AU = "au",
     NZ = "nz",
-    UK = "uk"
+    UK = "uk",
+    US = "us"
 }

package/dist/libs/analytics/src/enums/RegionName.d.ts

@@ -1,5 +1,6 @@
 export declare enum RegionName {
     CvApSoutheast1 = "cv-ap-southeast-1",
     CvApSoutheast2 = "cv-ap-southeast-2",
-    CvEuWest1 = "cv-eu-west-1"
+    CvEuWest1 = "cv-eu-west-1",
+    CvNaWest1 = "cv-na-west-1"
 }

package/dist/libs/analytics/src/interfaces/Region.d.ts

@@ -1,5 +1,4 @@
 import { RegionName } from 'libs/analytics/enums/RegionName';
 export interface Region {
-    displayName: string;
     systemName: RegionName;
 }

package/dist/libs/analytics/src/interfaces/RegionalUrl.d.ts

@@ -2,4 +2,5 @@ export interface RegionalUrl {
     cvApSoutheast1: string;
     cvApSoutheast2: string;
     cvEuWest1: string;
+    cvNaWest1: string;
 }

package/dist/libs/analytics/src/interfaces/User.d.ts

@@ -6,6 +6,8 @@ export declare enum UserGroup {
 }
 export interface User extends BaseObject {
     countryCode?: string;
+    contentRegion?: string;
+    instanceRegion?: string;
     customerId?: string;
     customerGuid?: string;
     customerName?: string;

package/dist/libs/shared/src/enums/CountryCode.d.ts

@@ -1,5 +1,6 @@
 export declare enum CountryCode {
     AU = "au",
     NZ = "nz",
-    UK = "uk"
+    UK = "uk",
+    US = "us"
 }

package/dist/libs/shared/src/interfaces/RegionalUrl.d.ts

@@ -2,4 +2,5 @@ export interface RegionalUrl {
     cvApSoutheast1: string;
     cvApSoutheast2: string;
     cvEuWest1: string;
+    cvNaWest1: string;
 }

package/dist/libs/shared/src/interfaces/models/Config.d.ts

@@ -3,7 +3,6 @@ import { CountryCode } from 'libs/shared/enums/CountryCode';
 export interface Config extends BaseObject {
     supportSiteUrl: string;
     imageCdnUrl: string;
-    countryCode: CountryCode;
     webPlayerUrl: string;
     gatewayApiUrl: string;
     notificationServiceUrl?: string;
@@ -13,4 +12,13 @@ export interface Config extends BaseObject {
     downloadProxy?: string;
     primaryUrl?: string;
     marketingSiteUrl?: string;
+    /**
+     * Instance CountryCode
+     *
+     * This is NOT the same as the customer/user CountryCode.
+     * This should only be used for legacy reasons where InstanceRegion is not supported.
+     */
+    countryCode: CountryCode;
+    instanceRegion: string;
+    contentRegion: string;
 }

package/dist/libs/shared/src/interfaces/models/Customer.d.ts

@@ -1,7 +1,9 @@
 import { BaseObject, Country } from 'libs/shared/interfaces';
 import { Organisation } from './Organisation';
 export interface Customer extends BaseObject {
-    organisation?: Organisation;
     crmId: string;
+    instanceRegion: string;
+    contentRegion: string;
+    organisation?: Organisation;
     country?: Country;
 }

package/dist/libs/shared/src/interfaces/models/User.d.ts

@@ -51,8 +51,40 @@ export interface CurrentUser extends BaseObject {
     emailVerified: boolean;
     customerId: string;
     customerName: string;
-    countryCode: string;
     customerLogo: string;
+    /**
+     * Regional instance the user (and their cusomter) belong to.
+     *
+     * @remarks
+     * This effectively dictates which region the user and their customer reside in and should be used
+     * in any scenario where data needs to be collected, controlled or mapped within that same region.
+     *
+     * Examples:
+     * 1. Any logic that relies on OnlineDB
+     * 2. Analytics data should all be logged in the same region, irrespective of where they're logged in.
+     * 3. Uploaded files and videos should all be targeted to the same region.
+     *
+     * This is not the same as CountryCode or ContentRegion.
+     */
+    instanceRegion: string;
+    /**
+     * The content set the user should have access to.
+     *
+     * @remarks
+     * Content is not tied to a country or instance region.
+     */
+    contentRegion: string;
+    /**
+     * User's Country in Master
+     *
+     * @remarks
+     * In most circumstances you'll want to use the user's InstanceRegion or ContentRegion over this.
+     * This is also different to the instance CountryCode used in the Config.
+     *
+     * Example:
+     * Scottish User/Customer will have their CountryCode set to GBR, not the UK.
+     */
+    countryCode: string;
 }
 /**
  * Current User for Online