@go1/go1-embedding-react-sdk 0.0.1 → 0.0.3

package/README.md

@@ -24,8 +24,8 @@ export function YourHostingComponent() {
 
   const options = useMemo<ContentViewProps>(() => {
     return {
-      feature: 'metrics',
-      portalName: 'learning-incorporated-usa',
+      feature: 'ai-chat',
+      portalURL: 'learning-incorporated-usa.mygo1.com',
       onGo1MessageReceived,
     };
   }, []);
@@ -56,7 +56,7 @@ interface Go1Message {
 
 interface ThemeInformation {
   /** Hex string, starting with a #. Example #0437F2 */
-  primaryColor: string;
+  accent: string;
 }
 
 /**
@@ -68,13 +68,13 @@ interface ThemeInformation {
  * }
  */
 interface FeatureAttributes {
-  [key: string]: number | string
+  [key: string]: number | string;
 }
 
 interface InitOptions {
   feature: string; // 'ai-chat' | 'explore' | 'preview';
   featureAttributes?: FeatureAttributes; // optional
-  portalName?: string; //optional
+  portalURL?: string; //optional
   onGo1MessageReceived?: OnGo1MessageReceived; //optional
   additionalUserInfo?: any; //optional
   themeInformation?: ThemeInformation; //optional
@@ -107,7 +107,7 @@ const onGo1MessageReceived = useCallback(message => {
 const options = useMemo<ContentViewProps>(() => {
   return {
     feature: 'ai-chat',
-    portalName: 'learning-incorporated-usa',
+    portalURL: 'learning-incorporated-usa.mygo1.com',
     featureAttributes: {
       id: 32973,
     },
@@ -117,7 +117,7 @@ const options = useMemo<ContentViewProps>(() => {
       goals: ['leadership', 'management']
     },
     themeInformation: {
-      primaryColor: '#0437F2'
+      accent: '#0437F2'
     },
     oneTimeToken: '907687a6e81a458190fe4c21f05ee689'
   };

package/dist/README.md

@@ -24,8 +24,8 @@ export function YourHostingComponent() {
 
   const options = useMemo<ContentViewProps>(() => {
     return {
-      feature: 'metrics',
-      portalName: 'learning-incorporated-usa',
+      feature: 'ai-chat',
+      portalURL: 'learning-incorporated-usa.mygo1.com',
       onGo1MessageReceived,
     };
   }, []);
@@ -56,7 +56,7 @@ interface Go1Message {
 
 interface ThemeInformation {
   /** Hex string, starting with a #. Example #0437F2 */
-  primaryColor: string;
+  accent: string;
 }
 
 /**
@@ -68,13 +68,13 @@ interface ThemeInformation {
  * }
  */
 interface FeatureAttributes {
-  [key: string]: number | string
+  [key: string]: number | string;
 }
 
 interface InitOptions {
   feature: string; // 'ai-chat' | 'explore' | 'preview';
   featureAttributes?: FeatureAttributes; // optional
-  portalName?: string; //optional
+  portalURL?: string; //optional
   onGo1MessageReceived?: OnGo1MessageReceived; //optional
   additionalUserInfo?: any; //optional
   themeInformation?: ThemeInformation; //optional
@@ -107,7 +107,7 @@ const onGo1MessageReceived = useCallback(message => {
 const options = useMemo<ContentViewProps>(() => {
   return {
     feature: 'ai-chat',
-    portalName: 'learning-incorporated-usa',
+    portalURL: 'learning-incorporated-usa.mygo1.com',
     featureAttributes: {
       id: 32973,
     },
@@ -117,7 +117,7 @@ const options = useMemo<ContentViewProps>(() => {
       goals: ['leadership', 'management']
     },
     themeInformation: {
-      primaryColor: '#0437F2'
+      accent: '#0437F2'
     },
     oneTimeToken: '907687a6e81a458190fe4c21f05ee689'
   };

package/dist/common/types.d.ts

@@ -8,7 +8,7 @@ export interface AdditionalInfoMessage {
     themeInformation?: ThemeInformation;
 }
 export interface ThemeInformation {
-    primaryColor: string;
+    accent: string;
 }
 export interface Go1Message {
     type: string;
@@ -21,7 +21,7 @@ export interface InitOptions {
     feature: string;
     iframeParentId: string;
     featureAttributes?: FeatureAttributes;
-    portalName?: string;
+    portalURL?: string;
     onGo1MessageReceived?: OnGo1MessageReceived;
     additionalUserInfo?: any;
     themeInformation?: ThemeInformation;

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

@@ -5,7 +5,7 @@ const React = require("react");
 const react_1 = require("react");
 const constants_1 = require("../../common/constants");
 function useGo1ContentView(props) {
-    const { feature, featureAttributes, portalName, oneTimeToken, onGo1MessageReceived, additionalUserInfo, themeInformation, baseURL, } = props;
+    const { feature, featureAttributes, portalURL, oneTimeToken, onGo1MessageReceived, additionalUserInfo, themeInformation, baseURL, } = props;
     const iframeRef = (0, react_1.useRef)(null);
     const url = baseURL || 'https://embedding.go1.com';
     let { iframeURL, iframeID } = (0, react_1.useMemo)(() => {
@@ -20,15 +20,15 @@ function useGo1ContentView(props) {
                 iframeURL.searchParams.append(key, `${value}`);
             }
         }
-        if (portalName) {
-            iframeURL.searchParams.append('portal_id', portalName);
+        if (portalURL) {
+            iframeURL.searchParams.append('portal_url', portalURL);
         }
         if (oneTimeToken) {
-            iframeURL.searchParams.append('oneTimeToken', oneTimeToken);
+            iframeURL.searchParams.append('one_time_token', oneTimeToken);
         }
         const iframeID = `go1-iframe-${feature}`;
         return { iframeURL, iframeID };
-    }, [url, feature, oneTimeToken, portalName, featureAttributes]);
+    }, [url, feature, oneTimeToken, portalURL, featureAttributes]);
     const sendMessageToGo1 = (0, react_1.useCallback)((message) => {
         iframeRef.current?.contentWindow?.postMessage(message, url);
     }, [url]);

package/package.json

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