@clickview/player 0.0.3-dev-us.7 → 0.0.3-dev.0

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

@@ -0,0 +1,22 @@
+import { CurationStatus } from 'libs/shared/enums/CurationStatus';
+import { InteractiveOriginType } from 'libs/shared/enums/InteractiveOriginType';
+import { BaseObject, VirtualObject } from 'libs/shared/interfaces';
+import { User, Thumbnail, Video } from 'libs/shared/interfaces/models';
+export interface InteractiveMetadata extends BaseObject {
+    status: CurationStatus;
+    interactiveId: string;
+    owner: User;
+    description?: string;
+    thumbnail?: Thumbnail;
+    video?: Video;
+    duration?: number;
+    _isClickViewContent?: IsClickViewContent;
+    originType: InteractiveOriginType;
+}
+export interface HasInteractive extends VirtualObject {
+    value: boolean;
+}
+interface IsClickViewContent extends VirtualObject {
+    value: boolean;
+}
+export {};

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

@@ -0,0 +1,4 @@
+export interface Language {
+    code: string;
+    name: string;
+}

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

@@ -0,0 +1,5 @@
+import { HashObject } from 'libs/common/react/interfaces/HashObject';
+export interface LanguageConfig {
+    locale: string;
+    phrases: HashObject;
+}

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

@@ -0,0 +1,8 @@
+import { StaffRequestRole } from 'libs/shared/enums/StaffRequestRole';
+import { BaseObject } from 'libs/shared/interfaces';
+export interface Library extends BaseObject {
+    allowedStaffRequestRole?: StaffRequestRole;
+    isHiddenLibrary: boolean;
+    isSharedLibrary: boolean;
+    type: 'custom_library' | 'hosted_library' | 'exchange' | 'workspace' | 'online_supplementary_library';
+}

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

@@ -0,0 +1,4 @@
+import { BaseObject } from 'libs/shared/interfaces';
+export interface Link extends BaseObject {
+    url: string;
+}

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

@@ -0,0 +1,3 @@
+import { BaseObject } from 'libs/shared/interfaces';
+export interface Organisation extends BaseObject {
+}

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

@@ -0,0 +1,4 @@
+import { BaseObject } from './primitives';
+export interface Pdf extends BaseObject {
+    url: string;
+}

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

@@ -0,0 +1,3 @@
+import { BaseObject } from 'libs/shared/interfaces';
+export interface Person extends BaseObject {
+}

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

@@ -0,0 +1,3 @@
+export interface PlayerViewKey {
+    viewKey: string;
+}

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

@@ -0,0 +1,20 @@
+import { BaseObject, Cover, VideoCollection, User, Thumbnail, Banner, PresentationAudienceCollection, UserCollection } from 'libs/shared/interfaces';
+import { PlaylistPrivacy } from 'libs/shared/enums/PlaylistPrivacy';
+import { VirtualObject } from './primitives';
+export interface Playlist extends BaseObject {
+    description?: string;
+    thumbnail?: Thumbnail;
+    videos?: VideoCollection;
+    owner?: User;
+    cover?: Cover;
+    banner?: Banner;
+    subjectPresentationAudiences?: PresentationAudienceCollection;
+    followers?: UserCollection;
+    privacy?: PlaylistPrivacy;
+    contentModifiedDate?: string;
+    _isClickViewPlaylist?: IsClickViewPlaylist;
+    _liteOwner?: User;
+}
+export interface IsClickViewPlaylist extends VirtualObject {
+    value: boolean;
+}

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

@@ -0,0 +1,3 @@
+import { Image } from 'libs/shared/interfaces';
+export interface Poster extends Image {
+}

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

@@ -0,0 +1,9 @@
+import { Cover, BaseObject } from 'libs/shared/interfaces';
+import { PresentationType } from 'libs/shared/enums/PresentationType';
+import { PresentationStatus } from 'libs/shared/enums/PresentationStatus';
+export interface Presentation extends BaseObject {
+    cover: Cover;
+    type: PresentationType;
+    status: PresentationStatus;
+    description: string;
+}

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

@@ -0,0 +1,6 @@
+export interface PresentationAudience {
+    backboneAudienceIds: string[];
+    masterId: string;
+    name: string;
+    presentationId: string;
+}

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

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

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

