signalium 1.1.1 → 1.2.1

package/.turbo/turbo-build.log

@@ -1,12 +1,12 @@
 
-> signalium@1.1.1 build
+> signalium@1.2.1 build
 > npm run build:esm && npm run build:cjs
 
 
-> signalium@1.1.1 build:esm
+> signalium@1.2.1 build:esm
 > tsc
 
 
-> signalium@1.1.1 build:cjs
+> signalium@1.2.1 build:cjs
 > tsc --module commonjs --outDir dist/cjs --moduleResolution node
 

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # signalium
 
+## 1.2.1
+
+### Patch Changes
+
+- af9216c: Updates runReactiveSafe API to simplify types
+
+## 1.2.0
+
+### Minor Changes
+
+- a56cc6f: Add runReactiveSafe for running reactive functions safely in React apps
+
 ## 1.1.1
 
 ### Patch Changes

package/dist/cjs/react/index.d.ts

@@ -2,4 +2,5 @@ export { ContextProvider } from './provider.js';
 export { useScope } from './context.js';
 export { setupReact } from './setup.js';
 export { useStateSignal } from './state.js';
+export { runReactiveSafe } from './rendering.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/cjs/react/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/react/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACxC,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/react/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACxC,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE5C,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC"}

package/dist/cjs/react/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useStateSignal = exports.setupReact = exports.useScope = exports.ContextProvider = void 0;
+exports.runReactiveSafe = exports.useStateSignal = exports.setupReact = exports.useScope = exports.ContextProvider = void 0;
 var provider_js_1 = require("./provider.js");
 Object.defineProperty(exports, "ContextProvider", { enumerable: true, get: function () { return provider_js_1.ContextProvider; } });
 var context_js_1 = require("./context.js");
@@ -9,4 +9,6 @@ var setup_js_1 = require("./setup.js");
 Object.defineProperty(exports, "setupReact", { enumerable: true, get: function () { return setup_js_1.setupReact; } });
 var state_js_1 = require("./state.js");
 Object.defineProperty(exports, "useStateSignal", { enumerable: true, get: function () { return state_js_1.useStateSignal; } });
+var rendering_js_1 = require("./rendering.js");
+Object.defineProperty(exports, "runReactiveSafe", { enumerable: true, get: function () { return rendering_js_1.runReactiveSafe; } });
 //# sourceMappingURL=index.js.map

package/dist/cjs/react/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/react/index.ts"],"names":[],"mappings":";;;AAAA,6CAAgD;AAAvC,8GAAA,eAAe,OAAA;AACxB,2CAAwC;AAA/B,sGAAA,QAAQ,OAAA;AACjB,uCAAwC;AAA/B,sGAAA,UAAU,OAAA;AACnB,uCAA4C;AAAnC,0GAAA,cAAc,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/react/index.ts"],"names":[],"mappings":";;;AAAA,6CAAgD;AAAvC,8GAAA,eAAe,OAAA;AACxB,2CAAwC;AAA/B,sGAAA,QAAQ,OAAA;AACjB,uCAAwC;AAA/B,sGAAA,UAAU,OAAA;AACnB,uCAA4C;AAAnC,0GAAA,cAAc,OAAA;AAEvB,+CAAiD;AAAxC,+GAAA,eAAe,OAAA"}

package/dist/cjs/react/rendering.d.ts

@@ -1,2 +1,8 @@
+/**
+ * Reactive functions can be called anywhere, but React Hooks cannot. When calling reactive functions
+ * in code that _may or may not_ be used while rendering, we need to use this function to wrap the
+ * call. This will ensure that we will not be in a rendering context when the reactive function is called.
+ */
+export declare const runReactiveSafe: <T>(fn: () => T) => T;
 export declare function isRendering(): boolean;
 //# sourceMappingURL=rendering.d.ts.map

package/dist/cjs/react/rendering.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rendering.d.ts","sourceRoot":"","sources":["../../../src/react/rendering.ts"],"names":[],"mappings":"AAcA,wBAAgB,WAAW,YAU1B"}
+{"version":3,"file":"rendering.d.ts","sourceRoot":"","sources":["../../../src/react/rendering.ts"],"names":[],"mappings":"AAgBA;;;;GAIG;AACH,eAAO,MAAM,eAAe,GAAI,CAAC,MAAM,MAAM,CAAC,KAAG,CAQhD,CAAC;AAEF,wBAAgB,WAAW,YAW1B"}

