@clickview/online 0.0.0-rc.0 → 0.0.0-rc.1

package/dist/en.json

@@ -1 +1 @@
-{"contentUpdates":{"contentUpdatesView":{"followed":"Successfully followed <strong>%{classification}</strong>","unfollowed":"Successfully unfollowed <strong>%{classification}</strong>","showMore":"Show more new %{classificationName} videos"}},"playlists":{"emptyState":{"noPlaylistsHeading":"You have no playlists","noPlaylistsInfo":"Click <strong>Create a new playlist</strong> in the left nav to create one.","noVideosHeading":"There are no videos in this playlist","noVideosInfo":"Learn how to add videos to a playlist."},"newPlaylistButton":{"createNew":"Create a new playlist"},"playlistDetails":{"nameLabel":"Playlist Name","namePlaceholder":"Give your playlist a name...","descriptionLabel":"Description","descriptionPlaceholder":"Describe your playlist here","create":"Create","save":"Save"},"playlistHeader":{"playAll":"Play All","share":"Share","edit":"Edit","follow":"Follow","following":"Following"},"videoNotFound":{"heading":"Video Not Found","info":"The video you have requested could not be found or has been removed.","returnTo":"Return to %{name}"},"hooks":{"somethingWentWrong":"Something went wrong"},"app":{"accessDeniedHeading":"You do not have permission to view this playlist.","accessDeniedInfo":"If it was previously shared with you, the owner may have changed the privacy settings.","notFoundHeading":"Playlist Not Found","notFoundInfo":"The playlist you have requested could not be found or has been removed."},"services":{"createPlaylistSuccess":"Successfully created playlist.","createPlaylistError":"Failed to create playlist.","updatePlaylistSuccess":"Successfully updated playlist.","updatePlaylistError":"Failed to save playlist.","deletePlaylistError":"Failed to delete playlist.","updatePlaylistOrderError":"Failed to update playlist order.","addToPlaylistSuccess":"Successfully added video to playlist.","addToPlaylistError":"Failed to add video to playlist."},"utils":{"nameExceeds":"Name is too long","nameRequired":"Name is required","descriptionExceeds":"Description is too long"},"addToPlaylist":{"heading":"Add to Playlist","selectPlaylist":"Select a playlist to add <strong>%{video}</strong> to:"},"selectPlaylist":{"placeholder":"Search your playlists or create a new one...","recentPlaylistsHeading":"Recent playlists saved to:","suggestionsHeading":"My Playlists","createPlaylist":"Create new playlist: <strong>%{name}</strong>"},"deletePlaylist":{"title":"Delete %{name}","keep":"No, keep my playlist","confirm":"Yes, delete this playlist","check":"Are you sure you want to delete this playlist?","warning":"This will permanently delete the playlist <strong>%{name}</strong>, along with any share links.","videoNote":"Videos in this playlist will not be deleted."},"editPlaylist":{"title":"Edit %{name}","heading":"Edit Playlist Details"},"migrationInProgress":{"heading":"Maintenance In Progress","description":"Playlists is currently undergoing some maintenance. Check back soon for some exciting updates!"},"newPlaylist":{"title":"New Playlist"},"playlists":{"title":"Playlists"},"removeVideoFromPlaylist":{"title":"Remove %{name}","keep":"No, keep this video","confirm":"Yes, remove this video","check":"Are you sure you want to remove this video?","warning":"This will remove <strong>%{video}</strong> from the playlist <strong>%{playlist}</strong>."},"liteClassificationUpdateBreadcrumbs":{"dashboard":"Dashboard","whatsNew":"Whats new at ClickView"},"liteWhatsNewBreadcrumbs":{"dashboard":"Dashboard","whatsNew":"Whats new at ClickView"},"playlistSortSelect":{"recentlyUpdated":"Recently updated","atoz":"A to Z","newest":"Newest"},"onlineClassificationBanner":{"follow":"Follow","following":"Following"},"onlineClassificationUpdateBreadcrumbs":{"dashboard":"Dashboard","whatsNew":"Whats new at ClickView"},"onlineWhatsNewBreadcrumbs":{"dashboard":"Dashboard","whatsNew":"Whats new at ClickView","switchBack":"Switch back to the old look"}},"liteContentUpdates":{"classificationBanner":{"unfollow":"Unfollow","follow":"Follow"}},"litePlaylists":{"playlistHeader":{"description":"Description","follow":"Follow","following":"Following","edit":"Edit","share":"Share","delete":"Delete"},"playlistListHeader":{"header":"My Playlists","newPlaylist":"New Playlist"}},"onlinePlaylists":{"leftNav":{"playlists":"Playlists","loading":"Loading more...","seeMore":"See more playlists"},"playlistActions":{"share":"Share","edit":"Edit Playlist Details","delete":"Delete Playlist"},"playlistHeader":{"playlists":"Playlists","video":"%{smart_count} video |||| %{smart_count} videos","backTo":"Back to %{label}","created":"Created %{date}","updated":"Last Updated %{date}"},"playlistList":{"video":"%{smart_count} video |||| %{smart_count} videos","created":"Created %{date}","heading":"%{fname} %{lname}'s Playlists"},"videoList":{"removeHeading":"Remove from playlist","removeInfo":"Remove from this playlist","library":"your Library","workspace":"your Workspace","exchange":"the Exchange","videoFrom":"This video comes from","series":"Series:","added":"Added","ratedTitle":"Rated:","unrated":"UNRATED","unratedTitle":"Rated: UNRATED","productionYearTitle":"Production Year:","interactive":"Interactive","interactiveTitle":"Interactive videos are available for this programme.","showMore":"... Show more","showLess":"Show less","hide":"Hide video","show":"Show video","plus":"+","minus":"-"},"shareView":{"close":"Close","share":"Share","sharePlaylist":"Share Playlist"}},"shared":{"context":{"defaultTitle":"Playlists"},"error":{"return":"Return to home"}}}
+{"playlists":{"onlineClassificationBanner":{"follow":"Follow","following":"Following"},"onlineClassificationUpdateBreadcrumbs":{"dashboard":"Dashboard","whatsNew":"Whats new at ClickView"},"onlineWhatsNewBreadcrumbs":{"dashboard":"Dashboard","whatsNew":"Whats new at ClickView","switchBack":"Switch back to the old look"},"leftNav":{"playlists":"Playlists","loading":"Loading more...","seeMore":"See more playlists"},"newPlaylistButton":{"createNew":"Create a new playlist"},"playlistActions":{"share":"Share","edit":"Edit Playlist Details","delete":"Delete Playlist"},"playlistDetails":{"nameLabel":"Playlist Name","namePlaceholder":"Give your playlist a name...","descriptionLabel":"Description","descriptionPlaceholder":"Describe your playlist here","create":"Create","save":"Save","cancel":"Cancel"},"playlistHeader":{"playAll":"Play All","share":"Share","edit":"Edit","follow":"Follow","following":"Following","playlists":"Playlists","video":"%{smart_count} video |||| %{smart_count} videos","backTo":"Back to %{label}","created":"Created %{date}","updated":"Last Updated %{date}"},"playlistList":{"video":"%{smart_count} video |||| %{smart_count} videos","created":"Created %{date}","heading":"%{fname} %{lname}'s Playlists"},"videoList":{"removeHeading":"Remove from playlist","removeInfo":"Remove from this playlist","library":"your Library","workspace":"your Workspace","exchange":"the Exchange","videoFrom":"This video comes from","series":"Series:","added":"Added","ratedTitle":"Rated:","unrated":"UNRATED","unratedTitle":"Rated: UNRATED","productionYearTitle":"Production Year:","interactive":"Interactive","interactiveTitle":"Interactive videos are available for this programme.","showMore":"... Show more","showLess":"Show less","hide":"Hide video","show":"Show video","plus":"+","minus":"-"},"videoNotFound":{"heading":"Video Not Found","info":"The video you have requested could not be found or has been removed.","returnTo":"Return to %{name}"},"app":{"accessDeniedHeading":"You do not have permission to view this playlist.","accessDeniedInfo":"If it was previously shared with you, the owner may have changed the privacy settings.","notFoundHeading":"Playlist Not Found","notFoundInfo":"The playlist you have requested could not be found or has been removed."},"services":{"createPlaylistSuccess":"Successfully created playlist.","createPlaylistError":"Failed to create playlist.","updatePlaylistSuccess":"Successfully updated playlist.","updatePlaylistError":"Failed to save playlist.","deletePlaylistError":"Failed to delete playlist.","updatePlaylistOrderError":"Failed to update playlist order.","addToPlaylistSuccess":"Successfully added video to playlist.","addToPlaylistError":"Failed to add video to playlist."},"addToPlaylist":{"heading":"Add to Playlist","selectPlaylist":"Select a playlist to add <strong>%{video}</strong> to:"},"selectPlaylist":{"placeholder":"Search your playlists or create a new one...","recentPlaylistsHeading":"Recent playlists saved to:","suggestionsHeading":"My Playlists","createPlaylist":"Create new playlist: <strong>%{name}</strong>"},"deletePlaylist":{"title":"Delete %{name}","keep":"No, keep my playlist","confirm":"Yes, delete this playlist","check":"Are you sure you want to delete this playlist?","warning":"This will permanently delete the playlist <strong>%{name}</strong>, along with any share links.","videoNote":"Videos in this playlist will not be deleted."},"editPlaylist":{"title":"Edit %{name}","heading":"Edit Playlist Details"},"migrationInProgress":{"heading":"Maintenance In Progress","description":"Playlists is currently undergoing some maintenance. Check back soon for some exciting updates!"},"newPlaylist":{"title":"New Playlist"},"playlists":{"title":"Playlists"},"removeVideoFromPlaylist":{"title":"Remove %{name}","keep":"No, keep this video","confirm":"Yes, remove this video","check":"Are you sure you want to remove this video?","warning":"This will remove <strong>%{video}</strong> from the playlist <strong>%{playlist}</strong>."},"emptyState":{"noPlaylistsHeading":"You have no playlists","noPlaylistsInfo":"Click <strong>Create a new playlist</strong> in the left nav to create one.","noVideosHeading":"There are no videos in this playlist","noVideosInfo":"Learn how to add videos to a playlist."},"hooks":{"somethingWentWrong":"Something went wrong"},"validation":{"nameExceeds":"Name is too long","nameRequired":"Name is required","descriptionExceeds":"Description is too long"}},"contentUpdates":{"contentUpdatesView":{"followed":"Successfully followed <strong>%{classification}</strong>","unfollowed":"Successfully unfollowed <strong>%{classification}</strong>","showMore":"Show more new %{classificationName} videos"}},"dashboard":{"heroWidget":{"play":"Play","addToPlaylist":"Add to playlist","previous":"Previous","next":"Next"},"dashboard":{"curriculum":"Search by Curriculum","contentUpdates":"Content Updates from ClickView"}},"":{},"subjects":{"classificationSeriesList":{"dashboard":"Dashboard","subview":"Series","heading":"Series: %{classification}"},"classification":{"dashboard":"Dashboard","playlists":"Playlists","series":"Series","popular":"Popular videos","unfollow":"Unfollow","follow":"Follow","share":"Share","followBtnTooltip":"Follow to get notifications on new content added to this subject"},"levelPreferences":{"heading":"What <span class=\"%{highlightClass}\">year levels</span> do you currently teach?","back":"Back","next":"Next","allLevels":"I teach all year levels"},"subjectPreferencesView":{"heading":"What type of <span class=\"%{highlightClass}\">videos</span> will be helpful to you?","infoRow1":"This will help us tailor ClickView to you.","infoRow2":"You can select as many as you like!","back":"Back","followSubjects":"Follow %{smart_count} Subject |||| Follow %{smart_count} Subjects","allOfParent":"All of %{parent}","allSubjects":"I'm interested in all subjects","next":"Next"},"preferencesSummary":{"heading":"<span class=\"%{highlightClass}\">Summary</span> of your preferences","info":"You can change your preferences in your profile settings at any time","levels":"Year levels","subjects":"Subjects","getStarted":"Get Started","noLevelPreferences":"You haven't set any level preferences yet.","noSubjectPreferences":"You haven't set any subject preferences yet."},"comingSoon":{"comingSoon":"Coming Soon","info":"We are currently building this topic. In the meantime, we can remind you when it's available.","remindMe":"Remind Me"},"heroVideo":{"resourcesHeading":"Resources","linksHeading":"Links","clipsHeading":"Clips","tagsHeading":"Tags","links":"%{smart_count} link |||| %{smart_count} links","resources":"%{smart_count} resource |||| %{smart_count} resources","clips":"%{smart_count} clip |||| %{smart_count} clips"}},"shared":{"context":{"defaultTitle":"Playlists"},"notFound":{"title":"Page not found","heading":"Page not found","description":"This page does not exist"},"error":{"return":"Return to home"},"share":{"close":"Close","share":"Share","sharePlaylist":"Share Playlist"},"playlistItem":{"videos":"%{smart_count} video |||| %{smart_count} videos"},"backButton":{"back":"Back","backTo":"Back to %{backToName}"},"editVideoDetails":{"nameExceeds":"Name is too long","nameRequired":"Name is required","descriptionExceeds":"Description is too long","namePlaceholder":"Enter a name for your video","descriptionPlaceholder":"Enter a description for your video","cancel":"Cancel","nameLabel":"Title","descriptionLabel":"Description"},"favouriteButton":{"favouriteError":"Failed to favourite video.","unfavouriteError":"Failed to unfavourite video."},"formButtons":{"create":"Create","save":"Save","next":"Next"},"pagination":{"next":"Next","previous":"Previous"},"searchBar":{"placeholder":"Enter a search query","recentSearchHeading":"Recent Searches"},"videoItemDescription":{"showMore":"... Show more","showLess":"Show less"},"dynamicWidget":{"topics":"Topics","teach":"What would you like to teach?","preferencesTooltip":"Update your preferences"},"fixedWidget":{"preferencesTooltip":"Update your preferences"},"greeting":{"morning":"Good morning","afternoon":"Good afternoon","evening":"Good evening","fallback":"Hello","prompt":"What would you like to teach today?"},"subjectWidgetItem":{"comingSoon":"Coming Soon","edit":"Edit My Subjects"},"_pagination":{"next":"Next","previous":"Previous"},"shared-utils":{"responsive":"Responsive","small":"Small","medium":"Medium","large":"Large"},"videoActionsHelper":{"addToPlaylist":"Add to playlist","removeFromPlaylist":"Remove from playlist","share":"Share","edit":"Edit"}},"notifications":{"notificationList":{"noNotifications":"You have no notifications"},"services":{"suggestEditSubmit":"Suggestion was successfully submitted"},"utils":{"viewVideoDetails":"View video details","viewVideo":"View video","reviewVideos":"Review videos","viewNewContent":"View new content","reviewVideo":"Review video","seeNow":"See now"},"notifications":{"title":"Notifications","notifications":"Notifications"},"notificationsPopover":{"notifications":"Notifications","seeAll":"See all notifications"}},"search":{"searchTips":{"heading":"Search Tips","firstTerm":"\"atomic bonding\"","firstDescription":"Search for exact phrases using quotation marks","secondTerm":"\"romeo and juliet\" english","secondDescription":"Combine normal and exact phrases together","thirdTerm":"-pollution","thirdDescription":"Exclude a keyword from your search","fourthTerm1":"tag:literature","fourthTerm2":"folder:science","fourthDescription":"Search for results within a tag, folder or series","fifthTerm":"folder:-physics","fifthDescription":"Use a \"-\" to exclude a folder, title or series"},"services":{"folderTag":"This folder","seriesTag":"This series"},"searchBar":{"findingResults":"Finding results...","recentSearches":"Recent Searches","allResults":"Show all results for","noLibraries":"There are currently no libraries to search. Add a new library to get started.","placeholder":"Search within your library... |||| Search within your libraries...","classifications":"topics","videos":"videos","tags":"tags","series":"series"}},"upload":{"fileType":{"heading":"Invalid file type","body":"Sorry but you cannot upload files of that type.","okay":"Okay","close":"Close"},"internetConnectivityError":{"title":"Internet connectivity issue","heading":"Connectivity issue.","body":"There seems to be an issue with your internet connection. Please try uploading your files again.","okay":"Okay"},"utils":{"videoProcessingError":"Something went wrong processing this video.","waiting":"Waiting to be processed","processing":"Processing %{progress}%","complete":"Complete","readyToWatch":"Ready to watch, still processing higher resolutions."}}}

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

