@easyops-cn/a2ui-react 0.0.0 → 0.0.2

package/{src/0.8/types/index.ts → dist/0.8/types/index.d.ts}

@@ -4,445 +4,360 @@
  * Core type definitions for the A2UI React renderer.
  * Based on the A2UI specification documents.
  */
-
-// ============ Value Types ============
-
 /**
  * Represents a value source - either a literal value or a reference to a data model path.
  */
-export type ValueSource =
-  | { literalString: string }
-  | { literalNumber: number }
-  | { literalBoolean: boolean }
-  | { literalArray: string[] }
-  | { path: string }
-
-// ============ Data Model ============
-
+export type ValueSource = {
+    literalString: string;
+} | {
+    literalNumber: number;
+} | {
+    literalBoolean: boolean;
+} | {
+    literalArray: string[];
+} | {
+    path: string;
+};
 /**
  * Primitive values that can be stored in the data model.
  */
-export type DataModelValue =
-  | string
-  | number
-  | boolean
-  | null
-  | DataModel
-  | unknown[]
-
+export type DataModelValue = string | number | boolean | null | DataModel | unknown[];
 /**
  * The data model is a hierarchical key-value store.
  * Components reference data using paths like "/user/name".
  */
 export interface DataModel {
-  [key: string]: DataModelValue
+    [key: string]: DataModelValue;
 }
-
 /**
  * Data entry from server messages (dataModelUpdate).
  */
 export interface DataEntry {
-  key: string
-  valueString?: string
-  valueNumber?: number
-  valueBoolean?: boolean
-  valueMap?: DataEntry[]
+    key: string;
+    valueString?: string;
+    valueNumber?: number;
+    valueBoolean?: boolean;
+    valueMap?: DataEntry[];
 }
-
-// ============ Surface ============
-
 /**
  * Surface styles configuration.
  */
 export interface SurfaceStyles {
-  font?: string
-  primaryColor?: string
+    font?: string;
+    primaryColor?: string;
 }
-
 /**
  * A Surface is the top-level container for A2UI rendering.
  */
 export interface Surface {
-  surfaceId: string
-  root: string
-  components: Map<string, ComponentDefinition>
-  styles?: SurfaceStyles
+    surfaceId: string;
+    root: string;
+    components: Map<string, ComponentDefinition>;
+    styles?: SurfaceStyles;
 }
-
-// ============ Component Definition ============
-
 /**
  * Base component properties that all components share.
  */
 export interface ComponentDefinition {
-  id: string
-  weight?: number
-  component: {
-    [componentType: string]: ComponentProps
-  }
+    id: string;
+    weight?: number;
+    component: {
+        [componentType: string]: ComponentProps;
+    };
 }
-
 /**
  * Generic component properties type.
  */
-export type ComponentProps = Record<string, unknown>
-
-// ============ Children Definition ============
-
+export type ComponentProps = Record<string, unknown>;
 /**
  * Template binding for dynamic child generation.
  */
 export interface TemplateBinding {
-  componentId: string
-  dataBinding: string
+    componentId: string;
+    dataBinding: string;
 }
-
 /**
  * Children definition for container components.
  */
 export interface ChildrenDefinition {
-  explicitList?: string[]
-  template?: TemplateBinding
+    explicitList?: string[];
+    template?: TemplateBinding;
 }
-
-// ============ Action ============
-
 /**
  * A single item in the action context.
  */
 export interface ActionContextItem {
-  key: string
-  value: ValueSource
+    key: string;
+    value: ValueSource;
 }
-
 /**
  * Action definition (attached to Button components).
  */
 export interface Action {
-  name: string
-  context?: ActionContextItem[]
+    name: string;
+    context?: ActionContextItem[];
 }
-
 /**
  * Resolved action payload sent to the action handler.
  */
 export interface ActionPayload {
-  surfaceId: string
-  name: string
-  context: Record<string, unknown>
-  sourceComponentId: string
+    surfaceId: string;
+    name: string;
+    context: Record<string, unknown>;
+    sourceComponentId: string;
 }
-
 /**
  * Action handler callback type.
  */
-export type ActionHandler = (action: ActionPayload) => void
-
-// ============ Message Types ============
-
+export type ActionHandler = (action: ActionPayload) => void;
 /**
  * BeginRendering message payload - initializes a new Surface.
  */
 export interface BeginRenderingPayload {
-  surfaceId: string
-  root: string
-  catalogId?: string
-  styles?: SurfaceStyles
+    surfaceId: string;
+    root: string;
+    catalogId?: string;
+    styles?: SurfaceStyles;
 }
