@luzmo/analytics-components-kit 1.0.5-beta.1 → 1.0.5-beta.3

package/react/utils/store/index.d.ts

@@ -1,135 +0,0 @@
-/**
- * State Store
- *
- * State management utilities for item and dashboard state
- * with undo/redo support and real-time collaboration capabilities.
- *
- * @module store
- *
- * @example
- * ```typescript
- * // Standalone item with undo/redo
- * import { createItemStore } from '../../utils/store';
- *
- * const itemStore = createItemStore({
- *   type: 'bar-chart',
- *   slots: [{ name: 'measure', content: [...] }],
- *   options: { display: { title: true } }
- * });
- *
- * itemStore.subscribe((state) => {
- *   // Update UI with new state
- * });
- *
- * itemStore.updateOption('display.title', false);
- * itemStore.undo(); // Restores title to true
- * ```
- *
- * @example
- * ```typescript
- * // Using the store registry
- * import {
- *   registerItemStore,
- *   getStore
- * } from '../../utils/store';
- *
- * // Create and register stores
- * const store = registerItemStore({ type: 'bar-chart' });
- *
- * // Use store ID in components
- * element.storeId = store.id;
- *
- * // Retrieve store by ID anywhere in the app
- * const sameStore = getStore(store.id);
- * ```
- *
- * @example
- * ```typescript
- * // Dashboard with real-time collaboration
- * import { createDashboardStore } from '../../utils/store';
- *
- * const dashboardStore = createDashboardStore(dashboardConfig);
- *
- * // Sync with other peers
- * dashboardStore.subscribeLocalUpdates((updates) => {
- *   websocket.send(updates);
- * });
- *
- * websocket.onmessage = (msg) => {
- *   dashboardStore.importUpdates(msg.data);
- * };
- * ```
- */
-import type { ItemState, ItemStoreConfig, ItemStore, DashboardState, DashboardStoreConfig, DashboardStore } from './types';
-/**
- * Promise that resolves immediately.
- * Kept for API compatibility - yjs is pure JavaScript and doesn't require WASM initialization.
- *
- * @example
- * ```typescript
- * import { ready, createItemStore } from '../../utils/store';
- *
- * await ready;
- * const store = createItemStore({ type: 'bar-chart' });
- * ```
- */
-export declare const ready: Promise<void>;
-/**
- * Execute a callback when the DOM is ready.
- * Handles the ES module timing issue where DOMContentLoaded may have already fired.
- *
- * @param callback Function to execute when DOM is ready
- *
- * @example
- * ```typescript
- * import { onReady, createItemStore } from '../../utils/store';
- *
- * onReady(() => {
- *   const store = createItemStore({ type: 'bar-chart' });
- *   initializeApp(store);
- * });
- * ```
- */
-export declare function onReady(callback: () => void): void;
-export { createItemStore } from './item-store';
-export { createDashboardStore } from './dashboard-store';
-/**
- * Create an item store.
- * This async version is kept for API compatibility.
- * Since yjs is pure JavaScript, no async initialization is needed.
- *
- * @param initialState Initial item state (optional)
- * @param config Store configuration (optional)
- * @param storeId Optional store ID (auto-generated UUID if not provided)
- * @returns Promise resolving to ItemStore instance
- *
- * @example
- * ```typescript
- * const store = await createItemStoreAsync({
- *   type: 'bar-chart',
- *   options: { display: { title: true } }
- * });
- * ```
- */
-export declare function createItemStoreAsync(initialState?: Partial<ItemState>, config?: ItemStoreConfig, storeId?: string): Promise<ItemStore>;
-/**
- * Create a dashboard store.
- * This async version is kept for API compatibility.
- * Since yjs is pure JavaScript, no async initialization is needed.
- *
- * @param initialState Initial dashboard state (optional)
- * @param config Store configuration (optional)
- * @param storeId Optional store ID (auto-generated UUID if not provided)
- * @returns Promise resolving to DashboardStore instance
- *
- * @example
- * ```typescript
- * const store = await createDashboardStoreAsync({
- *   version: '1.0.0',
- *   views: [{ screenModus: 'desktop', options: {}, filters: [], items: [] }]
- * });
- * ```
- */
-export declare function createDashboardStoreAsync(initialState?: Partial<DashboardState>, config?: DashboardStoreConfig, storeId?: string): Promise<DashboardStore>;
-export { getStore, getItemStore, getDashboardStore, hasStore, getStoreIds, registerStore, registerItemStore, registerDashboardStore, removeStore, destroyStore, clearRegistry } from './store-registry';
-export type { BaseStoreConfig, DashboardStoreConfig, ItemStoreConfig, ItemState, Slot, SlotContent, DashboardItemState, DashboardParameter, DashboardState, FilterConfig, ItemPosition, ScreenMode, TimezoneConfig, ViewOptions, ViewState, BaseStore, DashboardStore, ItemStore, ChangeSubscriber, LocalUpdatesSubscriber, StateSubscriber, SubscribeOptions, Unsubscribe } from './types';

