@zoom/cobrowsesdk 2.9.1 → 2.10.0

package/package.json

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

package/types/agent-umd.d.ts

@@ -696,11 +696,11 @@ declare enum SessionStatus {
 }
 declare function customer_focus_lost(payload: {
 	/**
-	 * customer is lost
+	 * Whether the customer is lost.
 	 */
 	isLost: boolean;
 	/**
-	 * sessionId
+	 * Session ID.
 	 */
 	sessionId: string;
 	/**
@@ -711,24 +711,24 @@ declare function customer_focus_lost(payload: {
 		name: string;
 	};
 	/**
-	 * SDK version
+	 * SDK version.
 	 */
 	version: string;
 }): void;
 declare function customer_transferred(payload: {
 	/**
-	 * sessionId
+	 * Session ID.
 	 */
 	sessionId: string;
 	/**
-	 * User info
+	 * User info.
 	 */
 	user: {
 		id: string;
 		name: string;
 	};
 	/**
-	 * SDK version
+	 * SDK version.
 	 */
 	version: string;
 }): void;
@@ -812,13 +812,13 @@ declare function session_ended(payload: {
 }): void;
 declare function session_error(payload: {
 	/**
-	 * error code
+	 * Error code.
 	 */
 	code: SessionErrorCode;
 	/**
-	 * error message
+	 * Error message.(Auxiliary prompt, not used to determine errors)
 	 */
-	errorMsg: string;
+	errorMsg: SessionErrorMessage;
 	/**
 	 * SDK version
 	 */
@@ -830,11 +830,11 @@ declare function session_joined(payload: {
 	 */
 	isReconnect: boolean;
 	/**
-	 * sessionId
+	 * Session ID.
 	 */
 	sessionId: string;
 	/**
-	 * SDK version
+	 * SDK version.
 	 */
 	version: string;
 }): void;
@@ -978,9 +978,18 @@ export type CreateAgentViewerEndpointCallback = ({ success, error, agentViewerUr
  * @description CreateAgentViewerEndpointCallback fetch error.
  */
 export type CreateAgentViewerEndpointError = {
-	msg: string;
-	code: number;
-	statusCode: number;
+	/**
+	 * Error code.
+	 */
+	code: SessionErrorCode;
+	/**
+	 * Error message.(Auxiliary prompt, not used to determine errors)
+	 */
+	errorMsg: SessionErrorMessage;
+	/**
+	 * SDK version.
+	 */
+	version: string;
 };
 /**
  * @description ZoomAgentCobrowseSDK request agent endpoint options.
@@ -1078,6 +1087,47 @@ export type SdkInfo = {
 	 */
 	version: string;
 };
+/**
+ * @description Session error messages.(Auxiliary prompt, not used to determine errors)
+ */
+export type SessionErrorMessage = {
+	/**
+	 * @description 1006 Join session failed due to pincode not found.
+	 */
+	SESSION_JOIN_PIN_NOT_FOUND: "Pincode is not found.";
+	/**
+	 * @description 1008 Join session failed due to invalid pincode.
+	 */
+	SESSION_PIN_INVALID_FORMAT: "Pincode exceeds the maximum length" | "Pincode contains invalid characters.";
+	/**
+	 * @description 1009 Join session failed due to empty pincode.
+	 */
+	SESSION_START_PIN_REQUIRED: "Pincode is required.";
+	/**
+	 * @description 1011 Join session failed.
+	 */
+	SESSION_JOIN_FAILED: "Session join failed due to an internal error." | "SDK version is invalid." | "Session does not exist or has ended." | "The website link is invalid." | "Failed to make a connection after multiple attempts." | "Failed to reconnect after fail over with multiple attempts." | "Failed to reconnect after fail over with multiple attempts.";
+	/**
+	 * @description 1013 Join session failed due to count limit.
+	 */
+	SESSION_AGENT_COUNT_LIMIT: "Maximum number of agents in a session reached.";
+	/**
+	 * @description 1015 Join session failed due to duplicate user.
+	 */
+	SESSION_DUPLICATE_USER: "The agent is already in the session.";
+	/**
+	 * @description 1016 Start or join session failed due to network error.
+	 */
+	NETWORK_ERROR: "Network request to backend failed after multiple attempts.";
+	/**
+	 * @description 2001 Join session failed due to invalid token.
+	 */
+	TOKEN_INVALID: "JWT token is invalid." | "JWT token has no permissions." | "JWT token has expired." | "JWT token access error." | "Internal token error.";
+	/**
+	 * @description 9999 Unknown error.
+	 */
+	UNDEFINED: "Service error occurred." | "API request rate limit, try again later." | "Session error occurred." | "Session error occurred, try again later.";
+};
 /**
  * @description Current session information.
  */

package/types/agent.d.ts

@@ -696,11 +696,11 @@ declare enum SessionStatus {
 }
 declare function customer_focus_lost(payload: {
 	/**
-	 * customer is lost
+	 * Whether the customer is lost.
 	 */
 	isLost: boolean;
 	/**
-	 * sessionId
+	 * Session ID.
 	 */
 	sessionId: string;
 	/**
@@ -711,24 +711,24 @@ declare function customer_focus_lost(payload: {
 		name: string;
 	};
 	/**
-	 * SDK version
+	 * SDK version.
 	 */
 	version: string;
 }): void;
 declare function customer_transferred(payload: {
 	/**
-	 * sessionId
+	 * Session ID.
 	 */
 	sessionId: string;
 	/**
-	 * User info
+	 * User info.
 	 */
 	user: {
 		id: string;
 		name: string;
 	};
 	/**
-	 * SDK version
+	 * SDK version.
 	 */
 	version: string;
 }): void;
@@ -812,13 +812,13 @@ declare function session_ended(payload: {
 }): void;
 declare function session_error(payload: {
 	/**
-	 * error code
+	 * Error code.
 	 */
 	code: SessionErrorCode;
 	/**
-	 * error message
+	 * Error message.(Auxiliary prompt, not used to determine errors)
 	 */
-	errorMsg: string;
+	errorMsg: SessionErrorMessage;
 	/**
 	 * SDK version
 	 */
@@ -830,11 +830,11 @@ declare function session_joined(payload: {
 	 */
 	isReconnect: boolean;
 	/**
-	 * sessionId
+	 * Session ID.
 	 */
 	sessionId: string;
 	/**
-	 * SDK version
+	 * SDK version.
 	 */
 	version: string;
 }): void;
@@ -972,9 +972,18 @@ export type CreateAgentViewerEndpointCallback = ({ success, error, agentViewerUr
  * @description CreateAgentViewerEndpointCallback fetch error.
  */
 export type CreateAgentViewerEndpointError = {
-	msg: string;
-	code: number;
-	statusCode: number;
+	/**
+	 * Error code.
+	 */
+	code: SessionErrorCode;
+	/**
+	 * Error message.(Auxiliary prompt, not used to determine errors)
+	 */
+	errorMsg: SessionErrorMessage;
+	/**
+	 * SDK version.
+	 */
+	version: string;
 };
 /**
  * @description ZoomAgentCobrowseSDK request agent endpoint options.
@@ -1072,6 +1081,47 @@ export type SdkInfo = {
 	 */
 	version: string;
 };
+/**
+ * @description Session error messages.(Auxiliary prompt, not used to determine errors)
+ */
+export type SessionErrorMessage = {
+	/**
+	 * @description 1006 Join session failed due to pincode not found.
+	 */
+	SESSION_JOIN_PIN_NOT_FOUND: "Pincode is not found.";
+	/**
+	 * @description 1008 Join session failed due to invalid pincode.
+	 */
+	SESSION_PIN_INVALID_FORMAT: "Pincode exceeds the maximum length" | "Pincode contains invalid characters.";
+	/**
+	 * @description 1009 Join session failed due to empty pincode.
+	 */
+	SESSION_START_PIN_REQUIRED: "Pincode is required.";
+	/**
+	 * @description 1011 Join session failed.
+	 */
+	SESSION_JOIN_FAILED: "Session join failed due to an internal error." | "SDK version is invalid." | "Session does not exist or has ended." | "The website link is invalid." | "Failed to make a connection after multiple attempts." | "Failed to reconnect after fail over with multiple attempts." | "Failed to reconnect after fail over with multiple attempts.";
+	/**
+	 * @description 1013 Join session failed due to count limit.
+	 */
+	SESSION_AGENT_COUNT_LIMIT: "Maximum number of agents in a session reached.";
+	/**
+	 * @description 1015 Join session failed due to duplicate user.
+	 */
+	SESSION_DUPLICATE_USER: "The agent is already in the session.";
+	/**
+	 * @description 1016 Start or join session failed due to network error.
+	 */
+	NETWORK_ERROR: "Network request to backend failed after multiple attempts.";
+	/**
+	 * @description 2001 Join session failed due to invalid token.
+	 */
+	TOKEN_INVALID: "JWT token is invalid." | "JWT token has no permissions." | "JWT token has expired." | "JWT token access error." | "Internal token error.";
+	/**
+	 * @description 9999 Unknown error.
+	 */
+	UNDEFINED: "Service error occurred." | "API request rate limit, try again later." | "Session error occurred." | "Session error occurred, try again later.";
+};
 /**
  * @description Current session information.
  */

package/types/customer-umd.d.ts

@@ -761,9 +761,9 @@ declare function session_error(payload: {
 	 */
 	code: SessionErrorCode;
 	/**
-	 * Error message.
+	 * Error message.(Auxiliary prompt, not used to determine errors)
 	 */
-	errorMsg: string;
+	errorMsg: SessionErrorMessage;
 	/**
 	 * SDK version.
 	 */
@@ -984,6 +984,55 @@ export type SdkInfo = {
 	 */
 	version: string;
 };
+/**
+ * @description Session error messages.(Auxiliary prompt, not used to determine errors)
+ */
+export type SessionErrorMessage = {
+	/**
+	 * @description 1001 Join session failed due to an invalid pincode.
+	 */
+	SESSION_START_FAILED: "The website link is invalid." | "Free trial account has no available credits.";
+	/**
+	 * @description 1002 Session is connecting.
+	 */
+	SESSION_CONNECTING_IN_PROGRESS: "A connection is already in progress." | "A transfer session is still recovering.";
+	/**
+	 * @description 1004 Join session failed due to count limit.
+	 */
+	SESSION_COUNT_LIMIT: "A session is already active.";
+	/**
+	 * @description 1008 Join session failed due to an invalid pincode.
+	 */
+	SESSION_PIN_INVALID_FORMAT: "Pincode exceeds the maximum length" | "Pincode contains invalid characters.";
+	/**
+	 * @description 1010 Start session failed due to pincode already in use.
+	 */
+	SESSION_START_PIN_CONFLICT: "Pincode has already been used.";
+	/**
+	 * @description 1011 Join session failed.
+	 */
+	SESSION_JOIN_FAILED: "Session join failed due to an internal error." | "SDK version is invalid." | "Session does not exist or has ended." | "The website link is invalid." | "Failed to make a connection after multiple attempts." | "Failed to reconnect after fail over with multiple attempts." | "Failed to reconnect after fail over with multiple attempts.";
+	/**
+	 * @description 1012 Join session failed due to count limit.
+	 */
+	SESSION_CUSTOMER_COUNT_LIMIT: "Maximum number of customers in a session reached.";
+	/**
+	 * @description 1016 Start or join session failed due to network error.
+	 */
+	NETWORK_ERROR: "Network request to backend failed after multiple attempts.";
+	/**
+	 * @description 1017 Session is being canceled.
+	 */
+	SESSION_CANCELING_IN_PROGRESS: "Operation failed, the session is being canceled.";
+	/**
+	 * @description 2001 Join session failed due to invalid token.
+	 */
+	TOKEN_INVALID: "JWT token is invalid." | "JWT token has no permissions." | "JWT token has expired." | "JWT token access error." | "Internal token error.";
+	/**
+	 * @description 9999 Unknown error.
+	 */
+	UNDEFINED: "Service error occurred." | "API request rate limit, try again later." | "Session error occurred." | "Session error occurred, try again later.";
+};
 /**
  * @description Current session information.
  */
@@ -1016,23 +1065,34 @@ export type Settings = {
 	 */
 	allowAgentAnnotation?: boolean;
 	/**
-	 * @description PII mask config.
+	 * @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;
+	/**
+	 * @description PII mask config，which only takes effect when the 'Mask Data in Cobrowse' switch in the admin settings is opened.
 	 */
 	piiMask?: {
 		//enable?: boolean;
 		/**
 		 * @description PII mask config.
-		 * 'custom_input': Customize the input to be masked based on 'mask_css_selectors' and 'mask_html_attribute'
-		 * 'all_input': Mask all inputs, ignore 'mask_css_selectors' and 'mask_html_attribute'
-		 *  the default is 'custom_input'
+		 * 'custom_input': Customize the input to be masked based on 'mask_css_selectors' and 'mask_html_attribute'.
+		 * 'all_input': Mask all inputs, ignore 'mask_css_selectors' and 'mask_html_attribute'.
+		 *  The default is the configuration of admin settings.
 		 */
 		maskType?: "custom_input" | "all_input";
 		/**
-		 * @description Mask part of the input by customizing the CSS selector, which only takes effect when the maskType is 'custom_input', the default is empty string.
+		 * @description Mask part of the input by customizing the CSS selector, which only takes effect when the maskType is 'custom_input'. The default is the configuration of admin settings.
 		 */
 		maskCssSelectors?: string;
 		/**
-		 * @description Mask part of the input by customizing the HTML attributes, which only takes effect when the maskType is 'custom_input', the default is empty string.
+		 * @description Mask part of the input by customizing the HTML attributes, which only takes effect when the maskType is 'custom_input', the default is the configuration of admin settings.
 		 */
 		maskHTMLAttributes?: string;
 	};
@@ -1054,7 +1114,7 @@ export type Settings = {
 		[key in CustomerCustomizeOverridesFeatureKey]?: CustomizeOverride;
 	};
 	/**
-	 * @description Remote assist config.
+	 * @description Remote assist config, which only take effect when the 'Remote assist' switch in the admin settings is opened.
 	 */
 	remoteAssist?: {
 		/**
@@ -1075,15 +1135,15 @@ export type Settings = {
 		remoteAssistTypes?: "scroll_page"[];
 	};
 	/**
-	 * @description Session continuation config.
+	 * @description Session continuation config, which only take effect when the 'Multi-tab session persistence' switch in the admin settings is opened.
 	 */
 	multiTabSessionPersistence?: {
 		/**
-		 * @description Whether to enable session continuation, the default is false.
+		 * @description Whether to enable multi-tab session persistence, the default is false.
 		 */
 		enable: boolean;
 		/**
-		 * @description The cookie key for session continuation, the default is '$$_ZCB_SESSION_$$'(base64 encoded).
+		 * @description The cookie key for multi-tab session persistence, the default is '$$_ZCB_SESSION_$$'(base64 encoded).
 		 */
 		stateCookieKey?: string;
 	};

package/types/customer.d.ts

@@ -761,9 +761,9 @@ declare function session_error(payload: {
 	 */
 	code: SessionErrorCode;
 	/**
-	 * Error message.
+	 * Error message.(Auxiliary prompt, not used to determine errors)
 	 */
-	errorMsg: string;
+	errorMsg: SessionErrorMessage;
 	/**
 	 * SDK version.
 	 */
@@ -978,6 +978,55 @@ export type SdkInfo = {
 	 */
 	version: string;
 };
+/**
+ * @description Session error messages.(Auxiliary prompt, not used to determine errors)
+ */
+export type SessionErrorMessage = {
+	/**
+	 * @description 1001 Join session failed due to an invalid pincode.
+	 */
+	SESSION_START_FAILED: "The website link is invalid." | "Free trial account has no available credits.";
+	/**
+	 * @description 1002 Session is connecting.
+	 */
+	SESSION_CONNECTING_IN_PROGRESS: "A connection is already in progress." | "A transfer session is still recovering.";
+	/**
+	 * @description 1004 Join session failed due to count limit.
+	 */
+	SESSION_COUNT_LIMIT: "A session is already active.";
+	/**
+	 * @description 1008 Join session failed due to an invalid pincode.
+	 */
+	SESSION_PIN_INVALID_FORMAT: "Pincode exceeds the maximum length" | "Pincode contains invalid characters.";
+	/**
+	 * @description 1010 Start session failed due to pincode already in use.
+	 */
+	SESSION_START_PIN_CONFLICT: "Pincode has already been used.";
+	/**
+	 * @description 1011 Join session failed.
+	 */
+	SESSION_JOIN_FAILED: "Session join failed due to an internal error." | "SDK version is invalid." | "Session does not exist or has ended." | "The website link is invalid." | "Failed to make a connection after multiple attempts." | "Failed to reconnect after fail over with multiple attempts." | "Failed to reconnect after fail over with multiple attempts.";
+	/**
+	 * @description 1012 Join session failed due to count limit.
+	 */
+	SESSION_CUSTOMER_COUNT_LIMIT: "Maximum number of customers in a session reached.";
+	/**
+	 * @description 1016 Start or join session failed due to network error.
+	 */
+	NETWORK_ERROR: "Network request to backend failed after multiple attempts.";
+	/**
+	 * @description 1017 Session is being canceled.
+	 */
+	SESSION_CANCELING_IN_PROGRESS: "Operation failed, the session is being canceled.";
+	/**
+	 * @description 2001 Join session failed due to invalid token.
+	 */
+	TOKEN_INVALID: "JWT token is invalid." | "JWT token has no permissions." | "JWT token has expired." | "JWT token access error." | "Internal token error.";
+	/**
+	 * @description 9999 Unknown error.
+	 */
+	UNDEFINED: "Service error occurred." | "API request rate limit, try again later." | "Session error occurred." | "Session error occurred, try again later.";
+};
 /**
  * @description Current session information.
  */
@@ -1010,23 +1059,34 @@ export type Settings = {
 	 */
 	allowAgentAnnotation?: boolean;
 	/**
-	 * @description PII mask config.
+	 * @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;
+	/**
+	 * @description PII mask config，which only takes effect when the 'Mask Data in Cobrowse' switch in the admin settings is opened.
 	 */
 	piiMask?: {
 		//enable?: boolean;
 		/**
 		 * @description PII mask config.
-		 * 'custom_input': Customize the input to be masked based on 'mask_css_selectors' and 'mask_html_attribute'
-		 * 'all_input': Mask all inputs, ignore 'mask_css_selectors' and 'mask_html_attribute'
-		 *  the default is 'custom_input'
+		 * 'custom_input': Customize the input to be masked based on 'mask_css_selectors' and 'mask_html_attribute'.
+		 * 'all_input': Mask all inputs, ignore 'mask_css_selectors' and 'mask_html_attribute'.
+		 *  The default is the configuration of admin settings.
 		 */
 		maskType?: "custom_input" | "all_input";
 		/**
-		 * @description Mask part of the input by customizing the CSS selector, which only takes effect when the maskType is 'custom_input', the default is empty string.
+		 * @description Mask part of the input by customizing the CSS selector, which only takes effect when the maskType is 'custom_input'. The default is the configuration of admin settings.
 		 */
 		maskCssSelectors?: string;
 		/**
-		 * @description Mask part of the input by customizing the HTML attributes, which only takes effect when the maskType is 'custom_input', the default is empty string.
+		 * @description Mask part of the input by customizing the HTML attributes, which only takes effect when the maskType is 'custom_input', the default is the configuration of admin settings.
 		 */
 		maskHTMLAttributes?: string;
 	};
@@ -1048,7 +1108,7 @@ export type Settings = {
 		[key in CustomerCustomizeOverridesFeatureKey]?: CustomizeOverride;
 	};
 	/**
-	 * @description Remote assist config.
+	 * @description Remote assist config, which only take effect when the 'Remote assist' switch in the admin settings is opened.
 	 */
 	remoteAssist?: {
 		/**
@@ -1069,15 +1129,15 @@ export type Settings = {
 		remoteAssistTypes?: "scroll_page"[];
 	};
 	/**
-	 * @description Session continuation config.
+	 * @description Session continuation config, which only take effect when the 'Multi-tab session persistence' switch in the admin settings is opened.
 	 */
 	multiTabSessionPersistence?: {
 		/**
-		 * @description Whether to enable session continuation, the default is false.
+		 * @description Whether to enable multi-tab session persistence, the default is false.
 		 */
 		enable: boolean;
 		/**
-		 * @description The cookie key for session continuation, the default is '$$_ZCB_SESSION_$$'(base64 encoded).
+		 * @description The cookie key for multi-tab session persistence, the default is '$$_ZCB_SESSION_$$'(base64 encoded).
 		 */
 		stateCookieKey?: string;
 	};