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

package/dist/libs/shared/src/apps/search/services/ContextualSearchService.d.ts

@@ -0,0 +1,34 @@
+import { Core } from "../../../../../common/src/backbone";
+export interface SearchContext {
+    appLink: Core.AppLink;
+    searchTag: string;
+    title?: string;
+    filterParam: string;
+    filterValue?: string;
+    setFilterValue: (context: SearchContext, self: any) => void;
+}
+export declare class ContextualSearchService extends Core.Service {
+    private searchContext;
+    private appVariables;
+    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;
+}

package/dist/libs/shared/src/apps/search/utils/InstantSearchHelper.d.ts

@@ -0,0 +1,22 @@
+/// <reference types="jquery" />
+import { ObjectHash } from 'backbone';
+import { RemoteSearch } from "../interfaces";
+/**
+ * Specific logic for processing responses from domain v1/search/instant endpoint
+ */
+export declare const InstantSearchHelper: {
+    prepareQuery: (query: string, settings: JQueryAjaxSettings, options?: ObjectHash) => string;
+    bloodhoundConfig(source: string, options: ObjectHash): RemoteSearch<any>;
+    handleResult(data: ObjectHash, item: any, options?: ObjectHash): any[];
+    processSubjectResult(collection: any[], item: any, options: ObjectHash): any[];
+    processVideoResult(collection: any[], item: any, options: ObjectHash): any[];
+    processTagsResult(collection: any[], item: any, options: ObjectHash): any[];
+    processSeriesResult(collection: any[], item: any, options: ObjectHash): any[];
+    processFolderResult(collection: any[], item: any, options?: ObjectHash): any[];
+    /**
+     * Manipulate
+     * @param collection
+     * @param options
+     */
+    processCollection(collection: any[], options?: ObjectHash): any[];
+};

package/dist/libs/shared/src/apps/search/utils/RecentSearchHelper.d.ts

@@ -0,0 +1,12 @@
+import { StorageHelper } from "../../../../../common/src/backbone/utils/LocalStorageHelper";
+export interface UpdateRecentSearchOptions<T> {
+    query: T;
+    add?: boolean;
+    remove?: boolean;
+    limit?: number;
+}
+export declare const RecentSearchHelper: {
+    getRecentSearches<T>(key: string, dataSource: StorageHelper): T[];
+    setRecentSearches<T_1>(key: string, recentSearches: T_1[], dataSource: StorageHelper): void;
+    updateRecentSearches<T_2>(key: string, dataSource: StorageHelper, options: UpdateRecentSearchOptions<T_2>): T_2[];
+};

package/dist/libs/shared/src/apps/search/utils/SearchHelper.d.ts

@@ -0,0 +1,5 @@
+import { Core } from "../../../../../common/src/backbone";
+import { HashObject } from "../../../../../common/src/react/interfaces/HashObject";
+export declare const SearchHelper: {
+    getContextualSearchQueryParams(context: Core.Model): HashObject<any>;
+};

package/dist/libs/shared/src/apps/search/utils/TypeaheadHelper.d.ts

