react-shared-states 1.0.8 → 1.0.12

package/dist/hooks/use-shared-subscription.d.ts

@@ -1,24 +1,52 @@
-import { PotentialPromise, Prefix, SharedCreated } from '../types';
-import { SharedApi } from '../SharedData';
-type Unsubscribe = () => void;
+import { PotentialPromise, Prefix, SharedCreated, SharedValue } from '../types';
+import { SharedValuesApi, SharedValuesManager } from '../SharedValuesManager';
+export type Unsubscribe = () => void;
 export declare namespace SubscriberEvents {
     type OnError = (error: unknown) => void;
     type OnCompletion = () => void;
     type Set<T> = (value: T) => void;
 }
-type Subscriber<T> = (set: SubscriberEvents.Set<T>, onError: SubscriberEvents.OnError, onCompletion: SubscriberEvents.OnCompletion) => PotentialPromise<Unsubscribe | void | undefined>;
-type SharedSubscriptionsState<T> = {
-    fnState: {
-        data?: T;
-        isLoading: boolean;
-        error?: unknown;
-        subscribed: boolean;
-    };
-    unsubscribe?: Unsubscribe | void;
+export type Subscriber<T> = (set: SubscriberEvents.Set<T>, onError: SubscriberEvents.OnError, onCompletion: SubscriberEvents.OnCompletion) => PotentialPromise<Unsubscribe | void | undefined>;
+type SharedSubscriptionValue<T> = {
+    data?: T;
+    isLoading: boolean;
+    error?: unknown;
+    subscribed?: boolean;
 };
-export declare class SharedSubscriptionsApi extends SharedApi<SharedSubscriptionsState<unknown>> {
-    get<T, S extends string = string>(key: S, scopeName?: Prefix): T;
-    set<T, S extends string = string>(key: S, fnState: SharedSubscriptionsState<T>, scopeName?: Prefix): void;
+interface SharedSubscription<T> extends SharedValue {
+    fnState: SharedSubscriptionValue<T>;
+    unsubscribe?: Unsubscribe | void;
+}
+declare class SharedSubscriptionsManager extends SharedValuesManager<SharedSubscription<unknown>, {
+    fnState: SharedSubscriptionValue<unknown>;
+}> {
+    defaultValue(): {
+        fnState: {
+            data: undefined;
+            isLoading: boolean;
+            error: undefined;
+            subscribed: boolean;
+        };
+    };
+    initValue(key: string, prefix: Prefix, isStatic?: boolean): void;
+    setValue<T>(key: string, prefix: Prefix, data: {
+        fnState: SharedSubscriptionValue<T>;
+    }): void;
+    useEffect(key: string, prefix: Prefix): void;
+    unsubscribe(key: string, prefix: Prefix): Promise<void>;
+}
+export declare class SharedSubscriptionsApi extends SharedValuesApi<SharedSubscription<unknown>, {
+    fnState: SharedSubscriptionValue<unknown>;
+}, SharedSubscriptionValue<unknown>> {
+    constructor(sharedSubscriptionsManager: SharedSubscriptionsManager);
+    get<T, S extends string = string>(key: S, scopeName?: Prefix): SharedSubscriptionValue<T>;
+    get<T>(sharedSubscriptionCreated: SharedSubscriptionCreated<T>): SharedSubscriptionValue<T>;
+    set<T, S extends string = string>(key: S, value: {
+        fnState: SharedSubscriptionValue<T>;
+    }, scopeName?: Prefix): void;
+    set<T>(sharedSubscriptionCreated: SharedSubscriptionCreated<T>, value: {
+        fnState: SharedSubscriptionValue<T>;
+    }): void;
 }
 export declare const sharedSubscriptionsApi: SharedSubscriptionsApi;
 interface SharedSubscriptionCreated<T> extends SharedCreated {
@@ -26,7 +54,7 @@ interface SharedSubscriptionCreated<T> extends SharedCreated {
 }
 export declare const createSharedSubscription: <T, Args extends unknown[]>(subscriber: Subscriber<T>, scopeName?: Prefix) => SharedSubscriptionCreated<T>;
 export type SharedSubscriptionStateReturn<T> = {
-    readonly state: NonNullable<SharedSubscriptionsState<T>['fnState']>;
+    readonly state: NonNullable<SharedSubscriptionValue<T>>;
     readonly trigger: () => void;
     readonly forceTrigger: () => void;
     readonly unsubscribe: () => void;