@fougere/schema 0.17.4-alpha.0 → 0.19.0-alpha.0

package/src/projection/card/Change.ts

@@ -1,7 +1,6 @@
-import type { BoundaryRef } from '../../axis/boundary/Boundary.js';
-import type { LifecycleRules } from '../../axis/lifecycle/Lifecycle.js';
+import type { FougereFieldAxes } from '../../FougereFieldAxes.js';
 import type { FieldDescriptor } from './FieldDescriptor.js';
-import type { RoleDescriptor } from './RoleDescriptor.js';
+import type { FieldExtension } from './FieldExtension.js';
 import type { TypeSet } from './TypeSet.js';
 
 /** One named difference, at one place. Each kind exists because a reader asks for it. */
@@ -19,6 +18,10 @@ export type Change =
   /** NOT NULL in either direction. Boot: an old writer cannot fill what it never knew. */
   | { kind: 'required'; field: string; from: boolean; to: boolean }
   /** An axis other than shape was restated. */
-  | { kind: 'restated'; field: string; axis: 'role'; from?: RoleDescriptor; to?: RoleDescriptor }
-  | { kind: 'restated'; field: string; axis: 'lifecycle'; from?: LifecycleRules; to?: LifecycleRules }
-  | { kind: 'restated'; field: string; axis: 'boundary'; from?: BoundaryRef; to?: BoundaryRef };
+  | { [Axis in keyof FougereFieldAxes]-?: {
+    kind: 'restated';
+    field: string;
+    axis: Axis;
+    from?: FieldExtension[Axis];
+    to?: FieldExtension[Axis];
+  } }[keyof FougereFieldAxes];

package/src/projection/card/Envelope.ts

@@ -0,0 +1,4 @@
+/** What every card document carries: the format it speaks, and who wrote it. */
+export const ENVELOPE = { 'x-fougere-version': 1, 'x-fougere-vendor': 'fougere' } as const;
+
+export type Envelope = typeof ENVELOPE;

package/src/projection/card/FieldDescriptor.ts

@@ -6,6 +6,5 @@ export type FieldDescriptor = ShapeKeywords & {
   type?: JSONSchema7TypeName | JSONSchema7TypeName[];
   items?: FieldDescriptor;
   properties?: Record<string, FieldDescriptor>;
-  description?: string;
   'x-fougere'?: FieldExtension;
 };

package/src/projection/card/FieldExtension.ts

@@ -1,12 +1,10 @@
-import type { BoundaryRef } from '../../axis/boundary/Boundary.js';
-import type { LifecycleRules } from '../../axis/lifecycle/Lifecycle.js';
+import type { FougereFieldAxes } from '../../FougereFieldAxes.js';
 import type { RoleDescriptor } from './RoleDescriptor.js';
 
-export interface FieldExtension {
-  role?: RoleDescriptor;
-  lifecycle?: LifecycleRules;
-  boundary?: BoundaryRef;
-
-  /** An axis registered from outside writes here, under its own name. */
-  [axis: string]: unknown;
-}
+/**
+ * What each axis writes on a card — its declaration as it stands, except `role`, whose target
+ * travels as a name. An axis registered from outside writes here too, under its own name.
+ */
+export type FieldExtension = {
+  [Axis in keyof FougereFieldAxes]?: Axis extends 'role' ? RoleDescriptor : FougereFieldAxes[Axis];
+} & { [axis: string]: unknown };

package/src/projection/card/RoleDescriptor.ts

@@ -1,4 +1,4 @@
-import type { EntityConstructor } from '../../axis/role/EntityConstructor.js';
+import type { Entity } from '../../entity/Entity.js';
 import type { Relation } from '../../axis/role/Relation.js';
 import type { RoleRules } from '../../axis/role/Role.js';
 import type { Resolver } from '../../axis/Resolver.js';
