@clickview/player 0.0.0-rc.1 → 0.0.0-rc.12

package/.storybook/stories/utils/mock-playerapi.ts

@@ -0,0 +1,238 @@
+import { PlaybackObject, Files, Chapters, Subtitles, LocalCacheAddress } from '../../../src/interfaces/models/PlaybackObject';
+
+import interactive from '../assets/interactive.json';
+
+const basicFiles = <Files> {
+  progressive: [{
+    url: 'https://static.clickview.com.au/testvideos/vpsbenchmark.mp4',
+    mimeType: 'video/mp4',
+    profile: '720'
+  }]
+};
+
+const multipleFiles = <Files> {
+  progressive: [{
+    mimeType: 'video/mp4',
+    profile: '240',
+    url: 'https://static.clickview.com.au/testvideos/vpsbenchmark.mp4?quality=240'
+  },{
+    mimeType: 'video/mp4',
+    profile: '720',
+    url: 'https://static.clickview.com.au/testvideos/vpsbenchmark.mp4?quality=720'
+  }]
+}
+
+const emptyChapters = <Chapters> {
+  list: []
+};
+
+const mockChapters = <Chapters> {
+  list: [{
+    name: 'Waves',
+    timestamp: 0,
+    endTimestamp: 5
+  },
+  {
+    name: 'Some More Waves',
+    timestamp: 5,
+    endTimestamp: 11
+  },
+  {
+    name: 'Waves hitting Rocks',
+    timestamp: 11,
+    endTimestamp: 13
+  },
+  {
+    name: 'Rocky Rocks',
+    timestamp: 13,
+    endTimestamp: 20
+  },
+  {
+    name: 'End of waves',
+    timestamp: 20,
+    endTimestamp: 28
+  },
+  {
+    name: 'Credits',
+    timestamp: 28,
+    endTimestamp: 600
+  }]
+};
+
+const emptySubtitles = <Subtitles> {
+  list: []
+};
+
+const multipleSubtitles = <Subtitles> {
+  list: [{
+    label: 'English',
+    language: 'en',
+    url: './en.vtt',
+    mimeType: 'text/vtt'
+  }, {
+    label: 'Spanish',
+    language: 'es',
+    url: './es.vtt',
+    mimeType: 'text/vtt'
+  },{
+    label: 'French',
+    language: 'fr',
+    url: './fr.vtt',
+    mimeType: 'text/vtt'
+  }]
+};
+
+const emptyLocalCacheAddresses = <LocalCacheAddress[]> [];
+
+const sources: { [key: string]: PlaybackObject } = {
+  basic: {
+    files: basicFiles,
+    mediaType: 'MasterVideo',
+    chapters: emptyChapters,
+    subtitles: {
+      list: [{
+        isDefault: false,
+        label: 'English',
+        language: 'en-au',
+        url: './en.vtt',
+        mimeType: 'text/vtt'
+      }]
+    },
+    localCacheAddresses: emptyLocalCacheAddresses
+  },
+  chapters: {
+    files: basicFiles,
+    mediaType: 'MasterVideo',
+    chapters: mockChapters,
+    subtitles: emptySubtitles,
+    localCacheAddresses: emptyLocalCacheAddresses
+  },
+  vertical: {
+    files: {
+      progressive: [{
+        mimeType: 'video/mp4',
+        profile: '720',
+        url: './vertical.mp4'
+      }]
+    },
+    mediaType: 'MasterVideo',
+    chapters: mockChapters,
+    subtitles: emptySubtitles,
+    localCacheAddresses: emptyLocalCacheAddresses
+  },
+  error: {
+    files: {
+      progressive: [{
+        mimeType: 'video/mp4',
+        profile: '240',
+
+        // This is intentionally not a video url
+        url: 'https://clickview.com.au'
+      }]
+    },
+    mediaType: 'MasterVideo',
+    chapters: emptyChapters,
+    subtitles: emptySubtitles,
+    localCacheAddresses: emptyLocalCacheAddresses
+  },
+  multipleQualities: {
+    files: multipleFiles,
+    mediaType: 'MasterVideo',
+    chapters: emptyChapters,
+    subtitles: emptySubtitles,
+    localCacheAddresses: emptyLocalCacheAddresses
+  },
+  poster: {
+    files: basicFiles,
+    mediaType: 'MasterVideo',
+    chapters: emptyChapters,
+    posterUrl: 'https://image.api.stg.cvnet.io/v2/thumbnails/Q229lo',
+    subtitles: emptySubtitles,
+    localCacheAddresses: emptyLocalCacheAddresses
+  },
+  everything: {
+    files: multipleFiles,
+    mediaType: 'MasterVideo',
+    chapters: mockChapters,
+    posterUrl: 'https://image.api.stg.cvnet.io/v2/thumbnails/Q229lo',
+    subtitles: multipleSubtitles,
+    localCacheAddresses: emptyLocalCacheAddresses
+  },
+  multipleSubtitles: {
+    files: basicFiles,
+    mediaType: 'MasterVideo',
+    chapters: emptyChapters,
+    subtitles: multipleSubtitles,
+    localCacheAddresses: emptyLocalCacheAddresses
+  },
+  multipleTracksWithDefault: {
+    files: basicFiles,
+    mediaType: 'MasterVideo',
+    chapters: emptyChapters,
+    subtitles: {
+      list: [{
+        label: 'English',
+        language: 'en',
+        url: './en.vtt',
+        mimeType: 'text/vtt'
+      }, {
+        label: 'Spanish',
+        language: 'es',
+        url: './es.vtt',
+        isDefault: true,
+        mimeType: 'text/vtt'
+      },{
+        label: 'French',
+        language: 'fr',
+        url: './fr.vtt',
+        mimeType: 'text/vtt'
+      }]
+    },
+    localCacheAddresses: emptyLocalCacheAddresses
+  },
+  interactive: {
+    files: basicFiles,
+    mediaType: 'MasterInteractive',
+    chapters: emptyChapters,
+    additionalData: interactive,
+    subtitles: emptySubtitles,
+    localCacheAddresses: emptyLocalCacheAddresses
+  },
+  clip: {
+    files: basicFiles,
+    mediaType: 'MasterClip',
+    chapters: emptyChapters,
+    additionalData: {
+      startTime: 60,
+      endTime: 240
+    },
+    subtitles: emptySubtitles,
+    localCacheAddresses: emptyLocalCacheAddresses
+  },
+  localcache: {
+    files: multipleFiles,
+    mediaType: 'MasterVideo',
+    chapters: emptyChapters,
+    subtitles: emptySubtitles,
+    localCacheAddresses: [{
+      httpsAddress: 'https://local.clickviewlocalcache.com:9055',
+      name: 'test',
+      playbackProfile: '1080'
+    }]
+  }
+};
+
+export function mockplayerApi(viewKey: string): Promise<PlaybackObject> {
+  const playbackObject = sources[viewKey];
+
+  if (!playbackObject)
+    throw Error('Unknown viewKey: ' + viewKey);
+
+  return new Promise<PlaybackObject>(resolve => {
+
+    // 200ms Timeout is just simulating an async api call to fetch tech info
+    window.setTimeout(() => {
+      resolve(playbackObject);
+    }, 200);
+  });
+}

