@clickview/player 0.0.1 → 0.0.2-dev.0

package/dist/libs/shared/src/components/svg-container/SvgContainer.d.ts

@@ -0,0 +1,21 @@
+import * as React from 'react';
+import { Placement } from 'react-bootstrap/Overlay';
+export declare enum SvgContainerSize {
+    Standard = "std",
+    Small = "sm",
+    Medium = "md",
+    Large = "lg",
+    ExtraLarge = "xlg",
+    XXL = "xxlg"
+}
+interface SvgContainerProps {
+    svgName: string;
+    size?: SvgContainerSize;
+    className?: string;
+    tagName?: React.ElementType;
+    onClick?: (...args: any[]) => void;
+    title?: string;
+    tooltipPlacement?: Placement;
+}
+export declare function SvgContainer(props: SvgContainerProps): React.ReactElement;
+export {};

package/dist/libs/shared/src/components/svgs/interaction-types/InteractionTypes.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+export declare function TrueOrFalseSvg(): React.ReactElement;
+export declare function ShortAnswerSvg(): React.ReactElement;
+export declare function MissingWordSvg(): React.ReactElement;
+export declare function MultipleChoiceSvg(): React.ReactElement;
+export declare function ImageSvg(): React.ReactElement;
+export declare function AnnotationSvg(): React.ReactElement;

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

@@ -0,0 +1,26 @@
+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;
+    onImageLoadError?: (e: React.SyntheticEvent<HTMLImageElement, Event>) => void;
+}
+export declare function BaseThumbnail(props: React.PropsWithChildren<ThumbnailProps>): React.ReactElement;
+export {};

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

@@ -0,0 +1,17 @@
+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[];
+    spanHack?: boolean;
+}
+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,23 @@
+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;
+    analyticsData?: HashObject;
+    analyticsOptions?: AnalyticsOptions;
+    imageCdnUrl: string;
+    imageErrorFallbackUrl?: string;
+}
+/**
+ * This component intentionally doesn't contain an appLink/download link
+ * so that the resource download behaviour can be handled differently depending
+ * on where this is rendered (e.g. primary play page vs embedded player)
+ */
+export declare function ResourceTile(props: ResourceTileProps): JSX.Element;
+export interface ResourceWidgetItemProps extends ResourceTileProps {
+    appLink: Core.AppLink;
+}
+export declare const ResourceWidgetItem: React.NamedExoticComponent<ResourceWidgetItemProps>;
+export {};

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

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

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

@@ -0,0 +1,8 @@
+interface IImageMinDimensions {
+    width: number;
+    height: number;
+}
+export declare const ImageMinDimensions: {
+    [index: string]: IImageMinDimensions;
+};
+export {};

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

@@ -0,0 +1,5 @@
+export declare enum ClassificationStatus {
+    Draft = "Draft",
+    ComingSoon = "ComingSoon",
+    Published = "Published"
+}

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,27 @@
+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,
+    None = 99999
+}
+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/InteractiveOriginType.d.ts

@@ -0,0 +1,4 @@
+export declare enum InteractiveOriginType {
+    Original = 0,
+    Copy = 1
+}

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

@@ -0,0 +1,4 @@
+export declare enum PresentationStatus {
+    Draft = "Draft",
+    Published = "Published"
+}

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,19 @@
+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",
+    Topics = "subjects",
+    NewDashboards = "new_dashboards",
+    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/errors/primitives/DialogError.d.ts

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

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

@@ -0,0 +1,6 @@
+export declare const useVideoDragDropState: () => {
+    enabled: boolean;
+    disable: () => void;
+    enable: () => void;
+};
+export declare function useDisableVideoDragDrop(): void;

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

@@ -0,0 +1,11 @@
+export interface NavLockOptions {
+    id?: string;
+    title?: string;
+    text?: string;
+    allowAppLinks?: boolean;
+    onConfirmUnlock?: () => void;
+}
+export declare const useNavLock: () => {
+    lock: (lockOptions?: NavLockOptions) => void;
+    unlock: (id: string) => void;
+};

package/dist/libs/shared/src/images/svg/ImportedSvgs.d.ts

