@sqlrooms/room-store 0.19.0

package/LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright 2025 Ilya Boyandin
+
+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:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+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

@@ -0,0 +1,126 @@
+# @sqlrooms/room-store
+
+This package provides the core state management for SQLRooms using [Zustand](https://github.com/pmndrs/zustand). It is designed to be extensible, allowing you to build custom room experiences by creating and composing state "slices".
+
+## Installation
+
+```bash
+npm install @sqlrooms/room-store @sqlrooms/room-config zod zustand
+```
+
+## Core Concepts
+
+### RoomStore
+
+The `RoomStore` is a Zustand store that holds the entire state of a room. It is created by calling `createRoomStore` with a function that composes one or more slice creators.
+
+### RoomState
+
+The `RoomState` is the object that defines the shape of the store. It has two main properties:
+
+- `config`: This holds the configuration of the room that is persisted. This is defined by a `zod` schema, often extending the `BaseRoomConfig` from `@sqlrooms/room-config`.
+- `room`: This holds the client-side state of the room, such as task progress, and provides actions for interacting with the room.
+
+### Slices
+
+A slice is a piece of the room's state and its associated actions. You can create your own slices to add custom functionality to your room. The framework provides `createRoomSlice` to create the base slice with core room functionality. You combine this with your own slices inside the `createRoomStore` composer function.
+
+## Basic Usage
+
+Here's an example of how to create a room store with a custom feature slice.
+
+```typescript
+import {
+  createRoomStore,
+  createRoomSlice,
+  RoomState,
+} from '@sqlrooms/room-store';
+import {BaseRoomConfig} from '@sqlrooms/room-config';
+import {z} from 'zod';
+import {StateCreator} from 'zustand';
+
+// 1. Define your persisted room configuration schema using Zod.
+// This extends the base config with a custom property.
+export const MyRoomConfig = BaseRoomConfig.extend({
+  defaultChartType: z.enum(['bar', 'line', 'scatter']).default('bar'),
+});
+export type MyRoomConfig = z.infer<typeof MyRoomConfig>;
+
+// 2. Define the state and actions for your custom feature slice.
+export interface MyFeatureSlice {
+  activeChartId: string | null;
+  setActiveChartId: (id: string | null) => void;
+}
+
+// 3. Create your custom slice.
+export const createMyFeatureSlice: StateCreator<MyFeatureSlice> = (set) => ({
+  activeChartId: null,
+  setActiveChartId: (id) => set({activeChartId: id}),
+});
+
+// 4. Define the full state of your room, combining the base RoomState
+// with your custom slice's state.
+export type MyRoomState = RoomState<MyRoomConfig> & MyFeatureSlice;
+
+// 5. Create the room store by composing the base slice and your custom slice.
+export const {roomStore, useRoomStore} = createRoomStore<
+  MyRoomConfig,
+  MyRoomState
+>((set, get, store) => ({
+  ...createRoomSlice<MyRoomConfig>({
+    config: {
+      // You can provide initial values for your config here
+      title: 'My First Room',
+      defaultChartType: 'line',
+      // other properties from BaseRoomConfig will have defaults
+    },
+    room: {},
+  })(set, get, store),
+
+  // Add your custom slice to the store
+  ...createMyFeatureSlice(set, get, store),
+}));
+
+export {roomStore, useRoomStore};
+```
+
+## Providing the Store
+
+To make the store available to your React components, you need to use the `RoomStateProvider` component at the root of your application.
+
+```tsx
+import {RoomStateProvider} from '@sqlrooms/room-store';
+import {roomStore} from './my-room-store';
+
+function App() {
+  return (
+    <RoomStateProvider value={roomStore}>
+      {/* Your room components go here */}
+    </RoomStateProvider>
+  );
+}
+```
+
+## Accessing the Store in Components
+
+You can use the `useRoomStore` hook returned by `createRoomStore` to access the room's state and actions from any component.
+
+```tsx
+import {useRoomStore} from './my-room-store';
+
+function RoomTitle() {
+  const title = useRoomStore((state) => state.config.title);
+  const activeChartId = useRoomStore((state) => state.activeChartId);
+  const setActiveChartId = useRoomStore((state) => state.setActiveChartId);
+
+  return (
+    <div>
+      <h1>{title}</h1>
+      <p>Active Chart: {activeChartId || 'None'}</p>
+      <button onClick={() => setActiveChartId('chart-123')}>
+        Activate Chart
+      </button>
+    </div>
+  );
+}
+```

package/dist/RoomStateProvider.d.ts

@@ -0,0 +1,9 @@
+import React, { ReactNode } from 'react';
+import { RoomState, RoomStore } from './RoomStore';
+export declare const RoomStateContext: React.Context<RoomStore<unknown> | null>;
+export type RoomStateProviderProps<PC> = React.PropsWithChildren<{
+    roomStore?: RoomStore<PC>;
+}>;
+export declare function RoomStateProvider<PC>({ children, roomStore, }: RoomStateProviderProps<PC>): ReactNode;
+export declare function useBaseRoomStore<PC, PS extends RoomState<PC>, T>(selector: (state: RoomState<PC>) => T): T;
+//# sourceMappingURL=RoomStateProvider.d.ts.map

package/dist/RoomStateProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RoomStateProvider.d.ts","sourceRoot":"","sources":["../src/RoomStateProvider.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAgB,SAAS,EAAa,MAAM,OAAO,CAAC;AAElE,OAAO,EAAC,SAAS,EAAE,SAAS,EAAC,MAAM,aAAa,CAAC;AAIjD,eAAO,MAAM,gBAAgB,0CAAiD,CAAC;AAE/E,MAAM,MAAM,sBAAsB,CAAC,EAAE,IAAI,KAAK,CAAC,iBAAiB,CAAC;IAC/D,SAAS,CAAC,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC;CAC3B,CAAC,CAAC;AAEH,wBAAgB,iBAAiB,CAAC,EAAE,EAAE,EACpC,QAAQ,EACR,SAAS,GACV,EAAE,sBAAsB,CAAC,EAAE,CAAC,GAAG,SAAS,CAQxC;AAED,wBAAgB,gBAAgB,CAAC,EAAE,EAAE,EAAE,SAAS,SAAS,CAAC,EAAE,CAAC,EAAE,CAAC,EAC9D,QAAQ,EAAE,CAAC,KAAK,EAAE,SAAS,CAAC,EAAE,CAAC,KAAK,CAAC,GACpC,CAAC,CAMH"}

package/dist/RoomStateProvider.js

@@ -0,0 +1,16 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { createContext, useContext } from 'react';
+import { useStore } from 'zustand';
+// See https://docs.pmnd.rs/zustand/guides/initialize-state-with-props
+export const RoomStateContext = createContext(null);
+export function RoomStateProvider({ children, roomStore, }) {
+    return (_jsx(RoomStateContext.Provider, { value: roomStore, children: children }));
+}
+export function useBaseRoomStore(selector) {
+    const store = useContext(RoomStateContext);
+    if (!store) {
+        throw new Error('Missing RoomStateProvider in the tree');
+    }
+    return useStore(store, selector);
+}
+//# sourceMappingURL=RoomStateProvider.js.map

package/dist/RoomStateProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RoomStateProvider.js","sourceRoot":"","sources":["../src/RoomStateProvider.tsx"],"names":[],"mappings":";AAAA,OAAc,EAAC,aAAa,EAAa,UAAU,EAAC,MAAM,OAAO,CAAC;AAClE,OAAO,EAAW,QAAQ,EAAC,MAAM,SAAS,CAAC;AAG3C,sEAAsE;AAEtE,MAAM,CAAC,MAAM,gBAAgB,GAAG,aAAa,CAA4B,IAAI,CAAC,CAAC;AAM/E,MAAM,UAAU,iBAAiB,CAAK,EACpC,QAAQ,EACR,SAAS,GACkB;IAC3B,OAAO,CACL,KAAC,gBAAgB,CAAC,QAAQ,IACxB,KAAK,EAAE,SAA0C,YAEhD,QAAQ,GACiB,CAC7B,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC9B,QAAqC;IAErC,MAAM,KAAK,GAAG,UAAU,CAAC,gBAAgB,CAAC,CAAC;IAC3C,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;IAC3D,CAAC;IACD,OAAO,QAAQ,CAAC,KAAgC,EAAE,QAAQ,CAAC,CAAC;AAC9D,CAAC","sourcesContent":["import React, {createContext, ReactNode, useContext} from 'react';\nimport {StoreApi, useStore} from 'zustand';\nimport {RoomState, RoomStore} from './RoomStore';\n\n// See https://docs.pmnd.rs/zustand/guides/initialize-state-with-props\n\nexport const RoomStateContext = createContext<RoomStore<unknown> | null>(null);\n\nexport type RoomStateProviderProps<PC> = React.PropsWithChildren<{\n  roomStore?: RoomStore<PC>;\n}>;\n\nexport function RoomStateProvider<PC>({\n  children,\n  roomStore,\n}: RoomStateProviderProps<PC>): ReactNode {\n  return (\n    <RoomStateContext.Provider\n      value={roomStore as unknown as RoomStore<unknown>}\n    >\n      {children}\n    </RoomStateContext.Provider>\n  );\n}\n\nexport function useBaseRoomStore<PC, PS extends RoomState<PC>, T>(\n  selector: (state: RoomState<PC>) => T,\n): T {\n  const store = useContext(RoomStateContext);\n  if (!store) {\n    throw new Error('Missing RoomStateProvider in the tree');\n  }\n  return useStore(store as unknown as StoreApi<PS>, selector);\n}\n"]}

package/dist/RoomStore.d.ts

@@ -0,0 +1,51 @@
+import { StateCreator, StoreApi } from 'zustand';
+export type RoomStore<PC> = StoreApi<RoomState<PC>>;
+export type RoomStateProps<PC> = {
+    lastSavedConfig: PC | undefined;
+    tasksProgress: Record<string, TaskProgress>;
+    captureException: (exception: unknown, captureContext?: unknown) => void;
+};
+export type TaskProgress = {
+    progress?: number | undefined;
+    message: string;
+};
+export type RoomStateActions<PC> = {
+    initialize: () => Promise<void>;
+    /**
+     * Set the room config.
+     * @param config - The room config to set.
+     */
+    setRoomConfig: (config: PC) => void;
+    /**
+     * Set the last saved room config. This can be used to check if the room has unsaved changes.
+     * @param config - The room config to set.
+     */
+    setLastSavedConfig: (config: PC) => void;
+    /**
+     * Check if the room has unsaved changes.
+     * @returns True if the room has unsaved changes, false otherwise.
+     */
+    hasUnsavedChanges(): boolean;
+    setTaskProgress: (id: string, taskProgress: TaskProgress | undefined) => void;
+    getLoadingProgress: () => TaskProgress | undefined;
+};
+export type RoomState<PC> = {
+    config: PC;
+    room: RoomStateProps<PC> & RoomStateActions<PC>;
+};
+export declare function createRoomSlice<PC>(props: {
+    config: PC;
+    room: Partial<Omit<RoomStateProps<PC>, 'config'>>;
+}): StateCreator<RoomState<PC>>;
+export declare function createBaseSlice<PC, S>(sliceCreator: (...args: Parameters<StateCreator<S & RoomState<PC>>>) => S): StateCreator<S>;
+/**
+ * Create a room store with custom fields and methods
+ * @param initialState - The initial state and config for the room
+ * @param sliceCreators - The slices to add to the room store
+ * @returns The room store and a hook for accessing the room store
+ */
+export declare function createRoomStore<PC, RS extends RoomState<PC>>(stateCreator: StateCreator<RS>): {
+    roomStore: StoreApi<RS>;
+    useRoomStore: <T>(selector: (state: RS) => T) => T;
+};
+//# sourceMappingURL=RoomStore.d.ts.map

package/dist/RoomStore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RoomStore.d.ts","sourceRoot":"","sources":["../src/RoomStore.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,YAAY,EAAE,QAAQ,EAAc,MAAM,SAAS,CAAC;AAG5D,MAAM,MAAM,SAAS,CAAC,EAAE,IAAI,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;AAEpD,MAAM,MAAM,cAAc,CAAC,EAAE,IAAI;IAC/B,eAAe,EAAE,EAAE,GAAG,SAAS,CAAC;IAChC,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAC5C,gBAAgB,EAAE,CAAC,SAAS,EAAE,OAAO,EAAE,cAAc,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;CAC1E,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,gBAAgB,CAAC,EAAE,IAAI;IACjC,UAAU,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhC;;;OAGG;IACH,aAAa,EAAE,CAAC,MAAM,EAAE,EAAE,KAAK,IAAI,CAAC;IACpC;;;OAGG;IACH,kBAAkB,EAAE,CAAC,MAAM,EAAE,EAAE,KAAK,IAAI,CAAC;IACzC;;;OAGG;IACH,iBAAiB,IAAI,OAAO,CAAC;IAE7B,eAAe,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,GAAG,SAAS,KAAK,IAAI,CAAC;IAC9E,kBAAkB,EAAE,MAAM,YAAY,GAAG,SAAS,CAAC;CACpD,CAAC;AAEF,MAAM,MAAM,SAAS,CAAC,EAAE,IAAI;IAC1B,MAAM,EAAE,EAAE,CAAC;IACX,IAAI,EAAE,cAAc,CAAC,EAAE,CAAC,GAAG,gBAAgB,CAAC,EAAE,CAAC,CAAC;CACjD,CAAC;AAEF,wBAAgB,eAAe,CAAC,EAAE,EAAE,KAAK,EAAE;IACzC,MAAM,EAAE,EAAE,CAAC;IACX,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC;CACnD,GAAG,YAAY,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAoE9B;AAED,wBAAgB,eAAe,CAAC,EAAE,EAAE,CAAC,EACnC,YAAY,EAAE,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,YAAY,CAAC,CAAC,GAAG,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,GACxE,YAAY,CAAC,CAAC,CAAC,CAOjB;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,EAAE,EAAE,EAAE,SAAS,SAAS,CAAC,EAAE,CAAC,EAC1D,YAAY,EAAE,YAAY,CAAC,EAAE,CAAC;;mBAcR,CAAC,YAAY,CAAC,KAAK,EAAE,EAAE,KAAK,CAAC,KAAG,CAAC;EAKxD"}

package/dist/RoomStore.js

@@ -0,0 +1,85 @@
+import { castDraft, produce } from 'immer';
+import { createStore } from 'zustand';
+import { useBaseRoomStore } from './RoomStateProvider';
+export function createRoomSlice(props) {
+    const { config: initialConfig, room: roomStateProps, ...restState } = props;
+    const initialRoomState = {
+        ...roomStateProps,
+        lastSavedConfig: undefined,
+        tasksProgress: {},
+        captureException: (exception) => {
+            console.error(exception);
+        },
+    };
+    const slice = (set, get) => {
+        const roomState = {
+            config: initialConfig,
+            room: {
+                ...initialRoomState,
+                initialize: async () => {
+                    // To be overridden by the room shell
+                },
+                setRoomConfig: (config) => set((state) => produce(state, (draft) => {
+                    draft.config = castDraft(config);
+                })),
+                setLastSavedConfig: (config) => set((state) => produce(state, (draft) => {
+                    draft.room.lastSavedConfig = castDraft(config);
+                })),
+                hasUnsavedChanges: () => {
+                    const { lastSavedConfig } = get().room;
+                    const { config } = get();
+                    return config !== lastSavedConfig;
+                },
+                /** Returns the progress of the last task */
+                getLoadingProgress() {
+                    const { tasksProgress } = get().room;
+                    const keys = Object.keys(tasksProgress);
+                    const lastKey = keys[keys.length - 1];
+                    if (lastKey) {
+                        return tasksProgress[lastKey];
+                    }
+                    return undefined;
+                },
+                setTaskProgress(id, taskProgress) {
+                    set((state) => produce(state, (draft) => {
+                        if (taskProgress) {
+                            draft.room.tasksProgress[id] = taskProgress;
+                        }
+                        else {
+                            delete draft.room.tasksProgress[id];
+                        }
+                    }));
+                },
+            },
+            ...restState,
+        };
+        return roomState;
+    };
+    return slice;
+}
+export function createBaseSlice(sliceCreator) {
+    return (set, get, store) => sliceCreator(set, get, store);
+}
+/**
+ * Create a room store with custom fields and methods
+ * @param initialState - The initial state and config for the room
+ * @param sliceCreators - The slices to add to the room store
+ * @returns The room store and a hook for accessing the room store
+ */
+export function createRoomStore(stateCreator) {
+    const roomStore = createStore((set, get, store) => ({
+        ...stateCreator(set, get, store),
+    }));
+    if (typeof window !== 'undefined') {
+        roomStore.getState().room.initialize();
+    }
+    else {
+        console.warn('Skipping room store initialization. Room store should be only used on client.');
+    }
+    function useRoomStore(selector) {
+        // @ts-ignore TODO fix typing
+        return useBaseRoomStore(selector);
+    }
+    return { roomStore, useRoomStore };
+}
+//# sourceMappingURL=RoomStore.js.map

package/dist/RoomStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RoomStore.js","sourceRoot":"","sources":["../src/RoomStore.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,SAAS,EAAE,OAAO,EAAC,MAAM,OAAO,CAAC;AACzC,OAAO,EAAyB,WAAW,EAAC,MAAM,SAAS,CAAC;AAC5D,OAAO,EAAC,gBAAgB,EAAC,MAAM,qBAAqB,CAAC;AA2CrD,MAAM,UAAU,eAAe,CAAK,KAGnC;IACC,MAAM,EAAC,MAAM,EAAE,aAAa,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,SAAS,EAAC,GAAG,KAAK,CAAC;IAC1E,MAAM,gBAAgB,GAAuB;QAC3C,GAAG,cAAc;QACjB,eAAe,EAAE,SAAS;QAC1B,aAAa,EAAE,EAAE;QACjB,gBAAgB,EAAE,CAAC,SAAkB,EAAE,EAAE;YACvC,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC3B,CAAC;KACF,CAAC;IACF,MAAM,KAAK,GAAgC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;QACtD,MAAM,SAAS,GAAkB;YAC/B,MAAM,EAAE,aAAa;YACrB,IAAI,EAAE;gBACJ,GAAG,gBAAgB;gBACnB,UAAU,EAAE,KAAK,IAAI,EAAE;oBACrB,qCAAqC;gBACvC,CAAC;gBAED,aAAa,EAAE,CAAC,MAAM,EAAE,EAAE,CACxB,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CACZ,OAAO,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE;oBACvB,KAAK,CAAC,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;gBACnC,CAAC,CAAC,CACH;gBACH,kBAAkB,EAAE,CAAC,MAAM,EAAE,EAAE,CAC7B,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CACZ,OAAO,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE;oBACvB,KAAK,CAAC,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;gBACjD,CAAC,CAAC,CACH;gBAEH,iBAAiB,EAAE,GAAG,EAAE;oBACtB,MAAM,EAAC,eAAe,EAAC,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC;oBACrC,MAAM,EAAC,MAAM,EAAC,GAAG,GAAG,EAAE,CAAC;oBACvB,OAAO,MAAM,KAAK,eAAe,CAAC;gBACpC,CAAC;gBAED,4CAA4C;gBAC5C,kBAAkB;oBAChB,MAAM,EAAC,aAAa,EAAC,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC;oBACnC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;oBACxC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;oBACtC,IAAI,OAAO,EAAE,CAAC;wBACZ,OAAO,aAAa,CAAC,OAAO,CAAC,CAAC;oBAChC,CAAC;oBACD,OAAO,SAAS,CAAC;gBACnB,CAAC;gBAED,eAAe,CAAC,EAAE,EAAE,YAAY;oBAC9B,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CACZ,OAAO,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE;wBACvB,IAAI,YAAY,EAAE,CAAC;4BACjB,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC;wBAC9C,CAAC;6BAAM,CAAC;4BACN,OAAO,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;wBACtC,CAAC;oBACH,CAAC,CAAC,CACH,CAAC;gBACJ,CAAC;aACF;YACD,GAAG,SAAS;SACb,CAAC;QAEF,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC;IAEF,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,UAAU,eAAe,CAC7B,YAAyE;IAEzE,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,CACzB,YAAY,CACV,GAAG,EACH,GAA8B,EAC9B,KAAoC,CACrC,CAAC;AACN,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAC7B,YAA8B;IAE9B,MAAM,SAAS,GAAG,WAAW,CAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;QACtD,GAAG,YAAY,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC;KACjC,CAAC,CAAC,CAAC;IAEJ,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE,CAAC;QAClC,SAAS,CAAC,QAAQ,EAAE,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;IACzC,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,IAAI,CACV,+EAA+E,CAChF,CAAC;IACJ,CAAC;IAED,SAAS,YAAY,CAAI,QAA0B;QACjD,6BAA6B;QAC7B,OAAO,gBAAgB,CAAC,QAA4B,CAAC,CAAC;IACxD,CAAC;IACD,OAAO,EAAC,SAAS,EAAE,YAAY,EAAC,CAAC;AACnC,CAAC","sourcesContent":["import {castDraft, produce} from 'immer';\nimport {StateCreator, StoreApi, createStore} from 'zustand';\nimport {useBaseRoomStore} from './RoomStateProvider';\n\nexport type RoomStore<PC> = StoreApi<RoomState<PC>>;\n\nexport type RoomStateProps<PC> = {\n  lastSavedConfig: PC | undefined;\n  tasksProgress: Record<string, TaskProgress>;\n  captureException: (exception: unknown, captureContext?: unknown) => void;\n};\n\nexport type TaskProgress = {\n  progress?: number | undefined;\n  message: string;\n};\n\nexport type RoomStateActions<PC> = {\n  initialize: () => Promise<void>;\n\n  /**\n   * Set the room config.\n   * @param config - The room config to set.\n   */\n  setRoomConfig: (config: PC) => void;\n  /**\n   * Set the last saved room config. This can be used to check if the room has unsaved changes.\n   * @param config - The room config to set.\n   */\n  setLastSavedConfig: (config: PC) => void;\n  /**\n   * Check if the room has unsaved changes.\n   * @returns True if the room has unsaved changes, false otherwise.\n   */\n  hasUnsavedChanges(): boolean; // since last save\n\n  setTaskProgress: (id: string, taskProgress: TaskProgress | undefined) => void;\n  getLoadingProgress: () => TaskProgress | undefined;\n};\n\nexport type RoomState<PC> = {\n  config: PC;\n  room: RoomStateProps<PC> & RoomStateActions<PC>;\n};\n\nexport function createRoomSlice<PC>(props: {\n  config: PC;\n  room: Partial<Omit<RoomStateProps<PC>, 'config'>>;\n}): StateCreator<RoomState<PC>> {\n  const {config: initialConfig, room: roomStateProps, ...restState} = props;\n  const initialRoomState: RoomStateProps<PC> = {\n    ...roomStateProps,\n    lastSavedConfig: undefined,\n    tasksProgress: {},\n    captureException: (exception: unknown) => {\n      console.error(exception);\n    },\n  };\n  const slice: StateCreator<RoomState<PC>> = (set, get) => {\n    const roomState: RoomState<PC> = {\n      config: initialConfig,\n      room: {\n        ...initialRoomState,\n        initialize: async () => {\n          // To be overridden by the room shell\n        },\n\n        setRoomConfig: (config) =>\n          set((state) =>\n            produce(state, (draft) => {\n              draft.config = castDraft(config);\n            }),\n          ),\n        setLastSavedConfig: (config) =>\n          set((state) =>\n            produce(state, (draft) => {\n              draft.room.lastSavedConfig = castDraft(config);\n            }),\n          ),\n\n        hasUnsavedChanges: () => {\n          const {lastSavedConfig} = get().room;\n          const {config} = get();\n          return config !== lastSavedConfig;\n        },\n\n        /** Returns the progress of the last task */\n        getLoadingProgress() {\n          const {tasksProgress} = get().room;\n          const keys = Object.keys(tasksProgress);\n          const lastKey = keys[keys.length - 1];\n          if (lastKey) {\n            return tasksProgress[lastKey];\n          }\n          return undefined;\n        },\n\n        setTaskProgress(id, taskProgress) {\n          set((state) =>\n            produce(state, (draft) => {\n              if (taskProgress) {\n                draft.room.tasksProgress[id] = taskProgress;\n              } else {\n                delete draft.room.tasksProgress[id];\n              }\n            }),\n          );\n        },\n      },\n      ...restState,\n    };\n\n    return roomState;\n  };\n\n  return slice;\n}\n\nexport function createBaseSlice<PC, S>(\n  sliceCreator: (...args: Parameters<StateCreator<S & RoomState<PC>>>) => S,\n): StateCreator<S> {\n  return (set, get, store) =>\n    sliceCreator(\n      set,\n      get as () => S & RoomState<PC>,\n      store as StoreApi<S & RoomState<PC>>,\n    );\n}\n\n/**\n * Create a room store with custom fields and methods\n * @param initialState - The initial state and config for the room\n * @param sliceCreators - The slices to add to the room store\n * @returns The room store and a hook for accessing the room store\n */\nexport function createRoomStore<PC, RS extends RoomState<PC>>(\n  stateCreator: StateCreator<RS>,\n) {\n  const roomStore = createStore<RS>((set, get, store) => ({\n    ...stateCreator(set, get, store),\n  }));\n\n  if (typeof window !== 'undefined') {\n    roomStore.getState().room.initialize();\n  } else {\n    console.warn(\n      'Skipping room store initialization. Room store should be only used on client.',\n    );\n  }\n\n  function useRoomStore<T>(selector: (state: RS) => T): T {\n    // @ts-ignore TODO fix typing\n    return useBaseRoomStore(selector as (state: RS) => T);\n  }\n  return {roomStore, useRoomStore};\n}\n"]}

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * {@include ../README.md}
+ * @packageDocumentation
+ */
+export { RoomStateContext, RoomStateProvider, useBaseRoomStore, type RoomStateProviderProps, } from './RoomStateProvider';
+export { createRoomStore, createRoomSlice, type RoomStateActions, type RoomStateProps, type RoomState, type RoomStore, type TaskProgress, createBaseSlice, } from './RoomStore';
+export * from '@sqlrooms/room-config';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,KAAK,sBAAsB,GAC5B,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EACL,eAAe,EACf,eAAe,EACf,KAAK,gBAAgB,EACrB,KAAK,cAAc,EACnB,KAAK,SAAS,EACd,KAAK,SAAS,EACd,KAAK,YAAY,EACjB,eAAe,GAChB,MAAM,aAAa,CAAC;AAErB,cAAc,uBAAuB,CAAC"}

package/dist/index.js

@@ -0,0 +1,8 @@
+/**
+ * {@include ../README.md}
+ * @packageDocumentation
+ */
+export { RoomStateContext, RoomStateProvider, useBaseRoomStore, } from './RoomStateProvider';
+export { createRoomStore, createRoomSlice, createBaseSlice, } from './RoomStore';
+export * from '@sqlrooms/room-config';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,GAEjB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EACL,eAAe,EACf,eAAe,EAMf,eAAe,GAChB,MAAM,aAAa,CAAC;AAErB,cAAc,uBAAuB,CAAC","sourcesContent":["/**\n * {@include ../README.md}\n * @packageDocumentation\n */\n\nexport {\n  RoomStateContext,\n  RoomStateProvider,\n  useBaseRoomStore,\n  type RoomStateProviderProps,\n} from './RoomStateProvider';\n\nexport {\n  createRoomStore,\n  createRoomSlice,\n  type RoomStateActions,\n  type RoomStateProps,\n  type RoomState,\n  type RoomStore,\n  type TaskProgress,\n  createBaseSlice,\n} from './RoomStore';\n\nexport * from '@sqlrooms/room-config';\n"]}

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@sqlrooms/room-store",
+  "version": "0.19.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "module": "dist/index.js",
+  "type": "module",
+  "author": "Ilya Boyandin <ilya@boyandin.me>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/sqlrooms/sqlrooms.git"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@sqlrooms/room-config": "0.19.0",
+    "immer": "^10.1.1",
+    "zod": "^3.25.57",
+    "zustand": "^5.0.5"
+  },
+  "peerDependencies": {
+    "react": ">=18"
+  },
+  "scripts": {
+    "dev": "tsc -w",
+    "build": "tsc",
+    "lint": "eslint .",
+    "typecheck": "tsc --noEmit",
+    "typedoc": "typedoc"
+  },
+  "gitHead": "ba6000f1e06d3ab01e309d805b5d187b32c9ff06"
+}