@dinghy-chat/widget 0.28.0 → 0.29.0

package/README.md

@@ -21,7 +21,7 @@ const dinghy = init({ url: "https://chat.example.com", key: "YOUR_PUBLIC_KEY" })
 dinghy.on("unread", (count) => console.log(count));
 ```
 
-`init` adds the tag once and returns the typed `Dinghy` object. Calls made before the script loads wait for it. It takes `url`, `key`, and `primary`, `accent`, `mascot`, `branding`, `launcher`, `position`, `offsetX`, `offsetY` and `zIndex`.
+`init` adds the tag once and returns the typed `Dinghy` object. Calls made before the script loads wait for it. It takes `url`, `key`, and `primary`, `accent`, `mascot`, `branding`, `launcher`, `position`, `offsetX`, `offsetY`, `zIndex` and `locale`.
 
 ## Attributes
 
@@ -34,6 +34,7 @@ dinghy.on("unread", (count) => console.log(count));
 | `data-position="left"`   | Puts the launcher and the chat on the left. The default is `right`.                         |
 | `data-offset-x="24"`     | Pixels from the side of the window. The default is `16`.                                    |
 | `data-offset-y="80"`     | Pixels from the bottom of the window. The default is `16`.                                  |
+| `data-locale="fr"`       | The widget's language: `en`, `fr` or `es`, over the workspace's Language setting.           |
 
 The widget ignores a value in any other format. The boat stops moving for a visitor who asks for reduced motion.
 
@@ -41,17 +42,17 @@ Set `--dinghy-font`, `--dinghy-radius` and `--dinghy-launcher-radius` on the `di
 
 ## Host page API
 
-| Call                                | What it does                                                                                                    |
-| ----------------------------------- | --------------------------------------------------------------------------------------------------------------- |
-| `Dinghy.open({ message })`          | Opens the chat. `message` is optional and fills the message box without sending it                              |
-| `Dinghy.close()`, `Dinghy.toggle()` | Closes the chat, or opens it if it is closed                                                                    |
-| `Dinghy.show()`, `Dinghy.hide()`    | Shows or hides the launcher                                                                                     |
-| `Dinghy.identify(token)`            | Signs in a user. `token` is a string, or a function that returns a promise of one, so a tab can renew a token   |
-| `Dinghy.reset()`                    | Ends the session in all tabs. Call this at sign-out                                                             |
-| `Dinghy.setContext(data)`           | Unsigned facts for operators, such as a plan. Up to 20 keys, each a short string, a number, a boolean or `null` |
-| `Dinghy.configure(options)`         | Changes `primary`, `accent`, `position`, `offsetX`, `offsetY` and `zIndex` now                                  |
-| `Dinghy.on(event, callback)`        | Calls `callback` on each event, and returns a function that removes it                                          |
-| `Dinghy.state`                      | `{ ready, open, unread }`                                                                                       |
+| Call                                | What it does                                                                                                       |
+| ----------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
+| `Dinghy.open({ message })`          | Opens the chat. `message` is optional and fills the message box without sending it                                 |
+| `Dinghy.close()`, `Dinghy.toggle()` | Closes the chat, or opens it if it is closed                                                                       |
+| `Dinghy.show()`, `Dinghy.hide()`    | Shows or hides the launcher                                                                                        |
+| `Dinghy.identify(token)`            | Signs in a user. `token` is a string, or a function that returns a promise of one, so a tab can renew a token      |
+| `Dinghy.reset()`                    | Ends the session in all tabs. Call this at sign-out                                                                |
+| `Dinghy.setContext(data)`           | Unsigned facts for operators, such as a plan. Up to 20 keys, each a short string, a number, a boolean or `null`    |
+| `Dinghy.configure(options)`         | Changes `primary`, `accent`, `position`, `offsetX`, `offsetY` and `zIndex` now, and `locale` before the chat opens |
+| `Dinghy.on(event, callback)`        | Calls `callback` on each event, and returns a function that removes it                                             |
+| `Dinghy.state`                      | `{ ready, open, unread }`                                                                                          |
 
 The events are `ready`, `open`, `close`, `unread` (the count, at once and on each change), `message:sent` and `message:received` (`{ body }`) and `conversation:started`.
 
