@go1/go1-embedding-react-sdk 0.9.4 → 0.11.0

package/README.md

@@ -56,6 +56,7 @@ export interface FeatureAttributeCommon {
   shouldSuppressOpeningPlayer?: boolean;
   shouldShowSelectWelcomeModal?: boolean;
   shouldSuppressBookmark?: boolean;
+  shouldSuppressBookmarkAction?: boolean;
   shouldSuppressPlaylistAdministration?: boolean;
   shouldSuppressShareLink?: boolean;
   shouldSuppressLibrary?: boolean;
@@ -102,7 +103,9 @@ export type Go1MessageType =
   | 'swap_out_open'
   | 'swap_out_close'
   | 'play_content'
-  | 'library_content_added';
+  | 'library_content_added'
+  | 'library_content_removed'
+  | 'save_content';
 
 export interface Go1Message {
   type: Go1MessageType;
@@ -115,6 +118,7 @@ export interface FeatureAttributeCommon {
   shouldSuppressOpeningPlayer?: boolean;
   shouldShowSelectWelcomeModal?: boolean;
   shouldSuppressBookmark?: boolean;
+  shouldSuppressBookmarkAction?: boolean;
   shouldSuppressPlaylistAdministration?: boolean;
   shouldSuppressShareLink?: boolean;
   shouldSuppressLibrary?: boolean;
@@ -127,7 +131,8 @@ export interface FeatureAttributeCommon {
 }
 
 /**
- * Used to configure the `ai-chat` feature
+ * @deprecated Use `feature: 'discovery-agent'` instead.
+ * Used to configure the `ai-chat` feature.
  */
 export interface FeatureAttributesAIChat extends FeatureAttributeCommon {
   intent?: 'skill_gap' | 'improve_skills' | 'next_role' | 'aspirations';
@@ -138,6 +143,13 @@ export interface FeatureAttributesAIChat extends FeatureAttributeCommon {
   showFooter?: boolean // Whether to show/hide the footer, defaults to true
 }
 
+/**
+ * Used to configure the `discovery-agent` feature
+ */
+export interface FeatureAttributesDiscoveryAgent extends FeatureAttributeCommon {
+  message?: string; // The desired message to start the chat, which will be shown to the user
+}
+
 /**
  * Used to configure the `preview` feature
  */
@@ -190,6 +202,7 @@ export type FeatureAttributesRecommendations = Omit<FeatureAttributesGo1LearnSea
 
 export type FeatureAttributes =
   | FeatureAttributesAIChat
+  | FeatureAttributesDiscoveryAgent
   | FeatureAttributesPreview
   | FeatureAttributesWallet
   | FeatureAttributesLibrary
@@ -201,7 +214,9 @@ export interface AdditionalUserInfo {
 }
 
 export type FeatureType =
+  /** @deprecated Use 'discovery-agent' instead. */
   | 'ai-chat'
+  | 'discovery-agent'
   /** @deprecated Use 'admin-curation' instead. */
   | 'content-hub'
   | 'preview'
@@ -242,6 +257,9 @@ export interface InitOptions {
 `admin-curation` for new integrations. Existing `content-hub` requests are
 redirected server-side to `admin-curation` during the deprecation window.
 
+`ai-chat` is deprecated and will be removed in a future major release. Use
+`discovery-agent` for new integrations.
+
 ## Function: `useGo1ContentView`
 
 A react hook that will return
@@ -344,7 +362,55 @@ Item has been added to the library
   "type": "library_content_added",
   "payload": {
     "id": "3510462",
-    "type": "lo"
+    "action_type": "admin-add",
+    "timestamp": "2026-06-16T02:13:45.123Z",
+    "type": "lo",
+    "lo_type": "course"
+  }
+}
+```
+
+Item has been removed from the library
+
+```typescript
+{
+  "type": "library_content_removed",
+  "payload": {
+    "id": "3510462",
+    "action_type": "admin-remove",
+    "timestamp": "2026-06-16T02:13:45.123Z",
+    "type": "lo",
+    "lo_type": "course"
+  }
+}
+```
+
+Item bookmark action has been requested by a learner while `shouldSuppressBookmarkAction` is enabled
+
+```typescript
+{
+  "type": "save_content",
+  "payload": {
+    "id": "3510462",
+    "action_type": "learner-save",
+    "timestamp": "2026-06-16T02:13:45.123Z",
+    "type": "lo",
+    "lo_type": "course"
+  }
+}
+```
+
+Item bookmark action has been requested by an admin while `shouldSuppressBookmarkAction` is enabled
+
+```typescript
+{
+  "type": "save_content",
+  "payload": {
+    "id": "3510462",
+    "action_type": "admin-save",
+    "timestamp": "2026-06-16T02:13:45.123Z",
+    "type": "lo",
+    "lo_type": "course"
   }
 }
 ```

package/dist/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @go1/go1-embedding-react-sdk
 
+## 0.11.0
+
+### Minor Changes
+
+- Add shouldSuppressBookmarkAction and save_content event payload support.
+
+## 0.10.0
+
+### Minor Changes
+
+- Update the schema of event library_content_added.
+- Add new message library_content_removed.
+
 ## 0.9.4
 
 ### Patch Changes

package/dist/README.md

@@ -56,6 +56,7 @@ export interface FeatureAttributeCommon {
   shouldSuppressOpeningPlayer?: boolean;
   shouldShowSelectWelcomeModal?: boolean;
   shouldSuppressBookmark?: boolean;
+  shouldSuppressBookmarkAction?: boolean;
   shouldSuppressPlaylistAdministration?: boolean;
   shouldSuppressShareLink?: boolean;
   shouldSuppressLibrary?: boolean;
@@ -102,7 +103,9 @@ export type Go1MessageType =
   | 'swap_out_open'
   | 'swap_out_close'
   | 'play_content'
-  | 'library_content_added';
+  | 'library_content_added'
+  | 'library_content_removed'
+  | 'save_content';
 
 export interface Go1Message {
   type: Go1MessageType;
@@ -115,6 +118,7 @@ export interface FeatureAttributeCommon {
   shouldSuppressOpeningPlayer?: boolean;
   shouldShowSelectWelcomeModal?: boolean;
   shouldSuppressBookmark?: boolean;
+  shouldSuppressBookmarkAction?: boolean;
   shouldSuppressPlaylistAdministration?: boolean;
   shouldSuppressShareLink?: boolean;
   shouldSuppressLibrary?: boolean;
@@ -127,7 +131,8 @@ export interface FeatureAttributeCommon {
 }
 
 /**
- * Used to configure the `ai-chat` feature
+ * @deprecated Use `feature: 'discovery-agent'` instead.
+ * Used to configure the `ai-chat` feature.
  */
 export interface FeatureAttributesAIChat extends FeatureAttributeCommon {
   intent?: 'skill_gap' | 'improve_skills' | 'next_role' | 'aspirations';
@@ -138,6 +143,13 @@ export interface FeatureAttributesAIChat extends FeatureAttributeCommon {
   showFooter?: boolean // Whether to show/hide the footer, defaults to true
 }
 
+/**
+ * Used to configure the `discovery-agent` feature
+ */
+export interface FeatureAttributesDiscoveryAgent extends FeatureAttributeCommon {
+  message?: string; // The desired message to start the chat, which will be shown to the user
+}
+
 /**
  * Used to configure the `preview` feature
  */
@@ -190,6 +202,7 @@ export type FeatureAttributesRecommendations = Omit<FeatureAttributesGo1LearnSea
 
 export type FeatureAttributes =
   | FeatureAttributesAIChat
+  | FeatureAttributesDiscoveryAgent
   | FeatureAttributesPreview
   | FeatureAttributesWallet
   | FeatureAttributesLibrary
@@ -201,7 +214,9 @@ export interface AdditionalUserInfo {
 }
 
 export type FeatureType =
+  /** @deprecated Use 'discovery-agent' instead. */
   | 'ai-chat'
+  | 'discovery-agent'
   /** @deprecated Use 'admin-curation' instead. */
   | 'content-hub'
   | 'preview'
@@ -242,6 +257,9 @@ export interface InitOptions {
 `admin-curation` for new integrations. Existing `content-hub` requests are
 redirected server-side to `admin-curation` during the deprecation window.
 
+`ai-chat` is deprecated and will be removed in a future major release. Use
+`discovery-agent` for new integrations.
+
 ## Function: `useGo1ContentView`
 
 A react hook that will return
@@ -344,7 +362,55 @@ Item has been added to the library
   "type": "library_content_added",
   "payload": {
     "id": "3510462",
-    "type": "lo"
+    "action_type": "admin-add",
+    "timestamp": "2026-06-16T02:13:45.123Z",
+    "type": "lo",
+    "lo_type": "course"
+  }
+}
+```
+
+Item has been removed from the library
+
+```typescript
+{
+  "type": "library_content_removed",
+  "payload": {
+    "id": "3510462",
+    "action_type": "admin-remove",
+    "timestamp": "2026-06-16T02:13:45.123Z",
+    "type": "lo",
+    "lo_type": "course"
+  }
+}
+```
+
+Item bookmark action has been requested by a learner while `shouldSuppressBookmarkAction` is enabled
+
+```typescript
+{
+  "type": "save_content",
+  "payload": {
+    "id": "3510462",
+    "action_type": "learner-save",
+    "timestamp": "2026-06-16T02:13:45.123Z",
+    "type": "lo",
+    "lo_type": "course"
+  }
+}
+```
+
+Item bookmark action has been requested by an admin while `shouldSuppressBookmarkAction` is enabled
+
+```typescript
+{
+  "type": "save_content",
+  "payload": {
+    "id": "3510462",
+    "action_type": "admin-save",
+    "timestamp": "2026-06-16T02:13:45.123Z",
+    "type": "lo",
+    "lo_type": "course"
   }
 }
 ```

package/dist/common/params.js

@@ -43,6 +43,7 @@ function isValidFeature(feature) {
     return types_1.features.includes(feature);
 }
 exports.DEPRECATED_FEATURES = {
+    'ai-chat': 'discovery-agent',
     'content-hub': 'admin-curation',
 };
 function warnIfDeprecatedFeature(feature) {

package/dist/common/types.d.ts

@@ -26,7 +26,24 @@ export interface ThemeInformationElysium {
     mode?: ThemeMode;
 }
 export type ThemeInformationPayload = ThemeInformation | ThemeInformationElysium | ThemeModeInformation;
-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_retirement_request' | '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_retirement_request' | 'bulk_upload_close' | 'contact_go1_navigation' | 'library_content_added' | 'library_content_removed' | 'save_content';
+export type LibraryContentAddedActionType = 'admin-add';
+export type LibraryContentRemovedActionType = 'admin-remove';
+export type SaveContentActionType = 'learner-save' | 'admin-save';
+export type LibraryContentAddedContentType = 'lo' | 'playlist';
+export interface LibraryContentMessagePayload {
+    id: string;
+    action_type: LibraryContentAddedActionType | LibraryContentRemovedActionType | SaveContentActionType;
+    timestamp: string;
+    type?: LibraryContentAddedContentType;
+    lo_type?: string;
+}
+export interface LibraryContentAddedPayload extends LibraryContentMessagePayload {
+    action_type: LibraryContentAddedActionType;
+}
+export interface LibraryContentRemovedPayload extends LibraryContentMessagePayload {
+    action_type: LibraryContentRemovedActionType;
+}
 interface Go1MessageUpdateExperience {
     type: 'update_experience';
     payload: {
@@ -44,6 +61,7 @@ export interface FeatureAttributeCommon {
     shouldSuppressOpeningPlayer?: boolean;
     shouldShowSelectWelcomeModal?: boolean;
     shouldSuppressBookmark?: boolean;
+    shouldSuppressBookmarkAction?: boolean;
     shouldSuppressPlaylistAdministration?: boolean;
     shouldSuppressShareLink?: boolean;
     shouldSuppressLibrary?: boolean;
@@ -69,6 +87,9 @@ export interface FeatureAttributesAIChat extends FeatureAttributesPreviewCommon
     desiredRole?: string;
     showFooter?: boolean;
 }
+export interface FeatureAttributesDiscoveryAgent extends FeatureAttributeCommon {
+    message?: string;
+}
 export interface FeatureAttributesPreview extends FeatureAttributesPreviewCommon {
     id: number;
 }
@@ -118,12 +139,12 @@ export type SearchLearningObjectsOptions = {
     sort?: string;
 };
 export type FeatureAttributesRecommendations = Omit<FeatureAttributesGo1LearnSearch, 'searchProvider'> & SearchLearningObjectsOptions;
-export type FeatureAttributes = FeatureAttributesAIChat | FeatureAttributesPreview | FeatureAttributesWallet | FeatureAttributesLibrary | FeatureAttributesSearch | FeatureAttributesMyLearning | FeatureAttributesBulkUpload | FeatureAttributesContentStatus | FeatureAttributesGo1LearnSearch | FeatureAttributesRecommendations;
+export type FeatureAttributes = FeatureAttributesAIChat | FeatureAttributesDiscoveryAgent | FeatureAttributesPreview | FeatureAttributesWallet | FeatureAttributesLibrary | FeatureAttributesSearch | FeatureAttributesMyLearning | FeatureAttributesBulkUpload | FeatureAttributesContentStatus | FeatureAttributesGo1LearnSearch | FeatureAttributesRecommendations;
 export interface AdditionalUserInfo {
     jobTitle: string;
 }
-export declare const features: readonly ["activity-feed", "ai-chat", "admin-curation", "auth-clients", "auth-clients-public", "go1-learn/library", "go1-learn/my-learning", "go1-learn/search", "go1-learn/search-categories", "bulk-upload", "content-hub", "content-status", "partner-sales", "preview", "recommendations", "search", "wallet"];
-export type FeatureType = Exclude<(typeof features)[number], 'content-hub'> | 'content-hub';
+export declare const features: readonly ["activity-feed", "ai-chat", "admin-curation", "auth-clients", "auth-clients-public", "discovery-agent", "go1-learn/library", "go1-learn/my-learning", "go1-learn/search", "go1-learn/search-categories", "bulk-upload", "content-hub", "content-status", "partner-sales", "preview", "recommendations", "search", "wallet"];
+export type FeatureType = Exclude<(typeof features)[number], 'ai-chat' | 'content-hub'> | 'ai-chat' | 'content-hub';
 export interface InitOptions {
     feature: FeatureType;
     iframeParentId?: string;

package/dist/common/types.js

@@ -7,6 +7,7 @@ exports.features = [
     'admin-curation',
     'auth-clients',
     'auth-clients-public',
+    'discovery-agent',
     'go1-learn/library',
     'go1-learn/my-learning',
     'go1-learn/search',

package/package.json

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