package/dist/cjs/react/rendering.js

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.runReactiveSafe = void 0;
 exports.isRendering = isRendering;
 const react_1 = __importDefault(require("react"));
 // This is a private React internal that we need to access to check if we are rendering.
@@ -14,9 +15,26 @@ const REACT_INTERNALS = react_1.default.__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WIL
     react_1.default.__SERVER_INTERNALS_DO_NOT_USE_OR_WARN_USERS_THEY_CANNOT_UPGRADE;
 const IS_REACT_18 = !!REACT_INTERNALS.ReactCurrentDispatcher;
 const ReactCurrentDispatcher = REACT_INTERNALS.ReactCurrentDispatcher || REACT_INTERNALS;
+let RENDERING_SAFE_MODE_COUNT = 0;
+/**
+ * Reactive functions can be called anywhere, but React Hooks cannot. When calling reactive functions
+ * in code that _may or may not_ be used while rendering, we need to use this function to wrap the
+ * call. This will ensure that we will not be in a rendering context when the reactive function is called.
+ */
+const runReactiveSafe = (fn) => {
+    RENDERING_SAFE_MODE_COUNT++;
+    try {
+        return fn();
+    }
+    finally {
+        RENDERING_SAFE_MODE_COUNT--;
+    }
+};
+exports.runReactiveSafe = runReactiveSafe;
 function isRendering() {
     const dispatcher = IS_REACT_18 ? ReactCurrentDispatcher.current : ReactCurrentDispatcher.H;
-    return (!!dispatcher &&
+    return (RENDERING_SAFE_MODE_COUNT === 0 &&
+        !!dispatcher &&
         // dispatcher can be in a state where it's defined, but all hooks are invalid to call.
         // Only way we can tell is that if they are invalid, they will all be equal to each other
         // (e.g. because it's the function that throws an error)

package/dist/cjs/react/rendering.js.map

@@ -1 +1 @@
-{"version":3,"file":"rendering.js","sourceRoot":"","sources":["../../../src/react/rendering.ts"],"names":[],"mappings":";;;;;AAcA,kCAUC;AAxBD,kDAA0B;AAE1B,wFAAwF;AACxF,oFAAoF;AACpF,mFAAmF;AACnF,0DAA0D;AAC1D,MAAM,eAAe,GAClB,eAAa,CAAC,kDAAkD;IAChE,eAAa,CAAC,+DAA+D;IAC7E,eAAa,CAAC,+DAA+D,CAAC;AAEjF,MAAM,WAAW,GAAG,CAAC,CAAC,eAAe,CAAC,sBAAsB,CAAC;AAC7D,MAAM,sBAAsB,GAAG,eAAe,CAAC,sBAAsB,IAAI,eAAe,CAAC;AAEzF,SAAgB,WAAW;IACzB,MAAM,UAAU,GAAG,WAAW,CAAC,CAAC,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC;IAE3F,OAAO,CACL,CAAC,CAAC,UAAU;QACZ,sFAAsF;QACtF,yFAAyF;QACzF,wDAAwD;QACxD,UAAU,CAAC,QAAQ,KAAK,UAAU,CAAC,SAAS,CAC7C,CAAC;AACJ,CAAC"}
+{"version":3,"file":"rendering.js","sourceRoot":"","sources":["../../../src/react/rendering.ts"],"names":[],"mappings":";;;;;;AA+BA,kCAWC;AA1CD,kDAA0B;AAE1B,wFAAwF;AACxF,oFAAoF;AACpF,mFAAmF;AACnF,0DAA0D;AAC1D,MAAM,eAAe,GAClB,eAAa,CAAC,kDAAkD;IAChE,eAAa,CAAC,+DAA+D;IAC7E,eAAa,CAAC,+DAA+D,CAAC;AAEjF,MAAM,WAAW,GAAG,CAAC,CAAC,eAAe,CAAC,sBAAsB,CAAC;AAC7D,MAAM,sBAAsB,GAAG,eAAe,CAAC,sBAAsB,IAAI,eAAe,CAAC;AAEzF,IAAI,yBAAyB,GAAG,CAAC,CAAC;AAElC;;;;GAIG;AACI,MAAM,eAAe,GAAG,CAAI,EAAW,EAAK,EAAE;IACnD,yBAAyB,EAAE,CAAC;IAE5B,IAAI,CAAC;QACH,OAAO,EAAE,EAAE,CAAC;IACd,CAAC;YAAS,CAAC;QACT,yBAAyB,EAAE,CAAC;IAC9B,CAAC;AACH,CAAC,CAAC;AARW,QAAA,eAAe,mBAQ1B;AAEF,SAAgB,WAAW;IACzB,MAAM,UAAU,GAAG,WAAW,CAAC,CAAC,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC;IAE3F,OAAO,CACL,yBAAyB,KAAK,CAAC;QAC/B,CAAC,CAAC,UAAU;QACZ,sFAAsF;QACtF,yFAAyF;QACzF,wDAAwD;QACxD,UAAU,CAAC,QAAQ,KAAK,UAAU,CAAC,SAAS,CAC7C,CAAC;AACJ,CAAC"}

package/dist/esm/react/index.d.ts

@@ -2,4 +2,5 @@ export { ContextProvider } from './provider.js';
 export { useScope } from './context.js';
 export { setupReact } from './setup.js';
 export { useStateSignal } from './state.js';
+export { runReactiveSafe } from './rendering.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/esm/react/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/react/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACxC,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/react/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACxC,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE5C,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC"}

package/dist/esm/react/index.js

@@ -2,4 +2,5 @@ export { ContextProvider } from './provider.js';
 export { useScope } from './context.js';
 export { setupReact } from './setup.js';
 export { useStateSignal } from './state.js';
+export { runReactiveSafe } from './rendering.js';
 //# sourceMappingURL=index.js.map

package/dist/esm/react/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/react/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACxC,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/react/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACxC,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE5C,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC"}

package/dist/esm/react/rendering.d.ts

@@ -1,2 +1,8 @@
+/**
+ * Reactive functions can be called anywhere, but React Hooks cannot. When calling reactive functions
+ * in code that _may or may not_ be used while rendering, we need to use this function to wrap the
+ * call. This will ensure that we will not be in a rendering context when the reactive function is called.
+ */
+export declare const runReactiveSafe: <T>(fn: () => T) => T;
 export declare function isRendering(): boolean;
 //# sourceMappingURL=rendering.d.ts.map

package/dist/esm/react/rendering.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rendering.d.ts","sourceRoot":"","sources":["../../../src/react/rendering.ts"],"names":[],"mappings":"AAcA,wBAAgB,WAAW,YAU1B"}
+{"version":3,"file":"rendering.d.ts","sourceRoot":"","sources":["../../../src/react/rendering.ts"],"names":[],"mappings":"AAgBA;;;;GAIG;AACH,eAAO,MAAM,eAAe,GAAI,CAAC,MAAM,MAAM,CAAC,KAAG,CAQhD,CAAC;AAEF,wBAAgB,WAAW,YAW1B"}

package/dist/esm/react/rendering.js

@@ -8,9 +8,25 @@ const REACT_INTERNALS = React.__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED
     React.__SERVER_INTERNALS_DO_NOT_USE_OR_WARN_USERS_THEY_CANNOT_UPGRADE;
 const IS_REACT_18 = !!REACT_INTERNALS.ReactCurrentDispatcher;
 const ReactCurrentDispatcher = REACT_INTERNALS.ReactCurrentDispatcher || REACT_INTERNALS;
+let RENDERING_SAFE_MODE_COUNT = 0;
+/**
+ * Reactive functions can be called anywhere, but React Hooks cannot. When calling reactive functions
+ * in code that _may or may not_ be used while rendering, we need to use this function to wrap the
+ * call. This will ensure that we will not be in a rendering context when the reactive function is called.
+ */
+export const runReactiveSafe = (fn) => {
+    RENDERING_SAFE_MODE_COUNT++;
+    try {
+        return fn();
+    }
+    finally {
+        RENDERING_SAFE_MODE_COUNT--;
+    }
+};
 export function isRendering() {
     const dispatcher = IS_REACT_18 ? ReactCurrentDispatcher.current : ReactCurrentDispatcher.H;
-    return (!!dispatcher &&
+    return (RENDERING_SAFE_MODE_COUNT === 0 &&
+        !!dispatcher &&
         // dispatcher can be in a state where it's defined, but all hooks are invalid to call.
         // Only way we can tell is that if they are invalid, they will all be equal to each other
         // (e.g. because it's the function that throws an error)

package/dist/esm/react/rendering.js.map

@@ -1 +1 @@
-{"version":3,"file":"rendering.js","sourceRoot":"","sources":["../../../src/react/rendering.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,wFAAwF;AACxF,oFAAoF;AACpF,mFAAmF;AACnF,0DAA0D;AAC1D,MAAM,eAAe,GAClB,KAAa,CAAC,kDAAkD;IAChE,KAAa,CAAC,+DAA+D;IAC7E,KAAa,CAAC,+DAA+D,CAAC;AAEjF,MAAM,WAAW,GAAG,CAAC,CAAC,eAAe,CAAC,sBAAsB,CAAC;AAC7D,MAAM,sBAAsB,GAAG,eAAe,CAAC,sBAAsB,IAAI,eAAe,CAAC;AAEzF,MAAM,UAAU,WAAW;IACzB,MAAM,UAAU,GAAG,WAAW,CAAC,CAAC,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC;IAE3F,OAAO,CACL,CAAC,CAAC,UAAU;QACZ,sFAAsF;QACtF,yFAAyF;QACzF,wDAAwD;QACxD,UAAU,CAAC,QAAQ,KAAK,UAAU,CAAC,SAAS,CAC7C,CAAC;AACJ,CAAC"}
+{"version":3,"file":"rendering.js","sourceRoot":"","sources":["../../../src/react/rendering.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,wFAAwF;AACxF,oFAAoF;AACpF,mFAAmF;AACnF,0DAA0D;AAC1D,MAAM,eAAe,GAClB,KAAa,CAAC,kDAAkD;IAChE,KAAa,CAAC,+DAA+D;IAC7E,KAAa,CAAC,+DAA+D,CAAC;AAEjF,MAAM,WAAW,GAAG,CAAC,CAAC,eAAe,CAAC,sBAAsB,CAAC;AAC7D,MAAM,sBAAsB,GAAG,eAAe,CAAC,sBAAsB,IAAI,eAAe,CAAC;AAEzF,IAAI,yBAAyB,GAAG,CAAC,CAAC;AAElC;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAI,EAAW,EAAK,EAAE;IACnD,yBAAyB,EAAE,CAAC;IAE5B,IAAI,CAAC;QACH,OAAO,EAAE,EAAE,CAAC;IACd,CAAC;YAAS,CAAC;QACT,yBAAyB,EAAE,CAAC;IAC9B,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,UAAU,WAAW;IACzB,MAAM,UAAU,GAAG,WAAW,CAAC,CAAC,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC;IAE3F,OAAO,CACL,yBAAyB,KAAK,CAAC;QAC/B,CAAC,CAAC,UAAU;QACZ,sFAAsF;QACtF,yFAAyF;QACzF,wDAAwD;QACxD,UAAU,CAAC,QAAQ,KAAK,UAAU,CAAC,SAAS,CAC7C,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "signalium",
-  "version": "1.1.1",
+  "version": "1.2.1",
   "type": "module",
   "repository": "https://github.com/pzuraq/signalium",
   "description": "Chain-reactivity at critical mass",

package/src/react/index.ts

@@ -2,3 +2,5 @@ export { ContextProvider } from './provider.js';
 export { useScope } from './context.js';
 export { setupReact } from './setup.js';
 export { useStateSignal } from './state.js';
+
+export { runReactiveSafe } from './rendering.js';

package/src/react/rendering.ts

@@ -12,10 +12,28 @@ const REACT_INTERNALS =
 const IS_REACT_18 = !!REACT_INTERNALS.ReactCurrentDispatcher;
 const ReactCurrentDispatcher = REACT_INTERNALS.ReactCurrentDispatcher || REACT_INTERNALS;
 
+let RENDERING_SAFE_MODE_COUNT = 0;
+
+/**
+ * Reactive functions can be called anywhere, but React Hooks cannot. When calling reactive functions
+ * in code that _may or may not_ be used while rendering, we need to use this function to wrap the
+ * call. This will ensure that we will not be in a rendering context when the reactive function is called.
+ */
+export const runReactiveSafe = <T>(fn: () => T): T => {
+  RENDERING_SAFE_MODE_COUNT++;
+
+  try {
+    return fn();
+  } finally {
+    RENDERING_SAFE_MODE_COUNT--;
+  }
+};
+
 export function isRendering() {
   const dispatcher = IS_REACT_18 ? ReactCurrentDispatcher.current : ReactCurrentDispatcher.H;
 
   return (
+    RENDERING_SAFE_MODE_COUNT === 0 &&
     !!dispatcher &&
     // dispatcher can be in a state where it's defined, but all hooks are invalid to call.
     // Only way we can tell is that if they are invalid, they will all be equal to each other