@contentful/experience-design-system-types 2.5.2-dev-build-eebccad.0 → 2.5.2
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 +21 -0
- package/README.md +7 -32
- package/dist/package.json +2 -1
- package/package.json +2 -1
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2024 Contentful GmbH
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,50 +1,25 @@
|
|
|
1
1
|
# @contentful/experience-design-system-types
|
|
2
2
|
|
|
3
|
-
Shared TypeScript types
|
|
3
|
+
Shared TypeScript types for the Contentful Experience Design System import pipeline. Covers the two file formats consumers provide (CDF for components, DTCG for tokens) and the contract types for the Design System Sources API.
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## Formats
|
|
5
|
+
## Modules
|
|
8
6
|
|
|
9
7
|
### CDF — Component Definition Format
|
|
10
8
|
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
**Exports:** `validateCDF`, `CDF_V1_SCHEMA_URL`, `CDF_PROPERTY_TYPES`, `CDFComponentEntry`, `CDFPropertyDefinition`, `CDFValidationError`
|
|
9
|
+
Types and validation for `.cdf.json` component definition files that describe a design system's component library. Exports `validateCDF`, `CDF_V1_SCHEMA_URL`, `CDF_PROPERTY_TYPES`, `CDFComponentEntry`, `CDFPropertyDefinition`, `CDFValidationError`.
|
|
14
10
|
|
|
15
11
|
### DTCG — Design Token Community Group
|
|
16
12
|
|
|
17
|
-
Types for `.tokens.json` files
|
|
18
|
-
|
|
19
|
-
**Exports:** `DESIGN_TOKEN_TYPES`, `DesignTokenType`, `DTCGTokenEntry`, `DTCGTokenGroup`, `DTCGTokenNode`, `DTCGTokenGroupNode`
|
|
13
|
+
Types for `.tokens.json` files in the [W3C DTCG format](https://tr.designtokens.org/format/) that describe a design system's token library. Exports `DESIGN_TOKEN_TYPES`, `DesignTokenType`, `DTCGTokenEntry`, `DTCGTokenGroup`, `DTCGTokenNode`, `DTCGTokenGroupNode`.
|
|
20
14
|
|
|
21
15
|
### Sources API — Manifest
|
|
22
16
|
|
|
23
|
-
Request body sent to both the preview and apply endpoints.
|
|
24
|
-
|
|
25
|
-
**Exports:** `ManifestPayload`
|
|
17
|
+
Request body sent to both the preview and apply endpoints. Exports `ManifestPayload`.
|
|
26
18
|
|
|
27
19
|
### Sources API — Preview
|
|
28
20
|
|
|
29
|
-
Response types for the Sources API preview endpoint, which returns a diff of what will change before committing.
|
|
30
|
-
|
|
31
|
-
**Exports:** `ServerPreviewResponse`, `EntityDiffGroup`, `ChangedEntity`, `BreakingChange`, `ChangeClassification`, `DownstreamImpact`, `ComponentTypeSummary`, `DesignTokenSummary`, `TaxonomySummary`, `PropertySummary`
|
|
21
|
+
Response types for the Sources API preview endpoint, which returns a diff of what will change before committing. Exports `ServerPreviewResponse`, `EntityDiffGroup`, `ChangedEntity`, `BreakingChange`, `ChangeClassification`, `DownstreamImpact`, and entity summary types (`ComponentTypeSummary`, `DesignTokenSummary`, `TaxonomySummary`, `PropertySummary`).
|
|
32
22
|
|
|
33
23
|
### Sources API — Apply
|
|
34
24
|
|
|
35
|
-
Response types for the Sources API apply endpoint, which runs the async import operation.
|
|
36
|
-
|
|
37
|
-
**Exports:** `ApplyOperationResponse`, `ApplyOperationItem`, `ApplyOperationItemError`, `ApplyOperationStatus`, `ApplyGateError`
|
|
38
|
-
|
|
39
|
-
## Development
|
|
40
|
-
|
|
41
|
-
```bash
|
|
42
|
-
# Build
|
|
43
|
-
pnpm -F @contentful/experience-design-system-types build
|
|
44
|
-
|
|
45
|
-
# Test
|
|
46
|
-
pnpm -F @contentful/experience-design-system-types test
|
|
47
|
-
|
|
48
|
-
# Typecheck
|
|
49
|
-
pnpm -F @contentful/experience-design-system-types typecheck
|
|
50
|
-
```
|
|
25
|
+
Response types for the Sources API apply endpoint, which runs the async import operation. Exports `ApplyOperationResponse`, `ApplyOperationItem`, `ApplyOperationItemError`, `ApplyOperationStatus`, `ApplyGateError`.
|
package/dist/package.json
CHANGED