@clickview/player 0.0.4-rc.0 → 0.0.4-rc.2

package/dist/libs/shared/src/interfaces/models/User.d.ts

@@ -0,0 +1,102 @@
+import { BaseObject, Group, Avatar, YearGroup, CustomerCollection } from 'libs/shared/interfaces';
+import { UserRole } from 'libs/shared/enums/UserRole';
+import { OnlineUserRole } from 'libs/shared/enums/UserRole';
+import { UserGroup } from 'libs/shared/enums/UserGroup';
+import { ObjectStatus } from 'libs/shared/enums/ObjectStatus';
+import { VirtualObject } from './primitives';
+export declare type OnlineYearGroup = 'Kindergarten' | 'Year 1' | 'Year 2' | 'Year 3' | 'Year 4' | 'Year 5' | 'Year 6' | 'Year 7' | 'Year 8' | 'Year 9' | 'Year 10' | 'Year 11' | 'Year 12' | 'Year 13' | 'Staff';
+/**
+ * Master User
+ */
+export interface User extends BaseObject {
+    id: string;
+    name: string;
+    surname: string;
+    bio: string;
+    email: string;
+    username: string;
+    status: ObjectStatus;
+    role: UserRole;
+    customers: CustomerCollection;
+    userType: UserGroup;
+    avatar?: Avatar;
+    isPrimaryContact: boolean;
+    isEmailVerified: boolean;
+    roleId: OnlineUserRole;
+    lastSignInDate?: string;
+    metadata?: {
+        lastSignInTime?: string;
+    };
+    _yearGroup: VirtualYearGroup;
+}
+export interface CuratorUser extends User {
+    userId: string;
+    firstName: string;
+    countryCode: string;
+    groups: Group[];
+}
+/**
+ * Current User for Lite/Cloud
+ */
+export interface CurrentUser extends BaseObject {
+    id: string;
+    username: string;
+    avatar: string;
+    timeZone: string;
+    role: 'Admin' | 'Guest' | 'User' | 'SuperAdmin';
+    displayName: string;
+    givenName: string;
+    familyName: string;
+    email: string;
+    emailVerified: boolean;
+    customerId: string;
+    customerName: string;
+    customerLogo: string;
+    /**
+     * Regional instance the user (and their cusomter) belong to.
+     *
+     * @remarks
+     * This effectively dictates which region the user and their customer reside in and should be used
+     * in any scenario where data needs to be collected, controlled or mapped within that same region.
+     *
+     * Examples:
+     * 1. Any logic that relies on OnlineDB
+     * 2. Analytics data should all be logged in the same region, irrespective of where they're logged in.
+     * 3. Uploaded files and videos should all be targeted to the same region.
+     *
+     * This is not the same as CountryCode or ContentRegion.
+     */
+    instanceRegion: string;
+    /**
+     * The content set the user should have access to.
+     *
+     * @remarks
+     * Content is not tied to a country or instance region.
+     */
+    contentRegion: string;
+    /**
+     * User's Country in Master
+     *
+     * @remarks
+     * In most circumstances you'll want to use the user's InstanceRegion or ContentRegion over this.
+     * This is also different to the instance CountryCode used in the Config.
+     *
+     * Example:
+     * Scottish User/Customer will have their CountryCode set to GBR, not the UK.
+     */
+    countryCode: string;
+}
+/**
+ * Current User for Online
+ */
+export interface OnlineCurrentUser extends CurrentUser {
+    yearGroup: string;
+    crmId: string;
+    customerType: string;
+    onlineRole: OnlineUserRole;
+    maxAllowedRating: number;
+}
+interface VirtualYearGroup extends VirtualObject {
+    value: YearGroup;
+}
+export {};

package/dist/libs/shared/src/interfaces/models/UserChannel.d.ts

@@ -0,0 +1,7 @@
+import { BaseObject } from './primitives';
+import { Thumbnail } from './Thumbnail';
+export interface UserChannel extends BaseObject {
+    thumbnail: Thumbnail;
+    description: string;
+    verified: boolean;
+}

package/dist/libs/shared/src/interfaces/models/Video.d.ts