@@ -47,7 +47,7 @@ export const roleOnCard: CardForm<RoleRules, RoleDescriptor> = {
     if (wire.relation) {
       const name = wire.relation.to;
       rules.relation = {
-        to: () => (resolve?.(name) ?? ({ name } as unknown)) as EntityConstructor,
+        to: () => (resolve?.(name) ?? ({ name } as unknown)) as Entity,
         kind: wire.relation.kind,
         ...(wire.relation.onDelete ? { onDelete: wire.relation.onDelete } : {}),
       };

package/src/projection/card/SchemaBundle.ts

@@ -1,7 +1,6 @@
 import type { SchemaDescriptor } from './SchemaDescriptor.js';
+import type { Envelope } from './Envelope.js';
 
-export interface SchemaBundle {
+export interface SchemaBundle extends Envelope {
   $defs: Record<string, SchemaDescriptor>;
-  'x-fougere-version': 1;
-  'x-fougere-vendor': 'fougere';
 }

package/src/projection/card/SchemaDescriptor.ts

@@ -1,12 +1,11 @@
 import type { FieldDescriptor } from './FieldDescriptor.js';
 import type { DerivedFrom } from './DerivedFrom.js';
+import type { Envelope } from './Envelope.js';
 
-export interface SchemaDescriptor {
+export interface SchemaDescriptor extends Envelope {
   title?: string;
   type: 'object';
   properties: Record<string, FieldDescriptor>;
   required?: string[];
   'x-fougere-derived'?: DerivedFrom;
-  'x-fougere-version': 1;
-  'x-fougere-vendor': 'fougere';
 }

package/src/vocabulary/primitive/json.ts

@@ -1,12 +1,12 @@
 import { Field, type Shared } from '../../field/Field.js';
 import type { SchemaView } from '../../SchemaView.js';
+import type { Entity } from '../../entity/Entity.js';
 import { InputValidator } from '../../validator/InputValidator.js';
 import { SchemaError } from '../../SchemaError.js';
 
-type Entity = SchemaView & (new (...args: never[]) => unknown);
 
 export function json<T = unknown>(opts?: Shared<T>): Field<T>;
-export function json<E extends SchemaView & (new (...args: any[]) => any)>(
+export function json<E extends Entity>(
   of: E,
   opts?: Shared<InstanceType<E>>,
 ): Field<InstanceType<E>>;

package/src/vocabulary/primitive/many.ts

@@ -1,11 +1,11 @@
-import { type EntityConstructor } from '../../axis/role/EntityConstructor.js';
+import type { Entity } from '../../entity/Entity.js';
 import { Relation } from '../../axis/role/Relation.js';
 import { Field, type Described } from '../../field/Field.js';
 
 /**
  * `many(() => Post)` → `{ type: 'array' }` with `role.relation.kind` `'many'`
  */
-export function many<E extends EntityConstructor>(
+export function many<E extends Entity>(
   target: E | (() => E),
   opts?: Described,
 ): Field<InstanceType<E>[]> {

package/src/vocabulary/primitive/ref.ts

@@ -1,4 +1,4 @@
-import { type EntityConstructor } from '../../axis/role/EntityConstructor.js';
+import type { Entity } from '../../entity/Entity.js';
 import { Relation, type OnDelete } from '../../axis/role/Relation.js';
 import { Field, type Shared } from '../../field/Field.js';
 
@@ -6,7 +6,7 @@ export interface RefOptions extends Shared<string> {
   onDelete?: OnDelete;
 }
 
-export function ref<E extends EntityConstructor>(
+export function ref<E extends Entity>(
   target: E | (() => E),
   opts?: RefOptions,
 ): Field<string> {

package/dist/axis/role/EntityConstructor.d.ts

@@ -1,2 +0,0 @@
-export type EntityConstructor = abstract new (...args: any[]) => any;
-//# sourceMappingURL=EntityConstructor.d.ts.map

package/dist/axis/role/EntityConstructor.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"EntityConstructor.d.ts","sourceRoot":"","sources":["../../../src/axis/role/EntityConstructor.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,iBAAiB,GAAG,QAAQ,MAAM,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC"}

package/dist/axis/role/EntityConstructor.js

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

package/dist/axis/role/EntityConstructor.js.map

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

package/src/axis/role/EntityConstructor.ts

@@ -1 +0,0 @@
-export type EntityConstructor = abstract new (...args: any[]) => any;