@clickview/player 0.0.0-rc.11 → 0.0.0-rc.12

package/dist/libs/common/src/backbone/interfaces/Pagination.d.ts

@@ -0,0 +1,33 @@
+export interface Pagination {
+    cursors: Cursors;
+    limit: number;
+}
+export interface Cursors {
+    next: string;
+    previous: string;
+}
+/**
+ * Do not extend or implement this interface.
+ * It is only exported for use within the BaseDataService.
+ *
+ * By default, the BaseDataService will convert legacy pagination
+ * objects to cursor-based pagination objects.
+ */
+export interface LegacyPagination {
+    page: number;
+    pageSize: number;
+    totalItems: number;
+    totalPages: number;
+}
+/**
+ * Do not extend or implement this interface.
+ * It is only exported for use within the BaseDataService.
+ *
+ * By default, the BaseDataService will convert legacy pagination
+ * objects to cursor-based pagination objects.
+ */
+export interface OffsetPagination {
+    offset: number;
+    pageSize: number;
+    totalItems: number;
+}

package/dist/libs/common/src/backbone/interfaces/StickitBinding.d.ts

@@ -0,0 +1,38 @@
+/// <reference types="jquery" />
+/// <reference types="jqueryui" />
+/// <reference types="typeahead" />
+/// <reference types="bootstrap" />
+/// <reference types="dropzone" />
+import { BaseModel } from '../core/BaseModel';
+export interface StickitBinding {
+    observe: string;
+    onGet?: string | ((value: string, options: any) => string);
+    onSet?: string | ((value: string, options: any) => string);
+    getVal?: string | (($el: JQuery, event: Event, options: any) => string);
+    update?: string | (($el: JQuery, value: string, model: BaseModel, options: any) => void);
+    updateModel?: string | boolean | ((value: string, event: Event, options: any) => boolean);
+    updateView?: string | boolean | (() => boolean);
+    afterUpdate?: string | (($el: JQuery, value: string, options: any) => void);
+    updateMethod?: string;
+    escape?: boolean;
+    initialize?: string | (($el: JQuery, model: BaseModel, options: any) => void);
+    destroy?: string | (($el: JQuery, model: BaseModel, options: any) => void);
+    visible?: boolean | ((value: string, options: any) => boolean);
+    visibleFn?: string;
+    events?: string[];
+    name?: string;
+    selectOptions?: {
+        collection: string;
+        labelPath: string;
+        valuePath: string;
+        defaultOption?: string;
+    };
+    setOptions?: {
+        silent?: boolean;
+        validate?: boolean;
+    };
+    classes?: {
+        [className: string]: StickitBinding;
+    };
+    attributes?: StickitBinding[];
+}

package/dist/libs/common/src/backbone/interfaces/Xhr.d.ts

@@ -0,0 +1,9 @@
+export interface Xhr extends Pick<XMLHttpRequest, 'getResponseHeader' | 'status'> {
+    responseJSON?: any;
+}
+/**
+ * We're making getResponseHeader optional for a slightly nicer API
+ */
+export interface SimulatedXhr extends Omit<Xhr, 'getResponseHeader'> {
+    getResponseHeader?: (name: string) => string;
+}

package/dist/libs/common/src/backbone/interfaces/index.d.ts

@@ -0,0 +1,9 @@
+export * from './BaseCollectionIdentifier';
+export * from './ChainableDataService';
+export * from './DataCache';
+export * from './DataProvider';
+export * from './DataServiceError';
+export * from './DataServiceRequests';
+export * from './Pagination';
+export * from './StickitBinding';
+export * from './Xhr';

package/dist/libs/common/src/backbone/services/EnvironmentVariables.d.ts

@@ -0,0 +1,13 @@
+import { ObjectHash } from 'backbone';
+declare class StaticEnvironmentVariables {
+    private static instance;
+    private variables;
+    constructor();
+    static get Instance(): StaticEnvironmentVariables;
+    get name(): string;
+    get isDevelopment(): boolean;
+    get(name: string): any;
+    setUpVariables(variables: ObjectHash): void;
+}
+export declare const EnvironmentVariables: StaticEnvironmentVariables;
+export {};

