@clickview/lite 0.0.26-rc.0 → 0.0.26-rc.1

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

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

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

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

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

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

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

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

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

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

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

@@ -1,17 +0,0 @@
-import { BaseObject } from "./";
-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

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

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

@@ -1,16 +0,0 @@
-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

@@ -1,15 +0,0 @@
-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

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

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

@@ -1,49 +0,0 @@
-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/models/CollectionEvent.d.ts

@@ -1,61 +0,0 @@
-import { HashObject } from "../interfaces/HashObject";
-import { VersionData } from "../interfaces/VersionData";
-import { UserAction, EventVersion, ActionContext } from "../interfaces/AnalyticsTypes";
-import { Region } from "../interfaces/Region";
-import { CountryCode } from "../enums/CountryCode";
-export interface IncomingEvent {
-    type: CollectionEventType;
-    data: HashObject;
-    actionContext: ActionContext;
-    eventVersion: EventVersion;
-}
-export interface RequestData {
-    url: string;
-    referrer: string;
-}
-export interface PlatformData {
-    browser: VersionData;
-    os: VersionData;
-    request: RequestData;
-    screenResolution: string;
-}
-export interface CollectionEventUserData {
-    id: string;
-    role: string;
-    userGroup: string;
-    yearGroup: string;
-    customer: {
-        id: string;
-        name: string;
-        country: CountryCode;
-        region: Region;
-        customerGuid: string;
-        crmId: number;
-        openCustomer: boolean;
-    };
-}
-export interface CollectionEventData {
-    [entity: string]: HashObject;
-    action: HashObject;
-    user: CollectionEventUserData;
-    platform: PlatformData;
-    product: VersionData;
-}
-export interface CollectionEventMetadata {
-    timestamp: string;
-    client: {
-        name: string;
-        version: string;
-        region: Region;
-    };
-    eventVersion: EventVersion;
-}
-export declare type CollectionEventType = UserAction;
-/**
- * Model to be sent to CollectionApi.
- */
-export interface CollectionEvent {
-    type: CollectionEventType;
-    data: CollectionEventData;
-    metadata: CollectionEventMetadata;
-}

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

@@ -1,19 +0,0 @@
-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/analytics/src/transport/EventTransport.d.ts

@@ -1,39 +0,0 @@
-import * as Marionette from 'backbone.marionette';
-import { CoreAnalyticsType } from "../models/AnalyticsEvent";
-import { BaseAnalyticsClient } from "../clients/BaseAnalyticsClient";
-import { CollectionApiClient } from "../clients/CollectionApiClient";
-declare type AnalyticsClient = BaseAnalyticsClient | CollectionApiClient;
-/**
- * TransportLayer is responsible for communicating outgoing events from the
- * AnalyticsService to registered AnalyticsClients.
- */
-interface TransportLayer {
-    publish(event: CoreAnalyticsType): void;
-    subscribe<TClient extends AnalyticsClient>(client: TClient): void;
-}
-export declare abstract class BaseAnalyticsTransport extends Marionette.Object implements TransportLayer {
-    abstract publish(event: CoreAnalyticsType): void;
-    abstract subscribe(client: AnalyticsClient): void;
-}
-/**
- * EventTransport will utilise Backbone.Radio to emit events.
- */
-export declare class EventTransport extends BaseAnalyticsTransport {
-    get name(): string;
-    get channelName(): string;
-    /**
-     * Publish an event to all AnalyticsClients
-     *
-     * @param event Outgoing event object
-     */
-    publish(event: CoreAnalyticsType): void;
-    /**
-     * Subscribe the client to all outgoing events emitted from the AnalyticsService.
-     * All events will be recieved via the client's exposed eventHandler. Any specific
-     * event filtering or custom enrichment should occur within a client.
-     *
-     * @param client AnalyticsClient
-     */
-    subscribe(client: AnalyticsClient): void;
-}
-export {};

package/dist/libs/analytics/src/utils/CollectionApiClientHelper.d.ts

@@ -1,6 +0,0 @@
-import { IncomingEvent } from "../models/CollectionEvent";
-import { HashObject } from "../interfaces";
-export declare const CollectionApiClientHelper: {
-    shouldLog(event: IncomingEvent): boolean;
-    formatData(event: IncomingEvent): HashObject<any> | HashObject<any>[];
-};

package/dist/libs/analytics/src/utils/DataFormatHelper.d.ts

@@ -1,14 +0,0 @@
-import { CoreAnalyticsType } from "../models/AnalyticsEvent";
-import { HashObject } from "../interfaces";
-declare type DataFormatter = (data: HashObject, event: CoreAnalyticsType) => HashObject;
-export interface DataFormatterHash {
-    [eventType: string]: DataFormatter;
-}
-export declare const DataFormatHelper: {
-    /**
-     * Object will be logged to sink as is
-     */
-    passthrough(data: HashObject<any>): HashObject<any>;
-    getEditData(data: HashObject<any>, event: CoreAnalyticsType): HashObject<any>;
-};
-export {};

package/dist/libs/analytics/src/utils/EventWhitelistHelper.d.ts