@@ -0,0 +1,45 @@
+import { BaseObject, CompanyCollection, PersonCollection, CategoryCollection, Channel, InteractiveCollection, LibraryCollection, Rating, Series, Thumbnail, TagCollection, Season, AudienceCollection, ResourceCollection, LinkCollection, ClipCollection, Glance, HeroBanner, RestrictedObject, VideoProgress, UserCollection, HasInteractive, CurriculumLinks } from 'libs/shared/interfaces';
+import { HasCurriculumLinks } from './Curriculum';
+import { User } from './User';
+import { SubtitleCollection } from '../collections';
+import { VirtualObject } from './primitives';
+export interface Video extends BaseObject {
+    categories?: CategoryCollection;
+    channel?: Channel;
+    description?: string;
+    duration?: number;
+    interactives?: InteractiveCollection;
+    libraries?: LibraryCollection;
+    productionYear?: number;
+    rating?: Rating;
+    series?: Series;
+    thumbnail?: Thumbnail;
+    tags?: TagCollection;
+    season?: Season;
+    episodeNumber?: number;
+    subjectPresentationAudiences?: AudienceCollection;
+    resources?: ResourceCollection;
+    subtitles?: SubtitleCollection;
+    productionCompanies?: CompanyCollection;
+    distributors?: CompanyCollection;
+    producers?: PersonCollection;
+    directors?: PersonCollection;
+    clips?: ClipCollection;
+    links?: LinkCollection;
+    glance?: Glance;
+    owner?: User;
+    hasSubtitle?: boolean;
+    heroBanner?: HeroBanner;
+    restrictions?: RestrictedObject[];
+    lastProgressPoint?: number;
+    favouritedBy?: UserCollection;
+    _hasInteractives?: HasInteractive;
+    _videoProgress?: VideoProgress;
+    _hasCurriculumLinks?: HasCurriculumLinks;
+    _curriculumLinks?: CurriculumLinks;
+    _canUpdate?: CanUpdate;
+    hasInteractives?: boolean;
+}
+export interface CanUpdate extends VirtualObject {
+    value: boolean;
+}

package/dist/libs/shared/src/interfaces/models/VideoHistory.d.ts

@@ -0,0 +1,12 @@
+import { BaseObject, VirtualObject } from './primitives';
+export interface VideoHistory extends Omit<BaseObject, 'id' | 'name'> {
+    videoId: string;
+    userId: string;
+    customerId: string;
+    lastDateWatched: string;
+    lastTimeWatched: string;
+    lastProgressPoint: number;
+}
+export interface VideoProgress extends VirtualObject {
+    progress: number;
+}

package/dist/libs/shared/src/interfaces/models/Widget.d.ts

@@ -0,0 +1,16 @@
+import { BaseObject } from 'libs/shared/interfaces';
+/**
+ * This maps directly against the widget types from Domain.
+ * Update is only required where the backend changes.
+ */
+export declare enum WidgetType {
+    Row = 0,
+    LargeRow = 1,
+    Hero = 2,
+    ResourcesTile = 3
+}
+export interface Widget extends Omit<BaseObject, 'type'> {
+    collectionId: number;
+    dashboardId: number;
+    type: WidgetType;
+}

package/dist/libs/shared/src/interfaces/models/YearGroup.d.ts

@@ -0,0 +1,5 @@
+import { BaseObject } from './primitives';
+export interface YearGroup extends BaseObject {
+    value: number;
+    description: string;
+}

package/dist/libs/shared/src/interfaces/models/index.d.ts

