@elicitkit/renderers 0.1.0

package/dist/tui.js

@@ -0,0 +1,89 @@
+/**
+ * `tui` tier — the universal sink the spec guarantees for every type
+ * (SPEC §4/§7). When no UI surface exists the agent reads this back and
+ * collects answers in conversation, then calls `elicit_submit`. Never
+ * hard-fails; this is why every type must define a text degradation.
+ */
+export function renderTui(set, token) {
+    const lines = [
+        "Elicitkit needs input. Answer each item, then call",
+        `elicit_submit with token "${token}" and an answers array.`,
+        "",
+    ];
+    set.asks.forEach((ask, i) => {
+        lines.push(`[${i + 1}] (${ask.type}) ${ask.prompt}`);
+        if (ask.help)
+            lines.push(`    ${ask.help}`);
+        lines.push(...detail(ask).map((l) => `    ${l}`));
+        lines.push(`    -> answer: { "id": "${ask.id}", "type": "${ask.type}", "status": "answered", "value": ... }`);
+        lines.push("");
+    });
+    return { tier: "tui", text: lines.join("\n") };
+}
+function detail(ask) {
+    switch (ask.type) {
+        case "ask_text":
+            return [`free text${ask.spec.multiline ? " (multiline)" : ""}`];
+        case "ask_confirm":
+            return [
+                `${ask.spec.affirm ?? "Yes"} / ${ask.spec.deny ?? "No"}` +
+                    (ask.spec.consequence ? ` - consequence: ${ask.spec.consequence}` : ""),
+                `value: boolean`,
+            ];
+        case "ask_select":
+            return [
+                ...ask.spec.options.map((o) => `- ${o.id}: ${o.label}${o.description ? ` - ${o.description}` : ""}`),
+                `value: ${ask.spec.multiple ? "string[] of ids" : "one id"}`,
+            ];
+        case "ask_code_diff":
+            return [
+                ...ask.spec.files.flatMap((f) => [
+                    `file ${f.path}`,
+                    ...f.hunks.map((h) => `  hunk ${h.id}${h.header ? `: ${h.header}` : ""}`),
+                ]),
+                `value: { "accepted": [hunkId...], "rejected": [hunkId...] }`,
+            ];
+        case "ask_number": {
+            const s = ask.spec ?? {};
+            const r = [
+                s.min != null ? `min ${s.min}` : null,
+                s.max != null ? `max ${s.max}` : null,
+                s.step != null ? `step ${s.step}` : null,
+                s.unit ? `unit ${s.unit}` : null,
+                s.integer ? "integer" : null,
+            ].filter(Boolean);
+            return [`number${r.length ? ` (${r.join(", ")})` : ""}`, `value: number`];
+        }
+        case "ask_slider":
+            return [
+                `slider ${ask.spec.min}..${ask.spec.max}${ask.spec.step ? ` step ${ask.spec.step}` : ""}${ask.spec.unit ? ` ${ask.spec.unit}` : ""}`,
+                `value: number in [${ask.spec.min}, ${ask.spec.max}]`,
+            ];
+        case "ask_rating": {
+            const max = ask.spec?.max ?? 5;
+            return [`rate 1..${max}`, `value: integer in [1, ${max}]`];
+        }
+        case "ask_date":
+            return [
+                ask.spec?.time ? "date + time" : "date",
+                `value: "${ask.spec?.time ? "YYYY-MM-DDTHH:MM" : "YYYY-MM-DD"}"`,
+            ];
+        case "ask_rank":
+            return [
+                ...ask.spec.items.map((i) => `- ${i.id}: ${i.label}`),
+                `value: [${ask.spec.items.map((i) => `"${i.id}"`).join(", ")}] in ranked order`,
+            ];
+        case "ask_color": {
+            const pal = ask.spec?.palette ?? [];
+            return [
+                pal.length
+                    ? `palette: ${pal.join(", ")}${ask.spec?.allowCustom ? " (or a custom color)" : ""}`
+                    : "any CSS color",
+                `value: a CSS color string (e.g. "#1d4ed8")`,
+            ];
+        }
+        default:
+            return [];
+    }
+}
+//# sourceMappingURL=tui.js.map