@@ -0,0 +1,75 @@
+/// <reference types="typeahead" />
+/// <reference types="jquery" />
+import { ObjectHash } from 'backbone';
+import * as Bloodhound from 'bloodhound';
+import { TypeaheadDataSource, LocalSearch, RemoteSearch, TypeaheadConfig, TypeaheadSourceItem } from "../interfaces";
+export declare const TypeaheadHelper: {
+    /**
+    * This function will only allow our typeahead to fetch results when we
+    * have exceeded our min length. The reason for doing this is that we want to the typeahead
+    * to load our recent searches immediately when we click the input, but before we perform any searches. - Mike
+    */
+    handleQuery<T>(dataSource?: TypeaheadDataSource<T>, options?: ObjectHash): TypeaheadDataSource<T>;
+    /**
+     * This function complements HandleQuery allowing us to override when and how typeahead templates are
+     * rendered. When the query doesn't meet our min length we will render a fallback template, which is
+     * essentially just an empty div. This is necessary to ensure we can display recent searchs when the
+     * typeahead is active (but less than the require length to trigger the search functionality). As we are
+     * dynamically generating the results for videos, folders and series we are deliberately using a closure
+     * to ensure we don't lose our template.
+     *
+     * It must also return <any> as the typeahead typings are shit.
+     * - Mike
+     */
+    getTemplate(template: Function, options?: ObjectHash): any;
+    /**
+     * Provides mechanism to map a single search query against multiple bloodhound sources.
+     * Sources may be remote endpoints or local in-memory collections.
+     * @param sources
+     * @param options
+     */
+    getSearchSources<T_1>(sources: TypeaheadSourceItem<T_1>[]): TypeaheadConfig<T_1>[];
+    /**
+     * Bloodhound helper
+     */
+    buildBloodhound<T_2>(options: RemoteSearch<T_2> | LocalSearch<T_2>): Bloodhound<T_2>;
+    /**
+     * This is attached as a callback to the typeahead's render event.
+     * Where there is a real suggestion from the server, we will automatically
+     * set the cursor to that item, to make it simply to add. This is to encourage the
+     * re-use of existing entities.
+     *
+     * Note: With multiple suggestion sets, the render event will also be called multiple times
+     * along with this callback.
+     */
+    selectFirstResult(e: JQueryEventObject, suggestions: any[], async: boolean, dataset: string): void;
+    /**
+    * Callback is designed to be attached to the stickit bindings for the typeahead form
+    * and emit events when a change is detected on the bound model. We do this to be
+    * able to detect whether an input has cleared from a previous selection,
+    *
+    * @param channelName
+    * @param event
+    */
+    emitEventOnInput(channelName: string, eventName: string, type: string, wrapperOptions?: ObjectHash): Function;
+    /**
+    * I hate this.
+    *
+    * Basically what this function does is curry a callback with the original association's
+    * data. Then, depending on the user's interaction with the typeahead input, it will restore that
+    * data when a blur event is triggered.
+    *
+    * @param data raw clone of original assoc model
+    *
+    * Curried callback
+    * @param channelName
+    * @param propertyName
+    */
+    resetAssociationOnBlur(data: ObjectHash): Function;
+    /**
+     * Create and render ConfirmSelection component for use as a
+     * @param options
+     */
+    getConfirmSelectionTemplate(options?: ObjectHash): Function;
+    clearInputOnBlur(channelName: string): void;
+};

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

