@clickview/library-editor 1.1.18 → 1.1.19-rc.0

package/dist/libs/common/src/react/utils/FetchHelper.d.ts

@@ -0,0 +1,50 @@
+import { BaseDataService } from "../../backbone/services/BaseDataService";
+import { DataServiceError } from "../../backbone/interfaces/DataServiceError";
+export interface FetchOptions {
+    /**
+     * Name of the required data service for fetchData.
+     */
+    dataServiceName: string;
+    /**
+     * @deprecated
+     * DataChannelName is now referenced directly from the data service
+     * instance itself.
+     *
+     * The channelName of the data service's dataChannel.
+     */
+    dataChannelName?: string;
+    /**
+     * The eventPrefix for the data being fetched.
+     */
+    eventPrefix: string;
+    /**
+     * Callback fn to fetch data give a data service instance.
+     */
+    fetchData: (dataService: BaseDataService) => any;
+    /**
+     * Callback fn to set the data when it is returned from the data service.
+     * This will usually be a setState function.
+     *
+     * Deliberately a loose Function type so that we can use React setState setters.
+     */
+    setData: Function;
+    /**
+     * onError callback fn.
+     */
+    onError?: (error: DataServiceError) => void;
+    /**
+     * The eventPrefix for the corresponding delete event for the object being
+     * fetched. This is used to listen to the delete event so that any cache
+     * invalidation listeners can be unbound to prevent an attempt to re-fetch
+     * the now deleted data.
+     */
+    deleteEventPrefix?: string;
+}
+export declare const FetchHelper: {
+    /**
+     * Helper function to fetch data inside a hook. Listeners are bound to the data channel
+     * request and sync events, then the request is sent. If data is returned it will be
+     * set using the setData function passed in.
+     */
+    fetch<T extends BaseDataService>(options: FetchOptions, setDataFetched: (fetched: boolean) => void): () => void;
+};

package/dist/libs/common/src/react/utils/ObjectHelper.d.ts

@@ -0,0 +1,10 @@
+export declare const ObjectHelper: {
+    isEmpty(obj: any): boolean;
+    values(obj: any): any[];
+    keys(obj: any): string[];
+    deepClone(obj: any): any;
+    getEnumKeys(obj: any): any[];
+    isObject(obj: any): boolean;
+    isEqual(obj1: any, obj2: any): boolean;
+    omit(obj: any, keys: string[]): any;
+};

package/dist/libs/shared/src/apps/notifications/collections/NotificationCollection.d.ts

@@ -0,0 +1,9 @@
+import { Core } from "../../../../../common/src/backbone";
+import { Notification } from "../models/Notification";
+/**
+ * @Backbone
+ */
+export declare class NotificationCollection extends Core.Collection<Notification> {
+    get model(): Core.ModelCtor<Notification>;
+    parse(response: any): any;
+}

package/dist/libs/shared/src/apps/notifications/components/notification-items/notification-item/NotificationItemComponent.d.ts

@@ -0,0 +1,23 @@
+import { ObjectHash } from 'backbone';
+import { Core } from "../../../../../../../common/src/backbone";
+interface NotificationItemOptions extends Core.ComponentOptions {
+    showActionText?: boolean;
+}
+export declare class NotificationItemComponent extends Core.Component {
+    options: NotificationItemOptions;
+    constructor(options: NotificationItemOptions);
+    initialize(): void;
+    get name(): string;
+    get template(): any;
+    get tagName(): string;
+    get attributes(): any;
+    get className(): string;
+    events(): ObjectHash;
+    private onClick;
+    get appLinks(): Core.AppLinkHash;
+    private getAppLink;
+    private updateReadStatus;
+    private getReadStatus;
+    viewOptions(): ObjectHash;
+}
+export {};

package/dist/libs/shared/src/apps/notifications/components/notification-list/NotificationListComponent.d.ts