package/dist/tui.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tui.js","sourceRoot":"","sources":["../src/tui.ts"],"names":[],"mappings":"AAGA;;;;;GAKG;AACH,MAAM,UAAU,SAAS,CAAC,GAAW,EAAE,KAAa;IAClD,MAAM,KAAK,GAAa;QACtB,oDAAoD;QACpD,6BAA6B,KAAK,yBAAyB;QAC3D,EAAE;KACH,CAAC;IAEF,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE;QAC1B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;QACrD,IAAI,GAAG,CAAC,IAAI;YAAE,KAAK,CAAC,IAAI,CAAC,OAAO,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;QAC5C,KAAK,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;QAClD,KAAK,CAAC,IAAI,CACR,2BAA2B,GAAG,CAAC,EAAE,eAAe,GAAG,CAAC,IAAI,yCAAyC,CAClG,CAAC;QACF,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC,CAAC,CAAC;IAEH,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;AACjD,CAAC;AAED,SAAS,MAAM,CAAC,GAAQ;IACtB,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC;QACjB,KAAK,UAAU;YACb,OAAO,CAAC,YAAY,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAClE,KAAK,aAAa;YAChB,OAAO;gBACL,GAAG,GAAG,CAAC,IAAI,CAAC,MAAM,IAAI,KAAK,MAAM,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,EAAE;oBACtD,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,mBAAmB,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBACzE,gBAAgB;aACjB,CAAC;QACJ,KAAK,YAAY;YACf,OAAO;gBACL,GAAG,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAC5E;gBACD,UAAU,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,QAAQ,EAAE;aAC7D,CAAC;QACJ,KAAK,eAAe;YAClB,OAAO;gBACL,GAAG,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;oBAC/B,QAAQ,CAAC,CAAC,IAAI,EAAE;oBAChB,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;iBAC1E,CAAC;gBACF,6DAA6D;aAC9D,CAAC;QACJ,KAAK,YAAY,CAAC,CAAC,CAAC;YAClB,MAAM,CAAC,GAAG,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC;YACzB,MAAM,CAAC,GAAG;gBACR,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,IAAI;gBACrC,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,IAAI;gBACrC,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI;gBACxC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI;gBAChC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI;aAC7B,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAClB,OAAO,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,eAAe,CAAC,CAAC;QAC5E,CAAC;QACD,KAAK,YAAY;YACf,OAAO;gBACL,UAAU,GAAG,CAAC,IAAI,CAAC,GAAG,KAAK,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE;gBACpI,qBAAqB,GAAG,CAAC,IAAI,CAAC,GAAG,KAAK,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG;aACtD,CAAC;QACJ,KAAK,YAAY,CAAC,CAAC,CAAC;YAClB,MAAM,GAAG,GAAG,GAAG,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC;YAC/B,OAAO,CAAC,WAAW,GAAG,EAAE,EAAE,yBAAyB,GAAG,GAAG,CAAC,CAAC;QAC7D,CAAC;QACD,KAAK,UAAU;YACb,OAAO;gBACL,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM;gBACvC,WAAW,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,YAAY,GAAG;aACjE,CAAC;QACJ,KAAK,UAAU;YACb,OAAO;gBACL,GAAG,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,KAAK,EAAE,CAAC;gBACrD,WAAW,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB;aAChF,CAAC;QACJ,KAAK,WAAW,CAAC,CAAC,CAAC;YACjB,MAAM,GAAG,GAAG,GAAG,CAAC,IAAI,EAAE,OAAO,IAAI,EAAE,CAAC;YACpC,OAAO;gBACL,GAAG,CAAC,MAAM;oBACR,CAAC,CAAC,YAAY,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,EAAE,EAAE;oBACpF,CAAC,CAAC,eAAe;gBACnB,4CAA4C;aAC7C,CAAC;QACJ,CAAC;QACD;YACE,OAAO,EAAE,CAAC;IACd,CAAC;AACH,CAAC"}

package/dist/url.d.ts

@@ -0,0 +1,20 @@
+import type { AskSet } from "@elicitkit/core";
+import type { RenderedPanel } from "./contract.js";
+/**
+ * `url` tier — for hosts that open an external page rather than embed UI. It
+ * is the *same* panel as `apps`, delivered as an `externalUrl` the host loads
+ * in an iframe/browser; answers post back via the same mcp-ui `tool` message.
+ *
+ * Return channel: the page yields a copy-pasteable JSON payload the user
+ * hands back to the assistant (which forwards it verbatim to `elicit_submit`).
+ * It also attempts the mcp-ui `tool` postMessage, so it is *automatic* when a
+ * host embeds it and *still works* when opened standalone in a browser — no
+ * server or signed link required for v0.1.
+ *
+ * v0.1: the page is self-contained in a `data:` URL. Task #6 may add a hosted
+ * route and Task #7 a signed one-time link, but the copy-paste channel keeps
+ * this tier fully functional in the meantime — a contained change behind this
+ * one function.
+ */
+export declare function renderUrl(set: AskSet, token: string): Promise<RenderedPanel>;
+//# sourceMappingURL=url.d.ts.map

