@go1/go1-embedding-react-sdk 0.1.0 → 0.3.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';
 }
 
@@ -311,4 +311,4 @@ const onGo1MessageReceived = (message) => {
 
 ## Support
 
-https://www.go1.com/developers
+<https://www.go1.com/developers>

package/dist/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @go1/go1-embedding-react-sdk
 
+## 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
+
+- new Go1MessageType 'contact_go1_navigation'
+
 ## 0.1.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';
 }
 
@@ -311,4 +311,4 @@ const onGo1MessageReceived = (message) => {
 
 ## Support
 
-https://www.go1.com/developers
+<https://www.go1.com/developers>

package/dist/common/params.d.ts

@@ -1,5 +1,6 @@
 import { FeatureType } from './types';
 export declare function addPortalURL(url: URL, portalURL: string, env?: 'staging' | 'production'): void;
 export declare function addOneTimeToken(url: URL, oneTimeToken: string): void;
+export declare function addForceReauth(url: URL): void;
 export declare function isValidOTT(oneTimeToken: string): boolean;
 export declare function isValidFeature(feature: FeatureType): boolean;

package/dist/common/params.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.addPortalURL = addPortalURL;
 exports.addOneTimeToken = addOneTimeToken;
+exports.addForceReauth = addForceReauth;
 exports.isValidOTT = isValidOTT;
 exports.isValidFeature = isValidFeature;
 const types_1 = require("./types");
@@ -25,6 +26,9 @@ function addOneTimeToken(url, oneTimeToken) {
         throw new Error('Invalid formatting for oneTimeToken');
     }
 }
+function addForceReauth(url) {
+    url.searchParams.append('force_reauth', 'true');
+}
 function isValidOTT(oneTimeToken) {
     const validOTT = /^[A-Za-z0-9]+$/;
     return validOTT.test(oneTimeToken);

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,7 +16,10 @@ 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' | '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';
+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';
 export type Go1Message = {
     type: Go1MessageType;
     payload?: any;
@@ -83,17 +86,18 @@ export interface FeatureAttributesGo1LearnSearch extends FeatureAttributeCommon
     searchTerm?: string;
     searchProvider?: string;
 }
-export type FeatureAttributesRecommendations = Omit<FeatureAttributesGo1LearnSearch, 'searchProvider'> & {
+export type SearchLearningObjectsOptions = {
     providers?: string[];
     skills?: string[];
     topics?: string[];
     sort?: string;
 };
+export type FeatureAttributesRecommendations = Omit<FeatureAttributesGo1LearnSearch, 'searchProvider'> & SearchLearningObjectsOptions;
 export type FeatureAttributes = FeatureAttributesAIChat | FeatureAttributesPreview | FeatureAttributesWallet | FeatureAttributesLibrary | FeatureAttributesSearch | FeatureAttributesMyPlaylists | FeatureAttributesMyLearning | FeatureAttributesBulkUpload | FeatureAttributesContentStatus | FeatureAttributesGo1LearnSearch | FeatureAttributesRecommendations;
 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 ["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", "auth-clients"];
 export type FeatureType = (typeof features)[number];
 export interface InitOptions {
     feature: FeatureType;
@@ -105,6 +109,7 @@ export interface InitOptions {
     additionalUserInfo?: AdditionalUserInfo;
     themeInformation?: ThemeInformation;
     oneTimeToken?: string;
+    accessToken?: string;
     integrationSystemId?: string;
     presentingIntegrationSystemId?: string;
     previewHost?: string;

package/dist/common/types.js

@@ -22,4 +22,5 @@ exports.features = [
     'partner-sales',
     'home',
     'recommendations',
+    'auth-clients',
 ];

package/dist/go1-embedding-react-sdk/src/index.js

@@ -6,7 +6,7 @@ const react_1 = require("react");
 const constants_1 = require("../../common/constants");
 const params_1 = require("../../common/params");
 function useGo1ContentView(props) {
-    const { feature, featureAttributes, portalURL, oneTimeToken, onGo1MessageReceived, additionalUserInfo, themeInformation, integrationSystemId, presentingIntegrationSystemId, env = 'production', previewHost, disableFSOuterScript, } = props;
+    const { feature, featureAttributes, portalURL, oneTimeToken, onGo1MessageReceived, additionalUserInfo, themeInformation, integrationSystemId, presentingIntegrationSystemId, env = 'production', previewHost, disableFSOuterScript, accessToken, } = props;
     const iframeRef = (0, react_1.useRef)(null);
     let url = 'https://embedding.go1.com';
     if (previewHost) {
@@ -29,9 +29,12 @@ function useGo1ContentView(props) {
         if (oneTimeToken || oneTimeToken === '') {
             (0, params_1.addOneTimeToken)(iframeURL, oneTimeToken);
         }
+        if (accessToken) {
+            (0, params_1.addForceReauth)(iframeURL);
+        }
         const iframeID = `go1-iframe-${feature}`;
         return { iframeURL, iframeID };
-    }, [url, feature, portalURL, oneTimeToken, env]);
+    }, [url, feature, portalURL, oneTimeToken, env, accessToken]);
     const eventListenerInstance = (0, react_1.useCallback)((event) => {
         const { _type, ...rest } = event.data;
         if (_type === constants_1.GO1_MESSAGE) {
@@ -50,6 +53,14 @@ function useGo1ContentView(props) {
                     payload,
                 });
             }
+            else if (rest.type === 'ott_required' && rest.payload?.init === true && accessToken) {
+                sendMessageToGo1({
+                    type: 'set_access_token',
+                    payload: {
+                        accessToken,
+                    },
+                });
+            }
             else {
                 if (onGo1MessageReceived) {
                     onGo1MessageReceived(rest);
@@ -66,6 +77,7 @@ function useGo1ContentView(props) {
         onGo1MessageReceived,
         feature,
         disableFSOuterScript,
+        accessToken,
     ]);
     (0, react_1.useEffect)(() => {
         window.addEventListener('message', eventListenerInstance);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@go1/go1-embedding-react-sdk",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "A React library to embed Go1 content into your website.",
   "main": "dist/go1-embedding-react-sdk/src/index.js",
   "files": [
@@ -22,12 +22,12 @@
   "devDependencies": {
     "@testing-library/jest-dom": "5.17.0",
     "@testing-library/react": "14.0.0",
-    "@testing-library/user-event": "14.4.3",
+    "@testing-library/user-event": "14.5.2",
     "jest": "^29.6.2",
     "react": "18.2.0",
     "react-dom": "^18.2.0",
     "ts-jest": "^29.1.1",
-    "typescript": "^5.1.6"
+    "typescript": "^5.8.3"
   },
   "peerDependencies": {
     "react": ">=16.8"