@clickview/player 0.0.3 → 0.0.4-rc.1

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

@@ -0,0 +1,20 @@
+/// <reference types="react" />
+import { Interaction } from 'libs/shared/interfaces';
+interface InteractionLabelProps {
+    interaction: Interaction;
+    smallIcon?: boolean;
+    showIcon?: boolean;
+    showTypeName?: boolean;
+    showQuestion?: boolean;
+    iconClassName?: string;
+    typeNameClassName?: string;
+    questionClassName?: string;
+}
+export declare function InteractionLabel(props: InteractionLabelProps): JSX.Element;
+export declare namespace InteractionLabel {
+    var defaultProps: {
+        showIcon: boolean;
+        showQuestion: boolean;
+    };
+}
+export {};

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

@@ -2,10 +2,12 @@ import * as React from 'react';
 import { HashObject } from 'libs/common/react/interfaces';
 import { Core } from 'libs/common/core';
 import { AnalyticsOptions } from 'libs/analytics/interfaces';
+import { SvgContainerSize } from 'libs/shared/components/svg-container/SvgContainer';
 export interface HeaderButton {
     appLink?: Core.AppLink;
     onClick?: (e: React.MouseEvent) => void;
     svgName?: string;
+    svgSize?: SvgContainerSize;
     className?: string;
     tooltip?: string;
     showSpinner?: boolean;

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

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

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

@@ -1,5 +1,5 @@
 export declare enum UserGroup {
-    Unknown = 0,
-    Staff = 1,
-    Learner = 2
+    Unknown = "unknown",
+    Staff = "staff",
+    Learner = "learner"
 }

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

@@ -8,8 +8,8 @@ export declare enum OnlineUserRole {
     ReadOnly = 8
 }
 export declare enum UserRole {
-    Guest = 16,
-    User = 32,
-    Admin = 48,
-    SuperAdmin = 64
+    Guest = "Guest",
+    User = "User",
+    Admin = "Admin",
+    SuperAdmin = "SuperAdmin"
 }

package/dist/libs/shared/src/hooks/UseGrabCursorProps.d.ts

@@ -0,0 +1,15 @@
+import React from 'react';
+/**
+ * This is a bit of a dumpster fire but it's the only sane solution
+ * I could find for implementing proper cursors while using
+ * react-sortable-hoc
+ * https://github.com/clauderic/react-sortable-hoc/issues/328
+ */
+export declare const useGrabCursorProps: () => {
+    ref: React.MutableRefObject<HTMLDivElement>;
+    style: {
+        cursor: string;
+    };
+    onMouseDown: () => void;
+    onMouseUp: () => void;
+};

package/dist/libs/shared/src/images/svg/ImportedSvgs.d.ts

@@ -87,5 +87,7 @@ export declare enum localSvgs {
     Print = "print",
     CreateInteractive = "create-interactive",
     Twitter = "twitter",
-    Facebook = "facebook"
+    Facebook = "facebook",
+    Classrooms = "classrooms",
+    Group = "group"
 }

package/dist/libs/shared/src/images/svg/objects/index.d.ts

@@ -26,6 +26,8 @@ import History from './history.svg';
 import Email from './email.svg';
 import YearLevel from './year-level.svg';
 import Subjects from './subjects.svg';
+import Classrooms from './classrooms.svg';
+import Group from './group.svg';
 import File from './file.svg';
 import FilePDF from './file-pdf.svg';
 import FileImg from './file-img.svg';
@@ -35,4 +37,4 @@ import FileZip from './file-zip.svg';
 import FileExcel from './file-excel.svg';
 import Twitter from './twitter.svg';
 import Facebook from './facebook.svg';
-export { Archive, Bell, Bookmark, Broadcast, Calendar, Cog, Folder, Handle, Interactive, Link, Playlist, PublisherArchive, Resources, StarOutline, Star, Tag, Time, Video, Subject, Series, File, FilePDF, FileImg, FilePowerpoint, FileWord, FileZip, FileExcel, Heart, HeartOutline, WhiteWave, Compass, History, Email, YearLevel, Subjects, Twitter, Facebook };
+export { Archive, Bell, Bookmark, Broadcast, Calendar, Cog, Folder, Handle, Interactive, Link, Playlist, PublisherArchive, Resources, StarOutline, Star, Tag, Time, Video, Subject, Series, File, FilePDF, FileImg, FilePowerpoint, FileWord, FileZip, FileExcel, Heart, HeartOutline, WhiteWave, Compass, History, Email, YearLevel, Subjects, Twitter, Facebook, Classrooms, Group };

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

@@ -1,5 +1,6 @@
-import { BaseObject, UserCollection } from 'libs/shared/interfaces';
+import { BaseObject, UserCollection, User } from 'libs/shared/interfaces';
 export interface Classroom extends BaseObject {
     users?: UserCollection;
     favouritedBy?: UserCollection;
+    owner?: User;
 }

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

@@ -1,12 +1,15 @@
-import { BaseObject, User, Video } from 'libs/shared/interfaces';
+import { BaseObject, InteractiveCollection, User, Video } from 'libs/shared/interfaces';
 import { VirtualObject } from './primitives';
+import { CanUpdate } from './Video';
 export interface Clip extends BaseObject {
     description?: string;
     startTime: number;
     endTime: number;
     owner?: User;
     video?: Video;
+    interactives?: InteractiveCollection;
     _isClickViewContent?: IsClickViewContent;
+    _canUpdate?: CanUpdate;
 }
 interface IsClickViewContent extends VirtualObject {
     value: boolean;

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

@@ -3,6 +3,7 @@ import { CountryCode } from 'libs/shared/enums/CountryCode';
 export interface Config extends BaseObject {
     supportSiteUrl: string;
     imageCdnUrl: string;
+    countryCode: CountryCode;
     webPlayerUrl: string;
     gatewayApiUrl: string;
     notificationServiceUrl?: string;
@@ -12,11 +13,4 @@ export interface Config extends BaseObject {
     downloadProxy?: string;
     primaryUrl?: string;
     marketingSiteUrl?: string;
-    /**
-     * Instance CountryCode
-     *
-     * This is NOT the same as the customer/user CountryCode.
-     * This should only be used for legacy reasons where InstanceRegion is not supported.
-     */
-    countryCode: CountryCode;
 }

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

@@ -1,8 +1,7 @@
 import { BaseObject, Country } from 'libs/shared/interfaces';
 import { Organisation } from './Organisation';
 export interface Customer extends BaseObject {
-    crmId: string;
-    instanceRegion: string;
     organisation?: Organisation;
+    crmId: string;
     country?: Country;
 }

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

@@ -2,7 +2,9 @@ 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';
+import { Clip } from './Clip';
 import { Timepoint } from './interactive';
+import { CanUpdate } from './Video';
 export interface InteractiveMetadata extends BaseObject {
     status: CurationStatus;
     interactiveId: string;
@@ -10,10 +12,12 @@ export interface InteractiveMetadata extends BaseObject {
     description?: string;
     thumbnail?: Thumbnail;
     video?: Video;
+    clip?: Clip;
     duration?: number;
     originType: InteractiveOriginType;
     _isClickViewContent?: IsClickViewContent;
     _timepoints?: VirtualTimepoints;
+    _canUpdate?: CanUpdate;
 }
 export interface HasInteractive extends VirtualObject {
     value: boolean;

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

@@ -7,4 +7,7 @@ export interface Series extends BaseObject {
     videos: VideoCollection;
     rating?: Rating;
     subjectPresentationAudiences?: PresentationAudienceCollection;
+    metadata?: {
+        year?: number;
+    };
 }

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

@@ -1,8 +1,9 @@
-import { BaseObject, Group, Avatar, YearGroup, CustomerCollection, YearGroupCollection } from 'libs/shared/interfaces';
+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
@@ -17,14 +18,16 @@ export interface User extends BaseObject {
     status: ObjectStatus;
     role: UserRole;
     customers: CustomerCollection;
-    yearGroup: OnlineYearGroup;
-    yearGroups: YearGroupCollection;
-    masterYearGroup: YearGroup;
     userType: UserGroup;
     avatar?: Avatar;
     isPrimaryContact: boolean;
+    isEmailVerified: boolean;
     roleId: OnlineUserRole;
     lastSignInDate?: string;
+    metadata?: {
+        lastSignInTime?: string;
+    };
+    _yearGroup: VirtualYearGroup;
 }
 export interface CuratorUser extends User {
     userId: string;
@@ -48,40 +51,8 @@ export interface CurrentUser extends BaseObject {
     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;
+    customerLogo: string;
 }
 /**
  * Current User for Online
@@ -93,3 +64,7 @@ export interface OnlineCurrentUser extends CurrentUser {
     onlineRole: OnlineUserRole;
     maxAllowedRating: number;
 }
+interface VirtualYearGroup extends VirtualObject {
+    value: YearGroup;
+}
+export {};

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

@@ -2,6 +2,7 @@ import { BaseObject, CompanyCollection, PersonCollection, CategoryCollection, Ch
 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;
@@ -36,5 +37,9 @@ export interface Video extends BaseObject {
     _videoProgress?: VideoProgress;
     _hasCurriculumLinks?: HasCurriculumLinks;
     _curriculumLinks?: CurriculumLinks;
+    _canUpdate?: CanUpdate;
     hasInteractives?: boolean;
 }
+export interface CanUpdate extends VirtualObject {
+    value: boolean;
+}

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

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

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

@@ -0,0 +1,16 @@
+import { Interaction, StudentAnswer } from 'libs/shared/interfaces';
+import { InteractionCorrectness } from 'libs/shared/enums/InteractionCorrectness';
+declare type GetStudentAnswerByActionableItemId = (id: string) => string;
+declare function notApplicable(): InteractionCorrectness;
+declare function awaitingMarking(): InteractionCorrectness;
+declare function isMissingWordCorrect(interaction: Interaction, getStudentAnswer: GetStudentAnswerByActionableItemId): InteractionCorrectness;
+declare function isMultipleChoiceCorrect(interaction: Interaction, getStudentAnswer: GetStudentAnswerByActionableItemId): InteractionCorrectness;
+declare function isShortAnswerMarkedCorrect(interaction: Interaction, getStudentAnswer: (id: string) => StudentAnswer): InteractionCorrectness;
+export declare const InteractiveCorrectnessHelper: {
+    notApplicable: typeof notApplicable;
+    awaitingMarking: typeof awaitingMarking;
+    isMissingWordCorrect: typeof isMissingWordCorrect;
+    isMultipleChoiceCorrect: typeof isMultipleChoiceCorrect;
+    isShortAnswerMarkedCorrect: typeof isShortAnswerMarkedCorrect;
+};
+export {};