@optiaxiom/proteus 0.0.0 → 0.1.0

package/dist/esm/spec.js

@@ -0,0 +1 @@
+export { default as schema } from './schema/public-schema.json.js';

package/dist/index.d.ts

@@ -0,0 +1,293 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { BoxProps, SelectProps, Disclosure, ButtonProps, InputProps, TextareaProps } from '@optiaxiom/react';
+import { ReactNode, ComponentPropsWithoutRef } from 'react';
+
+type ProteusCancelActionProps = {
+    children?: ReactNode;
+    /**
+     * Placeholder text for the text input field
+     */
+    placeholder?: string;
+};
+declare function ProteusCancelAction({ children, placeholder, }: ProteusCancelActionProps): react_jsx_runtime.JSX.Element;
+declare namespace ProteusCancelAction {
+    var displayName: string;
+}
+
+type Series = {
+    dataKey: string;
+    name?: string;
+};
+type ProteusChartProps = {
+    /**
+     * Chart data records, either inline, a ProteusValue reference, or a
+     * ProteusZip transformation
+     */
+    data: Record<string, unknown>[];
+    /**
+     * Data series configuration
+     */
+    series: Series[];
+    /**
+     * Chart type
+     */
+    type: "bar" | "line";
+    /**
+     * Key in data records for x-axis labels
+     */
+    xAxisKey?: string;
+};
+declare const ProteusChart: {
+    ({ data, series, type, xAxisKey, }: ProteusChartProps): react_jsx_runtime.JSX.Element;
+    displayName: string;
+};
+
+type ProteusDataTableProps = {
+    /**
+     * Column definitions
+     */
+    columns: ColumnDef[];
+    /**
+     * Column data
+     */
+    data?: Record<string, unknown>[];
+};
+type ColumnDef = {
+    accessorKey: string;
+    format?: string | {
+        options?: Record<string, unknown>;
+        type: string;
+    };
+    header: string;
+    size?: number;
+};
+declare const ProteusDataTable: {
+    ({ columns, data }: ProteusDataTableProps): react_jsx_runtime.JSX.Element;
+    displayName: string;
+};
+
+type ProteusImageProps = BoxProps<"img">;
+declare function ProteusImage(props: ProteusImageProps): react_jsx_runtime.JSX.Element;
+declare namespace ProteusImage {
+    var displayName: string;
+}
+
+type ProteusMapProps = {
+    children?: ReactNode;
+    /**
+     * JSON pointer path to the source array in the data (e.g., '/results')
+     */
+    path: string;
+    /**
+     * Optional separator to render between items. Can be a string or a
+     * ReactNode for more complex separators.
+     */
+    separator?: ReactNode;
+};
+declare function ProteusMap({ children, path, separator }: ProteusMapProps): react_jsx_runtime.JSX.Element | null;
+declare namespace ProteusMap {
+    var displayName: string;
+}
+
+type ProteusSelectProps = Omit<SelectProps, "options"> & {
+    /**
+     * The select items/options we want to render.
+     */
+    options?: Array<{
+        /**
+         * String representation of items
+         */
+        label: string;
+        /**
+         * Return a unique key for each item
+         */
+        value: string;
+    }>;
+};
+declare function ProteusSelect({ children, options, ...props }: ProteusSelectProps): react_jsx_runtime.JSX.Element;
+declare namespace ProteusSelect {
+    var displayName: string;
+}
+
+type ProteusShowProps = {
+    children?: ReactNode;
+    /**
+     * Single condition or array of conditions (AND logic). Each condition is an
+     * object with one operator key.
+     */
+    when: ProteusCondition;
+};
+type ComparisonValue = boolean | null | number | string | {
+    $type: "Value";
+    path: string;
+};
+type ProteusCondition = {
+    "!!": ComparisonValue;
+} | {
+    "!=": ComparisonValue[];
+} | {
+    "<": ComparisonValue[];
+} | {
+    "<=": ComparisonValue[];
+} | {
+    "==": ComparisonValue[];
+} | {
+    ">": ComparisonValue[];
+} | {
+    ">=": ComparisonValue[];
+} | {
+    and: ProteusCondition[];
+} | {
+    or: ProteusCondition[];
+};
+declare function ProteusShow({ children, when }: ProteusShowProps): react_jsx_runtime.JSX.Element | null;
+declare namespace ProteusShow {
+    var displayName: string;
+}
+
+type ProteusValueProps = {
+    /**
+     * Format to apply to cell values (e.g. 'Number', 'DateTime')
+     */
+    formatter?: "DateTime" | "Number" | {
+        /**
+         * Options passed to the Intl formatter constructor (e.g.,
+         * Intl.DateTimeFormatOptions or Intl.NumberFormatOptions)
+         */
+        options?: Record<string, unknown>;
+        /**
+         * Formatter type
+         */
+        type: "DateTime" | "Number";
+    };
+    /**
+     * Path to a value in the data. Absolute paths start with '/' and resolve from
+     * the root (e.g., '/title', '/options/0/label'). Inside a Map template, paths
+     * without a leading '/' are relative to the current item (e.g., 'title'
+     * resolves to each item's 'title' field).
+     */
+    path: string;
+};
+declare function ProteusValue(props: ProteusValueProps): any;
+declare namespace ProteusValue {
+    var displayName: string;
+}
+
+type ProteusDocumentShellProps = Pick<ComponentPropsWithoutRef<typeof Disclosure>, "defaultOpen" | "onOpenChange" | "open"> & {
+    /**
+     * Whether block is collapsible
+     */
+    collapsible?: boolean;
+    /**
+     * Current form data
+     */
+    data?: Record<string, unknown>;
+    /**
+     * The Proteus document to render
+     */
+    element: ProteusDocument$2;
+    /**
+     * Callback when form fields change
+     */
+    onDataChange?: (data: Record<string, unknown>) => void;
+    /**
+     * Callback when user sends a message action
+     */
+    onMessage?: (message: string) => Promise<void> | void;
+    /**
+     * Callback when user clicks a Action button with tool handler
+     */
+    onToolCall?: (toolName: string) => Promise<void> | void;
+    /**
+     * Whether form is readonly
+     */
+    readOnly?: boolean;
+    /**
+     * If true, the renderer will throw an error if the provided document is invalid. Otherwise, it will fail silently and render nothing.
+     */
+    strict?: boolean;
+};
+type ProteusDocument$2 = {
+    actions?: ReactNode;
+    appIcon?: string;
+    appName?: string;
+    blocking?: boolean;
+    body: ReactNode;
+    subtitle?: ReactNode;
+    title: ReactNode;
+};
+declare function ProteusDocumentShell({ collapsible: collapsibleProp, data, defaultOpen, element, onDataChange, onMessage, onOpenChange, onToolCall, open: openProp, readOnly, strict, }: ProteusDocumentShellProps): react_jsx_runtime.JSX.Element;
+declare namespace ProteusDocumentShell {
+    var displayName: string;
+}
+
+type ProteusEventHandler = {
+    action: "download";
+    url: (ProteusValueProps & {
+        $type: "Value";
+    }) | string;
+} | {
+    message: string;
+} | {
+    tool: string;
+};
+type ProteusDocument$1 = ProteusDocumentShellProps["element"] & {
+    $type: "Document";
+};
+type SafeParseResult<T> = {
+    data: T;
+    success: true;
+} | {
+    error: string[];
+    success: false;
+};
+declare function safeParseDocument({ actions, body, ...data }: Record<string, unknown>): SafeParseResult<ProteusDocument$1>;
+
+type ProteusActionProps = Omit<ButtonProps, "onClick"> & {
+    /**
+     * Action triggered when button is clicked
+     */
+    onClick?: ProteusEventHandler;
+};
+declare function ProteusAction({ children, onClick, ...props }: ProteusActionProps): react_jsx_runtime.JSX.Element;
+declare namespace ProteusAction {
+    var displayName: string;
+}
+
+type ProteusDocumentRendererProps = Omit<ComponentPropsWithoutRef<typeof ProteusDocumentShell>, "element"> & {
+    /**
+     * The Proteus document to render
+     */
+    element: ProteusDocument;
+    /**
+     * If true, the renderer will throw an error if the provided document is invalid. Otherwise, it will fail silently and render nothing.
+     */
+    strict?: boolean;
+};
+type ProteusDocument = {
+    $type: "Document";
+    actions?: unknown;
+    appIcon?: string;
+    appName?: string;
+    blocking?: boolean;
+    body: unknown;
+    subtitle?: unknown;
+    title: unknown;
+};
+declare function ProteusDocumentRenderer({ element: elementProp, strict, ...props }: ProteusDocumentRendererProps): react_jsx_runtime.JSX.Element | null;
+declare namespace ProteusDocumentRenderer {
+    var displayName: string;
+}
+
+declare function ProteusInput(props: InputProps): react_jsx_runtime.JSX.Element;
+declare namespace ProteusInput {
+    var displayName: string;
+}
+
+declare function ProteusTextarea(props: TextareaProps): react_jsx_runtime.JSX.Element;
+declare namespace ProteusTextarea {
+    var displayName: string;
+}
+
+export { ProteusAction, ProteusCancelAction, ProteusChart, ProteusDataTable, ProteusDocumentRenderer, ProteusDocumentShell, ProteusImage, ProteusInput, ProteusMap, ProteusSelect, ProteusShow, ProteusTextarea, ProteusValue, safeParseDocument };
+export type { ProteusDocumentRendererProps, ProteusDocumentShellProps };