@@ -0,0 +1,59 @@
+export * from './primitives';
+export * from './interactive';
+export * from './interactive-results';
+export * from './Audience';
+export * from './Avatar';
+export * from './Banner';
+export * from './Category';
+export * from './Channel';
+export * from './Classroom';
+export * from './ClassroomGroup';
+export * from './Config';
+export * from './Cover';
+export * from './Curriculum';
+export * from './EntitySetting';
+export * from './HeroBanner';
+export * from './Image';
+export * from './InteractiveMetadata';
+export * from './Library';
+export * from './Playlist';
+export * from './Rating';
+export * from './Season';
+export * from './Series';
+export * from './Season';
+export * from './Subject';
+export * from './Tag';
+export * from './Theme';
+export * from './Thumbnail';
+export * from './User';
+export * from './Video';
+export * from './Widget';
+export * from './Classification';
+export * from './Presentation';
+export * from './PresentationAudience';
+export * from './Poster';
+export * from './Resource';
+export * from './Person';
+export * from './Company';
+export * from './LanguageConfig';
+export * from './Clip';
+export * from './Link';
+export * from './Folder';
+export * from './Glance';
+export * from './Customer';
+export * from './Organisation';
+export * from './TallPoster';
+export * from './Share';
+export * from './Restriction';
+export * from './Video';
+export * from './Following';
+export * from './UserChannel';
+export * from './Group';
+export * from './VideoHistory';
+export * from './EntitySetting';
+export * from './Subtitle';
+export * from './Language';
+export * from './FileUpload';
+export * from './PlayerViewKey';
+export * from './YearGroup';
+export * from './Country';

package/dist/libs/shared/src/interfaces/models/interactive/ActionableItem.d.ts

@@ -0,0 +1,6 @@
+import { BaseObject } from 'libs/shared/interfaces/models/primitives/BaseObject';
+export interface ActionableItem extends BaseObject {
+    order?: number;
+    isCorrect?: boolean;
+    interactionId?: string;
+}

package/dist/libs/shared/src/interfaces/models/interactive/Interaction.d.ts

@@ -0,0 +1,14 @@
+import { HashObject } from 'libs/common/react/interfaces/HashObject';
+import { ActionableItem } from './ActionableItem';
+import { InteractionTypeId } from './InteractionTypeId';
+import { BaseObject } from '../primitives';
+export interface Interaction extends Omit<BaseObject, 'type' | 'typeId'> {
+    typeId: InteractionTypeId;
+    timepointId: string;
+    order: number;
+    interactiveId: string;
+    errorMessage?: string;
+    description?: string;
+    data: HashObject;
+    actionableItems?: ActionableItem[];
+}

package/dist/libs/shared/src/interfaces/models/interactive/InteractionTypeId.d.ts

@@ -0,0 +1,8 @@
+export declare enum InteractionTypeId {
+    MultipleChoice = 1,
+    ShortAnswer = 2,
+    TrueOrFalse = 3,
+    Annotation = 4,
+    Image = 5,
+    MissingWord = 6
+}

package/dist/libs/shared/src/interfaces/models/interactive/Interactive.d.ts

@@ -0,0 +1,7 @@
+import { BaseObject } from 'libs/shared/interfaces/models/primitives/BaseObject';
+import { Timepoint } from './Timepoint';
+export interface Interactive extends BaseObject {
+    immediateFeedback: boolean;
+    posterImage?: string;
+    timepoints?: Timepoint[];
+}

package/dist/libs/shared/src/interfaces/models/interactive/Timepoint.d.ts

@@ -0,0 +1,9 @@
+import { BaseObject } from 'libs/shared/interfaces/models/primitives/BaseObject';
+import { Interaction } from './Interaction';
+export interface Timepoint extends BaseObject {
+    interactiveId: string;
+    shouldPause: number;
+    visibleAt: number;
+    visibleFor?: number;
+    interactions?: Interaction[];
+}

package/dist/libs/shared/src/interfaces/models/interactive/index.d.ts

@@ -0,0 +1,5 @@
+export * from './ActionableItem';
+export * from './Interaction';
+export * from './InteractionTypeId';
+export * from './Interactive';
+export * from './Timepoint';

package/dist/libs/shared/src/interfaces/models/interactive-results/InteractiveResult.d.ts

@@ -0,0 +1,5 @@
+import { StudentAttempt } from 'libs/shared/interfaces';
+export interface InteractiveResult {
+    id: string;
+    attempts: StudentAttempt[];
+}

package/dist/libs/shared/src/interfaces/models/interactive-results/InteractiveResultSet.d.ts

@@ -0,0 +1,6 @@
+import { StudentResults } from 'libs/shared/interfaces';
+export interface InteractiveResultSet {
+    id: string;
+    duration: number;
+    students: StudentResults[];
+}

package/dist/libs/shared/src/interfaces/models/interactive-results/StudentAnswer.d.ts

