@clickview/player 0.0.0-rc.13 → 0.0.0-rc.14

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"
+}

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

@@ -0,0 +1,319 @@
+export declare type AnalyticsEventType = UserAction;
+export interface AnalyticsOptions {
+    actionType?: UserAction;
+    productArea?: string;
+    entity?: EntityType;
+    location?: LocationContext;
+    descriptor?: ActionDescriptor;
+    workflowPhase?: WorkflowPhase;
+    eventVersion?: EventVersion;
+}
+export interface ActionContext {
+    productArea: string;
+    entity: EntityType;
+    location: LocationContext;
+    descriptor: ActionDescriptor;
+    workflowPhase: WorkflowPhase;
+}
+/**
+ * All events recorded are captured within the following action names
+ */
+export declare enum UserAction {
+    /**
+     * The following events are listed in CollectionApi
+     */
+    Stream = "cv_product_stream",
+    StreamRaw = "cv_product_stream_raw",
+    WebPlayerStream = "cv_product_webplayer_stream",
+    StreamProgress = "cv_product_stream_progress",
+    Login = "cv_product_login",
+    LoginSsoRedirect = "cv_product_login_sso_redirect",
+    LoginFailed = "cv_product_login_failed",
+    Search = "cv_product_search",
+    InstantSearch = "cv_product_search",
+    SearchEmptyResult = "cv_product_search_empty_result",
+    Filter = "cv_product_search_filter",
+    SearchLanding = "cv_product_search_landing",
+    Share = "cv_product_share",
+    WorkspaceAdd = "cv_product_tv_add",
+    /**
+     * The following events are unlisted in CollectionApi
+     */
+    Rename = "cv_product_rename",
+    Move = "cv_product_move",
+    Sort = "cv_product_sort",
+    Create = "cv_product_create",
+    Delete = "cv_product_delete",
+    Associate = "cv_product_associate",
+    Dissociate = "cv_product_dissociate",
+    Edit = "cv_product_edit",
+    Approve = "cv_product_approve",
+    Reject = "cv_product_reject",
+    Disable = "cv_product_disable",
+    Upload = "cv_product_upload",
+    Download = "cv_product_download",
+    Navigate = "cv_product_navigate",
+    Click = "cv_product_click",
+    Suggest = "cv_product_suggest",
+    EditAssoc = "cv_product_edit_assoc",
+    Play = "cv_product_play",
+    Favourite = "cv_product_favourite",
+    Follow = "cv_product_follow",
+    Prefer = "cv_product_prefer",
+    Print = "cv_product_print",
+    Copy = "cv_product_copy",
+    Activate = "cv_product_activate",
+    SetAccess = "cv_product_set_access",
+    AddToLocalCache = "cv_product_add_to_lc",
+    /**
+     * Capture migration specific events in dedicated collection.
+     * The assumption here is that at some point in the distant future
+     * we will not longer care about these collections and it doesn't need to
+     * be part of the more general collections set.
+     */
+    ResolveWarning = "cv_product_resolve_warning",
+    DismissWarning = "cv_product_dismiss_warning"
+}
+export declare enum EntityType {
+    Folder = "folder",
+    Video = "video",
+    Rating = "rating",
+    Series = "series",
+    Library = "library",
+    Resource = "resource",
+    Tag = "tag",
+    Subtitle = "subtitle",
+    Chapter = "chapter",
+    Restriction = "restriction",
+    Interactive = "interactive",
+    PDF = "pdf",
+    CustomerSetting = "customer_setting",
+    UserSetting = "user_setting",
+    StaffRequest = "staff_request",
+    Logo = "logo",
+    Pagination = "pagination",
+    Thumbnail = "thumbnail",
+    Banner = "banner",
+    Link = "link",
+    Playlist = "playlist",
+    Person = "person",
+    Company = "company",
+    Classroom = "classroom",
+    ClassroomGroup = "classroom_group",
+    Classification = "classification",
+    ShareLink = "share_link",
+    Upload = "upload",
+    SearchResults = "search_results",
+    Audience = "audience",
+    User = "user",
+    Clip = "clip",
+    UserChannel = "user_channel",
+    Widget = "widget",
+    Url = "url"
+}
+export declare enum LocationContext {
+    TopNav = "top_nav",
+    LeftNav = "left_nav",
+    Popup = "popup",
+    Banner = "banner",
+    VideoList = "video_list",
+    VideoListItem = "video_list_item",
+    VideoListHeader = "video_header",
+    VideoThumbnail = "video_thumbnail",
+    ExpandableVideoThumbnail = "expandable_video_thumbnail",
+    VideoItemPreview = "video_item_preview",
+    VideoDetails = "video_details",
+    VideoDetailsHeader = "video_details_header",
+    EditVideoDetails = "edit_video_details",
+    EditVideoChapters = "edit_video_chapters",
+    EditVideoResources = "edit_video_resources",
+    VideoUpload = "video_upload",
+    VideoRequest = "video_request",
+    Pagination = "pagination",
+    SearchBar = "search_bar",
+    InstantSearch = "instant_search",
+    SearchFilters = "search_filters",
+    LibraryHeader = "library_header",
+    LibraryTiles = "library_tiles",
+    StaffRequestDetails = "staff_request_details",
+    SubFolderList = "sub_folder_list",
+    AwaitingReviewVideoListHeader = "awaiting_review_video_list_header",
+    AwaitingReviewVideoItem = "awaiting_review_video_item",
+    PastReleasesHeader = "past_releases_header",
+    MigrationWarnings = "migration_warnings",
+    PlaylistListHeader = "playlist_list_header",
+    PlaylistListItem = "playlist_list_item",
+    StaffManager = "staff_manager",
+    StaffManagerListItem = "staff_manager_list_item",
+    StudentManager = "student_manager",
+    StudentManagerListItem = "student_manager_list_item",
+    ClassroomsList = "classrooms_list",
+    ClassroomsListItem = "classrooms_list_item",
+    ClassroomOverview = "classroom_overview",
+    ClassroomOverviewStudentListItem = "classroom_overview_student_list_item",
+    ManageClassroomStudents = "manage_classroom_students",
+    ManageClassroomStudentListItem = "manage_classroom_student_list_item",
+    ManageClassroomGroups = "manage_classroom_groups",
+    ManageClassroomGroupListItem = "manage_classroom_group_list_item",
+    PlayPage = "play_page",
+    Player = "player",
+    FloatingPlayer = "floating_player",
+    InteractivePlayer = "interactive_player",
+    EmbeddedPlayer = "embedded_player",
+    ContentUpdatesClassificationBanner = "content_updates_classification_banner",
+    PreferencesSettings = "preferences_settings",
+    MyUploads = "my_uploads",
+    SlidingList = "sliding_list",
+    HeroBannerItem = "hero_banner_item",
+    SlidingListItem = "sliding_list_item",
+    ClassificationListItem = "classification_list_item",
+    ClassificationComingSoon = "classification_coming_soon",
+    ClassificationHero = "classification_hero",
+    Dashboard = "dashboard"
+}
+export declare enum WorkflowPhase {
+    Start = "start",
+    Complete = "complete",
+    Save = "save",
+    Discard = "discard"
+}
+/**
+ * Action descriptor sub-types
+ */
+export declare enum PageDescriptor {
+    PageLoad = "page_load"
+}
+export declare enum OperationDescriptor {
+    Single = "single",
+    Bulk = "bulk",
+    All = "all"
+}
+export declare enum SortDescriptor {
+    ProductionYear = "production_year",
+    Alphabetical = "alphabetical"
+}
+export declare enum FilterDescriptor {
+    Content = "content",
+    Quality = "quality",
+    Duration = "duration",
+    Reset = "reset"
+}
+export declare enum DirectSearchDescriptor {
+    Submit = "submit",
+    ShowAll = "show_all",
+    Recent = "recent",
+    SearchIcon = "search_icon"
+}
+export declare enum PlaybackDescriptor {
+    Start = "start",
+    Finish = "finish",
+    Terminate = "terminate",
+    Play = "play",
+    Pause = "pause",
+    Playback = "playback",
+    NextChapter = "next_chapter",
+    PreviousChapter = "previous_chapter",
+    FullScreenEnter = "full_screen_enter",
+    FullScreenExit = "full_screen_exit"
+}
+export declare enum ClickDescriptor {
+    TogglePreview = "toggle_preview",
+    NavigateHome = "navigate_home",
+    OpenInStaffView = "open_in_staff_view",
+    Title = "title",
+    ToggleHideValidListings = "toggle_hide_valid_listings",
+    LaunchImmersiveReader = "launch_immersive_reader",
+    CopyEmbedHtml = "copy_embed_html",
+    Close = "close",
+    Open = "open",
+    Button = "button",
+    Link = "link",
+    Tile = "tile",
+    Thumbnail = "thumbnail",
+    Cover = "cover",
+    TallPoster = "tall_poster",
+    Slide = "slide"
+}
+export declare enum VideoActionDescriptor {
+    FeatureUserChannelVideo = "feature_user_channel_video",
+    RemoveFromUserChannelPlaylist = "remove_from_user_channel_playlist",
+    ShareClip = "share_clip",
+    ViewOriginalVideo = "view_original_video",
+    ShareInteractive = "share_interactive",
+    DeleteInteractiveVideo = "delete_interactive_video",
+    CopyInteractiveVideo = "copy_interactive_video",
+    EditInteractiveVideo = "edit_interactive_video",
+    PrintAsWorksheet = "print_as_worksheet",
+    PreviewInteractiveVideo = "preview_interactive_video",
+    ViewResults = "view_results",
+    MoveToAnotherFolder = "move_to_another_folder",
+    CreateInteractiveVideo = "create_interactive_video",
+    ShareVideo = "share_video",
+    EditVideo = "edit_video",
+    DownloadVideo = "download_video",
+    AddToExchange = "add_to_exchange",
+    AddToUserChannel = "add_to_user_channel",
+    CreateClip = "create_clip",
+    FlagVideo = "flag_video",
+    AddToLibrary = "add_to_library",
+    AddToWorkspace = "add_to_workspace",
+    AddToPlaylist = "add_to_playlist",
+    RemoveFromPlaylist = "remove_from_playlist",
+    AddCurriculumLink = "add_curriculum_link",
+    ViewCurriculumLinks = "view_curriculum_links",
+    OpenInCurator = "open_in_curator",
+    ManageVideoAccess = "manage_video_access",
+    Approve = "approve",
+    AddToLocalCache = "add_to_local_cache",
+    OpenInLibraryEditor = "open_in_library_editor",
+    PlayClip = "play_clip",
+    EditClip = "edit_clip",
+    DeleteClip = "delete_clip"
+}
+export declare enum CustomerSettingDescriptor {
+    LibraryReview = "library_review"
+}
+export declare enum InteractionTypeDescriptor {
+    FileSelect = "file_select",
+    DragDrop = "drag_drop"
+}
+export declare enum SuggestionDescriptor {
+    Edit = "edit"
+}
+export declare enum AssocDescriptor {
+    Image = "image",
+    User = "user",
+    Playlist = "playlist",
+    Link = "link"
+}
+export declare enum ToggleDescriptor {
+    On = "on",
+    Off = "off"
+}
+/**
+ * Action descriptors give further context to UserActions
+ */
+export declare type ActionDescriptor = OperationDescriptor | SortDescriptor | FilterDescriptor | DirectSearchDescriptor | PageDescriptor | PlaybackDescriptor | CustomerSettingDescriptor | SuggestionDescriptor | InteractionTypeDescriptor | AssocDescriptor | ClickDescriptor | ToggleDescriptor | VideoActionDescriptor;
+/**
+ * Placeholder values to be used in circumstances where we need
+ * to simply signify that a change has occurred. Particularly if it is
+ * being collected as a set of other changes.
+ */
+export declare enum EventDefaultValue {
+    EntityRemoved = "cv_entity_removed",
+    ValueUpdated = "cv_value_updated"
+}
+export declare enum InteractionType {
+    FileSelect = "file_select",
+    DragDrop = "drag_drop"
+}
+export declare enum SearchQueryType {
+    Video = "videos",
+    Folder = "categories",
+    Series = "series",
+    Tags = "tags",
+    Subjects = "subjects"
+}
+export declare enum EventVersion {
+    V1 = 1
+}

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

