@vaadin/hilla-models 25.0.5 → 25.1.0-alpha10

package/ConstraintBuilder.d.ts

@@ -0,0 +1,11 @@
+import type { EmptyObject } from 'type-fest';
+import { type NonAttributedConstraint, $name, type AnyObject, Model, type Value } from './Model.js';
+export declare class ConstraintBuilder<V = unknown, const N extends string = string, A extends AnyObject = EmptyObject> {
+    #private;
+    protected [$name]: N | undefined;
+    constructor();
+    model<const M extends Model<V>>(supportedModel: M): ConstraintBuilder<Value<M>, N, A>;
+    name<const NN extends N>(name: NN): ConstraintBuilder<V, N & NN, A>;
+    attribute<AN extends string, AV>(name: AN, model: Model<AV>): ConstraintBuilder<V, N, (A extends EmptyObject ? AnyObject : A) & Readonly<undefined extends AV ? Partial<Record<AN, AV>> : Record<AN, AV>>>;
+    build(this: string extends N ? never : this): NonAttributedConstraint<V | undefined, N, A>;
+}

package/ConstraintBuilder.js

@@ -0,0 +1,49 @@
+import { $assertSupportedModel, $defaultValue, $name, Model, } from './Model.js';
+export class ConstraintBuilder {
+    #supportedModel;
+    [$name];
+    #attributeDefaults;
+    constructor() {
+        this.#supportedModel = Model;
+        this.#attributeDefaults = {};
+    }
+    model(supportedModel) {
+        this.#supportedModel = supportedModel;
+        return this;
+    }
+    name(name) {
+        this[$name] = name;
+        return this;
+    }
+    attribute(name, model) {
+        this.#attributeDefaults[name] = model[$defaultValue];
+        return this;
+    }
+    build() {
+        const name = this[$name];
+        const attributeDefaults = this.#attributeDefaults;
+        const supportedModel = this.#supportedModel;
+        function assertSupportedModel(model) {
+            if (!(model instanceof supportedModel)) {
+                throw new Error(`The constraint "${name}" is not applicable to the model "${model[$name]}".`);
+            }
+        }
+        let NonAttributedConstraint = ((valueOrAttributes) => {
+            const attributes = {
+                ...attributeDefaults,
+                ...(typeof valueOrAttributes === 'object' && valueOrAttributes !== null
+                    ? valueOrAttributes
+                    : { value: valueOrAttributes }),
+            };
+            return Object.defineProperties(Object.create(NonAttributedConstraint), {
+                attributes: { value: attributes },
+            });
+        });
+        NonAttributedConstraint = Object.defineProperties(NonAttributedConstraint, {
+            name: { value: name },
+            [$assertSupportedModel]: { value: assertSupportedModel },
+        });
+        return NonAttributedConstraint;
+    }
+}
+//# sourceMappingURL=ConstraintBuilder.js.map

