fusee-framework 1.6.0 → 1.8.0

package/framework/types/store.d.ts

@@ -1,8 +1,66 @@
-export function defineStore<T>(id: string, setup: () => T): () => T;
-export function resetStore(id: string): void;
-export function clearStores(): void;
-export function registerStorePlugin(plugin: (store: any, id: string) => void): void;
-
-declare global {
-    function defineStore<T>(id: string, setup: () => T): () => T;
-}
+export type MutationType = 'direct' | 'patch object' | 'patch function';
+
+export const MutationType: {
+    readonly DIRECT: 'direct';
+    readonly PATCH_OBJECT: 'patch object';
+    readonly PATCH_FUNCTION: 'patch function';
+};
+
+export interface StoreMutation {
+    type: MutationType;
+    storeId: string;
+    payload?: Record<string, any>;
+}
+
+export interface SubscribeOptions {
+    flush?: 'pre' | 'post' | 'sync';
+    detached?: boolean;
+}
+
+export type SubscribeCallback = (mutation: StoreMutation, state: any) => void;
+export type UnsubscribeFunction = () => void;
+
+export interface Store<T> {
+    readonly id: string;
+    readonly type: 'store';
+    patch(partial: Partial<{ [K in keyof T]: T[K] extends (...args: any[]) => any ? ReturnType<T[K]> : T[K] }> | ((state: T) => void)): void;
+    subscribe(callback: SubscribeCallback, options?: SubscribeOptions): UnsubscribeFunction;
+}
+
+export type StoreHook<T> = (() => T & Store<T>) & { $id: string };
+
+export function defineStore<T>(id: string, setup: () => T): StoreHook<T>;
+export function resetStore(id: string): void;
+export function clearStores(): void;
+export function registerStorePlugin(plugin: (store: any, id: string) => void): void;
+export function useNestedStore<T>(useStoreFn: StoreHook<T>): T & Store<T>;
+
+export type StoreToRefs<T> = {
+    [K in keyof T]: T[K] extends (...args: any[]) => infer R ? import('./signal').SignalAccessor<R> : never
+}
+
+export type StoreToState<T> = {
+    [K in keyof T]: T[K] extends (...args: any[]) => infer R
+        ? import('./signal').SignalAccessor<R> extends { readonly: true }
+            ? never
+            : import('./signal').SignalAccessor<R>
+        : never
+}
+
+export type StoreToGetters<T> = {
+    [K in keyof T]: T[K] extends (...args: any[]) => infer R
+        ? import('./signal').SignalAccessor<R> extends { readonly: true }
+            ? import('./signal').SignalAccessor<R>
+            : never
+        : never
+}
+
+export function storeToRefs<T>(store: T & Store<T>): StoreToRefs<T>;
+export function storeToState<T>(store: T & Store<T>): StoreToState<T>;
+export function storeToGetters<T>(store: T & Store<T>): StoreToGetters<T>;
+
+declare global {
+    function defineStore<T>(id: string, setup: () => T): import('./store').StoreHook<T>;
+    function useNestedStore<T>(useStoreFn: import('./store').StoreHook<T>): T & Store<T>;
+    type MutationType = import('./store').MutationType;
+}