@go1/go1-embedding-react-sdk 0.6.0 → 0.9.0

package/README.md

@@ -58,13 +58,26 @@ export interface FeatureAttributeCommon {
   shouldSuppressBookmark?: boolean;
   shouldSuppressPlaylistAdministration?: boolean;
   shouldSuppressShareLink?: boolean;
+  shouldSuppressLibrary?: boolean;
+  shouldSuppressPlaylist?: boolean;
+  shouldSuppressCopyRightFooter?: boolean;
+  shouldSuppressPlay?: boolean;
+  shouldSuppressExport?: boolean;
   contentScope?: 'subscription' | 'library';
+  shouldSuppressEndorsement?: boolean;
 }
 
 
+export type ThemeMode = 'light' | 'dark';
+
+export interface ThemeModeInformation {
+  mode: ThemeMode;
+}
+
 export interface ThemeInformation {
   /** Hex string, starting with a #. Example #0437F2 */
   accent: string;
+  mode?: ThemeMode;
 }
 
 export type Go1MessageType =
@@ -104,7 +117,13 @@ export interface FeatureAttributeCommon {
   shouldSuppressBookmark?: boolean;
   shouldSuppressPlaylistAdministration?: boolean;
   shouldSuppressShareLink?: boolean;
+  shouldSuppressLibrary?: boolean;
+  shouldSuppressPlaylist?: boolean;
+  shouldSuppressCopyRightFooter?: boolean;
+  shouldSuppressPlay?: boolean;
+  shouldSuppressExport?: boolean;
   contentScope?: 'subscription' | 'library';
+  shouldSuppressEndorsement?: boolean;
 }
 
 /**
@@ -155,7 +174,10 @@ export interface FeatureAttributesMyPlaylists extends FeatureAttributesPreviewCo
   playlistId?: number; // If embedding my-playlists feature with playlistId, the app will initialise with the specified playlistId page.
 }
 
-export interface FeatureAttributesMyLearning extends FeatureAttributeCommon {}
+export interface FeatureAttributesMyLearning extends FeatureAttributeCommon {
+  contentId?: number; // If the embedding my-learning feature includes a content id, the app will initialize with the specified content page.
+  selectingTab?: 'saved' | 'in-progress' | 'assigned' | 'completed';
+}
 
 export interface FeatureAttributesProspect {
   isProspectExperience?: boolean;
@@ -191,6 +213,7 @@ export interface AdditionalUserInfo {
 
 export type FeatureType =
   | 'ai-chat'
+  /** @deprecated Use 'admin-curation' instead. */
   | 'content-hub'
   | 'preview'
   | 'search'
