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

package/README.md

@@ -159,6 +159,13 @@ export interface FeatureAttributesGo1LearnSearch extends FeatureAttributeCommon
   searchProvider?: string; // If the embedding search feature includes a search provider, the app will initialize with the pre-filled search provider.
 }
 
+export type FeatureAttributesRecommendations = Omit<FeatureAttributesGo1LearnSearch, 'searchProvider'> & {
+  providers?: string[]; // If the embedding recommendations feature includes a search providers, the app will initialize with the pre-filled search provider
+  skills?: string[]; // If the embedding recommendations feature includes a search skills, the app will initialize with the pre-filled search skills
+  topics?: string[]; // If the embedding recommendations feature includes a search topics, the app will initialize with the pre-filled search topics
+  sort?: string; // If the embedding recommendations feature includes a search sort, the app will initialize with the pre-filled search sort
+}
+
 export type FeatureAttributes =
   | FeatureAttributesAIChat
   | FeatureAttributesPreview
@@ -166,7 +173,8 @@ export type FeatureAttributes =
   | FeatureAttributesLibrary
   | FeatureAttributesSearch
   | FeatureAttributesMyPlaylists
-  | FeatureAttributesMyLearning;;
+  | FeatureAttributesMyLearning
+  | FeatureAttributesRecommendations;
 
 export interface AdditionalUserInfo {
   jobTitle: string;

package/dist/CHANGELOG.md

@@ -0,0 +1,13 @@
+# @go1/go1-embedding-react-sdk
+
+## 0.2.0
+
+### Minor Changes
+
+- new Go1MessageType 'contact_go1_navigation'
+
+## 0.1.0
+
+### Minor Changes
+
+- New featureAttributes for Select Welcome Modal and Recommendation

package/dist/README.md

@@ -159,6 +159,13 @@ export interface FeatureAttributesGo1LearnSearch extends FeatureAttributeCommon
   searchProvider?: string; // If the embedding search feature includes a search provider, the app will initialize with the pre-filled search provider.
 }
 
+export type FeatureAttributesRecommendations = Omit<FeatureAttributesGo1LearnSearch, 'searchProvider'> & {
+  providers?: string[]; // If the embedding recommendations feature includes a search providers, the app will initialize with the pre-filled search provider
+  skills?: string[]; // If the embedding recommendations feature includes a search skills, the app will initialize with the pre-filled search skills
+  topics?: string[]; // If the embedding recommendations feature includes a search topics, the app will initialize with the pre-filled search topics
+  sort?: string; // If the embedding recommendations feature includes a search sort, the app will initialize with the pre-filled search sort
+}
+
 export type FeatureAttributes =
   | FeatureAttributesAIChat
   | FeatureAttributesPreview
@@ -166,7 +173,8 @@ export type FeatureAttributes =
   | FeatureAttributesLibrary
   | FeatureAttributesSearch
   | FeatureAttributesMyPlaylists
-  | FeatureAttributesMyLearning;;
+  | FeatureAttributesMyLearning
+  | FeatureAttributesRecommendations;
 
 export interface AdditionalUserInfo {
   jobTitle: string;

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

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isValidFeature = exports.isValidOTT = exports.addOneTimeToken = exports.addPortalURL = void 0;
+exports.addPortalURL = addPortalURL;
+exports.addOneTimeToken = addOneTimeToken;
+exports.addForceReauth = addForceReauth;
+exports.isValidOTT = isValidOTT;
+exports.isValidFeature = isValidFeature;
 const types_1 = require("./types");
 function addPortalURL(url, portalURL, env = 'production') {
     let validPortalURL = /^(?=.{1,255}$)([a-zA-Z0-9-]+\.)+mygo1\.com$/;
@@ -14,7 +18,6 @@ function addPortalURL(url, portalURL, env = 'production') {
         throw new Error(`Invalid formatting for portalURL ${portalURL}, env ${env}`);
     }
 }
-exports.addPortalURL = addPortalURL;
 function addOneTimeToken(url, oneTimeToken) {
     if (isValidOTT(oneTimeToken)) {
         url.searchParams.append('one_time_token', oneTimeToken);
@@ -23,13 +26,13 @@ function addOneTimeToken(url, oneTimeToken) {
         throw new Error('Invalid formatting for oneTimeToken');
     }
 }
-exports.addOneTimeToken = addOneTimeToken;
+function addForceReauth(url) {
+    url.searchParams.append('force_reauth', 'true');
+}
 function isValidOTT(oneTimeToken) {
     const validOTT = /^[A-Za-z0-9]+$/;
     return validOTT.test(oneTimeToken);
 }
-exports.isValidOTT = isValidOTT;
 function isValidFeature(feature) {
     return types_1.features.includes(feature);
 }
-exports.isValidFeature = isValidFeature;

package/dist/common/types.d.ts

@@ -16,7 +16,7 @@ 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 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;
@@ -25,6 +25,7 @@ export type ExternalExperience = 'manager' | 'learner' | 'role-aware';
 export interface FeatureAttributeCommon {
     shouldSuppressPreview?: boolean;
     shouldSuppressOpeningPlayer?: boolean;
+    shouldShowSelectWelcomeModal?: boolean;
     experience?: ExternalExperience;
     contentScope?: 'subscription' | 'library';
 }
@@ -82,7 +83,14 @@ export interface FeatureAttributesGo1LearnSearch extends FeatureAttributeCommon
     searchTerm?: string;
     searchProvider?: string;
 }
-export type FeatureAttributes = FeatureAttributesAIChat | FeatureAttributesPreview | FeatureAttributesWallet | FeatureAttributesLibrary | FeatureAttributesSearch | FeatureAttributesMyPlaylists | FeatureAttributesMyLearning | FeatureAttributesBulkUpload | FeatureAttributesContentStatus | FeatureAttributesGo1LearnSearch;
+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;
 }
@@ -98,6 +106,7 @@ export interface InitOptions {
     additionalUserInfo?: AdditionalUserInfo;
     themeInformation?: ThemeInformation;
     oneTimeToken?: string;
+    accessToken?: string;
     integrationSystemId?: string;
     presentingIntegrationSystemId?: string;
     previewHost?: string;

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

@@ -1,12 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useGo1ContentView = void 0;
+exports.useGo1ContentView = useGo1ContentView;
 const React = require("react");
 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);
@@ -78,7 +90,6 @@ function useGo1ContentView(props) {
     }, [iframeRef, iframeURL, iframeID]);
     return { sendMessageToGo1, ContentView };
 }
-exports.useGo1ContentView = useGo1ContentView;
 function Go1ContentView(iframeRef, iframeURL, iframeID, userProps) {
     return (React.createElement("iframe", { id: iframeID, ref: iframeRef, src: iframeURL.toString(), style: { border: 0, width: '100%', height: '100%' }, ...userProps }));
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@go1/go1-embedding-react-sdk",
-  "version": "0.0.78",
+  "version": "0.2.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"