@zhama/a2ui 0.10.1 → 0.10.3

package/dist/types-CtrG7MJe.d.cts

@@ -0,0 +1,475 @@
+/**
+ * A2UI Primitive Types
+ * 基础值类型，支持字面值和数据绑定路径
+ */
+interface StringValue {
+    path?: string;
+    literalString?: string;
+    literal?: string;
+}
+interface NumberValue {
+    path?: string;
+    literalNumber?: number;
+    literal?: number;
+}
+interface BooleanValue {
+    path?: string;
+    literalBoolean?: boolean;
+    literal?: boolean;
+}
+
+/**
+ * A2UI Component Types
+ * 组件类型定义
+ */
+
+interface Action {
+    name: string;
+    context?: Array<{
+        key: string;
+        value: {
+            path?: string;
+            literalString?: string;
+            literalNumber?: number;
+            literalBoolean?: boolean;
+        };
+    }>;
+}
+interface Text {
+    text: StringValue;
+    usageHint: 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'caption' | 'body';
+}
+interface Image {
+    url: StringValue;
+    usageHint: 'icon' | 'avatar' | 'smallFeature' | 'mediumFeature' | 'largeFeature' | 'header';
+    fit?: 'contain' | 'cover' | 'fill' | 'none' | 'scale-down';
+}
+interface Icon {
+    name: StringValue;
+    size?: number | string;
+    container?: boolean;
+    variant?: string;
+}
+interface Video {
+    url: StringValue;
+}
+interface AudioPlayer {
+    url: StringValue;
+    description?: StringValue;
+}
+interface Tabs {
+    tabItems: Array<{
+        title: {
+            path?: string;
+            literalString?: string;
+        };
+        child: string;
+    }>;
+}
+interface Divider {
+    axis?: 'horizontal' | 'vertical';
+    color?: string;
+    thickness?: number;
+}
+interface Modal {
+    entryPointChild: string;
+    contentChild: string;
+}
+interface Button {
+    child: string;
+    action: Action;
+}
+interface Checkbox {
+    label: StringValue;
+    value: {
+        path?: string;
+        literalBoolean?: boolean;
+    };
+}
+interface TextField {
+    text?: StringValue;
+    label: StringValue;
+    type?: 'shortText' | 'number' | 'date' | 'longText';
+    validationRegexp?: string;
+}
+interface DateTimeInput {
+    value: StringValue;
+    enableDate?: boolean;
+    enableTime?: boolean;
+    outputFormat?: string;
+}
+interface MultipleChoice {
+    selections: {
+        path?: string;
+        literalArray?: string[];
+    };
+    options?: Array<{
+        label: {
+            path?: string;
+            literalString?: string;
+        };
+        value: string;
+    }>;
+    maxAllowedSelections?: number;
+}
+interface Slider {
+    value: {
+        path?: string;
+        literalNumber?: number;
+    };
+    minValue?: number;
+    maxValue?: number;
+}
+
+/**
+ * A2UI Core Types
+ * 核心协议类型定义
+ */
+
+interface MessageProcessor {
+    getSurfaces(): ReadonlyMap<string, Surface>;
+    clearSurfaces(): void;
+    processMessages(messages: ServerToClientMessage[]): void;
+    getData(node: AnyComponentNode, relativePath: string, surfaceId: string): DataValue | null;
+    setData(node: AnyComponentNode | null, relativePath: string, value: DataValue, surfaceId: string): void;
+    resolvePath(path: string, dataContextPath?: string): string;
+}
+interface Theme {
+    components: {
+        AudioPlayer: Record<string, boolean>;
+        Button: Record<string, boolean>;
+        Card: Record<string, boolean>;
+        Column: Record<string, boolean>;
+        CheckBox: {
+            container: Record<string, boolean>;
+            element: Record<string, boolean>;
+            label: Record<string, boolean>;
+        };
+        DateTimeInput: {
+            container: Record<string, boolean>;
+            element: Record<string, boolean>;
+            label: Record<string, boolean>;
+        };
+        Divider: Record<string, boolean>;
+        Image: {
+            all: Record<string, boolean>;
+            icon: Record<string, boolean>;
+            avatar: Record<string, boolean>;
+            smallFeature: Record<string, boolean>;
+            mediumFeature: Record<string, boolean>;
+            largeFeature: Record<string, boolean>;
+            header: Record<string, boolean>;
+        };
+        Icon: Record<string, boolean>;
+        List: Record<string, boolean>;
+        Modal: {
+            backdrop: Record<string, boolean>;
+            element: Record<string, boolean>;
+        };
+        MultipleChoice: {
+            container: Record<string, boolean>;
+            element: Record<string, boolean>;
+            label: Record<string, boolean>;
+        };
+        Row: Record<string, boolean>;
+        Slider: {
+            container: Record<string, boolean>;
+            element: Record<string, boolean>;
+            label: Record<string, boolean>;
+        };
+        Tabs: {
+            container: Record<string, boolean>;
+            element: Record<string, boolean>;
+            controls: {
+                all: Record<string, boolean>;
+                selected: Record<string, boolean>;
+            };
+        };
+        Text: {
+            all: Record<string, boolean>;
+            h1: Record<string, boolean>;
+            h2: Record<string, boolean>;
+            h3: Record<string, boolean>;
+            h4: Record<string, boolean>;
+            h5: Record<string, boolean>;
+            h6: Record<string, boolean>;
+            caption: Record<string, boolean>;
+            body: Record<string, boolean>;
+            label: Record<string, boolean>;
+        };
+        TextField: {
+            container: Record<string, boolean>;
+            element: Record<string, boolean>;
+            label: Record<string, boolean>;
+        };
+        Video: Record<string, boolean>;
+    };
+    elements: {
+        a: Record<string, boolean>;
+        audio: Record<string, boolean>;
+        body: Record<string, boolean>;
+        button: Record<string, boolean>;
+        h1: Record<string, boolean>;
+        h2: Record<string, boolean>;
+        h3: Record<string, boolean>;
+        h4: Record<string, boolean>;
+        h5: Record<string, boolean>;
+        iframe: Record<string, boolean>;
+        input: Record<string, boolean>;
+        p: Record<string, boolean>;
+        pre: Record<string, boolean>;
+        textarea: Record<string, boolean>;
+        video: Record<string, boolean>;
+    };
+    markdown: {
+        p: string[];
+        h1: string[];
+        h2: string[];
+        h3: string[];
+        h4: string[];
+        h5: string[];
+        ul: string[];
+        ol: string[];
+        li: string[];
+        a: string[];
+        strong: string[];
+        em: string[];
+        code: string[];
+        blockquote: string[];
+    };
+    additionalStyles?: {
+        AudioPlayer?: Record<string, string>;
+        Button?: Record<string, string>;
+        Card?: Record<string, string>;
+        Column?: Record<string, string>;
+        CheckBox?: Record<string, string>;
+        DateTimeInput?: Record<string, string>;
+        Divider?: Record<string, string>;
+        Heading?: Record<string, string>;
+        Icon?: Record<string, string>;
+        Image?: Record<string, string>;
+        List?: Record<string, string>;
+        Modal?: Record<string, string>;
+        MultipleChoice?: Record<string, string>;
+        Row?: Record<string, string>;
+        Slider?: Record<string, string>;
+        Tabs?: Record<string, string>;
+        Text?: Record<string, string> | {
+            h1: Record<string, string>;
+            h2: Record<string, string>;
+            h3: Record<string, string>;
+            h4: Record<string, string>;
+            h5: Record<string, string>;
+            body: Record<string, string>;
+            caption: Record<string, string>;
+        };
+        TextField?: Record<string, string>;
+        Video?: Record<string, string>;
+    };
+}
+interface UserAction {
+    actionName: string;
+    sourceComponentId: string;
+    timestamp: string;
+    context?: Record<string, unknown>;
+}
+interface DataObject {
+    [key: string]: DataValue;
+}
+type DataMap = Map<string, DataValue>;
+type DataArray = DataValue[];
+type DataValue = string | number | boolean | null | DataMap | DataObject | DataArray;
+interface ComponentArrayTemplate {
+    componentId: string;
+    dataBinding: string;
+}
+interface ComponentArrayReference {
+    explicitList?: string[];
+    template?: ComponentArrayTemplate;
+}
+type ComponentProperties = {
+    children?: ComponentArrayReference;
+    child?: string;
+    [k: string]: unknown;
+};
+interface ComponentInstance {
+    id: string;
+    weight?: number;
+    component?: Record<string, ComponentProperties>;
+}
+interface BeginRenderingMessage {
+    surfaceId: string;
+    root: string;
+    styles?: Record<string, string>;
+}
+interface SurfaceUpdateMessage {
+    surfaceId: string;
+    components: ComponentInstance[];
+}
+interface DataModelUpdate {
+    surfaceId: string;
+    path?: string;
+    contents: ValueMap[];
+}
+type ValueMap = DataObject & {
+    key: string;
+    valueString?: string;
+    valueNumber?: number;
+    valueBoolean?: boolean;
+    valueMap?: ValueMap[];
+};
+interface DeleteSurfaceMessage {
+    surfaceId: string;
+}
+interface ServerToClientMessage {
+    beginRendering?: BeginRenderingMessage;
+    surfaceUpdate?: SurfaceUpdateMessage;
+    dataModelUpdate?: DataModelUpdate;
+    deleteSurface?: DeleteSurfaceMessage;
+}
+interface ResolvedMap {
+    [key: string]: ResolvedValue;
+}
+type ResolvedArray = ResolvedValue[];
+type ResolvedValue = string | number | boolean | null | AnyComponentNode | ResolvedMap | ResolvedArray;
+interface BaseComponentNode {
+    id: string;
+    weight?: number | string;
+    dataContextPath?: string;
+    slotName?: string;
+}
+interface TextNode extends BaseComponentNode {
+    type: 'Text';
+    properties: ResolvedText;
+}
+interface ImageNode extends BaseComponentNode {
+    type: 'Image';
+    properties: ResolvedImage;
+}
+interface IconNode extends BaseComponentNode {
+    type: 'Icon';
+    properties: ResolvedIcon;
+}
+interface VideoNode extends BaseComponentNode {
+    type: 'Video';
+    properties: ResolvedVideo;
+}
+interface AudioPlayerNode extends BaseComponentNode {
+    type: 'AudioPlayer';
+    properties: ResolvedAudioPlayer;
+}
+interface RowNode extends BaseComponentNode {
+    type: 'Row';
+    properties: ResolvedRow;
+}
+interface ColumnNode extends BaseComponentNode {
+    type: 'Column';
+    properties: ResolvedColumn;
+}
+interface ListNode extends BaseComponentNode {
+    type: 'List';
+    properties: ResolvedList;
+}
+interface CardNode extends BaseComponentNode {
+    type: 'Card';
+    properties: ResolvedCard;
+}
+interface TabsNode extends BaseComponentNode {
+    type: 'Tabs';
+    properties: ResolvedTabs;
+}
+interface DividerNode extends BaseComponentNode {
+    type: 'Divider';
+    properties: ResolvedDivider;
+}
+interface ModalNode extends BaseComponentNode {
+    type: 'Modal';
+    properties: ResolvedModal;
+}
+interface ButtonNode extends BaseComponentNode {
+    type: 'Button';
+    properties: ResolvedButton;
+}
+interface CheckboxNode extends BaseComponentNode {
+    type: 'CheckBox';
+    properties: ResolvedCheckbox;
+}
+interface TextFieldNode extends BaseComponentNode {
+    type: 'TextField';
+    properties: ResolvedTextField;
+}
+interface DateTimeInputNode extends BaseComponentNode {
+    type: 'DateTimeInput';
+    properties: ResolvedDateTimeInput;
+}
+interface MultipleChoiceNode extends BaseComponentNode {
+    type: 'MultipleChoice';
+    properties: ResolvedMultipleChoice;
+}
+interface SliderNode extends BaseComponentNode {
+    type: 'Slider';
+    properties: ResolvedSlider;
+}
+interface CustomNode extends BaseComponentNode {
+    type: string;
+    properties: CustomNodeProperties;
+}
+type AnyComponentNode = TextNode | IconNode | ImageNode | VideoNode | AudioPlayerNode | RowNode | ColumnNode | ListNode | CardNode | TabsNode | DividerNode | ModalNode | ButtonNode | CheckboxNode | TextFieldNode | DateTimeInputNode | MultipleChoiceNode | SliderNode | CustomNode;
+type ResolvedText = Text;
+type ResolvedIcon = Icon;
+type ResolvedImage = Image;
+type ResolvedVideo = Video;
+type ResolvedAudioPlayer = AudioPlayer;
+type ResolvedDivider = Divider;
+type ResolvedCheckbox = Checkbox;
+type ResolvedTextField = TextField;
+type ResolvedDateTimeInput = DateTimeInput;
+type ResolvedMultipleChoice = MultipleChoice;
+type ResolvedSlider = Slider;
+interface ResolvedRow {
+    children: AnyComponentNode[];
+    distribution?: 'start' | 'center' | 'end' | 'spaceBetween' | 'spaceAround' | 'spaceEvenly';
+    alignment?: 'start' | 'center' | 'end' | 'stretch';
+}
+interface ResolvedColumn {
+    children: AnyComponentNode[];
+    distribution?: 'start' | 'center' | 'end' | 'spaceBetween' | 'spaceAround' | 'spaceEvenly';
+    alignment?: 'start' | 'center' | 'end' | 'stretch';
+}
+interface ResolvedButton {
+    child: AnyComponentNode;
+    action: Action;
+}
+interface ResolvedList {
+    children: AnyComponentNode[];
+    direction?: 'vertical' | 'horizontal';
+    alignment?: 'start' | 'center' | 'end' | 'stretch';
+}
+interface ResolvedCard {
+    child?: AnyComponentNode;
+    children?: AnyComponentNode[];
+}
+interface ResolvedTabItem {
+    title: StringValue;
+    child: AnyComponentNode;
+}
+interface ResolvedTabs {
+    tabItems: ResolvedTabItem[];
+}
+interface ResolvedModal {
+    entryPointChild: AnyComponentNode;
+    contentChild: AnyComponentNode;
+}
+interface CustomNodeProperties {
+    [k: string]: ResolvedValue;
+}
+type SurfaceID = string;
+interface Surface {
+    rootComponentId: string | null;
+    componentTree: AnyComponentNode | null;
+    dataModel: DataMap;
+    components: Map<string, ComponentInstance>;
+    styles: Record<string, string>;
+}
+
+export type { TextFieldNode as $, Action as A, BooleanValue as B, Checkbox as C, Divider as D, AnyComponentNode as E, TextNode as F, ImageNode as G, IconNode as H, Image as I, VideoNode as J, AudioPlayerNode as K, RowNode as L, Modal as M, NumberValue as N, ColumnNode as O, ListNode as P, CardNode as Q, ResolvedValue as R, StringValue as S, Text as T, UserAction as U, Video as V, TabsNode as W, DividerNode as X, ModalNode as Y, ButtonNode as Z, CheckboxNode as _, Icon as a, DateTimeInputNode as a0, MultipleChoiceNode as a1, SliderNode as a2, CustomNode as a3, ResolvedText as a4, ResolvedIcon as a5, ResolvedImage as a6, ResolvedVideo as a7, ResolvedAudioPlayer as a8, ResolvedDivider as a9, ResolvedCheckbox as aa, ResolvedTextField as ab, ResolvedDateTimeInput as ac, ResolvedMultipleChoice as ad, ResolvedSlider as ae, ResolvedRow as af, ResolvedColumn as ag, ResolvedButton as ah, ResolvedList as ai, ResolvedCard as aj, ResolvedTabItem as ak, ResolvedTabs as al, ResolvedModal as am, CustomNodeProperties as an, SurfaceID as ao, Surface as ap, AudioPlayer as b, Tabs as c, Button as d, TextField as e, DateTimeInput as f, MultipleChoice as g, Slider as h, MessageProcessor as i, Theme as j, DataValue as k, DataObject as l, DataMap as m, DataArray as n, ComponentArrayTemplate as o, ComponentArrayReference as p, ComponentProperties as q, ComponentInstance as r, BeginRenderingMessage as s, SurfaceUpdateMessage as t, DataModelUpdate as u, ValueMap as v, DeleteSurfaceMessage as w, ServerToClientMessage as x, ResolvedMap as y, ResolvedArray as z };