@@ -0,0 +1,3 @@
+import { BaseObject } from 'libs/analytics/interfaces';
+export interface Config extends BaseObject {
+}

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

@@ -0,0 +1,3 @@
+import { BaseObject } from 'libs/analytics/interfaces';
+export interface Folder extends BaseObject {
+}

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

@@ -0,0 +1,3 @@
+export interface HashObject<T = any> {
+    [key: string]: T;
+}

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

@@ -0,0 +1,3 @@
+import { BaseObject } from 'libs/analytics/interfaces';
+export interface Owner extends BaseObject {
+}

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

@@ -0,0 +1,3 @@
+import { BaseObject } from 'libs/analytics/interfaces';
+export interface Playlist extends BaseObject {
+}

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

@@ -0,0 +1,4 @@
+import { BaseObject } from 'libs/analytics/interfaces';
+export interface Rating extends BaseObject {
+    code?: string;
+}

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

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

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

@@ -0,0 +1,5 @@
+export interface RegionalUrl {
+    cvApSoutheast1: string;
+    cvApSoutheast2: string;
+    cvEuWest1: string;
+}

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

@@ -0,0 +1,5 @@
+import { BaseObject } from 'libs/analytics/interfaces';
+export interface Resource extends BaseObject {
+    metadata?: any;
+    subtitle?: any;
+}

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