@@ -0,0 +1,9 @@
+import { InteractiveAnswerStatus } from 'libs/shared/enums/InteractiveAnswerStatus';
+export interface StudentAnswer {
+    id: string;
+    text: string;
+    resultId: string;
+    questionId: string;
+    status: InteractiveAnswerStatus;
+    dateCreated: string;
+}

package/dist/libs/shared/src/interfaces/models/interactive-results/StudentAttempt.d.ts

@@ -0,0 +1,6 @@
+import { StudentAnswer } from 'libs/shared/interfaces';
+export interface StudentAttempt {
+    id: string;
+    answeredAt: number;
+    answers: StudentAnswer[];
+}

package/dist/libs/shared/src/interfaces/models/interactive-results/StudentResult.d.ts

@@ -0,0 +1,6 @@
+import { InteractiveResult } from 'libs/shared/interfaces';
+export interface StudentResults {
+    name: string;
+    username: string;
+    results: InteractiveResult[];
+}

package/dist/libs/shared/src/interfaces/models/interactive-results/index.d.ts

@@ -0,0 +1,5 @@
+export * from './InteractiveResultSet';
+export * from './InteractiveResult';
+export * from './StudentAnswer';
+export * from './StudentAttempt';
+export * from './StudentResult';

package/dist/libs/shared/src/interfaces/models/primitives/BaseObject.d.ts

@@ -0,0 +1,10 @@
+import { MasterType } from 'libs/shared/enums/MasterType';
+export interface BaseObject {
+    id?: string;
+    name?: string;
+    type?: string;
+    typeId?: MasterType;
+    dateCreated?: string;
+    dateModified?: string;
+    dateAssociated?: string;
+}

package/dist/libs/shared/src/interfaces/models/primitives/VirtualObject.d.ts

@@ -0,0 +1,5 @@
+export interface VirtualObject {
+    id?: string;
+    type?: string;
+    typeId?: string;
+}

package/dist/libs/shared/src/interfaces/models/primitives/index.d.ts

@@ -0,0 +1,2 @@
+export * from './BaseObject';
+export * from './VirtualObject';

package/dist/libs/shared/src/interfaces/props/ViewProps.d.ts

@@ -0,0 +1,8 @@
+import { AnalyticsOptions } from 'libs/analytics/interfaces';
+export interface PopupViewProps {
+    closePopup: () => void;
+}
+export declare type PropsWithPopupViewProps<P> = P & PopupViewProps;
+export declare type PropsWithAnalyticsOptions<P> = P & {
+    analyticsOptions: AnalyticsOptions;
+};

package/dist/libs/shared/src/interfaces/props/index.d.ts

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

package/dist/libs/shared/src/interfaces/requests/CreateInteractiveMetadataRequest.d.ts

@@ -0,0 +1,12 @@
+import { CurationStatus } from 'libs/shared/enums/CurationStatus';
+import { InteractiveOriginType } from 'libs/shared/enums/InteractiveOriginType';
+export interface CreateInteractiveMetadataRequest {
+    name: string;
+    description?: string;
+    interactiveId: string;
+    originType: InteractiveOriginType;
+    owner: {
+        id: string;
+    };
+    status: CurationStatus;
+}

package/dist/libs/shared/src/interfaces/requests/CreateInteractiveRequest.d.ts

@@ -0,0 +1,5 @@
+export interface CreateInteractiveRequest {
+    name: string;
+    duration: number;
+    immediateFeedback: boolean;
+}

package/dist/libs/shared/src/interfaces/requests/CreateOrUpdateClipRequest.d.ts

@@ -0,0 +1,6 @@
+export interface CreateOrUpdateClipRequest {
+    name: string;
+    description?: string;
+    startTime: number;
+    endTime: number;
+}

package/dist/libs/shared/src/interfaces/requests/CreateViewKeyRequest.d.ts

@@ -0,0 +1,3 @@
+export interface CreateViewKeyRequest {
+    mediaId: string;
+}

package/dist/libs/shared/src/interfaces/requests/EditDetailsRequest.d.ts

@@ -0,0 +1,5 @@
+export interface EditDetailsRequest {
+    name: string;
+    description?: string;
+    immediateFeedback?: boolean;
+}

