@contentful/experience-design-system-cli 2.5.2 → 2.5.3-dev-build-727fd69.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/README.md +3 -1
- package/dist/package.json +1 -1
- package/dist/src/apply/api-client.js +2 -6
- package/package.json +2 -2
- package/skills/generate-components.md +2 -2
package/README.md
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
# @contentful/experience-design-system-cli
|
|
2
2
|
|
|
3
|
-
CLI for extracting, reviewing, generating, validating, and pushing Contentful Experience Design System component definitions.
|
|
3
|
+
CLI for extracting, reviewing, generating, validating, and pushing Contentful Experience Design System component definitions into [Experience Orchestration (ExO)](https://www.contentful.com/help/experience-orchestration/).
|
|
4
|
+
|
|
5
|
+
**Binary names:** `experiences` (primary), `exo` (alias), `experience-design-system-cli` (long-form). All three point to the same executable.
|
|
4
6
|
|
|
5
7
|
## Pipeline Overview
|
|
6
8
|
|
package/dist/package.json
CHANGED
|
@@ -48,12 +48,8 @@ export class ImportApiClient {
|
|
|
48
48
|
};
|
|
49
49
|
}
|
|
50
50
|
async validateToken() {
|
|
51
|
-
// /users/me is the canonical
|
|
52
|
-
//
|
|
53
|
-
// doesn't false-positive 401 for tokens that are entitled to call import endpoints
|
|
54
|
-
// but lack the role assignments public CMA's SpacesController/EnvironmentsController
|
|
55
|
-
// require. Per-space/per-org authorization is enforced by the design-systems API itself
|
|
56
|
-
// on the actual preview/apply call.
|
|
51
|
+
// /users/me is the canonical token-validity endpoint — avoids space-membership
|
|
52
|
+
// false positives that don't apply to the design-systems API authorization path.
|
|
57
53
|
const url = `${this.host}/users/me`;
|
|
58
54
|
const res = await request(url, { token: this.token });
|
|
59
55
|
if (res.status === 401) {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@contentful/experience-design-system-cli",
|
|
3
|
-
"version": "2.5.
|
|
3
|
+
"version": "2.5.3-dev-build-727fd69.0",
|
|
4
4
|
"description": "Contentful Experiences design system import CLI",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -32,7 +32,7 @@
|
|
|
32
32
|
"react-dom": "^18.3.1",
|
|
33
33
|
"ts-morph": "^27.0.2",
|
|
34
34
|
"typescript": "^5.9.3",
|
|
35
|
-
"@contentful/experience-design-system-types": "2.5.
|
|
35
|
+
"@contentful/experience-design-system-types": "2.5.3-dev-build-727fd69.0"
|
|
36
36
|
},
|
|
37
37
|
"devDependencies": {
|
|
38
38
|
"@tsconfig/node24": "^24.0.3",
|
|
@@ -109,7 +109,7 @@ Exactly **6** valid types:
|
|
|
109
109
|
| `token` | Design-token-linked prop — requires `token_kind` |
|
|
110
110
|
| `boolean` | Boolean toggle props (visible, disabled, enabled, etc.) |
|
|
111
111
|
|
|
112
|
-
> **IMPORTANT: No `number` type.** The
|
|
112
|
+
> **IMPORTANT: No `number` type.** The design-systems API only supports the `String` design property variant for numeric values. All numeric props must use `cdf_type: "string"` with the number as a string default (e.g. `"0"`, `"100"`). Boolean props can now use `cdf_type: "boolean"` directly.
|
|
113
113
|
|
|
114
114
|
> **Avoid `link` type for simple URL props.** Props named `href`, `url`, or holding plain URL strings → `cdf_type: "string"`, `cdf_category: "content"`. Reserve `link` for props that hold a reference to another Contentful entry.
|
|
115
115
|
|
|
@@ -337,7 +337,7 @@ Before emitting any tool calls, verify:
|
|
|
337
337
|
7. `required` values are JSON booleans, not strings
|
|
338
338
|
8. Framework internals (`ref`, event handlers, test IDs) are excluded — `className`, `style`, and `styles` are classified as `string` design props; discrete positional/geometric props (`top`, `bottom`, `left`, `right`, `rotation`, etc.) are also classified
|
|
339
339
|
9. No `cdf_type: "link"` used — `link` is reserved and rejected by the CLI parser
|
|
340
|
-
10. No `cdf_type: "number"` used — this is not a
|
|
340
|
+
10. No `cdf_type: "number"` used — this is not a supported type; use `"string"` with numeric defaults. `cdf_type: "boolean"` IS valid — use it for boolean toggle props.
|
|
341
341
|
|
|
342
342
|
After the run completes, the developer can validate the pipeline output with:
|
|
343
343
|
|