@gunubin/vorm-form 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 gunubin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.cjs

@@ -0,0 +1,175 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  buildOutputValues: () => buildOutputValues,
+  createField: () => createField,
+  createFormSchema: () => createFormSchema,
+  resolveMessage: () => resolveMessage,
+  validateField: () => validateField,
+  validateForm: () => validateForm
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/create-field.ts
+function createField(voOrConfig, options) {
+  if (voOrConfig && "create" in voOrConfig && typeof voOrConfig.create === "function") {
+    let factory2 = function(config2 = {}) {
+      return {
+        vo: voDef,
+        required: config2.required ?? false,
+        messages: mergeMessages(definitionMessages2, config2.messages),
+        rules: [...voDef.rules],
+        parse: parse2,
+        format: format2
+      };
+    };
+    var factory = factory2;
+    const voDef = voOrConfig;
+    const definitionMessages2 = options?.messages;
+    const parse2 = options?.parse;
+    const format2 = options?.format;
+    return factory2;
+  }
+  const config = voOrConfig ?? {};
+  const definitionMessages = config.messages;
+  const definitionRules = config.rules ?? [];
+  const parse = config.parse;
+  const format = config.format;
+  function factory(factoryConfig = {}) {
+    return {
+      vo: null,
+      required: factoryConfig.required ?? false,
+      messages: mergeMessages(definitionMessages, factoryConfig.messages),
+      rules: [...definitionRules],
+      parse,
+      format
+    };
+  }
+  return factory;
+}
+function mergeMessages(definition, factory) {
+  if (!definition && !factory) return {};
+  if (!definition) return factory;
+  if (!factory) return definition;
+  if (typeof factory === "function") return factory;
+  if (typeof definition === "function") return factory;
+  return { ...definition, ...factory };
+}
+
+// src/create-form-schema.ts
+function createFormSchema(config) {
+  return {
+    fields: config.fields,
+    messages: config.messages,
+    resolver: config.resolver
+  };
+}
+
+// src/resolve-message.ts
+var DEFAULT_MESSAGES = {
+  REQUIRED: "This field is required"
+};
+function resolveMessage(code, ...messageSources) {
+  for (const source of messageSources) {
+    if (!source) continue;
+    if (typeof source === "function") {
+      const result = source({ code });
+      if (result) return result;
+    } else {
+      const msg = source[code];
+      if (msg) return msg;
+    }
+  }
+  return DEFAULT_MESSAGES[code] ?? code;
+}
+
+// src/validate-field.ts
+function validateField(value, fieldSchema, formMessages) {
+  if (fieldSchema.required) {
+    if (value === void 0 || value === null || value === "") {
+      const code = "REQUIRED";
+      const message = resolveMessage(code, formMessages, fieldSchema.messages);
+      return { code, message };
+    }
+  } else {
+    if (value === void 0 || value === null || value === "") {
+      return null;
+    }
+  }
+  for (const rule of fieldSchema.rules) {
+    if (!rule.validate(value)) {
+      const message = resolveMessage(rule.code, formMessages, fieldSchema.messages);
+      return { code: rule.code, message };
+    }
+  }
+  return null;
+}
+
+// src/validate-form.ts
+function validateForm(values, schema) {
+  const errors = {};
+  for (const [name, fieldSchema] of Object.entries(schema.fields)) {
+    const value = values[name];
+    const formMessages = schema.messages?.[name];
+    const error = validateField(value, fieldSchema, formMessages);
+    if (error) {
+      errors[name] = error;
+    }
+  }
+  if (Object.keys(errors).length > 0) {
+    return errors;
+  }
+  if (schema.resolver) {
+    const resolverErrors = schema.resolver(values);
+    if (resolverErrors) {
+      return { ...errors, ...resolverErrors };
+    }
+  }
+  return errors;
+}
+
+// src/build-output-values.ts
+function buildOutputValues(values, fields) {
+  const output = {};
+  for (const [name, fieldSchema] of Object.entries(fields)) {
+    let value = values[name];
+    const isEmpty = value === void 0 || value === null || value === "";
+    if (isEmpty) {
+      output[name] = void 0;
+      continue;
+    }
+    if (fieldSchema.vo) {
+      value = fieldSchema.vo.create(value);
+    }
+    output[name] = value;
+  }
+  return output;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  buildOutputValues,
+  createField,
+  createFormSchema,
+  resolveMessage,
+  validateField,
+  validateForm
+});

package/dist/index.d.cts