@@ -0,0 +1,10 @@
+import { AnalyticsDataPayload } from "./models/AnalyticsEvent";
+import { ActionContext, EventVersion } from "./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 "../../common/src/backbone";
+import { ActionContext, AnalyticsOptions, ActionDescriptor, InteractionTypeDescriptor, InteractionType } from "./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/AnalyticsService.d.ts

@@ -0,0 +1,52 @@
+import { ObjectHash } from 'backbone';
+import { Core } from "../../common/src/backbone";
+import { User, Config } from "./interfaces";
+import { BaseAnalyticsTransport } from "./transport/EventTransport";
+import { BaseAnalyticsClient } from "./clients/BaseAnalyticsClient";
+import { BaseAnalyticsEnricher } from "./enrichers/BaseAnalyticsEnricher";
+import { CollectionApiClient } from "./clients/CollectionApiClient";
+interface ApplicationOptions {
+    user: User;
+    config: Config;
+}
+declare type AnalyticsClient = BaseAnalyticsClient | CollectionApiClient;
+interface ClientConstructor<TClient extends AnalyticsClient> {
+    new (options?: ObjectHash): TClient;
+}
+interface EnricherConstructor<TEnricher extends BaseAnalyticsEnricher> {
+    new (options?: ObjectHash): TEnricher;
+}
+interface TransportContructor<TTransport extends BaseAnalyticsTransport> {
+    new (options?: ObjectHash): TTransport;
+}
+export declare class AnalyticsService extends Core.Service {
+    private transport;
+    private clients;
+    private enrichers;
+    constructor(options: ApplicationOptions);
+    get name(): string;
+    registerTransport<TTransport extends BaseAnalyticsTransport>(transportCtor: TransportContructor<TTransport>, transportOptions?: ObjectHash): this;
+    private bindTransportListeners;
+    /**
+     * Register analytics clients that will listen to events processed and
+     * forwarded by the AnalyticsService.
+     *
+     * @param clients Single client or array of clients
+     */
+    registerClient<TClient extends AnalyticsClient>(clientCtor: ClientConstructor<TClient>, clientOptions?: ObjectHash): this;
+    registerEnricher<TEnricher extends BaseAnalyticsEnricher>(enricherCtor: EnricherConstructor<TEnricher>, enricherOptions?: ObjectHash): this;
+    /**
+     * Add any middleware/enrichers to be applied to ALL events here
+     * before publishing to any analytics clients. enrichers may also
+     * be used within each individual analyticsClient
+     *
+     * @param event AnalyticsEvent object
+     */
+    private onEvent;
+    private validateConstructor;
+    private registerMiddleware;
+    private executeMiddleware;
+    private bindNavigationListener;
+    private logNavigate;
+}
+export {};

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

