@elicitkit/spec 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 the Elicitkit authors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/SPEC.md

@@ -0,0 +1,215 @@
+# Elicitkit Question Spec — v0.1 (Draft)
+
+_Private working draft. Gitignored. Status: **Draft**, 2026-05-16. The spec is the product; the MCP server is its reference implementation._
+
+Key words **MUST**, **SHOULD**, **MAY** per RFC 2119.
+
+---
+
+## 1. Versioning
+
+- The spec is **SemVer**'d. Every payload carries `specVersion` (e.g. `"0.1.0"`).
+- Unknown **minor** additions MUST be ignored by older clients, not rejected (forward-compatible).
+- A breaking change is a **major** bump. The v0.1 envelope reserves fields (§4) precisely so the asking-intelligence layer ships later as a **minor**, never a major.
+
+## 2. Core model
+
+Three objects only:
+
+- **Ask** — one question (§3).
+- **AskSet** — an ordered batch of Asks with optional branching (§6).
+- **Answer** — the typed response contract (§5).
+
+## 3. The Ask envelope
+
+Every Ask, regardless of type, is:
+
+```jsonc
+{
+  "id": "string",                 // unique within the AskSet
+  "type": "ask_text | ask_select | ask_confirm | ask_code_diff | ...",
+  "prompt": "string",             // the question, plain text
+  "help": "string?",              // optional clarifying detail
+  "required": true,               // default true
+  "spec": { "...type-specific..." },
+
+  // ── Reserved hooks (v0.1 inert; populated in a later MINOR) ──
+  "agentGuess": "any?",           // the agent's proposed answer
+  "confidence": 0.0,              // 0–1; enables confidence-gated auto-accept
+  "memoryKey": "string?",         // stable key for answer-memory / auto-skip
+  "meta": {
+    "specVersion": "0.1.0",
+    "minTier": "tui"              // lowest render tier that is still faithful
+  }
+}
+```
+
+A type-aware renderer reads `type` + `spec`; a dumb renderer can always fall back to `prompt` + free text.
+
+## 4. Render tiers (progressive fallback)
+
+`tier ∈ { "apps", "url", "elicitation", "tui" }`, richest → poorest.
+
+- The host advertises `supportedTiers`. The server picks the **richest tier ≥ the Ask's `meta.minTier`** that the host supports.
+- Every type MUST define behaviour for **all four** tiers (degradation is part of the type definition, not an afterthought). A type that cannot degrade below `url` MUST set `minTier: "url"` and provide a text-summary fallback so it never hard-fails.
+
+### 4.1 Non-blocking contract (uniform across tiers)
+
+Every elicit tool call MUST return in less than the host's per-call MCP timeout (≪ 1 s server-side, bounded by **one** user answer at most on the elicitation tier). This is achieved by surfacing a **pending envelope** the agent drives forward across multiple tool calls:
+
+| Tool | Behaviour |
+|---|---|
+| `elicit(askSet, supportedTiers?)` | Returns fast. Shape: `{ pending: true, token, tier, ...tierContext }` with `_meta.elicitkit` carrying `renderedTier`, `hostTiers`, and (when the slow-ask auto-router fires) `routedAwayFromElicitation: true` plus a `routeReason`. The elicitation tier issues the FIRST native `elicitInput` inline and awaits ONE answer before returning. |
+| `elicit_next(token)` | **Elicitation tier only.** Issues the next `elicitInput`, awaits one user answer, returns `{ pending: true, token, completed, total }` or final `{ pending: false, answers }`. Other tiers complete via `elicit_submit` instead. |
+| `elicit_submit(token, answers)` | Panel tiers (`tui` / `url` / `apps`). Validates and completes the round. |
+
+Per-tier flow:
+
+- **tui** — `elicit` returns AskSet + token; agent presents in chat; agent calls `elicit_submit`.
+- **elicitation** — `elicit` opens the round, fires `elicitInput` for ask 1, awaits ONE answer, returns `{ pending, token, completed: 1, total: N }`. Agent calls `elicit_next(token)` per remaining ask. The final call returns `{ pending: false, answers }`.
+- **url** — `elicit` returns `{ pending, token, panelUrl }` IMMEDIATELY. Panel POSTs to `/elicit/submit` OR the user copy-pastes JSON back → agent forwards verbatim to `elicit_submit`.
+- **apps** — `elicit` returns `{ pending, token, panelUri }` IMMEDIATELY. mcp-ui widget posts back → agent forwards to `elicit_submit`.
+
+### 4.2 Slow-ask auto-router (normative)
+
+Before negotiating tiers, the server inspects the AskSet for asks that are likely to exceed the per-call MCP timeout when issued one-question-at-a-time through the native elicitation primitive. If any such ask is present the server MUST drop `elicitation` from the candidate tier list and surface `_meta.elicitkit.routedAwayFromElicitation: true` with a `routeReason` naming the rule that fired. The agent does not choose tiers manually.
+
+| Trigger | Reason |
+|---|---|
+| `ask_text` with `multiline: true` OR `maxLen >= 200` (or `maxLen` unset) | Long typing time |
+| `ask_code_diff` with > 2 hunks total across all files | Hunk-by-hunk review needs thought |
+| `ask_rank` with > 4 items | Ordering > 4 takes thought |
+
+Quick asks pass through to elicitation: `ask_select` (≤ 8 options), `ask_confirm`, `ask_number`, `ask_rating`, `ask_slider`, `ask_date`, `ask_color`, short `ask_text`. Future composite types (`ask_form`, `ask_table`) reserve the rule slot.
+
+## 5. Answer contract
+
+```jsonc
+{
+  "id": "string",                 // echoes the Ask id
+  "type": "string",
+  "status": "answered | declined | deferred",
+  "value": "any",                 // shape defined per type (§7); null unless answered
+  "meta": { "tier": "apps", "specVersion": "0.1.0" }
+}
+```
+
+- Servers MUST validate `value` against the type's schema and **re-ask** on invalid (max retries configurable).
+- `declined` and `deferred` are first-class — agents MUST handle "the human chose not to answer."
+
+## 6. AskSet (batch + branching)
+
+```jsonc
+{
+  "specVersion": "0.1.0",
+  "asks": [ Ask, ... ],
+  "edges": []                     // RESERVED v0.1: conditional branching (minor add)
+}
+```
+
+v0.1 renders `asks` in order in one panel where the tier allows (one round-trip). `edges` is reserved so question-graphs are a later minor.
+
+## 7. v0.1 type catalog
+
+Ten types are normative — the four-type wedge (§7.1–7.4) plus numeric / temporal / ordinal / color breadth (§7.5–7.10). Each defines behaviour for all four tiers; an unlisted `type` is a forward-compatible MINOR addition older clients ignore.
+
+### 7.1 `ask_text`
+`spec`: `{ multiline?: bool, placeholder?: str, pattern?: regex, maxLen?: int }` · `value`: `string`
+Tiers: apps/url = input; elicitation = string primitive; tui = prompt.
+
+### 7.2 `ask_select`
+`spec`: `{ options: [{id, label, description?}], multiple?: bool, min?, max? }` · `value`: `id | id[]`
+Tiers: apps/url = styled list; elicitation = enum; tui = arrow-select.
+
+### 7.3 `ask_confirm`
+`spec`: `{ affirm?: str="Yes", deny?: str="No", consequence?: str }` · `value`: `boolean`
+`consequence` renders as a "what will happen" preview where the tier allows.
+
+### 7.4 `ask_code_diff` — **the v0.1 wedge**
+```jsonc
+"spec": {
+  "files": [{
+    "path": "string",
+    "hunks": [{ "id": "string", "header": "string",
+                "before": "string", "after": "string" }]
+  }],
+  "granularity": "hunk"           // v0.1: per-hunk only
+}
+```
+`value`: `{ accepted: hunkId[], rejected: hunkId[] }`
+Tiers: apps/url = interactive diff with per-hunk ✓/✗; elicitation = one `ask_confirm` per hunk; tui = same, sequential. `minTier: "tui"` (never hard-fails).
+
+### 7.5 `ask_number`
+`spec`: `{ min?, max?, step?, unit?: str, integer?: bool }` · `value`: `number`
+Tiers: apps/url = number input; elicitation = number/integer primitive; tui = prompt (validated).
+
+### 7.6 `ask_rating`
+`spec`: `{ max?: int=5, icon?: "star"|"number", labels?: {min?,max?} }` · `value`: `integer` in `[1, max]`
+Tiers: apps/url = star/number row; elicitation = integer (min 1, max); tui = `1..max` prompt.
+
+### 7.7 `ask_slider`
+`spec`: `{ min, max, step?, unit?: str }` · `value`: `number` in `[min, max]`
+Tiers: apps/url = range slider w/ live value; elicitation/tui = number in range (slider is a presentation, never a fidelity floor).
+
+### 7.8 `ask_date`
+`spec`: `{ min?, max?, time?: bool }` · `value`: `"YYYY-MM-DD"` (RFC3339 date-time if `time`)
+Tiers: apps/url = native date(-time) input; elicitation = string `format: date|date-time`; tui = prompt (validated).
+
+### 7.9 `ask_rank`
+`spec`: `{ items: [{id, label, description?}] }` · `value`: `string[]` — a **permutation of all item ids**
+Tiers: apps/url = reorderable list (move up/down); elicitation/tui = enter the ids in order (degradation defined: ordering UI is not a fidelity floor — ranking still completes as an ordered id list).
+
+### 7.10 `ask_color`
+`spec`: `{ palette?: string[], allowCustom?: bool }` · `value`: a CSS color string
+With a `palette` and `allowCustom` not true, the value MUST be a palette entry.
+Each `palette[]` entry MUST match the **safe color grammar** (§7.y).
+Tiers: apps/url = swatches (+ native picker when custom allowed); elicitation =
+string `enum` of the palette when fixed, else free string; tui = prompt (validated).
+
+## 7.x Presentation hints (advisory, non-normative)
+
+Optional fields that richer renderers MAY honour. They never change the
+`value` contract and MUST be safely ignorable — a renderer that drops them
+is still conformant (forward-compatible).
+
+- `AskSet.meta.layout`: `"auto"` (default) · `"single"` · `"grid"` — column
+  strategy across asks.
+- `AskSet.meta.theme`: `"system"` (default) · `"midnight"` · `"paper"` ·
+  `"high-contrast"`; `AskSet.meta.accent`: a CSS color (overrides accent) —
+  MUST match the safe color grammar (§7.y).
+- `Ask.meta.span`: `"half"` | `"full"` — overrides the per-ask auto layout.
+- `ask_select.spec.display`: `"list"` (default) · `"cards"` · `"segmented"`
+  · `"grid"`.
+- `SelectOption.icon` (curated icon name or raw character/emoji — unknown
+  names degrade to text) and `SelectOption.color` (a swatch) — `color` MUST
+  match the safe color grammar (§7.y).
+
+### 7.y Safe color grammar (normative)
+
+`SelectOption.color`, every `ask_color.spec.palette[]` entry, and
+`AskSet.meta.accent` are CSS color strings rendered into a **CSS value
+sink**. To prevent value-injection (`url()` exfiltration, `var()` /
+`image-set()` / `element()` / gradient breakout) on channels with no
+Content-Security-Policy (e.g. an mcp-ui `rawHtml` embed, a `data:` URL, or
+a copy-pasted panel), these fields MUST match (after trimming):
+
+```
+^(?:#[0-9a-fA-F]{3,8}|[a-zA-Z]+|(?:rgb|rgba|hsl|hsla|hwb|lab|lch|oklab|oklch|color)\([0-9a-zA-Z.,%/ +\-]*\))$
+```
+
+It accepts `#hex` (3/4/6/8), a CSS named/keyword color, and the common
+functional notations with a safe inner charset; it structurally cannot
+express `url(`, `var(`, `image-set(`, `element(`, gradients, quotes, `;`,
+or a nested `(`. A producer MUST NOT emit a non-conforming value; a
+**validator MUST reject** an AskSet that contains one. Because these are
+optional presentation fields, a renderer MUST treat an empty or
+non-conforming value as "no color" (omit the swatch/chip/accent) and MUST
+NOT pass it to a CSS sink — never hard-fail rendering over it.
+
+## 8. Conformance (normative intent)
+
+A "Elicitkit-compliant" implementation MUST: round-trip the envelope (§3) and Answer (§5) losslessly; honour `required`/`declined`/`deferred`; implement all four tiers for every type it claims; preserve unknown reserved fields untouched. The conformance suite (separate package) is the source of truth.
+
+---
+
+_Next: encode this as JSON Schema (`schema/elicitkit-v0.1.schema.json`), then `packages/core` validates against it._

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./types.js";
+export declare const SPEC_VERSION = "0.1.0";
+export declare const SCHEMA_ID = "https://elicitkit.com/schema/v0.1";
+export declare const schema: Record<string, unknown>;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,cAAc,YAAY,CAAC;AAE3B,eAAO,MAAM,YAAY,UAAU,CAAC;AACpC,eAAO,MAAM,SAAS,sCAAsC,CAAC;AAQ7D,eAAO,MAAM,MAAM,EAAsD,MAAM,CAC7E,MAAM,EACN,OAAO,CACR,CAAC"}

