@optiaxiom/proteus 0.2.11 → 0.2.12

package/dist/index.d.ts

@@ -104,16 +104,22 @@ type ProteusFileUploadProps = {
      */
     accept?: string[];
     /**
-     * The name of the form control element. The resolved URL is written at
-     * `parentPath/name` in form data once the host's `onUpload` resolves.
+     * Maximum number of files allowed. When set to `1` the field is in
+     * single-file mode; any other value (or omitted) allows multiple uploads.
      */
-    name?: string;
+    maxFiles?: number;
+    /**
+     * Minimum number of files required.
+     */
+    minFiles?: number;
     /**
-     * Whether a file is required.
+     * The name of the form control element. The resolved metadata array is
+     * written at `parentPath/name` in form data once the host's `onUpload`
+     * resolves.
      */
-    required?: boolean;
+    name?: string;
 };
-declare function ProteusFileUpload({ accept, name, required, }: ProteusFileUploadProps): react_jsx_runtime.JSX.Element;
+declare function ProteusFileUpload({ accept, maxFiles, minFiles, name, }: ProteusFileUploadProps): react_jsx_runtime.JSX.Element;
 declare namespace ProteusFileUpload {
     var displayName: string;
 }
@@ -154,6 +160,11 @@ declare namespace ProteusImage {
 
 type ProteusMapProps = {
     children?: ReactNode;
+    /**
+     * When true, flattens the result array by one level. Only used during
+     * value resolution (e.g., onClick message); ignored during rendering.
+     */
+    flat?: boolean;
     /**
      * JSON pointer path to the source array in the data (e.g., '/results')
      */
@@ -254,7 +265,11 @@ type ProteusValueProps = {
     path: string;
 };
 
-type UploadFile = (file: File) => Promise<string>;
+type FileUploadMetadata = {
+    link: string;
+    name: string;
+};
+type UploadFile<F extends FileUploadMetadata = FileUploadMetadata> = (file: File) => Promise<F>;
 type UseResource = (resource: string) => {
     data: undefined | {
         mimeType: string;
@@ -302,7 +317,7 @@ type ProteusDocumentShellProps = Pick<ComponentPropsWithoutRef<typeof Disclosure
     onTrack?: (event: string, properties: Record<string, string>) => void;
     /**
      * Async upload callback used by FileUpload elements. Receives a File and
-     * resolves to a URL string the document writes into form data.
+     * resolves to a metadata object the document writes into form data.
      */
     onUpload?: UploadFile;
     /**
@@ -350,8 +365,8 @@ type ProteusEventHandler = {
 } | {
     message: string | StructuredMessage;
 };
-type StructuredMessage = {
-    files?: string[];
+type StructuredMessage<F extends FileUploadMetadata = FileUploadMetadata> = {
+    files?: F[];
     parts: Array<{
         content: string;
         type: "text";
@@ -420,4 +435,4 @@ declare namespace ProteusTextarea {
 declare function useProteusValue(element: ProteusValueProps): any;
 
 export { ProteusAction, ProteusBridge, ProteusChart, ProteusDataTable, ProteusDocumentRenderer, ProteusDocumentShell, ProteusFederated, ProteusFileUpload, ProteusImage, ProteusImageCarousel, ProteusInput, ProteusMap, ProteusSelect, ProteusShow, ProteusTextarea, safeParseDocument, useProteusValue };
-export type { ProteusDocumentRendererProps, ProteusDocumentShellProps, ProteusFileUploadProps, StructuredMessage, UploadFile };
+export type { FileUploadMetadata, ProteusDocumentRendererProps, ProteusDocumentShellProps, ProteusFileUploadProps, StructuredMessage, UploadFile };