@@ -212,7 +235,7 @@ export interface InitOptions {
   /** Optional end user information that can enhance the context and provide a better experience. No PII is needed, please do not send any. */
   additionalUserInfo?: AdditionalUserInfo;
   /** Optional UI configuration */
-  themeInformation?: ThemeInformation;
+  themeInformation?: ThemeInformation | ThemeModeInformation;
   /** Optional one time token that is used to pre-authorize the user without them needing to log in */
   oneTimeToken?: string;
   /** Optional OAuth token that is used to pre-authorize the user without them needing to log in */
@@ -221,9 +244,15 @@ export interface InitOptions {
   integrationSystemId?: string;
   /** Optional Id that let us know which integration system users are coming from, if using an intermediary system to embed */
   presentingIntegrationSystemId?: string;
+   /** Optional flag to control JWT persistence in browser storage, if false, JWT will not be stored in localStorage, sessionStorage, or cookies */
+  persistJWT?: boolean;
 }
 ```
 
+`content-hub` is deprecated and will be removed in a future major release. Use
+`admin-curation` for new integrations. Existing `content-hub` requests are
+redirected server-side to `admin-curation` during the deprecation window.
+
 ## Function: `useGo1ContentView`
 
 A react hook that will return
@@ -253,12 +282,14 @@ const options = useMemo<ContentViewProps>(() => {
     featureAttributes: {
       shouldSuppressShareLink: true,
     },
+    persistJWT: false,
     onGo1MessageReceived,
     additionalUserInfo: {
       jobTitle: 'Sales development representative',
     },
     themeInformation: {
       accent: '#0437F2',
+      mode: 'dark',
     },
     oneTimeToken: '907687a6e81a458190fe4c21f05ee689',
     integrationSystemId: 'int_nI7rPykBRm0C',

package/dist/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @go1/go1-embedding-react-sdk
 
+## 0.9.0
+
+### Minor Changes
+
+- Deprecate the content-hub feature in favour of admin-curation.
+
+## 0.8.0
+
+### Minor Changes
+
+- Allow embedded apps to receive light or dark mode via themeInformation.mode
+
+## 0.7.0
+
+### Minor Changes
+
+- Add shouldSuppressExport feature attribute
+
 ## 0.6.0
 
 ### Minor Changes

package/dist/README.md

@@ -58,13 +58,26 @@ export interface FeatureAttributeCommon {
   shouldSuppressBookmark?: boolean;
   shouldSuppressPlaylistAdministration?: boolean;
   shouldSuppressShareLink?: boolean;
+  shouldSuppressLibrary?: boolean;
+  shouldSuppressPlaylist?: boolean;
+  shouldSuppressCopyRightFooter?: boolean;
+  shouldSuppressPlay?: boolean;
+  shouldSuppressExport?: boolean;
   contentScope?: 'subscription' | 'library';
+  shouldSuppressEndorsement?: boolean;
 }
 
 
+export type ThemeMode = 'light' | 'dark';
+
+export interface ThemeModeInformation {
+  mode: ThemeMode;
+}
+
 export interface ThemeInformation {
   /** Hex string, starting with a #. Example #0437F2 */
   accent: string;
+  mode?: ThemeMode;
 }
 
 export type Go1MessageType =
@@ -104,7 +117,13 @@ export interface FeatureAttributeCommon {
   shouldSuppressBookmark?: boolean;
   shouldSuppressPlaylistAdministration?: boolean;
   shouldSuppressShareLink?: boolean;
+  shouldSuppressLibrary?: boolean;
+  shouldSuppressPlaylist?: boolean;
+  shouldSuppressCopyRightFooter?: boolean;
+  shouldSuppressPlay?: boolean;
+  shouldSuppressExport?: boolean;
   contentScope?: 'subscription' | 'library';
+  shouldSuppressEndorsement?: boolean;
 }
 
 /**
@@ -155,7 +174,10 @@ export interface FeatureAttributesMyPlaylists extends FeatureAttributesPreviewCo
   playlistId?: number; // If embedding my-playlists feature with playlistId, the app will initialise with the specified playlistId page.
 }
 
-export interface FeatureAttributesMyLearning extends FeatureAttributeCommon {}
+export interface FeatureAttributesMyLearning extends FeatureAttributeCommon {
+  contentId?: number; // If the embedding my-learning feature includes a content id, the app will initialize with the specified content page.
+  selectingTab?: 'saved' | 'in-progress' | 'assigned' | 'completed';
+}
 
 export interface FeatureAttributesProspect {
   isProspectExperience?: boolean;
@@ -191,6 +213,7 @@ export interface AdditionalUserInfo {
 
 export type FeatureType =
   | 'ai-chat'
+  /** @deprecated Use 'admin-curation' instead. */
   | 'content-hub'
   | 'preview'
   | 'search'
@@ -212,7 +235,7 @@ export interface InitOptions {
   /** Optional end user information that can enhance the context and provide a better experience. No PII is needed, please do not send any. */
   additionalUserInfo?: AdditionalUserInfo;
   /** Optional UI configuration */
-  themeInformation?: ThemeInformation;
+  themeInformation?: ThemeInformation | ThemeModeInformation;
   /** Optional one time token that is used to pre-authorize the user without them needing to log in */
   oneTimeToken?: string;
   /** Optional OAuth token that is used to pre-authorize the user without them needing to log in */
@@ -221,9 +244,15 @@ export interface InitOptions {
   integrationSystemId?: string;
   /** Optional Id that let us know which integration system users are coming from, if using an intermediary system to embed */
   presentingIntegrationSystemId?: string;
+   /** Optional flag to control JWT persistence in browser storage, if false, JWT will not be stored in localStorage, sessionStorage, or cookies */
+  persistJWT?: boolean;
 }
 ```
 
+`content-hub` is deprecated and will be removed in a future major release. Use
+`admin-curation` for new integrations. Existing `content-hub` requests are
+redirected server-side to `admin-curation` during the deprecation window.
+
 ## Function: `useGo1ContentView`
 
 A react hook that will return
@@ -253,12 +282,14 @@ const options = useMemo<ContentViewProps>(() => {
     featureAttributes: {
       shouldSuppressShareLink: true,
     },
+    persistJWT: false,
     onGo1MessageReceived,
     additionalUserInfo: {
       jobTitle: 'Sales development representative',
     },
     themeInformation: {
       accent: '#0437F2',
+      mode: 'dark',
     },
     oneTimeToken: '907687a6e81a458190fe4c21f05ee689',
     integrationSystemId: 'int_nI7rPykBRm0C',

package/dist/common/params.d.ts

@@ -2,5 +2,8 @@ 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 addPersistJWT(url: URL, persistJWT: boolean): void;
 export declare function isValidOTT(oneTimeToken: string): boolean;
 export declare function isValidFeature(feature: FeatureType): boolean;
+export declare const DEPRECATED_FEATURES: Readonly<Partial<Record<FeatureType, FeatureType>>>;
+export declare function warnIfDeprecatedFeature(feature: FeatureType): void;

package/dist/common/params.js

@@ -1,10 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEPRECATED_FEATURES = void 0;
 exports.addPortalURL = addPortalURL;
 exports.addOneTimeToken = addOneTimeToken;
 exports.addForceReauth = addForceReauth;
+exports.addPersistJWT = addPersistJWT;
 exports.isValidOTT = isValidOTT;
 exports.isValidFeature = isValidFeature;
+exports.warnIfDeprecatedFeature = warnIfDeprecatedFeature;
 const types_1 = require("./types");
 function addPortalURL(url, portalURL, env = 'production') {
     let validPortalURL = /^(?=.{1,255}$)([a-zA-Z0-9-]+\.)+mygo1\.com$/;
@@ -29,6 +32,9 @@ function addOneTimeToken(url, oneTimeToken) {
 function addForceReauth(url) {
     url.searchParams.append('force_reauth', 'true');
 }
+function addPersistJWT(url, persistJWT) {
+    url.searchParams.append('persist_jwt', persistJWT.toString());
+}
 function isValidOTT(oneTimeToken) {
     const validOTT = /^[A-Za-z0-9]+$/;
     return validOTT.test(oneTimeToken);
@@ -36,3 +42,12 @@ function isValidOTT(oneTimeToken) {
 function isValidFeature(feature) {
     return types_1.features.includes(feature);
 }
+exports.DEPRECATED_FEATURES = {
+    'content-hub': 'admin-curation',
+};
+function warnIfDeprecatedFeature(feature) {
+    const replacement = exports.DEPRECATED_FEATURES[feature];
+    if (!replacement)
+        return;
+    console.warn(`[go1-embedding-sdk] The "${feature}" feature is deprecated and will be removed in a future major release. Use "${replacement}" instead.`);
+}

package/dist/common/types.d.ts

@@ -7,19 +7,26 @@ export interface AdditionalInfoMessage {
     feature: FeatureType;
     additionalUserInfo?: AdditionalUserInfo;
     featureAttributes?: FeatureAttributes;
-    themeInformation?: ThemeInformation | ThemeInformationElysium;
+    themeInformation?: ThemeInformationPayload;
     integrationSystemId?: string;
     presentingIntegrationSystemId?: string;
     experience?: FeatureAttributes['experience'];
     disableFSOuterScript?: boolean;
 }
+export type ThemeMode = 'light' | 'dark';
+export interface ThemeModeInformation {
+    mode: ThemeMode;
+}
 export interface ThemeInformation {
     accent: string;
+    mode?: ThemeMode;
 }
 export interface ThemeInformationElysium {
     brandColor: string;
+    mode?: ThemeMode;
 }
-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_upload_close' | 'contact_go1_navigation' | 'library_content_added';
+export type ThemeInformationPayload = ThemeInformation | ThemeInformationElysium | ThemeModeInformation;
+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';
 interface Go1MessageUpdateExperience {
     type: 'update_experience';
     payload: {
@@ -39,8 +46,15 @@ export interface FeatureAttributeCommon {
     shouldSuppressBookmark?: boolean;
     shouldSuppressPlaylistAdministration?: boolean;
     shouldSuppressShareLink?: boolean;
+    shouldSuppressLibrary?: boolean;
+    shouldSuppressPlaylist?: boolean;
+    shouldSuppressCopyRightFooter?: boolean;
+    shouldSuppressPlay?: boolean;
+    shouldSuppressExport?: boolean;
     experience?: ExternalExperience;
     contentScope?: 'subscription' | 'library';
+    shouldSuppressEndorsement?: boolean;
+    shouldSuppressAssign?: boolean;
 }
 interface FeatureAttributesPreviewCommon extends FeatureAttributeCommon {
     startWith1Player?: boolean;
@@ -90,6 +104,7 @@ export interface FeatureAttributesMyPlaylists extends FeatureAttributesPreviewCo
     playlistId?: number;
 }
 export interface FeatureAttributesMyLearning extends FeatureAttributeCommon {
+    contentId?: number;
     selectingTab?: 'saved' | 'in-progress' | 'assigned' | 'completed';
 }
 export interface FeatureAttributesProspect {
@@ -110,8 +125,8 @@ export type FeatureAttributes = FeatureAttributesAIChat | FeatureAttributesPrevi
 export interface AdditionalUserInfo {
     jobTitle: string;
 }
-export declare const features: readonly ["auth-clients", "go1-learn/library", "go1-learn/my-learning", "go1-learn/search", "admin-curation", "activity-feed", "ai-chat", "bulk-upload", "content-hub", "content-retirement", "content-status", "library", "my-learning", "my-playlists", "partner-sales", "preview", "recommendations", "search", "wallet"];
-export type FeatureType = (typeof features)[number];
+export declare const features: readonly ["activity-feed", "ai-chat", "admin-curation", "auth-clients", "auth-clients-public", "go1-learn/library", "go1-learn/my-learning", "go1-learn/search", "go1-learn/search-categories", "bulk-upload", "content-hub", "content-retirement", "content-status", "library", "my-learning", "my-playlists", "partner-sales", "preview", "recommendations", "search", "wallet"];
+export type FeatureType = Exclude<(typeof features)[number], 'content-hub'> | 'content-hub';
 export interface InitOptions {
     feature: FeatureType;
     iframeParentId?: string;
@@ -120,12 +135,13 @@ export interface InitOptions {
     portalURL?: string;
     onGo1MessageReceived?: OnGo1MessageReceived;
     additionalUserInfo?: AdditionalUserInfo;
-    themeInformation?: ThemeInformation;
+    themeInformation?: ThemeInformationPayload;
     oneTimeToken?: string;
     accessToken?: string;
     integrationSystemId?: string;
     presentingIntegrationSystemId?: string;
     previewHost?: string;
     disableFSOuterScript?: boolean;
+    persistJWT?: boolean;
 }
 export {};

package/dist/common/types.js

@@ -2,13 +2,15 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.features = void 0;
 exports.features = [
+    'activity-feed',
+    'ai-chat',
+    'admin-curation',
     'auth-clients',
+    'auth-clients-public',
     'go1-learn/library',
     'go1-learn/my-learning',
     'go1-learn/search',
-    'admin-curation',
-    'activity-feed',
-    'ai-chat',
+    'go1-learn/search-categories',
     'bulk-upload',
     'content-hub',
     'content-retirement',

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

@@ -1,13 +1,47 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.useGo1ContentView = useGo1ContentView;
-const React = require("react");
+const React = __importStar(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, accessToken, } = props;
+    const { feature, featureAttributes, portalURL, oneTimeToken, onGo1MessageReceived, additionalUserInfo, themeInformation, integrationSystemId, presentingIntegrationSystemId, env = 'production', previewHost, disableFSOuterScript, accessToken, persistJWT, } = props;
     const iframeRef = (0, react_1.useRef)(null);
+    const warnedDeprecatedFeaturesRef = (0, react_1.useRef)(new Set());
     let url = 'https://embedding.go1.com';
     if (previewHost) {
         url = previewHost;
@@ -18,6 +52,12 @@ function useGo1ContentView(props) {
     if (!(0, params_1.isValidFeature)(feature)) {
         throw new Error('Unsupported feature');
     }
+    (0, react_1.useEffect)(() => {
+        if (warnedDeprecatedFeaturesRef.current.has(feature))
+            return;
+        (0, params_1.warnIfDeprecatedFeature)(feature);
+        warnedDeprecatedFeaturesRef.current.add(feature);
+    }, [feature]);
     const sendMessageToGo1 = (0, react_1.useCallback)((message) => {
         iframeRef.current?.contentWindow?.postMessage(message, url);
     }, [url]);
@@ -32,9 +72,12 @@ function useGo1ContentView(props) {
         if (accessToken) {
             (0, params_1.addForceReauth)(iframeURL);
         }
+        if (persistJWT !== undefined) {
+            (0, params_1.addPersistJWT)(iframeURL, persistJWT);
+        }
         const iframeID = `go1-iframe-${feature}`;
         return { iframeURL, iframeID };
-    }, [url, feature, portalURL, oneTimeToken, env, accessToken]);
+    }, [url, feature, portalURL, oneTimeToken, env, accessToken, persistJWT]);
     const eventListenerInstance = (0, react_1.useCallback)((event) => {
         const { _type, ...rest } = event.data;
         if (_type === constants_1.GO1_MESSAGE) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@go1/go1-embedding-react-sdk",
-  "version": "0.6.0",
+  "version": "0.9.0",
   "description": "A React library to embed Go1 content into your website.",
   "main": "dist/go1-embedding-react-sdk/src/index.js",
   "files": [
@@ -20,11 +20,11 @@
     "@testing-library/jest-dom": "5.17.0",
     "@testing-library/react": "14.0.0",
     "@testing-library/user-event": "14.5.2",
-    "jest": "^29.6.2",
+    "jest": "~29.7",
     "react": "18.2.0",
-    "react-dom": "^18.2.0",
-    "ts-jest": "^29.1.1",
-    "typescript": "^5.8.3"
+    "react-dom": "18.2.0",
+    "ts-jest": "^29.4.4",
+    "typescript": "~5.9.3"
   },
   "peerDependencies": {
     "react": ">=16.8"