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

package/src/vocabulary/primitive/oneOf.ts

@@ -1,32 +1,48 @@
-import { Field } from '../../field/Field.js';
+import { Field, type Shared } from '../../field/Field.js';
+import type { Shape } from '../../axis/shape/Shape.js';
+import { isArrayOf, isObject } from '../../lib/utils.js';
+import { SchemaError } from '../../SchemaError.js';
 
-interface OneOfOptions<V extends string = string> {
-  description?: string;
-  default?: V;
-}
+type Values = readonly [string, ...string[]] | readonly [number, ...number[]];
 
-export function oneOf<const T extends readonly string[]>(
-  ...values: [...T]
-): Field<T[number]>;
-export function oneOf<const T extends readonly string[]>(
-  ...args: [...T, OneOfOptions<T[number]>]
+export function oneOf<const T extends Values>(...values: [...T]): Field<T[number]>;
+
+export function oneOf<const T extends Values>(
+  ...args: [...T, Shared<T[number]>]
 ): Field<T[number]>;
+
 /**
- * The set travels: GraphQL enum, form `select` and DDL `CHECK`, from this one declaration.
- * FR : l'ensemble voyage : enum GraphQL, `select` du formulaire, `CHECK` du DDL.
  * `oneOf('draft', 'published', { default: 'draft' })` → `{ type: 'string', enum: [...] }`
  */
-export function oneOf<const T extends readonly string[]>(
-  ...args: [...T] | [...T, OneOfOptions<T[number]>]
+export function oneOf<const T extends Values>(
+  ...args: [...T] | [...T, Shared<T[number]>]
 ): Field<T[number]> {
-  const last = args[args.length - 1];
-  const hasOpts = typeof last === 'object' && last !== null && !Array.isArray(last);
-  const values = (hasOpts ? args.slice(0, -1) : args) as unknown as readonly string[];
-  const opts = hasOpts ? (last as OneOfOptions) : {};
-  return new Field<T[number]>({
-    shape: { type: 'string', enum: values },
-    lifecycle:
-      opts.default !== undefined ? { create: { value: opts.default } } : undefined,
-    meta: opts.description !== undefined ? { description: opts.description } : undefined,
-  });
+  const given: readonly unknown[] = args;
+  const last = given.at(-1);
+
+  const opts = isObject(last) ? last : undefined;
+  const values = opts ? given.slice(0, -1) : given;
+
+  let shape: Shape | undefined = undefined;
+
+  if (values.length === 0)
+    throw new SchemaError(
+      'oneOf() takes strings or numbers, then an optional object of options', { received: given },
+    );
+
+  if (isArrayOf(values, (value) => typeof value === 'string'))
+    shape = { type: 'string', enum: values };
+
+  if (isArrayOf(values, (value) => typeof value === 'number'))
+    shape = {
+      type: values.every(Number.isInteger) ? 'integer' : 'number',
+      enum: values,
+    };
+
+  if (shape === undefined)
+    throw new SchemaError(
+      'oneOf() takes strings or numbers, then an optional object of options', { received: given },
+    );
+
+  return new Field<T[number]>({ shape }).setShared(opts);
 }

package/src/vocabulary/primitive/primary.ts

@@ -1,7 +1,7 @@
-import { Field } from '../../field/Field.js';
+import { Field, type Described } from '../../field/Field.js';
 import { Generators, type GeneratorRef } from '../../axis/lifecycle/Generators.js';
 
-interface PrimaryOptions {
+interface PrimaryOptions extends Described {
   generate?: GeneratorRef | [name: string, fn: () => string];
 }
 
@@ -9,30 +9,34 @@ export function primary(opts?: PrimaryOptions): Field<string>;
 export function primary<T>(field: Field<T>): Field<T>;
 /**
  * `primary()` for a generated id; `primary(number())` to make a declared field the key.
- * FR : `primary()` pour un identifiant généré ; `primary(number())` pour promouvoir un champ.
  * `primary()` → `create: { generate: 'cuid2' }`, `update: 'forbidden'`
  */
 export function primary(fieldOrOptions?: Field | PrimaryOptions): Field {
   if (Field.is(fieldOrOptions)) {
     const field = fieldOrOptions;
+
     return field.with({
       role: { ...field.role, primary: true },
       lifecycle: { ...field.lifecycle, update: 'forbidden' },
     });
   }
 
-  const opts = (fieldOrOptions ?? {}) as PrimaryOptions;
+  const opts: PrimaryOptions = fieldOrOptions ?? {};
+
   let generate: GeneratorRef;
   if (Array.isArray(opts.generate)) {
     const [name, fn] = opts.generate;
+
     Generators.register(name, fn);
+
     generate = name;
   } else {
     generate = opts.generate ?? 'cuid2';
   }
+
   return new Field<string>({
     shape: { type: 'string' },
     role: { primary: true },
     lifecycle: { create: { generate }, update: 'forbidden' },
-  });
+  }).setShared(opts);
 }

package/src/vocabulary/primitive/ref.ts

@@ -1,12 +1,8 @@
 import { type EntityConstructor } from '../../axis/role/EntityConstructor.js';
 import { Relation, type OnDelete } from '../../axis/role/Relation.js';
-import { Field } from '../../field/Field.js';
+import { Field, type Shared } from '../../field/Field.js';
 
-export interface RefOptions {
-  /**
-   * What becomes of this row when the target's is deleted. `restrict` is the default because
-   * it is what a foreign key already does when nothing is stated.
-   */
+export interface RefOptions extends Shared<string> {
   onDelete?: OnDelete;
 }
 
@@ -17,5 +13,5 @@ export function ref<E extends EntityConstructor>(
   return new Field<string>({
     shape: { type: 'string' },
     role: { relation: Relation.one(target, opts?.onDelete) },
-  });
+  }).setShared(opts);
 }