@@ -0,0 +1,107 @@
+import { ObjectHash } from 'backbone';
+import { Core } from "../../../../../../common/src/backbone";
+export interface SearchBarViewOptions extends Core.ViewOptions {
+    showRecentSearch?: boolean;
+    disableMask?: boolean;
+    presentationId?: string;
+}
+export declare class SearchBarView extends Core.View {
+    protected options: SearchBarViewOptions;
+    private contextualSearchService;
+    private appVariables;
+    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 getConfigName;
+    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/libs/shared/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/libs/shared/src/apps/upload/collections/PendingItemsCollection.d.ts

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

package/dist/libs/shared/src/apps/upload/constants/UploadConstants.d.ts

@@ -0,0 +1,39 @@
+export declare const UploadEventNames: {
+    /**
+     * This is fired when a file has finished uploading to file API. This event
+     * has nothing to do with posting the uploaded resource to the respective repository.
+     */
+    UPLOAD_COMPLETE: string;
+    /**
+     * This is trigged when files are selected
+     * from either the FileSelectBehavior or the FileDropBehavior
+     */
+    FILES_SELECTED: string;
+    /**
+     * This triggered by the upload service when it received ingest urls for all
+     * the files added via a call to UploadService.addFiles(files: File[])
+     */
+    FILES_ADDED: string;
+    /**
+     * This is fired when the user cancels their own upload
+     */
+    UPLOAD_CANCELLED: string;
+    /**
+     * Name is self explanitory. This is only used internally by children
+     * of BasePendingItemsService at the moment
+     */
+    PENDING_ITEM_READY_TO_WATCH: string;
+    /**
+     * Fired when we know that the pending items in args has changed status
+     * or that it's foreground progress has been completed.
+     */
+    PENDING_ITEM_STATUS_CHANGE: string;
+    /**
+     * This is fired when the user cancels processing a recently uploaded video
+     */
+    PROCESSING_CANCELLED: string;
+    /**
+     * Fired when all uploads are finished or when uploading is cancelled. Unlocks navigation
+     */
+    UNLOCK_NAV: string;
+};

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

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

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

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

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

@@ -0,0 +1,15 @@
+import { DialogError } from "../../../../errors/primitives/DialogError";
+import { DialogOptions } from "../../../../interfaces";
+/**
+ * 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(): DialogOptions;
+}

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

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

package/dist/libs/shared/src/apps/upload/services/BasePendingItemsService.d.ts

@@ -0,0 +1,26 @@
+import { Core } from "../../../../../common/src/backbone";
+interface FetchPendingItemsOptions {
+    resetTimeout: boolean;
+    callback?: () => void;
+}
+export declare class BasePendingItemsService extends Core.Service {
+    private pendingItems;
+    private videoDataService;
+    private videoUploadDataService;
+    get name(): string;
+    get channelName(): string;
+    initialize(): void;
+    clearPendingItem(model: Core.Model, callback?: () => void): void;
+    forceFetchPendingItems(options?: FetchPendingItemsOptions): void;
+    retryPendingItem(model: Core.Model, callback?: () => void): void;
+    private itemStatusChanged;
+    getPendingItems(): Core.Collection;
+    private fetchPendingItems;
+    private updateViewModel;
+    /**
+     * Fetch every 5 seconds if any items are processing,
+     * otherwise fetch every 30 seconds.
+     */
+    private getTimeoutLength;
+}
+export {};

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

@@ -0,0 +1,30 @@
+import * as Dropzone from 'dropzone';
+import { Core } from "../../../../../common/src/backbone";
+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/libs/shared/src/apps/upload/services/UploadService.d.ts

@@ -0,0 +1,66 @@
+import { Core } from "../../../../../common/src/backbone";
+import { FileLifestyle } from "../enums/FileLifestyle";
+import { UploadApiWrapper } from './DropzoneWrapper';
+import { AnalyticsOptions } from "../../../../../analytics/src/interfaces";
+export 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;
+    protected uploader: UploadApiWrapper;
+    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[], analyticsOptions?: AnalyticsOptions): void;
+    private requestUploads;
+    addFile(file: File, analyticsOptions: AnalyticsOptions): void;
+    cancelUpload(id: string): void;
+    protected onSuccess(file: File, response: any): void;
+    cancelAllUploads(): void;
+    protected getAcceptedFiles(): string;
+}
+export declare class BaseVideoUploadService 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/libs/shared/src/apps/upload/utils/FileExtensionsHelper.d.ts

@@ -0,0 +1,9 @@
+declare const FileExtensions: {
+    IMAGES: string;
+    RESOURCES: string;
+    SUBTITLES: string;
+};
+declare const FileExtensionHelper: {
+    getResourceType(extension: string): string;
+};
+export { FileExtensions, FileExtensionHelper };

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

@@ -0,0 +1,9 @@
+import { Core } from "../../../../../common/src/backbone";
+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/libs/shared/src/constants/AppVariables.d.ts

@@ -0,0 +1,4 @@
+export declare const AppVariables: {
+    SEARCH: string;
+    NOTIFICATIONS: string;
+};

package/dist/libs/shared/src/constants/BootstrapKeys.d.ts

@@ -0,0 +1,6 @@
+declare const BootstrapKeys: {
+    LOCALE: string;
+    PHRASES: string;
+    VERSION: string;
+};
+export { BootstrapKeys };

package/dist/libs/shared/src/constants/DataPrefixes.d.ts

