@fougere/schema 0.12.0-alpha.0 → 0.12.2-alpha.0

package/dist/projection/card/RelationDescriptor.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"RelationDescriptor.js","sourceRoot":"","sources":["../../../src/projection/card/RelationDescriptor.ts"],"names":[],"mappings":""}

package/dist/validator/AdapterFieldValidator.d.ts

@@ -1,14 +0,0 @@
-import type { Shape } from '../axis/shape/Shape.js';
-/**
- * The format is DATA, not a TypeScript interface: an interface is erased before a JS
- * caller, a config or a card from another language could be measured against it.
- */
-export declare class AdapterFieldValidator {
-    private readonly validator;
-    private constructor();
-    /** Compiled once, at the adapter's own module load. */
-    static of(format: Shape): AdapterFieldValidator;
-    /** `Post.adapters.sql.body.columnType: Property "postgre" does not match …` */
-    assert(entries: unknown, path: string): void;
-}
-//# sourceMappingURL=AdapterFieldValidator.d.ts.map

package/dist/validator/AdapterFieldValidator.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"AdapterFieldValidator.d.ts","sourceRoot":"","sources":["../../src/validator/AdapterFieldValidator.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAC;AAIpD;;;GAGG;AACH,qBAAa,qBAAqB;IACZ,OAAO,CAAC,QAAQ,CAAC,SAAS;IAA9C,OAAO,eAAsD;IAE7D,uDAAuD;IACvD,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,KAAK,GAAG,qBAAqB,CAE9C;IAED,+EAA+E;IAC/E,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,CAqB3C;CACF"}

package/dist/validator/AdapterFieldValidator.js

@@ -1,37 +0,0 @@
-import { Validator } from '@cfworker/json-schema';
-import { isObject } from '../lib/utils.js';
-import { SchemaError } from '../SchemaError.js';
-/**
- * The format is DATA, not a TypeScript interface: an interface is erased before a JS
- * caller, a config or a card from another language could be measured against it.
- */
-export class AdapterFieldValidator {
-    validator;
-    constructor(validator) {
-        this.validator = validator;
-    }
-    /** Compiled once, at the adapter's own module load. */
-    static of(format) {
-        return new AdapterFieldValidator(new Validator(format, '2020-12', true));
-    }
-    /** `Post.adapters.sql.body.columnType: Property "postgre" does not match …` */
-    assert(entries, path) {
-        if (entries === undefined)
-            return;
-        if (!isObject(entries)) {
-            throw new SchemaError(`${path}: expected an object keyed by field name, got ${typeof entries}.`);
-        }
-        for (const [field, entry] of Object.entries(entries)) {
-            const verdict = this.validator.validate(entry);
-            if (verdict.valid)
-                continue;
-            // The engine reports outermost first and ends on `False boolean schema`, which names
-            // nothing. The last unit above that one is the one carrying the offending key.
-            const units = verdict.errors.filter((unit) => unit.keyword !== 'false');
-            const failure = units[units.length - 1] ?? verdict.errors[0];
-            const nested = (failure?.instanceLocation ?? '#').slice(1).replaceAll('/', '.');
-            throw new SchemaError(`${path}.${field}${nested}: ${failure?.error ?? 'does not match the format'}`);
-        }
-    }
-}
-//# sourceMappingURL=AdapterFieldValidator.js.map

package/dist/validator/AdapterFieldValidator.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"AdapterFieldValidator.js","sourceRoot":"","sources":["../../src/validator/AdapterFieldValidator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAElD,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD;;;GAGG;AACH,MAAM,OAAO,qBAAqB;IACK,SAAS;IAA9C,YAAqC,SAAoB;yBAApB,SAAS;IAAc,CAAC;IAE7D,uDAAuD;IACvD,MAAM,CAAC,EAAE,CAAC,MAAa;QACrB,OAAO,IAAI,qBAAqB,CAAC,IAAI,SAAS,CAAC,MAAgB,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;IACrF,CAAC;IAED,+EAA+E;IAC/E,MAAM,CAAC,OAAgB,EAAE,IAAY;QACnC,IAAI,OAAO,KAAK,SAAS;YAAE,OAAO;QAElC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YACvB,MAAM,IAAI,WAAW,CACnB,GAAG,IAAI,iDAAiD,OAAO,OAAO,GAAG,CAC1E,CAAC;QACJ,CAAC;QAED,KAAK,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YACrD,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAC/C,IAAI,OAAO,CAAC,KAAK;gBAAE,SAAS;YAE5B,qFAAqF;YACrF,+EAA+E;YAC/E,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,KAAK,OAAO,CAAC,CAAC;YACxE,MAAM,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YAC7D,MAAM,MAAM,GAAG,CAAC,OAAO,EAAE,gBAAgB,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;YAEhF,MAAM,IAAI,WAAW,CAAC,GAAG,IAAI,IAAI,KAAK,GAAG,MAAM,KAAK,OAAO,EAAE,KAAK,IAAI,2BAA2B,EAAE,CAAC,CAAC;QACvG,CAAC;IACH,CAAC;CACF"}

