@clickview/library-editor 1.1.13-rc.1 → 1.1.13

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

@@ -0,0 +1,15 @@
+import { ObjectHash } from 'backbone';
+import { Core } from '@clickview/common';
+export declare class VideoSearchResultComponent extends Core.Component<any> {
+    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/src/apps/search/components/search-context/SearchContextComponent.d.ts

@@ -0,0 +1,18 @@
+import { ObjectHash } from 'backbone';
+import { Core } from '@clickview/common';
+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/src/apps/search/components/search-tips/SearchTipsComponent.d.ts

@@ -0,0 +1,11 @@
+import { ObjectHash } from 'backbone';
+import { Core } from '@clickview/common';
+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/src/apps/search/services/ContextualSearchService.d.ts

@@ -0,0 +1,37 @@
+import { Core } from '@clickview/common';
+export interface SearchContext {
+    appLink: Core.AppLink;
+    searchTag: string;
+    title?: string;
+    filterParam: string;
+    filterValue?: string;
+    setFilterValue: (context: SearchContext, self: any) => void;
+}
+declare class StaticContextualSearchService extends Core.Service {
+    private static instance;
+    private searchContext;
+    static get Instance(): StaticContextualSearchService;
+    initialize(): void;
+    get name(): string;
+    get lang(): string;
+    getSearchContext(): Core.Model;
+    /**
+     * Event listeners
+     */
+    private onRouteChange;
+    private onTypeaheadToggle;
+    /**
+     * Context mutation methods
+     */
+    private setSearchContext;
+    private updateSearchContext;
+    private setFilterValue;
+    private resetSearchContext;
+    /**
+     * Validation methods
+     */
+    private isValidSearchContext;
+    private inSearchView;
+}
+export declare const ContextualSearchService: StaticContextualSearchService;
+export {};

package/dist/src/apps/search/views/search-bar/SearchBarView.d.ts

@@ -0,0 +1,102 @@
+import { ObjectHash } from 'backbone';
+import { Core } from '@clickview/common';
+export interface SearchBarViewOptions extends Core.ViewOptions {
+    showRecentSearch?: boolean;
+}
+export declare class SearchBarView extends Core.View {
+    protected options: SearchBarViewOptions;
+    private currentUser;
+    private libraryCollection;
+    private storageHelper;
+    private recentSearchEngine;
+    private viewCache;
+    private searchInput;
+    private searchContext;
+    private preventToggleEvent;
+    constructor(options: SearchBarViewOptions);
+    initialize(): void;
+    get name(): string;
+    get title(): boolean;
+    get tagName(): string;
+    get template(): any;
+    get lang(): string;
+    get channelName(): string;
+    get className(): string;
+    get defaults(): ObjectHash;
+    get elements(): ObjectHash;
+    events(): ObjectHash;
+    get bindings(): ObjectHash;
+    regions(): ObjectHash;
+    private get recentSearchKey();
+    private bindListeners;
+    /**
+     * View Cache management
+     */
+    private getOrCacheView;
+    private clearViewCache;
+    private getDynamicTemplate;
+    private getLimits;
+    /**
+     * Recent search logic
+     */
+    private updateSearchHistory;
+    private handleRecentSearch;
+    private onDeleteRecentSearch;
+    private getInstantSearchAppLink;
+    /**
+     * Typeahead event handlers
+     */
+    private onTypeaheadSelect;
+    private onClickSearch;
+    private onSubmit;
+    private submitQuery;
+    private resetQuery;
+    private updateInitialQuery;
+    private logSearch;
+    /**
+    * When the user clicks away from the typeahead, the close event will be fired, unbinding the delete
+    * event for recent search. Re-selecting the typehead will open it BUT it won't re-fetch the results and
+    * render event won't be fired. We need to manually re-bind the click handlers to ensure the delete
+    * functionality is retained.
+    */
+    private onTypeaheadOpen;
+    private onBeforeTypeaheadClose;
+    private onTypeaheadClose;
+    private showMask;
+    private hideMask;
+    private alignTypeahead;
+    private onTypeaheadRender;
+    private initTypeaheadListeners;
+    private initNoLibrariesTypeaheadListeners;
+    private onKeydown;
+    private onResetSearchContext;
+    /**
+     * Bloodhound & Typeadhead configs
+     */
+    private getRecentSearchBloodhound;
+    private getDynamicBloodhoundConfig;
+    private getDynamicTypeaheadConfig;
+    private getDynamicOptions;
+    /**
+     * Typeahead sources
+     */
+    private getRecentSearchSources;
+    private getDirectSearchSources;
+    private getDynamicSearchSources;
+    private getSources;
+    private getNoLibrariesSource;
+    private initializeTypeahead;
+    private hasLibraries;
+    private getLibraryIds;
+    /**
+     * Render methods
+     */
+    viewOptions(): ObjectHash;
+    get requiredResources(): Core.RequiredResourceHash;
+    private renderSearchTips;
+    private renderSearch;
+    private renderPartialSearch;
+    private renderSearchContext;
+    onRender(): void;
+    onClose(): void;
+}

package/dist/src/apps/search/views/search-bar/templates/index.d.ts

@@ -0,0 +1,9 @@
+import FolderResult from './FolderResult.hbs';
+import DirectSearchResult from './DirectSearchResult.hbs';
+import Loading from './Loading.hbs';
+import NotFound from './NotFound.hbs';
+import ResultFooter from './ResultFooter.hbs';
+import ResultHeader from './ResultHeader.hbs';
+import RecentSearchHeader from './RecentSearchHeader.hbs';
+import NoLibraries from './NoLibraries.hbs';
+export { FolderResult, DirectSearchResult, Loading, NotFound, ResultFooter, ResultHeader, RecentSearchHeader, NoLibraries };

package/dist/src/apps/upload/enums/FileLifestyle.d.ts

@@ -0,0 +1,4 @@
+export declare enum FileLifestyle {
+    Permanent = 0,
+    Temporary = 1
+}

package/dist/src/apps/upload/enums/PendingItemStatus.d.ts

@@ -0,0 +1,5 @@
+export declare enum PendingItemStatus {
+    Error = -1,
+    Processing = 1,
+    Completed = 2
+}

package/dist/src/apps/upload/errors/internet-connectivity/InternetConnectivityError.d.ts

@@ -0,0 +1,7 @@
+import { DialogError } from "../../../../shared/errors/primitives";
+import { DialogViewOptions } from "../../../../shared/components";
+export declare class InternetConnectivityError extends DialogError {
+    constructor();
+    get name(): string;
+    get dialogOptions(): DialogViewOptions;
+}

package/dist/src/apps/upload/services/DropzoneWrapper.d.ts

@@ -0,0 +1,30 @@
+import * as Dropzone from 'dropzone';
+import { Core } from '@clickview/common';
+export interface UploadApiWrapperOptions extends Core.ServiceOptions {
+    maxFileSize: number;
+    chunkSize: number;
+    chunkingEnabled: boolean;
+    loggingEnabled: boolean;
+    acceptedFiles: string;
+    channelName: string;
+}
+export interface UploadApiWrapper {
+    addFile(file: File): void;
+    destroy(): void;
+    start(): void;
+    getId(file: File): string;
+    removeFile(file: File): void;
+}
+export declare class DropzoneWrapper extends Core.Service implements UploadApiWrapper {
+    private dropzone;
+    options: UploadApiWrapperOptions;
+    get name(): string;
+    constructor(options: UploadApiWrapperOptions);
+    initialize(options: UploadApiWrapperOptions): void;
+    getId(file: File): string;
+    addFile(file: Dropzone.DropzoneFile): void;
+    removeFile(file: Dropzone.DropzoneFile): void;
+    start(): void;
+    destroy(): void;
+    static isValidFile(file: File, acceptedFiles: string): boolean;
+}

package/dist/src/apps/upload/services/UploadService.d.ts

@@ -0,0 +1,64 @@
+import { Core } from '@clickview/common';
+import { FileLifestyle } from '../enums/FileLifestyle';
+interface UploadItem extends Core.Model {
+    file: File;
+    name: string;
+    progress: number;
+}
+export declare enum UploadType {
+    Video = 0,
+    LearningResource = 1,
+    Subtitle = 2
+}
+declare class UploadService extends Core.Service {
+    protected uploadType: UploadType;
+    protected fileLifestyle: FileLifestyle;
+    private uploader;
+    private progressViewModel;
+    private uploadDataService;
+    private collection;
+    initialize(): void;
+    get channelName(): string;
+    get lang(): string;
+    /**
+     * Dropzone is initialized once after the first upload is requested and it's chunk size
+     * is set for the rest of the uploads. If we happen to have multiple ingest
+     * servers that have different chunk max / min sizes, this may voilate those
+     * sizes.
+     */
+    private initUploader;
+    private bindListeners;
+    private onProgress;
+    isUploading(): boolean;
+    getCollection(): Core.Collection<UploadItem>;
+    setOverallProgress(): void;
+    isValidFile(file: File): boolean;
+    /**
+     * Request uploads from fileApi and starts uploading.
+     * @param files Array of browser File objects
+     * @returns Returns false if any of the files did not match the accepted file list.
+     */
+    addFiles(files: File[]): void;
+    private requestUploads;
+    addFile(file: File): void;
+    cancelUpload(id: string): void;
+    private onSuccess;
+    cancelAllUploads(): void;
+    private getAcceptedFiles;
+}
+export declare class VideoUploadService extends UploadService {
+    protected get uploadType(): UploadType;
+    get name(): string;
+    get fileLifestyle(): FileLifestyle;
+}
+export declare class SubtitleUploadService extends UploadService {
+    protected get uploadType(): UploadType;
+    get name(): string;
+    get fileLifestyle(): FileLifestyle;
+}
+export declare class LearningResourceUploadService extends UploadService {
+    protected get uploadType(): UploadType;
+    get name(): string;
+    get fileLifestyle(): FileLifestyle;
+}
+export {};

package/dist/src/apps/upload/utils/PendingItemsHelper.d.ts

@@ -0,0 +1,9 @@
+import { Core } from '@clickview/common';
+declare const PendingItemsHelper: {
+    getStatus(model: Core.Model): string;
+    hasError(model: Core.Model): boolean;
+    isDone(model: Core.Model): boolean;
+    getProgress(model: Core.Model): number;
+    hasExpired(model: Core.Model, maxSessionLength: number): boolean;
+};
+export { PendingItemsHelper };

package/dist/src/apps/upload/utils/index.d.ts

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

package/dist/src/shared/behaviors/empty-state/EmptyStateBehavior.d.ts

@@ -0,0 +1,22 @@
+import { ObjectHash } from 'backbone';
+import { Core } from '@clickview/common';
+import { EmptyStateComponentOptions, EmptyStateComponent } from "../../components";
+interface EmptyStateBehaviorOptions {
+    region: string;
+    type: number;
+    shouldRender: () => boolean;
+    componentOptions?: EmptyStateComponentOptions;
+    emptyStateComponents: {
+        [type: number]: (self: any) => EmptyStateComponentOptions;
+    };
+}
+export declare class EmptyStateBehavior extends Core.Behavior {
+    options: EmptyStateBehaviorOptions;
+    get defaults(): ObjectHash;
+    set defaults(defaults: ObjectHash);
+    private shouldRender;
+    getComponent(): EmptyStateComponent;
+    renderEmptyState(): void;
+    onRender(): void;
+}
+export {};

package/dist/src/shared/behaviors/popover/PopoverBehavior.d.ts

@@ -0,0 +1,40 @@
+import { ObjectHash } from 'backbone';
+import { Core } from '@clickview/common';
+export declare enum PopoverPlacement {
+    auto = "auto",
+    top = "top",
+    bottom = "bottom",
+    left = "left",
+    right = "right"
+}
+export declare type PopoverSize = 'popover-sm' | 'popover-md' | 'popover-lg';
+export interface PopoverBehaviorOptions {
+    toggleEventName?: string;
+    renderContent: (region: string) => void;
+    placement?: PopoverPlacement;
+    title?: string;
+    containerSelector?: string;
+    size?: PopoverSize;
+    boundary?: any;
+    customClasses?: string;
+}
+export declare class PopoverBehavior extends Core.Behavior {
+    options: PopoverBehaviorOptions;
+    private popoverInitialized;
+    get defaults(): ObjectHash;
+    set defaults(defaults: ObjectHash);
+    get ui(): ObjectHash;
+    set ui(ui: ObjectHash);
+    events(): ObjectHash;
+    private bindListeners;
+    private bindBodyClickListener;
+    private bindDropdownListener;
+    private onPopoverInserted;
+    private onPopoverHidden;
+    private toggle;
+    private hide;
+    private onClickPopover;
+    private onClickOutside;
+    private getTrigger;
+    private onAttach;
+}

package/dist/src/shared/behaviors/tooltip/TooltipBehavior.d.ts

@@ -0,0 +1,12 @@
+import { ObjectHash } from 'backbone';
+import { Core } from '@clickview/common';
+export declare class TooltipBehavior extends Core.Behavior {
+    get defaults(): ObjectHash;
+    set defaults(defaults: ObjectHash);
+    get ui(): ObjectHash;
+    set ui(ui: ObjectHash);
+    private getElement;
+    private getOptions;
+    onRender(): void;
+    onBeforeDetach(): void;
+}

package/dist/src/shared/collections/PendingItemsCollection.d.ts

@@ -0,0 +1,8 @@
+import { Core } from '@clickview/common';
+declare class PendingItem extends Core.Model {
+    get idAttribute(): string;
+}
+export declare class PendingItemsCollection extends Core.Collection {
+    get model(): typeof PendingItem;
+}
+export {};

package/dist/src/shared/components/empty-state/EmptyStateComponent.d.ts

@@ -0,0 +1,24 @@
+import { ObjectHash } from 'backbone';
+import { Core } from '@clickview/common';
+export declare type EmptyStateImageSize = 'sm' | 'lg';
+export interface EmptyStateComponentOptions extends Core.ComponentOptions {
+    imageUrl: string;
+    heading?: string | (() => string);
+    description?: string | (() => string);
+    appLink?: Core.AppLinkHash;
+    customClass?: string;
+    customImageClass?: string;
+}
+export declare class EmptyStateComponent extends Core.Component {
+    protected options: EmptyStateComponentOptions;
+    constructor(options: EmptyStateComponentOptions);
+    get name(): string;
+    get className(): string;
+    get template(): string;
+    get defaults(): ObjectHash;
+    get appLinks(): Core.AppLinkHash;
+    private getImageClass;
+    private getHeading;
+    private getDescription;
+    viewOptions(): ObjectHash;
+}

package/dist/src/shared/components/pagination/PaginationComponent.d.ts

@@ -0,0 +1,28 @@
+import { ObjectHash } from 'backbone';
+import { Core, Cursors } from '@clickview/common';
+import { AnalyticsOptions } from '@clickview/analytics';
+interface PaginationComponentOptions extends Core.ComponentOptions {
+    cursors: Cursors;
+    appLink: Core.AppLink;
+    collectionId?: string;
+    allowFirstPageCursor?: boolean;
+    analyticsOptions?: AnalyticsOptions;
+    cursorParamName?: string;
+}
+export declare class PaginationComponent extends Core.Component {
+    options: PaginationComponentOptions;
+    constructor(options: PaginationComponentOptions);
+    get defaults(): ObjectHash;
+    get name(): string;
+    get template(): any;
+    get lang(): string;
+    get appLinks(): Core.AppLinkHash;
+    events(): ObjectHash;
+    private buildCursor;
+    private onClickPrevious;
+    private onClickNext;
+    private logAction;
+    viewOptions(): ObjectHash;
+    onBeforeRender(): boolean;
+}
+export {};

package/dist/src/shared/components/thumbnail/ThumbnailComponent.d.ts

@@ -0,0 +1,32 @@
+import { ObjectHash } from 'backbone';
+import { Core } from '@clickview/common';
+import { Video } from "../../models";
+import { ImageOptions } from "../../utils";
+export interface ThumbnailComponentOptions extends Core.ComponentOptions {
+    model: Video;
+    onClickHandler?: Function;
+    thumbnailOptions?: ImageOptions;
+    playIcon?: boolean;
+    lazyload?: boolean;
+    appLink?: Core.AppLink;
+    href?: string;
+    channelName?: string;
+}
+export declare class ThumbnailComponent extends Core.Component<Video> {
+    protected options: ThumbnailComponentOptions;
+    constructor(options: ThumbnailComponentOptions);
+    initialize(): void;
+    get name(): string;
+    get template(): string;
+    get tagName(): string;
+    get className(): string;
+    get elements(): ObjectHash;
+    events(): ObjectHash;
+    get appLinks(): Core.AppLinkHash;
+    get attributes(): ObjectHash;
+    private showPlayIcon;
+    private onClick;
+    private onImageLoad;
+    viewOptions(): ObjectHash;
+    onRender(): void;
+}

package/dist/src/shared/enums/AppLinkReferrer.d.ts

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

package/dist/src/shared/enums/CurationStatus.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This enum maps directly to the CurationStatus enum in the
+ * NuGet package ClickView.Models from master.
+ */
+export declare enum CurationStatus {
+    Draft = 0,
+    Published = 1,
+    Archive = 2,
+    Pending = 3,
+    Rejected = 4,
+    Processing = 5
+}

package/dist/src/shared/errors/file-type/FileTypeError.d.ts

@@ -0,0 +1,15 @@
+import { DialogError } from "../primitives";
+import { DialogViewOptions } from "../../components";
+/**
+ * TODO: Create a more useful message here.
+ * Perhaps using the mime types listen on MDN
+ * https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Complete_list_of_MIME_types
+ * or in the list of all the official mime types
+ * https://www.iana.org/assignments/media-types/media-types.xhtml
+ */
+export declare class FileTypeError extends DialogError {
+    constructor(message: string, files: File[], acceptedFiles: string);
+    get name(): string;
+    get lang(): string;
+    get dialogOptions(): DialogViewOptions;
+}

package/dist/src/shared/errors/primitives/AlertError.d.ts

@@ -0,0 +1,4 @@
+import { Core } from '@clickview/common';
+export declare class AlertError extends Core.SilentError {
+    get name(): string;
+}

package/dist/src/shared/errors/primitives/DialogError.d.ts

@@ -0,0 +1,9 @@
+import { Core } from '@clickview/common';
+import { DialogViewOptions } from "../../components";
+export declare abstract class DialogError extends Core.SilentError {
+    dialogOptions: DialogViewOptions;
+    constructor(message: string);
+    get name(): string;
+    onDone(): void;
+    onFail(): void;
+}

package/dist/src/shared/errors/primitives/ErrorPageError.d.ts

@@ -0,0 +1,7 @@
+import { Core } from '@clickview/common';
+export declare abstract class ErrorPageError extends Core.SilentError {
+    heading: string;
+    description: string;
+    appLink?: Core.AppLinkHash;
+    get name(): string;
+}

package/dist/src/shared/errors/primitives/index.d.ts

@@ -0,0 +1,3 @@
+export * from './AlertError';
+export * from './DialogError';
+export * from './ErrorPageError';

package/dist/src/shared/interfaces/CollectionIdentifier.d.ts

@@ -0,0 +1,7 @@
+import { BaseCollectionIdentifier, BaseCollectionIdentifierOptions } from '@clickview/common';
+import { SortType } from "../enums";
+export interface CollectionIdentifierOptions extends BaseCollectionIdentifierOptions<SortType> {
+}
+export declare class CollectionIdentifier extends BaseCollectionIdentifier<SortType> {
+    protected getSortTypeParam(): string;
+}

package/dist/src/shared/interfaces/Tooltip.d.ts

@@ -0,0 +1,6 @@
+export declare type TooltipPlacement = 'auto' | 'top' | 'bottom' | 'left' | 'right';
+export interface TooltipOptions {
+    selector?: string;
+    title?: string;
+    placement?: TooltipPlacement;
+}

package/dist/src/shared/services/ContextService.d.ts

@@ -0,0 +1,38 @@
+import { Core } from '@clickview/common';
+interface ApplicationContext {
+    pageLoad: boolean;
+    appLink: Core.AppLink;
+}
+export interface AppContextServiceOptions {
+}
+export declare class StaticContextService extends Core.Service {
+    private static instance;
+    private routeHistory;
+    private contextHistory;
+    get name(): string;
+    static get Instance(): StaticContextService;
+    initialize(): void;
+    /**
+     * Context specific methods.
+     * The Context History keeps track of ALL APPLINKS.
+     */
+    private setContext;
+    getCurrentContext(): ApplicationContext;
+    getPreviousContext(): ApplicationContext;
+    /**
+     * Route specific methods.
+     * The Route History works the same way as the Context History, except
+     * it will ONLY take applinks that change the route. This is useful
+     * for things like tracking state for in-application back buttons where we
+     * would not be interested in applinks that do not map to routes.
+     */
+    private updateRouteHistory;
+    getCurrentRoute(): ApplicationContext;
+    getPreviousRoute(): ApplicationContext;
+    /**
+     * Other utilities
+     */
+    fromPageLoad(): boolean;
+}
+export declare const ContextService: StaticContextService;
+export {};

package/dist/src/shared/services/LanguageDataService.d.ts

@@ -0,0 +1,12 @@
+import { ObjectHash } from 'backbone';
+import { BaseDataService } from '@clickview/common';
+interface LanguageConfig {
+    locale: string;
+    phrases: ObjectHash;
+}
+export declare class LanguageDataService extends BaseDataService {
+    get name(): string;
+    get channelName(): string;
+    getLanguageConfig(callback?: (languageConfig: LanguageConfig) => void): void;
+}
+export {};

package/dist/src/shared/services/LanguageService.d.ts

@@ -0,0 +1,16 @@
+import { Core } from '@clickview/common';
+import { LanguageConfig } from "../models/LanguageConfig";
+interface LanguageInterpolationOptions {
+    smartCount?: number;
+    [propName: string]: any;
+}
+declare class StaticLanguageService extends Core.Service {
+    private static instance;
+    private polyglot;
+    static get Instance(): StaticLanguageService;
+    get name(): string;
+    setConfig(config: LanguageConfig): void;
+    getPhrase(namespace: string, phraseKey: string, options?: LanguageInterpolationOptions): string;
+}
+export declare const LanguageService: StaticLanguageService;
+export {};

package/dist/src/shared/utils/EmptyStateHelper.d.ts

@@ -0,0 +1,4 @@
+import { Core } from '@clickview/common';
+export declare const EmptyStateHelper: {
+    isCollectionEmpty(view: Core.View<Core.Model>, collectionName?: string): boolean;
+};