@burnsred/entity 0.6.2 → 1.0.0

package/dist/field/Field.d.ts

@@ -0,0 +1,42 @@
+import type { ErrorSet, FieldCleaner, FieldErrorMap, FieldValidator, ValidatorResult } from '..';
+import type { FieldConstructorParams, FieldType } from '.';
+export declare class Field<T> implements FieldType<T> {
+    static defaultValue: unknown;
+    static defaultCleaners: FieldCleaner[];
+    static defaultValidators: FieldValidator[];
+    type: string;
+    name: string;
+    defaultValue: T;
+    blank: boolean;
+    readOnly: boolean;
+    cleaners: FieldCleaner[];
+    validators: FieldValidator[];
+    many: boolean;
+    choices: T[];
+    extra: object;
+    /**
+     * Base Entity Field class
+     *
+     * @param config
+     * @param config.type Type label for this field.
+     * @param config.blank Is this field allowed to be blank?
+     * @param config.cleaners Array of cleaner functions; used by `clean()`
+     * @param config.validators Array of validator functions; used by `validate()`
+     * @param config.many False if this field holds a scalar value; true if vector.
+     * @param config.choices Array of value choices
+     * @param config.defaultValue Default value for this field
+     */
+    constructor({ blank, cleaners, validators, many, readOnly, choices, defaultValue, ...extra }?: FieldConstructorParams<T>);
+    fromData(value: unknown): T;
+    toData(value: T): unknown;
+    default(): T | T[];
+    clean(value: T): T;
+    validate(value: T): ValidatorResult;
+    getErrors(errors: FieldErrorMap, key?: number | string): ErrorSet;
+    getValue(value: T, key?: string | number): T | T[keyof T];
+    getId(value?: T): string | undefined;
+    /**
+     * Dummy placeholder; only makes sense on an EntityField.
+     */
+    getField(_name: keyof T): FieldType<T[keyof T]>;
+}

package/dist/field/Field.js

