@contentful/experience-design-system-generation 2.32.1-dev-build-4663267.0 → 2.32.1-dev-build-3788447.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/package.json +2 -2
- package/skills/generate-components.md +36 -16
package/dist/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@contentful/experience-design-system-generation",
|
|
3
|
-
"version": "2.32.1-dev-build-
|
|
3
|
+
"version": "2.32.1-dev-build-3788447.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",
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@contentful/experience-design-system-generation",
|
|
3
|
-
"version": "2.32.1-dev-build-
|
|
3
|
+
"version": "2.32.1-dev-build-3788447.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.32.1-dev-build-
|
|
25
|
+
"@contentful/experience-design-system-types": "2.32.1-dev-build-3788447.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"` |
|
|
@@ -462,14 +464,30 @@ footer is supplementary and optional
|
|
|
462
464
|
{"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
465
|
```
|
|
464
466
|
|
|
465
|
-
### Named type (HeadingSize, ButtonVariant, etc.)
|
|
467
|
+
### Named type (HeadingSize, ButtonVariant, etc.) — do NOT infer the values
|
|
466
468
|
|
|
467
|
-
When a prop has a named TypeScript type that is not inlined as a union literal,
|
|
469
|
+
When a prop has a named TypeScript type that is not inlined as a union literal,
|
|
470
|
+
the value set is whatever that type's declaration says. A type *name* is not
|
|
471
|
+
evidence of its members: `HeadingSize` could be `h1`–`h6`, `sm|md|lg`, or
|
|
472
|
+
`s|m|l|xl`. Guessing picks one design system's vocabulary and is wrong more
|
|
473
|
+
often than it is right, and a wrong name matches no style rule — the author's
|
|
474
|
+
setting silently does nothing.
|
|
468
475
|
|
|
476
|
+
So: look for the declaration in the source shown. If it is there, copy it. If it
|
|
477
|
+
is not, **emit `string`** — `string` is an unrestricted enum, so the author stays
|
|
478
|
+
unrestricted but correct.
|
|
479
|
+
|
|
480
|
+
Members visible in the source shown — copy them, do not paraphrase:
|
|
481
|
+
```
|
|
482
|
+
titleSize has type HeadingSize; HeadingSize is declared in the excerpt as 'sm' | 'md' | 'lg'
|
|
483
|
+
{"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."}
|
|
484
|
+
```
|
|
485
|
+
|
|
486
|
+
Members NOT visible in the source shown — degrade to `string`:
|
|
469
487
|
```
|
|
470
|
-
titleSize has type HeadingSize
|
|
471
|
-
|
|
472
|
-
{"tool":"classify_prop","prop":"titleSize","cdf_type":"
|
|
488
|
+
titleSize has type HeadingSize; HeadingSize is not declared anywhere in the source shown
|
|
489
|
+
no evidence for its members, so no values list — string, not a guess
|
|
490
|
+
{"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
491
|
```
|
|
474
492
|
|
|
475
493
|
### href prop
|
|
@@ -495,7 +513,7 @@ Before emitting any tool calls, verify:
|
|
|
495
513
|
1. Every prop in the input has exactly one `classify_prop` or `exclude_prop` call
|
|
496
514
|
2. Every slot has exactly one `classify_slot` call
|
|
497
515
|
3. `classify_component` is emitted exactly once
|
|
498
|
-
4. Every `cdf_type: "enum"` has a non-empty `values` array
|
|
516
|
+
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
517
|
5. Every `cdf_type: "token"` has `token_kind` (or a warning in `description` if lookup failed) and does **not** have `values` set
|
|
500
518
|
6. No `cdf_type: "link"` — all href/url props use `string`
|
|
501
519
|
7. `required` values are JSON booleans, not strings
|
|
@@ -507,7 +525,7 @@ Before emitting any tool calls, verify:
|
|
|
507
525
|
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
526
|
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
527
|
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
|
|
528
|
+
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.
|
|
511
529
|
|
|
512
530
|
After the run completes, the developer can validate the pipeline output with:
|
|
513
531
|
|
|
@@ -528,4 +546,6 @@ properties — this is never acceptable.
|
|
|
528
546
|
If you are genuinely uncertain about every prop, classify each as:
|
|
529
547
|
{"tool":"classify_prop","prop":"<name>","cdf_type":"string","cdf_category":"content","required":false,"description":"Uncertain classification — review recommended"}
|
|
530
548
|
|
|
531
|
-
An imperfect classification is infinitely better than no classification.
|
|
549
|
+
An imperfect classification is infinitely better than no classification. That is
|
|
550
|
+
about **classifying a prop rather than dropping it** — it is not a licence to
|
|
551
|
+
invent a `values` list. The uncertain answer is `cdf_type: "string"`, every time.
|