reactjs-signal 1.1.1 → 1.1.3

package/README.md

@@ -25,7 +25,7 @@ npm install reactjs-signal
 
 ## Devtools
 
-- [reactjs-signal-devtools](https://github.com/hunghg255/reactjs-signal-devtools)
+- [reactjs-signal-devtools](https://github.com/hunghg255/reactjs-signal/tree/main/packages/reactjs-signal-devtools)
 
 ## Usage
 

package/dist/index.d.ts

@@ -1,4 +1,11 @@
-type IWritableSignal<T> = {
+/**
+ *
+ * React Alien Signals is a **TypeScript** library that provides hooks built on top of [Alien Signals](https://github.com/stackblitz/alien-signals).
+ * It offers a seamless integration with React, ensuring concurrency-safe re-renders without tearing.
+ *
+ * @module reactjs-signal
+ */
+type TWritableSignal<T> = {
     (): T;
     (value: T): void;
 };
@@ -13,21 +20,18 @@ type IWritableSignal<T> = {
  *
  * @template T - The type of the signal value.
  * @param {T} initialValue - The initial value of the signal.
- * @returns {IWritableSignal<T>} The created Alien Signal.
+ * @returns {TWritableSignal<T>} The created Alien Signal.
  */
-declare function createSignal<T>(initialValue: T): {
-    (): T;
-    (value: T): void;
-};
+declare function createSignal<T>(initialValue: T): TWritableSignal<T>;
 /**
  * Creates a writable Alien Signal that persists its value in localStorage.
  *
  * @template T - The type of the signal value.
  * @param {string} key - The localStorage key to use for persistence.
  * @param {T} initialValue - The initial value of the signal.
- * @returns {IWritableSignal<T>} The created Alien Signal.
+ * @returns {TWritableSignal<T>} The created Alien Signal.
  */
-declare function createSignalStorage<T>(key: string, initialValue: T): IWritableSignal<T>;
+declare function createSignalStorage<T>(key: string, initialValue: T): TWritableSignal<T>;
 /**
  * Creates a computed Alien Signal based on a getter function.
  *
@@ -72,10 +76,10 @@ declare function createEffect<T>(fn: () => T): () => void;
  * ```
  *
  * @template T - The type of the signal value.
- * @param {IWritableSignal<T>} alienSignal - The signal to read/write.
+ * @param {TWritableSignal<T>} alienSignal - The signal to read/write.
  * @returns {[T, (val: T | ((oldVal: T) => T)) => void]} A tuple [currentValue, setValue].
  */
-declare function useSignal<T>(alienSignal: IWritableSignal<T>): [T, (val: T | ((oldVal: T) => T)) => void];
+declare function useSignal<T>(alienSignal: TWritableSignal<T>): [T, (val: T | ((oldVal: T) => T)) => void];
 /**
  * React hook returning only the current value of an Alien Signal (or computed).
  * No setter is provided.
@@ -92,10 +96,10 @@ declare function useSignal<T>(alienSignal: IWritableSignal<T>): [T, (val: T | ((
  * ```
  *
  * @template T - The type of the signal value.
- * @param {IWritableSignal<T>} alienSignal - The signal to read.
+ * @param {TWritableSignal<T>} alienSignal - The signal to read.
  * @returns {T} The current value.
  */
-declare function useSignalValue<T>(alienSignal: IWritableSignal<T>): T;
+declare function useSignalValue<T>(alienSignal: TWritableSignal<T>): T;
 /**
  * React hook returning only a setter function for an Alien Signal.
  * No current value is provided, similar to Jotai's useSetAtom.
@@ -110,10 +114,10 @@ declare function useSignalValue<T>(alienSignal: IWritableSignal<T>): T;
  * ```
  *
  * @template T - The type of the signal value.
- * @param {IWritableSignal<T>} alienSignal - The signal to write.
+ * @param {TWritableSignal<T>} alienSignal - The signal to write.
  * @returns {(val: T | ((oldVal: T) => T)) => void} A setter function.
  */
-declare function useSetSignal<T>(alienSignal: IWritableSignal<T>): (val: T | ((oldVal: T) => T)) => void;
+declare function useSetSignal<T>(alienSignal: TWritableSignal<T>): (val: T | ((oldVal: T) => T)) => void;
 /**
  * React hook for running a side effect whenever Alien Signals' dependencies
  * used in `fn` change. The effect is cleaned up on component unmount.
@@ -138,9 +142,9 @@ declare function useSignalEffect(fn: () => void): void;
  * @returns
  *
  * @template T - The type of the signal value.
- * @param {IWritableSignal<T>} alienSignal - The signal to hydrate.
+ * @param {TWritableSignal<T>} alienSignal - The signal to hydrate.
  * @param {T} value - The value to hydrate the signal with.
  */
-declare function useHydrateSignal<T>(alienSignal: IWritableSignal<T>, value: T): void;
+declare function useHydrateSignal<T>(alienSignal: TWritableSignal<T>, value: T): void;
 
-export { createComputed, createEffect, createSignal, createSignalStorage, useHydrateSignal, useSetSignal, useSignal, useSignalEffect, useSignalValue };
+export { type TWritableSignal, createComputed, createEffect, createSignal, createSignalStorage, useHydrateSignal, useSetSignal, useSignal, useSignalEffect, useSignalValue };

package/dist/index.js

@@ -1 +1 @@
-import {signal,computed,effect}from'alien-signals';import {useSyncExternalStore,useEffect}from'react';var u=new WeakMap,l=t=>{let e=u.get(t);return e||(e=new WeakSet,u.set(t,e)),e};function d(t){return signal(t)}function y(t,e){let o=localStorage.getItem(t),r;if(o)try{r=JSON.parse(o);}catch(c){console.error(`Error parsing localStorage for key "${t}", using initial value.`,c),r=e;}else r=e;let n=d(r);return p(()=>{localStorage.setItem(t,JSON.stringify(n()));}),n}function W(t){return computed(t)}function p(t){return effect(t)}function I(t){return [useSyncExternalStore(r=>{let n=effect(()=>{t(),r();});return ()=>n()},()=>t(),()=>t()),r=>{t(typeof r=="function"?r(t()):r);}]}function x(t){return useSyncExternalStore(e=>{let o=effect(()=>{t(),e();});return ()=>o()},()=>t(),()=>t())}function b(t){return e=>{t(typeof e=="function"?e(t()):e);}}function m(t){useEffect(()=>{let e=effect(t);return ()=>e()},[]);}function v(t,e){let o=l(t);o.has(t)||(o.add(t),t(e));}export{W as createComputed,p as createEffect,d as createSignal,y as createSignalStorage,v as useHydrateSignal,b as useSetSignal,I as useSignal,m as useSignalEffect,x as useSignalValue};
+import {useSyncExternalStore,useEffect}from'react';import {signal,computed,effect}from'alien-signals';var a=new WeakMap;function l(t){let e=a.get(t);return e||(e=new WeakSet,a.set(t,e)),e}function d(t){return signal(t)}function y(t,e){let o=localStorage.getItem(t),r;if(o)try{r=JSON.parse(o);}catch(c){console.error(`Error parsing localStorage for key "${t}", using initial value.`,c),r=e;}else r=e;let n=d(r);return p(()=>{localStorage.setItem(t,JSON.stringify(n()));}),n}function W(t){return computed(t)}function p(t){return effect(t)}function x(t){return [useSyncExternalStore(r=>{let n=effect(()=>{t(),r();});return ()=>n()},()=>t(),()=>t()),r=>{t(typeof r=="function"?r(t()):r);}]}function b(t){return useSyncExternalStore(e=>{let o=effect(()=>{t(),e();});return ()=>o()},()=>t(),()=>t())}function m(t){return e=>{t(typeof e=="function"?e(t()):e);}}function v(t){useEffect(()=>{let e=effect(t);return ()=>e()},[]);}function V(t,e){let o=l(t);o.has(t)||(o.add(t),t(e));}export{W as createComputed,p as createEffect,d as createSignal,y as createSignalStorage,V as useHydrateSignal,m as useSetSignal,x as useSignal,v as useSignalEffect,b as useSignalValue};

package/package.json

@@ -1,59 +1,49 @@
 {
   "name": "reactjs-signal",
-  "version": "1.1.1",
-  "description": "",
   "type": "module",
-  "types": "./dist/index.d.ts",
+  "version": "1.1.3",
+  "description": "",
+  "author": "",
+  "license": "ISC",
+  "homepage": "https://github.com/hunghg255/reactjs-signal#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hunghg255/reactjs-signal.git"
+  },
+  "bugs": {
+    "url": "https://github.com/hunghg255/reactjs-signal/issues"
+  },
+  "keywords": [
+    "react",
+    "reactjs-signal",
+    "devtools"
+  ],
   "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
-      "import": "./dist/index.js",
-      "require": "./dist/index.js"
+      "require": "./dist/index.js",
+      "import": "./dist/index.js"
     }
   },
   "files": [
     "dist"
   ],
-  "scripts": {
-    "build": "tsup",
-    "watch": "npm run build -- --watch src",
-    "prepublishOnly": "npm run build",
-    "lint": "tsc",
-    "start": "esno src/index.ts",
-    "test": "vitest",
-    "verify-commit": "verify-commit-msg",
-    "prepare": "git-scm-hooks",
-    "release": "bumpp -r && npm publish"
+  "dependencies": {
+    "alien-signals": "^1.0.4"
+  },
+  "peerDependencies": {
+    "alien-signals": ">=1.0.0",
+    "react": ">=18"
   },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
   "devDependencies": {
     "@types/react": "^19.0.2",
-    "bumpp": "^9.2.1",
-    "git-scm-hooks": "^0.0.7",
     "tsup": "^8.0.1",
-    "typescript": "^5.3.3",
-    "verify-commit-msg": "^0.0.10"
-  },
-  "git-hooks": {
-    "pre-commit": "npm run lint",
-    "commit-msg": "npm run verify-commit"
-  },
-  "peerDependencies": {
-    "react": ">=18",
-    "alien-signals": ">=1.0.0"
-  },
-  "bugs": {
-    "url": "https://github.com/hunghg255/reactjs-signal/issues"
+    "typescript": "^5.3.3"
   },
-  "homepage": "https://github.com/hunghg255/reactjs-signal#readme",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/hunghg255/reactjs-signal.git"
-  },
-  "dependencies": {
-    "alien-signals": "^1.0.1"
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch"
   }
-}
+}