autoui-react 0.0.4-alpha → 0.0.5-alpha

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -4,23 +4,23 @@ import React from 'react';
4
4
  /**
5
5
  * Event types that can be triggered by UI elements
6
6
  */
7
- declare const uiEventType: z.ZodEnum<["CLICK", "CHANGE", "SUBMIT", "MOUSEOVER", "MOUSEOUT", "FOCUS", "BLUR"]>;
7
+ declare const uiEventType: z.ZodEnum<["INIT", "CLICK", "CHANGE", "SUBMIT", "MOUSEOVER", "MOUSEOUT", "FOCUS", "BLUR"]>;
8
8
  type UIEventType = z.infer<typeof uiEventType>;
9
9
  /**
10
10
  * Event payload schema
11
11
  */
12
12
  declare const uiEvent: z.ZodObject<{
13
- type: z.ZodEnum<["CLICK", "CHANGE", "SUBMIT", "MOUSEOVER", "MOUSEOUT", "FOCUS", "BLUR"]>;
13
+ type: z.ZodEnum<["INIT", "CLICK", "CHANGE", "SUBMIT", "MOUSEOVER", "MOUSEOUT", "FOCUS", "BLUR"]>;
14
14
  nodeId: z.ZodString;
15
15
  timestamp: z.ZodNullable<z.ZodNumber>;
16
16
  payload: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
17
17
  }, "strip", z.ZodTypeAny, {
18
- type: "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
18
+ type: "INIT" | "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
19
19
  nodeId: string;
20
20
  timestamp: number | null;
21
21
  payload: Record<string, unknown> | null;
22
22
  }, {
23
- type: "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
23
+ type: "INIT" | "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
24
24
  nodeId: string;
25
25
  timestamp: number | null;
26
26
  payload: Record<string, unknown> | null;
@@ -47,17 +47,17 @@ declare const uiState: z.ZodObject<{
47
47
  layout: z.ZodNullable<z.ZodType<UISpecNodeInterface, z.ZodTypeDef, UISpecNodeInterface>>;
48
48
  loading: z.ZodBoolean;
49
49
  history: z.ZodArray<z.ZodObject<{
50
- type: z.ZodEnum<["CLICK", "CHANGE", "SUBMIT", "MOUSEOVER", "MOUSEOUT", "FOCUS", "BLUR"]>;
50
+ type: z.ZodEnum<["INIT", "CLICK", "CHANGE", "SUBMIT", "MOUSEOVER", "MOUSEOUT", "FOCUS", "BLUR"]>;
51
51
  nodeId: z.ZodString;
52
52
  timestamp: z.ZodNullable<z.ZodNumber>;
53
53
  payload: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
54
54
  }, "strip", z.ZodTypeAny, {
55
- type: "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
55
+ type: "INIT" | "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
56
56
  nodeId: string;
57
57
  timestamp: number | null;
58
58
  payload: Record<string, unknown> | null;
59
59
  }, {
60
- type: "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
60
+ type: "INIT" | "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
61
61
  nodeId: string;
62
62
  timestamp: number | null;
63
63
  payload: Record<string, unknown> | null;
@@ -67,7 +67,7 @@ declare const uiState: z.ZodObject<{
67
67
  layout: UISpecNodeInterface | null;
68
68
  loading: boolean;
69
69
  history: {
70
- type: "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
70
+ type: "INIT" | "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
71
71
  nodeId: string;
72
72
  timestamp: number | null;
73
73
  payload: Record<string, unknown> | null;
@@ -77,7 +77,7 @@ declare const uiState: z.ZodObject<{
77
77
  layout: UISpecNodeInterface | null;
78
78
  loading: boolean;
79
79
  history: {
80
- type: "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
80
+ type: "INIT" | "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
81
81
  nodeId: string;
82
82
  timestamp: number | null;
83
83
  payload: Record<string, unknown> | null;
@@ -92,17 +92,17 @@ declare const plannerInput: z.ZodObject<{
92
92
  schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
93
93
  goal: z.ZodString;
94
94
  history: z.ZodNullable<z.ZodArray<z.ZodObject<{
95
- type: z.ZodEnum<["CLICK", "CHANGE", "SUBMIT", "MOUSEOVER", "MOUSEOUT", "FOCUS", "BLUR"]>;
95
+ type: z.ZodEnum<["INIT", "CLICK", "CHANGE", "SUBMIT", "MOUSEOVER", "MOUSEOUT", "FOCUS", "BLUR"]>;
96
96
  nodeId: z.ZodString;
97
97
  timestamp: z.ZodNullable<z.ZodNumber>;
98
98
  payload: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
99
99
  }, "strip", z.ZodTypeAny, {
100
- type: "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
100
+ type: "INIT" | "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
101
101
  nodeId: string;
102
102
  timestamp: number | null;
103
103
  payload: Record<string, unknown> | null;
104
104
  }, {
105
- type: "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
105
+ type: "INIT" | "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
106
106
  nodeId: string;
107
107
  timestamp: number | null;
108
108
  payload: Record<string, unknown> | null;
@@ -110,7 +110,7 @@ declare const plannerInput: z.ZodObject<{
110
110
  userContext: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
111
111
  }, "strip", z.ZodTypeAny, {
112
112
  history: {
113
- type: "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
113
+ type: "INIT" | "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
114
114
  nodeId: string;
115
115
  timestamp: number | null;
116
116
  payload: Record<string, unknown> | null;
@@ -120,7 +120,7 @@ declare const plannerInput: z.ZodObject<{
120
120
  userContext?: Record<string, unknown> | null | undefined;
121
121
  }, {
122
122
  history: {
123
- type: "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
123
+ type: "INIT" | "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
124
124
  nodeId: string;
125
125
  timestamp: number | null;
126
126
  payload: Record<string, unknown> | null;
@@ -143,7 +143,7 @@ interface DataContext {
143
143
  */
144
144
  declare enum ActionType {
145
145
  FULL_REFRESH = "FULL_REFRESH",// Generate a completely new UI
146
- UPDATE_NODE = "UPDATE_NODE",// Update a specific node
146
+ UPDATE_NODE = "UPDATE_NODE",// Update a specific node, potentially with new children
147
147
  ADD_DROPDOWN = "ADD_DROPDOWN",// Add a dropdown to a specific node
148
148
  SHOW_DETAIL = "SHOW_DETAIL",// Show a detail view
149
149
  HIDE_DETAIL = "HIDE_DETAIL",// Hide a detail view
@@ -156,8 +156,8 @@ declare enum ActionType {
156
156
  */
157
157
  interface ActionRouteConfig {
158
158
  actionType: ActionType;
159
- targetNodeId: string;
160
- promptTemplate: string;
159
+ targetNodeId?: string;
160
+ promptTemplate?: string;
161
161
  contextKeys?: string[];
162
162
  }
163
163
  /**
@@ -198,6 +198,22 @@ declare class ActionRouter {
198
198
  }
199
199
  declare function createDefaultRouter(): ActionRouter;
200
200
 
201
+ interface UseUIStateEngineOptions {
202
+ schema: Record<string, unknown>;
203
+ goal: string;
204
+ openaiApiKey?: string | undefined;
205
+ userContext?: Record<string, unknown> | undefined;
206
+ mockMode?: boolean | undefined;
207
+ planningConfig?: {
208
+ prefetchDepth?: number;
209
+ temperature?: number;
210
+ streaming?: boolean;
211
+ } | undefined;
212
+ router?: ActionRouter | undefined;
213
+ dataContext?: Record<string, unknown> | undefined;
214
+ enablePartialUpdates?: boolean | undefined;
215
+ }
216
+
201
217
  interface EventHookOptions {
202
218
  preventDefault?: boolean;
203
219
  stopPropagation?: boolean;
@@ -464,7 +480,7 @@ declare function createSchemaAdapter(options: SchemaAdapterOptions): SchemaAdapt
464
480
  interface DrizzleAdapterOptions {
465
481
  schema: Record<string, unknown>;
466
482
  }
467
- interface AutoUIProps {
483
+ interface AutoUIProps extends Omit<UseUIStateEngineOptions, "router" | "dataContext"> {
468
484
  schema: Record<string, unknown> | {
469
485
  type: "drizzle";
470
486
  options: DrizzleAdapterOptions;
@@ -508,6 +524,7 @@ interface AutoUIProps {
508
524
  temperature?: number;
509
525
  streaming?: boolean;
510
526
  };
527
+ openaiApiKey?: string;
511
528
  }
512
529
  /**
513
530
  * AutoUI - Main component for generating goal-oriented UIs
@@ -549,9 +566,12 @@ declare const generateUIComponent: (prompt: string) => Promise<string>;
549
566
  interface UsePlannerOptions {
550
567
  goal: string;
551
568
  schema: Record<string, unknown>;
569
+ openaiApiKey?: string;
552
570
  userContext?: Record<string, unknown>;
553
571
  router?: ActionRouter;
554
572
  modelProvider?: unknown;
573
+ initialLayout?: UISpecNode;
574
+ mockMode?: boolean;
555
575
  }
556
576
  interface UsePlannerResult {
557
577
  layout: UISpecNode | undefined;
package/dist/index.d.ts CHANGED
@@ -4,23 +4,23 @@ import React from 'react';
4
4
  /**
5
5
  * Event types that can be triggered by UI elements
6
6
  */
7
- declare const uiEventType: z.ZodEnum<["CLICK", "CHANGE", "SUBMIT", "MOUSEOVER", "MOUSEOUT", "FOCUS", "BLUR"]>;
7
+ declare const uiEventType: z.ZodEnum<["INIT", "CLICK", "CHANGE", "SUBMIT", "MOUSEOVER", "MOUSEOUT", "FOCUS", "BLUR"]>;
8
8
  type UIEventType = z.infer<typeof uiEventType>;
9
9
  /**
10
10
  * Event payload schema
11
11
  */
12
12
  declare const uiEvent: z.ZodObject<{
13
- type: z.ZodEnum<["CLICK", "CHANGE", "SUBMIT", "MOUSEOVER", "MOUSEOUT", "FOCUS", "BLUR"]>;
13
+ type: z.ZodEnum<["INIT", "CLICK", "CHANGE", "SUBMIT", "MOUSEOVER", "MOUSEOUT", "FOCUS", "BLUR"]>;
14
14
  nodeId: z.ZodString;
15
15
  timestamp: z.ZodNullable<z.ZodNumber>;
16
16
  payload: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
17
17
  }, "strip", z.ZodTypeAny, {
18
- type: "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
18
+ type: "INIT" | "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
19
19
  nodeId: string;
20
20
  timestamp: number | null;
21
21
  payload: Record<string, unknown> | null;
22
22
  }, {
23
- type: "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
23
+ type: "INIT" | "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
24
24
  nodeId: string;
25
25
  timestamp: number | null;
26
26
  payload: Record<string, unknown> | null;
@@ -47,17 +47,17 @@ declare const uiState: z.ZodObject<{
47
47
  layout: z.ZodNullable<z.ZodType<UISpecNodeInterface, z.ZodTypeDef, UISpecNodeInterface>>;
48
48
  loading: z.ZodBoolean;
49
49
  history: z.ZodArray<z.ZodObject<{
50
- type: z.ZodEnum<["CLICK", "CHANGE", "SUBMIT", "MOUSEOVER", "MOUSEOUT", "FOCUS", "BLUR"]>;
50
+ type: z.ZodEnum<["INIT", "CLICK", "CHANGE", "SUBMIT", "MOUSEOVER", "MOUSEOUT", "FOCUS", "BLUR"]>;
51
51
  nodeId: z.ZodString;
52
52
  timestamp: z.ZodNullable<z.ZodNumber>;
53
53
  payload: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
54
54
  }, "strip", z.ZodTypeAny, {
55
- type: "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
55
+ type: "INIT" | "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
56
56
  nodeId: string;
57
57
  timestamp: number | null;
58
58
  payload: Record<string, unknown> | null;
59
59
  }, {
60
- type: "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
60
+ type: "INIT" | "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
61
61
  nodeId: string;
62
62
  timestamp: number | null;
63
63
  payload: Record<string, unknown> | null;
@@ -67,7 +67,7 @@ declare const uiState: z.ZodObject<{
67
67
  layout: UISpecNodeInterface | null;
68
68
  loading: boolean;
69
69
  history: {
70
- type: "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
70
+ type: "INIT" | "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
71
71
  nodeId: string;
72
72
  timestamp: number | null;
73
73
  payload: Record<string, unknown> | null;
@@ -77,7 +77,7 @@ declare const uiState: z.ZodObject<{
77
77
  layout: UISpecNodeInterface | null;
78
78
  loading: boolean;
79
79
  history: {
80
- type: "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
80
+ type: "INIT" | "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
81
81
  nodeId: string;
82
82
  timestamp: number | null;
83
83
  payload: Record<string, unknown> | null;
@@ -92,17 +92,17 @@ declare const plannerInput: z.ZodObject<{
92
92
  schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
93
93
  goal: z.ZodString;
94
94
  history: z.ZodNullable<z.ZodArray<z.ZodObject<{
95
- type: z.ZodEnum<["CLICK", "CHANGE", "SUBMIT", "MOUSEOVER", "MOUSEOUT", "FOCUS", "BLUR"]>;
95
+ type: z.ZodEnum<["INIT", "CLICK", "CHANGE", "SUBMIT", "MOUSEOVER", "MOUSEOUT", "FOCUS", "BLUR"]>;
96
96
  nodeId: z.ZodString;
97
97
  timestamp: z.ZodNullable<z.ZodNumber>;
98
98
  payload: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
99
99
  }, "strip", z.ZodTypeAny, {
100
- type: "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
100
+ type: "INIT" | "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
101
101
  nodeId: string;
102
102
  timestamp: number | null;
103
103
  payload: Record<string, unknown> | null;
104
104
  }, {
105
- type: "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
105
+ type: "INIT" | "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
106
106
  nodeId: string;
107
107
  timestamp: number | null;
108
108
  payload: Record<string, unknown> | null;
@@ -110,7 +110,7 @@ declare const plannerInput: z.ZodObject<{
110
110
  userContext: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
111
111
  }, "strip", z.ZodTypeAny, {
112
112
  history: {
113
- type: "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
113
+ type: "INIT" | "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
114
114
  nodeId: string;
115
115
  timestamp: number | null;
116
116
  payload: Record<string, unknown> | null;
@@ -120,7 +120,7 @@ declare const plannerInput: z.ZodObject<{
120
120
  userContext?: Record<string, unknown> | null | undefined;
121
121
  }, {
122
122
  history: {
123
- type: "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
123
+ type: "INIT" | "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
124
124
  nodeId: string;
125
125
  timestamp: number | null;
126
126
  payload: Record<string, unknown> | null;
@@ -143,7 +143,7 @@ interface DataContext {
143
143
  */
144
144
  declare enum ActionType {
145
145
  FULL_REFRESH = "FULL_REFRESH",// Generate a completely new UI
146
- UPDATE_NODE = "UPDATE_NODE",// Update a specific node
146
+ UPDATE_NODE = "UPDATE_NODE",// Update a specific node, potentially with new children
147
147
  ADD_DROPDOWN = "ADD_DROPDOWN",// Add a dropdown to a specific node
148
148
  SHOW_DETAIL = "SHOW_DETAIL",// Show a detail view
149
149
  HIDE_DETAIL = "HIDE_DETAIL",// Hide a detail view
@@ -156,8 +156,8 @@ declare enum ActionType {
156
156
  */
157
157
  interface ActionRouteConfig {
158
158
  actionType: ActionType;
159
- targetNodeId: string;
160
- promptTemplate: string;
159
+ targetNodeId?: string;
160
+ promptTemplate?: string;
161
161
  contextKeys?: string[];
162
162
  }
163
163
  /**
@@ -198,6 +198,22 @@ declare class ActionRouter {
198
198
  }
199
199
  declare function createDefaultRouter(): ActionRouter;
200
200
 
201
+ interface UseUIStateEngineOptions {
202
+ schema: Record<string, unknown>;
203
+ goal: string;
204
+ openaiApiKey?: string | undefined;
205
+ userContext?: Record<string, unknown> | undefined;
206
+ mockMode?: boolean | undefined;
207
+ planningConfig?: {
208
+ prefetchDepth?: number;
209
+ temperature?: number;
210
+ streaming?: boolean;
211
+ } | undefined;
212
+ router?: ActionRouter | undefined;
213
+ dataContext?: Record<string, unknown> | undefined;
214
+ enablePartialUpdates?: boolean | undefined;
215
+ }
216
+
201
217
  interface EventHookOptions {
202
218
  preventDefault?: boolean;
203
219
  stopPropagation?: boolean;
@@ -464,7 +480,7 @@ declare function createSchemaAdapter(options: SchemaAdapterOptions): SchemaAdapt
464
480
  interface DrizzleAdapterOptions {
465
481
  schema: Record<string, unknown>;
466
482
  }
467
- interface AutoUIProps {
483
+ interface AutoUIProps extends Omit<UseUIStateEngineOptions, "router" | "dataContext"> {
468
484
  schema: Record<string, unknown> | {
469
485
  type: "drizzle";
470
486
  options: DrizzleAdapterOptions;
@@ -508,6 +524,7 @@ interface AutoUIProps {
508
524
  temperature?: number;
509
525
  streaming?: boolean;
510
526
  };
527
+ openaiApiKey?: string;
511
528
  }
512
529
  /**
513
530
  * AutoUI - Main component for generating goal-oriented UIs
@@ -549,9 +566,12 @@ declare const generateUIComponent: (prompt: string) => Promise<string>;
549
566
  interface UsePlannerOptions {
550
567
  goal: string;
551
568
  schema: Record<string, unknown>;
569
+ openaiApiKey?: string;
552
570
  userContext?: Record<string, unknown>;
553
571
  router?: ActionRouter;
554
572
  modelProvider?: unknown;
573
+ initialLayout?: UISpecNode;
574
+ mockMode?: boolean;
555
575
  }
556
576
  interface UsePlannerResult {
557
577
  layout: UISpecNode | undefined;