@tanstack/form-core 1.14.0 → 1.15.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/FieldGroupApi.cjs +156 -0
- package/dist/cjs/FieldGroupApi.cjs.map +1 -0
- package/dist/cjs/FieldGroupApi.d.cts +116 -0
- package/dist/cjs/FormApi.cjs.map +1 -1
- package/dist/cjs/FormApi.d.cts +13 -8
- package/dist/cjs/index.cjs +4 -0
- package/dist/cjs/index.cjs.map +1 -1
- package/dist/cjs/index.d.cts +1 -0
- package/dist/cjs/types.d.cts +78 -1
- package/dist/cjs/util-types.d.cts +7 -0
- package/dist/cjs/utils.cjs +24 -2
- package/dist/cjs/utils.cjs.map +1 -1
- package/dist/cjs/utils.d.cts +7 -0
- package/dist/esm/FieldGroupApi.d.ts +116 -0
- package/dist/esm/FieldGroupApi.js +156 -0
- package/dist/esm/FieldGroupApi.js.map +1 -0
- package/dist/esm/FormApi.d.ts +13 -8
- package/dist/esm/FormApi.js.map +1 -1
- package/dist/esm/index.d.ts +1 -0
- package/dist/esm/index.js +5 -1
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/types.d.ts +78 -1
- package/dist/esm/util-types.d.ts +7 -0
- package/dist/esm/utils.d.ts +7 -0
- package/dist/esm/utils.js +24 -2
- package/dist/esm/utils.js.map +1 -1
- package/package.json +1 -1
- package/src/FieldGroupApi.ts +461 -0
- package/src/FormApi.ts +18 -11
- package/src/index.ts +1 -0
- package/src/types.ts +152 -1
- package/src/util-types.ts +16 -0
- package/src/utils.ts +32 -2
package/dist/esm/utils.js
CHANGED
|
@@ -97,12 +97,25 @@ function makePathArray(str) {
|
|
|
97
97
|
throw new Error("Path must be a string.");
|
|
98
98
|
}
|
|
99
99
|
return str.replace(/(^\[)|]/gm, "").replace(/\[/g, ".").replace(reLineOfOnlyDigits, intReplace).replace(reDigitsBetweenDots, `.${intReplace}.`).replace(reStartWithDigitThenDot, `${intReplace}.`).replace(reDotWithDigitsToEnd, `.${intReplace}`).replace(reMultipleDots, ".").split(".").map((d) => {
|
|
100
|
-
if (d.
|
|
101
|
-
|
|
100
|
+
if (d.startsWith(intPrefix)) {
|
|
101
|
+
const numStr = d.substring(intPrefix.length);
|
|
102
|
+
const num = parseInt(numStr, 10);
|
|
103
|
+
if (String(num) === numStr) {
|
|
104
|
+
return num;
|
|
105
|
+
}
|
|
106
|
+
return numStr;
|
|
102
107
|
}
|
|
103
108
|
return d;
|
|
104
109
|
});
|
|
105
110
|
}
|
|
111
|
+
function concatenatePaths(path1, path2) {
|
|
112
|
+
if (path1.length === 0) return path2;
|
|
113
|
+
if (path2.length === 0) return path1;
|
|
114
|
+
if (path2.startsWith("[")) {
|
|
115
|
+
return path1 + path2;
|
|
116
|
+
}
|
|
117
|
+
return `${path1}.${path2}`;
|
|
118
|
+
}
|
|
106
119
|
function isNonEmptyArray(obj) {
|
|
107
120
|
return !(Array.isArray(obj) && obj.length === 0);
|
|
108
121
|
}
|
|
@@ -241,7 +254,16 @@ const determineFieldLevelErrorSourceAndValue = ({
|
|
|
241
254
|
}
|
|
242
255
|
return { newErrorValue: void 0, newSource: void 0 };
|
|
243
256
|
};
|
|
257
|
+
function createFieldMap(values) {
|
|
258
|
+
const output = {};
|
|
259
|
+
for (const key in values) {
|
|
260
|
+
output[key] = key;
|
|
261
|
+
}
|
|
262
|
+
return output;
|
|
263
|
+
}
|
|
244
264
|
export {
|
|
265
|
+
concatenatePaths,
|
|
266
|
+
createFieldMap,
|
|
245
267
|
deleteBy,
|
|
246
268
|
determineFieldLevelErrorSourceAndValue,
|
|
247
269
|
determineFormLevelErrorSourceAndValue,
|
package/dist/esm/utils.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"utils.js","sources":["../../src/utils.ts"],"sourcesContent":["import type { FieldValidators } from './FieldApi'\nimport type { FormValidators } from './FormApi'\nimport type {\n GlobalFormValidationError,\n ValidationCause,\n ValidationError,\n ValidationSource,\n} from './types'\n\nexport type UpdaterFn<TInput, TOutput = TInput> = (input: TInput) => TOutput\n\nexport type Updater<TInput, TOutput = TInput> =\n | TOutput\n | UpdaterFn<TInput, TOutput>\n\n/**\n * @private\n */\nexport function functionalUpdate<TInput, TOutput = TInput>(\n updater: Updater<TInput, TOutput>,\n input: TInput,\n): TOutput {\n return typeof updater === 'function'\n ? (updater as UpdaterFn<TInput, TOutput>)(input)\n : updater\n}\n\n/**\n * Get a value from an object using a path, including dot notation.\n * @private\n */\nexport function getBy(obj: any, path: any) {\n const pathObj = makePathArray(path)\n return pathObj.reduce((current: any, pathPart: any) => {\n if (current === null) return null\n if (typeof current !== 'undefined') {\n return current[pathPart]\n }\n return undefined\n }, obj)\n}\n\n/**\n * Set a value on an object using a path, including dot notation.\n * @private\n */\nexport function setBy(obj: any, _path: any, updater: Updater<any>) {\n const path = makePathArray(_path)\n\n function doSet(parent?: any): any {\n if (!path.length) {\n return functionalUpdate(updater, parent)\n }\n\n const key = path.shift()\n\n if (\n typeof key === 'string' ||\n (typeof key === 'number' && !Array.isArray(parent))\n ) {\n if (typeof parent === 'object') {\n if (parent === null) {\n parent = {}\n }\n return {\n ...parent,\n [key]: doSet(parent[key]),\n }\n }\n return {\n [key]: doSet(),\n }\n }\n\n if (Array.isArray(parent) && typeof key === 'number') {\n const prefix = parent.slice(0, key)\n return [\n ...(prefix.length ? prefix : new Array(key)),\n doSet(parent[key]),\n ...parent.slice(key + 1),\n ]\n }\n return [...new Array(key), doSet()]\n }\n\n return doSet(obj)\n}\n\n/**\n * Delete a field on an object using a path, including dot notation.\n * @private\n */\nexport function deleteBy(obj: any, _path: any) {\n const path = makePathArray(_path)\n\n function doDelete(parent: any): any {\n if (!parent) return\n if (path.length === 1) {\n const finalPath = path[0]!\n if (Array.isArray(parent) && typeof finalPath === 'number') {\n return parent.filter((_, i) => i !== finalPath)\n }\n const { [finalPath]: remove, ...rest } = parent\n return rest\n }\n\n const key = path.shift()\n\n if (typeof key === 'string') {\n if (typeof parent === 'object') {\n return {\n ...parent,\n [key]: doDelete(parent[key]),\n }\n }\n }\n\n if (typeof key === 'number') {\n if (Array.isArray(parent)) {\n if (key >= parent.length) {\n return parent\n }\n const prefix = parent.slice(0, key)\n return [\n ...(prefix.length ? prefix : new Array(key)),\n doDelete(parent[key]),\n ...parent.slice(key + 1),\n ]\n }\n }\n\n throw new Error('It seems we have created an infinite loop in deleteBy. ')\n }\n\n return doDelete(obj)\n}\n\nconst reLineOfOnlyDigits = /^(\\d+)$/gm\n// the second dot must be in a lookahead or the engine\n// will skip subsequent numbers (like foo.0.1.)\nconst reDigitsBetweenDots = /\\.(\\d+)(?=\\.)/gm\nconst reStartWithDigitThenDot = /^(\\d+)\\./gm\nconst reDotWithDigitsToEnd = /\\.(\\d+$)/gm\nconst reMultipleDots = /\\.{2,}/gm\n\nconst intPrefix = '__int__'\nconst intReplace = `${intPrefix}$1`\n\n/**\n * @private\n */\nexport function makePathArray(str: string | Array<string | number>) {\n if (Array.isArray(str)) {\n return [...str]\n }\n\n if (typeof str !== 'string') {\n throw new Error('Path must be a string.')\n }\n\n return (\n str\n // Leading `[` may lead to wrong parsing down the line\n // (Example: '[0][1]' should be '0.1', not '.0.1')\n .replace(/(^\\[)|]/gm, '')\n .replace(/\\[/g, '.')\n .replace(reLineOfOnlyDigits, intReplace)\n .replace(reDigitsBetweenDots, `.${intReplace}.`)\n .replace(reStartWithDigitThenDot, `${intReplace}.`)\n .replace(reDotWithDigitsToEnd, `.${intReplace}`)\n .replace(reMultipleDots, '.')\n .split('.')\n .map((d) => {\n if (d.indexOf(intPrefix) === 0) {\n return parseInt(d.substring(intPrefix.length), 10)\n }\n return d\n })\n )\n}\n\n/**\n * @private\n */\nexport function isNonEmptyArray(obj: any) {\n return !(Array.isArray(obj) && obj.length === 0)\n}\n\ninterface AsyncValidatorArrayPartialOptions<T> {\n validators?: T\n asyncDebounceMs?: number\n}\n\n/**\n * @private\n */\nexport interface AsyncValidator<T> {\n cause: ValidationCause\n validate: T\n debounceMs: number\n}\n\n/**\n * @private\n */\nexport function getAsyncValidatorArray<T>(\n cause: ValidationCause,\n options: AsyncValidatorArrayPartialOptions<T>,\n): T extends FieldValidators<any, any, any, any, any, any, any, any, any, any>\n ? Array<\n AsyncValidator<T['onChangeAsync'] | T['onBlurAsync'] | T['onSubmitAsync']>\n >\n : T extends FormValidators<any, any, any, any, any, any, any, any>\n ? Array<\n AsyncValidator<\n T['onChangeAsync'] | T['onBlurAsync'] | T['onSubmitAsync']\n >\n >\n : never {\n const { asyncDebounceMs } = options\n const {\n onChangeAsync,\n onBlurAsync,\n onSubmitAsync,\n onBlurAsyncDebounceMs,\n onChangeAsyncDebounceMs,\n } = (options.validators || {}) as\n | FieldValidators<any, any, any, any, any, any, any, any, any, any>\n | FormValidators<any, any, any, any, any, any, any, any>\n\n const defaultDebounceMs = asyncDebounceMs ?? 0\n\n const changeValidator = {\n cause: 'change',\n validate: onChangeAsync,\n debounceMs: onChangeAsyncDebounceMs ?? defaultDebounceMs,\n } as const\n\n const blurValidator = {\n cause: 'blur',\n validate: onBlurAsync,\n debounceMs: onBlurAsyncDebounceMs ?? defaultDebounceMs,\n } as const\n\n const submitValidator = {\n cause: 'submit',\n validate: onSubmitAsync,\n debounceMs: 0,\n } as const\n\n const noopValidator = (\n validator:\n | typeof changeValidator\n | typeof blurValidator\n | typeof submitValidator,\n ) => ({ ...validator, debounceMs: 0 }) as const\n\n switch (cause) {\n case 'submit':\n return [\n noopValidator(changeValidator),\n noopValidator(blurValidator),\n submitValidator,\n ] as never\n case 'blur':\n return [blurValidator] as never\n case 'change':\n return [changeValidator] as never\n case 'server':\n default:\n return [] as never\n }\n}\n\ninterface SyncValidatorArrayPartialOptions<T> {\n validators?: T\n}\n\n/**\n * @private\n */\nexport interface SyncValidator<T> {\n cause: ValidationCause\n validate: T\n}\n\n/**\n * @private\n */\nexport function getSyncValidatorArray<T>(\n cause: ValidationCause,\n options: SyncValidatorArrayPartialOptions<T>,\n): T extends FieldValidators<any, any, any, any, any, any, any, any, any, any>\n ? Array<\n SyncValidator<T['onChange'] | T['onBlur'] | T['onSubmit'] | T['onMount']>\n >\n : T extends FormValidators<any, any, any, any, any, any, any, any>\n ? Array<\n SyncValidator<\n T['onChange'] | T['onBlur'] | T['onSubmit'] | T['onMount']\n >\n >\n : never {\n const { onChange, onBlur, onSubmit, onMount } = (options.validators || {}) as\n | FieldValidators<any, any, any, any, any, any, any, any, any, any>\n | FormValidators<any, any, any, any, any, any, any, any>\n\n const changeValidator = { cause: 'change', validate: onChange } as const\n const blurValidator = { cause: 'blur', validate: onBlur } as const\n const submitValidator = { cause: 'submit', validate: onSubmit } as const\n const mountValidator = { cause: 'mount', validate: onMount } as const\n\n // Allows us to clear onServer errors\n const serverValidator = {\n cause: 'server',\n validate: () => undefined,\n } as const\n\n switch (cause) {\n case 'mount':\n return [mountValidator] as never\n case 'submit':\n return [\n changeValidator,\n blurValidator,\n submitValidator,\n serverValidator,\n ] as never\n case 'server':\n return [serverValidator] as never\n case 'blur':\n return [blurValidator, serverValidator] as never\n case 'change':\n default:\n return [changeValidator, serverValidator] as never\n }\n}\n\nexport const isGlobalFormValidationError = (\n error: unknown,\n): error is GlobalFormValidationError<unknown> => {\n return !!error && typeof error === 'object' && 'fields' in error\n}\n\nexport function evaluate<T>(objA: T, objB: T) {\n if (Object.is(objA, objB)) {\n return true\n }\n\n if (\n typeof objA !== 'object' ||\n objA === null ||\n typeof objB !== 'object' ||\n objB === null\n ) {\n return false\n }\n\n if (objA instanceof Map && objB instanceof Map) {\n if (objA.size !== objB.size) return false\n for (const [k, v] of objA) {\n if (!objB.has(k) || !Object.is(v, objB.get(k))) return false\n }\n return true\n }\n\n if (objA instanceof Set && objB instanceof Set) {\n if (objA.size !== objB.size) return false\n for (const v of objA) {\n if (!objB.has(v)) return false\n }\n return true\n }\n\n const keysA = Object.keys(objA)\n const keysB = Object.keys(objB)\n\n if (keysA.length !== keysB.length) {\n return false\n }\n\n for (const key of keysA) {\n // performs recursive search down the object tree\n\n if (\n !keysB.includes(key) ||\n !evaluate(objA[key as keyof T], objB[key as keyof T])\n ) {\n return false\n }\n }\n\n return true\n}\n\n/**\n * Determines the logic for determining the error source and value to set on the field meta within the form level sync/async validation.\n * @private\n */\nexport const determineFormLevelErrorSourceAndValue = ({\n newFormValidatorError,\n isPreviousErrorFromFormValidator,\n previousErrorValue,\n}: {\n newFormValidatorError: ValidationError\n isPreviousErrorFromFormValidator: boolean\n previousErrorValue: ValidationError\n}): {\n newErrorValue: ValidationError\n newSource: ValidationSource | undefined\n} => {\n // All falsy values are not considered errors\n if (newFormValidatorError) {\n return { newErrorValue: newFormValidatorError, newSource: 'form' }\n }\n\n // Clears form level error since it's now stale\n if (isPreviousErrorFromFormValidator) {\n return { newErrorValue: undefined, newSource: undefined }\n }\n\n // At this point, we have a preivous error which must have been set by the field validator, keep as is\n if (previousErrorValue) {\n return { newErrorValue: previousErrorValue, newSource: 'field' }\n }\n\n // No new or previous error, clear the error\n return { newErrorValue: undefined, newSource: undefined }\n}\n\n/**\n * Determines the logic for determining the error source and value to set on the field meta within the field level sync/async validation.\n * @private\n */\nexport const determineFieldLevelErrorSourceAndValue = ({\n formLevelError,\n fieldLevelError,\n}: {\n formLevelError: ValidationError\n fieldLevelError: ValidationError\n}): {\n newErrorValue: ValidationError\n newSource: ValidationSource | undefined\n} => {\n // At field level, we prioritize the field level error\n if (fieldLevelError) {\n return { newErrorValue: fieldLevelError, newSource: 'field' }\n }\n\n // If there is no field level error, and there is a form level error, we set the form level error\n if (formLevelError) {\n return { newErrorValue: formLevelError, newSource: 'form' }\n }\n\n return { newErrorValue: undefined, newSource: undefined }\n}\n"],"names":[],"mappings":"AAkBgB,SAAA,iBACd,SACA,OACS;AACT,SAAO,OAAO,YAAY,aACrB,QAAuC,KAAK,IAC7C;AACN;AAMgB,SAAA,MAAM,KAAU,MAAW;AACnC,QAAA,UAAU,cAAc,IAAI;AAClC,SAAO,QAAQ,OAAO,CAAC,SAAc,aAAkB;AACjD,QAAA,YAAY,KAAa,QAAA;AACzB,QAAA,OAAO,YAAY,aAAa;AAClC,aAAO,QAAQ,QAAQ;AAAA,IAAA;AAElB,WAAA;AAAA,KACN,GAAG;AACR;AAMgB,SAAA,MAAM,KAAU,OAAY,SAAuB;AAC3D,QAAA,OAAO,cAAc,KAAK;AAEhC,WAAS,MAAM,QAAmB;AAC5B,QAAA,CAAC,KAAK,QAAQ;AACT,aAAA,iBAAiB,SAAS,MAAM;AAAA,IAAA;AAGnC,UAAA,MAAM,KAAK,MAAM;AAGrB,QAAA,OAAO,QAAQ,YACd,OAAO,QAAQ,YAAY,CAAC,MAAM,QAAQ,MAAM,GACjD;AACI,UAAA,OAAO,WAAW,UAAU;AAC9B,YAAI,WAAW,MAAM;AACnB,mBAAS,CAAC;AAAA,QAAA;AAEL,eAAA;AAAA,UACL,GAAG;AAAA,UACH,CAAC,GAAG,GAAG,MAAM,OAAO,GAAG,CAAC;AAAA,QAC1B;AAAA,MAAA;AAEK,aAAA;AAAA,QACL,CAAC,GAAG,GAAG,MAAM;AAAA,MACf;AAAA,IAAA;AAGF,QAAI,MAAM,QAAQ,MAAM,KAAK,OAAO,QAAQ,UAAU;AACpD,YAAM,SAAS,OAAO,MAAM,GAAG,GAAG;AAC3B,aAAA;AAAA,QACL,GAAI,OAAO,SAAS,SAAS,IAAI,MAAM,GAAG;AAAA,QAC1C,MAAM,OAAO,GAAG,CAAC;AAAA,QACjB,GAAG,OAAO,MAAM,MAAM,CAAC;AAAA,MACzB;AAAA,IAAA;AAEF,WAAO,CAAC,GAAG,IAAI,MAAM,GAAG,GAAG,OAAO;AAAA,EAAA;AAGpC,SAAO,MAAM,GAAG;AAClB;AAMgB,SAAA,SAAS,KAAU,OAAY;AACvC,QAAA,OAAO,cAAc,KAAK;AAEhC,WAAS,SAAS,QAAkB;AAClC,QAAI,CAAC,OAAQ;AACT,QAAA,KAAK,WAAW,GAAG;AACf,YAAA,YAAY,KAAK,CAAC;AACxB,UAAI,MAAM,QAAQ,MAAM,KAAK,OAAO,cAAc,UAAU;AAC1D,eAAO,OAAO,OAAO,CAAC,GAAG,MAAM,MAAM,SAAS;AAAA,MAAA;AAEhD,YAAM,EAAE,CAAC,SAAS,GAAG,QAAQ,GAAG,KAAS,IAAA;AAClC,aAAA;AAAA,IAAA;AAGH,UAAA,MAAM,KAAK,MAAM;AAEnB,QAAA,OAAO,QAAQ,UAAU;AACvB,UAAA,OAAO,WAAW,UAAU;AACvB,eAAA;AAAA,UACL,GAAG;AAAA,UACH,CAAC,GAAG,GAAG,SAAS,OAAO,GAAG,CAAC;AAAA,QAC7B;AAAA,MAAA;AAAA,IACF;AAGE,QAAA,OAAO,QAAQ,UAAU;AACvB,UAAA,MAAM,QAAQ,MAAM,GAAG;AACrB,YAAA,OAAO,OAAO,QAAQ;AACjB,iBAAA;AAAA,QAAA;AAET,cAAM,SAAS,OAAO,MAAM,GAAG,GAAG;AAC3B,eAAA;AAAA,UACL,GAAI,OAAO,SAAS,SAAS,IAAI,MAAM,GAAG;AAAA,UAC1C,SAAS,OAAO,GAAG,CAAC;AAAA,UACpB,GAAG,OAAO,MAAM,MAAM,CAAC;AAAA,QACzB;AAAA,MAAA;AAAA,IACF;AAGI,UAAA,IAAI,MAAM,yDAAyD;AAAA,EAAA;AAG3E,SAAO,SAAS,GAAG;AACrB;AAEA,MAAM,qBAAqB;AAG3B,MAAM,sBAAsB;AAC5B,MAAM,0BAA0B;AAChC,MAAM,uBAAuB;AAC7B,MAAM,iBAAiB;AAEvB,MAAM,YAAY;AAClB,MAAM,aAAa,GAAG,SAAS;AAKxB,SAAS,cAAc,KAAsC;AAC9D,MAAA,MAAM,QAAQ,GAAG,GAAG;AACf,WAAA,CAAC,GAAG,GAAG;AAAA,EAAA;AAGZ,MAAA,OAAO,QAAQ,UAAU;AACrB,UAAA,IAAI,MAAM,wBAAwB;AAAA,EAAA;AAG1C,SACE,IAGG,QAAQ,aAAa,EAAE,EACvB,QAAQ,OAAO,GAAG,EAClB,QAAQ,oBAAoB,UAAU,EACtC,QAAQ,qBAAqB,IAAI,UAAU,GAAG,EAC9C,QAAQ,yBAAyB,GAAG,UAAU,GAAG,EACjD,QAAQ,sBAAsB,IAAI,UAAU,EAAE,EAC9C,QAAQ,gBAAgB,GAAG,EAC3B,MAAM,GAAG,EACT,IAAI,CAAC,MAAM;AACV,QAAI,EAAE,QAAQ,SAAS,MAAM,GAAG;AAC9B,aAAO,SAAS,EAAE,UAAU,UAAU,MAAM,GAAG,EAAE;AAAA,IAAA;AAE5C,WAAA;AAAA,EAAA,CACR;AAEP;AAKO,SAAS,gBAAgB,KAAU;AACxC,SAAO,EAAE,MAAM,QAAQ,GAAG,KAAK,IAAI,WAAW;AAChD;AAmBgB,SAAA,uBACd,OACA,SAWU;AACJ,QAAA,EAAE,oBAAoB;AACtB,QAAA;AAAA,IACJ;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EAAA,IACG,QAAQ,cAAc,CAAC;AAI5B,QAAM,oBAAoB,mBAAmB;AAE7C,QAAM,kBAAkB;AAAA,IACtB,OAAO;AAAA,IACP,UAAU;AAAA,IACV,YAAY,2BAA2B;AAAA,EACzC;AAEA,QAAM,gBAAgB;AAAA,IACpB,OAAO;AAAA,IACP,UAAU;AAAA,IACV,YAAY,yBAAyB;AAAA,EACvC;AAEA,QAAM,kBAAkB;AAAA,IACtB,OAAO;AAAA,IACP,UAAU;AAAA,IACV,YAAY;AAAA,EACd;AAEA,QAAM,gBAAgB,CACpB,eAII,EAAE,GAAG,WAAW,YAAY;AAElC,UAAQ,OAAO;AAAA,IACb,KAAK;AACI,aAAA;AAAA,QACL,cAAc,eAAe;AAAA,QAC7B,cAAc,aAAa;AAAA,QAC3B;AAAA,MACF;AAAA,IACF,KAAK;AACH,aAAO,CAAC,aAAa;AAAA,IACvB,KAAK;AACH,aAAO,CAAC,eAAe;AAAA,IACzB,KAAK;AAAA,IACL;AACE,aAAO,CAAC;AAAA,EAAA;AAEd;AAiBgB,SAAA,sBACd,OACA,SAWU;AACJ,QAAA,EAAE,UAAU,QAAQ,UAAU,YAAa,QAAQ,cAAc,CAAC;AAIxE,QAAM,kBAAkB,EAAE,OAAO,UAAU,UAAU,SAAS;AAC9D,QAAM,gBAAgB,EAAE,OAAO,QAAQ,UAAU,OAAO;AACxD,QAAM,kBAAkB,EAAE,OAAO,UAAU,UAAU,SAAS;AAC9D,QAAM,iBAAiB,EAAE,OAAO,SAAS,UAAU,QAAQ;AAG3D,QAAM,kBAAkB;AAAA,IACtB,OAAO;AAAA,IACP,UAAU,MAAM;AAAA,EAClB;AAEA,UAAQ,OAAO;AAAA,IACb,KAAK;AACH,aAAO,CAAC,cAAc;AAAA,IACxB,KAAK;AACI,aAAA;AAAA,QACL;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAAA,IACF,KAAK;AACH,aAAO,CAAC,eAAe;AAAA,IACzB,KAAK;AACI,aAAA,CAAC,eAAe,eAAe;AAAA,IACxC,KAAK;AAAA,IACL;AACS,aAAA,CAAC,iBAAiB,eAAe;AAAA,EAAA;AAE9C;AAEa,MAAA,8BAA8B,CACzC,UACgD;AAChD,SAAO,CAAC,CAAC,SAAS,OAAO,UAAU,YAAY,YAAY;AAC7D;AAEgB,SAAA,SAAY,MAAS,MAAS;AAC5C,MAAI,OAAO,GAAG,MAAM,IAAI,GAAG;AAClB,WAAA;AAAA,EAAA;AAIP,MAAA,OAAO,SAAS,YAChB,SAAS,QACT,OAAO,SAAS,YAChB,SAAS,MACT;AACO,WAAA;AAAA,EAAA;AAGL,MAAA,gBAAgB,OAAO,gBAAgB,KAAK;AAC9C,QAAI,KAAK,SAAS,KAAK,KAAa,QAAA;AACpC,eAAW,CAAC,GAAG,CAAC,KAAK,MAAM;AACzB,UAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,GAAG,KAAK,IAAI,CAAC,CAAC,EAAU,QAAA;AAAA,IAAA;AAElD,WAAA;AAAA,EAAA;AAGL,MAAA,gBAAgB,OAAO,gBAAgB,KAAK;AAC9C,QAAI,KAAK,SAAS,KAAK,KAAa,QAAA;AACpC,eAAW,KAAK,MAAM;AACpB,UAAI,CAAC,KAAK,IAAI,CAAC,EAAU,QAAA;AAAA,IAAA;AAEpB,WAAA;AAAA,EAAA;AAGH,QAAA,QAAQ,OAAO,KAAK,IAAI;AACxB,QAAA,QAAQ,OAAO,KAAK,IAAI;AAE1B,MAAA,MAAM,WAAW,MAAM,QAAQ;AAC1B,WAAA;AAAA,EAAA;AAGT,aAAW,OAAO,OAAO;AAGvB,QACE,CAAC,MAAM,SAAS,GAAG,KACnB,CAAC,SAAS,KAAK,GAAc,GAAG,KAAK,GAAc,CAAC,GACpD;AACO,aAAA;AAAA,IAAA;AAAA,EACT;AAGK,SAAA;AACT;AAMO,MAAM,wCAAwC,CAAC;AAAA,EACpD;AAAA,EACA;AAAA,EACA;AACF,MAOK;AAEH,MAAI,uBAAuB;AACzB,WAAO,EAAE,eAAe,uBAAuB,WAAW,OAAO;AAAA,EAAA;AAInE,MAAI,kCAAkC;AACpC,WAAO,EAAE,eAAe,QAAW,WAAW,OAAU;AAAA,EAAA;AAI1D,MAAI,oBAAoB;AACtB,WAAO,EAAE,eAAe,oBAAoB,WAAW,QAAQ;AAAA,EAAA;AAIjE,SAAO,EAAE,eAAe,QAAW,WAAW,OAAU;AAC1D;AAMO,MAAM,yCAAyC,CAAC;AAAA,EACrD;AAAA,EACA;AACF,MAMK;AAEH,MAAI,iBAAiB;AACnB,WAAO,EAAE,eAAe,iBAAiB,WAAW,QAAQ;AAAA,EAAA;AAI9D,MAAI,gBAAgB;AAClB,WAAO,EAAE,eAAe,gBAAgB,WAAW,OAAO;AAAA,EAAA;AAG5D,SAAO,EAAE,eAAe,QAAW,WAAW,OAAU;AAC1D;"}
|
|
1
|
+
{"version":3,"file":"utils.js","sources":["../../src/utils.ts"],"sourcesContent":["import type { FieldValidators } from './FieldApi'\nimport type { FormValidators } from './FormApi'\nimport type {\n GlobalFormValidationError,\n ValidationCause,\n ValidationError,\n ValidationSource,\n} from './types'\n\nexport type UpdaterFn<TInput, TOutput = TInput> = (input: TInput) => TOutput\n\nexport type Updater<TInput, TOutput = TInput> =\n | TOutput\n | UpdaterFn<TInput, TOutput>\n\n/**\n * @private\n */\nexport function functionalUpdate<TInput, TOutput = TInput>(\n updater: Updater<TInput, TOutput>,\n input: TInput,\n): TOutput {\n return typeof updater === 'function'\n ? (updater as UpdaterFn<TInput, TOutput>)(input)\n : updater\n}\n\n/**\n * Get a value from an object using a path, including dot notation.\n * @private\n */\nexport function getBy(obj: any, path: any) {\n const pathObj = makePathArray(path)\n return pathObj.reduce((current: any, pathPart: any) => {\n if (current === null) return null\n if (typeof current !== 'undefined') {\n return current[pathPart]\n }\n return undefined\n }, obj)\n}\n\n/**\n * Set a value on an object using a path, including dot notation.\n * @private\n */\nexport function setBy(obj: any, _path: any, updater: Updater<any>) {\n const path = makePathArray(_path)\n\n function doSet(parent?: any): any {\n if (!path.length) {\n return functionalUpdate(updater, parent)\n }\n\n const key = path.shift()\n\n if (\n typeof key === 'string' ||\n (typeof key === 'number' && !Array.isArray(parent))\n ) {\n if (typeof parent === 'object') {\n if (parent === null) {\n parent = {}\n }\n return {\n ...parent,\n [key]: doSet(parent[key]),\n }\n }\n return {\n [key]: doSet(),\n }\n }\n\n if (Array.isArray(parent) && typeof key === 'number') {\n const prefix = parent.slice(0, key)\n return [\n ...(prefix.length ? prefix : new Array(key)),\n doSet(parent[key]),\n ...parent.slice(key + 1),\n ]\n }\n return [...new Array(key), doSet()]\n }\n\n return doSet(obj)\n}\n\n/**\n * Delete a field on an object using a path, including dot notation.\n * @private\n */\nexport function deleteBy(obj: any, _path: any) {\n const path = makePathArray(_path)\n\n function doDelete(parent: any): any {\n if (!parent) return\n if (path.length === 1) {\n const finalPath = path[0]!\n if (Array.isArray(parent) && typeof finalPath === 'number') {\n return parent.filter((_, i) => i !== finalPath)\n }\n const { [finalPath]: remove, ...rest } = parent\n return rest\n }\n\n const key = path.shift()\n\n if (typeof key === 'string') {\n if (typeof parent === 'object') {\n return {\n ...parent,\n [key]: doDelete(parent[key]),\n }\n }\n }\n\n if (typeof key === 'number') {\n if (Array.isArray(parent)) {\n if (key >= parent.length) {\n return parent\n }\n const prefix = parent.slice(0, key)\n return [\n ...(prefix.length ? prefix : new Array(key)),\n doDelete(parent[key]),\n ...parent.slice(key + 1),\n ]\n }\n }\n\n throw new Error('It seems we have created an infinite loop in deleteBy. ')\n }\n\n return doDelete(obj)\n}\n\nconst reLineOfOnlyDigits = /^(\\d+)$/gm\n// the second dot must be in a lookahead or the engine\n// will skip subsequent numbers (like foo.0.1.)\nconst reDigitsBetweenDots = /\\.(\\d+)(?=\\.)/gm\nconst reStartWithDigitThenDot = /^(\\d+)\\./gm\nconst reDotWithDigitsToEnd = /\\.(\\d+$)/gm\nconst reMultipleDots = /\\.{2,}/gm\n\nconst intPrefix = '__int__'\nconst intReplace = `${intPrefix}$1`\n\n/**\n * @private\n */\nexport function makePathArray(str: string | Array<string | number>) {\n if (Array.isArray(str)) {\n return [...str]\n }\n\n if (typeof str !== 'string') {\n throw new Error('Path must be a string.')\n }\n\n return (\n str\n // Leading `[` may lead to wrong parsing down the line\n // (Example: '[0][1]' should be '0.1', not '.0.1')\n .replace(/(^\\[)|]/gm, '')\n .replace(/\\[/g, '.')\n .replace(reLineOfOnlyDigits, intReplace)\n .replace(reDigitsBetweenDots, `.${intReplace}.`)\n .replace(reStartWithDigitThenDot, `${intReplace}.`)\n .replace(reDotWithDigitsToEnd, `.${intReplace}`)\n .replace(reMultipleDots, '.')\n .split('.')\n .map((d) => {\n if (d.startsWith(intPrefix)) {\n const numStr = d.substring(intPrefix.length)\n const num = parseInt(numStr, 10)\n\n if (String(num) === numStr) {\n return num\n }\n return numStr\n }\n return d\n })\n )\n}\n\n/**\n * @private\n */\nexport function concatenatePaths(path1: string, path2: string): string {\n if (path1.length === 0) return path2\n if (path2.length === 0) return path1\n\n if (path2.startsWith('[')) {\n return path1 + path2\n }\n\n return `${path1}.${path2}`\n}\n\n/**\n * @private\n */\nexport function isNonEmptyArray(obj: any) {\n return !(Array.isArray(obj) && obj.length === 0)\n}\n\ninterface AsyncValidatorArrayPartialOptions<T> {\n validators?: T\n asyncDebounceMs?: number\n}\n\n/**\n * @private\n */\nexport interface AsyncValidator<T> {\n cause: ValidationCause\n validate: T\n debounceMs: number\n}\n\n/**\n * @private\n */\nexport function getAsyncValidatorArray<T>(\n cause: ValidationCause,\n options: AsyncValidatorArrayPartialOptions<T>,\n): T extends FieldValidators<any, any, any, any, any, any, any, any, any, any>\n ? Array<\n AsyncValidator<T['onChangeAsync'] | T['onBlurAsync'] | T['onSubmitAsync']>\n >\n : T extends FormValidators<any, any, any, any, any, any, any, any>\n ? Array<\n AsyncValidator<\n T['onChangeAsync'] | T['onBlurAsync'] | T['onSubmitAsync']\n >\n >\n : never {\n const { asyncDebounceMs } = options\n const {\n onChangeAsync,\n onBlurAsync,\n onSubmitAsync,\n onBlurAsyncDebounceMs,\n onChangeAsyncDebounceMs,\n } = (options.validators || {}) as\n | FieldValidators<any, any, any, any, any, any, any, any, any, any>\n | FormValidators<any, any, any, any, any, any, any, any>\n\n const defaultDebounceMs = asyncDebounceMs ?? 0\n\n const changeValidator = {\n cause: 'change',\n validate: onChangeAsync,\n debounceMs: onChangeAsyncDebounceMs ?? defaultDebounceMs,\n } as const\n\n const blurValidator = {\n cause: 'blur',\n validate: onBlurAsync,\n debounceMs: onBlurAsyncDebounceMs ?? defaultDebounceMs,\n } as const\n\n const submitValidator = {\n cause: 'submit',\n validate: onSubmitAsync,\n debounceMs: 0,\n } as const\n\n const noopValidator = (\n validator:\n | typeof changeValidator\n | typeof blurValidator\n | typeof submitValidator,\n ) => ({ ...validator, debounceMs: 0 }) as const\n\n switch (cause) {\n case 'submit':\n return [\n noopValidator(changeValidator),\n noopValidator(blurValidator),\n submitValidator,\n ] as never\n case 'blur':\n return [blurValidator] as never\n case 'change':\n return [changeValidator] as never\n case 'server':\n default:\n return [] as never\n }\n}\n\ninterface SyncValidatorArrayPartialOptions<T> {\n validators?: T\n}\n\n/**\n * @private\n */\nexport interface SyncValidator<T> {\n cause: ValidationCause\n validate: T\n}\n\n/**\n * @private\n */\nexport function getSyncValidatorArray<T>(\n cause: ValidationCause,\n options: SyncValidatorArrayPartialOptions<T>,\n): T extends FieldValidators<any, any, any, any, any, any, any, any, any, any>\n ? Array<\n SyncValidator<T['onChange'] | T['onBlur'] | T['onSubmit'] | T['onMount']>\n >\n : T extends FormValidators<any, any, any, any, any, any, any, any>\n ? Array<\n SyncValidator<\n T['onChange'] | T['onBlur'] | T['onSubmit'] | T['onMount']\n >\n >\n : never {\n const { onChange, onBlur, onSubmit, onMount } = (options.validators || {}) as\n | FieldValidators<any, any, any, any, any, any, any, any, any, any>\n | FormValidators<any, any, any, any, any, any, any, any>\n\n const changeValidator = { cause: 'change', validate: onChange } as const\n const blurValidator = { cause: 'blur', validate: onBlur } as const\n const submitValidator = { cause: 'submit', validate: onSubmit } as const\n const mountValidator = { cause: 'mount', validate: onMount } as const\n\n // Allows us to clear onServer errors\n const serverValidator = {\n cause: 'server',\n validate: () => undefined,\n } as const\n\n switch (cause) {\n case 'mount':\n return [mountValidator] as never\n case 'submit':\n return [\n changeValidator,\n blurValidator,\n submitValidator,\n serverValidator,\n ] as never\n case 'server':\n return [serverValidator] as never\n case 'blur':\n return [blurValidator, serverValidator] as never\n case 'change':\n default:\n return [changeValidator, serverValidator] as never\n }\n}\n\nexport const isGlobalFormValidationError = (\n error: unknown,\n): error is GlobalFormValidationError<unknown> => {\n return !!error && typeof error === 'object' && 'fields' in error\n}\n\nexport function evaluate<T>(objA: T, objB: T) {\n if (Object.is(objA, objB)) {\n return true\n }\n\n if (\n typeof objA !== 'object' ||\n objA === null ||\n typeof objB !== 'object' ||\n objB === null\n ) {\n return false\n }\n\n if (objA instanceof Map && objB instanceof Map) {\n if (objA.size !== objB.size) return false\n for (const [k, v] of objA) {\n if (!objB.has(k) || !Object.is(v, objB.get(k))) return false\n }\n return true\n }\n\n if (objA instanceof Set && objB instanceof Set) {\n if (objA.size !== objB.size) return false\n for (const v of objA) {\n if (!objB.has(v)) return false\n }\n return true\n }\n\n const keysA = Object.keys(objA)\n const keysB = Object.keys(objB)\n\n if (keysA.length !== keysB.length) {\n return false\n }\n\n for (const key of keysA) {\n // performs recursive search down the object tree\n\n if (\n !keysB.includes(key) ||\n !evaluate(objA[key as keyof T], objB[key as keyof T])\n ) {\n return false\n }\n }\n\n return true\n}\n\n/**\n * Determines the logic for determining the error source and value to set on the field meta within the form level sync/async validation.\n * @private\n */\nexport const determineFormLevelErrorSourceAndValue = ({\n newFormValidatorError,\n isPreviousErrorFromFormValidator,\n previousErrorValue,\n}: {\n newFormValidatorError: ValidationError\n isPreviousErrorFromFormValidator: boolean\n previousErrorValue: ValidationError\n}): {\n newErrorValue: ValidationError\n newSource: ValidationSource | undefined\n} => {\n // All falsy values are not considered errors\n if (newFormValidatorError) {\n return { newErrorValue: newFormValidatorError, newSource: 'form' }\n }\n\n // Clears form level error since it's now stale\n if (isPreviousErrorFromFormValidator) {\n return { newErrorValue: undefined, newSource: undefined }\n }\n\n // At this point, we have a preivous error which must have been set by the field validator, keep as is\n if (previousErrorValue) {\n return { newErrorValue: previousErrorValue, newSource: 'field' }\n }\n\n // No new or previous error, clear the error\n return { newErrorValue: undefined, newSource: undefined }\n}\n\n/**\n * Determines the logic for determining the error source and value to set on the field meta within the field level sync/async validation.\n * @private\n */\nexport const determineFieldLevelErrorSourceAndValue = ({\n formLevelError,\n fieldLevelError,\n}: {\n formLevelError: ValidationError\n fieldLevelError: ValidationError\n}): {\n newErrorValue: ValidationError\n newSource: ValidationSource | undefined\n} => {\n // At field level, we prioritize the field level error\n if (fieldLevelError) {\n return { newErrorValue: fieldLevelError, newSource: 'field' }\n }\n\n // If there is no field level error, and there is a form level error, we set the form level error\n if (formLevelError) {\n return { newErrorValue: formLevelError, newSource: 'form' }\n }\n\n return { newErrorValue: undefined, newSource: undefined }\n}\n\nexport function createFieldMap<T>(values: Readonly<T>): { [K in keyof T]: K } {\n const output: { [K in keyof T]: K } = {} as any\n\n for (const key in values) {\n output[key] = key\n }\n\n return output\n}\n"],"names":[],"mappings":"AAkBgB,SAAA,iBACd,SACA,OACS;AACT,SAAO,OAAO,YAAY,aACrB,QAAuC,KAAK,IAC7C;AACN;AAMgB,SAAA,MAAM,KAAU,MAAW;AACnC,QAAA,UAAU,cAAc,IAAI;AAClC,SAAO,QAAQ,OAAO,CAAC,SAAc,aAAkB;AACjD,QAAA,YAAY,KAAa,QAAA;AACzB,QAAA,OAAO,YAAY,aAAa;AAClC,aAAO,QAAQ,QAAQ;AAAA,IAAA;AAElB,WAAA;AAAA,KACN,GAAG;AACR;AAMgB,SAAA,MAAM,KAAU,OAAY,SAAuB;AAC3D,QAAA,OAAO,cAAc,KAAK;AAEhC,WAAS,MAAM,QAAmB;AAC5B,QAAA,CAAC,KAAK,QAAQ;AACT,aAAA,iBAAiB,SAAS,MAAM;AAAA,IAAA;AAGnC,UAAA,MAAM,KAAK,MAAM;AAGrB,QAAA,OAAO,QAAQ,YACd,OAAO,QAAQ,YAAY,CAAC,MAAM,QAAQ,MAAM,GACjD;AACI,UAAA,OAAO,WAAW,UAAU;AAC9B,YAAI,WAAW,MAAM;AACnB,mBAAS,CAAC;AAAA,QAAA;AAEL,eAAA;AAAA,UACL,GAAG;AAAA,UACH,CAAC,GAAG,GAAG,MAAM,OAAO,GAAG,CAAC;AAAA,QAC1B;AAAA,MAAA;AAEK,aAAA;AAAA,QACL,CAAC,GAAG,GAAG,MAAM;AAAA,MACf;AAAA,IAAA;AAGF,QAAI,MAAM,QAAQ,MAAM,KAAK,OAAO,QAAQ,UAAU;AACpD,YAAM,SAAS,OAAO,MAAM,GAAG,GAAG;AAC3B,aAAA;AAAA,QACL,GAAI,OAAO,SAAS,SAAS,IAAI,MAAM,GAAG;AAAA,QAC1C,MAAM,OAAO,GAAG,CAAC;AAAA,QACjB,GAAG,OAAO,MAAM,MAAM,CAAC;AAAA,MACzB;AAAA,IAAA;AAEF,WAAO,CAAC,GAAG,IAAI,MAAM,GAAG,GAAG,OAAO;AAAA,EAAA;AAGpC,SAAO,MAAM,GAAG;AAClB;AAMgB,SAAA,SAAS,KAAU,OAAY;AACvC,QAAA,OAAO,cAAc,KAAK;AAEhC,WAAS,SAAS,QAAkB;AAClC,QAAI,CAAC,OAAQ;AACT,QAAA,KAAK,WAAW,GAAG;AACf,YAAA,YAAY,KAAK,CAAC;AACxB,UAAI,MAAM,QAAQ,MAAM,KAAK,OAAO,cAAc,UAAU;AAC1D,eAAO,OAAO,OAAO,CAAC,GAAG,MAAM,MAAM,SAAS;AAAA,MAAA;AAEhD,YAAM,EAAE,CAAC,SAAS,GAAG,QAAQ,GAAG,KAAS,IAAA;AAClC,aAAA;AAAA,IAAA;AAGH,UAAA,MAAM,KAAK,MAAM;AAEnB,QAAA,OAAO,QAAQ,UAAU;AACvB,UAAA,OAAO,WAAW,UAAU;AACvB,eAAA;AAAA,UACL,GAAG;AAAA,UACH,CAAC,GAAG,GAAG,SAAS,OAAO,GAAG,CAAC;AAAA,QAC7B;AAAA,MAAA;AAAA,IACF;AAGE,QAAA,OAAO,QAAQ,UAAU;AACvB,UAAA,MAAM,QAAQ,MAAM,GAAG;AACrB,YAAA,OAAO,OAAO,QAAQ;AACjB,iBAAA;AAAA,QAAA;AAET,cAAM,SAAS,OAAO,MAAM,GAAG,GAAG;AAC3B,eAAA;AAAA,UACL,GAAI,OAAO,SAAS,SAAS,IAAI,MAAM,GAAG;AAAA,UAC1C,SAAS,OAAO,GAAG,CAAC;AAAA,UACpB,GAAG,OAAO,MAAM,MAAM,CAAC;AAAA,QACzB;AAAA,MAAA;AAAA,IACF;AAGI,UAAA,IAAI,MAAM,yDAAyD;AAAA,EAAA;AAG3E,SAAO,SAAS,GAAG;AACrB;AAEA,MAAM,qBAAqB;AAG3B,MAAM,sBAAsB;AAC5B,MAAM,0BAA0B;AAChC,MAAM,uBAAuB;AAC7B,MAAM,iBAAiB;AAEvB,MAAM,YAAY;AAClB,MAAM,aAAa,GAAG,SAAS;AAKxB,SAAS,cAAc,KAAsC;AAC9D,MAAA,MAAM,QAAQ,GAAG,GAAG;AACf,WAAA,CAAC,GAAG,GAAG;AAAA,EAAA;AAGZ,MAAA,OAAO,QAAQ,UAAU;AACrB,UAAA,IAAI,MAAM,wBAAwB;AAAA,EAAA;AAG1C,SACE,IAGG,QAAQ,aAAa,EAAE,EACvB,QAAQ,OAAO,GAAG,EAClB,QAAQ,oBAAoB,UAAU,EACtC,QAAQ,qBAAqB,IAAI,UAAU,GAAG,EAC9C,QAAQ,yBAAyB,GAAG,UAAU,GAAG,EACjD,QAAQ,sBAAsB,IAAI,UAAU,EAAE,EAC9C,QAAQ,gBAAgB,GAAG,EAC3B,MAAM,GAAG,EACT,IAAI,CAAC,MAAM;AACN,QAAA,EAAE,WAAW,SAAS,GAAG;AAC3B,YAAM,SAAS,EAAE,UAAU,UAAU,MAAM;AACrC,YAAA,MAAM,SAAS,QAAQ,EAAE;AAE3B,UAAA,OAAO,GAAG,MAAM,QAAQ;AACnB,eAAA;AAAA,MAAA;AAEF,aAAA;AAAA,IAAA;AAEF,WAAA;AAAA,EAAA,CACR;AAEP;AAKgB,SAAA,iBAAiB,OAAe,OAAuB;AACjE,MAAA,MAAM,WAAW,EAAU,QAAA;AAC3B,MAAA,MAAM,WAAW,EAAU,QAAA;AAE3B,MAAA,MAAM,WAAW,GAAG,GAAG;AACzB,WAAO,QAAQ;AAAA,EAAA;AAGV,SAAA,GAAG,KAAK,IAAI,KAAK;AAC1B;AAKO,SAAS,gBAAgB,KAAU;AACxC,SAAO,EAAE,MAAM,QAAQ,GAAG,KAAK,IAAI,WAAW;AAChD;AAmBgB,SAAA,uBACd,OACA,SAWU;AACJ,QAAA,EAAE,oBAAoB;AACtB,QAAA;AAAA,IACJ;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EAAA,IACG,QAAQ,cAAc,CAAC;AAI5B,QAAM,oBAAoB,mBAAmB;AAE7C,QAAM,kBAAkB;AAAA,IACtB,OAAO;AAAA,IACP,UAAU;AAAA,IACV,YAAY,2BAA2B;AAAA,EACzC;AAEA,QAAM,gBAAgB;AAAA,IACpB,OAAO;AAAA,IACP,UAAU;AAAA,IACV,YAAY,yBAAyB;AAAA,EACvC;AAEA,QAAM,kBAAkB;AAAA,IACtB,OAAO;AAAA,IACP,UAAU;AAAA,IACV,YAAY;AAAA,EACd;AAEA,QAAM,gBAAgB,CACpB,eAII,EAAE,GAAG,WAAW,YAAY;AAElC,UAAQ,OAAO;AAAA,IACb,KAAK;AACI,aAAA;AAAA,QACL,cAAc,eAAe;AAAA,QAC7B,cAAc,aAAa;AAAA,QAC3B;AAAA,MACF;AAAA,IACF,KAAK;AACH,aAAO,CAAC,aAAa;AAAA,IACvB,KAAK;AACH,aAAO,CAAC,eAAe;AAAA,IACzB,KAAK;AAAA,IACL;AACE,aAAO,CAAC;AAAA,EAAA;AAEd;AAiBgB,SAAA,sBACd,OACA,SAWU;AACJ,QAAA,EAAE,UAAU,QAAQ,UAAU,YAAa,QAAQ,cAAc,CAAC;AAIxE,QAAM,kBAAkB,EAAE,OAAO,UAAU,UAAU,SAAS;AAC9D,QAAM,gBAAgB,EAAE,OAAO,QAAQ,UAAU,OAAO;AACxD,QAAM,kBAAkB,EAAE,OAAO,UAAU,UAAU,SAAS;AAC9D,QAAM,iBAAiB,EAAE,OAAO,SAAS,UAAU,QAAQ;AAG3D,QAAM,kBAAkB;AAAA,IACtB,OAAO;AAAA,IACP,UAAU,MAAM;AAAA,EAClB;AAEA,UAAQ,OAAO;AAAA,IACb,KAAK;AACH,aAAO,CAAC,cAAc;AAAA,IACxB,KAAK;AACI,aAAA;AAAA,QACL;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAAA,IACF,KAAK;AACH,aAAO,CAAC,eAAe;AAAA,IACzB,KAAK;AACI,aAAA,CAAC,eAAe,eAAe;AAAA,IACxC,KAAK;AAAA,IACL;AACS,aAAA,CAAC,iBAAiB,eAAe;AAAA,EAAA;AAE9C;AAEa,MAAA,8BAA8B,CACzC,UACgD;AAChD,SAAO,CAAC,CAAC,SAAS,OAAO,UAAU,YAAY,YAAY;AAC7D;AAEgB,SAAA,SAAY,MAAS,MAAS;AAC5C,MAAI,OAAO,GAAG,MAAM,IAAI,GAAG;AAClB,WAAA;AAAA,EAAA;AAIP,MAAA,OAAO,SAAS,YAChB,SAAS,QACT,OAAO,SAAS,YAChB,SAAS,MACT;AACO,WAAA;AAAA,EAAA;AAGL,MAAA,gBAAgB,OAAO,gBAAgB,KAAK;AAC9C,QAAI,KAAK,SAAS,KAAK,KAAa,QAAA;AACpC,eAAW,CAAC,GAAG,CAAC,KAAK,MAAM;AACzB,UAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,GAAG,KAAK,IAAI,CAAC,CAAC,EAAU,QAAA;AAAA,IAAA;AAElD,WAAA;AAAA,EAAA;AAGL,MAAA,gBAAgB,OAAO,gBAAgB,KAAK;AAC9C,QAAI,KAAK,SAAS,KAAK,KAAa,QAAA;AACpC,eAAW,KAAK,MAAM;AACpB,UAAI,CAAC,KAAK,IAAI,CAAC,EAAU,QAAA;AAAA,IAAA;AAEpB,WAAA;AAAA,EAAA;AAGH,QAAA,QAAQ,OAAO,KAAK,IAAI;AACxB,QAAA,QAAQ,OAAO,KAAK,IAAI;AAE1B,MAAA,MAAM,WAAW,MAAM,QAAQ;AAC1B,WAAA;AAAA,EAAA;AAGT,aAAW,OAAO,OAAO;AAGvB,QACE,CAAC,MAAM,SAAS,GAAG,KACnB,CAAC,SAAS,KAAK,GAAc,GAAG,KAAK,GAAc,CAAC,GACpD;AACO,aAAA;AAAA,IAAA;AAAA,EACT;AAGK,SAAA;AACT;AAMO,MAAM,wCAAwC,CAAC;AAAA,EACpD;AAAA,EACA;AAAA,EACA;AACF,MAOK;AAEH,MAAI,uBAAuB;AACzB,WAAO,EAAE,eAAe,uBAAuB,WAAW,OAAO;AAAA,EAAA;AAInE,MAAI,kCAAkC;AACpC,WAAO,EAAE,eAAe,QAAW,WAAW,OAAU;AAAA,EAAA;AAI1D,MAAI,oBAAoB;AACtB,WAAO,EAAE,eAAe,oBAAoB,WAAW,QAAQ;AAAA,EAAA;AAIjE,SAAO,EAAE,eAAe,QAAW,WAAW,OAAU;AAC1D;AAMO,MAAM,yCAAyC,CAAC;AAAA,EACrD;AAAA,EACA;AACF,MAMK;AAEH,MAAI,iBAAiB;AACnB,WAAO,EAAE,eAAe,iBAAiB,WAAW,QAAQ;AAAA,EAAA;AAI9D,MAAI,gBAAgB;AAClB,WAAO,EAAE,eAAe,gBAAgB,WAAW,OAAO;AAAA,EAAA;AAG5D,SAAO,EAAE,eAAe,QAAW,WAAW,OAAU;AAC1D;AAEO,SAAS,eAAkB,QAA4C;AAC5E,QAAM,SAAgC,CAAC;AAEvC,aAAW,OAAO,QAAQ;AACxB,WAAO,GAAG,IAAI;AAAA,EAAA;AAGT,SAAA;AACT;"}
|
package/package.json
CHANGED
|
@@ -0,0 +1,461 @@
|
|
|
1
|
+
import { Derived } from '@tanstack/store'
|
|
2
|
+
import { concatenatePaths, getBy, makePathArray } from './utils'
|
|
3
|
+
import type { Updater } from './utils'
|
|
4
|
+
import type {
|
|
5
|
+
FormApi,
|
|
6
|
+
FormAsyncValidateOrFn,
|
|
7
|
+
FormValidateOrFn,
|
|
8
|
+
} from './FormApi'
|
|
9
|
+
import type { AnyFieldMeta, AnyFieldMetaBase } from './FieldApi'
|
|
10
|
+
import type {
|
|
11
|
+
DeepKeys,
|
|
12
|
+
DeepKeysOfType,
|
|
13
|
+
DeepValue,
|
|
14
|
+
FieldsMap,
|
|
15
|
+
} from './util-types'
|
|
16
|
+
import type {
|
|
17
|
+
FieldManipulator,
|
|
18
|
+
UpdateMetaOptions,
|
|
19
|
+
ValidationCause,
|
|
20
|
+
} from './types'
|
|
21
|
+
|
|
22
|
+
export type AnyFieldGroupApi = FieldGroupApi<
|
|
23
|
+
any,
|
|
24
|
+
any,
|
|
25
|
+
any,
|
|
26
|
+
any,
|
|
27
|
+
any,
|
|
28
|
+
any,
|
|
29
|
+
any,
|
|
30
|
+
any,
|
|
31
|
+
any,
|
|
32
|
+
any,
|
|
33
|
+
any,
|
|
34
|
+
any
|
|
35
|
+
>
|
|
36
|
+
|
|
37
|
+
export interface FieldGroupState<in out TFieldGroupData> {
|
|
38
|
+
/**
|
|
39
|
+
* The current values of the field group
|
|
40
|
+
*/
|
|
41
|
+
values: TFieldGroupData
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
/**
|
|
45
|
+
* An object representing the options for a field group.
|
|
46
|
+
*/
|
|
47
|
+
export interface FieldGroupOptions<
|
|
48
|
+
in out TFormData,
|
|
49
|
+
in out TFieldGroupData,
|
|
50
|
+
in out TFields extends
|
|
51
|
+
| DeepKeysOfType<TFormData, TFieldGroupData | null | undefined>
|
|
52
|
+
| FieldsMap<TFormData, TFieldGroupData>,
|
|
53
|
+
in out TOnMount extends undefined | FormValidateOrFn<TFormData>,
|
|
54
|
+
in out TOnChange extends undefined | FormValidateOrFn<TFormData>,
|
|
55
|
+
in out TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
|
|
56
|
+
in out TOnBlur extends undefined | FormValidateOrFn<TFormData>,
|
|
57
|
+
in out TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
|
|
58
|
+
in out TOnSubmit extends undefined | FormValidateOrFn<TFormData>,
|
|
59
|
+
in out TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
|
|
60
|
+
in out TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,
|
|
61
|
+
in out TSubmitMeta = never,
|
|
62
|
+
> {
|
|
63
|
+
form:
|
|
64
|
+
| FormApi<
|
|
65
|
+
TFormData,
|
|
66
|
+
TOnMount,
|
|
67
|
+
TOnChange,
|
|
68
|
+
TOnChangeAsync,
|
|
69
|
+
TOnBlur,
|
|
70
|
+
TOnBlurAsync,
|
|
71
|
+
TOnSubmit,
|
|
72
|
+
TOnSubmitAsync,
|
|
73
|
+
TOnServer,
|
|
74
|
+
TSubmitMeta
|
|
75
|
+
>
|
|
76
|
+
| FieldGroupApi<
|
|
77
|
+
any,
|
|
78
|
+
TFormData,
|
|
79
|
+
any,
|
|
80
|
+
any,
|
|
81
|
+
any,
|
|
82
|
+
any,
|
|
83
|
+
any,
|
|
84
|
+
any,
|
|
85
|
+
any,
|
|
86
|
+
any,
|
|
87
|
+
any,
|
|
88
|
+
TSubmitMeta
|
|
89
|
+
>
|
|
90
|
+
/**
|
|
91
|
+
* The path to the field group data.
|
|
92
|
+
*/
|
|
93
|
+
fields: TFields
|
|
94
|
+
/**
|
|
95
|
+
* The expected subsetValues that the form must provide.
|
|
96
|
+
*/
|
|
97
|
+
defaultValues?: TFieldGroupData
|
|
98
|
+
/**
|
|
99
|
+
* onSubmitMeta, the data passed from the handleSubmit handler, to the onSubmit function props
|
|
100
|
+
*/
|
|
101
|
+
onSubmitMeta?: TSubmitMeta
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
export class FieldGroupApi<
|
|
105
|
+
in out TFormData,
|
|
106
|
+
in out TFieldGroupData,
|
|
107
|
+
in out TFields extends
|
|
108
|
+
| DeepKeysOfType<TFormData, TFieldGroupData | null | undefined>
|
|
109
|
+
| FieldsMap<TFormData, TFieldGroupData>,
|
|
110
|
+
in out TOnMount extends undefined | FormValidateOrFn<TFormData>,
|
|
111
|
+
in out TOnChange extends undefined | FormValidateOrFn<TFormData>,
|
|
112
|
+
in out TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
|
|
113
|
+
in out TOnBlur extends undefined | FormValidateOrFn<TFormData>,
|
|
114
|
+
in out TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
|
|
115
|
+
in out TOnSubmit extends undefined | FormValidateOrFn<TFormData>,
|
|
116
|
+
in out TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
|
|
117
|
+
in out TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,
|
|
118
|
+
in out TSubmitMeta = never,
|
|
119
|
+
> implements FieldManipulator<TFieldGroupData, TSubmitMeta>
|
|
120
|
+
{
|
|
121
|
+
/**
|
|
122
|
+
* The form that called this field group.
|
|
123
|
+
*/
|
|
124
|
+
readonly form: FormApi<
|
|
125
|
+
TFormData,
|
|
126
|
+
TOnMount,
|
|
127
|
+
TOnChange,
|
|
128
|
+
TOnChangeAsync,
|
|
129
|
+
TOnBlur,
|
|
130
|
+
TOnBlurAsync,
|
|
131
|
+
TOnSubmit,
|
|
132
|
+
TOnSubmitAsync,
|
|
133
|
+
TOnServer,
|
|
134
|
+
TSubmitMeta
|
|
135
|
+
>
|
|
136
|
+
|
|
137
|
+
readonly fieldsMap: TFields
|
|
138
|
+
|
|
139
|
+
/**
|
|
140
|
+
* Get the true name of the field. Not required within `Field` or `AppField`.
|
|
141
|
+
* @private
|
|
142
|
+
*/
|
|
143
|
+
getFormFieldName = <TField extends DeepKeys<TFieldGroupData>>(
|
|
144
|
+
subfield: TField,
|
|
145
|
+
): DeepKeys<TFormData> => {
|
|
146
|
+
if (typeof this.fieldsMap === 'string') {
|
|
147
|
+
return concatenatePaths(this.fieldsMap, subfield)
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
const firstAccessor = makePathArray(subfield)[0]
|
|
151
|
+
if (typeof firstAccessor !== 'string') {
|
|
152
|
+
// top-level arrays cannot be mapped
|
|
153
|
+
return ''
|
|
154
|
+
}
|
|
155
|
+
|
|
156
|
+
const restOfPath = subfield.slice(firstAccessor.length)
|
|
157
|
+
const formMappedPath =
|
|
158
|
+
// TFields is either a string or this. See guard above.
|
|
159
|
+
(this.fieldsMap as FieldsMap<TFormData, TFieldGroupData>)[
|
|
160
|
+
firstAccessor as keyof TFieldGroupData
|
|
161
|
+
]
|
|
162
|
+
|
|
163
|
+
return concatenatePaths(formMappedPath, restOfPath)
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
store: Derived<FieldGroupState<TFieldGroupData>>
|
|
167
|
+
|
|
168
|
+
get state() {
|
|
169
|
+
return this.store.state
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
/**
|
|
173
|
+
* Constructs a new `FieldGroupApi` instance with the given form options.
|
|
174
|
+
*/
|
|
175
|
+
constructor(
|
|
176
|
+
opts: FieldGroupOptions<
|
|
177
|
+
TFormData,
|
|
178
|
+
TFieldGroupData,
|
|
179
|
+
TFields,
|
|
180
|
+
TOnMount,
|
|
181
|
+
TOnChange,
|
|
182
|
+
TOnChangeAsync,
|
|
183
|
+
TOnBlur,
|
|
184
|
+
TOnBlurAsync,
|
|
185
|
+
TOnSubmit,
|
|
186
|
+
TOnSubmitAsync,
|
|
187
|
+
TOnServer,
|
|
188
|
+
TSubmitMeta
|
|
189
|
+
>,
|
|
190
|
+
) {
|
|
191
|
+
if (opts.form instanceof FieldGroupApi) {
|
|
192
|
+
const group = opts.form
|
|
193
|
+
this.form = group.form as never
|
|
194
|
+
|
|
195
|
+
// the DeepKey is already namespaced, so we need to ensure that we reference
|
|
196
|
+
// the form and not the group
|
|
197
|
+
if (typeof opts.fields === 'string') {
|
|
198
|
+
this.fieldsMap = group.getFormFieldName(opts.fields) as TFields
|
|
199
|
+
} else {
|
|
200
|
+
// TypeScript has a tough time with generics being a union for some reason
|
|
201
|
+
const fields = {
|
|
202
|
+
...(opts.fields as FieldsMap<TFormData, TFieldGroupData>),
|
|
203
|
+
}
|
|
204
|
+
for (const key in fields) {
|
|
205
|
+
fields[key] = group.getFormFieldName(fields[key]) as never
|
|
206
|
+
}
|
|
207
|
+
this.fieldsMap = fields as never
|
|
208
|
+
}
|
|
209
|
+
} else {
|
|
210
|
+
this.form = opts.form
|
|
211
|
+
this.fieldsMap = opts.fields
|
|
212
|
+
}
|
|
213
|
+
|
|
214
|
+
this.store = new Derived({
|
|
215
|
+
deps: [this.form.store],
|
|
216
|
+
fn: ({ currDepVals }) => {
|
|
217
|
+
const currFormStore = currDepVals[0]
|
|
218
|
+
let values: TFieldGroupData
|
|
219
|
+
if (typeof this.fieldsMap === 'string') {
|
|
220
|
+
// all values live at that name, so we can directly fetch it
|
|
221
|
+
values = getBy(currFormStore.values, this.fieldsMap)
|
|
222
|
+
} else {
|
|
223
|
+
// we need to fetch the values from all places where they were mapped from
|
|
224
|
+
values = {} as never
|
|
225
|
+
const fields: Record<keyof TFieldGroupData, string> = this
|
|
226
|
+
.fieldsMap as never
|
|
227
|
+
for (const key in fields) {
|
|
228
|
+
values[key] = getBy(currFormStore.values, fields[key])
|
|
229
|
+
}
|
|
230
|
+
}
|
|
231
|
+
|
|
232
|
+
return {
|
|
233
|
+
values,
|
|
234
|
+
}
|
|
235
|
+
},
|
|
236
|
+
})
|
|
237
|
+
}
|
|
238
|
+
|
|
239
|
+
/**
|
|
240
|
+
* Mounts the field group instance to listen to value changes.
|
|
241
|
+
*/
|
|
242
|
+
mount = () => {
|
|
243
|
+
const cleanup = this.store.mount()
|
|
244
|
+
|
|
245
|
+
return cleanup
|
|
246
|
+
}
|
|
247
|
+
|
|
248
|
+
/**
|
|
249
|
+
* Validates the children of a specified array in the form starting from a given index until the end using the correct handlers for a given validation type.
|
|
250
|
+
*/
|
|
251
|
+
validateArrayFieldsStartingFrom = async <
|
|
252
|
+
TField extends DeepKeysOfType<TFieldGroupData, any[]>,
|
|
253
|
+
>(
|
|
254
|
+
field: TField,
|
|
255
|
+
index: number,
|
|
256
|
+
cause: ValidationCause,
|
|
257
|
+
) => {
|
|
258
|
+
return this.form.validateArrayFieldsStartingFrom(
|
|
259
|
+
this.getFormFieldName(field),
|
|
260
|
+
index,
|
|
261
|
+
cause,
|
|
262
|
+
)
|
|
263
|
+
}
|
|
264
|
+
|
|
265
|
+
/**
|
|
266
|
+
* Validates a specified field in the form using the correct handlers for a given validation type.
|
|
267
|
+
*/
|
|
268
|
+
validateField = <TField extends DeepKeys<TFieldGroupData>>(
|
|
269
|
+
field: TField,
|
|
270
|
+
cause: ValidationCause,
|
|
271
|
+
) => {
|
|
272
|
+
return this.form.validateField(this.getFormFieldName(field), cause)
|
|
273
|
+
}
|
|
274
|
+
|
|
275
|
+
/**
|
|
276
|
+
* Handles the form submission, performs validation, and calls the appropriate onSubmit or onSubmitInvalid callbacks.
|
|
277
|
+
*/
|
|
278
|
+
handleSubmit(): Promise<void>
|
|
279
|
+
handleSubmit(submitMeta: TSubmitMeta): Promise<void>
|
|
280
|
+
async handleSubmit(submitMeta?: TSubmitMeta): Promise<void> {
|
|
281
|
+
// cast is required since the implementation isn't one of the two overloads
|
|
282
|
+
return this.form.handleSubmit(submitMeta as any)
|
|
283
|
+
}
|
|
284
|
+
|
|
285
|
+
/**
|
|
286
|
+
* Gets the value of the specified field.
|
|
287
|
+
*/
|
|
288
|
+
getFieldValue = <TField extends DeepKeys<TFieldGroupData>>(
|
|
289
|
+
field: TField,
|
|
290
|
+
): DeepValue<TFieldGroupData, TField> => {
|
|
291
|
+
return this.form.getFieldValue(this.getFormFieldName(field)) as DeepValue<
|
|
292
|
+
TFieldGroupData,
|
|
293
|
+
TField
|
|
294
|
+
>
|
|
295
|
+
}
|
|
296
|
+
|
|
297
|
+
/**
|
|
298
|
+
* Gets the metadata of the specified field.
|
|
299
|
+
*/
|
|
300
|
+
getFieldMeta = <TField extends DeepKeys<TFieldGroupData>>(field: TField) => {
|
|
301
|
+
return this.form.getFieldMeta(this.getFormFieldName(field))
|
|
302
|
+
}
|
|
303
|
+
|
|
304
|
+
/**
|
|
305
|
+
* Updates the metadata of the specified field.
|
|
306
|
+
*/
|
|
307
|
+
setFieldMeta = <TField extends DeepKeys<TFieldGroupData>>(
|
|
308
|
+
field: TField,
|
|
309
|
+
updater: Updater<AnyFieldMetaBase>,
|
|
310
|
+
) => {
|
|
311
|
+
return this.form.setFieldMeta(this.getFormFieldName(field), updater)
|
|
312
|
+
}
|
|
313
|
+
|
|
314
|
+
/**
|
|
315
|
+
* Sets the value of the specified field and optionally updates the touched state.
|
|
316
|
+
*/
|
|
317
|
+
setFieldValue = <TField extends DeepKeys<TFieldGroupData>>(
|
|
318
|
+
field: TField,
|
|
319
|
+
updater: Updater<DeepValue<TFieldGroupData, TField>>,
|
|
320
|
+
opts?: UpdateMetaOptions,
|
|
321
|
+
) => {
|
|
322
|
+
return this.form.setFieldValue(
|
|
323
|
+
this.getFormFieldName(field) as never,
|
|
324
|
+
updater as never,
|
|
325
|
+
opts,
|
|
326
|
+
)
|
|
327
|
+
}
|
|
328
|
+
|
|
329
|
+
/**
|
|
330
|
+
* Delete a field and its subfields.
|
|
331
|
+
*/
|
|
332
|
+
deleteField = <TField extends DeepKeys<TFieldGroupData>>(field: TField) => {
|
|
333
|
+
return this.form.deleteField(this.getFormFieldName(field))
|
|
334
|
+
}
|
|
335
|
+
|
|
336
|
+
/**
|
|
337
|
+
* Pushes a value into an array field.
|
|
338
|
+
*/
|
|
339
|
+
pushFieldValue = <TField extends DeepKeysOfType<TFieldGroupData, any[]>>(
|
|
340
|
+
field: TField,
|
|
341
|
+
value: DeepValue<TFieldGroupData, TField> extends any[]
|
|
342
|
+
? DeepValue<TFieldGroupData, TField>[number]
|
|
343
|
+
: never,
|
|
344
|
+
opts?: UpdateMetaOptions,
|
|
345
|
+
) => {
|
|
346
|
+
return this.form.pushFieldValue(
|
|
347
|
+
this.getFormFieldName(field),
|
|
348
|
+
// since unknown doesn't extend an array, it types `value` as never.
|
|
349
|
+
value as never,
|
|
350
|
+
opts,
|
|
351
|
+
)
|
|
352
|
+
}
|
|
353
|
+
|
|
354
|
+
/**
|
|
355
|
+
* Insert a value into an array field at the specified index.
|
|
356
|
+
*/
|
|
357
|
+
insertFieldValue = async <
|
|
358
|
+
TField extends DeepKeysOfType<TFieldGroupData, any[]>,
|
|
359
|
+
>(
|
|
360
|
+
field: TField,
|
|
361
|
+
index: number,
|
|
362
|
+
value: DeepValue<TFieldGroupData, TField> extends any[]
|
|
363
|
+
? DeepValue<TFieldGroupData, TField>[number]
|
|
364
|
+
: never,
|
|
365
|
+
opts?: UpdateMetaOptions,
|
|
366
|
+
) => {
|
|
367
|
+
return this.form.insertFieldValue(
|
|
368
|
+
this.getFormFieldName(field),
|
|
369
|
+
index,
|
|
370
|
+
// since unknown doesn't extend an array, it types `value` as never.
|
|
371
|
+
value as never,
|
|
372
|
+
opts,
|
|
373
|
+
)
|
|
374
|
+
}
|
|
375
|
+
|
|
376
|
+
/**
|
|
377
|
+
* Replaces a value into an array field at the specified index.
|
|
378
|
+
*/
|
|
379
|
+
replaceFieldValue = async <
|
|
380
|
+
TField extends DeepKeysOfType<TFieldGroupData, any[]>,
|
|
381
|
+
>(
|
|
382
|
+
field: TField,
|
|
383
|
+
index: number,
|
|
384
|
+
value: DeepValue<TFieldGroupData, TField> extends any[]
|
|
385
|
+
? DeepValue<TFieldGroupData, TField>[number]
|
|
386
|
+
: never,
|
|
387
|
+
opts?: UpdateMetaOptions,
|
|
388
|
+
) => {
|
|
389
|
+
return this.form.replaceFieldValue(
|
|
390
|
+
this.getFormFieldName(field),
|
|
391
|
+
index,
|
|
392
|
+
// since unknown doesn't extend an array, it types `value` as never.
|
|
393
|
+
value as never,
|
|
394
|
+
opts,
|
|
395
|
+
)
|
|
396
|
+
}
|
|
397
|
+
|
|
398
|
+
/**
|
|
399
|
+
* Removes a value from an array field at the specified index.
|
|
400
|
+
*/
|
|
401
|
+
removeFieldValue = async <
|
|
402
|
+
TField extends DeepKeysOfType<TFieldGroupData, any[]>,
|
|
403
|
+
>(
|
|
404
|
+
field: TField,
|
|
405
|
+
index: number,
|
|
406
|
+
opts?: UpdateMetaOptions,
|
|
407
|
+
) => {
|
|
408
|
+
return this.form.removeFieldValue(this.getFormFieldName(field), index, opts)
|
|
409
|
+
}
|
|
410
|
+
|
|
411
|
+
/**
|
|
412
|
+
* Swaps the values at the specified indices within an array field.
|
|
413
|
+
*/
|
|
414
|
+
swapFieldValues = <TField extends DeepKeysOfType<TFieldGroupData, any[]>>(
|
|
415
|
+
field: TField,
|
|
416
|
+
index1: number,
|
|
417
|
+
index2: number,
|
|
418
|
+
opts?: UpdateMetaOptions,
|
|
419
|
+
) => {
|
|
420
|
+
return this.form.swapFieldValues(
|
|
421
|
+
this.getFormFieldName(field),
|
|
422
|
+
index1,
|
|
423
|
+
index2,
|
|
424
|
+
opts,
|
|
425
|
+
)
|
|
426
|
+
}
|
|
427
|
+
|
|
428
|
+
/**
|
|
429
|
+
* Moves the value at the first specified index to the second specified index within an array field.
|
|
430
|
+
*/
|
|
431
|
+
moveFieldValues = <TField extends DeepKeysOfType<TFieldGroupData, any[]>>(
|
|
432
|
+
field: TField,
|
|
433
|
+
index1: number,
|
|
434
|
+
index2: number,
|
|
435
|
+
opts?: UpdateMetaOptions,
|
|
436
|
+
) => {
|
|
437
|
+
return this.form.moveFieldValues(
|
|
438
|
+
this.getFormFieldName(field),
|
|
439
|
+
index1,
|
|
440
|
+
index2,
|
|
441
|
+
opts,
|
|
442
|
+
)
|
|
443
|
+
}
|
|
444
|
+
|
|
445
|
+
clearFieldValues = <TField extends DeepKeysOfType<TFieldGroupData, any[]>>(
|
|
446
|
+
field: TField,
|
|
447
|
+
opts?: UpdateMetaOptions,
|
|
448
|
+
) => {
|
|
449
|
+
return this.form.clearFieldValues(this.getFormFieldName(field), opts)
|
|
450
|
+
}
|
|
451
|
+
|
|
452
|
+
/**
|
|
453
|
+
* Resets the field value and meta to default state
|
|
454
|
+
*/
|
|
455
|
+
resetField = <TField extends DeepKeys<TFieldGroupData>>(field: TField) => {
|
|
456
|
+
return this.form.resetField(this.getFormFieldName(field))
|
|
457
|
+
}
|
|
458
|
+
|
|
459
|
+
validateAllFields = (cause: ValidationCause) =>
|
|
460
|
+
this.form.validateAllFields(cause)
|
|
461
|
+
}
|
package/src/FormApi.ts
CHANGED
|
@@ -30,6 +30,7 @@ import type {
|
|
|
30
30
|
} from './FieldApi'
|
|
31
31
|
import type {
|
|
32
32
|
ExtractGlobalFormError,
|
|
33
|
+
FieldManipulator,
|
|
33
34
|
FormValidationError,
|
|
34
35
|
FormValidationErrorMap,
|
|
35
36
|
UpdateMetaOptions,
|
|
@@ -316,6 +317,20 @@ export interface FormListeners<
|
|
|
316
317
|
}) => void
|
|
317
318
|
}
|
|
318
319
|
|
|
320
|
+
/**
|
|
321
|
+
* An object representing the base properties of a form, unrelated to any validators
|
|
322
|
+
*/
|
|
323
|
+
export interface BaseFormOptions<in out TFormData, in out TSubmitMeta = never> {
|
|
324
|
+
/**
|
|
325
|
+
* Set initial values for your form.
|
|
326
|
+
*/
|
|
327
|
+
defaultValues?: TFormData
|
|
328
|
+
/**
|
|
329
|
+
* onSubmitMeta, the data passed from the handleSubmit handler, to the onSubmit function props
|
|
330
|
+
*/
|
|
331
|
+
onSubmitMeta?: TSubmitMeta
|
|
332
|
+
}
|
|
333
|
+
|
|
319
334
|
/**
|
|
320
335
|
* An object representing the options for a form.
|
|
321
336
|
*/
|
|
@@ -330,11 +345,7 @@ export interface FormOptions<
|
|
|
330
345
|
in out TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
|
|
331
346
|
in out TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,
|
|
332
347
|
in out TSubmitMeta = never,
|
|
333
|
-
> {
|
|
334
|
-
/**
|
|
335
|
-
* Set initial values for your form.
|
|
336
|
-
*/
|
|
337
|
-
defaultValues?: TFormData
|
|
348
|
+
> extends BaseFormOptions<TFormData, TSubmitMeta> {
|
|
338
349
|
/**
|
|
339
350
|
* The default state for the form.
|
|
340
351
|
*/
|
|
@@ -377,11 +388,6 @@ export interface FormOptions<
|
|
|
377
388
|
TOnSubmitAsync
|
|
378
389
|
>
|
|
379
390
|
|
|
380
|
-
/**
|
|
381
|
-
* onSubmitMeta, the data passed from the handleSubmit handler, to the onSubmit function props
|
|
382
|
-
*/
|
|
383
|
-
onSubmitMeta?: TSubmitMeta
|
|
384
|
-
|
|
385
391
|
/**
|
|
386
392
|
* form level listeners
|
|
387
393
|
*/
|
|
@@ -780,7 +786,8 @@ export class FormApi<
|
|
|
780
786
|
in out TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
|
|
781
787
|
in out TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,
|
|
782
788
|
in out TSubmitMeta = never,
|
|
783
|
-
>
|
|
789
|
+
> implements FieldManipulator<TFormData, TSubmitMeta>
|
|
790
|
+
{
|
|
784
791
|
/**
|
|
785
792
|
* The options for the form.
|
|
786
793
|
*/
|
package/src/index.ts
CHANGED