package/.storybook/stories/utils/mock-setup.ts

@@ -0,0 +1,16 @@
+import { VideoJsPlayer } from 'video.js';
+import { BasePlayerOptions } from '../../../src/players/base-player';
+
+export const mockSetups: any = {
+  thumbnails: function(options: BasePlayerOptions, player: VideoJsPlayer): void {
+    player.addRemoteTextTrack({
+      kind: 'metadata',
+      src: './thumbnails.vtt',
+      label: 'thumbnails'
+    }, true);
+  },
+
+  everything: function(options: BasePlayerOptions, player: VideoJsPlayer): void {
+    mockSetups.thumbnails(options, player);
+  }
+};

package/dist/libs/analytics/src/Analytics.d.ts

@@ -0,0 +1,10 @@
+import { AnalyticsDataPayload } from 'libs/analytics/models/AnalyticsEvent';
+import { ActionContext, EventVersion } from 'libs/analytics/interfaces';
+export declare const Analytics: {
+    /**
+     * Push/emit all events along the analytics firehose
+     * @param eventType
+     * @param data Data to be passed to AnalyticsClient
+     */
+    log<TType extends import("./interfaces").UserAction, TData extends AnalyticsDataPayload>(eventType: TType, data: TData, actionContext?: ActionContext, eventVersion?: EventVersion): void;
+};

