@optiaxiom/proteus 0.2.5 → 0.2.7

package/dist/index.d.ts

@@ -38,7 +38,7 @@ type ProteusChartProps = {
     /**
      * Data series configuration
      */
-    series: Series[];
+    series?: Series[];
     /**
      * Chart type
      */
@@ -57,7 +57,7 @@ type ProteusDataTableProps = {
     /**
      * Column definitions
      */
-    columns: ColumnDef[];
+    columns?: ColumnDef[];
     /**
      * Column data
      */
@@ -77,6 +77,28 @@ declare const ProteusDataTable: {
     displayName: string;
 };
 
+type ProteusFileUploadProps = {
+    /**
+     * File types to accept; array of MIME types or extensions.
+     *
+     * @example ["image/*", ".pdf"]
+     */
+    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.
+     */
+    name?: string;
+    /**
+     * Whether a file is required.
+     */
+    required?: boolean;
+};
+declare function ProteusFileUpload({ accept, name, required, }: ProteusFileUploadProps): react_jsx_runtime.JSX.Element;
+declare namespace ProteusFileUpload {
+    var displayName: string;
+}
+
 type ProteusImageCarouselProps = {
     /**
      * Array of image data to display in the carousel.
@@ -213,6 +235,7 @@ type ProteusValueProps = {
     path: string;
 };
 
+type UploadFile = (file: File) => Promise<string>;
 type UseResource = (resource: string) => {
     data: undefined | {
         mimeType: string;
@@ -249,13 +272,20 @@ type ProteusDocumentShellProps = Pick<ComponentPropsWithoutRef<typeof Disclosure
      */
     onInteraction?: (name: string, params?: Record<string, unknown>) => Promise<unknown> | unknown;
     /**
-     * Callback when user sends a message action
+     * Callback when user sends a message action. The payload may be a plain
+     * string or a structured object (parts + optional files), depending on
+     * what the document declares for `Action.onClick.message`.
      */
-    onMessage?: (message: string) => Promise<void> | void;
+    onMessage?: (message: string | StructuredMessage) => Promise<void> | void;
     /**
      * Callback when an analytics event is fired
      */
     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.
+     */
+    onUpload?: UploadFile;
     /**
      * Whether form is readonly
      */
@@ -280,7 +310,7 @@ type ProteusDocument$2 = {
     title?: ReactNode;
     titleIcon?: string;
 };
-declare function ProteusDocumentShell({ collapsible: collapsibleProp, data, defaultOpen, element, onDataChange, onDownload, onInteraction, onMessage, onOpenChange, onTrack, open: openProp, readOnly, strict, useResource, }: ProteusDocumentShellProps): react_jsx_runtime.JSX.Element;
+declare function ProteusDocumentShell({ collapsible: collapsibleProp, data, defaultOpen, element, onDataChange, onDownload, onInteraction, onMessage, onOpenChange, onTrack, onUpload, open: openProp, readOnly, strict, useResource, }: ProteusDocumentShellProps): react_jsx_runtime.JSX.Element;
 declare namespace ProteusDocumentShell {
     var displayName: string;
 }
@@ -294,7 +324,14 @@ type ProteusEventHandler = {
     interaction: string;
     params?: Record<string, unknown>;
 } | {
-    message: string;
+    message: string | StructuredMessage;
+};
+type StructuredMessage = {
+    files?: string[];
+    parts: Array<{
+        content: string;
+        type: "text";
+    }>;
 };
 type ProteusDocument$1 = ProteusDocumentShellProps["element"] & {
     $type: "Document";
@@ -358,5 +395,5 @@ declare namespace ProteusTextarea {
 
 declare function useProteusValue(element: ProteusValueProps): any;
 
-export { ProteusAction, ProteusBridge, ProteusChart, ProteusDataTable, ProteusDocumentRenderer, ProteusDocumentShell, ProteusImage, ProteusImageCarousel, ProteusInput, ProteusMap, ProteusSelect, ProteusShow, ProteusTextarea, safeParseDocument, useProteusValue };
-export type { ProteusDocumentRendererProps, ProteusDocumentShellProps };
+export { ProteusAction, ProteusBridge, ProteusChart, ProteusDataTable, ProteusDocumentRenderer, ProteusDocumentShell, ProteusFileUpload, ProteusImage, ProteusImageCarousel, ProteusInput, ProteusMap, ProteusSelect, ProteusShow, ProteusTextarea, safeParseDocument, useProteusValue };
+export type { ProteusDocumentRendererProps, ProteusDocumentShellProps, ProteusFileUploadProps, StructuredMessage, UploadFile };