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

package/README.md

@@ -60,25 +60,36 @@ interface ThemeInformation {
 }
 
 /**
- * Used to specify how the feature should appear, or what data it should work with. 
- * example: 
- * {
- *   id: 341134,
- *   shouldShowHeading: false
- * }
+ * Used to configure the `ai-chat` feature
  */
-interface FeatureAttributes {
-  [key: string]: number | string;
+export interface FeatureAttributesAIChat {
+  experience: 'manager' | 'learner';
+  intent?: 'skill_gap' | 'improve_skills' | 'next_role' | 'aspirational';
+  existingSkills?: string[]; // max items 7, any more are discarded
+  desiredSkills?: string[]; // max items 7, any more are discarded
+}
+
+export type FeatureAttributes = FeatureAttributesAIChat
+
+export interface AdditionalUserInfo {
+  jobTitle: string;
 }
 
 interface InitOptions {
-  feature: string; // 'ai-chat' | 'explore' | 'preview';
-  featureAttributes?: FeatureAttributes; // optional
-  portalURL?: string; //optional
-  onGo1MessageReceived?: OnGo1MessageReceived; //optional
-  additionalUserInfo?: any; //optional
-  themeInformation?: ThemeInformation; //optional
-  oneTimeToken?: string; //optional
+  /** Mandatory identifier for the embedded feature */
+  feature: 'ai-chat' | 'content-hub' | 'preview';
+  /** Optional parameters to configure the feature. See associated types for examples */
+  featureAttributes?: FeatureAttributes;
+  /** Optional Go1 portal URL, used for login purposes if no `oneTimeToken` is provided */
+  portalURL?: string;
+  /** Optional function that is invoked when the Go1 content view emits a message */
+  onGo1MessageReceived?: OnGo1MessageReceived;
+  /** 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;
 }
 ```
 
@@ -109,12 +120,11 @@ const options = useMemo<ContentViewProps>(() => {
     feature: 'ai-chat',
     portalURL: 'learning-incorporated-usa.mygo1.com',
     featureAttributes: {
-      id: 32973,
+      experience: 'manager',
     },
     onGo1MessageReceived,
     additionalUserInfo: {
-      department: 'sales',
-      goals: ['leadership', 'management']
+      jobTitle: 'Sales development representative'
     },
     themeInformation: {
       accent: '#0437F2'

package/dist/README.md

@@ -60,25 +60,36 @@ interface ThemeInformation {
 }
 
 /**
- * Used to specify how the feature should appear, or what data it should work with. 
- * example: 
- * {
- *   id: 341134,
- *   shouldShowHeading: false
- * }
+ * Used to configure the `ai-chat` feature
  */
-interface FeatureAttributes {
-  [key: string]: number | string;
+export interface FeatureAttributesAIChat {
+  experience: 'manager' | 'learner';
+  intent?: 'skill_gap' | 'improve_skills' | 'next_role' | 'aspirational';
+  existingSkills?: string[]; // max items 7, any more are discarded
+  desiredSkills?: string[]; // max items 7, any more are discarded
+}
+
+export type FeatureAttributes = FeatureAttributesAIChat
+
+export interface AdditionalUserInfo {
+  jobTitle: string;
 }
 
 interface InitOptions {
-  feature: string; // 'ai-chat' | 'explore' | 'preview';
-  featureAttributes?: FeatureAttributes; // optional
-  portalURL?: string; //optional
-  onGo1MessageReceived?: OnGo1MessageReceived; //optional
-  additionalUserInfo?: any; //optional
-  themeInformation?: ThemeInformation; //optional
-  oneTimeToken?: string; //optional
+  /** Mandatory identifier for the embedded feature */
+  feature: 'ai-chat' | 'content-hub' | 'preview';
+  /** Optional parameters to configure the feature. See associated types for examples */
+  featureAttributes?: FeatureAttributes;
+  /** Optional Go1 portal URL, used for login purposes if no `oneTimeToken` is provided */
+  portalURL?: string;
+  /** Optional function that is invoked when the Go1 content view emits a message */
+  onGo1MessageReceived?: OnGo1MessageReceived;
+  /** 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;
 }
 ```
 
@@ -109,12 +120,11 @@ const options = useMemo<ContentViewProps>(() => {
     feature: 'ai-chat',
     portalURL: 'learning-incorporated-usa.mygo1.com',
     featureAttributes: {
-      id: 32973,
+      experience: 'manager',
     },
     onGo1MessageReceived,
     additionalUserInfo: {
-      department: 'sales',
-      goals: ['leadership', 'management']
+      jobTitle: 'Sales development representative'
     },
     themeInformation: {
       accent: '#0437F2'

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,7 +4,8 @@ export type IframesMap = {
     [key: string]: HTMLIFrameElement;
 };
 export interface AdditionalInfoMessage {
-    additionalUserInfo?: any;
+    additionalUserInfo?: AdditionalUserInfo;
+    featureAttributes?: FeatureAttributes;
     themeInformation?: ThemeInformation;
 }
 export interface ThemeInformation {
@@ -14,16 +15,24 @@ export interface Go1Message {
     type: string;
     payload?: any;
 }
-export interface FeatureAttributes {
-    [key: string]: number | string;
+export interface FeatureAttributesAIChat {
+    experience: 'manager' | 'learner';
+    intent?: 'skill_gap' | 'improve_skills' | 'next_role' | 'aspirational';
+    existingSkills?: string[];
+    desiredSkills?: string[];
+}
+export type FeatureAttributes = FeatureAttributesAIChat;
+export interface AdditionalUserInfo {
+    jobTitle: string;
 }
 export interface InitOptions {
-    feature: string;
-    iframeParentId: string;
+    feature: 'ai-chat' | 'content-hub' | 'preview';
+    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.3",
+  "version": "0.0.5",
   "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",