@@ -0,0 +1,26 @@
+import { ObjectHash } from 'backbone';
+import { Core } from "../../../../../../common/src/backbone";
+export declare enum NotificationChildType {
+    Default = 0,
+    Popover = 1
+}
+export interface NotificationComponentCollectionOptions extends Core.ComponentCollectionOptions {
+    childType: NotificationChildType;
+    isPopover?: boolean;
+}
+interface NotificationListComponentOptions extends Core.ComponentOptions {
+    childType: NotificationChildType;
+    isPopover?: boolean;
+}
+export declare class NotificationListComponent extends Core.Component {
+    options: NotificationListComponentOptions;
+    constructor(options: NotificationListComponentOptions);
+    get name(): string;
+    get template(): string;
+    get lang(): string;
+    regions(): ObjectHash;
+    get behaviors(): any[];
+    private getEmptyStateComponentOptions;
+    onRender(): void;
+}
+export {};

package/dist/libs/shared/src/apps/notifications/components/notification-status/NotificationStatusComponent.d.ts

@@ -0,0 +1,15 @@
+import { ObjectHash } from 'backbone';
+import { Core } from "../../../../../../common/src/backbone";
+interface NotificationStatusComponentOptions extends Core.ComponentOptions {
+    color: 'light' | 'dark';
+}
+export declare class NotificationStatusComponent extends Core.Component {
+    options: NotificationStatusComponentOptions;
+    constructor(options: NotificationStatusComponentOptions);
+    get name(): string;
+    get className(): string;
+    get template(): any;
+    initialize(): void;
+    viewOptions(): ObjectHash;
+}
+export {};

package/dist/libs/shared/src/apps/notifications/enums/AppLinkReferrer.d.ts

@@ -0,0 +1,3 @@
+export declare enum AppLinkReferrer {
+    Notification = "notification"
+}

package/dist/libs/shared/src/apps/notifications/enums/NotificationActions.d.ts

@@ -0,0 +1,3 @@
+export declare enum NotificationActions {
+    Read = "notification:read"
+}

package/dist/libs/shared/src/apps/notifications/enums/NotificationAlertType.d.ts

@@ -0,0 +1,7 @@
+export declare enum NotificationAlertType {
+    Other = 0,
+    Alert = 1,
+    Warning = 2,
+    Info = 3,
+    Success = 4
+}

package/dist/libs/shared/src/apps/notifications/enums/NotificationAppLinkModules.d.ts

@@ -0,0 +1,7 @@
+export declare enum NotificationAppLinkModules {
+    Video = "video",
+    Url = "url",
+    Module = "module",
+    App = "app",
+    StaffRequest = "staff_request"
+}

package/dist/libs/shared/src/apps/notifications/enums/NotificationModules.d.ts

@@ -0,0 +1,4 @@
+export declare enum NotificationModules {
+    LibraryReview = "libraryreview",
+    ContentUpdates = "newcontent"
+}

package/dist/libs/shared/src/apps/notifications/enums/NotificationStatus.d.ts

@@ -0,0 +1,5 @@
+export declare enum NotificationStatus {
+    Received = 1,
+    Seen = 2,
+    Read = 3
+}

package/dist/libs/shared/src/apps/notifications/enums/NotificationType.d.ts

@@ -0,0 +1,16 @@
+export declare enum NotificationType {
+    ExchangeVideoAvailable = "exchange-video-available",
+    WorkspaceVideoAvailable = "workspace-video-available",
+    Marketing = "marketing",
+    EditedVideoAvailable = "edited-video-available",
+    VideoRequestAvailable = "pay-tv-video-available",
+    VideoRequestDenied = "pay-tv-video-denied",
+    VideoReviewReminder = "term-update-review-reminder",
+    VideoReviewAddedToLibrary = "term-update-review-videos-added-to-library",
+    CustomLibraryVideoAvailable = "custom-library-video-available",
+    VideoProcessingFailed = "video-processing-failed",
+    StaffRequest = "new-staff-request",
+    StaffRequestFulfilled = "staff-request-fulfilment",
+    ChapterMergeSuccess = "media-concatenate-success",
+    SuggestEdit = "suggest-an-edit"
+}

package/dist/libs/shared/src/apps/notifications/interfaces/NotificationCollectionRequest.d.ts

@@ -0,0 +1,5 @@
+export interface NotificationCollectionRequest {
+    limit?: number;
+    cursor?: string;
+    before?: string;
+}

package/dist/libs/shared/src/apps/notifications/interfaces/index.d.ts

@@ -0,0 +1 @@
+export * from './NotificationCollectionRequest';

package/dist/libs/shared/src/apps/notifications/models/Notification.d.ts

