@lucas-barake/effect-form 0.8.0 → 0.9.1

package/src/FormBuilder.ts

@@ -1,6 +1,3 @@
-/**
- * @since 1.0.0
- */
 import type * as Registry from "@effect-atom/atom/Registry"
 import type * as Effect from "effect/Effect"
 import type * as Option from "effect/Option"
@@ -18,7 +15,6 @@ import type {
 import { isArrayFieldDef, isFieldDef } from "./Field.js"
 
 /**
- * @since 1.0.0
  * @category Models
  */
 export interface SubmittedValues<TFields extends FieldsRecord> {
@@ -29,14 +25,12 @@ export interface SubmittedValues<TFields extends FieldsRecord> {
 /**
  * Unique identifier for Field references.
  *
- * @since 1.0.0
  * @category Symbols
  * @internal
  */
 export const FieldTypeId: unique symbol = Symbol.for("@lucas-barake/effect-form/Field")
 
 /**
- * @since 1.0.0
  * @category Symbols
  * @internal
  */
@@ -45,7 +39,6 @@ export type FieldTypeId = typeof FieldTypeId
 /**
  * A field reference carrying type and path info for type-safe setValue operations.
  *
- * @since 1.0.0
  * @category Models
  */
 export interface FieldRef<S> {
@@ -57,7 +50,6 @@ export interface FieldRef<S> {
 /**
  * Creates a field reference for type-safe setValue operations.
  *
- * @since 1.0.0
  * @category Constructors
  * @internal
  */
@@ -74,13 +66,11 @@ export const makeFieldRef = <S>(key: string): FieldRef<S> => ({
 /**
  * Unique identifier for FormBuilder instances.
  *
- * @since 1.0.0
  * @category Symbols
  */
 export const TypeId: unique symbol = Symbol.for("@lucas-barake/effect-form/Form")
 
 /**
- * @since 1.0.0
  * @category Symbols
  */
 export type TypeId = typeof TypeId
@@ -88,7 +78,6 @@ export type TypeId = typeof TypeId
 /**
  * The state of a form at runtime.
  *
- * @since 1.0.0
  * @category Models
  */
 export interface FormState<TFields extends FieldsRecord> {
@@ -121,7 +110,6 @@ type Refinement = SyncRefinement | AsyncRefinement
  * includes a Schema for validation. The builder accumulates field definitions
  * and context requirements (`R`) from schemas that use Effect services.
  *
- * @since 1.0.0
  * @category Models
  */
 export interface FormBuilder<TFields extends FieldsRecord, R> {
@@ -281,7 +269,6 @@ const FormBuilderProto = {
  * // Output: false
  * ```
  *
- * @since 1.0.0
  * @category Guards
  */
 export const isFormBuilder = (u: unknown): u is FormBuilder<any, any> => Predicate.hasProperty(u, TypeId)
@@ -307,7 +294,6 @@ export const isFormBuilder = (u: unknown): u is FormBuilder<any, any> => Predica
  *   .addField(PasswordField)
  * ```
  *
- * @since 1.0.0
  * @category Constructors
  */
 // eslint-disable-next-line @typescript-eslint/no-empty-object-type
@@ -321,7 +307,6 @@ export const empty: FormBuilder<{}, never> = (() => {
 /**
  * Builds a combined Schema from a FormBuilder's field definitions.
  *
- * @since 1.0.0
  * @category Schema
  */
 export const buildSchema = <TFields extends FieldsRecord, R>(

package/src/Mode.ts

@@ -1,7 +1,5 @@
 /**
  * Form validation mode configuration.
- *
- * @since 1.0.0
  */
 import * as Duration from "effect/Duration"
 
@@ -17,7 +15,6 @@ import * as Duration from "effect/Duration"
  * - `{ onChange: { debounce, autoSubmit? } }`: Debounced validation, optional auto-submit
  * - `{ onBlur: { autoSubmit: true } }`: Validate on blur, auto-submit when valid
  *
- * @since 1.0.0
  * @category Models
  */
 export type FormMode =
@@ -32,7 +29,6 @@ export type FormMode =
  * Form mode without auto-submit options.
  * Used when SubmitArgs is not void, since auto-submit cannot provide custom arguments.
  *
- * @since 1.0.0
  * @category Models
  */
 export type FormModeWithoutAutoSubmit =
@@ -44,7 +40,6 @@ export type FormModeWithoutAutoSubmit =
 /**
  * Parsed form mode with resolved values.
  *
- * @since 1.0.0
  * @category Models
  */
 export interface ParsedMode {
@@ -56,7 +51,6 @@ export interface ParsedMode {
 /**
  * Parses a FormMode into a normalized ParsedMode.
  *
- * @since 1.0.0
  * @category Parsing
  */
 export const parse = (mode: FormMode = "onSubmit"): ParsedMode => {

package/src/{internal/path.ts → Path.ts}

@@ -1,7 +1,5 @@
 /**
- * Internal path utilities for form field operations.
- *
- * @internal
+ * Path utilities for form field operations.
  */
 
 const BRACKET_NOTATION_REGEX = /\[(\d+)\]/g

package/src/Validation.ts

@@ -1,16 +1,13 @@
 /**
  * Validation utilities for form error handling.
- *
- * @since 1.0.0
  */
 import * as Option from "effect/Option"
 import * as ParseResult from "effect/ParseResult"
-import { schemaPathToFieldPath } from "./internal/path.js"
+import { schemaPathToFieldPath } from "./Path.js"
 
 /**
  * Extracts the first error message from a ParseError.
  *
- * @since 1.0.0
  * @category Error Handling
  */
 export const extractFirstError = (error: ParseResult.ParseError): Option.Option<string> => {
@@ -25,7 +22,6 @@ export const extractFirstError = (error: ParseResult.ParseError): Option.Option<
  * Routes validation errors from a ParseError to a map of field paths to error messages.
  * Used for cross-field validation where schema errors need to be displayed on specific fields.
  *
- * @since 1.0.0
  * @category Error Handling
  */
 export const routeErrors = (error: ParseResult.ParseError): Map<string, string> => {

package/src/index.ts

@@ -1,33 +1,31 @@
 /**
  * Field definitions for type-safe forms.
- *
- * @since 1.0.0
  */
 export * as Field from "./Field.js"
 
 /**
  * Atoms for a single field.
  *
- * @since 1.0.0
  * @category Models
  */
 export * as FormAtoms from "./FormAtoms.js"
 
 /**
- * @since 1.0.0
+ * @category Models
  */
 export * as FormBuilder from "./FormBuilder.js"
 
 /**
  * Form validation mode configuration.
- *
- * @since 1.0.0
  */
 export * as Mode from "./Mode.js"
 
+/**
+ * Path utilities for form field operations.
+ */
+export * as Path from "./Path.js"
+
 /**
  * Validation utilities for form error handling.
- *
- * @since 1.0.0
  */
 export * as Validation from "./Validation.js"

package/src/internal/dirty.ts

@@ -5,7 +5,7 @@
  */
 import * as Equal from "effect/Equal"
 import * as Utils from "effect/Utils"
-import { getNestedValue, isPathUnderRoot } from "./path.js"
+import { getNestedValue, isPathUnderRoot } from "../Path.js"
 
 /**
  * Recalculates dirty fields for an array after mutation.

package/dist/cjs/internal/path.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"path.js","names":["BRACKET_NOTATION_REGEX","schemaPathToFieldPath","path","length","result","String","i","segment","exports","isPathUnderRoot","rootPath","startsWith","isPathOrParentDirty","dirtyFields","has","parent","lastDot","lastIndexOf","lastBracket","splitIndex","Math","max","substring","getNestedValue","obj","parts","replace","split","current","part","undefined","setNestedValue","value","Array","isArray"],"sources":["../../../src/internal/path.ts"],"sourcesContent":[null],"mappings":";;;;;;AAAA;;;;;AAMA,MAAMA,sBAAsB,GAAG,YAAY;AAE3C;;;;;;AAMO,MAAMC,qBAAqB,GAAIC,IAAgC,IAAY;EAChF,IAAIA,IAAI,CAACC,MAAM,KAAK,CAAC,EAAE,OAAO,EAAE;EAEhC,IAAIC,MAAM,GAAGC,MAAM,CAACH,IAAI,CAAC,CAAC,CAAC,CAAC;EAC5B,KAAK,IAAII,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGJ,IAAI,CAACC,MAAM,EAAEG,CAAC,EAAE,EAAE;IACpC,MAAMC,OAAO,GAAGL,IAAI,CAACI,CAAC,CAAC;IACvB,IAAI,OAAOC,OAAO,KAAK,QAAQ,EAAE;MAC/BH,MAAM,IAAI,IAAIG,OAAO,GAAG;IAC1B,CAAC,MAAM;MACLH,MAAM,IAAI,IAAIC,MAAM,CAACE,OAAO,CAAC,EAAE;IACjC;EACF;EACA,OAAOH,MAAM;AACf,CAAC;AAED;;;;;;;;;AAAAI,OAAA,CAAAP,qBAAA,GAAAA,qBAAA;AASO,MAAMQ,eAAe,GAAGA,CAACP,IAAY,EAAEQ,QAAgB,KAC5DR,IAAI,KAAKQ,QAAQ,IAAIR,IAAI,CAACS,UAAU,CAACD,QAAQ,GAAG,GAAG,CAAC,IAAIR,IAAI,CAACS,UAAU,CAACD,QAAQ,GAAG,GAAG,CAAC;AAEzF;;;AAAAF,OAAA,CAAAC,eAAA,GAAAA,eAAA;AAGO,MAAMG,mBAAmB,GAAGA,CAACC,WAAgC,EAAEX,IAAY,KAAa;EAC7F,IAAIW,WAAW,CAACC,GAAG,CAACZ,IAAI,CAAC,EAAE,OAAO,IAAI;EAEtC,IAAIa,MAAM,GAAGb,IAAI;EACjB,OAAO,IAAI,EAAE;IACX,MAAMc,OAAO,GAAGD,MAAM,CAACE,WAAW,CAAC,GAAG,CAAC;IACvC,MAAMC,WAAW,GAAGH,MAAM,CAACE,WAAW,CAAC,GAAG,CAAC;IAC3C,MAAME,UAAU,GAAGC,IAAI,CAACC,GAAG,CAACL,OAAO,EAAEE,WAAW,CAAC;IAEjD,IAAIC,UAAU,KAAK,CAAC,CAAC,EAAE;IAEvBJ,MAAM,GAAGA,MAAM,CAACO,SAAS,CAAC,CAAC,EAAEH,UAAU,CAAC;IACxC,IAAIN,WAAW,CAACC,GAAG,CAACC,MAAM,CAAC,EAAE,OAAO,IAAI;EAC1C;EAEA,OAAO,KAAK;AACd,CAAC;AAED;;;;;;AAAAP,OAAA,CAAAI,mBAAA,GAAAA,mBAAA;AAMO,MAAMW,cAAc,GAAGA,CAACC,GAAY,EAAEtB,IAAY,KAAa;EACpE,IAAIA,IAAI,KAAK,EAAE,EAAE,OAAOsB,GAAG;EAC3B,MAAMC,KAAK,GAAGvB,IAAI,CAACwB,OAAO,CAAC1B,sBAAsB,EAAE,KAAK,CAAC,CAAC2B,KAAK,CAAC,GAAG,CAAC;EACpE,IAAIC,OAAO,GAAYJ,GAAG;EAC1B,KAAK,MAAMK,IAAI,IAAIJ,KAAK,EAAE;IACxB,IAAIG,OAAO,IAAI,IAAI,IAAI,OAAOA,OAAO,KAAK,QAAQ,EAAE,OAAOE,SAAS;IACpEF,OAAO,GAAIA,OAAmC,CAACC,IAAI,CAAC;EACtD;EACA,OAAOD,OAAO;AAChB,CAAC;AAED;;;;;;;AAAApB,OAAA,CAAAe,cAAA,GAAAA,cAAA;AAOO,MAAMQ,cAAc,GAAGA,CAAIP,GAAM,EAAEtB,IAAY,EAAE8B,KAAc,KAAO;EAC3E,IAAI9B,IAAI,KAAK,EAAE,EAAE,OAAO8B,KAAU;EAClC,MAAMP,KAAK,GAAGvB,IAAI,CAACwB,OAAO,CAAC1B,sBAAsB,EAAE,KAAK,CAAC,CAAC2B,KAAK,CAAC,GAAG,CAAC;EACpE,MAAMvB,MAAM,GAAG;IAAE,GAAGoB;EAAG,CAA6B;EAEpD,IAAII,OAAO,GAAGxB,MAAM;EACpB,KAAK,IAAIE,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGmB,KAAK,CAACtB,MAAM,GAAG,CAAC,EAAEG,CAAC,EAAE,EAAE;IACzC,MAAMuB,IAAI,GAAGJ,KAAK,CAACnB,CAAC,CAAC;IACrB,IAAI2B,KAAK,CAACC,OAAO,CAACN,OAAO,CAACC,IAAI,CAAC,CAAC,EAAE;MAChCD,OAAO,CAACC,IAAI,CAAC,GAAG,CAAC,GAAID,OAAO,CAACC,IAAI,CAAoB,CAAC;IACxD,CAAC,MAAM;MACLD,OAAO,CAACC,IAAI,CAAC,GAAG;QAAE,GAAID,OAAO,CAACC,IAAI;MAA6B,CAAE;IACnE;IACAD,OAAO,GAAGA,OAAO,CAACC,IAAI,CAA4B;EACpD;EAEAD,OAAO,CAACH,KAAK,CAACA,KAAK,CAACtB,MAAM,GAAG,CAAC,CAAC,CAAC,GAAG6B,KAAK;EACxC,OAAO5B,MAAW;AACpB,CAAC;AAAAI,OAAA,CAAAuB,cAAA,GAAAA,cAAA","ignoreList":[]}

package/dist/dts/internal/path.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"path.d.ts","sourceRoot":"","sources":["../../../src/internal/path.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,GAAI,MAAM,aAAa,CAAC,WAAW,CAAC,KAAG,MAaxE,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe,GAAI,MAAM,MAAM,EAAE,UAAU,MAAM,KAAG,OACwB,CAAA;AAEzF;;GAEG;AACH,eAAO,MAAM,mBAAmB,GAAI,aAAa,WAAW,CAAC,MAAM,CAAC,EAAE,MAAM,MAAM,KAAG,OAgBpF,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GAAI,KAAK,OAAO,EAAE,MAAM,MAAM,KAAG,OAS3D,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,GAAI,CAAC,EAAE,KAAK,CAAC,EAAE,MAAM,MAAM,EAAE,OAAO,OAAO,KAAG,CAkBxE,CAAA"}

package/dist/esm/internal/path.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"path.js","names":["BRACKET_NOTATION_REGEX","schemaPathToFieldPath","path","length","result","String","i","segment","isPathUnderRoot","rootPath","startsWith","isPathOrParentDirty","dirtyFields","has","parent","lastDot","lastIndexOf","lastBracket","splitIndex","Math","max","substring","getNestedValue","obj","parts","replace","split","current","part","undefined","setNestedValue","value","Array","isArray"],"sources":["../../../src/internal/path.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;AAMA,MAAMA,sBAAsB,GAAG,YAAY;AAE3C;;;;;;AAMA,OAAO,MAAMC,qBAAqB,GAAIC,IAAgC,IAAY;EAChF,IAAIA,IAAI,CAACC,MAAM,KAAK,CAAC,EAAE,OAAO,EAAE;EAEhC,IAAIC,MAAM,GAAGC,MAAM,CAACH,IAAI,CAAC,CAAC,CAAC,CAAC;EAC5B,KAAK,IAAII,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGJ,IAAI,CAACC,MAAM,EAAEG,CAAC,EAAE,EAAE;IACpC,MAAMC,OAAO,GAAGL,IAAI,CAACI,CAAC,CAAC;IACvB,IAAI,OAAOC,OAAO,KAAK,QAAQ,EAAE;MAC/BH,MAAM,IAAI,IAAIG,OAAO,GAAG;IAC1B,CAAC,MAAM;MACLH,MAAM,IAAI,IAAIC,MAAM,CAACE,OAAO,CAAC,EAAE;IACjC;EACF;EACA,OAAOH,MAAM;AACf,CAAC;AAED;;;;;;;;;AASA,OAAO,MAAMI,eAAe,GAAGA,CAACN,IAAY,EAAEO,QAAgB,KAC5DP,IAAI,KAAKO,QAAQ,IAAIP,IAAI,CAACQ,UAAU,CAACD,QAAQ,GAAG,GAAG,CAAC,IAAIP,IAAI,CAACQ,UAAU,CAACD,QAAQ,GAAG,GAAG,CAAC;AAEzF;;;AAGA,OAAO,MAAME,mBAAmB,GAAGA,CAACC,WAAgC,EAAEV,IAAY,KAAa;EAC7F,IAAIU,WAAW,CAACC,GAAG,CAACX,IAAI,CAAC,EAAE,OAAO,IAAI;EAEtC,IAAIY,MAAM,GAAGZ,IAAI;EACjB,OAAO,IAAI,EAAE;IACX,MAAMa,OAAO,GAAGD,MAAM,CAACE,WAAW,CAAC,GAAG,CAAC;IACvC,MAAMC,WAAW,GAAGH,MAAM,CAACE,WAAW,CAAC,GAAG,CAAC;IAC3C,MAAME,UAAU,GAAGC,IAAI,CAACC,GAAG,CAACL,OAAO,EAAEE,WAAW,CAAC;IAEjD,IAAIC,UAAU,KAAK,CAAC,CAAC,EAAE;IAEvBJ,MAAM,GAAGA,MAAM,CAACO,SAAS,CAAC,CAAC,EAAEH,UAAU,CAAC;IACxC,IAAIN,WAAW,CAACC,GAAG,CAACC,MAAM,CAAC,EAAE,OAAO,IAAI;EAC1C;EAEA,OAAO,KAAK;AACd,CAAC;AAED;;;;;;AAMA,OAAO,MAAMQ,cAAc,GAAGA,CAACC,GAAY,EAAErB,IAAY,KAAa;EACpE,IAAIA,IAAI,KAAK,EAAE,EAAE,OAAOqB,GAAG;EAC3B,MAAMC,KAAK,GAAGtB,IAAI,CAACuB,OAAO,CAACzB,sBAAsB,EAAE,KAAK,CAAC,CAAC0B,KAAK,CAAC,GAAG,CAAC;EACpE,IAAIC,OAAO,GAAYJ,GAAG;EAC1B,KAAK,MAAMK,IAAI,IAAIJ,KAAK,EAAE;IACxB,IAAIG,OAAO,IAAI,IAAI,IAAI,OAAOA,OAAO,KAAK,QAAQ,EAAE,OAAOE,SAAS;IACpEF,OAAO,GAAIA,OAAmC,CAACC,IAAI,CAAC;EACtD;EACA,OAAOD,OAAO;AAChB,CAAC;AAED;;;;;;;AAOA,OAAO,MAAMG,cAAc,GAAGA,CAAIP,GAAM,EAAErB,IAAY,EAAE6B,KAAc,KAAO;EAC3E,IAAI7B,IAAI,KAAK,EAAE,EAAE,OAAO6B,KAAU;EAClC,MAAMP,KAAK,GAAGtB,IAAI,CAACuB,OAAO,CAACzB,sBAAsB,EAAE,KAAK,CAAC,CAAC0B,KAAK,CAAC,GAAG,CAAC;EACpE,MAAMtB,MAAM,GAAG;IAAE,GAAGmB;EAAG,CAA6B;EAEpD,IAAII,OAAO,GAAGvB,MAAM;EACpB,KAAK,IAAIE,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGkB,KAAK,CAACrB,MAAM,GAAG,CAAC,EAAEG,CAAC,EAAE,EAAE;IACzC,MAAMsB,IAAI,GAAGJ,KAAK,CAAClB,CAAC,CAAC;IACrB,IAAI0B,KAAK,CAACC,OAAO,CAACN,OAAO,CAACC,IAAI,CAAC,CAAC,EAAE;MAChCD,OAAO,CAACC,IAAI,CAAC,GAAG,CAAC,GAAID,OAAO,CAACC,IAAI,CAAoB,CAAC;IACxD,CAAC,MAAM;MACLD,OAAO,CAACC,IAAI,CAAC,GAAG;QAAE,GAAID,OAAO,CAACC,IAAI;MAA6B,CAAE;IACnE;IACAD,OAAO,GAAGA,OAAO,CAACC,IAAI,CAA4B;EACpD;EAEAD,OAAO,CAACH,KAAK,CAACA,KAAK,CAACrB,MAAM,GAAG,CAAC,CAAC,CAAC,GAAG4B,KAAK;EACxC,OAAO3B,MAAW;AACpB,CAAC","ignoreList":[]}