@@ -0,0 +1,88 @@
+/**
+ * SVGs must be exported here to ensure that they are part
+ * of the final webpack bundle.
+ * DO NOT import this into local Marionette files.
+ */
+export declare const importedSvgs: any[];
+/**
+ * SVGs available within the CV library
+ * Strings *must* match the svg filename.
+ *
+ * DO NOT import this into local Marionette files.
+ * Use cvSvgLibrary instead.
+ */
+export declare enum localSvgs {
+    AddToPlaylists = "add-to-playlist",
+    Caret = "caret",
+    Delete = "delete",
+    Edit = "edit",
+    NoEdit = "no-edit",
+    Close = "close",
+    Folder = "folder",
+    Resources = "resources",
+    More = "more",
+    Bell = "bell",
+    Plus = "plus",
+    Search = "search",
+    Share = "share",
+    Share2 = "share2",
+    Upload = "upload",
+    Preview = "preview",
+    CircleCheck = "circle-check",
+    Down = "down",
+    Right = "right",
+    UpDown = "up-down",
+    ChevronUp = "chevron-up",
+    ChevronDown = "chevron-down",
+    ChevronLeft = "chevron-left",
+    ChevronRight = "chevron-right",
+    VisibleOff = "visible-off",
+    VisibleOn = "visible-on",
+    PublisherArchive = "publisher-archive",
+    Play = "play",
+    PlayCircle = "play-circle",
+    ArrowLeft = "arrow-left",
+    CheckCircleOutline = "check-circle-o",
+    CheckCircle = "check-circle",
+    Check = "check",
+    Lock = "lock",
+    Link = "link",
+    Info = "info",
+    Question = "question",
+    Star = "star",
+    StarOutline = "star-o",
+    Archive = "archive",
+    Warning = "warning",
+    WarningOutline = "warning-o",
+    NewWindow = "new-window",
+    File = "file",
+    FilePDF = "file-pdf",
+    FileExcel = "file-excel",
+    FilePowerpoint = "file-ppt",
+    FileWord = "file-word",
+    FileImg = "file-img",
+    FileZip = "file-zip",
+    Enter = "enter",
+    Calendar = "calendar",
+    CloseCaption = "close-caption",
+    CloseCaptionBadge = "close-caption-badge",
+    Playlist = "playlist",
+    Handle = "handle",
+    Subject = "subject",
+    Series = "series",
+    EditClickView = "edit-clickview",
+    Heart = "heart",
+    HeartOutline = "heart-outline",
+    WhiteWave = "white-wave",
+    Cog = "cog",
+    Video = "video",
+    Compass = "compass",
+    History = "history",
+    Tag = "tag",
+    Email = "email",
+    YearLevel = "year-level",
+    Subjects = "subjects",
+    Download = "download",
+    Print = "print",
+    CreateInteractive = "create-interactive"
+}

package/dist/libs/shared/src/images/svg/actions/index.d.ts

@@ -0,0 +1,25 @@
+import AddToPlaylist from './add-to-playlist.svg';
+import Close from './close.svg';
+import Delete from './delete.svg';
+import Edit from './edit.svg';
+import Expand from './expand.svg';
+import Minus from './minus.svg';
+import More from './more.svg';
+import NewWindow from './new-window.svg';
+import Plus from './plus.svg';
+import Preview from './preview.svg';
+import Search from './search.svg';
+import Share from './share.svg';
+import Upload from './upload.svg';
+import Down from './down.svg';
+import Right from './right.svg';
+import UpDown from './up-down.svg';
+import VisibleOff from './visible-off.svg';
+import VisibleOn from './visible-on.svg';
+import NoEdit from './no-edit.svg';
+import EditClickView from './edit-clickview.svg';
+import Share2 from './share2.svg';
+import Download from './download.svg';
+import Print from './print.svg';
+import CreateInteractive from './create-interactive.svg';
+export { AddToPlaylist, Close, Delete, Edit, Expand, Minus, More, NewWindow, Plus, Preview, Search, Share, Upload, Down, Right, UpDown, VisibleOff, VisibleOn, NoEdit, EditClickView, Share2, Download, Print, CreateInteractive };

package/dist/libs/shared/src/images/svg/arrows/index.d.ts

