@clickview/lite 0.0.17 → 0.0.18-dev.0

package/dist/libs/shared/src/interfaces/services/BaseVideoUploadDataService.d.ts

@@ -0,0 +1,8 @@
+import { Core } from "../../../../common/src/backbone";
+export interface BaseVideoUploadDataService {
+    clearPendingItems(ids: string[], callback?: () => void): void;
+    cancelPendingItems(ids: string[], callback?: () => void): void;
+    retryPendingItems(ids: string[], callback?: () => void): void;
+    getPendingItem(id: string, callback: (item: Core.Model) => void): void;
+    getPendingItems(callback: (items: any[]) => void): void;
+}

package/dist/libs/shared/src/interfaces/services/index.d.ts

@@ -0,0 +1,4 @@
+export * from './BaseVideoDataService';
+export * from './BaseVideoUploadDataService';
+export * from './BaseLibraryDataService';
+export * from './BaseSeriesDataService';

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

@@ -0,0 +1,22 @@
+import { ObjectHash } from 'backbone';
+import { Core } from "../../../../../common/src/backbone";
+import { EmptyStateComponentOptions, EmptyStateComponent } from "../../components/empty-state/EmptyStateComponent";
+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/libs/shared/src/legacy/behaviors/popover/PopoverBehavior.d.ts

@@ -0,0 +1,40 @@
+import { ObjectHash } from 'backbone';
+import { Core } from "../../../../../common/src/backbone";
+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/libs/shared/src/legacy/behaviors/tooltip/TooltipBehavior.d.ts

@@ -0,0 +1,26 @@
+import { ObjectHash } from 'backbone';
+import { Core } from "../../../../../common/src/backbone";
+export declare type TooltipPlacement = 'auto' | 'top' | 'bottom' | 'left' | 'right';
+/**
+ * If a selector is not passed in, the tooltip
+ * will be added to the view's element.
+ *
+ * For multiple tooltips in a single component,
+ * omit the title option and instead add the title
+ * attribute to the elements in the template.
+ */
+export interface TooltipOptions {
+    selector?: string;
+    title?: string;
+    placement?: TooltipPlacement;
+}
+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/libs/shared/src/legacy/components/empty-state/EmptyStateComponent.d.ts

@@ -0,0 +1,24 @@
+import { ObjectHash } from 'backbone';
+import { Core } from "../../../../../common/src/backbone";
+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/libs/shared/src/legacy/components/pagination/PaginationComponent.d.ts

@@ -0,0 +1,29 @@
+import { ObjectHash } from 'backbone';
+import { Core } from "../../../../../common/src/backbone";
+import { Cursors } from "../../../../../common/src/backbone/interfaces";
+import { AnalyticsOptions } from "../../../../../analytics/src/interfaces";
+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/libs/shared/src/legacy/components/thumbnail/ThumbnailComponent.d.ts

