@sqlrooms/room-config 0.17.0

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.
Files changed (23) hide show
  1. package/LICENSE.md +9 -0
  2. package/README.md +124 -0
  3. package/dist/BaseRoomConfig.d.ts +408 -0
  4. package/dist/BaseRoomConfig.d.ts.map +1 -0
  5. package/dist/BaseRoomConfig.js +16 -0
  6. package/dist/BaseRoomConfig.js.map +1 -0
  7. package/dist/DataSource.d.ts +558 -0
  8. package/dist/DataSource.d.ts.map +1 -0
  9. package/dist/DataSource.js +83 -0
  10. package/dist/DataSource.js.map +1 -0
  11. package/dist/LayoutConfig.d.ts +64 -0
  12. package/dist/LayoutConfig.d.ts.map +1 -0
  13. package/dist/LayoutConfig.js +35 -0
  14. package/dist/LayoutConfig.js.map +1 -0
  15. package/dist/LoadOptions.d.ts +333 -0
  16. package/dist/LoadOptions.d.ts.map +1 -0
  17. package/dist/LoadOptions.js +83 -0
  18. package/dist/LoadOptions.js.map +1 -0
  19. package/dist/index.d.ts +9 -0
  20. package/dist/index.d.ts.map +1 -0
  21. package/dist/index.js +9 -0
  22. package/dist/index.js.map +1 -0
  23. package/package.json +34 -0