package/dist/libs/analytics/src/AnalyticsHelper.d.ts

@@ -0,0 +1,30 @@
+import { ObjectHash } from 'backbone';
+import { Core } from 'libs/common/core';
+import { ActionContext, AnalyticsOptions, ActionDescriptor, InteractionTypeDescriptor, InteractionType } from 'libs/analytics/interfaces';
+export declare const AnalyticsHelper: {
+    logUserAction(data: ObjectHash | ObjectHash[], analyticsOptions: AnalyticsOptions): void;
+    logNavigate(appLink: Core.AppLink, options: ObjectHash): void;
+    mergeOptions(baseOptions: AnalyticsOptions, newOptions: AnalyticsOptions): AnalyticsOptions;
+    buildActionContext(options?: AnalyticsOptions): ActionContext;
+    buildUserActionEvent(options?: AnalyticsOptions): ObjectHash;
+    buildCurrentLocation(): string;
+    /**
+     * Search logging helpers
+     */
+    /**
+     * Create a search event that is depenedent on whether we page loaded into search
+     * or used the search bar directly.
+     */
+    buildSearchEvent(query: string, descriptor: ActionDescriptor): ObjectHash;
+    buildInstantSearchEvent(query: string, suggestion: ObjectHash, source: string): ObjectHash;
+    /**
+     * Resources Helpers
+     */
+    /**
+     * Map our general InteractionType to an appropriate anayltics descriptor type.
+     * The reason we do this is to maintain a seperation between analytics metadata and
+     * actual domain data.
+     * @param type
+     */
+    mapInteractionType(type: InteractionType): InteractionTypeDescriptor;
+};

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

@@ -0,0 +1,48 @@
+import 'whatwg-fetch';
+import { IncomingEvent } from 'libs/analytics/models/CollectionEvent';
+import { HashObject } from 'libs/analytics/interfaces/HashObject';
+import { RegionalUrl } from 'libs/analytics/interfaces/RegionalUrl';
+import { User } from 'libs/analytics/interfaces/User';
+import { RegionName } from 'libs/analytics/enums/RegionName';
+interface CollectionApiClientOptions {
+    productName: string;
+    productVersion: string;
+    regionName: RegionName;
+    collectionApiUrls: RegionalUrl;
+    collectionApiClientId: string;
+    getUser: () => Promise<User>;
+    shouldLog?: (event: IncomingEvent) => boolean;
+    formatData?: (event: IncomingEvent) => HashObject | HashObject[];
+}
+/**
+ * A client for logging to CollectionApi.
+ * It should have no library dependencies and anything that it references
+ * should also have no library dependencies.
+ */
+export declare class CollectionApiClient {
+    private options;
+    constructor(options: CollectionApiClientOptions);
+    initialize(): void;
+    get name(): string;
+    log(event: IncomingEvent | IncomingEvent[]): Promise<void>;
+    private logBulk;
+    private validateOptions;
+    private shouldLog;
+    private postData;
+    private getSignatureHeader;
+    private getRegionalUrl;
+    private validateEvent;
+    private formatData;
+    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;
+    private getRegionByName;
+    private normalizeYearGroup;
+}
+export {};

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

@@ -0,0 +1,7 @@
+import { CountryCode } from 'libs/analytics/enums/CountryCode';
+import { RegionName } from 'libs/analytics/enums/RegionName';
+export declare const CountryRegionMapping: {
+    au: RegionName;
+    nz: RegionName;
+    uk: RegionName;
+};

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

@@ -0,0 +1,4 @@
+export declare enum EventFirehose {
+    Inlet = "event:inlet",
+    Outlet = "event:outlet"
+}

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

@@ -0,0 +1,3 @@
+export declare const GlobalChannels: {
+    ANALYTICS: string;
+};

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

@@ -0,0 +1,6 @@
+import { Region } from 'libs/analytics/interfaces/Region';
+export declare const Regions: {
+    CvApSoutheast1: Region;
+    CvApSoutheast2: Region;
+    CvEuWest1: Region;
+};

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

@@ -0,0 +1,4 @@
+export declare enum Services {
+    Analytics = "AnalyticsService",
+    Context = "ContextService"
+}

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

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

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

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