package/react/utils/store/store-registry.d.ts

@@ -1,170 +0,0 @@
-/**
- * Store Registry
- *
- * A global registry for stores that allows components to reference stores
- * by ID.
- *
- * @module store-registry
- *
- * @example
- * ```typescript
- * import {
- *   registerItemStore,
- *   getStore
- * } from '../../utils/store';
- *
- * // Create and register a store (auto-registers with its ID)
- * const store = registerItemStore({ type: 'bar-chart' });
- * const storeId = store.id; // Use this in component props
- *
- * // Later, retrieve the store by ID
- * const sameStore = getStore(storeId);
- * ```
- */
-import type { BaseStore, DashboardState, DashboardStore, DashboardStoreConfig, ItemState, ItemStore, ItemStoreConfig } from './types';
-/**
- * Get a store by its ID
- *
- * @param storeId The unique store identifier
- * @returns The store instance, or undefined if not found
- *
- * @example
- * ```typescript
- * const store = getStore('my-store-id');
- * if (store) {
- *   const state = store.getState();
- * }
- * ```
- */
-export declare function getStore<T = unknown>(storeId: string): BaseStore<T> | undefined;
-/**
- * Get an item store by its ID
- *
- * @param storeId The unique store identifier
- * @returns The item store instance, or undefined if not found
- */
-export declare function getItemStore(storeId: string): ItemStore | undefined;
-/**
- * Get a dashboard store by its ID
- *
- * @param storeId The unique store identifier
- * @returns The dashboard store instance, or undefined if not found
- */
-export declare function getDashboardStore(storeId: string): DashboardStore | undefined;
-/**
- * Check if a store exists in the registry
- *
- * @param storeId The store ID to check
- * @returns true if the store exists
- */
-export declare function hasStore(storeId: string): boolean;
-/**
- * Get all registered store IDs
- *
- * @returns Array of all registered store IDs
- */
-export declare function getStoreIds(): string[];
-/**
- * Register an existing store in the registry
- *
- * @param store The store instance to register
- * @returns The store instance (for chaining)
- * @throws Error if a store with the same ID already exists
- *
- * @example
- * ```typescript
- * const store = createItemStore({ type: 'bar-chart' });
- * registerStore(store);
- * // Now accessible via getStore(store.id)
- * ```
- */
-export declare function registerStore<T extends BaseStore<unknown>>(store: T): T;
-/**
- * Create and register a new item store
- *
- * @param initialState Initial item state (optional)
- * @param config Store configuration (optional)
- * @param storeId Optional custom store ID (auto-generated if not provided)
- * @returns The registered ItemStore instance
- *
- * @example
- * ```typescript
- * // Create stores
- * const store1 = registerItemStore({ type: 'bar-chart' });
- * const store2 = registerItemStore({ type: 'line-chart' });
- *
- * // Use store IDs in components
- * element.storeId = store1.id;
- * ```
- */
-export declare function registerItemStore(initialState?: Partial<ItemState>, config?: ItemStoreConfig, storeId?: string): ItemStore;
-/**
- * Create and register a new dashboard store
- *
- * @param initialState Initial dashboard state (optional)
- * @param config Store configuration (optional)
- * @param storeId Optional custom store ID (auto-generated if not provided)
- * @returns The registered DashboardStore instance
- *
- * @example
- * ```typescript
- * // Create dashboard store
- * const dashboardStore = registerDashboardStore({
- *   views: [{ screenModus: 'desktop', options: {}, filters: [], items: [] }]
- * });
- *
- * // Use in components
- * dashboardElement.storeId = dashboardStore.id;
- * ```
- */
-export declare function registerDashboardStore(initialState?: Partial<DashboardState>, config?: DashboardStoreConfig, storeId?: string): DashboardStore;
-/**
- * Remove a store from the registry
- *
- * Note: This does NOT destroy the store, only removes it from the registry.
- * Call store.destroy() separately if you want to clean up the store.
- *
- * @param storeId The store ID to remove
- * @returns true if the store was removed, false if it wasn't in the registry
- *
- * @example
- * ```typescript
- * const store = getStore(storeId);
- * if (store) {
- *   removeStore(storeId);
- *   store.destroy(); // Clean up the store
- * }
- * ```
- */
-export declare function removeStore(storeId: string): boolean;
-/**
- * Remove and destroy a store
- *
- * Removes the store from the registry and calls destroy() on it.
- *
- * @param storeId The store ID to remove and destroy
- * @returns true if the store was found and destroyed
- *
- * @example
- * ```typescript
- * destroyStore('my-store-id');
- * ```
- */
-export declare function destroyStore(storeId: string): boolean;
-/**
- * Clear all stores from the registry
- *
- * Optionally destroys all stores before clearing.
- *
- * @param destroy If true, calls destroy() on each store before clearing
- *
- * @example
- * ```typescript
- * // Just clear the registry
- * clearRegistry();
- *
- * // Clear and destroy all stores
- * clearRegistry(true);
- * ```
- */
-export declare function clearRegistry(destroy?: boolean): void;