package/dist/libs/common/src/backbone/utils/UrlHelper.d.ts

@@ -0,0 +1,14 @@
+import { ObjectHash } from 'backbone';
+interface FilterParams {
+    limit?: number;
+    cursor?: string;
+    before?: string;
+}
+export declare const UrlHelper: {
+    urlBuilder(base: string, queryStringObj: ObjectHash): string;
+    buildFilter(params: FilterParams): string;
+    makeHttps(url: string): string;
+    safeUrlConcat(baseUrl: string, path: string): string;
+    removeTrailingSlash(baseUrl: string): string;
+};
+export {};

package/dist/libs/common/src/react/flight/enums/RequestStatus.d.ts

@@ -0,0 +1,6 @@
+export declare enum RequestStatus {
+    None = "None",
+    Fetching = "Fetching",
+    Success = "Success",
+    Error = "Error"
+}

package/dist/libs/common/src/react/flight/enums/index.d.ts

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

package/dist/libs/common/src/react/flight/interfaces/FlightState.d.ts

@@ -0,0 +1,22 @@
+import { RequestStatus } from '../enums';
+import { Request } from './Request';
+import { HashObject } from 'libs/common/react/interfaces/HashObject';
+export interface FlightState {
+    readonly entities: NormalizedEntities;
+    readonly resources: Resources;
+}
+export interface NormalizedEntities {
+    readonly [key: string]: object;
+}
+export interface Resource {
+    readonly request: Request;
+    readonly status: RequestStatus;
+    readonly response?: string | string[] | HashObject | HashObject[];
+    readonly errorResponse?: any;
+    readonly timestamp?: number;
+    readonly statusCode?: number;
+    readonly entityIds?: string[];
+}
+export interface Resources {
+    readonly [key: string]: Resource;
+}

package/dist/libs/common/src/react/flight/interfaces/NormalizeOptions.d.ts

@@ -0,0 +1,4 @@
+export interface NormalizeOptions {
+    namespace?: string;
+    idAttribute?: string;
+}

package/dist/libs/common/src/react/flight/interfaces/Request.d.ts

@@ -0,0 +1,29 @@
+import { HttpVerbs } from 'libs/common/backbone/enums/HttpVerbs';
+import { HashObject } from 'libs/common/react/interfaces/HashObject';
+import { Xhr, SimulatedXhr } from 'libs/common/backbone/interfaces/Xhr';
+import { NormalizeOptions } from './NormalizeOptions';
+import { Resources } from './FlightState';
+import { UpdateStateOptions } from './UpdateStateOptions';
+export interface Request {
+    key: string;
+    url: string;
+    type?: HttpVerbs;
+    expiryTime?: number;
+    data?: HashObject | HashObject[];
+    normalize?: boolean;
+    normalizeOptions?: NormalizeOptions;
+    formatData?: (data: HashObject | HashObject[]) => HashObject | HashObject[];
+    bootstrapName?: string;
+    invalidationKeys?: string | string[];
+    updateState?: UpdateStateOptions | UpdateStateOptions[];
+    success?: (data: HashObject | HashObject[] | number) => void;
+    error?: (Xhr: Xhr) => void;
+    always?: () => void;
+    maintainState?: (resources: Resources) => Resources;
+}
+export interface SimulatedRequest extends Request {
+    successResponse?: () => (HashObject | HashObject[]);
+    errorResponse?: () => SimulatedXhr;
+    timeout?: number;
+    noResponse?: boolean;
+}

package/dist/libs/common/src/react/flight/interfaces/UpdateStateOptions.d.ts

@@ -0,0 +1,15 @@
+import { HashObject } from 'libs/common/react/interfaces/HashObject';
+export interface UpdateStateOptions {
+    keys: string | string[];
+    /**
+     * updateData takes a hash where the keys are keys for resources
+     * from the application state that match the keys above.
+     * The value is the denormalized (where applicable) data corresponding
+     * to that resource.
+     */
+    updateData: (data: {
+        [key: string]: HashObject;
+    }) => {
+        [key: string]: HashObject;
+    };
+}

package/dist/libs/common/src/react/interfaces/ApplicationData.d.ts

@@ -0,0 +1,3 @@
+export interface ApplicationData {
+    version: string;
+}

