@go1/go1-embedding-react-sdk 0.0.6 → 0.0.9

package/README.md

@@ -49,9 +49,11 @@ type OnGo1MessageReceived = (message: Go1Message) => void;
 
 type SendMessageToGo1 = (message: Go1Message) => void;
 
+type Go1MessageType = 'preview_start_content' | 'set_additional_embedding_data' | 'go1_app_initialised';
+
 interface Go1Message {
-  type: string;
-  payload?: any; //optional
+  type: Go1MessageType;
+  payload?: any;
 }
 
 interface ThemeInformation {
@@ -64,13 +66,21 @@ interface ThemeInformation {
  */
 export interface FeatureAttributesAIChat {
   experience: 'manager' | 'learner';
-  intent?: 'skill_gap' | 'improve_skills' | 'next_role' | 'aspirational';
+  intent?: 'skill_gap' | 'improve_skills' | 'next_role' | 'aspirations';
   message?: string; // The desired message to start the chat, which will be shown to the user
   existingSkills?: string[]; // max items 7, any more are discarded
   desiredSkills?: string[]; // max items 7, any more are discarded
+  desiredRole?: string; // e.g. "Senior Account Manager"
+}
+
+/**
+ * Used to configure the `preview` feature
+ */
+export interface FeatureAttributesPreview {
+  id: number
 }
 
-export type FeatureAttributes = FeatureAttributesAIChat
+export type FeatureAttributes = FeatureAttributesAIChat |  FeatureAttributesPreview;
 
 export interface AdditionalUserInfo {
   jobTitle: string;

package/dist/README.md

@@ -49,9 +49,11 @@ type OnGo1MessageReceived = (message: Go1Message) => void;
 
 type SendMessageToGo1 = (message: Go1Message) => void;
 
+type Go1MessageType = 'preview_start_content' | 'set_additional_embedding_data' | 'go1_app_initialised';
+
 interface Go1Message {
-  type: string;
-  payload?: any; //optional
+  type: Go1MessageType;
+  payload?: any;
 }
 
 interface ThemeInformation {
@@ -64,13 +66,21 @@ interface ThemeInformation {
  */
 export interface FeatureAttributesAIChat {
   experience: 'manager' | 'learner';
-  intent?: 'skill_gap' | 'improve_skills' | 'next_role' | 'aspirational';
+  intent?: 'skill_gap' | 'improve_skills' | 'next_role' | 'aspirations';
   message?: string; // The desired message to start the chat, which will be shown to the user
   existingSkills?: string[]; // max items 7, any more are discarded
   desiredSkills?: string[]; // max items 7, any more are discarded
+  desiredRole?: string; // e.g. "Senior Account Manager"
+}
+
+/**
+ * Used to configure the `preview` feature
+ */
+export interface FeatureAttributesPreview {
+  id: number
 }
 
-export type FeatureAttributes = FeatureAttributesAIChat
+export type FeatureAttributes = FeatureAttributesAIChat |  FeatureAttributesPreview;
 
 export interface AdditionalUserInfo {
   jobTitle: string;

package/dist/common/types.d.ts

@@ -11,23 +11,28 @@ export interface AdditionalInfoMessage {
 export interface ThemeInformation {
     accent: string;
 }
+export type Go1MessageType = 'preview_start_content' | 'set_additional_embedding_data' | 'go1_app_initialised';
 export interface Go1Message {
-    type: string;
+    type: Go1MessageType;
     payload?: any;
 }
 export interface FeatureAttributesAIChat {
     experience: 'manager' | 'learner';
-    intent?: 'skill_gap' | 'improve_skills' | 'next_role' | 'aspirational';
+    intent?: 'skill_gap' | 'improve_skills' | 'next_role' | 'aspirations';
     message?: string;
     existingSkills?: string[];
     desiredSkills?: string[];
+    desiredRole?: string;
 }
-export type FeatureAttributes = FeatureAttributesAIChat;
+export interface FeatureAttributesPreview {
+    id: number;
+}
+export type FeatureAttributes = FeatureAttributesAIChat | FeatureAttributesPreview;
 export interface AdditionalUserInfo {
     jobTitle: string;
 }
 export interface InitOptions {
-    feature: 'ai-chat' | 'content-hub' | 'preview';
+    feature: 'ai-chat' | 'content-hub' | 'preview' | 'library' | 'search';
     iframeParentId?: string;
     iframeParentElement?: HTMLElement;
     featureAttributes?: FeatureAttributes;

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

@@ -30,11 +30,11 @@ function useGo1ContentView(props) {
                 let payload = {
                     additionalUserInfo,
                     themeInformation,
-                    featureAttributes
+                    featureAttributes,
                 };
                 sendMessageToGo1({
                     type: 'set_additional_embedding_data',
-                    payload
+                    payload,
                 });
             }
             else {
@@ -48,7 +48,7 @@ function useGo1ContentView(props) {
         sendMessageToGo1,
         onGo1MessageReceived,
         themeInformation,
-        featureAttributes
+        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.6",
+  "version": "0.0.9",
   "description": "A React library to embed Go1 content into your website.",
   "main": "dist/go1-embedding-react-sdk/src/index.js",
   "files": [
@@ -20,10 +20,10 @@
   },
   "license": "ISC",
   "devDependencies": {
-    "@testing-library/jest-dom": "5.16.5",
+    "@testing-library/jest-dom": "5.17.0",
     "@testing-library/react": "14.0.0",
     "@testing-library/user-event": "14.4.3",
-    "jest": "^29.6.1",
+    "jest": "^29.6.2",
     "react": "18.2.0",
     "react-dom": "^18.2.0",
     "ts-jest": "^29.1.1",