@elizaos/shared 2.0.0-beta.1 → 2.0.3-beta.3

package/config/ui-spec.d.ts

@@ -0,0 +1,164 @@
+/**
+ * ui-spec.ts — TypeScript types for the json-render declarative UI spec.
+ *
+ * A UiSpec describes a tree of UI components that can be rendered
+ * from a JSON declaration. This is the full json-render component model.
+ *
+ * Structure:
+ *   { root: "main", elements: { [id]: UiElement }, state: { ... } }
+ *
+ * Each element has a type, props, optional children (IDs), event bindings,
+ * conditional visibility, validation, and repeat/list support.
+ */
+/** A value that can be either a literal or a path reference. */
+export type DynamicProp<T = string> = T | {
+    $path: string;
+};
+/** Conditional expression for dynamic prop resolution. */
+export interface CondExpr {
+    $cond: {
+        eq?: [unknown, unknown];
+        neq?: [unknown, unknown];
+        gt?: [unknown, unknown];
+        lt?: [unknown, unknown];
+        gte?: [unknown, unknown];
+        lte?: [unknown, unknown];
+        truthy?: unknown;
+        falsy?: unknown;
+        path?: string;
+    };
+    $then: unknown;
+    $else: unknown;
+}
+export type VisibilityOperator = "eq" | "ne" | "gt" | "gte" | "lt" | "lte";
+/** Path-based visibility condition. */
+export interface PathVisibility {
+    path: string;
+    operator: VisibilityOperator;
+    value: unknown;
+}
+/** Auth-based visibility condition. */
+export interface AuthVisibility {
+    auth: "signedIn" | "signedOut" | "admin" | string;
+}
+/** Logical combinators for complex visibility. */
+export interface AndVisibility {
+    and: UiSpecVisibilityCondition[];
+}
+export interface OrVisibility {
+    or: UiSpecVisibilityCondition[];
+}
+export interface NotVisibility {
+    not: UiSpecVisibilityCondition;
+}
+export type UiSpecVisibilityCondition = PathVisibility | AuthVisibility | AndVisibility | OrVisibility | NotVisibility;
+/** Built-in validator function names. */
+export type BuiltinValidator = "required" | "email" | "minLength" | "maxLength" | "pattern" | "min" | "max";
+/** A single validation check on a field. */
+export interface UiSpecValidationCheck {
+    fn: string;
+    args?: Record<string, unknown>;
+    message: string;
+}
+/** Validation configuration for a form element. */
+export interface UiSpecValidationConfig {
+    checks: UiSpecValidationCheck[];
+    validateOn?: "change" | "blur" | "submit";
+}
+/** Action success/error handlers. */
+export interface ActionOnSuccess {
+    action: string;
+    params?: Record<string, unknown>;
+}
+export interface ActionOnError {
+    action: string;
+    params?: Record<string, unknown>;
+}
+/** Confirmation prompt before action execution. */
+export interface ActionConfirm {
+    title: string;
+    message?: string;
+    confirmLabel?: string;
+    cancelLabel?: string;
+}
+export interface UiAction {
+    action: string;
+    params?: Record<string, unknown>;
+    confirm?: ActionConfirm;
+    onSuccess?: ActionOnSuccess;
+    onError?: ActionOnError;
+}
+export type UiEventBindings = Record<string, UiAction>;
+export interface RepeatConfig {
+    path: string;
+    key: string;
+}
+export type UiComponentType = "Stack" | "Grid" | "Card" | "Separator" | "Heading" | "Text" | "Input" | "Textarea" | "Select" | "Checkbox" | "Radio" | "Switch" | "Slider" | "Toggle" | "ToggleGroup" | "ButtonGroup" | "Table" | "Carousel" | "Badge" | "Avatar" | "Image" | "Alert" | "Progress" | "Rating" | "Skeleton" | "Spinner" | "Button" | "Link" | "DropdownMenu" | "Tabs" | "Pagination" | "Metric" | "BarGraph" | "LineGraph" | "Tooltip" | "Popover" | "Collapsible" | "Accordion" | "Dialog" | "Drawer" | "ProfileOverview" | "InfrastructureOverview" | "PermissionMatrix";
+export interface UiElement {
+    type: UiComponentType;
+    props: Record<string, unknown>;
+    children: string[];
+    on?: UiEventBindings;
+    repeat?: RepeatConfig;
+    visible?: UiSpecVisibilityCondition;
+    validation?: UiSpecValidationConfig;
+}
+export interface UiSpec {
+    root: string;
+    elements: Record<string, UiElement>;
+    state: Record<string, unknown>;
+}
+export interface AuthState {
+    isSignedIn: boolean;
+    roles?: string[];
+}
+export interface UiRenderContext {
+    spec: UiSpec;
+    state: Record<string, unknown>;
+    setState: (path: string, value: unknown) => void;
+    onAction?: (action: string, params?: Record<string, unknown>) => void;
+    /** Current repeat item data (set when inside a repeat block). */
+    repeatItem?: Record<string, unknown>;
+    /** Auth state for visibility evaluation. */
+    auth?: AuthState;
+    /** Whether the renderer is in a loading/streaming state. */
+    loading?: boolean;
+    /** Custom validator functions. */
+    validators?: Record<string, (value: unknown, args?: Record<string, unknown>) => boolean | Promise<boolean>>;
+    /** Field validation errors keyed by statePath. */
+    fieldErrors?: Record<string, string[]>;
+    /** Trigger validation for a field. */
+    validateField?: (statePath: string) => void;
+}
+/** RFC 6902 JSON Patch operation. */
+export type PatchOp = {
+    op: "add";
+    path: string;
+    value: unknown;
+} | {
+    op: "remove";
+    path: string;
+} | {
+    op: "replace";
+    path: string;
+    value: unknown;
+} | {
+    op: "move";
+    from: string;
+    path: string;
+} | {
+    op: "copy";
+    from: string;
+    path: string;
+} | {
+    op: "test";
+    path: string;
+    value: unknown;
+};
+/** Stream configuration for useUIStream. */
+export interface UIStreamConfig {
+    api: string;
+    onComplete?: (spec: UiSpec) => void;
+    onError?: (error: Error) => void;
+}
+//# sourceMappingURL=ui-spec.d.ts.map