@@ -1,19 +0,0 @@
-import { CoreAnalyticsType } from "../models/AnalyticsEvent";
-/**
- * Manage which events we want to log
- *
- * @description
- * All events have a UserAction type, however, that same type can be used to represent
- * different types of actions. For example, `UserAction.Rename` is used for events involving
- * the renaming of folders, libraries and videos (from different parts of the product).
- *
- * So if a situation arises where we only want to collect events for a certain entity or from a
- * certain part of the product. We can add a custom callback below and filter based on the event's actionContext.
- */
-export declare const EventWhitelistHelper: {
-    allow: () => boolean;
-    restrict: () => boolean;
-};
-export interface EventWhitelistHash {
-    [eventType: string]: (event: CoreAnalyticsType) => boolean;
-}

package/dist/libs/analytics/src/utils/TypeHelper.d.ts

@@ -1,4 +0,0 @@
-export declare const TypeHelper: {
-    isObject(obj: any): boolean;
-    isFunction(fn: (...args: any[]) => any): boolean;
-};

package/dist/libs/analytics/src/utils/UploadDataFormatHelper.d.ts

@@ -1,10 +0,0 @@
-import { HashObject, Subtitle, Resource } from "../interfaces";
-import { CoreAnalyticsType } from "../models/AnalyticsEvent";
-export declare const UploadDataFormatHelper: {
-    getUploadData(data: any, event: CoreAnalyticsType): HashObject<any>;
-    formatVideoUpload(data: any, event: CoreAnalyticsType): HashObject<any>[];
-    getStartVideoUploadData(files: File[]): HashObject<any>[];
-    getDiscardVideoUploadData(uploads: HashObject<any> | HashObject<any>[]): HashObject<any>[];
-    getCompleteUploadData(videos: HashObject<any>[]): HashObject<any>[];
-    formatResourceUpload(item: Resource | Subtitle): HashObject<any>;
-};

package/dist/libs/analytics/src/utils/UrlHelper.d.ts

@@ -1,3 +0,0 @@
-export declare const UrlHelper: {
-    safeUrlConcat(baseUrl: string, path: string): string;
-};

package/dist/libs/analytics/src/utils/UserAgentHelper.d.ts

@@ -1,10 +0,0 @@
-import { VersionData } from "../interfaces/VersionData";
-/**
- * Test order is important for all UARegex tests. Reordering them will break functionality.
- */
-export declare const UserAgentHelper: {
-    getDeviceType(): string;
-    getOperatingSystem(): VersionData;
-    getBrowser(): VersionData;
-    isTouchScreen(): boolean;
-};

package/dist/libs/analytics/src/utils/VideoDataFormatHelper.d.ts

@@ -1,42 +0,0 @@
-import { HashObject, Video } from "../interfaces";
-export interface VideoWatchAnalyticsEvent {
-    model: Video;
-    playbackStatus: PlaybackStatus;
-}
-export interface PlaybackStatus {
-    position: number;
-    chapter: number;
-    totalDuration: number;
-    totalWatched: number;
-    hasStarted?: boolean;
-}
-interface BaseVideoData {
-    id: string;
-    title: string;
-    trackingCode: string;
-    duration: number;
-}
-interface BaseAssocData {
-    id: string;
-    title?: string;
-}
-export interface VideoAnalyticsPayload {
-    video: BaseVideoData;
-    rating?: string;
-    series?: BaseAssocData;
-    folder?: BaseAssocData;
-    owner?: BaseAssocData;
-    playlist?: BaseAssocData;
-    playbackStatus?: PlaybackStatus;
-}
-export declare const VideoDataFormatHelper: {
-    getVideoData(options: VideoWatchAnalyticsEvent): VideoAnalyticsPayload;
-    /**
-     * Map to the same properties recorded in Online.
-     * @see _toLogMasterVideo() in AnalyticsService in Online
-     *
-     * TODO: Video origin and user channel logging - both of these need to be re-worked properly.
-     */
-    getLegacyVideoData(options: VideoWatchAnalyticsEvent): HashObject<any>;
-};
-export {};

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

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

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

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

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

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

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

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

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

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

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

@@ -1,37 +0,0 @@
-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

@@ -1,103 +0,0 @@
-/// <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;
-}
-export interface FilterOptions {
-    appLink: AppLink;
-    shell: Shell;
-}
-/**
- * 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[];
-    protected externalRoutes?: Marionette.AppRoutes;
-    /**
-     * 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<FilterOptions>[];
-    /**
-     * See BaseAppRouterOptions above.
-     */
-    protected options?: BaseAppRouterOptions;
-    constructor(options?: BaseAppRouterOptions);
-    private bindDisposal;
-    private addRouteLookup;
-    /**
-     * Creates all the reverse route lookups
-     * and binds all the appLinks to the radio channel
-     */
-    private processInternalRoutes;
-    private processExternalRoutes;
-    private processAppLinks;
-    /**
-     * 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: (...args: any) => any): this;
-}

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

@@ -1,76 +0,0 @@
-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: (...args: any) => any): this;
-}

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

@@ -1,6 +0,0 @@
-/// <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: (...args: any) => any): this;
-}

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

@@ -1,7 +0,0 @@
-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: (...args: any) => any): this;
-}