@burnsred/entity 0.6.1 → 1.0.0

package/README.md

@@ -1 +1,174 @@
-# @burnsred/entity
+# Entity
+
+The Entity package provides the fundamental Entity class and it supporting
+utilities.
+
+An Entity is used to provide cleaned, validated data records.
+
+## Defining an Entity
+
+```js
+import { Entity, CharField } from "@burnsred/entity";
+
+type User {
+    username: string;
+    email: string;
+    name?: string;
+}
+
+const UserEntity = new Entity<User>({
+    idField: 'username',
+    fields: {
+        username: new CharField(),
+        email: new CharField(),
+        name: new CharField({ blank: true }),
+    }
+});
+```
+
+Once your entity is defined, you can use it to construct an `User` from
+API response data:
+
+```js
+const rec = UserEntity.fromData(data);
+```
+
+## Declaring Fields
+
+Each field can specify its own list of validators and cleaners.
+
+Cleaners are used to cast input values from the User to the right type.
+
+Validators are used to check supplied values, and emit Errors.
+
+```js
+fields: {
+    uuid: new CharField({ cleaners=[trim] }),
+    size: new IntegerField({ validators=[maxValue(10)] })
+}
+```
+
+### Common field arguments.
+
+blank (boolean) false
+:   Is this field allowed to be omitted?
+
+cleaners (FieldCleaner[])
+:   A list of cleaners to apply when cleaning an record.
+
+validators (FieldValidator[])
+:    A list of validators to apply when validating an record.
+
+many (boolean) false
+:   If true, the value for this field is an array of values of its type.
+
+choices (any) []
+:    A list of valid choices. Can help with select lists.
+
+defaultValue
+:   Override the field's default value.
+
+Any extra properties passed will be stored in the `extra` property.
+
+## Cleaners
+
+Cleaner functions are primarily used for cleaning and casting data coming from
+the User.
+
+Since most HTML Input fields work with string values, many `Field`s will
+default to using a cleaner which casts to the correct type.
+
+## Validators
+
+Validator functions are used to check constraints, emitting FieldErrors to
+identify problems.
+
+They can be specified either on the Field or Entitly.
+
+Field validators are passed the value for that specific field, and are called
+with `this` being the Field.
+
+Entity validators are passed the whole record, and are called with `this` being
+the Entity.
+
+As an example, here is an Entity validator that ensures the start date is
+before the end date:
+
+```js
+function dateRange(record) {
+    const start = record.get("start_date");
+    const end = record.get("end_date");
+
+    if (start.valueOf() >= end.valueOf()) {
+        return {
+            code: "date-range",
+            message: "Start date must be before End date.",
+        };
+    }
+}
+```
+
+# Errors
+
+Managing and handling validation errors requires records to contain them.
+
+An individual validation error consists of a `code`, user meangful `message`,
+and possibly some additional `details`.
+
+For a scalar field, this can be managed as a list of such objects.
+
+For vector values (i.e. many=True) a list of lists will suffice. Extracting
+errors for a given position is as simple as indexing.
+
+For an `EntityField`, a mapping is used, instead. Each value, keyed by
+sub-field name, reflects the structure appropriate as described.
+
+```js
+IntegerField.validate("1") // [{ code: 'type', message: 'Value must be a number' }]
+
+EntityField.validate({ ... }) // { field: [...], ...}
+```
+
+From the top down, an Entity will get errors by looking into the Error map for
+the field name.
+
+The values will be either a list of Errors, a list-of-lists of Errors, or
+another map.
+
+# A more complex example
+
+Here's an example showing an Entity with a nested Entity as a field.
+
+```js
+type Post = {
+  id: number;
+  user: User;
+  posted: Date;
+  content: string;
+  public: boolean;
+}
+
+
+const PostEntity = new Entity<Post>({
+  fields={
+    id: IntegerField(),
+    user: EntityField<Post>({ entity: UserEntity }),
+    posted: DateField(),
+    content: TextField(),
+    public: BooleanField({ defaultVaule: false }),
+  }
+})
+```
+
+Now any record created by this Entity will contain a nested record in the `user`
+field.
+
+```js
+
+const post = PostEntity.fromData(...);
+
+...
+
+const errors = UserEntity.validate(post.user);
+
+```