@@ -0,0 +1,24 @@
+import { Core } from "../../../common/src/backbone";
+import { CoreAnalyticsType } from "../models/AnalyticsEvent";
+export interface AnalyticsClientOptions extends Core.ServiceOptions {
+}
+export declare class BaseAnalyticsClient extends Core.Service {
+    static readonly type: string;
+    constructor(options?: AnalyticsClientOptions);
+    /**
+     * Predicate to determine whether the event should be handled by the client.
+     *
+     * @param event
+     */
+    shouldLog(event?: CoreAnalyticsType): boolean;
+    /**
+     * This function will be bound by the transport layer to the firehose outlet event
+     * stream. All events that satify the shouldLog predicate will flow to this function.
+     * Any client-specific data/manipulation can be added to the event object in
+     * this function.
+     *
+     * @param event
+     */
+    log(event: CoreAnalyticsType): void;
+    isType(type: string): this is BaseAnalyticsClient;
+}

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

@@ -0,0 +1,48 @@
+import 'whatwg-fetch';
+import { IncomingEvent } from "../models/CollectionEvent";
+import { HashObject } from "../interfaces/HashObject";
+import { RegionalUrl } from "../interfaces/RegionalUrl";
+import { User } from "../interfaces/User";
+import { RegionName } from "../enums/RegionName";
+interface CollectionApiClientOptions {
+    productName: string;
+    productVersion: string;
+    regionName: RegionName;
+    collectionApiUrls: RegionalUrl;
+    collectionApiClientId: string;
+    getUser: () => Promise<User>;
+    shouldLog?: (event: IncomingEvent) => boolean;
+    formatData?: (event: IncomingEvent) => {
+        [dataKey: string]: 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): Promise<void>;
+    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;
+}
+export {};

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

