@clickview/lite 0.0.17-rc.0 → 0.0.18-dev.0

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

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 "../interfaces";
+import { EventVersion } from "../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 {};

package/dist/libs/analytics/src/services/ContextService.d.ts

@@ -0,0 +1,19 @@
+import { Core } from "../../../common/src/backbone";
+interface ApplicationContext {
+    pageLoad: boolean;
+    appLink: Core.AppLink;
+}
+export interface AppContextServiceOptions {
+}
+export declare class StaticContextService extends Core.Service {
+    private static instance;
+    private contextHistory;
+    get name(): string;
+    static get Instance(): StaticContextService;
+    initialize(): void;
+    private setContext;
+    getCurrentContext(): ApplicationContext;
+    fromPageLoad(): boolean;
+}
+export declare const ContextService: StaticContextService;
+export {};

package/dist/libs/common/src/backbone/constants/BehaviorChannels.d.ts

@@ -0,0 +1,5 @@
+export declare const BehaviorChannels: {
+    LAZY_LOAD: string;
+    POPUP: string;
+    IMAGE_SELECT: string;
+};

package/dist/libs/common/src/backbone/constants/Caches.d.ts

@@ -0,0 +1,3 @@
+export declare enum Caches {
+    Fifo = "FifoMemoryCache"
+}

package/dist/libs/common/src/backbone/constants/CommonChannels.d.ts

@@ -0,0 +1,5 @@
+export declare const CommonChannels: {
+    SHELL: string;
+    ALERT: string;
+    POPUP: string;
+};

package/dist/libs/common/src/backbone/constants/CommonServices.d.ts

@@ -0,0 +1,5 @@
+export declare const CommonServices: {
+    ALERT: string;
+    SCROLL: string;
+    LANGUAGE: string;
+};

package/dist/libs/common/src/backbone/constants/DataProviders.d.ts

@@ -0,0 +1,4 @@
+export declare enum DataProviders {
+    Ajax = "AjaxDataProvider",
+    Notifications = "NotificationsSignalRDataProvider"
+}

package/dist/libs/common/src/backbone/core/AppLink.d.ts

@@ -0,0 +1,37 @@
+import { ObjectHash } from 'backbone';
+export interface AppLink {
+    application: string;
+    action: string;
+    args?: (string | number)[];
+    params?: string | ObjectHash;
+}
+export interface AppLinkHash {
+    [selector: string]: AppLink;
+}
+export interface AppLinkOptions {
+    replace?: boolean;
+}
+export declare const AppLinkUtility: {
+    routingStarted(): void;
+    routingEnded(): void;
+    hasActiveRoute(): boolean;
+};
+export declare const AppLinkHelper: {
+    /**
+     * Build a href string from an AppLink object
+     * @param appLink
+     */
+    getHref(appLink: AppLink): string;
+    /**
+     * This is the reverse process of extracting params out of a route.
+     * (e.g. Will take the route '/videos/:id' and an array of args = [123]
+     *  and return '/videos/123')
+     */
+    buildRoute(route: string, appLink: AppLink): string;
+    /**
+     * Manually trigger an AppLink
+     * @param appLink
+     */
+    trigger(appLink: AppLink, options?: AppLinkOptions): void;
+    getCurrentAppLink(): AppLink;
+};

package/dist/libs/common/src/backbone/core/BaseAppRouter.d.ts

@@ -0,0 +1,95 @@
+/// <reference types="backbone" />
+import * as Marionette from 'backbone.marionette';
+import { Shell } from './Shell';
+import { BaseApplication, BaseApplicationOptions } from './BaseApplication';
+import { AppLink } from './AppLink';
+import { MiddlewareFunction } from './Middleware';
+export interface ExecuteRouteOptions {
+    isAppRoute: boolean;
+}
+/**
+ * This should only ever be used by the shell
+ * creating a new instance of the AppRoute
+ */
+export interface BaseAppRouterOptions extends Marionette.AppRouterOptions {
+    appConstructor: typeof BaseApplication;
+    /**
+     * These will be passed into the appConstructor
+     * when creating an instance of the Application
+     */
+    appOptions?: BaseApplicationOptions;
+    shell: Shell;
+}
+/**
+ * Every Application must have an AppRouter
+ */
+export declare class BaseAppRouter extends Marionette.AppRouter {
+    /**
+     * A hash of urls to method names on the Application.
+     * Exactly the same implementation as Backbone Router routes
+     * except the methods exist on the Application.
+     * See http://backbonejs.org/#Router-routes
+     */
+    protected appRoutes?: Marionette.AppRoutes;
+    protected appLinks?: string[];
+    /**
+     * The channelName used to trigger the appLinks
+     * on backbone.radio. This will match the Application's
+     * channelName.
+     */
+    protected channelName?: string;
+    /**
+     * These are async middleware functions that are run
+     * before any route on this router is executed.
+     *
+     * They can be used to prevent access to a router using
+     * asyncronous code.
+     */
+    protected filters: MiddlewareFunction<AppLink>[];
+    /**
+     * See BaseAppRouterOptions above.
+     */
+    protected options?: BaseAppRouterOptions;
+    constructor(options?: BaseAppRouterOptions);
+    private bindDisposal;
+    /**
+     * Creates all the reverse route lookups
+     * and binds all the appLinks to the radio channel
+     */
+    private processAppEvents;
+    /**
+     * This is the heart of the AppRouter. Every single route both page loads
+     * and appLinks will go through this method.
+     *
+     * This will return false if onBeforeAction returns false
+     * and the window history will not be altered.
+     */
+    private executeRoute;
+    /**
+     * Instantiates and starts the application if there was
+     * not already an instance.
+     *
+     * Why is the application stores on this.controller?
+     * In Marionette AppRouters hold reference to a controller
+     * which in turn is responsibile for maintaining reference to an application.
+     * We've restructured this architecture so that AppRouters directly hold
+     * the instance of the Application, but are still leveraging Marionette's
+     * use of appRoutes on the controller.
+     */
+    private createApp;
+    private destroyApp;
+    /**
+     * Overriding Marionette.AppRouter's _addAppRoute so that
+     * execute route is called instead of the method directly.
+     *
+     * We do this so that executeRoute can be called for every single
+     * route, whether it's a page load or an appLink. This will make it easier
+     * to modify the action
+     */
+    private _addAppRoute;
+    private toEventName;
+    private toMethodName;
+    private validateAppLink;
+    listenTo(object: any, eventMap: Backbone.EventMap): this;
+    listenTo(obj: string | Backbone.Events, events: string, callback: Function): this;
+}

