@contentful/experiences-components-react 1.39.0-alpha-20250528T1342-e28bc3d.0 → 1.39.0-alpha-20250603T1404-5a5eb4e.0

package/dist/index.js

@@ -1162,17 +1162,16 @@ const PrimitiveValueSchema = z.union([
     z.record(z.any(), z.any()),
     z.undefined(),
 ]);
+const UsedComponentsSchema = z.array(z.object({
+    sys: z.object({
+        type: z.literal('Link'),
+        id: z.string(),
+        linkType: z.literal('Entry'),
+    }),
+}));
 const uuidKeySchema = z
     .string()
     .regex(/^[a-zA-Z0-9-_]{1,21}$/, { message: 'Does not match /^[a-zA-Z0-9-_]{1,21}$/' });
-/**
- * Property keys for imported components have a limit of 32 characters (to be implemented) while
- * property keys for patterns have a limit of 54 characters (<32-char-variabl-name>_<21-char-nanoid-id>).
- * Because we cannot distinguish between the two in the componentTree, we will use the larger limit for both.
- */
-const propertyKeySchema = z
-    .string()
-    .regex(/^[a-zA-Z0-9-_]{1,54}$/, { message: 'Does not match /^[a-zA-Z0-9-_]{1,54}$/' });
 const DataSourceSchema = z.record(uuidKeySchema, z.object({
     sys: z.object({
         type: z.literal('Link'),
@@ -1180,7 +1179,62 @@ const DataSourceSchema = z.record(uuidKeySchema, z.object({
         linkType: z.enum(['Entry', 'Asset']),
     }),
 }));
+const UnboundValuesSchema = z.record(uuidKeySchema, z.object({
+    value: PrimitiveValueSchema,
+}));
+/**
+ * Property keys for imported components have a limit of 32 characters (to be implemented) while
+ * property keys for patterns have a limit of 54 characters (<32-char-variable-name>_<21-char-nanoid-id>).
+ * Because we cannot distinguish between the two in the componentTree, we will use the larger limit for both.
+ */
+const propertyKeySchema = z
+    .string()
+    .regex(/^[a-zA-Z0-9-_]{1,54}$/, { message: 'Does not match /^[a-zA-Z0-9-_]{1,54}$/' });
+const ComponentTreeNodeIdSchema = z
+    .string()
+    .regex(/^[a-zA-Z0-9]{1,8}$/, { message: 'Does not match /^[a-zA-Z0-9]{1,8}$/' });
+const breakpointsRefinement = (value, ctx) => {
+    if (!value.length || value[0].query !== '*') {
+        ctx.addIssue({
+            code: z.ZodIssueCode.custom,
+            message: `The first breakpoint should include the following attributes: { "query": "*" }`,
+        });
+    }
+    const hasDuplicateIds = value.some((currentBreakpoint, currentBreakpointIndex) => {
+        // check if the current breakpoint id is found in the rest of the array
+        const breakpointIndex = value.findIndex((breakpoint) => breakpoint.id === currentBreakpoint.id);
+        return breakpointIndex !== currentBreakpointIndex;
+    });
+    if (hasDuplicateIds) {
+        ctx.addIssue({
+            code: z.ZodIssueCode.custom,
+            message: `Breakpoint IDs must be unique`,
+        });
+    }
+    // Extract the queries boundary by removing the special characters around it
+    const queries = value.map((bp) => bp.query === '*' ? bp.query : parseInt(bp.query.replace(/px|<|>/, '')));
+    // sort updates queries array in place so we need to create a copy
+    const originalQueries = [...queries];
+    queries.sort((q1, q2) => {
+        if (q1 === '*') {
+            return -1;
+        }
+        if (q2 === '*') {
+            return 1;
+        }
+        return q1 > q2 ? -1 : 1;
+    });
+    if (originalQueries.join('') !== queries.join('')) {
+        ctx.addIssue({
+            code: z.ZodIssueCode.custom,
+            message: `Breakpoints should be ordered from largest to smallest pixel value`,
+        });
+    }
+};
 const ValuesByBreakpointSchema = z.record(z.lazy(() => PrimitiveValueSchema));
+const BindingSourceTypeEnumSchema = z
+    .array(z.enum(['entry', 'asset', 'manual', 'experience']))
+    .nonempty();
 const DesignValueSchema = z
     .object({
     type: z.literal('DesignValue'),
@@ -1213,8 +1267,6 @@ const ComponentValueSchema = z
     key: z.string(),
 })
     .strict();
-// TODO: finalize schema structure before release
-// https://contentful.atlassian.net/browse/LUMOS-523
 const NoValueSchema = z.object({ type: z.literal('NoValue') }).strict();
 const ComponentPropertyValueSchema = z.discriminatedUnion('type', [
     DesignValueSchema,
@@ -1226,41 +1278,12 @@ const ComponentPropertyValueSchema = z.discriminatedUnion('type', [
 ]);
 // TODO: finalize schema structure before release
 // https://contentful.atlassian.net/browse/LUMOS-523
-const VariableMappingSchema = z.object({
-    patternPropertyDefinitionId: propertyKeySchema,
-    type: z.literal('ContentTypeMapping'),
-    pathsByContentType: z.record(z.string(), z.object({ path: z.string() })),
-});
-const VariableMappingsSchema = z.record(propertyKeySchema, VariableMappingSchema);
-// TODO: finalize schema structure before release
-// https://contentful.atlassian.net/browse/LUMOS-523
-const PatternPropertyDefinitionSchema = z.object({
-    defaultValue: z
-        .record(z.string(), z.object({
-        sys: z.object({
-            type: z.literal('Link'),
-            id: z.string(),
-            linkType: z.enum(['Entry']),
-        }),
-    }))
-        .optional(),
-    contentTypes: z.record(z.string(), z.object({
-        sys: z.object({
-            type: z.literal('Link'),
-            id: z.string(),
-            linkType: z.enum(['ContentType']),
-        }),
-    })),
-});
-const PatternPropertyDefinitionsSchema = z.record(propertyKeySchema, PatternPropertyDefinitionSchema);
-// TODO: finalize schema structure before release
-// https://contentful.atlassian.net/browse/LUMOS-523
 const PatternPropertySchema = z.object({
     type: z.literal('BoundValue'),
     path: z.string(),
     contentType: z.string(),
 });
-const PatternPropertysSchema = z.record(propertyKeySchema, PatternPropertySchema);
+const PatternPropertiesSchema = z.record(propertyKeySchema, PatternPropertySchema);
 const BreakpointSchema = z
     .object({
     id: propertyKeySchema,
@@ -1270,12 +1293,6 @@ const BreakpointSchema = z
     displayIcon: z.enum(['desktop', 'tablet', 'mobile']).optional(),
 })
     .strict();
-const UnboundValuesSchema = z.record(uuidKeySchema, z.object({
-    value: PrimitiveValueSchema,
-}));
-const ComponentTreeNodeIdSchema = z
-    .string()
-    .regex(/^[a-zA-Z0-9]{1,8}$/, { message: 'Does not match /^[a-zA-Z0-9]{1,8}$/' });
 // Use helper schema to define a recursive schema with its type correctly below
 const BaseComponentTreeNodeSchema = z.object({
     id: ComponentTreeNodeIdSchema.optional(),
@@ -1283,14 +1300,8 @@ const BaseComponentTreeNodeSchema = z.object({
     displayName: z.string().optional(),
     slotId: z.string().optional(),
     variables: z.record(propertyKeySchema, ComponentPropertyValueSchema),
-    patternProperties: PatternPropertysSchema.optional(),
-});
-const ComponentTreeNodeSchema = BaseComponentTreeNodeSchema.extend({
-    children: z.lazy(() => ComponentTreeNodeSchema.array()),
+    patternProperties: PatternPropertiesSchema.optional(),
 });
-const BindingSourceTypeEnumSchema = z
-    .array(z.enum(['entry', 'asset', 'manual', 'experience']))
-    .nonempty();
 const ComponentVariableSchema = z.object({
     displayName: z.string().optional(),
     type: DefinitionPropertyTypeSchema,
@@ -1311,8 +1322,25 @@ const ComponentVariableSchema = z.object({
     })
         .optional(),
 });
-const ComponentVariablesSchema = z.record(z.string().regex(/^[a-zA-Z0-9-_]{1,54}$/), // Here the key is <variableName>_<nanoidId> so we need to allow for a longer length
-ComponentVariableSchema);
+const ComponentTreeNodeSchema = BaseComponentTreeNodeSchema.extend({
+    children: z.lazy(() => ComponentTreeNodeSchema.array()),
+});
+const ComponentTreeSchema = z
+    .object({
+    breakpoints: z.array(BreakpointSchema).superRefine(breakpointsRefinement),
+    children: z.array(ComponentTreeNodeSchema),
+    schemaVersion: SchemaVersions,
+})
+    .strict();
+const localeWrapper = (fieldSchema) => z.record(z.string(), fieldSchema);
+
+z.object({
+    componentTree: localeWrapper(ComponentTreeSchema),
+    dataSource: localeWrapper(DataSourceSchema),
+    unboundValues: localeWrapper(UnboundValuesSchema),
+    usedComponents: localeWrapper(UsedComponentsSchema).optional(),
+});
+
 const THUMBNAIL_IDS = [
     'columns',
     'columnsPlusRight',
@@ -1338,6 +1366,37 @@ const THUMBNAIL_IDS = [
     'textColumns',
     'duplex',
 ];
+// TODO: finalize schema structure before release
+// https://contentful.atlassian.net/browse/LUMOS-523
+const VariableMappingSchema = z.object({
+    patternPropertyDefinitionId: propertyKeySchema,
+    type: z.literal('ContentTypeMapping'),
+    pathsByContentType: z.record(z.string(), z.object({ path: z.string() })),
+});
+// TODO: finalize schema structure before release
+// https://contentful.atlassian.net/browse/LUMOS-523
+const PatternPropertyDefinitionSchema = z.object({
+    defaultValue: z
+        .record(z.string(), z.object({
+        sys: z.object({
+            type: z.literal('Link'),
+            id: z.string(),
+            linkType: z.enum(['Entry']),
+        }),
+    }))
+        .optional(),
+    contentTypes: z.record(z.string(), z.object({
+        sys: z.object({
+            type: z.literal('Link'),
+            id: z.string(),
+            linkType: z.enum(['ContentType']),
+        }),
+    })),
+});
+const PatternPropertyDefinitionsSchema = z.record(propertyKeySchema, PatternPropertyDefinitionSchema);
+const VariableMappingsSchema = z.record(propertyKeySchema, VariableMappingSchema);
+const ComponentVariablesSchema = z.record(z.string().regex(/^[a-zA-Z0-9-_]{1,54}$/), // Here the key is <variableName>_<nanoidId> so we need to allow for a longer length
+ComponentVariableSchema);
 const ComponentSettingsSchema = z.object({
     variableDefinitions: ComponentVariablesSchema,
     thumbnailId: z.enum(THUMBNAIL_IDS).optional(),
@@ -1345,65 +1404,12 @@ const ComponentSettingsSchema = z.object({
     variableMappings: VariableMappingsSchema.optional(),
     patternPropertyDefinitions: PatternPropertyDefinitionsSchema.optional(),
 });
-const UsedComponentsSchema = z.array(z.object({
-    sys: z.object({
-        type: z.literal('Link'),
-        id: z.string(),
-        linkType: z.literal('Entry'),
-    }),
-}));
-const breakpointsRefinement = (value, ctx) => {
-    if (!value.length || value[0].query !== '*') {
-        ctx.addIssue({
-            code: z.ZodIssueCode.custom,
-            message: `The first breakpoint should include the following attributes: { "query": "*" }`,
-        });
-    }
-    const hasDuplicateIds = value.some((currentBreakpoint, currentBreakpointIndex) => {
-        // check if the current breakpoint id is found in the rest of the array
-        const breakpointIndex = value.findIndex((breakpoint) => breakpoint.id === currentBreakpoint.id);
-        return breakpointIndex !== currentBreakpointIndex;
-    });
-    if (hasDuplicateIds) {
-        ctx.addIssue({
-            code: z.ZodIssueCode.custom,
-            message: `Breakpoint IDs must be unique`,
-        });
-    }
-    // Extract the queries boundary by removing the special characters around it
-    const queries = value.map((bp) => bp.query === '*' ? bp.query : parseInt(bp.query.replace(/px|<|>/, '')));
-    // sort updates queries array in place so we need to create a copy
-    const originalQueries = [...queries];
-    queries.sort((q1, q2) => {
-        if (q1 === '*') {
-            return -1;
-        }
-        if (q2 === '*') {
-            return 1;
-        }
-        return q1 > q2 ? -1 : 1;
-    });
-    if (originalQueries.join('') !== queries.join('')) {
-        ctx.addIssue({
-            code: z.ZodIssueCode.custom,
-            message: `Breakpoints should be ordered from largest to smallest pixel value`,
-        });
-    }
-};
-const ComponentTreeSchema = z
-    .object({
-    breakpoints: z.array(BreakpointSchema).superRefine(breakpointsRefinement),
-    children: z.array(ComponentTreeNodeSchema),
-    schemaVersion: SchemaVersions,
-})
-    .strict();
-const localeWrapper = (fieldSchema) => z.record(z.string(), fieldSchema);
 z.object({
     componentTree: localeWrapper(ComponentTreeSchema),
     dataSource: localeWrapper(DataSourceSchema),
     unboundValues: localeWrapper(UnboundValuesSchema),
     usedComponents: localeWrapper(UsedComponentsSchema).optional(),
-    componentSettings: localeWrapper(ComponentSettingsSchema).optional(),
+    componentSettings: localeWrapper(ComponentSettingsSchema),
 });
 
 z.object({