@pipelex/mthds-form 0.12.0 → 0.13.0

package/dist/react/index.d.ts

@@ -441,9 +441,13 @@ interface StuffViewerProps {
     /** Which view opens first. Rendered, unless a host has a reason. */
     defaultView?: StuffViewerView;
     /**
-     * Names the saved files: `<baseName>.json`, and any file inside the stuff
-     * that carries no name of its own, whichever control saved it. Defaults to
-     * the field's name, which is what the header shows.
+     * Names the saved files, whichever control saved them: the base name names
+     * the whole stuff, so the JSON copy is `<baseName>.json`, a file inside the
+     * stuff that carries no name of its own is `<baseName>-<place>`, and a stuff
+     * that is one file saves as `<baseName>.<ext>`. Defaults to the field's name,
+     * which is what the header shows. Give each stuff a distinct base name, as
+     * the default already is: two panels handed the same one save their unnamed
+     * files under the same names.
      */
     downloadBaseName?: string;
     /**
@@ -707,15 +711,62 @@ interface FieldStrings {
     optionalFieldsCount: (count: number) => string;
     optionalInputsCount: (count: number) => string;
 }
+/** The English strings, which every control falls back to. Kept under this name for existing hosts. */
 declare const DEFAULT_FIELD_STRINGS: FieldStrings;
-/** Inject host-app strings over the English defaults for every control below. */
-declare function FieldStringsProvider({ strings, children, }: {
-    strings: Partial<FieldStrings>;
+/**
+ * Set the strings every control below speaks. `locale` picks a language pack by its code (`fr`,
+ * `fr-FR`, `en-GB`…; an unknown one falls back to English), and `strings` overrides single keys
+ * on top of it. Both are optional: with neither, the controls speak English.
+ */
+declare function FieldStringsProvider({ locale, strings, children, }: {
+    locale?: string;
+    strings?: Partial<FieldStrings>;
     children: ReactNode;
 }): react.JSX.Element;
 /** The strings the nearest provider supplies (English defaults when none does). */
 declare function useFieldStrings(): FieldStrings;
 
+/**
+ * The controls' strings in English: the package's defaults, and the pack every unknown or missing
+ * locale falls back to (see `fieldStringsFor` in `./index.ts`).
+ */
+
+declare const EN_FIELD_STRINGS: FieldStrings;
+
+/**
+ * The controls' strings in French: a complete `FieldStrings`, for a host that
+ * serves French and has no message catalogue of its own to bridge. Mounted as
+ * `<FieldStringsProvider strings={FR_FIELD_STRINGS}>`, or spread under a host's
+ * own overrides (`{ ...FR_FIELD_STRINGS, addItem: 'Ajouter une ligne' }`).
+ *
+ * The count-bearing messages apply French plural rules, where zero and one both
+ * take the singular (`0 élément`, `1 élément`, `2 éléments`), and a size is
+ * written the French way: `ko` and `Mo`, a decimal comma, a space before them.
+ * Both come from `Intl` (`PluralRules`, `NumberFormat`), not hand-written rules.
+ * A colon takes the no-break space French typography puts before it, so it
+ * never wraps onto a line of its own.
+ *
+ * Typed as `FieldStrings` rather than `Partial`, so a key added to the contract
+ * fails the build here until it is translated.
+ */
+
+declare const FR_FIELD_STRINGS: FieldStrings;
+
+/**
+ * The language packs, by locale code, and the switch that picks one. A new language is one file in
+ * this folder, typed as a whole `FieldStrings`, added to `FIELD_STRINGS_BY_LOCALE` below.
+ */
+
+/** Every language pack the package ships, keyed by its primary language subtag. */
+declare const FIELD_STRINGS_BY_LOCALE: Readonly<Record<string, FieldStrings>>;
+/** The locale codes a pack exists for. */
+declare const SUPPORTED_LOCALES: string[];
+/**
+ * The pack for a locale code, read as BCP 47: its primary language subtag decides, so `fr`,
+ * `fr-FR`, `fr_CA` and `FR` all give French. A missing or unknown locale gives English.
+ */
+declare function fieldStringsFor(locale?: string | null): FieldStrings;
+
 declare function FieldDomIdProvider({ prefix, children, }: {
     /**
      * Omit to mint one from `useId`; `''` writes the path unprefixed. An explicit
@@ -773,4 +824,4 @@ declare function useFieldPresentation(): FieldPresentation;
  */
 declare function humanizeFieldName(name: string): string;
 
-export { BooleanField, ConceptPill, DEFAULT_FIELD_STRINGS, DateField, DocumentField, type DownloadDisplay, EnumField, FieldDomIdProvider, FieldEnv, type FieldPresentation, FieldPresentationProvider, FieldShell, type FieldStrings, FieldStringsProvider, type FileValue, HtmlPreview, type HtmlPreviewProps, ImageField, JsonView, ListField, Markdown, type MarkdownProps, NumberField, ObjectField, OptionalToggle, ProseField, type ProseImages, type ResolveShareUrl, type ResolveUrl, ResultEnvProvider, ResultField, type ResultFieldProps, StuffViewer, type StuffViewerProps, type StuffViewerView, TextField, UnknownField, fieldControlClass, humanizeFieldName, saveInBrowser, useFieldDomId, useFieldPresentation, useFieldStrings, useProseImages, useResolveShareUrl, useResolveUrl, useResolvedUrl };
+export { BooleanField, ConceptPill, DEFAULT_FIELD_STRINGS, DateField, DocumentField, type DownloadDisplay, EN_FIELD_STRINGS, EnumField, FIELD_STRINGS_BY_LOCALE, FR_FIELD_STRINGS, FieldDomIdProvider, FieldEnv, type FieldPresentation, FieldPresentationProvider, FieldShell, type FieldStrings, FieldStringsProvider, type FileValue, HtmlPreview, type HtmlPreviewProps, ImageField, JsonView, ListField, Markdown, type MarkdownProps, NumberField, ObjectField, OptionalToggle, ProseField, type ProseImages, type ResolveShareUrl, type ResolveUrl, ResultEnvProvider, ResultField, type ResultFieldProps, SUPPORTED_LOCALES, StuffViewer, type StuffViewerProps, type StuffViewerView, TextField, UnknownField, fieldControlClass, fieldStringsFor, humanizeFieldName, saveInBrowser, useFieldDomId, useFieldPresentation, useFieldStrings, useProseImages, useResolveShareUrl, useResolveUrl, useResolvedUrl };

package/dist/react/index.js

@@ -1,11 +1,11 @@
 "use client";
-export { BooleanField, ConceptPill, DEFAULT_FIELD_STRINGS, DateField, DocumentField, EnumField, FieldDomIdProvider, FieldPresentationProvider, FieldRenderer, FieldShell, FieldStringsProvider, HtmlPreview, ImageField, JsonView, ListField, Markdown, NumberField, ObjectField, OptionalToggle, ProseField, ResultEnvProvider, ResultField, StuffViewer, TextField, UnknownField, fieldControlClass, humanizeFieldName, saveInBrowser, useFieldDomId, useFieldPresentation, useFieldStrings, useProseImages, useResolveShareUrl, useResolveUrl, useResolvedUrl } from '../chunk-4KX6YTLW.js';
-import '../chunk-V7T4DM63.js';
-import '../chunk-VS5JMFUV.js';
+export { BooleanField, ConceptPill, DEFAULT_FIELD_STRINGS, DateField, DocumentField, EN_FIELD_STRINGS, EnumField, FIELD_STRINGS_BY_LOCALE, FR_FIELD_STRINGS, FieldDomIdProvider, FieldPresentationProvider, FieldRenderer, FieldShell, FieldStringsProvider, HtmlPreview, ImageField, JsonView, ListField, Markdown, NumberField, ObjectField, OptionalToggle, ProseField, ResultEnvProvider, ResultField, SUPPORTED_LOCALES, StuffViewer, TextField, UnknownField, fieldControlClass, fieldStringsFor, humanizeFieldName, saveInBrowser, useFieldDomId, useFieldPresentation, useFieldStrings, useProseImages, useResolveShareUrl, useResolveUrl, useResolvedUrl } from '../chunk-D2EQVWGN.js';
+import '../chunk-7KQXGG6J.js';
+import '../chunk-RRTI7AIR.js';
 import '../chunk-CM4KVG53.js';
 import '../chunk-FABY3DEY.js';
 import '../chunk-XCO6GTEC.js';
-import '../chunk-PM55AHRO.js';
+import '../chunk-MJQ7CXUB.js';
 import '../chunk-GKV77RAS.js';
 import '../chunk-V3OV2XQT.js';
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipelex/mthds-form",
-  "version": "0.12.0",
+  "version": "0.13.0",
   "description": "Headless form kernel and control set for MTHDS method inputs",
   "license": "MIT",
   "repository": {