use-effect-ts 0.0.1 → 0.0.3

package/README.md

@@ -1,3 +1,3 @@
 # use-effect-ts
 
-Effect.TS hooks for React.
+React hooks for Effect.TS 🚀

package/dist/index.d.ts

@@ -1,2 +1,7 @@
-export {};
+export { useComponentLifecycle } from "./use-component-lifecycle.js";
+export { useRunEffect } from "./use-run-effect.js";
+export { useRunEffectLatest } from "./use-run-effect-latest.js";
+export { useRunEffectQueue } from "./use-run-effect-queue.js";
+export { useComponentScope } from "./use-component-scope.js";
+export { useLiveRef } from "./use-live-ref.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AACrE,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC"}

package/dist/index.js

@@ -1,2 +1,6 @@
-console.log("Hello, World!");
-export {};
+export { useComponentLifecycle } from "./use-component-lifecycle.js";
+export { useRunEffect } from "./use-run-effect.js";
+export { useRunEffectLatest } from "./use-run-effect-latest.js";
+export { useRunEffectQueue } from "./use-run-effect-queue.js";
+export { useComponentScope } from "./use-component-scope.js";
+export { useLiveRef } from "./use-live-ref.js";

package/dist/use-component-lifecycle.d.ts

@@ -0,0 +1,5 @@
+import { Effect, Scope } from "effect";
+export declare function useComponentLifecycle(effect: Effect.Effect<unknown, unknown, Scope.Scope>, { deps, }?: {
+    deps?: unknown[];
+}): void;
+//# sourceMappingURL=use-component-lifecycle.d.ts.map

package/dist/use-component-lifecycle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-component-lifecycle.d.ts","sourceRoot":"","sources":["../src/use-component-lifecycle.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAS,KAAK,EAAE,MAAM,QAAQ,CAAC;AAI9C,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,EACpD,EACE,IAAS,GACV,GAAE;IACD,IAAI,CAAC,EAAE,OAAO,EAAE,CAAC;CACb,QAkBP"}

package/dist/use-component-lifecycle.js

@@ -0,0 +1,17 @@
+import { Effect, Fiber, Scope } from "effect";
+import { useEffect } from "react";
+import { useLiveRef } from "./use-live-ref.js";
+export function useComponentLifecycle(effect, { deps = [], } = {}) {
+    const effectRef = useLiveRef(effect);
+    useEffect(() => {
+        const scope = Effect.runSync(Scope.make());
+        const fiber = Effect.runFork(effectRef.current.pipe(Scope.extend(scope)));
+        return () => {
+            Effect.runFork(Effect.gen(function* () {
+                const exit = yield* Fiber.interrupt(fiber);
+                yield* Scope.close(scope, exit);
+            }));
+            void Effect.runPromise(Fiber.interrupt(fiber));
+        };
+    }, [effectRef, ...deps]);
+}

package/dist/use-component-scope.d.ts

@@ -0,0 +1,3 @@
+import { Scope } from "effect";
+export declare function useComponentScope(setup?: (scope: Scope.CloseableScope) => void): Scope.CloseableScope | undefined;
+//# sourceMappingURL=use-component-scope.d.ts.map

package/dist/use-component-scope.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-component-scope.d.ts","sourceRoot":"","sources":["../src/use-component-scope.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,KAAK,EAAE,MAAM,QAAQ,CAAC;AAG7C,wBAAgB,iBAAiB,CAC/B,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,cAAc,KAAK,IAAI,GAC5C,KAAK,CAAC,cAAc,GAAG,SAAS,CAclC"}

package/dist/use-component-scope.js

@@ -0,0 +1,14 @@
+import { Effect, Exit, Scope } from "effect";
+import { useEffect, useState } from "react";
+export function useComponentScope(setup) {
+    const [scope, setScope] = useState();
+    useEffect(() => {
+        const s = Effect.runSync(Scope.make());
+        setScope(s);
+        setup?.(s);
+        return () => {
+            void Effect.runPromise(Scope.close(s, Exit.void));
+        };
+    }, []);
+    return scope;
+}

package/dist/use-live-ref.d.ts

@@ -0,0 +1,4 @@
+export declare function useLiveRef<T>(value: T): {
+    current: T;
+};
+//# sourceMappingURL=use-live-ref.d.ts.map