@@ -0,0 +1,6 @@
+import { Core } from "../../../../../common/src/backbone";
+/**
+ * @Backbone
+ */
+export declare class Notification extends Core.Model {
+}

package/dist/libs/shared/src/apps/notifications/services/NotificationDataService.d.ts

@@ -0,0 +1,14 @@
+import { Cursors } from "../../../../../common/src/backbone/interfaces";
+import { BaseDataService } from "../../../../../common/src/backbone/services/BaseDataService";
+import { NotificationCollectionRequest } from "../interfaces";
+import { NotificationCollection } from "../collections/NotificationCollection";
+export declare class NotificationDataService extends BaseDataService {
+    get name(): string;
+    get channelName(): string;
+    get lang(): string;
+    getNotifications(userId: string, params: NotificationCollectionRequest, collectionIdentifier: string, callback?: (data?: any) => any): NotificationCollection;
+    markRead(id: string, callback?: (data?: any) => any): void;
+    markSeen(callback?: () => any): void;
+    getNotificationsCursors(collectionIdentifier: string): Cursors;
+    suggestEdit(data: any, callback?: (data: any) => void): any;
+}

package/dist/libs/shared/src/apps/notifications/services/NotificationService.d.ts

@@ -0,0 +1,33 @@
+import { Core } from "../../../../../common/src/backbone";
+import { Cursors } from "../../../../../common/src/backbone/interfaces";
+import { CollectionIdentifier } from "../../../legacy/interfaces";
+import { NotificationCollectionRequest } from "../interfaces";
+export declare class NotificationService extends Core.Service {
+    private notificationDataService;
+    private notificationSocketService;
+    private userDataService;
+    constructor();
+    get name(): string;
+    private initDataServices;
+    private bindSocketListeners;
+    private bindAppListeners;
+    private getDataServices;
+    private dataServicesExist;
+    /**
+     * On receiving a new notification via signalr, add the model to the top of the
+     * first page's collection.
+     */
+    private addNewNotification;
+    /**
+     * Triggered by signalr callback event when loading notifications in the top bar
+     */
+    private updateUnreadCount;
+    getNotifications(params: NotificationCollectionRequest, collectionIdentifier: CollectionIdentifier, callback?: (data?: any) => any): void;
+    /**
+     * Retrive current unread notification count
+     */
+    getNotificationsMetadata(): Core.Model;
+    markNotificationsSeen(): void;
+    markNotificationRead(id: string): void;
+    getNotificationsCursors(collectionIdentifier: CollectionIdentifier): Cursors;
+}

package/dist/libs/shared/src/apps/notifications/services/NotificationSocketService.d.ts

@@ -0,0 +1,8 @@
+import { BaseDataService } from "../../../../../common/src/backbone/services/BaseDataService";
+import { Notification } from "../models/Notification";
+export declare class NotificationSocketService extends BaseDataService {
+    get name(): string;
+    get channelName(): string;
+    receiveLatestNotifications(callback?: (notification: Notification) => any): Notification;
+    receiveUnreadNotificationCount(callback?: (unreadCount: number) => any): number;
+}

package/dist/libs/shared/src/apps/notifications/services/data-providers/NotificationsSocketDataProvider.d.ts

@@ -0,0 +1,4 @@
+import { SignalRDataProvider } from "../../../../../../common/src/backbone/services/data-providers/SignalRDataProvider";
+export declare class NotificationsSocketDataProvider extends SignalRDataProvider {
+    get name(): string;
+}

package/dist/libs/shared/src/apps/notifications/utils/NotificationAppLinkHelper.d.ts

@@ -0,0 +1,10 @@
+import { Core } from "../../../../../common/src/backbone";
+import { NotificationType } from "../enums/NotificationType";
+export declare const NotificationAppLinkHelper: {
+    /**
+     * Determine if the current notificationType is supported within the project so that
+     * we can construct an AppLink. Where it is not supported, we will just use the link.
+     */
+    canBuildAppLink: (Notificationtype: NotificationType) => boolean;
+    parseAppLink: (appLink: string, type: string) => Core.AppLink;
+};

package/dist/libs/shared/src/apps/notifications/utils/NotificationsHelper.d.ts