package/src/axis/boundary/BoundaryAxis.ts

@@ -1,32 +0,0 @@
-import type { Axis } from '../Axis.js';
-import { admitWire } from '../../projection/card/admission.js';
-import { isObject, shown } from '../../lib/utils.js';
-import type { BoundaryRef } from './BoundaryRef.js';
-
-export const boundaryAxis: Axis<BoundaryRef, BoundaryRef> = {
-  slot: 'boundary',
-
-  validator(value, errors) {
-    if (typeof value === 'string') return; 
-    if (!isObject(value)) {
-      errors.push({
-        path: ['boundary'],
-        message: `Expected an alias name or { in, out } — got ${shown(value)}`,
-      });
-      return;
-    }
-    for (const [side, verb] of [['in', 'decode'], ['out', 'encode']] as const) {
-      const rule = value[side];
-      if (rule === undefined || rule === 'closed') continue;
-      if (!isObject(rule) || typeof rule[verb] !== 'string') {
-        errors.push({ path: ['boundary', side], message: `Expected 'closed' or { ${verb}: <name> }` });
-      }
-    }
-  },
-
-  describe: (value) => value,
-  reconstruct: (wire) => {
-    admitWire(boundaryAxis.validator, wire, 'boundary');
-    return wire;
-  },
-};

package/src/axis/boundary/BoundaryRef.ts

@@ -1,3 +0,0 @@
-import type { BoundaryRules } from './BoundaryRules.js';
-
-export type BoundaryRef = 'isoDate' | (string & {}) | BoundaryRules;

package/src/axis/boundary/BoundaryRules.ts

@@ -1,4 +0,0 @@
-export interface BoundaryRules {
-  in?: 'closed' | { decode: string };
-  out?: 'closed' | { encode: string };
-}

package/src/axis/lifecycle/Clock.ts

@@ -1,22 +0,0 @@
-export class Clock {
-  private static reading: () => number = Date.now;
-
-  static now(): number {
-    return this.reading();
-  }
-
-  /**
-   *
-   * @returns function to restore the clock
-   */
-  static freeze(at: number | Date): () => void {
-    const previous = this.reading;
-    const instant = at instanceof Date ? at.getTime() : at;
-
-    this.reading = () => instant;
-
-    return () => {
-      this.reading = previous;
-    };
-  }
-}

package/src/axis/lifecycle/LifecycleAxis.ts

@@ -1,55 +0,0 @@
-import type { Axis } from '../Axis.js';
-import type { ValidationError } from '../../lib/ValidationError.js';
-import { admitWire, oneOfTokens } from '../../projection/card/admission.js';
-import { isObject, shown } from '../../lib/utils.js';
-import { CREATE_TOKENS, UPDATE_TOKENS } from './LifecycleRules.js';
-import { type LifecycleRules } from './LifecycleRules.js';
-
-export const lifecycleAxis: Axis<LifecycleRules, LifecycleRules> = {
-  slot: 'lifecycle',
-
-  validator(value, errors) {
-    if (!isObject(value)) {
-      errors.push({ path: ['lifecycle'], message: `Expected an object — got ${shown(value)}` });
-      return;
-    }
-    if (value.create !== undefined) validateCreate(value.create, errors);
-    if (value.update !== undefined && !oneOfTokens(value.update, UPDATE_TOKENS)) {
-      errors.push({
-        path: ['lifecycle', 'update'],
-        message: `Expected 'now' or 'forbidden' — got ${shown(value.update)}`,
-      });
-    }
-  },
-
-  describe: (value) => value,
-  reconstruct: (wire) => {
-    admitWire(lifecycleAxis.validator, wire, 'lifecycle');
-    return wire;
-  },
-};
-
-/**
- * Judges the create rule, whose four legal forms are stated here and nowhere else.
- * FR : juge la règle de création, dont les quatre formes légales sont énoncées ici seulement.
- * `create: 3` → `Expected 'now', 'optional', { value } or { generate } — got 3`
- */
-function validateCreate(rule: unknown, errors: ValidationError[]): void {
-  if (oneOfTokens(rule, CREATE_TOKENS)) return;
-  if (isObject(rule)) {
-    if ('value' in rule) return;
-    if ('generate' in rule) {
-      if (typeof rule.generate !== 'string') {
-        errors.push({
-          path: ['lifecycle', 'create', 'generate'],
-          message: `Expected a generator name — got ${shown(rule.generate)}`,
-        });
-      }
-      return;
-    }
-  }
-  errors.push({
-    path: ['lifecycle', 'create'],
-    message: `Expected 'now', 'optional', { value } or { generate } — got ${shown(rule)}`,
-  });
-}

