@contentful/experiences-validators 0.0.1-alpha.0 → 0.0.1-dev-20240216T095248.0

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 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';
+export { validateExperienceFields } from './validators.js';

package/dist/index.js

@@ -145,5 +145,34 @@ const ExperienceFieldsCMAShapeSchema = z
 })
     .superRefine(componentSettingsRefinement);
 
-export { ExperienceFieldsCMAShapeSchema as Schema_2023_09_28 };
+const VERSION_SCHEMAS = {
+    '2023-09-28': ExperienceFieldsCMAShapeSchema,
+};
+const validateExperienceFields = (experience, schemaVersion) => {
+    const schema = VERSION_SCHEMAS[schemaVersion];
+    if (!schema) {
+        return {
+            success: false,
+            error: new z.ZodError([
+                {
+                    code: z.ZodIssueCode.invalid_literal,
+                    expected: '2023-09-28',
+                    received: schemaVersion,
+                    path: ['fields', 'componentTree', 'schemaVersion'],
+                    message: 'Unsupported schema version',
+                },
+            ]),
+        };
+    }
+    const fieldsToValidate = {
+        componentTree: experience.fields.componentTree,
+        dataSource: experience.fields.dataSource,
+        unboundValues: experience.fields.unboundValues,
+        usedComponents: experience.fields.usedComponents,
+        componentSettings: experience.fields.componentSettings,
+    };
+    return schema.safeParse(fieldsToValidate);
+};
+
+export { ExperienceFieldsCMAShapeSchema as Schema_2023_09_28, validateExperienceFields };
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +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;;;;"}
+{"version":3,"file":"index.js","sources":["../src/schemas/schemaVersions.ts","../src/schemas/v2023_09_28/experience.ts","../src/validators.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","import { Schema_2023_09_28 } from './schemas';\nimport { z } from 'zod';\n\nconst VERSION_SCHEMAS = {\n  '2023-09-28': Schema_2023_09_28,\n};\nexport const validateExperienceFields = (\n  experience: any,\n  schemaVersion: keyof typeof VERSION_SCHEMAS\n): z.SafeParseReturnType<any, any> => {\n  const schema = VERSION_SCHEMAS[schemaVersion];\n\n  if (!schema) {\n    return {\n      success: false,\n      error: new z.ZodError([\n        {\n          code: z.ZodIssueCode.invalid_literal,\n          expected: '2023-09-28',\n          received: schemaVersion,\n          path: ['fields', 'componentTree', 'schemaVersion'],\n          message: 'Unsupported schema version',\n        },\n      ]),\n    };\n  }\n\n  const fieldsToValidate = {\n    componentTree: experience.fields.componentTree,\n    dataSource: experience.fields.dataSource,\n    unboundValues: experience.fields.unboundValues,\n    usedComponents: experience.fields.usedComponents,\n    componentSettings: experience.fields.componentSettings,\n  };\n\n  return schema.safeParse(fieldsToValidate);\n};\n"],"names":["Schema_2023_09_28"],"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;;AC3K1C,MAAM,eAAe,GAAG;AACtB,IAAA,YAAY,EAAEA,8BAAiB;CAChC,CAAC;MACW,wBAAwB,GAAG,CACtC,UAAe,EACf,aAA2C,KACR;AACnC,IAAA,MAAM,MAAM,GAAG,eAAe,CAAC,aAAa,CAAC,CAAC;IAE9C,IAAI,CAAC,MAAM,EAAE;QACX,OAAO;AACL,YAAA,OAAO,EAAE,KAAK;AACd,YAAA,KAAK,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC;AACpB,gBAAA;AACE,oBAAA,IAAI,EAAE,CAAC,CAAC,YAAY,CAAC,eAAe;AACpC,oBAAA,QAAQ,EAAE,YAAY;AACtB,oBAAA,QAAQ,EAAE,aAAa;AACvB,oBAAA,IAAI,EAAE,CAAC,QAAQ,EAAE,eAAe,EAAE,eAAe,CAAC;AAClD,oBAAA,OAAO,EAAE,4BAA4B;AACtC,iBAAA;aACF,CAAC;SACH,CAAC;KACH;AAED,IAAA,MAAM,gBAAgB,GAAG;AACvB,QAAA,aAAa,EAAE,UAAU,CAAC,MAAM,CAAC,aAAa;AAC9C,QAAA,UAAU,EAAE,UAAU,CAAC,MAAM,CAAC,UAAU;AACxC,QAAA,aAAa,EAAE,UAAU,CAAC,MAAM,CAAC,aAAa;AAC9C,QAAA,cAAc,EAAE,UAAU,CAAC,MAAM,CAAC,cAAc;AAChD,QAAA,iBAAiB,EAAE,UAAU,CAAC,MAAM,CAAC,iBAAiB;KACvD,CAAC;AAEF,IAAA,OAAO,MAAM,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;AAC5C;;;;"}

package/dist/validators.d.ts

@@ -0,0 +1,38 @@
+import { z } from 'zod';
+
+declare const VERSION_SCHEMAS: {
+    '2023-09-28': 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;
+    }>;
+};
+declare const validateExperienceFields: (experience: any, schemaVersion: keyof typeof VERSION_SCHEMAS) => z.SafeParseReturnType<any, any>;
+
+export { validateExperienceFields };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/experiences-validators",
-  "version": "0.0.1-alpha.0",
+  "version": "0.0.1-dev-20240216T095248.0",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -40,5 +40,5 @@
   "publishConfig": {
     "registry": "https://npm.pkg.github.com/"
   },
-  "gitHead": "8abedfa96df2f322f0d13958296ccfff5d53587d"
+  "gitHead": "02380d6700bd4e3fbf80a4e714cfa2bf3b34b3fd"
 }