@clickview/curator 1.0.25-dev.1 → 1.0.25-rc.1

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

@@ -1,168 +0,0 @@
-/// <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;
-    /**
-     * If additional headers are required (e.g. authorization) when fetching
-     * a remote resource, add them in here.
-     */
-    requestHeaders?: HashObject;
-    /**
-     * 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;
-    /**
-     * If true, a cross svg will be rendered.
-     * Clicking this icon will reset the query.
-     */
-    showClearInputIcon?: boolean;
-    /**
-     * Optional callback function to be called when the clear input
-     * icon is clicked.
-     * The query will be reset automatically, this callback is for
-     * adding additional functionality.
-     */
-    onClickClearInput?: () => void;
-    /**
-     * 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;
-    /**
-     * If true, the default Bootstrap styling will be applied when the
-     * input is focused.
-     */
-    highlightInputOnFocus?: boolean;
-    /**
-     * If true, suggestions will be rendered whenever the input is focussed.
-     * Useful for show recent searches suggestions when there's no query.
-     */
-    renderSuggestionsOnInputFocus?: boolean;
-    /**
-     * When true, the input field will be cleared whenever a suggestion is selected.
-     */
-    clearQueryOnSelect?: boolean;
-    onBackspace?: () => void;
-    /**
-     * When true, the search input will be wrapped in a <form />.
-     * This is true by default.
-     * If rendering <SearchBar /> within another form, set this to false.
-     */
-    renderAsForm?: boolean;
-}
-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;
-        renderAsForm: boolean;
-    };
-}

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

@@ -1,13 +0,0 @@
-/// <reference types="react" />
-import * as Autosuggest from 'react-autosuggest';
-import { HashObject } from "../../../../common/src/react/interfaces";
-declare type SearchIconPlacement = 'left' | 'right' | false;
-interface SearchInputProps<T> extends Autosuggest.InputProps<T> {
-    onClickSearchIcon?: () => void;
-    searchIconPlacement?: SearchIconPlacement;
-    showClearInputIcon?: boolean;
-    onClickClearInput?: () => void;
-    highlightOnFocus?: boolean;
-}
-export declare function SearchInput<T extends HashObject>(props: SearchInputProps<T>): JSX.Element;
-export {};

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

@@ -1,44 +0,0 @@
-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

@@ -1,8 +0,0 @@
-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

@@ -1,21 +0,0 @@
-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/text/Text.d.ts

@@ -1,13 +0,0 @@
-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

@@ -1,16 +0,0 @@
-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

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

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

@@ -1,8 +0,0 @@
-declare const BootstrapKeys: {
-    LOCALE: string;
-    PHRASES: string;
-    VERSION: string;
-    TOKEN: string;
-    PERMISSIONS: string;
-};
-export { BootstrapKeys };

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

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

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

@@ -1,12 +0,0 @@
-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

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

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

@@ -1,7 +0,0 @@
-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

@@ -1,20 +0,0 @@
-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

@@ -1,25 +0,0 @@
-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/context/ImageStorageContext.d.ts

@@ -1,45 +0,0 @@
-import * as React from 'react';
-import { Image } from "../interfaces";
-/**
- * This context is used for transferring image
- * data between different areas of the application.
- *
- * It stores base64 image files that have been read
- * in from ImageSelect component for the purpose of
- * being cropped and uploaded in ImageUploadView.
- *
- * Image objects uploaded in ImageUploadView can then be
- * stored in the context for use in the component
- * that initially requested the upload.
- */
-interface IImageStorageContext {
-    /**
-     * Retrieve the stored base64 dataUrl. This will
-     * reset the stored value after it is read.
-     */
-    getDataUrl: () => string;
-    /**
-     * Set the stored dataUrl.
-     */
-    setDataUrl: (dataUrl: string) => void;
-    /**
-     * Retrieve the stored image object. This will
-     * reset the stored image object.
-     */
-    getImage: () => Image;
-    /**
-     * Store an image after it has been successfully
-     * uploaded.
-     */
-    setImage: (image: Image) => void;
-    /**
-     * Flag to notify anything using this context
-     * that an image has been uploaded.
-     */
-    imageUploaded: boolean;
-}
-export declare const ImageStorageContext: React.Context<IImageStorageContext>;
-export declare const ImageStorageContextProvider: ({ children }: {
-    children?: React.ReactNode;
-}) => JSX.Element;
-export {};

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

@@ -1,4 +0,0 @@
-export declare enum ClassificationType {
-    Subject = "Subject",
-    Topic = "Topic"
-}

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

@@ -1,5 +0,0 @@
-export declare enum CountryCode {
-    AU = "au",
-    NZ = "nz",
-    UK = "uk"
-}

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

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

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

@@ -1,11 +0,0 @@
-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

@@ -1,3 +0,0 @@
-export declare enum GlanceFormat {
-    Markdown = "text/markdown"
-}

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

@@ -1,26 +0,0 @@
-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

@@ -1,59 +0,0 @@
-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

@@ -1,20 +0,0 @@
-/**
- * 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

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

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

@@ -1,23 +0,0 @@
-export declare type PermissionsLookup = {
-    [key in PermissionName]: boolean;
-};
-export declare enum PermissionName {
-    ManageUsers = "users.manage",
-    FollowSubjects = "subjects.follow",
-    ManageSubjectPreferences = "subjects.preferences.manage",
-    CreateClassrooms = "classrooms.create",
-    ViewClassrooms = "classrooms.view",
-    SharePlaylists = "playlists.share",
-    CreatePlaylists = "playlists.create",
-    ViewPlaylists = "playlists.view",
-    FollowPlaylists = "playlists.follow",
-    ViewVideos = "videos.view",
-    ShareVideos = "videos.share",
-    UploadVideos = "videos.upload",
-    FavouriteVideos = "videos.favourite",
-    CreateInteractives = "interactives.create",
-    ViewInteractives = "interactives.view",
-    CreateClips = "clips.create",
-    ViewClips = "clips.view",
-    EditProfile = "settings.editprofile"
-}

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

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

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

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

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

@@ -1,9 +0,0 @@
-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

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

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

@@ -1,17 +0,0 @@
-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

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