@clickview/curator 1.0.14-rc.0 → 1.0.15-dev.0

package/dist/libs/shared/src/components/confirmation-popup/ConfirmationPopup.d.ts

@@ -0,0 +1,17 @@
+import * as React from 'react';
+import { PopupViewProps } from "../../interfaces";
+interface ConfirmationPopupProps {
+    title: string;
+    onClickConfirm: () => void;
+    confirmButtonText?: string;
+    cancelButtonText?: string;
+}
+declare type PropTypes = React.PropsWithChildren<ConfirmationPopupProps & PopupViewProps>;
+export declare function ConfirmationPopup(props: PropTypes): React.ReactElement;
+export declare namespace ConfirmationPopup {
+    var defaultProps: {
+        confirmButtonText: string;
+        cancelButtonText: string;
+    };
+}
+export {};

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

@@ -0,0 +1,10 @@
+import * as 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/forms/form-buttons/FormButtons.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+interface FormButtonsProps {
+    isNew: boolean;
+    hasNext?: boolean;
+}
+export declare function FormButtons<Values extends object>(props: FormButtonsProps): JSX.Element;
+export {};

package/dist/libs/shared/src/components/forms/form-checkbox/FormCheckbox.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+import { FieldAttributes } from 'formik';
+import { FormFieldProps } from '../form-field/FormField';
+/**
+ * Use this checkbox within Formik contexts
+ */
+export declare function FormCheckbox<Values extends object>(props: FieldAttributes<FormFieldProps<Values>>): JSX.Element;

package/dist/libs/shared/src/components/forms/form-field/CharacterCounter.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+interface CharacterCounterProps<Values extends object> {
+    fieldName: keyof Values;
+    limit: number;
+}
+export declare function CharacterCounter<Values extends object>(props: CharacterCounterProps<Values>): JSX.Element;
+export {};

package/dist/libs/shared/src/components/forms/form-field/FormField.d.ts

@@ -0,0 +1,16 @@
+import * as React from 'react';
+import { FieldAttributes, FieldProps } from 'formik';
+export interface FormFieldProps<Values extends object> {
+    /**
+     * The name prop MUST be the same as the attribute
+     * name of the value that the field is bound to.
+     */
+    name: string;
+    label?: string;
+    children?: ((props: FieldProps) => React.ReactNode) | React.ReactNode;
+    showCharacterCounter?: boolean;
+}
+export declare function FieldWrapper<Values extends object>(props: FieldAttributes<FormFieldProps<Values>> & {
+    className: string;
+}): React.ReactElement;
+export declare function FormField<Values extends object>(props: FieldAttributes<FormFieldProps<Values>>): React.ReactElement;

package/dist/libs/shared/src/components/forms/form-wrapper/FormWrapper.d.ts

@@ -0,0 +1,20 @@
+/// <reference types="react" />
+import { FormikValues, FormikConfig, FormikContextType } from 'formik';
+declare type ModifiedFormikConfig<Values extends FormikValues> = Omit<FormikConfig<Values>, 'initialValues' | 'onSubmit'>;
+interface FormWrapperProps<FormValues extends FormikValues, ApiValues extends FormikValues> {
+    initialValues: FormValues | ApiValues;
+    onSubmit: (data: FormValues, onDone: () => void) => void;
+    castInitialValues?: boolean;
+    castValuesOnSubmit?: boolean;
+    allowInitialSubmit?: boolean;
+    resetOnSubmit?: boolean;
+}
+export declare function FormWrapper<FormValues extends FormikValues = FormikValues, ApiValues extends FormikValues = FormikValues, ExtraProps = {}>(props: ModifiedFormikConfig<FormValues> & ExtraProps & FormWrapperProps<FormValues, ApiValues>): JSX.Element;
+export declare namespace FormWrapper {
+    var defaultProps: {
+        castInitialValues: boolean;
+        castValuesOnSubmit: boolean;
+    };
+}
+export declare function useFormikContextWrapper<T>(): FormikContextType<T>;
+export {};

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