package/dist/url.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"url.d.ts","sourceRoot":"","sources":["../src/url.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAE9C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAEnD;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAwBlF"}

package/dist/url.js

@@ -0,0 +1,40 @@
+import { createUIResource } from "@mcp-ui/server";
+import { buildPanelHtml } from "./panel.js";
+/**
+ * `url` tier — for hosts that open an external page rather than embed UI. It
+ * is the *same* panel as `apps`, delivered as an `externalUrl` the host loads
+ * in an iframe/browser; answers post back via the same mcp-ui `tool` message.
+ *
+ * Return channel: the page yields a copy-pasteable JSON payload the user
+ * hands back to the assistant (which forwards it verbatim to `elicit_submit`).
+ * It also attempts the mcp-ui `tool` postMessage, so it is *automatic* when a
+ * host embeds it and *still works* when opened standalone in a browser — no
+ * server or signed link required for v0.1.
+ *
+ * v0.1: the page is self-contained in a `data:` URL. Task #6 may add a hosted
+ * route and Task #7 a signed one-time link, but the copy-paste channel keeps
+ * this tier fully functional in the meantime — a contained change behind this
+ * one function.
+ */
+export async function renderUrl(set, token) {
+    const html = buildPanelHtml(set, token, "url");
+    const dataUrl = "data:text/html;base64," + Buffer.from(html, "utf8").toString("base64");
+    const ui = await createUIResource({
+        uri: `ui://elicitkit/round/${token}`,
+        encoding: "text",
+        content: { type: "externalUrl", iframeUrl: dataUrl },
+        metadata: { title: "Elicitkit", description: `${set.asks.length} question(s)` },
+        uiMetadata: {
+            "preferred-frame-size": ["720px", "640px"],
+            "initial-render-data": { token },
+        },
+    });
+    return {
+        tier: "url",
+        text: "Ask the user to open the linked panel and answer it. They will paste " +
+            "back a JSON payload — forward it verbatim to elicit_submit (it carries " +
+            "the round token). If the host embeds the panel, submission is automatic.",
+        ui,
+    };
+}
+//# sourceMappingURL=url.js.map

package/dist/url.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"url.js","sourceRoot":"","sources":["../src/url.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAElD,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAG5C;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,GAAW,EAAE,KAAa;IACxD,MAAM,IAAI,GAAG,cAAc,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IAC/C,MAAM,OAAO,GACX,wBAAwB,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAE1E,MAAM,EAAE,GAAG,MAAM,gBAAgB,CAAC;QAChC,GAAG,EAAE,wBAAwB,KAAK,EAAE;QACpC,QAAQ,EAAE,MAAM;QAChB,OAAO,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,SAAS,EAAE,OAAO,EAAE;QACpD,QAAQ,EAAE,EAAE,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,GAAG,GAAG,CAAC,IAAI,CAAC,MAAM,cAAc,EAAE;QAC/E,UAAU,EAAE;YACV,sBAAsB,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC;YAC1C,qBAAqB,EAAE,EAAE,KAAK,EAAE;SACjC;KACF,CAAC,CAAC;IAEH,OAAO;QACL,IAAI,EAAE,KAAK;QACX,IAAI,EACF,uEAAuE;YACvE,yEAAyE;YACzE,0EAA0E;QAC5E,EAAE;KACH,CAAC;AACJ,CAAC"}

package/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@elicitkit/renderers",
+  "version": "0.1.0",
+  "description": "Elicitkit progressive renderers — one AskSet, four tiers (apps · url · elicitation · tui). The reference rendering of the spec's 4-tier contract.",
+  "license": "Apache-2.0",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": { ".": { "types": "./dist/index.d.ts", "default": "./dist/index.js" } },
+  "files": ["dist"],
+  "scripts": { "build": "tsc -p tsconfig.json" },
+  "dependencies": {
+    "@elicitkit/core": "workspace:*",
+    "@mcp-ui/server": "^6.1.0"
+  },
+  "publishConfig": { "access": "public" }
+}