package/dist/use-live-ref.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-live-ref.d.ts","sourceRoot":"","sources":["../src/use-live-ref.ts"],"names":[],"mappings":"AAEA,wBAAgB,UAAU,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG;IAAE,OAAO,EAAE,CAAC,CAAA;CAAE,CAKtD"}

package/dist/use-live-ref.js

@@ -0,0 +1,6 @@
+import { useRef } from "react";
+export function useLiveRef(value) {
+    const ref = useRef(value);
+    ref.current = value;
+    return ref;
+}

package/dist/use-run-effect-latest.d.ts

@@ -0,0 +1,3 @@
+import { Effect } from "effect";
+export declare function useRunEffectLatest<Args extends any[], A, E>(fn: (...args: Args) => Effect.Effect<A, E, never>): (...args: Args) => Promise<import("effect/Exit").Exit<import("effect/Fiber").RuntimeFiber<A, E>, never>>;
+//# sourceMappingURL=use-run-effect-latest.d.ts.map

package/dist/use-run-effect-latest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-run-effect-latest.d.ts","sourceRoot":"","sources":["../src/use-run-effect-latest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAsB,MAAM,QAAQ,CAAC;AAIpD,wBAAgB,kBAAkB,CAAC,IAAI,SAAS,GAAG,EAAE,EAAE,CAAC,EAAE,CAAC,EACzD,EAAE,EAAE,CAAC,GAAG,IAAI,EAAE,IAAI,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,IAYzC,GAAG,MAAM,IAAI,2FAStB"}

package/dist/use-run-effect-latest.js

@@ -0,0 +1,16 @@
+import { Effect, FiberHandle, Scope } from "effect";
+import { useComponentScope } from "./use-component-scope.js";
+import { useState } from "react";
+export function useRunEffectLatest(fn) {
+    const [fiberHandle, setFiberHandle] = useState(null);
+    useComponentScope((scope) => {
+        const fiberHandle = Effect.runSync(FiberHandle.make().pipe(Scope.extend(scope)));
+        setFiberHandle(fiberHandle);
+    });
+    return (...args) => {
+        if (!fiberHandle) {
+            throw new Error("useRunEffectLatest: No scope available, effect will not run. Consider using useComponentLifecycle to call initial run.");
+        }
+        return Effect.runPromiseExit(FiberHandle.run(fiberHandle, fn(...args)));
+    };
+}

package/dist/use-run-effect-queue.d.ts

@@ -0,0 +1,3 @@
+import { Effect } from "effect";
+export declare function useRunEffectQueue<Args extends any[], A, E>(fn: (...args: Args) => Effect.Effect<A, E, never>): (...args: Args) => void;
+//# sourceMappingURL=use-run-effect-queue.d.ts.map

package/dist/use-run-effect-queue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-run-effect-queue.d.ts","sourceRoot":"","sources":["../src/use-run-effect-queue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAA6B,MAAM,QAAQ,CAAC;AAI3D,wBAAgB,iBAAiB,CAAC,IAAI,SAAS,GAAG,EAAE,EAAE,CAAC,EAAE,CAAC,EACxD,EAAE,EAAE,CAAC,GAAG,IAAI,EAAE,IAAI,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,IA8BzC,GAAG,MAAM,IAAI,UAItB"}

package/dist/use-run-effect-queue.js

@@ -0,0 +1,29 @@
+import { Effect, Fiber, FiberHandle, Scope } from "effect";
+import { useComponentScope } from "./use-component-scope.js";
+import { useEffect, useRef } from "react";
+export function useRunEffectQueue(fn) {
+    const queue = useRef([]);
+    const scope = useComponentScope();
+    const isExecuting = useRef(false);
+    const runFromQueue = () => {
+        const [first, ...rest] = queue.current;
+        if (!scope || !first || isExecuting.current) {
+            return;
+        }
+        queue.current = rest;
+        isExecuting.current = true;
+        Effect.runPromiseExit(Effect.gen(function* () {
+            const fiberHandle = yield* FiberHandle.make().pipe(Scope.extend(scope));
+            const fiber = yield* FiberHandle.run(fiberHandle)(fn(...first));
+            yield* Fiber.join(fiber);
+        })).finally(() => {
+            isExecuting.current = false;
+            runFromQueue();
+        });
+    };
+    useEffect(runFromQueue, [scope]);
+    return (...args) => {
+        queue.current.push(args);
+        runFromQueue();
+    };
+}