@@ -75,7 +76,7 @@ connect-src https://chat.example.com;
 img-src https://chat.example.com;
 ```
 
-If your Dinghy serves images from a separate origin (`IMAGES_ORIGIN`), allow that origin in `img-src` too.
+If your Dinghy serves images and files from a separate origin (`UPLOADS_ORIGIN`), allow that origin in `img-src` and `connect-src` too, as the chat fetches a file to save it.
 
 The widget needs no `style-src` change, because it uses constructable stylesheets and the CSSOM.
 

package/dist/index.js

@@ -60,7 +60,8 @@ function init(options) {
     ["offset-y", options.offsetY],
     ["mascot", options.mascot === void 0 ? void 0 : String(options.mascot)],
     ["branding", options.branding === void 0 ? void 0 : String(options.branding)],
-    ["launcher", options.launcher === false ? "hidden" : void 0]
+    ["launcher", options.launcher === false ? "hidden" : void 0],
+    ["locale", options.locale]
   ];
   for (const [name, value] of attributes) {
     if (value !== void 0) script.setAttribute(`data-${name}`, String(value));

package/dist/shared.d.ts

@@ -6,6 +6,12 @@ export interface OpenOptions {
     /** Fills the message box. The visitor still sends it. */
     message?: string;
 }
+/**
+ * The languages the widget speaks. English is in the chat bundle, and each other one is a file
+ * beside it.
+ */
+export declare const LOCALES: readonly ["en", "fr", "es"];
+export type Locale = (typeof LOCALES)[number];
 /** What `configure` and the script tag's data attributes change. Invalid values are ignored. */
 export interface Appearance {
     /** A six-digit hex color, such as `#0b2239`. */
