@go1/go1-embedding-react-sdk 0.0.8 → 0.0.10

package/README.md

@@ -73,7 +73,14 @@ export interface FeatureAttributesAIChat {
   desiredRole?: string; // e.g. "Senior Account Manager"
 }
 
-export type FeatureAttributes = FeatureAttributesAIChat
+/**
+ * Used to configure the `preview` feature
+ */
+export interface FeatureAttributesPreview {
+  id: number
+}
+
+export type FeatureAttributes = FeatureAttributesAIChat |  FeatureAttributesPreview;
 
 export interface AdditionalUserInfo {
   jobTitle: string;
@@ -81,7 +88,7 @@ export interface AdditionalUserInfo {
 
 interface InitOptions {
   /** Mandatory identifier for the embedded feature */
-  feature: 'ai-chat' | 'content-hub' | 'preview';
+  feature: 'ai-chat' | 'content-hub' | 'preview' | 'library' | 'search';
   /** 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 */

package/dist/README.md

@@ -73,7 +73,14 @@ export interface FeatureAttributesAIChat {
   desiredRole?: string; // e.g. "Senior Account Manager"
 }
 
-export type FeatureAttributes = FeatureAttributesAIChat
+/**
+ * Used to configure the `preview` feature
+ */
+export interface FeatureAttributesPreview {
+  id: number
+}
+
+export type FeatureAttributes = FeatureAttributesAIChat |  FeatureAttributesPreview;
 
 export interface AdditionalUserInfo {
   jobTitle: string;
@@ -81,7 +88,7 @@ export interface AdditionalUserInfo {
 
 interface InitOptions {
   /** Mandatory identifier for the embedded feature */
-  feature: 'ai-chat' | 'content-hub' | 'preview';
+  feature: 'ai-chat' | 'content-hub' | 'preview' | 'library' | 'search';
   /** 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 */

package/dist/common/params.d.ts

@@ -1,2 +1,3 @@
-export declare function addPortalURL(url: URL, portalURL: string): void;
+export declare function addPortalURL(url: URL, portalURL: string, env?: 'qa' | 'prod'): void;
 export declare function addOneTimeToken(url: URL, oneTimeToken: string): void;
+export declare function isValidFeature(feature: string): boolean;

package/dist/common/params.js

@@ -1,8 +1,11 @@
 "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$/;
+exports.isValidFeature = exports.addOneTimeToken = exports.addPortalURL = void 0;
+function addPortalURL(url, portalURL, env = 'prod') {
+    let validPortalURL = /^(?=.{1,255}$)[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,245}[a-zA-Z0-9])?\.mygo1\.com$/;
+    if (env === 'qa') {
+        validPortalURL = /^(?=.{1,255}$)[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,245}[a-zA-Z0-9])?\.qa\.go1\.cloud$/;
+    }
     if (validPortalURL.test(portalURL)) {
         url.searchParams.append('portal_url', portalURL);
     }
@@ -21,3 +24,7 @@ function addOneTimeToken(url, oneTimeToken) {
     }
 }
 exports.addOneTimeToken = addOneTimeToken;
+function isValidFeature(feature) {
+    return ['ai-chat', 'content-hub', 'preview', 'library', 'search'].includes(feature);
+}
+exports.isValidFeature = isValidFeature;

package/dist/common/types.d.ts

@@ -24,12 +24,15 @@ export interface FeatureAttributesAIChat {
     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.d.ts

@@ -1,7 +1,11 @@
 import * as React from 'react';
 import { InitOptions, SendMessageToGo1 } from '../../common/types';
 export type ContentViewProps = Omit<InitOptions, 'iframeParentId' | 'iframeParentElement'>;
-export declare function useGo1ContentView(props: ContentViewProps): {
+type EnvProps = {
+    env?: 'qa' | 'prod';
+};
+export declare function useGo1ContentView(props: ContentViewProps & EnvProps): {
     sendMessageToGo1: SendMessageToGo1;
     ContentView: (userProps?: React.IframeHTMLAttributes<HTMLIFrameElement>) => React.JSX.Element;
 };
+export {};

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

@@ -6,20 +6,26 @@ 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, } = props;
+    const { feature, featureAttributes, portalURL, oneTimeToken, onGo1MessageReceived, additionalUserInfo, themeInformation, env = 'prod', } = props;
     const iframeRef = (0, react_1.useRef)(null);
-    const url = 'https://embedding.go1.com';
+    let url = 'https://embedding.go1.com';
+    if (env === 'qa') {
+        url = 'https://embedding.qa.go1.cloud';
+    }
+    if (!(0, params_1.isValidFeature)(feature)) {
+        throw new Error('Unsupported feature');
+    }
     let { iframeURL, iframeID } = (0, react_1.useMemo)(() => {
         let iframeURL = new URL(`${url}/${feature}`);
         if (portalURL) {
-            (0, params_1.addPortalURL)(iframeURL, portalURL);
+            (0, params_1.addPortalURL)(iframeURL, portalURL, env);
         }
         if (oneTimeToken) {
             (0, params_1.addOneTimeToken)(iframeURL, oneTimeToken);
         }
         const iframeID = `go1-iframe-${feature}`;
         return { iframeURL, iframeID };
-    }, [url, feature, oneTimeToken, portalURL]);
+    }, [url, feature, portalURL, oneTimeToken, env]);
     const sendMessageToGo1 = (0, react_1.useCallback)((message) => {
         iframeRef.current?.contentWindow?.postMessage(message, url);
     }, [url]);
@@ -30,11 +36,11 @@ function useGo1ContentView(props) {
                 let payload = {
                     additionalUserInfo,
                     themeInformation,
-                    featureAttributes
+                    featureAttributes,
                 };
                 sendMessageToGo1({
                     type: 'set_additional_embedding_data',
-                    payload
+                    payload,
                 });
             }
             else {
@@ -48,7 +54,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.8",
+  "version": "0.0.10",
   "description": "A React library to embed Go1 content into your website.",
   "main": "dist/go1-embedding-react-sdk/src/index.js",
   "files": [