@clickview/player 0.0.3-dev.1 → 0.0.3-rc.1

package/dist/libs/shared/src/components/actions/ActionButton.d.ts

@@ -0,0 +1,16 @@
+import * as React from 'react';
+import { Core } from 'libs/common/core';
+import { HashObject } from 'libs/common/react/interfaces';
+import { AnalyticsOptions } from 'libs/analytics/interfaces';
+interface ActionButtonProps {
+    appLink?: Core.AppLink;
+    onClick?: (e: React.MouseEvent) => void;
+    svgName?: string;
+    className?: string;
+    tooltip?: string;
+    showSpinner?: boolean;
+    analyticsData?: HashObject;
+    analyticsOptions?: AnalyticsOptions;
+}
+export declare function ActionButton(props: React.PropsWithChildren<ActionButtonProps>): JSX.Element;
+export {};

package/dist/libs/shared/src/components/actions/Actions.d.ts

@@ -0,0 +1,28 @@
+/// <reference types="react" />
+import { Core } from 'libs/common/core';
+import { HashObject } from 'libs/common/react/interfaces';
+import { AnalyticsOptions } from 'libs/analytics/interfaces';
+import { BaseObject } from 'libs/shared/interfaces';
+export interface ActionOptions {
+    order?: number;
+    label?: string;
+    appLink?: Core.AppLink;
+    onClick?: () => void;
+    svgName?: string;
+    className?: string;
+    button?: boolean;
+    tooltip?: string;
+    showSpinner?: boolean;
+    analyticsData?: HashObject;
+    analyticsOptions?: AnalyticsOptions;
+    disabled?: boolean;
+}
+export declare type ActionGenerator = (obj: BaseObject) => ActionOptions[];
+interface ActionsProps {
+    actions: ActionOptions[];
+    className?: string;
+    actionsDropdownClassName?: string;
+    sortComponent?: JSX.Element;
+}
+export declare function Actions(props: ActionsProps): JSX.Element;
+export {};

package/dist/libs/shared/src/components/actions/ActionsDropdown.d.ts

@@ -0,0 +1,15 @@
+import * as React from 'react';
+import { ActionOptions } from './Actions';
+export declare type DropdownActionOptions = Omit<ActionOptions, 'button' | 'tooltip'>;
+interface ActionsDropdownProps {
+    actions: DropdownActionOptions[];
+    className?: string;
+    dropdownToggleClassName?: string;
+}
+export declare function ActionsDropdown(props: ActionsDropdownProps): React.ReactElement;
+export declare namespace ActionsDropdown {
+    var defaultProps: {
+        dropdownToggleClassName: string;
+    };
+}
+export {};

package/dist/libs/shared/src/components/app-link/AppLink.d.ts

@@ -0,0 +1,21 @@
+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;
+    appLinkOptions?: Core.AppLinkOptions;
+    className?: string;
+    style?: React.CSSProperties;
+    tag?: 'a' | 'button';
+    onClick?: (e: React.MouseEvent) => void;
+    analyticsData?: HashObject;
+    analyticsOptions?: AnalyticsOptions;
+    title?: string;
+}
+export declare function AppLink(props: React.PropsWithChildren<AppLinkProps>): React.ReactElement;
+export declare namespace AppLink {
+    var defaultProps: {
+        appLinkOptions: {};
+    };
+}

package/dist/libs/shared/src/components/avatar/Avatar.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+interface AvatarProps {
+    imageCdnUrl: string;
+    initials: string;
+    imageUrl?: string;
+}
+export declare function Avatar(props: AvatarProps): JSX.Element;
+export {};

package/dist/libs/shared/src/components/div-button/DivButton.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+interface DivButtonProps extends React.ButtonHTMLAttributes<HTMLDivElement> {
+    onClick: (...args: any) => any;
+}
+/**
+ * This element lets us use `div` elements as buttons without losing the accessibility of
+ * a regular HTML button element
+ */
+export declare function DivButton(props: React.PropsWithChildren<DivButtonProps>): JSX.Element;
+export {};

package/dist/libs/shared/src/components/feedback-tooltip/FeedbackTooltip.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+interface FeedbackTooltipProps {
+    tooltipText: string;
+}
+export declare function FeedbackTooltip(props: FeedbackTooltipProps): JSX.Element;
+export {};

package/dist/libs/shared/src/components/icon-button/IconButton.d.ts

@@ -0,0 +1,19 @@
+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/AnalyticsTypes';
+interface IconButtonProps {
+    svgName: string;
+    className?: string;
+    appLink?: Core.AppLink;
+    onClick?: (e: React.MouseEvent) => void;
+    analyticsData?: HashObject;
+    analyticsOptions?: AnalyticsOptions;
+}
+/**
+ * Renders a button with an svg followed by text.
+ * The svg is required and is set using the svgName prop.
+ * Button text is optional and can be set using props.children.
+ */
+export declare function IconButton(props: React.PropsWithChildren<IconButtonProps>): React.ReactElement;
+export {};

package/dist/libs/shared/src/components/image-cropper/SimpleCropper.d.ts