package/LICENSE.md ADDED
@@ -0,0 +1,9 @@
1
+ MIT License
2
+
3
+ Copyright 2025 Ilya Boyandin
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
6
+
7
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
8
+
9
+ THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,124 @@
1
+ A central configuration and type definitions package that maintains base room configuration schemas and Zod schema definitions. It provides TypeScript types and interfaces along with essential constants and utilities used throughout the framework.
2
+
3
+ ## Features
4
+
5
+ - 📝 **Room Configuration**: Define and manage room configuration schemas
6
+ - 🔍 **Type Safety**: Strong TypeScript typing for configuration objects
7
+ - 🧩 **Layout Configuration**: Flexible layout configuration system
8
+ - ✅ **Validation**: Zod schemas for runtime validation of configuration
9
+
10
+ ## Installation
11
+
12
+ ```bash
13
+ npm install @sqlrooms/room-config
14
+ # or
15
+ yarn add @sqlrooms/room-config
16
+ ```
17
+
18
+ ## Basic Usage
19
+
20
+ ### Working with Base Room Configuration
21
+
22
+ ```tsx
23
+ import {BaseRoomConfig} from '@sqlrooms/room-config';
24
+
25
+ // Create a new room configuration
26
+ const roomConfig: BaseRoomConfig = {
27
+ name: 'My SQL Room',
28
+ description: 'A data analysis room using SQLRooms',
29
+ version: '1.0.0',
30
+ settings: {
31
+ theme: 'dark',
32
+ // Other settings...
33
+ },
34
+ };
35
+
36
+ // Access configuration properties
37
+ console.log(roomConfig.name); // 'My SQL Room'
38
+ ```
39
+
40
+ ### Persisting Room Configuration
41
+
42
+ Room configuration is designed to be saved and restored between sessions. Here's how to use it with Zustand's persist middleware:
43
+
44
+ ```tsx
45
+ import {persist} from 'zustand/middleware';
46
+ import {createRoomStore, createRoomSlice} from '@sqlrooms/room-shell';
47
+ import {BaseRoomConfig} from '@sqlrooms/room-config';
48
+
49
+ // Create a store with persistence for configuration
50
+ const {useRoomStore} = createRoomStore(
51
+ persist(
52
+ (set, get, store) => ({
53
+ ...createRoomSlice({
54
+ // Config is stored at the root level of state for persisting the app state
55
+ config: {
56
+ title: 'My Room',
57
+ // Other configuration properties
58
+ },
59
+ // Room object contains panels and runtime-only state
60
+ room: {
61
+ panels: {
62
+ // Panel definitions
63
+ },
64
+ },
65
+ })(set, get, store),
66
+ }),
67
+ {
68
+ name: 'room-config-storage',
69
+ // Only persist the configuration part of the state
70
+ partialize: (state) => ({
71
+ config: state.config,
72
+ }),
73
+ },
74
+ ),
75
+ );
76
+
77
+ // Access the config in components
78
+ function ConfigComponent() {
79
+ // Config is accessed directly from state, not from state.room.config
80
+ const config = useRoomStore((state) => state.config);
81
+
82
+ return <div>{config.title}</div>;
83
+ }
84
+ ```
85
+
86
+ ### Using Layout Configuration
87
+
88
+ ```tsx
89
+ import {LayoutConfig} from '@sqlrooms/room-config';
90
+
91
+ // Define a layout configuration
92
+ const layoutConfig: LayoutConfig = {
93
+ layout: 'grid',
94
+ panels: [
95
+ {
96
+ id: 'editor',
97
+ type: 'sql-editor',
98
+ position: {x: 0, y: 0, width: 6, height: 4},
99
+ },
100
+ {
101
+ id: 'results',
102
+ type: 'data-table',
103
+ position: {x: 0, y: 4, width: 6, height: 4},
104
+ },
105
+ ],
106
+ };
107
+
108
+ // Use the layout configuration in your application
109
+ function renderLayout(config: LayoutConfig) {
110
+ // Implementation...
111
+ }
112
+ ```
113
+
114
+ ## Advanced Features
115
+
116
+ - **Schema Extensions**: Extend base schemas for custom room types
117
+ - **Configuration Validation**: Validate configurations at runtime
118
+ - **Serialization**: Convert configurations to/from JSON for storage
119
+
120
+ For more information, visit the SQLRooms documentation.
121
+
122
+ ```
123
+
124
+ ```
package/dist/BaseRoomConfig.d.ts ADDED
@@ -0,0 +1,408 @@
1
+ import { z } from 'zod';
2
+ export declare const DEFAULT_ROOM_TITLE = "Untitled room";
3
+ export declare const BaseRoomConfig: z.ZodObject<{
4
+ title: z.ZodDefault<z.ZodString>;
5
+ description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
6
+ layout: z.ZodDefault<z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
7
+ type: z.ZodLiteral<"mosaic">;
8
+ nodes: z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodType<import("./LayoutConfig").MosaicLayoutParent, z.ZodTypeDef, import("./LayoutConfig").MosaicLayoutParent>]>>;
9
+ pinned: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
10
+ fixed: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
11
+ }, "strip", z.ZodTypeAny, {
12
+ type: "mosaic";
13
+ nodes: string | import("./LayoutConfig").MosaicLayoutParent | null;
14
+ pinned?: string[] | undefined;
15
+ fixed?: string[] | undefined;
16
+ }, {
17
+ type: "mosaic";
18
+ nodes: string | import("./LayoutConfig").MosaicLayoutParent | null;
19
+ pinned?: string[] | undefined;
20
+ fixed?: string[] | undefined;
21
+ }>]>>;
22
+ dataSources: z.ZodDefault<z.ZodArray<z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
23
+ tableName: z.ZodString;
24
+ } & {
25
+ type: z.ZodLiteral<"file">;
26
+ fileName: z.ZodString;
27
+ loadOptions: z.ZodOptional<z.ZodDiscriminatedUnion<"method", [z.ZodObject<{
28
+ schema: z.ZodOptional<z.ZodString>;
29
+ select: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
30
+ where: z.ZodOptional<z.ZodString>;
31
+ view: z.ZodOptional<z.ZodBoolean>;
32
+ temp: z.ZodOptional<z.ZodBoolean>;
33
+ replace: z.ZodOptional<z.ZodBoolean>;
34
+ } & {
35
+ method: z.ZodEnum<["read_json", "read_ndjson", "read_parquet", "read_csv", "auto"]>;
36
+ }, "strip", z.ZodUnknown, z.objectOutputType<{
37
+ schema: z.ZodOptional<z.ZodString>;
38
+ select: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
39
+ where: z.ZodOptional<z.ZodString>;
40
+ view: z.ZodOptional<z.ZodBoolean>;
41
+ temp: z.ZodOptional<z.ZodBoolean>;
42
+ replace: z.ZodOptional<z.ZodBoolean>;
43
+ } & {
44
+ method: z.ZodEnum<["read_json", "read_ndjson", "read_parquet", "read_csv", "auto"]>;
45
+ }, z.ZodUnknown, "strip">, z.objectInputType<{
46
+ schema: z.ZodOptional<z.ZodString>;
47
+ select: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
48
+ where: z.ZodOptional<z.ZodString>;
49
+ view: z.ZodOptional<z.ZodBoolean>;
50
+ temp: z.ZodOptional<z.ZodBoolean>;
51
+ replace: z.ZodOptional<z.ZodBoolean>;
52
+ } & {
53
+ method: z.ZodEnum<["read_json", "read_ndjson", "read_parquet", "read_csv", "auto"]>;
54
+ }, z.ZodUnknown, "strip">>, z.ZodObject<{
55
+ schema: z.ZodOptional<z.ZodString>;
56
+ select: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
57
+ where: z.ZodOptional<z.ZodString>;
58
+ view: z.ZodOptional<z.ZodBoolean>;
59
+ temp: z.ZodOptional<z.ZodBoolean>;
60
+ replace: z.ZodOptional<z.ZodBoolean>;
61
+ } & {
62
+ options: z.ZodOptional<z.ZodUnion<[z.ZodArray<z.ZodString, "many">, z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>]>>;
63
+ } & {
64
+ method: z.ZodLiteral<"st_read">;
65
+ }, "strip", z.ZodUnknown, z.objectOutputType<{
66
+ schema: z.ZodOptional<z.ZodString>;
67
+ select: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
68
+ where: z.ZodOptional<z.ZodString>;
69
+ view: z.ZodOptional<z.ZodBoolean>;
70
+ temp: z.ZodOptional<z.ZodBoolean>;
71
+ replace: z.ZodOptional<z.ZodBoolean>;
72
+ } & {
73
+ options: z.ZodOptional<z.ZodUnion<[z.ZodArray<z.ZodString, "many">, z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>]>>;
74
+ } & {
75
+ method: z.ZodLiteral<"st_read">;
76
+ }, z.ZodUnknown, "strip">, z.objectInputType<{
77
+ schema: z.ZodOptional<z.ZodString>;
78
+ select: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
79
+ where: z.ZodOptional<z.ZodString>;
80
+ view: z.ZodOptional<z.ZodBoolean>;
81
+ temp: z.ZodOptional<z.ZodBoolean>;
82
+ replace: z.ZodOptional<z.ZodBoolean>;
83
+ } & {
84
+ options: z.ZodOptional<z.ZodUnion<[z.ZodArray<z.ZodString, "many">, z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>]>>;
85
+ } & {
86
+ method: z.ZodLiteral<"st_read">;
87
+ }, z.ZodUnknown, "strip">>]>>;
88
+ }, "strip", z.ZodTypeAny, {
89
+ type: "file";
90
+ tableName: string;
91
+ fileName: string;
92
+ loadOptions?: z.objectOutputType<{
93
+ schema: z.ZodOptional<z.ZodString>;
94
+ select: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
95
+ where: z.ZodOptional<z.ZodString>;
96
+ view: z.ZodOptional<z.ZodBoolean>;
97
+ temp: z.ZodOptional<z.ZodBoolean>;
98
+ replace: z.ZodOptional<z.ZodBoolean>;
99
+ } & {
100
+ options: z.ZodOptional<z.ZodUnion<[z.ZodArray<z.ZodString, "many">, z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>]>>;
101
+ } & {
102
+ method: z.ZodLiteral<"st_read">;
103
+ }, z.ZodUnknown, "strip"> | z.objectOutputType<{
104
+ schema: z.ZodOptional<z.ZodString>;
105
+ select: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
106
+ where: z.ZodOptional<z.ZodString>;
107
+ view: z.ZodOptional<z.ZodBoolean>;
108
+ temp: z.ZodOptional<z.ZodBoolean>;
109
+ replace: z.ZodOptional<z.ZodBoolean>;
110
+ } & {
111
+ method: z.ZodEnum<["read_json", "read_ndjson", "read_parquet", "read_csv", "auto"]>;
112
+ }, z.ZodUnknown, "strip"> | undefined;
113
+ }, {
114
+ type: "file";
115
+ tableName: string;
116
+ fileName: string;
117
+ loadOptions?: z.objectInputType<{
118
+ schema: z.ZodOptional<z.ZodString>;
119
+ select: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
120
+ where: z.ZodOptional<z.ZodString>;
121
+ view: z.ZodOptional<z.ZodBoolean>;
122
+ temp: z.ZodOptional<z.ZodBoolean>;
123
+ replace: z.ZodOptional<z.ZodBoolean>;
124
+ } & {
125
+ options: z.ZodOptional<z.ZodUnion<[z.ZodArray<z.ZodString, "many">, z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>]>>;
126
+ } & {
127
+ method: z.ZodLiteral<"st_read">;
128
+ }, z.ZodUnknown, "strip"> | z.objectInputType<{
129
+ schema: z.ZodOptional<z.ZodString>;
130
+ select: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
131
+ where: z.ZodOptional<z.ZodString>;
132
+ view: z.ZodOptional<z.ZodBoolean>;
133
+ temp: z.ZodOptional<z.ZodBoolean>;
134
+ replace: z.ZodOptional<z.ZodBoolean>;
135
+ } & {
136
+ method: z.ZodEnum<["read_json", "read_ndjson", "read_parquet", "read_csv", "auto"]>;
137
+ }, z.ZodUnknown, "strip"> | undefined;
138
+ }>, z.ZodObject<{
139
+ tableName: z.ZodString;
140
+ } & {
141
+ type: z.ZodLiteral<"url">;
142
+ url: z.ZodString;
143
+ loadOptions: z.ZodOptional<z.ZodDiscriminatedUnion<"method", [z.ZodObject<{
144
+ schema: z.ZodOptional<z.ZodString>;
145
+ select: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
146
+ where: z.ZodOptional<z.ZodString>;
147
+ view: z.ZodOptional<z.ZodBoolean>;
148
+ temp: z.ZodOptional<z.ZodBoolean>;
149
+ replace: z.ZodOptional<z.ZodBoolean>;
150
+ } & {
151
+ method: z.ZodEnum<["read_json", "read_ndjson", "read_parquet", "read_csv", "auto"]>;
152
+ }, "strip", z.ZodUnknown, z.objectOutputType<{
153
+ schema: z.ZodOptional<z.ZodString>;
154
+ select: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
155
+ where: z.ZodOptional<z.ZodString>;
156
+ view: z.ZodOptional<z.ZodBoolean>;
157
+ temp: z.ZodOptional<z.ZodBoolean>;
158
+ replace: z.ZodOptional<z.ZodBoolean>;
159
+ } & {
160
+ method: z.ZodEnum<["read_json", "read_ndjson", "read_parquet", "read_csv", "auto"]>;
161
+ }, z.ZodUnknown, "strip">, z.objectInputType<{
162
+ schema: z.ZodOptional<z.ZodString>;
163
+ select: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
164
+ where: z.ZodOptional<z.ZodString>;
165
+ view: z.ZodOptional<z.ZodBoolean>;
166
+ temp: z.ZodOptional<z.ZodBoolean>;
167
+ replace: z.ZodOptional<z.ZodBoolean>;
168
+ } & {
169
+ method: z.ZodEnum<["read_json", "read_ndjson", "read_parquet", "read_csv", "auto"]>;
170
+ }, z.ZodUnknown, "strip">>, z.ZodObject<{
171
+ schema: z.ZodOptional<z.ZodString>;
172
+ select: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
173
+ where: z.ZodOptional<z.ZodString>;
174
+ view: z.ZodOptional<z.ZodBoolean>;
175
+ temp: z.ZodOptional<z.ZodBoolean>;
176
+ replace: z.ZodOptional<z.ZodBoolean>;
177
+ } & {
178
+ options: z.ZodOptional<z.ZodUnion<[z.ZodArray<z.ZodString, "many">, z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>]>>;
179
+ } & {
180
+ method: z.ZodLiteral<"st_read">;
181
+ }, "strip", z.ZodUnknown, z.objectOutputType<{
182
+ schema: z.ZodOptional<z.ZodString>;
183
+ select: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
184
+ where: z.ZodOptional<z.ZodString>;
185
+ view: z.ZodOptional<z.ZodBoolean>;
186
+ temp: z.ZodOptional<z.ZodBoolean>;
187
+ replace: z.ZodOptional<z.ZodBoolean>;
188
+ } & {
189
+ options: z.ZodOptional<z.ZodUnion<[z.ZodArray<z.ZodString, "many">, z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>]>>;
190
+ } & {
191
+ method: z.ZodLiteral<"st_read">;
192
+ }, z.ZodUnknown, "strip">, z.objectInputType<{
193
+ schema: z.ZodOptional<z.ZodString>;
194
+ select: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
195
+ where: z.ZodOptional<z.ZodString>;
196
+ view: z.ZodOptional<z.ZodBoolean>;
197
+ temp: z.ZodOptional<z.ZodBoolean>;
198
+ replace: z.ZodOptional<z.ZodBoolean>;
199
+ } & {
200
+ options: z.ZodOptional<z.ZodUnion<[z.ZodArray<z.ZodString, "many">, z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>]>>;
201
+ } & {
202
+ method: z.ZodLiteral<"st_read">;
203
+ }, z.ZodUnknown, "strip">>]>>;
204
+ httpMethod: z.ZodOptional<z.ZodString>;
205
+ headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
206
+ }, "strip", z.ZodTypeAny, {
207
+ type: "url";
208
+ url: string;
209
+ tableName: string;
210
+ loadOptions?: z.objectOutputType<{
211
+ schema: z.ZodOptional<z.ZodString>;
212
+ select: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
213
+ where: z.ZodOptional<z.ZodString>;
214
+ view: z.ZodOptional<z.ZodBoolean>;
215
+ temp: z.ZodOptional<z.ZodBoolean>;
216
+ replace: z.ZodOptional<z.ZodBoolean>;
217
+ } & {
218
+ options: z.ZodOptional<z.ZodUnion<[z.ZodArray<z.ZodString, "many">, z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>]>>;
219
+ } & {
220
+ method: z.ZodLiteral<"st_read">;
221
+ }, z.ZodUnknown, "strip"> | z.objectOutputType<{
222
+ schema: z.ZodOptional<z.ZodString>;
223
+ select: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
224
+ where: z.ZodOptional<z.ZodString>;
225
+ view: z.ZodOptional<z.ZodBoolean>;
226
+ temp: z.ZodOptional<z.ZodBoolean>;
227
+ replace: z.ZodOptional<z.ZodBoolean>;
228
+ } & {
229
+ method: z.ZodEnum<["read_json", "read_ndjson", "read_parquet", "read_csv", "auto"]>;
230
+ }, z.ZodUnknown, "strip"> | undefined;
231
+ httpMethod?: string | undefined;
232
+ headers?: Record<string, string> | undefined;
233
+ }, {
234
+ type: "url";
235
+ url: string;
236
+ tableName: string;
237
+ loadOptions?: z.objectInputType<{
238
+ schema: z.ZodOptional<z.ZodString>;
239
+ select: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
240
+ where: z.ZodOptional<z.ZodString>;
241
+ view: z.ZodOptional<z.ZodBoolean>;
242
+ temp: z.ZodOptional<z.ZodBoolean>;
243
+ replace: z.ZodOptional<z.ZodBoolean>;
244
+ } & {
245
+ options: z.ZodOptional<z.ZodUnion<[z.ZodArray<z.ZodString, "many">, z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>]>>;
246
+ } & {
247
+ method: z.ZodLiteral<"st_read">;
248
+ }, z.ZodUnknown, "strip"> | z.objectInputType<{
249
+ schema: z.ZodOptional<z.ZodString>;
250
+ select: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
251
+ where: z.ZodOptional<z.ZodString>;
252
+ view: z.ZodOptional<z.ZodBoolean>;
253
+ temp: z.ZodOptional<z.ZodBoolean>;
254
+ replace: z.ZodOptional<z.ZodBoolean>;
255
+ } & {
256
+ method: z.ZodEnum<["read_json", "read_ndjson", "read_parquet", "read_csv", "auto"]>;
257
+ }, z.ZodUnknown, "strip"> | undefined;
258
+ httpMethod?: string | undefined;
259
+ headers?: Record<string, string> | undefined;
260
+ }>, z.ZodObject<{
261
+ tableName: z.ZodString;
262
+ } & {
263
+ type: z.ZodLiteral<"sql">;
264
+ sqlQuery: z.ZodString;
265
+ }, "strip", z.ZodTypeAny, {
266
+ type: "sql";
267
+ tableName: string;
268
+ sqlQuery: string;
269
+ }, {
270
+ type: "sql";
271
+ tableName: string;
272
+ sqlQuery: string;
273
+ }>]>, "many">>;
274
+ }, "strip", z.ZodTypeAny, {
275
+ title: string;
276
+ layout: {
277
+ type: "mosaic";
278
+ nodes: string | import("./LayoutConfig").MosaicLayoutParent | null;
279
+ pinned?: string[] | undefined;
280
+ fixed?: string[] | undefined;
281
+ };
282
+ dataSources: ({
283
+ type: "file";
284
+ tableName: string;
285
+ fileName: string;
286
+ loadOptions?: z.objectOutputType<{
287
+ schema: z.ZodOptional<z.ZodString>;
288
+ select: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
289
+ where: z.ZodOptional<z.ZodString>;
290
+ view: z.ZodOptional<z.ZodBoolean>;
291
+ temp: z.ZodOptional<z.ZodBoolean>;
292
+ replace: z.ZodOptional<z.ZodBoolean>;
293
+ } & {
294
+ options: z.ZodOptional<z.ZodUnion<[z.ZodArray<z.ZodString, "many">, z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>]>>;
295
+ } & {
296
+ method: z.ZodLiteral<"st_read">;
297
+ }, z.ZodUnknown, "strip"> | z.objectOutputType<{
298
+ schema: z.ZodOptional<z.ZodString>;
299
+ select: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
300
+ where: z.ZodOptional<z.ZodString>;
301
+ view: z.ZodOptional<z.ZodBoolean>;
302
+ temp: z.ZodOptional<z.ZodBoolean>;
303
+ replace: z.ZodOptional<z.ZodBoolean>;
304
+ } & {
305
+ method: z.ZodEnum<["read_json", "read_ndjson", "read_parquet", "read_csv", "auto"]>;
306
+ }, z.ZodUnknown, "strip"> | undefined;
307
+ } | {
308
+ type: "url";
309
+ url: string;
310
+ tableName: string;
311
+ loadOptions?: z.objectOutputType<{
312
+ schema: z.ZodOptional<z.ZodString>;
313
+ select: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
314
+ where: z.ZodOptional<z.ZodString>;
315
+ view: z.ZodOptional<z.ZodBoolean>;
316
+ temp: z.ZodOptional<z.ZodBoolean>;
317
+ replace: z.ZodOptional<z.ZodBoolean>;
318
+ } & {
319
+ options: z.ZodOptional<z.ZodUnion<[z.ZodArray<z.ZodString, "many">, z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>]>>;
320
+ } & {
321
+ method: z.ZodLiteral<"st_read">;
322
+ }, z.ZodUnknown, "strip"> | z.objectOutputType<{
323
+ schema: z.ZodOptional<z.ZodString>;
324
+ select: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
325
+ where: z.ZodOptional<z.ZodString>;
326
+ view: z.ZodOptional<z.ZodBoolean>;
327
+ temp: z.ZodOptional<z.ZodBoolean>;
328
+ replace: z.ZodOptional<z.ZodBoolean>;
329
+ } & {
330
+ method: z.ZodEnum<["read_json", "read_ndjson", "read_parquet", "read_csv", "auto"]>;
331
+ }, z.ZodUnknown, "strip"> | undefined;
332
+ httpMethod?: string | undefined;
333
+ headers?: Record<string, string> | undefined;
334
+ } | {
335
+ type: "sql";
336
+ tableName: string;
337
+ sqlQuery: string;
338
+ })[];
339
+ description?: string | null | undefined;
340
+ }, {
341
+ title?: string | undefined;
342
+ description?: string | null | undefined;
343
+ layout?: {
344
+ type: "mosaic";
345
+ nodes: string | import("./LayoutConfig").MosaicLayoutParent | null;
346
+ pinned?: string[] | undefined;
347
+ fixed?: string[] | undefined;
348
+ } | undefined;
349
+ dataSources?: ({
350
+ type: "file";
351
+ tableName: string;
352
+ fileName: string;
353
+ loadOptions?: z.objectInputType<{
354
+ schema: z.ZodOptional<z.ZodString>;
355
+ select: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
356
+ where: z.ZodOptional<z.ZodString>;
357
+ view: z.ZodOptional<z.ZodBoolean>;
358
+ temp: z.ZodOptional<z.ZodBoolean>;
359
+ replace: z.ZodOptional<z.ZodBoolean>;
360
+ } & {
361
+ options: z.ZodOptional<z.ZodUnion<[z.ZodArray<z.ZodString, "many">, z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>]>>;
362
+ } & {
363
+ method: z.ZodLiteral<"st_read">;
364
+ }, z.ZodUnknown, "strip"> | z.objectInputType<{
365
+ schema: z.ZodOptional<z.ZodString>;
366
+ select: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
367
+ where: z.ZodOptional<z.ZodString>;
368
+ view: z.ZodOptional<z.ZodBoolean>;
369
+ temp: z.ZodOptional<z.ZodBoolean>;
370
+ replace: z.ZodOptional<z.ZodBoolean>;
371
+ } & {
372
+ method: z.ZodEnum<["read_json", "read_ndjson", "read_parquet", "read_csv", "auto"]>;
373
+ }, z.ZodUnknown, "strip"> | undefined;
374
+ } | {
375
+ type: "url";
376
+ url: string;
377
+ tableName: string;
378
+ loadOptions?: z.objectInputType<{
379
+ schema: z.ZodOptional<z.ZodString>;
380
+ select: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
381
+ where: z.ZodOptional<z.ZodString>;
382
+ view: z.ZodOptional<z.ZodBoolean>;
383
+ temp: z.ZodOptional<z.ZodBoolean>;
384
+ replace: z.ZodOptional<z.ZodBoolean>;
385
+ } & {
386
+ options: z.ZodOptional<z.ZodUnion<[z.ZodArray<z.ZodString, "many">, z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>]>>;
387
+ } & {
388
+ method: z.ZodLiteral<"st_read">;
389
+ }, z.ZodUnknown, "strip"> | z.objectInputType<{
390
+ schema: z.ZodOptional<z.ZodString>;
391
+ select: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
392
+ where: z.ZodOptional<z.ZodString>;
393
+ view: z.ZodOptional<z.ZodBoolean>;
394
+ temp: z.ZodOptional<z.ZodBoolean>;
395
+ replace: z.ZodOptional<z.ZodBoolean>;
396
+ } & {
397
+ method: z.ZodEnum<["read_json", "read_ndjson", "read_parquet", "read_csv", "auto"]>;
398
+ }, z.ZodUnknown, "strip"> | undefined;
399
+ httpMethod?: string | undefined;
400
+ headers?: Record<string, string> | undefined;
401
+ } | {
402
+ type: "sql";
403
+ tableName: string;
404
+ sqlQuery: string;
405
+ })[] | undefined;
406
+ }>;
407
+ export type BaseRoomConfig = z.infer<typeof BaseRoomConfig>;
408
+ //# sourceMappingURL=BaseRoomConfig.d.ts.map
package/dist/BaseRoomConfig.d.ts.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"BaseRoomConfig.d.ts","sourceRoot":"","sources":["../src/BaseRoomConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,CAAC,EAAC,MAAM,KAAK,CAAC;AAItB,eAAO,MAAM,kBAAkB,kBAAkB,CAAC;AAElD,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAYO,CAAC;AAEnC,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC"}
package/dist/BaseRoomConfig.js ADDED
@@ -0,0 +1,16 @@
1
+ import { z } from 'zod';
2
+ import { DataSource } from './DataSource';
3
+ import LayoutConfig, { DEFAULT_MOSAIC_LAYOUT } from './LayoutConfig';
4
+ export const DEFAULT_ROOM_TITLE = 'Untitled room';
5
+ export const BaseRoomConfig = z
6
+ .object({
7
+ title: z.string().default(DEFAULT_ROOM_TITLE).describe('Room title.'),
8
+ description: z.string().nullable().optional().describe('Room description.'),
9
+ layout: LayoutConfig.default(DEFAULT_MOSAIC_LAYOUT).describe('Layout specifies how views are arranged on the screen.'),
10
+ dataSources: z
11
+ .array(DataSource)
12
+ .default([])
13
+ .describe('Data sources. Each data source must have a unique tableName.'),
14
+ })
15
+ .describe('Room configuration.');
16
+ //# sourceMappingURL=BaseRoomConfig.js.map
package/dist/BaseRoomConfig.js.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"BaseRoomConfig.js","sourceRoot":"","sources":["../src/BaseRoomConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,CAAC,EAAC,MAAM,KAAK,CAAC;AACtB,OAAO,EAAC,UAAU,EAAC,MAAM,cAAc,CAAC;AACxC,OAAO,YAAY,EAAE,EAAC,qBAAqB,EAAC,MAAM,gBAAgB,CAAC;AAEnE,MAAM,CAAC,MAAM,kBAAkB,GAAG,eAAe,CAAC;AAElD,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC;KAC5B,MAAM,CAAC;IACN,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC;IACrE,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,mBAAmB,CAAC;IAC3E,MAAM,EAAE,YAAY,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC,QAAQ,CAC1D,wDAAwD,CACzD;IACD,WAAW,EAAE,CAAC;SACX,KAAK,CAAC,UAAU,CAAC;SACjB,OAAO,CAAC,EAAE,CAAC;SACX,QAAQ,CAAC,8DAA8D,CAAC;CAC5E,CAAC;KACD,QAAQ,CAAC,qBAAqB,CAAC,CAAC","sourcesContent":["import {z} from 'zod';\nimport {DataSource} from './DataSource';\nimport LayoutConfig, {DEFAULT_MOSAIC_LAYOUT} from './LayoutConfig';\n\nexport const DEFAULT_ROOM_TITLE = 'Untitled room';\n\nexport const BaseRoomConfig = z\n .object({\n title: z.string().default(DEFAULT_ROOM_TITLE).describe('Room title.'),\n description: z.string().nullable().optional().describe('Room description.'),\n layout: LayoutConfig.default(DEFAULT_MOSAIC_LAYOUT).describe(\n 'Layout specifies how views are arranged on the screen.',\n ),\n dataSources: z\n .array(DataSource)\n .default([])\n .describe('Data sources. Each data source must have a unique tableName.'),\n })\n .describe('Room configuration.');\n\nexport type BaseRoomConfig = z.infer<typeof BaseRoomConfig>;\n"]}