@contentful/experiences-validators 0.0.1-alpha.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Contentful
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+# Experience Builder Validators
+
+Define schemas and validator functions for experience data structures. 

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { Breakpoint, ComponentPropertyValue, ComponentTreeNode, ExperienceComponentSettings, ExperienceComponentTree, ExperienceDataSource, ExperienceFields, ExperienceUnboundValues, ExperienceUsedComponents, PrimitiveValue, ExperienceFieldsCMAShapeSchema as Schema_2023_09_28, ValuesByBreakpoint } from './schemas/v2023_09_28/experience.js';
+export { SchemaVersions } from './schemas/schemaVersions.js';

package/dist/index.js

@@ -0,0 +1,149 @@
+import { z } from 'zod';
+
+const SchemaVersions = z.union([
+    z.literal('2023-09-28'),
+    z.literal('2023-08-23'),
+    z.literal('2023-07-26'),
+    z.literal('2023-06-27'),
+]);
+
+const uuidKeySchema = z.string().regex(/^[a-zA-Z0-9-_]{1,21}$/);
+const propertyKeySchema = z.string().regex(/^[a-zA-Z0-9-_]{1,32}$/);
+const DataSourceSchema = z.record(uuidKeySchema, z.object({
+    sys: z.object({
+        type: z.literal('Link'),
+        id: z.string(),
+        linkType: z.literal('Entry').or(z.literal('Asset')),
+    }),
+}));
+const PrimitiveValueSchema = z.union([
+    z.string(),
+    z.boolean(),
+    z.number(),
+    z.record(z.any(), z.any()),
+    z.undefined(),
+]);
+const ComponentDefinitionPropertyTypeSchema = z.enum([
+    'Text',
+    'RichText',
+    'Number',
+    'Date',
+    'Boolean',
+    'Location',
+    'Media',
+    'Object',
+]);
+const ValuesByBreakpointSchema = z.record(z.lazy(() => PrimitiveValueSchema));
+const ComponentPropertyValueSchema = z.union([
+    z.object({
+        type: z.literal('DesignValue'),
+        valuesByBreakpoint: ValuesByBreakpointSchema,
+    }),
+    z.object({
+        type: z.literal('BoundValue'),
+        path: z.string(),
+    }),
+    z.object({
+        type: z.literal('UnboundValue'),
+        key: z.string(),
+    }),
+    z.object({
+        type: z.literal('ComponentValue'),
+        key: z.string(),
+    }),
+]);
+const BreakpointSchema = z.object({
+    id: propertyKeySchema,
+    query: z.string().regex(/^\*$|^<[0-9*]+px$/),
+    previewSize: z.string(),
+    displayName: z.string(),
+});
+const UnboundValuesSchema = z.record(uuidKeySchema, z.object({
+    value: PrimitiveValueSchema,
+}));
+// Use helper schema to define a recursive schema with its type correctly below
+const BaseComponentTreeNodeSchema = z.object({
+    definitionId: z.string(),
+    variables: z.record(propertyKeySchema, ComponentPropertyValueSchema),
+});
+const ComponentTreeNodeSchema = BaseComponentTreeNodeSchema.extend({
+    children: z.lazy(() => ComponentTreeNodeSchema.array()),
+});
+const ComponentSettingsSchema = z.object({
+    variableDefinitions: 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
+    z.object({
+        displayName: z.string(),
+        type: ComponentDefinitionPropertyTypeSchema,
+        defaultValue: ComponentPropertyValueSchema.optional(),
+        description: z.string().optional(),
+        group: z.string().optional(),
+        validations: z.record(z.string()).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].id !== 'desktop' || value[0].query !== '*') {
+        ctx.addIssue({
+            code: z.ZodIssueCode.custom,
+            message: `The first breakpoint should include the following attributes: { "id": "desktop", "query": "*" }`,
+            path: [...ctx.path, 0],
+        });
+    }
+    // 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 componentSettingsRefinement = (value, ctx) => {
+    const { componentSettings, usedComponents } = value;
+    if (!componentSettings || !usedComponents) {
+        return;
+    }
+    const localeKey = Object.keys(componentSettings ?? {})[0];
+    if (componentSettings[localeKey] !== undefined && usedComponents[localeKey] !== undefined) {
+        ctx.addIssue({
+            code: z.ZodIssueCode.custom,
+            message: `'componentSettings' field cannot be used in conjunction with 'usedComponents' field`,
+            path: ['componentSettings', localeKey],
+        });
+    }
+};
+const ComponentTreeSchema = z.object({
+    breakpoints: z.array(BreakpointSchema).superRefine(breakpointsRefinement),
+    children: z.array(ComponentTreeNodeSchema),
+    schemaVersion: SchemaVersions,
+});
+const localeWrapper = (fieldSchema) => z.record(z.string(), fieldSchema);
+const ExperienceFieldsCMAShapeSchema = z
+    .object({
+    componentTree: localeWrapper(ComponentTreeSchema),
+    dataSource: localeWrapper(DataSourceSchema),
+    unboundValues: localeWrapper(UnboundValuesSchema),
+    usedComponents: localeWrapper(UsedComponentsSchema).optional(),
+    componentSettings: localeWrapper(ComponentSettingsSchema).optional(),
+})
+    .superRefine(componentSettingsRefinement);
+
+export { ExperienceFieldsCMAShapeSchema as Schema_2023_09_28 };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/schemas/schemaVersions.ts","../src/schemas/v2023_09_28/experience.ts"],"sourcesContent":["import { z } from 'zod';\n\nexport const SchemaVersions = z.union([\n  z.literal('2023-09-28'),\n  z.literal('2023-08-23'),\n  z.literal('2023-07-26'),\n  z.literal('2023-06-27'),\n]);\nexport type SchemaVersions = z.infer<typeof SchemaVersions>;\n","import { z } from 'zod';\nimport { SchemaVersions } from '../schemaVersions';\n\nconst uuidKeySchema = z.string().regex(/^[a-zA-Z0-9-_]{1,21}$/);\nconst propertyKeySchema = z.string().regex(/^[a-zA-Z0-9-_]{1,32}$/);\n\nconst DataSourceSchema = z.record(\n  uuidKeySchema,\n  z.object({\n    sys: z.object({\n      type: z.literal('Link'),\n      id: z.string(),\n      linkType: z.literal('Entry').or(z.literal('Asset')),\n    }),\n  }),\n);\n\nconst PrimitiveValueSchema = z.union([\n  z.string(),\n  z.boolean(),\n  z.number(),\n  z.record(z.any(), z.any()),\n  z.undefined(),\n]);\n\nexport const ComponentDefinitionPropertyTypeSchema = z.enum([\n  'Text',\n  'RichText',\n  'Number',\n  'Date',\n  'Boolean',\n  'Location',\n  'Media',\n  'Object',\n]);\n\nconst ValuesByBreakpointSchema = z.record(z.lazy(() => PrimitiveValueSchema));\n\nconst ComponentPropertyValueSchema = z.union([\n  z.object({\n    type: z.literal('DesignValue'),\n    valuesByBreakpoint: ValuesByBreakpointSchema,\n  }),\n  z.object({\n    type: z.literal('BoundValue'),\n    path: z.string(),\n  }),\n  z.object({\n    type: z.literal('UnboundValue'),\n    key: z.string(),\n  }),\n  z.object({\n    type: z.literal('ComponentValue'),\n    key: z.string(),\n  }),\n]);\n\nexport type ComponentPropertyValue = z.infer<typeof ComponentPropertyValueSchema>;\n\nconst BreakpointSchema = z.object({\n  id: propertyKeySchema,\n  query: z.string().regex(/^\\*$|^<[0-9*]+px$/),\n  previewSize: z.string(),\n  displayName: z.string(),\n});\n\nconst UnboundValuesSchema = z.record(\n  uuidKeySchema,\n  z.object({\n    value: PrimitiveValueSchema,\n  }),\n);\n\n// Use helper schema to define a recursive schema with its type correctly below\nconst BaseComponentTreeNodeSchema = z.object({\n  definitionId: z.string(),\n  variables: z.record(propertyKeySchema, ComponentPropertyValueSchema),\n});\nexport type ComponentTreeNode = z.infer<typeof BaseComponentTreeNodeSchema> & {\n  children: ComponentTreeNode[];\n};\nconst ComponentTreeNodeSchema: z.ZodType<ComponentTreeNode> = BaseComponentTreeNodeSchema.extend({\n  children: z.lazy(() => ComponentTreeNodeSchema.array()),\n});\n\nconst ComponentSettingsSchema = z.object({\n  variableDefinitions: z.record(\n    z.string().regex(/^[a-zA-Z0-9-_]{1,54}$/), // Here the key is <variableName>_<nanoidId> so we need to allow for a longer length\n    z.object({\n      displayName: z.string(),\n      type: ComponentDefinitionPropertyTypeSchema,\n      defaultValue: ComponentPropertyValueSchema.optional(),\n      description: z.string().optional(),\n      group: z.string().optional(),\n      validations: z.record(z.string()).optional(),\n    }),\n  ),\n});\n\nconst UsedComponentsSchema = z.array(\n  z.object({\n    sys: z.object({\n      type: z.literal('Link'),\n      id: z.string(),\n      linkType: z.literal('Entry'),\n    }),\n  }),\n);\n\nconst breakpointsRefinement = (value: Breakpoint[], ctx: z.RefinementCtx) => {\n  if (!value.length || value[0].id !== 'desktop' || value[0].query !== '*') {\n    ctx.addIssue({\n      code: z.ZodIssueCode.custom,\n      message: `The first breakpoint should include the following attributes: { \"id\": \"desktop\", \"query\": \"*\" }`,\n      path: [...ctx.path, 0],\n    });\n  }\n  // Extract the queries boundary by removing the special characters around it\n  const queries = value.map((bp) =>\n    bp.query === '*' ? bp.query : parseInt(bp.query.replace(/px|<|>/, '')),\n  );\n  // sort updates queries array in place so we need to create a copy\n  const originalQueries = [...queries];\n  queries.sort((q1, q2) => {\n    if (q1 === '*') {\n      return -1;\n    }\n    if (q2 === '*') {\n      return 1;\n    }\n    return q1 > q2 ? -1 : 1;\n  });\n\n  if (originalQueries.join('') !== queries.join('')) {\n    ctx.addIssue({\n      code: z.ZodIssueCode.custom,\n      message: `Breakpoints should be ordered from largest to smallest pixel value`,\n    });\n  }\n};\n\nconst componentSettingsRefinement = (value, ctx: z.RefinementCtx) => {\n  const { componentSettings, usedComponents } = value as ExperienceFields;\n\n  if (!componentSettings || !usedComponents) {\n    return;\n  }\n  const localeKey = Object.keys(componentSettings ?? {})[0];\n\n  if (componentSettings[localeKey] !== undefined && usedComponents[localeKey] !== undefined) {\n    ctx.addIssue({\n      code: z.ZodIssueCode.custom,\n      message: `'componentSettings' field cannot be used in conjunction with 'usedComponents' field`,\n      path: ['componentSettings', localeKey],\n    });\n  }\n};\n\nconst ComponentTreeSchema = z.object({\n  breakpoints: z.array(BreakpointSchema).superRefine(breakpointsRefinement),\n  children: z.array(ComponentTreeNodeSchema),\n  schemaVersion: SchemaVersions,\n});\n\nconst localeWrapper = (fieldSchema: any) => z.record(z.string(), fieldSchema);\n\nexport const ExperienceFieldsCMAShapeSchema = z\n  .object({\n    componentTree: localeWrapper(ComponentTreeSchema),\n    dataSource: localeWrapper(DataSourceSchema),\n    unboundValues: localeWrapper(UnboundValuesSchema),\n    usedComponents: localeWrapper(UsedComponentsSchema).optional(),\n    componentSettings: localeWrapper(ComponentSettingsSchema).optional(),\n  })\n  .superRefine(componentSettingsRefinement);\n\nexport type ExperienceFields = z.infer<typeof ExperienceFieldsCMAShapeSchema>;\nexport type ExperienceDataSource = z.infer<typeof DataSourceSchema>;\nexport type ExperienceUnboundValues = z.infer<typeof UnboundValuesSchema>;\nexport type ExperienceUsedComponents = z.infer<typeof UsedComponentsSchema>;\nexport type ExperienceComponentSettings = z.infer<typeof ComponentSettingsSchema>;\nexport type ExperienceComponentTree = z.infer<typeof ComponentTreeSchema>;\nexport type ValuesByBreakpoint = z.infer<typeof ValuesByBreakpointSchema>;\nexport type Breakpoint = z.infer<typeof BreakpointSchema>;\nexport type PrimitiveValue = z.infer<typeof PrimitiveValueSchema>;\n"],"names":[],"mappings":";;AAEO,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC;AACpC,IAAA,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC;AACvB,IAAA,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC;AACvB,IAAA,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC;AACvB,IAAA,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC;AACxB,CAAA,CAAC;;ACJF,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC;AAChE,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC;AAEpE,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAC/B,aAAa,EACb,CAAC,CAAC,MAAM,CAAC;AACP,IAAA,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC;AACZ,QAAA,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;AACvB,QAAA,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;AACd,QAAA,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;KACpD,CAAC;AACH,CAAA,CAAC,CACH,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC;IACnC,CAAC,CAAC,MAAM,EAAE;IACV,CAAC,CAAC,OAAO,EAAE;IACX,CAAC,CAAC,MAAM,EAAE;AACV,IAAA,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC;IAC1B,CAAC,CAAC,SAAS,EAAE;AACd,CAAA,CAAC,CAAC;AAEI,MAAM,qCAAqC,GAAG,CAAC,CAAC,IAAI,CAAC;IAC1D,MAAM;IACN,UAAU;IACV,QAAQ;IACR,MAAM;IACN,SAAS;IACT,UAAU;IACV,OAAO;IACP,QAAQ;AACT,CAAA,CAAC,CAAC;AAEH,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,oBAAoB,CAAC,CAAC,CAAC;AAE9E,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC;IAC3C,CAAC,CAAC,MAAM,CAAC;AACP,QAAA,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC;AAC9B,QAAA,kBAAkB,EAAE,wBAAwB;KAC7C,CAAC;IACF,CAAC,CAAC,MAAM,CAAC;AACP,QAAA,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC;AAC7B,QAAA,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;KACjB,CAAC;IACF,CAAC,CAAC,MAAM,CAAC;AACP,QAAA,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC;AAC/B,QAAA,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;KAChB,CAAC;IACF,CAAC,CAAC,MAAM,CAAC;AACP,QAAA,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC;AACjC,QAAA,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;KAChB,CAAC;AACH,CAAA,CAAC,CAAC;AAIH,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;AAChC,IAAA,EAAE,EAAE,iBAAiB;IACrB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,mBAAmB,CAAC;AAC5C,IAAA,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;AACvB,IAAA,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;AACxB,CAAA,CAAC,CAAC;AAEH,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAClC,aAAa,EACb,CAAC,CAAC,MAAM,CAAC;AACP,IAAA,KAAK,EAAE,oBAAoB;AAC5B,CAAA,CAAC,CACH,CAAC;AAEF;AACA,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CAAC;AAC3C,IAAA,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;IACxB,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC,iBAAiB,EAAE,4BAA4B,CAAC;AACrE,CAAA,CAAC,CAAC;AAIH,MAAM,uBAAuB,GAAiC,2BAA2B,CAAC,MAAM,CAAC;AAC/F,IAAA,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,uBAAuB,CAAC,KAAK,EAAE,CAAC;AACxD,CAAA,CAAC,CAAC;AAEH,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;AACvC,IAAA,mBAAmB,EAAE,CAAC,CAAC,MAAM,CAC3B,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,uBAAuB,CAAC;IACzC,CAAC,CAAC,MAAM,CAAC;AACP,QAAA,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;AACvB,QAAA,IAAI,EAAE,qCAAqC;AAC3C,QAAA,YAAY,EAAE,4BAA4B,CAAC,QAAQ,EAAE;AACrD,QAAA,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;AAClC,QAAA,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;AAC5B,QAAA,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;AAC7C,KAAA,CAAC,CACH;AACF,CAAA,CAAC,CAAC;AAEH,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAClC,CAAC,CAAC,MAAM,CAAC;AACP,IAAA,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC;AACZ,QAAA,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;AACvB,QAAA,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;AACd,QAAA,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;KAC7B,CAAC;AACH,CAAA,CAAC,CACH,CAAC;AAEF,MAAM,qBAAqB,GAAG,CAAC,KAAmB,EAAE,GAAoB,KAAI;IAC1E,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,SAAS,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,GAAG,EAAE;QACxE,GAAG,CAAC,QAAQ,CAAC;AACX,YAAA,IAAI,EAAE,CAAC,CAAC,YAAY,CAAC,MAAM;AAC3B,YAAA,OAAO,EAAE,CAAiG,+FAAA,CAAA;YAC1G,IAAI,EAAE,CAAC,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;AACvB,SAAA,CAAC,CAAC;KACJ;;AAED,IAAA,MAAM,OAAO,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,KAC3B,EAAE,CAAC,KAAK,KAAK,GAAG,GAAG,EAAE,CAAC,KAAK,GAAG,QAAQ,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CACvE,CAAC;;AAEF,IAAA,MAAM,eAAe,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC;IACrC,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,KAAI;AACtB,QAAA,IAAI,EAAE,KAAK,GAAG,EAAE;YACd,OAAO,CAAC,CAAC,CAAC;SACX;AACD,QAAA,IAAI,EAAE,KAAK,GAAG,EAAE;AACd,YAAA,OAAO,CAAC,CAAC;SACV;AACD,QAAA,OAAO,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;AAC1B,KAAC,CAAC,CAAC;AAEH,IAAA,IAAI,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE;QACjD,GAAG,CAAC,QAAQ,CAAC;AACX,YAAA,IAAI,EAAE,CAAC,CAAC,YAAY,CAAC,MAAM;AAC3B,YAAA,OAAO,EAAE,CAAoE,kEAAA,CAAA;AAC9E,SAAA,CAAC,CAAC;KACJ;AACH,CAAC,CAAC;AAEF,MAAM,2BAA2B,GAAG,CAAC,KAAK,EAAE,GAAoB,KAAI;AAClE,IAAA,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,GAAG,KAAyB,CAAC;AAExE,IAAA,IAAI,CAAC,iBAAiB,IAAI,CAAC,cAAc,EAAE;QACzC,OAAO;KACR;AACD,IAAA,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,iBAAiB,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AAE1D,IAAA,IAAI,iBAAiB,CAAC,SAAS,CAAC,KAAK,SAAS,IAAI,cAAc,CAAC,SAAS,CAAC,KAAK,SAAS,EAAE;QACzF,GAAG,CAAC,QAAQ,CAAC;AACX,YAAA,IAAI,EAAE,CAAC,CAAC,YAAY,CAAC,MAAM;AAC3B,YAAA,OAAO,EAAE,CAAqF,mFAAA,CAAA;AAC9F,YAAA,IAAI,EAAE,CAAC,mBAAmB,EAAE,SAAS,CAAC;AACvC,SAAA,CAAC,CAAC;KACJ;AACH,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IACnC,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,WAAW,CAAC,qBAAqB,CAAC;AACzE,IAAA,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,uBAAuB,CAAC;AAC1C,IAAA,aAAa,EAAE,cAAc;AAC9B,CAAA,CAAC,CAAC;AAEH,MAAM,aAAa,GAAG,CAAC,WAAgB,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,WAAW,CAAC,CAAC;AAEvE,MAAM,8BAA8B,GAAG,CAAC;AAC5C,KAAA,MAAM,CAAC;AACN,IAAA,aAAa,EAAE,aAAa,CAAC,mBAAmB,CAAC;AACjD,IAAA,UAAU,EAAE,aAAa,CAAC,gBAAgB,CAAC;AAC3C,IAAA,aAAa,EAAE,aAAa,CAAC,mBAAmB,CAAC;AACjD,IAAA,cAAc,EAAE,aAAa,CAAC,oBAAoB,CAAC,CAAC,QAAQ,EAAE;AAC9D,IAAA,iBAAiB,EAAE,aAAa,CAAC,uBAAuB,CAAC,CAAC,QAAQ,EAAE;CACrE,CAAC;KACD,WAAW,CAAC,2BAA2B;;;;"}

package/dist/schemas/schemaVersions.d.ts

@@ -0,0 +1,6 @@
+import { z } from 'zod';
+
+declare const SchemaVersions: z.ZodUnion<[z.ZodLiteral<"2023-09-28">, z.ZodLiteral<"2023-08-23">, z.ZodLiteral<"2023-07-26">, z.ZodLiteral<"2023-06-27">]>;
+type SchemaVersions = z.infer<typeof SchemaVersions>;
+
+export { SchemaVersions };

package/dist/schemas/v2023_09_28/experience.d.ts

@@ -0,0 +1,408 @@
+import { z } from 'zod';
+
+declare const DataSourceSchema: z.ZodRecord<z.ZodString, z.ZodObject<{
+    sys: z.ZodObject<{
+        type: z.ZodLiteral<"Link">;
+        id: z.ZodString;
+        linkType: z.ZodUnion<[z.ZodLiteral<"Entry">, z.ZodLiteral<"Asset">]>;
+    }, "strip", z.ZodTypeAny, {
+        type: "Link";
+        id: string;
+        linkType: "Entry" | "Asset";
+    }, {
+        type: "Link";
+        id: string;
+        linkType: "Entry" | "Asset";
+    }>;
+}, "strip", z.ZodTypeAny, {
+    sys: {
+        type: "Link";
+        id: string;
+        linkType: "Entry" | "Asset";
+    };
+}, {
+    sys: {
+        type: "Link";
+        id: string;
+        linkType: "Entry" | "Asset";
+    };
+}>>;
+declare const PrimitiveValueSchema: z.ZodUnion<[z.ZodString, z.ZodBoolean, z.ZodNumber, z.ZodRecord<z.ZodAny, z.ZodAny>, z.ZodUndefined]>;
+declare const ValuesByBreakpointSchema: z.ZodRecord<z.ZodString, z.ZodLazy<z.ZodUnion<[z.ZodString, z.ZodBoolean, z.ZodNumber, z.ZodRecord<z.ZodAny, z.ZodAny>, z.ZodUndefined]>>>;
+declare const ComponentPropertyValueSchema: z.ZodUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"DesignValue">;
+    valuesByBreakpoint: z.ZodRecord<z.ZodString, z.ZodLazy<z.ZodUnion<[z.ZodString, z.ZodBoolean, z.ZodNumber, z.ZodRecord<z.ZodAny, z.ZodAny>, z.ZodUndefined]>>>;
+}, "strip", z.ZodTypeAny, {
+    type: "DesignValue";
+    valuesByBreakpoint: Record<string, string | number | boolean | Record<any, any> | undefined>;
+}, {
+    type: "DesignValue";
+    valuesByBreakpoint: Record<string, string | number | boolean | Record<any, any> | undefined>;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"BoundValue">;
+    path: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    path: string;
+    type: "BoundValue";
+}, {
+    path: string;
+    type: "BoundValue";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"UnboundValue">;
+    key: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "UnboundValue";
+    key: string;
+}, {
+    type: "UnboundValue";
+    key: string;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"ComponentValue">;
+    key: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "ComponentValue";
+    key: string;
+}, {
+    type: "ComponentValue";
+    key: string;
+}>]>;
+type ComponentPropertyValue = z.infer<typeof ComponentPropertyValueSchema>;
+declare const BreakpointSchema: z.ZodObject<{
+    id: z.ZodString;
+    query: z.ZodString;
+    previewSize: z.ZodString;
+    displayName: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    query: string;
+    previewSize: string;
+    displayName: string;
+}, {
+    id: string;
+    query: string;
+    previewSize: string;
+    displayName: string;
+}>;
+declare const UnboundValuesSchema: z.ZodRecord<z.ZodString, z.ZodObject<{
+    value: z.ZodUnion<[z.ZodString, z.ZodBoolean, z.ZodNumber, z.ZodRecord<z.ZodAny, z.ZodAny>, z.ZodUndefined]>;
+}, "strip", z.ZodTypeAny, {
+    value?: string | number | boolean | Record<any, any> | undefined;
+}, {
+    value?: string | number | boolean | Record<any, any> | undefined;
+}>>;
+declare const BaseComponentTreeNodeSchema: z.ZodObject<{
+    definitionId: z.ZodString;
+    variables: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodObject<{
+        type: z.ZodLiteral<"DesignValue">;
+        valuesByBreakpoint: z.ZodRecord<z.ZodString, z.ZodLazy<z.ZodUnion<[z.ZodString, z.ZodBoolean, z.ZodNumber, z.ZodRecord<z.ZodAny, z.ZodAny>, z.ZodUndefined]>>>;
+    }, "strip", z.ZodTypeAny, {
+        type: "DesignValue";
+        valuesByBreakpoint: Record<string, string | number | boolean | Record<any, any> | undefined>;
+    }, {
+        type: "DesignValue";
+        valuesByBreakpoint: Record<string, string | number | boolean | Record<any, any> | undefined>;
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"BoundValue">;
+        path: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        path: string;
+        type: "BoundValue";
+    }, {
+        path: string;
+        type: "BoundValue";
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"UnboundValue">;
+        key: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: "UnboundValue";
+        key: string;
+    }, {
+        type: "UnboundValue";
+        key: string;
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"ComponentValue">;
+        key: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: "ComponentValue";
+        key: string;
+    }, {
+        type: "ComponentValue";
+        key: string;
+    }>]>>;
+}, "strip", z.ZodTypeAny, {
+    definitionId: string;
+    variables: Record<string, {
+        type: "DesignValue";
+        valuesByBreakpoint: Record<string, string | number | boolean | Record<any, any> | undefined>;
+    } | {
+        path: string;
+        type: "BoundValue";
+    } | {
+        type: "UnboundValue";
+        key: string;
+    } | {
+        type: "ComponentValue";
+        key: string;
+    }>;
+}, {
+    definitionId: string;
+    variables: Record<string, {
+        type: "DesignValue";
+        valuesByBreakpoint: Record<string, string | number | boolean | Record<any, any> | undefined>;
+    } | {
+        path: string;
+        type: "BoundValue";
+    } | {
+        type: "UnboundValue";
+        key: string;
+    } | {
+        type: "ComponentValue";
+        key: string;
+    }>;
+}>;
+type ComponentTreeNode = z.infer<typeof BaseComponentTreeNodeSchema> & {
+    children: ComponentTreeNode[];
+};
+declare const ComponentSettingsSchema: z.ZodObject<{
+    variableDefinitions: z.ZodRecord<z.ZodString, z.ZodObject<{
+        displayName: z.ZodString;
+        type: z.ZodEnum<["Text", "RichText", "Number", "Date", "Boolean", "Location", "Media", "Object"]>;
+        defaultValue: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
+            type: z.ZodLiteral<"DesignValue">;
+            valuesByBreakpoint: z.ZodRecord<z.ZodString, z.ZodLazy<z.ZodUnion<[z.ZodString, z.ZodBoolean, z.ZodNumber, z.ZodRecord<z.ZodAny, z.ZodAny>, z.ZodUndefined]>>>;
+        }, "strip", z.ZodTypeAny, {
+            type: "DesignValue";
+            valuesByBreakpoint: Record<string, string | number | boolean | Record<any, any> | undefined>;
+        }, {
+            type: "DesignValue";
+            valuesByBreakpoint: Record<string, string | number | boolean | Record<any, any> | undefined>;
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"BoundValue">;
+            path: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            path: string;
+            type: "BoundValue";
+        }, {
+            path: string;
+            type: "BoundValue";
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"UnboundValue">;
+            key: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            type: "UnboundValue";
+            key: string;
+        }, {
+            type: "UnboundValue";
+            key: string;
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"ComponentValue">;
+            key: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            type: "ComponentValue";
+            key: string;
+        }, {
+            type: "ComponentValue";
+            key: string;
+        }>]>>;
+        description: z.ZodOptional<z.ZodString>;
+        group: z.ZodOptional<z.ZodString>;
+        validations: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    }, "strip", z.ZodTypeAny, {
+        type: "Text" | "RichText" | "Number" | "Date" | "Boolean" | "Location" | "Media" | "Object";
+        displayName: string;
+        defaultValue?: {
+            type: "DesignValue";
+            valuesByBreakpoint: Record<string, string | number | boolean | Record<any, any> | undefined>;
+        } | {
+            path: string;
+            type: "BoundValue";
+        } | {
+            type: "UnboundValue";
+            key: string;
+        } | {
+            type: "ComponentValue";
+            key: string;
+        } | undefined;
+        description?: string | undefined;
+        group?: string | undefined;
+        validations?: Record<string, string> | undefined;
+    }, {
+        type: "Text" | "RichText" | "Number" | "Date" | "Boolean" | "Location" | "Media" | "Object";
+        displayName: string;
+        defaultValue?: {
+            type: "DesignValue";
+            valuesByBreakpoint: Record<string, string | number | boolean | Record<any, any> | undefined>;
+        } | {
+            path: string;
+            type: "BoundValue";
+        } | {
+            type: "UnboundValue";
+            key: string;
+        } | {
+            type: "ComponentValue";
+            key: string;
+        } | undefined;
+        description?: string | undefined;
+        group?: string | undefined;
+        validations?: Record<string, string> | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    variableDefinitions: Record<string, {
+        type: "Text" | "RichText" | "Number" | "Date" | "Boolean" | "Location" | "Media" | "Object";
+        displayName: string;
+        defaultValue?: {
+            type: "DesignValue";
+            valuesByBreakpoint: Record<string, string | number | boolean | Record<any, any> | undefined>;
+        } | {
+            path: string;
+            type: "BoundValue";
+        } | {
+            type: "UnboundValue";
+            key: string;
+        } | {
+            type: "ComponentValue";
+            key: string;
+        } | undefined;
+        description?: string | undefined;
+        group?: string | undefined;
+        validations?: Record<string, string> | undefined;
+    }>;
+}, {
+    variableDefinitions: Record<string, {
+        type: "Text" | "RichText" | "Number" | "Date" | "Boolean" | "Location" | "Media" | "Object";
+        displayName: string;
+        defaultValue?: {
+            type: "DesignValue";
+            valuesByBreakpoint: Record<string, string | number | boolean | Record<any, any> | undefined>;
+        } | {
+            path: string;
+            type: "BoundValue";
+        } | {
+            type: "UnboundValue";
+            key: string;
+        } | {
+            type: "ComponentValue";
+            key: string;
+        } | undefined;
+        description?: string | undefined;
+        group?: string | undefined;
+        validations?: Record<string, string> | undefined;
+    }>;
+}>;
+declare const UsedComponentsSchema: z.ZodArray<z.ZodObject<{
+    sys: z.ZodObject<{
+        type: z.ZodLiteral<"Link">;
+        id: z.ZodString;
+        linkType: z.ZodLiteral<"Entry">;
+    }, "strip", z.ZodTypeAny, {
+        type: "Link";
+        id: string;
+        linkType: "Entry";
+    }, {
+        type: "Link";
+        id: string;
+        linkType: "Entry";
+    }>;
+}, "strip", z.ZodTypeAny, {
+    sys: {
+        type: "Link";
+        id: string;
+        linkType: "Entry";
+    };
+}, {
+    sys: {
+        type: "Link";
+        id: string;
+        linkType: "Entry";
+    };
+}>, "many">;
+declare const ComponentTreeSchema: z.ZodObject<{
+    breakpoints: z.ZodEffects<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        query: z.ZodString;
+        previewSize: z.ZodString;
+        displayName: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        query: string;
+        previewSize: string;
+        displayName: string;
+    }, {
+        id: string;
+        query: string;
+        previewSize: string;
+        displayName: string;
+    }>, "many">, {
+        id: string;
+        query: string;
+        previewSize: string;
+        displayName: string;
+    }[], {
+        id: string;
+        query: string;
+        previewSize: string;
+        displayName: string;
+    }[]>;
+    children: z.ZodArray<z.ZodType<ComponentTreeNode, z.ZodTypeDef, ComponentTreeNode>, "many">;
+    schemaVersion: z.ZodUnion<[z.ZodLiteral<"2023-09-28">, z.ZodLiteral<"2023-08-23">, z.ZodLiteral<"2023-07-26">, z.ZodLiteral<"2023-06-27">]>;
+}, "strip", z.ZodTypeAny, {
+    children: ComponentTreeNode[];
+    breakpoints: {
+        id: string;
+        query: string;
+        previewSize: string;
+        displayName: string;
+    }[];
+    schemaVersion: "2023-09-28" | "2023-08-23" | "2023-07-26" | "2023-06-27";
+}, {
+    children: ComponentTreeNode[];
+    breakpoints: {
+        id: string;
+        query: string;
+        previewSize: string;
+        displayName: string;
+    }[];
+    schemaVersion: "2023-09-28" | "2023-08-23" | "2023-07-26" | "2023-06-27";
+}>;
+declare const ExperienceFieldsCMAShapeSchema: z.ZodEffects<z.ZodObject<{
+    componentTree: z.ZodRecord<z.ZodString, any>;
+    dataSource: z.ZodRecord<z.ZodString, any>;
+    unboundValues: z.ZodRecord<z.ZodString, any>;
+    usedComponents: z.ZodOptional<z.ZodRecord<z.ZodString, any>>;
+    componentSettings: z.ZodOptional<z.ZodRecord<z.ZodString, any>>;
+}, "strip", z.ZodTypeAny, {
+    componentTree: Record<string, any>;
+    dataSource: Record<string, any>;
+    unboundValues: Record<string, any>;
+    usedComponents?: Record<string, any> | undefined;
+    componentSettings?: Record<string, any> | undefined;
+}, {
+    componentTree: Record<string, any>;
+    dataSource: Record<string, any>;
+    unboundValues: Record<string, any>;
+    usedComponents?: Record<string, any> | undefined;
+    componentSettings?: Record<string, any> | undefined;
+}>, {
+    componentTree: Record<string, any>;
+    dataSource: Record<string, any>;
+    unboundValues: Record<string, any>;
+    usedComponents?: Record<string, any> | undefined;
+    componentSettings?: Record<string, any> | undefined;
+}, {
+    componentTree: Record<string, any>;
+    dataSource: Record<string, any>;
+    unboundValues: Record<string, any>;
+    usedComponents?: Record<string, any> | undefined;
+    componentSettings?: Record<string, any> | undefined;
+}>;
+type ExperienceFields = z.infer<typeof ExperienceFieldsCMAShapeSchema>;
+type ExperienceDataSource = z.infer<typeof DataSourceSchema>;
+type ExperienceUnboundValues = z.infer<typeof UnboundValuesSchema>;
+type ExperienceUsedComponents = z.infer<typeof UsedComponentsSchema>;
+type ExperienceComponentSettings = z.infer<typeof ComponentSettingsSchema>;
+type ExperienceComponentTree = z.infer<typeof ComponentTreeSchema>;
+type ValuesByBreakpoint = z.infer<typeof ValuesByBreakpointSchema>;
+type Breakpoint = z.infer<typeof BreakpointSchema>;
+type PrimitiveValue = z.infer<typeof PrimitiveValueSchema>;
+
+export { type Breakpoint, type ComponentPropertyValue, type ComponentTreeNode, type ExperienceComponentSettings, type ExperienceComponentTree, type ExperienceDataSource, type ExperienceFields, ExperienceFieldsCMAShapeSchema, type ExperienceUnboundValues, type ExperienceUsedComponents, type PrimitiveValue, type ValuesByBreakpoint };

