@go1/go1-embedding-react-sdk 0.0.76 → 0.1.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,7 @@
+# @go1/go1-embedding-react-sdk
+
+## 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.js

@@ -1,6 +1,9 @@
 "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.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 +17,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 +25,10 @@ function addOneTimeToken(url, oneTimeToken) {
         throw new Error('Invalid formatting for oneTimeToken');
     }
 }
-exports.addOneTimeToken = addOneTimeToken;
 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,15 +16,16 @@ 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';
-export interface Go1Message {
+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 Go1Message = {
     type: Go1MessageType;
     payload?: any;
-}
+};
 export type ExternalExperience = 'manager' | 'learner' | 'role-aware';
 export interface FeatureAttributeCommon {
     shouldSuppressPreview?: boolean;
     shouldSuppressOpeningPlayer?: boolean;
+    shouldShowSelectWelcomeModal?: boolean;
     experience?: ExternalExperience;
     contentScope?: 'subscription' | 'library';
 }
@@ -51,6 +52,7 @@ export interface FeatureAttributesWallet extends FeatureAttributeCommon {
 }
 export interface FeatureAttributesBulkUpload extends FeatureAttributeCommon {
     bulkMode: 'create' | 'update';
+    isStandalone?: boolean;
 }
 export interface FeatureAttributesContentStatus extends FeatureAttributeCommon {
     isStandalone?: boolean;
@@ -80,13 +82,18 @@ export interface FeatureAttributesMyLearning extends FeatureAttributeCommon {
 export interface FeatureAttributesGo1LearnSearch extends FeatureAttributeCommon {
     searchTerm?: string;
     searchProvider?: string;
-    searchTab?: 'items' | 'playlists';
 }
-export type FeatureAttributes = FeatureAttributesAIChat | FeatureAttributesPreview | FeatureAttributesWallet | FeatureAttributesLibrary | FeatureAttributesSearch | FeatureAttributesMyPlaylists | FeatureAttributesMyLearning | FeatureAttributesBulkUpload | FeatureAttributesContentStatus | FeatureAttributesGo1LearnSearch;
+export type FeatureAttributesRecommendations = Omit<FeatureAttributesGo1LearnSearch, 'searchProvider'> & {
+    providers?: string[];
+    skills?: string[];
+    topics?: string[];
+    sort?: string;
+};
+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"];
+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 type FeatureType = (typeof features)[number];
 export interface InitOptions {
     feature: FeatureType;

package/dist/common/types.js

@@ -21,4 +21,5 @@ exports.features = [
     'content-status',
     'partner-sales',
     'home',
+    'recommendations',
 ];

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

@@ -1,6 +1,6 @@
 "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");
@@ -78,7 +78,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.76",
+  "version": "0.1.0",
   "description": "A React library to embed Go1 content into your website.",
   "main": "dist/go1-embedding-react-sdk/src/index.js",
   "files": [