@@ -0,0 +1,7 @@
+import { CoreAnalyticsType } from "../models/AnalyticsEvent";
+import { BaseAnalyticsClient } from './BaseAnalyticsClient';
+export declare class DebuggerClient extends BaseAnalyticsClient {
+    get name(): string;
+    shouldLog(): boolean;
+    log(event: CoreAnalyticsType): void;
+}

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

@@ -0,0 +1 @@
+export declare const ApplicationOptionsKey = "application:options";

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

@@ -0,0 +1,7 @@
+import { CountryCode } from "../enums/CountryCode";
+import { RegionName } from "../enums/RegionName";
+export declare const CountryRegionMapping: {
+    [CountryCode.AU]: RegionName;
+    [CountryCode.NZ]: RegionName;
+    [CountryCode.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 "../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/enrichers/BaseAnalyticsEnricher.d.ts

@@ -0,0 +1,19 @@
+import { Core } from "../../../common/src/backbone";
+import { CoreAnalyticsType } from "../models/AnalyticsEvent";
+export interface AnalyticsEnricherOptions {
+}
+export declare class BaseAnalyticsEnricher extends Core.Service {
+    static readonly type: string;
+    /**
+     * Enriches the current event with additional data.
+     * All events that satify the shouldEnrich predicate will flow to this function.
+     *
+     * This function is registered as middleware within the AnalyticsService and pass
+     * the event object being modifed on to subsequent middleware callbacks (other analytics);
+     *
+     * @param event
+     * @param next
+     */
+    enrich<TEvent extends CoreAnalyticsType>(event: TEvent, next: Function): void;
+    isType(type: string): this is BaseAnalyticsEnricher;
+}

package/dist/libs/analytics/src/enrichers/CoreContextEnricher.d.ts

@@ -0,0 +1,22 @@
+import { CoreAnalyticsType } from "../models/AnalyticsEvent";
+import { BaseAnalyticsEnricher, AnalyticsEnricherOptions } from './BaseAnalyticsEnricher';
+export interface CoreContextEnricherOptions extends AnalyticsEnricherOptions {
+    productName: string;
+    productVersion: string;
+}
+export declare class CoreContextEnricher extends BaseAnalyticsEnricher {
+    private productName;
+    private productVersion;
+    constructor(options: CoreContextEnricherOptions);
+    get name(): string;
+    private shouldEnrich;
+    enrich(event: CoreAnalyticsType, next: any): void;
+    private getCoreContext;
+    /**
+     * Get current timestamp in UTC
+     */
+    private getTimestamp;
+    private getProductInfo;
+    private getRequestInfo;
+    private getClientInfo;
+}

package/dist/libs/analytics/src/enrichers/UserDataEnricher.d.ts

@@ -0,0 +1,10 @@
+import { CoreAnalyticsType } from "../models/AnalyticsEvent";
+import { BaseAnalyticsEnricher } from './BaseAnalyticsEnricher';
+export declare class UserDataEnricher extends BaseAnalyticsEnricher {
+    private user;
+    get name(): string;
+    initialize(): void;
+    private shouldEnrich;
+    enrich(event: CoreAnalyticsType, next: Function): void;
+    private getUser;
+}

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,214 @@
+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",
+    WebPlayerStream = "cv_product_webplayer_stream",
+    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",
+    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",
+    StaffRequest = "staff_request",
+    Logo = "logo",
+    Pagination = "pagination",
+    Thumbnail = "thumbnail",
+    Banner = "banner",
+    Link = "link",
+    Playlist = "playlist",
+    Person = "person",
+    Company = "company"
+}
+export declare enum LocationContext {
+    TopNav = "top_nav",
+    LeftNav = "left_nav",
+    Popup = "popup",
+    Banner = "banner",
+    VideoList = "video_list",
+    VideoListItem = "video_list_item",
+    VideoListHeader = "video_header",
+    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"
+}
+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",
+    Thumbnail = "thumbnail",
+    Title = "title"
+}
+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"
+}
+/**
+ * Action descriptors give further context to UserActions
+ */
+export declare type ActionDescriptor = OperationDescriptor | SortDescriptor | FilterDescriptor | DirectSearchDescriptor | PageDescriptor | PlaybackDescriptor | CustomerSettingDescriptor | SuggestionDescriptor | InteractionTypeDescriptor | AssocDescriptor | ClickDescriptor;
+/**
+ * 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"
+}
+export declare enum EventVersion {
+    V1 = 1
+}

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

@@ -0,0 +1,3 @@
+import { BaseObject } from "./";
+export interface Config extends BaseObject {
+}

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

@@ -0,0 +1,3 @@
+import { BaseObject } from "./";
+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 "./";
+export interface Owner extends BaseObject {
+}

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

@@ -0,0 +1,3 @@
+import { BaseObject } from "./";
+export interface Playlist extends BaseObject {
+}

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

@@ -0,0 +1,4 @@
+import { BaseObject } from "./";
+export interface Rating extends BaseObject {
+    code?: string;
+}

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

@@ -0,0 +1,5 @@
+import { RegionName } from "../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 "./";
+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 "./";
+export interface Series extends BaseObject {
+}

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

@@ -0,0 +1,4 @@
+import { BaseObject } from "./";
+export interface Subtitle extends BaseObject {
+    metadata?: any;
+}

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

@@ -0,0 +1,6 @@
+import { BaseObject } from "./";
+export interface User extends BaseObject {
+    countryCode?: string;
+    customerId?: string;
+    role?: string;
+}

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 "./";
+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;
+}