notform 2.2.0 → 2.2.1

package/dist/index.d.ts

@@ -1,7 +1,6 @@
 import { Component, ComputedRef, MaybeRefOrGetter, Raw, Ref } from "vue";
 import { StandardSchemaV1 } from "@standard-schema/spec";
 import { Get, PartialDeep, Paths as Paths$1 } from "type-fest";
-
 //#region src/types/shared.d.ts
 /**
  * The validation mode determines when validation occurs.
@@ -97,9 +96,13 @@ interface UseNotFormConfig<TSchema extends ObjectSchema> {
  * @template TSchema The form schema.
  */
 type NotFormInstance<TSchema extends ObjectSchema> = Raw<{
-  /** The values the form was initialised or last reset with. */readonly initialValues: UseNotFormConfig<TSchema>['initialValues']; /** The errors the form was initialised or last reset with. */
-  readonly initialErrors: UseNotFormConfig<TSchema>['initialErrors']; /** The resolved validation triggers for this form. */
-  readonly validateOn: Required<NonNullable<UseNotFormConfig<TSchema>['validateOn']>>; /** The resolved validation mode for this form. */
+  /** The values the form was initialised or last reset with. */
+  readonly initialValues: UseNotFormConfig<TSchema>['initialValues'];
+  /** The errors the form was initialised or last reset with. */
+  readonly initialErrors: UseNotFormConfig<TSchema>['initialErrors'];
+  /** The resolved validation triggers for this form. */
+  readonly validateOn: Required<NonNullable<UseNotFormConfig<TSchema>['validateOn']>>;
+  /** The resolved validation mode for this form. */
   readonly validationMode: Required<NonNullable<UseNotFormConfig<TSchema>['validationMode']>>;
   /**
    * Deeply reactive object of field values.
@@ -134,20 +137,24 @@ type NotFormInstance<TSchema extends ObjectSchema> = Raw<{
    * The set of field paths the user has interacted with.
    * Populated for all paths when the form is submitted.
    */
-  touchedFields: Set<Paths<StandardSchemaV1.InferInput<TSchema>>>; /** Whether any field has been touched. */
+  touchedFields: Set<Paths<StandardSchemaV1.InferInput<TSchema>>>;
+  /** Whether any field has been touched. */
   isTouched: ComputedRef<boolean>;
   /**
    * Marks a field as touched.
    * Called automatically by the field's `onBlur` handler.
    */
-  touchField: (path: Paths<StandardSchemaV1.InferInput<TSchema>>) => void; /** The set of field paths whose current value differs from the initial value. */
-  dirtyFields: Set<Paths<StandardSchemaV1.InferInput<TSchema>>>; /** Whether any field value differs from its initial value. */
+  touchField: (path: Paths<StandardSchemaV1.InferInput<TSchema>>) => void;
+  /** The set of field paths whose current value differs from the initial value. */
+  dirtyFields: Set<Paths<StandardSchemaV1.InferInput<TSchema>>>;
+  /** Whether any field value differs from its initial value. */
   isDirty: ComputedRef<boolean>;
   /**
    * Marks a field as dirty.
    * Called automatically when a field value changes.
    */
-  dirtyField: (path: Paths<StandardSchemaV1.InferInput<TSchema>>) => void; /** The raw validation issues produced by the last validation run. */
+  dirtyField: (path: Paths<StandardSchemaV1.InferInput<TSchema>>) => void;
+  /** The raw validation issues produced by the last validation run. */
   errors: Array<StandardSchemaV1.Issue>;
   /**
    * A flat map of field path to its first error message.
@@ -165,8 +172,10 @@ type NotFormInstance<TSchema extends ObjectSchema> = Raw<{
    * Replaces an existing error for the same path, or appends it if none exists.
    * Useful for setting server-side errors after submission.
    */
-  setError: (error: StandardSchemaV1.Issue) => void; /** Replaces all current errors with the provided issues. */
-  setErrors: (errors: Array<StandardSchemaV1.Issue>) => void; /** Removes all active validation errors. */
+  setError: (error: StandardSchemaV1.Issue) => void;
+  /** Replaces all current errors with the provided issues. */
+  setErrors: (errors: Array<StandardSchemaV1.Issue>) => void;
+  /** Removes all active validation errors. */
   clearErrors: () => void;
   /**
    * Returns all validation issues for a specific field path.
@@ -175,7 +184,8 @@ type NotFormInstance<TSchema extends ObjectSchema> = Raw<{
    * form.getFieldErrors('address.city')
    * ```
    */
-  getFieldErrors: (path: Paths<StandardSchemaV1.InferInput<TSchema>>) => Array<StandardSchemaV1.Issue>; /** Whether a validation run is currently in progress. */
+  getFieldErrors: (path: Paths<StandardSchemaV1.InferInput<TSchema>>) => Array<StandardSchemaV1.Issue>;
+  /** Whether a validation run is currently in progress. */
   isValidating: Ref<boolean>;
   /**
    * Validates the entire form against the schema.
@@ -186,8 +196,10 @@ type NotFormInstance<TSchema extends ObjectSchema> = Raw<{
    * Validates a single field against the schema.
    * Only replaces errors for that field — all other fields are left untouched.
    */
-  validateField: (path: Paths<StandardSchemaV1.InferInput<TSchema>>) => Promise<StandardSchemaV1.Result<StandardSchemaV1.InferOutput<TSchema>>>; /** Whether the form currently has no validation errors. */
-  isValid: ComputedRef<boolean>; /** Whether the form is currently running its submit handler. */
+  validateField: (path: Paths<StandardSchemaV1.InferInput<TSchema>>) => Promise<StandardSchemaV1.Result<StandardSchemaV1.InferOutput<TSchema>>>;
+  /** Whether the form currently has no validation errors. */
+  isValid: ComputedRef<boolean>;
+  /** Whether the form is currently running its submit handler. */
   isSubmitting: Ref<boolean>;
   /**
    * Validates the form and runs `onSubmit` if it passes.
@@ -294,9 +306,13 @@ interface NotArrayFieldItem {
 interface NotArrayFieldSlots<TSchema extends ObjectSchema, TItem = any> {
   /** The default slot receives the full array state and manipulation methods. */
   default: (props: {
-    /** The dot-separated path to this array field. */path: string; /** The array items with stable keys and paths for use with `v-for`. */
-    items: Array<NotArrayFieldItem>; /** All validation issues for this array field from the last validation run. */
-    errors: Array<StandardSchemaV1.Issue>; /** Whether this array field currently has no validation errors. */
+    /** The dot-separated path to this array field. */
+    path: string;
+    /** The array items with stable keys and paths for use with `v-for`. */
+    items: Array<NotArrayFieldItem>;
+    /** All validation issues for this array field from the last validation run. */
+    errors: Array<StandardSchemaV1.Issue>;
+    /** Whether this array field currently has no validation errors. */
     isValid: boolean;
     /**
      * Whether any item in this array has been touched.
@@ -307,7 +323,8 @@ interface NotArrayFieldSlots<TSchema extends ObjectSchema, TItem = any> {
      * Whether any item in this array differs from its initial value.
      * Derived from the form's `dirtyFields` set.
      */
-    isDirty: boolean; /** Whether validation is currently running for this array field. */
+    isDirty: boolean;
+    /** Whether validation is currently running for this array field. */
     isValidating: boolean;
     /**
      * Manually triggers validation for this array field.
@@ -369,7 +386,7 @@ declare const __VLS_export$3: <TSchema extends ObjectSchema, TItemSchema extends
   __ctx?: NonNullable<Awaited<typeof __VLS_setup>>;
 };
 declare const _default: typeof __VLS_export$3;
-type __VLS_PrettifyLocal$1<T> = (T extends any ? { [K in keyof T]: T[K] } : { [K in keyof T as K]: T[K] }) & {};
+type __VLS_PrettifyLocal$1<T> = (T extends any ? { [K in keyof T]: T[K]; } : { [K in keyof T as K]: T[K]; }) & {};
 //#endregion
 //#region src/types/not-field.d.ts
 /** Props for the `NotField` component. */
@@ -433,17 +450,23 @@ interface NotFieldProps {
 interface NotFieldSlots<TSchema extends ObjectSchema> {
   /** The default slot receives the full field state and event handlers. */
   default?: (props: {
-    /** The dot-separated path to this field. */path: string;
+    /** The dot-separated path to this field. */
+    path: string;
     /**
      * The current value of this field — read-only snapshot for display purposes.
      * Do not mutate directly or use with `v-model`.
      * For two-way binding use `v-model="form.values.fieldName"` instead.
      */
-    value: any; /** All validation issues for this field from the last validation run. */
-    errors: Array<StandardSchemaV1.Issue>; /** Whether this field currently has no validation errors. */
-    isValid: boolean; /** Whether the user has interacted with this field, or the form has been submitted. */
-    isTouched: boolean; /** Whether this field's current value differs from its initial value. */
-    isDirty: boolean; /** Whether an async validator is currently running for this field. */
+    value: any;
+    /** All validation issues for this field from the last validation run. */
+    errors: Array<StandardSchemaV1.Issue>;
+    /** Whether this field currently has no validation errors. */
+    isValid: boolean;
+    /** Whether the user has interacted with this field, or the form has been submitted. */
+    isTouched: boolean;
+    /** Whether this field's current value differs from its initial value. */
+    isDirty: boolean;
+    /** Whether an async validator is currently running for this field. */
     isValidating: boolean;
     /**
      * Manually triggers validation for this field.
@@ -465,9 +488,13 @@ interface NotFieldSlots<TSchema extends ObjectSchema> {
      * ```
      */
     events: {
-      /** Triggered when the field loses focus. */onBlur: () => void; /** Triggered on every keystroke or value change. */
-      onInput: () => void; /** Triggered when the field value is committed. */
-      onChange: () => void; /** Triggered when the field gains focus. */
+      /** Triggered when the field loses focus. */
+      onBlur: () => void;
+      /** Triggered on every keystroke or value change. */
+      onInput: () => void;
+      /** Triggered when the field value is committed. */
+      onChange: () => void;
+      /** Triggered when the field gains focus. */
       onFocus: () => void;
     };
   }) => any;
@@ -486,7 +513,7 @@ declare const __VLS_export$2: <TSchema extends ObjectSchema>(__VLS_props: NonNul
   __ctx?: NonNullable<Awaited<typeof __VLS_setup>>;
 };
 declare const _default$1: typeof __VLS_export$2;
-type __VLS_PrettifyLocal<T> = (T extends any ? { [K in keyof T]: T[K] } : { [K in keyof T as K]: T[K] }) & {};
+type __VLS_PrettifyLocal<T> = (T extends any ? { [K in keyof T]: T[K]; } : { [K in keyof T as K]: T[K]; }) & {};
 //#endregion
 //#region src/components/not-form.vue.d.ts
 type __VLS_Slots$1 = NotFormSlots;
@@ -526,7 +553,8 @@ interface NotMessageProps {
 interface NotMessageSlots {
   /** The default slot receives the error message context for custom rendering */
   default?: (props: {
-    /** The first active validation error message for the specified field */message?: string;
+    /** The first active validation error message for the specified field */
+    message?: string;
   }) => any;
 }
 //#endregion

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "notform",
   "type": "module",
-  "version": "2.2.0",
+  "version": "2.2.1",
   "private": false,
   "description": "Vue Forms Without the Friction",
   "author": "Favour Emeka <favorodera@gmail.com>",
@@ -45,22 +45,22 @@
   "dependencies": {
     "@standard-schema/spec": "^1.1.0",
     "dequal": "^2.0.3",
-    "dot-prop": "^10.1.0",
+    "dot-prop": "^10.2.0",
     "klona": "^2.0.6"
   },
   "devDependencies": {
-    "@favorodera/eslint-config": "^1.0.3",
-    "@types/node": "^26.1.0",
-    "@vitejs/plugin-vue": "^6.0.7",
-    "@vitest/ui": "^4.1.9",
+    "@favorodera/eslint-config": "^1.0.4",
+    "@types/node": "^26.1.2",
+    "@vitejs/plugin-vue": "^6.0.8",
+    "@vitest/ui": "^4.1.10",
     "@vue/test-utils": "^2.4.11",
-    "happy-dom": "^20.10.6",
-    "tsdown": "^0.22.3",
+    "happy-dom": "^20.11.1",
+    "tsdown": "^0.22.14",
     "type-fest": "^5.7.0",
-    "vite": "^8.1.3",
-    "vitest": "^4.1.9",
-    "vue": "^3.5.39",
-    "vue-tsc": "^3.3.6"
+    "vite": "^8.2.0",
+    "vitest": "^4.1.10",
+    "vue": "^3.0.0",
+    "vue-tsc": "^3.3.9"
   },
   "scripts": {
     "build": "tsdown",