@@ -0,0 +1,12 @@
+export declare const SharedDataPrefixes: {
+    SUBJECT_PLAYLISTS: string;
+    CURRENT_USER: string;
+    WORKSPACE: string;
+    CONFIG: string;
+    LOCALE: string;
+    PHRASES: string;
+    SEARCH_FILTERS: string;
+    SERIES: string;
+    NOTIFICATIONS: string;
+    SUGGEST_EDIT: string;
+};

package/dist/libs/shared/src/constants/RadioChannels.d.ts

@@ -0,0 +1,20 @@
+export declare const SharedDataChannels: {
+    CONFIG: string;
+    USER: string;
+    LANGUAGE: string;
+    LIBRARY: string;
+    SEARCH: string;
+    SERIES: string;
+    NOTIFICATIONS: string;
+    NOTIFICATIONS_SOCKET: string;
+};
+export declare const SharedServiceChannels: {
+    PENDING_ITEMS: string;
+    VIDEO_UPLOAD: string;
+    SUBTITLE_UPLOAD: string;
+    RESOURCE_UPLOAD: string;
+    CONTEXTUAL_SEARCH: string;
+};
+export declare const SharedAppChannels: {
+    NOTIFICATIONS: string;
+};

package/dist/libs/shared/src/constants/SharedServices.d.ts

@@ -0,0 +1,25 @@
+export declare const SharedDataServices: {
+    Config: string;
+    User: string;
+    Language: string;
+    Video: string;
+    VideoUpload: string;
+    Library: string;
+    Search: string;
+    Series: string;
+    Notification: string;
+    NotificationSocket: string;
+};
+export declare const SharedServices: {
+    ImageUrl: string;
+    PendingItems: string;
+    Alerts: string;
+    VideoUpload: string;
+    ResourceUpload: string;
+    SubtitleUpload: string;
+    VideoMixin: string;
+    ContextualSearch: string;
+    Context: string;
+    Notification: string;
+    AppOptions: string;
+};

package/dist/libs/shared/src/enums/ClassificationType.d.ts

@@ -0,0 +1,4 @@
+export declare enum ClassificationType {
+    Subject = "Subject",
+    Topic = "Topic"
+}

package/dist/libs/shared/src/enums/CountryCode.d.ts

@@ -0,0 +1,5 @@
+export declare enum CountryCode {
+    AU = "au",
+    NZ = "nz",
+    UK = "uk"
+}

package/dist/libs/shared/src/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/libs/shared/src/enums/CustomerType.d.ts

@@ -0,0 +1,11 @@
+export declare enum CustomerType {
+    Unclassified = 0,
+    Primary = 1,
+    Secondary = 2,
+    K12 = 3,
+    Tertiary = 4,
+    NonEducational = 5,
+    Partners = 6,
+    Internal = 7,
+    Other = 8
+}

package/dist/libs/shared/src/enums/GlanceFormat.d.ts

@@ -0,0 +1,3 @@
+export declare enum GlanceFormat {
+    Markdown = "text/markdown"
+}

package/dist/libs/shared/src/enums/Images.d.ts

@@ -0,0 +1,26 @@
+export declare enum ImageSize {
+    Small = "small",
+    Medium = "medium",
+    Large = "large"
+}
+export declare enum ImageType {
+    Thumbnails = 0,
+    Banners = 1,
+    Avatars = 2,
+    Logos = 3,
+    Covers = 4,
+    Posters = 5,
+    TallPosters = 6,
+    HeroBanners = 7
+}
+export declare enum ResizeType {
+    Crop = 0,
+    Stretched = 1,
+    Cover = 2
+}
+export declare enum FileIdType {
+    None = 0,
+    ImageAPIv1 = 1,
+    FileAPIv1 = 2,
+    ImageAPIv2 = 3
+}

package/dist/libs/shared/src/enums/LibraryType.d.ts

@@ -0,0 +1,5 @@
+export declare enum LibraryType {
+    HostedLibrary = 0,
+    Exchange = 1,
+    MoviesAndTvLibrary = 2
+}