@go1/go1-embedding-react-sdk 0.0.45 → 0.0.48

package/README.md

@@ -77,7 +77,8 @@ export type Go1MessageType =
   | 'search_filter_toggle'
   | 'pass_ott'
   | 'logout',
-  | 'sync_content';
+  | 'sync_content'
+  | 'inter_feature_navigation';
 
 export interface Go1Message {
   type: Go1MessageType;
@@ -88,7 +89,6 @@ interface FeatureAttributeCommon {
   shouldSuppressPreview?: boolean;
   experience?: 'manager' | 'learner';
   shouldShowGo1FeedbackButton?: boolean;
-  shouldShowSaveToPlaylistButton?: boolean;
   contentScope?: 'subscription' | 'library';
 }
 
@@ -136,13 +136,17 @@ export interface FeatureAttributesRetirement extends FeatureAttributeCommon {
 }
 
 export interface FeatureAttributesSearch extends FeatureAttributeCommon {}
+export interface FeatureAttributesMyPlaylists extends FeatureAttributesPreviewCommon {
+  playlistId?: number; // If embedding my-playlists feature with playlistId, the app will initialise with the specified playlistId page.
+}
 
 export type FeatureAttributes =
   | FeatureAttributesAIChat
   | FeatureAttributesPreview
   | FeatureAttributesWallet
   | FeatureAttributesLibrary
-  | FeatureAttributesSearch;
+  | FeatureAttributesSearch
+  | FeatureAttributesMyPlaylists;
 
 export interface AdditionalUserInfo {
   jobTitle: string;
@@ -156,7 +160,8 @@ export type FeatureType =
   | 'search'
   | 'wallet'
   | 'content-retirement'
-  | 'my-playlists';
+  | 'my-playlists'
+  | 'activity-feed';
 
 export interface InitOptions {
   /** Mandatory identifier for the embedded feature */
@@ -234,6 +239,8 @@ const { sendMessageToGo1, ContentView } = useGo1ContentView(options);
 
 Send a message to the Go1 content view. Useful to control the user experience when an event starts on your website and the Go1 content view needs to be aware of it (and potentially perform other actions - this is `feature` dependent.)
 
+A currently supported message is `update_experience`, this will update the experience Feature Attribute. An example of its usage is below.
+
 ```typescript
 function sendMessageToGo1(message: Go1Message): void;
 ```
@@ -242,7 +249,8 @@ function sendMessageToGo1(message: Go1Message): void;
 
 ```typescript
 const message = {
-  type: 'return_to_home_screen',
+  type: 'update_experience',
+  payload: { experience: 'learner' },
 };
 sendMessageToGo1(message);
 ```

package/dist/README.md

@@ -77,7 +77,8 @@ export type Go1MessageType =
   | 'search_filter_toggle'
   | 'pass_ott'
   | 'logout',
-  | 'sync_content';
+  | 'sync_content'
+  | 'inter_feature_navigation';
 
 export interface Go1Message {
   type: Go1MessageType;
@@ -88,7 +89,6 @@ interface FeatureAttributeCommon {
   shouldSuppressPreview?: boolean;
   experience?: 'manager' | 'learner';
   shouldShowGo1FeedbackButton?: boolean;
-  shouldShowSaveToPlaylistButton?: boolean;
   contentScope?: 'subscription' | 'library';
 }
 
@@ -136,13 +136,17 @@ export interface FeatureAttributesRetirement extends FeatureAttributeCommon {
 }
 
 export interface FeatureAttributesSearch extends FeatureAttributeCommon {}
+export interface FeatureAttributesMyPlaylists extends FeatureAttributesPreviewCommon {
+  playlistId?: number; // If embedding my-playlists feature with playlistId, the app will initialise with the specified playlistId page.
+}
 
 export type FeatureAttributes =
   | FeatureAttributesAIChat
   | FeatureAttributesPreview
   | FeatureAttributesWallet
   | FeatureAttributesLibrary
-  | FeatureAttributesSearch;
+  | FeatureAttributesSearch
+  | FeatureAttributesMyPlaylists;
 
 export interface AdditionalUserInfo {
   jobTitle: string;
@@ -156,7 +160,8 @@ export type FeatureType =
   | 'search'
   | 'wallet'
   | 'content-retirement'
-  | 'my-playlists';
+  | 'my-playlists'
+  | 'activity-feed';
 
 export interface InitOptions {
   /** Mandatory identifier for the embedded feature */
@@ -234,6 +239,8 @@ const { sendMessageToGo1, ContentView } = useGo1ContentView(options);
 
 Send a message to the Go1 content view. Useful to control the user experience when an event starts on your website and the Go1 content view needs to be aware of it (and potentially perform other actions - this is `feature` dependent.)
 
+A currently supported message is `update_experience`, this will update the experience Feature Attribute. An example of its usage is below.
+
 ```typescript
 function sendMessageToGo1(message: Go1Message): void;
 ```
@@ -242,7 +249,8 @@ function sendMessageToGo1(message: Go1Message): void;
 
 ```typescript
 const message = {
-  type: 'return_to_home_screen',
+  type: 'update_experience',
+  payload: { experience: 'learner' },
 };
 sendMessageToGo1(message);
 ```

package/dist/common/types.d.ts

@@ -9,20 +9,21 @@ export interface AdditionalInfoMessage {
     themeInformation?: ThemeInformation;
     integrationSystemId?: string;
     presentingIntegrationSystemId?: string;
+    experience?: FeatureAttributes['experience'];
 }
 export interface ThemeInformation {
     accent: string;
 }
-export type Go1MessageType = 'preview_start_content' | 'preview_close' | 'preview_add_content_success' | 'preview_add_content_failure' | 'preview_remove_content_success' | 'preview_remove_content_failure' | 'parent_show_preview' | 'set_additional_embedding_data' | 'go1_app_initialised' | 'ott_required' | 'search_result_selected' | 'search_filter_toggle' | 'search_redirected' | 'pass_ott' | 'logout' | 'sync_content' | 'open_save_to_playlist_modal';
+export type Go1MessageType = 'preview_start_content' | 'preview_close' | 'preview_add_content_success' | 'preview_add_content_failure' | 'preview_remove_content_success' | 'preview_remove_content_failure' | 'parent_show_preview' | 'set_additional_embedding_data' | 'go1_app_initialised' | 'ott_required' | 'search_result_selected' | 'search_filter_toggle' | 'search_redirected' | 'pass_ott' | 'logout' | 'sync_content' | 'open_save_to_playlist_modal' | 'update_experience' | 'inter_feature_navigation';
 export interface Go1Message {
     type: Go1MessageType;
     payload?: any;
 }
+type go1OnlyEnabledFeatures = Array<'ai-chat' | 'library' | 'my-playlists' | 'search'>;
 export interface FeatureAttributeCommon {
     shouldSuppressPreview?: boolean;
     experience?: 'manager' | 'learner';
     shouldShowGo1FeedbackButton?: boolean;
-    shouldShowSaveToPlaylistButton?: boolean;
     featureName?: string;
     contentScope?: 'subscription' | 'library';
 }
@@ -37,6 +38,8 @@ export interface FeatureAttributesAIChat extends FeatureAttributesPreviewCommon
     existingSkills?: string[];
     desiredSkills?: string[];
     desiredRole?: string;
+    go1OnlySaveToMyPlaylistsOverride?: boolean;
+    go1OnlyEnabledFeatures?: go1OnlyEnabledFeatures;
 }
 export interface FeatureAttributesPreview extends FeatureAttributesPreviewCommon {
     id: number;
@@ -52,20 +55,26 @@ export interface FeatureAttributesLearnerSearch extends FeatureAttributeCommon {
 export interface FeatureAttributesLibrary extends FeatureAttributesPreviewCommon, FeatureAttributesRetirement {
     libraryEmptyStateDescription?: string;
     shouldShowLibraryTabs?: boolean;
+    go1OnlyEnabledFeatures?: go1OnlyEnabledFeatures;
 }
 export interface FeatureAttributesRetirement extends FeatureAttributesPreviewCommon {
     shouldShowAlternativesSearchButton?: boolean;
     shouldShowNotificationEmailRegisterSwitch?: boolean;
 }
 export interface FeatureAttributesSearch extends FeatureAttributesPreviewCommon {
+    go1OnlyEnabledFeatures?: go1OnlyEnabledFeatures;
 }
 export interface FeatureAttributesContentHub extends FeatureAttributesPreviewCommon {
 }
-export type FeatureAttributes = FeatureAttributesAIChat | FeatureAttributesPreview | FeatureAttributesWallet | FeatureAttributesLibrary | FeatureAttributesSearch;
+export interface FeatureAttributesMyPlaylists extends FeatureAttributesPreviewCommon {
+    playlistId?: number;
+    go1OnlyEnabledFeatures?: go1OnlyEnabledFeatures;
+}
+export type FeatureAttributes = FeatureAttributesAIChat | FeatureAttributesPreview | FeatureAttributesWallet | FeatureAttributesLibrary | FeatureAttributesSearch | FeatureAttributesMyPlaylists;
 export interface AdditionalUserInfo {
     jobTitle: string;
 }
-export declare const features: readonly ["ai-chat", "content-hub", "preview", "library", "search", "wallet", "content-retirement", "my-playlists"];
+export declare const features: readonly ["ai-chat", "content-hub", "preview", "library", "search", "wallet", "content-retirement", "my-playlists", "activity-feed"];
 export type FeatureType = (typeof features)[number];
 export interface InitOptions {
     feature: FeatureType;

package/dist/common/types.js

@@ -10,4 +10,5 @@ exports.features = [
     'wallet',
     'content-retirement',
     'my-playlists',
+    'activity-feed',
 ];

package/dist/go1-embedding-react-sdk/src/index.js

@@ -19,7 +19,7 @@ function useGo1ContentView(props) {
         iframeRef.current?.contentWindow?.postMessage(message, url);
     }, [url]);
     let { iframeURL, iframeID } = (0, react_1.useMemo)(() => {
-        let iframeURL = new URL(`${url}/${feature === 'my-playlists' ? 'my-playlists/own' : `${feature}`}`);
+        let iframeURL = new URL(`${url}/${feature}`);
         if (portalURL) {
             (0, params_1.addPortalURL)(iframeURL, portalURL, env);
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@go1/go1-embedding-react-sdk",
-  "version": "0.0.45",
+  "version": "0.0.48",
   "description": "A React library to embed Go1 content into your website.",
   "main": "dist/go1-embedding-react-sdk/src/index.js",
   "files": [