Custumu

Description

Custumu shows the chat widget on the public pages of your site. After you activate the plugin, open Settings → Custumu and paste the public key from your dashboard.

The chat script in assets/widget.js is a compiled file. The human-readable source that produces it is included in the source directory of this plugin. The comment at the top of assets/widget.js names each bundled library, its version, its license, and its public repository.

Source code

assets/widget.js is built with Vite from the files in `source`. The widget entry is `source/widget`. The shared chat components it imports are `source/src/components` and `source/src/lib`.

To regenerate assets/widget.js, assets/emojibase, and source from the Custumu project:

1. Install Node.js and npm.
2. Run npm install.
3. Run npm run build:widget.

That command builds the widget and copies assets/widget.js, the emoji data, and the human-readable source into this plugin.

Third-party code included in assets/widget.js:

• React and React DOM — MIT — https://github.com/react/react
• frimousse — MIT — https://github.com/liveblocks/frimousse
• lucide-react — ISC — https://github.com/lucide-icons/lucide
• react-markdown — MIT — https://github.com/remarkjs/react-markdown
• remark-gfm — MIT — https://github.com/remarkjs/remark-gfm
• remark-breaks — MIT — https://github.com/remarkjs/remark-breaks

Emoji names and keywords come from Emojibase — MIT — https://github.com/milesj/emojibase

Those files are stored in this plugin at assets/emojibase/es/data.json and assets/emojibase/es/messages.json. The chat loads them from the plugin directory.

External services

This plugin connects to the Custumu API at https://api.custumu.com to show the chat on the public pages of the site and to let visitors talk with the business assistant.

It sends the site’s public key when the page loads, to fetch the widget settings (name, color, welcome message, and logo address).

When a visitor opens the chat, it sends that public key and a visitor identifier stored in the browser. When the visitor writes, it sends the message text, the address of the page, and the visitor’s timezone. When the visitor opens an earlier conversation, it sends the public key, the visitor identifier, and the conversation identifier. When the visitor rates a closed conversation, it sends the score and an optional comment.

The logo, when the business has set one, is the image address returned by this API.

This service is provided by “Custumu”: terms of use, privacy policy.