@@ -0,0 +1,18 @@
+import { NotificationType } from "../enums/NotificationType";
+import { NotificationAlertType } from "../enums/NotificationAlertType";
+export declare const NotificationsHelper: {
+    getIconColor: (type: NotificationAlertType) => "dark" | "success" | "danger" | "warning";
+    getIcon: (type: NotificationAlertType) => import("../../../images/svg").localSvgs.CheckCircle | import("../../../images/svg").localSvgs.Info | import("../../../images/svg").localSvgs.Warning;
+    /**
+     * This is a manual override based on the notification type. This is only
+     * temporary as some noitifications don't have the correct alert type.
+     */
+    getIconColorByNotificationType: (type: NotificationType) => "danger" | "warning";
+    /**
+     * This is a manual override based on the notification type.
+     * Using this to detect marketing notifications as they don't have a fixed
+     * type atm.
+     */
+    getIconByNotificationType: (type: NotificationType) => import("../../../images/svg").localSvgs;
+    getNotificationAction: (type: NotificationType) => string;
+};

package/dist/libs/shared/src/apps/notifications/views/header/NotificationHeaderView.d.ts

@@ -0,0 +1,16 @@
+import { ObjectHash } from 'backbone';
+import { Core } from "../../../../../../common/src/backbone";
+export declare class NotificationHeaderView extends Core.View {
+    private appVariables;
+    initialize(): void;
+    get name(): string;
+    get title(): boolean;
+    get className(): string;
+    get template(): any;
+    regions(): ObjectHash;
+    events(): ObjectHash;
+    private renderNotificationList;
+    private renderNotificationStatus;
+    viewOptions(): ObjectHash;
+    onRender(): void;
+}

package/dist/libs/shared/src/apps/notifications/views/notifications/NotificationsView.d.ts

@@ -0,0 +1,27 @@
+import { ObjectHash } from 'backbone';
+import { Core } from "../../../../../../common/src/backbone";
+import { NotificationCollection } from "../../collections/NotificationCollection";
+export interface NotificationsViewOptions extends Core.ViewOptions {
+    params: ObjectHash;
+}
+export declare class NotificationsView extends Core.View {
+    protected options: NotificationsViewOptions;
+    collection: NotificationCollection;
+    private collectionIdentifier;
+    private notificationService;
+    private appVariables;
+    constructor(options: NotificationsViewOptions);
+    get name(): string;
+    get title(): string;
+    get lang(): string;
+    get className(): string;
+    get template(): any;
+    regions(): ObjectHash;
+    initialize(): void;
+    private onData;
+    private getCollectionIdentifier;
+    private renderNotificationList;
+    private renderPagination;
+    onBeforeRender(): boolean;
+    onRender(): void;
+}

package/dist/libs/shared/src/apps/notifications/views/popover/NotificationsPopoverView.d.ts

@@ -0,0 +1,34 @@
+import { ObjectHash } from 'backbone';
+import { Core } from "../../../../../../common/src/backbone";
+import { NotificationCollection } from "../../collections/NotificationCollection";
+import { NotificationChildType } from "../../components/notification-list/NotificationListComponent";
+export interface NotificationsPopoverViewOptions extends Core.ViewOptions {
+    childType: NotificationChildType;
+}
+export declare class NotificationsPopoverView extends Core.View {
+    options: NotificationsPopoverViewOptions;
+    collection: NotificationCollection;
+    private collectionIdentifier;
+    private notificationService;
+    private appVariables;
+    constructor(options: NotificationsPopoverViewOptions);
+    get name(): string;
+    get title(): boolean;
+    get lang(): string;
+    get className(): string;
+    get template(): any;
+    regions(): ObjectHash;
+    get elements(): ObjectHash;
+    get appLinks(): Core.AppLinkHash;
+    initialize(): void;
+    private onData;
+    private getCollectionIdentifier;
+    private renderNotificationList;
+    /**
+       * Only trigger the notification seen event once the collection has been loaded.
+       */
+    private triggerSeen;
+    onBeforeRender(): boolean;
+    viewOptions(): ObjectHash;
+    onRender(): void;
+}

package/dist/libs/shared/src/apps/search/components/confirm-selection/ConfirmSelectionComponent.d.ts