-
 /**
  * SurfaceUpdate message payload - updates the component tree.
  */
 export interface SurfaceUpdatePayload {
-  surfaceId: string
-  components: ComponentDefinition[]
+    surfaceId: string;
+    components: ComponentDefinition[];
 }
-
 /**
  * DataModelUpdate message payload - updates the data model.
  */
 export interface DataModelUpdatePayload {
-  surfaceId: string
-  path?: string
-  contents: DataEntry[]
+    surfaceId: string;
+    path?: string;
+    contents: DataEntry[];
 }
-
 /**
  * DeleteSurface message payload - removes a Surface.
  */
 export interface DeleteSurfacePayload {
-  surfaceId: string
+    surfaceId: string;
 }
-
 /**
  * A2UI message from server to client.
  * Only one of the fields should be set per message.
  */
 export interface A2UIMessage {
-  beginRendering?: BeginRenderingPayload
-  surfaceUpdate?: SurfaceUpdatePayload
-  dataModelUpdate?: DataModelUpdatePayload
-  deleteSurface?: DeleteSurfacePayload
+    beginRendering?: BeginRenderingPayload;
+    surfaceUpdate?: SurfaceUpdatePayload;
+    dataModelUpdate?: DataModelUpdatePayload;
+    deleteSurface?: DeleteSurfacePayload;
 }
-
-// ============ Base Component Props ============
-
 /**
  * Base props shared by all A2UI components.
  */
 export interface BaseComponentProps {
-  surfaceId: string
-  componentId: string
-  weight?: number
+    surfaceId: string;
+    componentId: string;
+    weight?: number;
 }
-
-// ============ Display Component Props ============
-
 /**
  * Text component properties.
  */
 export interface TextComponentProps extends BaseComponentProps {
-  text?: ValueSource
-  usageHint?: 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'caption' | 'body'
+    text?: ValueSource;
+    usageHint?: 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'caption' | 'body';
 }
-
 /**
  * Image component properties.
  */
 export interface ImageComponentProps extends BaseComponentProps {
-  url?: ValueSource
-  fit?: 'contain' | 'cover' | 'fill' | 'none' | 'scale-down'
-  usageHint?:
-    | 'icon'
-    | 'avatar'
-    | 'smallFeature'
-    | 'mediumFeature'
-    | 'largeFeature'
-    | 'header'
-}
-
+    url?: ValueSource;
+    fit?: 'contain' | 'cover' | 'fill' | 'none' | 'scale-down';
+    usageHint?: 'icon' | 'avatar' | 'smallFeature' | 'mediumFeature' | 'largeFeature' | 'header';
+}
 /**
  * Icon component properties.
  */
 export interface IconComponentProps extends BaseComponentProps {
-  name?: ValueSource
+    name?: ValueSource;
 }
-
 /**
  * Video component properties.
  */
 export interface VideoComponentProps extends BaseComponentProps {
-  url?: ValueSource
+    url?: ValueSource;
 }
-
 /**
  * AudioPlayer component properties.
  */
 export interface AudioPlayerComponentProps extends BaseComponentProps {
-  url?: ValueSource
-  description?: ValueSource
+    url?: ValueSource;
+    description?: ValueSource;
 }
-
 /**
  * Divider component properties.
  */
 export interface DividerComponentProps extends BaseComponentProps {
-  axis?: 'horizontal' | 'vertical'
+    axis?: 'horizontal' | 'vertical';
 }
-
-// ============ Layout Component Props ============
-
 /**
  * Distribution values for flex layouts.
  */
-export type Distribution =
-  | 'start'
-  | 'center'
-  | 'end'
-  | 'spaceBetween'
-  | 'spaceAround'
-  | 'spaceEvenly'
-
+export type Distribution = 'start' | 'center' | 'end' | 'spaceBetween' | 'spaceAround' | 'spaceEvenly';
 /**
  * Alignment values for flex layouts.
  */
-export type Alignment = 'start' | 'center' | 'end' | 'stretch'
-
+export type Alignment = 'start' | 'center' | 'end' | 'stretch';
 /**
  * Row component properties.
  */
 export interface RowComponentProps extends BaseComponentProps {
-  children?: ChildrenDefinition
-  distribution?: Distribution
-  alignment?: Alignment
+    children?: ChildrenDefinition;
+    distribution?: Distribution;
+    alignment?: Alignment;
 }