package/dist/use-run-effect.d.ts

@@ -0,0 +1,3 @@
+import { Effect } from "effect";
+export declare function useRunEffect<Args extends any[], A, E>(fn: (...args: Args) => Effect.Effect<A, E, never>): (...args: Args) => Promise<import("effect/Exit").Exit<import("effect/Fiber").RuntimeFiber<A, E>, never>>;
+//# sourceMappingURL=use-run-effect.d.ts.map

package/dist/use-run-effect.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-run-effect.d.ts","sourceRoot":"","sources":["../src/use-run-effect.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAmB,MAAM,QAAQ,CAAC;AAIjD,wBAAgB,YAAY,CAAC,IAAI,SAAS,GAAG,EAAE,EAAE,CAAC,EAAE,CAAC,EACnD,EAAE,EAAE,CAAC,GAAG,IAAI,EAAE,IAAI,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,IAQzC,GAAG,MAAM,IAAI,2FAStB"}

package/dist/use-run-effect.js

@@ -0,0 +1,16 @@
+import { Effect, FiberSet, Scope } from "effect";
+import { useComponentScope } from "./use-component-scope.js";
+import { useState } from "react";
+export function useRunEffect(fn) {
+    const [fiberSet, setFiberSet] = useState(null);
+    useComponentScope((scope) => {
+        const fiberSet = Effect.runSync(FiberSet.make().pipe(Scope.extend(scope)));
+        setFiberSet(fiberSet);
+    });
+    return (...args) => {
+        if (!fiberSet) {
+            throw new Error("useRunEffect: No scope available, effect will not run. Consider using useComponentLifecycle to call initial run.");
+        }
+        return Effect.runPromiseExit(FiberSet.run(fiberSet, fn(...args)));
+    };
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "use-effect-ts",
   "type": "module",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "exports": {
     ".": "./dist/index.js",
     "./*": "./dist/*"
@@ -12,14 +12,15 @@
     "README.md",
     "LICENCE"
   ],
-  "dependencies": {
-    "effect": "3.16.9"
-  },
   "devDependencies": {
     "@tsconfig/node22": "22.0.2",
+    "@types/react": "^19.1.8",
+    "effect": "3.16.12",
+    "react": "19.1.0",
     "typescript": "5.8.3"
   },
   "peerDependencies": {
+    "effect": ">=3.0.0",
     "react": ">=18.0.0"
   },
   "scripts": {

package/src/index.ts

@@ -1 +1,6 @@
-console.log("Hello, World!");
+export { useComponentLifecycle } from "./use-component-lifecycle.js";
+export { useRunEffect } from "./use-run-effect.js";
+export { useRunEffectLatest } from "./use-run-effect-latest.js";
+export { useRunEffectQueue } from "./use-run-effect-queue.js";
+export { useComponentScope } from "./use-component-scope.js";
+export { useLiveRef } from "./use-live-ref.js";

package/src/use-component-lifecycle.ts

@@ -0,0 +1,29 @@
+import { Effect, Fiber, Scope } from "effect";
+import { useEffect } from "react";
+import { useLiveRef } from "./use-live-ref.js";
+
+export function useComponentLifecycle(
+  effect: Effect.Effect<unknown, unknown, Scope.Scope>,
+  {
+    deps = [],
+  }: {
+    deps?: unknown[];
+  } = {},
+) {
+  const effectRef = useLiveRef(effect);
+
+  useEffect(() => {
+    const scope = Effect.runSync(Scope.make());
+    const fiber = Effect.runFork(effectRef.current.pipe(Scope.extend(scope)));
+
+    return () => {
+      Effect.runFork(
+        Effect.gen(function* () {
+          const exit = yield* Fiber.interrupt(fiber);
+          yield* Scope.close(scope, exit);
+        }),
+      );
+      void Effect.runPromise(Fiber.interrupt(fiber));
+    };
+  }, [effectRef, ...deps]);
+}

package/src/use-component-scope.ts

@@ -0,0 +1,20 @@
+import { Effect, Exit, Scope } from "effect";
+import { useEffect, useState } from "react";
+
+export function useComponentScope(
+  setup?: (scope: Scope.CloseableScope) => void,
+): Scope.CloseableScope | undefined {
+  const [scope, setScope] = useState<Scope.CloseableScope>();
+
+  useEffect(() => {
+    const s = Effect.runSync(Scope.make());
+    setScope(s);
+    setup?.(s);
+
+    return () => {
+      void Effect.runPromise(Scope.close(s, Exit.void));
+    };
+  }, []);
+
+  return scope;
+}

package/src/use-live-ref.ts

@@ -0,0 +1,8 @@
+import { useRef } from "react";
+
+export function useLiveRef<T>(value: T): { current: T } {
+  const ref = useRef(value);
+  ref.current = value;
+
+  return ref;
+}

package/src/use-run-effect-latest.ts

@@ -0,0 +1,27 @@
+import { Effect, FiberHandle, Scope } from "effect";
+import { useComponentScope } from "./use-component-scope.js";
+import { useState } from "react";
+
+export function useRunEffectLatest<Args extends any[], A, E>(
+  fn: (...args: Args) => Effect.Effect<A, E, never>,
+) {
+  const [fiberHandle, setFiberHandle] =
+    useState<FiberHandle.FiberHandle | null>(null);
+
+  useComponentScope((scope) => {
+    const fiberHandle = Effect.runSync(
+      FiberHandle.make().pipe(Scope.extend(scope)),
+    );
+    setFiberHandle(fiberHandle);
+  });
+
+  return (...args: Args) => {
+    if (!fiberHandle) {
+      throw new Error(
+        "useRunEffectLatest: No scope available, effect will not run. Consider using useComponentLifecycle to call initial run.",
+      );
+    }
+
+    return Effect.runPromiseExit(FiberHandle.run(fiberHandle, fn(...args)));
+  };
+}

package/src/use-run-effect-queue.ts

@@ -0,0 +1,40 @@
+import { Effect, Fiber, FiberHandle, Scope } from "effect";
+import { useComponentScope } from "./use-component-scope.js";
+import { useEffect, useRef } from "react";
+
+export function useRunEffectQueue<Args extends any[], A, E>(
+  fn: (...args: Args) => Effect.Effect<A, E, never>,
+) {
+  const queue = useRef<Args[]>([]);
+  const scope = useComponentScope();
+
+  const isExecuting = useRef(false);
+  const runFromQueue = () => {
+    const [first, ...rest] = queue.current;
+    if (!scope || !first || isExecuting.current) {
+      return;
+    }
+
+    queue.current = rest;
+    isExecuting.current = true;
+    Effect.runPromiseExit(
+      Effect.gen(function* () {
+        const fiberHandle = yield* FiberHandle.make().pipe(Scope.extend(scope));
+
+        const fiber = yield* FiberHandle.run(fiberHandle)(fn(...first));
+
+        yield* Fiber.join(fiber);
+      }),
+    ).finally(() => {
+      isExecuting.current = false;
+      runFromQueue();
+    });
+  };
+
+  useEffect(runFromQueue, [scope]);
+
+  return (...args: Args) => {
+    queue.current.push(args);
+    runFromQueue();
+  };
+}

package/src/use-run-effect.ts

@@ -0,0 +1,23 @@
+import { Effect, FiberSet, Scope } from "effect";
+import { useComponentScope } from "./use-component-scope.js";
+import { useState } from "react";
+
+export function useRunEffect<Args extends any[], A, E>(
+  fn: (...args: Args) => Effect.Effect<A, E, never>,
+) {
+  const [fiberSet, setFiberSet] = useState<FiberSet.FiberSet | null>(null);
+  useComponentScope((scope) => {
+    const fiberSet = Effect.runSync(FiberSet.make().pipe(Scope.extend(scope)));
+    setFiberSet(fiberSet);
+  });
+
+  return (...args: Args) => {
+    if (!fiberSet) {
+      throw new Error(
+        "useRunEffect: No scope available, effect will not run. Consider using useComponentLifecycle to call initial run.",
+      );
+    }
+
+    return Effect.runPromiseExit(FiberSet.run(fiberSet, fn(...args)));
+  };
+}