package/dist/libs/common/src/backbone/core/BaseApplication.d.ts

@@ -0,0 +1,76 @@
+import { ObjectHash } from 'backbone';
+import * as Marionette from 'backbone.marionette';
+import { Shell } from './Shell';
+import { BaseLayoutView, BaseLayoutViewOptions } from './BaseLayoutView';
+import { LayoutService, LayoutOptions } from './LayoutService';
+import { BaseAppRouter } from './BaseAppRouter';
+export interface BaseApplicationOptions extends Marionette.ApplicationOptions {
+    shell: Shell;
+    layoutService: LayoutService;
+    channelName?: string;
+}
+export declare class BaseApplication extends Marionette.Application {
+    /**
+     * Layout service is used to retreive the layout on each route
+     */
+    private layoutService;
+    /**
+     * The layout that should be used to render all content into the DOM
+     */
+    protected layout?: BaseLayoutView;
+    /**
+     * This is specified by all children of Core.Application
+     * to determine which layout to load in from layout service,
+     * and what options to instantiate it with.
+     */
+    protected layoutOptions: LayoutOptions<BaseLayoutViewOptions>;
+    /**
+     * A reference to the shell is always kept as a
+     * way to both render the layout into the dom
+     * and keep reference to global services
+     */
+    protected shell: Shell;
+    /**
+     * An instance of the Core.AppRouter is created
+     * for each Application in order to listen to applink
+     * events. The application instance is only then instantiated
+     * when the Application route is hit
+     */
+    static router: typeof BaseAppRouter;
+    /**
+     * Provides the ability to define useful error messages.
+     */
+    name: string;
+    /** When overridden determines which options are
+     * mixed into the instance */
+    props: string[];
+    /**
+     * Used by application actions to set default options.
+     */
+    private defaultQueryParams;
+    /**
+     * Shell and layoutService will be mixed into each instance
+     * of Core.Applicataion
+     */
+    get defaultProps(): string[];
+    /**
+     * The constructor will merge in props and ensure any required properties
+     * are defined
+     * @constructor
+     */
+    constructor(options?: BaseApplicationOptions);
+    private getGlobalRadioChannel;
+    /**
+     * This method is triggered by Core.AppRouter when it loads
+     * in a route for this application. It will swap in the appropriate
+     * layout before hitting the application's action.
+     *
+     */
+    private onLoadLayout;
+    private onShowPopup;
+    protected onShowAlert(options: ObjectHash): void;
+    protected setDefaultQueryParams(params: ObjectHash): void;
+    getAndClearDefaultQueryParams(): ObjectHash;
+    listenTo(object: any, eventMap: Backbone.EventMap): this;
+    listenTo(obj: string | Backbone.Events, events: string, callback: Function): this;
+}

package/dist/libs/common/src/backbone/core/BaseBehavior.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="backbone" />
+import * as Marionette from 'backbone.marionette';
+export declare class BaseBehavior extends Marionette.Behavior {
+    listenTo(object: any, eventMap: Backbone.EventMap): this;
+    listenTo(obj: string | Backbone.Events, events: string, callback: Function): this;
+}

package/dist/libs/common/src/backbone/core/BaseCollection.d.ts

@@ -0,0 +1,7 @@
+import * as Backbone from 'backbone';
+import { BaseModel } from './BaseModel';
+export declare class BaseCollection<TModel extends BaseModel = BaseModel> extends Backbone.Collection<TModel> {
+    parent?: BaseModel | BaseCollection;
+    listenTo(object: any, eventMap: Backbone.EventMap): this;
+    listenTo(obj: string | Backbone.Events, events: string, callback: Function): this;
+}

package/dist/libs/common/src/backbone/core/BaseCollectionView.d.ts

@@ -0,0 +1,16 @@
+/// <reference types="backbone" />
+import * as Marionette from 'backbone.marionette';
+import { BaseCollection } from './BaseCollection';
+import { CoreView } from './BaseView';
+import { BaseModel } from './BaseModel';
+export interface BaseCollectionViewOptions<TModel extends BaseModel = BaseModel> extends Marionette.CollectionViewOptions<TModel> {
+    channelName?: string;
+}
+export declare class BaseCollectionView<TModel extends BaseModel = BaseModel, TView extends CoreView<TModel> = CoreView<TModel>, TCollection extends BaseCollection<TModel> = BaseCollection<TModel>> extends Marionette.CollectionView<TModel, TView, TCollection> {
+    protected options: BaseCollectionViewOptions<TModel>;
+    constructor(options?: BaseCollectionViewOptions<TModel>);
+    serializeModel(): any;
+    serializeCollection(): any[];
+    listenTo(object: any, eventMap: Backbone.EventMap): this;
+    listenTo(obj: string | Backbone.Events, events: string, callback: Function): this;
+}