@conform-to/react 1.15.1 → 1.17.0

package/dist/future/util.d.ts

@@ -1,6 +1,6 @@
 import type { FormError } from '@conform-to/dom/future';
 import type { StandardSchemaV1 } from './standard-schema';
-import { ValidateHandler, ValidateResult } from './types';
+import { ValidateHandler, ValidateResult, BaseFieldMetadata, ConditionalFieldMetadata } from './types';
 export declare function isUndefined(value: unknown): value is undefined;
 export declare function isString(value: unknown): value is string;
 export declare function isNumber(value: unknown): value is number;
@@ -42,6 +42,9 @@ export declare function resolveValidateResult<ErrorShape, Value>(result: ReturnT
         value?: Value | undefined;
     }> | undefined;
 };
+/**
+ * Resolves a StandardSchema validation result to conform's format.
+ */
 export declare function resolveStandardSchemaResult<Value>(result: StandardSchemaV1.Result<Value>): {
     error: FormError<string> | null;
     value?: Value;
@@ -65,4 +68,44 @@ export declare function appendUniqueItem<Item>(list: Array<Item>, item: Item): I
  */
 export declare function compactMap<Item>(list: Array<NonNullable<Item>>, fn: (value: Item) => Item | null): Array<Item>;
 export declare function generateUniqueKey(): string;
+/**
+ * Creates a type-only marker for TypeScript inference.
+ *
+ * This function always returns `true` at runtime. It exists
+ * purely to capture the generic type parameter for compile-time type checking.
+ * No runtime validation is performed.
+ *
+ * Common uses:
+ * - `isError`: Specify the error shape for type inference
+ * - `when`: Narrow field metadata to specific shapes for conditional props
+ *
+ * @example Specify error shape
+ * ```ts
+ * configureForms({
+ *   isError: shape<string>(),  // errors are strings
+ * });
+ * ```
+ *
+ * @example Conditional field metadata
+ * ```ts
+ * extendFieldMetadata(metadata, { when }) {
+ *   return {
+ *     get dateRangePickerProps() {
+ *       return when(metadata, shape<{ start: string; end: string }>(), (m) => ({
+ *         startName: m.getFieldset().start.name,
+ *         endName: m.getFieldset().end.name,
+ *       }));
+ *     },
+ *   };
+ * }
+ * ```
+ */
+export declare function shape<T>(): (value: unknown) => value is T;
+/**
+ * Creates a conditional field metadata property that is only available
+ * when the field shape matches the specified type.
+ */
+export declare function when<FieldShape, ErrorShape, Metadata>(metadata: BaseFieldMetadata<unknown, ErrorShape>, _shape: (value: unknown) => value is FieldShape, fn: (m: BaseFieldMetadata<FieldShape, ErrorShape>) => Metadata): ConditionalFieldMetadata<Metadata, FieldShape>;
+export declare function isStandardSchemaV1(schema: unknown): schema is StandardSchemaV1;
+export declare function validateStandardSchemaV1<Schema extends StandardSchemaV1>(schema: Schema, payload: Record<string, unknown>): any;
 //# sourceMappingURL=util.d.ts.map

package/dist/future/util.js

@@ -118,6 +118,10 @@ function resolveValidateResult(result) {
     asyncResult: asyncResult ? asyncResult.then(normalizeValidateResult) : undefined
   };
 }