@@ -0,0 +1,9 @@
+import Caret from './caret.svg';
+import ChevronUp from './chevron-up.svg';
+import ChevronDown from './chevron-down.svg';
+import ChevronLeft from './chevron-left.svg';
+import ChevronRight from './chevron-right.svg';
+import ArrowLeft from './arrow-left.svg';
+import ArrowRight from './arrow-right.svg';
+import Enter from './enter.svg';
+export { Caret, ChevronUp, ChevronDown, ChevronLeft, ChevronRight, ArrowLeft, ArrowRight, Enter };

package/dist/libs/shared/src/images/svg/index.d.ts

@@ -0,0 +1,2 @@
+import './settings.ts';
+export * from './ImportedSvgs';

package/dist/libs/shared/src/images/svg/objects/index.d.ts

@@ -0,0 +1,36 @@
+import Archive from './archive.svg';
+import Bell from './bell.svg';
+import Bookmark from './bookmark.svg';
+import Broadcast from './broadcast.svg';
+import Calendar from './calendar.svg';
+import Cog from './cog.svg';
+import Folder from './folder.svg';
+import Handle from './handle.svg';
+import Heart from './heart.svg';
+import HeartOutline from './heart-outline.svg';
+import Interactive from './interactive.svg';
+import Link from './link.svg';
+import Playlist from './playlist.svg';
+import PublisherArchive from './publisher-archive.svg';
+import Resources from './resources.svg';
+import StarOutline from './star-o.svg';
+import Star from './star.svg';
+import Tag from './tag.svg';
+import Time from './time.svg';
+import Video from './video.svg';
+import Subject from './subject.svg';
+import Series from './series.svg';
+import WhiteWave from './white-wave.svg';
+import Compass from './compass.svg';
+import History from './history.svg';
+import Email from './email.svg';
+import YearLevel from './year-level.svg';
+import Subjects from './subjects.svg';
+import File from './file.svg';
+import FilePDF from './file-pdf.svg';
+import FileImg from './file-img.svg';
+import FilePowerpoint from './file-ppt.svg';
+import FileWord from './file-word.svg';
+import FileZip from './file-zip.svg';
+import FileExcel from './file-excel.svg';
+export { Archive, Bell, Bookmark, Broadcast, Calendar, Cog, Folder, Handle, Interactive, Link, Playlist, PublisherArchive, Resources, StarOutline, Star, Tag, Time, Video, Subject, Series, File, FilePDF, FileImg, FilePowerpoint, FileWord, FileZip, FileExcel, Heart, HeartOutline, WhiteWave, Compass, History, Email, YearLevel, Subjects };

package/dist/libs/shared/src/images/svg/player/index.d.ts

@@ -0,0 +1,14 @@
+import Quality240 from './quality-240.svg';
+import Quality480 from './quality-480.svg';
+import QualityHD from './quality-hd.svg';
+import CloseCaption from './close-caption.svg';
+import Contract from './contract.svg';
+import FullScreen from './full-screen.svg';
+import Mute from './mute.svg';
+import Next from './next.svg';
+import Play from './play.svg';
+import PlayCircle from './play-circle.svg';
+import Pause from './pause.svg';
+import Previous from './previous.svg';
+import Volume from './volume.svg';
+export { Quality240, Quality480, QualityHD, CloseCaption, Contract, FullScreen, Mute, Next, Play, PlayCircle, Pause, Previous, Volume };

package/dist/libs/shared/src/images/svg/settings.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/libs/shared/src/images/svg/status/index.d.ts

@@ -0,0 +1,13 @@
+import CheckCircle from './check-circle.svg';
+import CheckCircleOutline from './check-circle-o.svg';
+import Check from './check.svg';
+import CloseCaptionBadge from './close-caption-badge.svg';
+import Question from './question.svg';
+import Info from './info.svg';
+import Lock from './lock.svg';
+import Verified from './verified.svg';
+import VisibleOff from './visible-off.svg';
+import VisibleOn from './visible-on.svg';
+import WarningOutline from './warning-o.svg';
+import Warning from './warning.svg';
+export { CheckCircle, CheckCircleOutline, Check, CloseCaptionBadge, Info, Lock, Verified, VisibleOff, VisibleOn, WarningOutline, Warning, Question };