@go1/go1-embedding-react-sdk 0.11.0 → 0.13.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.
Files changed (5) hide show
  1. package/README.md +21 -0
  2. package/dist/CHANGELOG.md +12 -0
  3. package/dist/README.md +21 -0
  4. package/dist/common/types.d.ts +10 -1
  5. package/package.json +1 -1
package/README.md CHANGED
@@ -64,6 +64,9 @@ export interface FeatureAttributeCommon {
64
64
  shouldSuppressCopyRightFooter?: boolean;
65
65
  shouldSuppressPlay?: boolean;
66
66
  shouldSuppressExport?: boolean;
67
+ shouldSuppressAIAgents?: boolean;
68
+ shouldSuppressAIDiscoveryAgent?: boolean;
69
+ shouldSuppressAIReportingAgent?: boolean;
67
70
  contentScope?: 'subscription' | 'library';
68
71
  shouldSuppressEndorsement?: boolean;
69
72
  }
@@ -105,6 +108,7 @@ export type Go1MessageType =
105
108
  | 'play_content'
106
109
  | 'library_content_added'
107
110
  | 'library_content_removed'
111
+ | 'library_content_exported'
108
112
  | 'save_content';
109
113
 
110
114
  export interface Go1Message {
@@ -126,6 +130,9 @@ export interface FeatureAttributeCommon {
126
130
  shouldSuppressCopyRightFooter?: boolean;
127
131
  shouldSuppressPlay?: boolean;
128
132
  shouldSuppressExport?: boolean;
133
+ shouldSuppressAIAgents?: boolean;
134
+ shouldSuppressAIDiscoveryAgent?: boolean;
135
+ shouldSuppressAIReportingAgent?: boolean;
129
136
  contentScope?: 'subscription' | 'library';
130
137
  shouldSuppressEndorsement?: boolean;
131
138
  }
@@ -385,6 +392,20 @@ Item has been removed from the library
385
392
  }
386
393
  ```
387
394
 
395
+ Selected library items have been exported through postMessage
396
+
397
+ ```typescript
398
+ {
399
+ "type": "library_content_exported",
400
+ "payload": {
401
+ "items": [
402
+ { "id": "3510462", "type": "lo" },
403
+ { "id": "3510463", "type": "lo" }
404
+ ]
405
+ }
406
+ }
407
+ ```
408
+
388
409
  Item bookmark action has been requested by a learner while `shouldSuppressBookmarkAction` is enabled
389
410
 
390
411
  ```typescript
package/dist/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @go1/go1-embedding-react-sdk
2
2
 
3
+ ## 0.13.0
4
+
5
+ ### Minor Changes
6
+
7
+ - Add library_content_exported postMessage event for selected library item exports.
8
+
9
+ ## 0.12.0
10
+
11
+ ### Minor Changes
12
+
13
+ - Add AI agent suppression feature attributes.
14
+
3
15
  ## 0.11.0
4
16
 
5
17
  ### Minor Changes
package/dist/README.md CHANGED
@@ -64,6 +64,9 @@ export interface FeatureAttributeCommon {
64
64
  shouldSuppressCopyRightFooter?: boolean;
65
65
  shouldSuppressPlay?: boolean;
66
66
  shouldSuppressExport?: boolean;
67
+ shouldSuppressAIAgents?: boolean;
68
+ shouldSuppressAIDiscoveryAgent?: boolean;
69
+ shouldSuppressAIReportingAgent?: boolean;
67
70
  contentScope?: 'subscription' | 'library';
68
71
  shouldSuppressEndorsement?: boolean;
69
72
  }
@@ -105,6 +108,7 @@ export type Go1MessageType =
105
108
  | 'play_content'
106
109
  | 'library_content_added'
107
110
  | 'library_content_removed'
111
+ | 'library_content_exported'
108
112
  | 'save_content';
109
113
 
110
114
  export interface Go1Message {
@@ -126,6 +130,9 @@ export interface FeatureAttributeCommon {
126
130
  shouldSuppressCopyRightFooter?: boolean;
127
131
  shouldSuppressPlay?: boolean;
128
132
  shouldSuppressExport?: boolean;
133
+ shouldSuppressAIAgents?: boolean;
134
+ shouldSuppressAIDiscoveryAgent?: boolean;
135
+ shouldSuppressAIReportingAgent?: boolean;
129
136
  contentScope?: 'subscription' | 'library';
130
137
  shouldSuppressEndorsement?: boolean;
131
138
  }
@@ -385,6 +392,20 @@ Item has been removed from the library
385
392
  }
386
393
  ```
387
394
 
395
+ Selected library items have been exported through postMessage
396
+
397
+ ```typescript
398
+ {
399
+ "type": "library_content_exported",
400
+ "payload": {
401
+ "items": [
402
+ { "id": "3510462", "type": "lo" },
403
+ { "id": "3510463", "type": "lo" }
404
+ ]
405
+ }
406
+ }
407
+ ```
408
+
388
409
  Item bookmark action has been requested by a learner while `shouldSuppressBookmarkAction` is enabled
389
410
 
390
411
  ```typescript
package/dist/common/types.d.ts CHANGED
@@ -26,7 +26,7 @@ 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' | 'library_content_removed' | 'save_content';
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' | 'library_content_exported' | 'save_content';
30
30
  export type LibraryContentAddedActionType = 'admin-add';
31
31
  export type LibraryContentRemovedActionType = 'admin-remove';
32
32
  export type SaveContentActionType = 'learner-save' | 'admin-save';
@@ -44,6 +44,12 @@ export interface LibraryContentAddedPayload extends LibraryContentMessagePayload
44
44
  export interface LibraryContentRemovedPayload extends LibraryContentMessagePayload {
45
45
  action_type: LibraryContentRemovedActionType;
46
46
  }
47
+ export type LibraryContentExportedPayload = {
48
+ items: Array<{
49
+ id: string;
50
+ type: 'lo';
51
+ }>;
52
+ };
47
53
  interface Go1MessageUpdateExperience {
48
54
  type: 'update_experience';
49
55
  payload: {
@@ -69,6 +75,9 @@ export interface FeatureAttributeCommon {
69
75
  shouldSuppressCopyRightFooter?: boolean;
70
76
  shouldSuppressPlay?: boolean;
71
77
  shouldSuppressExport?: boolean;
78
+ shouldSuppressAIAgents?: boolean;
79
+ shouldSuppressAIDiscoveryAgent?: boolean;
80
+ shouldSuppressAIReportingAgent?: boolean;
72
81
  experience?: ExternalExperience;
73
82
  contentScope?: 'subscription' | 'library';
74
83
  shouldSuppressEndorsement?: boolean;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@go1/go1-embedding-react-sdk",
3
- "version": "0.11.0",
3
+ "version": "0.13.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": [