@@ -0,0 +1,72 @@
+import { VOLike, ValidationRule } from '@gunubin/vorm-core';
+
+type ErrorMessageMap<C extends string = string> = {
+    [K in C]?: string;
+};
+type ErrorMessageFn<C extends string = string> = (error: {
+    code: C;
+}) => string;
+type ErrorMessages<C extends string = string> = ErrorMessageMap<C> | ErrorMessageFn<C>;
+type FieldSchema<T, TOutput, TRequired extends boolean, TCodes extends string = string> = {
+    vo: VOLike<T, TOutput, TCodes> | null;
+    required: TRequired;
+    messages: ErrorMessages<TCodes | (TRequired extends true ? 'REQUIRED' : never)>;
+    rules: ValidationRule<T, TCodes>[];
+    parse?: (raw: string) => T;
+    format?: (value: T) => string;
+};
+type FieldError = {
+    code: string;
+    message: string;
+};
+type FormErrors = Record<string, FieldError>;
+type FormSchemaConfig<TFields extends Record<string, FieldSchema<any, any, boolean, any>>> = {
+    fields: TFields;
+    messages?: Record<string, ErrorMessages>;
+    resolver?: (values: FormInputValues<TFields>) => FormErrors | null;
+};
+type FormSchema<TFields extends Record<string, FieldSchema<any, any, boolean, any>>> = {
+    fields: TFields;
+    messages?: Record<string, ErrorMessages>;
+    resolver?: (values: FormInputValues<TFields>) => FormErrors | null;
+};
+type FormInputValues<TFields extends Record<string, FieldSchema<any, any, boolean, any>>> = {
+    [K in keyof TFields]: TFields[K] extends FieldSchema<infer TInput, any, infer TRequired, any> ? TRequired extends true ? TInput : TInput | undefined : never;
+};
+type FormOutputValues<TFields extends Record<string, FieldSchema<any, any, boolean, any>>> = {
+    [K in keyof TFields]: TFields[K] extends FieldSchema<any, infer TOutput, infer TRequired, any> ? TRequired extends true ? TOutput : TOutput | undefined : never;
+};
+
+type FieldFactory<TInput, TOutput, TCodes extends string> = {
+    (config: {
+        required: true;
+        messages?: ErrorMessages<TCodes | 'REQUIRED'>;
+    }): FieldSchema<TInput, TOutput, true, TCodes>;
+    (config?: {
+        required?: false;
+        messages?: ErrorMessages<TCodes>;
+    }): FieldSchema<TInput, TOutput, false, TCodes>;
+};
+declare function createField<TInput, TOutput, TCodes extends string>(vo: VOLike<TInput, TOutput, TCodes>, options?: {
+    messages?: ErrorMessages<TCodes>;
+    parse?: (raw: string) => TInput;
+    format?: (value: TInput) => string;
+}): FieldFactory<TInput, TOutput, TCodes>;
+declare function createField<T, TOut = T, TCodes extends string = string>(config?: {
+    rules?: ValidationRule<T, TCodes>[];
+    messages?: ErrorMessages<TCodes>;
+    parse?: (raw: string) => T;
+    format?: (value: T) => string;
+}): FieldFactory<T, TOut, TCodes>;
+
+declare function createFormSchema<TFields extends Record<string, FieldSchema<any, any, boolean, any>>>(config: FormSchemaConfig<TFields>): FormSchema<TFields>;
+
+declare function validateField<T>(value: T | undefined | null, fieldSchema: FieldSchema<T, any, boolean, any>, formMessages?: ErrorMessages): FieldError | null;
+
+declare function validateForm<TFields extends Record<string, FieldSchema<any, any, boolean, any>>>(values: FormInputValues<TFields>, schema: FormSchema<TFields>): FormErrors;
+
+declare function buildOutputValues(values: Record<string, unknown>, fields: Record<string, FieldSchema<any, any, boolean, any>>): Record<string, unknown>;
+
+declare function resolveMessage(code: string, ...messageSources: (ErrorMessages | undefined)[]): string;
+
+export { type ErrorMessageFn, type ErrorMessageMap, type ErrorMessages, type FieldError, type FieldSchema, type FormErrors, type FormInputValues, type FormOutputValues, type FormSchema, type FormSchemaConfig, buildOutputValues, createField, createFormSchema, resolveMessage, validateField, validateForm };

package/dist/index.d.ts