package/dist/cleaner/as-boolean.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Cleaner function which casts the value to a Boolean
+ *
+ * @param value
+ * @returns boolean
+ */
+export default function asBoolean(value: unknown): boolean;

package/dist/cleaner/as-boolean.js

@@ -0,0 +1,10 @@
+/**
+ * Cleaner function which casts the value to a Boolean
+ *
+ * @param value
+ * @returns boolean
+ */
+export default function asBoolean(value) {
+    return Boolean(value);
+}
+//# sourceMappingURL=as-boolean.js.map

package/dist/cleaner/as-boolean.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"as-boolean.js","sourceRoot":"","sources":["../../src/cleaner/as-boolean.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,SAAS,CAAC,KAAc;IAC9C,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC;AACxB,CAAC"}

package/dist/cleaner/as-date.d.ts

@@ -0,0 +1 @@
+export default function asDate(value: unknown): Date | null;

package/dist/cleaner/as-date.js

@@ -0,0 +1,5 @@
+export default function asDate(value) {
+    const ts = Date.parse(value);
+    return isNaN(ts) ? null : new Date(ts);
+}
+//# sourceMappingURL=as-date.js.map

package/dist/cleaner/as-date.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"as-date.js","sourceRoot":"","sources":["../../src/cleaner/as-date.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,UAAU,MAAM,CAAC,KAAc;IAC3C,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,KAAe,CAAC,CAAC;IAEvC,OAAO,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,EAAE,CAAC,CAAC;AACzC,CAAC"}

package/dist/cleaner/as-integer.d.ts

@@ -0,0 +1 @@
+export default function asInteger(value: unknown): number | null;

package/dist/cleaner/as-integer.js

@@ -0,0 +1,5 @@
+export default function asInteger(value) {
+    const val = Number.parseInt(value, 10);
+    return Number.isNaN(val) ? null : val;
+}
+//# sourceMappingURL=as-integer.js.map

package/dist/cleaner/as-integer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"as-integer.js","sourceRoot":"","sources":["../../src/cleaner/as-integer.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,UAAU,SAAS,CAAC,KAAc;IAC9C,MAAM,GAAG,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAe,EAAE,EAAE,CAAC,CAAC;IAEjD,OAAO,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC;AACxC,CAAC"}

package/dist/cleaner/as-number.d.ts

@@ -0,0 +1 @@
+export default function asNumber(value: unknown): number | null;

package/dist/cleaner/as-number.js

@@ -0,0 +1,5 @@
+export default function asNumber(value) {
+    const val = Number.parseFloat(value);
+    return Number.isNaN(val) ? null : val;
+}
+//# sourceMappingURL=as-number.js.map

package/dist/cleaner/as-number.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"as-number.js","sourceRoot":"","sources":["../../src/cleaner/as-number.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,UAAU,QAAQ,CAAC,KAAc;IAC7C,MAAM,GAAG,GAAG,MAAM,CAAC,UAAU,CAAC,KAAe,CAAC,CAAC;IAE/C,OAAO,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC;AACxC,CAAC"}

package/dist/cleaner/as-string.d.ts

@@ -0,0 +1 @@
+export default function asString(value: unknown): string;

package/dist/cleaner/as-string.js

@@ -0,0 +1,4 @@
+export default function asString(value) {
+    return value.toString();
+}
+//# sourceMappingURL=as-string.js.map

package/dist/cleaner/as-string.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"as-string.js","sourceRoot":"","sources":["../../src/cleaner/as-string.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,UAAU,QAAQ,CAAC,KAAc;IAC7C,OAAQ,KAAgB,CAAC,QAAQ,EAAE,CAAC;AACtC,CAAC"}

package/dist/cleaner/collapse-spaces.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Replaces multiple whitespace characters within a string with a single space.
+ */
+export default function collapseSpaces(value: unknown): string;