package/config/ui-spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ui-spec.d.ts","sourceRoot":"","sources":["../../src/config/ui-spec.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAIH,gEAAgE;AAChE,MAAM,MAAM,WAAW,CAAC,CAAC,GAAG,MAAM,IAAI,CAAC,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAE5D,0DAA0D;AAC1D,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE;QACL,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACxB,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACzB,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACxB,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACxB,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACzB,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACzB,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;IACF,KAAK,EAAE,OAAO,CAAC;IACf,KAAK,EAAE,OAAO,CAAC;CAChB;AAID,MAAM,MAAM,kBAAkB,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,KAAK,GAAG,IAAI,GAAG,KAAK,CAAC;AAE3E,uCAAuC;AACvC,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,KAAK,EAAE,OAAO,CAAC;CAChB;AAED,uCAAuC;AACvC,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,UAAU,GAAG,WAAW,GAAG,OAAO,GAAG,MAAM,CAAC;CACnD;AAED,kDAAkD;AAClD,MAAM,WAAW,aAAa;IAC5B,GAAG,EAAE,yBAAyB,EAAE,CAAC;CAClC;AACD,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,yBAAyB,EAAE,CAAC;CACjC;AACD,MAAM,WAAW,aAAa;IAC5B,GAAG,EAAE,yBAAyB,CAAC;CAChC;AAED,MAAM,MAAM,yBAAyB,GACjC,cAAc,GACd,cAAc,GACd,aAAa,GACb,YAAY,GACZ,aAAa,CAAC;AAIlB,yCAAyC;AACzC,MAAM,MAAM,gBAAgB,GACxB,UAAU,GACV,OAAO,GACP,WAAW,GACX,WAAW,GACX,SAAS,GACT,KAAK,GACL,KAAK,CAAC;AAEV,4CAA4C;AAC5C,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,mDAAmD;AACnD,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,qBAAqB,EAAE,CAAC;IAChC,UAAU,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAC;CAC3C;AAID,qCAAqC;AACrC,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC;AAED,mDAAmD;AACnD,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,QAAQ;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,SAAS,CAAC,EAAE,eAAe,CAAC;IAC5B,OAAO,CAAC,EAAE,aAAa,CAAC;CACzB;AAED,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AAIvD,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACb;AAID,MAAM,MAAM,eAAe,GAEvB,OAAO,GACP,MAAM,GACN,MAAM,GACN,WAAW,GAEX,SAAS,GACT,MAAM,GAEN,OAAO,GACP,UAAU,GACV,QAAQ,GACR,UAAU,GACV,OAAO,GACP,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,aAAa,GACb,aAAa,GAEb,OAAO,GACP,UAAU,GACV,OAAO,GACP,QAAQ,GACR,OAAO,GAEP,OAAO,GACP,UAAU,GACV,QAAQ,GACR,UAAU,GACV,SAAS,GAET,QAAQ,GACR,MAAM,GACN,cAAc,GACd,MAAM,GACN,YAAY,GAEZ,QAAQ,GAER,UAAU,GACV,WAAW,GAEX,SAAS,GACT,SAAS,GACT,aAAa,GACb,WAAW,GACX,QAAQ,GACR,QAAQ,GAER,iBAAiB,GACjB,wBAAwB,GACxB,kBAAkB,CAAC;AAIvB,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,eAAe,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,EAAE,CAAC,EAAE,eAAe,CAAC;IACrB,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,OAAO,CAAC,EAAE,yBAAyB,CAAC;IACpC,UAAU,CAAC,EAAE,sBAAsB,CAAC;CACrC;AAID,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACpC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAChC;AAID,MAAM,WAAW,SAAS;IACxB,UAAU,EAAE,OAAO,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB;AAID,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;IACjD,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI,CAAC;IACtE,iEAAiE;IACjE,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACrC,4CAA4C;IAC5C,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,4DAA4D;IAC5D,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,kCAAkC;IAClC,UAAU,CAAC,EAAE,MAAM,CACjB,MAAM,EACN,CACE,KAAK,EAAE,OAAO,EACd,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAC3B,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAChC,CAAC;IACF,kDAAkD;IAClD,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IACvC,sCAAsC;IACtC,aAAa,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,CAAC;CAC7C;AAID,qCAAqC;AACrC,MAAM,MAAM,OAAO,GACf;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,OAAO,CAAA;CAAE,GAC3C;IAAE,EAAE,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAC9B;IAAE,EAAE,EAAE,SAAS,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,OAAO,CAAA;CAAE,GAC/C;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAC1C;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAC1C;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,OAAO,CAAA;CAAE,CAAC;AAEjD,4CAA4C;AAC5C,MAAM,WAAW,cAAc;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IACpC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;CAClC"}