@contentful/experience-design-system-generation 2.28.1-dev-build-60a02cc.0 → 2.28.1-dev-build-090b2d1.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.
- package/dist/package.json +1 -1
- package/dist/src/agent-runner.d.ts +2 -0
- package/dist/src/agent-runner.js +11 -5
- package/package.json +2 -2
- package/skills/generate-components.md +43 -17
package/dist/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@contentful/experience-design-system-generation",
|
|
3
|
-
"version": "2.28.1-dev-build-
|
|
3
|
+
"version": "2.28.1-dev-build-090b2d1.0",
|
|
4
4
|
"description": "Agent-invocation and skill-prompt engine for the Contentful Experience Design System SDK",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -86,6 +86,8 @@ export interface ParsedTokenToolCalls {
|
|
|
86
86
|
export interface ParsedToolCalls {
|
|
87
87
|
calls: ToolCall[];
|
|
88
88
|
warnings: string[];
|
|
89
|
+
/** True when a line was lost outright (unparseable, or no `tool` field) — a retry signal, distinct from a parsed-but-rejected call. */
|
|
90
|
+
hadDroppedLine: boolean;
|
|
89
91
|
}
|
|
90
92
|
export declare function parseToolCallLines(stdout: string): ParsedToolCalls;
|
|
91
93
|
export declare function parseTokenToolCallLines(stdout: string): ParsedTokenToolCalls;
|
package/dist/src/agent-runner.js
CHANGED
|
@@ -26,12 +26,13 @@ function findJsonObjectEnd(line) {
|
|
|
26
26
|
return -1;
|
|
27
27
|
}
|
|
28
28
|
/**
|
|
29
|
-
* Reads an agent's stdout into
|
|
30
|
-
*
|
|
29
|
+
* Reads an agent's stdout into tool-call objects; non-`{` lines are prose.
|
|
30
|
+
* `hadDroppedLine` is true only when a line is lost outright, not rejected later.
|
|
31
31
|
*/
|
|
32
32
|
function readToolCallObjects(stdout) {
|
|
33
33
|
const objects = [];
|
|
34
34
|
const warnings = [];
|
|
35
|
+
let hadDroppedLine = false;
|
|
35
36
|
for (const raw of stdout.split('\n')) {
|
|
36
37
|
const line = raw.trim();
|
|
37
38
|
if (!line.startsWith('{'))
|
|
@@ -39,6 +40,7 @@ function readToolCallObjects(stdout) {
|
|
|
39
40
|
const end = findJsonObjectEnd(line);
|
|
40
41
|
if (end === -1) {
|
|
41
42
|
warnings.push(`unparseable line: ${line.slice(0, 120)}`);
|
|
43
|
+
hadDroppedLine = true;
|
|
42
44
|
continue;
|
|
43
45
|
}
|
|
44
46
|
let parsed;
|
|
@@ -47,6 +49,7 @@ function readToolCallObjects(stdout) {
|
|
|
47
49
|
}
|
|
48
50
|
catch {
|
|
49
51
|
warnings.push(`unparseable line: ${line.slice(0, 120)}`);
|
|
52
|
+
hadDroppedLine = true;
|
|
50
53
|
continue;
|
|
51
54
|
}
|
|
52
55
|
const trailing = line.slice(end + 1);
|
|
@@ -56,8 +59,11 @@ function readToolCallObjects(stdout) {
|
|
|
56
59
|
if (typeof parsed === 'object' && parsed !== null && 'tool' in parsed) {
|
|
57
60
|
objects.push(parsed);
|
|
58
61
|
}
|
|
62
|
+
else {
|
|
63
|
+
hadDroppedLine = true;
|
|
64
|
+
}
|
|
59
65
|
}
|
|
60
|
-
return { objects, warnings };
|
|
66
|
+
return { objects, warnings, hadDroppedLine };
|
|
61
67
|
}
|
|
62
68
|
export function parseSelectToolCallLines(stdout) {
|
|
63
69
|
const calls = [];
|
|
@@ -93,7 +99,7 @@ const VALID_CDF_TYPES = new Set(['string', 'richtext', 'media', 'enum', 'token',
|
|
|
93
99
|
const VALID_CATEGORIES = new Set(['content', 'design', 'state']);
|
|
94
100
|
export function parseToolCallLines(stdout) {
|
|
95
101
|
const calls = [];
|
|
96
|
-
const { objects, warnings } = readToolCallObjects(stdout);
|
|
102
|
+
const { objects, warnings, hadDroppedLine } = readToolCallObjects(stdout);
|
|
97
103
|
for (const rec of objects) {
|
|
98
104
|
if (!VALID_TOOL_NAMES.has(rec.tool)) {
|
|
99
105
|
warnings.push(`unknown tool: ${String(rec.tool)}`);
|
|
@@ -181,7 +187,7 @@ export function parseToolCallLines(stdout) {
|
|
|
181
187
|
calls.push(call);
|
|
182
188
|
}
|
|
183
189
|
}
|
|
184
|
-
return { calls, warnings };
|
|
190
|
+
return { calls, warnings, hadDroppedLine };
|
|
185
191
|
}
|
|
186
192
|
export function parseTokenToolCallLines(stdout) {
|
|
187
193
|
const calls = [];
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@contentful/experience-design-system-generation",
|
|
3
|
-
"version": "2.28.1-dev-build-
|
|
3
|
+
"version": "2.28.1-dev-build-090b2d1.0",
|
|
4
4
|
"description": "Agent-invocation and skill-prompt engine for the Contentful Experience Design System SDK",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -22,7 +22,7 @@
|
|
|
22
22
|
"skills/"
|
|
23
23
|
],
|
|
24
24
|
"dependencies": {
|
|
25
|
-
"@contentful/experience-design-system-types": "2.28.1-dev-build-
|
|
25
|
+
"@contentful/experience-design-system-types": "2.28.1-dev-build-090b2d1.0"
|
|
26
26
|
},
|
|
27
27
|
"devDependencies": {
|
|
28
28
|
"@tsconfig/node24": "^24.0.4",
|
|
@@ -91,7 +91,7 @@ Emit one JSON object per line. The CLI parses lines starting with `{`. Lines not
|
|
|
91
91
|
- Every prop in the input must produce exactly one call: `classify_prop` OR `exclude_prop`.
|
|
92
92
|
- Every slot must produce exactly one `classify_slot` call.
|
|
93
93
|
- Emit `classify_component` once at the start (required). The `description` field is **required** — always provide a brief description of the component's purpose.
|
|
94
|
-
- `values` is required for `cdf_type: "enum"` — must be a non-empty string array of the variant names the prop accepts.
|
|
94
|
+
- `values` is required for `cdf_type: "enum"` — must be a non-empty string array of the variant names the prop accepts. **There is no legal `enum` with a guessed list.** If the value set is shown to you anywhere in the material below — the type's own declaration, an `allowedValues` list on the raw prop, a variant/lookup map, a default, a sibling excerpt — copy it and emit `enum`. If it is shown nowhere, emit `cdf_type: "string"` and leave `values` off. `string` is an unrestricted enum: the author can still pass the real value. A guessed list silently rejects it.
|
|
95
95
|
- **Do NOT include `values` for `cdf_type: "token"`.** The two property types carry different kinds of list. An `enum` prop's list holds *variant names* the component accepts (`"primary"`, `"secondary"`). A `token` prop's list holds *design token paths* (`"color.brand.primary"`), produced by the separate token-mapping step (`$token.allowed`) — never by you. Emitting `values` on a token prop makes the definition invalid.
|
|
96
96
|
- `token_kind` is required for `cdf_type: "token"` — must be a DTCG `$type` string, e.g. `"color"`.
|
|
97
97
|
- `required` must be a JSON boolean (`true`/`false`), not a string.
|
|
@@ -208,12 +208,14 @@ the default "could be overridden" (every default can), or because the tie-break
|
|
|
208
208
|
below exists. Nothing downstream re-derives, corrects, or second-guesses this —
|
|
209
209
|
what you emit is what ships.
|
|
210
210
|
|
|
211
|
-
**Ambiguity resolves to `enum` — but only when Q1–Q3 cannot be answered
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
the use sits in a file you cannot see, or
|
|
215
|
-
of use (the "uses not shown" line). In those
|
|
216
|
-
|
|
211
|
+
**Ambiguity resolves to `enum` — but only when Q1–Q3 cannot be answered, and only
|
|
212
|
+
when you can still cite its values.** The tie-break applies solely when the source
|
|
213
|
+
shown does not let you answer the three questions: the property is interpolated
|
|
214
|
+
in one place and looked up in another, the use sits in a file you cannot see, or
|
|
215
|
+
the source is truncated at the point of use (the "uses not shown" line). In those
|
|
216
|
+
cases emit `enum` if a value set is citable from the source shown, else `cdf_type:
|
|
217
|
+
"string"` per "no legal `enum` with a guessed list" — either way, record the
|
|
218
|
+
ambiguity in `reason`. When the three
|
|
217
219
|
questions *can* be answered from the source shown, they are answered and the
|
|
218
220
|
tie-break does not apply: a clear Q1-yes is `enum`, a clear Q2-yes + Q3-yes is
|
|
219
221
|
`token`, and a type annotation does not create ambiguity. An `enum` is delivered
|
|
@@ -297,7 +299,7 @@ A prop with a complex TypeScript type is **not automatically excluded**. Many pr
|
|
|
297
299
|
| Raw type pattern | How to resolve |
|
|
298
300
|
|---|---|
|
|
299
301
|
| `'primary' \| 'secondary' \| 'ghost'` (union of literals) | → `enum`, extract `values` |
|
|
300
|
-
| `HeadingSize` / `ButtonVariant` / any named type that is clearly a finite set of visual options | → `enum
|
|
302
|
+
| `HeadingSize` / `ButtonVariant` / any named type that is clearly a finite set of visual options | → `enum` if you can cite its values from the source shown (the type's own declaration, a lookup table, a default) — copy them, never invent them. If the source shown does not enumerate the values, this is not the Q1–Q3 ambiguity tie-break — it is the "no legal `enum` with a guessed list" rule: emit `cdf_type: "string"` instead, with the missing evidence noted in `reason`. Do not default to a generic guess like `['sm', 'md', 'lg']` or `['primary', 'secondary']` — those are one design system's vocabulary, not a fallback for missing evidence. |
|
|
301
303
|
| `Variant` / `variant` prop | Usually a visual design variant. → `enum`, `cdf_category: "design"`. Same evidence rule as above — cite values from the source shown; do not invent them. |
|
|
302
304
|
| `Section[]` / array of custom items where the structure is unclear | → `exclude_prop` only if the array elements are complex objects with no obvious flat representation. If items are simple (title, label, id), consider representing as `string` (a comma-separated IDs or keys) or note in `description` why. |
|
|
303
305
|
| `ExperienceConfiguration<Variant>` / deep generic | Personalization config — → `exclude_prop`, reason: `"personalization configuration — framework internal"` |
|
|
@@ -364,7 +366,7 @@ as enum so the author picks "primary" and the component receives "primary".
|
|
|
364
366
|
|
|
365
367
|
---
|
|
366
368
|
|
|
367
|
-
## Category
|
|
369
|
+
## Category and required corrections
|
|
368
370
|
|
|
369
371
|
The pre-classified `category` is wrong in predictable ways. Correct silently (document in `description`):
|
|
370
372
|
|
|
@@ -375,6 +377,11 @@ The pre-classified `category` is wrong in predictable ways. Correct silently (do
|
|
|
375
377
|
|
|
376
378
|
> **Key question for category**: "Who fills this in?" — A content editor fills in `content`. A designer configures `design`. Neither fills in `state` — it comes from routing, runtime behavior, or component infrastructure.
|
|
377
379
|
|
|
380
|
+
**`required` is also a hint, and it is also wrong.** Verify it against the declaration:
|
|
381
|
+
- A prop with a default value — a `$default`, a destructure default, or a `defaultVariants` entry — is **never** `required: true`. The two together are incoherent.
|
|
382
|
+
- A prop declared `foo?:` is `required: false`, whatever the hint says.
|
|
383
|
+
- Props reached through `VariantProps<typeof x>` or a Radix/`ComponentPropsWithoutRef` base are optional unless the component's own interface redeclares them as required.
|
|
384
|
+
|
|
378
385
|
---
|
|
379
386
|
|
|
380
387
|
## Slot classification
|
|
@@ -462,14 +469,30 @@ footer is supplementary and optional
|
|
|
462
469
|
{"tool":"classify_slot","slot":"footer","required":false,"description":"Optional footer area for actions or metadata","rationale":"Footer is a supplementary region typically used for actions or metadata. Optional because most cards do not need one and the card renders correctly without it."}
|
|
463
470
|
```
|
|
464
471
|
|
|
465
|
-
### Named type (HeadingSize, ButtonVariant, etc.)
|
|
472
|
+
### Named type (HeadingSize, ButtonVariant, etc.) — do NOT infer the values
|
|
473
|
+
|
|
474
|
+
When a prop has a named TypeScript type that is not inlined as a union literal,
|
|
475
|
+
the value set is whatever that type's declaration says. A type *name* is not
|
|
476
|
+
evidence of its members: `HeadingSize` could be `h1`–`h6`, `sm|md|lg`, or
|
|
477
|
+
`s|m|l|xl`. Guessing picks one design system's vocabulary and is wrong more
|
|
478
|
+
often than it is right, and a wrong name matches no style rule — the author's
|
|
479
|
+
setting silently does nothing.
|
|
480
|
+
|
|
481
|
+
So: look for the declaration in the source shown. If it is there, copy it. If it
|
|
482
|
+
is not, **emit `string`** — `string` is an unrestricted enum, so the author stays
|
|
483
|
+
unrestricted but correct.
|
|
466
484
|
|
|
467
|
-
|
|
485
|
+
Members visible in the source shown — copy them, do not paraphrase:
|
|
486
|
+
```
|
|
487
|
+
titleSize has type HeadingSize; HeadingSize is declared in the excerpt as 'sm' | 'md' | 'lg'
|
|
488
|
+
{"tool":"classify_prop","prop":"titleSize","cdf_type":"enum","cdf_category":"design","required":false,"values":["sm","md","lg"],"description":"Heading size","reason":"Copied from the HeadingSize declaration shown in the excerpt."}
|
|
489
|
+
```
|
|
468
490
|
|
|
491
|
+
Members NOT visible in the source shown — degrade to `string`:
|
|
469
492
|
```
|
|
470
|
-
titleSize has type HeadingSize
|
|
471
|
-
|
|
472
|
-
{"tool":"classify_prop","prop":"titleSize","cdf_type":"
|
|
493
|
+
titleSize has type HeadingSize; HeadingSize is not declared anywhere in the source shown
|
|
494
|
+
no evidence for its members, so no values list — string, not a guess
|
|
495
|
+
{"tool":"classify_prop","prop":"titleSize","cdf_type":"string","cdf_category":"design","required":false,"description":"Heading size","reason":"HeadingSize is not declared in the source shown, so its members cannot be cited. Emitted as string rather than inventing a value list."}
|
|
473
496
|
```
|
|
474
497
|
|
|
475
498
|
### href prop
|
|
@@ -495,7 +518,7 @@ Before emitting any tool calls, verify:
|
|
|
495
518
|
1. Every prop in the input has exactly one `classify_prop` or `exclude_prop` call
|
|
496
519
|
2. Every slot has exactly one `classify_slot` call
|
|
497
520
|
3. `classify_component` is emitted exactly once
|
|
498
|
-
4. Every `cdf_type: "enum"` has a non-empty `values` array
|
|
521
|
+
4. Every `cdf_type: "enum"` has a non-empty `values` array taken from the material shown. A prop whose value set was shown nowhere is `cdf_type: "string"` with no `values` — never an `enum` with a plausible-looking list, and never an `exclude_prop`.
|
|
499
522
|
5. Every `cdf_type: "token"` has `token_kind` (or a warning in `description` if lookup failed) and does **not** have `values` set
|
|
500
523
|
6. No `cdf_type: "link"` — all href/url props use `string`
|
|
501
524
|
7. `required` values are JSON booleans, not strings
|
|
@@ -507,7 +530,8 @@ Before emitting any tool calls, verify:
|
|
|
507
530
|
13. `rationale.description` follows the same "Description content rules" as `description` — no internal initiative names (`INTEG-*`, `EDSI`, `DSI`, `M1`, `M2`, wave/phase references, etc.).
|
|
508
531
|
14. Every `cdf_type: "token"` prop cites a line that interpolates its value into a style **and** a token reference at that use (Q2 yes, Q3 yes), and carries no `values`. If you cannot cite both, it is `enum` or `string`; if you can, it is `token` — its type annotation is not a reason to emit `string`.
|
|
509
532
|
15. Every prop whose values are friendly names is `enum` with a non-empty `values` array, even when each name resolves to a design token internally; every prop for which Q1–Q3 could not be answered was emitted as `enum` (or `string`) with the ambiguity stated in `reason`, and no answerable prop was called ambiguous.
|
|
510
|
-
16. Every `enum`'s `values` array is copied from evidence in the
|
|
533
|
+
16. Every `enum`'s `values` array is copied from evidence in the material shown — a type declaration, an `allowedValues` list on the raw prop, a variant or lookup map, a default, in the component's own file or in any sibling excerpt — and none of it was invented. Where the value set appears nowhere, the prop is `cdf_type: "string"`, with the reason recorded in `reason`. Do not drop a prop merely because you could not enumerate its values.
|
|
534
|
+
17. No prop has `required: true` alongside a default value (`$default`, a destructure default, or a `defaultVariants` entry) — the two are incoherent. A prop declared `foo?:`, or reached through `VariantProps<typeof x>` or a Radix/`ComponentPropsWithoutRef` base without its own required redeclaration, is `required: false`.
|
|
511
535
|
|
|
512
536
|
After the run completes, the developer can validate the pipeline output with:
|
|
513
537
|
|
|
@@ -528,4 +552,6 @@ properties — this is never acceptable.
|
|
|
528
552
|
If you are genuinely uncertain about every prop, classify each as:
|
|
529
553
|
{"tool":"classify_prop","prop":"<name>","cdf_type":"string","cdf_category":"content","required":false,"description":"Uncertain classification — review recommended"}
|
|
530
554
|
|
|
531
|
-
An imperfect classification is infinitely better than no classification.
|
|
555
|
+
An imperfect classification is infinitely better than no classification. That is
|
|
556
|
+
about **classifying a prop rather than dropping it** — it is not a licence to
|
|
557
|
+
invent a `values` list. The uncertain answer is `cdf_type: "string"`, every time.
|