@go1/go1-embedding-react-sdk 0.0.4 → 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/types.d.ts

@@ -15,14 +15,18 @@ export interface Go1Message {
     type: string;
     payload?: any;
 }
-export interface FeatureAttributes {
-    [key: string]: any;
+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 {
-    [key: string]: any;
+    jobTitle: string;
 }
 export interface InitOptions {
-    feature: string;
+    feature: 'ai-chat' | 'content-hub' | 'preview';
     iframeParentId?: string;
     iframeParentElement?: HTMLElement;
     featureAttributes?: FeatureAttributes;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@go1/go1-embedding-react-sdk",
-  "version": "0.0.4",
+  "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": [