package/dist/cleaner/collapse-spaces.js

@@ -0,0 +1,7 @@
+/**
+ * Replaces multiple whitespace characters within a string with a single space.
+ */
+export default function collapseSpaces(value) {
+    return value.replace(/\s\s+/g, ' ');
+}
+//# sourceMappingURL=collapse-spaces.js.map

package/dist/cleaner/collapse-spaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"collapse-spaces.js","sourceRoot":"","sources":["../../src/cleaner/collapse-spaces.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,OAAO,UAAU,cAAc,CAAC,KAAc;IACnD,OAAQ,KAAgB,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;AAClD,CAAC"}

package/dist/cleaner/index.d.ts

@@ -0,0 +1,7 @@
+export { default as collapseSpaces } from './collapse-spaces';
+export { default as asString } from './as-string';
+export { default as asBoolean } from './as-boolean';
+export { default as asNumber } from './as-number';
+export { default as asInteger } from './as-integer';
+export { default as trim } from './trim';
+export { default as asDate } from './as-date';

package/dist/cleaner/index.js

@@ -0,0 +1,8 @@
+export { default as collapseSpaces } from './collapse-spaces';
+export { default as asString } from './as-string';
+export { default as asBoolean } from './as-boolean';
+export { default as asNumber } from './as-number';
+export { default as asInteger } from './as-integer';
+export { default as trim } from './trim';
+export { default as asDate } from './as-date';
+//# sourceMappingURL=index.js.map

package/dist/cleaner/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/cleaner/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,cAAc,CAAC;AACpD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,cAAc,CAAC;AACpD,OAAO,EAAE,OAAO,IAAI,IAAI,EAAE,MAAM,QAAQ,CAAC;AACzC,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,WAAW,CAAC"}

package/dist/cleaner/trim.d.ts

@@ -0,0 +1 @@
+export default function trim(value: unknown): unknown;

package/dist/cleaner/trim.js

@@ -0,0 +1,4 @@
+export default function trim(value) {
+    return value.trim();
+}
+//# sourceMappingURL=trim.js.map

package/dist/cleaner/trim.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"trim.js","sourceRoot":"","sources":["../../src/cleaner/trim.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,UAAU,IAAI,CAAC,KAAc;IACzC,OAAQ,KAAgB,CAAC,IAAI,EAAE,CAAC;AAClC,CAAC"}

package/dist/entity/Entity.d.ts

@@ -0,0 +1,20 @@
+import type { EntityRecordCleaner, EntityRecordValidator, EntityType, FieldErrorMap } from '..';
+import { EntityField, type FieldConstructorParams, type FieldType } from '../field';
+type EntityConstructorParams<T> = Pick<EntityType<T>, 'idField' | 'fields'> & Partial<Pick<EntityType<T>, 'cleaners' | 'validators'>>;
+export default class Entity<T> implements EntityType<T> {
+    idField: keyof T;
+    fields: {
+        [F in keyof T]: FieldType<T[F]>;
+    };
+    cleaners: EntityRecordCleaner<T>[];
+    validators: EntityRecordValidator<T>[];
+    extra: object;
+    constructor({ idField, fields, cleaners, validators, ...extra }: EntityConstructorParams<T>);
+    fromData(data: Record<string, unknown>): T;
+    toData(record: T): Record<string, unknown>;
+    clean(record: T): T;
+    validate(record: T): FieldErrorMap;
+    getId(record?: T): string | undefined;
+    getEntityField(options?: FieldConstructorParams<T>): EntityField<T>;
+}
+export {};

package/dist/entity/Entity.js