package/dist/libs/common/src/react/interfaces/ApplicationState.d.ts

@@ -0,0 +1,8 @@
+import { ApplicationData } from 'libs/common/react/interfaces/ApplicationData';
+import { FlightState } from 'libs/common/react/flight/interfaces/FlightState';
+import { HashObject } from 'libs/common/react/interfaces/HashObject';
+export interface ApplicationState {
+    readonly flightData: FlightState;
+    readonly applicationData: ApplicationData;
+    readonly viewModelData: HashObject;
+}

package/dist/libs/common/src/react/interfaces/BaseReducerActions.d.ts

@@ -0,0 +1,4 @@
+export interface ReducerActions<TActionType, TPayloadType = any> {
+    type: TActionType;
+    payload?: TPayloadType;
+}

package/dist/libs/common/src/react/interfaces/HashObject.d.ts

@@ -0,0 +1,3 @@
+export interface HashObject<T = any> {
+    [key: string]: T;
+}

package/dist/libs/common/src/react/interfaces/index.d.ts

@@ -0,0 +1,4 @@
+export * from './ApplicationData';
+export * from './ApplicationState';
+export * from './BaseReducerActions';
+export * from './HashObject';

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/common/src/react/utils/RandomHelper.d.ts

@@ -0,0 +1,3 @@
+export declare const RandomHelper: {
+    getRandomInt(max?: number): number;
+};

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/components/app-link/AppLink.d.ts

@@ -0,0 +1,13 @@
+import * as React from 'react';
+import { Core } from 'libs/common/core';
+import { HashObject } from 'libs/common/react/interfaces/HashObject';
+import { AnalyticsOptions } from 'libs/analytics/interfaces';
+export interface AppLinkProps {
+    appLink: Core.AppLink;
+    className?: string;
+    tag?: 'a' | 'button';
+    onClick?: (e: React.MouseEvent) => void;
+    analyticsData?: HashObject;
+    analyticsOptions?: AnalyticsOptions;
+}
+export declare function AppLink(props: React.PropsWithChildren<AppLinkProps>): React.ReactElement;

package/dist/libs/shared/src/components/lazy-image/LazyImage.d.ts

@@ -0,0 +1,7 @@
+import * as React from 'react';
+interface LazyImageProps extends React.ImgHTMLAttributes<HTMLImageElement> {
+    forceLoad?: boolean;
+    extraClasses?: string;
+}
+export declare const LazyImage: React.NamedExoticComponent<LazyImageProps>;
+export {};

package/dist/libs/shared/src/components/thumbnails/base/BaseThumbnail.d.ts

@@ -0,0 +1,25 @@
+import * as React from 'react';
+import { Core } from 'libs/common/core';
+import { Image } from 'libs/shared/interfaces';
+import { ImageOptions } from 'libs/shared/utils/ImageHelper';
+import { AnalyticsOptions, HashObject } from 'libs/analytics/interfaces';
+export declare enum AspectRatio {
+    SixteenByNine = 0,
+    OneByOne = 1,
+    TwoByThree = 2,
+    NineBySixteen = 3
+}
+interface ThumbnailProps {
+    data: Image | string;
+    imageOptions?: ImageOptions;
+    appLink?: Core.AppLink;
+    aspectRatio?: AspectRatio;
+    className?: string;
+    imageClassName?: string;
+    imageStyle?: HashObject;
+    preload?: boolean;
+    analyticsData?: HashObject;
+    analyticsOptions?: AnalyticsOptions;
+}
+export declare function BaseThumbnail(props: React.PropsWithChildren<ThumbnailProps>): React.ReactElement;
+export {};

package/dist/libs/shared/src/components/tooltip/Tooltip.d.ts

@@ -0,0 +1,16 @@
+import * as React from 'react';
+import { Placement } from 'react-bootstrap/Overlay';
+declare type TriggerType = 'hover' | 'click' | 'focus';
+interface TooltipProps {
+    title: string;
+    placement?: Placement;
+    trigger?: TriggerType | TriggerType[];
+}
+export declare function Tooltip(props: React.PropsWithChildren<TooltipProps>): React.ReactElement;
+export declare namespace Tooltip {
+    var defaultProps: {
+        trigger: string[];
+        placement: string;
+    };
+}
+export {};

