@esmj/signals 0.0.2

package/LICENSE

@@ -0,0 +1,8 @@
+
+Copyright 2024 Miroslav Jancarik jancarikmiroslav@gmail.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+# Signals
+
+// TODO

package/dist/index.d.mts

@@ -0,0 +1,266 @@
+import { Observable, Observer } from '@esmj/observable';
+
+let context = null;
+
+function untrack(callback) {
+  const prevContext = context;
+  context = null;
+  const result = callback();
+  context = prevContext;
+
+  return result;
+}
+
+const INTERNAL_OBSERVABLE = Symbol('internal observable');
+const ORIGINAL_NEXT = Symbol('original next');
+
+class Watcher extends Observable {
+  #pendings = new Set();
+  #notify = null;
+
+  constructor(notify) {
+    super();
+
+    this.#notify = notify;
+
+    this.pipe((observable) => {
+      const originalSubscribe = observable.subscribe.bind(observable);
+      observable.subscribe = (observer) => {
+        originalSubscribe(observer);
+        this.#pendings.add(observer);
+      };
+
+      return observable;
+    });
+  }
+  watch(signal) {
+    // Watch State
+    if (typeof signal.next !== 'function') {
+      signal.next = () => {
+        return untrack(() => {
+          this.#notify();
+        });
+      };
+      signal.next[ORIGINAL_NEXT] = undefined;
+    }
+
+    // WATCH Computed
+    if (
+      signal instanceof Computed &&
+      signal.next[ORIGINAL_NEXT] === undefined
+    ) {
+      const originalNext = signal.next.bind(signal);
+      signal.next = () => {
+        return untrack(() => {
+          originalNext();
+
+          this.#notify();
+        });
+      };
+      signal.next[ORIGINAL_NEXT] = originalNext;
+    }
+
+    return this.subscribe(signal);
+  }
+
+  getPending() {
+    return Array.from(this.#pendings);
+  }
+
+  unwatch(signal) {
+    signal.next = signal.next[ORIGINAL_NEXT];
+
+    return this.unsubscribe(signal);
+  }
+}
+
+let w = null;
+
+function createWatcher(notify) {
+  w = new Watcher(notify);
+}
+
+createWatcher(() => {
+  // TODO performance improvement
+  setTimeout(() => {
+    getPending().forEach((pending) => {
+      untrack(() => {
+        pending.get();
+      });
+    });
+  }, 0);
+});
+
+function getPending() {
+  return w.getPending();
+}
+
+function watch(signal) {
+  return w.watch(signal);
+}
+
+function unwatch(signal) {
+  return w.unwatch(signal);
+}
+
+class Computed extends Observer {
+  #dirty = true;
+  #prevContext = null;
+  #signal = null;
+  #context = this.#createNewContext();
+  #callback = null;
+  #options = null;
+
+  constructor(callback, options) {
+    super();
+
+    this.#callback = callback;
+    this.#options = options;
+
+    this.get = this.get.bind(this);
+  }
+
+  #clearContextDependencies() {
+    Array.from(this.#context.dependencies.values()).forEach(
+      ({ unsubscribe }) => {
+        unsubscribe();
+      },
+    );
+    this.#context.dependencies.clear();
+  }
+
+  #createNewContext() {
+    const context = {
+      dependencies: new Map(),
+      observer: this,
+    };
+
+    return context;
+  }
+
+  #savePrevContext() {
+    this.#prevContext = context;
+    context = this.#context;
+  }
+
+  #restorePrevContext() {
+    context = this.#prevContext;
+  }
+
+  next() {
+    this.#dirty = true;
+    this.#signal[INTERNAL_OBSERVABLE].next();
+  }
+
+  get() {
+    if (!this.#signal) {
+      this.#signal = createSignal(this.#run(), this.#options);
+    }
+
+    if (this.#dirty) {
+      this.#run();
+    }
+
+    return this.#signal.get();
+  }
+
+  #run() {
+    this.#dirty = false;
+
+    this.#clearContextDependencies();
+    this.#savePrevContext();
+
+    let result;
+    try {
+      result = this.#callback();
+    } catch (e) {
+      result = e;
+    }
+
+    this.#restorePrevContext();
+
+    // todo test it
+    if (result instanceof Promise) {
+      result = result
+        .then((value) => {
+          return value;
+        })
+        .catch((e) => {
+          throw e;
+        });
+    }
+
+    if (this.#signal) {
+      this.#signal.set(result);
+    }
+
+    if (result instanceof Error) {
+      throw result;
+    }
+
+    return result;
+  }
+}
+
+function computed(callback, options) {
+  const instance = new Computed(callback, options);
+
+  return instance;
+}
+
+function effect(callback) {
+  let destructor;
+
+  let c = computed(
+    () => {
+      destructor?.();
+      destructor = callback();
+    },
+    { equals: () => false },
+  );
+  c.get();
+
+  watch(c);
+  return () => {
+    destructor?.();
+    unwatch(c);
+  };
+}
+
+function createSignal(value, options = {}) {
+  const equals = options?.equals ?? Object.is;
+
+  const observable = new Observable();
+  function get() {
+    if (typeof context === 'object' && context !== null) {
+      context.dependencies.set(
+        observable,
+        observable.subscribe(context.observer),
+      );
+    }
+
+    if (value instanceof Error) {
+      throw value;
+    }
+
+    return value;
+  }
+
+  // TODO implement batch updates
+  function set(_value) {
+    if (!equals(value, _value)) {
+      value = _value;
+
+      observable.next();
+    }
+
+    return value;
+  }
+
+  return { get, set, [INTERNAL_OBSERVABLE]: observable };
+}
+
+// alias
+const state = createSignal;
+
+export { computed, createSignal, createWatcher, effect, getPending, state, untrack, unwatch, watch };

