@sqlrooms/room-config 0.27.0 → 0.28.0

package/README.md

@@ -1,103 +1,80 @@
-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.
+Core Zod schemas and types for persisted Room configuration.
 
-## Features
-
-- 📝 **Room Configuration**: Define and manage room configuration schemas
-- 🔍 **Type Safety**: Strong TypeScript typing for configuration objects
-- ✅ **Validation**: Zod schemas for runtime validation of configuration
+Use this package when you need to validate, type, or serialize the persisted configuration portion of a SQLRooms app.
 
 ## Installation
 
 ```bash
 npm install @sqlrooms/room-config
-# or
-yarn add @sqlrooms/room-config
 ```
 
-## Basic Usage
+## Main exports
 
-### Working with Base Room Configuration
+- `BaseRoomConfig`, `createDefaultBaseRoomConfig()`, `DEFAULT_ROOM_TITLE`
+- data source schemas: `DataSource`, `FileDataSource`, `UrlDataSource`, `SqlQueryDataSource`
+- data source type guards: `isFileDataSource`, `isUrlDataSource`, `isSqlQueryDataSource`
+- file load option schemas/types (`LoadFileOptions`, `StandardLoadFileOptions`, etc.)
+- layout schema re-exports from `@sqlrooms/layout-config`
 
-```tsx
-import {BaseRoomConfig} from '@sqlrooms/room-config';
+## Basic usage
 
-// Create a new room configuration
-const roomConfig: BaseRoomConfig = {
-  name: 'My SQL Room',
-  description: 'A data analysis room using SQLRooms',
-  version: '1.0.0',
-  settings: {
-    theme: 'dark',
-    // Other settings...
-  },
-};
+### Validate room config
 
-// Access configuration properties
-console.log(roomConfig.name); // 'My SQL Room'
+```ts
+import {BaseRoomConfig} from '@sqlrooms/room-config';
+
+const roomConfig = BaseRoomConfig.parse({
+  title: 'Earthquakes Explorer',
+  description: 'Browser-based analytics app',
+  dataSources: [
+    {
+      type: 'url',
+      tableName: 'earthquakes',
+      url: 'https://huggingface.co/datasets/sqlrooms/earthquakes/resolve/main/earthquakes.parquet',
+    },
+    {
+      type: 'sql',
+      tableName: 'top_quakes',
+      sqlQuery: 'SELECT * FROM earthquakes ORDER BY Magnitude DESC LIMIT 100',
+    },
+  ],
+});
 ```
 
-### Persisting Room Configuration
+### Create defaults
 
-Room configuration is designed to be saved and restored between sessions. Here's how to use the `persistSliceConfigs` helper:
+```ts
+import {createDefaultBaseRoomConfig} from '@sqlrooms/room-config';
+
+const defaultConfig = createDefaultBaseRoomConfig();
+```
 
-```tsx
+## Use with persistence
+
+```ts
+import {BaseRoomConfig, LayoutConfig} from '@sqlrooms/room-config';
 import {
-  createRoomStore,
   createRoomShellSlice,
-  RoomShellSliceState,
+  createRoomStore,
   persistSliceConfigs,
-  LayoutConfig,
 } from '@sqlrooms/room-shell';
-import {BaseRoomConfig} from '@sqlrooms/room-config';
 
-type MyRoomState = RoomShellSliceState;
+const persistence = {
+  name: 'my-room-storage',
+  sliceConfigSchemas: {
+    room: BaseRoomConfig,
+    layout: LayoutConfig,
+  },
+};
 
-// Create a store with persistence for configuration
-const {useRoomStore} = createRoomStore<MyRoomState>(
-  persistSliceConfigs(
-    {
-      name: 'room-config-storage',
-      sliceConfigSchemas: {
-        room: BaseRoomConfig,
-        layout: LayoutConfig,
+const {roomStore} = createRoomStore(
+  persistSliceConfigs(persistence, (set, get, store) => ({
+    ...createRoomShellSlice({
+      config: {
+        title: 'My Room',
+        dataSources: [],
       },
-    },
-    (set, get, store) => ({
-      ...createRoomShellSlice({
-        config: {
-          title: 'My Room',
-          // Other configuration properties
-        },
-        layout: {
-          config: {
-            // Layout configuration
-          },
-          panels: {
-            // Panel definitions
-          },
-        },
-      })(set, get, store),
-    }),
-  ),
+    })(set, get, store),
+  })),
 );
-
-// Access the config in components
-function ConfigComponent() {
-  // Config is accessed from state.room.config
-  const config = useRoomStore((state) => state.room.config);
-
-  return <div>{config.title}</div>;
-}
-```
-
-## Advanced Features
-
-- **Schema Extensions**: Extend base schemas for custom room types
-- **Configuration Validation**: Validate configurations at runtime
-- **Serialization**: Convert configurations to/from JSON for storage
-
-For more information, visit the SQLRooms documentation.
-
-```
-
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sqlrooms/room-config",
-  "version": "0.27.0",
+  "version": "0.28.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "module": "dist/index.js",
@@ -19,7 +19,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@sqlrooms/layout-config": "0.27.0",
+    "@sqlrooms/layout-config": "0.28.0",
     "zod": "^4.1.8"
   },
   "peerDependencies": {
@@ -33,5 +33,5 @@
     "typecheck": "tsc --noEmit",
     "typedoc": "typedoc"
   },
-  "gitHead": "f215995ab4adeac4c58171739261a15cbba9e82b"
+  "gitHead": "dcac54f8adf77240e293c93d224a0ce9fd8142a9"
 }