package/dist/types.d.ts

@@ -0,0 +1,2 @@
+export { Breakpoint, ComponentPropertyValue, ComponentTreeNode, ExperienceComponentSettings, ExperienceComponentTree, ExperienceDataSource, ExperienceFields, ExperienceUnboundValues, ExperienceUsedComponents, PrimitiveValue, ValuesByBreakpoint } from './schemas/v2023_09_28/experience.js';
+export { SchemaVersions } from './schemas/schemaVersions.js';

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@contentful/experiences-validators",
+  "version": "0.0.1-alpha.0",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "type": "module",
+  "homepage": "https://github.com/contentful/experience-builder/tree/next/packages/validators#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/contentful/experience-builder.git"
+  },
+  "scripts": {
+    "dev": "vite",
+    "clean": "rimraf dist",
+    "prebuild": "npm run clean",
+    "build": "rollup -c rollup.config.mjs",
+    "preview": "vite preview",
+    "test": "vitest",
+    "test:coverage": "vitest run --coverage"
+  },
+  "files": [
+    "dist/**/*.*"
+  ],
+  "exports": {
+    "*": {
+      "types": [
+        "./dist/index.d.ts"
+      ]
+    }
+  },
+  "devDependencies": {
+    "typescript": "^5.2.2",
+    "vite": "^5.0.8",
+    "vitest": "^1.2.2"
+  },
+  "dependencies": {
+    "zod": "^3.22.4"
+  },
+  "publishConfig": {
+    "registry": "https://npm.pkg.github.com/"
+  },
+  "gitHead": "8abedfa96df2f322f0d13958296ccfff5d53587d"
+}