@clickview/curator 1.0.25-dev.1 → 1.0.25-rc.1

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

@@ -1,21 +0,0 @@
-import { BaseObject, Cover, Banner, PlaylistCollection, VideoCollection, SeriesCollection, TallPoster, UserCollection } from "./..";
-import { ClassificationType } from "../../enums/ClassificationType";
-export interface Classification extends BaseObject {
-    presentationId: string;
-    parentIds: string[];
-    backboneClassificationIds: string[];
-    type: ClassificationType;
-    emphasize?: boolean;
-    slug: string;
-    pinnedVideoMasterId?: string;
-    comingSoon?: boolean;
-    canBePreferred?: boolean;
-    banner?: Banner;
-    playlists?: PlaylistCollection;
-    videos?: VideoCollection;
-    series?: SeriesCollection;
-    cover?: Cover;
-    tallPoster?: TallPoster;
-    followers?: UserCollection;
-    children?: Classification[];
-}

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

@@ -1,4 +0,0 @@
-import { BaseObject } from "./..";
-export interface Classroom extends BaseObject {
-    isFavourited: boolean;
-}

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

@@ -1,18 +0,0 @@
-import { BaseObject, UserCollection } from "./..";
-export declare enum ClassroomGroupColour {
-    White = "colour:0",
-    Pink = "colour:1",
-    YellowOrange = "colour:2",
-    Emerald = "colour:3",
-    PuertoRico = "colour:4",
-    PictonBlue = "colour:5",
-    EastSide = "colour:6",
-    Portage = "colour:7"
-}
-export interface ClassroomGroup extends BaseObject {
-    description: string;
-    metadata: {
-        colour: ClassroomGroupColour;
-    };
-    users?: UserCollection;
-}

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

@@ -1,8 +0,0 @@
-import { BaseObject, User, Video } from "./..";
-export interface Clip extends BaseObject {
-    description?: string;
-    startTime: number;
-    endTime: number;
-    owner?: User;
-    video?: Video;
-}

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

@@ -1,3 +0,0 @@
-import { BaseObject } from "./..";
-export interface Company extends BaseObject {
-}

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

@@ -1,13 +0,0 @@
-import { BaseObject, RegionalUrl } from "./..";
-import { CountryCode } from "../../enums/CountryCode";
-export interface Config extends BaseObject {
-    supportSiteUrl: string;
-    imageCdnUrl: string;
-    countryCode: CountryCode;
-    webPlayerUrl: string;
-    gatewayApiUrl: string;
-    notificationServiceUrl?: string;
-    collectionApiUrls?: RegionalUrl;
-    collectionApiClientId?: string;
-    playerApiUrl?: string;
-}

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

@@ -1,3 +0,0 @@
-import { Image } from "./..";
-export interface Cover extends Image {
-}

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

@@ -1,18 +0,0 @@
-import { CurriculumType } from "../../enums/CurriculumType";
-import { VirtualObject } from './primitives/VirtualObject';
-export interface Curriculum<T = CurriculumType> {
-    backboneClassificationIds: number[];
-    canBePreferred: boolean;
-    comingSoon: boolean;
-    description?: string;
-    emphasize: boolean;
-    id: string;
-    name?: string;
-    parentIds: string[];
-    presentationId: number;
-    slug: string;
-    type: T;
-}
-export interface CurriculumLinks extends VirtualObject {
-    value: Curriculum[][];
-}

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

@@ -1,6 +0,0 @@
-import { BaseObject } from "./..";
-import { Organisation } from './Organisation';
-export interface Customer extends BaseObject {
-    organisation: Organisation;
-    crmId: string;
-}

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

@@ -1,9 +0,0 @@
-import { SettingKind } from "../../enums/SettingKind";
-import { SettingName } from "../../enums/SettingName";
-export interface EntitySetting<TValue = any> {
-    name: SettingName;
-    displayName: string;
-    value: TValue;
-    type: string;
-    kind: SettingKind;
-}

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

@@ -1,20 +0,0 @@
-/**
- * Interface for a file uploaded
- * to FileApi
- */
-export interface FileUpload {
-    id: string;
-    file: {
-        cvUpload: {
-            uploadId: string;
-            ingestUrl: string;
-        };
-    };
-    fileInfo: {
-        id: string;
-        name: string;
-        extension: string;
-        size: number;
-        url: string;
-    };
-}

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

@@ -1,7 +0,0 @@
-import { BaseObject, Banner, Thumbnail, FolderCollection, VideoCollection } from "./..";
-export interface Folder extends BaseObject {
-    banner?: Banner;
-    thumbnail?: Thumbnail;
-    children?: FolderCollection;
-    videos?: VideoCollection;
-}

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

@@ -1,4 +0,0 @@
-export interface Following {
-    objectId: string;
-    isFollowing: boolean;
-}

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

@@ -1,9 +0,0 @@
-import { BaseObject } from "./..";
-import { GlanceFormat } from "../../enums/GlanceFormat";
-import { ThemeType } from "../../enums/ThemeType";
-export interface Glance extends BaseObject {
-    theme: string;
-    format: GlanceFormat;
-    content: string;
-    type: ThemeType;
-}

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

