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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -56,6 +56,7 @@ export interface FeatureAttributeCommon {
56
56
  shouldSuppressOpeningPlayer?: boolean;
57
57
  shouldShowSelectWelcomeModal?: boolean;
58
58
  shouldSuppressBookmark?: boolean;
59
+ shouldSuppressBookmarkAction?: boolean;
59
60
  shouldSuppressPlaylistAdministration?: boolean;
60
61
  shouldSuppressShareLink?: boolean;
61
62
  shouldSuppressLibrary?: boolean;
@@ -63,6 +64,9 @@ export interface FeatureAttributeCommon {
63
64
  shouldSuppressCopyRightFooter?: boolean;
64
65
  shouldSuppressPlay?: boolean;
65
66
  shouldSuppressExport?: boolean;
67
+ shouldSuppressAIAgents?: boolean;
68
+ shouldSuppressAIDiscoveryAgent?: boolean;
69
+ shouldSuppressAIReportingAgent?: boolean;
66
70
  contentScope?: 'subscription' | 'library';
67
71
  shouldSuppressEndorsement?: boolean;
68
72
  }
@@ -102,7 +106,9 @@ export type Go1MessageType =
102
106
  | 'swap_out_open'
103
107
  | 'swap_out_close'
104
108
  | 'play_content'
105
- | 'library_content_added';
109
+ | 'library_content_added'
110
+ | 'library_content_removed'
111
+ | 'save_content';
106
112
 
107
113
  export interface Go1Message {
108
114
  type: Go1MessageType;
@@ -115,6 +121,7 @@ export interface FeatureAttributeCommon {
115
121
  shouldSuppressOpeningPlayer?: boolean;
116
122
  shouldShowSelectWelcomeModal?: boolean;
117
123
  shouldSuppressBookmark?: boolean;
124
+ shouldSuppressBookmarkAction?: boolean;
118
125
  shouldSuppressPlaylistAdministration?: boolean;
119
126
  shouldSuppressShareLink?: boolean;
120
127
  shouldSuppressLibrary?: boolean;
@@ -122,12 +129,16 @@ export interface FeatureAttributeCommon {
122
129
  shouldSuppressCopyRightFooter?: boolean;
123
130
  shouldSuppressPlay?: boolean;
124
131
  shouldSuppressExport?: boolean;
132
+ shouldSuppressAIAgents?: boolean;
133
+ shouldSuppressAIDiscoveryAgent?: boolean;
134
+ shouldSuppressAIReportingAgent?: boolean;
125
135
  contentScope?: 'subscription' | 'library';
126
136
  shouldSuppressEndorsement?: boolean;
127
137
  }
128
138
 
129
139
  /**
130
- * Used to configure the `ai-chat` feature
140
+ * @deprecated Use `feature: 'discovery-agent'` instead.
141
+ * Used to configure the `ai-chat` feature.
131
142
  */
132
143
  export interface FeatureAttributesAIChat extends FeatureAttributeCommon {
133
144
  intent?: 'skill_gap' | 'improve_skills' | 'next_role' | 'aspirations';
@@ -138,6 +149,13 @@ export interface FeatureAttributesAIChat extends FeatureAttributeCommon {
138
149
  showFooter?: boolean // Whether to show/hide the footer, defaults to true
139
150
  }
140
151
 
152
+ /**
153
+ * Used to configure the `discovery-agent` feature
154
+ */
155
+ export interface FeatureAttributesDiscoveryAgent extends FeatureAttributeCommon {
156
+ message?: string; // The desired message to start the chat, which will be shown to the user
157
+ }
158
+
141
159
  /**
142
160
  * Used to configure the `preview` feature
143
161
  */
@@ -190,6 +208,7 @@ export type FeatureAttributesRecommendations = Omit<FeatureAttributesGo1LearnSea
190
208
 
191
209
  export type FeatureAttributes =
192
210
  | FeatureAttributesAIChat
211
+ | FeatureAttributesDiscoveryAgent
193
212
  | FeatureAttributesPreview
194
213
  | FeatureAttributesWallet
195
214
  | FeatureAttributesLibrary
@@ -201,7 +220,9 @@ export interface AdditionalUserInfo {
201
220
  }
202
221
 
203
222
  export type FeatureType =
223
+ /** @deprecated Use 'discovery-agent' instead. */
204
224
  | 'ai-chat'
225
+ | 'discovery-agent'
205
226
  /** @deprecated Use 'admin-curation' instead. */
206
227
  | 'content-hub'
207
228
  | 'preview'
@@ -242,6 +263,9 @@ export interface InitOptions {
242
263
  `admin-curation` for new integrations. Existing `content-hub` requests are
243
264
  redirected server-side to `admin-curation` during the deprecation window.
244
265
 
266
+ `ai-chat` is deprecated and will be removed in a future major release. Use
267
+ `discovery-agent` for new integrations.
268
+
245
269
  ## Function: `useGo1ContentView`
246
270
 
247
271
  A react hook that will return
@@ -344,7 +368,55 @@ Item has been added to the library
344
368
  "type": "library_content_added",
345
369
  "payload": {
346
370
  "id": "3510462",
347
- "type": "lo"
371
+ "action_type": "admin-add",
372
+ "timestamp": "2026-06-16T02:13:45.123Z",
373
+ "type": "lo",
374
+ "lo_type": "course"
375
+ }
376
+ }
377
+ ```
378
+
379
+ Item has been removed from the library
380
+
381
+ ```typescript
382
+ {
383
+ "type": "library_content_removed",
384
+ "payload": {
385
+ "id": "3510462",
386
+ "action_type": "admin-remove",
387
+ "timestamp": "2026-06-16T02:13:45.123Z",
388
+ "type": "lo",
389
+ "lo_type": "course"
390
+ }
391
+ }
392
+ ```
393
+
394
+ Item bookmark action has been requested by a learner while `shouldSuppressBookmarkAction` is enabled
395
+
396
+ ```typescript
397
+ {
398
+ "type": "save_content",
399
+ "payload": {
400
+ "id": "3510462",
401
+ "action_type": "learner-save",
402
+ "timestamp": "2026-06-16T02:13:45.123Z",
403
+ "type": "lo",
404
+ "lo_type": "course"
405
+ }
406
+ }
407
+ ```
408
+
409
+ Item bookmark action has been requested by an admin while `shouldSuppressBookmarkAction` is enabled
410
+
411
+ ```typescript
412
+ {
413
+ "type": "save_content",
414
+ "payload": {
415
+ "id": "3510462",
416
+ "action_type": "admin-save",
417
+ "timestamp": "2026-06-16T02:13:45.123Z",
418
+ "type": "lo",
419
+ "lo_type": "course"
348
420
  }
349
421
  }
350
422
  ```
package/dist/CHANGELOG.md CHANGED
@@ -1,5 +1,24 @@
1
1
  # @go1/go1-embedding-react-sdk
2
2
 
3
+ ## 0.12.0
4
+
5
+ ### Minor Changes
6
+
7
+ - Add AI agent suppression feature attributes.
8
+
9
+ ## 0.11.0
10
+
11
+ ### Minor Changes
12
+
13
+ - Add shouldSuppressBookmarkAction and save_content event payload support.
14
+
15
+ ## 0.10.0
16
+
17
+ ### Minor Changes
18
+
19
+ - Update the schema of event library_content_added.
20
+ - Add new message library_content_removed.
21
+
3
22
  ## 0.9.4
4
23
 
5
24
  ### Patch Changes
package/dist/README.md CHANGED
@@ -56,6 +56,7 @@ export interface FeatureAttributeCommon {
56
56
  shouldSuppressOpeningPlayer?: boolean;
57
57
  shouldShowSelectWelcomeModal?: boolean;
58
58
  shouldSuppressBookmark?: boolean;
59
+ shouldSuppressBookmarkAction?: boolean;
59
60
  shouldSuppressPlaylistAdministration?: boolean;
60
61
  shouldSuppressShareLink?: boolean;
61
62
  shouldSuppressLibrary?: boolean;
@@ -63,6 +64,9 @@ export interface FeatureAttributeCommon {
63
64
  shouldSuppressCopyRightFooter?: boolean;
64
65
  shouldSuppressPlay?: boolean;
65
66
  shouldSuppressExport?: boolean;
67
+ shouldSuppressAIAgents?: boolean;
68
+ shouldSuppressAIDiscoveryAgent?: boolean;
69
+ shouldSuppressAIReportingAgent?: boolean;
66
70
  contentScope?: 'subscription' | 'library';
67
71
  shouldSuppressEndorsement?: boolean;
68
72
  }
@@ -102,7 +106,9 @@ export type Go1MessageType =
102
106
  | 'swap_out_open'
103
107
  | 'swap_out_close'
104
108
  | 'play_content'
105
- | 'library_content_added';
109
+ | 'library_content_added'
110
+ | 'library_content_removed'
111
+ | 'save_content';
106
112
 
107
113
  export interface Go1Message {
108
114
  type: Go1MessageType;
@@ -115,6 +121,7 @@ export interface FeatureAttributeCommon {
115
121
  shouldSuppressOpeningPlayer?: boolean;
116
122
  shouldShowSelectWelcomeModal?: boolean;
117
123
  shouldSuppressBookmark?: boolean;
124
+ shouldSuppressBookmarkAction?: boolean;
118
125
  shouldSuppressPlaylistAdministration?: boolean;
119
126
  shouldSuppressShareLink?: boolean;
120
127
  shouldSuppressLibrary?: boolean;
@@ -122,12 +129,16 @@ export interface FeatureAttributeCommon {
122
129
  shouldSuppressCopyRightFooter?: boolean;
123
130
  shouldSuppressPlay?: boolean;
124
131
  shouldSuppressExport?: boolean;
132
+ shouldSuppressAIAgents?: boolean;
133
+ shouldSuppressAIDiscoveryAgent?: boolean;
134
+ shouldSuppressAIReportingAgent?: boolean;
125
135
  contentScope?: 'subscription' | 'library';
126
136
  shouldSuppressEndorsement?: boolean;
127
137
  }
128
138
 
129
139
  /**
130
- * Used to configure the `ai-chat` feature
140
+ * @deprecated Use `feature: 'discovery-agent'` instead.
141
+ * Used to configure the `ai-chat` feature.
131
142
  */
132
143
  export interface FeatureAttributesAIChat extends FeatureAttributeCommon {
133
144
  intent?: 'skill_gap' | 'improve_skills' | 'next_role' | 'aspirations';
@@ -138,6 +149,13 @@ export interface FeatureAttributesAIChat extends FeatureAttributeCommon {
138
149
  showFooter?: boolean // Whether to show/hide the footer, defaults to true
139
150
  }
140
151
 
152
+ /**
153
+ * Used to configure the `discovery-agent` feature
154
+ */
155
+ export interface FeatureAttributesDiscoveryAgent extends FeatureAttributeCommon {
156
+ message?: string; // The desired message to start the chat, which will be shown to the user
157
+ }
158
+
141
159
  /**
142
160
  * Used to configure the `preview` feature
143
161
  */
@@ -190,6 +208,7 @@ export type FeatureAttributesRecommendations = Omit<FeatureAttributesGo1LearnSea
190
208
 
191
209
  export type FeatureAttributes =
192
210
  | FeatureAttributesAIChat
211
+ | FeatureAttributesDiscoveryAgent
193
212
  | FeatureAttributesPreview
194
213
  | FeatureAttributesWallet
195
214
  | FeatureAttributesLibrary
@@ -201,7 +220,9 @@ export interface AdditionalUserInfo {
201
220
  }
202
221
 
203
222
  export type FeatureType =
223
+ /** @deprecated Use 'discovery-agent' instead. */
204
224
  | 'ai-chat'
225
+ | 'discovery-agent'
205
226
  /** @deprecated Use 'admin-curation' instead. */
206
227
  | 'content-hub'
207
228
  | 'preview'
@@ -242,6 +263,9 @@ export interface InitOptions {
242
263
  `admin-curation` for new integrations. Existing `content-hub` requests are
243
264
  redirected server-side to `admin-curation` during the deprecation window.
244
265
 
266
+ `ai-chat` is deprecated and will be removed in a future major release. Use
267
+ `discovery-agent` for new integrations.
268
+
245
269
  ## Function: `useGo1ContentView`
246
270
 
247
271
  A react hook that will return
@@ -344,7 +368,55 @@ Item has been added to the library
344
368
  "type": "library_content_added",
345
369
  "payload": {
346
370
  "id": "3510462",
347
- "type": "lo"
371
+ "action_type": "admin-add",
372
+ "timestamp": "2026-06-16T02:13:45.123Z",
373
+ "type": "lo",
374
+ "lo_type": "course"
375
+ }
376
+ }
377
+ ```
378
+
379
+ Item has been removed from the library
380
+
381
+ ```typescript
382
+ {
383
+ "type": "library_content_removed",
384
+ "payload": {
385
+ "id": "3510462",
386
+ "action_type": "admin-remove",
387
+ "timestamp": "2026-06-16T02:13:45.123Z",
388
+ "type": "lo",
389
+ "lo_type": "course"
390
+ }
391
+ }
392
+ ```
393
+
394
+ Item bookmark action has been requested by a learner while `shouldSuppressBookmarkAction` is enabled
395
+
396
+ ```typescript
397
+ {
398
+ "type": "save_content",
399
+ "payload": {
400
+ "id": "3510462",
401
+ "action_type": "learner-save",
402
+ "timestamp": "2026-06-16T02:13:45.123Z",
403
+ "type": "lo",
404
+ "lo_type": "course"
405
+ }
406
+ }
407
+ ```
408
+
409
+ Item bookmark action has been requested by an admin while `shouldSuppressBookmarkAction` is enabled
410
+
411
+ ```typescript
412
+ {
413
+ "type": "save_content",
414
+ "payload": {
415
+ "id": "3510462",
416
+ "action_type": "admin-save",
417
+ "timestamp": "2026-06-16T02:13:45.123Z",
418
+ "type": "lo",
419
+ "lo_type": "course"
348
420
  }
349
421
  }
350
422
  ```
@@ -43,6 +43,7 @@ function isValidFeature(feature) {
43
43
  return types_1.features.includes(feature);
44
44
  }
45
45
  exports.DEPRECATED_FEATURES = {
46
+ 'ai-chat': 'discovery-agent',
46
47
  'content-hub': 'admin-curation',
47
48
  };
48
49
  function warnIfDeprecatedFeature(feature) {
@@ -26,7 +26,24 @@ export interface ThemeInformationElysium {
26
26
  mode?: ThemeMode;
27
27
  }
28
28
  export type ThemeInformationPayload = ThemeInformation | ThemeInformationElysium | ThemeModeInformation;
29
- 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';
29
+ 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';
30
+ export type LibraryContentAddedActionType = 'admin-add';
31
+ export type LibraryContentRemovedActionType = 'admin-remove';
32
+ export type SaveContentActionType = 'learner-save' | 'admin-save';
33
+ export type LibraryContentAddedContentType = 'lo' | 'playlist';
34
+ export interface LibraryContentMessagePayload {
35
+ id: string;
36
+ action_type: LibraryContentAddedActionType | LibraryContentRemovedActionType | SaveContentActionType;
37
+ timestamp: string;
38
+ type?: LibraryContentAddedContentType;
39
+ lo_type?: string;
40
+ }
41
+ export interface LibraryContentAddedPayload extends LibraryContentMessagePayload {
42
+ action_type: LibraryContentAddedActionType;
43
+ }
44
+ export interface LibraryContentRemovedPayload extends LibraryContentMessagePayload {
45
+ action_type: LibraryContentRemovedActionType;
46
+ }
30
47
  interface Go1MessageUpdateExperience {
31
48
  type: 'update_experience';
32
49
  payload: {
@@ -44,6 +61,7 @@ export interface FeatureAttributeCommon {
44
61
  shouldSuppressOpeningPlayer?: boolean;
45
62
  shouldShowSelectWelcomeModal?: boolean;
46
63
  shouldSuppressBookmark?: boolean;
64
+ shouldSuppressBookmarkAction?: boolean;
47
65
  shouldSuppressPlaylistAdministration?: boolean;
48
66
  shouldSuppressShareLink?: boolean;
49
67
  shouldSuppressLibrary?: boolean;
@@ -51,6 +69,9 @@ export interface FeatureAttributeCommon {
51
69
  shouldSuppressCopyRightFooter?: boolean;
52
70
  shouldSuppressPlay?: boolean;
53
71
  shouldSuppressExport?: boolean;
72
+ shouldSuppressAIAgents?: boolean;
73
+ shouldSuppressAIDiscoveryAgent?: boolean;
74
+ shouldSuppressAIReportingAgent?: boolean;
54
75
  experience?: ExternalExperience;
55
76
  contentScope?: 'subscription' | 'library';
56
77
  shouldSuppressEndorsement?: boolean;
@@ -69,6 +90,9 @@ export interface FeatureAttributesAIChat extends FeatureAttributesPreviewCommon
69
90
  desiredRole?: string;
70
91
  showFooter?: boolean;
71
92
  }
93
+ export interface FeatureAttributesDiscoveryAgent extends FeatureAttributeCommon {
94
+ message?: string;
95
+ }
72
96
  export interface FeatureAttributesPreview extends FeatureAttributesPreviewCommon {
73
97
  id: number;
74
98
  }
@@ -118,12 +142,12 @@ export type SearchLearningObjectsOptions = {
118
142
  sort?: string;
119
143
  };
120
144
  export type FeatureAttributesRecommendations = Omit<FeatureAttributesGo1LearnSearch, 'searchProvider'> & SearchLearningObjectsOptions;
121
- export type FeatureAttributes = FeatureAttributesAIChat | FeatureAttributesPreview | FeatureAttributesWallet | FeatureAttributesLibrary | FeatureAttributesSearch | FeatureAttributesMyLearning | FeatureAttributesBulkUpload | FeatureAttributesContentStatus | FeatureAttributesGo1LearnSearch | FeatureAttributesRecommendations;
145
+ export type FeatureAttributes = FeatureAttributesAIChat | FeatureAttributesDiscoveryAgent | FeatureAttributesPreview | FeatureAttributesWallet | FeatureAttributesLibrary | FeatureAttributesSearch | FeatureAttributesMyLearning | FeatureAttributesBulkUpload | FeatureAttributesContentStatus | FeatureAttributesGo1LearnSearch | FeatureAttributesRecommendations;
122
146
  export interface AdditionalUserInfo {
123
147
  jobTitle: string;
124
148
  }
125
- 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"];
126
- export type FeatureType = Exclude<(typeof features)[number], 'content-hub'> | 'content-hub';
149
+ 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"];
150
+ export type FeatureType = Exclude<(typeof features)[number], 'ai-chat' | 'content-hub'> | 'ai-chat' | 'content-hub';
127
151
  export interface InitOptions {
128
152
  feature: FeatureType;
129
153
  iframeParentId?: string;
@@ -7,6 +7,7 @@ exports.features = [
7
7
  'admin-curation',
8
8
  'auth-clients',
9
9
  'auth-clients-public',
10
+ 'discovery-agent',
10
11
  'go1-learn/library',
11
12
  'go1-learn/my-learning',
12
13
  'go1-learn/search',
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@go1/go1-embedding-react-sdk",
3
- "version": "0.9.4",
3
+ "version": "0.12.0",
4
4
  "description": "A React library to embed Go1 content into your website.",
5
5
  "main": "dist/go1-embedding-react-sdk/src/index.js",
6
6
  "files": [