@@ -0,0 +1,63 @@
+import { EntityField, } from '../field';
+export default class Entity {
+    idField;
+    fields;
+    cleaners;
+    validators;
+    extra;
+    constructor({ idField, fields, cleaners = [], validators = [], ...extra }) {
+        this.idField = idField;
+        this.fields = fields;
+        this.cleaners = cleaners;
+        this.validators = validators;
+        this.extra = extra;
+        // Set field names
+        Object.entries(this.fields).forEach(([fieldName, field]) => (field.name = fieldName));
+    }
+    fromData(data) {
+        return Object.fromEntries(Object.entries(this.fields).map(([fieldName, field]) => [
+            fieldName,
+            fieldName in data
+                ? field.fromData(data[fieldName])
+                : field.default({ data }),
+        ]));
+    }
+    toData(record) {
+        const result = {};
+        Object.entries(this.fields).forEach(([fieldName, field]) => {
+            if (field.readOnly)
+                return;
+            result[fieldName] = field.toData(record[fieldName]);
+        });
+        return result;
+    }
+    clean(record) {
+        record = Object.values(this.fields).reduce(
+        // TS can't infer the type of Field.clean()
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
+        (curr, field) => {
+            curr[field.name] = field.clean(curr[field.name]);
+            return curr;
+        }, record);
+        return this.cleaners.reduce((curr, cleaner) => cleaner.call(this, curr), record);
+    }
+    validate(record) {
+        const errors = Object.fromEntries(Object.entries(this.fields)
+            .map(([fieldName, field]) => [
+            fieldName,
+            field.validate(record[fieldName]),
+        ])
+            // Remove empty entries
+            .filter(([_name, err]) => Array.isArray(err) ? err.length : err !== undefined));
+        this.validators.forEach((validator) => validator(record, errors));
+        return errors;
+    }
+    getId(record) {
+        return record == null ? undefined : record[this.idField];
+    }
+    getEntityField(options = {}) {
+        return new EntityField({ entity: this, ...options });
+    }
+}
+//# sourceMappingURL=Entity.js.map

package/dist/entity/Entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Entity.js","sourceRoot":"","sources":["../../src/entity/Entity.ts"],"names":[],"mappings":"AAMA,OAAO,EACL,WAAW,GAGZ,MAAM,UAAU,CAAC;AAKlB,MAAM,CAAC,OAAO,OAAO,MAAM;IACzB,OAAO,CAAU;IACjB,MAAM,CAAsC;IAC5C,QAAQ,CAA2B;IACnC,UAAU,CAA6B;IACvC,KAAK,CAAS;IAEd,YAAY,EACV,OAAO,EACP,MAAM,EACN,QAAQ,GAAG,EAAE,EACb,UAAU,GAAG,EAAE,EACf,GAAG,KAAK,EACmB;QAC3B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QAEnB,kBAAkB;QAClB,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CACjC,CAAC,CAAC,SAAS,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAE,KAA4B,CAAC,IAAI,GAAG,SAAS,CAAC,CACzE,CAAC;IACJ,CAAC;IAED,QAAQ,CAAC,IAA6B;QACpC,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC;YACtD,SAAS;YACT,SAAS,IAAI,IAAI;gBACf,CAAC,CAAE,KAA4B,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBACzD,CAAC,CAAE,KAA4B,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,CAAC;SACpD,CAAC,CACE,CAAC;IACT,CAAC;IAED,MAAM,CAAC,MAAS;QACd,MAAM,MAAM,GAA4B,EAAE,CAAC;QAE3C,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,EAAE,KAAK,CAAC,EAAE,EAAE;YACzD,IAAK,KAA4B,CAAC,QAAQ;gBAAE,OAAO;YACnD,MAAM,CAAC,SAAS,CAAC,GAAI,KAA4B,CAAC,MAAM,CACtD,MAAM,CAAC,SAAoB,CAAC,CAC7B,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,MAAS;QACb,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM;QACxC,2CAA2C;QAC3C,6DAA6D;QAC7D,aAAa;QACb,CAAC,IAAO,EAAE,KAAgB,EAAE,EAAE;YAC5B,IAAI,CAAC,KAAK,CAAC,IAAe,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAe,CAAC,CAAC,CAAC;YACvE,OAAO,IAAI,CAAC;QACd,CAAC,EACD,MAAM,CACF,CAAC;QAEP,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CACzB,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,EAC3C,MAAM,CACP,CAAC;IACJ,CAAC;IAED,QAAQ,CAAC,MAAS;QAChB,MAAM,MAAM,GAAkB,MAAM,CAAC,WAAW,CAC9C,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC;aACxB,GAAG,CAAC,CAAC,CAAC,SAAS,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC;YAC3B,SAAS;YACR,KAA4B,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAoB,CAAC,CAAC;SACrE,CAAC;YACF,uBAAuB;aACtB,MAAM,CAAC,CAAC,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,EAAE,CACvB,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,KAAK,SAAS,CACpD,CACJ,CAAC;QAEF,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;QAElE,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,MAAU;QACd,OAAO,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAY,CAAC;IACvE,CAAC;IAED,cAAc,CAAC,UAAqC,EAAE;QACpD,OAAO,IAAI,WAAW,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvD,CAAC;CACF"}

