@blac/core 2.0.0-rc-2 → 2.0.0-rc-3

package/dist/index.d.ts

@@ -1,12 +1,11 @@
 /**
  * Main Blac class that manages the state management system.
  * Implements a singleton pattern to ensure only one instance exists.
- * Handles bloc lifecycle, plugin management, and instance tracking.
+ * Handles bloc lifecycle, and instance tracking.
  *
  * Key responsibilities:
  * - Managing bloc instances (creation, disposal, lookup)
  * - Handling isolated and non-isolated blocs
- * - Managing plugins and lifecycle events
  * - Providing logging and debugging capabilities
  */
 export declare class Blac {
@@ -17,12 +16,10 @@ export declare class Blac {
     static getAllBlocs: <B extends BlocConstructor<unknown>>(blocClass: B, options?: {
         searchIsolated?: boolean;
     }) => InstanceType<B>[];
-    static addPlugin: (plugin: BlacPlugin) => void;
     /** Map storing all registered bloc instances by their class name and ID */
     blocInstanceMap: Map<string, BlocBase<any>>;
     /** Map storing isolated bloc instances grouped by their constructor */
     isolatedBlocMap: Map<BlocConstructor<any>, BlocBase<any>[]>;
-    pluginList: BlacPlugin[];
     /** Flag to control whether changes should be posted to document */
     postChangesToDocument: boolean;
     /**
@@ -65,31 +62,6 @@ export declare class Blac {
      */
     resetInstance: () => void;
     static resetInstance: () => void;
-    /**
-     * Adds a plugin to the Blac instance
-     * @param plugin - The plugin to add
-     */
-    addPlugin: (plugin: BlacPlugin) => void;
-    /**
-     * Dispatches a lifecycle event to all registered plugins
-     * @param event - The lifecycle event to dispatch
-     * @param bloc - The bloc instance involved in the event
-     * @param params - Additional parameters for the event
-     */
-    dispatchEventToPlugins: (event: BlacLifecycleEvent, bloc: BlocBase<any>, params?: unknown) => void;
-    /**
-     * Dispatches a lifecycle event and handles related cleanup actions.
-     * This method is responsible for:
-     * - Logging the event
-     * - Handling bloc disposal when needed
-     * - Managing bloc consumer cleanup
-     * - Forwarding the event to plugins
-     *
-     * @param event - The lifecycle event to dispatch
-     * @param bloc - The bloc instance involved in the event
-     * @param params - Additional parameters for the event
-     */
-    dispatchEvent: (event: BlacLifecycleEvent, bloc: BlocBase<any>, params?: unknown) => void;
     /**
      * Disposes of a bloc instance by removing it from the appropriate registry
      * @param bloc - The bloc instance to dispose
@@ -142,6 +114,8 @@ export declare class Blac {
      * @returns The newly created bloc instance
      */
     createNewBlocInstance<B extends BlocConstructor<BlocBase<any>>>(blocClass: B, id: BlocInstanceId, options?: GetBlocOptions<InstanceType<B>>): InstanceType<B>;
+    activateBloc: (bloc: BlocBase<any>) => void;
+    static activateBloc: (bloc: BlocBase<any>) => void;
     /**
      * Gets or creates a bloc instance based on the provided class and options.
      * If a bloc with the given ID exists, it will be returned. Otherwise, a new instance will be created.
@@ -185,20 +159,6 @@ export declare class Blac {
     }) => InstanceType<B>[];
 }
 
-declare type BlacAddon = {
-    name: string;
-    onInit?: BlacAddonInit;
-    onEmit?: BlacAddonEmit;
-};
-
-declare type BlacAddonEmit = (params: {
-    oldState: unknown;
-    newState: unknown;
-    cubit: BlocBase<any>;
-}) => void;
-
-declare type BlacAddonInit = (bloc: BlocBase<any>) => void;
-
 /**
  * Configuration options for the Blac instance
  */
@@ -207,20 +167,6 @@ export declare interface BlacConfig {
     exposeBlacInstance?: boolean;
 }
 
-/**
- * Enum representing different lifecycle events that can occur in the Blac system.
- * These events are used to track the lifecycle of blocs and their consumers.
- */
-export declare enum BlacLifecycleEvent {
-    BLOC_DISPOSED = "BLOC_DISPOSED",
-    BLOC_CREATED = "BLOC_CREATED",
-    LISTENER_REMOVED = "LISTENER_REMOVED",
-    LISTENER_ADDED = "LISTENER_ADDED",
-    STATE_CHANGED = "STATE_CHANGED",
-    BLOC_CONSUMER_REMOVED = "BLOC_CONSUMER_REMOVED",
-    BLOC_CONSUMER_ADDED = "BLOC_CONSUMER_ADDED"
-}
-
 /**
  * A class that manages observers for a Bloc's state changes
  * @template S - The type of state being observed
@@ -263,9 +209,9 @@ export declare class BlacObservable<S = unknown> {
      */
     notify(newState: S, oldState: S, action?: unknown): void;
     /**
-     * Disposes of all observers and clears the observer set
+     * Clears the observer set
      */
-    dispose(): void;
+    clear(): void;
 }
 
 /**
@@ -285,11 +231,6 @@ export declare type BlacObserver<S> = {
     id: string;
 };
 
-export declare interface BlacPlugin {
-    name: string;
-    onEvent(event: BlacLifecycleEvent, bloc: BlocBase<any>, params?: unknown): void;
-}
-
 export declare abstract class Bloc<S, // State type
 A extends object, // Base Action/Event type, constrained to object
 P = unknown> extends BlocBase<S, P> {
@@ -320,6 +261,7 @@ P = unknown> extends BlocBase<S, P> {
  * @template P The type of props that can be passed during instance creation (optional)
  */
 export declare abstract class BlocBase<S, P = unknown> {
+    uid: `${string}-${string}-${string}-${string}-${string}`;
     /**
      * When true, every consumer will receive its own unique instance of this Bloc.
      * Use this when state should not be shared between components.
@@ -339,7 +281,6 @@ export declare abstract class BlocBase<S, P = unknown> {
      * When provided, observers will only be notified when selected dependencies change.
      */
     defaultDependencySelector: DependencySelector<S> | undefined;
-    /* Excluded from this release type: _addons */
     /* Excluded from this release type: _isolated */
     /* Excluded from this release type: _observer */
     /* Excluded from this release type: _blac */
@@ -381,7 +322,6 @@ export declare abstract class BlocBase<S, P = unknown> {
     /* Excluded from this release type: _consumers */
     /* Excluded from this release type: _addConsumer */
     /* Excluded from this release type: _removeConsumer */
-    /* Excluded from this release type: _connectAddons */
     lastUpdate: number;
     /* Excluded from this release type: _pushState */
 }
@@ -456,6 +396,7 @@ export declare interface GetBlocOptions<B extends BlocBase<any>> {
     props?: InferPropsFromGeneric<B>;
     onMount?: (bloc: B) => void;
     instanceRef?: string;
+    throwIfNotFound?: boolean;
 }
 
 /**
@@ -464,38 +405,6 @@ export declare interface GetBlocOptions<B extends BlocBase<any>> {
  */
 export declare type InferPropsFromGeneric<T> = T extends Bloc<any, any, infer P> ? P : T extends Cubit<any, infer P> ? P : never;
 
-/**
- * Persist addon
- *
- * @param options
- * @returns BlacAddon
- */
-export declare function Persist(options?: {
-    /**
-     * @default 'blac'
-     */
-    keyPrefix?: string;
-    /**
-     * @default the bloc's id
-     */
-    keyName?: string;
-    /**
-     * Used when the value is not found in storage
-     */
-    defaultValue?: unknown;
-    /**
-     * @default 'localStorage'
-     * @see StorageType
-     */
-    storageType?: StorageType;
-    /**
-     * @default false
-     */
-    onError?: (e: unknown) => void;
-}): BlacAddon;
-
-declare type StorageType = 'localStorage' | 'sessionStorage';
-
 /**
  * Extracts the state type from a BlocBase instance
  * @template B - The BlocBase type to extract the state from