@cogenta/schema 0.1.0

package/dist/validation.js

@@ -0,0 +1,183 @@
+import { CogentaError } from '@cogenta/core';
+import { z } from 'zod';
+import { richTextDocumentSchema } from './rich-text.js';
+import { systemFieldsSchema } from './system-fields.js';
+/**
+ * Written out rather than taken from Zod's helper: a `json` column must hold
+ * what `JSON.parse` can return and nothing else — no `undefined`, no `Date`,
+ * no class instance that would come back as `{}` after a round-trip.
+ */
+export const jsonValueSchema = z.lazy(() => z.union([
+    z.string(),
+    z.number().finite(),
+    z.boolean(),
+    z.null(),
+    z.array(jsonValueSchema),
+    z.record(z.string(), jsonValueSchema),
+]));
+export const geoPointSchema = z.strictObject({
+    lat: z.number().min(-90).max(90),
+    lng: z.number().min(-180).max(180),
+    label: z.string().optional(),
+});
+/** Lowercase words joined by single hyphens: what a URL segment may contain. */
+export const SLUG_PATTERN = /^[a-z0-9]+(?:-[a-z0-9]+)*$/;
+/** `#rgb`, `#rrggbb` or `#rrggbbaa`. A colour is data, never a CSS value (R3). */
+export const COLOR_PATTERN = /^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$/;
+export const contentBlockSchema = z.looseObject({
+    /** Stable for the life of the block: comments, diffs and RAG chunks key off it. */
+    _key: z.string().min(1),
+    _type: z.string().min(1),
+});
+function idSchema() {
+    // Every content id is an application-minted UUIDv7 (ADR-0015), so a reference
+    // that is not uuid-shaped can only be a mistake.
+    return z.uuid();
+}
+function selectValues(field) {
+    const raw = field.options.options;
+    if (!Array.isArray(raw))
+        return [];
+    return raw.map((choice) => typeof choice === 'object' && choice !== null && 'value' in choice
+        ? String(choice.value)
+        : String(choice));
+}
+function numberOption(field, key) {
+    const value = field.options[key];
+    return typeof value === 'number' ? value : undefined;
+}
+/**
+ * A field that holds several values is stored as rows in a join table, and a
+ * join table cannot say "null" — it can only have no rows. So `required` on a
+ * to-many field means "at least one", and its empty case is `[]`, never null.
+ */
+function manyOf(item, field) {
+    const array = z.array(item);
+    return field.required === true ? array.min(1) : array;
+}
+export function isCollectionValued(field) {
+    if (field.kind === 'blocks')
+        return true;
+    const isManyKind = field.kind === 'media' || field.kind === 'relation' || field.kind === 'select';
+    return isManyKind && field.options.many === true;
+}
+function baseSchemaFor(field) {
+    switch (field.kind) {
+        case 'text': {
+            let schema = z.string();
+            const min = numberOption(field, 'min');
+            const max = numberOption(field, 'max');
+            if (min !== undefined)
+                schema = schema.min(min);
+            if (max !== undefined)
+                schema = schema.max(max);
+            return schema;
+        }
+        case 'richText':
+            return richTextDocumentSchema;
+        case 'slug': {
+            let schema = z.string().regex(SLUG_PATTERN, 'must be lowercase words joined by hyphens');
+            const max = numberOption(field, 'max');
+            if (max !== undefined)
+                schema = schema.max(max);
+            return schema;
+        }
+        case 'number': {
+            let schema = field.options.integer === true ? z.number().int() : z.number().finite();
+            const min = numberOption(field, 'min');
+            const max = numberOption(field, 'max');
+            if (min !== undefined)
+                schema = schema.min(min);
+            if (max !== undefined)
+                schema = schema.max(max);
+            return schema;
+        }
+        case 'boolean':
+            return z.boolean();
+        case 'date':
+            return z.iso.date();
+        case 'datetime':
+            return z.iso.datetime({ offset: true });
+        case 'media':
+        case 'relation':
+            return field.options.many === true ? manyOf(idSchema(), field) : idSchema();
+        case 'select': {
+            const choice = z.enum(selectValues(field));
+            return field.options.many === true ? manyOf(choice, field) : choice;
+        }
+        case 'json':
+            return jsonValueSchema;
+        case 'geo':
+            return geoPointSchema;
+        case 'color':
+            return z.string().regex(COLOR_PATTERN, 'must be a hex colour such as #1a2b3c');
+        case 'blocks': {
+            const allow = field.options.allow;
+            const blocks = manyOf(contentBlockSchema, field);
+            if (allow === '*' || !Array.isArray(allow))
+                return blocks;
+            const allowed = new Set(allow.map(String));
+            return blocks.superRefine((value, context) => {
+                for (const [index, block] of value.entries()) {
+                    if (!allowed.has(block._type)) {
+                        context.addIssue({
+                            code: 'custom',
+                            message: `block "${block._type}" is not allowed here`,
+                            path: [index, '_type'],
+                        });
+                    }
+                }
+            });
+        }
+        default:
+            throw new CogentaError({
+                code: 'SCHEMA_INVALID',
+                message: `Unknown field kind "${String(field.kind)}".`,
+                hint: 'Build fields with the `f` constructors from @cogenta/schema.',
+            });
+    }
+}
+/**
+ * The validator for one field, custom rule and optionality included.
+ *
+ * An optional field accepts `null` and an absent key alike: a form that never
+ * showed the field and a form that cleared it mean the same thing to storage.
+ */
+export function fieldSchema(field) {
+    let schema = baseSchemaFor(field);
+    const { validate } = field;
+    if (validate !== undefined) {
+        schema = schema.superRefine((value, context) => {
+            const verdict = validate(value);
+            if (verdict !== true) {
+                context.addIssue({ code: 'custom', message: verdict });
+            }
+        });
+    }
+    if (field.required === true)
+        return schema;
+    // Absent and null both mean "nothing was entered". They are normalised to one
+    // stored shape so that a reader never has to handle two spellings of empty.
+    return isCollectionValued(field)
+        ? schema.nullish().transform((value) => value ?? [])
+        : schema.nullish().transform((value) => value ?? null);
+}
+/** What an author may send: the declared fields, and nothing else. */
+export function collectionInputSchema(collection) {
+    const shape = {};
+    for (const [name, field] of Object.entries(collection.fields)) {
+        shape[name] = fieldSchema(field);
+    }
+    // Strict on purpose, as everywhere else in Cogenta: an unknown key is a typo
+    // in a field name, and dropping it silently loses the editor's work.
+    return z.strictObject(shape);
+}
+/** A stored entry: system fields plus the declared ones. */
+export function collectionEntrySchema(collection) {
+    const shape = {};
+    for (const [name, field] of Object.entries(collection.fields)) {
+        shape[name] = fieldSchema(field);
+    }
+    return systemFieldsSchema.extend(shape);
+}
+//# sourceMappingURL=validation.js.map

