@ekz/formix 1.0.2 → 2.0.0

package/package.json

@@ -1,65 +1,91 @@
 {
   "name": "@ekz/formix",
-  "packageManager": "yarn@4.9.2",
-  "version": "1.0.2",
+  "version": "2.0.0",
+  "license": "MIT",
   "description": "Type-safe React form to be used with Typescript",
-  "keywords": [
-    "react",
-    "form",
-    "formix",
-    "typescript",
-    "type-safe"
-  ],
-  "author": {
-    "name": "Alan Heitkotter",
-    "email": "heitkotter@gmail.com"
-  },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/erkez/formix.git"
+    "url": "https://github.com/erkez/ekz.git",
+    "directory": "formix"
   },
-  "bugs": {
-    "url": "https://github.com/erkez/formix/issues"
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "main": "lib/cjs/index.js",
+  "module": "lib/esm/index.js",
+  "esnext": "lib/esnext/index.js",
+  "typings": "lib/esm/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/esm/index.d.ts",
+      "import": "./lib/esm/index.js",
+      "require": "./lib/cjs/index.js"
+    }
   },
-  "homepage": "https://github.com/erkez/formix#readme",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
-  "license": "MIT",
   "files": [
     "lib",
     "README.md",
     "LICENSE"
   ],
+  "keywords": [
+    "react",
+    "form",
+    "formix",
+    "typescript",
+    "type-safe"
+  ],
   "peerDependencies": {
-    "@ekz/option": "^1.2.1",
-    "immutable": "^4",
-    "react": "^16.8.0 || ^17 || ^18",
+    "@ekz/option": "^2.0.0",
+    "immutable": "^4 || ^5",
+    "react": "^16.8.0 || ^17 || ^18 || ^19",
     "typescript": "^4 || ^5"
   },
   "devDependencies": {
-    "@ekz/option": "^1.2.5",
-    "@ekz/packer": "^0.16.0",
-    "@testing-library/jest-dom": "^5.11.9",
-    "@testing-library/react": "^11.1.0",
-    "@testing-library/react-hooks": "^5.1.0",
-    "@trivago/prettier-plugin-sort-imports": "^4.3.0",
-    "@types/jest": "^26.0.15",
-    "documentation": "^13.1.1",
-    "immutable": "^4.3.6",
-    "jest": "^26.6.1",
+    "@ekz/option": "workspace:^",
+    "@testing-library/dom": "^10.4.1",
+    "@testing-library/jest-dom": "^6.9.1",
+    "@testing-library/react": "^16.3.2",
+    "@testing-library/react-hooks": "^8.0.1",
+    "@testing-library/user-event": "^14.6.1",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^25.6.0",
+    "@types/react": "18.3.28",
+    "immutable": "^5.1.5",
+    "jest": "^30.2.0",
+    "jest-environment-jsdom": "^30.2.0",
+    "npm-run-all": "^4.1.5",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
-    "typescript": "^5.5.3"
+    "ts-jest": "^29.4.6",
+    "typescript": "^5.9.3"
   },
   "scripts": {
-    "test": "npx jest",
-    "lint": "npx eslint --ext .ts --ext .tsx .",
+    "clean": "rm -rf lib/* || true",
+    "lint": "npx eslint --ext .ts --ext .tsx ./src/main/web",
     "lint:fix": "yarn lint --fix",
-    "build": "yarn build:dev",
-    "build:watch": "yarn build:dev --watch",
-    "build:dev": "npx webpack --mode=development",
-    "build:prod": "npx webpack --mode=production",
-    "declarations:ts": "npx tsc -d --declarationDir lib --emitDeclarationOnly --jsx react src/index.ts",
-    "prepublish": "yarn test --ci --no-watchman && yarn lint && yarn build:prod && yarn declarations:ts"
+    "compile": "run-p \"compile:*\"",
+    "compile:esm": "tsc -p ./src/main/web --outDir ./lib/esm",
+    "compile:cjs": "tsc -p ./src/main/web -m commonjs --verbatimModuleSyntax false --outDir ./lib/cjs",
+    "compile:esnext": "tsc -p ./src/main/web -t esnext --outDir ./lib/esnext",
+    "test": "jest",
+    "prepublish": "yarn clean && yarn test --ci --no-watchman && yarn lint && yarn compile"
+  },
+  "jest": {
+    "preset": "ts-jest/presets/default",
+    "testEnvironment": "jsdom",
+    "roots": [
+      "<rootDir>/__tests__"
+    ],
+    "transform": {
+      "^.+\\.tsx?$": [
+        "ts-jest",
+        {
+          "tsconfig": {
+            "jsx": "react"
+          }
+        }
+      ]
+    }
   }
 }

