@contentful/experience-design-system-types 2.24.1-dev-build-5ff9f2f.0 → 2.24.1-dev-build-3ddd9a7.0

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/experience-design-system-types",
-  "version": "2.24.1-dev-build-5ff9f2f.0",
+  "version": "2.24.1-dev-build-3ddd9a7.0",
   "license": "MIT",
   "type": "module",
   "module": "./dist/src/index.js",

package/dist/src/cdf/index.d.ts

@@ -1,4 +1,4 @@
 export { validateCDF, parseCDFComponents } from './validate.js';
 export { CDF_V1_SCHEMA_URL } from './schema.js';
 export { CDF_PROPERTY_TYPES, CDF_PROPERTY_CATEGORIES } from './vocabularies.js';
-export { CDFComponentSchema, CDFPropertySchema, CDFSlotSchema, type CDFComponentEntry, type CDFPropertyDefinition, type CDFSlotDefinition, type CDFValidationError, } from './types.js';
+export { CDFComponentSchema, CDFPropertySchema, CDFSlotSchema, type CDFComponentEntry, type CDFPropertyDefinition, type CDFSlotDefinition, type CDFValidationError, type CDFValidationWarning, } from './types.js';

package/dist/src/cdf/schema.d.ts

@@ -76,6 +76,18 @@ export declare const cdfV1JsonSchema: {
                 readonly '$token.kind': {
                     readonly type: "string";
                 };
+                readonly '$token.sets': {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                };
+                readonly '$token.allowed': {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                };
             };
             readonly additionalProperties: false;
         };

package/dist/src/cdf/schema.js

@@ -42,6 +42,8 @@ export const cdfV1JsonSchema = {
                 $default: {},
                 $values: { type: 'array', items: { type: 'string' } },
                 '$token.kind': { type: 'string' },
+                '$token.sets': { type: 'array', items: { type: 'string' } },
+                '$token.allowed': { type: 'array', items: { type: 'string' } },
             },
             additionalProperties: false,
         },

package/dist/src/cdf/types.d.ts

@@ -20,6 +20,8 @@ export declare const CDFPropertySchema: z.ZodMiniObject<{
     $default: z.ZodMiniOptional<z.ZodMiniAny>;
     $values: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
     '$token.kind': z.ZodMiniOptional<z.ZodMiniString<string>>;
+    '$token.sets': z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
+    '$token.allowed': z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
 }, z.core.$strict>;
 export type CDFPropertyDefinition = z.infer<typeof CDFPropertySchema>;
 export declare const CDFSlotSchema: z.ZodMiniObject<{
@@ -52,6 +54,8 @@ export declare const CDFComponentSchema: z.ZodMiniObject<{
         $default: z.ZodMiniOptional<z.ZodMiniAny>;
         $values: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
         '$token.kind': z.ZodMiniOptional<z.ZodMiniString<string>>;
+        '$token.sets': z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
+        '$token.allowed': z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
     }, z.core.$strict>>;
     $slots: z.ZodMiniOptional<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniObject<{
         $description: z.ZodMiniOptional<z.ZodMiniString<string>>;
@@ -70,9 +74,14 @@ export interface CDFValidationError {
     expected?: string;
     actual?: string;
 }
+export interface CDFValidationWarning {
+    path: string;
+    message: string;
+}
 export interface CDFValidationResult {
     valid: boolean;
     errors: CDFValidationError[];
+    warnings: CDFValidationWarning[];
     components: Array<{
         key: string;
         entry: CDFComponentEntry;

package/dist/src/cdf/types.js

@@ -8,6 +8,8 @@ export const CDFPropertySchema = z.strictObject({
     $default: z.optional(z.any()),
     $values: z.optional(z.array(z.string())),
     '$token.kind': z.optional(z.string()),
+    '$token.sets': z.optional(z.array(z.string())),
+    '$token.allowed': z.optional(z.array(z.string())),
 });
 export const CDFSlotSchema = z.strictObject({
     $description: z.optional(z.string()),

package/dist/src/cdf/validate.js

@@ -22,6 +22,58 @@ export function parseCDFComponents(obj, prefix = '') {
     }
     return results;
 }
+function validatePropertyTokenConstraints(path, prop, errors, warnings) {
+    const sets = prop['$token.sets'];
+    const allowed = prop['$token.allowed'];
+    if (sets === undefined && allowed === undefined)
+        return;
+    const isTokenDesignProperty = prop['$type'] === 'token' && prop['$category'] === 'design';
+    if (!isTokenDesignProperty) {
+        if (sets !== undefined) {
+            errors.push({
+                path: `${path}/$token.sets`,
+                message: '"$token.sets" is only allowed on properties with $type "token" and $category "design"',
+            });
+        }
+        if (allowed !== undefined) {
+            errors.push({
+                path: `${path}/$token.allowed`,
+                message: '"$token.allowed" is only allowed on properties with $type "token" and $category "design"',
+            });
+        }
+        return;
+    }
+    if (allowed !== undefined && sets !== undefined) {
+        const offending = allowed.filter((tokenPath) => !sets.includes(tokenPath));
+        if (offending.length > 0) {
+            errors.push({
+                path: `${path}/$token.allowed`,
+                message: `"$token.allowed" must be a subset of "$token.sets"; not found in $token.sets: ${offending.join(', ')}`,
+            });
+        }
+    }
+    const values = prop['$values'];
+    if (allowed !== undefined && allowed.length > 0 && values !== undefined) {
+        const sameContents = allowed.length === values.length && allowed.every((v) => values.includes(v));
+        if (!sameContents) {
+            warnings.push({
+                path: `${path}/$token.allowed`,
+                message: '"$values" and "$token.allowed" have differing contents; "$token.allowed" is authoritative',
+            });
+        }
+    }
+}
+function validateTokenConstraints(components) {
+    const errors = [];
+    const warnings = [];
+    for (const { key, entry } of components) {
+        const componentPath = `/${key.replace(/\./g, '/')}`;
+        for (const [propKey, prop] of Object.entries(entry.$properties ?? {})) {
+            validatePropertyTokenConstraints(`${componentPath}/$properties/${propKey}`, prop, errors, warnings);
+        }
+    }
+    return { errors, warnings };
+}
 export function validateCDF(input) {
     const valid = validate(input);
     if (!valid) {
@@ -30,7 +82,7 @@ export function validateCDF(input) {
             message: err.message ?? 'Unknown validation error',
             expected: err.params ? JSON.stringify(err.params) : undefined,
         }));
-        return { valid: false, errors, components: [] };
+        return { valid: false, errors, warnings: [], components: [] };
     }
     const file = input;
     if (file.$schema !== CDF_V1_SCHEMA_URL) {
@@ -44,9 +96,11 @@ export function validateCDF(input) {
                     actual: file.$schema,
                 },
             ],
+            warnings: [],
             components: [],
         };
     }
     const components = parseCDFComponents(file);
-    return { valid: true, errors: [], components };
+    const { errors, warnings } = validateTokenConstraints(components);
+    return { valid: errors.length === 0, errors, warnings, components };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/experience-design-system-types",
-  "version": "2.24.1-dev-build-5ff9f2f.0",
+  "version": "2.24.1-dev-build-3ddd9a7.0",
   "license": "MIT",
   "type": "module",
   "module": "./dist/src/index.js",