package/dist/validation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.js","sourceRoot":"","sources":["../src/validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AACvB,OAAO,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAA;AACvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAA;AAmBvD;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAyB,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAC/D,CAAC,CAAC,KAAK,CAAC;IACN,CAAC,CAAC,MAAM,EAAE;IACV,CAAC,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE;IACnB,CAAC,CAAC,OAAO,EAAE;IACX,CAAC,CAAC,IAAI,EAAE;IACR,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC;IACxB,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,eAAe,CAAC;CACtC,CAAC,CACH,CAAA;AAED,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,YAAY,CAAC;IAC3C,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;IAChC,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;IAClC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC7B,CAAC,CAAA;AAIF,gFAAgF;AAChF,MAAM,CAAC,MAAM,YAAY,GAAG,4BAA4B,CAAA;AAExD,kFAAkF;AAClF,MAAM,CAAC,MAAM,aAAa,GAAG,qDAAqD,CAAA;AAElF,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,WAAW,CAAC;IAC9C,mFAAmF;IACnF,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACvB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;CACzB,CAAC,CAAA;AAYF,SAAS,QAAQ;IACf,8EAA8E;IAC9E,iDAAiD;IACjD,OAAO,CAAC,CAAC,IAAI,EAAE,CAAA;AACjB,CAAC;AAED,SAAS,YAAY,CAAC,KAAsB;IAC1C,MAAM,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAA;IACjC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC;QAAE,OAAO,EAAE,CAAA;IAClC,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CACxB,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,IAAI,OAAO,IAAI,MAAM;QAChE,CAAC,CAAC,MAAM,CAAE,MAA6B,CAAC,KAAK,CAAC;QAC9C,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CACnB,CAAA;AACH,CAAC;AAED,SAAS,YAAY,CAAC,KAAsB,EAAE,GAAW;IACvD,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;IAChC,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAA;AACtD,CAAC;AAED;;;;GAIG;AACH,SAAS,MAAM,CAAsB,IAAO,EAAE,KAAsB;IAClE,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IAC3B,OAAO,KAAK,CAAC,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAA;AACvD,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,KAAsB;IACvD,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAA;IACxC,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,KAAK,OAAO,IAAI,KAAK,CAAC,IAAI,KAAK,UAAU,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAA;IACjG,OAAO,UAAU,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,KAAK,IAAI,CAAA;AAClD,CAAC;AAED,SAAS,aAAa,CAAC,KAAsB;IAC3C,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,MAAM,EAAE,CAAC;YACZ,IAAI,MAAM,GAAG,CAAC,CAAC,MAAM,EAAE,CAAA;YACvB,MAAM,GAAG,GAAG,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;YACtC,MAAM,GAAG,GAAG,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;YACtC,IAAI,GAAG,KAAK,SAAS;gBAAE,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;YAC/C,IAAI,GAAG,KAAK,SAAS;gBAAE,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;YAC/C,OAAO,MAAM,CAAA;QACf,CAAC;QACD,KAAK,UAAU;YACb,OAAO,sBAAsB,CAAA;QAC/B,KAAK,MAAM,EAAE,CAAC;YACZ,IAAI,MAAM,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,YAAY,EAAE,2CAA2C,CAAC,CAAA;YACxF,MAAM,GAAG,GAAG,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;YACtC,IAAI,GAAG,KAAK,SAAS;gBAAE,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;YAC/C,OAAO,MAAM,CAAA;QACf,CAAC;QACD,KAAK,QAAQ,EAAE,CAAC;YACd,IAAI,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,CAAA;YACpF,MAAM,GAAG,GAAG,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;YACtC,MAAM,GAAG,GAAG,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;YACtC,IAAI,GAAG,KAAK,SAAS;gBAAE,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;YAC/C,IAAI,GAAG,KAAK,SAAS;gBAAE,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;YAC/C,OAAO,MAAM,CAAA;QACf,CAAC;QACD,KAAK,SAAS;YACZ,OAAO,CAAC,CAAC,OAAO,EAAE,CAAA;QACpB,KAAK,MAAM;YACT,OAAO,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,CAAA;QACrB,KAAK,UAAU;YACb,OAAO,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAA;QACzC,KAAK,OAAO,CAAC;QACb,KAAK,UAAU;YACb,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAA;QAC7E,KAAK,QAAQ,EAAE,CAAC;YACd,MAAM,MAAM,GAAG,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAA;YAC1C,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAA;QACrE,CAAC;QACD,KAAK,MAAM;YACT,OAAO,eAAe,CAAA;QACxB,KAAK,KAAK;YACR,OAAO,cAAc,CAAA;QACvB,KAAK,OAAO;YACV,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,aAAa,EAAE,sCAAsC,CAAC,CAAA;QAChF,KAAK,QAAQ,EAAE,CAAC;YACd,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAA;YACjC,MAAM,MAAM,GAAG,MAAM,CAAC,kBAAkB,EAAE,KAAK,CAAC,CAAA;YAChD,IAAI,KAAK,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;gBAAE,OAAO,MAAM,CAAA;YACzD,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAA;YAC1C,OAAO,MAAM,CAAC,WAAW,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;gBAC3C,KAAK,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;oBAC7C,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;wBAC9B,OAAO,CAAC,QAAQ,CAAC;4BACf,IAAI,EAAE,QAAQ;4BACd,OAAO,EAAE,UAAU,KAAK,CAAC,KAAK,uBAAuB;4BACrD,IAAI,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC;yBACvB,CAAC,CAAA;oBACJ,CAAC;gBACH,CAAC;YACH,CAAC,CAAC,CAAA;QACJ,CAAC;QACD;YACE,MAAM,IAAI,YAAY,CAAC;gBACrB,IAAI,EAAE,gBAAgB;gBACtB,OAAO,EAAE,uBAAuB,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI;gBACtD,IAAI,EAAE,8DAA8D;aACrE,CAAC,CAAA;IACN,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,KAAsB;IAChD,IAAI,MAAM,GAAG,aAAa,CAAC,KAAK,CAAC,CAAA;IAEjC,MAAM,EAAE,QAAQ,EAAE,GAAG,KAAK,CAAA;IAC1B,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,MAAM,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,KAAc,EAAE,OAAO,EAAE,EAAE;YACtD,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAA;YAC/B,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;gBACrB,OAAO,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAA;YACxD,CAAC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,IAAI,KAAK,CAAC,QAAQ,KAAK,IAAI;QAAE,OAAO,MAAM,CAAA;IAE1C,8EAA8E;IAC9E,4EAA4E;IAC5E,OAAO,kBAAkB,CAAC,KAAK,CAAC;QAC9B,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC;QACpD,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,IAAI,IAAI,CAAC,CAAA;AAC1D,CAAC;AAED,sEAAsE;AACtE,MAAM,UAAU,qBAAqB,CAAC,UAAgC;IACpE,MAAM,KAAK,GAA8B,EAAE,CAAA;IAC3C,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QAC9D,KAAK,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,CAAA;IAClC,CAAC;IACD,6EAA6E;IAC7E,qEAAqE;IACrE,OAAO,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAA;AAC9B,CAAC;AAED,4DAA4D;AAC5D,MAAM,UAAU,qBAAqB,CAAC,UAAgC;IACpE,MAAM,KAAK,GAA8B,EAAE,CAAA;IAC3C,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QAC9D,KAAK,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,CAAA;IAClC,CAAC;IACD,OAAO,kBAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;AACzC,CAAC"}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@cogenta/schema",
+  "version": "0.1.0",
+  "description": "Content schema in code: collections, field types, generated types and migrations.",
+  "license": "MPL-2.0",
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=22.11.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/cogenta-cms/cogenta.git",
+    "directory": "packages/schema"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "typecheck": "tsc -p tsconfig.typecheck.json",
+    "test": "vitest run --passWithNoTests",
+    "test:integration": "vitest run --config vitest.integration.config.ts --passWithNoTests"
+  },
+  "dependencies": {
+    "@cogenta/core": "workspace:*",
+    "zod": "catalog:"
+  },
+  "devDependencies": {
+    "typescript": "catalog:",
+    "vitest": "catalog:"
+  }
+}