@@ -0,0 +1,72 @@
+import { VOLike, ValidationRule } from '@gunubin/vorm-core';
+
+type ErrorMessageMap<C extends string = string> = {
+    [K in C]?: string;
+};
+type ErrorMessageFn<C extends string = string> = (error: {
+    code: C;
+}) => string;
+type ErrorMessages<C extends string = string> = ErrorMessageMap<C> | ErrorMessageFn<C>;
+type FieldSchema<T, TOutput, TRequired extends boolean, TCodes extends string = string> = {
+    vo: VOLike<T, TOutput, TCodes> | null;
+    required: TRequired;
+    messages: ErrorMessages<TCodes | (TRequired extends true ? 'REQUIRED' : never)>;
+    rules: ValidationRule<T, TCodes>[];
+    parse?: (raw: string) => T;
+    format?: (value: T) => string;
+};
+type FieldError = {
+    code: string;
+    message: string;
+};
+type FormErrors = Record<string, FieldError>;
+type FormSchemaConfig<TFields extends Record<string, FieldSchema<any, any, boolean, any>>> = {
+    fields: TFields;
+    messages?: Record<string, ErrorMessages>;
+    resolver?: (values: FormInputValues<TFields>) => FormErrors | null;
+};
+type FormSchema<TFields extends Record<string, FieldSchema<any, any, boolean, any>>> = {
+    fields: TFields;
+    messages?: Record<string, ErrorMessages>;
+    resolver?: (values: FormInputValues<TFields>) => FormErrors | null;
+};
+type FormInputValues<TFields extends Record<string, FieldSchema<any, any, boolean, any>>> = {
+    [K in keyof TFields]: TFields[K] extends FieldSchema<infer TInput, any, infer TRequired, any> ? TRequired extends true ? TInput : TInput | undefined : never;
+};
+type FormOutputValues<TFields extends Record<string, FieldSchema<any, any, boolean, any>>> = {
+    [K in keyof TFields]: TFields[K] extends FieldSchema<any, infer TOutput, infer TRequired, any> ? TRequired extends true ? TOutput : TOutput | undefined : never;
+};
+
+type FieldFactory<TInput, TOutput, TCodes extends string> = {
+    (config: {
+        required: true;
+        messages?: ErrorMessages<TCodes | 'REQUIRED'>;
+    }): FieldSchema<TInput, TOutput, true, TCodes>;
+    (config?: {
+        required?: false;
+        messages?: ErrorMessages<TCodes>;
+    }): FieldSchema<TInput, TOutput, false, TCodes>;
+};
+declare function createField<TInput, TOutput, TCodes extends string>(vo: VOLike<TInput, TOutput, TCodes>, options?: {
+    messages?: ErrorMessages<TCodes>;
+    parse?: (raw: string) => TInput;
+    format?: (value: TInput) => string;
+}): FieldFactory<TInput, TOutput, TCodes>;
+declare function createField<T, TOut = T, TCodes extends string = string>(config?: {
+    rules?: ValidationRule<T, TCodes>[];
+    messages?: ErrorMessages<TCodes>;
+    parse?: (raw: string) => T;
+    format?: (value: T) => string;
+}): FieldFactory<T, TOut, TCodes>;
+
+declare function createFormSchema<TFields extends Record<string, FieldSchema<any, any, boolean, any>>>(config: FormSchemaConfig<TFields>): FormSchema<TFields>;
+
+declare function validateField<T>(value: T | undefined | null, fieldSchema: FieldSchema<T, any, boolean, any>, formMessages?: ErrorMessages): FieldError | null;
+
+declare function validateForm<TFields extends Record<string, FieldSchema<any, any, boolean, any>>>(values: FormInputValues<TFields>, schema: FormSchema<TFields>): FormErrors;
+
+declare function buildOutputValues(values: Record<string, unknown>, fields: Record<string, FieldSchema<any, any, boolean, any>>): Record<string, unknown>;
+
+declare function resolveMessage(code: string, ...messageSources: (ErrorMessages | undefined)[]): string;
+
+export { type ErrorMessageFn, type ErrorMessageMap, type ErrorMessages, type FieldError, type FieldSchema, type FormErrors, type FormInputValues, type FormOutputValues, type FormSchema, type FormSchemaConfig, buildOutputValues, createField, createFormSchema, resolveMessage, validateField, validateForm };

package/dist/index.js

