@formwright/core 0.1.0 → 0.2.0

package/dist/index.js

@@ -1,5 +1,5 @@
-import { signal, computed, untrack, batch } from './chunk-EZUHEI5F.js';
-export { batch, computed, effect, isTracking, signal, untrack } from './chunk-EZUHEI5F.js';
+import { signal, computed, effect, untrack, batch } from './chunk-O4DUMDBU.js';
+export { batch, computed, effect, isTracking, signal, untrack } from './chunk-O4DUMDBU.js';
 import { parseSchema } from '@formwright/schema';
 
 // src/conditions.ts
@@ -90,35 +90,42 @@ function isEmpty(value) {
   return value === void 0 || value === null || value === "";
 }
 function compileValidator(schema) {
+  const overrides = schema.messages ?? {};
+  const msg = (rule, fallback) => overrides[rule] ?? (typeof schema.message === "string" ? schema.message : fallback);
   return (value) => {
-    const msg = (fallback) => typeof schema.message === "string" ? schema.message : fallback;
     if (isEmpty(value)) {
-      return schema.required ? msg("This field is required") : null;
+      return schema.required ? msg("required", "This field is required") : null;
     }
     if (schema.kind === "string" || schema.format) {
       const str = String(value);
       if (schema.minLength !== void 0 && str.length < schema.minLength) {
-        return msg(`Must be at least ${schema.minLength} characters`);
+        return msg("minLength", `Must be at least ${schema.minLength} characters`);
       }
       if (schema.maxLength !== void 0 && str.length > schema.maxLength) {
-        return msg(`Must be at most ${schema.maxLength} characters`);
+        return msg("maxLength", `Must be at most ${schema.maxLength} characters`);
       }
       if (schema.pattern !== void 0 && !new RegExp(schema.pattern).test(str)) {
-        return msg("Invalid format");
+        return msg("pattern", "Invalid format");
       }
-      if (schema.format === "email" && !EMAIL.test(str)) return msg("Enter a valid email");
-      if (schema.format === "url" && !URL.test(str)) return msg("Enter a valid URL");
-      if (schema.format === "uuid" && !UUID.test(str)) return msg("Enter a valid UUID");
+      if (schema.format === "email" && !EMAIL.test(str))
+        return msg("format", "Enter a valid email");
+      if (schema.format === "url" && !URL.test(str)) return msg("format", "Enter a valid URL");
+      if (schema.format === "uuid" && !UUID.test(str)) return msg("format", "Enter a valid UUID");
     }
     if (schema.kind === "number") {
       const num = Number(value);
-      if (Number.isNaN(num)) return msg("Must be a number");
-      if (schema.min !== void 0 && num < schema.min) return msg(`Must be \u2265 ${schema.min}`);
-      if (schema.max !== void 0 && num > schema.max) return msg(`Must be \u2264 ${schema.max}`);
+      if (Number.isNaN(num)) return msg("type", "Must be a number");
+      if (schema.min !== void 0 && num < schema.min)
+        return msg("min", `Must be \u2265 ${schema.min}`);
+      if (schema.max !== void 0 && num > schema.max)
+        return msg("max", `Must be \u2264 ${schema.max}`);
     }
     return null;
   };
 }
+function requiredMessage(schema) {
+  return schema?.messages?.required ?? (typeof schema?.message === "string" ? schema.message : "This field is required");
+}
 
 // src/providers.ts
 function isProviderRef(value) {
@@ -158,10 +165,14 @@ function defaultValueFor(type) {
       return "";
   }
 }
