@go1/go1-embedding-react-sdk 0.0.37 → 0.0.39

package/README.md

@@ -88,6 +88,7 @@ interface FeatureAttributeCommon {
   shouldSuppressPreview?: boolean;
   experience?: 'manager' | 'learner';
   shouldShowGo1FeedbackButton?: boolean;
+  shouldShowSaveToPlaylistButton?: boolean;
 }
 
 /**
@@ -158,7 +159,6 @@ export type FeatureType =
 export interface InitOptions {
   /** Mandatory identifier for the embedded feature */
   feature: FeatureType;
-  // eslint-disable-next-line max-len
   /** Optional element id to search for, and use as the parent for the Go1 content view (use either this or `iframeParentElement`, not both) */
   iframeParentId?: string;
   /** Optional element to use as the parent for the Go1 content view (use either this or `iframeParentId`, not both) */
@@ -169,15 +169,16 @@ export interface InitOptions {
   portalURL?: string;
   /** Optional function that is invoked when the Go1 content view emits a message */
   onGo1MessageReceived?: OnGo1MessageReceived;
-  // eslint-disable-next-line max-len
   /** 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;
   /** Optional token that is used to pre-authorize the user without them needing to log in */
   oneTimeToken?: string;
-  /** Optional Id that let us know users are coming from which integration system (will be required in the future)*/
+  /** Optional Id that let us know which integration system users are coming from (will be required in the future)*/
   integrationSystemId?: string;
+  /** Optional Id that let us know which integration system users are coming from, if using an intermediary system to embed */
+  presentingIntegrationSystemId?: string;
 }
 ```
 

package/dist/README.md

@@ -88,6 +88,7 @@ interface FeatureAttributeCommon {
   shouldSuppressPreview?: boolean;
   experience?: 'manager' | 'learner';
   shouldShowGo1FeedbackButton?: boolean;
+  shouldShowSaveToPlaylistButton?: boolean;
 }
 
 /**
@@ -158,7 +159,6 @@ export type FeatureType =
 export interface InitOptions {
   /** Mandatory identifier for the embedded feature */
   feature: FeatureType;
-  // eslint-disable-next-line max-len
   /** Optional element id to search for, and use as the parent for the Go1 content view (use either this or `iframeParentElement`, not both) */
   iframeParentId?: string;
   /** Optional element to use as the parent for the Go1 content view (use either this or `iframeParentId`, not both) */
@@ -169,15 +169,16 @@ export interface InitOptions {
   portalURL?: string;
   /** Optional function that is invoked when the Go1 content view emits a message */
   onGo1MessageReceived?: OnGo1MessageReceived;
-  // eslint-disable-next-line max-len
   /** 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;
   /** Optional token that is used to pre-authorize the user without them needing to log in */
   oneTimeToken?: string;
-  /** Optional Id that let us know users are coming from which integration system (will be required in the future)*/
+  /** Optional Id that let us know which integration system users are coming from (will be required in the future)*/
   integrationSystemId?: string;
+  /** Optional Id that let us know which integration system users are coming from, if using an intermediary system to embed */
+  presentingIntegrationSystemId?: string;
 }
 ```
 

package/dist/common/types.d.ts

@@ -7,11 +7,13 @@ export interface AdditionalInfoMessage {
     additionalUserInfo?: AdditionalUserInfo;
     featureAttributes?: FeatureAttributes;
     themeInformation?: ThemeInformation;
+    integrationSystemId?: string;
+    presentingIntegrationSystemId?: string;
 }
 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';
+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';
 export interface Go1Message {
     type: Go1MessageType;
     payload?: any;
@@ -20,6 +22,7 @@ export interface FeatureAttributeCommon {
     shouldSuppressPreview?: boolean;
     experience?: 'manager' | 'learner';
     shouldShowGo1FeedbackButton?: boolean;
+    shouldShowSaveToPlaylistButton?: boolean;
 }
 interface FeatureAttributesPreviewCommon extends FeatureAttributeCommon {
     startWith1Player?: boolean;
@@ -73,5 +76,6 @@ export interface InitOptions {
     themeInformation?: ThemeInformation;
     oneTimeToken?: string;
     integrationSystemId?: string;
+    presentingIntegrationSystemId?: string;
 }
 export {};

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, env = 'production', } = props;
+    const { feature, featureAttributes, portalURL, oneTimeToken, onGo1MessageReceived, additionalUserInfo, themeInformation, integrationSystemId, presentingIntegrationSystemId, env = 'production', } = props;
     const iframeRef = (0, react_1.useRef)(null);
     let url = 'https://embedding.go1.com';
     if (env === 'staging') {
@@ -26,12 +26,9 @@ function useGo1ContentView(props) {
         if (oneTimeToken) {
             (0, params_1.addOneTimeToken)(iframeURL, oneTimeToken);
         }
-        if (integrationSystemId) {
-            iframeURL.searchParams.append('integration_system_id', integrationSystemId);
-        }
         const iframeID = `go1-iframe-${feature}`;
         return { iframeURL, iframeID };
-    }, [url, feature, portalURL, oneTimeToken, integrationSystemId, env]);
+    }, [url, feature, portalURL, oneTimeToken, env]);
     const eventListenerInstance = (0, react_1.useCallback)((event) => {
         const { _type, ...rest } = event.data;
         if (_type === constants_1.GO1_MESSAGE) {
@@ -40,6 +37,8 @@ function useGo1ContentView(props) {
                     additionalUserInfo,
                     themeInformation,
                     featureAttributes,
+                    integrationSystemId,
+                    presentingIntegrationSystemId,
                 };
                 sendMessageToGo1({
                     type: 'set_additional_embedding_data',
@@ -52,7 +51,15 @@ function useGo1ContentView(props) {
                 }
             }
         }
-    }, [additionalUserInfo, sendMessageToGo1, onGo1MessageReceived, themeInformation, featureAttributes]);
+    }, [
+        additionalUserInfo,
+        themeInformation,
+        featureAttributes,
+        integrationSystemId,
+        presentingIntegrationSystemId,
+        sendMessageToGo1,
+        onGo1MessageReceived,
+    ]);
     (0, react_1.useEffect)(() => {
         window.addEventListener('message', eventListenerInstance);
         return () => {

package/package.json

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