@blac/react 2.0.0-rc-2 → 2.0.0-rc-4
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/dist/index.cjs.js +1 -1
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.d.ts +13 -25
- package/dist/index.es.js +127 -99
- package/dist/index.es.js.map +1 -1
- package/package.json +3 -2
- package/src/index.ts +2 -2
- package/src/useBloc.tsx +83 -177
- package/src/useExternalBlocStore.ts +197 -0
- package/src/externalBlocStore.ts +0 -93
package/dist/index.cjs.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const
|
|
1
|
+
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const u=require("react"),I=require("@blac/core"),M=(y,c)=>{var t;const{id:S,props:h,selector:v}=c??{},s=u.useMemo(()=>crypto.randomUUID(),[]),m=y.isolated?s:S,f=u.useRef(new Set),b=u.useRef(new Set),C=u.useCallback(()=>I.Blac.getBloc(y,{id:m,props:h,instanceRef:s}),[y,h]),o=u.useRef(C()),g=u.useMemo(()=>e=>{const n=o.current;if(!n)return[];if(v)return v(e);if(n.defaultDependencySelector)return n.defaultDependencySelector(e);if(typeof e!="object")return[[e]];const i=[];for(const l of f.current)l in e&&i.push(e[l]);const x=[];for(const l of b.current)if(l in n)try{const d=n[l];switch(typeof d){case"function":continue;default:x.push(d);continue}}catch(d){I.Blac.instance.log("useBloc Error",d)}return[i,x]},[]),r=u.useMemo(()=>({subscribe:e=>{const n=o.current;if(!n)return()=>{};let i=!1;const x={fn:()=>{try{i||(i=!0,f.current=new Set,b.current=new Set,i=!1),e(n.state)}catch(d){console.error({e:d,blocInstance:n,dependencyArray:g})}},dependencyArray:g,id:s};I.Blac.activateBloc(n);const l=n._observer.subscribe(x);return()=>{l()}},getSnapshot:()=>{var e;return((e=o.current)==null?void 0:e.state)||{}},getServerSnapshot:()=>{var e;return((e=o.current)==null?void 0:e.state)||{}}}),[(t=o.current)==null?void 0:t.uid]);return{usedKeys:f,usedClassPropKeys:b,externalStore:r,instance:o,rid:s}};function P(y,c){var o,g;const{externalStore:S,usedKeys:h,usedClassPropKeys:v,instance:s,rid:B}=M(y,c),a=u.useSyncExternalStore(S.subscribe,S.getSnapshot,S.getServerSnapshot),m=u.useRef(new WeakMap),f=u.useRef(new WeakMap),b=u.useMemo(()=>{if(typeof a!="object"||a===null)return a;let r=m.current.get(a);return r||(r=new Proxy(a,{get(t,e){return h.current.add(e),t[e]},has(t,e){return e in t},ownKeys(t){return Reflect.ownKeys(t)},getOwnPropertyDescriptor(t,e){return Reflect.getOwnPropertyDescriptor(t,e)}}),m.current.set(a,r)),r},[a]),C=u.useMemo(()=>{if(!s.current)return null;let r=f.current.get(s.current);return r||(r=new Proxy(s.current,{get(t,e){if(!t)return null;const n=t[e];return typeof n!="function"&&v.current.add(e),n}}),f.current.set(s.current,r)),r},[(o=s.current)==null?void 0:o.uid]);return u.useEffect(()=>{var t;const r=s.current;if(r)return r._addConsumer(B),(t=c==null?void 0:c.onMount)==null||t.call(c,r),()=>{var e;r&&((e=c==null?void 0:c.onUnmount)==null||e.call(c,r),r._removeConsumer(B))}},[(g=s.current)==null?void 0:g.uid,B]),[b,C]}exports.externalBlocStore=M;exports.useBloc=P;
|
|
2
2
|
//# sourceMappingURL=index.cjs.js.map
|
package/dist/index.cjs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.cjs.js","sources":["../src/externalBlocStore.ts","../src/useBloc.tsx"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any */\nimport { BlocBase, BlocConstructor, BlocHookDependencyArrayFn, BlocState } from '@blac/core';\n\n/**\n * Interface defining an external store that can be used to subscribe to and access bloc state.\n * This interface follows the React external store pattern for state management.\n * \n * @template B - The type of the Bloc instance\n * @template S - The type of the Bloc state\n */\nexport interface ExternalStore<\n B extends InstanceType<BlocConstructor<any>>\n> {\n /**\n * Subscribes to changes in the store and returns an unsubscribe function.\n * @param onStoreChange - Callback function that will be called whenever the store changes\n * @returns A function that can be called to unsubscribe from store changes\n */\n subscribe: (onStoreChange: (state: BlocState<B>) => void) => () => void;\n\n /**\n * Gets the current snapshot of the store state.\n * @returns The current state of the store\n */\n getSnapshot: () => BlocState<B>;\n\n /**\n * Gets the server snapshot of the store state.\n * This is optional and defaults to the same value as getSnapshot.\n * @returns The server state of the store\n */\n getServerSnapshot?: () => BlocState<B>;\n}\n\n/**\n * Creates an external store that wraps a Bloc instance, providing a React-compatible interface\n * for subscribing to and accessing bloc state.\n * \n * @template B - The type of the Bloc instance\n * @template S - The type of the Bloc state\n * @param bloc - The Bloc instance to wrap\n * @param dependencyArray - Function that returns an array of dependencies for the subscription\n * @param rid - Unique identifier for the subscription\n * @returns An ExternalStore instance that provides methods to subscribe to and access bloc state\n */\nconst externalBlocStore = <\n B extends InstanceType<BlocConstructor<any>>\n>(\n resolvedBloc: B,\n dependencyArray: BlocHookDependencyArrayFn<BlocState<B>>,\n rid: string,\n): ExternalStore<B> => {\n // TODO: Revisit this type assertion. Ideally, 'resolvedBloc' should conform to a type\n // that guarantees '_observer' and 'state' properties without needing 'as unknown as ...'.\n // This might require adjustments in the core @blac/core types.\n const asBlocBase = resolvedBloc as unknown as BlocBase<BlocState<B>>;\n return {\n subscribe: (listener: (state: BlocState<B>) => void) => {\n // Subscribe to the bloc's observer with the provided listener function\n // This will trigger the callback whenever the bloc's state changes\n const unSub = asBlocBase._observer.subscribe({\n fn: () => {\n try {\n listener(asBlocBase.state);\n } catch (e) {\n // Log any errors that occur during the listener callback\n // This ensures errors in listeners don't break the entire application\n console.error({\n e,\n resolvedBloc,\n dependencyArray,\n });\n }\n },\n // Pass the dependency array to control when the subscription is updated\n dependencyArray,\n // Use the provided id to identify this subscription\n id: rid,\n });\n\n // Return an unsubscribe function that can be called to clean up the subscription\n return () => {\n unSub();\n };\n },\n // Return an immutable snapshot of the current bloc state\n getSnapshot: (): BlocState<B> => asBlocBase.state,\n // Server snapshot mirrors the client snapshot in this implementation\n getServerSnapshot: (): BlocState<B> => asBlocBase.state,\n };\n};\n\nexport default externalBlocStore;\n","/* eslint-disable @typescript-eslint/restrict-template-expressions */\n/* eslint-disable @typescript-eslint/no-explicit-any */\nimport {\n Blac,\n BlocBase,\n BlocBaseAbstract,\n BlocConstructor,\n BlocHookDependencyArrayFn,\n BlocState,\n InferPropsFromGeneric,\n} from '@blac/core';\nimport {\n useEffect,\n useLayoutEffect,\n useMemo,\n useRef,\n useSyncExternalStore,\n} from 'react';\nimport externalBlocStore from './externalBlocStore';\n\n/**\n * Type definition for the return type of the useBloc hook\n * @template B - Bloc constructor type\n */\ntype HookTypes<B extends BlocConstructor<BlocBase<any>>> = [\n BlocState<InstanceType<B>>,\n InstanceType<B>,\n];\n\n/**\n * Configuration options for the useBloc hook\n */\nexport interface BlocHookOptions<B extends BlocBase<any>> {\n id?: string;\n selector?: BlocHookDependencyArrayFn<BlocState<B>>;\n props?: InferPropsFromGeneric<B>;\n onMount?: (bloc: B) => void;\n onUnmount?: (bloc: B) => void;\n}\n\n/**\n * Default dependency selector that wraps the entire state in an array\n * @template T - State type\n * @param {T} s - Current state\n * @returns {Array<Array<T>>} Dependency array containing the entire state\n */\n\n/**\n * React hook for integrating with Blac state management\n *\n * This hook connects a React component to a Bloc state container, providing\n * automatic re-rendering when relevant state changes, dependency tracking,\n * and proper lifecycle management.\n *\n * @template B - Bloc constructor type\n * @template O - BlocHookOptions type\n * @param {B} bloc - Bloc constructor class\n * @param {O} [options] - Configuration options for the hook\n * @returns {HookTypes<B>} Tuple containing [state, bloc instance]\n *\n * @example\n * const [state, counterBloc] = useBloc(CounterBloc);\n * // Access state\n * console.log(state.count);\n * // Call bloc methods\n * counterBloc.increment();\n */\nexport default function useBloc<B extends BlocConstructor<BlocBase<any>>>(\n bloc: B,\n options?: BlocHookOptions<InstanceType<B>>,\n): HookTypes<B> {\n const { selector: selector, id: blocId, props } = options ?? {};\n const rid = useMemo(() => {\n return Math.random().toString(36);\n }, []);\n\n // Track used state keys\n const usedKeys = useRef<Set<string>>(new Set());\n const instanceKeys = useRef<Set<string>>(new Set());\n\n // Track used class properties\n const usedClassPropKeys = useRef<Set<string>>(new Set());\n const instanceClassPropKeys = useRef<Set<string>>(new Set());\n\n const renderInstance = {};\n\n // Determine ID for isolated or shared blocs\n const base = bloc as unknown as BlocBaseAbstract;\n const isIsolated = base.isolated;\n const effectiveBlocId = isIsolated ? rid : blocId;\n\n // Use useRef to hold the bloc instance reference consistently across renders\n const blocRef = useRef<InstanceType<B> | null>(null);\n\n // Initialize or get the bloc instance ONCE using useMemo based on the effective ID\n // This avoids re-running Blac.getBloc on every render.\n useMemo(() => {\n blocRef.current = Blac.getBloc(bloc, {\n id: effectiveBlocId,\n props,\n instanceRef: rid, // Pass component ID for consumer tracking\n });\n }, [bloc, effectiveBlocId, rid]); // Dependencies ensure this runs only when bloc type or ID changes\n\n const resolvedBloc = blocRef.current;\n\n if (!resolvedBloc) {\n // This should ideally not happen if Blac.getBloc works correctly\n throw new Error(`useBloc: could not resolve bloc: ${bloc.name || bloc}`);\n }\n\n // Update props ONLY if this hook instance created the bloc (or is the designated main instance)\n // We rely on Blac.getBloc to handle initial props correctly during creation.\n // Subsequent calls should not overwrite props.\n // Check if this instanceRef matches the one stored on the bloc when it was created/first retrieved.\n if (\n rid === resolvedBloc._instanceRef &&\n options?.props &&\n Blac.instance.findRegisteredBlocInstance(bloc, effectiveBlocId) ===\n resolvedBloc\n ) {\n // Avoid double-setting props if Blac.getBloc already set them during creation\n if (resolvedBloc.props !== options.props) {\n resolvedBloc.props = options.props;\n }\n }\n\n // Configure dependency tracking for re-renders\n const dependencyArray: BlocHookDependencyArrayFn<BlocState<InstanceType<B>>> =\n useMemo(\n () =>\n (\n newState,\n ): ReturnType<\n BlocHookDependencyArrayFn<BlocState<InstanceType<B>>>\n > => {\n // Use custom dependency selector if provided\n if (selector) {\n return selector(newState);\n }\n\n // Fall back to bloc's default dependency selector if available\n if (resolvedBloc.defaultDependencySelector) {\n return resolvedBloc.defaultDependencySelector(newState);\n }\n\n // For primitive states, use default selector\n if (typeof newState !== 'object') {\n // Default behavior for primitive states: re-render if the state itself changes.\n return [[newState]];\n }\n\n // For object states, track which properties were actually used\n const usedStateValues: string[] = [];\n for (const key of usedKeys.current) {\n if (key in newState) {\n usedStateValues.push(newState[key as keyof typeof newState]);\n }\n }\n\n // Track used class properties for dependency tracking, this enables rerenders when class getters change\n const usedClassValues: unknown[] = [];\n for (const key of usedClassPropKeys.current) {\n if (key in resolvedBloc) {\n try {\n const value = resolvedBloc[key as keyof InstanceType<B>];\n switch (typeof value) {\n case 'function':\n continue;\n default:\n usedClassValues.push(value);\n continue;\n }\n } catch (error) {\n Blac.instance.log('useBloc Error', error);\n }\n }\n }\n\n setTimeout(() => {\n instanceKeys.current = new Set();\n instanceClassPropKeys.current = new Set();\n });\n\n return [usedStateValues, usedClassValues];\n },\n [],\n );\n\n // Set up external store subscription for state updates\n const store = useMemo(\n () => externalBlocStore(resolvedBloc, dependencyArray, rid),\n [resolvedBloc, rid],\n ); // dependencyArray removed as it changes frequently\n\n // Subscribe to state changes using React's external store API\n const state = useSyncExternalStore<BlocState<InstanceType<B>>>(\n store.subscribe,\n store.getSnapshot,\n store.getServerSnapshot,\n );\n\n // Create a proxy for state to track property access\n // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n const returnState: BlocState<InstanceType<B>> = useMemo(() => {\n try {\n if (typeof state === 'object') {\n // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n return new Proxy(state as any, {\n get(_, prop) {\n instanceKeys.current.add(prop as string);\n usedKeys.current.add(prop as string);\n const value = state[prop as keyof typeof state];\n // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n return value;\n },\n });\n }\n } catch (error) {\n Blac.instance.log('useBloc Error', error);\n }\n return state;\n }, [state]);\n\n // Create a proxy for the bloc instance to track property access\n const returnClass = useMemo(() => {\n return new Proxy(resolvedBloc, {\n get(_, prop) {\n const value = resolvedBloc[prop as keyof InstanceType<B>];\n // Track which class properties are accessed (excluding methods)\n if (typeof value !== 'function') {\n instanceClassPropKeys.current.add(prop as string);\n }\n return value;\n },\n });\n }, [resolvedBloc]);\n\n // Clean up tracked keys after each render\n useLayoutEffect(() => {\n // inherit the keys from the previous render\n usedKeys.current = new Set(instanceKeys.current);\n usedClassPropKeys.current = new Set(instanceClassPropKeys.current);\n }, [renderInstance]);\n\n // Set up bloc lifecycle management\n useEffect(() => {\n const currentBlocInstance = blocRef.current; // Capture instance for cleanup\n if (!currentBlocInstance) return;\n\n currentBlocInstance._addConsumer(rid);\n\n // Call onMount callback if provided\n options?.onMount?.(currentBlocInstance);\n\n // Cleanup: remove this component as a consumer using the captured instance\n return () => {\n options?.onUnmount?.(currentBlocInstance);\n currentBlocInstance._removeConsumer(rid);\n };\n }, [bloc, rid]); // Do not add options.onMount to deps, it will cause a loop\n\n return [returnState, returnClass];\n}\n"],"names":["externalBlocStore","resolvedBloc","dependencyArray","rid","asBlocBase","listener","unSub","e","externalBlocStore$1","useBloc","bloc","options","selector","blocId","props","useMemo","usedKeys","useRef","instanceKeys","usedClassPropKeys","instanceClassPropKeys","renderInstance","effectiveBlocId","blocRef","Blac","newState","usedStateValues","key","usedClassValues","value","error","store","state","useSyncExternalStore","returnState","_","prop","returnClass","useLayoutEffect","useEffect","currentBlocInstance","_a"],"mappings":"iIA6CMA,EAAoB,CAGxBC,EACAC,EACAC,IACqB,CAIrB,MAAMC,EAAaH,EACZ,MAAA,CACL,UAAYI,GAA4C,CAGhD,MAAAC,EAAQF,EAAW,UAAU,UAAU,CAC3C,GAAI,IAAM,CACJ,GAAA,CACFC,EAASD,EAAW,KAAK,QAClBG,EAAG,CAGV,QAAQ,MAAM,CACZ,EAAAA,EACA,aAAAN,EACA,gBAAAC,CAAA,CACD,CACH,CACF,EAEA,gBAAAA,EAEA,GAAIC,CAAA,CACL,EAGD,MAAO,IAAM,CACLG,GAAA,CAEV,EAEA,YAAa,IAAoBF,EAAW,MAE5C,kBAAmB,IAAoBA,EAAW,KAAA,CAEtD,EAEAI,EAAeR,ECzBS,SAAAS,EACtBC,EACAC,EACc,CACd,KAAM,CAAE,SAAAC,EAAoB,GAAIC,EAAQ,MAAAC,CAAM,EAAIH,GAAW,GACvDR,EAAMY,EAAAA,QAAQ,IACX,KAAK,OAAA,EAAS,SAAS,EAAE,EAC/B,CAAE,CAAA,EAGCC,EAAWC,EAAAA,OAAwB,IAAA,GAAK,EACxCC,EAAeD,EAAAA,OAAwB,IAAA,GAAK,EAG5CE,EAAoBF,EAAAA,OAAwB,IAAA,GAAK,EACjDG,EAAwBH,EAAAA,OAAwB,IAAA,GAAK,EAErDI,EAAiB,CAAA,EAKjBC,EAFOZ,EACW,SACaP,EAAMU,EAGrCU,EAAUN,SAA+B,IAAI,EAInDF,EAAAA,QAAQ,IAAM,CACJQ,EAAA,QAAUC,OAAK,QAAQd,EAAM,CACnC,GAAIY,EACJ,MAAAR,EACA,YAAaX,CAAA,CACd,CACA,EAAA,CAACO,EAAMY,EAAiBnB,CAAG,CAAC,EAE/B,MAAMF,EAAesB,EAAQ,QAE7B,GAAI,CAACtB,EAEH,MAAM,IAAI,MAAM,oCAAoCS,EAAK,MAAQA,CAAI,EAAE,EAQvEP,IAAQF,EAAa,eACrBU,GAAA,MAAAA,EAAS,QACTa,OAAK,SAAS,2BAA2Bd,EAAMY,CAAe,IAC5DrB,GAGEA,EAAa,QAAUU,EAAQ,QACjCV,EAAa,MAAQU,EAAQ,OAKjC,MAAMT,EACJa,EAAA,QACE,IAEIU,GAGG,CAEH,GAAIb,EACF,OAAOA,EAASa,CAAQ,EAI1B,GAAIxB,EAAa,0BACR,OAAAA,EAAa,0BAA0BwB,CAAQ,EAIpD,GAAA,OAAOA,GAAa,SAEf,MAAA,CAAC,CAACA,CAAQ,CAAC,EAIpB,MAAMC,EAA4B,CAAA,EACvB,UAAAC,KAAOX,EAAS,QACrBW,KAAOF,GACOC,EAAA,KAAKD,EAASE,CAA4B,CAAC,EAK/D,MAAMC,EAA6B,CAAA,EACxB,UAAAD,KAAOR,EAAkB,QAClC,GAAIQ,KAAO1B,EACL,GAAA,CACI,MAAA4B,EAAQ5B,EAAa0B,CAA4B,EACvD,OAAQ,OAAOE,EAAO,CACpB,IAAK,WACH,SACF,QACED,EAAgB,KAAKC,CAAK,EAC1B,QACJ,QACOC,EAAO,CACTN,EAAAA,KAAA,SAAS,IAAI,gBAAiBM,CAAK,CAC1C,CAIJ,kBAAW,IAAM,CACFZ,EAAA,YAAc,IACLE,EAAA,YAAc,GAAI,CACzC,EAEM,CAACM,EAAiBE,CAAe,CAC1C,EACF,CAAC,CAAA,EAICG,EAAQhB,EAAA,QACZ,IAAMf,EAAkBC,EAAcC,EAAiBC,CAAG,EAC1D,CAACF,EAAcE,CAAG,CAAA,EAId6B,EAAQC,EAAA,qBACZF,EAAM,UACNA,EAAM,YACNA,EAAM,iBAAA,EAKFG,EAA0CnB,EAAAA,QAAQ,IAAM,CACxD,GAAA,CACE,GAAA,OAAOiB,GAAU,SAEZ,OAAA,IAAI,MAAMA,EAAc,CAC7B,IAAIG,EAAGC,EAAM,CACE,OAAAlB,EAAA,QAAQ,IAAIkB,CAAc,EAC9BpB,EAAA,QAAQ,IAAIoB,CAAc,EACrBJ,EAAMI,CAA0B,CAGhD,CAAA,CACD,QAEIN,EAAO,CACTN,EAAAA,KAAA,SAAS,IAAI,gBAAiBM,CAAK,CAC1C,CACO,OAAAE,CAAA,EACN,CAACA,CAAK,CAAC,EAGJK,EAActB,EAAAA,QAAQ,IACnB,IAAI,MAAMd,EAAc,CAC7B,IAAIkC,EAAGC,EAAM,CACL,MAAAP,EAAQ5B,EAAamC,CAA6B,EAEpD,OAAA,OAAOP,GAAU,YACGT,EAAA,QAAQ,IAAIgB,CAAc,EAE3CP,CACT,CAAA,CACD,EACA,CAAC5B,CAAY,CAAC,EAGjBqC,OAAAA,EAAAA,gBAAgB,IAAM,CAEpBtB,EAAS,QAAU,IAAI,IAAIE,EAAa,OAAO,EAC/CC,EAAkB,QAAU,IAAI,IAAIC,EAAsB,OAAO,CAAA,EAChE,CAACC,CAAc,CAAC,EAGnBkB,EAAAA,UAAU,IAAM,OACd,MAAMC,EAAsBjB,EAAQ,QACpC,GAAKiB,EAEL,OAAAA,EAAoB,aAAarC,CAAG,GAGpCsC,EAAA9B,GAAA,YAAAA,EAAS,UAAT,MAAA8B,EAAA,KAAA9B,EAAmB6B,GAGZ,IAAM,QACXC,EAAA9B,GAAA,YAAAA,EAAS,YAAT,MAAA8B,EAAA,KAAA9B,EAAqB6B,GACrBA,EAAoB,gBAAgBrC,CAAG,CAAA,CACzC,EACC,CAACO,EAAMP,CAAG,CAAC,EAEP,CAAC+B,EAAaG,CAAW,CAClC"}
|
|
1
|
+
{"version":3,"file":"index.cjs.js","sources":["../src/useExternalBlocStore.ts","../src/useBloc.tsx"],"sourcesContent":["import { Blac, BlacObserver, BlocBase, BlocBaseAbstract, BlocConstructor, BlocHookDependencyArrayFn, BlocState } from '@blac/core';\nimport { useCallback, useMemo, useRef } from 'react';\nimport { BlocHookOptions } from './useBloc';\n\nexport interface ExternalStore<\n B extends BlocConstructor<BlocBase<any>>\n> {\n /**\n * Subscribes to changes in the store and returns an unsubscribe function.\n * @param onStoreChange - Callback function that will be called whenever the store changes\n * @returns A function that can be called to unsubscribe from store changes\n */\n subscribe: (onStoreChange: (state: BlocState<InstanceType<B>>) => void) => () => void;\n\n /**\n * Gets the current snapshot of the store state.\n * @returns The current state of the store\n */\n getSnapshot: () => BlocState<InstanceType<B>>;\n\n /**\n * Gets the server snapshot of the store state.\n * This is optional and defaults to the same value as getSnapshot.\n * @returns The server state of the store\n */\n getServerSnapshot?: () => BlocState<InstanceType<B>>;\n}\n\nexport interface ExternalBlacStore<\n B extends BlocConstructor<BlocBase<any>>\n> {\n usedKeys: React.RefObject<Set<string>>;\n usedClassPropKeys: React.RefObject<Set<string>>;\n externalStore: ExternalStore<B>;\n instance: React.RefObject<InstanceType<B>>;\n rid: string;\n}\n\n/**\n * Creates an external store that wraps a Bloc instance, providing a React-compatible interface\n * for subscribing to and accessing bloc state.\n */\nconst useExternalBlocStore = <\n B extends BlocConstructor<BlocBase<any>>\n>(\n bloc: B,\n options: BlocHookOptions<InstanceType<B>> | undefined,\n): ExternalBlacStore<B> => {\n const { id: blocId, props, selector } = options ?? {};\n\n const rid = useMemo(() => {\n return crypto.randomUUID();\n }, []);\n\n const base = bloc as unknown as BlocBaseAbstract;\n\n const isIsolated = base.isolated;\n const effectiveBlocId = isIsolated ? rid : blocId;\n\n const usedKeys = useRef<Set<string>>(new Set());\n const usedClassPropKeys = useRef<Set<string>>(new Set());\n\n const getBloc = useCallback(() => {\n return Blac.getBloc(bloc, {\n id: effectiveBlocId,\n props,\n instanceRef: rid\n });\n }, [bloc, props]);\n\n const blocInstance = useRef<InstanceType<B>>(getBloc());\n\n\n const dependencyArray: BlocHookDependencyArrayFn<BlocState<InstanceType<B>>> =\n useMemo(\n () =>\n (newState): ReturnType<BlocHookDependencyArrayFn<BlocState<InstanceType<B>>>> => {\n const instance = blocInstance.current;\n\n if (!instance) {\n return [];\n }\n\n // Use custom dependency selector if provided\n if (selector) {\n return selector(newState);\n }\n\n // Fall back to bloc's default dependency selector if available\n if (instance.defaultDependencySelector) {\n return instance.defaultDependencySelector(newState);\n }\n\n // For primitive states, use default selector\n if (typeof newState !== 'object') {\n // Default behavior for primitive states: re-render if the state itself changes.\n return [[newState]];\n }\n\n // For object states, track which properties were actually used\n const usedStateValues: string[] = [];\n for (const key of usedKeys.current) {\n if (key in newState) {\n usedStateValues.push(newState[key as keyof typeof newState]);\n }\n }\n\n // Track used class properties for dependency tracking, this enables rerenders when class getters change\n const usedClassValues: unknown[] = [];\n for (const key of usedClassPropKeys.current) {\n if (key in instance) {\n try {\n const value = instance[key as keyof InstanceType<B>];\n switch (typeof value) {\n case 'function':\n continue;\n default:\n usedClassValues.push(value);\n continue;\n }\n } catch (error) {\n Blac.instance.log('useBloc Error', error);\n }\n }\n }\n\n return [usedStateValues, usedClassValues];\n },\n [],\n );\n\n const state: ExternalStore<B> = useMemo(() => {\n return {\n subscribe: (listener: (state: BlocState<InstanceType<B>>) => void) => {\n const currentInstance = blocInstance.current;\n if (!currentInstance) {\n return () => {}; // Return no-op if no instance\n }\n\n // Use a flag to prevent multiple resets during the same listener execution\n let isResetting = false;\n\n const observer: BlacObserver<BlocState<InstanceType<B>>> = {\n fn: () => {\n try {\n if (!isResetting) {\n isResetting = true;\n usedKeys.current = new Set();\n usedClassPropKeys.current = new Set();\n isResetting = false;\n }\n\n listener(currentInstance.state);\n } catch (e) {\n // Log any errors that occur during the listener callback\n // This ensures errors in listeners don't break the entire application\n console.error({\n e,\n blocInstance: currentInstance,\n dependencyArray,\n });\n }\n },\n // Pass the dependency array to control when the subscription is updated\n dependencyArray,\n // Use the provided id to identify this subscription\n id: rid,\n }\n\n Blac.activateBloc(currentInstance);\n\n // Subscribe to the bloc's observer with the provided listener function\n // This will trigger the callback whenever the bloc's state changes\n const unSub = currentInstance._observer.subscribe(observer);\n\n // Return an unsubscribe function that can be called to clean up the subscription\n return () => {\n unSub();\n };\n },\n // Return an immutable snapshot of the current bloc state\n getSnapshot: (): BlocState<InstanceType<B>> => blocInstance.current?.state || ({} as BlocState<InstanceType<B>>),\n // Server snapshot mirrors the client snapshot in this implementation\n getServerSnapshot: (): BlocState<InstanceType<B>> => blocInstance.current?.state || ({} as BlocState<InstanceType<B>>),\n }\n }, [blocInstance.current?.uid]); // Re-create store when instance changes\n\n return {\n usedKeys,\n usedClassPropKeys,\n externalStore: state,\n instance: blocInstance,\n rid,\n };\n};\n\nexport default useExternalBlocStore;\n","import {\n BlocBase,\n BlocConstructor,\n BlocHookDependencyArrayFn,\n BlocState,\n InferPropsFromGeneric,\n} from '@blac/core';\nimport {\n useEffect,\n useMemo,\n useRef,\n useSyncExternalStore\n} from 'react';\nimport useExternalBlocStore from './useExternalBlocStore';\n\n/**\n * Type definition for the return type of the useBloc hook\n * @template B - Bloc constructor type\n */\ntype HookTypes<B extends BlocConstructor<BlocBase<any>>> = [\n BlocState<InstanceType<B>>,\n InstanceType<B>,\n];\n\n/**\n * Configuration options for the useBloc hook\n */\nexport interface BlocHookOptions<B extends BlocBase<any>> {\n id?: string;\n selector?: BlocHookDependencyArrayFn<BlocState<B>>;\n props?: InferPropsFromGeneric<B>;\n onMount?: (bloc: B) => void;\n onUnmount?: (bloc: B) => void;\n}\n\n/**\n * Default dependency selector that wraps the entire state in an array\n * @template T - State type\n * @param {T} s - Current state\n * @returns {Array<Array<T>>} Dependency array containing the entire state\n */\n\nconst log = (...args: unknown[]) => {\n console.log('useBloc', ...args);\n};\n\n/**\n * React hook for integrating with Blac state management\n *\n * This hook connects a React component to a Bloc state container, providing\n * automatic re-rendering when relevant state changes, dependency tracking,\n * and proper lifecycle management.\n *\n * @template B - Bloc constructor type\n * @template O - BlocHookOptions type\n * @param {B} bloc - Bloc constructor class\n * @param {O} [options] - Configuration options for the hook\n * @returns {HookTypes<B>} Tuple containing [state, bloc instance]\n *\n * @example\n * const [state, counterBloc] = useBloc(CounterBloc);\n * // Access state\n * console.log(state.count);\n * // Call bloc methods\n * counterBloc.increment();\n */\nexport default function useBloc<B extends BlocConstructor<BlocBase<any>>>(\n bloc: B,\n options?: BlocHookOptions<InstanceType<B>>,\n): HookTypes<B> {\n // Determine ID for isolated or shared blocs\n // const base = bloc as unknown as BlocBaseAbstract;\n // const isIsolated = base.isolated;\n // const effectiveBlocId = isIsolated ? rid : blocId;\n const {\n externalStore,\n usedKeys,\n usedClassPropKeys,\n instance,\n rid,\n } = useExternalBlocStore(bloc, options);\n\n // Subscribe to state changes using React's external store API\n const state = useSyncExternalStore<BlocState<InstanceType<B>>>(\n externalStore.subscribe,\n externalStore.getSnapshot,\n externalStore.getServerSnapshot,\n );\n\n // Cache proxies to avoid recreation on every render\n const stateProxyCache = useRef<WeakMap<object, object>>(new WeakMap());\n const classProxyCache = useRef<WeakMap<object, object>>(new WeakMap());\n\n const returnState = useMemo(() => {\n if (typeof state !== 'object' || state === null) {\n return state;\n }\n\n // Check cache first\n let proxy = stateProxyCache.current.get(state);\n if (!proxy) {\n proxy = new Proxy(state, {\n get(target, prop) {\n usedKeys.current.add(prop as string);\n const value = target[prop as keyof typeof target];\n return value;\n },\n // Handle symbols and non-enumerable properties\n has(target, prop) {\n return prop in target;\n },\n ownKeys(target) {\n return Reflect.ownKeys(target);\n },\n getOwnPropertyDescriptor(target, prop) {\n return Reflect.getOwnPropertyDescriptor(target, prop);\n }\n });\n stateProxyCache.current.set(state as object, proxy as object);\n }\n return proxy;\n }, [state]);\n\n const returnClass = useMemo(() => {\n if (!instance.current) {\n return null;\n }\n\n // Check cache first\n let proxy = classProxyCache.current.get(instance.current);\n if (!proxy) {\n proxy = new Proxy(instance.current, {\n get(target, prop) {\n if (!target) {\n return null;\n }\n const value = target[prop as keyof InstanceType<B>];\n if (typeof value !== 'function') {\n usedClassPropKeys.current.add(prop as string);\n }\n return value;\n },\n });\n classProxyCache.current.set(instance.current, proxy);\n }\n return proxy;\n }, [instance.current?.uid]);\n\n // Set up bloc lifecycle management\n useEffect(() => {\n const currentInstance = instance.current;\n if (!currentInstance) return;\n \n currentInstance._addConsumer(rid);\n\n // Call onMount callback if provided\n options?.onMount?.(currentInstance);\n\n // Cleanup: remove this component as a consumer using the captured instance\n return () => {\n if (!currentInstance) {\n return;\n }\n options?.onUnmount?.(currentInstance);\n currentInstance._removeConsumer(rid);\n };\n }, [instance.current?.uid, rid]); // Use UID to ensure we re-run when instance changes\n\n return [returnState as BlocState<InstanceType<B>>, returnClass as InstanceType<B>];\n}\n"],"names":["useExternalBlocStore","bloc","options","blocId","props","selector","rid","useMemo","effectiveBlocId","usedKeys","useRef","usedClassPropKeys","getBloc","useCallback","Blac","blocInstance","dependencyArray","newState","instance","usedStateValues","key","usedClassValues","value","error","state","listener","currentInstance","isResetting","observer","e","unSub","_a","useBloc","externalStore","useSyncExternalStore","stateProxyCache","classProxyCache","returnState","proxy","target","prop","returnClass","useEffect","_b"],"mappings":"iIA0CMA,EAAuB,CAG3BC,EACAC,IACyB,OACzB,KAAM,CAAE,GAAIC,EAAQ,MAAAC,EAAO,SAAAC,CAAS,EAAIH,GAAW,CAAC,EAE9CI,EAAMC,EAAAA,QAAQ,IACX,OAAO,WAAW,EACxB,EAAE,EAKCC,EAHOP,EAEW,SACaK,EAAMH,EAErCM,EAAWC,EAAAA,OAAwB,IAAA,GAAK,EACxCC,EAAoBD,EAAAA,OAAwB,IAAA,GAAK,EAEjDE,EAAUC,EAAAA,YAAY,IACnBC,EAAA,KAAK,QAAQb,EAAM,CACxB,GAAIO,EACJ,MAAAJ,EACA,YAAaE,CAAA,CACd,EACA,CAACL,EAAMG,CAAK,CAAC,EAEVW,EAAeL,SAAwBE,GAAS,EAGhDI,EACJT,EAAA,QACE,IACGU,GAAgF,CAC/E,MAAMC,EAAWH,EAAa,QAE9B,GAAI,CAACG,EACH,MAAO,CAAC,EAIV,GAAIb,EACF,OAAOA,EAASY,CAAQ,EAI1B,GAAIC,EAAS,0BACJ,OAAAA,EAAS,0BAA0BD,CAAQ,EAIhD,GAAA,OAAOA,GAAa,SAEf,MAAA,CAAC,CAACA,CAAQ,CAAC,EAIpB,MAAME,EAA4B,CAAC,EACxB,UAAAC,KAAOX,EAAS,QACrBW,KAAOH,GACOE,EAAA,KAAKF,EAASG,CAA4B,CAAC,EAK/D,MAAMC,EAA6B,CAAC,EACzB,UAAAD,KAAOT,EAAkB,QAClC,GAAIS,KAAOF,EACL,GAAA,CACI,MAAAI,EAAQJ,EAASE,CAA4B,EACnD,OAAQ,OAAOE,EAAO,CACpB,IAAK,WACH,SACF,QACED,EAAgB,KAAKC,CAAK,EAC1B,QAAA,QAEGC,EAAO,CACTT,EAAAA,KAAA,SAAS,IAAI,gBAAiBS,CAAK,CAAA,CAKvC,MAAA,CAACJ,EAAiBE,CAAe,CAC1C,EACF,CAAA,CACF,EAEIG,EAA0BjB,EAAAA,QAAQ,KAC/B,CACL,UAAYkB,GAA0D,CACpE,MAAMC,EAAkBX,EAAa,QACrC,GAAI,CAACW,EACH,MAAO,IAAM,CAAC,EAIhB,IAAIC,EAAc,GAElB,MAAMC,EAAqD,CACzD,GAAI,IAAM,CACJ,GAAA,CACGD,IACWA,EAAA,GACLlB,EAAA,YAAc,IACLE,EAAA,YAAc,IAClBgB,EAAA,IAGhBF,EAASC,EAAgB,KAAK,QACvBG,EAAG,CAGV,QAAQ,MAAM,CACZ,EAAAA,EACA,aAAcH,EACd,gBAAAV,CAAA,CACD,CAAA,CAEL,EAEA,gBAAAA,EAEA,GAAIV,CACN,EAEAQ,EAAA,KAAK,aAAaY,CAAe,EAIjC,MAAMI,EAAQJ,EAAgB,UAAU,UAAUE,CAAQ,EAG1D,MAAO,IAAM,CACLE,EAAA,CACR,CACF,EAEA,YAAa,IAAkC,OAAA,QAAAC,EAAAhB,EAAa,UAAb,YAAAgB,EAAsB,QAAU,CAAC,GAEhF,kBAAmB,IAAkC,OAAA,QAAAA,EAAAhB,EAAa,UAAb,YAAAgB,EAAsB,QAAU,CAAA,EACvF,GACC,EAACA,EAAAhB,EAAa,UAAb,YAAAgB,EAAsB,GAAG,CAAC,EAEvB,MAAA,CACL,SAAAtB,EACA,kBAAAE,EACA,cAAea,EACf,SAAUT,EACV,IAAAT,CACF,CACF,EChIwB,SAAA0B,EACtB/B,EACAC,EACc,SAKR,KAAA,CACJ,cAAA+B,EACA,SAAAxB,EACA,kBAAAE,EACA,SAAAO,EACA,IAAAZ,CAAA,EACEN,EAAqBC,EAAMC,CAAO,EAGhCsB,EAAQU,EAAA,qBACZD,EAAc,UACdA,EAAc,YACdA,EAAc,iBAChB,EAGME,EAAkBzB,EAAAA,OAAoC,IAAA,OAAS,EAC/D0B,EAAkB1B,EAAAA,OAAoC,IAAA,OAAS,EAE/D2B,EAAc9B,EAAAA,QAAQ,IAAM,CAChC,GAAI,OAAOiB,GAAU,UAAYA,IAAU,KAClC,OAAAA,EAIT,IAAIc,EAAQH,EAAgB,QAAQ,IAAIX,CAAK,EAC7C,OAAKc,IACKA,EAAA,IAAI,MAAMd,EAAO,CACvB,IAAIe,EAAQC,EAAM,CACP,OAAA/B,EAAA,QAAQ,IAAI+B,CAAc,EACrBD,EAAOC,CAA2B,CAElD,EAEA,IAAID,EAAQC,EAAM,CAChB,OAAOA,KAAQD,CACjB,EACA,QAAQA,EAAQ,CACP,OAAA,QAAQ,QAAQA,CAAM,CAC/B,EACA,yBAAyBA,EAAQC,EAAM,CAC9B,OAAA,QAAQ,yBAAyBD,EAAQC,CAAI,CAAA,CACtD,CACD,EACeL,EAAA,QAAQ,IAAIX,EAAiBc,CAAe,GAEvDA,CAAA,EACN,CAACd,CAAK,CAAC,EAEJiB,EAAclC,EAAAA,QAAQ,IAAM,CAC5B,GAAA,CAACW,EAAS,QACL,OAAA,KAIT,IAAIoB,EAAQF,EAAgB,QAAQ,IAAIlB,EAAS,OAAO,EACxD,OAAKoB,IACKA,EAAA,IAAI,MAAMpB,EAAS,QAAS,CAClC,IAAIqB,EAAQC,EAAM,CAChB,GAAI,CAACD,EACI,OAAA,KAEH,MAAAjB,EAAQiB,EAAOC,CAA6B,EAC9C,OAAA,OAAOlB,GAAU,YACDX,EAAA,QAAQ,IAAI6B,CAAc,EAEvClB,CAAA,CACT,CACD,EACDc,EAAgB,QAAQ,IAAIlB,EAAS,QAASoB,CAAK,GAE9CA,CACN,EAAA,EAACP,EAAAb,EAAS,UAAT,YAAAa,EAAkB,GAAG,CAAC,EAG1BW,OAAAA,EAAAA,UAAU,IAAM,OACd,MAAMhB,EAAkBR,EAAS,QACjC,GAAKQ,EAEL,OAAAA,EAAgB,aAAapB,CAAG,GAGhCyB,EAAA7B,GAAA,YAAAA,EAAS,UAAT,MAAA6B,EAAA,KAAA7B,EAAmBwB,GAGZ,IAAM,OACNA,KAGLK,EAAA7B,GAAA,YAAAA,EAAS,YAAT,MAAA6B,EAAA,KAAA7B,EAAqBwB,GACrBA,EAAgB,gBAAgBpB,CAAG,EACrC,GACC,EAACqC,EAAAzB,EAAS,UAAT,YAAAyB,EAAkB,IAAKrC,CAAG,CAAC,EAExB,CAAC+B,EAA2CI,CAA8B,CACnF"}
|
package/dist/index.d.ts
CHANGED
|
@@ -15,44 +15,38 @@ declare interface BlocHookOptions<B extends BlocBase<any>> {
|
|
|
15
15
|
onUnmount?: (bloc: B) => void;
|
|
16
16
|
}
|
|
17
17
|
|
|
18
|
+
declare interface ExternalBlacStore<B extends BlocConstructor<BlocBase<any>>> {
|
|
19
|
+
usedKeys: React.RefObject<Set<string>>;
|
|
20
|
+
usedClassPropKeys: React.RefObject<Set<string>>;
|
|
21
|
+
externalStore: ExternalStore<B>;
|
|
22
|
+
instance: React.RefObject<InstanceType<B>>;
|
|
23
|
+
rid: string;
|
|
24
|
+
}
|
|
25
|
+
|
|
18
26
|
/**
|
|
19
27
|
* Creates an external store that wraps a Bloc instance, providing a React-compatible interface
|
|
20
28
|
* for subscribing to and accessing bloc state.
|
|
21
|
-
*
|
|
22
|
-
* @template B - The type of the Bloc instance
|
|
23
|
-
* @template S - The type of the Bloc state
|
|
24
|
-
* @param bloc - The Bloc instance to wrap
|
|
25
|
-
* @param dependencyArray - Function that returns an array of dependencies for the subscription
|
|
26
|
-
* @param rid - Unique identifier for the subscription
|
|
27
|
-
* @returns An ExternalStore instance that provides methods to subscribe to and access bloc state
|
|
28
29
|
*/
|
|
29
|
-
export declare const externalBlocStore: <B extends
|
|
30
|
+
export declare const externalBlocStore: <B extends BlocConstructor<BlocBase<any>>>(bloc: B, options: BlocHookOptions<InstanceType<B>> | undefined) => ExternalBlacStore<B>;
|
|
30
31
|
|
|
31
|
-
|
|
32
|
-
* Interface defining an external store that can be used to subscribe to and access bloc state.
|
|
33
|
-
* This interface follows the React external store pattern for state management.
|
|
34
|
-
*
|
|
35
|
-
* @template B - The type of the Bloc instance
|
|
36
|
-
* @template S - The type of the Bloc state
|
|
37
|
-
*/
|
|
38
|
-
declare interface ExternalStore<B extends InstanceType<BlocConstructor<any>>> {
|
|
32
|
+
declare interface ExternalStore<B extends BlocConstructor<BlocBase<any>>> {
|
|
39
33
|
/**
|
|
40
34
|
* Subscribes to changes in the store and returns an unsubscribe function.
|
|
41
35
|
* @param onStoreChange - Callback function that will be called whenever the store changes
|
|
42
36
|
* @returns A function that can be called to unsubscribe from store changes
|
|
43
37
|
*/
|
|
44
|
-
subscribe: (onStoreChange: (state: BlocState<B
|
|
38
|
+
subscribe: (onStoreChange: (state: BlocState<InstanceType<B>>) => void) => () => void;
|
|
45
39
|
/**
|
|
46
40
|
* Gets the current snapshot of the store state.
|
|
47
41
|
* @returns The current state of the store
|
|
48
42
|
*/
|
|
49
|
-
getSnapshot: () => BlocState<B
|
|
43
|
+
getSnapshot: () => BlocState<InstanceType<B>>;
|
|
50
44
|
/**
|
|
51
45
|
* Gets the server snapshot of the store state.
|
|
52
46
|
* This is optional and defaults to the same value as getSnapshot.
|
|
53
47
|
* @returns The server state of the store
|
|
54
48
|
*/
|
|
55
|
-
getServerSnapshot?: () => BlocState<B
|
|
49
|
+
getServerSnapshot?: () => BlocState<InstanceType<B>>;
|
|
56
50
|
}
|
|
57
51
|
|
|
58
52
|
/**
|
|
@@ -64,12 +58,6 @@ BlocState<InstanceType<B>>,
|
|
|
64
58
|
InstanceType<B>
|
|
65
59
|
];
|
|
66
60
|
|
|
67
|
-
/**
|
|
68
|
-
* Default dependency selector that wraps the entire state in an array
|
|
69
|
-
* @template T - State type
|
|
70
|
-
* @param {T} s - Current state
|
|
71
|
-
* @returns {Array<Array<T>>} Dependency array containing the entire state
|
|
72
|
-
*/
|
|
73
61
|
/**
|
|
74
62
|
* React hook for integrating with Blac state management
|
|
75
63
|
*
|
package/dist/index.es.js
CHANGED
|
@@ -1,120 +1,148 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
const
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
1
|
+
import { useMemo as g, useRef as h, useCallback as P, useSyncExternalStore as p, useEffect as K } from "react";
|
|
2
|
+
import { Blac as w } from "@blac/core";
|
|
3
|
+
const k = (d, c) => {
|
|
4
|
+
var t;
|
|
5
|
+
const { id: y, props: x, selector: v } = c ?? {}, s = g(() => crypto.randomUUID(), []), B = d.isolated ? s : y, l = h(/* @__PURE__ */ new Set()), S = h(/* @__PURE__ */ new Set()), I = P(() => w.getBloc(d, {
|
|
6
|
+
id: B,
|
|
7
|
+
props: x,
|
|
8
|
+
instanceRef: s
|
|
9
|
+
}), [d, x]), u = h(I()), b = g(
|
|
10
|
+
() => (e) => {
|
|
11
|
+
const n = u.current;
|
|
12
|
+
if (!n)
|
|
13
|
+
return [];
|
|
14
|
+
if (v)
|
|
15
|
+
return v(e);
|
|
16
|
+
if (n.defaultDependencySelector)
|
|
17
|
+
return n.defaultDependencySelector(e);
|
|
18
|
+
if (typeof e != "object")
|
|
19
|
+
return [[e]];
|
|
20
|
+
const f = [];
|
|
21
|
+
for (const a of l.current)
|
|
22
|
+
a in e && f.push(e[a]);
|
|
23
|
+
const C = [];
|
|
24
|
+
for (const a of S.current)
|
|
25
|
+
if (a in n)
|
|
26
|
+
try {
|
|
27
|
+
const i = n[a];
|
|
28
|
+
switch (typeof i) {
|
|
29
|
+
case "function":
|
|
30
|
+
continue;
|
|
31
|
+
default:
|
|
32
|
+
C.push(i);
|
|
33
|
+
continue;
|
|
34
|
+
}
|
|
35
|
+
} catch (i) {
|
|
36
|
+
w.instance.log("useBloc Error", i);
|
|
37
|
+
}
|
|
38
|
+
return [f, C];
|
|
39
|
+
},
|
|
40
|
+
[]
|
|
41
|
+
), r = g(() => ({
|
|
42
|
+
subscribe: (e) => {
|
|
43
|
+
const n = u.current;
|
|
44
|
+
if (!n)
|
|
45
|
+
return () => {
|
|
46
|
+
};
|
|
47
|
+
let f = !1;
|
|
48
|
+
const C = {
|
|
8
49
|
fn: () => {
|
|
9
50
|
try {
|
|
10
|
-
|
|
11
|
-
} catch (
|
|
51
|
+
f || (f = !0, l.current = /* @__PURE__ */ new Set(), S.current = /* @__PURE__ */ new Set(), f = !1), e(n.state);
|
|
52
|
+
} catch (i) {
|
|
12
53
|
console.error({
|
|
13
|
-
e:
|
|
14
|
-
|
|
15
|
-
dependencyArray:
|
|
54
|
+
e: i,
|
|
55
|
+
blocInstance: n,
|
|
56
|
+
dependencyArray: b
|
|
16
57
|
});
|
|
17
58
|
}
|
|
18
59
|
},
|
|
19
60
|
// Pass the dependency array to control when the subscription is updated
|
|
20
|
-
dependencyArray:
|
|
61
|
+
dependencyArray: b,
|
|
21
62
|
// Use the provided id to identify this subscription
|
|
22
|
-
id:
|
|
23
|
-
}
|
|
63
|
+
id: s
|
|
64
|
+
};
|
|
65
|
+
w.activateBloc(n);
|
|
66
|
+
const a = n._observer.subscribe(C);
|
|
24
67
|
return () => {
|
|
25
|
-
|
|
68
|
+
a();
|
|
26
69
|
};
|
|
27
70
|
},
|
|
28
71
|
// Return an immutable snapshot of the current bloc state
|
|
29
|
-
getSnapshot: () =>
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
};
|
|
33
|
-
}, j = M;
|
|
34
|
-
function L(s, e) {
|
|
35
|
-
const { selector: y, id: o, props: h } = e ?? {}, c = a(() => Math.random().toString(36), []), l = S(/* @__PURE__ */ new Set()), m = S(/* @__PURE__ */ new Set()), x = S(/* @__PURE__ */ new Set()), g = S(/* @__PURE__ */ new Set()), I = {}, v = s.isolated ? c : o, b = S(null);
|
|
36
|
-
a(() => {
|
|
37
|
-
b.current = B.getBloc(s, {
|
|
38
|
-
id: v,
|
|
39
|
-
props: h,
|
|
40
|
-
instanceRef: c
|
|
41
|
-
// Pass component ID for consumer tracking
|
|
42
|
-
});
|
|
43
|
-
}, [s, v, c]);
|
|
44
|
-
const t = b.current;
|
|
45
|
-
if (!t)
|
|
46
|
-
throw new Error(`useBloc: could not resolve bloc: ${s.name || s}`);
|
|
47
|
-
c === t._instanceRef && (e != null && e.props) && B.instance.findRegisteredBlocInstance(s, v) === t && t.props !== e.props && (t.props = e.props);
|
|
48
|
-
const C = a(
|
|
49
|
-
() => (r) => {
|
|
50
|
-
if (y)
|
|
51
|
-
return y(r);
|
|
52
|
-
if (t.defaultDependencySelector)
|
|
53
|
-
return t.defaultDependencySelector(r);
|
|
54
|
-
if (typeof r != "object")
|
|
55
|
-
return [[r]];
|
|
56
|
-
const n = [];
|
|
57
|
-
for (const d of l.current)
|
|
58
|
-
d in r && n.push(r[d]);
|
|
59
|
-
const u = [];
|
|
60
|
-
for (const d of x.current)
|
|
61
|
-
if (d in t)
|
|
62
|
-
try {
|
|
63
|
-
const i = t[d];
|
|
64
|
-
switch (typeof i) {
|
|
65
|
-
case "function":
|
|
66
|
-
continue;
|
|
67
|
-
default:
|
|
68
|
-
u.push(i);
|
|
69
|
-
continue;
|
|
70
|
-
}
|
|
71
|
-
} catch (i) {
|
|
72
|
-
B.instance.log("useBloc Error", i);
|
|
73
|
-
}
|
|
74
|
-
return setTimeout(() => {
|
|
75
|
-
m.current = /* @__PURE__ */ new Set(), g.current = /* @__PURE__ */ new Set();
|
|
76
|
-
}), [n, u];
|
|
72
|
+
getSnapshot: () => {
|
|
73
|
+
var e;
|
|
74
|
+
return ((e = u.current) == null ? void 0 : e.state) || {};
|
|
77
75
|
},
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
), f = R(
|
|
83
|
-
w.subscribe,
|
|
84
|
-
w.getSnapshot,
|
|
85
|
-
w.getServerSnapshot
|
|
86
|
-
), E = a(() => {
|
|
87
|
-
try {
|
|
88
|
-
if (typeof f == "object")
|
|
89
|
-
return new Proxy(f, {
|
|
90
|
-
get(r, n) {
|
|
91
|
-
return m.current.add(n), l.current.add(n), f[n];
|
|
92
|
-
}
|
|
93
|
-
});
|
|
94
|
-
} catch (r) {
|
|
95
|
-
B.instance.log("useBloc Error", r);
|
|
96
|
-
}
|
|
97
|
-
return f;
|
|
98
|
-
}, [f]), _ = a(() => new Proxy(t, {
|
|
99
|
-
get(r, n) {
|
|
100
|
-
const u = t[n];
|
|
101
|
-
return typeof u != "function" && g.current.add(n), u;
|
|
76
|
+
// Server snapshot mirrors the client snapshot in this implementation
|
|
77
|
+
getServerSnapshot: () => {
|
|
78
|
+
var e;
|
|
79
|
+
return ((e = u.current) == null ? void 0 : e.state) || {};
|
|
102
80
|
}
|
|
103
|
-
}), [t]);
|
|
81
|
+
}), [(t = u.current) == null ? void 0 : t.uid]);
|
|
82
|
+
return {
|
|
83
|
+
usedKeys: l,
|
|
84
|
+
usedClassPropKeys: S,
|
|
85
|
+
externalStore: r,
|
|
86
|
+
instance: u,
|
|
87
|
+
rid: s
|
|
88
|
+
};
|
|
89
|
+
};
|
|
90
|
+
function E(d, c) {
|
|
91
|
+
var u, b;
|
|
92
|
+
const {
|
|
93
|
+
externalStore: y,
|
|
94
|
+
usedKeys: x,
|
|
95
|
+
usedClassPropKeys: v,
|
|
96
|
+
instance: s,
|
|
97
|
+
rid: m
|
|
98
|
+
} = k(d, c), o = p(
|
|
99
|
+
y.subscribe,
|
|
100
|
+
y.getSnapshot,
|
|
101
|
+
y.getServerSnapshot
|
|
102
|
+
), B = h(/* @__PURE__ */ new WeakMap()), l = h(/* @__PURE__ */ new WeakMap()), S = g(() => {
|
|
103
|
+
if (typeof o != "object" || o === null)
|
|
104
|
+
return o;
|
|
105
|
+
let r = B.current.get(o);
|
|
106
|
+
return r || (r = new Proxy(o, {
|
|
107
|
+
get(t, e) {
|
|
108
|
+
return x.current.add(e), t[e];
|
|
109
|
+
},
|
|
110
|
+
// Handle symbols and non-enumerable properties
|
|
111
|
+
has(t, e) {
|
|
112
|
+
return e in t;
|
|
113
|
+
},
|
|
114
|
+
ownKeys(t) {
|
|
115
|
+
return Reflect.ownKeys(t);
|
|
116
|
+
},
|
|
117
|
+
getOwnPropertyDescriptor(t, e) {
|
|
118
|
+
return Reflect.getOwnPropertyDescriptor(t, e);
|
|
119
|
+
}
|
|
120
|
+
}), B.current.set(o, r)), r;
|
|
121
|
+
}, [o]), I = g(() => {
|
|
122
|
+
if (!s.current)
|
|
123
|
+
return null;
|
|
124
|
+
let r = l.current.get(s.current);
|
|
125
|
+
return r || (r = new Proxy(s.current, {
|
|
126
|
+
get(t, e) {
|
|
127
|
+
if (!t)
|
|
128
|
+
return null;
|
|
129
|
+
const n = t[e];
|
|
130
|
+
return typeof n != "function" && v.current.add(e), n;
|
|
131
|
+
}
|
|
132
|
+
}), l.current.set(s.current, r)), r;
|
|
133
|
+
}, [(u = s.current) == null ? void 0 : u.uid]);
|
|
104
134
|
return K(() => {
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
var n;
|
|
108
|
-
const r = b.current;
|
|
135
|
+
var t;
|
|
136
|
+
const r = s.current;
|
|
109
137
|
if (r)
|
|
110
|
-
return r._addConsumer(
|
|
111
|
-
var
|
|
112
|
-
(
|
|
138
|
+
return r._addConsumer(m), (t = c == null ? void 0 : c.onMount) == null || t.call(c, r), () => {
|
|
139
|
+
var e;
|
|
140
|
+
r && ((e = c == null ? void 0 : c.onUnmount) == null || e.call(c, r), r._removeConsumer(m));
|
|
113
141
|
};
|
|
114
|
-
}, [s,
|
|
142
|
+
}, [(b = s.current) == null ? void 0 : b.uid, m]), [S, I];
|
|
115
143
|
}
|
|
116
144
|
export {
|
|
117
|
-
|
|
118
|
-
|
|
145
|
+
k as externalBlocStore,
|
|
146
|
+
E as useBloc
|
|
119
147
|
};
|
|
120
148
|
//# sourceMappingURL=index.es.js.map
|
package/dist/index.es.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.es.js","sources":["../src/externalBlocStore.ts","../src/useBloc.tsx"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any */\nimport { BlocBase, BlocConstructor, BlocHookDependencyArrayFn, BlocState } from '@blac/core';\n\n/**\n * Interface defining an external store that can be used to subscribe to and access bloc state.\n * This interface follows the React external store pattern for state management.\n * \n * @template B - The type of the Bloc instance\n * @template S - The type of the Bloc state\n */\nexport interface ExternalStore<\n B extends InstanceType<BlocConstructor<any>>\n> {\n /**\n * Subscribes to changes in the store and returns an unsubscribe function.\n * @param onStoreChange - Callback function that will be called whenever the store changes\n * @returns A function that can be called to unsubscribe from store changes\n */\n subscribe: (onStoreChange: (state: BlocState<B>) => void) => () => void;\n\n /**\n * Gets the current snapshot of the store state.\n * @returns The current state of the store\n */\n getSnapshot: () => BlocState<B>;\n\n /**\n * Gets the server snapshot of the store state.\n * This is optional and defaults to the same value as getSnapshot.\n * @returns The server state of the store\n */\n getServerSnapshot?: () => BlocState<B>;\n}\n\n/**\n * Creates an external store that wraps a Bloc instance, providing a React-compatible interface\n * for subscribing to and accessing bloc state.\n * \n * @template B - The type of the Bloc instance\n * @template S - The type of the Bloc state\n * @param bloc - The Bloc instance to wrap\n * @param dependencyArray - Function that returns an array of dependencies for the subscription\n * @param rid - Unique identifier for the subscription\n * @returns An ExternalStore instance that provides methods to subscribe to and access bloc state\n */\nconst externalBlocStore = <\n B extends InstanceType<BlocConstructor<any>>\n>(\n resolvedBloc: B,\n dependencyArray: BlocHookDependencyArrayFn<BlocState<B>>,\n rid: string,\n): ExternalStore<B> => {\n // TODO: Revisit this type assertion. Ideally, 'resolvedBloc' should conform to a type\n // that guarantees '_observer' and 'state' properties without needing 'as unknown as ...'.\n // This might require adjustments in the core @blac/core types.\n const asBlocBase = resolvedBloc as unknown as BlocBase<BlocState<B>>;\n return {\n subscribe: (listener: (state: BlocState<B>) => void) => {\n // Subscribe to the bloc's observer with the provided listener function\n // This will trigger the callback whenever the bloc's state changes\n const unSub = asBlocBase._observer.subscribe({\n fn: () => {\n try {\n listener(asBlocBase.state);\n } catch (e) {\n // Log any errors that occur during the listener callback\n // This ensures errors in listeners don't break the entire application\n console.error({\n e,\n resolvedBloc,\n dependencyArray,\n });\n }\n },\n // Pass the dependency array to control when the subscription is updated\n dependencyArray,\n // Use the provided id to identify this subscription\n id: rid,\n });\n\n // Return an unsubscribe function that can be called to clean up the subscription\n return () => {\n unSub();\n };\n },\n // Return an immutable snapshot of the current bloc state\n getSnapshot: (): BlocState<B> => asBlocBase.state,\n // Server snapshot mirrors the client snapshot in this implementation\n getServerSnapshot: (): BlocState<B> => asBlocBase.state,\n };\n};\n\nexport default externalBlocStore;\n","/* eslint-disable @typescript-eslint/restrict-template-expressions */\n/* eslint-disable @typescript-eslint/no-explicit-any */\nimport {\n Blac,\n BlocBase,\n BlocBaseAbstract,\n BlocConstructor,\n BlocHookDependencyArrayFn,\n BlocState,\n InferPropsFromGeneric,\n} from '@blac/core';\nimport {\n useEffect,\n useLayoutEffect,\n useMemo,\n useRef,\n useSyncExternalStore,\n} from 'react';\nimport externalBlocStore from './externalBlocStore';\n\n/**\n * Type definition for the return type of the useBloc hook\n * @template B - Bloc constructor type\n */\ntype HookTypes<B extends BlocConstructor<BlocBase<any>>> = [\n BlocState<InstanceType<B>>,\n InstanceType<B>,\n];\n\n/**\n * Configuration options for the useBloc hook\n */\nexport interface BlocHookOptions<B extends BlocBase<any>> {\n id?: string;\n selector?: BlocHookDependencyArrayFn<BlocState<B>>;\n props?: InferPropsFromGeneric<B>;\n onMount?: (bloc: B) => void;\n onUnmount?: (bloc: B) => void;\n}\n\n/**\n * Default dependency selector that wraps the entire state in an array\n * @template T - State type\n * @param {T} s - Current state\n * @returns {Array<Array<T>>} Dependency array containing the entire state\n */\n\n/**\n * React hook for integrating with Blac state management\n *\n * This hook connects a React component to a Bloc state container, providing\n * automatic re-rendering when relevant state changes, dependency tracking,\n * and proper lifecycle management.\n *\n * @template B - Bloc constructor type\n * @template O - BlocHookOptions type\n * @param {B} bloc - Bloc constructor class\n * @param {O} [options] - Configuration options for the hook\n * @returns {HookTypes<B>} Tuple containing [state, bloc instance]\n *\n * @example\n * const [state, counterBloc] = useBloc(CounterBloc);\n * // Access state\n * console.log(state.count);\n * // Call bloc methods\n * counterBloc.increment();\n */\nexport default function useBloc<B extends BlocConstructor<BlocBase<any>>>(\n bloc: B,\n options?: BlocHookOptions<InstanceType<B>>,\n): HookTypes<B> {\n const { selector: selector, id: blocId, props } = options ?? {};\n const rid = useMemo(() => {\n return Math.random().toString(36);\n }, []);\n\n // Track used state keys\n const usedKeys = useRef<Set<string>>(new Set());\n const instanceKeys = useRef<Set<string>>(new Set());\n\n // Track used class properties\n const usedClassPropKeys = useRef<Set<string>>(new Set());\n const instanceClassPropKeys = useRef<Set<string>>(new Set());\n\n const renderInstance = {};\n\n // Determine ID for isolated or shared blocs\n const base = bloc as unknown as BlocBaseAbstract;\n const isIsolated = base.isolated;\n const effectiveBlocId = isIsolated ? rid : blocId;\n\n // Use useRef to hold the bloc instance reference consistently across renders\n const blocRef = useRef<InstanceType<B> | null>(null);\n\n // Initialize or get the bloc instance ONCE using useMemo based on the effective ID\n // This avoids re-running Blac.getBloc on every render.\n useMemo(() => {\n blocRef.current = Blac.getBloc(bloc, {\n id: effectiveBlocId,\n props,\n instanceRef: rid, // Pass component ID for consumer tracking\n });\n }, [bloc, effectiveBlocId, rid]); // Dependencies ensure this runs only when bloc type or ID changes\n\n const resolvedBloc = blocRef.current;\n\n if (!resolvedBloc) {\n // This should ideally not happen if Blac.getBloc works correctly\n throw new Error(`useBloc: could not resolve bloc: ${bloc.name || bloc}`);\n }\n\n // Update props ONLY if this hook instance created the bloc (or is the designated main instance)\n // We rely on Blac.getBloc to handle initial props correctly during creation.\n // Subsequent calls should not overwrite props.\n // Check if this instanceRef matches the one stored on the bloc when it was created/first retrieved.\n if (\n rid === resolvedBloc._instanceRef &&\n options?.props &&\n Blac.instance.findRegisteredBlocInstance(bloc, effectiveBlocId) ===\n resolvedBloc\n ) {\n // Avoid double-setting props if Blac.getBloc already set them during creation\n if (resolvedBloc.props !== options.props) {\n resolvedBloc.props = options.props;\n }\n }\n\n // Configure dependency tracking for re-renders\n const dependencyArray: BlocHookDependencyArrayFn<BlocState<InstanceType<B>>> =\n useMemo(\n () =>\n (\n newState,\n ): ReturnType<\n BlocHookDependencyArrayFn<BlocState<InstanceType<B>>>\n > => {\n // Use custom dependency selector if provided\n if (selector) {\n return selector(newState);\n }\n\n // Fall back to bloc's default dependency selector if available\n if (resolvedBloc.defaultDependencySelector) {\n return resolvedBloc.defaultDependencySelector(newState);\n }\n\n // For primitive states, use default selector\n if (typeof newState !== 'object') {\n // Default behavior for primitive states: re-render if the state itself changes.\n return [[newState]];\n }\n\n // For object states, track which properties were actually used\n const usedStateValues: string[] = [];\n for (const key of usedKeys.current) {\n if (key in newState) {\n usedStateValues.push(newState[key as keyof typeof newState]);\n }\n }\n\n // Track used class properties for dependency tracking, this enables rerenders when class getters change\n const usedClassValues: unknown[] = [];\n for (const key of usedClassPropKeys.current) {\n if (key in resolvedBloc) {\n try {\n const value = resolvedBloc[key as keyof InstanceType<B>];\n switch (typeof value) {\n case 'function':\n continue;\n default:\n usedClassValues.push(value);\n continue;\n }\n } catch (error) {\n Blac.instance.log('useBloc Error', error);\n }\n }\n }\n\n setTimeout(() => {\n instanceKeys.current = new Set();\n instanceClassPropKeys.current = new Set();\n });\n\n return [usedStateValues, usedClassValues];\n },\n [],\n );\n\n // Set up external store subscription for state updates\n const store = useMemo(\n () => externalBlocStore(resolvedBloc, dependencyArray, rid),\n [resolvedBloc, rid],\n ); // dependencyArray removed as it changes frequently\n\n // Subscribe to state changes using React's external store API\n const state = useSyncExternalStore<BlocState<InstanceType<B>>>(\n store.subscribe,\n store.getSnapshot,\n store.getServerSnapshot,\n );\n\n // Create a proxy for state to track property access\n // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n const returnState: BlocState<InstanceType<B>> = useMemo(() => {\n try {\n if (typeof state === 'object') {\n // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n return new Proxy(state as any, {\n get(_, prop) {\n instanceKeys.current.add(prop as string);\n usedKeys.current.add(prop as string);\n const value = state[prop as keyof typeof state];\n // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n return value;\n },\n });\n }\n } catch (error) {\n Blac.instance.log('useBloc Error', error);\n }\n return state;\n }, [state]);\n\n // Create a proxy for the bloc instance to track property access\n const returnClass = useMemo(() => {\n return new Proxy(resolvedBloc, {\n get(_, prop) {\n const value = resolvedBloc[prop as keyof InstanceType<B>];\n // Track which class properties are accessed (excluding methods)\n if (typeof value !== 'function') {\n instanceClassPropKeys.current.add(prop as string);\n }\n return value;\n },\n });\n }, [resolvedBloc]);\n\n // Clean up tracked keys after each render\n useLayoutEffect(() => {\n // inherit the keys from the previous render\n usedKeys.current = new Set(instanceKeys.current);\n usedClassPropKeys.current = new Set(instanceClassPropKeys.current);\n }, [renderInstance]);\n\n // Set up bloc lifecycle management\n useEffect(() => {\n const currentBlocInstance = blocRef.current; // Capture instance for cleanup\n if (!currentBlocInstance) return;\n\n currentBlocInstance._addConsumer(rid);\n\n // Call onMount callback if provided\n options?.onMount?.(currentBlocInstance);\n\n // Cleanup: remove this component as a consumer using the captured instance\n return () => {\n options?.onUnmount?.(currentBlocInstance);\n currentBlocInstance._removeConsumer(rid);\n };\n }, [bloc, rid]); // Do not add options.onMount to deps, it will cause a loop\n\n return [returnState, returnClass];\n}\n"],"names":["externalBlocStore","resolvedBloc","dependencyArray","rid","asBlocBase","listener","unSub","e","externalBlocStore$1","useBloc","bloc","options","selector","blocId","props","useMemo","usedKeys","useRef","instanceKeys","usedClassPropKeys","instanceClassPropKeys","renderInstance","effectiveBlocId","blocRef","Blac","newState","usedStateValues","key","usedClassValues","value","error","store","state","useSyncExternalStore","returnState","_","prop","returnClass","useLayoutEffect","useEffect","currentBlocInstance","_a"],"mappings":";;AA6CA,MAAMA,IAAoB,CAGxBC,GACAC,GACAC,MACqB;AAIrB,QAAMC,IAAaH;AACZ,SAAA;AAAA,IACL,WAAW,CAACI,MAA4C;AAGhD,YAAAC,IAAQF,EAAW,UAAU,UAAU;AAAA,QAC3C,IAAI,MAAM;AACJ,cAAA;AACF,YAAAC,EAASD,EAAW,KAAK;AAAA,mBAClBG,GAAG;AAGV,oBAAQ,MAAM;AAAA,cACZ,GAAAA;AAAA,cACA,cAAAN;AAAA,cACA,iBAAAC;AAAA,YAAA,CACD;AAAA,UACH;AAAA,QACF;AAAA;AAAA,QAEA,iBAAAA;AAAA;AAAA,QAEA,IAAIC;AAAA,MAAA,CACL;AAGD,aAAO,MAAM;AACL,QAAAG;MAAA;AAAA,IAEV;AAAA;AAAA,IAEA,aAAa,MAAoBF,EAAW;AAAA;AAAA,IAE5C,mBAAmB,MAAoBA,EAAW;AAAA,EAAA;AAEtD,GAEAI,IAAeR;ACzBS,SAAAS,EACtBC,GACAC,GACc;AACd,QAAM,EAAE,UAAAC,GAAoB,IAAIC,GAAQ,OAAAC,EAAM,IAAIH,KAAW,IACvDR,IAAMY,EAAQ,MACX,KAAK,OAAA,EAAS,SAAS,EAAE,GAC/B,CAAE,CAAA,GAGCC,IAAWC,EAAwB,oBAAA,IAAK,CAAA,GACxCC,IAAeD,EAAwB,oBAAA,IAAK,CAAA,GAG5CE,IAAoBF,EAAwB,oBAAA,IAAK,CAAA,GACjDG,IAAwBH,EAAwB,oBAAA,IAAK,CAAA,GAErDI,IAAiB,CAAA,GAKjBC,IAFOZ,EACW,WACaP,IAAMU,GAGrCU,IAAUN,EAA+B,IAAI;AAInD,EAAAF,EAAQ,MAAM;AACJ,IAAAQ,EAAA,UAAUC,EAAK,QAAQd,GAAM;AAAA,MACnC,IAAIY;AAAA,MACJ,OAAAR;AAAA,MACA,aAAaX;AAAA;AAAA,IAAA,CACd;AAAA,EACA,GAAA,CAACO,GAAMY,GAAiBnB,CAAG,CAAC;AAE/B,QAAMF,IAAesB,EAAQ;AAE7B,MAAI,CAACtB;AAEH,UAAM,IAAI,MAAM,oCAAoCS,EAAK,QAAQA,CAAI,EAAE;AAQvE,EAAAP,MAAQF,EAAa,iBACrBU,KAAA,QAAAA,EAAS,UACTa,EAAK,SAAS,2BAA2Bd,GAAMY,CAAe,MAC5DrB,KAGEA,EAAa,UAAUU,EAAQ,UACjCV,EAAa,QAAQU,EAAQ;AAKjC,QAAMT,IACJa;AAAA,IACE,MACE,CACEU,MAGG;AAEH,UAAIb;AACF,eAAOA,EAASa,CAAQ;AAI1B,UAAIxB,EAAa;AACR,eAAAA,EAAa,0BAA0BwB,CAAQ;AAIpD,UAAA,OAAOA,KAAa;AAEf,eAAA,CAAC,CAACA,CAAQ,CAAC;AAIpB,YAAMC,IAA4B,CAAA;AACvB,iBAAAC,KAAOX,EAAS;AACzB,QAAIW,KAAOF,KACOC,EAAA,KAAKD,EAASE,CAA4B,CAAC;AAK/D,YAAMC,IAA6B,CAAA;AACxB,iBAAAD,KAAOR,EAAkB;AAClC,YAAIQ,KAAO1B;AACL,cAAA;AACI,kBAAA4B,IAAQ5B,EAAa0B,CAA4B;AACvD,oBAAQ,OAAOE,GAAO;AAAA,cACpB,KAAK;AACH;AAAA,cACF;AACE,gBAAAD,EAAgB,KAAKC,CAAK;AAC1B;AAAA,YACJ;AAAA,mBACOC,GAAO;AACT,YAAAN,EAAA,SAAS,IAAI,iBAAiBM,CAAK;AAAA,UAC1C;AAIJ,wBAAW,MAAM;AACF,QAAAZ,EAAA,8BAAc,OACLE,EAAA,8BAAc;MAAI,CACzC,GAEM,CAACM,GAAiBE,CAAe;AAAA,IAC1C;AAAA,IACF,CAAC;AAAA,EAAA,GAICG,IAAQhB;AAAA,IACZ,MAAMf,EAAkBC,GAAcC,GAAiBC,CAAG;AAAA,IAC1D,CAACF,GAAcE,CAAG;AAAA,EAAA,GAId6B,IAAQC;AAAA,IACZF,EAAM;AAAA,IACNA,EAAM;AAAA,IACNA,EAAM;AAAA,EAAA,GAKFG,IAA0CnB,EAAQ,MAAM;AACxD,QAAA;AACE,UAAA,OAAOiB,KAAU;AAEZ,eAAA,IAAI,MAAMA,GAAc;AAAA,UAC7B,IAAIG,GAAGC,GAAM;AACE,mBAAAlB,EAAA,QAAQ,IAAIkB,CAAc,GAC9BpB,EAAA,QAAQ,IAAIoB,CAAc,GACrBJ,EAAMI,CAA0B;AAAA,UAGhD;AAAA,QAAA,CACD;AAAA,aAEIN,GAAO;AACT,MAAAN,EAAA,SAAS,IAAI,iBAAiBM,CAAK;AAAA,IAC1C;AACO,WAAAE;AAAA,EAAA,GACN,CAACA,CAAK,CAAC,GAGJK,IAActB,EAAQ,MACnB,IAAI,MAAMd,GAAc;AAAA,IAC7B,IAAIkC,GAAGC,GAAM;AACL,YAAAP,IAAQ5B,EAAamC,CAA6B;AAEpD,aAAA,OAAOP,KAAU,cACGT,EAAA,QAAQ,IAAIgB,CAAc,GAE3CP;AAAA,IACT;AAAA,EAAA,CACD,GACA,CAAC5B,CAAY,CAAC;AAGjB,SAAAqC,EAAgB,MAAM;AAEpB,IAAAtB,EAAS,UAAU,IAAI,IAAIE,EAAa,OAAO,GAC/CC,EAAkB,UAAU,IAAI,IAAIC,EAAsB,OAAO;AAAA,EAAA,GAChE,CAACC,CAAc,CAAC,GAGnBkB,EAAU,MAAM;;AACd,UAAMC,IAAsBjB,EAAQ;AACpC,QAAKiB;AAEL,aAAAA,EAAoB,aAAarC,CAAG,IAGpCsC,IAAA9B,KAAA,gBAAAA,EAAS,YAAT,QAAA8B,EAAA,KAAA9B,GAAmB6B,IAGZ,MAAM;;AACX,SAAAC,IAAA9B,KAAA,gBAAAA,EAAS,cAAT,QAAA8B,EAAA,KAAA9B,GAAqB6B,IACrBA,EAAoB,gBAAgBrC,CAAG;AAAA,MAAA;AAAA,EACzC,GACC,CAACO,GAAMP,CAAG,CAAC,GAEP,CAAC+B,GAAaG,CAAW;AAClC;"}
|
|
1
|
+
{"version":3,"file":"index.es.js","sources":["../src/useExternalBlocStore.ts","../src/useBloc.tsx"],"sourcesContent":["import { Blac, BlacObserver, BlocBase, BlocBaseAbstract, BlocConstructor, BlocHookDependencyArrayFn, BlocState } from '@blac/core';\nimport { useCallback, useMemo, useRef } from 'react';\nimport { BlocHookOptions } from './useBloc';\n\nexport interface ExternalStore<\n B extends BlocConstructor<BlocBase<any>>\n> {\n /**\n * Subscribes to changes in the store and returns an unsubscribe function.\n * @param onStoreChange - Callback function that will be called whenever the store changes\n * @returns A function that can be called to unsubscribe from store changes\n */\n subscribe: (onStoreChange: (state: BlocState<InstanceType<B>>) => void) => () => void;\n\n /**\n * Gets the current snapshot of the store state.\n * @returns The current state of the store\n */\n getSnapshot: () => BlocState<InstanceType<B>>;\n\n /**\n * Gets the server snapshot of the store state.\n * This is optional and defaults to the same value as getSnapshot.\n * @returns The server state of the store\n */\n getServerSnapshot?: () => BlocState<InstanceType<B>>;\n}\n\nexport interface ExternalBlacStore<\n B extends BlocConstructor<BlocBase<any>>\n> {\n usedKeys: React.RefObject<Set<string>>;\n usedClassPropKeys: React.RefObject<Set<string>>;\n externalStore: ExternalStore<B>;\n instance: React.RefObject<InstanceType<B>>;\n rid: string;\n}\n\n/**\n * Creates an external store that wraps a Bloc instance, providing a React-compatible interface\n * for subscribing to and accessing bloc state.\n */\nconst useExternalBlocStore = <\n B extends BlocConstructor<BlocBase<any>>\n>(\n bloc: B,\n options: BlocHookOptions<InstanceType<B>> | undefined,\n): ExternalBlacStore<B> => {\n const { id: blocId, props, selector } = options ?? {};\n\n const rid = useMemo(() => {\n return crypto.randomUUID();\n }, []);\n\n const base = bloc as unknown as BlocBaseAbstract;\n\n const isIsolated = base.isolated;\n const effectiveBlocId = isIsolated ? rid : blocId;\n\n const usedKeys = useRef<Set<string>>(new Set());\n const usedClassPropKeys = useRef<Set<string>>(new Set());\n\n const getBloc = useCallback(() => {\n return Blac.getBloc(bloc, {\n id: effectiveBlocId,\n props,\n instanceRef: rid\n });\n }, [bloc, props]);\n\n const blocInstance = useRef<InstanceType<B>>(getBloc());\n\n\n const dependencyArray: BlocHookDependencyArrayFn<BlocState<InstanceType<B>>> =\n useMemo(\n () =>\n (newState): ReturnType<BlocHookDependencyArrayFn<BlocState<InstanceType<B>>>> => {\n const instance = blocInstance.current;\n\n if (!instance) {\n return [];\n }\n\n // Use custom dependency selector if provided\n if (selector) {\n return selector(newState);\n }\n\n // Fall back to bloc's default dependency selector if available\n if (instance.defaultDependencySelector) {\n return instance.defaultDependencySelector(newState);\n }\n\n // For primitive states, use default selector\n if (typeof newState !== 'object') {\n // Default behavior for primitive states: re-render if the state itself changes.\n return [[newState]];\n }\n\n // For object states, track which properties were actually used\n const usedStateValues: string[] = [];\n for (const key of usedKeys.current) {\n if (key in newState) {\n usedStateValues.push(newState[key as keyof typeof newState]);\n }\n }\n\n // Track used class properties for dependency tracking, this enables rerenders when class getters change\n const usedClassValues: unknown[] = [];\n for (const key of usedClassPropKeys.current) {\n if (key in instance) {\n try {\n const value = instance[key as keyof InstanceType<B>];\n switch (typeof value) {\n case 'function':\n continue;\n default:\n usedClassValues.push(value);\n continue;\n }\n } catch (error) {\n Blac.instance.log('useBloc Error', error);\n }\n }\n }\n\n return [usedStateValues, usedClassValues];\n },\n [],\n );\n\n const state: ExternalStore<B> = useMemo(() => {\n return {\n subscribe: (listener: (state: BlocState<InstanceType<B>>) => void) => {\n const currentInstance = blocInstance.current;\n if (!currentInstance) {\n return () => {}; // Return no-op if no instance\n }\n\n // Use a flag to prevent multiple resets during the same listener execution\n let isResetting = false;\n\n const observer: BlacObserver<BlocState<InstanceType<B>>> = {\n fn: () => {\n try {\n if (!isResetting) {\n isResetting = true;\n usedKeys.current = new Set();\n usedClassPropKeys.current = new Set();\n isResetting = false;\n }\n\n listener(currentInstance.state);\n } catch (e) {\n // Log any errors that occur during the listener callback\n // This ensures errors in listeners don't break the entire application\n console.error({\n e,\n blocInstance: currentInstance,\n dependencyArray,\n });\n }\n },\n // Pass the dependency array to control when the subscription is updated\n dependencyArray,\n // Use the provided id to identify this subscription\n id: rid,\n }\n\n Blac.activateBloc(currentInstance);\n\n // Subscribe to the bloc's observer with the provided listener function\n // This will trigger the callback whenever the bloc's state changes\n const unSub = currentInstance._observer.subscribe(observer);\n\n // Return an unsubscribe function that can be called to clean up the subscription\n return () => {\n unSub();\n };\n },\n // Return an immutable snapshot of the current bloc state\n getSnapshot: (): BlocState<InstanceType<B>> => blocInstance.current?.state || ({} as BlocState<InstanceType<B>>),\n // Server snapshot mirrors the client snapshot in this implementation\n getServerSnapshot: (): BlocState<InstanceType<B>> => blocInstance.current?.state || ({} as BlocState<InstanceType<B>>),\n }\n }, [blocInstance.current?.uid]); // Re-create store when instance changes\n\n return {\n usedKeys,\n usedClassPropKeys,\n externalStore: state,\n instance: blocInstance,\n rid,\n };\n};\n\nexport default useExternalBlocStore;\n","import {\n BlocBase,\n BlocConstructor,\n BlocHookDependencyArrayFn,\n BlocState,\n InferPropsFromGeneric,\n} from '@blac/core';\nimport {\n useEffect,\n useMemo,\n useRef,\n useSyncExternalStore\n} from 'react';\nimport useExternalBlocStore from './useExternalBlocStore';\n\n/**\n * Type definition for the return type of the useBloc hook\n * @template B - Bloc constructor type\n */\ntype HookTypes<B extends BlocConstructor<BlocBase<any>>> = [\n BlocState<InstanceType<B>>,\n InstanceType<B>,\n];\n\n/**\n * Configuration options for the useBloc hook\n */\nexport interface BlocHookOptions<B extends BlocBase<any>> {\n id?: string;\n selector?: BlocHookDependencyArrayFn<BlocState<B>>;\n props?: InferPropsFromGeneric<B>;\n onMount?: (bloc: B) => void;\n onUnmount?: (bloc: B) => void;\n}\n\n/**\n * Default dependency selector that wraps the entire state in an array\n * @template T - State type\n * @param {T} s - Current state\n * @returns {Array<Array<T>>} Dependency array containing the entire state\n */\n\nconst log = (...args: unknown[]) => {\n console.log('useBloc', ...args);\n};\n\n/**\n * React hook for integrating with Blac state management\n *\n * This hook connects a React component to a Bloc state container, providing\n * automatic re-rendering when relevant state changes, dependency tracking,\n * and proper lifecycle management.\n *\n * @template B - Bloc constructor type\n * @template O - BlocHookOptions type\n * @param {B} bloc - Bloc constructor class\n * @param {O} [options] - Configuration options for the hook\n * @returns {HookTypes<B>} Tuple containing [state, bloc instance]\n *\n * @example\n * const [state, counterBloc] = useBloc(CounterBloc);\n * // Access state\n * console.log(state.count);\n * // Call bloc methods\n * counterBloc.increment();\n */\nexport default function useBloc<B extends BlocConstructor<BlocBase<any>>>(\n bloc: B,\n options?: BlocHookOptions<InstanceType<B>>,\n): HookTypes<B> {\n // Determine ID for isolated or shared blocs\n // const base = bloc as unknown as BlocBaseAbstract;\n // const isIsolated = base.isolated;\n // const effectiveBlocId = isIsolated ? rid : blocId;\n const {\n externalStore,\n usedKeys,\n usedClassPropKeys,\n instance,\n rid,\n } = useExternalBlocStore(bloc, options);\n\n // Subscribe to state changes using React's external store API\n const state = useSyncExternalStore<BlocState<InstanceType<B>>>(\n externalStore.subscribe,\n externalStore.getSnapshot,\n externalStore.getServerSnapshot,\n );\n\n // Cache proxies to avoid recreation on every render\n const stateProxyCache = useRef<WeakMap<object, object>>(new WeakMap());\n const classProxyCache = useRef<WeakMap<object, object>>(new WeakMap());\n\n const returnState = useMemo(() => {\n if (typeof state !== 'object' || state === null) {\n return state;\n }\n\n // Check cache first\n let proxy = stateProxyCache.current.get(state);\n if (!proxy) {\n proxy = new Proxy(state, {\n get(target, prop) {\n usedKeys.current.add(prop as string);\n const value = target[prop as keyof typeof target];\n return value;\n },\n // Handle symbols and non-enumerable properties\n has(target, prop) {\n return prop in target;\n },\n ownKeys(target) {\n return Reflect.ownKeys(target);\n },\n getOwnPropertyDescriptor(target, prop) {\n return Reflect.getOwnPropertyDescriptor(target, prop);\n }\n });\n stateProxyCache.current.set(state as object, proxy as object);\n }\n return proxy;\n }, [state]);\n\n const returnClass = useMemo(() => {\n if (!instance.current) {\n return null;\n }\n\n // Check cache first\n let proxy = classProxyCache.current.get(instance.current);\n if (!proxy) {\n proxy = new Proxy(instance.current, {\n get(target, prop) {\n if (!target) {\n return null;\n }\n const value = target[prop as keyof InstanceType<B>];\n if (typeof value !== 'function') {\n usedClassPropKeys.current.add(prop as string);\n }\n return value;\n },\n });\n classProxyCache.current.set(instance.current, proxy);\n }\n return proxy;\n }, [instance.current?.uid]);\n\n // Set up bloc lifecycle management\n useEffect(() => {\n const currentInstance = instance.current;\n if (!currentInstance) return;\n \n currentInstance._addConsumer(rid);\n\n // Call onMount callback if provided\n options?.onMount?.(currentInstance);\n\n // Cleanup: remove this component as a consumer using the captured instance\n return () => {\n if (!currentInstance) {\n return;\n }\n options?.onUnmount?.(currentInstance);\n currentInstance._removeConsumer(rid);\n };\n }, [instance.current?.uid, rid]); // Use UID to ensure we re-run when instance changes\n\n return [returnState as BlocState<InstanceType<B>>, returnClass as InstanceType<B>];\n}\n"],"names":["useExternalBlocStore","bloc","options","blocId","props","selector","rid","useMemo","effectiveBlocId","usedKeys","useRef","usedClassPropKeys","getBloc","useCallback","Blac","blocInstance","dependencyArray","newState","instance","usedStateValues","key","usedClassValues","value","error","state","listener","currentInstance","isResetting","observer","e","unSub","_a","useBloc","externalStore","useSyncExternalStore","stateProxyCache","classProxyCache","returnState","proxy","target","prop","returnClass","useEffect","_b"],"mappings":";;AA0CM,MAAAA,IAAuB,CAG3BC,GACAC,MACyB;;AACzB,QAAM,EAAE,IAAIC,GAAQ,OAAAC,GAAO,UAAAC,EAAS,IAAIH,KAAW,CAAC,GAE9CI,IAAMC,EAAQ,MACX,OAAO,WAAW,GACxB,EAAE,GAKCC,IAHOP,EAEW,WACaK,IAAMH,GAErCM,IAAWC,EAAwB,oBAAA,KAAK,GACxCC,IAAoBD,EAAwB,oBAAA,KAAK,GAEjDE,IAAUC,EAAY,MACnBC,EAAK,QAAQb,GAAM;AAAA,IACxB,IAAIO;AAAA,IACJ,OAAAJ;AAAA,IACA,aAAaE;AAAA,EAAA,CACd,GACA,CAACL,GAAMG,CAAK,CAAC,GAEVW,IAAeL,EAAwBE,GAAS,GAGhDI,IACJT;AAAA,IACE,MACE,CAACU,MAAgF;AAC/E,YAAMC,IAAWH,EAAa;AAE9B,UAAI,CAACG;AACH,eAAO,CAAC;AAIV,UAAIb;AACF,eAAOA,EAASY,CAAQ;AAI1B,UAAIC,EAAS;AACJ,eAAAA,EAAS,0BAA0BD,CAAQ;AAIhD,UAAA,OAAOA,KAAa;AAEf,eAAA,CAAC,CAACA,CAAQ,CAAC;AAIpB,YAAME,IAA4B,CAAC;AACxB,iBAAAC,KAAOX,EAAS;AACzB,QAAIW,KAAOH,KACOE,EAAA,KAAKF,EAASG,CAA4B,CAAC;AAK/D,YAAMC,IAA6B,CAAC;AACzB,iBAAAD,KAAOT,EAAkB;AAClC,YAAIS,KAAOF;AACL,cAAA;AACI,kBAAAI,IAAQJ,EAASE,CAA4B;AACnD,oBAAQ,OAAOE,GAAO;AAAA,cACpB,KAAK;AACH;AAAA,cACF;AACE,gBAAAD,EAAgB,KAAKC,CAAK;AAC1B;AAAA,YAAA;AAAA,mBAEGC,GAAO;AACT,YAAAT,EAAA,SAAS,IAAI,iBAAiBS,CAAK;AAAA,UAAA;AAKvC,aAAA,CAACJ,GAAiBE,CAAe;AAAA,IAC1C;AAAA,IACF,CAAA;AAAA,EACF,GAEIG,IAA0BjB,EAAQ,OAC/B;AAAA,IACL,WAAW,CAACkB,MAA0D;AACpE,YAAMC,IAAkBX,EAAa;AACrC,UAAI,CAACW;AACH,eAAO,MAAM;AAAA,QAAC;AAIhB,UAAIC,IAAc;AAElB,YAAMC,IAAqD;AAAA,QACzD,IAAI,MAAM;AACJ,cAAA;AACF,YAAKD,MACWA,IAAA,IACLlB,EAAA,8BAAc,IAAI,GACTE,EAAA,8BAAc,IAAI,GACtBgB,IAAA,KAGhBF,EAASC,EAAgB,KAAK;AAAA,mBACvBG,GAAG;AAGV,oBAAQ,MAAM;AAAA,cACZ,GAAAA;AAAA,cACA,cAAcH;AAAA,cACd,iBAAAV;AAAA,YAAA,CACD;AAAA,UAAA;AAAA,QAEL;AAAA;AAAA,QAEA,iBAAAA;AAAA;AAAA,QAEA,IAAIV;AAAA,MACN;AAEA,MAAAQ,EAAK,aAAaY,CAAe;AAIjC,YAAMI,IAAQJ,EAAgB,UAAU,UAAUE,CAAQ;AAG1D,aAAO,MAAM;AACL,QAAAE,EAAA;AAAA,MACR;AAAA,IACF;AAAA;AAAA,IAEA,aAAa,MAAkC;;AAAA,eAAAC,IAAAhB,EAAa,YAAb,gBAAAgB,EAAsB,UAAU,CAAC;AAAA;AAAA;AAAA,IAEhF,mBAAmB,MAAkC;;AAAA,eAAAA,IAAAhB,EAAa,YAAb,gBAAAgB,EAAsB,UAAU,CAAA;AAAA;AAAA,EACvF,IACC,EAACA,IAAAhB,EAAa,YAAb,gBAAAgB,EAAsB,GAAG,CAAC;AAEvB,SAAA;AAAA,IACL,UAAAtB;AAAA,IACA,mBAAAE;AAAA,IACA,eAAea;AAAA,IACf,UAAUT;AAAA,IACV,KAAAT;AAAA,EACF;AACF;AChIwB,SAAA0B,EACtB/B,GACAC,GACc;;AAKR,QAAA;AAAA,IACJ,eAAA+B;AAAA,IACA,UAAAxB;AAAA,IACA,mBAAAE;AAAA,IACA,UAAAO;AAAA,IACA,KAAAZ;AAAA,EAAA,IACEN,EAAqBC,GAAMC,CAAO,GAGhCsB,IAAQU;AAAA,IACZD,EAAc;AAAA,IACdA,EAAc;AAAA,IACdA,EAAc;AAAA,EAChB,GAGME,IAAkBzB,EAAoC,oBAAA,SAAS,GAC/D0B,IAAkB1B,EAAoC,oBAAA,SAAS,GAE/D2B,IAAc9B,EAAQ,MAAM;AAChC,QAAI,OAAOiB,KAAU,YAAYA,MAAU;AAClC,aAAAA;AAIT,QAAIc,IAAQH,EAAgB,QAAQ,IAAIX,CAAK;AAC7C,WAAKc,MACKA,IAAA,IAAI,MAAMd,GAAO;AAAA,MACvB,IAAIe,GAAQC,GAAM;AACP,eAAA/B,EAAA,QAAQ,IAAI+B,CAAc,GACrBD,EAAOC,CAA2B;AAAA,MAElD;AAAA;AAAA,MAEA,IAAID,GAAQC,GAAM;AAChB,eAAOA,KAAQD;AAAA,MACjB;AAAA,MACA,QAAQA,GAAQ;AACP,eAAA,QAAQ,QAAQA,CAAM;AAAA,MAC/B;AAAA,MACA,yBAAyBA,GAAQC,GAAM;AAC9B,eAAA,QAAQ,yBAAyBD,GAAQC,CAAI;AAAA,MAAA;AAAA,IACtD,CACD,GACeL,EAAA,QAAQ,IAAIX,GAAiBc,CAAe,IAEvDA;AAAA,EAAA,GACN,CAACd,CAAK,CAAC,GAEJiB,IAAclC,EAAQ,MAAM;AAC5B,QAAA,CAACW,EAAS;AACL,aAAA;AAIT,QAAIoB,IAAQF,EAAgB,QAAQ,IAAIlB,EAAS,OAAO;AACxD,WAAKoB,MACKA,IAAA,IAAI,MAAMpB,EAAS,SAAS;AAAA,MAClC,IAAIqB,GAAQC,GAAM;AAChB,YAAI,CAACD;AACI,iBAAA;AAEH,cAAAjB,IAAQiB,EAAOC,CAA6B;AAC9C,eAAA,OAAOlB,KAAU,cACDX,EAAA,QAAQ,IAAI6B,CAAc,GAEvClB;AAAA,MAAA;AAAA,IACT,CACD,GACDc,EAAgB,QAAQ,IAAIlB,EAAS,SAASoB,CAAK,IAE9CA;AAAA,EACN,GAAA,EAACP,IAAAb,EAAS,YAAT,gBAAAa,EAAkB,GAAG,CAAC;AAG1B,SAAAW,EAAU,MAAM;;AACd,UAAMhB,IAAkBR,EAAS;AACjC,QAAKQ;AAEL,aAAAA,EAAgB,aAAapB,CAAG,IAGhCyB,IAAA7B,KAAA,gBAAAA,EAAS,YAAT,QAAA6B,EAAA,KAAA7B,GAAmBwB,IAGZ,MAAM;;AACX,QAAKA,OAGLK,IAAA7B,KAAA,gBAAAA,EAAS,cAAT,QAAA6B,EAAA,KAAA7B,GAAqBwB,IACrBA,EAAgB,gBAAgBpB,CAAG;AAAA,MACrC;AAAA,KACC,EAACqC,IAAAzB,EAAS,YAAT,gBAAAyB,EAAkB,KAAKrC,CAAG,CAAC,GAExB,CAAC+B,GAA2CI,CAA8B;AACnF;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@blac/react",
|
|
3
|
-
"version": "2.0.0-rc-
|
|
3
|
+
"version": "2.0.0-rc-4",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"author": "Brendan Mullins <jsnanigans@gmail.com>",
|
|
6
6
|
"main": "dist/index.cjs.js",
|
|
@@ -30,7 +30,7 @@
|
|
|
30
30
|
"@types/react-dom": "^18.0.0 || ^19.0.0",
|
|
31
31
|
"react": "^18.0.0 || ^19.0.0",
|
|
32
32
|
"react-dom": "^18.0.0 || ^19.0.0",
|
|
33
|
-
"@blac/core": "2.0.0-rc-
|
|
33
|
+
"@blac/core": "2.0.0-rc-4"
|
|
34
34
|
},
|
|
35
35
|
"peerDependenciesMeta": {
|
|
36
36
|
"@types/react": {
|
|
@@ -52,6 +52,7 @@
|
|
|
52
52
|
"happy-dom": "^17.4.7",
|
|
53
53
|
"jsdom": "^24.1.1",
|
|
54
54
|
"prettier": "^3.5.3",
|
|
55
|
+
"react": "^19.1.0",
|
|
55
56
|
"react-dom": "^19.1.0",
|
|
56
57
|
"typescript": "^5.8.3",
|
|
57
58
|
"vite": "^5.3.1",
|
package/src/index.ts
CHANGED
package/src/useBloc.tsx
CHANGED
|
@@ -1,9 +1,5 @@
|
|
|
1
|
-
/* eslint-disable @typescript-eslint/restrict-template-expressions */
|
|
2
|
-
/* eslint-disable @typescript-eslint/no-explicit-any */
|
|
3
1
|
import {
|
|
4
|
-
Blac,
|
|
5
2
|
BlocBase,
|
|
6
|
-
BlocBaseAbstract,
|
|
7
3
|
BlocConstructor,
|
|
8
4
|
BlocHookDependencyArrayFn,
|
|
9
5
|
BlocState,
|
|
@@ -11,12 +7,11 @@ import {
|
|
|
11
7
|
} from '@blac/core';
|
|
12
8
|
import {
|
|
13
9
|
useEffect,
|
|
14
|
-
useLayoutEffect,
|
|
15
10
|
useMemo,
|
|
16
11
|
useRef,
|
|
17
|
-
useSyncExternalStore
|
|
12
|
+
useSyncExternalStore
|
|
18
13
|
} from 'react';
|
|
19
|
-
import
|
|
14
|
+
import useExternalBlocStore from './useExternalBlocStore';
|
|
20
15
|
|
|
21
16
|
/**
|
|
22
17
|
* Type definition for the return type of the useBloc hook
|
|
@@ -45,6 +40,10 @@ export interface BlocHookOptions<B extends BlocBase<any>> {
|
|
|
45
40
|
* @returns {Array<Array<T>>} Dependency array containing the entire state
|
|
46
41
|
*/
|
|
47
42
|
|
|
43
|
+
const log = (...args: unknown[]) => {
|
|
44
|
+
console.log('useBloc', ...args);
|
|
45
|
+
};
|
|
46
|
+
|
|
48
47
|
/**
|
|
49
48
|
* React hook for integrating with Blac state management
|
|
50
49
|
*
|
|
@@ -69,196 +68,103 @@ export default function useBloc<B extends BlocConstructor<BlocBase<any>>>(
|
|
|
69
68
|
bloc: B,
|
|
70
69
|
options?: BlocHookOptions<InstanceType<B>>,
|
|
71
70
|
): HookTypes<B> {
|
|
72
|
-
const { selector: selector, id: blocId, props } = options ?? {};
|
|
73
|
-
const rid = useMemo(() => {
|
|
74
|
-
return Math.random().toString(36);
|
|
75
|
-
}, []);
|
|
76
|
-
|
|
77
|
-
// Track used state keys
|
|
78
|
-
const usedKeys = useRef<Set<string>>(new Set());
|
|
79
|
-
const instanceKeys = useRef<Set<string>>(new Set());
|
|
80
|
-
|
|
81
|
-
// Track used class properties
|
|
82
|
-
const usedClassPropKeys = useRef<Set<string>>(new Set());
|
|
83
|
-
const instanceClassPropKeys = useRef<Set<string>>(new Set());
|
|
84
|
-
|
|
85
|
-
const renderInstance = {};
|
|
86
|
-
|
|
87
71
|
// Determine ID for isolated or shared blocs
|
|
88
|
-
const base = bloc as unknown as BlocBaseAbstract;
|
|
89
|
-
const isIsolated = base.isolated;
|
|
90
|
-
const effectiveBlocId = isIsolated ? rid : blocId;
|
|
72
|
+
// const base = bloc as unknown as BlocBaseAbstract;
|
|
73
|
+
// const isIsolated = base.isolated;
|
|
74
|
+
// const effectiveBlocId = isIsolated ? rid : blocId;
|
|
75
|
+
const {
|
|
76
|
+
externalStore,
|
|
77
|
+
usedKeys,
|
|
78
|
+
usedClassPropKeys,
|
|
79
|
+
instance,
|
|
80
|
+
rid,
|
|
81
|
+
} = useExternalBlocStore(bloc, options);
|
|
91
82
|
|
|
92
|
-
//
|
|
93
|
-
const
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
blocRef.current = Blac.getBloc(bloc, {
|
|
99
|
-
id: effectiveBlocId,
|
|
100
|
-
props,
|
|
101
|
-
instanceRef: rid, // Pass component ID for consumer tracking
|
|
102
|
-
});
|
|
103
|
-
}, [bloc, effectiveBlocId, rid]); // Dependencies ensure this runs only when bloc type or ID changes
|
|
104
|
-
|
|
105
|
-
const resolvedBloc = blocRef.current;
|
|
83
|
+
// Subscribe to state changes using React's external store API
|
|
84
|
+
const state = useSyncExternalStore<BlocState<InstanceType<B>>>(
|
|
85
|
+
externalStore.subscribe,
|
|
86
|
+
externalStore.getSnapshot,
|
|
87
|
+
externalStore.getServerSnapshot,
|
|
88
|
+
);
|
|
106
89
|
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
}
|
|
90
|
+
// Cache proxies to avoid recreation on every render
|
|
91
|
+
const stateProxyCache = useRef<WeakMap<object, object>>(new WeakMap());
|
|
92
|
+
const classProxyCache = useRef<WeakMap<object, object>>(new WeakMap());
|
|
111
93
|
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
// Check if this instanceRef matches the one stored on the bloc when it was created/first retrieved.
|
|
116
|
-
if (
|
|
117
|
-
rid === resolvedBloc._instanceRef &&
|
|
118
|
-
options?.props &&
|
|
119
|
-
Blac.instance.findRegisteredBlocInstance(bloc, effectiveBlocId) ===
|
|
120
|
-
resolvedBloc
|
|
121
|
-
) {
|
|
122
|
-
// Avoid double-setting props if Blac.getBloc already set them during creation
|
|
123
|
-
if (resolvedBloc.props !== options.props) {
|
|
124
|
-
resolvedBloc.props = options.props;
|
|
94
|
+
const returnState = useMemo(() => {
|
|
95
|
+
if (typeof state !== 'object' || state === null) {
|
|
96
|
+
return state;
|
|
125
97
|
}
|
|
126
|
-
}
|
|
127
|
-
|
|
128
|
-
// Configure dependency tracking for re-renders
|
|
129
|
-
const dependencyArray: BlocHookDependencyArrayFn<BlocState<InstanceType<B>>> =
|
|
130
|
-
useMemo(
|
|
131
|
-
() =>
|
|
132
|
-
(
|
|
133
|
-
newState,
|
|
134
|
-
): ReturnType<
|
|
135
|
-
BlocHookDependencyArrayFn<BlocState<InstanceType<B>>>
|
|
136
|
-
> => {
|
|
137
|
-
// Use custom dependency selector if provided
|
|
138
|
-
if (selector) {
|
|
139
|
-
return selector(newState);
|
|
140
|
-
}
|
|
141
|
-
|
|
142
|
-
// Fall back to bloc's default dependency selector if available
|
|
143
|
-
if (resolvedBloc.defaultDependencySelector) {
|
|
144
|
-
return resolvedBloc.defaultDependencySelector(newState);
|
|
145
|
-
}
|
|
146
|
-
|
|
147
|
-
// For primitive states, use default selector
|
|
148
|
-
if (typeof newState !== 'object') {
|
|
149
|
-
// Default behavior for primitive states: re-render if the state itself changes.
|
|
150
|
-
return [[newState]];
|
|
151
|
-
}
|
|
152
|
-
|
|
153
|
-
// For object states, track which properties were actually used
|
|
154
|
-
const usedStateValues: string[] = [];
|
|
155
|
-
for (const key of usedKeys.current) {
|
|
156
|
-
if (key in newState) {
|
|
157
|
-
usedStateValues.push(newState[key as keyof typeof newState]);
|
|
158
|
-
}
|
|
159
|
-
}
|
|
160
|
-
|
|
161
|
-
// Track used class properties for dependency tracking, this enables rerenders when class getters change
|
|
162
|
-
const usedClassValues: unknown[] = [];
|
|
163
|
-
for (const key of usedClassPropKeys.current) {
|
|
164
|
-
if (key in resolvedBloc) {
|
|
165
|
-
try {
|
|
166
|
-
const value = resolvedBloc[key as keyof InstanceType<B>];
|
|
167
|
-
switch (typeof value) {
|
|
168
|
-
case 'function':
|
|
169
|
-
continue;
|
|
170
|
-
default:
|
|
171
|
-
usedClassValues.push(value);
|
|
172
|
-
continue;
|
|
173
|
-
}
|
|
174
|
-
} catch (error) {
|
|
175
|
-
Blac.instance.log('useBloc Error', error);
|
|
176
|
-
}
|
|
177
|
-
}
|
|
178
|
-
}
|
|
179
98
|
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
99
|
+
// Check cache first
|
|
100
|
+
let proxy = stateProxyCache.current.get(state);
|
|
101
|
+
if (!proxy) {
|
|
102
|
+
proxy = new Proxy(state, {
|
|
103
|
+
get(target, prop) {
|
|
104
|
+
usedKeys.current.add(prop as string);
|
|
105
|
+
const value = target[prop as keyof typeof target];
|
|
106
|
+
return value;
|
|
186
107
|
},
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
store.getSnapshot,
|
|
200
|
-
store.getServerSnapshot,
|
|
201
|
-
);
|
|
202
|
-
|
|
203
|
-
// Create a proxy for state to track property access
|
|
204
|
-
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
|
|
205
|
-
const returnState: BlocState<InstanceType<B>> = useMemo(() => {
|
|
206
|
-
try {
|
|
207
|
-
if (typeof state === 'object') {
|
|
208
|
-
// eslint-disable-next-line @typescript-eslint/no-unsafe-return
|
|
209
|
-
return new Proxy(state as any, {
|
|
210
|
-
get(_, prop) {
|
|
211
|
-
instanceKeys.current.add(prop as string);
|
|
212
|
-
usedKeys.current.add(prop as string);
|
|
213
|
-
const value = state[prop as keyof typeof state];
|
|
214
|
-
// eslint-disable-next-line @typescript-eslint/no-unsafe-return
|
|
215
|
-
return value;
|
|
216
|
-
},
|
|
217
|
-
});
|
|
218
|
-
}
|
|
219
|
-
} catch (error) {
|
|
220
|
-
Blac.instance.log('useBloc Error', error);
|
|
108
|
+
// Handle symbols and non-enumerable properties
|
|
109
|
+
has(target, prop) {
|
|
110
|
+
return prop in target;
|
|
111
|
+
},
|
|
112
|
+
ownKeys(target) {
|
|
113
|
+
return Reflect.ownKeys(target);
|
|
114
|
+
},
|
|
115
|
+
getOwnPropertyDescriptor(target, prop) {
|
|
116
|
+
return Reflect.getOwnPropertyDescriptor(target, prop);
|
|
117
|
+
}
|
|
118
|
+
});
|
|
119
|
+
stateProxyCache.current.set(state as object, proxy as object);
|
|
221
120
|
}
|
|
222
|
-
return
|
|
121
|
+
return proxy;
|
|
223
122
|
}, [state]);
|
|
224
123
|
|
|
225
|
-
// Create a proxy for the bloc instance to track property access
|
|
226
124
|
const returnClass = useMemo(() => {
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
// Track which class properties are accessed (excluding methods)
|
|
231
|
-
if (typeof value !== 'function') {
|
|
232
|
-
instanceClassPropKeys.current.add(prop as string);
|
|
233
|
-
}
|
|
234
|
-
return value;
|
|
235
|
-
},
|
|
236
|
-
});
|
|
237
|
-
}, [resolvedBloc]);
|
|
125
|
+
if (!instance.current) {
|
|
126
|
+
return null;
|
|
127
|
+
}
|
|
238
128
|
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
129
|
+
// Check cache first
|
|
130
|
+
let proxy = classProxyCache.current.get(instance.current);
|
|
131
|
+
if (!proxy) {
|
|
132
|
+
proxy = new Proxy(instance.current, {
|
|
133
|
+
get(target, prop) {
|
|
134
|
+
if (!target) {
|
|
135
|
+
return null;
|
|
136
|
+
}
|
|
137
|
+
const value = target[prop as keyof InstanceType<B>];
|
|
138
|
+
if (typeof value !== 'function') {
|
|
139
|
+
usedClassPropKeys.current.add(prop as string);
|
|
140
|
+
}
|
|
141
|
+
return value;
|
|
142
|
+
},
|
|
143
|
+
});
|
|
144
|
+
classProxyCache.current.set(instance.current, proxy);
|
|
145
|
+
}
|
|
146
|
+
return proxy;
|
|
147
|
+
}, [instance.current?.uid]);
|
|
245
148
|
|
|
246
149
|
// Set up bloc lifecycle management
|
|
247
150
|
useEffect(() => {
|
|
248
|
-
const
|
|
249
|
-
if (!
|
|
250
|
-
|
|
251
|
-
|
|
151
|
+
const currentInstance = instance.current;
|
|
152
|
+
if (!currentInstance) return;
|
|
153
|
+
|
|
154
|
+
currentInstance._addConsumer(rid);
|
|
252
155
|
|
|
253
156
|
// Call onMount callback if provided
|
|
254
|
-
options?.onMount?.(
|
|
157
|
+
options?.onMount?.(currentInstance);
|
|
255
158
|
|
|
256
159
|
// Cleanup: remove this component as a consumer using the captured instance
|
|
257
160
|
return () => {
|
|
258
|
-
|
|
259
|
-
|
|
161
|
+
if (!currentInstance) {
|
|
162
|
+
return;
|
|
163
|
+
}
|
|
164
|
+
options?.onUnmount?.(currentInstance);
|
|
165
|
+
currentInstance._removeConsumer(rid);
|
|
260
166
|
};
|
|
261
|
-
}, [
|
|
167
|
+
}, [instance.current?.uid, rid]); // Use UID to ensure we re-run when instance changes
|
|
262
168
|
|
|
263
|
-
return [returnState
|
|
169
|
+
return [returnState as BlocState<InstanceType<B>>, returnClass as InstanceType<B>];
|
|
264
170
|
}
|
|
@@ -0,0 +1,197 @@
|
|
|
1
|
+
import { Blac, BlacObserver, BlocBase, BlocBaseAbstract, BlocConstructor, BlocHookDependencyArrayFn, BlocState } from '@blac/core';
|
|
2
|
+
import { useCallback, useMemo, useRef } from 'react';
|
|
3
|
+
import { BlocHookOptions } from './useBloc';
|
|
4
|
+
|
|
5
|
+
export interface ExternalStore<
|
|
6
|
+
B extends BlocConstructor<BlocBase<any>>
|
|
7
|
+
> {
|
|
8
|
+
/**
|
|
9
|
+
* Subscribes to changes in the store and returns an unsubscribe function.
|
|
10
|
+
* @param onStoreChange - Callback function that will be called whenever the store changes
|
|
11
|
+
* @returns A function that can be called to unsubscribe from store changes
|
|
12
|
+
*/
|
|
13
|
+
subscribe: (onStoreChange: (state: BlocState<InstanceType<B>>) => void) => () => void;
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* Gets the current snapshot of the store state.
|
|
17
|
+
* @returns The current state of the store
|
|
18
|
+
*/
|
|
19
|
+
getSnapshot: () => BlocState<InstanceType<B>>;
|
|
20
|
+
|
|
21
|
+
/**
|
|
22
|
+
* Gets the server snapshot of the store state.
|
|
23
|
+
* This is optional and defaults to the same value as getSnapshot.
|
|
24
|
+
* @returns The server state of the store
|
|
25
|
+
*/
|
|
26
|
+
getServerSnapshot?: () => BlocState<InstanceType<B>>;
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
export interface ExternalBlacStore<
|
|
30
|
+
B extends BlocConstructor<BlocBase<any>>
|
|
31
|
+
> {
|
|
32
|
+
usedKeys: React.RefObject<Set<string>>;
|
|
33
|
+
usedClassPropKeys: React.RefObject<Set<string>>;
|
|
34
|
+
externalStore: ExternalStore<B>;
|
|
35
|
+
instance: React.RefObject<InstanceType<B>>;
|
|
36
|
+
rid: string;
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
/**
|
|
40
|
+
* Creates an external store that wraps a Bloc instance, providing a React-compatible interface
|
|
41
|
+
* for subscribing to and accessing bloc state.
|
|
42
|
+
*/
|
|
43
|
+
const useExternalBlocStore = <
|
|
44
|
+
B extends BlocConstructor<BlocBase<any>>
|
|
45
|
+
>(
|
|
46
|
+
bloc: B,
|
|
47
|
+
options: BlocHookOptions<InstanceType<B>> | undefined,
|
|
48
|
+
): ExternalBlacStore<B> => {
|
|
49
|
+
const { id: blocId, props, selector } = options ?? {};
|
|
50
|
+
|
|
51
|
+
const rid = useMemo(() => {
|
|
52
|
+
return crypto.randomUUID();
|
|
53
|
+
}, []);
|
|
54
|
+
|
|
55
|
+
const base = bloc as unknown as BlocBaseAbstract;
|
|
56
|
+
|
|
57
|
+
const isIsolated = base.isolated;
|
|
58
|
+
const effectiveBlocId = isIsolated ? rid : blocId;
|
|
59
|
+
|
|
60
|
+
const usedKeys = useRef<Set<string>>(new Set());
|
|
61
|
+
const usedClassPropKeys = useRef<Set<string>>(new Set());
|
|
62
|
+
|
|
63
|
+
const getBloc = useCallback(() => {
|
|
64
|
+
return Blac.getBloc(bloc, {
|
|
65
|
+
id: effectiveBlocId,
|
|
66
|
+
props,
|
|
67
|
+
instanceRef: rid
|
|
68
|
+
});
|
|
69
|
+
}, [bloc, props]);
|
|
70
|
+
|
|
71
|
+
const blocInstance = useRef<InstanceType<B>>(getBloc());
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
const dependencyArray: BlocHookDependencyArrayFn<BlocState<InstanceType<B>>> =
|
|
75
|
+
useMemo(
|
|
76
|
+
() =>
|
|
77
|
+
(newState): ReturnType<BlocHookDependencyArrayFn<BlocState<InstanceType<B>>>> => {
|
|
78
|
+
const instance = blocInstance.current;
|
|
79
|
+
|
|
80
|
+
if (!instance) {
|
|
81
|
+
return [];
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
// Use custom dependency selector if provided
|
|
85
|
+
if (selector) {
|
|
86
|
+
return selector(newState);
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
// Fall back to bloc's default dependency selector if available
|
|
90
|
+
if (instance.defaultDependencySelector) {
|
|
91
|
+
return instance.defaultDependencySelector(newState);
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
// For primitive states, use default selector
|
|
95
|
+
if (typeof newState !== 'object') {
|
|
96
|
+
// Default behavior for primitive states: re-render if the state itself changes.
|
|
97
|
+
return [[newState]];
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
// For object states, track which properties were actually used
|
|
101
|
+
const usedStateValues: string[] = [];
|
|
102
|
+
for (const key of usedKeys.current) {
|
|
103
|
+
if (key in newState) {
|
|
104
|
+
usedStateValues.push(newState[key as keyof typeof newState]);
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
// Track used class properties for dependency tracking, this enables rerenders when class getters change
|
|
109
|
+
const usedClassValues: unknown[] = [];
|
|
110
|
+
for (const key of usedClassPropKeys.current) {
|
|
111
|
+
if (key in instance) {
|
|
112
|
+
try {
|
|
113
|
+
const value = instance[key as keyof InstanceType<B>];
|
|
114
|
+
switch (typeof value) {
|
|
115
|
+
case 'function':
|
|
116
|
+
continue;
|
|
117
|
+
default:
|
|
118
|
+
usedClassValues.push(value);
|
|
119
|
+
continue;
|
|
120
|
+
}
|
|
121
|
+
} catch (error) {
|
|
122
|
+
Blac.instance.log('useBloc Error', error);
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
return [usedStateValues, usedClassValues];
|
|
128
|
+
},
|
|
129
|
+
[],
|
|
130
|
+
);
|
|
131
|
+
|
|
132
|
+
const state: ExternalStore<B> = useMemo(() => {
|
|
133
|
+
return {
|
|
134
|
+
subscribe: (listener: (state: BlocState<InstanceType<B>>) => void) => {
|
|
135
|
+
const currentInstance = blocInstance.current;
|
|
136
|
+
if (!currentInstance) {
|
|
137
|
+
return () => {}; // Return no-op if no instance
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
// Use a flag to prevent multiple resets during the same listener execution
|
|
141
|
+
let isResetting = false;
|
|
142
|
+
|
|
143
|
+
const observer: BlacObserver<BlocState<InstanceType<B>>> = {
|
|
144
|
+
fn: () => {
|
|
145
|
+
try {
|
|
146
|
+
if (!isResetting) {
|
|
147
|
+
isResetting = true;
|
|
148
|
+
usedKeys.current = new Set();
|
|
149
|
+
usedClassPropKeys.current = new Set();
|
|
150
|
+
isResetting = false;
|
|
151
|
+
}
|
|
152
|
+
|
|
153
|
+
listener(currentInstance.state);
|
|
154
|
+
} catch (e) {
|
|
155
|
+
// Log any errors that occur during the listener callback
|
|
156
|
+
// This ensures errors in listeners don't break the entire application
|
|
157
|
+
console.error({
|
|
158
|
+
e,
|
|
159
|
+
blocInstance: currentInstance,
|
|
160
|
+
dependencyArray,
|
|
161
|
+
});
|
|
162
|
+
}
|
|
163
|
+
},
|
|
164
|
+
// Pass the dependency array to control when the subscription is updated
|
|
165
|
+
dependencyArray,
|
|
166
|
+
// Use the provided id to identify this subscription
|
|
167
|
+
id: rid,
|
|
168
|
+
}
|
|
169
|
+
|
|
170
|
+
Blac.activateBloc(currentInstance);
|
|
171
|
+
|
|
172
|
+
// Subscribe to the bloc's observer with the provided listener function
|
|
173
|
+
// This will trigger the callback whenever the bloc's state changes
|
|
174
|
+
const unSub = currentInstance._observer.subscribe(observer);
|
|
175
|
+
|
|
176
|
+
// Return an unsubscribe function that can be called to clean up the subscription
|
|
177
|
+
return () => {
|
|
178
|
+
unSub();
|
|
179
|
+
};
|
|
180
|
+
},
|
|
181
|
+
// Return an immutable snapshot of the current bloc state
|
|
182
|
+
getSnapshot: (): BlocState<InstanceType<B>> => blocInstance.current?.state || ({} as BlocState<InstanceType<B>>),
|
|
183
|
+
// Server snapshot mirrors the client snapshot in this implementation
|
|
184
|
+
getServerSnapshot: (): BlocState<InstanceType<B>> => blocInstance.current?.state || ({} as BlocState<InstanceType<B>>),
|
|
185
|
+
}
|
|
186
|
+
}, [blocInstance.current?.uid]); // Re-create store when instance changes
|
|
187
|
+
|
|
188
|
+
return {
|
|
189
|
+
usedKeys,
|
|
190
|
+
usedClassPropKeys,
|
|
191
|
+
externalStore: state,
|
|
192
|
+
instance: blocInstance,
|
|
193
|
+
rid,
|
|
194
|
+
};
|
|
195
|
+
};
|
|
196
|
+
|
|
197
|
+
export default useExternalBlocStore;
|
package/src/externalBlocStore.ts
DELETED
|
@@ -1,93 +0,0 @@
|
|
|
1
|
-
/* eslint-disable @typescript-eslint/no-explicit-any */
|
|
2
|
-
import { BlocBase, BlocConstructor, BlocHookDependencyArrayFn, BlocState } from '@blac/core';
|
|
3
|
-
|
|
4
|
-
/**
|
|
5
|
-
* Interface defining an external store that can be used to subscribe to and access bloc state.
|
|
6
|
-
* This interface follows the React external store pattern for state management.
|
|
7
|
-
*
|
|
8
|
-
* @template B - The type of the Bloc instance
|
|
9
|
-
* @template S - The type of the Bloc state
|
|
10
|
-
*/
|
|
11
|
-
export interface ExternalStore<
|
|
12
|
-
B extends InstanceType<BlocConstructor<any>>
|
|
13
|
-
> {
|
|
14
|
-
/**
|
|
15
|
-
* Subscribes to changes in the store and returns an unsubscribe function.
|
|
16
|
-
* @param onStoreChange - Callback function that will be called whenever the store changes
|
|
17
|
-
* @returns A function that can be called to unsubscribe from store changes
|
|
18
|
-
*/
|
|
19
|
-
subscribe: (onStoreChange: (state: BlocState<B>) => void) => () => void;
|
|
20
|
-
|
|
21
|
-
/**
|
|
22
|
-
* Gets the current snapshot of the store state.
|
|
23
|
-
* @returns The current state of the store
|
|
24
|
-
*/
|
|
25
|
-
getSnapshot: () => BlocState<B>;
|
|
26
|
-
|
|
27
|
-
/**
|
|
28
|
-
* Gets the server snapshot of the store state.
|
|
29
|
-
* This is optional and defaults to the same value as getSnapshot.
|
|
30
|
-
* @returns The server state of the store
|
|
31
|
-
*/
|
|
32
|
-
getServerSnapshot?: () => BlocState<B>;
|
|
33
|
-
}
|
|
34
|
-
|
|
35
|
-
/**
|
|
36
|
-
* Creates an external store that wraps a Bloc instance, providing a React-compatible interface
|
|
37
|
-
* for subscribing to and accessing bloc state.
|
|
38
|
-
*
|
|
39
|
-
* @template B - The type of the Bloc instance
|
|
40
|
-
* @template S - The type of the Bloc state
|
|
41
|
-
* @param bloc - The Bloc instance to wrap
|
|
42
|
-
* @param dependencyArray - Function that returns an array of dependencies for the subscription
|
|
43
|
-
* @param rid - Unique identifier for the subscription
|
|
44
|
-
* @returns An ExternalStore instance that provides methods to subscribe to and access bloc state
|
|
45
|
-
*/
|
|
46
|
-
const externalBlocStore = <
|
|
47
|
-
B extends InstanceType<BlocConstructor<any>>
|
|
48
|
-
>(
|
|
49
|
-
resolvedBloc: B,
|
|
50
|
-
dependencyArray: BlocHookDependencyArrayFn<BlocState<B>>,
|
|
51
|
-
rid: string,
|
|
52
|
-
): ExternalStore<B> => {
|
|
53
|
-
// TODO: Revisit this type assertion. Ideally, 'resolvedBloc' should conform to a type
|
|
54
|
-
// that guarantees '_observer' and 'state' properties without needing 'as unknown as ...'.
|
|
55
|
-
// This might require adjustments in the core @blac/core types.
|
|
56
|
-
const asBlocBase = resolvedBloc as unknown as BlocBase<BlocState<B>>;
|
|
57
|
-
return {
|
|
58
|
-
subscribe: (listener: (state: BlocState<B>) => void) => {
|
|
59
|
-
// Subscribe to the bloc's observer with the provided listener function
|
|
60
|
-
// This will trigger the callback whenever the bloc's state changes
|
|
61
|
-
const unSub = asBlocBase._observer.subscribe({
|
|
62
|
-
fn: () => {
|
|
63
|
-
try {
|
|
64
|
-
listener(asBlocBase.state);
|
|
65
|
-
} catch (e) {
|
|
66
|
-
// Log any errors that occur during the listener callback
|
|
67
|
-
// This ensures errors in listeners don't break the entire application
|
|
68
|
-
console.error({
|
|
69
|
-
e,
|
|
70
|
-
resolvedBloc,
|
|
71
|
-
dependencyArray,
|
|
72
|
-
});
|
|
73
|
-
}
|
|
74
|
-
},
|
|
75
|
-
// Pass the dependency array to control when the subscription is updated
|
|
76
|
-
dependencyArray,
|
|
77
|
-
// Use the provided id to identify this subscription
|
|
78
|
-
id: rid,
|
|
79
|
-
});
|
|
80
|
-
|
|
81
|
-
// Return an unsubscribe function that can be called to clean up the subscription
|
|
82
|
-
return () => {
|
|
83
|
-
unSub();
|
|
84
|
-
};
|
|
85
|
-
},
|
|
86
|
-
// Return an immutable snapshot of the current bloc state
|
|
87
|
-
getSnapshot: (): BlocState<B> => asBlocBase.state,
|
|
88
|
-
// Server snapshot mirrors the client snapshot in this implementation
|
|
89
|
-
getServerSnapshot: (): BlocState<B> => asBlocBase.state,
|
|
90
|
-
};
|
|
91
|
-
};
|
|
92
|
-
|
|
93
|
-
export default externalBlocStore;
|