package/dist/entity/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Cleaners provide casting and conversion functions for user input.
+ *
+ * This may include type conversion, whitespace trimming/normalising, etc.
+ *
+ * It does not include validation, and can not yield errors.
+ */
+export { default as Entity } from './Entity';

package/dist/entity/index.js

@@ -0,0 +1,9 @@
+/**
+ * Cleaners provide casting and conversion functions for user input.
+ *
+ * This may include type conversion, whitespace trimming/normalising, etc.
+ *
+ * It does not include validation, and can not yield errors.
+ */
+export { default as Entity } from './Entity';
+//# sourceMappingURL=index.js.map

package/dist/entity/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/entity/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,UAAU,CAAC"}

package/dist/field/BooleanField.d.ts

@@ -0,0 +1,7 @@
+import { asBoolean } from '../cleaner';
+import { Field } from '.';
+export declare class BooleanField extends Field<boolean> {
+    static defaultValue: boolean;
+    static defaultCleaners: (typeof asBoolean)[];
+    type: string;
+}

package/dist/field/BooleanField.js

@@ -0,0 +1,8 @@
+import { asBoolean } from '../cleaner';
+import { Field } from '.';
+export class BooleanField extends Field {
+    static defaultValue = false;
+    static defaultCleaners = [asBoolean];
+    type = 'boolean';
+}
+//# sourceMappingURL=BooleanField.js.map

package/dist/field/BooleanField.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BooleanField.js","sourceRoot":"","sources":["../../src/field/BooleanField.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,CAAC;AAE1B,MAAM,OAAO,YAAa,SAAQ,KAAc;IAC9C,MAAM,CAAC,YAAY,GAAG,KAAK,CAAC;IAC5B,MAAM,CAAC,eAAe,GAAG,CAAC,SAAS,CAAC,CAAC;IAErC,IAAI,GAAG,SAAS,CAAC"}

package/dist/field/CharField.d.ts

@@ -0,0 +1,7 @@
+import { asString } from '../cleaner';
+import { Field } from '.';
+export declare class CharField extends Field<string> {
+    static defaultValue: string;
+    static defaultCleaners: (typeof asString)[];
+    type: string;
+}

package/dist/field/CharField.js

@@ -0,0 +1,8 @@
+import { asString } from '../cleaner';
+import { Field } from '.';
+export class CharField extends Field {
+    static defaultValue = '';
+    static defaultCleaners = [asString];
+    type = 'char';
+}
+//# sourceMappingURL=CharField.js.map

package/dist/field/CharField.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CharField.js","sourceRoot":"","sources":["../../src/field/CharField.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,CAAC;AAE1B,MAAM,OAAO,SAAU,SAAQ,KAAa;IAC1C,MAAM,CAAC,YAAY,GAAG,EAAE,CAAC;IACzB,MAAM,CAAC,eAAe,GAAG,CAAC,QAAQ,CAAC,CAAC;IAEpC,IAAI,GAAG,MAAM,CAAC"}

package/dist/field/DateField.d.ts