-
 /**
  * Column component properties.
  */
 export interface ColumnComponentProps extends BaseComponentProps {
-  children?: ChildrenDefinition
-  distribution?: Distribution
-  alignment?: Alignment
+    children?: ChildrenDefinition;
+    distribution?: Distribution;
+    alignment?: Alignment;
 }
-
 /**
  * List component properties.
  */
 export interface ListComponentProps extends BaseComponentProps {
-  children?: ChildrenDefinition
-  direction?: 'vertical' | 'horizontal'
-  alignment?: Alignment
+    children?: ChildrenDefinition;
+    direction?: 'vertical' | 'horizontal';
+    alignment?: Alignment;
 }
-
 /**
  * Card component properties.
  */
 export interface CardComponentProps extends BaseComponentProps {
-  child?: string
+    child?: string;
 }
-
 /**
  * Tab item definition.
  */
 export interface TabItem {
-  title?: ValueSource
-  child: string
+    title?: ValueSource;
+    child: string;
 }
-
 /**
  * Tabs component properties.
  */
 export interface TabsComponentProps extends BaseComponentProps {
-  tabItems?: TabItem[]
+    tabItems?: TabItem[];
 }
-
 /**
  * Modal component properties.
  */
 export interface ModalComponentProps extends BaseComponentProps {
-  entryPointChild?: string
-  contentChild?: string
+    entryPointChild?: string;
+    contentChild?: string;
 }
-
-// ============ Interactive Component Props ============
-
 /**
  * Button component properties.
  */
 export interface ButtonComponentProps extends BaseComponentProps {
-  child?: string
-  primary?: boolean
-  action?: Action
+    child?: string;
+    primary?: boolean;
+    action?: Action;
 }
-
 /**
  * CheckBox component properties.
  */
 export interface CheckBoxComponentProps extends BaseComponentProps {
-  label?: ValueSource
-  value?: ValueSource
+    label?: ValueSource;
+    value?: ValueSource;
 }
-
 /**
  * TextField component properties.
  */
 export interface TextFieldComponentProps extends BaseComponentProps {
-  label?: ValueSource
-  text?: ValueSource
-  textFieldType?: 'date' | 'longText' | 'number' | 'shortText' | 'obscured'
-  validationRegexp?: string
+    label?: ValueSource;
+    text?: ValueSource;
+    textFieldType?: 'date' | 'longText' | 'number' | 'shortText' | 'obscured';
+    validationRegexp?: string;
 }
-
 /**
  * DateTimeInput component properties.
  */
 export interface DateTimeInputComponentProps extends BaseComponentProps {
-  value?: ValueSource
-  enableDate?: boolean
-  enableTime?: boolean
+    value?: ValueSource;
+    enableDate?: boolean;
+    enableTime?: boolean;
 }
-
 /**
  * MultipleChoice option definition.
  */
 export interface MultipleChoiceOption {
-  label?: ValueSource
-  value: string
+    label?: ValueSource;
+    value: string;
 }
-
 /**
  * MultipleChoice component properties.
  */
 export interface MultipleChoiceComponentProps extends BaseComponentProps {
-  selections?: ValueSource
-  options?: MultipleChoiceOption[]
-  maxAllowedSelections?: number
+    selections?: ValueSource;
+    options?: MultipleChoiceOption[];
+    maxAllowedSelections?: number;
 }
-
 /**
  * Slider component properties.
  */
 export interface SliderComponentProps extends BaseComponentProps {
-  value?: ValueSource
-  minValue?: number
-  maxValue?: number
+    value?: ValueSource;
+    minValue?: number;
+    maxValue?: number;
 }
-
-// ============ Renderer Props ============
-
 /**
  * Decision button for the fixed bottom area.
  */
 export interface DecisionButton {
-  name: string
-  label: string
-  action: string
-  variant?: 'primary' | 'secondary' | 'destructive'
-  icon?: string
+    name: string;
+    label: string;
+    action: string;
+    variant?: 'primary' | 'secondary' | 'destructive';
+    icon?: string;
 }
-
 /**
  * Confirmed info item for display.
  */
 export interface ConfirmedInfoItem {
-  label: string
-  value: string
-  highlight?: boolean
-  isFullWidth?: boolean
+    label: string;
+    value: string;
+    highlight?: boolean;
+    isFullWidth?: boolean;
 }