@@ -0,0 +1,97 @@
+export class Field {
+    static defaultValue;
+    static defaultCleaners = [];
+    static defaultValidators = [];
+    type = '';
+    name;
+    defaultValue;
+    blank;
+    readOnly;
+    cleaners;
+    validators;
+    many;
+    choices;
+    extra; // grab bag of extra options
+    /**
+     * Base Entity Field class
+     *
+     * @param config
+     * @param config.type Type label for this field.
+     * @param config.blank Is this field allowed to be blank?
+     * @param config.cleaners Array of cleaner functions; used by `clean()`
+     * @param config.validators Array of validator functions; used by `validate()`
+     * @param config.many False if this field holds a scalar value; true if vector.
+     * @param config.choices Array of value choices
+     * @param config.defaultValue Default value for this field
+     */
+    constructor({ blank = false, cleaners, validators, many = false, readOnly = false, choices, defaultValue, ...extra } = {}) {
+        this.name = '';
+        this.blank = blank;
+        this.cleaners =
+            cleaners || this.constructor.defaultCleaners;
+        this.validators =
+            validators || this.constructor.defaultValidators;
+        this.many = many;
+        this.readOnly = readOnly;
+        this.choices = choices || [];
+        this.defaultValue =
+            defaultValue !== undefined
+                ? defaultValue
+                : this.constructor.defaultValue;
+        this.extra = extra;
+    }
+    fromData(value) {
+        return value;
+    }
+    toData(value) {
+        return this.readOnly ? undefined : value;
+    }
+    default() {
+        return this.many ? [] : this.defaultValue;
+    }
+    clean(value) {
+        return this.cleaners.reduce((val, cleaner) => cleaner(val), value);
+    }
+    validate(value) {
+        return this.validators
+            .map((validator) => validator.call(this, value))
+            .flat(1)
+            .filter(Boolean); // TS can't detect we've filtered the undefineds
+    }
+    getErrors(errors, key) {
+        switch (typeof key) {
+            case 'undefined':
+                return errors;
+            case 'number':
+                if (!this.many) {
+                    throw new Error(`[Field: ${this.name}] Index lookup not supported on scalar field.`);
+                }
+                return errors[key];
+            case 'string':
+                throw new Error(`[Field: ${this.name}] Use of field lookup not supported.`);
+        }
+    }
+    getValue(value, key) {
+        switch (typeof key) {
+            case 'string':
+                throw Error(`Field ${this.name} [${this.type}] does not support field lookups: ${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;
+        }
+    }
+    getId(value) {
+        return value;
+    }
+    /**
+     * Dummy placeholder; only makes sense on an EntityField.
+     */
+    getField(_name) {
+        throw new Error(`Cannot get sub-field for type ${this.type}`);
+    }
+}
+//# sourceMappingURL=Field.js.map

package/dist/field/Field.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Field.js","sourceRoot":"","sources":["../../src/field/Field.ts"],"names":[],"mappings":"AAUA,MAAM,OAAO,KAAK;IAChB,MAAM,CAAC,YAAY,CAAU;IAC7B,MAAM,CAAC,eAAe,GAAmB,EAAE,CAAC;IAC5C,MAAM,CAAC,iBAAiB,GAAqB,EAAE,CAAC;IAEhD,IAAI,GAAG,EAAE,CAAC;IACV,IAAI,CAAS;IACb,YAAY,CAAI;IAChB,KAAK,CAAU;IACf,QAAQ,CAAU;IAClB,QAAQ,CAAiB;IACzB,UAAU,CAAmB;IAC7B,IAAI,CAAU;IACd,OAAO,CAAM;IACb,KAAK,CAAS,CAAC,4BAA4B;IAE3C;;;;;;;;;;;OAWG;IACH,YAAY,EACV,KAAK,GAAG,KAAK,EACb,QAAQ,EACR,UAAU,EACV,IAAI,GAAG,KAAK,EACZ,QAAQ,GAAG,KAAK,EAChB,OAAO,EACP,YAAY,EACZ,GAAG,KAAK,KACqB,EAAE;QAC/B,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC;QACf,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,QAAQ;YACX,QAAQ,IAAK,IAAI,CAAC,WAA4B,CAAC,eAAe,CAAC;QACjE,IAAI,CAAC,UAAU;YACb,UAAU,IAAK,IAAI,CAAC,WAA4B,CAAC,iBAAiB,CAAC;QACrE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,OAAO,GAAG,OAAO,IAAI,EAAE,CAAC;QAE7B,IAAI,CAAC,YAAY;YACf,YAAY,KAAK,SAAS;gBACxB,CAAC,CAAC,YAAY;gBACd,CAAC,CAAG,IAAI,CAAC,WAA4B,CAAC,YAAkB,CAAC;QAC7D,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED,QAAQ,CAAC,KAAc;QACrB,OAAO,KAAU,CAAC;IACpB,CAAC;IAED,MAAM,CAAC,KAAQ;QACb,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC;IAC3C,CAAC;IAED,OAAO;QACL,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC;IAC5C,CAAC;IAED,KAAK,CAAC,KAAQ;QACZ,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAM,EAAE,KAAK,CAAC,CAAC;IAC1E,CAAC;IAED,QAAQ,CAAC,KAAQ;QACf,OAAO,IAAI,CAAC,UAAU;aACnB,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;aAC/C,IAAI,CAAC,CAAC,CAAC;aACP,MAAM,CAAC,OAAO,CAAoB,CAAC,CAAC,gDAAgD;IACzF,CAAC;IAED,SAAS,CAAC,MAAqB,EAAE,GAAqB;QACpD,QAAQ,OAAO,GAAG,EAAE;YAClB,KAAK,WAAW;gBACd,OAAO,MAAM,CAAC;YAChB,KAAK,QAAQ;gBACX,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;oBACd,MAAM,IAAI,KAAK,CACb,WAAW,IAAI,CAAC,IAAI,+CAA+C,CACpE,CAAC;iBACH;gBACD,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;YACrB,KAAK,QAAQ;gBACX,MAAM,IAAI,KAAK,CACb,WAAW,IAAI,CAAC,IAAI,sCAAsC,CAC3D,CAAC;SACL;IACH,CAAC;IAED,QAAQ,CAAC,KAAQ,EAAE,GAAqB;QACtC,QAAQ,OAAO,GAAG,EAAE;YAClB,KAAK,QAAQ;gBACX,MAAM,KAAK,CACT,SAAS,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,qCAAqC,GAAG,EAAE,CAC3E,CAAC;YACJ,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,GAAa,CAAC,CAAC;YACvC,KAAK,WAAW;gBACd,OAAO,KAAK,CAAC;SAChB;IACH,CAAC;IAED,KAAK,CAAC,KAAS;QACb,OAAO,KAAe,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,KAAc;QACrB,MAAM,IAAI,KAAK,CAAC,iCAAiC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;IAChE,CAAC"}

package/dist/field/IdField.d.ts

@@ -0,0 +1,15 @@
+import { Field } from '.';
+import { type FieldConstructorParams } from '.';
+/**
+ * Specialised Field type for use as ID.
+ *
+ * Ensures `many` is not set.
+ * Defaults to `undefined`.
+ * Will cast loaded values to string if possible.
+ *
+ */
+export declare class IdField extends Field<string | undefined> {
+    type: string;
+    constructor(config?: FieldConstructorParams<string | undefined>);
+    fromData(value: unknown): string | undefined;
+}

package/dist/field/IdField.js

@@ -0,0 +1,23 @@
+import { Field } from '.';
+/**
+ * Specialised Field type for use as ID.
+ *
+ * Ensures `many` is not set.
+ * Defaults to `undefined`.
+ * Will cast loaded values to string if possible.
+ *
+ */
+export class IdField extends Field {
+    type = 'id';
+    constructor(config = {}) {
+        super(config);
+        if (this.many)
+            throw new Error('IdField must not have many set');
+    }
+    fromData(value) {
+        return value?.toString instanceof Function
+            ? value.toString()
+            : value;
+    }
+}
+//# sourceMappingURL=IdField.js.map

package/dist/field/IdField.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IdField.js","sourceRoot":"","sources":["../../src/field/IdField.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,CAAC;AAG1B;;;;;;;GAOG;AACH,MAAM,OAAO,OAAQ,SAAQ,KAAyB;IACpD,IAAI,GAAG,IAAI,CAAC;IAEZ,YAAY,SAAqD,EAAE;QACjE,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,IAAI,CAAC,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;IACnE,CAAC;IAED,QAAQ,CAAC,KAAc;QACrB,OAAO,KAAK,EAAE,QAAQ,YAAY,QAAQ;YACxC,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE;YAClB,CAAC,CAAE,KAAmB,CAAC;IAC3B,CAAC;CACF"}

package/dist/field/IntegerField.d.ts

@@ -0,0 +1,6 @@
+import { asInteger } from '../cleaner';
+import { NumberField } from '.';
+export declare class IntegerField extends NumberField {
+    static defaultCleaners: (typeof asInteger)[];
+    fromData(value: unknown): number;
+}

package/dist/field/IntegerField.js

@@ -0,0 +1,9 @@
+import { asInteger } from '../cleaner';
+import { NumberField } from '.';
+export class IntegerField extends NumberField {
+    static defaultCleaners = [asInteger];
+    fromData(value) {
+        return asInteger(value);
+    }
+}
+//# sourceMappingURL=IntegerField.js.map

package/dist/field/IntegerField.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IntegerField.js","sourceRoot":"","sources":["../../src/field/IntegerField.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC,OAAO,EAAE,WAAW,EAAE,MAAM,GAAG,CAAC;AAEhC,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C,MAAM,CAAC,eAAe,GAAG,CAAC,SAAS,CAAC,CAAC;IAErC,QAAQ,CAAC,KAAc;QACrB,OAAO,SAAS,CAAC,KAAK,CAAW,CAAC;IACpC,CAAC"}

package/dist/field/NumberField.d.ts

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

package/dist/field/NumberField.js

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

package/dist/field/NumberField.js.map

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

package/dist/field/TextField.d.ts

@@ -0,0 +1,4 @@
+import { CharField } from '.';
+export declare class TextField extends CharField {
+    type: string;
+}

package/dist/field/TextField.js

@@ -0,0 +1,5 @@
+import { CharField } from '.';
+export class TextField extends CharField {
+    type = 'text';
+}
+//# sourceMappingURL=TextField.js.map

package/dist/field/TextField.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TextField.js","sourceRoot":"","sources":["../../src/field/TextField.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,GAAG,CAAC;AAE9B,MAAM,OAAO,SAAU,SAAQ,SAAS;IACtC,IAAI,GAAG,MAAM,CAAC;CACf"}

package/dist/field/index.d.ts

@@ -0,0 +1,68 @@
+export * from './Field';
+export * from './EntityField';
+export * from './BooleanField';
+export * from './CharField';
+export * from './DateField';
+export * from './DateTimeField';
+export * from './TextField';
+export * from './NumberField';
+export * from './IntegerField';
+export * from './IdField';
+import type { ErrorSet, FieldCleaner, FieldErrorMap, FieldValidator, ValidatorResult } from '..';
+export type FieldConstructorParams<T> = Partial<Pick<FieldType<T>, 'type' | 'blank' | 'cleaners' | 'validators' | 'many' | 'readOnly' | 'choices'>> & {
+    defaultValue?: T;
+};
+export interface FieldType<T> {
+    name: string;
+    type: string;
+    blank: boolean;
+    many: boolean;
+    readOnly: boolean;
+    choices: T[];
+    cleaners: FieldCleaner[];
+    validators: FieldValidator[];
+    /**
+     * Convert a raw value.
+     * Used for data from API
+     */
+    fromData: (value: unknown) => T;
+    /**
+     * Restore a value to raw state
+     */
+    toData: (value: T) => unknown;
+    /**
+     * Get the default value for this field.
+     */
+    default: (options: object) => T | T[];
+    /**
+     * Apply cleaners to the value.
+     * Use for data from user input.
+     */
+    clean: (value: T) => T;
+    /**
+     * Validate the value, returning an array of errors.
+     */
+    validate: (value: T) => ValidatorResult;
+    /**
+     * Extract errors for this field only.
+     */
+    getErrors: (errors: FieldErrorMap, key?: number | string) => ErrorSet;
+    /**
+     * Retrieves the value
+     *
+     * For scalar values, this is just the value
+     * For vector and compound values, the second argument specifies the key/index.
+     */
+    getValue: (value: T, key?: string | number) => T | T[keyof T];
+    /**
+     * Extract the identifier for the value.
+     *
+     * For scalar values, this is just the value.
+     * For Entities, this is their ID field's value.
+     */
+    getId: (value?: T) => string | undefined;
+    /**
+     * Provide a Field for a specific element of a compound value.
+     */
+    getField: (name: keyof T) => FieldType<T[keyof T]>;
+}

package/dist/field/index.js

@@ -0,0 +1,12 @@
+// NB: Field MUST be imported first!
+export * from './Field';
+export * from './EntityField';
+export * from './BooleanField';
+export * from './CharField';
+export * from './DateField';
+export * from './DateTimeField';
+export * from './TextField';
+export * from './NumberField';
+export * from './IntegerField';
+export * from './IdField';
+//# sourceMappingURL=index.js.map

package/dist/field/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/field/index.ts"],"names":[],"mappings":"AAAA,oCAAoC;AACpC,cAAc,SAAS,CAAC;AACxB,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,WAAW,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,67 @@
+export * from './field';
+export * from './entity';
+export * from './cleaner';
+export * from './validator';
+import type { EntityField, FieldConstructorParams, FieldType } from './field';
+export type FieldError = {
+    code: string;
+    message: string;
+};
+/**
+ * Scalar fields have Array<FieldError>
+ * EntityFields have FieldErrorMap
+ * Vector fields have Array<as above>
+ */
+export type ErrorSet = Array<FieldError> | Array<Array<FieldError>> | FieldErrorMap | Array<FieldErrorMap>;
+export type FieldErrorMap = {
+    [key: string]: ErrorSet;
+};
+export type ValidatorResult = ErrorSet | undefined;
+export type FieldCleaner = (value: unknown) => unknown;
+export type FieldValidator = (value: unknown) => ValidatorResult;
+export type EntityRecordCleaner<T> = (record: T) => T;
+export type EntityRecordValidator<T> = (record: T, errors: FieldErrorMap) => FieldErrorMap;
+export interface EntityType<T> {
+    /** Field to use to uniquely identify a record. */
+    idField: keyof T;
+    /** Map of fields */
+    fields: {
+        [F in keyof T]: FieldType<T[F]>;
+    };
+    /** Array of cleaner functions; used by `clean()` */
+    cleaners: EntityRecordCleaner<T>[];
+    /** Array of validator functions; used by `validate()` */
+    validators: EntityRecordValidator<T>[];
+    /**
+     * Construct an entity record from supplied data.
+     *
+     * Use for data from API.
+     */
+    fromData: (data: Record<string, unknown>) => T;
+    /**
+     * Extract plain data from a record.
+     */
+    toData: (record: T) => Record<string, unknown>;
+    /**
+     * Given an existing record, clean its values.
+     *
+     * Applies per-field cleaners first, then Entity level cleaners.
+     *
+     * Used for data from user input.
+     */
+    clean: (record: T) => T;
+    /**
+     * Apply all field and entitly defined validators and collect errors.
+     */
+    validate: (record: T) => FieldErrorMap;
+    /**
+     * Extract the identifier for the supplied record.
+     *
+     * This can also be useful for `key={}` properties.
+     */
+    getId: (record?: T) => string | undefined;
+    /**
+     * Helper to create an EntityField for this type of entity.
+     */
+    getEntityField: (options?: FieldConstructorParams<T>) => EntityField<T>;
+}

package/dist/index.js

@@ -1,5 +1,5 @@
-if (process.env.NODE_ENV === 'production') {
-  module.exports = require('./production.min'); // eslint-disable-line global-require, import/no-unresolved
-} else {
-  module.exports = require('./development'); // eslint-disable-line global-require, import/no-unresolved
-}
+export * from './field';
+export * from './entity';
+export * from './cleaner';
+export * from './validator';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC"}

package/dist/validator/entity-valid.d.ts

@@ -0,0 +1,9 @@
+import { type EntityField } from '../field';
+/**
+ * Ensure the associated Entity considers the value valid.
+ */
+declare function entityValid<T>(this: EntityField<T>, value: unknown): {
+    code: string;
+    message: string;
+}[] | undefined;
+export default entityValid;

package/dist/validator/entity-valid.js

@@ -0,0 +1,12 @@
+/**
+ * Ensure the associated Entity considers the value valid.
+ */
+function entityValid(value) {
+    const errors = this.entity.validate(value);
+    // TODO: ensure this handles cases of highly recursive error structures.
+    if (Object.values(errors).some((err) => err && err.length)) {
+        return [{ code: 'entity-invalid', message: 'Entity is not valid.' }];
+    }
+}
+export default entityValid;
+//# sourceMappingURL=entity-valid.js.map

package/dist/validator/entity-valid.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entity-valid.js","sourceRoot":"","sources":["../../src/validator/entity-valid.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,SAAS,WAAW,CAA0B,KAAc;IAC1D,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAU,CAAC,CAAC;IAEhD,wEAAwE;IACxE,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,EAAE;QAC1D,OAAO,CAAC,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,EAAE,sBAAsB,EAAE,CAAC,CAAC;KACtE;AACH,CAAC;AAED,eAAe,WAAW,CAAC"}

package/dist/validator/index.d.ts

@@ -0,0 +1,2 @@
+export { default as entityValid } from './entity-valid';
+export { default as valueRange } from './value-range';

package/dist/validator/index.js

@@ -0,0 +1,3 @@
+export { default as entityValid } from './entity-valid';
+export { default as valueRange } from './value-range';
+//# sourceMappingURL=index.js.map

package/dist/validator/index.js.map

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

package/dist/validator/value-range.d.ts

@@ -0,0 +1,8 @@
+import type { FieldType } from '../field';
+/**
+ * A validator factory to ensure a numeric value is within range.
+ */
+export default function valueRange(min: number, max: number): (this: FieldType<unknown>, value: unknown) => {
+    code: string;
+    message: string;
+}[] | undefined;

package/dist/validator/value-range.js

@@ -0,0 +1,24 @@
+/**
+ * A validator factory to ensure a numeric value is within range.
+ */
+export default function valueRange(min, max) {
+    return function (value) {
+        if (min !== undefined && value < min) {
+            return [
+                {
+                    code: 'range-error',
+                    message: `Value must be greater than ${min}`,
+                },
+            ];
+        }
+        if (max !== undefined && value > max) {
+            return [
+                {
+                    code: 'range-error',
+                    message: `Value must be less than ${max}`,
+                },
+            ];
+        }
+    };
+}
+//# sourceMappingURL=value-range.js.map

package/dist/validator/value-range.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"value-range.js","sourceRoot":"","sources":["../../src/validator/value-range.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,CAAC,OAAO,UAAU,UAAU,CAAC,GAAW,EAAE,GAAW;IACzD,OAAO,UAAoC,KAAc;QACvD,IAAI,GAAG,KAAK,SAAS,IAAK,KAAgB,GAAG,GAAG,EAAE;YAChD,OAAO;gBACL;oBACE,IAAI,EAAE,aAAa;oBACnB,OAAO,EAAE,8BAA8B,GAAG,EAAE;iBAC7C;aACF,CAAC;SACH;QACD,IAAI,GAAG,KAAK,SAAS,IAAK,KAAgB,GAAG,GAAG,EAAE;YAChD,OAAO;gBACL;oBACE,IAAI,EAAE,aAAa;oBACnB,OAAO,EAAE,2BAA2B,GAAG,EAAE;iBAC1C;aACF,CAAC;SACH;IACH,CAAC,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,40 +1,27 @@
 {
-  "author": "Thierry Wong and Burnsred",
-  "description": "entity",
-  "license": "MIT",
-  "main": "dist/index.js",
-  "module": "dist/index.js",
   "name": "@burnsred/entity",
-  "private": false,
-  "repository": "https://github.com/burnsred/burnsred-entity-library.git",
-  "sideEffects": false,
-  "version": "0.6.2",
-  "publishConfig": {
-    "access": "public"
-  },
+  "version": "1.0.0",
+  "description": "",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "scripts": {
-    "build": "rollup -c=../../configs/rollup.config.js",
-    "destroy": "rimraf dist",
-    "link-main:dist": "json -I -f package.json -e 'this.main=\"dist/index.js\"'",
-    "link-main:src": "json -I -f package.json -e 'this.main=\"src/index.js\"'",
-    "link-module:dist": "json -I -f package.json -e 'this.module=\"dist/index.js\"'",
-    "link-module:src": "json -I -f package.json -e 'this.module=\"src/index.js\"'",
-    "postbuild": "npm run link-main:dist && npm run link-module:dist",
-    "postdestroy": "npm run link-main:src && npm run link-module:src",
-    "prebuild": "npm run destroy"
-  },
-  "dependencies": {
-    "idx": "2.5.5",
-    "immutable": "4.0.0-rc.12",
-    "query-string": "6.4.0"
-  },
-  "devDependencies": {
-    "lodash": "4.17.11",
-    "moment": "2.24.0"
+    "test": "vitest run",
+    "build": "tsc -b",
+    "clean": "rm -rf tsconfig.tsbuildinfo dist/",
+    "lint": "eslint src/",
+    "lint:fix": "eslint --fix src/",
+    "test:watch": "vitest",
+    "prepublishOnly": "npm run build",
+    "check": "tsc --NoEmit"
   },
-  "peerDependencies": {
-    "lodash": ">=4.12.0",
-    "moment": ">=2.0.0"
+  "repository": {
+    "type": "git",
+    "url": "git@bitbucket.org-br:burnsred/burnsred-engage-ui.git"
   },
-  "gitHead": "b5eddced9b62ae74a4de6c2be7c9206b11ce1c05"
+  "author": "BurnsRED",
+  "license": "UNLICENSED",
+  "type": "module",
+  "files": [
+    "dist/**"
+  ]
 }

package/CHANGELOG.md

@@ -1,88 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-## [0.6.2](https://github.com/burnsred/burnsred-entity-library/compare/v0.5.2...v0.6.2) (2019-05-15)
-
-
-### Bug Fixes
-
-* deploy ([28349bb](https://github.com/burnsred/burnsred-entity-library/commit/28349bb))
-
-
-
-
-
-## [0.5.2](https://github.com/gnowth/entity/compare/v0.5.1...v0.5.2) (2019-05-14)
-
-
-### Bug Fixes
-
-* change license to MIT ([#154](https://github.com/gnowth/entity/issues/154)) ([78d85be](https://github.com/gnowth/entity/commit/78d85be))
-
-
-
-
-
-## [0.5.1](https://github.com/gnowth/entity/compare/v0.5.0...v0.5.1) (2019-03-20)
-
-
-### Bug Fixes
-
-* build import and lodash replacement ([#139](https://github.com/gnowth/entity/issues/139)) ([0f937b7](https://github.com/gnowth/entity/commit/0f937b7))
-
-
-
-
-
-# [0.5.0](https://github.com/gnowth/entity/compare/v0.4.0...v0.5.0) (2019-03-19)
-
-
-### Features
-
-* add mock get api ([#106](https://github.com/gnowth/entity/issues/106)) ([e27d63b](https://github.com/gnowth/entity/commit/e27d63b))
-* added mock to entity ([#112](https://github.com/gnowth/entity/issues/112)) ([358bdee](https://github.com/gnowth/entity/commit/358bdee))
-* added UIPortal ([#137](https://github.com/gnowth/entity/issues/137)) ([08105b8](https://github.com/gnowth/entity/commit/08105b8))
-* PopupShadow allows a dirtier value of parent Form ([#81](https://github.com/gnowth/entity/issues/81)) ([4813d6b](https://github.com/gnowth/entity/commit/4813d6b))
-* widgetcheckbox, with other fixes ([#129](https://github.com/gnowth/entity/issues/129)) ([3c7810a](https://github.com/gnowth/entity/commit/3c7810a))
-
-
-### Performance Improvements
-
-* allow lodash plugin to optimise ([#132](https://github.com/gnowth/entity/issues/132)) ([3c04468](https://github.com/gnowth/entity/commit/3c04468))
-
-
-
-
-
-# [0.4.0](https://github.com/gnowth/entity/compare/v0.2.0...v0.4.0) (2019-01-27)
-
-
-### Bug Fixes
-
-* github requiring ssh from circleci ([3d86a88](https://github.com/gnowth/entity/commit/3d86a88))
-
-
-### Performance Improvements
-
-* split code in vender/route ([#45](https://github.com/gnowth/entity/issues/45)) ([96b2067](https://github.com/gnowth/entity/commit/96b2067))
-
-
-
-
-
-# [0.2.0](https://github.com/gnowth/entity/compare/v0.1.1...v0.2.0) (2018-11-16)
-
-
-### Features
-
-* added widgetList, field getKey ([#21](https://github.com/gnowth/entity/issues/21)) ([3ffb626](https://github.com/gnowth/entity/commit/3ffb626))
-
-
-
-
-
-## 0.1.1 (2018-11-11)
-
-**Note:** Version bump only for package @entity/core