+var uidSeq = 0;
 var FieldState = class {
   /** Discriminant for the {@link FieldNode} union (leaf vs group/collection). */
   kind = "field";
   id;
+  /** A globally-unique DOM id for the control (collection rows reuse `id`, so this must be unique). */
+  domId = `fw-${(uidSeq++).toString(36)}`;
+  /** The field's schema — mutable at runtime via {@link patchSchema}. */
   schema;
   value;
   error;
@@ -169,7 +180,10 @@ var FieldState = class {
   visible;
   enabled;
   required;
+  /** Bumps whenever the schema is patched — renderers re-render the field on change. */
+  revision;
   validator;
+  rev = signal(0);
   constructor(schema, initial, getValue) {
     this.id = schema.id;
     this.schema = schema;
@@ -177,15 +191,29 @@ var FieldState = class {
     this.error = signal(null);
     this.touched = signal(false);
     this.validator = schema.validation ? compileValidator(schema.validation) : null;
-    this.visible = computed(() => evaluateCondition(schema.visibleWhen, getValue, true));
-    this.enabled = computed(() => evaluateCondition(schema.enabledWhen, getValue, true));
+    this.revision = this.rev;
+    this.visible = computed(() => {
+      this.rev.get();
+      return evaluateCondition(this.schema.visibleWhen, getValue, true);
+    });
+    this.enabled = computed(() => {
+      this.rev.get();
+      return evaluateCondition(this.schema.enabledWhen, getValue, true);
+    });
     this.required = computed(() => {
-      if (schema.requiredWhen !== void 0) {
-        return evaluateCondition(schema.requiredWhen, getValue, false);
+      this.rev.get();
+      if (this.schema.requiredWhen !== void 0) {
+        return evaluateCondition(this.schema.requiredWhen, getValue, false);
       }
-      return schema.validation?.required ?? false;
+      return this.schema.validation?.required ?? false;
     });
   }
+  /** Merge a partial schema in at runtime (change type, label, options, validation, …). */
+  patchSchema(partial) {
+    this.schema = { ...this.schema, ...partial };
+    this.validator = this.schema.validation ? compileValidator(this.schema.validation) : null;
+    this.rev.update((n) => n + 1);
+  }
   /** Run validation, store and return the error (or null). Hidden fields never error. */
   validate() {
     if (!this.visible.peek()) {
@@ -194,7 +222,7 @@ var FieldState = class {
     }
     let result = null;
     if (this.required.peek() && isEmpty2(this.value.peek())) {
-      result = "This field is required";
+      result = requiredMessage(this.schema.validation);
     } else if (this.validator) {
       result = this.validator(this.value.peek());
     }
@@ -212,12 +240,20 @@ function isEmpty2(value) {
 }
 
 // src/nodes.ts
+var PRESENTATIONAL = /* @__PURE__ */ new Set(["heading", "separator", "paragraph"]);
+function isPresentational(type) {
+  return PRESENTATIONAL.has(type);
+}
 function nodeValue(node) {
   return node.value.get();
 }
 function collectValues(nodes) {
   const out = {};
-  for (const node of nodes) out[node.id] = nodeValue(node);
+  for (const node of nodes) {
+    if (node.schema.omit || isPresentational(node.schema.type)) continue;
+    if (!node.visible.get()) continue;
+    out[node.id] = nodeValue(node);
+  }
   return out;
 }
 function buildNodes(schemas, scope, initial) {
@@ -376,15 +412,28 @@ var Form = class {
   rootByName;
   listeners = /* @__PURE__ */ new Map();
   disposeRenderer = null;
+  disposePersist = null;
   constructor(schema, initialValues = {}, options = {}) {
     this.schema = parseSchema(schema);
     this.options = options;
     this.initialValues = initialValues;
-    const tree = buildTree(this.schema.fields, initialValues);
+    const fields = this.schema.locales?.length ? expandLocalized(this.schema.fields, this.schema.locales) : this.schema.fields;
+    const seed = loadPersisted(options.persistKey, initialValues);
+    const tree = buildTree(fields, seed);
     this.tree = tree.nodes;
     this.rootByName = tree.byName;
-    this.order = this.schema.fields.map((f) => f.id);
+    this.order = fields.map((f) => f.id);
     this.values = computed(() => collectTree(this.tree));
+    if (options.persistKey) {
+      const key = options.persistKey;
+      this.disposePersist = effect(() => {
+        const v = this.values.get();
+        try {
+          localStorage.setItem(key, JSON.stringify(v));
+        } catch {
+        }
+      });
+    }
     this.initialSnapshot = JSON.stringify(untrack(() => this.values.peek()));
     this.isDirty = computed(() => JSON.stringify(this.values.get()) !== this.initialSnapshot);
     this.isValid = computed(() => {
@@ -415,12 +464,22 @@ var Form = class {
   setFieldValue(field, value) {
     field.value.set(value);
     field.touched.set(true);
-    if (field.error.peek() !== null) field.validate();
+    field.validate();
     this.emit("change", { id: field.id, value });
   }
   setError(id, error) {
     this.field(id)?.error.set(error);
   }
+  /** Patch one field's schema at runtime (change type, label, options, validation, …). */
+  setFieldSchema(path, partial) {
+    this.field(path)?.patchSchema(partial);
+  }
+  /** Patch many fields' schemas at once: `form.patch({ state: { type: "text" }, … })`. */
+  patch(updates) {
+    batch(() => {
+      for (const [path, partial] of Object.entries(updates)) this.setFieldSchema(path, partial);
+    });
+  }
   setErrors(errors) {
     batch(() => {
       for (const [id, error] of Object.entries(errors)) this.setError(id, error);
@@ -442,27 +501,38 @@ var Form = class {
       return ok;
     });
   }
-  /** Run the submission pipeline: validate → transform → send → onSuccess/onError. */
-  async submit() {
+  /**
+   * Run the submission pipeline: validate → transform → send → onSuccess/onError.
+   * Pass an inline `transform` to shape the final payload, e.g.
+   * `form.submit((values) => ({ ...values, source: "web" }))`.
+   *
+   * Always **resolves** with a {@link SubmitResult} — never throws — so you can
+   * handle both outcomes from the API in one place:
+   * `const res = await form.submit(); res.ok ? res.data : res.error`.
+   */
+  async submit(transform) {
     if (!this.validate()) {
-      const error = new FormValidationError(this.collectErrors());
+      const errors = this.collectErrors();
+      const error = new FormValidationError(errors);
       this.runErrorHandler(error);
       this.emit("error", error);
-      throw error;
+      return { ok: false, error, errors };
     }
     this.submitting.set(true);
     const values = untrack(() => this.values.peek());
-    const payload = this.applyTransform(values);
+    const named = this.applyTransform(values);
+    const payload = transform ? transform(named, this) : named;
     this.emit("submit", payload);
     try {
-      const result = await this.send(payload);
-      this.runSuccessHandler(result);
-      this.emit("success", result);
-      return result;
+      const data = await this.send(payload);
+      this.clearPersisted();
+      this.runSuccessHandler(data);
+      this.emit("success", data);
+      return { ok: true, data };
     } catch (error) {
       this.runErrorHandler(error);
       this.emit("error", error);
-      throw error;
+      return { ok: false, error };
     } finally {
       this.submitting.set(false);
     }
@@ -472,6 +542,13 @@ var Form = class {
       resetNodes(this.tree, values);
     });
   }
+  /** Trigger a named form action: runs its handler (from options) and emits "action". */
+  action(name) {
+    const def = this.schema.actions?.find((a) => a.name === name);
+    const handler = def?.handler ? this.options.handlers?.[def.handler] : void 0;
+    handler?.(this);
+    this.emit("action", { name });
+  }
   /** Mount into a host element using the given renderer (or the registered default). */
   mount(host, renderer = defaultRenderer) {
     if (!renderer) {
@@ -486,8 +563,19 @@ var Form = class {
   destroy() {
     this.disposeRenderer?.();
     this.disposeRenderer = null;
+    this.disposePersist?.();
+    this.disposePersist = null;
     this.listeners.clear();
   }
+  /** Remove the cached draft from `localStorage` (called on a successful submit). */
+  clearPersisted() {
+    const key = this.options.persistKey;
+    if (!key || typeof localStorage === "undefined") return;
+    try {
+      localStorage.removeItem(key);
+    } catch {
+    }
+  }
   // ---- events -------------------------------------------------------------
   on(event, listener) {
     let set = this.listeners.get(event);
@@ -549,6 +637,54 @@ var FormValidationError = class extends Error {
 function collectTree(tree) {
   return collectValues(tree);
 }
+function loadPersisted(key, initial) {
+  if (!key || typeof localStorage === "undefined") return initial;
+  try {
+    const saved = localStorage.getItem(key);
+    if (saved) return { ...initial, ...JSON.parse(saved) };
+  } catch {
+  }
+  return initial;
+}
+function expandLocalized(fields, locales) {
+  return fields.map((f) => {
+    if (f.localized) {
+      const leafType = f.type === "group" || f.type === "collection" ? "text" : f.type;
+      const child = (loc) => {
+        const c = { id: loc, type: leafType, label: loc };
+        if (f.placeholder !== void 0) c["placeholder"] = f.placeholder;
+        if (f.validation !== void 0) c["validation"] = f.validation;
+        if (f.options !== void 0) c["options"] = f.options;
+        if (f.widget !== void 0) c["widget"] = f.widget;
+        if (f.tooltip !== void 0) c["tooltip"] = f.tooltip;
+        return c;
+      };
+      const group = {
+        id: f.id,
+        type: "group",
+        // Keep the `localized` flag so the renderer shows ONE input + a language
+        // switcher (instead of one input per locale). Value stays `{ en, ar }`.
+        localized: true,
+        fields: locales.map(child)
+      };
+      if (f.defaultLocale !== void 0) group["defaultLocale"] = f.defaultLocale;
+      for (const key of [
+        "label",
+        "visibleWhen",
+        "enabledWhen",
+        "class",
+        "classes",
+        "help",
+        "tooltip"
+      ]) {
+        if (f[key] !== void 0) group[key] = f[key];
+      }
+      return group;
+    }
+    if (f.fields) return { ...f, fields: expandLocalized(f.fields, locales) };
+    return f;
+  });
+}
 function collectLeaves(tree) {
   const out = /* @__PURE__ */ new Map();
   const walk = (nodes, prefix) => {
@@ -580,6 +716,6 @@ function resolveLeaf(tree, rootByName, path) {
   return node && node.kind === "field" ? node : void 0;
 }
 
-export { CollectionNode, FieldState, Form, FormValidationError, GroupNode, buildTree, compileValidator, defaultValueFor, eachLeaf, evaluateCondition, isProviderRef, referencedFields, resolve, resolveQuery, setDefaultRenderer };
+export { CollectionNode, FieldState, Form, FormValidationError, GroupNode, buildTree, compileValidator, defaultValueFor, eachLeaf, evaluateCondition, isPresentational, isProviderRef, referencedFields, resolve, resolveQuery, setDefaultRenderer };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map