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

package/README.md

@@ -1,6 +1,6 @@
 # Go1 Embedding React SDK
 
-A react hook to embed a Go1 content view in your site. Includes two-way messaging between your site and the Go1 content view.
+A React hook to embed a Go1 content view in your site. Includes two-way messaging between your site and the Go1 content view.
 
 ## Installation
 
@@ -95,7 +95,7 @@ export type Experience = 'manager' | 'learner' | 'role-aware'
 
 interface FeatureAttributeCommon {
   shouldSuppressPreview?: boolean;
-  experience?: Experience;
+  experience?: Experience; // Defaults to `manager`
   contentScope?: 'subscription' | 'library';
 }
 
@@ -309,6 +309,19 @@ const onGo1MessageReceived = (message) => {
 };
 ```
 
+### Go1 Message Example Payloads
+
+Item has been added to the library
+
+```typescript
+{
+  "type": "library_content_added",
+  "payload": {
+    "id": "3510462"
+  }
+}
+```
+
 ## Support
 
-https://www.go1.com/developers
+<https://www.go1.com/developers>

package/dist/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @go1/go1-embedding-react-sdk
 
+## 0.4.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
+
+## 0.3.0
+
+### Minor Changes
+
+- New featureAttributes for Select Welcome Modal and Recommendation
+- new Go1MessageType 'contact_go1_navigation'
+- Add new feature auth-clients
+
 ## 0.2.0
 
 ### Minor Changes

package/dist/README.md

@@ -1,6 +1,6 @@
 # Go1 Embedding React SDK
 
-A react hook to embed a Go1 content view in your site. Includes two-way messaging between your site and the Go1 content view.
+A React hook to embed a Go1 content view in your site. Includes two-way messaging between your site and the Go1 content view.
 
 ## Installation
 
@@ -95,7 +95,7 @@ export type Experience = 'manager' | 'learner' | 'role-aware'
 
 interface FeatureAttributeCommon {
   shouldSuppressPreview?: boolean;
-  experience?: Experience;
+  experience?: Experience; // Defaults to `manager`
   contentScope?: 'subscription' | 'library';
 }
 
@@ -309,6 +309,19 @@ const onGo1MessageReceived = (message) => {
 };
 ```
 
+### Go1 Message Example Payloads
+
+Item has been added to the library
+
+```typescript
+{
+  "type": "library_content_added",
+  "payload": {
+    "id": "3510462"
+  }
+}
+```
+
 ## Support
 
-https://www.go1.com/developers
+<https://www.go1.com/developers>

package/dist/common/types.d.ts

@@ -7,7 +7,7 @@ export interface AdditionalInfoMessage {
     feature: FeatureType;
     additionalUserInfo?: AdditionalUserInfo;
     featureAttributes?: FeatureAttributes;
-    themeInformation?: ThemeInformation;
+    themeInformation?: ThemeInformation | ThemeInformationElysium;
     integrationSystemId?: string;
     presentingIntegrationSystemId?: string;
     experience?: FeatureAttributes['experience'];
@@ -16,11 +16,21 @@ export interface AdditionalInfoMessage {
 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' | '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';
-export type Go1Message = {
-    type: Go1MessageType;
+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';
+interface Go1MessageUpdateExperience {
+    type: 'update_experience';
+    payload: {
+        experience: ExternalExperience;
+    };
+}
+interface Go1MessageGeneric {
+    type: Exclude<Go1MessageType, 'update_experience'>;
     payload?: any;
-};
+}
+export type Go1Message = Go1MessageUpdateExperience | Go1MessageGeneric;
 export type ExternalExperience = 'manager' | 'learner' | 'role-aware';
 export interface FeatureAttributeCommon {
     shouldSuppressPreview?: boolean;
@@ -46,7 +56,7 @@ export interface FeatureAttributesPreview extends FeatureAttributesPreviewCommon
     id: number;
 }
 export interface FeatureAttributesWallet extends FeatureAttributeCommon {
-    walletMode: 'setup' | 'main' | 'request_admin';
+    walletMode: 'setup' | 'main';
     deepLink?: string;
     oneClickBuyUrl?: string;
 }
@@ -94,7 +104,7 @@ export type FeatureAttributes = FeatureAttributesAIChat | FeatureAttributesPrevi
 export interface AdditionalUserInfo {
     jobTitle: string;
 }
-export declare const features: readonly ["ai-chat", "content-hub", "preview", "library", "search", "wallet", "content-retirement", "my-playlists", "activity-feed", "my-learning", "insights", "go1-learn/library", "go1-learn/my-learning", "go1-learn/learner-content", "go1-learn/search", "bulk-upload", "content-status", "partner-sales", "home", "recommendations"];
+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 type FeatureType = (typeof features)[number];
 export interface InitOptions {
     feature: FeatureType;

package/dist/common/types.js

@@ -2,24 +2,25 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.features = void 0;
 exports.features = [
-    'ai-chat',
-    'content-hub',
-    'preview',
-    'library',
-    'search',
-    'wallet',
-    'content-retirement',
-    'my-playlists',
-    'activity-feed',
-    'my-learning',
-    'insights',
+    'auth-clients',
+    'go1-learn/learner-content',
     'go1-learn/library',
     'go1-learn/my-learning',
-    'go1-learn/learner-content',
     'go1-learn/search',
+    'insights',
+    'activity-feed',
+    'ai-chat',
     'bulk-upload',
+    'content-hub',
+    'content-retirement',
     'content-status',
-    'partner-sales',
     'home',
+    'library',
+    'my-learning',
+    'my-playlists',
+    'partner-sales',
+    'preview',
     'recommendations',
+    'search',
+    'wallet',
 ];

package/package.json

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