@clickview/player 0.0.26 → 0.0.27-rc.0

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

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

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

@@ -1,13 +0,0 @@
-import { ShareLinkStatus } from 'libs/shared/enums/ShareLinkStatus';
-import { ShareType } from 'libs/shared/enums/ShareType';
-import { BaseShareObject } from './BaseShareObject';
-export interface ShareLink extends BaseShareObject {
-    url: string;
-    embedUrl: string;
-    passwordHash?: string;
-    passwordSalt?: string;
-    linkExpireDate?: string;
-    status: ShareLinkStatus;
-    isPasswordProtected: boolean;
-    type: ShareType.ShareLink;
-}

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

@@ -1,6 +0,0 @@
-import { MasterType } from 'libs/shared/enums/MasterType';
-export interface ShareRecipient {
-    id: string;
-    typeId: MasterType;
-    dateShared?: string;
-}

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

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

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

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

@@ -1,8 +0,0 @@
-import { BaseObject } from 'libs/shared/interfaces';
-import { TagType } from 'libs/shared/enums/TagType';
-export interface TagMetadata {
-    type: TagType;
-}
-export interface Tag extends BaseObject {
-    metadata?: TagMetadata;
-}

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

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

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

@@ -1,23 +0,0 @@
-import { BaseObject } from './primitives';
-import { ThemeType } from 'libs/shared/enums/ThemeType';
-import { HeroBanner } from './HeroBanner';
-export interface ThemeImages {
-    bottomLeft?: HeroBanner;
-    bottomRight?: HeroBanner;
-    topLeft?: HeroBanner;
-    topRight?: HeroBanner;
-}
-export interface ThemeColours {
-    primary?: string;
-    secondary?: string;
-    tertiary?: string;
-}
-export interface ThemeData {
-    images?: ThemeImages;
-    colours?: ThemeColours;
-}
-export interface Theme extends BaseObject {
-    name: string;
-    type: ThemeType;
-    data: ThemeData;
-}

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

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

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

@@ -1,2 +0,0 @@
-import { DirectShare, ShareLink } from 'libs/shared/interfaces';
-export declare type UnionShareObject = ShareLink | DirectShare;

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

@@ -1,112 +0,0 @@
-import { BaseObject, Group, Avatar, YearGroup, CustomerCollection, ClassroomCollection, ClassroomGroupCollection, 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';
-import { InstanceRegion } from 'libs/shared/enums/InstanceRegion';
-import { ContentRegion } from 'libs/shared/enums/ContentRegion';
-import { CountryCode } from 'libs/shared/enums/CountryCode';
-/**
- * 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;
-    displayName?: string;
-    metadata?: {
-        lastSignInTime?: string;
-        displayName?: string;
-        isEmailVerified?: boolean;
-    };
-    masterYearGroup?: YearGroup;
-    yearGroups?: YearGroupCollection;
-    classrooms?: ClassroomCollection;
-    classroomGroups?: ClassroomGroupCollection;
-}
-export interface CuratorUser extends User {
-    userId: string;
-    firstName: string;
-    countryCode: string;
-    groups: Group[];
-}
-/**
- * Current User for Lite/Cloud
- */
-export interface CurrentUser extends BaseObject {
-    isAuthenticated: boolean;
-    id: string;
-    username: string;
-    avatar: string;
-    timeZone: string;
-    role: UserRole;
-    displayName: string;
-    givenName: string;
-    familyName: string;
-    email: string;
-    emailVerified: boolean;
-    customerId: string;
-    customerName: string;
-    customerLogo: string;
-    /**
-     * @important
-     * This should NOT be read in the product if it doesn't have to be.
-     * For things like feature blocking (e.g. student feed only being accessable to students), you should use
-     * Permissions API instead (talk to Josh T or Cam, or see `usePermissions`).
-     *
-     * This should be used for things like displaying different text in the product based on if the current user
-     * is a student or staff.
-     */
-    userType: UserGroup;
-    /**
-     * 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: InstanceRegion;
-    /**
-     * The content set the user should have access to.
-     *
-     * @remarks
-     * Content is not tied to a country or instance region.
-     */
-    contentRegion: ContentRegion;
-    /**
-     * 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: CountryCode;
-}
-/**
- * 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

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

@@ -1,49 +0,0 @@
-import { BaseObject, CompanyCollection, PersonCollection, CategoryCollection, Channel, InteractiveCollection, LibraryCollection, Rating, Series, Thumbnail, TagCollection, Season, AudienceCollection, ResourceCollection, LinkCollection, ClipCollection, Glance, HeroBanner, RestrictedObject, VideoProgress, UserCollection, HasInteractive, PointOfInterestCollection, SubtitleCollection, User } from 'libs/shared/interfaces';
-import { VirtualObject } from './primitives';
-import { CurationStatus } from 'libs/shared/enums/CurationStatus';
-export interface Video extends BaseObject {
-    status?: CurationStatus;
-    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;
-    pointsOfInterest?: PointOfInterestCollection;
-    _hasInteractives?: HasInteractive;
-    _videoProgress?: VideoProgress;
-    _hasCurriculumLinks?: boolean;
-    _canUpdate?: CanUpdate;
-    _canBeConsumed?: CanBeConsumed;
-    hasInteractives?: boolean;
-}
-export interface CanUpdate extends VirtualObject {
-    value: boolean;
-}
-export interface CanBeConsumed extends VirtualObject {
-    value: boolean;
-    reason?: 'private' | 'rating-not-allowed';
-}

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

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

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

@@ -1,16 +0,0 @@
-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: string;
-    dashboardId: string;
-    type: WidgetType;
-}

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

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

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

@@ -1,70 +0,0 @@
-export * from './primitives';
-export * from './interactive';
-export * from './interactive-results';
-export * from './Audience';
-export * from './Avatar';
-export * from './Banner';
-export * from './Category';
-export * from './CategoryTree';
-export * from './Channel';
-export * from './Classroom';
-export * from './ClassroomGroup';
-export * from './Config';
-export * from './Cover';
-export * from './Curriculum';
-export * from './Dashboard';
-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 './ContentRegionObject';
-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';
-export * from './Logo';
-export * from './MasterNestedObject';
-export * from './ShareLink';
-export * from './ShareRecipient';
-export * from './DirectShare';
-export * from './UnionShareObject';
-export * from './PointOfInterest';
-export * from './Product';

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

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

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

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

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

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

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

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

@@ -1,11 +0,0 @@
-import { StudentResults } from 'libs/shared/interfaces';
-export interface InteractiveResultSet {
-    id: string;
-    duration: number;
-    students: StudentResults[];
-    /**
-     * If results are filtered, studentCount will be the number
-     * of students in the filter, even if they don't have results.
-     */
-    studentCount?: number;
-}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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