package/src/vocabulary/primitive/text.ts

@@ -1,13 +1,11 @@
-import { Field } from '../../field/Field.js';
+import { Field, type Shared } from '../../field/Field.js';
 import { type StringFormat } from '../../axis/shape/StringFormat.js';
 
-export interface TextOptions {
+export interface TextOptions extends Shared<string> {
   min?: number;
   max?: number;
   pattern?: string;
   format?: StringFormat;
-  default?: string;
-  description?: string;
 }
 
 export function text(opts?: TextOptions): Field<string> {
@@ -19,8 +17,5 @@ export function text(opts?: TextOptions): Field<string> {
       pattern: opts?.pattern,
       format: opts?.format,
     },
-    lifecycle:
-      opts?.default !== undefined ? { create: { value: opts.default } } : undefined,
-    meta: opts?.description !== undefined ? { description: opts.description } : undefined,
-  });
+  }).setShared(opts);
 }

package/src/vocabulary/rule/nullable.ts

@@ -4,7 +4,6 @@ import { type Field } from '../../field/Field.js';
 
 /**
  * Adds `null` and leaves the field REQUIRED — `optional()` is the one permitting absence.
- * FR : ajoute `null` en laissant le champ OBLIGATOIRE — `optional()` permet l'absence.
  * `nullable(text())` → `{ type: ['string', 'null'] }`, and `validate({})` still refuses
  */
 export const nullable: <T>(field: Field<T>) => Field<T | null> = vocabulary(

package/src/vocabulary/rule/optional.ts

@@ -4,7 +4,6 @@ import { type Field } from '../../field/Field.js';
 
 /**
  * Adds `null` AND permits absence. A field that already states a `create` rule keeps it.
- * FR : ajoute `null` ET permet l'absence. Un champ qui énonce déjà un `create` le garde.
  * `optional(text())` → `{ type: ['string', 'null'] }` and `create: 'optional'`
  */
 export const optional: <T>(field: Field<T>) => Field<T | null> = vocabulary(

package/src/vocabulary/rule/readOnly.ts

@@ -3,8 +3,6 @@ import { Boundary } from '../../axis/boundary/Boundary.js';
 import { Field } from '../../field/Field.js';
 
 /**
- * Closes the way in, so the field leaves `Visibility.input` and every form derived from it.
- * FR : ferme l'entrée : le champ quitte `Visibility.input` et tout formulaire qui en dérive.
  * `readOnly(text())` → `boundary.in` is `'closed'`
  */
 export const readOnly: <T>(field: Field<T>) => Field<T> = vocabulary(

package/src/vocabulary/rule/writeOnly.ts

@@ -3,8 +3,6 @@ import { Boundary } from '../../axis/boundary/Boundary.js';
 import { Field } from '../../field/Field.js';
 
 /**
- * Closes the way out, the dual of `readOnly`: the value is written and never sent back.
- * FR : ferme la sortie, dual de `readOnly` : la valeur s'écrit et ne repart jamais.
  * `writeOnly(text())` → `boundary.out` is `'closed'`
  */
 export const writeOnly: <T>(field: Field<T>) => Field<T> = vocabulary(

package/src/vocabulary/vocabulary.ts

@@ -1,52 +1,48 @@
-import { Field } from '../field/Field.js';
+import { Field, type FieldDeclaration } from '../field/Field.js';
 import { Axes } from '../axis/Axes.js';
 import { dequal } from 'dequal';
 import { SchemaError } from '../SchemaError.js';
 
-const memberSlots = (): string[] => [...Axes.names, 'meta'];
-
 /**
- * Builds a `rule/` word, which states members on the field it receives.
- * FR : fabrique un mot de `rule/`, qui énonce des membres sur le champ reçu.
+ * Builds a `rule/` word
  * `vocabulary('indexed', () => ({ role: { index: true } }))`
  */
 export function vocabulary(
-  name: string,
+  word: string,
   states: (field: Field) => Partial<Field>,
 ): FieldWord {
-  return (field) => field.with(merge(name, field, states(field)));
+  return (field) => field.with(merge(word, field, states(field)));
 }
 
 export type FieldWord = (field: Field<any>) => Field<any>;
 
 /**
- * Refuses two words stating one member differently, rather than letting the outer win.
- * FR : refuse deux mots qui énoncent un même membre différemment.
- * `readOnly(writeOnly(text()))` → both apply; `immutable(created())` → throws
+ * Refuses two words stating one member DIFFERENTLY, rather than letting the outer win.
+ * `readOnly(writeOnly(text()))` → both apply, they write two members; `immutable(created())`
+ * too, since both say `update: 'forbidden'`; `immutable(updated())` → throws.
  */
-function merge(name: string, field: Field, given: Partial<Field>): Partial<Field> {
+function merge(word: string, field: Field, changes: Partial<FieldDeclaration>): Partial<Field> {
   const merged: Record<string, unknown> = {};
-  const stated = given as Record<string, unknown>;
-  const held = field as unknown as Record<string, unknown>;
-  if ('shape' in given) merged.shape = given.shape;
+  if ('shape' in changes) merged.shape = changes.shape;
 
-  for (const slot of memberSlots()) {
-    const members = stated[slot];
+  for (const name of Axes.names as (keyof FieldDeclaration)[]) {
+    const members = changes[name];
     if (members === undefined) continue;
-    const already = held[slot] as Record<string, unknown> | undefined;
-    if (typeof members !== 'object' || members === null || typeof already !== 'object') {
-      merged[slot] = members;
+    const already = field.axis(name);
+    if (typeof members !== 'object' || members === null || typeof already !== 'object' || already === null) {
+      merged[name] = members;
       continue;
     }
     for (const [member, value] of Object.entries(members)) {
-      const previous = already?.[member];
+      const previous = (already as Record<string, unknown>)[member];
       if (previous === undefined || dequal(previous, value)) continue;
       throw new SchemaError(
-        `vocabulary: \`${name}\` states ${slot}.${member} = ${JSON.stringify(value)}, but the ` +
+        `vocabulary: \`${word}\` states ${name}.${member} = ${JSON.stringify(value)}, but the ` +
           `field already states ${JSON.stringify(previous)}. Apply one or the other, not both.`,
       );
     }
-    merged[slot] = { ...already, ...members };
+    merged[name] = { ...already, ...members };
   }
+
   return merged as Partial<Field>;
 }

package/dist/entity/CompositeUnique.d.ts

@@ -1,4 +0,0 @@
-import type { FieldName } from '../field/FieldName.js';
-import type { Fields } from '../field/Fields.js';
-export type CompositeUnique<TFields extends Fields> = readonly (readonly FieldName<TFields>[])[];
-//# sourceMappingURL=CompositeUnique.d.ts.map

package/dist/entity/CompositeUnique.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"CompositeUnique.d.ts","sourceRoot":"","sources":["../../src/entity/CompositeUnique.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAGjD,MAAM,MAAM,eAAe,CAAC,OAAO,SAAS,MAAM,IAChD,SAAS,CAAC,SAAS,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC"}

package/dist/entity/CompositeUnique.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=CompositeUnique.js.map

package/dist/entity/CompositeUnique.js.map

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

package/dist/field/FougereFieldAxes.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"FougereFieldAxes.d.ts","sourceRoot":"","sources":["../../src/field/FougereFieldAxes.ts"],"names":[],"mappings":"AACA,MAAM,WAAW,gBAAgB;CAAG"}

package/dist/field/FougereFieldAxes.js.map

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

package/dist/field/Meta.d.ts

@@ -1,6 +0,0 @@
-import { Format, type Accepted } from '../lib/Format.js';
-export declare const META_FORMAT: Format<{
-    description?: string | undefined;
-}>;
-export type Meta = Accepted<typeof META_FORMAT>;
-//# sourceMappingURL=Meta.d.ts.map

package/dist/field/Meta.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Meta.d.ts","sourceRoot":"","sources":["../../src/field/Meta.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,KAAK,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAEzD,eAAO,MAAM,WAAW;;EAAmE,CAAC;AAE5F,MAAM,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,WAAW,CAAC,CAAC"}

package/dist/field/Meta.js

@@ -1,3 +0,0 @@
-import { Format } from '../lib/Format.js';
-export const META_FORMAT = Format.of('field/meta').key('description', Format.text).closed();
-//# sourceMappingURL=Meta.js.map

package/dist/field/Meta.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Meta.js","sourceRoot":"","sources":["../../src/field/Meta.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAiB,MAAM,kBAAkB,CAAC;AAEzD,MAAM,CAAC,MAAM,WAAW,GAAG,MAAM,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,aAAa,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC"}

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,5 +0,0 @@
-import { Format, type Accepted } from '../lib/Format.js';
-
-export const META_FORMAT = Format.of('field/meta').key('description', Format.text).closed();
-
-export type Meta = Accepted<typeof META_FORMAT>;