@@ -0,0 +1,15 @@
+/// <reference types="react" />
+import { ImageType } from 'libs/shared/enums/Images';
+import './image-cropper.scss';
+export interface SimpleCropperProps {
+    src: string;
+    alt: string;
+    onClickCrop: (dataUrl: string) => void;
+    closePopup: () => void;
+    /**
+     * If an imageType isn't provide the aspect ratio
+     * and min sizes won'd be locked
+     */
+    imageType?: ImageType;
+}
+export declare function SimpleCropper(props: SimpleCropperProps): JSX.Element;

package/dist/libs/shared/src/components/immersive-reader/ImmersiveReader.d.ts

@@ -0,0 +1,14 @@
+/// <reference types="react" />
+import { PropsWithAnalyticsOptions } from 'libs/shared/interfaces';
+declare type ImmersiveReaderProps = PropsWithAnalyticsOptions<{
+    text: string;
+    title?: string;
+    className?: string;
+    analyticsData: {
+        id: string;
+        type: string;
+    };
+    html?: boolean;
+}>;
+export declare function ImmersiveReader(props: ImmersiveReaderProps): JSX.Element;
+export {};

package/dist/libs/shared/src/components/interactive-questions/InteractiveQuestions.d.ts

@@ -0,0 +1,12 @@
+import React from 'react';
+import { Interactive, Interaction } from 'libs/shared/interfaces';
+import { InteractionCorrectness } from 'libs/shared/enums/InteractionCorrectness';
+export interface InteractiveQuestionProps {
+    interactive: Interactive;
+    goToTimepoint?: (timepointId: string, interactionId: string) => void;
+    selectedInteractionId?: string;
+    maxHeight: number;
+    onClickDelete?: (interactionId: string) => void;
+    getCorrectness?: (interaction: Interaction) => InteractionCorrectness;
+}
+export declare function InteractiveQuestions(props: InteractiveQuestionProps): React.ReactElement;

package/dist/libs/shared/src/components/interactive-questions/formatAnnotationText.d.ts

@@ -0,0 +1 @@
+export declare function formatAnnotationText(text: string): string;

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

@@ -0,0 +1,35 @@
+import * as React from 'react';
+import { HashObject } from 'libs/common/react/interfaces';
+import { Core } from 'libs/common/core';
+import { AnalyticsOptions } from 'libs/analytics/interfaces';
+export interface HeaderButton {
+    appLink?: Core.AppLink;
+    onClick?: (e: React.MouseEvent) => void;
+    svgName?: string;
+    className?: string;
+    tooltip?: string;
+    showSpinner?: boolean;
+    analyticsData?: HashObject;
+    analyticsOptions?: AnalyticsOptions;
+}
+interface PopupProps {
+    title?: string;
+    closeButton?: boolean;
+    closePopup: () => void;
+    onEntered?: () => void;
+    size?: 'sm' | 'lg' | 'xl';
+    showLoadingSpinner?: boolean;
+    headerButtons?: HeaderButton[];
+    centered?: boolean;
+    bodyClassName?: string;
+    dialogClassName?: string;
+}
+export declare function Popup(props: React.PropsWithChildren<PopupProps>): React.ReactElement;
+export declare namespace Popup {
+    var defaultProps: {
+        closeButton: boolean;
+        bodyClassName: string;
+        dialogClassName: string;
+    };
+}
+export {};

package/dist/libs/shared/src/components/popup/PopupButtons.d.ts

@@ -0,0 +1,14 @@
+import * as React from 'react';
+import { ButtonProps } from 'react-bootstrap';
+export interface PopupButton extends ButtonProps {
+    className?: string;
+    onClick: () => void;
+    buttonText: string;
+    isSpinnerButton?: boolean;
+    showSpinner?: boolean;
+}
+interface PopupButtonsProps {
+    buttons: PopupButton[];
+}
+export declare function PopupButtons({ buttons }: PopupButtonsProps): React.ReactElement;
+export {};

package/dist/libs/shared/src/components/popup/PopupLoadingSpinner.d.ts

@@ -0,0 +1,2 @@
+import * as React from 'react';
+export declare function PopupLoadingSpinner(): React.ReactElement;

package/dist/libs/shared/src/components/spinner-button/SpinnerButton.d.ts

@@ -0,0 +1,8 @@
+import * as React from 'react';
+import { ButtonProps } from 'react-bootstrap';
+export interface SpinnerButtonProps extends ButtonProps {
+    showSpinner: boolean;
+    onClick?: () => void;
+    className?: string;
+}
+export declare function SpinnerButton(props: React.PropsWithChildren<SpinnerButtonProps>): React.ReactElement;

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

@@ -0,0 +1,13 @@
+import * as React from 'react';
+interface LanguageInterpolationOptions {
+    smartCount?: number;
+    [propName: string]: any;
+}
+interface TextProps {
+    phrase: string;
+    namespace?: string;
+    options?: LanguageInterpolationOptions;
+}
+export declare const LanguageNamespaceContext: React.Context<string>;
+export declare const Text: React.NamedExoticComponent<TextProps>;
+export {};

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

@@ -0,0 +1,8 @@
+export declare enum InteractionCorrectness {
+    Correct = 0,
+    Incorrect = 1,
+    AwaitingMarking = 2,
+    Answered = 3,
+    UnAnswered = 4,
+    NotApplicable = 5
+}

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

@@ -0,0 +1,5 @@
+export declare enum InteractiveAnswerStatus {
+    Incorrect = 0,
+    Correct = 1,
+    PendingReview = 2
+}

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
+}