@biglogic/rgs 3.9.7 → 3.9.8
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.
- package/core/ssr.d.ts +73 -0
- package/core/thunk.d.ts +75 -0
- package/index.cjs +595 -338
- package/index.d.ts +4 -0
- package/index.js +602 -350
- package/package.json +1 -1
package/core/ssr.d.ts
ADDED
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
import type { IStore, StoreConfig } from "./types";
|
|
2
|
+
export declare const isServerSide: () => boolean;
|
|
3
|
+
export declare const isClientSide: () => boolean;
|
|
4
|
+
export interface SSRStoreConfig<S extends Record<string, unknown>> extends StoreConfig<S> {
|
|
5
|
+
deferHydration?: boolean;
|
|
6
|
+
initialState?: S;
|
|
7
|
+
ssrSafe?: boolean;
|
|
8
|
+
}
|
|
9
|
+
export declare const createSSRStore: <S extends Record<string, unknown>>(config?: SSRStoreConfig<S>) => IStore<S> & {
|
|
10
|
+
hydrate: () => Promise<void>;
|
|
11
|
+
getSerializedState: () => string | null;
|
|
12
|
+
isHydrated: () => boolean;
|
|
13
|
+
};
|
|
14
|
+
export declare const hydrateOnClient: (store: IStore<Record<string, unknown>>) => Promise<void>;
|
|
15
|
+
export declare const dehydrateStore: (store: IStore<Record<string, unknown>>) => string;
|
|
16
|
+
export declare const rehydrateStore: (store: IStore<Record<string, unknown>>, serializedState: string) => void;
|
|
17
|
+
export declare const useHydrated: () => boolean;
|
|
18
|
+
export declare const useHydrationStatus: () => {
|
|
19
|
+
isHydrated: boolean;
|
|
20
|
+
isHydrating: boolean;
|
|
21
|
+
};
|
|
22
|
+
export declare const useDeferredStore: <S extends Record<string, unknown>>(store: IStore<S> & {
|
|
23
|
+
isHydrated?: () => boolean;
|
|
24
|
+
}) => IStore<S>;
|
|
25
|
+
export declare const createNextStore: <S extends Record<string, unknown>>(config?: SSRStoreConfig<S>) => IStore<S> & {
|
|
26
|
+
hydrate: () => Promise<void>;
|
|
27
|
+
getSerializedState: () => string | null;
|
|
28
|
+
isHydrated: () => boolean;
|
|
29
|
+
} & {
|
|
30
|
+
useHydrated: () => boolean;
|
|
31
|
+
useHydrationStatus: () => {
|
|
32
|
+
isHydrated: boolean;
|
|
33
|
+
isHydrating: boolean;
|
|
34
|
+
};
|
|
35
|
+
useDeferredStore: <K extends keyof S>(key: K) => unknown;
|
|
36
|
+
};
|
|
37
|
+
export declare const getSSRInitialState: (store: IStore<Record<string, unknown>>) => Record<string, unknown>;
|
|
38
|
+
export declare const initializeFromSSR: (store: IStore<Record<string, unknown>>, initialState: Record<string, unknown>) => void;
|
|
39
|
+
declare const _default: {
|
|
40
|
+
isServerSide: () => boolean;
|
|
41
|
+
isClientSide: () => boolean;
|
|
42
|
+
createSSRStore: <S extends Record<string, unknown>>(config?: SSRStoreConfig<S>) => IStore<S> & {
|
|
43
|
+
hydrate: () => Promise<void>;
|
|
44
|
+
getSerializedState: () => string | null;
|
|
45
|
+
isHydrated: () => boolean;
|
|
46
|
+
};
|
|
47
|
+
hydrateOnClient: (store: IStore<Record<string, unknown>>) => Promise<void>;
|
|
48
|
+
dehydrateStore: (store: IStore<Record<string, unknown>>) => string;
|
|
49
|
+
rehydrateStore: (store: IStore<Record<string, unknown>>, serializedState: string) => void;
|
|
50
|
+
useHydrated: () => boolean;
|
|
51
|
+
useHydrationStatus: () => {
|
|
52
|
+
isHydrated: boolean;
|
|
53
|
+
isHydrating: boolean;
|
|
54
|
+
};
|
|
55
|
+
useDeferredStore: <S extends Record<string, unknown>>(store: IStore<S> & {
|
|
56
|
+
isHydrated?: () => boolean;
|
|
57
|
+
}) => IStore<S>;
|
|
58
|
+
createNextStore: <S extends Record<string, unknown>>(config?: SSRStoreConfig<S>) => IStore<S> & {
|
|
59
|
+
hydrate: () => Promise<void>;
|
|
60
|
+
getSerializedState: () => string | null;
|
|
61
|
+
isHydrated: () => boolean;
|
|
62
|
+
} & {
|
|
63
|
+
useHydrated: () => boolean;
|
|
64
|
+
useHydrationStatus: () => {
|
|
65
|
+
isHydrated: boolean;
|
|
66
|
+
isHydrating: boolean;
|
|
67
|
+
};
|
|
68
|
+
useDeferredStore: <K extends keyof S>(key: K) => unknown;
|
|
69
|
+
};
|
|
70
|
+
getSSRInitialState: (store: IStore<Record<string, unknown>>) => Record<string, unknown>;
|
|
71
|
+
initializeFromSSR: (store: IStore<Record<string, unknown>>, initialState: Record<string, unknown>) => void;
|
|
72
|
+
};
|
|
73
|
+
export default _default;
|
package/core/thunk.d.ts
ADDED
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
import type { IStore } from "./types";
|
|
2
|
+
export type ThunkAction<R = void, S extends Record<string, unknown> = Record<string, unknown>> = (dispatch: ThunkDispatch<S>, getState: () => S, extraArgument?: unknown) => Promise<R> | R;
|
|
3
|
+
export type ThunkDispatch<S extends Record<string, unknown> = Record<string, unknown>> = <R>(action: ThunkAction<R, S> | ThunkActionPayload<S>) => Promise<R>;
|
|
4
|
+
export interface ThunkActionPayload<_S extends Record<string, unknown> = Record<string, unknown>> {
|
|
5
|
+
type: string;
|
|
6
|
+
payload?: unknown;
|
|
7
|
+
meta?: Record<string, unknown>;
|
|
8
|
+
}
|
|
9
|
+
export interface ThunkMiddlewareConfig {
|
|
10
|
+
extraArgument?: unknown;
|
|
11
|
+
dispatchKey?: string;
|
|
12
|
+
}
|
|
13
|
+
export declare const createThunkStore: <S extends Record<string, unknown>>(store: IStore<S>, config?: ThunkMiddlewareConfig) => IStore<S> & {
|
|
14
|
+
dispatch: ThunkDispatch<S>;
|
|
15
|
+
};
|
|
16
|
+
export declare const createActions: <S extends Record<string, unknown>, T extends Record<string, unknown>>(store: IStore<S>, creators: T) => T & {
|
|
17
|
+
dispatch: ThunkDispatch<S>;
|
|
18
|
+
};
|
|
19
|
+
export declare const createAsyncAction: <T>(key: string, fetcher: () => Promise<T>) => ThunkAction<T, Record<string, {
|
|
20
|
+
data: T | null;
|
|
21
|
+
loading: boolean;
|
|
22
|
+
error: Error | null;
|
|
23
|
+
}>>;
|
|
24
|
+
export declare const createAsyncActions: <S extends Record<string, unknown>>(store: IStore<S>, actions: Record<string, () => Promise<unknown>>) => Record<string, ThunkAction<unknown, S>>;
|
|
25
|
+
export type Effect = {
|
|
26
|
+
type: 'call';
|
|
27
|
+
fn: () => Promise<unknown>;
|
|
28
|
+
args?: unknown[];
|
|
29
|
+
} | {
|
|
30
|
+
type: 'put';
|
|
31
|
+
action: ThunkActionPayload<Record<string, unknown>>;
|
|
32
|
+
} | {
|
|
33
|
+
type: 'select';
|
|
34
|
+
selector: (state: Record<string, unknown>) => unknown;
|
|
35
|
+
} | {
|
|
36
|
+
type: 'take';
|
|
37
|
+
pattern: string | ((action: ThunkActionPayload) => boolean);
|
|
38
|
+
} | {
|
|
39
|
+
type: 'all';
|
|
40
|
+
effects: Effect[];
|
|
41
|
+
} | {
|
|
42
|
+
type: 'race';
|
|
43
|
+
effects: Record<string, Effect>;
|
|
44
|
+
};
|
|
45
|
+
export declare const call: (fn: () => Promise<unknown>, ...args: unknown[]) => Effect;
|
|
46
|
+
export declare const put: (action: ThunkActionPayload<Record<string, unknown>>) => Effect;
|
|
47
|
+
export declare const select: (selector: (state: Record<string, unknown>) => unknown) => Effect;
|
|
48
|
+
export declare const take: (pattern: string | ((action: ThunkActionPayload) => boolean)) => Effect;
|
|
49
|
+
export declare const all: (effects: Effect[]) => Effect;
|
|
50
|
+
export declare const race: (effects: Record<string, Effect>) => Effect;
|
|
51
|
+
export declare const createSaga: <S extends Record<string, unknown>>(generator: Generator<Effect, void, unknown>) => ((dispatch: ThunkDispatch<S>, getState: () => S, extraArgument?: unknown) => Promise<void>);
|
|
52
|
+
export declare const runSaga: <S extends Record<string, unknown>>(store: IStore<S>, saga: ThunkAction<void, S>) => (() => void);
|
|
53
|
+
declare const _default: {
|
|
54
|
+
createThunkStore: <S extends Record<string, unknown>>(store: IStore<S>, config?: ThunkMiddlewareConfig) => IStore<S> & {
|
|
55
|
+
dispatch: ThunkDispatch<S>;
|
|
56
|
+
};
|
|
57
|
+
createActions: <S extends Record<string, unknown>, T extends Record<string, unknown>>(store: IStore<S>, creators: T) => T & {
|
|
58
|
+
dispatch: ThunkDispatch<S>;
|
|
59
|
+
};
|
|
60
|
+
createAsyncAction: <T>(key: string, fetcher: () => Promise<T>) => ThunkAction<T, Record<string, {
|
|
61
|
+
data: T | null;
|
|
62
|
+
loading: boolean;
|
|
63
|
+
error: Error | null;
|
|
64
|
+
}>>;
|
|
65
|
+
createAsyncActions: <S extends Record<string, unknown>>(store: IStore<S>, actions: Record<string, () => Promise<unknown>>) => Record<string, ThunkAction<unknown, S>>;
|
|
66
|
+
call: (fn: () => Promise<unknown>, ...args: unknown[]) => Effect;
|
|
67
|
+
put: (action: ThunkActionPayload<Record<string, unknown>>) => Effect;
|
|
68
|
+
select: (selector: (state: Record<string, unknown>) => unknown) => Effect;
|
|
69
|
+
take: (pattern: string | ((action: ThunkActionPayload) => boolean)) => Effect;
|
|
70
|
+
all: (effects: Effect[]) => Effect;
|
|
71
|
+
race: (effects: Record<string, Effect>) => Effect;
|
|
72
|
+
createSaga: <S extends Record<string, unknown>>(generator: Generator<Effect, void, unknown>) => ((dispatch: ThunkDispatch<S>, getState: () => S, extraArgument?: unknown) => Promise<void>);
|
|
73
|
+
runSaga: <S extends Record<string, unknown>>(store: IStore<S>, saga: ThunkAction<void, S>) => (() => void);
|
|
74
|
+
};
|
|
75
|
+
export default _default;
|