@@ -0,0 +1,12 @@
+import { ObjectHash } from 'backbone';
+import { Core } from "../../../../../../common/src/backbone";
+interface ConfirmSelectionComponentOptions extends Core.ComponentOptions {
+}
+export declare class ConfirmSelectionComponent extends Core.Component {
+    constructor(options: ConfirmSelectionComponentOptions);
+    get name(): string;
+    get template(): string;
+    get className(): string;
+    viewOptions(): ObjectHash;
+}
+export {};

package/dist/libs/shared/src/apps/search/components/instant-search/classification/ClassificationSearchResultComponent.d.ts

@@ -0,0 +1,17 @@
+import { ObjectHash } from 'backbone';
+import { Core } from "../../../../../../../common/src/backbone";
+import { BaseSearchAppVariables } from "../../../../../interfaces";
+export declare class ClassificationSearchResultComponent extends Core.Component {
+    appVariables: BaseSearchAppVariables;
+    initialize(): void;
+    get name(): string;
+    get template(): string;
+    get className(): string;
+    regions(): ObjectHash;
+    events(): ObjectHash;
+    private onClick;
+    private getUrl;
+    private renderThumbnail;
+    viewOptions(): ObjectHash;
+    onRender(): void;
+}

package/dist/libs/shared/src/apps/search/components/instant-search/index.d.ts

@@ -0,0 +1,5 @@
+export * from './recent-search/RecentSearchResultComponent';
+export * from './series/SeriesSearchResultComponent';
+export * from './tag/TagSearchResultComponent';
+export * from './video-result/VideoSearchResultComponent';
+export * from './classification/ClassificationSearchResultComponent';

package/dist/libs/shared/src/apps/search/components/instant-search/recent-search/RecentSearchResultComponent.d.ts

@@ -0,0 +1,15 @@
+import { ObjectHash } from 'backbone';
+import { Core } from "../../../../../../../common/src/backbone";
+interface RecentSearchResultComponentOptions extends Core.ComponentOptions {
+    channelName: string;
+}
+export declare class RecentSearchResultComponent extends Core.Component {
+    constructor(options: RecentSearchResultComponentOptions);
+    get name(): string;
+    get template(): string;
+    get className(): string;
+    events(): ObjectHash;
+    viewOptions(): ObjectHash;
+    private onClick;
+}
+export {};

package/dist/libs/shared/src/apps/search/components/instant-search/series/SeriesSearchResultComponent.d.ts

@@ -0,0 +1,9 @@
+import { ObjectHash } from 'backbone';
+import { Core } from "../../../../../../../common/src/backbone";
+export declare class SeriesSearchResultComponent extends Core.Component {
+    get name(): string;
+    get template(): string;
+    get className(): string;
+    events(): ObjectHash;
+    private onClick;
+}

package/dist/libs/shared/src/apps/search/components/instant-search/tag/TagSearchResultComponent.d.ts

@@ -0,0 +1,9 @@
+import { ObjectHash } from 'backbone';
+import { Core } from "../../../../../../../common/src/backbone";
+export declare class TagSearchResultComponent extends Core.Component {
+    get name(): string;
+    get template(): string;
+    get className(): string;
+    events(): ObjectHash;
+    private onClick;
+}

package/dist/libs/shared/src/apps/search/components/instant-search/video-result/VideoSearchResultComponent.d.ts

@@ -0,0 +1,18 @@
+import { ObjectHash } from 'backbone';
+import { Core } from "../../../../../../../common/src/backbone";
+import { BaseSearchAppVariables } from "../../../../../interfaces";
+export declare class VideoSearchResultComponent extends Core.Component<any> {
+    appVariables: BaseSearchAppVariables;
+    initialize(): void;
+    get name(): string;
+    get template(): string;
+    get className(): string;
+    regions(): ObjectHash;
+    events(): ObjectHash;
+    private onClick;
+    private getCollection;
+    private getUrl;
+    private renderThumbnail;
+    viewOptions(): ObjectHash;
+    onRender(): void;
+}

package/dist/libs/shared/src/apps/search/components/search-context/SearchContextComponent.d.ts

@@ -0,0 +1,18 @@
+import { ObjectHash } from 'backbone';
+import { Core } from "../../../../../../common/src/backbone";
+export declare class SearchContextComponent extends Core.Component {
+    initialize(): void;
+    get name(): string;
+    get template(): string;
+    get tagName(): string;
+    get className(): string;
+    get behaviors(): any[];
+    get elements(): ObjectHash;
+    events(): ObjectHash;
+    private onClick;
+    private onMouseEnter;
+    private onMouseLeave;
+    private toggleFocus;
+    viewOptions(): ObjectHash;
+    onBeforeRender(): boolean;
+}

