@clickview/online 0.0.9 → 0.0.10-dev.1

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

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

package/dist/libs/shared/src/interfaces/collections/ClassificationCollection.d.ts

@@ -0,0 +1,4 @@
+import { BasePaginatedCollection } from "./..";
+import { Classification } from "./..";
+export interface ClassificationCollection extends BasePaginatedCollection<Classification> {
+}

package/dist/libs/shared/src/interfaces/collections/ClassroomCollection.d.ts

@@ -0,0 +1,4 @@
+import { BasePaginatedCollection } from "./..";
+import { Classroom } from "./..";
+export interface ClassroomCollection extends BasePaginatedCollection<Classroom> {
+}

package/dist/libs/shared/src/interfaces/collections/ClassroomGroupCollection.d.ts

@@ -0,0 +1,4 @@
+import { BasePaginatedCollection } from "./..";
+import { ClassroomGroup } from "./..";
+export interface ClassroomGroupCollection extends BasePaginatedCollection<ClassroomGroup> {
+}

package/dist/libs/shared/src/interfaces/collections/InteractiveCollection.d.ts

@@ -1,4 +1,4 @@
 import { BasePaginatedCollection } from "./..";
-import { Interactive } from "./..";
-export interface InteractiveCollection extends BasePaginatedCollection<Interactive> {
+import { InteractiveMetadata } from "./..";
+export interface InteractiveCollection extends BasePaginatedCollection<InteractiveMetadata> {
 }

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

@@ -19,3 +19,7 @@ export * from './LinkCollection';
 export * from './ClipCollection';
 export * from './FolderCollection';
 export * from './CustomerCollection';
+export * from './SubtitleCollection';
+export * from './ClassificationCollection';
+export * from './ClassroomCollection';
+export * from './ClassroomGroupCollection';

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

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

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

@@ -0,0 +1,18 @@
+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,7 +1,8 @@
-import { BaseObject, User } from "./..";
+import { BaseObject, User, Video } from "./..";
 export interface Clip extends BaseObject {
-    description: string;
+    description?: string;
     startTime: number;
     endTime: number;
-    owner: User;
+    owner?: User;
+    video?: Video;
 }

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

@@ -5,7 +5,9 @@ export interface Config extends BaseObject {
     imageCdnUrl: string;
     countryCode: CountryCode;
     webPlayerUrl: string;
+    gatewayApiUrl: string;
     notificationServiceUrl?: string;
     collectionApiUrls?: RegionalUrl;
     collectionApiClientId?: string;
+    playerApiUrl?: string;
 }

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

@@ -1,4 +1,5 @@
 import { CurriculumType } from "../../enums/CurriculumType";
+import { VirtualObject } from './primitives/VirtualObject';
 export interface Curriculum<T = CurriculumType> {
     backboneClassificationIds: number[];
     canBePreferred: boolean;
@@ -12,3 +13,6 @@ export interface Curriculum<T = CurriculumType> {
     slug: string;
     type: T;
 }
+export interface CurriculumLinks extends VirtualObject {
+    value: Curriculum[][];
+}

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

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

@@ -0,0 +1,14 @@
+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/Link.d.ts

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

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

@@ -1,9 +1,17 @@
 import { BaseObject } from './primitives';
-interface ResourceMatadata {
-    type: string;
+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: ResourceMatadata;
+    metadata: ResourceMetadata;
+    fileId: string;
+    thumbnail: Thumbnail;
+    pdf?: Pdf;
 }
 export {};

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

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

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

@@ -2,7 +2,11 @@ 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
  */
@@ -13,10 +17,15 @@ export interface User extends BaseObject {
     bio: string;
     email: string;
     username: string;
-    status: 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;

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

@@ -1,4 +1,4 @@
-import { BaseObject, CompanyCollection, PersonCollection, CategoryCollection, Channel, InteractiveCollection, LibraryCollection, Rating, Series, Thumbnail, TagCollection, Season, AudienceCollection, ResourceCollection, LinkCollection, ClipCollection, Glance, HeroBanner, RestrictedObject } from "./..";
+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;
@@ -22,9 +22,13 @@ export interface Video extends BaseObject {
     clips?: ClipCollection;
     links?: LinkCollection;
     glance?: Glance;
-    isFavourited?: boolean;
     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,4 +1,4 @@
-import { BaseObject } from './primitives';
+import { BaseObject, VirtualObject } from './primitives';
 export interface VideoHistory extends Omit<BaseObject, 'id' | 'name'> {
     videoId: string;
     userId: string;
@@ -7,3 +7,6 @@ export interface VideoHistory extends Omit<BaseObject, 'id' | 'name'> {
     lastTimeWatched: string;
     lastProgressPoint: number;
 }
+export interface VideoProgress extends VirtualObject {
+    progress: number;
+}

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

@@ -9,7 +9,7 @@ export declare enum WidgetType {
     Hero = 2,
     ResourcesTile = 3
 }
-export interface Widget extends BaseObject {
+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

@@ -1,16 +1,19 @@
 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 './Interactive';
+export * from './InteractiveMetadata';
 export * from './Library';
 export * from './Playlist';
 export * from './Rating';
@@ -47,3 +50,8 @@ 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

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

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

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

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 "../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 "../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,6 @@
+export * from './ActionableItem';
+export * from './Interaction';
+export * from './InteractionType';
+export * from './InteractionTypeId';
+export * from './Interactive';
+export * from './Timepoint';

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

@@ -1,6 +1,7 @@
 export interface BaseObject {
     id?: string;
     name?: string;
+    type?: string;
     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

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

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

@@ -1,5 +1,9 @@
+import { UpdateObjectRating, UpdateObjectChannel, Thumbnail } from "./..";
 export interface UpdateVideoRequest {
-    id: string;
     name: string;
     description?: string;
+    rating: UpdateObjectRating;
+    dateBroadcast?: string;
+    channel?: UpdateObjectChannel;
+    thumbnail?: Thumbnail;
 }

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

@@ -1,2 +1,7 @@
+export * from './CreateOrUpdateClipRequest';
+export * from './CreateViewKeyRequest';
 export * from './ReorderRequest';
+export * from './UpdateObjectChannel';
+export * from './UpdateObjectRating';
+export * from './UpdateResourceRequest';
 export * from './UpdateVideoRequest';

package/dist/libs/shared/src/interfaces/services/BaseUserDataService.d.ts

@@ -1,4 +1,6 @@
 import { CurrentUser } from "./..";
+import { HashObject } from "../../../../common/src/react/interfaces";
 export interface BaseUserDataService {
     getCurrentUser(success?: (user: CurrentUser) => void, error?: () => void): void;
+    getWorkspace(success?: (workspace: HashObject) => void, error?: () => void): void;
 }

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

@@ -4,3 +4,4 @@ export * from './BaseLibraryDataService';
 export * from './BaseSeriesDataService';
 export * from './BaseSettingsDataService';
 export * from './BaseUserDataService';
+export * from './BaseConfigDataService';

package/dist/libs/shared/src/services/ConfigDataService.d.ts

@@ -1,8 +1,8 @@
 import { FetchOptions } from "../../../common/src/react/utils/FetchHelper";
 import { BaseDataService } from "../../../common/src/backbone/services/BaseDataService";
 import { DataServiceError } from "../../../common/src/backbone/interfaces";
-import { Config } from "../interfaces";
-export declare class ConfigDataService extends BaseDataService {
+import { Config, BaseConfigDataService } from "../interfaces";
+export declare class ConfigDataService extends BaseDataService implements BaseConfigDataService {
     get name(): string;
     get channelName(): string;
     getConfig(callback?: (Config: Config) => void, errorCallback?: () => void): Config;

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

@@ -0,0 +1,30 @@
+import { HashObject } from "../../../common/src/react/interfaces/HashObject";
+import { User } from '../interfaces';
+export declare const FavouriteHelper: {
+    /**
+     * This helper is based on a *critical* assumption that the with statement
+     * retrieving the favouritedBy collection uses a filter for the current user's id.
+     *
+     * The reason we're not passing the current user as an arg is that we would need to
+     * drill the user object all the way down to low level componenets.
+     *
+     * @param object
+     */
+    isFavouritedByCurrentUser(object: HashObject<any>): boolean;
+    /**
+     * Determine whether the user has favourited the object
+     *
+     * @param object
+     */
+    isFavouritedByUser(object: HashObject<any>, user: User): boolean;
+    /**
+     * Determine whether the object can be favourited.
+     *
+     * Based on the premise that the existence of the assoc property means that the object
+     * does support being favourited. Ensure that your with statement is correctly retrieving
+     * the favouritedBy assoc.
+     *
+     * @param object
+     */
+    canFavourite(object: HashObject<any>): boolean;
+};

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

@@ -20,12 +20,13 @@ export interface CategoryMapperImageOptions {
 export declare const ImageHelper: {
     createUrl(baseUrl: string, options?: ImageOptions): string;
     createBannerUrl(banner: Banner, mappingOptions?: CategoryMapperImageOptions, imageOptions?: ImageOptions): string;
+    createResourceImage(baseUrl: string, resourceUrl: string, options?: ImageOptions): string;
     /**
-   * Ensures that strings are properly escaped before using them
-   * within a URL.
-   */
+     * Ensures that strings are properly escaped before using them
+     * within a URL.
+     */
     Rfc3986EncodeURIComponent(str: string): string;
     _createCategoryMappedUrl(mappingOptions: CategoryMapperImageOptions, options?: ImageOptions): string;
-    _createUrl(baseUrl: string, options?: ImageOptions): string;
+    _createUrl(baseUrl: string, queryParams?: HashObject<any>): string;
     legacyCreateThumbnailUrl(thumbnail: string | HashObject<any> | Core.Model, options?: ImageOptions): string;
 };

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

@@ -0,0 +1,11 @@
+import { StorageHelper } from "../../../common/src/backbone/utils/LocalStorageHelper";
+interface AddRecentItemOptions {
+    id: string;
+    limit?: number;
+}
+export declare const RecentItemHelper: {
+    getRecentItem(cacheKey: string, dataSource: StorageHelper): string[];
+    setRecentItem(cacheKey: string, ids: string[], dataSource: StorageHelper): void;
+    addRecentItem(cacheKey: string, dataSource: StorageHelper, options: AddRecentItemOptions): string[];
+};
+export {};

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

@@ -8,7 +8,6 @@ export interface SVGOptions {
 }
 export declare class StaticSvgHelper {
     private static instance;
-    private constructor();
     static get Instance(): StaticSvgHelper;
     getSvg(svgName: string, options?: SVGOptions): string;
     private getIcon;

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

@@ -1,3 +1,12 @@
+import { Library, Video } from "../interfaces";
+import { MasterObjectTypes } from "../enums/MasterObjectTypes";
 export declare const VideoDetailsHelper: {
     mapRatingToClass(ratingValue: number): string;
+    mapSourceToDisplayName(library: Library): string;
+    mapSourceToClass(sourceType: MasterObjectTypes): string;
+    isInteractive(video: Video): boolean;
+    mapTypeToSvg(type: string): any;
+    mapTypeToClass(type: string): any;
+    mapTypeToExtension(type: string): string;
+    mapTypeToName(type: string): string;
 };

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

@@ -0,0 +1,5 @@
+import { Video } from "../interfaces";
+export declare const VideoHelper: {
+    hasSeries(video: Video): boolean;
+    getVideoProgress(video: Video): number;
+};