package/lib/FieldState.d.ts

@@ -1,17 +0,0 @@
-import { FieldMetadata, FieldValue, FieldState as IFieldState } from './types';
-export default class FieldState<T> implements IFieldState<T> {
-    readonly value: T;
-    readonly disabled: boolean;
-    readonly active: boolean;
-    readonly touched: boolean;
-    constructor(value: T, disabled: boolean, active: boolean, touched: boolean);
-    updated(fields: Partial<FieldValue<T> & FieldMetadata>): FieldState<T>;
-    /**
-     * `equals` only takes the value and disabled properties into consideration.
-     */
-    equals(other: FieldState<T> | null | undefined): boolean;
-    /**
-     * `hashCode` only takes the value and disabled properties into consideration.
-     */
-    hashCode(): number;
-}

package/lib/fields.d.ts

@@ -1,15 +0,0 @@
-import * as React from 'react';
-import { ArrayField, ArrayFieldRef, Field, FieldRef, GenericFieldRef } from './types';
-export declare function useField<T>(fieldRef: FieldRef<T>): Field<T>;
-export declare function useArrayField<T extends GenericFieldRef, V>(fieldRef: ArrayFieldRef<T, V>): ArrayField<T, V>;
-type UseFieldProps<T> = {
-    field: FieldRef<T>;
-    render(field: Field<T>): React.ReactNode;
-};
-export declare function UseField<T>(props: UseFieldProps<T>): React.ReactElement;
-type UseArrayFieldProps<T extends GenericFieldRef, V> = {
-    field: ArrayFieldRef<T, V>;
-    render(field: ArrayField<T, V>): React.ReactNode;
-};
-export declare function UseArrayField<T extends GenericFieldRef, V>(props: UseArrayFieldProps<T, V>): React.ReactElement;
-export {};

package/lib/form.d.ts

@@ -1,13 +0,0 @@
-import * as React from 'react';
-import { GenericFieldRef, FormApi, FormWithFields } from './types';
-export declare function FormProvider(props: {
-    children: React.ReactNode;
-}): React.ReactElement;
-export declare function useForm(): FormApi;
-export declare function useFormWithFields<Deps extends unknown[], F extends GenericFieldRef>(fieldsCreator: (...deps: [...Deps]) => F, deps: [...Deps]): FormWithFields<F>;
-export declare function withForm<Props>(Component: React.ComponentType<Props>): React.ComponentType<Props>;
-type UseFormProps = {
-    children: (form: FormApi) => React.ReactNode;
-};
-export declare function UseForm(props: UseFormProps): React.ReactElement;
-export {};

package/lib/index.d.ts

@@ -1,5 +0,0 @@
-export { useField, useArrayField, UseField, UseArrayField } from './fields';
-export { FormProvider, UseForm, useForm, useFormWithFields, withForm } from './form';
-export { defineField, isFieldRef, defineArrayField, isArrayFieldRef } from './references';
-export { useAsyncFieldStateValidation, useAsyncFieldValidation, useFieldStateValidation, useFieldValidation } from './validation/fields';
-export type { GenericFieldRef, FieldRef, ArrayFieldRef, Field, ArrayField, FieldValue, FieldState, FieldMetadata, FieldMetadataUpdaters, FormStates, FieldRefStates, FormValues, FieldRefValues, FormApi, FormWithFields, ValidationError, ValidationResult, FieldValidation, FormValidationApi, FormValidations } from './types';

package/lib/index.js