-
 /**
  * Confirmed info section configuration.
  */
 export interface ConfirmedInfo {
-  title?: string
-  items: ConfirmedInfoItem[]
+    title?: string;
+    items: ConfirmedInfoItem[];
 }
-
 /**
  * Form section warning configuration.
  */
 export interface FormSectionWarning {
-  title: string
-  message: string
+    title: string;
+    message: string;
 }
-
 /**
  * Completed action information.
  */
 export interface CompletedAction {
-  action: string
-  label: string
-  completedAt?: string
-  completedBy?: string
-  formData?: Record<string, unknown>
+    action: string;
+    label: string;
+    completedAt?: string;
+    completedBy?: string;
+    formData?: Record<string, unknown>;
 }
-
 /**
  * Progress information.
  */
 export interface Progress {
-  current: number
-  total: number
+    current: number;
+    total: number;
 }

package/dist/0.8/utils/dataBinding.d.ts

@@ -0,0 +1,95 @@
+import { ValueSource, DataModel, DataEntry, DataModelValue } from '../types';
+/**
+ * Resolves a ValueSource to its actual value.
+ *
+ * @param source - The value source (literal or path reference)
+ * @param dataModel - The data model for path lookups
+ * @param defaultValue - Default value if source is undefined or path not found
+ * @returns The resolved value
+ *
+ * @example
+ * // Literal values
+ * resolveValue({ literalString: "Hello" }, {}); // "Hello"
+ * resolveValue({ literalNumber: 42 }, {});      // 42
+ *
+ * // Path references
+ * const model = { user: { name: "John" } };
+ * resolveValue({ path: "/user/name" }, model);  // "John"
+ * resolveValue({ path: "/user/age" }, model, 0); // 0 (default)
+ */
+export declare function resolveValue<T = unknown>(source: ValueSource | undefined, dataModel: DataModel, defaultValue?: T): T;
+/**
+ * Checks if a value source is a path reference.
+ *
+ * @param source - The value source to check
+ * @returns True if the source is a path reference
+ */
+export declare function isPathReference(source: ValueSource | undefined): source is {
+    path: string;
+};
+/**
+ * Gets the path from a value source, or undefined if it's not a path reference.
+ *
+ * @param source - The value source
+ * @returns The path string or undefined
+ */
+export declare function getPath(source: ValueSource | undefined): string | undefined;
+/**
+ * Converts a DataEntry array to a plain object.
+ * This is used for processing dataModelUpdate message contents.
+ *
+ * @param contents - Array of data entries from the server
+ * @returns A plain object with the converted values
+ *
+ * @example
+ * contentsToObject([
+ *   { key: "name", valueString: "John" },
+ *   { key: "age", valueNumber: 30 },
+ *   { key: "active", valueBoolean: true },
+ *   { key: "profile", valueMap: [
+ *     { key: "email", valueString: "john@example.com" }
+ *   ]}
+ * ]);
+ * // Returns: { name: "John", age: 30, active: true, profile: { email: "john@example.com" } }
+ */
+export declare function contentsToObject(contents: DataEntry[]): Record<string, DataModelValue>;
+/**
+ * Creates a literal string value source.
+ *
+ * @param value - The string value
+ * @returns A ValueSource with literalString
+ */
+export declare function literalString(value: string): ValueSource;
+/**
+ * Creates a literal number value source.
+ *
+ * @param value - The number value
+ * @returns A ValueSource with literalNumber
+ */
+export declare function literalNumber(value: number): ValueSource;
+/**
+ * Creates a literal boolean value source.
+ *
+ * @param value - The boolean value
+ * @returns A ValueSource with literalBoolean
+ */
+export declare function literalBoolean(value: boolean): ValueSource;
+/**
+ * Creates a path reference value source.
+ *
+ * @param path - The data model path
+ * @returns A ValueSource with path
+ */
+export declare function pathRef(path: string): ValueSource;
+/**
+ * Resolves action context items to a plain object.
+ * This is used when dispatching actions to resolve all context values.
+ *
+ * @param context - Array of action context items
+ * @param dataModel - The data model for path lookups
+ * @returns A plain object with resolved context values
+ */
+export declare function resolveActionContext(context: Array<{
+    key: string;
+    value: ValueSource;
+}> | undefined, dataModel: DataModel): Record<string, unknown>;

package/dist/0.8/utils/dataBinding.test.d.ts

@@ -0,0 +1,6 @@
+/**
+ * dataBinding Tests
+ *
+ * Tests for data binding utility functions used in A2UI.
+ */
+export {};