@@ -0,0 +1,17 @@
+import { BaseObject } from './primitives';
+import { Thumbnail } from './Thumbnail';
+import { ResourceFileType } from 'libs/shared/enums/ResourceFileType';
+import { Pdf } from './Pdf';
+export declare type ResourceType = 'teacher-pack' | 'student-activity' | 'additional-materials' | 'atom-guide';
+interface ResourceMetadata {
+    type: ResourceFileType;
+    resourceType?: ResourceType;
+}
+export interface Resource extends BaseObject {
+    url: string;
+    metadata: ResourceMetadata;
+    fileId: string;
+    thumbnail: Thumbnail;
+    pdf?: Pdf;
+}
+export {};

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

@@ -0,0 +1,6 @@
+export interface Restriction {
+    objectId: string;
+    restrictedObjects: RestrictedObject[];
+}
+export interface RestrictedObject {
+}

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

@@ -0,0 +1,4 @@
+import { BaseObject } from './primitives';
+export interface Season extends BaseObject {
+    number: number;
+}

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

@@ -0,0 +1,10 @@
+import { BaseObject, PresentationAudienceCollection, Poster, TallPoster, Banner, Rating, VideoCollection } from 'libs/shared/interfaces';
+export interface Series extends BaseObject {
+    description: string;
+    poster: Poster;
+    tallPoster: TallPoster;
+    banner: Banner;
+    videos: VideoCollection;
+    rating?: Rating;
+    subjectPresentationAudiences?: PresentationAudienceCollection;
+}

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

@@ -0,0 +1,9 @@
+export interface Share {
+    privacy: string;
+    privacyId: number;
+    resourceId: string;
+    resourceType: string;
+    resourceUrl: string;
+    shortCode: string;
+    shortUrl: string;
+}

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

@@ -0,0 +1,13 @@
+import { BaseObject } from 'libs/shared/interfaces';
+import { Cover, Thumbnail, Banner, VideoCollection, PlaylistCollection, SeriesCollection } from 'libs/shared/interfaces';
+export interface Subject extends BaseObject {
+    banner?: Banner;
+    thumbnail?: Thumbnail;
+    children?: Subject[];
+    backboneClassificationIds: string[];
+    playlists?: PlaylistCollection;
+    videos?: VideoCollection;
+    series?: SeriesCollection;
+    parentId?: string;
+    cover?: Cover;
+}

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

@@ -0,0 +1,7 @@
+import { BaseObject } from './primitives';
+export interface Subtitle extends BaseObject {
+    language: string;
+    metadata: {
+        autoGenerated?: boolean;
+    };
+}

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

@@ -0,0 +1,3 @@
+import { BaseObject } from 'libs/shared/interfaces';
+export interface Tag extends BaseObject {
+}

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

@@ -0,0 +1,3 @@
+import { Image } from 'libs/shared/interfaces';
+export interface TallPoster extends Image {
+}

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

@@ -0,0 +1,14 @@
+import { BaseObject } from './primitives';
+import { ThemeType } from 'libs/shared/enums/ThemeType';
+import { HeroBanner } from './HeroBanner';
+export interface ThemeData {
+    bottomLeft: HeroBanner;
+    bottomRight: HeroBanner;
+    topLeft: HeroBanner;
+    topRight: HeroBanner;
+}
+export interface Theme extends BaseObject {
+    name: string;
+    type: ThemeType;
+    data: ThemeData;
+}

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

@@ -0,0 +1,6 @@
+import { Image } from 'libs/shared/interfaces';
+export interface Thumbnail extends Image {
+    metadata?: {
+        rotation?: number;
+    };
+}

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

@@ -0,0 +1,63 @@
+import { BaseObject, Group, Avatar, YearGroup, CustomerCollection, YearGroupCollection } 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';
+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;
+    yearGroup: OnlineYearGroup;
+    yearGroups: YearGroupCollection;
+    masterYearGroup: YearGroup;
+    userType: UserGroup;
+    avatar?: Avatar;
+    isPrimaryContact: boolean;
+    roleId: OnlineUserRole;
+    lastSignInDate?: string;
+}
+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;
+    countryCode: string;
+    customerLogo: string;
+}
+/**
+ * Current User for Online
+ */
+export interface OnlineCurrentUser extends CurrentUser {
+    yearGroup: string;
+    crmId: string;
+    customerType: string;
+    onlineRole: OnlineUserRole;
+    maxAllowedRating: number;
+}

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,38 @@
+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';
+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;
+    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;
+    hasInteractives?: 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;
+}