package/dist/libs/shared/src/apps/search/components/search-tips/SearchTipsComponent.d.ts

@@ -0,0 +1,11 @@
+import { ObjectHash } from 'backbone';
+import { Core } from "../../../../../../common/src/backbone";
+export declare class SearchTipsComponent extends Core.Component {
+    initialize(): void;
+    get name(): string;
+    get template(): string;
+    get lang(): string;
+    get behaviors(): any[];
+    private renderTips;
+    viewOptions(): ObjectHash;
+}

package/dist/libs/shared/src/apps/search/constants/TypeaheadConfiguration.d.ts

@@ -0,0 +1,12 @@
+export declare const TypeaheadConfiguration: {
+    /**
+     * Request remote data after character input meets length
+     */
+    ActivationLength: number;
+    SuggestionLimit: {
+        Min: number;
+        Default: number;
+        Folder: number;
+        Recent: number;
+    };
+};

package/dist/libs/shared/src/apps/search/enums/FilterTypes.d.ts

@@ -0,0 +1,14 @@
+export declare enum FilterTypes {
+    Sources = "libraries",
+    Folder = "folder",
+    Tags = "tag",
+    Ratings = "ratings",
+    Interactives = "interactives",
+    Resources = "resources",
+    Subtitles = "subtitles",
+    ProductionYear = "productionYear",
+    ProducedByClickView = "producedByClickView",
+    HD = "hd",
+    Duration = "duration",
+    Series = "series"
+}

package/dist/libs/shared/src/apps/search/enums/SearchQueryType.d.ts

@@ -0,0 +1,18 @@
+export declare enum SearchQueryType {
+    Video = "videos",
+    Folder = "categories",
+    Series = "series",
+    Channel = "channels",
+    Distributors = "companies",
+    Producers = "people",
+    Tags = "tags",
+    Language = "languages",
+    TagsRaw = "tag",
+    ChannelRaw = "channel",
+    Recent = "recent",
+    Direct = "direct",
+    ProductionCompanies = "companies",
+    Directors = "people",
+    Season = "season",
+    Classification = "subjects"
+}

package/dist/libs/shared/src/apps/search/enums/SearchTypes.d.ts

@@ -0,0 +1,8 @@
+export declare enum SearchTypes {
+    Direct = "direct-search",
+    Recent = "recent-searches"
+}
+export declare enum BloodhoundType {
+    Remote = 0,
+    Local = 1
+}

package/dist/libs/shared/src/apps/search/interfaces/SearchTypes.d.ts

@@ -0,0 +1,26 @@
+/// <reference types="typeahead" />
+import { ObjectHash } from 'backbone';
+export interface RemoteSearch<T> extends Bloodhound.BloodhoundOptions<T> {
+    remote: Bloodhound.RemoteOptions<T>;
+}
+export interface LocalSearch<T> extends Bloodhound.BloodhoundOptions<T> {
+    local: T[] | (() => T[]);
+}
+export declare type TypeaheadDataSource<T> = Bloodhound<T> | ((query: string, syncResults: (result: T[]) => void, asyncResults?: (result: T[]) => void) => void);
+export interface InstantSearchBloodhound<T> {
+    bloodhound: TypeaheadDataSource<T>;
+    name: string;
+}
+export declare type TypeaheadConfig<T> = Twitter.Typeahead.Dataset<T>;
+export interface TypeaheadConfigHandler<T> {
+    (source?: InstantSearchBloodhound<T>, index?: number, options?: ObjectHash): Twitter.Typeahead.Dataset<T>;
+}
+export interface BloodhoundConfigHandler<T> {
+    (source: string, options?: ObjectHash): LocalSearch<T> | RemoteSearch<T>;
+}
+export interface TypeaheadSourceItem<T> {
+    name: string;
+    typeaheadConfig: TypeaheadConfigHandler<T>;
+    bloodhoundConfig?: BloodhoundConfigHandler<T>;
+    options?: ObjectHash;
+}

package/dist/libs/shared/src/apps/search/interfaces/index.d.ts

@@ -0,0 +1 @@
+export * from './SearchTypes';