@clickview/player 0.0.3-dev-us.7 → 0.0.3-dev.0

package/.storybook/stories/utils/mock-playerapi.ts

@@ -164,23 +164,11 @@ const mockResources = <Resources> {
 const emptyLocalCacheAddresses = <LocalCacheAddress[]> [];
 
 const mockExtraData = {
-  title: 'Paralympics',
   videoId: '',
   viewerId: '',
   viewerCustomerId: '',
   region: '',
-  mediaId: '',
-  settings: {
-    showSubtitles: false,
-    playbackProfile: '',
-    playbackProfileLocalCache: '',
-    playbackSubtitleSizeDefault: ''
-  },
-  warning: 'Bloody Scenes, Violence, Alcohol Abuse and Death',
-  ratingCode: 'PG',
-  seriesName: 'Global Icons',
-  seasonNumber: 1,
-  episodeNumber: 2
+  mediaId: ''
 }
 
 const sources: { [key: string]: PlaybackObject } = {

package/dist/en.json

@@ -0,0 +1,390 @@
+{
+  "notifications": {
+    "notificationList": {
+      "noNotifications": "You have no notifications"
+    },
+    "services": {
+      "suggestEditSubmit": "Suggestion was successfully submitted"
+    },
+    "utils": {
+      "viewVideoDetails": "View video details",
+      "viewVideo": "View video",
+      "reviewVideos": "Review videos",
+      "viewNewContent": "View new content",
+      "reviewVideo": "Review video",
+      "seeNow": "See now"
+    },
+    "notifications": {
+      "title": "Notifications",
+      "notifications": "Notifications"
+    },
+    "notificationsPopover": {
+      "notifications": "Notifications",
+      "seeAll": "See all notifications"
+    }
+  },
+  "playlists": {
+    "emptyState": {
+      "noPlaylistsHeading": "You have no playlists",
+      "noPlaylistsInfo": "Click <strong>New Playlist</strong> above to create one.",
+      "noVideosHeading": "There are no videos in this playlist",
+      "noVideosInfo": "Learn how to add videos to a playlist."
+    },
+    "playlistItem": {
+      "videos": "%{smart_count} video |||| %{smart_count} videos",
+      "lastUpdated": "Last updated: %{timeAgo}",
+      "notUpdatedRecently": "Last updated over a month ago"
+    },
+    "playlistSortSelect": {
+      "recentlyUpdated": "Recently updated",
+      "atoz": "A to Z",
+      "ztoa": "Z to A",
+      "newest": "Newest",
+      "oldest": "Oldest"
+    },
+    "hooks": {
+      "somethingWentWrong": "Something went wrong"
+    },
+    "validation": {
+      "nameExceeds": "Name is too long",
+      "nameRequired": "Name is required",
+      "descriptionExceeds": "Description is too long"
+    }
+  },
+  "search": {
+    "searchTips": {
+      "heading": "Search Tips",
+      "firstTerm": "\"atomic bonding\"",
+      "firstDescription": "Search for exact phrases using quotation marks",
+      "secondTerm": "\"romeo and juliet\" english",
+      "secondDescription": "Combine normal and exact phrases together",
+      "thirdTerm": "-pollution",
+      "thirdDescription": "Exclude a keyword from your search",
+      "fourthTerm1": "tag:literature",
+      "fourthTerm2": "folder:science",
+      "fourthDescription": "Search for results within a tag, folder or series",
+      "fifthTerm": "folder:-physics",
+      "fifthDescription": "Use a \"-\" to exclude a folder, title or series"
+    },
+    "services": {
+      "folderTag": "This folder",
+      "seriesTag": "This series"
+    },
+    "searchBar": {
+      "findingResults": "Finding results...",
+      "recentSearches": "Recent Searches",
+      "allResults": "Show all results for",
+      "noLibraries": "There are currently no libraries to search. Add a new library to get started.",
+      "placeholder": "Search within your library... |||| Search within your libraries...",
+      "classifications": "topics",
+      "videos": "videos",
+      "tags": "tags",
+      "series": "series"
+    }
+  },
+  "subjects": {
+    "audienceFilter": {
+      "clear": "Clear"
+    },
+    "comingSoon": {
+      "comingSoon": "Coming Soon",
+      "info1": "We are currently building this topic.",
+      "info2": "In the meantime, we can remind you when it's available.",
+      "remindMe": "Remind Me"
+    },
+    "heroVideo": {
+      "resourcesHeading": "Resources",
+      "linksHeading": "Links",
+      "clipsHeading": "Clips",
+      "tagsHeading": "Tags",
+      "links": "%{smart_count} link |||| %{smart_count} links",
+      "resources": "%{smart_count} resource |||| %{smart_count} resources",
+      "clips": "%{smart_count} clip |||| %{smart_count} clips"
+    }
+  },
+  "upload": {
+    "fileType": {
+      "heading": "Invalid file type",
+      "body": "Sorry but you cannot upload files of that type.",
+      "okay": "Okay",
+      "close": "Close"
+    },
+    "internetConnectivityError": {
+      "title": "Internet connectivity issue",
+      "heading": "Connectivity issue.",
+      "body": "There seems to be an issue with your internet connection. Please try uploading your files again.",
+      "okay": "Okay"
+    },
+    "utils": {
+      "videoProcessingError": "Something went wrong processing this video.",
+      "waiting": "Waiting to be processed",
+      "processing": "Processing %{progress}%",
+      "complete": "Complete",
+      "readyToWatch": "Ready to watch, still processing higher resolutions."
+    }
+  },
+  "shared": {
+    "backButton": {
+      "back": "Back",
+      "backTo": "Back to %{backToName}"
+    },
+    "badges": {
+      "interactive": "Interactive",
+      "resources": "Resources"
+    },
+    "channelFormField": {
+      "channel": "Channel",
+      "placeholder": "Search for a channel..."
+    },
+    "confirmationPopup": {
+      "confirm": "Confirm",
+      "cancel": "Cancel"
+    },
+    "curriculumLinks": {
+      "curriculumLinks": "Curriculum Links",
+      "seeLess": "See less"
+    },
+    "editLink": {
+      "linkNameExceeds": "Please provide a shorter name",
+      "linkNameRequired": "Please provide a name for your resource",
+      "linkUrlRequired": "Please provide a valid URL for your resource. e.g. https://example.com",
+      "linkUrlExceeds": "Please provide a shorter URL",
+      "urlLabel": "URL",
+      "urlPlaceholder": "Paste the URL to a resource here",
+      "nameLabel": "Name",
+      "namePlaceholder": "Display name",
+      "cancel": "Cancel"
+    },
+    "editResource": {
+      "name": "Name",
+      "namePlaceholder": "Enter a name for this resource",
+      "nameTooLong": "Name is too long",
+      "nameRequired": "Name is required",
+      "cancel": "Cancel"
+    },
+    "editVideoDetails": {
+      "nameExceeds": "Name is too long",
+      "nameRequired": "Name is required",
+      "descriptionExceeds": "Description is too long",
+      "namePlaceholder": "Enter a name for your video",
+      "descriptionPlaceholder": "Enter a description for your video",
+      "cancel": "Cancel",
+      "nameLabel": "Title",
+      "descriptionLabel": "Description"
+    },
+    "editVideoLinks": {
+      "heading": "Resource Links",
+      "description": "You may attach links to other learning resources related to this video.",
+      "attach": "Attach",
+      "limit": "There is a resource link limit of %{limit} links. To add another link please first remove one."
+    },
+    "editVideoResources": {
+      "resourcesLimit": "There is a resource limit of %{limit} resources. To add another resource please first remove one.",
+      "customerResources": "My School's Learning Resources",
+      "clickViewResources": "Learning Resources by ClickView",
+      "resources": "Learning Resources",
+      "resourcesDescription": "Maximum file size 10MB. <span class='text-muted'>(Word, Excel, PowerPoint, pdf, text and images are supported.)</span>",
+      "resourcesAlternative": "or Drag and drop learning resources(s) to upload",
+      "clickViewResourcesEmpty": "There are no ClickView resources for this video"
+    },
+    "editVideoSubtitles": {
+      "subtitlesLimit": "There is a subtitle limit of %{limit} subtitles. To add another subtitle please first remove one.",
+      "customerSubtitles": "My School's Subtitles",
+      "subtitles": "Subtitles",
+      "subtitlesDescription": "You can upload up to %{limit} subtitles. <span class='text-muted'>(.srt files are supported.)</span>",
+      "subtitlesAlternative": "or Drag and drop a subtitle file (*.srt) to upload",
+      "clickViewSubtitles": "Subtitles by ClickView",
+      "clickViewSubtitlesEmpty": "There are no ClickView subtitles for this video"
+    },
+    "favouriteButton": {
+      "favouriteError": "Failed to favourite video.",
+      "unfavouriteError": "Failed to unfavourite video."
+    },
+    "fileSelect": {
+      "browse": "Browse for a file",
+      "invalidFileType": "Invalid file type"
+    },
+    "formButtons": {
+      "create": "Create",
+      "save": "Save",
+      "next": "Next"
+    },
+    "imageCropper": {
+      "cancel": "Cancel",
+      "crop": "Crop",
+      "title": "Crop and resize your image"
+    },
+    "imageSelect": {
+      "minDimensions": "(Minimum dimensions are %{width}px x %{height}px)",
+      "uploadAThumbnail": "Upload a thumbnail"
+    },
+    "immersiveReader": {
+      "titleFallback": "Immersive Reader"
+    },
+    "interactiveQuestions": {
+      "answer": "Answer",
+      "pending": "Pending",
+      "answered": "Answered"
+    },
+    "languageSelect": {
+      "heading": "Select a language for your subtitle",
+      "placeholder": "Select a language",
+      "close": "Close",
+      "submit": "Submit",
+      "label": "Language"
+    },
+    "pagination": {
+      "next": "Next",
+      "previous": "Previous"
+    },
+    "searchBar": {
+      "placeholder": "Enter a search query",
+      "recentSearchHeading": "Recent Searches"
+    },
+    "videoAtAGlance": {
+      "readFullDescription": "View Video Details",
+      "videoAtAGlance": "Video at a glance...",
+      "seeCurriculumLinks": "See Curriculum Links"
+    },
+    "videoItemDescription": {
+      "showMore": "... Show more",
+      "showLess": "Show less"
+    },
+    "videoOwnerText": {
+      "clickViewContent": "Created by ClickView"
+    },
+    "dynamicWidget": {
+      "topics": "Topics",
+      "relatedTopics": "Related Topics",
+      "teach": "What would you like to teach?",
+      "preferencesTooltip": "Update your preferences"
+    },
+    "fixedWidget": {
+      "preferencesTooltip": "Update your preferences"
+    },
+    "greeting": {
+      "morning": "Good morning",
+      "afternoon": "Good afternoon",
+      "evening": "Good evening",
+      "fallback": "Hello",
+      "prompt": "What would you like to teach today?"
+    },
+    "interactiveWidgetItem": {
+      "previewQuestions": "Preview Questions"
+    },
+    "subjectWidgetItem": {
+      "comingSoon": "Coming Soon",
+      "edit": "Edit My Topics",
+      "all": "Explore all topics"
+    },
+    "dataHooks": {
+      "favourited": "Added <strong>%{video}</strong> to favourited videos.",
+      "unfavourited": "Removed <strong>%{video}</strong> from favourited videos."
+    },
+    "hooks": {
+      "navLockTitle": "Are you sure you want to leave?",
+      "navLockBody": "By leaving the current page all uploads will be discarded",
+      "discard": "Discard",
+      "cancel": "Cancel"
+    },
+    "behaviors": {
+      "fileDrop": {
+        "fileDrop": "Drop files here to begin uploading"
+      }
+    },
+    "_fileSelect": {
+      "browse": "Browse for a file",
+      "drop": "Drop files here to begin uploading"
+    },
+    "_pagination": {
+      "next": "Next",
+      "previous": "Previous"
+    },
+    "tooManyFiles": {
+      "title": "Uploading many files",
+      "heading": "Multiple files selected",
+      "body": "Please only upload one file at a time.",
+      "okay": "Okay"
+    },
+    "errors": {
+      "tooManyResources": {
+        "heading": "Too many resources.",
+        "body": "Cannot add more than %{resourceLimit} resource files to a video. Please remove some resources if you would like to add more.",
+        "okay": "Okay"
+      },
+      "tooManySubtitles": {
+        "heading": "Too many subtitles",
+        "body": "Cannot add more than %{subtitleLimit} subtitle files to a video. Please remove some subtitles if you would like to add more.",
+        "okay": "Okay"
+      }
+    },
+    "interactionTypes": {
+      "annotationName": "Annotation",
+      "imageName": "Image",
+      "missingWordName": "Missing word",
+      "missingWordPrompt": "Fill in the blank by typing the missing word(s)",
+      "multipleChoiceName": "Multiple Choice",
+      "multipleChoicePrompt": "Choose the correct answer(s)",
+      "shortAnswerName": "Short Answer",
+      "shortAnswerPrompt": "Type in your answer to the question",
+      "trueOrFalseName": "True or False",
+      "trueOrFalsePrompt": "Choose the correct answe"
+    },
+    "shared-utils": {
+      "responsive": "Responsive",
+      "small": "Small",
+      "medium": "Medium",
+      "large": "Large",
+      "exchange": "Exchange",
+      "workspace": "Workspace",
+      "file": "File",
+      "zipArchive": "Zip archive",
+      "presentation": "Presentation",
+      "spreadsheet": "Spreadsheet",
+      "document": "Document",
+      "pdf": "PDF",
+      "image": "Image",
+      "autoGeneratedSubtitle": "%{name} (auto-generated)",
+      "cancel": "Cancel",
+      "confirm": "Confirm"
+    },
+    "deleteLinkView": {
+      "heading": "Remove link?",
+      "body": "Are you sure you want to remove <strong>%{name}</strong>?",
+      "remove": "Remove",
+      "success": "Successfully removed link",
+      "error": "Failed to remove link. Please try again later."
+    },
+    "deleteResourceView": {
+      "heading": "Remove learning resource?",
+      "body": "Are you sure you want to remove <strong>%{name}</strong>?",
+      "remove": "Remove",
+      "success": "Successfully removed resource",
+      "error": "Failed to remove resource. Please try again later."
+    },
+    "deleteSubtitleView": {
+      "heading": "Remove subtitle?",
+      "body": "Are you sure you want to remove these subtitles: <strong>%{language}</strong>?",
+      "remove": "Remove",
+      "success": "Successfully removed subtitle",
+      "error": "Failed to remove subtitle. Please try again later."
+    },
+    "editLinkView": {
+      "heading": "Edit link",
+      "success": "Successfully saved link",
+      "error": "Failed to save link. Please try again later."
+    },
+    "editResourceView": {
+      "heading": "Edit learning resource",
+      "success": "Successfully updated resource",
+      "error": "Failed to update resource. Please try again later."
+    }
+  },
+  "workspace": {
+    "ratingSelect": {
+      "rating": "Rating",
+      "removeRating": "Remove rating",
+      "removeRatingTitle": "Without a rating, this video will be viewable by all staff and students"
+    }
+  }
+}

package/dist/libs/analytics/src/Analytics.d.ts

@@ -0,0 +1,10 @@
+import { AnalyticsDataPayload } from 'libs/analytics/models/AnalyticsEvent';
+import { ActionContext, EventVersion } from 'libs/analytics/interfaces';
+export declare const Analytics: {
+    /**
+     * Push/emit all events along the analytics firehose
+     * @param eventType
+     * @param data Data to be passed to AnalyticsClient
+     */
+    log<TType extends import("./interfaces").UserAction, TData extends AnalyticsDataPayload>(eventType: TType, data: TData, actionContext?: ActionContext, eventVersion?: EventVersion): void;
+};

package/dist/libs/analytics/src/AnalyticsHelper.d.ts

@@ -0,0 +1,30 @@
+import { ObjectHash } from 'backbone';
+import { Core } from 'libs/common/core';
+import { ActionContext, AnalyticsOptions, ActionDescriptor, InteractionTypeDescriptor, InteractionType } from 'libs/analytics/interfaces';
+export declare const AnalyticsHelper: {
+    logUserAction(data: ObjectHash | ObjectHash[], analyticsOptions: AnalyticsOptions): void;
+    logNavigate(appLink: Core.AppLink, options: ObjectHash): void;
+    mergeOptions(baseOptions: AnalyticsOptions, newOptions: AnalyticsOptions): AnalyticsOptions;
+    buildActionContext(options?: AnalyticsOptions): ActionContext;
+    buildUserActionEvent(options?: AnalyticsOptions): ObjectHash;
+    buildCurrentLocation(): string;
+    /**
+     * Search logging helpers
+     */
+    /**
+     * Create a search event that is depenedent on whether we page loaded into search
+     * or used the search bar directly.
+     */
+    buildSearchEvent(query: string, descriptor: ActionDescriptor): ObjectHash;
+    buildInstantSearchEvent(query: string, suggestion: ObjectHash, source: string): ObjectHash;
+    /**
+     * Resources Helpers
+     */
+    /**
+     * Map our general InteractionType to an appropriate anayltics descriptor type.
+     * The reason we do this is to maintain a seperation between analytics metadata and
+     * actual domain data.
+     * @param type
+     */
+    mapInteractionType(type: InteractionType): InteractionTypeDescriptor;
+};

package/dist/libs/analytics/src/clients/CollectionApiClient.d.ts

@@ -0,0 +1,48 @@
+import 'whatwg-fetch';
+import { IncomingEvent } from 'libs/analytics/models/CollectionEvent';
+import { HashObject } from 'libs/analytics/interfaces/HashObject';
+import { RegionalUrl } from 'libs/analytics/interfaces/RegionalUrl';
+import { User } from 'libs/analytics/interfaces/User';
+import { RegionName } from 'libs/analytics/enums/RegionName';
+interface CollectionApiClientOptions {
+    productName: string;
+    productVersion: string;
+    regionName: RegionName;
+    collectionApiUrls: RegionalUrl;
+    collectionApiClientId: string;
+    getUser: () => Promise<User>;
+    shouldLog?: (event: IncomingEvent) => boolean;
+    formatData?: (event: IncomingEvent) => HashObject | HashObject[];
+}
+/**
+ * A client for logging to CollectionApi.
+ * It should have no library dependencies and anything that it references
+ * should also have no library dependencies.
+ */
+export declare class CollectionApiClient {
+    private options;
+    constructor(options: CollectionApiClientOptions);
+    initialize(): void;
+    get name(): string;
+    log(event: IncomingEvent | IncomingEvent[]): Promise<void>;
+    private logBulk;
+    private validateOptions;
+    private shouldLog;
+    private postData;
+    private getSignatureHeader;
+    private getRegionalUrl;
+    private validateEvent;
+    private formatData;
+    private getEventData;
+    private extractData;
+    private getUserData;
+    /**
+     * Until region is added to the user Auth claims, we use countryCode to obtain region.
+     */
+    private getRegion;
+    private getPlatformMetadata;
+    private getEventMetadata;
+    private getRegionByName;
+    private normalizeYearGroup;
+}
+export {};

package/dist/libs/analytics/src/constants/CountryRegionMapping.d.ts

@@ -0,0 +1,7 @@
+import { CountryCode } from 'libs/analytics/enums/CountryCode';
+import { RegionName } from 'libs/analytics/enums/RegionName';
+export declare const CountryRegionMapping: {
+    au: RegionName;
+    nz: RegionName;
+    uk: RegionName;
+};

package/dist/libs/analytics/src/constants/EventFirehose.d.ts

@@ -0,0 +1,4 @@
+export declare enum EventFirehose {
+    Inlet = "event:inlet",
+    Outlet = "event:outlet"
+}

package/dist/libs/analytics/src/constants/GlobalChannels.d.ts

@@ -0,0 +1,3 @@
+export declare const GlobalChannels: {
+    ANALYTICS: string;
+};

package/dist/libs/analytics/src/constants/Regions.d.ts

@@ -0,0 +1,6 @@
+import { Region } from 'libs/analytics/interfaces/Region';
+export declare const Regions: {
+    CvApSoutheast1: Region;
+    CvApSoutheast2: Region;
+    CvEuWest1: Region;
+};

package/dist/libs/analytics/src/constants/Services.d.ts

@@ -0,0 +1,4 @@
+export declare enum Services {
+    Analytics = "AnalyticsService",
+    Context = "ContextService"
+}

package/dist/libs/analytics/src/enums/CountryCode.d.ts

@@ -0,0 +1,5 @@
+export declare enum CountryCode {
+    AU = "au",
+    NZ = "nz",
+    UK = "uk"
+}

package/dist/libs/analytics/src/enums/RegionName.d.ts

@@ -0,0 +1,5 @@
+export declare enum RegionName {
+    CvApSoutheast1 = "cv-ap-southeast-1",
+    CvApSoutheast2 = "cv-ap-southeast-2",
+    CvEuWest1 = "cv-eu-west-1"
+}