@overgaming/valiform 0.2.1 → 0.3.0

package/dist/src/components/Field.vue.d.ts

@@ -36,7 +36,6 @@ declare var __VLS_1: {
     isDirty: boolean;
     error: string;
     errors: string[];
-    setValue: (value: unknown) => void;
     validate: () => boolean;
     reset: () => void;
 };

package/dist/src/components/__tests__/components/ExampleField.vue.d.ts

@@ -32,7 +32,6 @@ declare var __VLS_8: {
     isDirty: boolean;
     error: string;
     errors: string[];
-    setValue: (value: unknown) => void;
     validate: () => boolean;
     reset: () => void;
 };

package/dist/src/context/useFieldContext.d.ts

@@ -2,4 +2,40 @@ import type { InjectionKey } from 'vue';
 import type { FieldContext } from '../types';
 export declare const fieldContextKey: InjectionKey<FieldContext>;
 export declare const useFieldContextProvider: (data: FieldContext) => void;
-export declare const useFieldContext: (defaultData?: FieldContext | null) => FieldContext | null;
+/**
+ * Retrieves the `FieldContext` provided by the nearest `Field` component ancestor.
+ *
+ * **Three call signatures:**
+ *
+ * - `useFieldContext()` — no args. Returns `FieldContext` directly (no `!` needed).
+ *   Throws at runtime if called outside a `Field`. Use this for components that
+ *   must always be nested inside a `Field` (e.g. `FieldLabel`, `FieldError`).
+ *
+ * - `useFieldContext(fallback: FieldContext)` — with a fallback object. Returns
+ *   `FieldContext` directly (no `!` needed). Use this for components that can work
+ *   both inside and outside a `Field` (e.g. standalone inputs with `v-model`).
+ *
+ * - `useFieldContext(null)` — explicit null. Returns `FieldContext | null`.
+ *   Use when you want to handle the absence of context manually.
+ *
+ * @example
+ * // Always inside a Field — throws at runtime if misused:
+ * const { labelProps } = useFieldContext();
+ *
+ * @example
+ * // Standalone-capable input — works inside or outside a Field:
+ * const model = defineModel<string>({ default: '' });
+ * const { inputValue, inputProps } = useFieldContext({ inputValue: model });
+ *
+ * @example
+ * // Manual null-handling:
+ * const ctx = useFieldContext(null);
+ * if (ctx) { ... }
+ *
+ * @example
+ * // ❌ Wrong — `{}` does not satisfy FieldContext and will cause a type error:
+ * const { labelProps } = useFieldContext({});
+ */
+export declare function useFieldContext(): FieldContext;
+export declare function useFieldContext(defaultData: null): FieldContext | null;
+export declare function useFieldContext(defaultData: FieldContext): FieldContext;

package/dist/src/types.d.ts

@@ -33,7 +33,7 @@ export type InputProps = {
     onBlur: () => void;
 };
 export interface FieldContext {
-    inputValue: WritableComputedRef<unknown>;
+    inputValue: WritableComputedRef<unknown> | Ref<unknown>;
     inputProps: ComputedRef<InputProps>;
     labelProps: {
         for: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@overgaming/valiform",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Vue 3 form validation library",
   "keywords": [
     "form",