package/src/axis/lifecycle/LifecycleRules.ts

@@ -1,9 +0,0 @@
-import type { GeneratorRef } from './Generators.js';
-
-export const CREATE_TOKENS = ['now', 'optional'] as const;
-export const UPDATE_TOKENS = ['now', 'forbidden'] as const;
-
-export interface LifecycleRules {
-  create?: { value: unknown } | { generate: GeneratorRef } | (typeof CREATE_TOKENS)[number];
-  update?: (typeof UPDATE_TOKENS)[number];
-}

package/src/axis/role/RoleAxis.ts

@@ -1,104 +0,0 @@
-import type { Axis } from '../Axis.js';
-import type { Resolver } from '../Resolver.js';
-import { refuse, oneOfTokens } from '../../projection/card/admission.js';
-import { isObject, lowerFirst, shown } from '../../lib/utils.js';
-import type { ValidationError } from '../../lib/ValidationError.js';
-import { type EntityConstructor } from './EntityConstructor.js';
-import { ON_DELETE, RELATION_KINDS, type Relation } from './Relation.js';
-import { type RoleRules } from './RoleRules.js';
-import type { RoleDescriptor } from '../../projection/card/RoleDescriptor.js';
-
-export const roleAxis: Axis<RoleRules, RoleDescriptor> = {
-  slot: 'role',
-
-  validator(value, errors) {
-    if (!isObject(value)) {
-      errors.push({ path: ['role'], message: `Expected an object — got ${shown(value)}` });
-      return;
-    }
-    for (const flag of ['primary', 'index', 'unique'] as const) {
-      if (value[flag] !== undefined && typeof value[flag] !== 'boolean') {
-        errors.push({
-          path: ['role', flag],
-          message: `Expected a boolean — got ${shown(value[flag])}`,
-        });
-      }
-    }
-    if (value.relation !== undefined) validateRelation(value.relation, errors);
-  },
-
-  /** A card carries the target's NAME: a class cannot cross a process boundary. */
-  describe(role, key) {
-    const descriptor: Mutable<RoleDescriptor> = {};
-    if (role.primary) descriptor.primary = true;
-    if (role.unique) descriptor.unique = [[key]];
-    if (role.index) descriptor.index = true;
-    if (role.relation) {
-      const target = role.relation.to() as { name?: string };
-      descriptor.relation = {
-        to: lowerFirst(target.name ?? ''),
-        kind: role.relation.kind,
-        ...(role.relation.onDelete ? { onDelete: role.relation.onDelete } : {}),
-      };
-    }
-    return Object.keys(descriptor).length ? descriptor : undefined;
-  },
-
-  reconstruct(wire, resolve?: Resolver) {
-    const rules: RoleRules = {};
-    if (wire.primary) rules.primary = true;
-    if (wire.unique?.some((group) => group.length === 1)) rules.unique = true;
-    if (wire.index) rules.index = true;
-    if (wire.relation) {
-      // `validator` cannot serve here: it demands `() => Post` where a card carries a name.
-      if (!oneOfTokens(wire.relation.kind, RELATION_KINDS)) {
-        refuse(
-          `role.relation.kind is ${JSON.stringify(wire.relation.kind)}`,
-          `Expected one of ${RELATION_KINDS.join(', ')}.`,
-        );
-      }
-      if (wire.relation.onDelete !== undefined && !oneOfTokens(wire.relation.onDelete, ON_DELETE)) {
-        refuse(
-          `role.relation.onDelete is ${JSON.stringify(wire.relation.onDelete)}`,
-          `Expected one of ${ON_DELETE.join(', ')}.`,
-        );
-      }
-      const name = wire.relation.to;
-      rules.relation = {
-        to: () => (resolve?.(name) ?? ({ name } as unknown)) as EntityConstructor,
-        kind: wire.relation.kind as Relation['kind'],
-        ...(wire.relation.onDelete ? { onDelete: wire.relation.onDelete as Relation['onDelete'] } : {}),
-      } as RoleRules['relation'];
-    }
-    return rules;
-  },
-};
-
-/**
- * Judges a relation where `to` is a thunk; a card states a NAME, resolved by `toSchema` first.
- * FR : juge une relation dont `to` est une fonction ; une carte y met un NOM, résolu avant.
- * `{ to: User, kind: 'one' }` → `Expected a function returning the target entity, … () => Post`
- */
-function validateRelation(relation: unknown, errors: ValidationError[]): void {
-  if (!isObject(relation)) {
-    errors.push({ path: ['role', 'relation'], message: `Expected an object — got ${shown(relation)}` });
-    return;
-  }
-  if (!oneOfTokens(relation.kind, RELATION_KINDS)) {
-    errors.push({
-      path: ['role', 'relation', 'kind'],
-      message: `Expected 'one' or 'many' — got ${shown(relation.kind)}`,
-    });
-  }
-  if (typeof relation.to !== 'function') {
-    errors.push({ path: ['role', 'relation', 'to'], message: 'Expected a function returning the target entity, such as () => Post' });
-  }
-  if (relation.onDelete !== undefined && !oneOfTokens(relation.onDelete, ON_DELETE)) {
-    errors.push({
-      path: ['role', 'relation', 'onDelete'],
-      message: `Expected 'cascade', 'restrict' or 'set null' — got ${shown(relation.onDelete)}`,
-    });
-  }
-}
-
-type Mutable<T> = { -readonly [K in keyof T]: T[K] };