@@ -1,3 +0,0 @@
-import { BaseObject } from "./..";
-export interface Group extends BaseObject {
-}

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

@@ -1,3 +0,0 @@
-import { Image } from "./..";
-export interface HeroBanner extends Image {
-}

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

@@ -1,7 +0,0 @@
-import { BaseObject } from "./..";
-import { FileIdType } from "../../enums/Images";
-export interface Image extends BaseObject {
-    url?: string;
-    fileId?: string;
-    fileIdType?: FileIdType;
-}

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

@@ -1,14 +0,0 @@
-import { BaseObject, VirtualObject } from "./..";
-import { User } from './User';
-import { Thumbnail } from './Thumbnail';
-import { Video } from './Video';
-export interface InteractiveMetadata extends BaseObject {
-    interactiveId: string;
-    owner: User;
-    description?: string;
-    thumbnail?: Thumbnail;
-    video?: Video;
-}
-export interface HasInteractive extends VirtualObject {
-    value: boolean;
-}

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

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

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

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

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

@@ -1,5 +0,0 @@
-import { BaseObject } from "./..";
-export interface Library extends BaseObject {
-    isHiddenLibrary: boolean;
-    type: 'custom_library' | 'hosted_library' | 'exchange' | 'workspace' | 'online_supplementary_library';
-}

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

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

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

@@ -1,3 +0,0 @@
-import { BaseObject } from "./..";
-export interface Organisation extends BaseObject {
-}

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

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

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

@@ -1,3 +0,0 @@
-import { BaseObject } from "./..";
-export interface Person extends BaseObject {
-}

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

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

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

@@ -1,14 +0,0 @@
-import { BaseObject, Cover, VideoCollection, User, Thumbnail, Banner, PresentationAudienceCollection, UserCollection } from "./..";
-import { PlaylistPrivacy } from "../../enums/PlaylistPrivacy";
-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;
-}

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

@@ -1,3 +0,0 @@
-import { Image } from "./..";
-export interface Poster extends Image {
-}

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

@@ -1,6 +0,0 @@
-import { Cover, BaseObject } from "./..";
-import { PresentationType } from "../../enums/PresentationType";
-export interface Presentation extends BaseObject {
-    cover: Cover;
-    type: PresentationType;
-}

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

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

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

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

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

@@ -1,17 +0,0 @@
-import { BaseObject } from './primitives';
-import { Thumbnail } from './Thumbnail';
-import { ResourceFileType } from "../../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

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

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

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

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

@@ -1,10 +0,0 @@
-import { BaseObject, PresentationAudienceCollection, Poster, TallPoster, Banner, Rating, VideoCollection } from "./..";
-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

@@ -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/Subject.d.ts

@@ -1,13 +0,0 @@
-import { BaseObject } from "./..";
-import { Cover, Thumbnail, Banner, VideoCollection, PlaylistCollection, SeriesCollection } from "./..";
-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,3 +0,0 @@
-import { BaseObject } from "./..";
-export interface Tag extends BaseObject {
-}

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

@@ -1,3 +0,0 @@
-import { Image } from "./..";
-export interface TallPoster extends Image {
-}

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

@@ -1,14 +0,0 @@
-import { BaseObject } from './primitives';
-import { ThemeType } from "../../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

@@ -1,6 +0,0 @@
-import { Image } from "./..";
-export interface Thumbnail extends Image {
-    metadata?: {
-        rotation?: number;
-    };
-}

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

@@ -1,64 +0,0 @@
-import { BaseObject, Group, Avatar } from "./..";
-import { UserRole } from "../../enums/UserRole";
-import { CustomerType } from "../../enums/CustomerType";
-import { OnlineUserRole } from "../../enums/UserRole";
-import { UserGroup } from "../../enums/UserGroup";
-import { ObjectStatus } from "../../enums/ObjectStatus";
-import { CustomerCollection } from '../collections';
-import { YearGroup } from './YearGroup';
-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;
-    masterYearGroup: YearGroup;
-    userType: UserGroup;
-    avatar?: Avatar;
-    isPrimaryContact: boolean;
-    roleId: OnlineUserRole;
-}
-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: CustomerType;
-    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,34 +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, CurriculumLinks } from "./..";
-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;
-    hasSubtitle?: boolean;
-    heroBanner?: HeroBanner;
-    restrictions?: RestrictedObject[];
-    lastProgressPoint?: number;
-    favouritedBy?: UserCollection;
-    _hasinteractives?: HasInteractive;
-    _videoprogress?: VideoProgress;
-    _hasCurriculumLinks?: boolean;
-    _curriculumLinks?: CurriculumLinks;
-}

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

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

@@ -1,16 +0,0 @@
-import { BaseObject } from "./..";
-/**
- * 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

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

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

@@ -1,57 +0,0 @@
-export * from './primitives';
-export * from './interactive';
-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';

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

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

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

@@ -1,7 +0,0 @@
-import { InteractionTypeId } from './InteractionTypeId';
-export interface InteractionType {
-    id: InteractionTypeId;
-    name: string;
-    colour: string;
-    icon: string;
-}