@adobe/design-data-spec 0.1.0 → 0.1.1
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/LICENSE +201 -0
- package/conformance/README.md +27 -26
- package/conformance/invalid/SPEC-014/expected-errors.json +10 -0
- package/conformance/invalid/SPEC-014/tokens.tokens.json +9 -0
- package/conformance/valid/lifecycle-with-last-modified.json +12 -0
- package/package.json +2 -3
- package/rules/rules.yaml +9 -0
- package/schemas/token.schema.json +8 -0
- package/spec/evolution.md +33 -32
- package/spec/manifest.md +3 -1
- package/spec/taxonomy.md +17 -1
- package/spec/token-format.md +14 -10
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "{}"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/conformance/README.md
CHANGED
|
@@ -16,6 +16,7 @@ Each **invalid** case lives under `invalid/<RULE_ID>/` with:
|
|
|
16
16
|
| `invalid/SPEC-005` | SPEC-005 | Dimension `default` not in `modes`. |
|
|
17
17
|
| `invalid/SPEC-006` | SPEC-006 | Ambiguous resolution / specificity tie (warning). |
|
|
18
18
|
| `invalid/SPEC-008` | SPEC-008 | Non-default mode variants with no base/default variant. |
|
|
19
|
+
| `invalid/SPEC-014` | SPEC-014 | `lastModified` semver precedes `introduced`. |
|
|
19
20
|
|
|
20
21
|
Implementors SHOULD run these fixtures once the Rust validator exposes rule IDs ([#724](https://github.com/adobe/spectrum-design-data/issues/724), [#725](https://github.com/adobe/spectrum-design-data/issues/725)).
|
|
21
22
|
|
|
@@ -48,20 +49,20 @@ Each **diff** case lives under `diff/<name>/` with:
|
|
|
48
49
|
* `new/` — new token dataset
|
|
49
50
|
* `expected.json` — full `DiffReport` structure (six category arrays: renamed, deprecated, reverted, added, deleted, updated)
|
|
50
51
|
|
|
51
|
-
| Folder
|
|
52
|
-
|
|
|
53
|
-
| `diff/identical-tokens`
|
|
54
|
-
| `diff/simple-add-delete`
|
|
55
|
-
| `diff/rename-by-uuid`
|
|
56
|
-
| `diff/deprecated-new-token`
|
|
57
|
-
| `diff/deprecated-set-level`
|
|
58
|
-
| `diff/reverted-token`
|
|
59
|
-
| `diff/matched-gaining-deprecated`
|
|
60
|
-
| `diff/property-value-update`
|
|
61
|
-
| `diff/property-nested-change`
|
|
62
|
-
| `diff/uuid-backfill`
|
|
63
|
-
| `diff/cross-format`
|
|
64
|
-
| `diff/rename-with-property-changes`
|
|
52
|
+
| Folder | Intent |
|
|
53
|
+
| ----------------------------------- | ------------------------------------------------------------------------------- |
|
|
54
|
+
| `diff/identical-tokens` | Two identical datasets MUST produce an empty diff (all arrays empty). |
|
|
55
|
+
| `diff/simple-add-delete` | One old-only token → deleted; one new-only token → added. |
|
|
56
|
+
| `diff/rename-by-uuid` | Same UUID, different name objects → renamed (not add + delete). |
|
|
57
|
+
| `diff/deprecated-new-token` | Unmatched new token with `deprecated: true` → deprecated (not added). |
|
|
58
|
+
| `diff/deprecated-set-level` | All set entries `deprecated: true` normalizes to token-level deprecated. |
|
|
59
|
+
| `diff/reverted-token` | Matched token that loses `deprecated` → reverted (not updated). |
|
|
60
|
+
| `diff/matched-gaining-deprecated` | Matched token that gains `deprecated` → updated (not deprecated). |
|
|
61
|
+
| `diff/property-value-update` | Matched token with changed `value` → updated with property change. |
|
|
62
|
+
| `diff/property-nested-change` | Nested object change reported at leaf path (e.g. `sets.light.value`). |
|
|
63
|
+
| `diff/uuid-backfill` | Old lacks UUID, new gains it with same name object → paired (not add + delete). |
|
|
64
|
+
| `diff/cross-format` | Legacy old + cascade new, paired by UUID across formats. |
|
|
65
|
+
| `diff/rename-with-property-changes` | Renamed token with additional value changes populates `property_changes`. |
|
|
65
66
|
|
|
66
67
|
The Rust SDK drives these fixtures in `sdk/core/src/lib.rs` (`diff_conformance` module, closes [#788](https://github.com/adobe/spectrum-design-data/issues/788)).
|
|
67
68
|
|
|
@@ -75,17 +76,17 @@ Each **query** case lives under `query/<name>/` with:
|
|
|
75
76
|
* `query.txt` — plain-text filter expression
|
|
76
77
|
* `expected.json` — sorted array of matched token UUIDs
|
|
77
78
|
|
|
78
|
-
| Folder
|
|
79
|
-
|
|
|
80
|
-
| `query/single-field`
|
|
81
|
-
| `query/and-conditions`
|
|
82
|
-
| `query/or-conditions`
|
|
83
|
-
| `query/negation`
|
|
84
|
-
| `query/wildcard-suffix`
|
|
85
|
-
| `query/wildcard-prefix`
|
|
86
|
-
| `query/empty-matches-all`
|
|
87
|
-
| `query/no-matches`
|
|
88
|
-
| `query/schema-key`
|
|
89
|
-
| `query/and-or-precedence`
|
|
79
|
+
| Folder | Intent |
|
|
80
|
+
| ------------------------- | ------------------------------------------------------- |
|
|
81
|
+
| `query/single-field` | Basic `key=value` equality filter. |
|
|
82
|
+
| `query/and-conditions` | `,` (AND) requires all conditions to match. |
|
|
83
|
+
| `query/or-conditions` | `\|` (OR) matches if any alternative matches. |
|
|
84
|
+
| `query/negation` | `!=` matches non-equal values and absent fields. |
|
|
85
|
+
| `query/wildcard-suffix` | Glob `*` at end of value matches prefix. |
|
|
86
|
+
| `query/wildcard-prefix` | Glob `*` at start of value matches suffix. |
|
|
87
|
+
| `query/empty-matches-all` | Empty filter expression is a universal match. |
|
|
88
|
+
| `query/no-matches` | Filter with no matching tokens returns empty result. |
|
|
89
|
+
| `query/schema-key` | `$schema` key queries the top-level `$schema` field. |
|
|
90
|
+
| `query/and-or-precedence` | AND binds tighter than OR: `a,b\|c` = `(a AND b) OR c`. |
|
|
90
91
|
|
|
91
92
|
The Rust SDK drives these fixtures in `sdk/core/src/lib.rs` (`query_conformance` module, closes [#788](https://github.com/adobe/spectrum-design-data/issues/788)).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@adobe/design-data-spec",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "Design Data Specification — prose, JSON Schemas, rule catalog, and conformance fixtures for Spectrum design data",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"repository": {
|
|
@@ -18,7 +18,6 @@
|
|
|
18
18
|
"node": ">=20.12.0",
|
|
19
19
|
"pnpm": ">=10.17.1"
|
|
20
20
|
},
|
|
21
|
-
"packageManager": "pnpm@10.17.1",
|
|
22
21
|
"exports": {
|
|
23
22
|
"./package.json": "./package.json",
|
|
24
23
|
"./schemas/token.schema.json": "./schemas/token.schema.json",
|
|
@@ -37,4 +36,4 @@
|
|
|
37
36
|
"README.md"
|
|
38
37
|
],
|
|
39
38
|
"scripts": {}
|
|
40
|
-
}
|
|
39
|
+
}
|
package/rules/rules.yaml
CHANGED
|
@@ -118,3 +118,12 @@ rules:
|
|
|
118
118
|
message: "Token {token} has plannedRemoval but is not marked deprecated"
|
|
119
119
|
spec_ref: spec/token-format.md#lifecycle-and-metadata
|
|
120
120
|
introduced_in: "1.0.0-draft"
|
|
121
|
+
|
|
122
|
+
- id: SPEC-014
|
|
123
|
+
name: last-modified-not-before-introduced
|
|
124
|
+
severity: error
|
|
125
|
+
category: completeness
|
|
126
|
+
assert: If lastModified is present, its semver MUST NOT precede introduced.
|
|
127
|
+
message: "Token {token} has lastModified {lastModified} earlier than introduced {introduced}"
|
|
128
|
+
spec_ref: spec/token-format.md#lifecycle-and-metadata
|
|
129
|
+
introduced_in: "1.0.0-draft"
|
|
@@ -131,6 +131,10 @@
|
|
|
131
131
|
"introduced": {
|
|
132
132
|
"type": "string"
|
|
133
133
|
},
|
|
134
|
+
"lastModified": {
|
|
135
|
+
"type": "string",
|
|
136
|
+
"description": "Spec version when token value or metadata last changed (e.g. \"2.1.0\"). MUST be >= introduced (see SPEC-014)."
|
|
137
|
+
},
|
|
134
138
|
"deprecated": {
|
|
135
139
|
"type": "string",
|
|
136
140
|
"description": "Spec version when token was deprecated (e.g. \"3.2.0\"). Truthy = deprecated."
|
|
@@ -188,6 +192,10 @@
|
|
|
188
192
|
"introduced": {
|
|
189
193
|
"type": "string"
|
|
190
194
|
},
|
|
195
|
+
"lastModified": {
|
|
196
|
+
"type": "string",
|
|
197
|
+
"description": "Spec version when token value or metadata last changed (e.g. \"2.1.0\"). MUST be >= introduced (see SPEC-014)."
|
|
198
|
+
},
|
|
191
199
|
"deprecated": {
|
|
192
200
|
"type": "string",
|
|
193
201
|
"description": "Spec version when token was deprecated (e.g. \"3.2.0\"). Truthy = deprecated."
|
package/spec/evolution.md
CHANGED
|
@@ -12,13 +12,13 @@ Tokens progress through the following lifecycle stages:
|
|
|
12
12
|
introduced → active → deprecated → planned removal → removed
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
-
| Stage | Token state
|
|
16
|
-
| ------------------- |
|
|
17
|
-
| **Introduced** | Token first appears in the dataset. `introduced` field records the version.
|
|
18
|
-
| **Active** | Token is current and recommended for use. No `deprecated` field.
|
|
15
|
+
| Stage | Token state |
|
|
16
|
+
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
17
|
+
| **Introduced** | Token first appears in the dataset. `introduced` field records the version. |
|
|
18
|
+
| **Active** | Token is current and recommended for use. No `deprecated` field. |
|
|
19
19
|
| **Deprecated** | Token is no longer recommended. `deprecated` records the version. Consumers receive warnings. `replaced_by` points to the successor token(s) when a direct replacement exists. |
|
|
20
|
-
| **Planned removal** | `plannedRemoval` records the target version. The token remains in the dataset but consumers should complete migration.
|
|
21
|
-
| **Removed** | Token is deleted from the dataset. Consumers that still reference it will break.
|
|
20
|
+
| **Planned removal** | `plannedRemoval` records the target version. The token remains in the dataset but consumers should complete migration. |
|
|
21
|
+
| **Removed** | Token is deleted from the dataset. Consumers that still reference it will break. |
|
|
22
22
|
|
|
23
23
|
### Lifecycle fields
|
|
24
24
|
|
|
@@ -28,10 +28,10 @@ See [Token format — Lifecycle and metadata](token-format.md#lifecycle-and-meta
|
|
|
28
28
|
|
|
29
29
|
When a token carries `replaced_by`:
|
|
30
30
|
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
31
|
+
* Each target UUID **MUST** resolve to an existing token in the dataset (rule `SPEC-010`).
|
|
32
|
+
* The target token **SHOULD NOT** itself be deprecated. Chains of replacements (A replaced by B, B replaced by C) are discouraged; authors should point directly to the final replacement.
|
|
33
|
+
* For a single UUID (1:1 replacement), consumers can mechanically rewrite references.
|
|
34
|
+
* For an array of UUIDs (one-to-many split), the `deprecated_comment` **MUST** explain which replacement applies in which context.
|
|
35
35
|
|
|
36
36
|
## Migration windows
|
|
37
37
|
|
|
@@ -49,27 +49,27 @@ The specification follows [Semantic Versioning](https://semver.org/) for its pub
|
|
|
49
49
|
|
|
50
50
|
### Minor changes (backward compatible)
|
|
51
51
|
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
52
|
+
* New tokens added to the dataset
|
|
53
|
+
* New optional fields added to token schema
|
|
54
|
+
* New validation rules added to the rule catalog
|
|
55
|
+
* Tokens deprecated (with `deprecated` field)
|
|
56
|
+
* Rule severity relaxed (error → warning)
|
|
57
|
+
* New enum values added to registries
|
|
58
58
|
|
|
59
59
|
### Major changes (breaking)
|
|
60
60
|
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
61
|
+
* Tokens removed from the dataset
|
|
62
|
+
* Required fields added to token schema
|
|
63
|
+
* Existing fields removed or type-changed
|
|
64
|
+
* Rule severity tightened (warning → error)
|
|
65
|
+
* Enum values removed from registries
|
|
66
|
+
* Constraint tightening (e.g. stricter value validation)
|
|
67
67
|
|
|
68
68
|
### Patch changes (clarifications)
|
|
69
69
|
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
70
|
+
* Typo fixes in spec prose
|
|
71
|
+
* Clarifications to normative text that do not change conformance behavior
|
|
72
|
+
* Test fixture additions or corrections
|
|
73
73
|
|
|
74
74
|
## Legacy format contract
|
|
75
75
|
|
|
@@ -79,13 +79,14 @@ The `@adobe/spectrum-tokens` package continues to publish tokens in the **legacy
|
|
|
79
79
|
|
|
80
80
|
### Lifecycle field mapping
|
|
81
81
|
|
|
82
|
-
| Cascade format
|
|
83
|
-
|
|
|
84
|
-
| `deprecated: "3.2.0"` (version string) | `deprecated: true` (boolean)
|
|
85
|
-
| `replaced_by: "<uuid>"` | `renamed: "<target-token-name>"`
|
|
86
|
-
| `introduced`
|
|
87
|
-
| `
|
|
88
|
-
| `
|
|
82
|
+
| Cascade format | Legacy format |
|
|
83
|
+
| -------------------------------------- | ------------------------------------- |
|
|
84
|
+
| `deprecated: "3.2.0"` (version string) | `deprecated: true` (boolean) |
|
|
85
|
+
| `replaced_by: "<uuid>"` | `renamed: "<target-token-name>"` |
|
|
86
|
+
| `introduced` | Not emitted |
|
|
87
|
+
| `lastModified` | Not emitted |
|
|
88
|
+
| `plannedRemoval` | Not emitted |
|
|
89
|
+
| `deprecated_comment` | `deprecated_comment` (passed through) |
|
|
89
90
|
|
|
90
91
|
### Coexistence during migration
|
|
91
92
|
|
package/spec/manifest.md
CHANGED
|
@@ -26,7 +26,9 @@ A manifest **MUST** conform to [`manifest.schema.json`](../schemas/manifest.sche
|
|
|
26
26
|
|
|
27
27
|
### `include` / `exclude`
|
|
28
28
|
|
|
29
|
-
**NORMATIVE:** Entries **MUST** be non-empty strings.
|
|
29
|
+
**NORMATIVE:** Entries **MUST** be non-empty strings.
|
|
30
|
+
|
|
31
|
+
> **Note:** Query notation syntax is fully defined in [Query](query.md) and is normative for programmatic use. Its normative use in manifest `include`/`exclude` is deferred to a post-`1.0.0-draft` revision pending conformance fixtures; until then, implementations **MUST** treat manifest query values as opaque identifiers.
|
|
30
32
|
|
|
31
33
|
### `overrides`
|
|
32
34
|
|
package/spec/taxonomy.md
CHANGED
|
@@ -77,7 +77,23 @@ Additional categories for variant and state are inherited from the existing name
|
|
|
77
77
|
| Variant | `variant` | Variant within a component (e.g. accent, negative, primary). |
|
|
78
78
|
| State | `state` | Interactive or semantic state (e.g. hover, focus, disabled). |
|
|
79
79
|
|
|
80
|
-
**NOTE:** The categories above are filtered for semantic and layout token taxonomies. Additional
|
|
80
|
+
**NOTE:** The categories above are filtered for semantic and layout token taxonomies. Additional taxonomies for other token types (color, typography, motion) will be defined in future spec versions — see the open follow-up RFC discussion [#806](https://github.com/adobe/spectrum-design-data/discussions/806) (Q3, taxonomy scoping). The taxonomy is built to scale as new concepts and terms are identified.
|
|
81
|
+
|
|
82
|
+
### Structure vs. component — when does the line move?
|
|
83
|
+
|
|
84
|
+
The `structure` and `component` fields both answer "What?" but apply at different scopes. A useful rule of thumb:
|
|
85
|
+
|
|
86
|
+
* Use `component` when the token belongs to a specific component's surface (e.g. `button-background-color` — the background color of the Button component).
|
|
87
|
+
* Use `structure` when the token belongs to a reusable visual pattern that recurs **across** components (e.g. `container-padding` — padding for any container-shaped surface, regardless of which component owns it).
|
|
88
|
+
|
|
89
|
+
**Worked example — `card`:**
|
|
90
|
+
|
|
91
|
+
* As a `structure`: when "card" describes a layout primitive used inside many components (e.g. `card-padding-medium` on a list item, a popover body, or a modal header), the token is structure-scoped.
|
|
92
|
+
* As a `component`: when "card" describes the dedicated Card component's own surfaces (e.g. `card-background-color` on the Card root), the token is component-scoped.
|
|
93
|
+
|
|
94
|
+
The same word can validly appear in both fields across the dataset; they are independent. Authors choose based on whether the token's *meaning* generalizes across many components (structure) or is specific to one component's identity (component).
|
|
95
|
+
|
|
96
|
+
Source: Nate Baldwin, "Naming conventions & shared taxonomy" — Design Data & Platforms onsite, April 1, 2026.
|
|
81
97
|
|
|
82
98
|
## Component anatomy vs. token objects
|
|
83
99
|
|
package/spec/token-format.md
CHANGED
|
@@ -72,15 +72,16 @@ When **`value`** is present, it **MUST** conform to the declared value type for
|
|
|
72
72
|
|
|
73
73
|
The following OPTIONAL fields implement the token lifecycle model described in [#623](https://github.com/adobe/spectrum-design-data/discussions/623) and the evolution policy in [Evolution](evolution.md). Inspired by Swift's `@available` attribute, Kotlin's `@Deprecated`, and OpenAPI 3.3's deprecation model.
|
|
74
74
|
|
|
75
|
-
| Field | Type | Description
|
|
76
|
-
| -------------------- | --------------------------------------- |
|
|
77
|
-
| `uuid` | string (UUID) | Stable unique id for rename tracking and diffs.
|
|
78
|
-
| `introduced` | string (version) | Spec version when the token was first added (e.g. `"1.0.0"`).
|
|
79
|
-
| `
|
|
80
|
-
| `
|
|
81
|
-
| `
|
|
82
|
-
| `
|
|
83
|
-
| `
|
|
75
|
+
| Field | Type | Description |
|
|
76
|
+
| -------------------- | --------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
|
77
|
+
| `uuid` | string (UUID) | Stable unique id for rename tracking and diffs. |
|
|
78
|
+
| `introduced` | string (version) | Spec version when the token was first added (e.g. `"1.0.0"`). |
|
|
79
|
+
| `lastModified` | string (version) | Spec version when the token's value or metadata last changed (e.g. `"2.1.0"`). Updated on any non-formatting change. |
|
|
80
|
+
| `deprecated` | string (version) | Spec version when the token was deprecated (e.g. `"3.2.0"`). Truthy = deprecated. |
|
|
81
|
+
| `deprecated_comment` | string | Human-readable deprecation explanation and migration guidance. |
|
|
82
|
+
| `replaced_by` | string (UUID) or array of string (UUID) | UUID(s) of the replacement token(s). Single string for 1:1 replacement; array for one-to-many splits. |
|
|
83
|
+
| `plannedRemoval` | string (version) | Spec version when the token will be removed. If omitted, defaults to the next major version after `deprecated`. |
|
|
84
|
+
| `private` | boolean | Not part of public API surface. |
|
|
84
85
|
|
|
85
86
|
#### Lifecycle example
|
|
86
87
|
|
|
@@ -90,6 +91,7 @@ The following OPTIONAL fields implement the token lifecycle model described in [
|
|
|
90
91
|
"value": "#0265dc",
|
|
91
92
|
"uuid": "aaaaaaaa-0001-4000-8000-000000000001",
|
|
92
93
|
"introduced": "1.0.0",
|
|
94
|
+
"lastModified": "3.2.0",
|
|
93
95
|
"deprecated": "3.2.0",
|
|
94
96
|
"deprecated_comment": "Use action-background-default instead.",
|
|
95
97
|
"replaced_by": "bbbbbbbb-0002-4000-8000-000000000001",
|
|
@@ -109,13 +111,15 @@ The following OPTIONAL fields implement the token lifecycle model described in [
|
|
|
109
111
|
|
|
110
112
|
**NORMATIVE:** Each UUID in `replaced_by` **MUST** resolve to an existing token in the dataset (see rule `SPEC-010`).
|
|
111
113
|
|
|
114
|
+
**NORMATIVE:** If `lastModified` is present, its version **MUST NOT** precede `introduced` (see rule `SPEC-014`). Authors **SHOULD** bump `lastModified` whenever a token's `value`, alias `$ref`, or non-formatting metadata changes; pure formatting or comment-only edits do not require a bump.
|
|
115
|
+
|
|
112
116
|
#### Legacy format mapping
|
|
113
117
|
|
|
114
118
|
When generating legacy-format output from cascade tokens:
|
|
115
119
|
|
|
116
120
|
* `deprecated: "3.2.0"` maps to `deprecated: true`
|
|
117
121
|
* `replaced_by: "<uuid>"` maps to `renamed: "<target-token-name>"` (resolved via UUID lookup)
|
|
118
|
-
* `introduced` and `plannedRemoval` have no legacy equivalent and are not emitted
|
|
122
|
+
* `introduced`, `lastModified`, and `plannedRemoval` have no legacy equivalent and are not emitted
|
|
119
123
|
|
|
120
124
|
When migrating legacy-format tokens to cascade:
|
|
121
125
|
|