package/src/axis/role/RoleRules.ts

@@ -1,8 +0,0 @@
-import type { Relation } from './Relation.js';
-
-export interface RoleRules {
-  primary?: boolean;
-  index?: boolean;
-  unique?: boolean;
-  relation?: Relation;
-}

package/src/entity/CompositeUnique.ts

@@ -1,6 +0,0 @@
-import type { FieldName } from '../field/FieldName.js';
-import type { Fields } from '../field/Fields.js';
-
-// Ex: [['title', 'name'], ['id']]
-export type CompositeUnique<TFields extends Fields> =
-  readonly (readonly FieldName<TFields>[])[];

package/src/field/Meta.ts

@@ -1,3 +0,0 @@
-export interface Meta {
-  description?: string;
-}

package/src/projection/card/RelationDescriptor.ts

@@ -1,3 +0,0 @@
-import type { Relation } from '../../axis/role/Relation.js';
-
-export type RelationDescriptor = Pick<Relation, 'kind' | 'onDelete'> & { to: string };

package/src/validator/AdapterFieldValidator.ts

@@ -1,41 +0,0 @@
-import { Validator } from '@cfworker/json-schema';
-import type { Shape } from '../axis/shape/Shape.js';
-import { isObject } from '../lib/utils.js';
-import { SchemaError } from '../SchemaError.js';
-
-/**
- * The format is DATA, not a TypeScript interface: an interface is erased before a JS
- * caller, a config or a card from another language could be measured against it.
- */
-export class AdapterFieldValidator {
-  private constructor(private readonly validator: Validator) {}
-
-  /** Compiled once, at the adapter's own module load. */
-  static of(format: Shape): AdapterFieldValidator {
-    return new AdapterFieldValidator(new Validator(format as object, '2020-12', true));
-  }
-
-  /** `Post.adapters.sql.body.columnType: Property "postgre" does not match …` */
-  assert(entries: unknown, path: string): void {
-    if (entries === undefined) return;
-
-    if (!isObject(entries)) {
-      throw new SchemaError(
-        `${path}: expected an object keyed by field name, got ${typeof entries}.`,
-      );
-    }
-
-    for (const [field, entry] of Object.entries(entries)) {
-      const verdict = this.validator.validate(entry);
-      if (verdict.valid) continue;
-
-      // The engine reports outermost first and ends on `False boolean schema`, which names
-      // nothing. The last unit above that one is the one carrying the offending key.
-      const units = verdict.errors.filter((unit) => unit.keyword !== 'false');
-      const failure = units[units.length - 1] ?? verdict.errors[0];
-      const nested = (failure?.instanceLocation ?? '#').slice(1).replaceAll('/', '.');
-
-      throw new SchemaError(`${path}.${field}${nested}: ${failure?.error ?? 'does not match the format'}`);
-    }
-  }
-}