@@ -16,6 +22,8 @@ export interface Appearance {
     offsetX?: number;
     offsetY?: number;
     zIndex?: number;
+    /** A language the widget speaks, such as `fr`, over the saved one. Set it before the chat opens. */
+    locale?: string;
 }
 /** What an owner saves in the operator app's Widget tab. Null texts and colors mean the widget's own. */
 export interface WidgetSettings {
@@ -39,6 +47,8 @@ export interface WidgetSettings {
     sound: boolean;
     /** The visitor gets the conversation by email when it closes. The widget does not use it. */
     transcript: boolean;
+    /** Visitors may send files as well as images. */
+    visitorFiles: boolean;
     /** Whose faces the header shows. `online` falls back to the latest repliers when nobody is. */
     headerFaces: "online" | "repliers" | "chosen" | "none";
     /** How many faces, 1 to HEADER_FACES_MAX. */
@@ -47,6 +57,11 @@ export interface WidgetSettings {
     headerDot: boolean;
     /** Under the title while someone is online: "Online", or the usual reply time. */
     headerStatus: "presence" | "reply_time";
+    /**
+     * The widget's own words in one language, or `visitor` for the first of the browser's languages
+     * that the widget speaks. The team's own texts stay as written.
+     */
+    language: "visitor" | Locale;
 }
 /** A member the widget's header shows: a first name and a picture, never an email. */
 export interface TeamFace {
@@ -56,6 +71,19 @@ export interface TeamFace {
     name: string;
     pictureUrl: string | null;
 }
+/** The days of the week, in the order the settings list them. */
+export declare const WEEKDAYS: readonly ["mon", "tue", "wed", "thu", "fri", "sat", "sun"];
+export type Weekday = (typeof WEEKDAYS)[number];
+/** The most opening ranges one day holds. */
+export declare const DAY_RANGES_MAX = 3;
+/**
+ * When the team answers: each day's ranges, such as `["09:00", "18:00"]`, in order and apart, in
+ * the workspace's IANA time zone. A range may end at "24:00". A day with none is closed.
+ */
+export interface BusinessHours {
+    timeZone: string;
+    week: Record<Weekday, [string, string][]>;
+}
 /** The saved settings, as the widget's appearance route answers them. */
 export interface SavedAppearance extends WidgetSettings {
     /** The chat sends the visitor's unsent words, so operators see them as they type. */
@@ -68,6 +96,8 @@ export interface SavedAppearance extends WidgetSettings {
      * members online now, the latest repliers for `repliers`, the chosen members for `chosen`.
      */
     faces: TeamFace[];
+    /** Null while business hours are off, so the widget follows presence alone. */
+    hours: BusinessHours | null;
 }
 /** The longest title an owner can save. */
 export declare const TITLE_MAX = 40;
@@ -173,7 +203,10 @@ export interface WidgetContext {
     shadow: ShadowRoot;
     /** The saved settings, which the loader asked for. See loadAppearance. */
     appearance: Promise<SavedAppearance | null | undefined>;
-    /** Reads the tag's data attributes by dataset name, such as `mascot`. They win over the saved settings. */
+    /**
+     * Reads the tag's data attributes by dataset name, such as `mascot`, and the values configure()
+     * set. They win over the saved settings.
+     */
     attribute(name: string): string | undefined;
     /** The full-page chat that a reply email opens, on the Dinghy server's own origin. */
     page?: boolean;
@@ -206,6 +239,39 @@ export declare function rememberOpen(publicKey: string, open: boolean): void;
 export declare function forgetVisitor(publicKey: string): void;
 /** The longest message, in characters: the composers' limit, which the server checks too. */
 export declare const MESSAGE_MAX = 10000;
+/** The most members one note mentions, which the operator app keeps to and the server checks. */
+export declare const MENTIONS_MAX = 10;
+/** The longest saved reply shortcut, in characters, where the form's field stops. */
+export declare const SAVED_REPLY_SHORTCUT_MAX = 32;
+/**
+ * A saved reply's shortcut, what follows `/` in the composer. The form, the server and the database
+ * check it.
+ */
+export declare const SAVED_REPLY_SHORTCUT: RegExp;
+/**
+ * The limits of saved replies, labels and bulk changes. The server and the database check them, and
+ * the operator app keeps to them and names them in its texts.
+ */
+export declare const SAVED_REPLIES_MAX = 200;
+export declare const SAVED_REPLY_BODY_MAX = 5000;
+export declare const LABELS_MAX = 100;
+export declare const LABEL_NAME_MAX = 40;
+/** The most conversations one bulk change takes. */
+export declare const BULK_MAX = 100;
+/**
+ * The longest two-step sign-in code the server takes once spaces are gone, well above a recovery
+ * code's 19 characters with its dashes. The operator app's field stops there, so a code typed with
+ * spaces always fits.
+ */
+export declare const TWO_FACTOR_CODE_MAX = 40;
+/**
+ * The rules of a request to remove two-step sign-in, which the server applies and the operator app
+ * names: the wait before it completes, how long a cancel blocks a new request, and how recent the
+ * email link of the session that asks must be.
+ */
+export declare const TWO_FACTOR_REMOVAL_WAIT_HOURS = 72;
+export declare const TWO_FACTOR_REMOVAL_BLOCK_DAYS = 7;
+export declare const TWO_FACTOR_REMOVAL_FRESH_MINUTES = 15;
 /**
  * A bot repeats its typing notice while it writes, so one that stops repeating has stopped: the
  * chat and the operator app drop it after this long with no update.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dinghy-chat/widget",
-  "version": "0.28.0",
+  "version": "0.29.0",
   "description": "Add the Dinghy chat to your site from code, with a typed API.",
   "type": "module",
   "license": "MIT",