@@ -0,0 +1,15 @@
+import * as React from 'react';
+import { Core } from "../../../../common/src/backbone";
+interface IconButtonProps {
+    svgName: string;
+    className?: string;
+    appLink?: Core.AppLink;
+    onClick?: (e: React.MouseEvent) => void;
+}
+/**
+ * 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/pagination/Pagination.d.ts

@@ -0,0 +1,28 @@
+/// <reference types="react" />
+import { Core } from "../../../../common/src/backbone";
+import { Cursors } from "../../../../common/src/backbone/interfaces";
+interface CursorPaginationProps {
+    cursors: Cursors;
+    appLink: Core.AppLink;
+    className?: string;
+}
+export declare function Pagination({ appLink, cursors, className }: CursorPaginationProps): JSX.Element;
+export declare namespace Pagination {
+    var defaultProps: {
+        className: string;
+    };
+}
+interface LocalPaginationProps {
+    onClickNext: () => void;
+    onClickBack: () => void;
+    currentPage: number;
+    totalPages: number;
+    className?: string;
+}
+export declare function LocalPagination(props: LocalPaginationProps): JSX.Element;
+export declare namespace LocalPagination {
+    var defaultProps: {
+        className: string;
+    };
+}
+export {};

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

@@ -0,0 +1,10 @@
+import * as React from 'react';
+interface PopupProps {
+    title?: string;
+    closeButton?: boolean;
+    closePopup: () => void;
+    onEntered?: () => void;
+    showLoadingSpinner?: boolean;
+}
+export declare function Popup(props: React.PropsWithChildren<PopupProps>): React.ReactElement;
+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/search-bar/SearchBar.d.ts

@@ -0,0 +1,134 @@
+/// <reference types="react" />
+import * as Autosuggest from 'react-autosuggest';
+import { HashObject } from "../../../../common/src/react/interfaces/HashObject";
+import * as SearchUtils from './SearchUtils';
+export interface SearchBarProps<T extends HashObject> {
+    /**
+     * Optional initial query. Useful for populating the search bar
+     * on a search results page.
+     */
+    initialQuery?: string;
+    /**
+     * Callback function for when a suggestion is selected.
+     */
+    onSuggestionSelected: (suggestion: T) => void;
+    /**
+     * Flag to determine if the query should be updated when a
+     * suggestion is selected. Defaults to `true` in `defaultProps`.
+     * If true, SearchUtils.getSuggestionValue is used to update the query.
+     */
+    updateQueryOnSelection?: boolean;
+    /**
+     * Optional callback for when the search query changes.
+     */
+    onQueryChange?: (query: string) => void;
+    /**
+     * Optional callback for when the search is submitted.
+     */
+    onSubmit?: (query: string) => void;
+    /**
+     * Optional callback to get the remote resource if remote search
+     * results are being used.
+     */
+    getRemoteUrl?: (query: string) => string;
+    /**
+     * Optional formatting function for the data returned from the remote resource.
+     */
+    formatRemoteSuggestions?: (data: any) => T[];
+    /**
+     * Optional array of recent searches.
+     */
+    recentSearches?: T[];
+    /**
+     * A label for the recent search section.
+     * A default is provided in the i18n config.
+     */
+    recentSearchHeading?: string;
+    /**
+     * A label for the main suggestions section.
+     * Will not be used if getSections is passed as a prop.
+     */
+    suggestionsHeading?: string;
+    /**
+     * Optional array of local data to be used as suggestion sources.
+     */
+    local?: T[];
+    /**
+     * Optional array of initial suggestions. These suggestions will be available
+     * when no query is present. Entering a query will begin filtering suggestions.
+     * This is useful for using SearchBar to filter a list.
+     */
+    initialSuggestions?: T[];
+    /**
+     * Key used to filter local data. This is required if local is provided,
+     * however a default of 'name' is set in `defaultProps`.
+     */
+    valueKey?: keyof T;
+    /**
+     * Optional function to filter suggestions from local data.
+     * SearchUtils.getLocalSuggestions will be used by default.
+     */
+    getLocalSuggestions?: (query: string, local: T[]) => T[];
+    /**
+     * Optional function for splitting suggestions into sections.
+     * Doesn't apply to recent searches (SuggestionType.Recent).
+     */
+    getSections?: (suggestions: T[]) => SearchUtils.SuggestionSection<T>[];
+    /**
+     * Placeholder for the search input.
+     * A default is provided in the i18n config.
+     */
+    placeholder?: string;
+    /**
+     * The number of characters required to begin providing suggestions.
+     * A default is provided in `defaultProps`.
+     */
+    activationLength?: number;
+    /**
+     * Max number of suggestions to render. A default is set in `defaultProps`.
+     * Set to false to render all suggestions (e.g. for filtering a list in memory).
+     */
+    suggestionLimit?: number | false;
+    /**
+     * Callback function to get the component to be rendered for a suggestion.
+     * SearchUtils.getSuggestionComponent is used a default. This uses
+     * `valueKey` to render text.
+     */
+    getSuggestionComponent?: (suggestion: T) => JSX.Element;
+    /**
+     * If true, suggestions will be rendered, even if the input isn't focussed.
+     */
+    alwaysRenderSuggestions?: boolean;
+    theme?: Autosuggest.Theme;
+    /**
+     * Option to determine whether to render the search icon and if so,
+     * which side to render it on. Defaults to `right` in `defaultProps`
+     */
+    searchIconPlacement?: 'left' | 'right' | false;
+    /**
+     * Flag to determine whether clicking the search icon should trigger
+     * submitting the search query.
+     */
+    submitOnClickSearchIcon?: boolean;
+    /**
+     * Flag to determine whether the search input should be autofocused.
+     */
+    autoFocusInput?: boolean;
+    /**
+     * When true, the input field will be cleared whenever a suggestion is selected.
+     */
+    clearQueryOnSelect?: boolean;
+    onBackspace?: () => void;
+}
+export declare function SearchBar<T extends HashObject>(props: SearchBarProps<T>): JSX.Element;
+export declare namespace SearchBar {
+    var defaultProps: {
+        updateQueryOnSelection: boolean;
+        valueKey: string;
+        activationLength: number;
+        suggestionLimit: number;
+        recentSearches: any[];
+        initialSuggestions: any[];
+        searchIconPlacement: string;
+    };
+}

