Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@channel.io/channel-web-sdk-loader
Advanced tools
@channel.io/channel-web-sdk-loader - npm Package Compare versions
Comparing version 1.0.0 to 1.1.0
@@ -237,14 +237,30 @@ declare global { | ||
| /** | ||
| * Opens a chat within the messenger. | ||
| * Opens a chat interface | ||
| * | ||
| * - For an empty chatId, a new chat is opened. Any provided message appears in the chat input. If the support bot is active, it will initiate. | ||
| * - If a chat with the provided chatId exists, that chat will open, and any message will be ignored. | ||
| * - If a chat doesn't exist, the home is opened. | ||
| * - Note: Using this function outside a click event handler may lead to issues on iOS Safari. | ||
| * - Reveals the `messenger` if hidden. | ||
| * - For an undefined `chatId`, a new chat is created. Any provided `message` populates the chat input. The support bot initializes if active. | ||
| * - If a chat with the given `chatId` exists, the chat will open, and the `message` parameter will be disregarded. | ||
| * - If no matching chat exists, the `home` view opens. | ||
| * - Caution: Utilizing this function outside a click event may cause issues in iOS Safari. | ||
| * | ||
| * @param {string | number | undefined} chatId - The ID of the chat to open. | ||
| * @param {string | undefined} message - Message to appear in the chat input. | ||
| * @param {string | number | undefined} chatId - ID of the chat to reveal. | ||
| * @param {string | undefined} message - Optional text to populate the chat input field. | ||
| * @see https://developers.channel.io/docs/web-channelio#openchat | ||
| */ | ||
| export declare function openChat(chatId?: string | number, message?: string): void; | ||
| /** | ||
| * Initiates a chat by triggering a specified support bot. | ||
| * | ||
| * - Reveals the `messenger` if hidden. | ||
| * - Activates the support bot identified by the given `supportBotId`. | ||
| * - No action is taken if `supportBotId` is not specified. | ||
| * - Shows an error page if a support bot with the specified `supportBotId` does not exist. | ||
| * - Populates the chat input with `message` upon support bot completion if provided. | ||
| * - Caution: Utilizing this function outside a click event may cause issues in iOS Safari. | ||
| * | ||
| * @param {string} supportBotId - Identifier of the targeted support bot. | ||
| * @param {string | undefined} message - Optional message to populate the chat input field post support bot action. | ||
| * @see https://developers.channel.io/docs/web-channelio#opensupportbot | ||
| */ | ||
| export declare function openSupportBot(supportBotId: string, message?: string): void; | ||
| export interface EventProperty { | ||
@@ -251,0 +267,0 @@ [key: string]: string | number | boolean | null; |
| "use strict"; | ||
| Object.defineProperty(exports, "__esModule", { value: true }); | ||
| exports.setAppearance = exports.hideChannelButton = exports.showChannelButton = exports.resetPage = exports.setPage = exports.removeTags = exports.addTags = exports.updateUser = exports.clearCallbacks = exports.onUrlClicked = exports.onFollowUpChanged = exports.onChatCreated = exports.onBadgeChanged = exports.onHideMessenger = exports.onShowMessenger = exports.track = exports.openChat = exports.hideMessenger = exports.showMessenger = exports.shutdown = exports.boot = exports.loadScript = void 0; | ||
| exports.setAppearance = exports.hideChannelButton = exports.showChannelButton = exports.resetPage = exports.setPage = exports.removeTags = exports.addTags = exports.updateUser = exports.clearCallbacks = exports.onUrlClicked = exports.onFollowUpChanged = exports.onChatCreated = exports.onBadgeChanged = exports.onHideMessenger = exports.onShowMessenger = exports.track = exports.openSupportBot = exports.openChat = exports.hideMessenger = exports.showMessenger = exports.shutdown = exports.boot = exports.loadScript = void 0; | ||
| const isSSR = typeof window === 'undefined'; | ||
@@ -127,11 +127,12 @@ /** | ||
| /** | ||
| * Opens a chat within the messenger. | ||
| * Opens a chat interface | ||
| * | ||
| * - For an empty chatId, a new chat is opened. Any provided message appears in the chat input. If the support bot is active, it will initiate. | ||
| * - If a chat with the provided chatId exists, that chat will open, and any message will be ignored. | ||
| * - If a chat doesn't exist, the home is opened. | ||
| * - Note: Using this function outside a click event handler may lead to issues on iOS Safari. | ||
| * - Reveals the `messenger` if hidden. | ||
| * - For an undefined `chatId`, a new chat is created. Any provided `message` populates the chat input. The support bot initializes if active. | ||
| * - If a chat with the given `chatId` exists, the chat will open, and the `message` parameter will be disregarded. | ||
| * - If no matching chat exists, the `home` view opens. | ||
| * - Caution: Utilizing this function outside a click event may cause issues in iOS Safari. | ||
| * | ||
| * @param {string | number | undefined} chatId - The ID of the chat to open. | ||
| * @param {string | undefined} message - Message to appear in the chat input. | ||
| * @param {string | number | undefined} chatId - ID of the chat to reveal. | ||
| * @param {string | undefined} message - Optional text to populate the chat input field. | ||
| * @see https://developers.channel.io/docs/web-channelio#openchat | ||
@@ -152,2 +153,28 @@ */ | ||
| /** | ||
| * Initiates a chat by triggering a specified support bot. | ||
| * | ||
| * - Reveals the `messenger` if hidden. | ||
| * - Activates the support bot identified by the given `supportBotId`. | ||
| * - No action is taken if `supportBotId` is not specified. | ||
| * - Shows an error page if a support bot with the specified `supportBotId` does not exist. | ||
| * - Populates the chat input with `message` upon support bot completion if provided. | ||
| * - Caution: Utilizing this function outside a click event may cause issues in iOS Safari. | ||
| * | ||
| * @param {string} supportBotId - Identifier of the targeted support bot. | ||
| * @param {string | undefined} message - Optional message to populate the chat input field post support bot action. | ||
| * @see https://developers.channel.io/docs/web-channelio#opensupportbot | ||
| */ | ||
| function openSupportBot(supportBotId, message) { | ||
| if (isSSR) { | ||
| console.error('openSupportBot is only executable on browser.'); | ||
| return; | ||
| } | ||
| if (!window.ChannelIO) { | ||
| console.error('ChannelIO is not loaded. Please call loadScript() before openSupportBot().'); | ||
| return; | ||
| } | ||
| window.ChannelIO('openSupportBot', supportBotId, message); | ||
| } | ||
| exports.openSupportBot = openSupportBot; | ||
| /** | ||
| * Tracks user event. | ||
@@ -154,0 +181,0 @@ * |
| { | ||
| "name": "@channel.io/channel-web-sdk-loader", | ||
| "version": "1.0.0", | ||
| "version": "1.1.0", | ||
| "description": "Channel Web SDK Loader for web", | ||
@@ -5,0 +5,0 @@ "main": "dist/index.js", |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by4.42%
51694
- Lines of code
- increased by4.97%
908
No dependency changes