@@ -1 +0,0 @@
-!function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t(require("immutable"),require("react")):"function"==typeof define&&define.amd?define(["immutable","react"],t):"object"==typeof exports?exports.Formix=t(require("immutable"),require("react")):e.Formix=t(e.immutable,e.react)}(self,((e,t)=>(()=>{"use strict";var r={144:t=>{t.exports=e},155:e=>{e.exports=t}},n={};function i(e){var t=n[e];if(void 0!==t)return t.exports;var u=n[e]={exports:{}};return r[e](u,u.exports,i),u.exports}i.d=(e,t)=>{for(var r in t)i.o(t,r)&&!i.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},i.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),i.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})};var u={};i.r(u),i.d(u,{FormProvider:()=>V,UseArrayField:()=>U,UseField:()=>L,UseForm:()=>D,defineArrayField:()=>g,defineField:()=>b,isArrayFieldRef:()=>h,isFieldRef:()=>m,useArrayField:()=>_,useAsyncFieldStateValidation:()=>W,useAsyncFieldValidation:()=>K,useField:()=>A,useFieldStateValidation:()=>z,useFieldValidation:()=>B,useForm:()=>C,useFormWithFields:()=>k,withForm:()=>x});var o=i(155),a=i(144);function l(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function c(e,t,r){return(t=function(e){var t=function(e,t){if("object"!=typeof e||!e)return e;var r=e[Symbol.toPrimitive];if(void 0!==r){var n=r.call(e,t||"default");if("object"!=typeof n)return n;throw new TypeError("@@toPrimitive must return a primitive value.")}return("string"===t?String:Number)(e)}(e,"string");return"symbol"==typeof t?t:t+""}(t))in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}const f=function(){function e(e,t,r,n){this.value=e,this.disabled=t,this.active=r,this.touched=n,this.value=e,this.disabled=t,this.active=r,this.touched=n}return e.prototype.updated=function(t){var r,n,i,u=function(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?l(Object(r),!0).forEach((function(t){c(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):l(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}({value:this.value},t);return new e(u.value,null!==(r=t.disabled)&&void 0!==r?r:this.disabled,null!==(n=t.active)&&void 0!==n?n:this.active,null!==(i=t.touched)&&void 0!==i?i:this.touched)},e.prototype.equals=function(e){return null!=e&&(0,a.is)(this.value,e.value)&&this.disabled===e.disabled},e.prototype.hashCode=function(){return(0,a.hash)(this.value)&(0,a.hash)(this.disabled)},e}();var s,d=(s=function(e,t){return s=Object.setPrototypeOf||{__proto__:[]}instanceof Array&&function(e,t){e.__proto__=t}||function(e,t){for(var r in t)Object.prototype.hasOwnProperty.call(t,r)&&(e[r]=t[r])},s(e,t)},function(e,t){if("function"!=typeof t&&null!==t)throw new TypeError("Class extends value "+String(t)+" is not a constructor or null");function r(){this.constructor=e}s(e,t),e.prototype=null===t?Object.create(t):(r.prototype=t.prototype,new r)});function p(e,t,r){return(t=function(e){var t=function(e,t){if("object"!=typeof e||!e)return e;var r=e[Symbol.toPrimitive];if(void 0!==r){var n=r.call(e,t||"default");if("object"!=typeof n)return n;throw new TypeError("@@toPrimitive must return a primitive value.")}return("string"===t?String:Number)(e)}(e,"string");return"symbol"==typeof t?t:t+""}(t))in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}var v=function(e,t){p(this,"initialState",void 0),this.initialState=new f(e,t,!1,!1)};function b(e){return new v(e,arguments.length>1&&void 0!==arguments[1]&&arguments[1])}function m(e){return e instanceof v}var y=function(e){function t(t,r,n){var i=e.call(this,t,n)||this;return i.itemTemplate=r,i.itemTemplate=r,i}return d(t,e),t}(v);function g(e,t){var r=arguments.length>2&&void 0!==arguments[2]&&arguments[2];return new y((0,a.Seq)(e).map(t).toList(),t,r)}function h(e){return e instanceof y}var O=Object.freeze({error:null,pending:!1}),j=["reset"];function S(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function w(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?S(Object(r),!0).forEach((function(t){P(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):S(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function P(e,t,r){return(t=function(e){var t=function(e,t){if("object"!=typeof e||!e)return e;var r=e[Symbol.toPrimitive];if(void 0!==r){var n=r.call(e,t||"default");if("object"!=typeof n)return n;throw new TypeError("@@toPrimitive must return a primitive value.")}return("string"===t?String:Number)(e)}(e,"string");return"symbol"==typeof t?t:t+""}(t))in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function F(){var e=o.useState(a.Map),t=e[0],r=e[1],n=o.useCallback((function(e){return t.get(e,e.initialState)}),[t]),i=o.useCallback((function(e){return n(e).value}),[n]),u=o.useCallback((function(e,t){r((function(r){return"function"==typeof t?r.update(e,e.initialState,t):r.set(e,t)}))}),[]),l=o.useCallback((function(e,t){return function e(r){if(h(r))return n(r).value.map(e);if(m(r)){var i=n(r);return"value"===t?i.value:i}return a.Seq.Keyed(r).map((function(t){return e(t)})).toObject()}(e)}),[n]),c=o.useCallback((function(e){return l(e,"state")}),[l]),f=o.useCallback((function(e){return l(e,"value")}),[l]),s=o.useCallback((function(){return r((0,a.Map)())}),[r]),d=o.useMemo((function(){return t.some((function(e,t){return!e.equals(t.initialState)}))}),[t]),p=function(e){var t=o.useState(a.Map),r=t[0],n=t[1],i=o.useCallback((function(e){return n((function(t){return t.update(e.fieldRef,(0,a.OrderedSet)(),(function(t){return t.add(e)}))})),function(){return n((function(t){return t.update(e.fieldRef,(0,a.OrderedSet)(),(function(t){return t.remove(e)}))}))}}),[]),u=o.useCallback((function(e){return r.get(e,(0,a.OrderedSet)()).reduce((function(e,t){return{error:e.error||t.error,pending:e.pending||t.pending}}),O)}),[r]),l=o.useCallback((function(t){var n=function t(r){return h(r)?e(r).value.flatMap(t):m(r)?a.List.of(r):a.Seq.Keyed(r).valueSeq().flatMap(t).toList()}(t).toSet();return r.filter((function(e,t){return n.has(t)})).valueSeq().flatMap((function(e){return e})).every((function(e){return null==e.error&&!e.pending}))}),[e,r]),c=o.useMemo((function(){return r.valueSeq().flatMap((function(e){return e})).some((function(e){return e.pending}))}),[r]);return{registerValidation:i,getValidationResult:u,isFieldValid:l,valid:o.useMemo((function(){return!c&&r.valueSeq().flatMap((function(e){return e})).every((function(e){return null==e.error}))}),[c,r]),pending:c}}(n);return o.useMemo((function(){return w({getFieldState:n,getFieldValue:i,setFieldState:u,getStates:c,getValues:f,reset:s,modified:d},p)}),[n,i,u,c,f,s,d,p])}function M(){throw new Error("Cannot call method on empty context. Did you forget <Form />?")}var E=o.createContext({getFieldState:M,getFieldValue:M,setFieldState:M,getStates:M,getValues:M,getValidationResult:M,registerValidation:M,isFieldValid:M,reset:M,pending:!1,valid:!1,modified:!1});function V(e){var t=F();return o.createElement(E.Provider,{value:t},e.children)}function C(){return o.useContext(E)}function k(e,t){var r=C(),n=r.reset,i=function(e,t){if(null==e)return{};var r,n,i=function(e,t){if(null==e)return{};var r={};for(var n in e)if({}.hasOwnProperty.call(e,n)){if(t.includes(n))continue;r[n]=e[n]}return r}(e,t);if(Object.getOwnPropertySymbols){var u=Object.getOwnPropertySymbols(e);for(n=0;n<u.length;n++)r=u[n],t.includes(r)||{}.propertyIsEnumerable.call(e,r)&&(i[r]=e[r])}return i}(r,j),u=o.useMemo((function(){return e.apply(void 0,t)}),t);return o.useLayoutEffect((function(){n()}),[n,u]),o.useMemo((function(){return w(w({},i),{},{reset:n,fields:u})}),[i,n,u])}function x(e){return function(t){return o.createElement(V,null,o.createElement(e,t))}}function D(e){var t=C();return o.createElement(o.Fragment,null,e.children(t))}function T(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function q(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?T(Object(r),!0).forEach((function(t){R(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):T(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function R(e,t,r){return(t=function(e){var t=function(e,t){if("object"!=typeof e||!e)return e;var r=e[Symbol.toPrimitive];if(void 0!==r){var n=r.call(e,t||"default");if("object"!=typeof n)return n;throw new TypeError("@@toPrimitive must return a primitive value.")}return("string"===t?String:Number)(e)}(e,"string");return"symbol"==typeof t?t:t+""}(t))in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function A(e){var t=C(),r=t.getFieldState,n=t.setFieldState,i=t.getValidationResult,u=r(e),a=i(e),l=o.useCallback((function(t){n(e,(function(e){var r="function"==typeof t?t(e.value):t;return e.value===r?e:e.updated({value:r,touched:!0})}))}),[e,n]),c=o.useCallback((function(t){return n(e,(function(e){return e.updated({disabled:t})}))}),[e,n]),f=o.useCallback((function(){return n(e,(function(e){return e.updated({active:!0,touched:!0})}))}),[e,n]),s=o.useCallback((function(){return n(e,(function(e){return e.updated({active:!1})}))}),[e,n]);return o.useMemo((function(){return q(q({value:u.value},a),{},{disabled:u.disabled,active:u.active,touched:u.touched,setValue:l,setDisabled:c,onFocus:f,onBlur:s})}),[u,a,l,c,f,s])}function _(e){var t=C().getValidationResult,r=A(e),n=r.value,i=r.setValue,u=r.disabled,a=r.active,l=r.touched,c=r.setDisabled,f=r.onBlur,s=r.onFocus,d=t(e),p=o.useCallback((function(t){var r=e.itemTemplate(t);return i((function(e){return e.unshift(r)})),r}),[i,e]),v=o.useCallback((function(t){var r=e.itemTemplate(t);return i((function(e){return e.push(r)})),r}),[i,e]),b=o.useCallback((function(t,r){var n=e.itemTemplate(r);return i((function(e){return e.insert(t,n)})),n}),[i,e]),m=o.useCallback((function(e){i((function(t){var r=t.indexOf(e);return-1!==r?t.remove(r):t}))}),[i]),y=o.useCallback((function(e,t){i((function(r){var n=r.get(e),i=r.get(t);if(null==n||null==i)throw new Error("Invalid element access");return r.remove(e).insert(e,i).remove(t).insert(t,n)}))}),[i]);return o.useMemo((function(){return q(q({items:n},d),{},{unshift:p,push:v,insert:b,remove:m,swap:y,disabled:u,active:a,touched:l,setDisabled:c,onBlur:f,onFocus:s})}),[n,d,p,v,b,m,y,u,a,l,c,f,s])}function L(e){var t=A(e.field);return o.createElement(o.Fragment,null,e.render(t))}function U(e){var t=_(e.field);return o.createElement(o.Fragment,null,e.render(t))}var N=function(e,t,r){if(r||2===arguments.length)for(var n,i=0,u=t.length;i<u;i++)!n&&i in t||(n||(n=Array.prototype.slice.call(t,0,i)),n[i]=t[i]);return e.concat(n||Array.prototype.slice.call(t))};function B(e,t,r){var n=C(),i=n.getValues,u=n.registerValidation,a=i(e),l=o.useMemo((function(){return(null!=r?r:[]).map(i)}),N([i],null!=r?r:[],!0)),c=o.useMemo((function(){return t(a,l)}),N([a],l,!0)),f=o.useMemo((function(){return{fieldRef:e,error:c,pending:!1}}),[e,c]);o.useLayoutEffect((function(){return u(f)}),[u,f])}function I(e,t,r){var n=o.useState({pending:!1,error:null}),i=n[0],u=n[1];return o.useEffect((function(){var r=!0;u((function(e){return{pending:!0,error:e.error}}));var n=setTimeout((function(){e().then((function(e){r&&u({pending:!1,error:e})})).catch((function(e){r&&u({pending:!1,error:"Unexpected error"}),console.warn("[Unhandled Validation Error]",e),console.warn("An async validator should never throw, but it should resolve with the validation result.")}))}),t);return function(){r=!1,clearTimeout(n)}}),N([t],r,!0)),i}function K(e,t,r){var n=arguments.length>3&&void 0!==arguments[3]?arguments[3]:200,i=C(),u=i.getValues,a=i.registerValidation,l=u(e),c=o.useMemo((function(){return(null!=r?r:[]).map(u)}),N([u],null!=r?r:[],!0)),f=I((function(){return t(l,c)}),n,N([l],c,!0)),s=o.useMemo((function(){return{fieldRef:e,error:f.error,pending:f.pending}}),[e,f.error,f.pending]);o.useLayoutEffect((function(){return a(s)}),[a,s])}function z(e,t,r){var n=C(),i=n.getStates,u=n.registerValidation,a=i(e),l=o.useMemo((function(){return(null!=r?r:[]).map(i)}),N([i],null!=r?r:[],!0)),c=o.useMemo((function(){return t(a,l)}),N([a],l,!0)),f=o.useMemo((function(){return{fieldRef:e,error:c,pending:!1}}),[e,c]);o.useLayoutEffect((function(){return u(f)}),[u,f])}function W(e,t,r){var n=arguments.length>3&&void 0!==arguments[3]?arguments[3]:200,i=C(),u=i.getStates,a=i.registerValidation,l=u(e),c=o.useMemo((function(){return(null!=r?r:[]).map(u)}),N([u],null!=r?r:[],!0)),f=I((function(){return t(l,c)}),n,N([l],c,!0)),s=o.useMemo((function(){return{fieldRef:e,error:f.error,pending:f.pending}}),[e,f.error,f.pending]);o.useLayoutEffect((function(){return a(s)}),[a,s])}return u})()));

package/lib/references.d.ts

@@ -1,5 +0,0 @@
-import { ArrayFieldRef, FieldRef, GenericFieldRef } from './types';
-export declare function defineField<V>(initialValue: V, initialDisabled?: boolean): FieldRef<V>;
-export declare function isFieldRef(field: unknown): field is FieldRef<unknown>;
-export declare function defineArrayField<T extends GenericFieldRef, V>(initialItems: Iterable<V>, itemTemplate: (value: V) => T, initialDisabled?: boolean): ArrayFieldRef<T, V>;
-export declare function isArrayFieldRef(field: unknown): field is ArrayFieldRef<GenericFieldRef, unknown>;

package/lib/types.d.ts

@@ -1,111 +0,0 @@
-import type { Map, List, OrderedSet } from 'immutable';
-export type GenericFieldRef = ArrayFieldRef<GenericFieldRef, unknown> | FieldRef<unknown> | {
-    [key: string]: GenericFieldRef;
-};
-export interface FieldRef<T> {
-    readonly initialState: FieldState<T>;
-}
-export interface ArrayFieldRef<T extends GenericFieldRef, V> extends FieldRef<List<T>> {
-    itemTemplate(value: V): T;
-}
-/**
- * `FieldState` represents the state of a `FieldRef`
- */
-export interface FieldState<T> extends FieldValue<T>, FieldMetadata {
-    /**
-     * Value of the field
-     */
-    readonly value: T;
-    /**
-     * `true` when field is disabled
-     */
-    readonly disabled: boolean;
-    /**
-     * `true` when field is focused
-     */
-    readonly active: boolean;
-    /**
-     * `true` when field has been focused once
-     */
-    readonly touched: boolean;
-    updated(fields: Partial<FieldValue<T> & FieldMetadata>): FieldState<T>;
-    /**
-     * `equals` only takes the value and disabled properties into consideration.
-     */
-    equals(other: FieldState<T> | null | undefined): boolean;
-    /**
-     * `hashCode` only takes the value and disabled properties into consideration.
-     */
-    hashCode(): number;
-}
-export interface FieldValue<T> {
-    readonly value: T;
-}
-export interface FieldMetadata {
-    readonly disabled: boolean;
-    readonly active: boolean;
-    readonly touched: boolean;
-}
-export interface FieldMetadataUpdaters {
-    setDisabled(disabled: boolean): void;
-    onFocus(): void;
-    onBlur(): void;
-}
-export interface Field<T> extends FieldValue<T>, FieldMetadata, FieldMetadataUpdaters, ValidationResult {
-    setValue(value: React.SetStateAction<T>): void;
-}
-export interface ArrayField<T extends GenericFieldRef, V> extends FieldMetadata, FieldMetadataUpdaters, ValidationResult {
-    readonly items: List<T>;
-    unshift(value: V): T;
-    push(value: V): T;
-    insert(index: number, value: V): T;
-    remove(item: T): void;
-    swap(indexA: number, indexB: number): void;
-}
-export type FormStates<F> = F extends ArrayFieldRef<infer T, unknown> ? List<FormStates<T>> : F extends FieldRef<infer T> ? FieldState<T> : F extends {
-    [K: string]: GenericFieldRef;
-} ? {
-    [K in keyof F]: FormStates<F[K]>;
-} : never;
-export type FieldRefStates<T extends GenericFieldRef[]> = {
-    [K in keyof T]: FormStates<T[K]>;
-};
-export type FormValues<F> = F extends ArrayFieldRef<infer T, unknown> ? List<FormValues<T>> : F extends FieldRef<infer T> ? T : F extends {
-    [K: string]: GenericFieldRef;
-} ? {
-    [K in keyof F]: FormValues<F[K]>;
-} : never;
-export type FieldRefValues<T extends GenericFieldRef[]> = {
-    [K in keyof T]: FormValues<T[K]>;
-};
-export interface FormApi extends FormValidationApi {
-    getFieldState<T>(fieldRef: FieldRef<T>): FieldState<T>;
-    getFieldValue<T>(fieldRef: FieldRef<T>): T;
-    setFieldState<T>(fieldRef: FieldRef<T>, state: React.SetStateAction<FieldState<T>>): void;
-    getStates<F extends GenericFieldRef>(fields: F): FormStates<F>;
-    getValues<F extends GenericFieldRef>(fields: F): FormValues<F>;
-    reset(): void;
-    modified: boolean;
-}
-export interface FormWithFields<F extends GenericFieldRef> extends FormApi {
-    fields: F;
-}
-/**
- * A ReactElement or a string represent an error message, and null represents no errors.
- */
-export type ValidationError = React.ReactElement | string | null;
-export interface ValidationResult {
-    readonly error: ValidationError;
-    readonly pending: boolean;
-}
-export interface FieldValidation<T> extends ValidationResult {
-    readonly fieldRef: FieldRef<T>;
-}
-export type FormValidations = Map<FieldRef<unknown>, OrderedSet<FieldValidation<unknown>>>;
-export interface FormValidationApi {
-    registerValidation(validation: FieldValidation<unknown>): () => void;
-    getValidationResult(fieldRef: FieldRef<unknown>): ValidationResult;
-    isFieldValid(fieldRef: GenericFieldRef): boolean;
-    valid: boolean;
-    pending: boolean;
-}

package/lib/validation/fields.d.ts

@@ -1,5 +0,0 @@
-import { GenericFieldRef, FormValues, FormStates, FieldRef, FieldRefValues, FieldRefStates, ValidationError } from '../types';
-export declare function useFieldValidation<F extends FieldRef<unknown>, D extends GenericFieldRef[] = []>(fieldRef: F, validate: (value: FormValues<F>, ds: [...FieldRefValues<D>]) => ValidationError, deps?: [...D]): void;
-export declare function useAsyncFieldValidation<F extends FieldRef<unknown>, D extends GenericFieldRef[] = []>(fieldRef: F, validate: (value: FormValues<F>, ds: [...FieldRefValues<D>]) => Promise<ValidationError>, deps?: [...D], debounceMs?: number): void;
-export declare function useFieldStateValidation<F extends FieldRef<unknown>, D extends GenericFieldRef[] = []>(fieldRef: F, validate: (fieldState: FormStates<F>, dependentFieldStates: [...FieldRefStates<D>]) => ValidationError, deps?: [...D]): void;
-export declare function useAsyncFieldStateValidation<F extends FieldRef<unknown>, D extends GenericFieldRef[] = []>(fieldRef: F, validate: (fieldState: FormStates<F>, ds: [...FieldRefStates<D>]) => Promise<ValidationError>, deps?: [...D], debounceMs?: number): void;

package/lib/validation/form.d.ts

@@ -1,2 +0,0 @@
-import { FormApi, FormValidationApi } from '../types';
-export declare function useFormValidation(getFieldState: FormApi['getFieldState']): FormValidationApi;