@inploi/plugin-chatbot 14.13.3 → 14.15.0

package/README.md

@@ -0,0 +1,31 @@
+# @inploi/plugin-chatbot
+
+The legacy chatbot renders application flows with the shared application engine.
+It needs `@inploi/sdk` 2.4.0 or later (peer dependency): the npm build imports
+the shared alert contract from the SDK at runtime.
+Register `chatbotPlugin({ theme: { hue: 260, mode: 'light' } })`, then pass the
+result of `fetchFlowByJobId` or `fetchFlowById` to `open`.
+
+`fetchFlowByJobId` retains optional API context in `jobContext`; flow nodes read it
+merged beneath the host's `context`, recursively, including `job.custom_data`.
+Explicit host values win, and undefined host values preserve served values.
+Saved application keys continue to use only host context, including when a host
+replaces `context` after fetching the flow.
+
+Set optional `jobAlerts: true` on plugin initialisation to offer email alerts
+beneath a semantic submission-closed notice when an email answer is available.
+The default is off. `open` and the fetch helpers accept `jobAlerts` too; an
+explicit per-application value overrides initialisation, including `false`.
+Fetch-flow errors never show the offer.
+
+Only Get job alerts saves a weekly search. The offer uses the canonical `email`
+answer, falling back to an authored email-format text question, and optional
+`first_name`/`last_name` answers. On acceptance, known jobs are looked up and their
+identity verified before their available city, town and category filters are saved.
+A failed lookup or save shows an error. Missing job metadata permits a partial
+or company-wide search; No thanks sends nothing. One offer per application keeps
+its in-memory choice and pending save across closing, reopening and Undo in the
+same application session. A fresh application gets a fresh offer.
+
+Copy is defined in the English dictionary in `src/i18n.ts` and can be overridden
+through the existing `terms` option. This package has no locale dictionaries.