@@ -0,0 +1,3 @@
+import { BaseObject } from 'libs/analytics/interfaces';
+export interface Series extends BaseObject {
+}

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

@@ -0,0 +1,4 @@
+import { BaseObject } from 'libs/analytics/interfaces';
+export interface Subtitle extends BaseObject {
+    metadata?: any;
+}

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

@@ -0,0 +1,17 @@
+import { BaseObject } from 'libs/analytics/interfaces';
+export declare enum UserGroup {
+    Staff = "staff",
+    Learner = "learner",
+    Unknown = "unknown"
+}
+export interface User extends BaseObject {
+    countryCode?: string;
+    customerId?: string;
+    customerGuid?: string;
+    customerName?: string;
+    crmId?: number;
+    role?: string;
+    userGroup?: UserGroup;
+    yearGroup?: string;
+    isOpenCustomer?: boolean;
+}

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

@@ -0,0 +1,4 @@
+export interface VersionData {
+    name: string;
+    version: string;
+}

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

@@ -0,0 +1,16 @@
+import { BaseObject } from 'libs/analytics/interfaces';
+import { Series } from './Series';
+import { Folder } from './Folder';
+import { Owner } from './Owner';
+import { Playlist } from './Playlist';
+import { Rating } from './Rating';
+export interface Video extends BaseObject {
+    series?: Series;
+    categories?: Folder[];
+    owner?: Owner;
+    playlist?: Playlist;
+    rating?: Rating;
+    duration?: number;
+    trackingCode?: string;
+    productionYear?: number;
+}

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