package/dist/index.d.ts

@@ -0,0 +1,266 @@
+import { Observable, Observer } from '@esmj/observable';
+
+let context = null;
+
+function untrack(callback) {
+  const prevContext = context;
+  context = null;
+  const result = callback();
+  context = prevContext;
+
+  return result;
+}
+
+const INTERNAL_OBSERVABLE = Symbol('internal observable');
+const ORIGINAL_NEXT = Symbol('original next');
+
+class Watcher extends Observable {
+  #pendings = new Set();
+  #notify = null;
+
+  constructor(notify) {
+    super();
+
+    this.#notify = notify;
+
+    this.pipe((observable) => {
+      const originalSubscribe = observable.subscribe.bind(observable);
+      observable.subscribe = (observer) => {
+        originalSubscribe(observer);
+        this.#pendings.add(observer);
+      };
+
+      return observable;
+    });
+  }
+  watch(signal) {
+    // Watch State
+    if (typeof signal.next !== 'function') {
+      signal.next = () => {
+        return untrack(() => {
+          this.#notify();
+        });
+      };
+      signal.next[ORIGINAL_NEXT] = undefined;
+    }
+
+    // WATCH Computed
+    if (
+      signal instanceof Computed &&
+      signal.next[ORIGINAL_NEXT] === undefined
+    ) {
+      const originalNext = signal.next.bind(signal);
+      signal.next = () => {
+        return untrack(() => {
+          originalNext();
+
+          this.#notify();
+        });
+      };
+      signal.next[ORIGINAL_NEXT] = originalNext;
+    }
+
+    return this.subscribe(signal);
+  }
+
+  getPending() {
+    return Array.from(this.#pendings);
+  }
+
+  unwatch(signal) {
+    signal.next = signal.next[ORIGINAL_NEXT];
+
+    return this.unsubscribe(signal);
+  }
+}
+
+let w = null;
+
+function createWatcher(notify) {
+  w = new Watcher(notify);
+}
+
+createWatcher(() => {
+  // TODO performance improvement
+  setTimeout(() => {
+    getPending().forEach((pending) => {
+      untrack(() => {
+        pending.get();
+      });
+    });
+  }, 0);
+});
+
+function getPending() {
+  return w.getPending();
+}
+
+function watch(signal) {
+  return w.watch(signal);
+}
+
+function unwatch(signal) {
+  return w.unwatch(signal);
+}
+
+class Computed extends Observer {
+  #dirty = true;
+  #prevContext = null;
+  #signal = null;
+  #context = this.#createNewContext();
+  #callback = null;
+  #options = null;
+
+  constructor(callback, options) {
+    super();
+
+    this.#callback = callback;
+    this.#options = options;
+
+    this.get = this.get.bind(this);
+  }
+
+  #clearContextDependencies() {
+    Array.from(this.#context.dependencies.values()).forEach(
+      ({ unsubscribe }) => {
+        unsubscribe();
+      },
+    );
+    this.#context.dependencies.clear();
+  }
+
+  #createNewContext() {
+    const context = {
+      dependencies: new Map(),
+      observer: this,
+    };
+
+    return context;
+  }
+
+  #savePrevContext() {
+    this.#prevContext = context;
+    context = this.#context;
+  }
+
+  #restorePrevContext() {
+    context = this.#prevContext;
+  }
+
+  next() {
+    this.#dirty = true;
+    this.#signal[INTERNAL_OBSERVABLE].next();
+  }
+
+  get() {
+    if (!this.#signal) {
+      this.#signal = createSignal(this.#run(), this.#options);
+    }
+
+    if (this.#dirty) {
+      this.#run();
+    }
+
+    return this.#signal.get();
+  }
+
+  #run() {
+    this.#dirty = false;
+
+    this.#clearContextDependencies();
+    this.#savePrevContext();
+
+    let result;
+    try {
+      result = this.#callback();
+    } catch (e) {
+      result = e;
+    }
+
+    this.#restorePrevContext();
+
+    // todo test it
+    if (result instanceof Promise) {
+      result = result
+        .then((value) => {
+          return value;
+        })
+        .catch((e) => {
+          throw e;
+        });
+    }
+
+    if (this.#signal) {
+      this.#signal.set(result);
+    }
+
+    if (result instanceof Error) {
+      throw result;
+    }
+
+    return result;
+  }
+}
+
+function computed(callback, options) {
+  const instance = new Computed(callback, options);
+
+  return instance;
+}
+
+function effect(callback) {
+  let destructor;
+
+  let c = computed(
+    () => {
+      destructor?.();
+      destructor = callback();
+    },
+    { equals: () => false },
+  );
+  c.get();
+
+  watch(c);
+  return () => {
+    destructor?.();
+    unwatch(c);
+  };
+}
+
+function createSignal(value, options = {}) {
+  const equals = options?.equals ?? Object.is;
+
+  const observable = new Observable();
+  function get() {
+    if (typeof context === 'object' && context !== null) {
+      context.dependencies.set(
+        observable,
+        observable.subscribe(context.observer),
+      );
+    }
+
+    if (value instanceof Error) {
+      throw value;
+    }
+
+    return value;
+  }
+
+  // TODO implement batch updates
+  function set(_value) {
+    if (!equals(value, _value)) {
+      value = _value;
+
+      observable.next();
+    }
+
+    return value;
+  }
+
+  return { get, set, [INTERNAL_OBSERVABLE]: observable };
+}
+
+// alias
+const state = createSignal;
+
+export { computed, createSignal, createWatcher, effect, getPending, state, untrack, unwatch, watch };

