@clickview/player 0.0.2 → 0.0.3-dev-us.2

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

@@ -42,6 +42,7 @@ export declare enum localSvgs {
     Play = "play",
     PlayCircle = "play-circle",
     ArrowLeft = "arrow-left",
+    ArrowRight = "arrow-right",
     CheckCircleOutline = "check-circle-o",
     CheckCircle = "check-circle",
     Check = "check",
@@ -84,5 +85,7 @@ export declare enum localSvgs {
     Subjects = "subjects",
     Download = "download",
     Print = "print",
-    CreateInteractive = "create-interactive"
+    CreateInteractive = "create-interactive",
+    Twitter = "twitter",
+    Facebook = "facebook"
 }

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

@@ -33,4 +33,6 @@ import FilePowerpoint from './file-ppt.svg';
 import FileWord from './file-word.svg';
 import FileZip from './file-zip.svg';
 import FileExcel from './file-excel.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 };
+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 };

package/dist/libs/shared/src/interfaces/VideoTypes.d.ts

@@ -0,0 +1,2 @@
+import { Video, Clip, InteractiveMetadata } from './models';
+export declare type VideoTypes = Video | Clip | InteractiveMetadata;

package/dist/libs/shared/src/interfaces/app-variables/BaseSearchAppVariables.d.ts

@@ -14,4 +14,5 @@ export declare abstract class BaseSearchAppVariables {
     abstract get addSlugs(): boolean;
     abstract get searchBarPlaceholder(): string;
     abstract get showSearchTips(): boolean;
+    abstract get useContextualSearch(): boolean;
 }

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

@@ -11,3 +11,4 @@ export * from './RegionalUrl';
 export * from './AppLinkWithLabel';
 export * from './WidgetContext';
 export * from './RegionalUrl';
+export * from './VideoTypes';

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

@@ -10,7 +10,6 @@ export interface Classification extends BaseObject {
     emphasize?: boolean;
     slug: string;
     pinnedVideoMasterId?: string;
-    comingSoon?: boolean;
     canBePreferred?: boolean;
     banner?: Banner;
     playlists?: PlaylistCollection;

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

@@ -3,7 +3,6 @@ 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,4 +11,12 @@ export interface Config extends BaseObject {
     playerApiUrl?: string;
     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/Curriculum.d.ts

@@ -1,9 +1,11 @@
+import { ClassificationStatus } from 'libs/shared/enums/ClassificationStatus';
 import { CurriculumType } from 'libs/shared/enums/CurriculumType';
 import { VirtualObject } from './primitives/VirtualObject';
 export interface Curriculum<T = CurriculumType> {
     backboneClassificationIds: number[];
     canBePreferred: boolean;
-    comingSoon: boolean;
+    comingSoon?: boolean;
+    status: ClassificationStatus;
     description?: string;
     emphasize: boolean;
     id: string;

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

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

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

@@ -1,14 +1,19 @@
+import { CurationStatus } from 'libs/shared/enums/CurationStatus';
+import { InteractiveOriginType } from 'libs/shared/enums/InteractiveOriginType';
 import { BaseObject, VirtualObject } from 'libs/shared/interfaces';
-import { User } from './User';
-import { Thumbnail } from './Thumbnail';
-import { Video } from './Video';
+import { User, Thumbnail, Video } from 'libs/shared/interfaces/models';
+import { Timepoint } from './interactive';
 export interface InteractiveMetadata extends BaseObject {
+    status: CurationStatus;
     interactiveId: string;
     owner: User;
     description?: string;
     thumbnail?: Thumbnail;
     video?: Video;
+    duration?: number;
+    originType: InteractiveOriginType;
     _isClickViewContent?: IsClickViewContent;
+    _timepoints?: VirtualTimepoints;
 }
 export interface HasInteractive extends VirtualObject {
     value: boolean;
@@ -16,4 +21,7 @@ export interface HasInteractive extends VirtualObject {
 interface IsClickViewContent extends VirtualObject {
     value: boolean;
 }
+interface VirtualTimepoints extends VirtualObject {
+    value: Timepoint[];
+}
 export {};

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

@@ -1,5 +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/User.d.ts

@@ -1,6 +1,5 @@
 import { BaseObject, Group, Avatar, YearGroup, CustomerCollection, YearGroupCollection } from 'libs/shared/interfaces';
 import { UserRole } from 'libs/shared/enums/UserRole';
-import { CustomerType } from 'libs/shared/enums/CustomerType';
 import { OnlineUserRole } from 'libs/shared/enums/UserRole';
 import { UserGroup } from 'libs/shared/enums/UserGroup';
 import { ObjectStatus } from 'libs/shared/enums/ObjectStatus';
@@ -24,8 +23,12 @@ export interface User extends BaseObject {
     userType: UserGroup;
     avatar?: Avatar;
     isPrimaryContact: boolean;
+    isEmailVerified: boolean;
     roleId: OnlineUserRole;
     lastSignInDate?: string;
+    metadata?: {
+        lastSignInTime?: string;
+    };
 }
 export interface CuratorUser extends User {
     userId: string;
@@ -49,8 +52,40 @@ export interface CurrentUser extends BaseObject {
     emailVerified: boolean;
     customerId: string;
     customerName: string;
-    countryCode: 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
@@ -58,7 +93,7 @@ export interface CurrentUser extends BaseObject {
 export interface OnlineCurrentUser extends CurrentUser {
     yearGroup: string;
     crmId: string;
-    customerType: CustomerType;
+    customerType: string;
     onlineRole: OnlineUserRole;
     maxAllowedRating: number;
 }

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

@@ -1,6 +1,7 @@
 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';
 export interface Video extends BaseObject {
     categories?: CategoryCollection;
     channel?: Channel;
@@ -17,6 +18,7 @@ export interface Video extends BaseObject {
     episodeNumber?: number;
     subjectPresentationAudiences?: AudienceCollection;
     resources?: ResourceCollection;
+    subtitles?: SubtitleCollection;
     productionCompanies?: CompanyCollection;
     distributors?: CompanyCollection;
     producers?: PersonCollection;

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

@@ -1,5 +1,6 @@
 export * from './primitives';
 export * from './interactive';
+export * from './interactive-results';
 export * from './Audience';
 export * from './Avatar';
 export * from './Banner';

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

@@ -1,3 +1,4 @@
+import { CurationStatus } from 'libs/shared/enums/CurationStatus';
 import { InteractiveOriginType } from 'libs/shared/enums/InteractiveOriginType';
 export interface CreateInteractiveMetadataRequest {
     name: string;
@@ -7,4 +8,5 @@ export interface CreateInteractiveMetadataRequest {
     owner: {
         id: string;
     };
+    status: CurationStatus;
 }

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

@@ -1,4 +1,5 @@
 export interface CreateInteractiveRequest {
     name: string;
     duration: number;
+    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

@@ -1,4 +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/index.d.ts

@@ -10,3 +10,4 @@ export * from './CreateInteractiveMetadataRequest';
 export * from './EditDetailsRequest';
 export * from './EditInteractiveRequest';
 export * from './EditInteractiveMetadataRequest';
+export * from './EditInteractiveMetadataOriginRequest';

package/dist/libs/shared/src/utils/interaction-type-helper/InteractionTypeHelper.d.ts

@@ -5,6 +5,10 @@ interface InteractionTypeInfo {
     prompt?: string;
     bgClassName: string;
     Svg: () => React.ReactElement;
+    /**
+     * Used for anlaytics
+     */
+    typeName: string;
 }
 export declare const InteractionTypeHelper: {
     getTypeInfo: (typeId: InteractionTypeId) => InteractionTypeInfo;