@zoom/cobrowsesdk 2.10.0 → 2.11.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zoom/cobrowsesdk",
-  "version": "2.10.0",
+  "version": "2.11.0",
   "description": "ZOOM Cobrowse sdk",
   "files": [
     "esm",

package/types/agent-umd.d.ts

@@ -1157,6 +1157,24 @@ export type Settings = {
 	customizeOverrides?: {
 		[key in AgentCustomizeOverridesFeatureKey]?: CustomizeOverride;
 	};
+	/**
+	 * @description Annotation config, which only takes effect agent-side.
+	 */
+	annotation?: {
+		/**
+		 * @description Whether to enable annotation on the agent side, the default is true.
+		 */
+		enableAgentAnnotation?: boolean;
+		/**
+		 * @description Default selected toolbar button on the agent side. The default is 'Vanishing Pen'.
+		 * Supported values: 'Mouse', 'Pen', 'Rectangle', 'Eraser', 'Vanishing Pen', 'Vanishing Rectangle', 'Vanishing Mouse'.
+		 * 'Mouse', 'Pen', 'Rectangle', 'Eraser' are in 'Pen' toolbar submenu.
+		 * 'Vanishing Pen', 'Vanishing Rectangle', 'Vanishing Mouse' are in 'Vanishing Pen' toolbar submenu.
+		 * 'None', '' or an illegal value means no default selected toolbar button.
+		 * This value is also affected by the 'customizeOverrides' config in the toolbar.
+		 */
+		defaultSelectedToolbarButton?: string;
+	};
 	/**
 	 * @description In npm mode, a root dom selector or HTMLElement is required to insert an agent portal iframe into your page.
 	 */

package/types/agent.d.ts

@@ -1151,6 +1151,24 @@ export type Settings = {
 	customizeOverrides?: {
 		[key in AgentCustomizeOverridesFeatureKey]?: CustomizeOverride;
 	};
+	/**
+	 * @description Annotation config, which only takes effect agent-side.
+	 */
+	annotation?: {
+		/**
+		 * @description Whether to enable annotation on the agent side, the default is true.
+		 */
+		enableAgentAnnotation?: boolean;
+		/**
+		 * @description Default selected toolbar button on the agent side. The default is 'Vanishing Pen'.
+		 * Supported values: 'Mouse', 'Pen', 'Rectangle', 'Eraser', 'Vanishing Pen', 'Vanishing Rectangle', 'Vanishing Mouse'.
+		 * 'Mouse', 'Pen', 'Rectangle', 'Eraser' are in 'Pen' toolbar submenu.
+		 * 'Vanishing Pen', 'Vanishing Rectangle', 'Vanishing Mouse' are in 'Vanishing Pen' toolbar submenu.
+		 * 'None', '' or an illegal value means no default selected toolbar button.
+		 * This value is also affected by the 'customizeOverrides' config in the toolbar.
+		 */
+		defaultSelectedToolbarButton?: string;
+	};
 	/**
 	 * @description In npm mode, a root dom selector or HTMLElement is required to insert an agent portal iframe into your page.
 	 */

package/types/customer-umd.d.ts

@@ -778,6 +778,10 @@ declare function session_reconnecting(payload: {
 	 * SDK version.
 	 */
 	version: string;
+	/**
+	 * Reconnecting type.
+	 */
+	reconnectingType: "reconnecting" | "persisting";
 }): void;
 declare function session_started(payload: {
 	/**
@@ -1057,26 +1061,20 @@ export type SessionInfo = {
  */
 export type Settings = {
 	/**
-	 * @description Whether to enable annotation on the customer side, the default is false.
-	 */
-	allowCustomerAnnotation?: boolean;
-	/**
-	 * @description Whether to enable agent on the customer side, the default is true.
+	 * @description Annotation config.
 	 */
-	allowAgentAnnotation?: boolean;
-	/**
-	 * @description Whether to enable annotation follow page scroll, the default is false.
-	 */
-	enableAnnotationFollowScroll?: boolean;
-	/**
-	 * @description Default selected toolbar button on the agent side. The default is 'Vanishing Pen'.
-	 * Support: 'Mouse', 'Pen', 'Rectangle', 'Eraser', 'Vanishing Pen', 'Vanishing Rectangle', 'Vanishing Mouse'.
-	 * 'Mouse', 'Pen', 'Rectangle', 'Eraser' in 'Pen' toolbar sub-menu.
-	 * 'Vanishing Pen', 'Vanishing Rectangle', 'Vanishing Mouse' in 'Vanishing Pen' toolbar sub-menu.
-	 */
-	defaultSelectedToolbarButton?: string;
+	annotation?: {
+		/**
+		 * @description Whether to enable annotation on the customer side, the default is false.
+		 */
+		enableCustomerAnnotation?: boolean;
+		/**
+		 * @description Whether to enable annotation follow page scroll, the default is false.
+		 */
+		enableAnnotationFollowScroll?: boolean;
+	};
 	/**
-	 * @description PII mask config，which only takes effect when the 'Mask Data in Cobrowse' switch in the admin settings is opened.
+	 * @description PII mask config, which only takes effect when the 'Mask Data in Cobrowse' switch in the admin settings is opened.
 	 */
 	piiMask?: {
 		//enable?: boolean;

package/types/customer.d.ts

@@ -778,6 +778,10 @@ declare function session_reconnecting(payload: {
 	 * SDK version.
 	 */
 	version: string;
+	/**
+	 * Reconnecting type.
+	 */
+	reconnectingType: "reconnecting" | "persisting";
 }): void;
 declare function session_started(payload: {
 	/**
@@ -1051,26 +1055,20 @@ export type SessionInfo = {
  */
 export type Settings = {
 	/**
-	 * @description Whether to enable annotation on the customer side, the default is false.
-	 */
-	allowCustomerAnnotation?: boolean;
-	/**
-	 * @description Whether to enable agent on the customer side, the default is true.
+	 * @description Annotation config.
 	 */
-	allowAgentAnnotation?: boolean;
-	/**
-	 * @description Whether to enable annotation follow page scroll, the default is false.
-	 */
-	enableAnnotationFollowScroll?: boolean;
-	/**
-	 * @description Default selected toolbar button on the agent side. The default is 'Vanishing Pen'.
-	 * Support: 'Mouse', 'Pen', 'Rectangle', 'Eraser', 'Vanishing Pen', 'Vanishing Rectangle', 'Vanishing Mouse'.
-	 * 'Mouse', 'Pen', 'Rectangle', 'Eraser' in 'Pen' toolbar sub-menu.
-	 * 'Vanishing Pen', 'Vanishing Rectangle', 'Vanishing Mouse' in 'Vanishing Pen' toolbar sub-menu.
-	 */
-	defaultSelectedToolbarButton?: string;
+	annotation?: {
+		/**
+		 * @description Whether to enable annotation on the customer side, the default is false.
+		 */
+		enableCustomerAnnotation?: boolean;
+		/**
+		 * @description Whether to enable annotation follow page scroll, the default is false.
+		 */
+		enableAnnotationFollowScroll?: boolean;
+	};
 	/**
-	 * @description PII mask config，which only takes effect when the 'Mask Data in Cobrowse' switch in the admin settings is opened.
+	 * @description PII mask config, which only takes effect when the 'Mask Data in Cobrowse' switch in the admin settings is opened.
 	 */
 	piiMask?: {
 		//enable?: boolean;