package/dist/index.js

@@ -0,0 +1 @@
+'use strict';var observable=require('@esmj/observable');var r=null;function h(n){let t=r;r=null;let e=n();return r=t,e}var x=Symbol("internal observable"),c=Symbol("original next"),f=class extends observable.Observable{#t=new Set;#e=null;constructor(t){super(),this.#e=t,this.pipe(e=>{let s=e.subscribe.bind(e);return e.subscribe=i=>{s(i),this.#t.add(i);},e});}watch(t){if(typeof t.next!="function"&&(t.next=()=>h(()=>{this.#e();}),t.next[c]=void 0),t instanceof o&&t.next[c]===void 0){let e=t.next.bind(t);t.next=()=>h(()=>{e(),this.#e();}),t.next[c]=e;}return this.subscribe(t)}getPending(){return Array.from(this.#t)}unwatch(t){return t.next=t.next[c],this.unsubscribe(t)}},u=null;function w(n){u=new f(n);}w(()=>{setTimeout(()=>{y().forEach(n=>{h(()=>{n.get();});});},0);});function y(){return u.getPending()}function g(n){return u.watch(n)}function m(n){return u.unwatch(n)}var o=class extends observable.Observer{#t=!0;#e=null;#n=null;#r=this.#u();#s=null;#i=null;constructor(t,e){super(),this.#s=t,this.#i=e,this.get=this.get.bind(this);}#o(){Array.from(this.#r.dependencies.values()).forEach(({unsubscribe:t})=>{t();}),this.#r.dependencies.clear();}#u(){return {dependencies:new Map,observer:this}}#h(){this.#e=r,r=this.#r;}#f(){r=this.#e;}next(){this.#t=!0,this.#n[x].next();}get(){return this.#n||(this.#n=d(this.#c(),this.#i)),this.#t&&this.#c(),this.#n.get()}#c(){this.#t=!1,this.#o(),this.#h();let t;try{t=this.#s();}catch(e){t=e;}if(this.#f(),t instanceof Promise&&(t=t.then(e=>e).catch(e=>{throw e})),this.#n&&this.#n.set(t),t instanceof Error)throw t;return t}};function E(n,t){return new o(n,t)}function P(n){let t,e=E(()=>{t?.(),t=n();},{equals:()=>!1});return e.get(),g(e),()=>{t?.(),m(e);}}function d(n,t={}){let e=t?.equals??Object.is,s=new observable.Observable;function i(){if(typeof r=="object"&&r!==null&&r.dependencies.set(s,s.subscribe(r.observer)),n instanceof Error)throw n;return n}function b(l){return e(n,l)||(n=l,s.next()),n}return {get:i,set:b,[x]:s}}var S=d;exports.computed=E;exports.createSignal=d;exports.createWatcher=w;exports.effect=P;exports.getPending=y;exports.state=S;exports.untrack=h;exports.unwatch=m;exports.watch=g;

package/dist/index.mjs

@@ -0,0 +1 @@
+import {Observable,Observer}from'@esmj/observable';var r=null;function h(n){let t=r;r=null;let e=n();return r=t,e}var x=Symbol("internal observable"),c=Symbol("original next"),f=class extends Observable{#t=new Set;#e=null;constructor(t){super(),this.#e=t,this.pipe(e=>{let s=e.subscribe.bind(e);return e.subscribe=i=>{s(i),this.#t.add(i);},e});}watch(t){if(typeof t.next!="function"&&(t.next=()=>h(()=>{this.#e();}),t.next[c]=void 0),t instanceof o&&t.next[c]===void 0){let e=t.next.bind(t);t.next=()=>h(()=>{e(),this.#e();}),t.next[c]=e;}return this.subscribe(t)}getPending(){return Array.from(this.#t)}unwatch(t){return t.next=t.next[c],this.unsubscribe(t)}},u=null;function w(n){u=new f(n);}w(()=>{setTimeout(()=>{y().forEach(n=>{h(()=>{n.get();});});},0);});function y(){return u.getPending()}function g(n){return u.watch(n)}function m(n){return u.unwatch(n)}var o=class extends Observer{#t=!0;#e=null;#n=null;#r=this.#u();#s=null;#i=null;constructor(t,e){super(),this.#s=t,this.#i=e,this.get=this.get.bind(this);}#o(){Array.from(this.#r.dependencies.values()).forEach(({unsubscribe:t})=>{t();}),this.#r.dependencies.clear();}#u(){return {dependencies:new Map,observer:this}}#h(){this.#e=r,r=this.#r;}#f(){r=this.#e;}next(){this.#t=!0,this.#n[x].next();}get(){return this.#n||(this.#n=d(this.#c(),this.#i)),this.#t&&this.#c(),this.#n.get()}#c(){this.#t=!1,this.#o(),this.#h();let t;try{t=this.#s();}catch(e){t=e;}if(this.#f(),t instanceof Promise&&(t=t.then(e=>e).catch(e=>{throw e})),this.#n&&this.#n.set(t),t instanceof Error)throw t;return t}};function E(n,t){return new o(n,t)}function P(n){let t,e=E(()=>{t?.(),t=n();},{equals:()=>!1});return e.get(),g(e),()=>{t?.(),m(e);}}function d(n,t={}){let e=t?.equals??Object.is,s=new Observable;function i(){if(typeof r=="object"&&r!==null&&r.dependencies.set(s,s.subscribe(r.observer)),n instanceof Error)throw n;return n}function b(l){return e(n,l)||(n=l,s.next()),n}return {get:i,set:b,[x]:s}}var S=d;export{E as computed,d as createSignal,w as createWatcher,P as effect,y as getPending,S as state,h as untrack,m as unwatch,g as watch};

package/package.json

@@ -0,0 +1,84 @@
+{
+  "name": "@esmj/signals",
+  "version": "0.0.2",
+  "description": "Tiny reactive signals.",
+  "keywords": [
+    "signals",
+    "reactive",
+    "effect",
+    "computed"
+  ],
+  "main": "dist/index",
+  "module": "dist/index",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "sideEffects": false,
+  "typings": "dist/index.d.ts",
+  "scripts": {
+    "lint:cmd": "eslint -c ./.eslintrc.js --ignore-path ./.prettierignore  --no-eslintrc",
+    "lint": "npm run lint:cmd -- 'src/**/*.ts'",
+    "lint:fix": "npm run lint -- --fix",
+    "dev": "node_modules/.bin/tsup --dts --watch --onSuccess 'node ./dist/index.mjs'",
+    "test": "node --test",
+    "test:watch": "npm run test -- --watchAll",
+    "preversion": "npm test && npm run lint && npm run build",
+    "version": "npm run changelog && git add CHANGELOG.md",
+    "postversion": "git push && git push --tags",
+    "commit": "node_modules/.bin/git-cz",
+    "changelog": "node_modules/.bin/conventional-changelog -p angular -i CHANGELOG.md -s -r 1",
+    "build": "node_modules/.bin/tsup --dts",
+    "prepare": "husky install"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mjancarik/esmj-task.git"
+  },
+  "author": "Miroslav Jancarik",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/mjancarik/esmj-task/issues"
+  },
+  "lint-staged": {
+    "**/*.{ts,js,mjs}": "npm run lint:cmd"
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "config": {
+    "commitizen": {
+      "path": "git-cz"
+    }
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "homepage": "https://github.com/mjancarik/esmj-task#readme",
+  "devDependencies": {
+    "@commitlint/cli": "^19.5.0",
+    "@commitlint/config-conventional": "^19.5.0",
+    "@typescript-eslint/eslint-plugin": "^8.12.2",
+    "@typescript-eslint/parser": "^8.12.2",
+    "commitizen": "^4.3.1",
+    "conventional-changelog-cli": "^5.0.0",
+    "cz-conventional-changelog": "^3.3.0",
+    "eslint": "^8.48.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-jasmine": "^4.2.2",
+    "eslint-plugin-prettier": "^5.2.1",
+    "git-cz": "^4.9.0",
+    "husky": "^9.1.6",
+    "lint-staged": "^15.2.10",
+    "prettier": "^3.3.3",
+    "tsup": "^8.3.5"
+  },
+  "dependencies": {
+    "@esmj/observable": "^0.1.1"
+  }
+}