package/ConstraintBuilder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConstraintBuilder.js","sourceRoot":"","sources":["src/ConstraintBuilder.ts"],"names":[],"mappings":"AACA,OAAO,EACL,qBAAqB,EAIrB,aAAa,EACb,KAAK,EAEL,KAAK,GAEN,MAAM,YAAY,CAAC;AAepB,MAAM,OAAO,iBAAiB;IAC5B,eAAe,CAAW;IAChB,CAAC,KAAK,CAAC,CAAgB;IACxB,kBAAkB,CAAc;IAEzC;QACE,IAAI,CAAC,eAAe,GAAG,KAA4B,CAAC;QACpD,IAAI,CAAC,kBAAkB,GAAG,EAA4B,CAAC;IACzD,CAAC;IAOD,KAAK,CAA2B,cAAiB;QAC/C,IAAI,CAAC,eAAe,GAAG,cAAc,CAAC;QACtC,OAAO,IAAW,CAAC;IACrB,CAAC;IAQD,IAAI,CAAqB,IAAQ;QAC/B,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;QACnB,OAAO,IAAW,CAAC;IACrB,CAAC;IASD,SAAS,CACP,IAAQ,EACR,KAAgB;QAMf,IAAI,CAAC,kBAA8C,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,aAAa,CAAC,CAAC;QAClF,OAAO,IAAW,CAAC;IACrB,CAAC;IAQD,KAAK;QACH,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QACzB,MAAM,iBAAiB,GAAG,IAAI,CAAC,kBAAkB,CAAC;QAClD,MAAM,cAAc,GAAG,IAAI,CAAC,eAAe,CAAC;QAE5C,SAAS,oBAAoB,CAAC,KAAe;YAC3C,IAAI,CAAC,CAAC,KAAK,YAAY,cAAc,CAAC,EAAE,CAAC;gBACvC,MAAM,IAAI,KAAK,CAAC,mBAAmB,IAAI,qCAAqC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAChG,CAAC;QACH,CAAC;QAED,IAAI,uBAAuB,GAAG,CAAC,CAAC,iBAA2B,EAAE,EAAE;YAC7D,MAAM,UAAU,GAAgB;gBAC9B,GAAG,iBAAiB;gBACpB,GAAG,CAAC,OAAO,iBAAiB,KAAK,QAAQ,IAAI,iBAAiB,KAAK,IAAI;oBACrE,CAAC,CAAC,iBAAiB;oBACnB,CAAC,CAAC,EAAE,KAAK,EAAE,iBAAiB,EAAE,CAAC;aAClC,CAAC;YAEF,OAAO,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,uBAAuB,CAAC,EAAE;gBACrE,UAAU,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE;aAClC,CAAoC,CAAC;QACxC,CAAC,CAA8C,CAAC;QAEhD,uBAAuB,GAAG,MAAM,CAAC,gBAAgB,CAAC,uBAAuB,EAAE;YACzE,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE;YACrB,CAAC,qBAAqB,CAAC,EAAE,EAAE,KAAK,EAAE,oBAAoB,EAAE;SACzD,CAAiD,CAAC;QAEnD,OAAO,uBAAuE,CAAC;IACjF,CAAC;CACF","sourcesContent":["import type { EmptyObject } from 'type-fest';\nimport {\n  $assertSupportedModel,\n  type Constraint,\n  type ConstraintFn,\n  type NonAttributedConstraint,\n  $defaultValue,\n  $name,\n  type AnyObject,\n  Model,\n  type Value,\n} from './Model.js';\n\n/**\n * A builder class for declaring constraints.\n * @internal low-level API for internal use only.\n *\n * @typeParam V - The value type of the constraint.\n * @typeParam N - The name of the constraint.\n * @typeParam A - The attributes for the constraint function, object with string\n * keys and arbitrary values. Attributes are required or optional settings for\n * a particular constraint, for example, the 'min' and 'max' settings for the\n * `Size({min, max})` constraint. When the `value` attribute is the only one,\n * the value can be given directly as the first argument of the constraint\n * function; otherwise the attribute object should be provided.\n */\nexport class ConstraintBuilder<V = unknown, const N extends string = string, A extends AnyObject = EmptyObject> {\n  #supportedModel: Model<V>;\n  protected [$name]: N | undefined;\n  readonly #attributeDefaults: Required<A>;\n\n  constructor() {\n    this.#supportedModel = Model as unknown as Model<V>;\n    this.#attributeDefaults = {} as unknown as Required<A>;\n  }\n\n  /**\n   * Sets the model that the constraint is applicable to.\n   *\n   * @param supportedModel - The model that the constraint is applicable to.\n   */\n  model<const M extends Model<V>>(supportedModel: M): ConstraintBuilder<Value<M>, N, A> {\n    this.#supportedModel = supportedModel;\n    return this as any;\n  }\n\n  /**\n   * Sets the name of the constraint.\n   *\n   * @param name - the name of the constraint.\n   * @returns The current builder instance updated with the new name.\n   */\n  name<const NN extends N>(name: NN): ConstraintBuilder<V, N & NN, A> {\n    this[$name] = name;\n    return this as any;\n  }\n\n  /**\n   * Defines a new attribute for the constraint.\n   *\n   * @param name - the name of the attribute.\n   * @param model - the model of the attribute value.\n   * @returns The current builder instance updated with the new attribute.\n   */\n  attribute<AN extends string, AV>(\n    name: AN,\n    model: Model<AV>,\n  ): ConstraintBuilder<\n    V,\n    N,\n    (A extends EmptyObject ? AnyObject : A) & Readonly<undefined extends AV ? Partial<Record<AN, AV>> : Record<AN, AV>>\n  > {\n    (this.#attributeDefaults as Record<string, unknown>)[name] = model[$defaultValue];\n    return this as any;\n  }\n\n  /**\n   * Builds the constraint declaration. On the typing level, it checks if all the\n   * constraint parts are set correctly and raises an error if not.\n   *\n   * @returns The constraint declaration.\n   */\n  build(this: string extends N ? never : this): NonAttributedConstraint<V | undefined, N, A> {\n    const name = this[$name];\n    const attributeDefaults = this.#attributeDefaults;\n    const supportedModel = this.#supportedModel;\n\n    function assertSupportedModel(model: Model<V>): void {\n      if (!(model instanceof supportedModel)) {\n        throw new Error(`The constraint \"${name}\" is not applicable to the model \"${model[$name]}\".`);\n      }\n    }\n\n    let NonAttributedConstraint = ((valueOrAttributes?: unknown) => {\n      const attributes: Required<A> = {\n        ...attributeDefaults,\n        ...(typeof valueOrAttributes === 'object' && valueOrAttributes !== null\n          ? valueOrAttributes\n          : { value: valueOrAttributes }),\n      };\n\n      return Object.defineProperties(Object.create(NonAttributedConstraint), {\n        attributes: { value: attributes },\n      }) as Constraint<V | undefined, N, A>;\n    }) as unknown as ConstraintFn<V | undefined, A>;\n\n    NonAttributedConstraint = Object.defineProperties(NonAttributedConstraint, {\n      name: { value: name },\n      [$assertSupportedModel]: { value: assertSupportedModel },\n    }) as NonAttributedConstraint<V | undefined, N, A>;\n\n    return NonAttributedConstraint as NonAttributedConstraint<V | undefined, N, A>;\n  }\n}\n"]}

package/Model.d.ts

@@ -0,0 +1,75 @@
+import type { EmptyObject } from 'type-fest';
+export interface JvmTypeRef {
+    jvmType: string;
+    genericArguments?: JvmTypeRef[];
+}
+export type AnnotationValue = AnnotationValue[] | JvmTypeRef | boolean | number | string | undefined;
+export interface Annotation {
+    jvmType: string;
+    attributes?: Record<string, AnnotationValue>;
+}
+export interface ModelMetadata {
+    jvmType?: string;
+    annotations?: Annotation[];
+}
+export type Target<T = unknown> = {
+    readonly model?: Model<T>;
+    readonly value: T;
+};
+export declare const nothing: unique symbol;
+export declare enum Enum {
+}
+export type AnyObject = Readonly<Record<never, never>>;
+export declare const $key: unique symbol;
+export declare const $name: unique symbol;
+export declare const $owner: unique symbol;
+export declare const $meta: unique symbol;
+export declare const $optional: unique symbol;
+export declare const $defaultValue: unique symbol;
+export declare const $constraints: unique symbol;
+export declare const $members: unique symbol;
+export type Value<M extends Model> = M extends Model<infer T> ? T : never;
+export type Extensions<M extends Model> = M extends Model<unknown, infer EX> ? EX : AnyObject;
+export declare const $assertSupportedModel: unique symbol;
+export type ConstraintFn<V = unknown, A extends AnyObject = AnyObject> = EmptyObject extends A ? (attributes?: A) => Constraint<V> : {
+    readonly value: never;
+} extends A ? (valueOrAttributes: (A & {
+    readonly value: unknown;
+})['value'] | A) => Constraint<V> : (attributes: A) => Constraint<V>;
+export type NonAttributedConstraint<V = unknown, N extends string = string, A extends AnyObject = AnyObject> = ConstraintFn<V, A> & Readonly<{
+    attributes: A;
+    name: N;
+    [$assertSupportedModel](model: Model<V>): void;
+}>;
+export type Constraint<V = unknown, N extends string = string, A extends AnyObject = AnyObject> = Readonly<{
+    attributes: EmptyObject extends A ? A : Required<A>;
+    name: N;
+    [$assertSupportedModel](model: Model<V>): void;
+}>;
+export type Model<V = unknown, EX extends AnyObject = AnyObject> = EX & {
+    readonly [$key]: keyof any;
+    readonly [$name]: string;
+    readonly [$owner]: Model | Target;
+    readonly [$meta]?: ModelMetadata;
+    readonly [$optional]: boolean;
+    readonly [$constraints]: readonly Constraint[];
+    readonly [$defaultValue]: V;
+    readonly [Symbol.toStringTag]: string;
+    [Symbol.hasInstance](value: any): value is Model<V, EX>;
+    toString(): string;
+};
+export type DefaultValueProvider<V, EX extends AnyObject = AnyObject> = (model: Model<V, EX>) => V;
+export declare const Model: Model;
+export declare const $sourceModel: unique symbol;
+export declare const $targetModel: unique symbol;
+export type ModelConverter<SM extends Model = Model, TM extends Model = Model> = {
+    readonly [$sourceModel]: SM;
+    readonly [$targetModel]: TM;
+};
+export type SourceModel<MC extends ModelConverter> = MC[typeof $sourceModel];
+export type TargetModel<MC extends ModelConverter, SM extends SourceModel<MC>> = (MC & {
+    readonly [$sourceModel]: SM;
+})[typeof $targetModel];
+export interface CompositeOf<A extends ModelConverter, B extends ModelConverter<Model, SourceModel<A>>> extends ModelConverter<SourceModel<B>> {
+    readonly [$targetModel]: TargetModel<A, TargetModel<B, SourceModel<this>>>;
+}

package/{model.js → Model.js}

@@ -10,16 +10,16 @@ export const $name = Symbol('name');
 export const $owner = Symbol('owner');
 export const $meta = Symbol('meta');
 export const $optional = Symbol('optional');
-export const $defaultValue = Symbol('value');
-export const $enum = Symbol('enumerate');
+export const $defaultValue = Symbol('defaultValue');
+export const $constraints = Symbol('constraints');
 export const $members = Symbol('members');
-export const $itemModel = Symbol('itemModel');
+export const $assertSupportedModel = Symbol('assertSupportedModel');
 export const Model = Object.create(null, {
     [$key]: {
         value: 'model',
     },
     [$name]: {
-        value: 'Model',
+        value: 'unknown',
     },
     [$owner]: {
         value: detachedTarget,
@@ -29,6 +29,9 @@ export const Model = Object.create(null, {
         value: false,
     },
     [$defaultValue]: {},
+    [$constraints]: {
+        value: [],
+    },
     [Symbol.toStringTag]: {
         get() {
             return this[$name];
@@ -45,4 +48,4 @@ export const Model = Object.create(null, {
         },
     },
 });
-//# sourceMappingURL=model.js.map
+//# sourceMappingURL=Model.js.map

package/Model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Model.js","sourceRoot":"","sources":["src/Model.ts"],"names":[],"mappings":"AA+BA,MAAM,CAAC,MAAM,OAAO,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;AAEzC,MAAM,cAAc,GAAW,MAAM,CAAC,MAAM,CAC1C;IACE,QAAQ,EAAE,GAAG,EAAE,CAAC,YAAY;CAC7B,EACD;IACE,KAAK,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE;IAC3B,KAAK,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE;CAC1B,CACF,CAAC;AAUF,MAAM,CAAC,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;AAKlC,MAAM,CAAC,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;AAKpC,MAAM,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;AAKtC,MAAM,CAAC,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;AAKpC,MAAM,CAAC,MAAM,SAAS,GAAkB,MAAM,CAAC,UAAU,CAAC,CAAC;AAK3D,MAAM,CAAC,MAAM,aAAa,GAAG,MAAM,CAAC,cAAc,CAAC,CAAC;AAKpD,MAAM,CAAC,MAAM,YAAY,GAAG,MAAM,CAAC,aAAa,CAAC,CAAC;AAKlD,MAAM,CAAC,MAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;AAiB1C,MAAM,CAAC,MAAM,qBAAqB,GAAG,MAAM,CAAC,sBAAsB,CAAC,CAAC;AA4GpE,MAAM,CAAC,MAAM,KAAK,GAAU,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE;IAC9C,CAAC,IAAI,CAAC,EAAE;QACN,KAAK,EAAE,OAAO;KACf;IACD,CAAC,KAAK,CAAC,EAAE;QACP,KAAK,EAAE,SAAS;KACjB;IACD,CAAC,MAAM,CAAC,EAAE;QACR,KAAK,EAAE,cAAc;KACtB;IACD,CAAC,KAAK,CAAC,EAAE,EAAE;IACX,CAAC,SAAS,CAAC,EAAE;QACX,KAAK,EAAE,KAAK;KACb;IACD,CAAC,aAAa,CAAC,EAAE,EAAE;IACnB,CAAC,YAAY,CAAC,EAAE;QACd,KAAK,EAAE,EAAE;KACV;IACD,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE;QACpB,GAAG;YACD,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC;QACrB,CAAC;KACF;IACD,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE;QACpB,KAAK,CAAc,CAAU;YAC3B,OAAO,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,CAAC,IAAI,MAAM,CAAC,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QAC5G,CAAC;KACF;IACD,QAAQ,EAAE;QACR,KAAK;YAEH,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACzG,CAAC;KACF;CACF,CAAC,CAAC","sourcesContent":["import type { EmptyObject } from 'type-fest';\n\nexport interface JvmTypeRef {\n  jvmType: string;\n  genericArguments?: JvmTypeRef[];\n}\n\nexport type AnnotationValue = AnnotationValue[] | JvmTypeRef | boolean | number | string | undefined;\n\nexport interface Annotation {\n  jvmType: string;\n  attributes?: Record<string, AnnotationValue>;\n}\n\n/**\n * The metadata of a model.\n */\nexport interface ModelMetadata {\n  jvmType?: string;\n  annotations?: Annotation[];\n}\n\n/**\n * The target to which a model is attached. It could be a Binder instance, a\n * Signal or another object. However, it could never be another model.\n */\nexport type Target<T = unknown> = {\n  readonly model?: Model<T>;\n  readonly value: T;\n};\n\nexport const nothing = Symbol('nothing');\n\nconst detachedTarget: Target = Object.create(\n  {\n    toString: () => ':detached:',\n  },\n  {\n    model: { value: undefined },\n    value: { value: nothing },\n  },\n);\n\nexport declare enum Enum {}\n\nexport type AnyObject = Readonly<Record<never, never>>; // {}\n\n/* eslint-disable tsdoc/syntax */\n/**\n * The symbol that represents the {@link Model[$key]} property.\n */\nexport const $key = Symbol('key');\n\n/**\n * The symbol that represents the {@link Model[$name]} property.\n */\nexport const $name = Symbol('name');\n\n/**\n * The symbol that represents the {@link Model[$owner]} property.\n */\nexport const $owner = Symbol('owner');\n\n/**\n * The symbol that represents the {@link Model[$meta]} property.\n */\nexport const $meta = Symbol('meta');\n\n/**\n * The symbol that represents the {@link Model[$optional]} property.\n */\nexport const $optional: unique symbol = Symbol('optional');\n\n/**\n * The symbol that represents the {@link Model[$defaultValue]} property.\n */\nexport const $defaultValue = Symbol('defaultValue');\n\n/**\n * The symbol that represents the constraints property of the {@link Model} type.\n */\nexport const $constraints = Symbol('constraints');\n\n/**\n * The symbol that represents the {@link UnionModel[$members]} property.\n */\nexport const $members = Symbol('members');\n\n/* eslint-enable tsdoc/syntax */\n\n/**\n * Extracts the value type the model represents.\n */\nexport type Value<M extends Model> = M extends Model<infer T> ? T : never;\n\n/**\n * Extracts the list of extra properties of the model.\n */\nexport type Extensions<M extends Model> = M extends Model<unknown, infer EX> ? EX : AnyObject;\n\n/**\n * The symbol that represents the {@link Constraint} method asserting supported model.\n */\nexport const $assertSupportedModel = Symbol('assertSupportedModel');\n\n/**\n * The constraint function type.\n */\nexport type ConstraintFn<V = unknown, A extends AnyObject = AnyObject> = EmptyObject extends A\n  ? (attributes?: A) => Constraint<V>\n  : { readonly value: never } extends A\n    ? (valueOrAttributes: (A & { readonly value: unknown })['value'] | A) => Constraint<V>\n    : (attributes: A) => Constraint<V>;\n\n/**\n * The constraint type that doesn't necessarily have attributes specified.\n *\n * @typeParam V - The type of the data described by the model.\n * @typeParam N - The name of the constraint.\n * @typeParam A - The attributes of the constraint.\n */\nexport type NonAttributedConstraint<\n  V = unknown,\n  N extends string = string,\n  A extends AnyObject = AnyObject,\n> = ConstraintFn<V, A> &\n  Readonly<{\n    attributes: A;\n    name: N;\n    [$assertSupportedModel](model: Model<V>): void;\n  }>;\n\n/**\n * The constraint type with specified attributes.\n *\n * @typeParam V - The type of the data described by the model.\n * @typeParam N - The name of the constraint.\n * @typeParam A - The attributes of the constraint.\n */\nexport type Constraint<V = unknown, N extends string = string, A extends AnyObject = AnyObject> = Readonly<{\n  attributes: EmptyObject extends A ? A : Required<A>;\n  name: N;\n  [$assertSupportedModel](model: Model<V>): void;\n}>;\n\n/**\n * A model that represents a specific type of data.\n *\n * @typeParam V - The type of the data described by the model.\n * @typeParam EX - The extra properties of the model. It could be either a model\n * that represents a property of the object the current model describe, or a\n * model-specific metadata. It's recommended to use a symbol as a key for the\n * metadata property to avoid the potential naming conflicts with the described\n * object properties.\n *\n * @remarks\n * Since we know the full model definition only on this step, the `R` type\n * parameter is essential to describe a model with self-reference properties.\n */\nexport type Model<V = unknown, EX extends AnyObject = AnyObject> = EX & {\n  /**\n   * The key of the model in the owner model.\n   */\n  readonly [$key]: keyof any;\n\n  /**\n   * The name of the model. For attached models, the name will be prefixed\n   * with the `@` symbol.\n   */\n  readonly [$name]: string;\n\n  /**\n   * The owner model of the model. For detached models, the owner will always\n   * be a specific global object `detachedTarget`.\n   */\n  readonly [$owner]: Model | Target;\n\n  /**\n   * The metadata of the model.\n   */\n  readonly [$meta]?: ModelMetadata;\n\n  /**\n   * Whether the model is optional. It describes if the data described by\n   * this model is nullable.\n   */\n  readonly [$optional]: boolean;\n\n  /**\n   * The list of validation constraints for the model.\n   */\n  readonly [$constraints]: readonly Constraint[];\n\n  /**\n   * The default value of the model.\n   */\n  readonly [$defaultValue]: V;\n  readonly [Symbol.toStringTag]: string;\n  [Symbol.hasInstance](value: any): value is Model<V, EX>;\n  toString(): string;\n};\n\n/**\n * A function that provides a default value for a model.\n *\n * @typeParam V - The type of the data described by the model.\n * @typeParam EX - The extra properties of the model.\n * @typeParam R - The keys of the self-referencing properties of the model.\n */\nexport type DefaultValueProvider<V, EX extends AnyObject = AnyObject> = (model: Model<V, EX>) => V;\n\nexport const Model: Model = Object.create(null, {\n  [$key]: {\n    value: 'model',\n  },\n  [$name]: {\n    value: 'unknown',\n  },\n  [$owner]: {\n    value: detachedTarget,\n  },\n  [$meta]: {},\n  [$optional]: {\n    value: false,\n  },\n  [$defaultValue]: {},\n  [$constraints]: {\n    value: [],\n  },\n  [Symbol.toStringTag]: {\n    get(this: Model) {\n      return this[$name];\n    },\n  },\n  [Symbol.hasInstance]: {\n    value(this: Model, o: unknown) {\n      return typeof o === 'object' && o != null && (this === o || Object.prototype.isPrototypeOf.call(this, o));\n    },\n  },\n  toString: {\n    value(this: Model) {\n      // eslint-disable-next-line @typescript-eslint/no-base-to-string\n      return `[${String(this[$owner])} / ${String(this[$key])}${this[$optional] ? '?' : ''}] ${this[$name]}`;\n    },\n  },\n});\n\n// The following symbols are used to define HKT signatures for model converter\n// functions, enabling type inference for functional composition for them.\n// Inspired by: https://stackoverflow.com/a/69247453\n\n/**\n * The symbol marking source (parameter) type for model converter HKT\n * signatures.\n */\nexport declare const $sourceModel: unique symbol;\n\n/**\n * The symbol marking target (return) type for model converter HKT\n * signatures.\n */\nexport declare const $targetModel: unique symbol;\n\n/**\n * Base HKT signature for model converter functions. Corresponds to a function\n * such as.\n */\nexport type ModelConverter<SM extends Model = Model, TM extends Model = Model> = {\n  readonly [$sourceModel]: SM;\n  readonly [$targetModel]: TM;\n};\n\n/**\n * Gets the source type of the given model converter HKT signature.\n */\nexport type SourceModel<MC extends ModelConverter> = MC[typeof $sourceModel];\n\n/**\n * Gets the target type of the given model converter HKT signature for the given\n * source type.\n */\nexport type TargetModel<MC extends ModelConverter, SM extends SourceModel<MC>> = (MC & {\n  readonly [$sourceModel]: SM;\n})[typeof $targetModel];\n\n/**\n * Makes functional composition of two given model converter HKT signatures,\n * given A(x) and B(x) returns A(B(x)) HKT signature.\n */\nexport interface CompositeOf<A extends ModelConverter, B extends ModelConverter<Model, SourceModel<A>>>\n  extends ModelConverter<SourceModel<B>> {\n  readonly [$targetModel]: TargetModel<A, TargetModel<B, SourceModel<this>>>;\n}\n"]}

package/constraints.d.ts

@@ -0,0 +1,22 @@
+export declare const Null: import("./Model.js").NonAttributedConstraint<unknown, "Null", Readonly<Record<never, never>> & Readonly<Partial<Record<"message", string | undefined>>>>;
+export declare const NotNull: import("./Model.js").NonAttributedConstraint<unknown, "NotNull", Readonly<Record<never, never>> & Readonly<Partial<Record<"message", string | undefined>>>>;
+export declare const AssertTrue: import("./Model.js").NonAttributedConstraint<boolean | undefined, "AssertTrue", Readonly<Record<never, never>> & Readonly<Partial<Record<"message", string | undefined>>>>;
+export declare const AssertFalse: import("./Model.js").NonAttributedConstraint<boolean | undefined, "AssertFalse", Readonly<Record<never, never>> & Readonly<Partial<Record<"message", string | undefined>>>>;
+export declare const Min: import("./Model.js").NonAttributedConstraint<number | undefined, "Min", Readonly<Record<never, never>> & Readonly<Partial<Record<"message", string | undefined>>> & Readonly<Record<"value", number>>>;
+export declare const Max: import("./Model.js").NonAttributedConstraint<number | undefined, "Max", Readonly<Record<never, never>> & Readonly<Partial<Record<"message", string | undefined>>> & Readonly<Record<"value", number>>>;
+export declare const DecimalMin: import("./Model.js").NonAttributedConstraint<string | number | undefined, "DecimalMin", Readonly<Record<never, never>> & Readonly<Record<"value", number>>>;
+export declare const DecimalMax: import("./Model.js").NonAttributedConstraint<string | number | undefined, "DecimalMax", import("type-fest").EmptyObject>;
+export declare const Negative: import("./Model.js").NonAttributedConstraint<number | undefined, "Negative", Readonly<Record<never, never>> & Readonly<Partial<Record<"message", string | undefined>>>>;
+export declare const NegativeOrZero: import("./Model.js").NonAttributedConstraint<number | undefined, "NegativeOrZero", Readonly<Record<never, never>> & Readonly<Partial<Record<"message", string | undefined>>>>;
+export declare const Positive: import("./Model.js").NonAttributedConstraint<number | undefined, "Positive", Readonly<Record<never, never>> & Readonly<Partial<Record<"message", string | undefined>>>>;
+export declare const PositiveOrZero: import("./Model.js").NonAttributedConstraint<number | undefined, "PositiveOrZero", Readonly<Record<never, never>> & Readonly<Partial<Record<"message", string | undefined>>>>;
+export declare const Size: import("./Model.js").NonAttributedConstraint<string | unknown[] | undefined, "Size", Readonly<Record<never, never>> & Readonly<Partial<Record<"min", number | undefined>>> & Readonly<Partial<Record<"max", number | undefined>>>>;
+export declare const Digits: import("./Model.js").NonAttributedConstraint<string | number | undefined, "Digits", Readonly<Record<never, never>> & Readonly<Record<"integer", number>> & Readonly<Record<"fraction", number>>>;
+export declare const Past: import("./Model.js").NonAttributedConstraint<string | undefined, "Past", import("type-fest").EmptyObject>;
+export declare const PastOrPresent: import("./Model.js").NonAttributedConstraint<string | undefined, "PastOrPresent", import("type-fest").EmptyObject>;
+export declare const Future: import("./Model.js").NonAttributedConstraint<string | undefined, "Future", import("type-fest").EmptyObject>;
+export declare const FutureOrPresent: import("./Model.js").NonAttributedConstraint<string | undefined, "FutureOrPresent", import("type-fest").EmptyObject>;
+export declare const Pattern: import("./Model.js").NonAttributedConstraint<string | undefined, "Pattern", Readonly<Record<never, never>> & Readonly<Record<"regexp", string>>>;
+export declare const NotEmpty: import("./Model.js").NonAttributedConstraint<string | Record<string, unknown> | unknown[] | undefined, "NotEmpty", import("type-fest").EmptyObject>;
+export declare const NotBlank: import("./Model.js").NonAttributedConstraint<string | undefined, "NotBlank", import("type-fest").EmptyObject>;
+export declare const Email: import("./Model.js").NonAttributedConstraint<string | undefined, "Email", import("type-fest").EmptyObject>;

package/constraints.js

@@ -0,0 +1,90 @@
+import { ConstraintBuilder } from './ConstraintBuilder.js';
+import * as m from './m.js';
+import { Model } from './Model.js';
+import { ArrayModel, BooleanModel, NumberModel, RecordModel, StringModel } from './models.js';
+export const Null = new ConstraintBuilder()
+    .model(Model)
+    .attribute('message', m.optional(StringModel))
+    .name('Null')
+    .build();
+export const NotNull = new ConstraintBuilder()
+    .model(Model)
+    .attribute('message', m.optional(StringModel))
+    .name('NotNull')
+    .build();
+export const AssertTrue = new ConstraintBuilder()
+    .model(BooleanModel)
+    .attribute('message', m.optional(StringModel))
+    .name('AssertTrue')
+    .build();
+export const AssertFalse = new ConstraintBuilder()
+    .model(BooleanModel)
+    .attribute('message', m.optional(StringModel))
+    .name('AssertFalse')
+    .build();
+export const Min = new ConstraintBuilder()
+    .model(NumberModel)
+    .attribute('message', m.optional(StringModel))
+    .name('Min')
+    .attribute('value', NumberModel)
+    .build();
+export const Max = new ConstraintBuilder()
+    .model(NumberModel)
+    .attribute('message', m.optional(StringModel))
+    .name('Max')
+    .attribute('value', NumberModel)
+    .build();
+export const DecimalMin = new ConstraintBuilder()
+    .model(m.union(NumberModel, StringModel))
+    .name('DecimalMin')
+    .attribute('value', NumberModel)
+    .build();
+export const DecimalMax = new ConstraintBuilder().model(m.union(NumberModel, StringModel)).name('DecimalMax').build();
+export const Negative = new ConstraintBuilder()
+    .model(NumberModel)
+    .attribute('message', m.optional(StringModel))
+    .name('Negative')
+    .build();
+export const NegativeOrZero = new ConstraintBuilder()
+    .model(NumberModel)
+    .attribute('message', m.optional(StringModel))
+    .name('NegativeOrZero')
+    .build();
+export const Positive = new ConstraintBuilder()
+    .model(NumberModel)
+    .attribute('message', m.optional(StringModel))
+    .name('Positive')
+    .build();
+export const PositiveOrZero = new ConstraintBuilder()
+    .model(NumberModel)
+    .attribute('message', m.optional(StringModel))
+    .name('PositiveOrZero')
+    .build();
+export const Size = new ConstraintBuilder()
+    .model(m.union(StringModel, ArrayModel))
+    .name('Size')
+    .attribute('min', m.optional(m.withDefaultValue(NumberModel, 0)))
+    .attribute('max', m.optional(m.withDefaultValue(NumberModel, Number.MAX_SAFE_INTEGER)))
+    .build();
+export const Digits = new ConstraintBuilder()
+    .model(m.union(StringModel, NumberModel))
+    .name('Digits')
+    .attribute('integer', NumberModel)
+    .attribute('fraction', NumberModel)
+    .build();
+export const Past = new ConstraintBuilder().model(StringModel).name('Past').build();
+export const PastOrPresent = new ConstraintBuilder().model(StringModel).name('PastOrPresent').build();
+export const Future = new ConstraintBuilder().model(StringModel).name('Future').build();
+export const FutureOrPresent = new ConstraintBuilder().model(StringModel).name('FutureOrPresent').build();
+export const Pattern = new ConstraintBuilder()
+    .model(StringModel)
+    .name('Pattern')
+    .attribute('regexp', StringModel)
+    .build();
+export const NotEmpty = new ConstraintBuilder()
+    .model(m.union(StringModel, ArrayModel, RecordModel))
+    .name('NotEmpty')
+    .build();
+export const NotBlank = new ConstraintBuilder().model(StringModel).name('NotBlank').build();
+export const Email = new ConstraintBuilder().model(StringModel).name('Email').build();
+//# sourceMappingURL=constraints.js.map

package/constraints.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constraints.js","sourceRoot":"","sources":["src/constraints.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAK9F,MAAM,CAAC,MAAM,IAAI,GAAG,IAAI,iBAAiB,EAAE;KACxC,KAAK,CAAC,KAAK,CAAC;KACZ,SAAS,CAAC,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;KAC7C,IAAI,CAAC,MAAM,CAAC;KACZ,KAAK,EAAE,CAAC;AAKX,MAAM,CAAC,MAAM,OAAO,GAAG,IAAI,iBAAiB,EAAE;KAC3C,KAAK,CAAC,KAAK,CAAC;KACZ,SAAS,CAAC,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;KAC7C,IAAI,CAAC,SAAS,CAAC;KACf,KAAK,EAAE,CAAC;AAOX,MAAM,CAAC,MAAM,UAAU,GAAG,IAAI,iBAAiB,EAAE;KAC9C,KAAK,CAAC,YAAY,CAAC;KACnB,SAAS,CAAC,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;KAC7C,IAAI,CAAC,YAAY,CAAC;KAClB,KAAK,EAAE,CAAC;AAOX,MAAM,CAAC,MAAM,WAAW,GAAG,IAAI,iBAAiB,EAAE;KAC/C,KAAK,CAAC,YAAY,CAAC;KACnB,SAAS,CAAC,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;KAC7C,IAAI,CAAC,aAAa,CAAC;KACnB,KAAK,EAAE,CAAC;AAOX,MAAM,CAAC,MAAM,GAAG,GAAG,IAAI,iBAAiB,EAAE;KACvC,KAAK,CAAC,WAAW,CAAC;KAClB,SAAS,CAAC,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;KAC7C,IAAI,CAAC,KAAK,CAAC;KACX,SAAS,CAAC,OAAO,EAAE,WAAW,CAAC;KAC/B,KAAK,EAAE,CAAC;AAOX,MAAM,CAAC,MAAM,GAAG,GAAG,IAAI,iBAAiB,EAAE;KACvC,KAAK,CAAC,WAAW,CAAC;KAClB,SAAS,CAAC,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;KAC7C,IAAI,CAAC,KAAK,CAAC;KACX,SAAS,CAAC,OAAO,EAAE,WAAW,CAAC;KAC/B,KAAK,EAAE,CAAC;AAOX,MAAM,CAAC,MAAM,UAAU,GAAG,IAAI,iBAAiB,EAAE;KAC9C,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;KACxC,IAAI,CAAC,YAAY,CAAC;KAClB,SAAS,CAAC,OAAO,EAAE,WAAW,CAAC;KAC/B,KAAK,EAAE,CAAC;AAOX,MAAM,CAAC,MAAM,UAAU,GAAG,IAAI,iBAAiB,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,KAAK,EAAE,CAAC;AAOtH,MAAM,CAAC,MAAM,QAAQ,GAAG,IAAI,iBAAiB,EAAE;KAC5C,KAAK,CAAC,WAAW,CAAC;KAClB,SAAS,CAAC,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;KAC7C,IAAI,CAAC,UAAU,CAAC;KAChB,KAAK,EAAE,CAAC;AAOX,MAAM,CAAC,MAAM,cAAc,GAAG,IAAI,iBAAiB,EAAE;KAClD,KAAK,CAAC,WAAW,CAAC;KAClB,SAAS,CAAC,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;KAC7C,IAAI,CAAC,gBAAgB,CAAC;KACtB,KAAK,EAAE,CAAC;AAOX,MAAM,CAAC,MAAM,QAAQ,GAAG,IAAI,iBAAiB,EAAE;KAC5C,KAAK,CAAC,WAAW,CAAC;KAClB,SAAS,CAAC,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;KAC7C,IAAI,CAAC,UAAU,CAAC;KAChB,KAAK,EAAE,CAAC;AAOX,MAAM,CAAC,MAAM,cAAc,GAAG,IAAI,iBAAiB,EAAE;KAClD,KAAK,CAAC,WAAW,CAAC;KAClB,SAAS,CAAC,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;KAC7C,IAAI,CAAC,gBAAgB,CAAC;KACtB,KAAK,EAAE,CAAC;AAOX,MAAM,CAAC,MAAM,IAAI,GAAG,IAAI,iBAAiB,EAAE;KACxC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;KACvC,IAAI,CAAC,MAAM,CAAC;KACZ,SAAS,CAAC,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,gBAAgB,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC;KAChE,SAAS,CAAC,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,gBAAgB,CAAC,WAAW,EAAE,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC;KACtF,KAAK,EAAE,CAAC;AAOX,MAAM,CAAC,MAAM,MAAM,GAAG,IAAI,iBAAiB,EAAE;KAC1C,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;KACxC,IAAI,CAAC,QAAQ,CAAC;KACd,SAAS,CAAC,SAAS,EAAE,WAAW,CAAC;KACjC,SAAS,CAAC,UAAU,EAAE,WAAW,CAAC;KAClC,KAAK,EAAE,CAAC;AAOX,MAAM,CAAC,MAAM,IAAI,GAAG,IAAI,iBAAiB,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,CAAC;AAOpF,MAAM,CAAC,MAAM,aAAa,GAAG,IAAI,iBAAiB,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,KAAK,EAAE,CAAC;AAOtG,MAAM,CAAC,MAAM,MAAM,GAAG,IAAI,iBAAiB,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,CAAC;AAOxF,MAAM,CAAC,MAAM,eAAe,GAAG,IAAI,iBAAiB,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,KAAK,EAAE,CAAC;AAO1G,MAAM,CAAC,MAAM,OAAO,GAAG,IAAI,iBAAiB,EAAE;KAC3C,KAAK,CAAC,WAAW,CAAC;KAClB,IAAI,CAAC,SAAS,CAAC;KACf,SAAS,CAAC,QAAQ,EAAE,WAAW,CAAC;KAChC,KAAK,EAAE,CAAC;AAOX,MAAM,CAAC,MAAM,QAAQ,GAAG,IAAI,iBAAiB,EAAE;KAC5C,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC;KACpD,IAAI,CAAC,UAAU,CAAC;KAChB,KAAK,EAAE,CAAC;AAOX,MAAM,CAAC,MAAM,QAAQ,GAAG,IAAI,iBAAiB,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,KAAK,EAAE,CAAC;AAO5F,MAAM,CAAC,MAAM,KAAK,GAAG,IAAI,iBAAiB,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC","sourcesContent":["import { ConstraintBuilder } from './ConstraintBuilder.js';\nimport * as m from './m.js';\nimport { Model } from './Model.js';\nimport { ArrayModel, BooleanModel, NumberModel, RecordModel, StringModel } from './models.js';\n\n/**\n * The constrained model value must be `undefined`.\n */\nexport const Null = new ConstraintBuilder()\n  .model(Model)\n  .attribute('message', m.optional(StringModel))\n  .name('Null')\n  .build();\n\n/**\n * The constrained model value must not be `undefined`.\n */\nexport const NotNull = new ConstraintBuilder()\n  .model(Model)\n  .attribute('message', m.optional(StringModel))\n  .name('NotNull')\n  .build();\n\n/**\n * The constrained model value must be `true`.\n *\n * `undefined` value is considered valid.\n */\nexport const AssertTrue = new ConstraintBuilder()\n  .model(BooleanModel)\n  .attribute('message', m.optional(StringModel))\n  .name('AssertTrue')\n  .build();\n\n/**\n * The constrained model value must be `false`.\n *\n * `undefined` value is considered valid.\n */\nexport const AssertFalse = new ConstraintBuilder()\n  .model(BooleanModel)\n  .attribute('message', m.optional(StringModel))\n  .name('AssertFalse')\n  .build();\n\n/**\n * The constrained model value must be higher than or equal to the specified value.\n *\n * `undefined` value is considered valid.\n */\nexport const Min = new ConstraintBuilder()\n  .model(NumberModel)\n  .attribute('message', m.optional(StringModel))\n  .name('Min')\n  .attribute('value', NumberModel)\n  .build();\n\n/**\n * The constrained model value must be lower than or equal to the specified value.\n *\n * `undefined` value is considered valid.\n */\nexport const Max = new ConstraintBuilder()\n  .model(NumberModel)\n  .attribute('message', m.optional(StringModel))\n  .name('Max')\n  .attribute('value', NumberModel)\n  .build();\n\n/**\n * The constrained model value must be a number that is greater than or equal to the specified value.\n *\n * `undefined` value is considered valid.\n */\nexport const DecimalMin = new ConstraintBuilder()\n  .model(m.union(NumberModel, StringModel))\n  .name('DecimalMin')\n  .attribute('value', NumberModel)\n  .build();\n\n/**\n * The constrained model value must be a number that is lower than or equal to the specified value.\n *\n * `undefined` value is considered valid.\n */\nexport const DecimalMax = new ConstraintBuilder().model(m.union(NumberModel, StringModel)).name('DecimalMax').build();\n\n/**\n * The constrained model value must be strictly below zero.\n *\n * `undefined` value is considered valid.\n */\nexport const Negative = new ConstraintBuilder()\n  .model(NumberModel)\n  .attribute('message', m.optional(StringModel))\n  .name('Negative')\n  .build();\n\n/**\n * The constrained model value must be below zero or equal to zero.\n *\n * `undefined` value is considered valid.\n */\nexport const NegativeOrZero = new ConstraintBuilder()\n  .model(NumberModel)\n  .attribute('message', m.optional(StringModel))\n  .name('NegativeOrZero')\n  .build();\n\n/**\n * The constrained model value must be strictly above zero.\n *\n * `undefined` value is considered valid.\n */\nexport const Positive = new ConstraintBuilder()\n  .model(NumberModel)\n  .attribute('message', m.optional(StringModel))\n  .name('Positive')\n  .build();\n\n/**\n * The constrained model value must be above zero or equal to zero.\n *\n * `undefined` value is considered valid.\n */\nexport const PositiveOrZero = new ConstraintBuilder()\n  .model(NumberModel)\n  .attribute('message', m.optional(StringModel))\n  .name('PositiveOrZero')\n  .build();\n\n/**\n * The length of the constrained value must be between the specified boundaries.\n *\n * `undefined` value is considered valid.\n */\nexport const Size = new ConstraintBuilder()\n  .model(m.union(StringModel, ArrayModel))\n  .name('Size')\n  .attribute('min', m.optional(m.withDefaultValue(NumberModel, 0)))\n  .attribute('max', m.optional(m.withDefaultValue(NumberModel, Number.MAX_SAFE_INTEGER)))\n  .build();\n\n/**\n * The constrained value must be a number within the specified range.\n *\n * `undefined` value is considered valid.\n */\nexport const Digits = new ConstraintBuilder()\n  .model(m.union(StringModel, NumberModel))\n  .name('Digits')\n  .attribute('integer', NumberModel)\n  .attribute('fraction', NumberModel)\n  .build();\n\n/**\n * The constrained value must be a date, time, or timestamp in the past.\n *\n * `undefined` value is considered valid.\n */\nexport const Past = new ConstraintBuilder().model(StringModel).name('Past').build();\n\n/**\n * The constrained value must be a date, time, or timestamp in the past or present.\n *\n * `undefined` value is considered valid.\n */\nexport const PastOrPresent = new ConstraintBuilder().model(StringModel).name('PastOrPresent').build();\n\n/**\n * The constrained value must be a date, time, or timestamp in the future.\n *\n * `undefined` value is considered valid.\n */\nexport const Future = new ConstraintBuilder().model(StringModel).name('Future').build();\n\n/**\n * The constrained value must be a date, time, or timestamp in the future or present.\n *\n * `undefined` value is considered valid.\n */\nexport const FutureOrPresent = new ConstraintBuilder().model(StringModel).name('FutureOrPresent').build();\n\n/**\n * The constrained value must match the specified regular expression.\n *\n * `undefined` value is considered valid.\n */\nexport const Pattern = new ConstraintBuilder()\n  .model(StringModel)\n  .name('Pattern')\n  .attribute('regexp', StringModel)\n  .build();\n\n/**\n * The constrained value must not be an `undefined` or empty.\n *\n * `undefined` value is considered valid.\n */\nexport const NotEmpty = new ConstraintBuilder()\n  .model(m.union(StringModel, ArrayModel, RecordModel))\n  .name('NotEmpty')\n  .build();\n\n/**\n * The constrained value must not be an `undefined` and must contain at least one non-whitespace character.\n *\n * `undefined` value is considered valid.\n */\nexport const NotBlank = new ConstraintBuilder().model(StringModel).name('NotBlank').build();\n\n/**\n * The constrained value must be a valid email address.\n *\n * `undefined` value is considered valid.\n */\nexport const Email = new ConstraintBuilder().model(StringModel).name('Email').build();\n"]}

package/converters.d.ts

@@ -0,0 +1,33 @@
+import { $assertSupportedModel, type $targetModel, type Constraint, type CompositeOf, type SourceModel, type TargetModel, type Model, type ModelConverter, type ModelMetadata, type Value } from './Model.js';
+import { ArrayModel, type OptionalModel } from './models.js';
+export type ModelConverterFn<SM extends Model = Model, TM extends Model = Model> = (model: SM, ...extraArgs: readonly any[]) => TM;
+export type ModelConverterCallable<MC extends ModelConverter, F extends ModelConverterFn<SourceModel<MC>, TargetModel<MC, SourceModel<MC>>>> = F extends (model: Model, ...extraArgs: infer E) => Model ? <const IMC extends ModelConverter>(modelConverter: IMC, ...extraArgs: E) => CompositeOf<MC, IMC> : never;
+export interface IdentityOf extends ModelConverter {
+    readonly [$targetModel]: SourceModel<this>;
+}
+declare function selfImpl<const M extends Model>(model: M): M;
+export type ModelSelf = IdentityOf & typeof selfImpl;
+declare const _self: ModelSelf;
+export { _self as self };
+export interface OptionalOf extends ModelConverter {
+    readonly [$targetModel]: OptionalModel<SourceModel<this>>;
+}
+declare function optionalImpl<const M extends Model>(model: M): OptionalModel<M>;
+export declare const optional: OptionalOf & typeof optionalImpl & (<const IMC extends ModelConverter>(modelConverter: IMC) => CompositeOf<OptionalOf, IMC>);
+export interface ArrayOf extends ModelConverter {
+    readonly [$targetModel]: ArrayModel<SourceModel<this>>;
+}
+declare function arrayImpl<const M extends Model>(model: M): ArrayModel<M>;
+export declare const array: ArrayOf & typeof arrayImpl & (<const IMC extends ModelConverter>(modelConverter: IMC) => CompositeOf<ArrayOf, IMC>);
+declare function constrainedImpl<const M extends Model>(this: void, model: M, constraint: Constraint<Value<M>>, ...moreConstraints: ReadonlyArray<Constraint<Value<M>>>): M;
+export declare const constrained: IdentityOf & typeof constrainedImpl & (<const IMC extends ModelConverter>(modelConverter: IMC, constraint: Readonly<{
+    attributes: Readonly<Record<never, never>>;
+    name: string;
+    [$assertSupportedModel](model: Model<unknown, Readonly<Record<never, never>>>): void;
+}>, ...moreConstraints: Readonly<{
+    attributes: Readonly<Record<never, never>>;
+    name: string;
+    [$assertSupportedModel](model: Model<unknown, Readonly<Record<never, never>>>): void;
+}>[]) => CompositeOf<IdentityOf, IMC>);
+declare function metaImpl<const M extends Model>(this: void, model: M, metadata: ModelMetadata): M;
+export declare const meta: IdentityOf & typeof metaImpl & (<const IMC extends ModelConverter>(modelConverter: IMC, metadata: ModelMetadata) => CompositeOf<IdentityOf, IMC>);

package/converters.js

@@ -0,0 +1,44 @@
+import { $assertSupportedModel, $constraints, $name, $optional, } from './Model.js';
+import { CoreModelBuilder } from './modelBuilders.js';
+import { $itemModel, ArrayModel } from './models.js';
+function createModelConverter(modelConverterFn) {
+    return ((modelOrConverter, ...extraArgs) => {
+        if (typeof modelOrConverter === 'function') {
+            return (model) => modelConverterFn(modelOrConverter(model), ...extraArgs);
+        }
+        return modelConverterFn(modelOrConverter, ...extraArgs);
+    });
+}
+function selfImpl(model) {
+    return model;
+}
+const _self = selfImpl;
+export { _self as self };
+function optionalImpl(model) {
+    return new CoreModelBuilder(model).name(model[$name]).define($optional, { value: true }).build();
+}
+export const optional = createModelConverter(optionalImpl);
+function arrayImpl(model) {
+    return new CoreModelBuilder(ArrayModel, () => [])
+        .name(`Array<${model[$name]}>`)
+        .define($itemModel, { value: model })
+        .build();
+}
+export const array = createModelConverter(arrayImpl);
+function constrainedImpl(model, constraint, ...moreConstraints) {
+    const previousConstraints = model[$constraints];
+    const newConstraints = [constraint, ...moreConstraints];
+    for (const newConstraint of newConstraints) {
+        newConstraint[$assertSupportedModel](model);
+    }
+    return new CoreModelBuilder(model)
+        .name(model[$name])
+        .define($constraints, { value: [...previousConstraints, ...newConstraints] })
+        .build();
+}
+export const constrained = createModelConverter(constrainedImpl);
+function metaImpl(model, metadata) {
+    return new CoreModelBuilder(model).name(model[$name]).meta(metadata).build();
+}
+export const meta = createModelConverter(metaImpl);
+//# sourceMappingURL=converters.js.map

package/converters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"converters.js","sourceRoot":"","sources":["src/converters.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,YAAY,EACZ,KAAK,EACL,SAAS,GAUV,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,UAAU,EAAE,UAAU,EAAsB,MAAM,aAAa,CAAC;AAiCzE,SAAS,oBAAoB,CAG3B,gBAAmB;IACnB,OAAO,CAAC,CAAC,gBAA0C,EAAE,GAAG,SAAyB,EAAE,EAAE;QACnF,IAAI,OAAO,gBAAgB,KAAK,UAAU,EAAE,CAAC;YAC3C,OAAO,CAAC,KAAY,EAAE,EAAE,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE,GAAG,SAAS,CAAC,CAAC;QACnF,CAAC;QAED,OAAO,gBAAgB,CAAC,gBAAgB,EAAE,GAAG,SAAS,CAAC,CAAC;IAC1D,CAAC,CAAQ,CAAC;AACZ,CAAC;AASD,SAAS,QAAQ,CAAwB,KAAQ;IAC/C,OAAO,KAAK,CAAC;AACf,CAAC;AAQD,MAAM,KAAK,GAAG,QAAqB,CAAC;AACpC,OAAO,EAAE,KAAK,IAAI,IAAI,EAAE,CAAC;AASzB,SAAS,YAAY,CAAwB,KAAQ;IACnD,OAAO,IAAI,gBAAgB,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,EAAsB,CAAC;AACvH,CAAC;AAOD,MAAM,CAAC,MAAM,QAAQ,GAAG,oBAAoB,CAAkC,YAAY,CAAC,CAAC;AAS5F,SAAS,SAAS,CAAwB,KAAQ;IAChD,OAAO,IAAI,gBAAgB,CAAkB,UAAU,EAAE,GAAoB,EAAE,CAAC,EAAE,CAAC;SAChF,IAAI,CAAC,SAAS,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC;SAC9B,MAAM,CAAC,UAAU,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;SACpC,KAAK,EAAmB,CAAC;AAC9B,CAAC;AAMD,MAAM,CAAC,MAAM,KAAK,GAAG,oBAAoB,CAA4B,SAAS,CAAC,CAAC;AAEhF,SAAS,eAAe,CAEtB,KAAQ,EACR,UAAgC,EAChC,GAAG,eAAoD;IAEvD,MAAM,mBAAmB,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC;IAChD,MAAM,cAAc,GAAG,CAAC,UAAU,EAAE,GAAG,eAAe,CAAC,CAAC;IACxD,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE,CAAC;QAC3C,aAAa,CAAC,qBAAqB,CAAC,CAAC,KAAwB,CAAC,CAAC;IACjE,CAAC;IACD,OAAO,IAAI,gBAAgB,CAAC,KAAK,CAAC;SAC/B,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;SAClB,MAAM,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,CAAC,GAAG,mBAAmB,EAAE,GAAG,cAAc,CAAC,EAAE,CAAC;SAC5E,KAAK,EAAS,CAAC;AACpB,CAAC;AAQD,MAAM,CAAC,MAAM,WAAW,GAAG,oBAAoB,CAAqC,eAAe,CAAC,CAAC;AAErG,SAAS,QAAQ,CAAoC,KAAQ,EAAE,QAAuB;IACpF,OAAO,IAAI,gBAAgB,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAO,CAAC;AACpF,CAAC;AAOD,MAAM,CAAC,MAAM,IAAI,GAAG,oBAAoB,CAA8B,QAAQ,CAAC,CAAC","sourcesContent":["import {\n  $assertSupportedModel,\n  $constraints,\n  $name,\n  $optional,\n  type $targetModel,\n  type Constraint,\n  type CompositeOf,\n  type SourceModel,\n  type TargetModel,\n  type Model,\n  type ModelConverter,\n  type ModelMetadata,\n  type Value,\n} from './Model.js';\nimport { CoreModelBuilder } from './modelBuilders.js';\nimport { $itemModel, ArrayModel, type OptionalModel } from './models.js';\n\n/**\n * Function that converts the given model.\n *\n * @param model - the model to convert\n * @returns derived model\n */\nexport type ModelConverterFn<SM extends Model = Model, TM extends Model = Model> = (\n  model: SM,\n  ...extraArgs: readonly any[]\n) => TM;\n\n/**\n * Universal converter function type for models and model converter functions.\n */\nexport type ModelConverterCallable<\n  MC extends ModelConverter,\n  F extends ModelConverterFn<SourceModel<MC>, TargetModel<MC, SourceModel<MC>>>,\n> = F extends (model: Model, ...extraArgs: infer E) => Model\n  ? <const IMC extends ModelConverter>(modelConverter: IMC, ...extraArgs: E) => CompositeOf<MC, IMC>\n  : never;\n\n/**\n * Applies HKT signature and adds model converter callback support for the given\n * simple model converter function implementation. These additions provide\n * support for self-referencing properties in object model, i. g.,\n * `.property(m.optional(m.self))`.\n *\n * @param modelConverterFn - model function implementation\n * @returns model converter that also supports other converters as arguments,\n * for which it returns a composite model converter.\n */\nfunction createModelConverter<\n  const MC extends ModelConverter,\n  const F extends ModelConverterFn<SourceModel<MC>, TargetModel<MC, SourceModel<MC>>>,\n>(modelConverterFn: F): MC & F & ModelConverterCallable<MC, F> {\n  return ((modelOrConverter: Model | ModelConverterFn, ...extraArgs: readonly any[]) => {\n    if (typeof modelOrConverter === 'function') {\n      return (model: Model) => modelConverterFn(modelOrConverter(model), ...extraArgs);\n    }\n\n    return modelConverterFn(modelOrConverter, ...extraArgs);\n  }) as any;\n}\n\n/**\n * HKT signature for model converters that return models of the same data type\n * as the given model.\n */\nexport interface IdentityOf extends ModelConverter {\n  readonly [$targetModel]: SourceModel<this>;\n}\nfunction selfImpl<const M extends Model>(model: M): M {\n  return model;\n}\nexport type ModelSelf = IdentityOf & typeof selfImpl;\n\n/**\n * The model converter identity function that returns the given model.\n *\n * @param model - The model to return.\n */\nconst _self = selfImpl as ModelSelf;\nexport { _self as self };\n\n/**\n * HKT signature for optional model converter, which returns optional model\n * of the given one.\n */\nexport interface OptionalOf extends ModelConverter {\n  readonly [$targetModel]: OptionalModel<SourceModel<this>>;\n}\nfunction optionalImpl<const M extends Model>(model: M) {\n  return new CoreModelBuilder(model).name(model[$name]).define($optional, { value: true }).build() as OptionalModel<M>;\n}\n\n/**\n * Creates a new model that represents an optional value.\n *\n * @param base - The base model to extend.\n */\nexport const optional = createModelConverter<OptionalOf, typeof optionalImpl>(optionalImpl);\n\n/**\n * HKT signature for array model converte, which returns array model with\n * items of the given model.\n */\nexport interface ArrayOf extends ModelConverter {\n  readonly [$targetModel]: ArrayModel<SourceModel<this>>;\n}\nfunction arrayImpl<const M extends Model>(model: M) {\n  return new CoreModelBuilder<Array<Value<M>>>(ArrayModel, (): Array<Value<M>> => [])\n    .name(`Array<${model[$name]}>`)\n    .define($itemModel, { value: model })\n    .build() as ArrayModel<M>;\n}\n/**\n * Creates a new model that represents an array of items.\n *\n * @param itemModel - The model of the items in the array.\n */\nexport const array = createModelConverter<ArrayOf, typeof arrayImpl>(arrayImpl);\n\nfunction constrainedImpl<const M extends Model>(\n  this: void,\n  model: M,\n  constraint: Constraint<Value<M>>,\n  ...moreConstraints: ReadonlyArray<Constraint<Value<M>>>\n): M {\n  const previousConstraints = model[$constraints];\n  const newConstraints = [constraint, ...moreConstraints];\n  for (const newConstraint of newConstraints) {\n    newConstraint[$assertSupportedModel](model as Model<Value<M>>);\n  }\n  return new CoreModelBuilder(model)\n    .name(model[$name])\n    .define($constraints, { value: [...previousConstraints, ...newConstraints] })\n    .build() as any;\n}\n/**\n * Applies the constraints to the given model.\n *\n * @param model - The model to apply the constraints to.\n * @param constraint - The constraint to apply.\n * @param moreConstraints - Additional constraints to apply.\n */\nexport const constrained = createModelConverter<IdentityOf, typeof constrainedImpl>(constrainedImpl);\n\nfunction metaImpl<const M extends Model>(this: void, model: M, metadata: ModelMetadata): M {\n  return new CoreModelBuilder(model).name(model[$name]).meta(metadata).build() as M;\n}\n/**\n * Defines the metadata for the given model.\n *\n * @param model - The model to define metadata for.\n * @param metadata - The metadata to define.\n */\nexport const meta = createModelConverter<IdentityOf, typeof metaImpl>(metaImpl);\n"]}

package/index.d.ts

@@ -1,25 +1,7 @@
-import type { EmptyObject } from 'type-fest';
-import { ObjectModelBuilder } from './builders.js';
-import { ArrayModel, EnumModel, type UnionModel } from './core.js';
-import { type AnyObject, type Target, type Enum, type Extensions, Model, type References, type Value } from './model.js';
-export * from './model.js';
-export * from './core.js';
-export type * from './builders.js';
-declare const m: {
-    attach<M extends Model>(model: M, target: Target<Value<M>>): M;
-    extend<M extends Model<AnyObject>>(base: M): ObjectModelBuilder<Value<M>, Value<M>, Extensions<M>, {
-        named: false;
-        selfRefKeys: References<M>;
-    }>;
-    optional<M extends Model>(base: M): M;
-    array<M extends Model>(itemModel: M): ArrayModel<M>;
-    object<T extends AnyObject>(name: string): ObjectModelBuilder<T, EmptyObject, EmptyObject, {
-        named: true;
-        selfRefKeys: never;
-    }>;
-    enum<T extends typeof Enum>(obj: T, name: string): EnumModel<T>;
-    union<MM extends Model[]>(...members: MM): UnionModel<MM>;
-    items<V extends Model>(model: ArrayModel<V>): Generator<V, undefined, void>;
-    value<T>(model: Model<T>): T;
-};
+import * as m from './m.js';
+export * from './Model.js';
+export * from './models.js';
+export type * from './modelBuilders.js';
+export type * from './converters.js';
+export * from './constraints.js';
 export default m;

package/index.js

@@ -1,72 +1,6 @@
-import { CoreModelBuilder, ObjectModelBuilder } from './builders.js';
-import { ArrayModel, EnumModel, ObjectModel } from './core.js';
-import { $defaultValue, $enum, $itemModel, $key, $members, $name, $optional, $owner, Model, nothing, } from './model.js';
-export * from './model.js';
-export * from './core.js';
-const { defineProperty } = Object;
-const arrayItemModels = new WeakMap();
-function getRawValue(model) {
-    if (model[$owner] instanceof Model) {
-        const parentValue = getRawValue(model[$owner]);
-        return parentValue === nothing ? nothing : parentValue[model[$key]];
-    }
-    return model[$owner].value;
-}
-const m = {
-    attach(model, target) {
-        const _model = new CoreModelBuilder(model)
-            .name(`@${model[$name]}`)
-            .build();
-        defineProperty(_model, $owner, { value: target });
-        defineProperty(target, 'model', { enumerable: true, configurable: true, value: model });
-        return _model;
-    },
-    extend(base) {
-        return new ObjectModelBuilder(base);
-    },
-    optional(base) {
-        return new CoreModelBuilder(base)
-            .define($optional, { value: true })
-            .build();
-    },
-    array(itemModel) {
-        return new CoreModelBuilder(ArrayModel)
-            .name(`Array<${itemModel[$name]}>`)
-            .define($itemModel, { value: itemModel })
-            .build();
-    },
-    object(name) {
-        return new ObjectModelBuilder(ObjectModel).name(name);
-    },
-    enum(obj, name) {
-        return new CoreModelBuilder(EnumModel).define($enum, { value: obj }).name(name).build();
-    },
-    union(...members) {
-        return new CoreModelBuilder(Model, () => members[0][$defaultValue])
-            .name(members.map((model) => model[$name]).join(' | '))
-            .define($members, { value: members })
-            .build();
-    },
-    *items(model) {
-        const list = arrayItemModels.get(model) ?? [];
-        arrayItemModels.set(model, list);
-        const value = m.value(model);
-        list.length = value.length;
-        for (let i = 0; i < value.length; i++) {
-            if (!list[i]) {
-                list[i] = new CoreModelBuilder(model[$itemModel], () => value[i])
-                    .name(`${model[$itemModel][$name]}[${i}]`)
-                    .define($key, { value: i })
-                    .define($owner, { value: model })
-                    .build();
-            }
-            yield list[i];
-        }
-    },
-    value(model) {
-        const value = getRawValue(model);
-        return value === nothing ? model[$defaultValue] : value;
-    },
-};
+import * as m from './m.js';
+export * from './Model.js';
+export * from './models.js';
+export * from './constraints.js';
 export default m;
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACrE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,WAAW,EAAmB,MAAM,WAAW,CAAC;AAChF,OAAO,EACL,aAAa,EACb,KAAK,EACL,UAAU,EACV,IAAI,EACJ,QAAQ,EACR,KAAK,EACL,SAAS,EACT,MAAM,EAKN,KAAK,EACL,OAAO,GAGR,MAAM,YAAY,CAAC;AAEpB,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAG1B,MAAM,EAAE,cAAc,EAAE,GAAG,MAAM,CAAC;AAElC,MAAM,eAAe,GAAG,IAAI,OAAO,EAAuB,CAAC;AAE3D,SAAS,WAAW,CAAI,KAAe;IACrC,IAAI,KAAK,CAAC,MAAM,CAAC,YAAY,KAAK,EAAE,CAAC;QAInC,MAAM,WAAW,GAAG,WAAW,CAAC,KAAK,CAAC,MAAM,CAAgC,CAAC,CAAC;QAC9E,OAAO,WAAW,KAAK,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IACtE,CAAC;IAGD,OAAQ,KAAK,CAAC,MAAM,CAAe,CAAC,KAAK,CAAC;AAC5C,CAAC;AAKD,MAAM,CAAC,GAAG;IASR,MAAM,CAAkB,KAAQ,EAAE,MAAwB;QACxD,MAAM,MAAM,GAAG,IAAI,gBAAgB,CAAwE,KAAK,CAAC;aAC9G,IAAI,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;aACxB,KAAK,EAAE,CAAC;QACX,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;QAClD,cAAc,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;QAGxF,OAAO,MAAa,CAAC;IACvB,CAAC;IAOD,MAAM,CACJ,IAAO;QAEP,OAAO,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;IAOD,QAAQ,CAAkB,IAAO;QAC/B,OAAO,IAAI,gBAAgB,CAAuE,IAAI,CAAC;aACpG,MAAM,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;aAClC,KAAK,EAAO,CAAC;IAClB,CAAC;IAOD,KAAK,CAAkB,SAAY;QACjC,OAAO,IAAI,gBAAgB,CAAkB,UAAU,CAAC;aACrD,IAAI,CAAC,SAAS,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC;aAClC,MAAM,CAAC,UAAU,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;aACxC,KAAK,EAAE,CAAC;IACb,CAAC;IAOD,MAAM,CACJ,IAAY;QAEZ,OAAO,IAAI,kBAAkB,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,IAAI,CAAQ,CAAC;IAC/D,CAAC;IAQD,IAAI,CAAwB,GAAM,EAAE,IAAY;QAC9C,OAAO,IAAI,gBAAgB,CAAa,SAAS,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC;IACtG,CAAC;IAQD,KAAK,CAAqB,GAAG,OAAW;QACtC,OAAO,IAAI,gBAAgB,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,aAAa,CAAsB,CAAC;aACrF,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aACtD,MAAM,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;aACpC,KAAK,EAAE,CAAC;IACb,CAAC;IAQD,CAAC,KAAK,CAAkB,KAAoB;QAC1C,MAAM,IAAI,GAAG,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;QAC9C,eAAe,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACjC,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAE7B,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAE3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACtC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;gBACb,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,gBAAgB,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;qBAC9D,IAAI,CAAC,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC;qBACzC,MAAM,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;qBAC1B,MAAM,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;qBAChC,KAAK,EAAE,CAAC;YACb,CAAC;YAED,MAAM,IAAI,CAAC,CAAC,CAAM,CAAC;QACrB,CAAC;IACH,CAAC;IASD,KAAK,CAAI,KAAe;QACtB,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;QAGjC,OAAO,KAAK,KAAK,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAC1D,CAAC;CACF,CAAC;AAEF,eAAe,CAAC,CAAC","sourcesContent":["import type { EmptyObject } from 'type-fest';\nimport { CoreModelBuilder, ObjectModelBuilder } from './builders.js';\nimport { ArrayModel, EnumModel, ObjectModel, type UnionModel } from './core.js';\nimport {\n  $defaultValue,\n  $enum,\n  $itemModel,\n  $key,\n  $members,\n  $name,\n  $optional,\n  $owner,\n  type AnyObject,\n  type Target,\n  type Enum,\n  type Extensions,\n  Model,\n  nothing,\n  type References,\n  type Value,\n} from './model.js';\n\nexport * from './model.js';\nexport * from './core.js';\nexport type * from './builders.js';\n\nconst { defineProperty } = Object;\n\nconst arrayItemModels = new WeakMap<ArrayModel, Model[]>();\n\nfunction getRawValue<T>(model: Model<T>): T | typeof nothing {\n  if (model[$owner] instanceof Model) {\n    // If the current model is a property of another model, the owner is\n    // definitely an object. So we just return the part of the value of\n    // the owner.\n    const parentValue = getRawValue(model[$owner] as Model<Record<keyof any, T>>);\n    return parentValue === nothing ? nothing : parentValue[model[$key]];\n  }\n\n  // Otherwise, the owner is a Target, so we can return the full value.\n  return (model[$owner] as Target<T>).value;\n}\n\n/**\n * The utility object that provides methods to create and manipulate models.\n */\nconst m = {\n  /**\n   * Attaches the given model to the target.\n   *\n   * @param model - The model to attach.\n   * @param target - The target to attach the model to. It could be a Binder\n   * instance, a Signal, or another object. However, it could never be another\n   * model.\n   */\n  attach<M extends Model>(model: M, target: Target<Value<M>>): M {\n    const _model = new CoreModelBuilder<Value<M>, Extensions<M>, { named: false; selfRefKeys: References<M> }>(model)\n      .name(`@${model[$name]}`)\n      .build();\n    defineProperty(_model, $owner, { value: target });\n    defineProperty(target, 'model', { enumerable: true, configurable: true, value: model });\n\n    // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion\n    return _model as any;\n  },\n\n  /**\n   * Creates a new model that extends the given base model.\n   *\n   * @param base - The base model to extend.\n   */\n  extend<M extends Model<AnyObject>>(\n    base: M,\n  ): ObjectModelBuilder<Value<M>, Value<M>, Extensions<M>, { named: false; selfRefKeys: References<M> }> {\n    return new ObjectModelBuilder(base);\n  },\n\n  /**\n   * Creates a new model that represents an optional value.\n   *\n   * @param base - The base model to extend.\n   */\n  optional<M extends Model>(base: M): M {\n    return new CoreModelBuilder<Value<M>, Extensions<M>, { named: true; selfRefKeys: References<M> }>(base)\n      .define($optional, { value: true })\n      .build() as M;\n  },\n\n  /**\n   * Creates a new model that represents an array of items.\n   *\n   * @param itemModel - The model of the items in the array.\n   */\n  array<M extends Model>(itemModel: M): ArrayModel<M> {\n    return new CoreModelBuilder<Array<Value<M>>>(ArrayModel)\n      .name(`Array<${itemModel[$name]}>`)\n      .define($itemModel, { value: itemModel })\n      .build();\n  },\n\n  /**\n   * Creates a new model that represents an object.\n   *\n   * @param name - The name of the object.\n   */\n  object<T extends AnyObject>(\n    name: string,\n  ): ObjectModelBuilder<T, EmptyObject, EmptyObject, { named: true; selfRefKeys: never }> {\n    return new ObjectModelBuilder(ObjectModel).name(name) as any;\n  },\n\n  /**\n   * Creates a new model that represents an enum.\n   *\n   * @param obj - The enum object to represent.\n   * @param name - The name of the model.\n   */\n  enum<T extends typeof Enum>(obj: T, name: string): EnumModel<T> {\n    return new CoreModelBuilder<T[keyof T]>(EnumModel).define($enum, { value: obj }).name(name).build();\n  },\n\n  /**\n   * Creates a new model that represents a union of the values of the given\n   * models.\n   *\n   * @param members - The models to create the union from.\n   */\n  union<MM extends Model[]>(...members: MM): UnionModel<MM> {\n    return new CoreModelBuilder(Model, () => members[0][$defaultValue] as Value<MM[number]>)\n      .name(members.map((model) => model[$name]).join(' | '))\n      .define($members, { value: members })\n      .build();\n  },\n\n  /**\n   * Iterates over the given array model yielding an item model for each item\n   * the model value has.\n   *\n   * @param model - The array model to iterate over.\n   */\n  *items<V extends Model>(model: ArrayModel<V>): Generator<V, undefined, void> {\n    const list = arrayItemModels.get(model) ?? [];\n    arrayItemModels.set(model, list);\n    const value = m.value(model);\n\n    list.length = value.length;\n\n    for (let i = 0; i < value.length; i++) {\n      if (!list[i]) {\n        list[i] = new CoreModelBuilder(model[$itemModel], () => value[i])\n          .name(`${model[$itemModel][$name]}[${i}]`)\n          .define($key, { value: i })\n          .define($owner, { value: model })\n          .build();\n      }\n\n      yield list[i] as V;\n    }\n  },\n\n  /**\n   * Provides the value the given model represents. For attached models it will\n   * be the owner value or its part, for detached models it will be the default\n   * value of the model.\n   *\n   * @param model - The model to get the value from.\n   */\n  value<T>(model: Model<T>): T {\n    const value = getRawValue(model);\n\n    // If the value is `nothing`, we return the default value of the model.\n    return value === nothing ? model[$defaultValue] : value;\n  },\n};\n\nexport default m;\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAI5B,cAAc,kBAAkB,CAAC;AAEjC,eAAe,CAAC,CAAC","sourcesContent":["import * as m from './m.js';\n\nexport * from './Model.js';\nexport * from './models.js';\nexport type * from './modelBuilders.js';\nexport type * from './converters.js';\n\nexport * from './constraints.js';\n\nexport default m;\n"]}

package/m.d.ts

@@ -0,0 +1,17 @@
+import type { EmptyObject } from 'type-fest';
+import { type Constraint, type NonAttributedConstraint, Model, type Target, type Value, type Extensions, type AnyObject, type Enum } from './Model.js';
+import { ObjectModelBuilder } from './modelBuilders.js';
+import { type ArrayModel, EnumModel, type UnionModel, type OptionalModel } from './models.js';
+export { self, optional, array, constrained, meta } from './converters.js';
+export declare function attach<M extends Model>(this: void, model: M, targetProvider: () => Target<Value<M>>): M;
+export declare function extend<M extends Model<AnyObject>>(this: void, base: M): ObjectModelBuilder<Value<M>, Value<M>, Extensions<M>>;
+export declare function object<T extends AnyObject>(this: void, name: string): ObjectModelBuilder<T, AnyObject, AnyObject, {
+    named: true;
+}>;
+declare function _enum<T extends typeof Enum>(this: void, obj: T, name: string): EnumModel<T>;
+export { _enum as enum };
+export declare function union<MM extends Model[]>(this: void, ...members: MM): UnionModel<MM>;
+export declare function getValue<T>(this: void, model: Model<T>): T;
+export declare function items<V extends Model>(this: void, model: ArrayModel<V> | OptionalModel<ArrayModel<V>>): Generator<V, undefined, void>;
+export declare function withDefaultValue<const M extends Model>(this: void, model: M, defaultValue: Value<M>): M;
+export declare function isConstraint<V, N extends string = string, A extends AnyObject = EmptyObject>(this: void, arg: unknown, constraintType: NonAttributedConstraint<V, N, A>): arg is Constraint<V, N, A>;

package/m.js

@@ -0,0 +1,76 @@
+import { Model, $owner, nothing, $key, $name, $defaultValue, $members, } from './Model.js';
+import { CoreModelBuilder, ObjectModelBuilder } from './modelBuilders.js';
+import { EnumModel, ObjectModel, $itemModel, $enum, } from './models.js';
+const { defineProperty } = Object;
+const arrayItemModels = new WeakMap();
+function getRawValue(model) {
+    if (model[$owner] instanceof Model) {
+        const parentValue = getRawValue(model[$owner]);
+        return parentValue === nothing ? nothing : parentValue[model[$key]];
+    }
+    return model[$owner].value;
+}
+export { self, optional, array, constrained, meta } from './converters.js';
+export function attach(model, targetProvider) {
+    const _model = new CoreModelBuilder(model)
+        .name(`@${model[$name]}`)
+        .build();
+    defineProperty(_model, $owner, { get: targetProvider });
+    return _model;
+}
+export function extend(base) {
+    return new ObjectModelBuilder(base);
+}
+export function object(name) {
+    return new ObjectModelBuilder(ObjectModel).name(name);
+}
+function _enum(obj, name) {
+    return new CoreModelBuilder(EnumModel).define($enum, { value: obj }).name(name).build();
+}
+export { _enum as enum };
+export function union(...members) {
+    return new CoreModelBuilder(Model, () => members[0][$defaultValue])
+        .name(members.map((model) => model[$name]).join(' | '))
+        .define($members, { value: members })
+        .define(Symbol.hasInstance, {
+        value: (v) => members.some((member) => v instanceof member),
+    })
+        .build();
+}
+export function getValue(model) {
+    const v = getRawValue(model);
+    return v === nothing ? model[$defaultValue] : v;
+}
+export function* items(model) {
+    const list = arrayItemModels.get(model) ?? [];
+    arrayItemModels.set(model, list);
+    const v = getValue(model) ?? [];
+    list.length = v.length;
+    for (let i = 0; i < v.length; i++) {
+        if (!list[i]) {
+            list[i] = new CoreModelBuilder(model[$itemModel], () => v[i])
+                .name(`${model[$itemModel][$name]}[${i}]`)
+                .define($key, { value: i })
+                .define($owner, { value: model })
+                .build();
+        }
+        yield list[i];
+    }
+}
+export function withDefaultValue(model, defaultValue) {
+    return new CoreModelBuilder(model, () => defaultValue).name(model[$name]).build();
+}
+export function isConstraint(arg, constraintType) {
+    let p = arg;
+    do {
+        if (p === constraintType) {
+            return true;
+        }
+        if (typeof p !== 'object') {
+            return false;
+        }
+        p = Object.getPrototypeOf(p);
+    } while (p !== undefined && p !== null);
+    return false;
+}
+//# sourceMappingURL=m.js.map

package/m.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"m.js","sourceRoot":"","sources":["src/m.ts"],"names":[],"mappings":"AACA,OAAO,EAGL,KAAK,EACL,MAAM,EACN,OAAO,EACP,IAAI,EAIJ,KAAK,EAGL,aAAa,EACb,QAAQ,GACT,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAC1E,OAAO,EAEL,SAAS,EACT,WAAW,EAEX,UAAU,EAEV,KAAK,GACN,MAAM,aAAa,CAAC;AAErB,MAAM,EAAE,cAAc,EAAE,GAAG,MAAM,CAAC;AAElC,MAAM,eAAe,GAAG,IAAI,OAAO,EAAmD,CAAC;AAEvF,SAAS,WAAW,CAAI,KAAe;IACrC,IAAI,KAAK,CAAC,MAAM,CAAC,YAAY,KAAK,EAAE,CAAC;QAInC,MAAM,WAAW,GAAG,WAAW,CAAC,KAAK,CAAC,MAAM,CAAgC,CAAC,CAAC;QAC9E,OAAO,WAAW,KAAK,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IACtE,CAAC;IAGD,OAAQ,KAAK,CAAC,MAAM,CAAe,CAAC,KAAK,CAAC;AAC5C,CAAC;AAED,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAU3E,MAAM,UAAU,MAAM,CAA8B,KAAQ,EAAE,cAAsC;IAClG,MAAM,MAAM,GAAG,IAAI,gBAAgB,CAA4C,KAAK,CAAC;SAClF,IAAI,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;SACxB,KAAK,EAAE,CAAC;IACX,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,cAAc,EAAE,CAAC,CAAC;IAGxD,OAAO,MAAa,CAAC;AACvB,CAAC;AAOD,MAAM,UAAU,MAAM,CAEpB,IAAO;IAEP,OAAO,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC;AACtC,CAAC;AAOD,MAAM,UAAU,MAAM,CAEpB,IAAY;IAEZ,OAAO,IAAI,kBAAkB,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,IAAI,CAAQ,CAAC;AAC/D,CAAC;AAQD,SAAS,KAAK,CAAoC,GAAM,EAAE,IAAY;IACpE,OAAO,IAAI,gBAAgB,CAAa,SAAS,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC;AACtG,CAAC;AACD,OAAO,EAAE,KAAK,IAAI,IAAI,EAAE,CAAC;AAQzB,MAAM,UAAU,KAAK,CAAiC,GAAG,OAAW;IAClE,OAAO,IAAI,gBAAgB,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,aAAa,CAAsB,CAAC;SACrF,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SACtD,MAAM,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;SACpC,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE;QAC1B,KAAK,EAAE,CAAC,CAAU,EAA0B,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,YAAY,MAAM,CAAC;KAC7F,CAAC;SACD,KAAK,EAAE,CAAC;AACb,CAAC;AASD,MAAM,UAAU,QAAQ,CAAgB,KAAe;IACrD,MAAM,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;IAG7B,OAAO,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAClD,CAAC;AAQD,MAAM,SAAS,CAAC,CAAC,KAAK,CAEpB,KAAmD;IAEnD,MAAM,IAAI,GAAG,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;IAC9C,eAAe,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACjC,MAAM,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;IAEhC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC;IAEvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAClC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;YACb,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,gBAAgB,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;iBAC1D,IAAI,CAAC,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC;iBACzC,MAAM,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;iBAC1B,MAAM,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;iBAChC,KAAK,EAAE,CAAC;QACb,CAAC;QAED,MAAM,IAAI,CAAC,CAAC,CAAM,CAAC;IACrB,CAAC;AACH,CAAC;AAQD,MAAM,UAAU,gBAAgB,CAAoC,KAAQ,EAAE,YAAsB;IAClG,OAAO,IAAI,gBAAgB,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,EAAO,CAAC;AACzF,CAAC;AAQD,MAAM,UAAU,YAAY,CAE1B,GAAY,EACZ,cAAgD;IAEhD,IAAI,CAAC,GAAY,GAAG,CAAC;IACrB,GAAG,CAAC;QACF,IAAI,CAAC,KAAK,cAAc,EAAE,CAAC;YACzB,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;YAC1B,OAAO,KAAK,CAAC;QACf,CAAC;QACD,CAAC,GAAG,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IAC/B,CAAC,QAAQ,CAAC,KAAK,SAAS,IAAI,CAAC,KAAK,IAAI,EAAE;IACxC,OAAO,KAAK,CAAC;AACf,CAAC","sourcesContent":["import type { EmptyObject } from 'type-fest';\nimport {\n  type Constraint,\n  type NonAttributedConstraint,\n  Model,\n  $owner,\n  nothing,\n  $key,\n  type Target,\n  type Value,\n  type Extensions,\n  $name,\n  type AnyObject,\n  type Enum,\n  $defaultValue,\n  $members,\n} from './Model.js';\nimport { CoreModelBuilder, ObjectModelBuilder } from './modelBuilders.js';\nimport {\n  type ArrayModel,\n  EnumModel,\n  ObjectModel,\n  type UnionModel,\n  $itemModel,\n  type OptionalModel,\n  $enum,\n} from './models.js';\n\nconst { defineProperty } = Object;\n\nconst arrayItemModels = new WeakMap<ArrayModel | OptionalModel<ArrayModel>, Model[]>();\n\nfunction getRawValue<T>(model: Model<T>): T | typeof nothing {\n  if (model[$owner] instanceof Model) {\n    // If the current model is a property of another model, the owner is\n    // definitely an object. So we just return the part of the value of\n    // the owner.\n    const parentValue = getRawValue(model[$owner] as Model<Record<keyof any, T>>);\n    return parentValue === nothing ? nothing : parentValue[model[$key]];\n  }\n\n  // Otherwise, the owner is a Target, so we can return the full value.\n  return (model[$owner] as Target<T>).value;\n}\n\nexport { self, optional, array, constrained, meta } from './converters.js';\n\n/**\n * Attaches the given model to the target.\n *\n * @param model - The model to attach.\n * @param targetProvider - The target to attach the model to. It could be a Binder\n * instance, a Signal, or another object. However, it could never be another\n * model.\n */\nexport function attach<M extends Model>(this: void, model: M, targetProvider: () => Target<Value<M>>): M {\n  const _model = new CoreModelBuilder<Value<M>, Extensions<M>, { named: false }>(model)\n    .name(`@${model[$name]}`)\n    .build();\n  defineProperty(_model, $owner, { get: targetProvider });\n\n  // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion\n  return _model as any;\n}\n\n/**\n * Creates a new model that extends the given base model.\n *\n * @param base - The base model to extend.\n */\nexport function extend<M extends Model<AnyObject>>(\n  this: void,\n  base: M,\n): ObjectModelBuilder<Value<M>, Value<M>, Extensions<M>> {\n  return new ObjectModelBuilder(base);\n}\n\n/**\n * Creates a new model that represents an object.\n *\n * @param name - The name of the object.\n */\nexport function object<T extends AnyObject>(\n  this: void,\n  name: string,\n): ObjectModelBuilder<T, AnyObject, AnyObject, { named: true }> {\n  return new ObjectModelBuilder(ObjectModel).name(name) as any;\n}\n\n/**\n * Creates a new model that represents an enum.\n *\n * @param obj - The enum object to represent.\n * @param name - The name of the model.\n */\nfunction _enum<T extends typeof Enum>(this: void, obj: T, name: string): EnumModel<T> {\n  return new CoreModelBuilder<T[keyof T]>(EnumModel).define($enum, { value: obj }).name(name).build();\n}\nexport { _enum as enum };\n\n/**\n * Creates a new model that represents a union of the values of the given\n * models.\n *\n * @param members - The models to create the union from.\n */\nexport function union<MM extends Model[]>(this: void, ...members: MM): UnionModel<MM> {\n  return new CoreModelBuilder(Model, () => members[0][$defaultValue] as Value<MM[number]>)\n    .name(members.map((model) => model[$name]).join(' | '))\n    .define($members, { value: members })\n    .define(Symbol.hasInstance, {\n      value: (v: unknown): v is Value<MM[number]> => members.some((member) => v instanceof member),\n    })\n    .build();\n}\n\n/**\n * Provides the value the given model represents. For attached models it will\n * be the owner value or its part, for detached models it will be the default\n * value of the model.\n *\n * @param model - The model to get the value from.\n */\nexport function getValue<T>(this: void, model: Model<T>): T {\n  const v = getRawValue(model);\n\n  // If the value is `nothing`, we return the default value of the model.\n  return v === nothing ? model[$defaultValue] : v;\n}\n\n/**\n * Iterates over the given array model yielding an item model for each item\n * the model value has.\n *\n * @param model - The array model to iterate over.\n */\nexport function* items<V extends Model>(\n  this: void,\n  model: ArrayModel<V> | OptionalModel<ArrayModel<V>>,\n): Generator<V, undefined, void> {\n  const list = arrayItemModels.get(model) ?? [];\n  arrayItemModels.set(model, list);\n  const v = getValue(model) ?? [];\n\n  list.length = v.length;\n\n  for (let i = 0; i < v.length; i++) {\n    if (!list[i]) {\n      list[i] = new CoreModelBuilder(model[$itemModel], () => v[i])\n        .name(`${model[$itemModel][$name]}[${i}]`)\n        .define($key, { value: i })\n        .define($owner, { value: model })\n        .build();\n    }\n\n    yield list[i] as V;\n  }\n}\n\n/**\n * Replaces the default value of the given model with the given value.\n *\n * @param model - The model to replace the default value of.\n * @param defaultValue - The new default value.\n */\nexport function withDefaultValue<const M extends Model>(this: void, model: M, defaultValue: Value<M>): M {\n  return new CoreModelBuilder(model, () => defaultValue).name(model[$name]).build() as M;\n}\n\n/**\n * Checks if the given value is a constraint of the given type.\n *\n * @param arg - The argument to check.\n * @param constraintType - The constraint to check against.\n */\nexport function isConstraint<V, N extends string = string, A extends AnyObject = EmptyObject>(\n  this: void,\n  arg: unknown,\n  constraintType: NonAttributedConstraint<V, N, A>,\n): arg is Constraint<V, N, A> {\n  let p: unknown = arg;\n  do {\n    if (p === constraintType) {\n      return true;\n    }\n    if (typeof p !== 'object') {\n      return false;\n    }\n    p = Object.getPrototypeOf(p);\n  } while (p !== undefined && p !== null);\n  return false;\n}\n"]}

package/modelBuilders.d.ts

@@ -0,0 +1,47 @@
+import { type AnyObject, type DefaultValueProvider, type TargetModel, type Model, type ModelConverter, type ModelMetadata } from './Model.js';
+import type { ObjectModel } from './models.js';
+declare const $model: unique symbol;
+export type Flags = {
+    named: boolean;
+};
+export declare class CoreModelBuilder<V, EX extends AnyObject = AnyObject, F extends Flags = {
+    named: false;
+}> {
+    protected readonly [$model]: Model<V, EX>;
+    constructor(base: Model, defaultValueProvider?: (model: Model<V, EX>) => V);
+    meta(value: ModelMetadata): this;
+    define<const DK extends symbol, const DV>(key: DK, value: TypedPropertyDescriptor<DV>): CoreModelBuilder<V, {
+        readonly [key in keyof EX | DK]: key extends DK ? DV : key extends keyof EX ? EX[key] : never;
+    }, F>;
+    defaultValueProvider(defaultValueProvider: DefaultValueProvider<V, EX>): this;
+    name(name: string): CoreModelBuilder<V, EX, {
+        named: true;
+    }>;
+    build(this: F['named'] extends true ? this : never): AnyObject extends EX ? Model<V> : Model<V, EX>;
+}
+export declare class ObjectModelBuilder<V extends AnyObject, CV extends AnyObject = AnyObject, EX extends AnyObject = AnyObject, F extends Flags = {
+    named: false;
+}> extends CoreModelBuilder<V, {
+    readonly [K in keyof EX]: EX[K] extends ModelConverter ? TargetModel<EX[K], ObjectModel<V, EX>> : EX[K];
+}, F> {
+    constructor(base: Model);
+    object<NV extends V>(this: F['named'] extends false ? this : never, name: string): ObjectModelBuilder<NV, CV, EX, {
+        named: true;
+    }>;
+    ['define']: <const DK extends symbol, DV>(key: DK, value: TypedPropertyDescriptor<DV>) => ObjectModelBuilder<V, CV, {
+        readonly [key in keyof EX | DK]: key extends DK ? DV : key extends keyof EX ? EX[key] : never;
+    }, F>;
+    ['meta']: (value: ModelMetadata) => this;
+    property<const PK extends string & keyof V, const M extends Model<V[PK]>>(key: PK, model: M): ObjectModelBuilder<V, {
+        readonly [key in keyof CV | PK]: key extends PK ? V[PK] : key extends keyof CV ? CV[key] : never;
+    }, {
+        readonly [key in keyof EX | PK]: key extends PK ? M : key extends keyof EX ? EX[key] : never;
+    }, F>;
+    property<const PK extends string & keyof V, const MC extends ModelConverter>(key: PK, model: MC): ObjectModelBuilder<V, {
+        readonly [key in keyof CV | PK]: key extends PK ? V[PK] : key extends keyof CV ? CV[key] : never;
+    }, {
+        readonly [key in keyof EX | PK]: key extends PK ? MC : key extends keyof EX ? EX[key] : never;
+    }, F>;
+    build: (this: F['named'] extends true ? (CV extends V ? this : never) : never) => ObjectModel<V, EX>;
+}
+export {};

package/{builders.js → modelBuilders.js}

@@ -1,4 +1,4 @@
-import { $defaultValue, $key, $meta, $name, $owner, } from './model.js';
+import { $defaultValue, $key, $meta, $name, $optional, $owner, } from './Model.js';
 const { create, defineProperty } = Object;
 const $model = Symbol('model');
 export class CoreModelBuilder {
@@ -36,12 +36,10 @@ const propertyRegistry = new WeakMap();
 export class ObjectModelBuilder extends CoreModelBuilder {
     constructor(base) {
         super(base, (m) => {
-            const result = create(null);
+            const result = {};
             for (const key in m) {
-                defineProperty(result, key, {
-                    enumerable: true,
-                    get: () => m[key][$defaultValue],
-                });
+                const keyModel = m[key];
+                result[key] = keyModel[$optional] ? undefined : keyModel[$defaultValue];
             }
             return result;
         });
@@ -49,7 +47,7 @@ export class ObjectModelBuilder extends CoreModelBuilder {
     object(name) {
         return this.name(name);
     }
-    property(key, model, options) {
+    property(key, model) {
         defineProperty(this[$model], key, {
             enumerable: true,
             get() {
@@ -60,7 +58,6 @@ export class ObjectModelBuilder extends CoreModelBuilder {
                 props[key] ??= new CoreModelBuilder(typeof model === 'function' ? model(this) : model)
                     .define($key, { value: key })
                     .define($owner, { value: this })
-                    .define($meta, { value: options?.meta })
                     .build();
                 return props[key];
             },
@@ -68,4 +65,4 @@ export class ObjectModelBuilder extends CoreModelBuilder {
         return this;
     }
 }
-//# sourceMappingURL=builders.js.map
+//# sourceMappingURL=modelBuilders.js.map

package/modelBuilders.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"modelBuilders.js","sourceRoot":"","sources":["src/modelBuilders.ts"],"names":[],"mappings":"AACA,OAAO,EACL,aAAa,EACb,IAAI,EACJ,KAAK,EACL,KAAK,EACL,SAAS,EACT,MAAM,GAOP,MAAM,YAAY,CAAC;AAGpB,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,MAAM,CAAC;AAE1C,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;AAqB/B,MAAM,OAAO,gBAAgB;IACR,CAAC,MAAM,CAAC,CAAe;IAO1C,YAAY,IAAW,EAAE,oBAAiD;QACxE,IAAI,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;QAE5B,IAAI,oBAAoB,EAAE,CAAC;YACzB,IAAI,CAAC,oBAAoB,CAAC,oBAAoB,CAAC,CAAC;QAClD,CAAC;IACH,CAAC;IAQD,IAAI,CAAC,KAAoB;QACvB,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAC9B,OAAO,IAAI,CAAC;IACd,CAAC;IAeD,MAAM,CACJ,GAAO,EACP,KAAkC;QAQlC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;QACzC,OAAO,IAAW,CAAC;IACrB,CAAC;IAWD,oBAAoB,CAAC,oBAAiD;QACpE,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE;YACzB,GAAG;gBACD,OAAO,oBAAoB,CAAC,IAAI,CAAC,CAAC;YACpC,CAAC;SACF,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAUD,IAAI,CAAC,IAAY;QACf,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAQ,CAAC;IACpD,CAAC;IAQD,KAAK;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC;IACtB,CAAC;CACF;AASD,MAAM,gBAAgB,GAAG,IAAI,OAAO,EAAgC,CAAC;AAcrE,MAAM,OAAO,kBAKX,SAAQ,gBAMT;IACC,YAAY,IAAW;QACrB,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE;YAChB,MAAM,MAAM,GAA4B,EAAE,CAAC;YAG3C,KAAK,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC;gBACpB,MAAM,QAAQ,GAAG,CAAC,CAAC,GAAyB,CAAU,CAAC;gBACvD,MAAM,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;YAK1E,CAAC;YAED,OAAO,MAAW,CAAC;QACrB,CAAC,CAAC,CAAC;IACL,CAAC;IAQD,MAAM,CAEJ,IAAY;QAEZ,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAQ,CAAC;IAChC,CAAC;IA6DD,QAAQ,CACN,GAAO,EACP,KAAuC;QAEvC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE;YAChC,UAAU,EAAE,IAAI;YAChB,GAAG;gBACD,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;oBAChC,gBAAgB,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;gBACjC,CAAC;gBAED,MAAM,KAAK,GAAG,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAE,CAAC;gBAE1C,KAAK,CAAC,GAAG,CAAC,KAAK,IAAI,gBAAgB,CACjC,OAAO,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAClD;qBACE,MAAM,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC;qBAC5B,MAAM,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;qBAC/B,KAAK,EAAE,CAAC;gBAEX,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC;YACpB,CAAC;SACF,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IACd,CAAC;CAMF","sourcesContent":["/* eslint-disable @typescript-eslint/consistent-indexed-object-style */\nimport {\n  $defaultValue,\n  $key,\n  $meta,\n  $name,\n  $optional,\n  $owner,\n  type AnyObject,\n  type DefaultValueProvider,\n  type TargetModel,\n  type Model,\n  type ModelConverter,\n  type ModelMetadata,\n} from './Model.js';\nimport type { ObjectModel } from './models.js';\n\nconst { create, defineProperty } = Object;\n\nconst $model = Symbol('model');\n\n/**\n * The flags for the model constructor that allow to determine specific characteristics of the model.\n */\nexport type Flags = {\n  /**\n   * Defines if the model is named.\n   */\n  named: boolean;\n};\n\n/**\n * A builder class for creating all basic models.\n * @internal low-level API for internal use only.\n *\n * @typeParam V - The final value type of the model.\n * @typeParam EX - The extra properties of the model.\n * @typeParam F - The flags for the model constructor that allow to determine\n * specific characteristics of the model.\n */\nexport class CoreModelBuilder<V, EX extends AnyObject = AnyObject, F extends Flags = { named: false }> {\n  protected readonly [$model]: Model<V, EX>;\n\n  /**\n   * @param base - The base model to extend.\n   * @param defaultValueProvider - The function that provides the default value\n   * for the model.\n   */\n  constructor(base: Model, defaultValueProvider?: (model: Model<V, EX>) => V) {\n    this[$model] = create(base);\n\n    if (defaultValueProvider) {\n      this.defaultValueProvider(defaultValueProvider);\n    }\n  }\n\n  /**\n   * Appends metadata to the model.\n   *\n   * @param value - The metadata to append.\n   * @returns The current builder instance.\n   */\n  meta(value: ModelMetadata): this {\n    this.define($meta, { value });\n    return this;\n  }\n\n  /**\n   * Defines a new property on the model. The property serves the purposes of\n   * storing the extra data for specific types of models.\n   *\n   * @remarks\n   * The key of the property should be a symbol to avoid conflicts with\n   * properties defined via\n   * {@link ObjectModelBuilder}.\n   *\n   * @param key - The key of the property.\n   * @param value - The descriptor of the property.\n   * @returns The current builder instance.\n   */\n  define<const DK extends symbol, const DV>(\n    key: DK,\n    value: TypedPropertyDescriptor<DV>,\n  ): CoreModelBuilder<\n    V,\n    {\n      readonly [key in keyof EX | DK]: key extends DK ? DV : key extends keyof EX ? EX[key] : never;\n    },\n    F\n  > {\n    defineProperty(this[$model], key, value);\n    return this as any;\n  }\n\n  /**\n   * Sets the default value provider for the model. This is an alternative way\n   * to provide the default value for the model if for some reason using the\n   * constructor parameter is undesired.\n   *\n   * @param defaultValueProvider - The function that provides the default value\n   * for the model.\n   * @returns The current builder instance.\n   */\n  defaultValueProvider(defaultValueProvider: DefaultValueProvider<V, EX>): this {\n    this.define($defaultValue, {\n      get(this: Model<V, EX>) {\n        return defaultValueProvider(this);\n      },\n    });\n    return this;\n  }\n\n  /**\n   * Sets the name of the model. The name is used for debugging purposes and is\n   * displayed in the string representation. Setting the name is required;\n   * otherwise, the {@link CoreModelBuilder.build} method won't be available.\n   *\n   * @param name - The name of the model.\n   * @returns The current builder instance.\n   */\n  name(name: string): CoreModelBuilder<V, EX, { named: true }> {\n    return this.define($name, { value: name }) as any;\n  }\n\n  /**\n   * Builds the model. On the typing level, it checks if all the model parts are\n   * set correctly and raises an error if not.\n   *\n   * @returns The model.\n   */\n  build(this: F['named'] extends true ? this : never): AnyObject extends EX ? Model<V> : Model<V, EX> {\n    return this[$model];\n  }\n}\n\n/**\n * A registry for the property models of the object model. Since the property\n * registration is lazy, we cannot store the property models directly on the\n * object model, so the registry plays a role of a private storage for them.\n *\n * @internal\n */\nconst propertyRegistry = new WeakMap<Model, Record<string, Model>>();\n\n/**\n * A builder class for creating object models.\n * @internal low-level API for internal use only.\n *\n * @typeParam V - The final value type of the model.\n * @typeParam CV - The current value type of the model. It changes as the model\n * is being built and defines if the\n * {@link ObjectModelBuilder.build} method can be called.\n * @typeParam EX - The extra properties of the model.\n * @typeParam F - The flags for the model constructor that allow to determine\n * specific characteristics of the model.\n */\nexport class ObjectModelBuilder<\n  V extends AnyObject,\n  CV extends AnyObject = AnyObject,\n  EX extends AnyObject = AnyObject,\n  F extends Flags = { named: false },\n> extends CoreModelBuilder<\n  V,\n  {\n    readonly [K in keyof EX]: EX[K] extends ModelConverter ? TargetModel<EX[K], ObjectModel<V, EX>> : EX[K];\n  },\n  F\n> {\n  constructor(base: Model) {\n    super(base, (m) => {\n      const result: Record<string, unknown> = {};\n\n      // eslint-disable-next-line no-restricted-syntax\n      for (const key in m) {\n        const keyModel = m[key as keyof Model<V, EX>] as Model;\n        result[key] = keyModel[$optional] ? undefined : keyModel[$defaultValue];\n        // defineProperty(result, key, {\n        //   enumerable: true,\n        //   value: keyModel[$optional] ? undefined : keyModel[$defaultValue],\n        // });\n      }\n\n      return result as V;\n    });\n  }\n\n  /**\n   * The method that should follow the {@link m.extend} method. It allows to\n   * declare the extension for the model and properly name it.\n   *\n   * @param name - The name of the model.\n   */\n  object<NV extends V>(\n    this: F['named'] extends false ? this : never,\n    name: string,\n  ): ObjectModelBuilder<NV, CV, EX, { named: true }> {\n    return this.name(name) as any;\n  }\n\n  /**\n   * {@inheritDoc CoreModelBuilder.define}\n   */\n  // @ts-ignore: TypeScript has difficulties with the override type here\n  declare ['define']: <const DK extends symbol, DV>(\n    key: DK,\n    value: TypedPropertyDescriptor<DV>,\n  ) => ObjectModelBuilder<\n    V,\n    CV,\n    {\n      readonly [key in keyof EX | DK]: key extends DK ? DV : key extends keyof EX ? EX[key] : never;\n    },\n    F\n  >;\n\n  /**\n   * {@inheritDoc CoreModelBuilder.meta}\n   */\n  declare ['meta']: (value: ModelMetadata) => this;\n\n  /**\n   * Defines a new model property on the model. Unlike the\n   * {@link ObjectModelBuilder.define}, this property is public and allows the\n   * user to interact with the model data structure. It also updates the current\n   * value type of the model to make it closer to the final value type.\n   *\n   * @param key - The key of the property.\n   * @param model - The model of the property value. You can also provide a\n   * function that produces the model based on the current model.\n   *\n   * @returns The current builder instance updated with the new property type.\n   */\n  property<const PK extends string & keyof V, const M extends Model<V[PK]>>(\n    key: PK,\n    model: M,\n  ): ObjectModelBuilder<\n    V,\n    {\n      readonly [key in keyof CV | PK]: key extends PK ? V[PK] : key extends keyof CV ? CV[key] : never;\n    },\n    {\n      readonly [key in keyof EX | PK]: key extends PK ? M : key extends keyof EX ? EX[key] : never;\n    },\n    F\n  >;\n  property<const PK extends string & keyof V, const MC extends ModelConverter>(\n    key: PK,\n    model: MC,\n  ): ObjectModelBuilder<\n    V,\n    {\n      readonly [key in keyof CV | PK]: key extends PK ? V[PK] : key extends keyof CV ? CV[key] : never;\n    },\n    {\n      readonly [key in keyof EX | PK]: key extends PK ? MC : key extends keyof EX ? EX[key] : never;\n    },\n    F\n  >;\n  property<PK extends string & keyof V, M extends Model<V[PK]>>(\n    key: PK,\n    model: M | ((model: Model<V, EX>) => M),\n  ): unknown {\n    defineProperty(this[$model], key, {\n      enumerable: true,\n      get(this: Model<V, EX & { readonly [key in PK]: M }>) {\n        if (!propertyRegistry.has(this)) {\n          propertyRegistry.set(this, {});\n        }\n\n        const props = propertyRegistry.get(this)!;\n\n        props[key] ??= new CoreModelBuilder<V[PK], object, { named: true }>(\n          typeof model === 'function' ? model(this) : model,\n        )\n          .define($key, { value: key })\n          .define($owner, { value: this })\n          .build();\n\n        return props[key];\n      },\n    });\n\n    return this;\n  }\n\n  /**\n   * {@inheritDoc CoreModelBuilder.build}\n   */\n  declare build: (this: F['named'] extends true ? (CV extends V ? this : never) : never) => ObjectModel<V, EX>;\n}\n"]}

package/models.d.ts

@@ -0,0 +1,31 @@
+import { type $defaultValue, type $members, type AnyObject, type Enum, type Extensions, type TargetModel, Model, type ModelConverter, type Value } from './Model.js';
+export type PrimitiveModel<V = unknown> = Model<V>;
+export declare const PrimitiveModel: Model<unknown>;
+export type StringModel = PrimitiveModel<string>;
+export declare const StringModel: Model<string>;
+export type NumberModel = PrimitiveModel<number>;
+export declare const NumberModel: Model<number>;
+export type BooleanModel = PrimitiveModel<boolean>;
+export declare const BooleanModel: Model<boolean>;
+export declare const $itemModel: unique symbol;
+export type ArrayModel<M extends Model = Model> = Model<Array<Value<M>>, {
+    readonly [$itemModel]: M;
+}>;
+export declare const ArrayModel: ArrayModel;
+export type ObjectModel<V, EX extends AnyObject = AnyObject> = Model<V, {
+    readonly [K in keyof EX]: EX[K] extends ModelConverter ? TargetModel<EX[K], ObjectModel<V, EX>> : EX[K];
+}>;
+export declare const ObjectModel: Model<Readonly<Record<never, never>>>;
+export type RecordModel<K extends string, V> = Model<Record<K, V>>;
+export declare const RecordModel: Model<Record<string, unknown>>;
+export declare const $enum: unique symbol;
+export type EnumModel<T extends typeof Enum> = Model<T[keyof T], {
+    readonly [$enum]: T;
+}>;
+export declare const EnumModel: EnumModel<typeof Enum>;
+export type UnionModel<MM extends Model[]> = Model<Value<MM[number]>, {
+    readonly [$members]: MM;
+}>;
+export type OptionalModel<M extends Model> = Model<M[typeof $defaultValue] | undefined, Extensions<M> & {
+    readonly $optional: true;
+}>;

package/{core.js → models.js}

@@ -1,17 +1,22 @@
-import { CoreModelBuilder } from './builders.js';
-import { $enum, $itemModel, Model } from './model.js';
+import { Model, } from './Model.js';
+import { CoreModelBuilder } from './modelBuilders.js';
 export const PrimitiveModel = new CoreModelBuilder(Model, () => undefined).name('primitive').build();
 export const StringModel = new CoreModelBuilder(PrimitiveModel, () => '').name('string').build();
-export const NumberModel = new CoreModelBuilder(PrimitiveModel, () => 0).name('number').build();
+export const NumberModel = new CoreModelBuilder(PrimitiveModel, () => NaN).name('number').build();
 export const BooleanModel = new CoreModelBuilder(PrimitiveModel, () => false).name('boolean').build();
+export const $itemModel = Symbol('itemModel');
 export const ArrayModel = new CoreModelBuilder(Model, () => [])
     .name('Array')
     .define($itemModel, { value: Model })
     .build();
 export const ObjectModel = new CoreModelBuilder(Model, () => ({})).name('Object').build();
+export const RecordModel = new CoreModelBuilder(ObjectModel, () => ({}))
+    .name('Record')
+    .build();
+export const $enum = Symbol('enumerate');
 export const EnumModel = new CoreModelBuilder(Model)
     .name('Enum')
     .define($enum, { value: {} })
     .defaultValueProvider((self) => Object.values(self[$enum])[0])
     .build();
-//# sourceMappingURL=core.js.map
+//# sourceMappingURL=models.js.map

package/models.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.js","sourceRoot":"","sources":["src/models.ts"],"names":[],"mappings":"AAAA,OAAO,EAOL,KAAK,GAGN,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAMtD,MAAM,CAAC,MAAM,cAAc,GAAG,IAAI,gBAAgB,CAAC,KAAK,EAAE,GAAY,EAAE,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,KAAK,EAAE,CAAC;AAM9G,MAAM,CAAC,MAAM,WAAW,GAAG,IAAI,gBAAgB,CAAC,cAAc,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,CAAC;AAMjG,MAAM,CAAC,MAAM,WAAW,GAAG,IAAI,gBAAgB,CAAC,cAAc,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,CAAC;AAMlG,MAAM,CAAC,MAAM,YAAY,GAAG,IAAI,gBAAgB,CAAC,cAAc,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,CAAC;AAKtG,MAAM,CAAC,MAAM,UAAU,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;AAW9C,MAAM,CAAC,MAAM,UAAU,GAAe,IAAI,gBAAgB,CAAC,KAAK,EAAE,GAAc,EAAE,CAAC,EAAE,CAAC;KACnF,IAAI,CAAC,OAAO,CAAC;KACb,MAAM,CAAC,UAAU,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;KACpC,KAAK,EAAE,CAAC;AAWX,MAAM,CAAC,MAAM,WAAW,GAAG,IAAI,gBAAgB,CAAC,KAAK,EAAE,GAAc,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,CAAC;AAQrG,MAAM,CAAC,MAAM,WAAW,GAAG,IAAI,gBAAgB,CAAC,WAAW,EAAE,GAA4B,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;KAC9F,IAAI,CAAC,QAAQ,CAAC;KACd,KAAK,EAAE,CAAC;AAKX,MAAM,CAAC,MAAM,KAAK,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;AAYzC,MAAM,CAAC,MAAM,SAAS,GAA2B,IAAI,gBAAgB,CAAmC,KAAK,CAAC;KAC3G,IAAI,CAAC,MAAM,CAAC;KAEZ,MAAM,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,EAAiB,EAAE,CAAC;KAC3C,oBAAoB,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;KAC7D,KAAK,EAAE,CAAC","sourcesContent":["import {\n  type $defaultValue,\n  type $members,\n  type AnyObject,\n  type Enum,\n  type Extensions,\n  type TargetModel,\n  Model,\n  type ModelConverter,\n  type Value,\n} from './Model.js';\nimport { CoreModelBuilder } from './modelBuilders.js';\n\n/**\n * The model of a primitive value, like `string`, `number` or `boolean`.\n */\nexport type PrimitiveModel<V = unknown> = Model<V>;\nexport const PrimitiveModel = new CoreModelBuilder(Model, (): unknown => undefined).name('primitive').build();\n\n/**\n * The model of a string value.\n */\nexport type StringModel = PrimitiveModel<string>;\nexport const StringModel = new CoreModelBuilder(PrimitiveModel, () => '').name('string').build();\n\n/**\n * The model of a number value.\n */\nexport type NumberModel = PrimitiveModel<number>;\nexport const NumberModel = new CoreModelBuilder(PrimitiveModel, () => NaN).name('number').build();\n\n/**\n * The model of a boolean value.\n */\nexport type BooleanModel = PrimitiveModel<boolean>;\nexport const BooleanModel = new CoreModelBuilder(PrimitiveModel, () => false).name('boolean').build();\n\n/**\n * The symbol that represents the ArrayModel item property.\n */\nexport const $itemModel = Symbol('itemModel');\n\n/**\n * The model of array data.\n */\nexport type ArrayModel<M extends Model = Model> = Model<\n  Array<Value<M>>,\n  {\n    readonly [$itemModel]: M;\n  }\n>;\nexport const ArrayModel: ArrayModel = new CoreModelBuilder(Model, (): unknown[] => [])\n  .name('Array')\n  .define($itemModel, { value: Model })\n  .build();\n\n/**\n * The model of object data.\n */\nexport type ObjectModel<V, EX extends AnyObject = AnyObject> = Model<\n  V,\n  {\n    readonly [K in keyof EX]: EX[K] extends ModelConverter ? TargetModel<EX[K], ObjectModel<V, EX>> : EX[K];\n  }\n>;\nexport const ObjectModel = new CoreModelBuilder(Model, (): AnyObject => ({})).name('Object').build();\n\n/**\n * The model of a `Record<string, V>` data, which is a special case\n * of `ObjectModel<Record<string, V>>` that is used to represent an arbitrary\n * object with string keys, such as a Java `Map<String, Object>`.\n */\nexport type RecordModel<K extends string, V> = Model<Record<K, V>>;\nexport const RecordModel = new CoreModelBuilder(ObjectModel, (): Record<string, unknown> => ({}))\n  .name('Record')\n  .build();\n\n/**\n * The symbol that represents the `EnumModel[$enumerate]` property.\n */\nexport const $enum = Symbol('enumerate');\n\n/**\n * The model of enum data.\n */\nexport type EnumModel<T extends typeof Enum> = Model<\n  T[keyof T],\n  {\n    readonly [$enum]: T;\n  }\n>;\n\nexport const EnumModel: EnumModel<typeof Enum> = new CoreModelBuilder<(typeof Enum)[keyof typeof Enum]>(Model)\n  .name('Enum')\n  // eslint-disable-next-line @typescript-eslint/consistent-type-assertions\n  .define($enum, { value: {} as typeof Enum })\n  .defaultValueProvider((self) => Object.values(self[$enum])[0])\n  .build();\n\n/**\n * The model of a union data.\n */\nexport type UnionModel<MM extends Model[]> = Model<Value<MM[number]>, { readonly [$members]: MM }>;\n\n/**\n * The model of an optional type.\n */\nexport type OptionalModel<M extends Model> = Model<\n  M[typeof $defaultValue] | undefined,\n  Extensions<M> & {\n    readonly $optional: true;\n  }\n>;\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vaadin/hilla-models",
-  "version": "25.0.5",
+  "version": "25.1.0-alpha10",
   "description": "Generative form models for Hilla",
   "main": "index.js",
   "module": "index.js",
@@ -42,9 +42,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "dependencies": {
-    "@vaadin/hilla-lit-form": "25.0.5"
-  },
+  "dependencies": {},
   "peerDependencies": {
     "react": "18 || 19",
     "react-dom": "18 || 19"

package/builders.d.ts

@@ -1,44 +0,0 @@
-import type { EmptyObject } from 'type-fest';
-import type { ObjectModel } from './core';
-import { type AnyObject, type DefaultValueProvider, type Model, type ModelMetadata } from './model.js';
-export type ModelBuilderPropertyOptions = Readonly<{
-    meta?: ModelMetadata;
-}>;
-declare const $model: unique symbol;
-export type Flags = {
-    named: boolean;
-    selfRefKeys: keyof any;
-};
-export declare class CoreModelBuilder<V, EX extends AnyObject = EmptyObject, F extends Flags = {
-    named: false;
-    selfRefKeys: never;
-}> {
-    protected readonly [$model]: Model<V, EX>;
-    constructor(base: Model, defaultValueProvider?: (model: Model<V, EX>) => V);
-    meta(value: ModelMetadata): this;
-    define<DK extends symbol, DV>(key: DK, value: TypedPropertyDescriptor<DV>): CoreModelBuilder<V, EX & Readonly<Record<DK, DV>>, F>;
-    defaultValueProvider(defaultValueProvider: DefaultValueProvider<V, EX>): this;
-    name(name: string): CoreModelBuilder<V, EX, {
-        named: true;
-        selfRefKeys: F['selfRefKeys'];
-    }>;
-    build(this: F['named'] extends true ? this : never): Model<V, EX>;
-}
-export declare class ObjectModelBuilder<V extends AnyObject, CV extends AnyObject = EmptyObject, EX extends AnyObject = EmptyObject, F extends Flags = {
-    named: false;
-    selfRefKeys: never;
-}> extends CoreModelBuilder<V, EX, F> {
-    constructor(base: Model);
-    object<NV extends AnyObject>(this: F['named'] extends false ? this : never, name: string): ObjectModelBuilder<NV & V, CV, EX, {
-        named: true;
-        selfRefKeys: F['selfRefKeys'];
-    }>;
-    ['define']: <DK extends symbol, DV>(key: DK, value: TypedPropertyDescriptor<DV>) => ObjectModelBuilder<V, CV, EX & Readonly<Record<DK, DV>>, F>;
-    ['meta']: (value: ModelMetadata) => this;
-    property<PK extends string & keyof V, EXK extends AnyObject = EmptyObject>(key: PK, model: Model<V[PK], EXK> | ((model: Model<V, EX & Readonly<Record<PK, Model<V[PK], EXK>>>>) => Model<V[PK], EXK>), options?: ModelBuilderPropertyOptions): Extract<V[PK], V> extends never ? ObjectModelBuilder<V, CV & Readonly<Record<PK, V[PK]>>, EX & Readonly<Record<PK, Model<V[PK], EXK>>>, F> : ObjectModelBuilder<V, CV & Readonly<Record<PK, V[PK]>>, EX, {
-        named: F['named'];
-        selfRefKeys: F['selfRefKeys'] | PK;
-    }>;
-    build: (this: F['named'] extends true ? (CV extends V ? this : never) : never) => ObjectModel<V, EX, F['selfRefKeys']>;
-}
-export {};

package/builders.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"builders.js","sourceRoot":"","sources":["src/builders.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,aAAa,EACb,IAAI,EACJ,KAAK,EACL,KAAK,EACL,MAAM,GAKP,MAAM,YAAY,CAAC;AAEpB,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,MAAM,CAAC;AAS1C,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;AAgC/B,MAAM,OAAO,gBAAgB;IAKR,CAAC,MAAM,CAAC,CAAe;IAO1C,YAAY,IAAW,EAAE,oBAAiD;QACxE,IAAI,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;QAE5B,IAAI,oBAAoB,EAAE,CAAC;YACzB,IAAI,CAAC,oBAAoB,CAAC,oBAAoB,CAAC,CAAC;QAClD,CAAC;IACH,CAAC;IAQD,IAAI,CAAC,KAAoB;QACvB,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAC9B,OAAO,IAAI,CAAC;IACd,CAAC;IAeD,MAAM,CACJ,GAAO,EACP,KAAkC;QAElC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;QACzC,OAAO,IAAW,CAAC;IACrB,CAAC;IAWD,oBAAoB,CAAC,oBAAiD;QACpE,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE;YACzB,GAAG;gBACD,OAAO,oBAAoB,CAAC,IAAI,CAAC,CAAC;YACpC,CAAC;SACF,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAUD,IAAI,CAAC,IAAY;QACf,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAQ,CAAC;IACpD,CAAC;IAQD,KAAK;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC;IACtB,CAAC;CACF;AASD,MAAM,gBAAgB,GAAG,IAAI,OAAO,EAAgC,CAAC;AAarE,MAAM,OAAO,kBAKX,SAAQ,gBAA0B;IAClC,YAAY,IAAW;QACrB,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE;YAChB,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;YAG5B,KAAK,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC;gBACpB,cAAc,CAAC,MAAM,EAAE,GAAG,EAAE;oBAC1B,UAAU,EAAE,IAAI;oBAChB,GAAG,EAAE,GAAG,EAAE,CAAE,CAAC,CAAC,GAAyB,CAAW,CAAC,aAAa,CAAC;iBAClE,CAAC,CAAC;YACL,CAAC;YAED,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC,CAAC;IACL,CAAC;IAQD,MAAM,CAEJ,IAAY;QAEZ,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAQ,CAAC;IAChC,CAAC;IA8BD,QAAQ,CACN,GAAO,EACP,KAAiH,EACjH,OAAqC;QAsBrC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE;YAChC,UAAU,EAAE,IAAI;YAChB,GAAG;gBACD,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;oBAChC,gBAAgB,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;gBACjC,CAAC;gBAED,MAAM,KAAK,GAAG,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAE,CAAC;gBAE1C,KAAK,CAAC,GAAG,CAAC,KAAK,IAAI,gBAAgB,CACjC,OAAO,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAClD;qBACE,MAAM,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC;qBAC5B,MAAM,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;qBAC/B,MAAM,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;qBACvC,KAAK,EAAE,CAAC;gBAEX,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC;YACpB,CAAC;SACF,CAAC,CAAC;QAEH,OAAO,IAAW,CAAC;IACrB,CAAC;CAQF","sourcesContent":["import type { EmptyObject } from 'type-fest';\nimport type { ObjectModel } from './core';\nimport {\n  $defaultValue,\n  $key,\n  $meta,\n  $name,\n  $owner,\n  type AnyObject,\n  type DefaultValueProvider,\n  type Model,\n  type ModelMetadata,\n} from './model.js';\n\nconst { create, defineProperty } = Object;\n\n/**\n * The options for creating the model property.\n */\nexport type ModelBuilderPropertyOptions = Readonly<{\n  meta?: ModelMetadata;\n}>;\n\nconst $model = Symbol('model');\n\n/**\n * The flags for the model constructor that allow to determine specific characteristics of the model.\n */\nexport type Flags = {\n  /**\n   * Defines if the model is named.\n   */\n  named: boolean;\n\n  /**\n   * The keys of the self-referencing properties.\n   *\n   * @remarks\n   * The problem of self-reference models is that they cannot have intermediate\n   * type because during the property definition, the model itself is in the\n   * middle of construction. That's why we define the specific type-only flag\n   * that allows us to know which model properties are self-referenced. We can\n   * safely set it in the end of building using this flag.\n   */\n  selfRefKeys: keyof any;\n};\n\n/**\n * A builder class for creating all basic models.\n *\n * @typeParam V - The final value type of the model.\n * @typeParam EX - The extra properties of the model.\n * @typeParam F - The flags for the model constructor that allow to determine\n * specific characteristics of the model.\n */\nexport class CoreModelBuilder<\n  V,\n  EX extends AnyObject = EmptyObject,\n  F extends Flags = { named: false; selfRefKeys: never },\n> {\n  protected readonly [$model]: Model<V, EX>;\n\n  /**\n   * @param base - The base model to extend.\n   * @param defaultValueProvider - The function that provides the default value\n   * for the model.\n   */\n  constructor(base: Model, defaultValueProvider?: (model: Model<V, EX>) => V) {\n    this[$model] = create(base);\n\n    if (defaultValueProvider) {\n      this.defaultValueProvider(defaultValueProvider);\n    }\n  }\n\n  /**\n   * Appends metadata to the model.\n   *\n   * @param value - The metadata to append.\n   * @returns The current builder instance.\n   */\n  meta(value: ModelMetadata): this {\n    this.define($meta, { value });\n    return this;\n  }\n\n  /**\n   * Defines a new property on the model. The property serves the purposes of\n   * storing the extra data for specific types of models.\n   *\n   * @remarks\n   * The key of the property should be a symbol to avoid conflicts with\n   * properties defined via\n   * {@link ObjectModelBuilder}.\n   *\n   * @param key - The key of the property.\n   * @param value - The descriptor of the property.\n   * @returns The current builder instance.\n   */\n  define<DK extends symbol, DV>(\n    key: DK,\n    value: TypedPropertyDescriptor<DV>,\n  ): CoreModelBuilder<V, EX & Readonly<Record<DK, DV>>, F> {\n    defineProperty(this[$model], key, value);\n    return this as any;\n  }\n\n  /**\n   * Sets the default value provider for the model. This is an alternative way\n   * to provide the default value for the model if for some reason using the\n   * constructor parameter is undesired.\n   *\n   * @param defaultValueProvider - The function that provides the default value\n   * for the model.\n   * @returns The current builder instance.\n   */\n  defaultValueProvider(defaultValueProvider: DefaultValueProvider<V, EX>): this {\n    this.define($defaultValue, {\n      get(this: Model<V, EX>) {\n        return defaultValueProvider(this);\n      },\n    });\n    return this;\n  }\n\n  /**\n   * Sets the name of the model. The name is used for debugging purposes and is\n   * displayed in the string representation. Setting the name is required;\n   * otherwise, the {@link CoreModelBuilder.build} method won't be available.\n   *\n   * @param name - The name of the model.\n   * @returns The current builder instance.\n   */\n  name(name: string): CoreModelBuilder<V, EX, { named: true; selfRefKeys: F['selfRefKeys'] }> {\n    return this.define($name, { value: name }) as any;\n  }\n\n  /**\n   * Builds the model. On the typing level, it checks if all the model parts are\n   * set correctly, and raises an error if not.\n   *\n   * @returns The model.\n   */\n  build(this: F['named'] extends true ? this : never): Model<V, EX> {\n    return this[$model];\n  }\n}\n\n/**\n * A registry for the property models of the object model. Since the property\n * registration is lazy, we cannot store the property models directly on the\n * object model, so the registry plays a role of a private storage for them.\n *\n * @internal\n */\nconst propertyRegistry = new WeakMap<Model, Record<string, Model>>();\n\n/**\n * A builder class for creating object models.\n *\n * @typeParam V - The final value type of the model.\n * @typeParam CV - The current value type of the model. It changes as the model\n * is being built and defines if the\n * {@link ObjectModelBuilder.build} method can be called.\n * @typeParam EX - The extra properties of the model.\n * @typeParam F - The flags for the model constructor that allow to determine\n * specific characteristics of the model.\n */\nexport class ObjectModelBuilder<\n  V extends AnyObject,\n  CV extends AnyObject = EmptyObject,\n  EX extends AnyObject = EmptyObject,\n  F extends Flags = { named: false; selfRefKeys: never },\n> extends CoreModelBuilder<V, EX, F> {\n  constructor(base: Model) {\n    super(base, (m) => {\n      const result = create(null);\n\n      // eslint-disable-next-line no-restricted-syntax\n      for (const key in m) {\n        defineProperty(result, key, {\n          enumerable: true,\n          get: () => (m[key as keyof Model<V, EX>] as Model)[$defaultValue],\n        });\n      }\n\n      return result;\n    });\n  }\n\n  /**\n   * The method that should follow the {@link m.extend} method. It allows to\n   * declare the extension for the model and properly name it.\n   *\n   * @param name - The name of the model.\n   */\n  object<NV extends AnyObject>(\n    this: F['named'] extends false ? this : never,\n    name: string,\n  ): ObjectModelBuilder<NV & V, CV, EX, { named: true; selfRefKeys: F['selfRefKeys'] }> {\n    return this.name(name) as any;\n  }\n\n  /**\n   * {@inheritDoc CoreModelBuilder.define}\n   */\n  declare ['define']: <DK extends symbol, DV>(\n    key: DK,\n    value: TypedPropertyDescriptor<DV>,\n  ) => ObjectModelBuilder<V, CV, EX & Readonly<Record<DK, DV>>, F>;\n\n  /**\n   * {@inheritDoc CoreModelBuilder.meta}\n   */\n  declare ['meta']: (value: ModelMetadata) => this;\n\n  /**\n   * Defines a new model property on the model. Unlike the\n   * {@link ObjectModelBuilder.define}, this property is public and allows the\n   * user to interact with the model data structure. It also updates the current\n   * value type of the model to make it closer to the final value type.\n   *\n   * @param key - The key of the property.\n   * @param model - The model of the property value. You can also provide a\n   * function that produces the model based on the current model.\n   * @param options - Additional options for the property.\n   *\n   * @returns The current builder instance updated with the new property type.\n   * In case there is a self-referencing property, the {@link Flags.selfRefKeys}\n   * flag for the specific property is set.\n   */\n  property<PK extends string & keyof V, EXK extends AnyObject = EmptyObject>(\n    key: PK,\n    model: Model<V[PK], EXK> | ((model: Model<V, EX & Readonly<Record<PK, Model<V[PK], EXK>>>>) => Model<V[PK], EXK>),\n    options?: ModelBuilderPropertyOptions,\n  ): // It is a workaround for the self-referencing models.\n  // If the type of the model property is not the model itself,\n  Extract<V[PK], V> extends never\n    ? // Then we simply extend the model with the property, and update the\n      // current value type of the model.\n      ObjectModelBuilder<V, CV & Readonly<Record<PK, V[PK]>>, EX & Readonly<Record<PK, Model<V[PK], EXK>>>, F>\n    : // Otherwise, we set a flag of the model that it contains a self-reference\n      // property.\n      ObjectModelBuilder<\n        V,\n        CV & Readonly<Record<PK, V[PK]>>,\n        EX,\n        {\n          // Just inheriting the current flag.\n          named: F['named'];\n          // Adding the property name to all existing self-referencing\n          // properties.\n          // eslint-disable-next-line @typescript-eslint/no-redundant-type-constituents\n          selfRefKeys: F['selfRefKeys'] | PK;\n        }\n      > {\n    defineProperty(this[$model], key, {\n      enumerable: true,\n      get(this: Model<V, EX & Readonly<Record<PK, Model<V[PK], EXK>>>>) {\n        if (!propertyRegistry.has(this)) {\n          propertyRegistry.set(this, {});\n        }\n\n        const props = propertyRegistry.get(this)!;\n\n        props[key] ??= new CoreModelBuilder<V[PK], EXK, { named: true; selfRefKeys: never }>(\n          typeof model === 'function' ? model(this) : model,\n        )\n          .define($key, { value: key })\n          .define($owner, { value: this })\n          .define($meta, { value: options?.meta })\n          .build();\n\n        return props[key];\n      },\n    });\n\n    return this as any;\n  }\n\n  /**\n   * {@inheritDoc CoreModelBuilder.build}\n   */\n  declare build: (\n    this: F['named'] extends true ? (CV extends V ? this : never) : never,\n  ) => ObjectModel<V, EX, F['selfRefKeys']>;\n}\n"]}

package/core.d.ts

@@ -1,23 +0,0 @@
-import type { EmptyObject } from 'type-fest';
-import { $enum, $itemModel, type $members, type AnyObject, type Enum, Model, type Value } from './model.js';
-export type PrimitiveModel<V = unknown> = Model<V>;
-export declare const PrimitiveModel: Model<unknown, EmptyObject>;
-export type StringModel = PrimitiveModel<string>;
-export declare const StringModel: Model<string, EmptyObject>;
-export type NumberModel = PrimitiveModel<number>;
-export declare const NumberModel: Model<number, EmptyObject>;
-export type BooleanModel = PrimitiveModel<boolean>;
-export declare const BooleanModel: Model<boolean, EmptyObject>;
-export type ArrayModel<M extends Model = Model> = Model<Array<Value<M>>, Readonly<{
-    [$itemModel]: M;
-}>>;
-export declare const ArrayModel: Model<unknown[], EmptyObject & Readonly<Record<typeof $itemModel, Model<unknown, EmptyObject, never>>>>;
-export type ObjectModel<V, EX extends AnyObject = EmptyObject, R extends keyof any = never> = Model<V, EX, R>;
-export declare const ObjectModel: Model<Readonly<Record<never, never>>, EmptyObject>;
-export type EnumModel<T extends typeof Enum> = Model<T[keyof T], Readonly<{
-    [$enum]: T;
-}>>;
-export declare const EnumModel: Model<string, EmptyObject & Readonly<Record<typeof $enum, typeof Enum>>>;
-export type UnionModel<MM extends Model[]> = Model<Value<MM[number]>, Readonly<{
-    [$members]: MM;
-}>>;

package/core.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"core.js","sourceRoot":"","sources":["src/core.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,EAAE,KAAK,EAAE,UAAU,EAA4C,KAAK,EAAc,MAAM,YAAY,CAAC;AAM5G,MAAM,CAAC,MAAM,cAAc,GAAG,IAAI,gBAAgB,CAAC,KAAK,EAAE,GAAY,EAAE,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,KAAK,EAAE,CAAC;AAM9G,MAAM,CAAC,MAAM,WAAW,GAAG,IAAI,gBAAgB,CAAC,cAAc,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,CAAC;AAMjG,MAAM,CAAC,MAAM,WAAW,GAAG,IAAI,gBAAgB,CAAC,cAAc,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,CAAC;AAMhG,MAAM,CAAC,MAAM,YAAY,GAAG,IAAI,gBAAgB,CAAC,cAAc,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,CAAC;AAYtG,MAAM,CAAC,MAAM,UAAU,GAAG,IAAI,gBAAgB,CAAC,KAAK,EAAE,GAAc,EAAE,CAAC,EAAE,CAAC;KACvE,IAAI,CAAC,OAAO,CAAC;KACb,MAAM,CAAC,UAAU,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;KACpC,KAAK,EAAE,CAAC;AAOX,MAAM,CAAC,MAAM,WAAW,GAAG,IAAI,gBAAgB,CAAC,KAAK,EAAE,GAAc,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,CAAC;AAYrG,MAAM,CAAC,MAAM,SAAS,GAAG,IAAI,gBAAgB,CAAmC,KAAK,CAAC;KACnF,IAAI,CAAC,MAAM,CAAC;KAEZ,MAAM,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,EAAiB,EAAE,CAAC;KAC3C,oBAAoB,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;KAC7D,KAAK,EAAE,CAAC","sourcesContent":["import type { EmptyObject } from 'type-fest';\nimport { CoreModelBuilder } from './builders.js';\nimport { $enum, $itemModel, type $members, type AnyObject, type Enum, Model, type Value } from './model.js';\n\n/**\n * The model of a primitive value, like `string`, `number` or `boolean`.\n */\nexport type PrimitiveModel<V = unknown> = Model<V>;\nexport const PrimitiveModel = new CoreModelBuilder(Model, (): unknown => undefined).name('primitive').build();\n\n/**\n * The model of a string value.\n */\nexport type StringModel = PrimitiveModel<string>;\nexport const StringModel = new CoreModelBuilder(PrimitiveModel, () => '').name('string').build();\n\n/**\n * The model of a number value.\n */\nexport type NumberModel = PrimitiveModel<number>;\nexport const NumberModel = new CoreModelBuilder(PrimitiveModel, () => 0).name('number').build();\n\n/**\n * The model of a boolean value.\n */\nexport type BooleanModel = PrimitiveModel<boolean>;\nexport const BooleanModel = new CoreModelBuilder(PrimitiveModel, () => false).name('boolean').build();\n\n/**\n * The model of an array data.\n */\nexport type ArrayModel<M extends Model = Model> = Model<\n  Array<Value<M>>,\n  Readonly<{\n    [$itemModel]: M;\n  }>\n>;\n\nexport const ArrayModel = new CoreModelBuilder(Model, (): unknown[] => [])\n  .name('Array')\n  .define($itemModel, { value: Model })\n  .build();\n\n/**\n * The model of an object data.\n */\nexport type ObjectModel<V, EX extends AnyObject = EmptyObject, R extends keyof any = never> = Model<V, EX, R>;\n\nexport const ObjectModel = new CoreModelBuilder(Model, (): AnyObject => ({})).name('Object').build();\n\n/**\n * The model of an enum data.\n */\nexport type EnumModel<T extends typeof Enum> = Model<\n  T[keyof T],\n  Readonly<{\n    [$enum]: T;\n  }>\n>;\n\nexport const EnumModel = new CoreModelBuilder<(typeof Enum)[keyof typeof Enum]>(Model)\n  .name('Enum')\n  // eslint-disable-next-line @typescript-eslint/consistent-type-assertions\n  .define($enum, { value: {} as typeof Enum })\n  .defaultValueProvider((self) => Object.values(self[$enum])[0])\n  .build();\n\n/**\n * The model of a union data.\n */\nexport type UnionModel<MM extends Model[]> = Model<Value<MM[number]>, Readonly<{ [$members]: MM }>>;\n"]}

package/model.d.ts

@@ -1,49 +0,0 @@
-import type { EmptyObject } from 'type-fest';
-export interface JvmTypeRef {
-    jvmType: string;
-    genericArguments?: JvmTypeRef[];
-}
-export type AnnotationValue = AnnotationValue[] | JvmTypeRef | boolean | number | string | undefined;
-export interface Annotation {
-    jvmType: string;
-    arguments: Record<string, AnnotationValue>;
-}
-export interface ModelMetadata {
-    jvmType?: string;
-    annotations?: Annotation[];
-}
-export type Target<T = unknown> = Readonly<{
-    model?: Model<T>;
-    value: T;
-}>;
-export declare const nothing: unique symbol;
-export declare enum Enum {
-}
-export type AnyObject = Readonly<Record<never, never>>;
-export declare const $key: unique symbol;
-export declare const $name: unique symbol;
-export declare const $owner: unique symbol;
-export declare const $meta: unique symbol;
-export declare const $optional: unique symbol;
-export declare const $defaultValue: unique symbol;
-export declare const $enum: unique symbol;
-export declare const $members: unique symbol;
-export declare const $itemModel: unique symbol;
-export type Value<M extends Model> = M extends Model<infer T> ? T : never;
-export type Extensions<M extends Model> = M extends Model<unknown, infer EX> ? EX : EmptyObject;
-export type References<M extends Model> = M extends Model<unknown, AnyObject, infer R> ? R : never;
-export type Model<V = unknown, EX extends AnyObject = EmptyObject, R extends keyof any = never> = EX & Readonly<{
-    [P in R]: Model<V, EX, R>;
-}> & Readonly<{
-    [$key]: keyof any;
-    [$name]: string;
-    [$owner]: Model | Target;
-    [$meta]?: ModelMetadata;
-    [$optional]: boolean;
-    [$defaultValue]: V;
-    [Symbol.toStringTag]: string;
-    [Symbol.hasInstance](value: any): value is Model<V, EX, R>;
-    toString(): string;
-}>;
-export type DefaultValueProvider<V, EX extends AnyObject = EmptyObject, R extends keyof any = never> = (model: Model<V, EX, R>) => V;
-export declare const Model: Model;

package/model.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"model.js","sourceRoot":"","sources":["src/model.ts"],"names":[],"mappings":"AA+BA,MAAM,CAAC,MAAM,OAAO,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;AAEzC,MAAM,cAAc,GAAW,MAAM,CAAC,MAAM,CAC1C;IACE,QAAQ,EAAE,GAAG,EAAE,CAAC,YAAY;CAC7B,EACD;IACE,KAAK,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE;IAC3B,KAAK,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE;CAC1B,CACF,CAAC;AAUF,MAAM,CAAC,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;AAKlC,MAAM,CAAC,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;AAKpC,MAAM,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;AAKtC,MAAM,CAAC,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;AAKpC,MAAM,CAAC,MAAM,SAAS,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;AAK5C,MAAM,CAAC,MAAM,aAAa,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;AAK7C,MAAM,CAAC,MAAM,KAAK,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;AAKzC,MAAM,CAAC,MAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;AAK1C,MAAM,CAAC,MAAM,UAAU,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;AAuF9C,MAAM,CAAC,MAAM,KAAK,GAAU,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE;IAC9C,CAAC,IAAI,CAAC,EAAE;QACN,KAAK,EAAE,OAAO;KACf;IACD,CAAC,KAAK,CAAC,EAAE;QACP,KAAK,EAAE,OAAO;KACf;IACD,CAAC,MAAM,CAAC,EAAE;QACR,KAAK,EAAE,cAAc;KACtB;IACD,CAAC,KAAK,CAAC,EAAE,EAAE;IACX,CAAC,SAAS,CAAC,EAAE;QACX,KAAK,EAAE,KAAK;KACb;IACD,CAAC,aAAa,CAAC,EAAE,EAAE;IACnB,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE;QACpB,GAAG;YACD,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC;QACrB,CAAC;KACF;IACD,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE;QACpB,KAAK,CAAc,CAAU;YAC3B,OAAO,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,CAAC,IAAI,MAAM,CAAC,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QAC5G,CAAC;KACF;IACD,QAAQ,EAAE;QACR,KAAK;YAEH,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACzG,CAAC;KACF;CACF,CAAC,CAAC","sourcesContent":["import type { EmptyObject } from 'type-fest';\n\nexport interface JvmTypeRef {\n  jvmType: string;\n  genericArguments?: JvmTypeRef[];\n}\n\nexport type AnnotationValue = AnnotationValue[] | JvmTypeRef | boolean | number | string | undefined;\n\nexport interface Annotation {\n  jvmType: string;\n  arguments: Record<string, AnnotationValue>;\n}\n\n/**\n * The metadata of a model.\n */\nexport interface ModelMetadata {\n  jvmType?: string;\n  annotations?: Annotation[];\n}\n\n/**\n * The target to which a model is attached. It could be a Binder instance, a\n * Signal or another object. However, it could never be another model.\n */\nexport type Target<T = unknown> = Readonly<{\n  model?: Model<T>;\n  value: T;\n}>;\n\nexport const nothing = Symbol('nothing');\n\nconst detachedTarget: Target = Object.create(\n  {\n    toString: () => ':detached:',\n  },\n  {\n    model: { value: undefined },\n    value: { value: nothing },\n  },\n);\n\nexport declare enum Enum {}\n\nexport type AnyObject = Readonly<Record<never, never>>; // {}\n\n/* eslint-disable tsdoc/syntax */\n/**\n * The symbol that represents the {@link Model[$key]} property.\n */\nexport const $key = Symbol('key');\n\n/**\n * The symbol that represents the {@link Model[$name]} property.\n */\nexport const $name = Symbol('name');\n\n/**\n * The symbol that represents the {@link Model[$owner]} property.\n */\nexport const $owner = Symbol('owner');\n\n/**\n * The symbol that represents the {@link Model[$meta]} property.\n */\nexport const $meta = Symbol('meta');\n\n/**\n * The symbol that represents the {@link Model[$optional]} property.\n */\nexport const $optional = Symbol('optional');\n\n/**\n * The symbol that represents the {@link Model[$value]} property.\n */\nexport const $defaultValue = Symbol('value');\n\n/**\n * The symbol that represents the {@link EnumModel[$enumerate]} property.\n */\nexport const $enum = Symbol('enumerate');\n\n/**\n * The symbol that represents the {@link UnionModel[$members]} property.\n */\nexport const $members = Symbol('members');\n\n/**\n * The symbol that represents the {@link ArrayModel[$itemModel]} property.\n */\nexport const $itemModel = Symbol('itemModel');\n\n/* eslint-enable tsdoc/syntax */\n\n/**\n * Extracts the value type the model represents.\n */\nexport type Value<M extends Model> = M extends Model<infer T> ? T : never;\n\n/**\n * Extracts the list of extra properties of the model.\n */\nexport type Extensions<M extends Model> = M extends Model<unknown, infer EX> ? EX : EmptyObject;\n\n/**\n * Extracts the list of self-referencing properties of the model.\n */\nexport type References<M extends Model> = M extends Model<unknown, AnyObject, infer R> ? R : never;\n\n/**\n * A model that represents a specific type of data.\n *\n * @typeParam V - The type of the data described by the model.\n * @typeParam EX - The extra properties of the model. It could be either a model\n * that represents a property of the object the current model describe, or a\n * model-specific metadata. It's recommended to use a symbol as a key for the\n * metadata property to avoid the potential naming conflicts with the described\n * object properties.\n * @typeParam R - The keys of the self-referencing properties of the model.\n *\n * @remarks\n * Since we know the full model definition only on this step, the `R` type\n * parameter is essential to describe a model with self-reference properties.\n */\nexport type Model<V = unknown, EX extends AnyObject = EmptyObject, R extends keyof any = never> = EX &\n  Readonly<{\n    [P in R]: Model<V, EX, R>;\n  }> &\n  Readonly<{\n    /**\n     * The key of the model in the owner model.\n     */\n    [$key]: keyof any;\n\n    /**\n     * The name of the model. For attached models, the name will be prefixed\n     * with the `@` symbol.\n     */\n    [$name]: string;\n\n    /**\n     * The owner model of the model. For detached models, the owner will always\n     * be a specific global object `detachedTarget`.\n     */\n    [$owner]: Model | Target;\n\n    /**\n     * The metadata of the model.\n     */\n    [$meta]?: ModelMetadata;\n\n    /**\n     * Whether the model is optional. It describes if the data described by\n     * this model is nullable.\n     */\n    [$optional]: boolean;\n\n    /**\n     * The default value of the model.\n     */\n    [$defaultValue]: V;\n    [Symbol.toStringTag]: string;\n    [Symbol.hasInstance](value: any): value is Model<V, EX, R>;\n    toString(): string;\n  }>;\n\n/**\n * A function that provides a default value for a model.\n *\n * @typeParam V - The type of the data described by the model.\n * @typeParam EX - The extra properties of the model.\n * @typeParam R - The keys of the self-referencing properties of the model.\n */\nexport type DefaultValueProvider<V, EX extends AnyObject = EmptyObject, R extends keyof any = never> = (\n  model: Model<V, EX, R>,\n) => V;\n\nexport const Model: Model = Object.create(null, {\n  [$key]: {\n    value: 'model',\n  },\n  [$name]: {\n    value: 'Model',\n  },\n  [$owner]: {\n    value: detachedTarget,\n  },\n  [$meta]: {},\n  [$optional]: {\n    value: false,\n  },\n  [$defaultValue]: {},\n  [Symbol.toStringTag]: {\n    get(this: Model) {\n      return this[$name];\n    },\n  },\n  [Symbol.hasInstance]: {\n    value(this: Model, o: unknown) {\n      return typeof o === 'object' && o != null && (this === o || Object.prototype.isPrototypeOf.call(this, o));\n    },\n  },\n  toString: {\n    value(this: Model) {\n      // eslint-disable-next-line @typescript-eslint/no-base-to-string\n      return `[${String(this[$owner])} / ${String(this[$key])}${this[$optional] ? '?' : ''}] ${this[$name]}`;\n    },\n  },\n});\n"]}