@kitn.ai/ui 0.28.0 → 0.29.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (376) hide show
  1. package/README.md +1 -1
  2. package/dist/agent-tooling/construct/public.d.ts +15 -0
  3. package/dist/agent-tooling/construct/schema.d.ts +111 -0
  4. package/dist/construct-cli.es.js +3 -3
  5. package/dist/construct.d.ts +5 -0
  6. package/dist/construct.js +327 -0
  7. package/dist/core-C8fzo39E.js +1 -12
  8. package/dist/engine-javascript-C1x7zo1_.js +1 -141
  9. package/dist/mcp.es.js +1 -1
  10. package/package.json +16 -16
  11. package/bin/route.test.js +0 -58
  12. package/src/agent-tooling/README.md +0 -192
  13. package/src/agent-tooling/archetypes.ts +0 -205
  14. package/src/agent-tooling/catalog/README.md +0 -676
  15. package/src/agent-tooling/catalog/catalog-types.ts +0 -231
  16. package/src/agent-tooling/catalog/fabrications.ts +0 -96
  17. package/src/agent-tooling/catalog/invariants.ts +0 -284
  18. package/src/agent-tooling/catalog/labs-titles.ts +0 -114
  19. package/src/agent-tooling/catalog/scenarios.ts +0 -87
  20. package/src/agent-tooling/catalog/surfaces.ts +0 -347
  21. package/src/agent-tooling/construct/cli-entry.ts +0 -8
  22. package/src/agent-tooling/construct/cli.ts +0 -147
  23. package/src/agent-tooling/construct/codegen.ts +0 -1635
  24. package/src/agent-tooling/construct/construct.v1.schema.json +0 -319
  25. package/src/agent-tooling/construct/dev.ts +0 -148
  26. package/src/agent-tooling/construct/fixtures/demo-widget.construct.json +0 -7
  27. package/src/agent-tooling/construct/fixtures/ops-console.construct.json +0 -44
  28. package/src/agent-tooling/construct/fixtures/owner-widget.construct.json +0 -32
  29. package/src/agent-tooling/construct/schema.ts +0 -452
  30. package/src/agent-tooling/integrations/anthropic.ts +0 -442
  31. package/src/agent-tooling/integrations/cloudflare.ts +0 -218
  32. package/src/agent-tooling/integrations/langgraph.ts +0 -133
  33. package/src/agent-tooling/integrations/mastra.ts +0 -182
  34. package/src/agent-tooling/integrations/mock.ts +0 -148
  35. package/src/agent-tooling/integrations/ollama.ts +0 -97
  36. package/src/agent-tooling/integrations/openai.ts +0 -95
  37. package/src/agent-tooling/integrations/openrouter.ts +0 -82
  38. package/src/agent-tooling/integrations/pi.ts +0 -176
  39. package/src/agent-tooling/integrations/pydantic-ai.ts +0 -108
  40. package/src/agent-tooling/integrations/vercel-ai-sdk.ts +0 -398
  41. package/src/agent-tooling/mcp/css-raw.d.ts +0 -12
  42. package/src/agent-tooling/mcp/manifest.ts +0 -422
  43. package/src/agent-tooling/mcp/server.ts +0 -116
  44. package/src/agent-tooling/mcp/stdio.ts +0 -18
  45. package/src/agent-tooling/mcp/tools/construct.ts +0 -130
  46. package/src/agent-tooling/mcp/tools/debug.ts +0 -621
  47. package/src/agent-tooling/mcp/tools/reference.ts +0 -980
  48. package/src/agent-tooling/mcp/tools/scaffold.ts +0 -6708
  49. package/src/agent-tooling/mcp/tools/theme.ts +0 -456
  50. package/src/agent-tooling/mcp/tools/types.ts +0 -14
  51. package/src/agent-tooling/mcp/validate-args.ts +0 -141
  52. package/src/agent-tooling/recipes/composed-thread.ts +0 -714
  53. package/src/agent-tooling/recipes/index.ts +0 -22
  54. package/src/agent-tooling/recipes/types.ts +0 -32
  55. package/src/agent-tooling/registry.ts +0 -132
  56. package/src/agent-tooling/route-emit.ts +0 -305
  57. package/src/agent-tooling/types.ts +0 -390
  58. package/src/components/artifact-card.tsx +0 -120
  59. package/src/components/artifact.tsx +0 -914
  60. package/src/components/attachment-types.ts +0 -66
  61. package/src/components/attachments.tsx +0 -536
  62. package/src/components/audio-visualizer/audio-visualizer.voice-fixture.ts +0 -257
  63. package/src/components/audio-visualizer/aurora.glsl.ts +0 -330
  64. package/src/components/audio-visualizer/fit-scale.ts +0 -112
  65. package/src/components/audio-visualizer/index.tsx +0 -528
  66. package/src/components/audio-visualizer/labs/lab-choreography.ts +0 -187
  67. package/src/components/audio-visualizer/labs/lab-shaders.ts +0 -363
  68. package/src/components/audio-visualizer/labs/lab-visualizer.tsx +0 -102
  69. package/src/components/audio-visualizer/shader-canvas.tsx +0 -876
  70. package/src/components/audio-visualizer/sizes.ts +0 -54
  71. package/src/components/audio-visualizer/variant-aurora.tsx +0 -305
  72. package/src/components/audio-visualizer/variant-bar.tsx +0 -175
  73. package/src/components/audio-visualizer/variant-custom.tsx +0 -344
  74. package/src/components/audio-visualizer/variant-grid.tsx +0 -175
  75. package/src/components/audio-visualizer/variant-radial.tsx +0 -163
  76. package/src/components/audio-visualizer/variant-wave.tsx +0 -130
  77. package/src/components/audio-visualizer/wave.glsl.ts +0 -130
  78. package/src/components/card-fallback.tsx +0 -60
  79. package/src/components/card-renderer.tsx +0 -220
  80. package/src/components/card.tsx +0 -212
  81. package/src/components/chain-of-thought.tsx +0 -348
  82. package/src/components/chat-container.tsx +0 -89
  83. package/src/components/chat-scope-picker.tsx +0 -57
  84. package/src/components/chat-thread.tsx +0 -1014
  85. package/src/components/checkpoint.tsx +0 -88
  86. package/src/components/choice-card.tsx +0 -743
  87. package/src/components/coachmark.tsx +0 -249
  88. package/src/components/code-block.tsx +0 -181
  89. package/src/components/composer-dom.ts +0 -159
  90. package/src/components/composer-highlight.ts +0 -242
  91. package/src/components/composer-history.ts +0 -82
  92. package/src/components/composer.tsx +0 -1075
  93. package/src/components/confirm-card.tsx +0 -402
  94. package/src/components/context.tsx +0 -377
  95. package/src/components/conversation-item.tsx +0 -241
  96. package/src/components/conversation-list.tsx +0 -429
  97. package/src/components/conversation-panel.tsx +0 -118
  98. package/src/components/dismissed-stub.tsx +0 -80
  99. package/src/components/embed.tsx +0 -200
  100. package/src/components/empty.tsx +0 -177
  101. package/src/components/feedback-bar.tsx +0 -166
  102. package/src/components/file-tree.tsx +0 -530
  103. package/src/components/file-upload.tsx +0 -167
  104. package/src/components/form-widgets.tsx +0 -525
  105. package/src/components/form.tsx +0 -1296
  106. package/src/components/home-panel.tsx +0 -159
  107. package/src/components/image.tsx +0 -65
  108. package/src/components/link-preview.tsx +0 -195
  109. package/src/components/loader.tsx +0 -367
  110. package/src/components/markdown.tsx +0 -162
  111. package/src/components/message-skills.tsx +0 -40
  112. package/src/components/message.tsx +0 -765
  113. package/src/components/model-switcher.tsx +0 -132
  114. package/src/components/prompt-input.tsx +0 -188
  115. package/src/components/prompt-suggestion.tsx +0 -150
  116. package/src/components/reasoning.tsx +0 -293
  117. package/src/components/response-compare-types.ts +0 -152
  118. package/src/components/response-compare.tsx +0 -455
  119. package/src/components/response-stream.tsx +0 -109
  120. package/src/components/screen.tsx +0 -181
  121. package/src/components/scroll-button.tsx +0 -93
  122. package/src/components/source.tsx +0 -192
  123. package/src/components/tasks-card.tsx +0 -801
  124. package/src/components/text-shimmer.tsx +0 -37
  125. package/src/components/thinking-bar.tsx +0 -50
  126. package/src/components/thread.tsx +0 -228
  127. package/src/components/toast.tsx +0 -503
  128. package/src/components/tool-classify.ts +0 -26
  129. package/src/components/tool-types.ts +0 -49
  130. package/src/components/tool.tsx +0 -190
  131. package/src/components/use-card-resolution.ts +0 -44
  132. package/src/components/voice-input.tsx +0 -222
  133. package/src/components/voice-output.tsx +0 -242
  134. package/src/components/widget-tab-bar.tsx +0 -73
  135. package/src/components/workspace-shell.tsx +0 -285
  136. package/src/diagnostics/hook.ts +0 -352
  137. package/src/diagnostics/index.ts +0 -82
  138. package/src/diagnostics/report-request.ts +0 -296
  139. package/src/elements/agent-card.tsx +0 -67
  140. package/src/elements/artifact.tsx +0 -194
  141. package/src/elements/attachments.tsx +0 -140
  142. package/src/elements/audio-visualizer.tsx +0 -227
  143. package/src/elements/autoloader.ts +0 -89
  144. package/src/elements/avatar.tsx +0 -33
  145. package/src/elements/badge.tsx +0 -32
  146. package/src/elements/button.tsx +0 -149
  147. package/src/elements/card.tsx +0 -133
  148. package/src/elements/cards.tsx +0 -266
  149. package/src/elements/chain-of-thought.tsx +0 -141
  150. package/src/elements/chat-scope-picker.tsx +0 -65
  151. package/src/elements/chat-types.ts +0 -102
  152. package/src/elements/chat-workspace.tsx +0 -188
  153. package/src/elements/chat.tsx +0 -304
  154. package/src/elements/checkbox-group.tsx +0 -164
  155. package/src/elements/checkbox.tsx +0 -134
  156. package/src/elements/checkpoint.tsx +0 -47
  157. package/src/elements/choice.tsx +0 -100
  158. package/src/elements/coachmark.tsx +0 -90
  159. package/src/elements/code-block.tsx +0 -60
  160. package/src/elements/command.tsx +0 -197
  161. package/src/elements/compare.tsx +0 -111
  162. package/src/elements/compiled.css +0 -2
  163. package/src/elements/composer.tsx +0 -162
  164. package/src/elements/confirm-card.tsx +0 -76
  165. package/src/elements/context-meter.tsx +0 -107
  166. package/src/elements/conversation-item.tsx +0 -120
  167. package/src/elements/conversation-list.tsx +0 -203
  168. package/src/elements/css.ts +0 -5
  169. package/src/elements/default-input.tsx +0 -392
  170. package/src/elements/define-entry.ts +0 -12
  171. package/src/elements/define.tsx +0 -563
  172. package/src/elements/diagnostic-events.ts +0 -114
  173. package/src/elements/dialog.tsx +0 -145
  174. package/src/elements/disclosure.ts +0 -95
  175. package/src/elements/dock.tsx +0 -215
  176. package/src/elements/dropdown.tsx +0 -123
  177. package/src/elements/editable-label.tsx +0 -140
  178. package/src/elements/element-data-types.ts +0 -152
  179. package/src/elements/element-diagnostics.ts +0 -392
  180. package/src/elements/element-manifest.json +0 -354
  181. package/src/elements/element-nonscalar.json +0 -187
  182. package/src/elements/element-types.d.ts +0 -4353
  183. package/src/elements/embed.tsx +0 -35
  184. package/src/elements/empty.tsx +0 -29
  185. package/src/elements/feedback-bar.tsx +0 -66
  186. package/src/elements/file-tree.tsx +0 -62
  187. package/src/elements/file-upload.tsx +0 -44
  188. package/src/elements/form.tsx +0 -94
  189. package/src/elements/hover-card.tsx +0 -80
  190. package/src/elements/icon.tsx +0 -41
  191. package/src/elements/image.tsx +0 -32
  192. package/src/elements/input.tsx +0 -492
  193. package/src/elements/kbd.tsx +0 -45
  194. package/src/elements/link-preview.tsx +0 -34
  195. package/src/elements/loader.tsx +0 -25
  196. package/src/elements/markdown.tsx +0 -38
  197. package/src/elements/menu.tsx +0 -241
  198. package/src/elements/message-skills.tsx +0 -83
  199. package/src/elements/message.tsx +0 -361
  200. package/src/elements/model-switcher.tsx +0 -121
  201. package/src/elements/nav.tsx +0 -87
  202. package/src/elements/notice.tsx +0 -53
  203. package/src/elements/pane-grid.tsx +0 -111
  204. package/src/elements/pane-group.tsx +0 -119
  205. package/src/elements/pane.tsx +0 -129
  206. package/src/elements/popover.tsx +0 -81
  207. package/src/elements/progress-bar.tsx +0 -39
  208. package/src/elements/prompt-dock.tsx +0 -82
  209. package/src/elements/prompt-input.tsx +0 -240
  210. package/src/elements/prompt-suggestions.tsx +0 -113
  211. package/src/elements/radio-group.tsx +0 -129
  212. package/src/elements/reasoning.tsx +0 -71
  213. package/src/elements/register-impl.ts +0 -148
  214. package/src/elements/register.ts +0 -76
  215. package/src/elements/remote.tsx +0 -225
  216. package/src/elements/resizable.globals.d.ts +0 -36
  217. package/src/elements/resizable.tsx +0 -704
  218. package/src/elements/response-stream.tsx +0 -40
  219. package/src/elements/screen.tsx +0 -90
  220. package/src/elements/scroll-area.tsx +0 -33
  221. package/src/elements/scroll-button.tsx +0 -179
  222. package/src/elements/search.tsx +0 -185
  223. package/src/elements/segmented.tsx +0 -129
  224. package/src/elements/select.tsx +0 -165
  225. package/src/elements/separator.tsx +0 -36
  226. package/src/elements/setting-item.tsx +0 -50
  227. package/src/elements/settings-group.tsx +0 -37
  228. package/src/elements/skeleton.tsx +0 -45
  229. package/src/elements/slider.tsx +0 -171
  230. package/src/elements/slot-text.ts +0 -73
  231. package/src/elements/slots.ts +0 -787
  232. package/src/elements/source.tsx +0 -126
  233. package/src/elements/status.tsx +0 -42
  234. package/src/elements/styles.css +0 -328
  235. package/src/elements/switch.tsx +0 -118
  236. package/src/elements/tabs.tsx +0 -95
  237. package/src/elements/tasks.tsx +0 -103
  238. package/src/elements/text-shimmer.tsx +0 -28
  239. package/src/elements/thinking-bar.tsx +0 -43
  240. package/src/elements/thread.tsx +0 -139
  241. package/src/elements/toast.tsx +0 -106
  242. package/src/elements/tool.tsx +0 -78
  243. package/src/elements/tooltip.tsx +0 -85
  244. package/src/elements/validate-messages.ts +0 -76
  245. package/src/elements/voice-input.tsx +0 -100
  246. package/src/elements/voice-output.tsx +0 -82
  247. package/src/index.ts +0 -430
  248. package/src/primitives/audio-bands.ts +0 -174
  249. package/src/primitives/card-component-types.ts +0 -63
  250. package/src/primitives/card-contract.ts +0 -80
  251. package/src/primitives/card-data-types.ts +0 -361
  252. package/src/primitives/card-host.tsx +0 -37
  253. package/src/primitives/card-recovery.ts +0 -160
  254. package/src/primitives/card-registry.tsx +0 -78
  255. package/src/primitives/card-resolution.ts +0 -36
  256. package/src/primitives/card-routing.ts +0 -85
  257. package/src/primitives/card-schemas/artifact.schema.json +0 -92
  258. package/src/primitives/card-schemas/card-envelope.schema.json +0 -14
  259. package/src/primitives/card-schemas/card-event.schema.json +0 -12
  260. package/src/primitives/card-schemas/choice.schema.json +0 -75
  261. package/src/primitives/card-schemas/confirm.schema.json +0 -65
  262. package/src/primitives/card-schemas/embed.schema.json +0 -63
  263. package/src/primitives/card-schemas/form.result.schema.json +0 -7
  264. package/src/primitives/card-schemas/form.schema.json +0 -53
  265. package/src/primitives/card-schemas/link.schema.json +0 -54
  266. package/src/primitives/card-schemas/tasks.result.schema.json +0 -16
  267. package/src/primitives/card-schemas/tasks.schema.json +0 -83
  268. package/src/primitives/card-tags.ts +0 -61
  269. package/src/primitives/card-validate-cards.ts +0 -255
  270. package/src/primitives/card-validate-schemas.ts +0 -58
  271. package/src/primitives/card-validate.ts +0 -131
  272. package/src/primitives/chat-config.tsx +0 -103
  273. package/src/primitives/composer-model.ts +0 -49
  274. package/src/primitives/composer-triggers.ts +0 -35
  275. package/src/primitives/controllable.ts +0 -21
  276. package/src/primitives/conversation-store.ts +0 -248
  277. package/src/primitives/create-kai-chat.ts +0 -66
  278. package/src/primitives/create-tween.ts +0 -266
  279. package/src/primitives/embed-providers.ts +0 -254
  280. package/src/primitives/field-mask.ts +0 -256
  281. package/src/primitives/field-semantics.ts +0 -115
  282. package/src/primitives/highlighter.ts +0 -157
  283. package/src/primitives/input-mask.ts +0 -853
  284. package/src/primitives/link-preview.ts +0 -87
  285. package/src/primitives/message-feedback.ts +0 -124
  286. package/src/primitives/pdf-preview.ts +0 -121
  287. package/src/primitives/toast-store.ts +0 -338
  288. package/src/primitives/url-scheme-policy.ts +0 -70
  289. package/src/primitives/use-audio-analysis.ts +0 -340
  290. package/src/primitives/use-auto-resize.ts +0 -31
  291. package/src/primitives/use-resize-observer.ts +0 -45
  292. package/src/primitives/use-sequencer.ts +0 -72
  293. package/src/primitives/use-speech-recognition.ts +0 -146
  294. package/src/primitives/use-stick-to-bottom.ts +0 -75
  295. package/src/primitives/use-text-stream.ts +0 -143
  296. package/src/primitives/use-voice-recorder.ts +0 -62
  297. package/src/primitives/visualizer-sequences.ts +0 -350
  298. package/src/remote/host-embed.ts +0 -345
  299. package/src/remote/index.ts +0 -2
  300. package/src/remote/origin.ts +0 -30
  301. package/src/remote/provider-runtime.ts +0 -262
  302. package/src/remote/provider.ts +0 -2
  303. package/src/remote/validate.ts +0 -22
  304. package/src/remote/version.ts +0 -12
  305. package/src/remote/wire.ts +0 -48
  306. package/src/schemas/from-tool-call.ts +0 -151
  307. package/src/schemas/index.ts +0 -341
  308. package/src/schemas/provider-subsets.ts +0 -538
  309. package/src/schemas/registry.ts +0 -355
  310. package/src/schemas/tool-defs.ts +0 -793
  311. package/src/solid.ts +0 -173
  312. package/src/state/index.ts +0 -44
  313. package/src/state/messages.ts +0 -53
  314. package/src/state/mock.ts +0 -297
  315. package/src/state/parts.ts +0 -295
  316. package/src/state/persistence.ts +0 -180
  317. package/src/state/stream.ts +0 -246
  318. package/src/state/suggestions.ts +0 -9
  319. package/src/state/threads.ts +0 -142
  320. package/src/test-utils/fake-clock.ts +0 -88
  321. package/src/types.ts +0 -95
  322. package/src/ui/action-icons.ts +0 -53
  323. package/src/ui/agent-card.tsx +0 -218
  324. package/src/ui/avatar.tsx +0 -23
  325. package/src/ui/badge.tsx +0 -21
  326. package/src/ui/button.tsx +0 -49
  327. package/src/ui/card.tsx +0 -245
  328. package/src/ui/checkbox-group.tsx +0 -153
  329. package/src/ui/checkbox.tsx +0 -63
  330. package/src/ui/collapsible.tsx +0 -163
  331. package/src/ui/command.tsx +0 -103
  332. package/src/ui/dialog.tsx +0 -223
  333. package/src/ui/dock.tsx +0 -630
  334. package/src/ui/dropdown.tsx +0 -636
  335. package/src/ui/editable-label.tsx +0 -112
  336. package/src/ui/hover-card.tsx +0 -345
  337. package/src/ui/icon.tsx +0 -167
  338. package/src/ui/input.tsx +0 -391
  339. package/src/ui/kbd.tsx +0 -118
  340. package/src/ui/nav.tsx +0 -282
  341. package/src/ui/notice.tsx +0 -84
  342. package/src/ui/overlay.tsx +0 -277
  343. package/src/ui/pane-grid.tsx +0 -117
  344. package/src/ui/pane-group.tsx +0 -291
  345. package/src/ui/pane.tsx +0 -193
  346. package/src/ui/popover.tsx +0 -106
  347. package/src/ui/progress-bar.tsx +0 -83
  348. package/src/ui/prompt-dock.tsx +0 -145
  349. package/src/ui/radio.tsx +0 -150
  350. package/src/ui/resizable.tsx +0 -693
  351. package/src/ui/scroll-area.tsx +0 -26
  352. package/src/ui/segmented.tsx +0 -109
  353. package/src/ui/select.tsx +0 -168
  354. package/src/ui/separator.tsx +0 -10
  355. package/src/ui/settings-group.tsx +0 -67
  356. package/src/ui/skeleton.tsx +0 -73
  357. package/src/ui/slider.tsx +0 -178
  358. package/src/ui/status.tsx +0 -48
  359. package/src/ui/switch.tsx +0 -119
  360. package/src/ui/tabs.tsx +0 -168
  361. package/src/ui/textarea.tsx +0 -21
  362. package/src/ui/tooltip.tsx +0 -118
  363. package/src/utils/cn.ts +0 -30
  364. package/src/wire/chunk.ts +0 -248
  365. package/src/wire/consume.ts +0 -599
  366. package/src/wire/diagnostics.ts +0 -727
  367. package/src/wire/encode-probe.ts +0 -214
  368. package/src/wire/encode.ts +0 -947
  369. package/src/wire/files.ts +0 -342
  370. package/src/wire/formats/anthropic.ts +0 -274
  371. package/src/wire/formats/openai.ts +0 -228
  372. package/src/wire/index.ts +0 -95
  373. package/src/wire/media-types.ts +0 -344
  374. package/src/wire/read.ts +0 -396
  375. package/src/wire/sink-helpers.ts +0 -50
  376. package/src/wire/sse.ts +0 -153