@@ -0,0 +1,143 @@
+// src/create-field.ts
+function createField(voOrConfig, options) {
+  if (voOrConfig && "create" in voOrConfig && typeof voOrConfig.create === "function") {
+    let factory2 = function(config2 = {}) {
+      return {
+        vo: voDef,
+        required: config2.required ?? false,
+        messages: mergeMessages(definitionMessages2, config2.messages),
+        rules: [...voDef.rules],
+        parse: parse2,
+        format: format2
+      };
+    };
+    var factory = factory2;
+    const voDef = voOrConfig;
+    const definitionMessages2 = options?.messages;
+    const parse2 = options?.parse;
+    const format2 = options?.format;
+    return factory2;
+  }
+  const config = voOrConfig ?? {};
+  const definitionMessages = config.messages;
+  const definitionRules = config.rules ?? [];
+  const parse = config.parse;
+  const format = config.format;
+  function factory(factoryConfig = {}) {
+    return {
+      vo: null,
+      required: factoryConfig.required ?? false,
+      messages: mergeMessages(definitionMessages, factoryConfig.messages),
+      rules: [...definitionRules],
+      parse,
+      format
+    };
+  }
+  return factory;
+}
+function mergeMessages(definition, factory) {
+  if (!definition && !factory) return {};
+  if (!definition) return factory;
+  if (!factory) return definition;
+  if (typeof factory === "function") return factory;
+  if (typeof definition === "function") return factory;
+  return { ...definition, ...factory };
+}
+
+// src/create-form-schema.ts
+function createFormSchema(config) {
+  return {
+    fields: config.fields,
+    messages: config.messages,
+    resolver: config.resolver
+  };
+}
+
+// src/resolve-message.ts
+var DEFAULT_MESSAGES = {
+  REQUIRED: "This field is required"
+};
+function resolveMessage(code, ...messageSources) {
+  for (const source of messageSources) {
+    if (!source) continue;
+    if (typeof source === "function") {
+      const result = source({ code });
+      if (result) return result;
+    } else {
+      const msg = source[code];
+      if (msg) return msg;
+    }
+  }
+  return DEFAULT_MESSAGES[code] ?? code;
+}
+
+// src/validate-field.ts
+function validateField(value, fieldSchema, formMessages) {
+  if (fieldSchema.required) {
+    if (value === void 0 || value === null || value === "") {
+      const code = "REQUIRED";
+      const message = resolveMessage(code, formMessages, fieldSchema.messages);
+      return { code, message };
+    }
+  } else {
+    if (value === void 0 || value === null || value === "") {
+      return null;
+    }
+  }
+  for (const rule of fieldSchema.rules) {
+    if (!rule.validate(value)) {
+      const message = resolveMessage(rule.code, formMessages, fieldSchema.messages);
+      return { code: rule.code, message };
+    }
+  }
+  return null;
+}
+
+// src/validate-form.ts
+function validateForm(values, schema) {
+  const errors = {};
+  for (const [name, fieldSchema] of Object.entries(schema.fields)) {
+    const value = values[name];
+    const formMessages = schema.messages?.[name];
+    const error = validateField(value, fieldSchema, formMessages);
+    if (error) {
+      errors[name] = error;
+    }
+  }
+  if (Object.keys(errors).length > 0) {
+    return errors;
+  }
+  if (schema.resolver) {
+    const resolverErrors = schema.resolver(values);
+    if (resolverErrors) {
+      return { ...errors, ...resolverErrors };
+    }
+  }
+  return errors;
+}
+
+// src/build-output-values.ts
+function buildOutputValues(values, fields) {
+  const output = {};
+  for (const [name, fieldSchema] of Object.entries(fields)) {
+    let value = values[name];
+    const isEmpty = value === void 0 || value === null || value === "";
+    if (isEmpty) {
+      output[name] = void 0;
+      continue;
+    }
+    if (fieldSchema.vo) {
+      value = fieldSchema.vo.create(value);
+    }
+    output[name] = value;
+  }
+  return output;
+}
+export {
+  buildOutputValues,
+  createField,
+  createFormSchema,
+  resolveMessage,
+  validateField,
+  validateForm
+};

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@gunubin/vorm-form",
+  "version": "0.1.0",
+  "description": "Field schemas, form validation, and output building for vorm",
+  "keywords": [
+    "form",
+    "validation",
+    "field-schema",
+    "typescript"
+  ],
+  "license": "MIT",
+  "author": "gunubin",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/gunubin/vorm.git",
+    "directory": "packages/form"
+  },
+  "homepage": "https://github.com/gunubin/vorm#readme",
+  "bugs": {
+    "url": "https://github.com/gunubin/vorm/issues"
+  },
+  "sideEffects": false,
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@gunubin/vorm-core": "0.2.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.9.3",
+    "vitest": "^3.0.5"
+  },
+  "scripts": {
+    "build": "tsup",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  }
+}