@wssto2/vue-core 0.4.14 → 0.4.16

package/dist/form/useForm.d.ts

@@ -80,8 +80,8 @@ export interface FormOptions<Values extends object, Output = Values> {
     readonly defaults: Values | (() => Values);
     /** The app's schema (anything with Zod's `safeParse`). Without one the server is the only validator. */
     readonly validator?: FormValidator<Output>;
-    /** Server messages are often codes: turn one into a sentence (`t(message)`). Default: as sent. */
-    readonly translate?: (message: string, field: string) => string;
+    /** A field message into a sentence, for a form that says it differently from the rest of the app. Default: the application's (`createApplication({ describeFieldError })`), else as sent. */
+    readonly describeFieldError?: (message: string, field: string) => string;
     /** The draft's name for a field the server names, given the whole dotted path (`tax_id` is `taxId`, `lines.0.unit_price` is `lines.0.unitPrice`). Default: the same name. */
     readonly serverField?: (field: string) => string;
     /** The sentence for a failure; return undefined for the library's default of that kind. */

package/dist/form/useHiddenFieldErrors.d.ts

@@ -0,0 +1,23 @@
+import { type ComputedRef, type MaybeRefOrGetter } from "vue";
+import type { Form } from "./useForm";
+export interface HiddenFieldError {
+    /** The path of the field (`lines.0.quantity`). */
+    readonly field: string;
+    /** Its first message. */
+    readonly message: string;
+}
+/**
+ * The form's errors whose field is not on screen: the draft lacks that field (a server field), or it sits in a part that is not
+ * shown (a collapsed section). `FormErrors` lists them; use this for another way to say it, such as a toast when a save fails.
+ *
+ *   const hidden = useHiddenFieldErrors({ form });
+ *   // after a refused save: toast.error(hidden.value.map((each) => `${label(each.field)}: ${each.message}`).join("; "))
+ *
+ * A field counts as shown while an element carries `data-field-key="<name>"` (`form.bind()` sets it) or the name of something that
+ * contains it. The answer follows the errors and is worked out after the next render, so read it after `await nextTick()`.
+ */
+export declare function useHiddenFieldErrors(options: {
+    readonly form: Pick<Form<object>, "errors">;
+    /** Where to look for shown fields; by default the whole document. */
+    readonly root?: MaybeRefOrGetter<ParentNode | null | undefined>;
+}): ComputedRef<readonly HiddenFieldError[]>;

package/dist/form/useSaveChrome.d.ts

@@ -11,16 +11,21 @@ export interface SaveChromeOptions {
     readonly ready?: MaybeRefOrGetter<boolean>;
     /** The action id (for tests and shortcuts). Default `save`. */
     readonly id?: string;
+    /** Save is disabled while the form has no changes (nothing to save). Default true; a page that creates a record passes false so an untouched form can still be submitted and say what is missing. */
+    readonly disabledWhileClean?: MaybeRefOrGetter<boolean>;
     readonly save: () => void;
-    /** Cancel: put the saved values back. */
-    readonly cancel: () => void;
+    /** Cancel: put the saved values back. Without it there is no Cancel (a section edited in place, where leaving is guarded anyway). */
+    readonly cancel?: () => void;
 }
 /**
  * The page chrome of a page that edits directly (a long form, a settings section): Save as the page's primary action with
- * a spinner while it works, "Unsaved changes" beside it, Cancel (while there are edits) in place of Back, and the leave guard.
+ * a spinner while it works (disabled while there is nothing to save), "Unsaved changes" beside it, Cancel (while there are edits, if you
+ * give one) in place of Back, and the leave guard.
  * Inside an `EditorPage` this is done for you; use it for a page of your own. Call it from a component rendered inside the
  * page shell (or where the app's page chrome is installed).
  *
  *   useSaveChrome({ form, label: () => t("save"), allowed: () => can("tickets:update"), save: submit, cancel: () => form.reset() });
+ *   useSaveChrome({ form, allowed: () => can("dealer:update"), save: submit });                // a section edited in place: no Cancel
+ *   useSaveChrome({ form, disabledWhileClean: false, save: submit });                          // a create page: Save is always there
  */
 export declare function useSaveChrome(options: SaveChromeOptions): void;

package/dist/i18n/describeError.d.ts

@@ -19,6 +19,14 @@ interface Translator {
  */
 export type AppErrorDescriber = (error: unknown) => string | undefined;
 export declare const appErrorDescriberKey: InjectionKey<AppErrorDescriber>;
+/**
+ * The application's one sentence for a field message the server sent (`createApplication({ describeFieldError })`): often a
+ * code or a translation key. Asked by every form that has no `describeFieldError` of its own; `(message, field) => sentence`.
+ */
+export type AppFieldErrorDescriber = (message: string, field: string) => string;
+export declare const appFieldErrorDescriberKey: InjectionKey<AppFieldErrorDescriber>;
+/** The application's field-message describer, when one was installed and this runs in a setup. */
+export declare function useAppFieldErrorDescriber(): AppFieldErrorDescriber | null;
 /** The application's describer, when one was installed and this runs in a setup. */
 export declare function useAppErrorDescriber(): AppErrorDescriber | null;
 /** `describeError` over a translator; exported for the composable and tests. */

package/dist/i18n/index.d.ts

@@ -379,11 +379,12 @@ export declare const coreMessages: {
     readonly hr: CoreMessages;
     readonly bs: CoreMessages;
     readonly sl: CoreMessages;
+    readonly "sr-Latn": CoreMessages;
 };
 export type CoreLocale = keyof typeof coreMessages;
 export { localeMessages } from "./messages";
 export type { LocaleMessagesOptions, MessageLoader, MessageNamespace, Messages } from "./messages";
 export { createMessageRuntime } from "./runtime";
 export type { MessageFailure, MessageRuntime, MessageRuntimeOptions, MessageTarget } from "./runtime";
-export { appErrorDescriberKey, useDescribeError } from "./describeError";
-export type { AppErrorDescriber, DescribeError, DescribeErrorOptions } from "./describeError";
+export { appErrorDescriberKey, appFieldErrorDescriberKey, useDescribeError } from "./describeError";
+export type { AppErrorDescriber, AppFieldErrorDescriber, DescribeError, DescribeErrorOptions } from "./describeError";