@@ -1,621 +0,0 @@
1
- import { z } from 'zod';
2
- import type { Tool } from './types';
3
-
4
- /**
5
- * debug — diagnose common AI/UI (kai-*) integration failures.
6
- *
7
- * Given a `symptom` (prose) and/or a `snippet` (code), returns the likely
8
- * cause + fix for the classic `kai-*` failure modes so a harness can
9
- * self-correct without a human in the loop.
10
- *
11
- * Rule set sourced from:
12
- * - apps/docs/src/content/docs/guides/for-ai-agents.mdx §"What agents most commonly get wrong"
13
- * - context7.json `rules` array (5 contract rules)
14
- */
15
-
16
- interface Rule {
17
- id: string;
18
- test: (text: string) => boolean;
19
- title: string;
20
- cause: string;
21
- fix: string;
22
- }
23
-
24
- const RULES: Rule[] = [
25
- {
26
- // Rule 1 — array/object data set as an HTML attribute
27
- // Source: for-ai-agents.mdx §1; context7.json rule 2
28
- id: 'array-as-attribute',
29
- test: (t) =>
30
- /\b(messages|models|context|suggestions|triggers)\s*=\s*["']/.test(t),
31
- title: 'Array/object prop set as an HTML attribute (silent failure)',
32
- cause:
33
- 'An HTML attribute is always a string. Passing `messages`, `models`, `context`, ' +
34
- '`suggestions`, or `triggers` as an HTML attribute silently fails — ' +
35
- 'the element receives a stringified value it cannot parse.',
36
- fix:
37
- 'Set the property in JavaScript, not as an HTML attribute. ' +
38
- 'Only scalar props (`placeholder`, `loading`, `theme`) work as attributes.\n\n' +
39
- '```js\n' +
40
- "// ✅ Works — set messages in JavaScript as a property\n" +
41
- "const chat = document.querySelector('kai-chat');\n" +
42
- "chat.messages = [{ id: '1', role: 'assistant', parts: [{ type: 'text', text: 'Hello!' }] }];\n" +
43
- '```\n\n' +
44
- '```html\n' +
45
- '<!-- ❌ Fails — messages cannot be an HTML attribute -->\n' +
46
- '<kai-chat messages="[...]"></kai-chat>\n' +
47
- '```',
48
- },
49
- {
50
- // Rule 2 — in-place mutation → no re-render
51
- // Source: for-ai-agents.mdx §3; context7.json rule 4
52
- id: 'in-place-mutation',
53
- test: (t) =>
54
- /don'?t\s+update|doesn'?t\s+re.?render|no\s+re.?render|\.push\(|\bpush(?:es|ing)?\s+(?:to|into|onto)\b|mutate|in.place/.test(t),
55
- title: 'In-place mutation does not trigger a re-render',
56
- cause:
57
- 'Mutating an existing message object or array in place (e.g. `chat.messages.push(…)` ' +
58
- 'or `chat.messages[i].parts = […]`) does not trigger a re-render. ' +
59
- 'The element only reacts when it detects a new array/object reference.',
60
- fix:
61
- 'Assign a NEW array (and a new object) on every change — never mutate in place.\n\n' +
62
- '```js\n' +
63
- '// ✅ Triggers re-render — new array + new object reference\n' +
64
- 'chat.messages = [\n' +
65
- ' ...chat.messages,\n' +
66
- " { id: crypto.randomUUID(), role: 'user', parts: [{ type: 'text', text: userText }] },\n" +
67
- '];\n\n' +
68
- '// ✅ During streaming: new array + new object per chunk, and FOLD the delta\n' +
69
- "// onto the trailing text part so reasoning/tool/card parts survive.\n" +
70
- "import { appendTextPart } from '@kitn.ai/ui/state';\n" +
71
- 'chat.messages = chat.messages.map((m) =>\n' +
72
- ' m.id === assistantId ? { ...m, parts: appendTextPart(m.parts, delta) } : m\n' +
73
- ');\n\n' +
74
- '// ❌ Does NOT trigger re-render\n' +
75
- 'chat.messages.push(newMsg);\n' +
76
- 'chat.messages[i].parts = appendTextPart(chat.messages[i].parts, delta);\n\n' +
77
- '// ❌ Re-renders, but DROPS the reasoning/tool/card parts already on the message\n' +
78
- 'chat.messages = chat.messages.map((m) =>\n' +
79
- " m.id === assistantId ? { ...m, parts: [{ type: 'text', text: accumulated }] } : m\n" +
80
- ');\n' +
81
- '```\n\n' +
82
- 'The ergonomic path: helpers in `@kitn.ai/ui/state` (`appendMessage`, `updateMessage`, `appendText`) ' +
83
- 'and `createAssistantStream` handle the new-reference contract for you. ' +
84
- '`useKaiChat` (React) and `createKaiChat` (Solid) own state entirely so mutation is never an option.\n\n' +
85
- '// setMessages((m) => appendMessage(m, msg)) // new array, no footgun',
86
- },
87
- {
88
- // Rule 3 — listening for events on a parent / wrong element
89
- // Source: for-ai-agents.mdx §2; context7.json rule 3
90
- id: 'event-bubbling',
91
- test: (t) =>
92
- /event.*not\s+fir|not\s+fir.*event|listen.*document|document.*listen|listen.*parent|parent.*listen|event.*bubbl/i.test(
93
- t,
94
- ),
95
- title: 'Listening for events on the wrong element (events are non-bubbling)',
96
- cause:
97
- '`kai-*` events are non-bubbling CustomEvents. Adding a listener to `document`, ' +
98
- '`window`, or a parent container will never fire because the event does not bubble up.',
99
- fix:
100
- 'Listen directly on the `kai-*` element. ' +
101
- 'The submit event is `kai-submit` with `event.detail.value`.\n\n' +
102
- '```js\n' +
103
- "const chat = document.querySelector('kai-chat');\n\n" +
104
- "// ✅ Listen directly on the element\n" +
105
- "chat.addEventListener('kai-submit', (e) => {\n" +
106
- ' console.log(e.detail.value); // the text the user typed\n' +
107
- '});\n\n' +
108
- "// ❌ Never fires — kai-submit does not bubble\n" +
109
- "document.addEventListener('kai-submit', handler);\n" +
110
- '```\n\n' +
111
- 'Common events: `kai-submit`, `kai-feedback`, `kai-model-change`, `kai-new-chat`, `kai-select`.',
112
- },
113
- {
114
- // Rule 4 — wrong element prefix kitn-
115
- // Source: context7.json rule 1
116
- id: 'wrong-prefix',
117
- test: (t) => /\bkitn-/.test(t),
118
- title: 'Wrong element prefix `kitn-` (should be `kai-`)',
119
- cause:
120
- 'The custom element prefix is `kai-` (e.g. `<kai-chat>`, `<kai-artifact>`). ' +
121
- '`kitn-` is a legacy name (the register-all bundle is `kai.es.js`) — it is not a ' +
122
- 'registered element name. Using `<kitn-chat>` results in an unknown element that renders nothing.',
123
- fix:
124
- 'Replace the `kitn-` prefix with `kai-` everywhere.\n\n' +
125
- '```html\n' +
126
- '<!-- ✅ Correct element prefix -->\n' +
127
- '<kai-chat></kai-chat>\n' +
128
- '<kai-artifact></kai-artifact>\n\n' +
129
- '<!-- ❌ Wrong — kitn-chat is not an element (the bundle is kai.es.js) -->\n' +
130
- '<kitn-chat></kitn-chat>\n' +
131
- '```',
132
- },
133
- {
134
- // Rule 6 — custom elements not registered / renders nothing (React #1 failure)
135
- // Source: field-test reports; for-ai-agents.mdx §"Import order matters"
136
- id: 'elements-not-registered',
137
- test: (t) => {
138
- // Core render-nothing / unregistered-element signals
139
- if (
140
- /renders?\s+nothing|nothing\s+renders?|not\s+registered|unregistered|not\s+upgraded|unknown\s+element|customElements\.get|undefined\s+element|no\s+shadow\s+root/.test(t)
141
- )
142
- return true;
143
- // "empty" / "blank" / "doesn't render" / "won't render" only fire when
144
- // a render/element/component context is also present to avoid false positives
145
- if (
146
- /\b(empty|blank)\b/.test(t) &&
147
- /render|element|component|kai-|<[a-z]+-|shadow/.test(t)
148
- )
149
- return true;
150
- if (
151
- /doesn'?t\s+render|won'?t\s+render/.test(t) &&
152
- /kai-|element|component|custom.?element/.test(t)
153
- )
154
- return true;
155
- return false;
156
- },
157
- title: 'Custom elements not registered — renders nothing / empty box',
158
- cause:
159
- 'The `@kitn.ai/ui/react` wrappers (and bare `<kai-*>` tags) do NOT register the ' +
160
- 'custom elements by themselves. Without the element-registration side-effect import, ' +
161
- '`<kai-chat>` / `<Chat>` is an un-upgraded unknown element — an empty box. ' +
162
- '`customElements.get(\'kai-chat\') === undefined`.',
163
- fix:
164
- 'Import the elements bundle for its side effect BEFORE your first render — ' +
165
- 'it must run before the component mounts.\n\n' +
166
- '```tsx\n' +
167
- "import '@kitn.ai/ui/elements' // registers <kai-*> — REQUIRED, must come first\n" +
168
- "import { Chat } from '@kitn.ai/ui/react'\n" +
169
- "import '@kitn.ai/ui/theme.css'\n" +
170
- '```\n\n' +
171
- 'In plain HTML: `import \'@kitn.ai/ui/elements\'` in your module script. ' +
172
- 'The import is a side effect — keep it even if your linter flags it as "unused".',
173
- },
174
- {
175
- // Rule 7 — tsc errors inside node_modules/@kitn.ai/ui/src (SolidJS source pulled in)
176
- // Source: field-test reports; packaging gap (tracked upstream)
177
- id: 'tsc-source-pull',
178
- test: (t) =>
179
- /node_modules\/@kitn\.ai\/ui/.test(t) &&
180
- /tsc|TS2786|cannot\s+be\s+used\s+as\s+a\s+jsx\s+component|Show\b|Portal\b|Dynamic\b|error\s+TS|type\s+error/.test(
181
- t,
182
- ),
183
- title: 'tsc errors inside node_modules/@kitn.ai/ui/src (SolidJS source compiled under React)',
184
- cause:
185
- 'The package currently ships TypeScript/TSX source, and a type entry value-re-exports ' +
186
- 'from it, so the consumer\'s `tsc` resolves and compiles the library\'s SolidJS internals ' +
187
- '(`src/ui/*.tsx`) under the app\'s React JSX config — `Show`/`Portal`/`Dynamic` aren\'t ' +
188
- 'React components, causing TS2786 / "cannot be used as a JSX component" errors. ' +
189
- '`vite`/esbuild build fine (they strip types); only `tsc` breaks. ' +
190
- '`skipLibCheck` does not help (these are `.tsx` source, not `.d.ts`).',
191
- fix:
192
- 'Redirect the type resolution for that subpath in your tsconfig ' +
193
- '(Vite ignores tsconfig `paths`, so runtime is unaffected):\n\n' +
194
- '```jsonc\n' +
195
- '// tsconfig (app)\n' +
196
- '"baseUrl": ".",\n' +
197
- '"paths": { "@kitn.ai/ui/elements": ["./src/stubs/kitn-elements.d.ts"] }\n' +
198
- '```\n\n' +
199
- '```ts\n' +
200
- '// src/stubs/kitn-elements.d.ts\n' +
201
- 'export {}\n' +
202
- '```\n\n' +
203
- '(This is a known packaging gap being tracked upstream.)',
204
- },
205
- {
206
- // Rule 8 — fetch('/api/chat') 404 in a Vite SPA (no server-side routes)
207
- // Source: field-test reports; common scaffold confusion
208
- id: 'vite-api-404',
209
- test: (t) => {
210
- // /api/chat 404
211
- if (/\/api\/chat/.test(t) && /\b404\b|not\s+found/i.test(t)) return true;
212
- // Vite + missing API route / route handler / POST
213
- if (/\bvite\b/.test(t) && /api\s+route|route\s+handler|\bPOST\b.*not\s+work/.test(t)) return true;
214
- // Next.js route handler used in a Vite app
215
- if (/next\.?js.*route|route.*next\.?js/.test(t) && /\bvite\b/.test(t)) return true;
216
- return false;
217
- },
218
- title: 'fetch(\'/api/chat\') 404 — Vite SPA has no server-side API routes',
219
- cause:
220
- 'A plain Vite/CRA React SPA has no server — there are no `/api` routes. ' +
221
- 'A scaffolded Next.js route handler (`export async function POST`) does not run there, ' +
222
- 'so `fetch(\'/api/chat\')` 404s.',
223
- fix:
224
- 'Either run the backend somewhere real, or skip it entirely for local dev:\n\n' +
225
- '```ts\n' +
226
- '// Option A — use Next.js where route handlers are supported\n' +
227
- "// app/api/chat/route.ts: export async function POST(req) { ... }\n\n" +
228
- '// Option B — add a Vite dev-server middleware/proxy\n' +
229
- "// vite.config.ts: server: { proxy: { '/api': 'http://localhost:3001' } }\n\n" +
230
- '// Option C — run a separate Express/Hono server\n' +
231
- "// framework: 'express' in your harness config\n\n" +
232
- '// Option D — zero-config local dev with mock integration (no backend needed)\n' +
233
- "// Use `integration: 'mock'` in the scaffold tool\n" +
234
- '```',
235
- },
236
- {
237
- // Rule 9 — reduce bundle size / footprint / "how much does @kitn.ai/ui add"
238
- // Source: dist/elements/<file>.js per-element exports; dist/autoloader.js
239
- id: 'bundle-footprint',
240
- test: (t) =>
241
- /bundle\s*size|footprint|tree.?shak|how\s+much.*does.*@kitn|reduce.*import|import.*only.*element|per.?element\s+import|autoload|cdn.*no.?build|no.?build.*cdn/i.test(
242
- t,
243
- ),
244
- title: 'Reducing bundle footprint — three load modes',
245
- cause:
246
- 'The default `import \'@kitn.ai/ui/elements\'` registers every `kai-*` element. ' +
247
- 'If your page uses only one or two elements, that pulls in the full ~119 KB gz bundle. ' +
248
- 'Two opt-in modes let you load only what you need.',
249
- fix:
250
- '**Mode 1 — register-all (default, SSR-safe):**\n' +
251
- 'Best for multi-element apps or any SSR/meta-framework. ' +
252
- 'Load once and every `kai-*` element is available.\n\n' +
253
- '```js\n' +
254
- "import '@kitn.ai/ui/elements'; // ~119 KB gz — registers everything\n" +
255
- '```\n\n' +
256
- '**Mode 2 — per-element import (tree-shaking, bundler apps):**\n' +
257
- 'Use `import \'@kitn.ai/ui/elements/<file>\'` to register only one element. ' +
258
- 'A bundler (Vite, webpack, Rollup) will tree-shake to just its chunks (~73 KB gz for `kai-chat` alone). ' +
259
- 'Client-only — do not use in SSR entry points.\n\n' +
260
- '```js\n' +
261
- "// Registers only <kai-chat> (~73 KB gz vs ~119 KB gz register-all)\n" +
262
- "import '@kitn.ai/ui/elements/chat';\n\n" +
263
- "// Other examples:\n" +
264
- "import '@kitn.ai/ui/elements/code-block'; // <kai-code-block>\n" +
265
- "import '@kitn.ai/ui/elements/confirm-card'; // <kai-confirm>\n" +
266
- '```\n\n' +
267
- 'The file name is the element\'s source basename from `element-manifest.json` ' +
268
- '(e.g. `kai-chat` → `chat`, `kai-confirm` → `confirm-card`).\n\n' +
269
- '**Mode 3 — autoloader (no-build / CDN pages only):**\n' +
270
- 'Watches the DOM and dynamically imports each `kai-*` element\'s module on demand. ' +
271
- 'A page that uses only `<kai-chat>` never downloads the other elements. ' +
272
- 'It is a CDN / static-file tool — load it from a `<script type="module">` tag. ' +
273
- 'It is NOT importable through a bundler: Vite/webpack relocate it and the on-demand imports 404. ' +
274
- 'Client-only.\n\n' +
275
- '```html\n' +
276
- '<script type="module" src="https://cdn.jsdelivr.net/npm/@kitn.ai/ui@<version>/dist/elements/autoloader.js"></script>\n' +
277
- '```\n\n' +
278
- 'In a BUNDLED app (Vite/webpack/Next) use Mode 1 or Mode 2 instead — not the autoloader.\n\n' +
279
- '**SSR note:** use Mode 1 (register-all) in SSR apps — ' +
280
- 'per-element imports and the autoloader are client-only (they call DOM APIs at module eval). ' +
281
- 'Modes 1 & 2 are side-effect imports; keep them even if your linter flags them as "unused".',
282
- },
283
- {
284
- // Rule 5 — SSR / server component / document is not defined
285
- // Source: for-ai-agents.mdx (client-only import); context7.json rule 2 (property rule requires DOM)
286
- id: 'ssr-server-component',
287
- test: (t) => {
288
- // Core SSR signals — always trigger
289
- if (/\bssr\b|server\s+component|document\s+is\s+not\s+defined|window\s+is\s+not\s+defined|next\.?js.*server|server.*next\.?js/.test(t)) return true;
290
- // "hydration" only triggers when a web-component / kai context is also present
291
- if (/hydration/.test(t) && /kai|web.?component|custom.?element|<[a-z]+-/.test(t)) return true;
292
- return false;
293
- },
294
- title: 'SSR / server-side rendering — element requires the browser DOM',
295
- cause:
296
- '`kai-*` elements are client-side web components. They require `document` and ' +
297
- '`customElements` to register and render. Importing them in a server component ' +
298
- '(Next.js App Router server component, Nuxt SSR, etc.) throws ' +
299
- '"document is not defined" or silently produces no output.',
300
- fix:
301
- 'Register the element on the client only. ' +
302
- 'Use your framework\'s "client-only" / island / dynamic-import pattern.\n\n' +
303
- '```js\n' +
304
- "// ✅ Plain HTML / vanilla — import in a <script type=\"module\">\n" +
305
- "import '@kitn.ai/ui/elements';\n\n" +
306
- '// ✅ Next.js App Router — mark the component with "use client"\n' +
307
- "'use client';\n" +
308
- "import '@kitn.ai/ui/elements';\n\n" +
309
- '// ✅ Next.js — dynamic import with ssr: false\n' +
310
- "import dynamic from 'next/dynamic';\n" +
311
- "const KaiChat = dynamic(() => import('@kitn.ai/ui/elements').then(() => 'kai-chat'), { ssr: false });\n\n" +
312
- '// ✅ React wrapper (already client-safe)\n' +
313
- "import { Chat } from '@kitn.ai/ui/react';\n" +
314
- '```',
315
- },
316
- {
317
- // Rule 10 — toast() is the imperative API; there is no <kai-toast> to place
318
- // Source: src/primitives/toast-store.ts (the `toast` fn + auto-mounted region)
319
- id: 'toast-imperative',
320
- test: (t) => {
321
- // Placing a toast element by hand (the region auto-mounts — you never write it).
322
- if (/<kai-toast(-region)?\b/.test(t)) return true;
323
- // Asking how to show / trigger a toast or notification with kai context.
324
- if (
325
- /\btoast(s)?\b|notification|snackbar/i.test(t) &&
326
- /how.*(show|raise|trigger|fire|display)|show.*toast|raise.*toast|trigger.*toast|toast.*(not|isn'?t|won'?t).*(show|appear|render)|where.*toast|add.*toast|kai-|@kitn/i.test(t)
327
- )
328
- return true;
329
- return false;
330
- },
331
- title: 'Toast is an imperative call — `toast(\'…\')`, not a `<kai-toast>` you place',
332
- cause:
333
- 'Toasts are raised IMPERATIVELY by calling `toast(message)` — there is no ' +
334
- '`<kai-toast>` element you add to your markup. The first call lazily mounts ONE ' +
335
- '`<kai-toast-region>` on `document.body` (a real, kit-styled, viewport-positioned ' +
336
- 'element) and every later toast feeds that same region. Trying to place a toast ' +
337
- 'element by hand, or looking for a `messages`/`toasts` prop to push into, is the ' +
338
- 'wrong model.',
339
- fix:
340
- 'Import `toast` and call it. It is exported from BOTH the root `@kitn.ai/ui` and ' +
341
- 'the `@kitn.ai/ui/elements` bundle, so the web-components-only consumer gets it too. ' +
342
- 'It is SSR-safe (no DOM is touched until the first call on the client).\n\n' +
343
- '```js\n' +
344
- "import { toast } from '@kitn.ai/ui/elements'; // or '@kitn.ai/ui'\n\n" +
345
- "// ✅ Fire-and-forget\n" +
346
- "toast('Copied to clipboard');\n" +
347
- "toast.success('Saved');\n\n" +
348
- "// ✅ With an Undo action + an imperative handle\n" +
349
- "const t = toast('Item deleted', {\n" +
350
- " action: { label: 'Undo', onAction: () => restore() },\n" +
351
- '});\n' +
352
- "t.update({ message: 'Restored', variant: 'success' });\n" +
353
- 't.dismiss();\n' +
354
- '```\n\n' +
355
- 'The auto-mounted `<kai-toast-region>` carries its own shadow root + kit styles — ' +
356
- 'do NOT add a `<kai-toast-region>` tag yourself unless you deliberately want a ' +
357
- 'second, declaratively-controlled region.',
358
- },
359
- {
360
- // Rule 11 — dismissed cards are DEFERRED (reopenable stub), not deleted
361
- // Source: src/primitives/card-recovery.ts (dismissRecovery) + the dismissed stub
362
- id: 'card-dismiss-deferred',
363
- test: (t) => {
364
- const cardCtx = /\bcard(s)?\b|envelope|kai-card|kai-cards|kai-confirm|kai-choice|kai-tasks|kai-form|generative.?ui|resolution|dismissRecovery/i;
365
- if (!cardCtx.test(t)) return false;
366
- // dismiss / reopen / undo / disappear / filter-out signals in a card context.
367
- return /dismiss|reopen|re-?open|\bundo\b|disappear|remove.*card|card.*(gone|remove|delete|vanish)|filter.*out|stub/i.test(t);
368
- },
369
- title: 'Dismissed cards are DEFERRED (a reopenable stub), not deleted',
370
- cause:
371
- 'Dismissing a generative-UI card does NOT delete its envelope from history. The ' +
372
- 'card stamps a `{ kind: \'dismissed\' }` resolution onto its envelope and collapses ' +
373
- 'to a small reopenable stub ("Proposed: <title> — dismissed · Reopen"). If you ' +
374
- 'filter `dismissed` envelopes out of your cards array, the stub vanishes and the ' +
375
- 'user can never reopen it — and you lose the audit trail of what was proposed.',
376
- fix:
377
- 'Keep dismissed envelopes in the array. Wire dismiss/reopen with `dismissRecovery()` ' +
378
- '(from `@kitn.ai/ui`), which builds the `onDismiss`/`onReopen` half of a `CardPolicy` ' +
379
- 'over your store and can show a "Dismissed · Undo" toast via an injected adapter.\n\n' +
380
- '```ts\n' +
381
- "import { dismissRecovery } from '@kitn.ai/ui';\n" +
382
- "import { toast } from '@kitn.ai/ui/elements';\n\n" +
383
- '// Adapter: map dismissRecovery\'s toast shape onto the imperative toast().\n' +
384
- 'const toastAdapter = {\n' +
385
- ' show: ({ message, action, durationMs }) => {\n' +
386
- " const handle = toast(message, {\n" +
387
- ' duration: durationMs,\n' +
388
- ' action: action && { label: action.label, onAction: action.onClick },\n' +
389
- ' });\n' +
390
- ' return { dismiss: handle.dismiss };\n' +
391
- ' },\n' +
392
- '};\n\n' +
393
- 'const { onDismiss, onReopen } = dismissRecovery({\n' +
394
- ' get: () => cards, // your current envelopes\n' +
395
- ' set: (next) => setCards(next), // NEW array reference (never mutate in place)\n' +
396
- ' toast: toastAdapter,\n' +
397
- '});\n' +
398
- '// Pass these on the CardPolicy you hand to <kai-cards> / <kai-remote>.\n' +
399
- '```\n\n' +
400
- '`onDismiss` writes `dismissed` immutably (Undo restores the prior resolution); ' +
401
- '`onReopen` clears it back to live (or stamps `expired` when the host says the card ' +
402
- 'is no longer reopenable). Never mutate the array in place — re-render needs a new ref.',
403
- },
404
- {
405
- // Rule 12 — kai-compare contract: two candidates, JS data prop, stream both, terminal pick
406
- // Source: src/elements/compare.tsx + src/components/response-compare-types.ts
407
- id: 'compare-contract',
408
- test: (t) => {
409
- if (/<kai-compare\b|kai-compare-select|ResponseCompareData|response.?compare/i.test(t)) return true;
410
- // "compare two responses / candidates / A vs B" with a kai/UI context.
411
- if (
412
- /compar(e|ing|ison)|side.by.side|a\/b|two\s+(responses|candidates|answers|completions)|dual.?response/i.test(t) &&
413
- /kai-|@kitn|candidate|prefer(ence)?|chosen|reject/i.test(t)
414
- )
415
- return true;
416
- return false;
417
- },
418
- title: '`kai-compare` — two candidates, `data` as a JS property, terminal pick',
419
- cause:
420
- '`<kai-compare>` shows EXACTLY two assistant candidates for one prompt and lets the ' +
421
- 'user pick the better one. The `data` value is an array/object, so it must be set as ' +
422
- 'a JS PROPERTY (never an HTML attribute). Both candidates can stream — but, like ' +
423
- '`kai-chat`, that needs a NEW `data` reference per chunk (mutating in place will not ' +
424
- 're-render). The pick is a COMMIT (not a Submit): it fires once and the card collapses.',
425
- fix:
426
- 'Set `data` in JS with two candidates, stream by reassigning a fresh `data` object ' +
427
- 'per chunk, and listen for `kai-compare-select` directly on the element.\n\n' +
428
- '```ts\n' +
429
- "import { toast } from '@kitn.ai/ui/elements';\n" +
430
- "import type { ResponseCompareData, CompareSelection } from '@kitn.ai/ui';\n\n" +
431
- "const el = document.querySelector('kai-compare')!;\n" +
432
- '// data is a JS PROPERTY — exactly two candidates, each with a unique id.\n' +
433
- 'el.data = {\n' +
434
- " prompt: 'Summarise the report',\n" +
435
- ' candidates: [\n' +
436
- " { id: 'a', content: '', streaming: true },\n" +
437
- " { id: 'b', content: '', streaming: true },\n" +
438
- ' ],\n' +
439
- '} satisfies ResponseCompareData;\n\n' +
440
- '// Stream BOTH columns: replace data with a NEW object per chunk.\n' +
441
- "el.data = { ...el.data, candidates: [{ ...a, content: aText }, { ...b, content: bText }] };\n" +
442
- '// Clear `streaming` on a candidate when it settles — the pick stays disabled\n' +
443
- '// until BOTH have settled, then `kai-ready` fires.\n\n' +
444
- "// Picking is terminal: emits { chosenId, rejectedIds, at } and collapses.\n" +
445
- "el.addEventListener('kai-compare-select', (e) => {\n" +
446
- ' const { chosenId, rejectedIds } = (e as CustomEvent<CompareSelection>).detail;\n' +
447
- ' recordPreference({ prompt, chosen: chosenId, rejected: rejectedIds });\n' +
448
- '});\n' +
449
- '```\n\n' +
450
- 'A malformed definition (not two candidates, missing/duplicate ids) fires `kai-error` ' +
451
- 'instead. The event is non-bubbling — listen on the element, not on `document`.',
452
- },
453
- {
454
- // Rule 13 — kai-composer is the bare editor; attachments + send live on kai-prompt-input
455
- // Source: src/elements/composer.tsx (element doc), src/elements/prompt-input.tsx,
456
- // apps/docs components/composer.mdx (the taxonomy sentence). Rung-6 F-43.
457
- id: 'composer-attachments',
458
- test: (t) => {
459
- // Attachment / send-button / toolbar questions asked ABOUT the composer.
460
- if (!/kai-composer|composer\b/i.test(t)) return false;
461
- return /attach|paperclip|file.?upload|upload|send.?button|toolbar|staging|staged/i.test(t);
462
- },
463
- title: '`<kai-composer>` is the bare editor — attachments and the send button live on `<kai-prompt-input>`',
464
- cause:
465
- '`<kai-composer>` is deliberately the bare editing surface: rich text, entity pills, ' +
466
- 'triggers, Enter-to-submit — and nothing else. No send button, no toolbar, no attachment ' +
467
- 'surface; its `kai-submit` detail is `{ doc, text, entities }` with no `attachments` field. ' +
468
- 'Nothing is missing — the batteries-included wrapper is a different element.',
469
- fix:
470
- 'Reach for `<kai-prompt-input>`, which is built on the composer and adds the send button, ' +
471
- 'the toolbar, and attachments: a paperclip that stages files as chips, a ' +
472
- '`kai-attachments-change` event, and `attachments` on its `kai-submit` detail.\n\n' +
473
- '```html\n' +
474
- '<kai-prompt-input placeholder="Send a message..."></kai-prompt-input>\n' +
475
- '```\n\n' +
476
- '```js\n' +
477
- "document.querySelector('kai-prompt-input').addEventListener('kai-submit', (e) => {\n" +
478
- ' const { value, attachments } = e.detail; // attachments staged via the paperclip\n' +
479
- '});\n' +
480
- '```\n\n' +
481
- 'Keep `<kai-composer>` only when you are composing the input row yourself — then the ' +
482
- 'picker, staging tray and send control are yours to build, and every staged file’s ' +
483
- '`url` must be a `data:` URI, never `URL.createObjectURL` (see the attachment-blob-url rule).',
484
- },
485
- {
486
- // Rule 14 — blob: attachment URLs: the wire refuses them; use a data: URI
487
- // Source: src/components/attachment-types.ts (AttachmentData.url doc),
488
- // src/elements/default-input.tsx (readAsDataUrl), src/wire/files.ts (the refusal),
489
- // apps/docs patterns/attachments-flow.mdx. Rung-6 F-44; the defect PR #186 shipped.
490
- id: 'attachment-blob-url',
491
- test: (t) => {
492
- // The literal defect in a snippet, with attachment/file-staging context.
493
- if (/createObjectURL/.test(t) && /attachment|type:\s*'file'|filename|kai|@kitn/i.test(t)) return true;
494
- // A wire refusal or preview-works-send-fails symptom naming blob: URLs.
495
- if (/blob:/.test(t) && /attachment|toOpenAIMessages|toAnthropicMessages|wire|kai|@kitn/i.test(t)) return true;
496
- return false;
497
- },
498
- title: 'Never `URL.createObjectURL` in `AttachmentData.url` — read the file as a `data:` URI',
499
- cause:
500
- 'An object URL resolves only inside the browser tab that minted it, so `url: ' +
501
- 'URL.createObjectURL(file)` renders a flawless local preview and is meaningless to any ' +
502
- 'provider. `toOpenAIMessages` / `toAnthropicMessages` REFUSE a `blob:` URL rather than ' +
503
- 'send an address the model cannot fetch — before they refused it, an attachment-only ' +
504
- 'turn reached the model as nothing at all. A mock-only app hides the defect ' +
505
- '(`createMockResponder` never encodes the thread back); it surfaces the moment you point ' +
506
- 'at a real provider.',
507
- fix:
508
- 'Read every staged file as a `data:` URI and put THAT in `url` — it previews identically ' +
509
- 'and is the one form both provider wires actually take:\n\n' +
510
- '```js\n' +
511
- 'const readAsDataUrl = (file) =>\n' +
512
- ' new Promise((resolve, reject) => {\n' +
513
- ' const reader = new FileReader();\n' +
514
- ' reader.onload = () => resolve(String(reader.result));\n' +
515
- ' reader.onerror = () => reject(reader.error);\n' +
516
- ' reader.readAsDataURL(file);\n' +
517
- ' });\n\n' +
518
- "const url = await readAsDataUrl(file); // data: URI — never URL.createObjectURL\n" +
519
- "return { id, type: 'file', filename: file.name, mediaType: file.type, url };\n" +
520
- '```\n\n' +
521
- '`<kai-prompt-input>`’s built-in paperclip already does this for you; the conversion ' +
522
- 'is only yours when you stage files yourself. With `data:` URIs there is also nothing ' +
523
- 'to revoke — no object-URL lifecycle to manage.',
524
- },
525
- {
526
- // Rule 15 — mock tool calls: MockTurn.toolCalls scripts them; the HOST resolves them
527
- // Source: src/state/mock.ts (MockTurn/MockToolCall), src/wire/chunk.ts (ModelTurn.toolCalls),
528
- // src/state/stream.ts (upsertTool). Rung-6 F-46/F-47/F-52.
529
- id: 'mock-tool-calls',
530
- test: (t) => {
531
- const toolContext = /tool.?call|toolCalls|input-available/i.test(t);
532
- // The mock responder asked about tool calls…
533
- if (/createMockResponder|mock responder|MockTurn/i.test(t) && toolContext) return true;
534
- // …or a tool part parked in input-available with kai/mock context.
535
- if (toolContext && /\bmock\b/i.test(t) && /kai|@kitn|stream|responder/i.test(t)) return true;
536
- return false;
537
- },
538
- title: 'Scripting mock tool calls — `MockTurn.toolCalls`; the HOST resolves the announced call',
539
- cause:
540
- 'Two separate facts. (1) The default mock replies are text-only, so out of the box ' +
541
- '`createMockResponder()` never announces a tool call — scripting one takes a `MockTurn` ' +
542
- 'reply. (2) A tool call — mock or real provider — is only ever ANNOUNCED by the stream: ' +
543
- 'the part parks at `state: \'input-available\'` and stays there. The kit parses and ' +
544
- 'renders the call; EXECUTING it and answering is the host’s job.',
545
- fix:
546
- 'Script the call with a `MockTurn` reply (`{ text?, toolCalls? }`); the mock frames it ' +
547
- 'announce-then-arguments with `finish_reason: \'tool_calls\'`, exactly as a real ' +
548
- 'OpenAI-wire turn, so it flows through `readOpenAIStream` unchanged:\n\n' +
549
- '```js\n' +
550
- "import { createMockResponder } from '@kitn.ai/ui/state';\n\n" +
551
- 'const mock = createMockResponder({\n' +
552
- ' replies: [\n' +
553
- " 'Plain text turn.',\n" +
554
- " { text: 'Checking…', toolCalls: [{ name: 'get_weather', arguments: { city: 'Oslo' } }] },\n" +
555
- ' ],\n' +
556
- '});\n' +
557
- '```\n\n' +
558
- 'Then resolve each announced call yourself after the read settles — walk the returned ' +
559
- '`ModelTurn.toolCalls` and patch the part to `output-available`:\n\n' +
560
- '```js\n' +
561
- 'const result = await readOpenAIStream(response, stream);\n' +
562
- 'for (const call of result.toolCalls) {\n' +
563
- ' const output = await runTool(call.name, call.input); // your side of the seam\n' +
564
- " stream.upsertTool(call.id, { state: 'output-available', output });\n" +
565
- '}\n' +
566
- '```\n\n' +
567
- 'Skip any call with `providerExecuted: true` — the provider already ran it and its ' +
568
- 'result arrived in-stream.',
569
- },
570
- ];
571
-
572
- function buildText(matched: Rule[]): string {
573
- if (matched.length === 0) {
574
- return (
575
- 'No known failure pattern matched. Suggested next steps:\n\n' +
576
- '1. Use the `component_reference` tool to look up the real API for the element ' +
577
- '(prop names, event names, attribute vs. property distinction).\n' +
578
- '2. If the problem is in host code rather than an element — streaming, ' +
579
- '`createAssistantStream`, `createMockResponder`, the SSE readers, the encoders — ' +
580
- 'call `component_reference` with `{ name: "programmatic" }` for the full ' +
581
- '`@kitn.ai/ui/state` + `@kitn.ai/ui/wire` API, and `{ name: "composed-thread" }` ' +
582
- 'for a complete hand-composed surface to compare wiring against.\n' +
583
- '3. Check the **Streaming recipe** and the **Programmatic layer** sections in ' +
584
- '`llms-full.txt` (`node_modules/@kitn.ai/ui/llms-full.txt` or ' +
585
- 'https://ui.kitn.ai/llms-full.txt) for correct streaming wiring.\n' +
586
- '4. Paste `https://ui.kitn.ai/llms.txt` into your prompt for a compact orientation.'
587
- );
588
- }
589
-
590
- const sections = matched.map((rule, i) => {
591
- const n = i + 1;
592
- return `## ${n}. ${rule.title}\n\n**Cause:** ${rule.cause}\n\n**Fix:** ${rule.fix}`;
593
- });
594
-
595
- const header =
596
- matched.length === 1
597
- ? '1 likely cause found:\n\n'
598
- : `${matched.length} likely causes found:\n\n`;
599
-
600
- return header + sections.join('\n\n---\n\n');
601
- }
602
-
603
- export const debug: Tool = {
604
- name: 'debug',
605
- description:
606
- 'Diagnose common AI/UI (kai-*) integration issues. ' +
607
- 'Provide a `symptom` (prose description) and/or a `snippet` (code) ' +
608
- 'and receive the likely cause + fix for classic kai-* failure modes.',
609
- inputSchema: z.object({
610
- symptom: z.string().optional(),
611
- snippet: z.string().optional(),
612
- }),
613
- handler: async (args) => {
614
- const combined = `${(args.symptom as string | undefined) ?? ''} ${(args.snippet as string | undefined) ?? ''}`;
615
- const matched = RULES.filter((rule) => rule.test(combined));
616
-
617
- return {
618
- content: [{ type: 'text', text: buildText(matched) }],
619
- };
620
- },
621
- };