0.5.0 (#4)

* Removed placeholder application

* Reorganized exports

* Fixed undefined helper message

* requireTouched true as default

* Fixed imports

* Fixed demo

* Removed requirement of type Record

* Added defaultState and errorState custom configurations

* Removed unused imports

* Updated demo

projects/signal-forms/src/lib/helpers/is-signal-form-valid.helper.ts

@@ -1,5 +1,5 @@
 import { Signal, computed } from "@angular/core"
-import { SignalForm } from "../interfaces"
+import { SignalForm } from "../interfaces/signal-forms.interface"
 
 /**
  * Creates a signal representing the SignalForm validity

projects/signal-forms/src/lib/helpers/reset-signal-form.helper.ts

@@ -1,4 +1,4 @@
-import { SignalForm } from "../interfaces"
+import { SignalForm } from "../interfaces/signal-forms.interface"
 
 /**
  * Resets a SignalForm to it's initial values

projects/signal-forms/src/lib/helpers/run-validators.helper.ts

@@ -1,14 +1,16 @@
+import { ValidatorFunction } from "../interfaces/validator-function.interface"
+
 /**
  * Private helper. Runs all validators and returns the validation message if any fail
  * @param validators the list of validators
  * @param currentValue the currentValue signal value
  * @returns The validation message of the failed validator
  */
-export function runValidators(validators: Array<Function>, currentValue: any): string | null {
+export function runValidators<T>(validators: Array<ValidatorFunction<T>>, currentValue: T): string | null {
 	for (let validator of validators) {
 		let validationResult = validator(currentValue)
 		if (validationResult) {
-			return validationResult
+			return validationResult.message
 		}
 	}
 	return null

projects/signal-forms/src/lib/helpers/signal-form-value.helper.ts

@@ -1,5 +1,5 @@
 import { computed } from "@angular/core"
-import { SignalForm } from "../interfaces"
+import { SignalForm } from "../interfaces/signal-forms.interface"
 
 export function signalFormValue<T extends Record<string | number | symbol, unknown>>(signalForm: SignalForm<T>) {
 	return computed(() => {

projects/signal-forms/src/lib/interfaces/signal-forms-definition.interface.ts

@@ -1,8 +1,8 @@
-import { BaseType } from "./base-type.interface"
+import { ValidatorFunction } from "./validator-function.interface"
 
-export type SignalFormDefinition<T extends BaseType> = {
+export type SignalFormDefinition<T> = {
     [K in keyof T]: {
         initialValue: T[K],
-        validators?: Array<(value: T[K]) => Error | null>
+        validators?: Array<ValidatorFunction<T[K]>>
     }
 }

projects/signal-forms/src/lib/interfaces/signal-forms-options.interface.ts

@@ -1,3 +1,5 @@
 export type SignalFormOptions = {
-    requireTouched: boolean
+    requireTouched: boolean,
+    defaultState: string,
+    errorState: string
 }

projects/signal-forms/src/lib/interfaces/signal-forms.interface.ts

@@ -1,12 +1,12 @@
 import { Signal, WritableSignal } from "@angular/core"
-import { BaseType } from "./base-type.interface"
+import { State } from "./state.interface"
 
-export type SignalForm<T extends BaseType> = {
+export type SignalForm<T> = {
     [K in keyof T]: {
         initialValue: T[K],
         currentValue: WritableSignal<T[K]>,
         touched: WritableSignal<boolean>,
-        state: Signal<['error' | 'default', string | null]>,
+        state: Signal<State>,
         valid: Signal<boolean>
     }
 }

projects/signal-forms/src/lib/interfaces/state.interface.ts

@@ -0,0 +1,4 @@
+export type State = {
+    state: string,
+    message: string | null
+}

projects/signal-forms/src/lib/interfaces/validator-function.interface.ts

@@ -0,0 +1 @@
+export type ValidatorFunction<T> = (value: T) => Error | null

projects/signal-forms/src/lib/signal-forms.module.ts

@@ -1,10 +1,14 @@
 import { signal, computed } from "@angular/core"
 import { runValidators } from "./helpers/run-validators.helper"
-import { SignalFormOptions, SignalFormDefinition, SignalForm } from "./interfaces"
+import { SignalFormOptions } from "./interfaces/signal-forms-options.interface"
+import { SignalFormDefinition } from "./interfaces/signal-forms-definition.interface"
+import { SignalForm } from "./interfaces/signal-forms.interface"
 
 
 const signalFormOptionsDefaults: SignalFormOptions = {
-    requireTouched: false
+    requireTouched: true,
+	defaultState: 'default',
+	errorState: 'error'
 }
 
 /**
@@ -13,7 +17,7 @@ const signalFormOptionsDefaults: SignalFormOptions = {
  * @param options An optional SignalFormOptions object
  * @returns a SignalForm
  */
-export function signalForm<T extends Record<string | number | symbol, unknown>>(
+export function signalForm<T>(
     initialValue: SignalFormDefinition<T>, 
     options: SignalFormOptions = signalFormOptionsDefaults
 ) {
@@ -26,13 +30,13 @@ export function signalForm<T extends Record<string | number | symbol, unknown>>(
 			touched: signal(false),
 			state: computed(() => {
 				if (options.requireTouched && !signalForm[key].touched()) {
-					return ['default', null]
+					return {state: options.defaultState, message: null}
 				}
 				let validationResult = runValidators(value.validators ?? [], signalForm[key].currentValue())
 				if (validationResult) {
-					return ['error', validationResult]
+					return {state: options.errorState, message: validationResult}
 				}
-				return ['default', null]
+				return {state: options.defaultState, message: null}
 			}),
 			valid: computed(() => !runValidators(value.validators ?? [], signalForm[key].currentValue()))
 		}

projects/signal-forms/src/public-api.ts

@@ -3,5 +3,11 @@
  */
 
 export * from './lib/signal-forms.module'
-export * from './lib/helpers'
-export * from './lib/interfaces'
+
+export * from './lib/helpers/is-signal-form-valid.helper'
+export * from './lib/helpers/reset-signal-form.helper'
+export * from './lib/helpers/signal-form-value.helper'
+
+export * from './lib/interfaces/signal-forms.interface'
+export * from './lib/interfaces/signal-forms-options.interface'
+export * from './lib/interfaces/signal-forms-definition.interface'