@go1/go1-embedding-react-sdk 0.4.0 → 0.6.0

package/README.md

@@ -51,12 +51,17 @@ export type SendMessageToGo1 = (message: Go1Message) => void;
 
 export type IframesMap = { [key: string]: HTMLIFrameElement };
 
-export interface AdditionalInfoMessage {
-  additionalUserInfo?: AdditionalUserInfo;
-  featureAttributes?: FeatureAttributes;
-  themeInformation?: ThemeInformation;
+export interface FeatureAttributeCommon {
+  shouldSuppressPreview?: boolean;
+  shouldSuppressOpeningPlayer?: boolean;
+  shouldShowSelectWelcomeModal?: boolean;
+  shouldSuppressBookmark?: boolean;
+  shouldSuppressPlaylistAdministration?: boolean;
+  shouldSuppressShareLink?: boolean;
+  contentScope?: 'subscription' | 'library';
 }
 
+
 export interface ThemeInformation {
   /** Hex string, starting with a #. Example #0437F2 */
   accent: string;
@@ -84,18 +89,21 @@ export type Go1MessageType =
   | 'swap_out_open'
   | 'swap_out_close'
   | 'play_content'
-  | 'go1pay_custom_data';
+  | 'library_content_added';
 
 export interface Go1Message {
   type: Go1MessageType;
   payload?: any;
 }
 
-export type Experience = 'manager' | 'learner' | 'role-aware'
 
-interface FeatureAttributeCommon {
+export interface FeatureAttributeCommon {
   shouldSuppressPreview?: boolean;
-  experience?: Experience; // Defaults to `manager`
+  shouldSuppressOpeningPlayer?: boolean;
+  shouldShowSelectWelcomeModal?: boolean;
+  shouldSuppressBookmark?: boolean;
+  shouldSuppressPlaylistAdministration?: boolean;
+  shouldSuppressShareLink?: boolean;
   contentScope?: 'subscription' | 'library';
 }
 
@@ -130,11 +138,6 @@ export interface FeatureAttributesWallet extends FeatureAttributeCommon {
   oneClickBuyUrl?: string;
 }
 
-export interface FeatureAttributesLearnerSearch extends FeatureAttributeCommon {
-  isGo1MobileApp?: boolean;
-  experience?: 'learner';
-}
-
 export interface FeatureAttributesLibrary extends FeatureAttributeCommon, FeatureAttributesRetirement {
   libraryEmptyStateDescription?: string;
   shouldShowLibraryTabs?: boolean;
@@ -154,7 +157,13 @@ export interface FeatureAttributesMyPlaylists extends FeatureAttributesPreviewCo
 
 export interface FeatureAttributesMyLearning extends FeatureAttributeCommon {}
 
-export interface FeatureAttributesGo1LearnSearch extends FeatureAttributeCommon {
+export interface FeatureAttributesProspect {
+  isProspectExperience?: boolean;
+}
+
+export interface FeatureAttributesGo1LearnSearch
+  extends FeatureAttributeCommon,
+    FeatureAttributesProspect {
   searchTerm?: string; // If the embedding search feature includes a search term, the app will initialize with the pre-filled search term.
   searchProvider?: string; // If the embedding search feature includes a search provider, the app will initialize with the pre-filled search provider.
 }
@@ -184,13 +193,8 @@ export type FeatureType =
   | 'ai-chat'
   | 'content-hub'
   | 'preview'
-  | 'library'
   | 'search'
-  | 'wallet'
-  | 'content-retirement'
-  | 'my-playlists'
-  | 'activity-feed'
-  | 'my-learning';
+  | 'admin-curation';
 
 export interface InitOptions {
   /** Mandatory identifier for the embedded feature */
@@ -209,8 +213,10 @@ export interface InitOptions {
   additionalUserInfo?: AdditionalUserInfo;
   /** Optional UI configuration */
   themeInformation?: ThemeInformation;
-  /** Optional token that is used to pre-authorize the user without them needing to log in */
+  /** Optional one time token that is used to pre-authorize the user without them needing to log in */
   oneTimeToken?: string;
+  /** Optional OAuth token that is used to pre-authorize the user without them needing to log in */
+  accessToken?: string;
   /** Optional Id that let us know which integration system users are coming from (will be required in the future)*/
   integrationSystemId?: string;
   /** Optional Id that let us know which integration system users are coming from, if using an intermediary system to embed */
@@ -245,7 +251,7 @@ const options = useMemo<ContentViewProps>(() => {
     feature: 'ai-chat',
     portalURL: 'learning-incorporated-usa.mygo1.com',
     featureAttributes: {
-      experience: 'manager',
+      shouldSuppressShareLink: true,
     },
     onGo1MessageReceived,
     additionalUserInfo: {
@@ -268,7 +274,7 @@ 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.
+An example of its usage is below.
 
 ```typescript
 function sendMessageToGo1(message: Go1Message): void;
@@ -278,8 +284,8 @@ function sendMessageToGo1(message: Go1Message): void;
 
 ```typescript
 const message = {
-  type: 'update_experience',
-  payload: { experience: 'learner' },
+  type: 'logout',
+  payload: {},
 };
 sendMessageToGo1(message);
 ```
@@ -317,7 +323,8 @@ Item has been added to the library
 {
   "type": "library_content_added",
   "payload": {
-    "id": "3510462"
+    "id": "3510462",
+    "type": "lo"
   }
 }
 ```

package/dist/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @go1/go1-embedding-react-sdk
 
+## 0.6.0
+
+### Minor Changes
+
+- - Adding isProspectExperience to featureAttributes. Allowing partners to use the Prospect experience
+
+## 0.5.0
+
+### Minor Changes
+
+- New featureAttributes for Select Welcome Modal and Recommendation
+- new Go1MessageType 'contact_go1_navigation'
+- Add new feature auth-clients
+
+### Patch Changes
+
+- Add new message library_content_added
+- Remove message elysium_modal_open and elysium_modal_close
+- Adding shouldSuppressBookmark and shouldSuppressPlaylistAdministration to featureAttributes, allowing partners to hide the bookmark and playlist functionality
+
 ## 0.4.0
 
 ### Minor Changes

package/dist/README.md

@@ -51,12 +51,17 @@ export type SendMessageToGo1 = (message: Go1Message) => void;
 
 export type IframesMap = { [key: string]: HTMLIFrameElement };
 
-export interface AdditionalInfoMessage {
-  additionalUserInfo?: AdditionalUserInfo;
-  featureAttributes?: FeatureAttributes;
-  themeInformation?: ThemeInformation;
+export interface FeatureAttributeCommon {
+  shouldSuppressPreview?: boolean;
+  shouldSuppressOpeningPlayer?: boolean;
+  shouldShowSelectWelcomeModal?: boolean;
+  shouldSuppressBookmark?: boolean;
+  shouldSuppressPlaylistAdministration?: boolean;
+  shouldSuppressShareLink?: boolean;
+  contentScope?: 'subscription' | 'library';
 }
 
+
 export interface ThemeInformation {
   /** Hex string, starting with a #. Example #0437F2 */
   accent: string;
@@ -84,18 +89,21 @@ export type Go1MessageType =
   | 'swap_out_open'
   | 'swap_out_close'
   | 'play_content'
-  | 'go1pay_custom_data';
+  | 'library_content_added';
 
 export interface Go1Message {
   type: Go1MessageType;
   payload?: any;
 }
 
-export type Experience = 'manager' | 'learner' | 'role-aware'
 
-interface FeatureAttributeCommon {
+export interface FeatureAttributeCommon {
   shouldSuppressPreview?: boolean;
-  experience?: Experience; // Defaults to `manager`
+  shouldSuppressOpeningPlayer?: boolean;
+  shouldShowSelectWelcomeModal?: boolean;
+  shouldSuppressBookmark?: boolean;
+  shouldSuppressPlaylistAdministration?: boolean;
+  shouldSuppressShareLink?: boolean;
   contentScope?: 'subscription' | 'library';
 }
 
@@ -130,11 +138,6 @@ export interface FeatureAttributesWallet extends FeatureAttributeCommon {
   oneClickBuyUrl?: string;
 }
 
-export interface FeatureAttributesLearnerSearch extends FeatureAttributeCommon {
-  isGo1MobileApp?: boolean;
-  experience?: 'learner';
-}
-
 export interface FeatureAttributesLibrary extends FeatureAttributeCommon, FeatureAttributesRetirement {
   libraryEmptyStateDescription?: string;
   shouldShowLibraryTabs?: boolean;
@@ -154,7 +157,13 @@ export interface FeatureAttributesMyPlaylists extends FeatureAttributesPreviewCo
 
 export interface FeatureAttributesMyLearning extends FeatureAttributeCommon {}
 
-export interface FeatureAttributesGo1LearnSearch extends FeatureAttributeCommon {
+export interface FeatureAttributesProspect {
+  isProspectExperience?: boolean;
+}
+
+export interface FeatureAttributesGo1LearnSearch
+  extends FeatureAttributeCommon,
+    FeatureAttributesProspect {
   searchTerm?: string; // If the embedding search feature includes a search term, the app will initialize with the pre-filled search term.
   searchProvider?: string; // If the embedding search feature includes a search provider, the app will initialize with the pre-filled search provider.
 }
@@ -184,13 +193,8 @@ export type FeatureType =
   | 'ai-chat'
   | 'content-hub'
   | 'preview'
-  | 'library'
   | 'search'
-  | 'wallet'
-  | 'content-retirement'
-  | 'my-playlists'
-  | 'activity-feed'
-  | 'my-learning';
+  | 'admin-curation';
 
 export interface InitOptions {
   /** Mandatory identifier for the embedded feature */
@@ -209,8 +213,10 @@ export interface InitOptions {
   additionalUserInfo?: AdditionalUserInfo;
   /** Optional UI configuration */
   themeInformation?: ThemeInformation;
-  /** Optional token that is used to pre-authorize the user without them needing to log in */
+  /** Optional one time token that is used to pre-authorize the user without them needing to log in */
   oneTimeToken?: string;
+  /** Optional OAuth token that is used to pre-authorize the user without them needing to log in */
+  accessToken?: string;
   /** Optional Id that let us know which integration system users are coming from (will be required in the future)*/
   integrationSystemId?: string;
   /** Optional Id that let us know which integration system users are coming from, if using an intermediary system to embed */
@@ -245,7 +251,7 @@ const options = useMemo<ContentViewProps>(() => {
     feature: 'ai-chat',
     portalURL: 'learning-incorporated-usa.mygo1.com',
     featureAttributes: {
-      experience: 'manager',
+      shouldSuppressShareLink: true,
     },
     onGo1MessageReceived,
     additionalUserInfo: {
@@ -268,7 +274,7 @@ 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.
+An example of its usage is below.
 
 ```typescript
 function sendMessageToGo1(message: Go1Message): void;
@@ -278,8 +284,8 @@ function sendMessageToGo1(message: Go1Message): void;
 
 ```typescript
 const message = {
-  type: 'update_experience',
-  payload: { experience: 'learner' },
+  type: 'logout',
+  payload: {},
 };
 sendMessageToGo1(message);
 ```
@@ -317,7 +323,8 @@ Item has been added to the library
 {
   "type": "library_content_added",
   "payload": {
-    "id": "3510462"
+    "id": "3510462",
+    "type": "lo"
   }
 }
 ```

package/dist/common/types.d.ts

@@ -19,7 +19,7 @@ export interface ThemeInformation {
 export interface ThemeInformationElysium {
     brandColor: 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' | 'set_access_token' | 'logout' | 'sync_content' | 'open_save_to_playlist_modal' | 'update_experience' | 'inter_feature_navigation' | 'side_drawer_open' | 'side_drawer_close' | 'elysium_modal_open' | 'elysium_modal_close' | 'play_content' | 'go1pay_custom_data' | 'bulk_upload_content' | 'bulk_upload_metadata' | 'bulk_upload_close' | 'contact_go1_navigation' | 'library_content_added';
+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' | 'set_access_token' | 'logout' | 'sync_content' | 'open_save_to_playlist_modal' | 'update_experience' | 'inter_feature_navigation' | 'side_drawer_open' | 'side_drawer_close' | 'play_content' | 'go1pay_custom_data' | 'bulk_upload_content' | 'bulk_upload_metadata' | 'bulk_upload_close' | 'contact_go1_navigation' | 'library_content_added';
 interface Go1MessageUpdateExperience {
     type: 'update_experience';
     payload: {
@@ -36,6 +36,9 @@ export interface FeatureAttributeCommon {
     shouldSuppressPreview?: boolean;
     shouldSuppressOpeningPlayer?: boolean;
     shouldShowSelectWelcomeModal?: boolean;
+    shouldSuppressBookmark?: boolean;
+    shouldSuppressPlaylistAdministration?: boolean;
+    shouldSuppressShareLink?: boolean;
     experience?: ExternalExperience;
     contentScope?: 'subscription' | 'library';
 }
@@ -89,7 +92,10 @@ export interface FeatureAttributesMyPlaylists extends FeatureAttributesPreviewCo
 export interface FeatureAttributesMyLearning extends FeatureAttributeCommon {
     selectingTab?: 'saved' | 'in-progress' | 'assigned' | 'completed';
 }
-export interface FeatureAttributesGo1LearnSearch extends FeatureAttributeCommon {
+export interface FeatureAttributesProspect {
+    isProspectExperience?: boolean;
+}
+export interface FeatureAttributesGo1LearnSearch extends FeatureAttributeCommon, FeatureAttributesProspect {
     searchTerm?: string;
     searchProvider?: string;
 }
@@ -104,7 +110,7 @@ export type FeatureAttributes = FeatureAttributesAIChat | FeatureAttributesPrevi
 export interface AdditionalUserInfo {
     jobTitle: string;
 }
-export declare const features: readonly ["auth-clients", "go1-learn/learner-content", "go1-learn/library", "go1-learn/my-learning", "go1-learn/search", "insights", "activity-feed", "ai-chat", "bulk-upload", "content-hub", "content-retirement", "content-status", "home", "library", "my-learning", "my-playlists", "partner-sales", "preview", "recommendations", "search", "wallet"];
+export declare const features: readonly ["auth-clients", "go1-learn/library", "go1-learn/my-learning", "go1-learn/search", "admin-curation", "activity-feed", "ai-chat", "bulk-upload", "content-hub", "content-retirement", "content-status", "library", "my-learning", "my-playlists", "partner-sales", "preview", "recommendations", "search", "wallet"];
 export type FeatureType = (typeof features)[number];
 export interface InitOptions {
     feature: FeatureType;

package/dist/common/types.js

@@ -3,18 +3,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.features = void 0;
 exports.features = [
     'auth-clients',
-    'go1-learn/learner-content',
     'go1-learn/library',
     'go1-learn/my-learning',
     'go1-learn/search',
-    'insights',
+    'admin-curation',
     'activity-feed',
     'ai-chat',
     'bulk-upload',
     'content-hub',
     'content-retirement',
     'content-status',
-    'home',
     'library',
     'my-learning',
     'my-playlists',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@go1/go1-embedding-react-sdk",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "A React library to embed Go1 content into your website.",
   "main": "dist/go1-embedding-react-sdk/src/index.js",
   "files": [
@@ -15,9 +15,6 @@
     "@go1/go1-embedding-js-sdk",
     "Go1"
   ],
-  "scripts": {
-    "test": "jest"
-  },
   "license": "ISC",
   "devDependencies": {
     "@testing-library/jest-dom": "5.17.0",
@@ -31,5 +28,8 @@
   },
   "peerDependencies": {
     "react": ">=16.8"
+  },
+  "scripts": {
+    "test": "jest"
   }
-}
+}