@j13b/react-state 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 TCN
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,16 @@
+@j13b/react-state
+Copyright 2026 Jared J Barnes
+
+This package contains the React bindings extracted from @j13b/state,
+which is a fork of @tcn/state
+(https://www.npmjs.com/package/@tcn/state):
+
+    Copyright 2024 TCN
+    Licensed under the Apache License, Version 2.0
+
+The fork and all subsequent modifications by Jared J Barnes are also
+distributed under the Apache License, Version 2.0. See LICENSE.
+
+Files in this repository may have been modified from the @tcn/state
+distribution. Refer to the git history for the complete record of
+changes (Apache License 2.0 § 4(b)).

package/README.md

@@ -0,0 +1,60 @@
+# @j13b/react-state
+
+React bindings for [`@j13b/state`](https://github.com/jaredjbarnes/state) — hooks for subscribing to `Signal`s, `Runner`s, and broadcasts from React components.
+
+## Install
+
+```bash
+npm install @j13b/react-state @j13b/state
+```
+
+Peer dependencies: `@j13b/state` (^0.2.0), `react` (^18.2.0), and `react-dom` (^18.2.0).
+
+## Quick start
+
+```tsx
+import { Signal } from "@j13b/state";
+import { useSignalValue } from "@j13b/react-state";
+
+const counter = new Signal(0);
+
+function Counter() {
+  const value = useSignalValue(counter.broadcast);
+  return <button onClick={() => counter.set(value + 1)}>Count: {value}</button>;
+}
+```
+
+## Hooks
+
+| Hook | Returns / does |
+|---|---|
+| `useSignalValue(broadcast)` | Current value; re-renders on change. |
+| `useSignalValueEffect(cb, broadcast)` | Runs `cb` on value changes without re-rendering. |
+| `useUpdate()` | A function that forces a re-render. |
+| `useRunnerStatus(broadcast)` | The runner's `Status` (INITIAL, PENDING, SUCCESS, ERROR). |
+| `useRunnerStatusEffect(cb, task)` | Runs `cb` on status changes. |
+| `useRunnerError(task)` | The runner's current `Error \| null`. |
+| `useRunnerErrorEffect(cb, task)` | Runs `cb` on error changes. |
+| `useRunnerProgress(task)` | The runner's progress (0–1). |
+| `useRunnerProgressEffect(cb, task)` | Runs `cb` on progress changes. |
+| `useRunnerFeedback(task)` | The runner's feedback message. |
+| `useRunnerFeedbackEffect(cb, task)` | Runs `cb` on feedback changes. |
+
+This package pairs with [`@j13b/state`](https://www.npmjs.com/package/@j13b/state), which provides the framework-agnostic primitives (`Signal`, `Runner`, `DerivedSignal`, events, and helpers) that these hooks subscribe to.
+
+## Scripts
+
+```bash
+npm run build         # vite + dts → dist/
+npm run check:types   # tsc --noEmit
+npm test              # vitest watch
+npm run test:run      # vitest run (CI)
+```
+
+## Origins
+
+These hooks were extracted from `@j13b/state`, which is a fork of [`@tcn/state`](https://www.npmjs.com/package/@tcn/state) (Copyright 2024 TCN). See [`NOTICE`](./NOTICE) for upstream attribution.
+
+## License
+
+Apache License 2.0 — see [LICENSE](./LICENSE).

package/dist/cjs/hooks/use_runner_error.d.ts

@@ -0,0 +1,25 @@
+import { IRunnerBroadcast } from '@j13b/state';
+/**
+ * A React hook that subscribes to the error state of a runner.
+ *
+ * @template T - The type of value that the runner manages
+ * @param {IRunnerBroadcast<T>} task - The runner broadcast interface to subscribe to
+ * @returns {Error | null} The current error state of the runner, or null if there is no error
+ *
+ * @example
+ * ```tsx
+ * const error = useRunnerError(saveRunner.broadcast);
+ * if (error) {
+ *   return <ErrorMessage error={error} />;
+ * }
+ * ```
+ *
+ * @remarks
+ * This hook is useful for:
+ * - Displaying error messages in the UI
+ * - Conditionally rendering error states
+ * - Triggering error handling logic
+ *
+ * The hook will automatically unsubscribe when the component unmounts.
+ */
+export declare function useRunnerError(task: IRunnerBroadcast<any>): Error | null;

package/dist/cjs/hooks/use_runner_error.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useRunnerError = useRunnerError;
+const use_signal_value_js_1 = require("./use_signal_value.js");
+/**
+ * A React hook that subscribes to the error state of a runner.
+ *
+ * @template T - The type of value that the runner manages
+ * @param {IRunnerBroadcast<T>} task - The runner broadcast interface to subscribe to
+ * @returns {Error | null} The current error state of the runner, or null if there is no error
+ *
+ * @example
+ * ```tsx
+ * const error = useRunnerError(saveRunner.broadcast);
+ * if (error) {
+ *   return <ErrorMessage error={error} />;
+ * }
+ * ```
+ *
+ * @remarks
+ * This hook is useful for:
+ * - Displaying error messages in the UI
+ * - Conditionally rendering error states
+ * - Triggering error handling logic
+ *
+ * The hook will automatically unsubscribe when the component unmounts.
+ */
+function useRunnerError(task) {
+    return (0, use_signal_value_js_1.useSignalValue)(task.stateBroadcast).error;
+}

package/dist/cjs/hooks/use_runner_error_effect.d.ts

@@ -0,0 +1,28 @@
+import { IRunnerBroadcast } from '@j13b/state';
+/**
+ * A React hook that executes a callback whenever the error state of a Runner changes.
+ * This hook is useful for handling side effects that need to respond to error states
+ * in async operations managed by a Runner.
+ *
+ * @template T - The type of value managed by the Runner
+ * @param callback - A function that will be called with the current error state
+ * @param task - The Runner instance to monitor for error changes
+ * @returns void
+ *
+ * @example
+ * ```tsx
+ * useRunnerErrorEffect((error) => {
+ *   if (error) {
+ *     // Handle the error, e.g., show a notification
+ *     showErrorNotification(error.message);
+ *   }
+ * }, myRunner);
+ * ```
+ *
+ * @remarks
+ * - The callback will be called immediately with the current error state
+ * - The callback will be called whenever the error state changes
+ * - The hook automatically handles cleanup on component unmount
+ * - This hook is built on top of useSignalValueEffect for efficient state tracking
+ */
+export declare function useRunnerErrorEffect(callback: (error: Error | null) => void, task: IRunnerBroadcast<any>): void;

package/dist/cjs/hooks/use_runner_error_effect.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useRunnerErrorEffect = useRunnerErrorEffect;
+const use_signal_value_effect_js_1 = require("./use_signal_value_effect.js");
+/**
+ * A React hook that executes a callback whenever the error state of a Runner changes.
+ * This hook is useful for handling side effects that need to respond to error states
+ * in async operations managed by a Runner.
+ *
+ * @template T - The type of value managed by the Runner
+ * @param callback - A function that will be called with the current error state
+ * @param task - The Runner instance to monitor for error changes
+ * @returns void
+ *
+ * @example
+ * ```tsx
+ * useRunnerErrorEffect((error) => {
+ *   if (error) {
+ *     // Handle the error, e.g., show a notification
+ *     showErrorNotification(error.message);
+ *   }
+ * }, myRunner);
+ * ```
+ *
+ * @remarks
+ * - The callback will be called immediately with the current error state
+ * - The callback will be called whenever the error state changes
+ * - The hook automatically handles cleanup on component unmount
+ * - This hook is built on top of useSignalValueEffect for efficient state tracking
+ */
+function useRunnerErrorEffect(callback, task) {
+    return (0, use_signal_value_effect_js_1.useSignalValueEffect)(state => {
+        callback(state.error);
+    }, task.stateBroadcast);
+}

package/dist/cjs/hooks/use_runner_feedback.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @module hooks/use_runner_feedback
+ *
+ * This module provides a hook for accessing the feedback message from a Runner's state.
+ * It is useful for displaying status messages to users during async operations.
+ */
+import { IRunnerBroadcast } from '@j13b/state';
+/**
+ * Hook that provides access to the feedback message from a Runner's state.
+ *
+ * @template T - The type of the Runner's value
+ * @param {IRunnerBroadcast<T>} task - The Runner broadcast interface to subscribe to
+ * @returns {string | undefined} The current feedback message, or undefined if no feedback is set
+ *
+ * @example
+ * ```tsx
+ * const feedback = useRunnerFeedback(saveRunner.broadcast);
+ * return <div>{feedback}</div>;
+ * ```
+ *
+ * @remarks
+ * This hook is useful for displaying status messages to users during async operations.
+ * The feedback message is typically set using the Runner's setFeedback method.
+ * The component will automatically re-render when the feedback message changes.
+ */
+export declare function useRunnerFeedback(task: IRunnerBroadcast<any>): string;

package/dist/cjs/hooks/use_runner_feedback.js

@@ -0,0 +1,31 @@
+"use strict";
+/**
+ * @module hooks/use_runner_feedback
+ *
+ * This module provides a hook for accessing the feedback message from a Runner's state.
+ * It is useful for displaying status messages to users during async operations.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useRunnerFeedback = useRunnerFeedback;
+const use_signal_value_js_1 = require("./use_signal_value.js");
+/**
+ * Hook that provides access to the feedback message from a Runner's state.
+ *
+ * @template T - The type of the Runner's value
+ * @param {IRunnerBroadcast<T>} task - The Runner broadcast interface to subscribe to
+ * @returns {string | undefined} The current feedback message, or undefined if no feedback is set
+ *
+ * @example
+ * ```tsx
+ * const feedback = useRunnerFeedback(saveRunner.broadcast);
+ * return <div>{feedback}</div>;
+ * ```
+ *
+ * @remarks
+ * This hook is useful for displaying status messages to users during async operations.
+ * The feedback message is typically set using the Runner's setFeedback method.
+ * The component will automatically re-render when the feedback message changes.
+ */
+function useRunnerFeedback(task) {
+    return (0, use_signal_value_js_1.useSignalValue)(task.stateBroadcast).feedback;
+}

package/dist/cjs/hooks/use_runner_feedback_effect.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @module hooks/use_runner_feedback_effect
+ *
+ * This module provides a React hook for handling feedback messages from a Runner.
+ * It allows components to react to changes in the feedback state of async operations.
+ */
+import { IRunnerBroadcast } from '@j13b/state';
+/**
+ * A React hook that executes a callback whenever the feedback message of a Runner changes.
+ *
+ * This hook is useful for displaying operation feedback to users, such as loading messages,
+ * progress updates, or error notifications. It automatically handles cleanup when the
+ * component unmounts.
+ *
+ * @example
+ * ```tsx
+ * useRunnerFeedbackEffect(
+ *   (feedback) => {
+ *     // Update UI with feedback message
+ *     setMessage(feedback);
+ *   },
+ *   myRunner.broadcast
+ * );
+ * ```
+ *
+ * @param callback - A function that will be called with the new feedback message whenever it changes
+ * @param task - The Runner's broadcast interface to subscribe to
+ * @returns void
+ */
+export declare function useRunnerFeedbackEffect(callback: (feedback: string) => void, task: IRunnerBroadcast<any>): void;

package/dist/cjs/hooks/use_runner_feedback_effect.js

@@ -0,0 +1,37 @@
+"use strict";
+/**
+ * @module hooks/use_runner_feedback_effect
+ *
+ * This module provides a React hook for handling feedback messages from a Runner.
+ * It allows components to react to changes in the feedback state of async operations.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useRunnerFeedbackEffect = useRunnerFeedbackEffect;
+const use_signal_value_effect_js_1 = require("./use_signal_value_effect.js");
+/**
+ * A React hook that executes a callback whenever the feedback message of a Runner changes.
+ *
+ * This hook is useful for displaying operation feedback to users, such as loading messages,
+ * progress updates, or error notifications. It automatically handles cleanup when the
+ * component unmounts.
+ *
+ * @example
+ * ```tsx
+ * useRunnerFeedbackEffect(
+ *   (feedback) => {
+ *     // Update UI with feedback message
+ *     setMessage(feedback);
+ *   },
+ *   myRunner.broadcast
+ * );
+ * ```
+ *
+ * @param callback - A function that will be called with the new feedback message whenever it changes
+ * @param task - The Runner's broadcast interface to subscribe to
+ * @returns void
+ */
+function useRunnerFeedbackEffect(callback, task) {
+    return (0, use_signal_value_effect_js_1.useSignalValueEffect)(state => {
+        callback(state.feedback);
+    }, task.stateBroadcast);
+}

package/dist/cjs/hooks/use_runner_progress.d.ts

@@ -0,0 +1,21 @@
+/**
+ * A React hook that subscribes to the progress state of a Runner.
+ *
+ * @template T - The type of the Runner's value
+ * @param {IRunnerBroadcast<T>} task - The Runner broadcast interface to subscribe to
+ * @returns {number} A number between 0 and 1 representing the current progress of the task
+ *
+ * @example
+ * ```tsx
+ * const progress = useRunnerProgress(saveRunner.broadcast);
+ * // progress will be a number between 0 and 1
+ * // 0 = not started, 1 = complete
+ * ```
+ *
+ * @remarks
+ * This hook is useful for tracking the progress of long-running operations
+ * such as file uploads, data processing, or any task that can report progress.
+ * The component will automatically re-render when the progress value changes.
+ */
+import { IRunnerBroadcast } from '@j13b/state';
+export declare function useRunnerProgress(task: IRunnerBroadcast<any>): number;

package/dist/cjs/hooks/use_runner_progress.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useRunnerProgress = useRunnerProgress;
+const use_signal_value_js_1 = require("./use_signal_value.js");
+function useRunnerProgress(task) {
+    return (0, use_signal_value_js_1.useSignalValue)(task.stateBroadcast).progress;
+}

package/dist/cjs/hooks/use_runner_progress_effect.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @module hooks/use_runner_progress_effect
+ *
+ * This module provides a React hook for tracking the progress of a Runner operation.
+ * It allows components to react to progress changes in long-running operations.
+ */
+import { IRunnerBroadcast } from '@j13b/state';
+/**
+ * Hook that executes a callback whenever the progress of a Runner operation changes.
+ *
+ * @template T - The type of the Runner's value
+ * @param callback - Function to be called when progress changes. Receives the current progress value (0-1)
+ * @param task - The Runner broadcast interface to track progress from
+ * @returns void
+ *
+ * @example
+ * ```tsx
+ * useRunnerProgressEffect(
+ *   (progress) => {
+ *     console.log(`Operation is ${progress * 100}% complete`);
+ *   },
+ *   myRunner.broadcast
+ * );
+ * ```
+ *
+ * @remarks
+ * - The callback will be called with a number between 0 and 1 representing progress
+ * - The effect is automatically cleaned up when the component unmounts
+ * - This hook is built on top of useSignalValueEffect for efficient state tracking
+ */
+export declare function useRunnerProgressEffect(callback: (progress: number) => void, task: IRunnerBroadcast<any>): void;

package/dist/cjs/hooks/use_runner_progress_effect.js

@@ -0,0 +1,38 @@
+"use strict";
+/**
+ * @module hooks/use_runner_progress_effect
+ *
+ * This module provides a React hook for tracking the progress of a Runner operation.
+ * It allows components to react to progress changes in long-running operations.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useRunnerProgressEffect = useRunnerProgressEffect;
+const use_signal_value_effect_js_1 = require("./use_signal_value_effect.js");
+/**
+ * Hook that executes a callback whenever the progress of a Runner operation changes.
+ *
+ * @template T - The type of the Runner's value
+ * @param callback - Function to be called when progress changes. Receives the current progress value (0-1)
+ * @param task - The Runner broadcast interface to track progress from
+ * @returns void
+ *
+ * @example
+ * ```tsx
+ * useRunnerProgressEffect(
+ *   (progress) => {
+ *     console.log(`Operation is ${progress * 100}% complete`);
+ *   },
+ *   myRunner.broadcast
+ * );
+ * ```
+ *
+ * @remarks
+ * - The callback will be called with a number between 0 and 1 representing progress
+ * - The effect is automatically cleaned up when the component unmounts
+ * - This hook is built on top of useSignalValueEffect for efficient state tracking
+ */
+function useRunnerProgressEffect(callback, task) {
+    return (0, use_signal_value_effect_js_1.useSignalValueEffect)(state => {
+        callback(state.progress);
+    }, task.stateBroadcast);
+}

package/dist/cjs/hooks/use_runner_status.d.ts

@@ -0,0 +1,23 @@
+import { IRunnerBroadcast } from '@j13b/state';
+/**
+ * A hook that subscribes to a runner's status changes and returns the current status.
+ * The component will re-render whenever the runner's status changes.
+ *
+ * @template T - The type of the runner's value
+ * @param broadcast - The broadcast interface of the runner to subscribe to
+ * @returns The current status of the runner (INITIAL, PENDING, SUCCESS, ERROR)
+ *
+ * @example
+ * ```tsx
+ * const status = useRunnerStatus(runner.broadcast);
+ *
+ * return (
+ *   <div>
+ *     {status === 'PENDING' && <Spinner />}
+ *     {status === 'ERROR' && <ErrorMessage />}
+ *     {status === 'SUCCESS' && <SuccessMessage />}
+ *   </div>
+ * );
+ * ```
+ */
+export declare function useRunnerStatus(broadcast: IRunnerBroadcast<any>): import("@j13b/state").Status;