@@ -0,0 +1,15 @@
+export * from './AnalyticsTypes';
+export * from './User';
+export * from './Config';
+export * from './Owner';
+export * from './Folder';
+export * from './HashObject';
+export * from './Playlist';
+export * from './Resource';
+export * from './Rating';
+export * from './Region';
+export * from './RegionalUrl';
+export * from './Series';
+export * from './Subtitle';
+export * from './Video';
+export * from './primitives/BaseObject';

package/dist/libs/analytics/src/interfaces/primitives/BaseObject.d.ts

@@ -0,0 +1,7 @@
+export interface BaseObject {
+    id?: string;
+    name?: string;
+    dateCreated?: string;
+    dateModified?: string;
+    dateAssociated?: string;
+}

package/dist/libs/analytics/src/models/AnalyticsEvent.d.ts

@@ -0,0 +1,49 @@
+import { ObjectHash } from 'backbone';
+import { AnalyticsEventType, ActionContext } from 'libs/analytics/interfaces';
+import { EventVersion } from 'libs/analytics/interfaces';
+interface Enrichment {
+    [prop: string]: string;
+}
+export interface DataObjectPayload extends ObjectHash {
+}
+export interface DataCollectionPayload extends Array<ObjectHash> {
+}
+export declare type AnalyticsDataPayload = DataObjectPayload | DataCollectionPayload;
+/**
+ * Base AnalyticsEvent Object.
+ * Acts as a wrapper for our events, encapsulating the event type
+ * and a data payload.
+ */
+export declare class AnalyticsEvent<TType extends AnalyticsEventType, TPayload extends AnalyticsDataPayload> {
+    type: TType;
+    data: TPayload;
+    actionContext: ActionContext;
+    eventVersion: EventVersion;
+    constructor(type: TType, data: TPayload, actionContext?: ActionContext, eventVersion?: EventVersion);
+    /**
+     * Utility function that allows us to create type guards.
+     * @param type EventType
+     */
+    isType(type: TType): this is TType;
+    /**
+     * Mix different enrichments into the base AnalyticsEvent object
+     * to keep it as flat as possible.
+     *
+     * @param key Top level enrichment name
+     * @param value Either a string or set of KV Pairs
+     */
+    enrich(key: string, value: string | Enrichment): void;
+    get(key: string): string | Enrichment;
+    /**
+     * Check that the incoming enrichment doesn't clash with
+     * a pre-existing enrichement.
+     *
+     * @param key
+     */
+    private validateKey;
+}
+/**
+ * Alias our analytics type to make our function signatures and typings a little cleaner
+ */
+export declare type CoreAnalyticsType = AnalyticsEvent<AnalyticsEventType, AnalyticsDataPayload>;
+export {};