+
+/**
+ * Resolves a StandardSchema validation result to conform's format.
+ */
 function resolveStandardSchemaResult(result) {
   if (!result.issues) {
     return {
@@ -149,10 +153,10 @@ function merge(obj, update) {
  */
 function transformKeys(obj, fn) {
   var result = {};
-  for (var [_key, _value] of Object.entries(obj)) {
+  for (var [_key, _value2] of Object.entries(obj)) {
     var _name = fn(_key);
     if (_name !== null) {
-      result[_name] = _value;
+      result[_name] = _value2;
     }
   }
   return result;
@@ -175,9 +179,9 @@ function appendUniqueItem(list, item) {
 function compactMap(list, fn) {
   var result = [];
   for (var item of list) {
-    var _value2 = fn(item);
-    if (_value2 !== null) {
-      result.push(_value2);
+    var _value3 = fn(item);
+    if (_value3 !== null) {
+      result.push(_value3);
     }
   }
   return result;
@@ -186,6 +190,60 @@ function generateUniqueKey() {
   return Math.trunc(Date.now() * Math.random()).toString(36);
 }
 
+/**
+ * Creates a type-only marker for TypeScript inference.
+ *
+ * This function always returns `true` at runtime. It exists
+ * purely to capture the generic type parameter for compile-time type checking.
+ * No runtime validation is performed.
+ *
+ * Common uses:
+ * - `isError`: Specify the error shape for type inference
+ * - `when`: Narrow field metadata to specific shapes for conditional props
+ *
+ * @example Specify error shape
+ * ```ts
+ * configureForms({
+ *   isError: shape<string>(),  // errors are strings
+ * });
+ * ```
+ *
+ * @example Conditional field metadata
+ * ```ts
+ * extendFieldMetadata(metadata, { when }) {
+ *   return {
+ *     get dateRangePickerProps() {
+ *       return when(metadata, shape<{ start: string; end: string }>(), (m) => ({
+ *         startName: m.getFieldset().start.name,
+ *         endName: m.getFieldset().end.name,
+ *       }));
+ *     },
+ *   };
+ * }
+ * ```
+ */
+function shape() {
+  return _value => true;
+}
+
+/**
+ * Creates a conditional field metadata property that is only available
+ * when the field shape matches the specified type.
+ */
+function when(metadata, _shape, fn) {
+  return fn(metadata);
+}
+function isStandardSchemaV1(schema) {
+  return typeof schema === 'object' && schema !== null && '~standard' in schema && typeof schema['~standard'] === 'object' && schema['~standard'] !== null && 'version' in schema['~standard'] && schema['~standard'].version === 1;
+}
+function validateStandardSchemaV1(schema, payload) {
+  var result = schema['~standard'].validate(payload);
+  if (result instanceof Promise) {
+    return result.then(actualResult => resolveStandardSchemaResult(actualResult));
+  }
+  return resolveStandardSchemaResult(result);
+}
+
 exports.appendUniqueItem = appendUniqueItem;
 exports.compactMap = compactMap;
 exports.createPathIndexUpdater = createPathIndexUpdater;
@@ -194,6 +252,7 @@ exports.getArrayAtPath = getArrayAtPath;
 exports.isNullable = isNullable;
 exports.isNumber = isNumber;
 exports.isOptional = isOptional;
+exports.isStandardSchemaV1 = isStandardSchemaV1;
 exports.isString = isString;
 exports.isUndefined = isUndefined;
 exports.merge = merge;
@@ -201,5 +260,8 @@ exports.normalizeFormError = normalizeFormError;
 exports.normalizeValidateResult = normalizeValidateResult;
 exports.resolveStandardSchemaResult = resolveStandardSchemaResult;
 exports.resolveValidateResult = resolveValidateResult;
+exports.shape = shape;
 exports.transformKeys = transformKeys;
 exports.updateValueAtPath = updateValueAtPath;
+exports.validateStandardSchemaV1 = validateStandardSchemaV1;
+exports.when = when;

package/dist/future/util.mjs

@@ -114,6 +114,10 @@ function resolveValidateResult(result) {
     asyncResult: asyncResult ? asyncResult.then(normalizeValidateResult) : undefined
   };
 }
+
+/**
+ * Resolves a StandardSchema validation result to conform's format.
+ */
 function resolveStandardSchemaResult(result) {
   if (!result.issues) {
     return {
@@ -145,10 +149,10 @@ function merge(obj, update) {
  */
 function transformKeys(obj, fn) {
   var result = {};
-  for (var [_key, _value] of Object.entries(obj)) {
+  for (var [_key, _value2] of Object.entries(obj)) {
     var _name = fn(_key);
     if (_name !== null) {
-      result[_name] = _value;
+      result[_name] = _value2;
     }
   }
   return result;
@@ -171,9 +175,9 @@ function appendUniqueItem(list, item) {
 function compactMap(list, fn) {
   var result = [];
   for (var item of list) {
-    var _value2 = fn(item);
-    if (_value2 !== null) {
-      result.push(_value2);
+    var _value3 = fn(item);
+    if (_value3 !== null) {
+      result.push(_value3);
     }
   }
   return result;
@@ -182,4 +186,58 @@ function generateUniqueKey() {
   return Math.trunc(Date.now() * Math.random()).toString(36);
 }
 
-export { appendUniqueItem, compactMap, createPathIndexUpdater, generateUniqueKey, getArrayAtPath, isNullable, isNumber, isOptional, isString, isUndefined, merge, normalizeFormError, normalizeValidateResult, resolveStandardSchemaResult, resolveValidateResult, transformKeys, updateValueAtPath };
+/**
+ * Creates a type-only marker for TypeScript inference.
+ *
+ * This function always returns `true` at runtime. It exists
+ * purely to capture the generic type parameter for compile-time type checking.
+ * No runtime validation is performed.
+ *
+ * Common uses:
+ * - `isError`: Specify the error shape for type inference
+ * - `when`: Narrow field metadata to specific shapes for conditional props
+ *
+ * @example Specify error shape
+ * ```ts
+ * configureForms({
+ *   isError: shape<string>(),  // errors are strings
+ * });
+ * ```
+ *
+ * @example Conditional field metadata
+ * ```ts
+ * extendFieldMetadata(metadata, { when }) {
+ *   return {
+ *     get dateRangePickerProps() {
+ *       return when(metadata, shape<{ start: string; end: string }>(), (m) => ({
+ *         startName: m.getFieldset().start.name,
+ *         endName: m.getFieldset().end.name,
+ *       }));
+ *     },
+ *   };
+ * }
+ * ```
+ */
+function shape() {
+  return _value => true;
+}
+
+/**
+ * Creates a conditional field metadata property that is only available
+ * when the field shape matches the specified type.
+ */
+function when(metadata, _shape, fn) {
+  return fn(metadata);
+}
+function isStandardSchemaV1(schema) {
+  return typeof schema === 'object' && schema !== null && '~standard' in schema && typeof schema['~standard'] === 'object' && schema['~standard'] !== null && 'version' in schema['~standard'] && schema['~standard'].version === 1;
+}
+function validateStandardSchemaV1(schema, payload) {
+  var result = schema['~standard'].validate(payload);
+  if (result instanceof Promise) {
+    return result.then(actualResult => resolveStandardSchemaResult(actualResult));
+  }
+  return resolveStandardSchemaResult(result);
+}
+
+export { appendUniqueItem, compactMap, createPathIndexUpdater, generateUniqueKey, getArrayAtPath, isNullable, isNumber, isOptional, isStandardSchemaV1, isString, isUndefined, merge, normalizeFormError, normalizeValidateResult, resolveStandardSchemaResult, resolveValidateResult, shape, transformKeys, updateValueAtPath, validateStandardSchemaV1, when };

package/dist/helpers.d.ts

@@ -34,6 +34,7 @@ type InputProps = Pretty<FormControlProps & {
     step?: string | number;
     pattern?: string;
     multiple?: boolean;
+    accept?: string;
     value?: string;
     defaultChecked?: boolean;
     defaultValue?: string;

package/dist/helpers.js

@@ -109,7 +109,8 @@ function getInputProps(metadata, options) {
     max: metadata.max,
     step: metadata.step,
     pattern: metadata.pattern,
-    multiple: metadata.multiple
+    multiple: metadata.multiple,
+    accept: metadata.accept
   });
   if (typeof options.value === 'undefined' || options.value) {
     if (options.type === 'checkbox' || options.type === 'radio') {

package/dist/helpers.mjs

@@ -105,7 +105,8 @@ function getInputProps(metadata, options) {
     max: metadata.max,
     step: metadata.step,
     pattern: metadata.pattern,
-    multiple: metadata.multiple
+    multiple: metadata.multiple,
+    accept: metadata.accept
   });
   if (typeof options.value === 'undefined' || options.value) {
     if (options.type === 'checkbox' || options.type === 'radio') {

package/dist/integrations.d.ts

@@ -6,9 +6,9 @@ export declare function createDummySelect(form: HTMLFormElement, name: string, v
 export declare function isDummySelect(element: HTMLElement): element is HTMLSelectElement;
 export declare function getInputValue(element: HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement): string | string[] | null;
 export declare function useInputEvent(onUpdate: React.Dispatch<React.SetStateAction<string | string[] | undefined>>): {
-    change(value: string | string[]): void;
-    focus(): void;
-    blur(): void;
+    change: (value: string | string[]) => void;
+    focus: () => void;
+    blur: () => void;
     register: RefCallback<HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement | undefined>;
 };
 export declare function useInputValue<Value extends string | string[] | Array<string | undefined>>(options: {

package/package.json

@@ -3,7 +3,7 @@
   "description": "Conform view adapter for react",
   "homepage": "https://conform.guide",
   "license": "MIT",
-  "version": "1.15.1",
+  "version": "1.17.0",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
@@ -41,7 +41,7 @@
     "url": "https://github.com/edmundhung/conform/issues"
   },
   "dependencies": {
-    "@conform-to/dom": "1.15.1"
+    "@conform-to/dom": "1.17.0"
   },
   "devDependencies": {
     "@babel/core": "^7.17.8",