package/dist/index.js

@@ -0,0 +1,12 @@
+import { createRequire } from "node:module";
+export * from "./types.js";
+export const SPEC_VERSION = "0.1.0";
+export const SCHEMA_ID = "https://elicitkit.com/schema/v0.1";
+/**
+ * The canonical JSON Schema, loaded at runtime via createRequire.
+ * Resolved relative to dist/index.js → ../schema (shipped via package "files"),
+ * which avoids ESM JSON import-attribute pitfalls on Node 20.
+ */
+const require = createRequire(import.meta.url);
+export const schema = require("../schema/elicitkit-v0.1.schema.json");
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,cAAc,YAAY,CAAC;AAE3B,MAAM,CAAC,MAAM,YAAY,GAAG,OAAO,CAAC;AACpC,MAAM,CAAC,MAAM,SAAS,GAAG,mCAAmC,CAAC;AAE7D;;;;GAIG;AACH,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC/C,MAAM,CAAC,MAAM,MAAM,GAAG,OAAO,CAAC,sCAAsC,CAGnE,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,179 @@
+/**
+ * Elicitkit canonical TypeScript types — v0.1.
+ * Mirrors SPEC.md and schema/elicitkit-v0.1.schema.json. The spec is the product.
+ */
+export type Tier = "apps" | "url" | "elicitation" | "tui";
+export interface AskMeta {
+    specVersion: string;
+    /** lowest render tier that is still faithful */
+    minTier?: Tier;
+    /** layout override for this ask; otherwise an auto heuristic decides */
+    span?: "half" | "full";
+    [k: string]: unknown;
+}
+export interface AskBase {
+    id: string;
+    prompt: string;
+    help?: string;
+    /** default true */
+    required?: boolean;
+    /** the agent's proposed answer */
+    agentGuess?: unknown;
+    /** 0–1; enables confidence-gated auto-accept */
+    confidence?: number;
+    /** stable key for answer-memory / auto-skip */
+    memoryKey?: string;
+    meta?: AskMeta;
+}
+export interface AskText extends AskBase {
+    type: "ask_text";
+    spec: {
+        multiline?: boolean;
+        placeholder?: string;
+        pattern?: string;
+        maxLen?: number;
+    };
+}
+export interface SelectOption {
+    id: string;
+    label: string;
+    description?: string;
+    /** Optional adornment — a curated icon name (renderer-defined set) or a
+     *  raw character/emoji. Unknown names degrade to text. */
+    icon?: string;
+    /** Optional swatch color (any CSS color) shown beside the option. */
+    color?: string;
+}
+/** Presentation hint for `ask_select`. Renderers MAY honour it; all MUST
+ *  remain correct if they ignore it (forward-compatible). */
+export type SelectDisplay = "list" | "cards" | "segmented" | "grid";
+export interface AskSelect extends AskBase {
+    type: "ask_select";
+    spec: {
+        options: SelectOption[];
+        multiple?: boolean;
+        min?: number;
+        max?: number;
+        display?: SelectDisplay;
+    };
+}
+export interface AskConfirm extends AskBase {
+    type: "ask_confirm";
+    spec: {
+        affirm?: string;
+        deny?: string;
+        consequence?: string;
+    };
+}
+export interface DiffHunk {
+    id: string;
+    header?: string;
+    before?: string;
+    after: string;
+}
+export interface DiffFile {
+    path: string;
+    hunks: DiffHunk[];
+}
+/** The v0.1 wedge. */
+export interface AskCodeDiff extends AskBase {
+    type: "ask_code_diff";
+    spec: {
+        files: DiffFile[];
+        granularity?: "hunk";
+    };
+}
+/** Numeric input. value: number. */
+export interface AskNumber extends AskBase {
+    type: "ask_number";
+    spec: {
+        min?: number;
+        max?: number;
+        step?: number;
+        unit?: string;
+        integer?: boolean;
+    };
+}
+/** 1..max rating. value: integer in [1, max]. */
+export interface AskRating extends AskBase {
+    type: "ask_rating";
+    spec: {
+        max?: number;
+        icon?: "star" | "number";
+        labels?: {
+            min?: string;
+            max?: string;
+        };
+    };
+}
+/** Bounded range. value: number in [min, max]. */
+export interface AskSlider extends AskBase {
+    type: "ask_slider";
+    spec: {
+        min: number;
+        max: number;
+        step?: number;
+        unit?: string;
+    };
+}
+/** Date, optionally with time. value: "YYYY-MM-DD" (or RFC3339 if time). */
+export interface AskDate extends AskBase {
+    type: "ask_date";
+    spec: {
+        min?: string;
+        max?: string;
+        time?: boolean;
+    };
+}
+export interface RankItem {
+    id: string;
+    label: string;
+    description?: string;
+}
+/** Order a fixed set. value: string[] — a permutation of the item ids. */
+export interface AskRank extends AskBase {
+    type: "ask_rank";
+    spec: {
+        items: RankItem[];
+    };
+}
+/** Pick a color. value: a CSS color string (e.g. "#1d4ed8"). When a
+ *  `palette` is given and `allowCustom` is not true, the value MUST be one
+ *  of the palette entries. */
+export interface AskColor extends AskBase {
+    type: "ask_color";
+    spec: {
+        palette?: string[];
+        allowCustom?: boolean;
+    };
+}
+export type Ask = AskText | AskSelect | AskConfirm | AskCodeDiff | AskNumber | AskRating | AskSlider | AskDate | AskRank | AskColor;
+export interface AskSet {
+    specVersion: string;
+    asks: Ask[];
+    /** RESERVED v0.1: conditional branching */
+    edges?: unknown[];
+    /** Optional, renderer-advisory. `layout`: "auto" (default) lets the
+     *  renderer decide single/multi-column per ask; "single" forces one
+     *  column; "grid" prefers pairing. Ignorable by any renderer. */
+    meta?: {
+        layout?: "auto" | "single" | "grid";
+        /** skin: "system" (default) | "midnight" | "paper" | "high-contrast" */
+        theme?: "system" | "midnight" | "paper" | "high-contrast";
+        /** any CSS color — overrides the accent in any theme */
+        accent?: string;
+        [k: string]: unknown;
+    };
+}
+export type AnswerStatus = "answered" | "declined" | "deferred";
+export interface Answer {
+    id: string;
+    type: string;
+    status: AnswerStatus;
+    value?: unknown;
+    meta?: {
+        tier?: Tier;
+        specVersion?: string;
+    };
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,MAAM,IAAI,GAAG,MAAM,GAAG,KAAK,GAAG,aAAa,GAAG,KAAK,CAAC;AAE1D,MAAM,WAAW,OAAO;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,gDAAgD;IAChD,OAAO,CAAC,EAAE,IAAI,CAAC;IACf,wEAAwE;IACxE,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,mBAAmB;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IAGnB,kCAAkC;IAClC,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,gDAAgD;IAChD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,+CAA+C;IAC/C,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,WAAW,OAAQ,SAAQ,OAAO;IACtC,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,EAAE;QAAE,SAAS,CAAC,EAAE,OAAO,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CACxF;AAED,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;8DAC0D;IAC1D,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qEAAqE;IACrE,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;6DAC6D;AAC7D,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,OAAO,GAAG,WAAW,GAAG,MAAM,CAAC;AAEpE,MAAM,WAAW,SAAU,SAAQ,OAAO;IACxC,IAAI,EAAE,YAAY,CAAC;IACnB,IAAI,EAAE;QACJ,OAAO,EAAE,YAAY,EAAE,CAAC;QACxB,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,OAAO,CAAC,EAAE,aAAa,CAAC;KACzB,CAAC;CACH;AAED,MAAM,WAAW,UAAW,SAAQ,OAAO;IACzC,IAAI,EAAE,aAAa,CAAC;IACpB,IAAI,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CAChE;AAED,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,QAAQ,EAAE,CAAC;CACnB;AAED,sBAAsB;AACtB,MAAM,WAAW,WAAY,SAAQ,OAAO;IAC1C,IAAI,EAAE,eAAe,CAAC;IACtB,IAAI,EAAE;QAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CACnD;AAED,oCAAoC;AACpC,MAAM,WAAW,SAAU,SAAQ,OAAO;IACxC,IAAI,EAAE,YAAY,CAAC;IACnB,IAAI,EAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC;CACvF;AAED,iDAAiD;AACjD,MAAM,WAAW,SAAU,SAAQ,OAAO;IACxC,IAAI,EAAE,YAAY,CAAC;IACnB,IAAI,EAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAC;QAAC,MAAM,CAAC,EAAE;YAAE,GAAG,CAAC,EAAE,MAAM,CAAC;YAAC,GAAG,CAAC,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,CAAC;CAC3F;AAED,kDAAkD;AAClD,MAAM,WAAW,SAAU,SAAQ,OAAO;IACxC,IAAI,EAAE,YAAY,CAAC;IACnB,IAAI,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CAClE;AAED,4EAA4E;AAC5E,MAAM,WAAW,OAAQ,SAAQ,OAAO;IACtC,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,EAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC;CACtD;AAED,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,0EAA0E;AAC1E,MAAM,WAAW,OAAQ,SAAQ,OAAO;IACtC,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,EAAE;QAAE,KAAK,EAAE,QAAQ,EAAE,CAAA;KAAE,CAAC;CAC7B;AAED;;8BAE8B;AAC9B,MAAM,WAAW,QAAS,SAAQ,OAAO;IACvC,IAAI,EAAE,WAAW,CAAC;IAClB,IAAI,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,WAAW,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC;CACrD;AAED,MAAM,MAAM,GAAG,GACX,OAAO,GACP,SAAS,GACT,UAAU,GACV,WAAW,GACX,SAAS,GACT,SAAS,GACT,SAAS,GACT,OAAO,GACP,OAAO,GACP,QAAQ,CAAC;AAEb,MAAM,WAAW,MAAM;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,GAAG,EAAE,CAAC;IACZ,2CAA2C;IAC3C,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC;IAClB;;qEAEiE;IACjE,IAAI,CAAC,EAAE;QACL,MAAM,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,MAAM,CAAC;QACpC,wEAAwE;QACxE,KAAK,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,OAAO,GAAG,eAAe,CAAC;QAC1D,wDAAwD;QACxD,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB,CAAC;CACH;AAED,MAAM,MAAM,YAAY,GAAG,UAAU,GAAG,UAAU,GAAG,UAAU,CAAC;AAEhE,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,YAAY,CAAC;IACrB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,IAAI,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,IAAI,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CAC9C"}

package/dist/types.js

@@ -0,0 +1,6 @@
+/**
+ * Elicitkit canonical TypeScript types — v0.1.
+ * Mirrors SPEC.md and schema/elicitkit-v0.1.schema.json. The spec is the product.
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG"}

package/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "@elicitkit/spec",
+  "version": "0.1.0",
+  "description": "The Elicitkit question spec — JSON Schema + canonical TypeScript types. This package is the product.",
+  "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" },
+    "./schema": "./schema/elicitkit-v0.1.schema.json"
+  },
+  "files": ["dist", "schema", "SPEC.md"],
+  "scripts": { "build": "tsc -p tsconfig.json" },
+  "publishConfig": { "access": "public" }
+}

package/schema/elicitkit-v0.1.schema.json

@@ -0,0 +1,208 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://elicitkit.com/schema/v0.1",
+  "title": "Elicitkit Question Spec v0.1",
+  "description": "Draft. The reserved hooks (agentGuess/confidence/memoryKey) are inert in v0.1 and populated in a later MINOR.",
+  "$defs": {
+    "tier": { "enum": ["apps", "url", "elicitation", "tui"] },
+    "safeColor": {
+      "type": "string",
+      "description": "A CSS color constrained to a structurally safe grammar: #hex(3/4/6/8), a CSS named/keyword color, or a common functional notation with a safe inner charset. Structurally cannot express url(/var(/image-set(/element(/gradients/quotes/;/nested ( — no exfiltration or CSS breakout. Renderers MUST ignore (omit) any non-conforming value for these optional presentation fields.",
+      "pattern": "^(?:#[0-9a-fA-F]{3,8}|[a-zA-Z]+|(?:rgb|rgba|hsl|hsla|hwb|lab|lch|oklab|oklch|color)\\([0-9a-zA-Z.,%/ +\\-]*\\))$"
+    },
+    "meta": {
+      "type": "object",
+      "properties": {
+        "specVersion": { "type": "string", "pattern": "^\\d+\\.\\d+\\.\\d+$" },
+        "minTier": { "$ref": "#/$defs/tier" },
+        "accent": { "$ref": "#/$defs/safeColor" }
+      },
+      "required": ["specVersion"],
+      "additionalProperties": true
+    },
+    "ask": {
+      "type": "object",
+      "properties": {
+        "id": { "type": "string", "minLength": 1 },
+        "type": { "enum": ["ask_text", "ask_select", "ask_confirm", "ask_code_diff", "ask_number", "ask_rating", "ask_slider", "ask_date", "ask_rank", "ask_color"] },
+        "prompt": { "type": "string", "minLength": 1 },
+        "help": { "type": "string" },
+        "required": { "type": "boolean", "default": true },
+        "spec": { "type": "object" },
+        "agentGuess": {},
+        "confidence": { "type": "number", "minimum": 0, "maximum": 1 },
+        "memoryKey": { "type": "string" },
+        "meta": { "$ref": "#/$defs/meta" }
+      },
+      "required": ["id", "type", "prompt", "spec"],
+      "allOf": [
+        {
+          "if": { "properties": { "type": { "const": "ask_select" } } },
+          "then": { "properties": { "spec": {
+            "type": "object",
+            "properties": {
+              "options": { "type": "array", "minItems": 1, "items": {
+                "type": "object",
+                "properties": {
+                  "id": { "type": "string" },
+                  "label": { "type": "string" },
+                  "description": { "type": "string" },
+                  "icon": { "type": "string" },
+                  "color": { "$ref": "#/$defs/safeColor" }
+                },
+                "required": ["id", "label"]
+              } },
+              "multiple": { "type": "boolean" },
+              "min": { "type": "integer" },
+              "max": { "type": "integer" },
+              "display": { "enum": ["list", "cards", "segmented", "grid"] }
+            },
+            "required": ["options"]
+          } } }
+        },
+        {
+          "if": { "properties": { "type": { "const": "ask_code_diff" } } },
+          "then": { "properties": { "spec": {
+            "type": "object",
+            "properties": {
+              "files": { "type": "array", "minItems": 1, "items": {
+                "type": "object",
+                "properties": {
+                  "path": { "type": "string" },
+                  "hunks": { "type": "array", "minItems": 1, "items": {
+                    "type": "object",
+                    "properties": {
+                      "id": { "type": "string" },
+                      "header": { "type": "string" },
+                      "before": { "type": "string" },
+                      "after": { "type": "string" }
+                    },
+                    "required": ["id", "after"]
+                  } }
+                },
+                "required": ["path", "hunks"]
+              } },
+              "granularity": { "const": "hunk" }
+            },
+            "required": ["files"]
+          } } }
+        },
+        {
+          "if": { "properties": { "type": { "const": "ask_number" } } },
+          "then": { "properties": { "spec": {
+            "type": "object",
+            "properties": {
+              "min": { "type": "number" },
+              "max": { "type": "number" },
+              "step": { "type": "number" },
+              "unit": { "type": "string" },
+              "integer": { "type": "boolean" }
+            }
+          } } }
+        },
+        {
+          "if": { "properties": { "type": { "const": "ask_rating" } } },
+          "then": { "properties": { "spec": {
+            "type": "object",
+            "properties": {
+              "max": { "type": "integer", "minimum": 2 },
+              "icon": { "enum": ["star", "number"] },
+              "labels": { "type": "object", "properties": {
+                "min": { "type": "string" }, "max": { "type": "string" }
+              } }
+            }
+          } } }
+        },
+        {
+          "if": { "properties": { "type": { "const": "ask_slider" } } },
+          "then": { "properties": { "spec": {
+            "type": "object",
+            "properties": {
+              "min": { "type": "number" },
+              "max": { "type": "number" },
+              "step": { "type": "number" },
+              "unit": { "type": "string" }
+            },
+            "required": ["min", "max"]
+          } } }
+        },
+        {
+          "if": { "properties": { "type": { "const": "ask_date" } } },
+          "then": { "properties": { "spec": {
+            "type": "object",
+            "properties": {
+              "min": { "type": "string" },
+              "max": { "type": "string" },
+              "time": { "type": "boolean" }
+            }
+          } } }
+        },
+        {
+          "if": { "properties": { "type": { "const": "ask_color" } } },
+          "then": { "properties": { "spec": {
+            "type": "object",
+            "properties": {
+              "palette": { "type": "array", "items": { "$ref": "#/$defs/safeColor" } },
+              "allowCustom": { "type": "boolean" }
+            }
+          } } }
+        },
+        {
+          "if": { "properties": { "type": { "const": "ask_rank" } } },
+          "then": { "properties": { "spec": {
+            "type": "object",
+            "properties": {
+              "items": { "type": "array", "minItems": 2, "items": {
+                "type": "object",
+                "properties": {
+                  "id": { "type": "string" },
+                  "label": { "type": "string" },
+                  "description": { "type": "string" }
+                },
+                "required": ["id", "label"]
+              } }
+            },
+            "required": ["items"]
+          } } }
+        }
+      ]
+    },
+    "askSet": {
+      "type": "object",
+      "properties": {
+        "specVersion": { "type": "string", "pattern": "^\\d+\\.\\d+\\.\\d+$" },
+        "asks": { "type": "array", "minItems": 1, "items": { "$ref": "#/$defs/ask" } },
+        "edges": { "type": "array", "description": "RESERVED v0.1: conditional branching" },
+        "meta": {
+          "type": "object",
+          "description": "Optional AskSet-level presentation hints (advisory, forward-compatible). Unknown keys are preserved.",
+          "properties": {
+            "layout": { "type": "string" },
+            "theme": { "type": "string" },
+            "accent": { "$ref": "#/$defs/safeColor" }
+          },
+          "additionalProperties": true
+        }
+      },
+      "required": ["specVersion", "asks"]
+    },
+    "answer": {
+      "type": "object",
+      "properties": {
+        "id": { "type": "string" },
+        "type": { "type": "string" },
+        "status": { "enum": ["answered", "declined", "deferred"] },
+        "value": {},
+        "meta": {
+          "type": "object",
+          "properties": {
+            "tier": { "$ref": "#/$defs/tier" },
+            "specVersion": { "type": "string" }
+          }
+        }
+      },
+      "required": ["id", "type", "status"]
+    }
+  },
+  "$ref": "#/$defs/askSet"
+}