@go1/go1-embedding-react-sdk 0.0.2 → 0.0.4

package/README.md

@@ -56,7 +56,7 @@ interface Go1Message {
 
 interface ThemeInformation {
   /** Hex string, starting with a #. Example #0437F2 */
-  primaryColor: string;
+  accent: string;
 }
 
 /**
@@ -68,7 +68,7 @@ interface ThemeInformation {
  * }
  */
 interface FeatureAttributes {
-  [key: string]: number | string
+  [key: string]: number | string;
 }
 
 interface InitOptions {
@@ -117,7 +117,7 @@ const options = useMemo<ContentViewProps>(() => {
       goals: ['leadership', 'management']
     },
     themeInformation: {
-      primaryColor: '#0437F2'
+      accent: '#0437F2'
     },
     oneTimeToken: '907687a6e81a458190fe4c21f05ee689'
   };

package/dist/README.md

@@ -56,7 +56,7 @@ interface Go1Message {
 
 interface ThemeInformation {
   /** Hex string, starting with a #. Example #0437F2 */
-  primaryColor: string;
+  accent: string;
 }
 
 /**
@@ -68,7 +68,7 @@ interface ThemeInformation {
  * }
  */
 interface FeatureAttributes {
-  [key: string]: number | string
+  [key: string]: number | string;
 }
 
 interface InitOptions {
@@ -117,7 +117,7 @@ const options = useMemo<ContentViewProps>(() => {
       goals: ['leadership', 'management']
     },
     themeInformation: {
-      primaryColor: '#0437F2'
+      accent: '#0437F2'
     },
     oneTimeToken: '907687a6e81a458190fe4c21f05ee689'
   };

package/dist/common/params.d.ts

@@ -0,0 +1,2 @@
+export declare function addPortalURL(url: URL, portalURL: string): void;
+export declare function addOneTimeToken(url: URL, oneTimeToken: string): void;

package/dist/common/params.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addOneTimeToken = exports.addPortalURL = void 0;
+function addPortalURL(url, portalURL) {
+    const validPortalURL = /^(?=.{1,255}$)[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,245}[a-zA-Z0-9])?\.mygo1\.com$/;
+    if (validPortalURL.test(portalURL)) {
+        url.searchParams.append('portal_url', portalURL);
+    }
+    else {
+        throw new Error('Invalid formatting for portalURL');
+    }
+}
+exports.addPortalURL = addPortalURL;
+function addOneTimeToken(url, oneTimeToken) {
+    const validOTT = /^[A-Za-z0-9]+$/;
+    if (validOTT.test(oneTimeToken)) {
+        url.searchParams.append('one_time_token', oneTimeToken);
+    }
+    else {
+        throw new Error('Invalid formatting for oneTimeToken');
+    }
+}
+exports.addOneTimeToken = addOneTimeToken;

package/dist/common/types.d.ts

@@ -4,26 +4,31 @@ export type IframesMap = {
     [key: string]: HTMLIFrameElement;
 };
 export interface AdditionalInfoMessage {
-    additionalUserInfo?: any;
+    additionalUserInfo?: AdditionalUserInfo;
+    featureAttributes?: FeatureAttributes;
     themeInformation?: ThemeInformation;
 }
 export interface ThemeInformation {
-    primaryColor: string;
+    accent: string;
 }
 export interface Go1Message {
     type: string;
     payload?: any;
 }
 export interface FeatureAttributes {
-    [key: string]: number | string;
+    [key: string]: any;
+}
+export interface AdditionalUserInfo {
+    [key: string]: any;
 }
 export interface InitOptions {
     feature: string;
-    iframeParentId: string;
+    iframeParentId?: string;
+    iframeParentElement?: HTMLElement;
     featureAttributes?: FeatureAttributes;
     portalURL?: string;
     onGo1MessageReceived?: OnGo1MessageReceived;
-    additionalUserInfo?: any;
+    additionalUserInfo?: AdditionalUserInfo;
     themeInformation?: ThemeInformation;
     oneTimeToken?: string;
 }

package/dist/go1-embedding-react-sdk/src/index.d.ts

@@ -1,8 +1,6 @@
 import * as React from 'react';
 import { InitOptions, SendMessageToGo1 } from '../../common/types';
-export interface ContentViewProps extends Omit<InitOptions, 'iframeParentId'> {
-    baseURL?: string;
-}
+export type ContentViewProps = Omit<InitOptions, 'iframeParentId' | 'iframeParentElement'>;
 export declare function useGo1ContentView(props: ContentViewProps): {
     sendMessageToGo1: SendMessageToGo1;
     ContentView: (userProps?: React.IframeHTMLAttributes<HTMLIFrameElement>) => React.JSX.Element;

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

@@ -4,31 +4,22 @@ exports.useGo1ContentView = void 0;
 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, baseURL, } = props;
+    const { feature, featureAttributes, portalURL, oneTimeToken, onGo1MessageReceived, additionalUserInfo, themeInformation, } = props;
     const iframeRef = (0, react_1.useRef)(null);
-    const url = baseURL || 'https://embedding.go1.com';
+    const url = 'https://embedding.go1.com';
     let { iframeURL, iframeID } = (0, react_1.useMemo)(() => {
         let iframeURL = new URL(`${url}/${feature}`);
-        if (featureAttributes) {
-            const { id, ...rest } = featureAttributes;
-            if (id) {
-                iframeURL.pathname += `/${id}`;
-            }
-            const entries = Object.entries(rest);
-            for (let [key, value] of entries) {
-                iframeURL.searchParams.append(key, `${value}`);
-            }
-        }
         if (portalURL) {
-            iframeURL.searchParams.append('portal_url', portalURL);
+            (0, params_1.addPortalURL)(iframeURL, portalURL);
         }
         if (oneTimeToken) {
-            iframeURL.searchParams.append('one_time_token', oneTimeToken);
+            (0, params_1.addOneTimeToken)(iframeURL, oneTimeToken);
         }
         const iframeID = `go1-iframe-${feature}`;
         return { iframeURL, iframeID };
-    }, [url, feature, oneTimeToken, portalURL, featureAttributes]);
+    }, [url, feature, oneTimeToken, portalURL]);
     const sendMessageToGo1 = (0, react_1.useCallback)((message) => {
         iframeRef.current?.contentWindow?.postMessage(message, url);
     }, [url]);
@@ -36,12 +27,14 @@ function useGo1ContentView(props) {
         const { _type, ...rest } = event.data;
         if (_type === constants_1.GO1_MESSAGE) {
             if (rest.type === 'go1_app_initialised') {
+                let payload = {
+                    additionalUserInfo,
+                    themeInformation,
+                    featureAttributes
+                };
                 sendMessageToGo1({
                     type: 'set_additional_embedding_data',
-                    payload: {
-                        additionalUserInfo,
-                        themeInformation,
-                    },
+                    payload
                 });
             }
             else {
@@ -55,6 +48,7 @@ function useGo1ContentView(props) {
         sendMessageToGo1,
         onGo1MessageReceived,
         themeInformation,
+        featureAttributes
     ]);
     (0, react_1.useEffect)(() => {
         window.addEventListener('message', eventListenerInstance);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@go1/go1-embedding-react-sdk",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "A React library to embed Go1 content into your website.",
   "main": "dist/go1-embedding-react-sdk/src/index.js",
   "files": [
@@ -18,7 +18,7 @@
   "scripts": {
     "test": "jest"
   },
-  "license": "MIT",
+  "license": "ISC",
   "devDependencies": {
     "@testing-library/jest-dom": "5.16.5",
     "@testing-library/react": "14.0.0",