@@ -0,0 +1,35 @@
+import { ObjectHash } from 'backbone';
+import { Core } from "../../../../../common/src/backbone";
+import { ImageOptions } from "../../../utils/ImageHelper";
+export interface ThumbnailComponentOptions extends Core.ComponentOptions {
+    model: Core.Model;
+    onClickHandler?: Function;
+    thumbnailOptions?: ImageOptions;
+    playIcon?: boolean;
+    lazyload?: boolean;
+    appLink?: Core.AppLink;
+    href?: string;
+    channelName?: string;
+    classNameOverride?: string;
+}
+/**
+ * @Backbone
+ */
+export declare class ThumbnailComponent extends Core.Component {
+    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/libs/shared/src/legacy/constants/empty-state-components/EmptyStateComponents.d.ts

@@ -0,0 +1,6 @@
+import { EmptyStateComponentOptions } from "../../components/empty-state/EmptyStateComponent";
+export interface EmptyStateOptions extends Pick<EmptyStateComponentOptions, Exclude<keyof EmptyStateComponentOptions, 'imageUrl'>> {
+}
+export declare const EmptyStateComponents: {
+    [type: number]: (self: any) => EmptyStateComponentOptions;
+};

package/dist/libs/shared/src/legacy/enums/EmptyState.d.ts

@@ -0,0 +1,3 @@
+export declare enum SharedEmptyState {
+    Notifications = 0
+}

package/dist/libs/shared/src/legacy/enums/SortType.d.ts

@@ -0,0 +1,7 @@
+export declare enum SortType {
+    MostRecent = 1,
+    AtoZ = 2,
+    ProductionYear = 3,
+    Newest = 4,
+    SeriesSort = 5
+}

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

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

package/dist/libs/shared/src/legacy/interfaces/index.d.ts

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

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

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

package/dist/libs/shared/src/legacy/utils/LangHelper.d.ts

@@ -0,0 +1,5 @@
+import * as Handlebars from 'handlebars';
+export declare const LangHelper: {
+    register(): void;
+    isValid(key: string, options: Handlebars.HelperOptions): boolean;
+};

package/dist/libs/shared/src/services/AppOptionsService.d.ts

@@ -0,0 +1,20 @@
+import { CustomerType } from "../enums/CustomerType";
+import { OnlineUserRole } from "../enums/UserRole";
+interface OnlineModules {
+    curriculum: boolean;
+}
+export interface AppOptions {
+    onlineModules?: OnlineModules;
+    customerType: CustomerType;
+    onlineRole: OnlineUserRole;
+}
+export declare class AppOptionsService {
+    private options;
+    constructor(options: AppOptions);
+    get name(): string;
+    get hasCurriculum(): boolean;
+    get isTeacher(): boolean;
+    get onlineRole(): OnlineUserRole;
+    get onlineCustomerType(): CustomerType;
+}
+export {};

package/dist/libs/shared/src/services/ConfigDataService.d.ts

@@ -0,0 +1,12 @@
+import { FetchOptions } from "../../../common/src/react/utils/FetchHelper";
+import { BaseDataService } from "../../../common/src/backbone/services/BaseDataService";
+import { DataServiceError } from "../../../common/src/backbone/interfaces";
+import { Config } from "../interfaces";
+export declare class ConfigDataService extends BaseDataService {
+    get name(): string;
+    get channelName(): string;
+    getConfig(callback?: (Config: Config) => void, errorCallback?: () => void): Config;
+}
+export declare const ConfigDataServiceHelper: {
+    getConfigFetchOptions(setData: (data: Config) => void, onError?: (error: DataServiceError) => void): FetchOptions;
+};

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

@@ -0,0 +1,38 @@
+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 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/libs/shared/src/services/ImageUrlService.d.ts

@@ -0,0 +1,12 @@
+import { Core } from "../../../common/src/backbone";
+import { ImageUrls } from "../interfaces";
+interface ImageUrlServiceOptions extends Core.ServiceOptions {
+    imageUrls: ImageUrls;
+}
+export declare class ImageUrlService extends Core.Service {
+    private imageUrls;
+    constructor(options: ImageUrlServiceOptions);
+    get name(): string;
+    getImageUrls(): ImageUrls;
+}
+export {};

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

@@ -0,0 +1,7 @@
+import { BaseDataService } from "../../../common/src/backbone/services/BaseDataService";
+import { LanguageConfig } from "../interfaces";
+export declare class LanguageDataService extends BaseDataService {
+    get name(): string;
+    get channelName(): string;
+    getLanguageConfig(callback?: (languageConfig: LanguageConfig) => void): void;
+}

package/dist/libs/shared/src/services/UserDataService.d.ts

@@ -0,0 +1,23 @@
+/// <reference types="backbone" />
+/// <reference types="backbone.radio" />
+/// <reference types="backbone.validation" />
+import { FetchOptions } from "../../../common/src/react/utils/FetchHelper";
+import { BaseDataService } from "../../../common/src/backbone/services/BaseDataService";
+import { DataServiceError } from "../../../common/src/backbone/interfaces";
+import { HashObject } from "../../../common/src/react/interfaces/HashObject";
+export declare class UserDataService extends BaseDataService {
+    get name(): string;
+    get channelName(): string;
+    getCurrentUser<T>(callback?: (user: T) => void, errorCallback?: () => void): T;
+    getWorkspace(callback: (workspace: HashObject) => void, errorCallback?: () => void): HashObject;
+}
+export declare const UserDataServiceHelper: {
+    getCurrentUserFetchOptions<T>(setData: (data: T) => void, onError?: (error: DataServiceError) => void): FetchOptions;
+    currentUser: {
+        dataServiceName: string;
+        eventName: string;
+        getData: (instance: UserDataService) => unknown;
+        getInstance: (context: import("backbone").Events) => unknown;
+        beforeOnBeforeRender: boolean;
+    };
+};

package/dist/libs/shared/src/utils/AudienceHelper.d.ts

@@ -0,0 +1,10 @@
+import { Audience, PresentationAudience } from "../interfaces";
+export declare const AudienceHelper: {
+    /**
+     * This is needed to sort an object's audiences, as they are not sorted by the backend.
+     * To do this, we take the presentation audiences (sorted) and filter them by the object's
+     * audiences, leaving behind a sorted array of object audiences.
+     */
+    getSortedPresentationAudiences(objectAudiences: Audience[], presentationAudiences: PresentationAudience[]): PresentationAudience[];
+    getMergedPresentationAudienceString(presentationAudiences: PresentationAudience[]): PresentationAudience;
+};

package/dist/libs/shared/src/utils/DashboardHelper.d.ts

@@ -0,0 +1,9 @@
+import { OnlineUserRole } from "../enums/UserRole";
+import { UserGroup } from "../enums/UserGroup";
+export declare const DashboardHelper: {
+    /**
+     * Same implementation as GetUserGroup() in Online.
+     * @param userRole
+     */
+    getUserGroup(userRole: OnlineUserRole): UserGroup;
+};

package/dist/libs/shared/src/utils/DragHelper.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+export declare const DragHelper: {
+    hideDragImage(event: import("react").DragEvent<HTMLElement>): void;
+};

package/dist/libs/shared/src/utils/DurationHelper.d.ts

@@ -0,0 +1,7 @@
+declare const DurationHelper: {
+    /**
+     * Copypasta from Online. Feel free to improve it if you see fit - Sha
+     */
+    ToDisplayDuration(milliseconds: number): string;
+};
+export { DurationHelper };

package/dist/libs/shared/src/utils/EmbedHelper.d.ts

@@ -0,0 +1,8 @@
+export interface EmbedResolution {
+    width: '100%' | '640' | '1014' | '1280';
+    height: '100%' | '360' | '576' | '720';
+    label: string;
+}
+export declare const EmbedHelper: {
+    getEmbedResolutions(): EmbedResolution[];
+};

package/dist/libs/shared/src/utils/FormHelper.d.ts

@@ -0,0 +1,4 @@
+import { FormikErrors, FormikTouched } from 'formik';
+export declare const FormHelper: {
+    getCustomFormControlClassName<T>(errors: FormikErrors<T>, touched: FormikTouched<T>, attribute: string, additionalClassName?: string): string;
+};

package/dist/libs/shared/src/utils/ImageHelper.d.ts

@@ -0,0 +1,30 @@
+import { HashObject } from "../../../common/src/react/interfaces/HashObject";
+import { Core } from "../../../common/src/backbone";
+import { Banner } from "../interfaces";
+import { ImageType, ImageSize, ResizeType } from "../enums/Images";
+export interface ImageOptions {
+    size?: ImageSize;
+    bgColor?: string;
+    width?: number;
+    height?: number;
+    resizeType?: ResizeType;
+    ratio?: string;
+    name?: string;
+}
+export interface CategoryMapperImageOptions {
+    fallbackBaseUrl: string;
+    fallbackCategoryName: string;
+    type: ImageType;
+}
+export declare const ImageHelper: {
+    createUrl(baseUrl: string, options?: ImageOptions): string;
+    createBannerUrl(banner: Banner, mappingOptions?: CategoryMapperImageOptions, imageOptions?: ImageOptions): string;
+    /**
+   * Ensures that strings are properly escaped before using them
+   * within a URL.
+   */
+    Rfc3986EncodeURIComponent(str: string): string;
+    _createCategoryMappedUrl(mappingOptions: CategoryMapperImageOptions, options?: ImageOptions): string;
+    _createUrl(baseUrl: string, options?: ImageOptions): string;
+    legacyCreateThumbnailUrl(thumbnail: string | HashObject<any> | Core.Model, options?: ImageOptions): string;
+};

package/dist/libs/shared/src/utils/LibraryDataServiceHelper.d.ts

@@ -0,0 +1,13 @@
+/// <reference types="backbone" />
+/// <reference types="backbone.radio" />
+/// <reference types="backbone.validation" />
+import { BaseLibraryDataService } from "../interfaces";
+export declare const SharedLibraryDataServiceHelper: {
+    libraries: {
+        dataServiceName: string;
+        eventName: string;
+        getData: (instance: BaseLibraryDataService) => import("../../../common/src/backbone/core").Collection<import("../../../common/src/backbone/core").Model>;
+        getInstance: (context: import("backbone").Events) => unknown;
+        beforeOnBeforeRender: boolean;
+    };
+};

package/dist/libs/shared/src/utils/MaskHelper.d.ts

@@ -0,0 +1,15 @@
+/// <reference types="jquery" />
+/// <reference types="jqueryui" />
+/// <reference types="typeahead" />
+/// <reference types="dropzone" />
+/// <reference types="bootstrap" />
+export interface MaskHelperOptions {
+    targetSelector?: string;
+    additionalClasses?: string;
+    fade?: boolean;
+}
+export declare const MaskHelper: {
+    showMask(options?: MaskHelperOptions): JQuery<HTMLElement>;
+    hideMask(maskEl?: JQuery<HTMLElement>): void;
+    getTarget(targetSelector?: string): JQuery<HTMLElement>;
+};

package/dist/libs/shared/src/utils/NumberHelper.d.ts

@@ -0,0 +1,3 @@
+export declare const NumberHelper: {
+    padNumber(num: number, padLength: number): string;
+};

package/dist/libs/shared/src/utils/PageTitleHelper.d.ts

@@ -0,0 +1,3 @@
+export declare const PageTitleHelper: {
+    setPageTitle(title: string): void;
+};

package/dist/libs/shared/src/utils/PartialLoadingHelper.d.ts

@@ -0,0 +1,12 @@
+interface PartialLoadingOptions {
+    numItems?: number;
+    minWidth?: number;
+    maxWidth?: number;
+}
+interface PartialLoadingItem {
+    width: string;
+}
+export declare const PartialLoadingHelper: {
+    getPartialLoadingItems(options?: PartialLoadingOptions): PartialLoadingItem[];
+};
+export {};

package/dist/libs/shared/src/utils/RatingHelper.d.ts

@@ -0,0 +1,4 @@
+import { OnlineCurrentUser } from "../interfaces";
+export declare const RatingHelper: {
+    getMaxAllowedRatingForUser(user: OnlineCurrentUser): number;
+};

package/dist/libs/shared/src/utils/ReorderHelper.d.ts

@@ -0,0 +1,15 @@
+import { HashObject } from "../../../common/src/react/interfaces/HashObject";
+import { BaseObject, ReorderRequest } from "../interfaces";
+interface ReorderResult<T extends BaseObject> {
+    reorderRequest: ReorderRequest;
+    reorderedItems: T[];
+}
+export declare const ReorderHelper: {
+    reorder<T extends BaseObject>(items: T[], oldIdx: number, newIdx: number): ReorderResult<T>;
+    updateState(dataPrefix: string, reorderRequest: ReorderRequest, data: {
+        [key: string]: HashObject<any>;
+    }): {
+        [key: string]: HashObject<any>;
+    };
+};
+export {};

package/dist/libs/shared/src/utils/RestrictionHelper.d.ts

@@ -0,0 +1,5 @@
+import { Restriction, VideoWithRestrictions, RestrictedObject, Video } from "../interfaces";
+export declare const RestrictionHelper: {
+    mixinRestrictions(videos: Video[], restrictions: Restriction[]): VideoWithRestrictions[];
+    getVideoRestrictions(videoId: string, restrictions: Restriction[]): RestrictedObject[];
+};

package/dist/libs/shared/src/utils/SvgHelper.d.ts

@@ -0,0 +1,19 @@
+import * as FA from '@fortawesome/fontawesome';
+import { localSvgs } from "../images/svg";
+interface SVGIconParams extends FA.IconParams {
+}
+export interface SVGOptions {
+    prefix?: string;
+    iconOptions?: SVGIconParams;
+}
+export declare class StaticSvgHelper {
+    private static instance;
+    private constructor();
+    static get Instance(): StaticSvgHelper;
+    getSvg(svgName: string, options?: SVGOptions): string;
+    private getIcon;
+    private faIconLookup;
+}
+export declare const SvgHelper: StaticSvgHelper;
+export declare const cvSvgLibrary: typeof localSvgs;
+export {};

package/dist/libs/shared/src/utils/VideoDetailsHelper.d.ts

@@ -0,0 +1,3 @@
+export declare const VideoDetailsHelper: {
+    mapRatingToClass(ratingValue: number): string;
+};

package/dist/libs/shared/src/utils/VideoHelper.d.ts

@@ -0,0 +1,4 @@
+import { Video } from "../interfaces";
+export declare const VideoHelper: {
+    hasSeries(video: Video): boolean;
+};

package/dist/libs/shared/src/utils/video-actions/VideoActionsHelper.d.ts

@@ -0,0 +1,14 @@
+export declare enum VideoAction {
+    AddToPlaylist = 0,
+    RemoveFromPlaylist = 1,
+    Share = 2,
+    Edit = 3
+}
+interface BaseVideoActionOptions {
+    label: string;
+    svgName: string;
+}
+export declare const getVideoActionOptions: () => {
+    [index: string]: BaseVideoActionOptions;
+};
+export {};

package/dist/libs/shared/src/views/dialog/DialogView.d.ts

@@ -0,0 +1,9 @@
+import * as React from 'react';
+import { PopupViewProps, DialogOptions } from "../../interfaces";
+interface DialogViewProps extends DialogOptions {
+    onDone?: () => void;
+    onFail?: () => void;
+}
+declare type PropTypes = React.PropsWithChildren<DialogViewProps & PopupViewProps>;
+export declare function DialogView(props: PropTypes): React.ReactElement;
+export {};