@@ -0,0 +1,9 @@
+import { asDate } from '../cleaner';
+import { Field } from '.';
+export declare class DateField extends Field<Date | null> {
+    static defaultValue: null;
+    static defaultCleaners: (typeof asDate)[];
+    type: string;
+    fromData(value: unknown): Date | null;
+    toData(value: Date | null): unknown;
+}

package/dist/field/DateField.js

@@ -0,0 +1,19 @@
+import { asDate } from '../cleaner';
+import { Field } from '.';
+export class DateField extends Field {
+    static defaultValue = null;
+    static defaultCleaners = [asDate];
+    type = 'date';
+    fromData(value) {
+        return asDate(value);
+    }
+    toData(value) {
+        // toISOString always converts to UTC
+        // We must adjust our timezone accordingly, lest we send the wrong date
+        if (value instanceof Date) {
+            value.setMinutes(value.getMinutes() - value.getTimezoneOffset());
+        }
+        return value ? value.toISOString().split('T')[0] : '';
+    }
+}
+//# sourceMappingURL=DateField.js.map

package/dist/field/DateField.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DateField.js","sourceRoot":"","sources":["../../src/field/DateField.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEpC,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,CAAC;AAE1B,MAAM,OAAO,SAAU,SAAQ,KAAkB;IAC/C,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC;IAC3B,MAAM,CAAC,eAAe,GAAG,CAAC,MAAM,CAAC,CAAC;IAElC,IAAI,GAAG,MAAM,CAAC;IAEd,QAAQ,CAAC,KAAc;QACrB,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC;IAED,MAAM,CAAC,KAAkB;QACvB,qCAAqC;QACrC,uEAAuE;QACvE,IAAI,KAAK,YAAY,IAAI,EAAE;YACzB,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,UAAU,EAAE,GAAG,KAAK,CAAC,iBAAiB,EAAE,CAAC,CAAC;SAClE;QACD,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACxD,CAAC"}

package/dist/field/DateTimeField.d.ts

@@ -0,0 +1,9 @@
+import { asDate } from '../cleaner';
+import { Field } from '.';
+export declare class DateTimeField extends Field<Date | null> {
+    static defaultValue: null;
+    static defaultCleaners: (typeof asDate)[];
+    type: string;
+    fromData(value: unknown): Date | null;
+    toData(value: Date | null): unknown;
+}

package/dist/field/DateTimeField.js

@@ -0,0 +1,14 @@
+import { asDate } from '../cleaner';
+import { Field } from '.';
+export class DateTimeField extends Field {
+    static defaultValue = null;
+    static defaultCleaners = [asDate];
+    type = 'date';
+    fromData(value) {
+        return asDate(value);
+    }
+    toData(value) {
+        return value ? value.toISOString() : '';
+    }
+}
+//# sourceMappingURL=DateTimeField.js.map

package/dist/field/DateTimeField.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DateTimeField.js","sourceRoot":"","sources":["../../src/field/DateTimeField.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEpC,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,CAAC;AAE1B,MAAM,OAAO,aAAc,SAAQ,KAAkB;IACnD,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC;IAC3B,MAAM,CAAC,eAAe,GAAG,CAAC,MAAM,CAAC,CAAC;IAElC,IAAI,GAAG,MAAM,CAAC;IAEd,QAAQ,CAAC,KAAc;QACrB,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC;IAED,MAAM,CAAC,KAAkB;QACvB,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1C,CAAC"}

package/dist/field/EntityField.d.ts

@@ -0,0 +1,22 @@
+import { type EntityType, type ErrorSet, type FieldErrorMap, type ValidatorResult } from '..';
+import { Field } from '.';
+import type { FieldConstructorParams, FieldType } from '.';
+type EntityFieldConstructorParams<T> = FieldConstructorParams<T> & {
+    entity: EntityType<T>;
+};
+export declare class EntityField<T> extends Field<T> {
+    type: string;
+    entity: EntityType<T>;
+    constructor({ entity, ...options }: EntityFieldConstructorParams<T>);
+    getValue(value: T, key?: string | number): T | NonNullable<T>[keyof T];
+    validate(value: unknown): ValidatorResult;
+    /**
+     * EntityField is a special case.
+     *
+     * A Form Input may be asking us for the errors of a specific field.
+     */
+    getErrors(errors: FieldErrorMap, key?: number | string): ErrorSet;
+    getId(value?: T): string | undefined;
+    getField(name: keyof T): FieldType<T[keyof T]>;
+}
+export {};