package/dist/libs/shared/src/interfaces/requests/EditInteractiveMetadataOriginRequest.d.ts

@@ -0,0 +1,5 @@
+import { InteractiveOriginType } from 'libs/shared/enums/InteractiveOriginType';
+export declare class EditInteractiveMetadataOriginRequest {
+    originType: InteractiveOriginType;
+    interactiveId: string;
+}

package/dist/libs/shared/src/interfaces/requests/EditInteractiveMetadataRequest.d.ts

@@ -0,0 +1,6 @@
+import { CurationStatus } from 'libs/shared/enums/CurationStatus';
+export interface EditInteractiveMetadataRequest {
+    name: string;
+    description?: string;
+    status: CurationStatus;
+}

package/dist/libs/shared/src/interfaces/requests/EditInteractiveRequest.d.ts

@@ -0,0 +1,6 @@
+export interface EditInteractiveRequest {
+    id: string;
+    name: string;
+    duration: number;
+    immediateFeedback: boolean;
+}

package/dist/libs/shared/src/interfaces/requests/ReorderRequest.d.ts

@@ -0,0 +1,12 @@
+export interface ReorderRequest {
+    /**
+     * ID of object we want to move.
+     */
+    sourceMemberId: string;
+    /**
+     * ID of object that will be directly below the source object after reordering.
+     *
+     * Set to null if the source object is being moved to the last position.
+     */
+    destinationMemberId?: string;
+}

package/dist/libs/shared/src/interfaces/requests/UpdateObjectChannel.d.ts

@@ -0,0 +1,3 @@
+export interface UpdateObjectChannel {
+    id: string;
+}

package/dist/libs/shared/src/interfaces/requests/UpdateObjectRating.d.ts

@@ -0,0 +1,3 @@
+export interface UpdateObjectRating {
+    id: string;
+}

package/dist/libs/shared/src/interfaces/requests/UpdateResourceRequest.d.ts

@@ -0,0 +1,3 @@
+export interface UpdateResourceRequest {
+    name: string;
+}

package/dist/libs/shared/src/interfaces/requests/UpdateVideoRequest.d.ts

@@ -0,0 +1,9 @@
+import { UpdateObjectRating, UpdateObjectChannel, Thumbnail } from 'libs/shared/interfaces';
+export interface UpdateVideoRequest {
+    name: string;
+    description?: string;
+    rating: UpdateObjectRating;
+    dateBroadcast?: string;
+    channel?: UpdateObjectChannel;
+    thumbnail?: Thumbnail;
+}

package/dist/libs/shared/src/interfaces/requests/index.d.ts

@@ -0,0 +1,13 @@
+export * from './CreateOrUpdateClipRequest';
+export * from './CreateViewKeyRequest';
+export * from './ReorderRequest';
+export * from './UpdateObjectChannel';
+export * from './UpdateObjectRating';
+export * from './UpdateResourceRequest';
+export * from './UpdateVideoRequest';
+export * from './CreateInteractiveRequest';
+export * from './CreateInteractiveMetadataRequest';
+export * from './EditDetailsRequest';
+export * from './EditInteractiveRequest';
+export * from './EditInteractiveMetadataRequest';
+export * from './EditInteractiveMetadataOriginRequest';

package/dist/libs/shared/src/interfaces/services/BaseConfigDataService.d.ts

@@ -0,0 +1,5 @@
+import { Config } from 'libs/shared/interfaces';
+export interface BaseConfigDataService {
+    getConfig(success?: (config: Config) => void, error?: () => void): void;
+    getVersion(success?: (version: string) => void, error?: () => void): void;
+}

package/dist/libs/shared/src/interfaces/services/BaseLibraryDataService.d.ts

@@ -0,0 +1,10 @@
+import { Core } from 'libs/common/core';
+import { Library, Folder } from 'libs/shared/interfaces';
+export interface LibraryAPIResponse {
+    data: Library;
+    children: Folder[];
+}
+export interface BaseLibraryDataService {
+    getLibraries: (callback?: (data?: Core.Collection) => void) => Core.Collection;
+    getFolder: (id: string, callback?: (data?: Core.Model) => void) => Core.Model;
+}

package/dist/libs/shared/src/interfaces/services/BaseSeriesDataService.d.ts