package/dist/libs/shared/src/components/search-bar/SearchInput.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+import * as Autosuggest from 'react-autosuggest';
+interface SearchInputProps {
+    onClickSearchIcon?: () => void;
+    searchIconPlacement?: 'left' | 'right' | false;
+}
+export declare function SearchInput<T extends {}>(props: SearchInputProps & Autosuggest.InputProps<T>): JSX.Element;
+export {};

package/dist/libs/shared/src/components/search-bar/SearchUtils.d.ts

@@ -0,0 +1,44 @@
+import * as React from 'react';
+import * as Autosuggest from 'react-autosuggest';
+import { HashObject } from "../../../../common/src/react/interfaces/HashObject";
+import { SearchBarProps } from './SearchBar';
+export declare enum SuggestionType {
+    Local = "local",
+    Recent = "recent",
+    Remote = "remote"
+}
+/**
+ * Suggestions grouped as a section
+ */
+export interface SuggestionSection<T extends HashObject> {
+    data: T[];
+    title?: string;
+}
+/**
+ * How suggestion data is stored in state in SearchBar
+ */
+export declare type SuggestionState<T extends HashObject> = {
+    [key in SuggestionType]: T[];
+};
+export declare function getInitialState<T extends HashObject>(initialSuggestions: T[], recentSearches: T[]): SuggestionState<T>;
+export declare function onSuggestionsFetchRequestedHandler<T extends HashObject>(props: SearchBarProps<T>, setSuggestions: React.Dispatch<React.SetStateAction<SuggestionState<T>>>, resetSuggestions: () => void): (params: Autosuggest.SuggestionsFetchRequestedParams) => void;
+export declare function getSuggestionValue<T extends HashObject>(valueKey: keyof T, suggestion: T): string;
+/**
+ * Default suggestion component. Renders text based on valueKey.
+ *
+ * @param valueKey object attribute to be rendered.
+ */
+export declare function getSuggestionComponent<T extends HashObject>(valueKey: keyof T, suggestion: T): JSX.Element;
+/**
+ * Maps the suggestion state into sections.
+ *
+ * @param getSections - an optional function passed in from anything consuming
+ * SearchBar used to break the local and remote suggestions into sections.
+ */
+export declare function getSuggestionSections<T extends HashObject>(suggestionState: SuggestionState<T>, showRecentSearches: boolean, recentSearchHeading: string, suggestionsHeading?: string, getSections?: (suggestions: T[]) => SuggestionSection<T>[], suggestionLimit?: number | false): SuggestionSection<T>[];
+/**
+ * Maps a section into a list of suggestions.
+ */
+export declare function getSectionSuggestions<T extends HashObject>(section: SuggestionSection<T>): T[];
+export declare function renderSectionTitle<T extends HashObject>(section: SuggestionSection<T>): JSX.Element | null;
+export declare function getTheme(theme?: Autosuggest.Theme): Autosuggest.Theme;

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

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

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

@@ -0,0 +1,20 @@
+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"
+}
+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/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/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/constants/AppVariables.d.ts

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

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

@@ -0,0 +1,4 @@
+export declare const CacheDurations: {
+    SHORT: number;
+    STANDARD: number;
+};

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

@@ -0,0 +1,7 @@
+export declare const LayoutRegions: {
+    TOP_NAV: string;
+    LEFT_NAV: string;
+    CONTENT: string;
+    POPUP: string;
+    ALERT: 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/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,59 @@
+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
+}

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

@@ -0,0 +1,18 @@
+/**
+ * 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)"
+}

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

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