package/dist/field/EntityField.js

@@ -0,0 +1,55 @@
+import { Field } from '.';
+export class EntityField extends Field {
+    type = 'entity';
+    entity;
+    constructor({ entity, ...options }) {
+        super(options);
+        this.entity = entity;
+    }
+    getValue(value, key) {
+        if (!value)
+            return value;
+        switch (typeof key) {
+            case 'string':
+                if (this.many) {
+                    throw Error(`Field ${this.name} [${this.type}] does not support field lookups: ${key}`);
+                }
+                return value[key];
+            case 'number':
+                if (!this.many) {
+                    throw Error(`Field ${this.name} [${this.type}] does not support index lookups`);
+                }
+                return value[key];
+            case 'undefined':
+                return value;
+        }
+    }
+    validate(value) {
+        if (!value) {
+            if (!this.blank) {
+                return [{ code: 'blank', message: 'Field must not be blank' }];
+            }
+            return;
+        }
+        return this.entity.validate(value);
+    }
+    /**
+     * EntityField is a special case.
+     *
+     * A Form Input may be asking us for the errors of a specific field.
+     */
+    getErrors(errors, key) {
+        if (key !== undefined) {
+            return errors[key];
+        }
+        return errors;
+    }
+    getId(value) {
+        return value && this.entity.getId(value);
+    }
+    // Used by Form
+    getField(name) {
+        return this.entity.fields[name];
+    }
+}
+//# sourceMappingURL=EntityField.js.map

package/dist/field/EntityField.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EntityField.js","sourceRoot":"","sources":["../../src/field/EntityField.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,CAAC;AAO1B,MAAM,OAAO,WAAe,SAAQ,KAAQ;IAC1C,IAAI,GAAG,QAAQ,CAAC;IAChB,MAAM,CAAgB;IAEtB,YAAY,EAAE,MAAM,EAAE,GAAG,OAAO,EAAmC;QACjE,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,QAAQ,CAAC,KAAQ,EAAE,GAAqB;QACtC,IAAI,CAAC,KAAK;YAAE,OAAO,KAAK,CAAC;QACzB,QAAQ,OAAO,GAAG,EAAE;YAClB,KAAK,QAAQ;gBACX,IAAI,IAAI,CAAC,IAAI,EAAE;oBACb,MAAM,KAAK,CACT,SAAS,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,qCAAqC,GAAG,EAAE,CAC3E,CAAC;iBACH;gBACD,OAAO,KAAK,CAAC,GAAc,CAAC,CAAC;YAC/B,KAAK,QAAQ;gBACX,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;oBACd,MAAM,KAAK,CACT,SAAS,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,kCAAkC,CACnE,CAAC;iBACH;gBACD,OAAQ,KAAa,CAAC,GAAG,CAAC,CAAC;YAC7B,KAAK,WAAW;gBACd,OAAO,KAAK,CAAC;SAChB;IACH,CAAC;IAED,QAAQ,CAAC,KAAc;QACrB,IAAI,CAAC,KAAK,EAAE;YACV,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;gBACf,OAAO,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,yBAAyB,EAAE,CAAC,CAAC;aAChE;YACD,OAAO;SACR;QACD,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAU,CAAC,CAAC;IAC1C,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,MAAqB,EAAE,GAAqB;QACpD,IAAI,GAAG,KAAK,SAAS,EAAE;YACrB,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;SACpB;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,KAAS;QACb,OAAO,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAU,CAAC,CAAC;IAChD,CAAC;IAED,eAAe;IACf,QAAQ,CAAC,IAAa;QACpB,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;CACF"}