@formio/uag-js 2.0.0-rc.7 → 2.0.0-rc.8

package/README.md

@@ -13,23 +13,25 @@ Formio.use(UAG('https://uag.example.com'));
 Formio.createForm(document.getElementById('claim'), 'https://forms.example.com/myproject/claim');
 ```
 
+Without a bundler, load the UAG's own `https://uag.example.com/uag-js/uag.use.js` (and `uag-js.css`) after formio.js: it registers itself with that UAG and its modules' components. See [Or load it from the UAG](https://ai.form.io/developers/renderer#or-load-it-from-the-uag).
+
 Requests to the UAG carry the user's Form.io token (`x-jwt-token`), as formio.js sends it to Form.io; no other token is needed. Routing in the browser is not a security boundary: protect the fields an agent owns on the server, with an agent role, form permissions and `uagAuthoritative`.
 
 ## AI Document
 
-The **AI Document** component (`uagdocument`) is a UAG module: it comes with `@formio/uag-extras/modules/ai-document`, not with this package. A UAG that uses the module adds the component to `/uag-js/uag.use.js` and the portal script; an application with a bundler registers it after this package: `Formio.use(UAG(url)); Formio.use(aiDocument);`. It builds on `client`, below.
+The **AI Document** component (`uagdocument`) is a UAG module from [`@formio/uag-extras`](https://github.com/formio/uag-extras) (`npm install @formio/uag-extras@^1`), not from this package. A UAG that uses the module adds the component to its `/uag-js/uag.use.js`; an application with a bundler registers it after this package:
 
-## For components: `client`
+```js
+import aiDocument from '@formio/uag-extras/modules/ai-document/client';
+Formio.use(UAG('https://uag.example.com'));
+Formio.use(aiDocument);
+```
+
+See [AI Document](https://ai.form.io/developers/ai-document).
 
-Once `Formio.use(UAG(url))` has run, `client` (also `FormioUAG.client` and `UAG.client`) is the API that components of UAG modules build on, stable within a major version:
+## For components: `client`
 
-| Member | What it gives |
-|---|---|
-| `url()`, `token(form?)`, `headers(form?)` | The UAG's URL, the user's Form.io token, and the headers that identify the user to the UAG. |
-| `formUrl(definition)` | A form's URL on the UAG, from its definition or a rendered form. |
-| `ready`, `loaded`, `plugins(type?)`, `plugin(type, name)` | The installed plugins (`document`, `converter`, `module`), embedded by the UAG's scripts or fetched with the user's token. |
-| `stream(url, body, { onEvent, signal, form })` | POST JSON, accepting server-sent events: every event goes to `onEvent`; it resolves with the `done` event's data (or the JSON answer), and rejects with the UAG's message, `status` and `code`. |
-| `renderMarkdown(text)`, `escapeHtml(text)` | Markdown as the UAG sanitizes it, rendered with every text escaped. |
+Once the UAG is registered, `client` (also `Formio.uagClient`, `FormioUAG.client` and `UAG.client`) is the browser API that components of UAG modules build on, stable within a major version: the UAG's URL, the user's token and headers, a form's URL on the UAG, the installed plugins, `stream()` for module routes, and Markdown rendering.
 
 ```js
 import { client } from '@formio/uag-js';
@@ -37,6 +39,8 @@ await client.ready;
 const done = await client.stream(client.formUrl(form) + '/document/process', { path, files }, { onEvent: (name, data) => {} });
 ```
 
+Every member, and how `stream()` resolves and rejects: [For module components: `client`](https://ai.form.io/developers/renderer#for-module-components-client).
+
 ## Chat
 
 Any form tagged `uag` can also be rendered as a chat, the way `Formio.createForm` renders it as a form. A person describes what they need; the chat asks for what is still missing and fills the form behind it, which validates and submits through the UAG once they confirm. Each turn is the form's `{form}/agent/chat` on the UAG, so there is no model code and no server of your own, and it needs no Agentic Formflow license (the UAG needs an agent engine).
@@ -44,7 +48,7 @@ Any form tagged `uag` can also be rendered as a chat, the way `Formio.createForm
 ```js
 Formio.use(UAG('https://uag.example.com'));
 
-const chat = await Formio.createChat(document.getElementById('help'), 'https://forms.example.com/myproject/servicerequest', {
+const chat = await Formio.createChat(document.getElementById('help'), 'https://forms.example.com/myproject/service-request', {
   suggestions: ['My internet is down'],
   markdown: (text) => marked.parse(text)   // optional; the output is sanitized
 });

package/index.d.ts

@@ -189,11 +189,10 @@ export interface ChatForm {
 export interface UAGOptions extends Omit<AttachOptions, 'uagUrl' | 'formUrl'> {
     /** `false` attaches no Agent Input anywhere; submissions of `uag` forms still go to the UAG. */
     agentInput?: boolean;
-    /** AI Document options. `auto`: process files on upload unless a component turns it off (default true). */
-    documents?: { auto?: boolean };
     /**
-     * Portal mode (the UAG's portal script): register only the AI Document
-     * component and the manifest. Saves are not routed and Agent Input is not run.
+     * Portal mode, used by the UAG's portal script: registers only the client
+     * and the manifest, for the modules' components. Saves are not routed, and
+     * neither Agent Input nor the chat is registered.
      */
     portal?: boolean;
     /** The installed plugins, as `GET {project}/plugins` describes them. Fetched at registration when not given. */
@@ -328,5 +327,7 @@ declare const uag: {
     SSEParser: typeof SSEParser;
     isEmpty: typeof isEmpty;
     CHAT_TEMPLATES: typeof CHAT_TEMPLATES;
+    renderMarkdown: typeof renderMarkdown;
+    client: typeof client;
 };
 export default uag;

package/index.js

@@ -734,7 +734,7 @@
      * The chat: a formio.js display that renders a form as a conversation.
      *
      *   Formio.use(UAG('https://uag.example.com'));
-     *   Formio.createChat(element, 'https://forms.example.com/myproject/servicerequest');
+     *   Formio.createChat(element, 'https://forms.example.com/myproject/service-request');
      *
      * Each message the person sends goes to the form's chat on the UAG
      * (`{form}/agent/chat`) with the conversation and the form's data; the

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@formio/uag-js",
-  "version": "2.0.0-rc.7",
+  "version": "2.0.0-rc.8",
   "description": "The Form.io UAG for formio.js applications: register it once, and forms tagged \"uag\" save through the UAG and get Agent Input, without overwriting what the user entered.",
   "keywords": [
     "formio",
@@ -30,7 +30,6 @@
     "index.mjs",
     "index.d.ts",
     "uag-js.css",
-    "uag.use.js",
     "README.md",
     "LICENSE.txt"
   ],

package/uag.use.js

@@ -1,25 +0,0 @@
-/**
- * @formio/uag-js for a page without a bundler. Load it after formio.js and
- * this package's index.js, from the UAG it should talk to:
- *
- *   <script src="https://cdn.form.io/js/formio.full.min.js"></script>
- *   <script src="https://uag.example.com/uag-js/uag.use.js"></script>
- *
- * The UAG serves this file at /uag-js/uag.use.js with the bundle and its
- * manifest included. On its own, it registers FormioUAG (index.js) with the
- * UAG it was loaded from, read from its own src, and fetches the manifest.
- */
-(function () {
-    var script = document.currentScript;
-    var src = script && script.src ? new URL(script.src, location.href) : null;
-    var uagUrl = src && src.href.indexOf('/uag-js/') !== -1 ? src.href.slice(0, src.href.indexOf('/uag-js/')) : (src ? src.origin : location.origin);
-    function register() {
-        if (!window.Formio || !window.FormioUAG || typeof window.Formio.use !== 'function') return false;
-        window.Formio.use(window.FormioUAG.UAG(uagUrl));
-        return true;
-    }
-    if (!register()) {
-        var tries = 0;
-        var timer = setInterval(function () { if (register() || ++tries > 600) clearInterval(timer); }, 50);
-    }
-})();