@@ -0,0 +1,4 @@
+import { Core } from 'libs/common/core';
+export interface BaseSeriesDataService {
+    getSeries: (id: string, callback?: (data?: Core.Model) => void) => Core.Model;
+}

package/dist/libs/shared/src/interfaces/services/BaseSettingsDataService.d.ts

@@ -0,0 +1,7 @@
+import { SettingName } from 'libs/shared/enums/SettingName';
+import { EntitySetting } from 'libs/shared/interfaces';
+import { SettingKind } from 'libs/shared/enums/SettingKind';
+export interface BaseSettingsDataService<TSettingModel = EntitySetting, TSettingCollection = EntitySetting[]> {
+    getSetting: (entityId: string, name: SettingName, callback?: (data: TSettingModel) => void) => TSettingModel;
+    getSettings: (entityId: string, kind?: SettingKind, callback?: (data: TSettingCollection) => void) => TSettingCollection;
+}

package/dist/libs/shared/src/interfaces/services/BaseUserDataService.d.ts

@@ -0,0 +1,6 @@
+import { CurrentUser } from 'libs/shared/interfaces';
+import { HashObject } from 'libs/common/react/interfaces';
+export interface BaseUserDataService {
+    getCurrentUser(success?: (user: CurrentUser) => void, error?: () => void): void;
+    getWorkspace(success?: (workspace: HashObject) => void, error?: () => void): void;
+}

package/dist/libs/shared/src/interfaces/services/BaseVideoDataService.d.ts

@@ -0,0 +1,5 @@
+import { Core } from 'libs/common/core';
+export interface BaseVideoDataService<T extends Core.Collection> {
+    clearVideoCache(): void;
+    getVideos(ids: string[], callback?: (videos: T) => void): T;
+}

package/dist/libs/shared/src/interfaces/services/BaseVideoUploadDataService.d.ts

@@ -0,0 +1,8 @@
+import { Core } from 'libs/common/core';
+export interface BaseVideoUploadDataService {
+    clearPendingItems(ids: string[], callback?: () => void): void;
+    cancelPendingItems(ids: string[], callback?: () => void): void;
+    retryPendingItems(ids: string[], callback?: () => void): void;
+    getPendingItem(id: string, callback: (item: Core.Model) => void): void;
+    getPendingItems(callback: (items: any[]) => void): void;
+}

package/dist/libs/shared/src/interfaces/services/index.d.ts

@@ -0,0 +1,7 @@
+export * from './BaseVideoDataService';
+export * from './BaseVideoUploadDataService';
+export * from './BaseLibraryDataService';
+export * from './BaseSeriesDataService';
+export * from './BaseSettingsDataService';
+export * from './BaseUserDataService';
+export * from './BaseConfigDataService';

package/dist/libs/shared/src/utils/DialogHelper.d.ts

@@ -0,0 +1,24 @@
+import React from 'react';
+import { PopupButton } from 'libs/shared/components/popup/PopupButtons';
+import { SimpleCropperProps } from 'libs/shared/components/image-cropper/SimpleCropper';
+export interface DialogButton extends Omit<PopupButton, 'onClick'> {
+    onClick?: () => void;
+    success?: boolean;
+}
+interface DialogOptions {
+    title?: string;
+    buttons?: DialogButton[];
+    success?: () => void;
+    cancel?: () => void;
+    size?: 'sm' | 'lg' | 'xl';
+    hideButtons?: boolean;
+    centered?: boolean;
+    dialogClassName?: string;
+}
+export declare const DialogHelper: {
+    render: (children: React.SFCElement<any> | React.SFCElement<any>[], options?: DialogOptions) => void;
+    getCancelDefault(): DialogButton;
+    getConfirmDefault(): DialogButton;
+    renderCropper(props: Omit<SimpleCropperProps, 'closePopup'>): void;
+};
+export {};

package/dist/libs/shared/src/utils/DurationHelper.d.ts

@@ -0,0 +1,7 @@
+declare const DurationHelper: {
+    /**
+     * Copypasta from Online. Feel free to improve it if you see fit - Sha
+     */
+    ToDisplayDuration(milliseconds: number): string;
+};
+export { DurationHelper };