package/dist/libs/shared/src/components/widgets/items/resource-widget-item/ResourceWidgetItem.d.ts

@@ -0,0 +1,17 @@
+import React from 'react';
+import { Core } from 'libs/common/core';
+import { HashObject } from 'libs/common/react/interfaces';
+import { AnalyticsOptions } from 'libs/analytics/interfaces';
+import { Resource, Link } from 'libs/shared/interfaces';
+interface ResourceTileProps {
+    data: Resource | Link;
+    appLink: Core.AppLink;
+    analyticsData?: HashObject;
+    analyticsOptions?: AnalyticsOptions;
+    imageCdnUrl: string;
+}
+export declare function ResourceTile(props: ResourceTileProps): JSX.Element;
+export interface ResourceWidgetItemProps extends ResourceTileProps {
+}
+export declare const ResourceWidgetItem: React.NamedExoticComponent<ResourceWidgetItemProps>;
+export {};

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

@@ -0,0 +1,5 @@
+export declare const AppVariables: {
+    SEARCH: string;
+    NOTIFICATIONS: string;
+    SUBJECTS: 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/CurriculumType.d.ts

@@ -0,0 +1,6 @@
+export declare enum CurriculumType {
+    Subject = "CurriculumSubject",
+    Audience = "CurriculumAudience",
+    Area = "CurriculumArea",
+    Leaf = "CurriculumLeaf"
+}

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/MasterType.d.ts

@@ -0,0 +1,61 @@
+export declare enum MasterType {
+    Audience = 1,
+    Category = 2,
+    Channel = 3,
+    Chapter = 4,
+    Comment = 5,
+    OwnerComment = 6,
+    Image = 7,
+    Thumbnail = 8,
+    Avatar = 9,
+    Banner = 10,
+    Video = 11,
+    Trailer = 12,
+    Rating = 13,
+    Topic = 14,
+    Series = 15,
+    Season = 16,
+    HostedMediaObjectCollection = 17,
+    ExchangeCollection = 18,
+    CustomMediaObjectCollection = 19,
+    Playlist = 20,
+    ClickViewTvCollection = 21,
+    ClickViewProductionsCollection = 22,
+    User = 23,
+    SystemUser = 24,
+    Customer = 25,
+    Country = 26,
+    Organisation = 28,
+    SystemOrganisation = 29,
+    Group = 30,
+    SystemGroup = 31,
+    FlagReason = 32,
+    Library = 33,
+    Interactive = 34,
+    WorkspaceCollection = 35,
+    Conversation = 36,
+    Message = 37,
+    Notification = 38,
+    Clip = 39,
+    Link = 40,
+    UserChannel = 41,
+    Resource = 42,
+    VideoStream = 43,
+    AudioStream = 44,
+    Tag = 45,
+    Subtitle = 46,
+    LicencedContentCollection = 47,
+    PublicCollection = 48,
+    CategoryTree = 49,
+    Logo = 50,
+    Permission = 51,
+    Subject = 52,
+    Field = 53,
+    Company = 54,
+    Person = 55,
+    Cover = 56,
+    Poster = 57,
+    SubjectAudience = 58,
+    Classroom = 67,
+    ClassroomGroup = 68
+}

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

@@ -0,0 +1,20 @@
+/**
+ * Breakpoints:
+ * - xs: 0
+ * - sm: 576px
+ * - md: 768px
+ * - lg: 992px
+ * - xl: 1200px
+ */
+export declare enum MediaQueryStrings {
+    XS = "(max-width: 575px)",
+    SM = "(min-width: 576px) and (max-width: 767px)",
+    MD = "(min-width: 768px) and (max-width: 991px)",
+    LG = "(min-width: 992px)",
+    XL = "(min-width: 1200px)",
+    XXL = "(min-width: 1440px)",
+    SMDown = "(max-width: 576px)",
+    MDDown = "(max-width: 768px)",
+    LGDown = "(max-width: 992px)",
+    XLDown = "(max-width: 1200px)"
+}

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

@@ -0,0 +1,5 @@
+export declare enum ObjectStatus {
+    Disabled = 0,
+    Active = 1,
+    Inactive = 2
+}

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

@@ -0,0 +1,5 @@
+export declare enum PlaylistPrivacy {
+    Private = 1,
+    Customer = 2,
+    Public = 3
+}

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

@@ -0,0 +1,4 @@
+export declare enum PresentationType {
+    Subject = "subject",
+    Curriculum = "curriculum"
+}

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

@@ -0,0 +1,9 @@
+export declare enum ResourceFileType {
+    Pdf = "pdf",
+    Image = "image",
+    PowerPoint = "powerpoint",
+    Document = "document",
+    Excel = "excel",
+    Zip = "archive",
+    File = "text"
+}

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

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

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

@@ -0,0 +1,17 @@
+export declare enum SettingName {
+    MustCompleteOnboarding = "must_complete_onboarding",
+    StudentWorkspaceSharing = "student_ws_sharing",
+    StudentToStudentMessaging = "student_to_student_messaging",
+    HideResourcesForStudents = "hide_resources_for_students",
+    LibraryReview = "library_review",
+    SchoolMessaging = "school_messaging",
+    LegacyTvNaming = "legacy_tv_naming",
+    LegacyAlbertCustomer = "legacy_albert_customer",
+    HideHostedLibraries = "hide_hosted_libraries",
+    StaffRequest = "staff_request",
+    MaxCustomLibraries = "max_custom_libraries",
+    CustomLibrariesBetaAccess = "custom_libraries_beta_access",
+    AutoCaptioning = "auto_captioning",
+    HasCompletedOnboarding = "has_completed_onboarding",
+    BulkOnboardingPreferencesState = "bulk_onboarding_preferences_state"
+}

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

@@ -0,0 +1,3 @@
+export declare enum ThemeType {
+    Glance = "glance"
+}

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

@@ -0,0 +1,5 @@
+export declare enum UserGroup {
+    Unknown = 0,
+    Staff = 1,
+    Learner = 2
+}

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

@@ -0,0 +1,15 @@
+export declare enum OnlineUserRole {
+    Unspecified = 0,
+    Student = 1,
+    Staff = 2,
+    Admin = 3,
+    CVAdmin = 4,
+    FreeUser = 6,
+    ReadOnly = 8
+}
+export declare enum UserRole {
+    Guest = 16,
+    User = 32,
+    Admin = 48,
+    SuperAdmin = 64
+}

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

@@ -0,0 +1,10 @@
+export declare enum WidgetContents {
+    Videos = "videos",
+    Series = "series",
+    Subjects = "subjects",
+    Playlists = "playlists",
+    UserChannels = "user channels",
+    Interactives = "interactives",
+    Clips = "clips",
+    Resources = "resources"
+}

package/dist/libs/shared/src/hooks/UseGetMediaQueryString.d.ts

@@ -0,0 +1,2 @@
+import { MediaQueryStrings } from 'libs/shared/enums/MediaQueries';
+export declare function useGetMediaQueryString(): MediaQueryStrings;

package/dist/libs/shared/src/hooks/UseLazyLoad.d.ts

@@ -0,0 +1,6 @@
+interface LazyUtils {
+    ref: (node?: Element) => void | null;
+    inView: boolean;
+}
+export declare function useLazyLoad(prevent?: boolean): LazyUtils;
+export {};

package/dist/libs/shared/src/hooks/UseMediaQuery.d.ts

@@ -0,0 +1 @@
+export declare function useMediaQuery(query: string): boolean;

package/dist/libs/shared/src/interfaces/AppLinkWithLabel.d.ts

@@ -0,0 +1,5 @@
+import { Core } from 'libs/common/core';
+export interface AppLinkWithLabel {
+    label: string;
+    appLink: Core.AppLink;
+}

package/dist/libs/shared/src/interfaces/DialogOptions.d.ts

@@ -0,0 +1,13 @@
+export interface DialogButton {
+    text: string;
+    type?: 'button' | 'reset' | 'submit';
+    className: string;
+    close?: boolean;
+    success?: boolean;
+    identifier?: string;
+}
+export interface DialogOptions {
+    title: string;
+    text: string;
+    buttons?: DialogButton[];
+}