signalium 0.3.7 → 1.0.0

package/src/hooks.ts

@@ -1,402 +1,68 @@
 import {
-  createComputedSignal,
-  createAsyncComputedSignal,
-  createSubscriptionSignal,
-  getCurrentConsumer,
-  createWatcherSignal,
-  ComputedSignal,
-  createStateSignal,
-  createAsyncTaskSignal,
-  StateSignal,
-} from './signals.js';
-import {
-  type AsyncTask,
-  type AsyncReady,
-  type AsyncResult,
-  type Signal,
-  type SignalOptions,
-  type SignalOptionsWithInit,
-  Watcher,
-  WriteableSignal,
+  ReactiveTask,
+  ReactiveValue,
+  ReadyReactivePromise,
+  ReadyReactiveValue,
+  Signal,
+  SignalOptions,
   SignalSubscribe,
+  type SignalOptionsWithInit,
 } from './types.js';
-import { getObjectId, getUnknownSignalFnName, hashValue } from './utils.js';
-import { getFrameworkScope, useSignalValue } from './config.js';
-import WeakRef from './weakref.js';
-
-declare const CONTEXT_KEY: unique symbol;
-
-export type Context<T> = symbol & {
-  [CONTEXT_KEY]: T;
-};
-
-const CONTEXT_DEFAULT_VALUES = new Map<Context<unknown>, unknown>();
-const CONTEXT_MASKS = new Map<Context<unknown>, bigint>();
-
-let CONTEXT_MASKS_COUNT = 0;
-
-const COMPUTED_CONTEXT_MASKS = new Map<object, bigint>();
-export const COMPUTED_OWNERS = new WeakMap<ComputedSignal<unknown>, SignalScope>();
-
-let CURRENT_MASK: bigint | null = null;
-
-export const state = <T>(value: T, opts?: Partial<SignalOptions<T, unknown[]>>): WriteableSignal<T> => {
-  const signal = createStateSignal(value, opts) as StateSignal<T>;
-
-  return {
-    set(v: T) {
-      signal.set(v);
-    },
-
-    get() {
-      // eslint-disable-next-line react-hooks/rules-of-hooks
-      return useSignalValue(signal._desc, () => signal.get());
-    },
-  };
-};
-
-export const createContext = <T>(initialValue: T, description?: string) => {
-  const count = CONTEXT_MASKS_COUNT++;
-  const key = Symbol(description ?? `context:${count}`) as Context<T>;
-
-  CONTEXT_DEFAULT_VALUES.set(key, initialValue);
-  CONTEXT_MASKS.set(key, BigInt(1) << BigInt(count));
-
-  return key;
-};
-
-export type SignalStoreMap = {
-  [K in Context<unknown>]: K extends Context<infer T> ? T : never;
-};
-
-export class SignalScope {
-  constructor(
-    contexts: SignalStoreMap,
-    private parent?: SignalScope,
-  ) {
-    this.contexts = Object.create(parent?.contexts || null);
-
-    for (const key of Object.getOwnPropertySymbols(contexts)) {
-      this.contexts[key as Context<unknown>] = contexts[key as Context<unknown>];
-      this.contextMask |= CONTEXT_MASKS.get(key as Context<unknown>)!;
-    }
-  }
-
-  private contexts: SignalStoreMap;
-  private children = new Map<string, SignalScope>();
-  private contextMask = 0n;
-  private signals = new Map<string, WeakRef<Signal<unknown>>>();
-
-  getChild(contexts: SignalStoreMap) {
-    const key = hashValue(contexts);
-
-    let child = this.children.get(key);
-
-    if (child === undefined) {
-      child = new SignalScope(contexts, this);
-      this.children.set(key, child);
-    }
-
-    return child;
-  }
-
-  getContext<T>(context: Context<T>): T | undefined {
-    const value = this.contexts[context];
-
-    if (CURRENT_MASK !== null) {
-      CURRENT_MASK |= CONTEXT_MASKS.get(context)!;
-    }
-
-    return value as T | undefined;
-  }
-
-  private getSignal(key: string, computedMask: bigint): Signal<unknown> | undefined {
-    return (this.contextMask & computedMask) === 0n && this.parent
-      ? this.parent.getSignal(key, computedMask)
-      : this.signals.get(key)?.deref();
-  }
-
-  private setSignal(key: string, signal: Signal<unknown>, mask: bigint, isPromoting: boolean) {
-    if ((this.contextMask & mask) === 0n && this.parent) {
-      this.parent.setSignal(key, signal, mask, isPromoting);
-    } else {
-      this.signals.set(key, new WeakRef(signal));
-
-      if (isPromoting) {
-        this.parent?.deleteSignal(key);
-      }
-    }
-  }
-
-  private deleteSignal(key: string) {
-    this.signals.delete(key);
-    this.parent?.deleteSignal(key);
-  }
-
-  run(fn: (...args: any[]) => any, args: any[], key: string, signal: Signal<unknown>, initialized: boolean) {
-    const prevMask = CURRENT_MASK;
-    const fnMask = COMPUTED_CONTEXT_MASKS.get(fn) ?? 0n;
-    const signalMask = COMPUTED_CONTEXT_MASKS.get(signal) ?? 0n;
-
-    try {
-      CURRENT_MASK = signalMask | fnMask;
-
-      return fn(...args);
-    } finally {
-      if (!initialized || signalMask !== CURRENT_MASK) {
-        COMPUTED_CONTEXT_MASKS.set(fn, CURRENT_MASK!);
-        COMPUTED_CONTEXT_MASKS.set(signal, CURRENT_MASK!);
-        getCurrentScope().setSignal(key, signal!, CURRENT_MASK!, initialized);
-        initialized = true;
-      }
-
-      CURRENT_MASK = prevMask;
-    }
-  }
-
-  get(
-    makeSignal: (
-      fn: (...args: any[]) => any,
-      opts?: Partial<SignalOptionsWithInit<unknown, unknown[]>>,
-    ) => Signal<unknown>,
-    fn: (...args: any[]) => any,
-    key: string,
-    params: string,
-    args: unknown[],
-    opts?: Partial<SignalOptions<unknown, unknown[]>>,
-  ): unknown {
-    const computedMask = COMPUTED_CONTEXT_MASKS.get(fn) ?? 0n;
-
-    const fnName = opts?.desc ?? fn.name ?? getUnknownSignalFnName(fn, makeSignal);
-
-    let signal = this.getSignal(key, computedMask);
-
-    if (signal === undefined) {
-      const optsWithMeta = { ...opts, id: key, desc: fnName, params };
-      let initialized = false;
-
-      if (makeSignal === createSubscriptionSignal) {
-        signal = makeSignal(state => {
-          const sub = this.run(fn, [state, ...args], key, signal!, initialized);
-
-          if (typeof sub === 'object' && sub !== null && sub?.update) {
-            const originalUpdate = sub.update;
-
-            sub.update = () => {
-              return this.run(originalUpdate, [], key, signal!, initialized);
-            };
-          }
-
-          initialized = true;
-
-          return sub;
-        }, optsWithMeta);
-      } else {
-        signal = makeSignal((...runArgs) => {
-          const result = this.run(fn, [...args, ...runArgs], key, signal!, initialized);
-
-          initialized = true;
-
-          return result;
-        }, optsWithMeta);
-      }
-    }
+import { useDerivedSignal } from './config.js';
+import { getCurrentScope, SignalScope } from './internals/contexts.js';
+import { createStateSignal } from './internals/state.js';
+import { createDerivedSignal } from './internals/derived.js';
+import { ReactivePromise } from './internals/async.js';
+import { Tracer } from './trace.js';
 
-    COMPUTED_OWNERS.set(signal as ComputedSignal<unknown>, this);
+export const state = createStateSignal;
 
-    const value = signal.get();
-
-    if (CURRENT_MASK !== null) {
-      CURRENT_MASK |= COMPUTED_CONTEXT_MASKS.get(fn) ?? 0n;
-    }
-
-    return value;
-  }
-}
-
-export let ROOT_SCOPE = new SignalScope({});
-
-export const clearRootScope = () => {
-  ROOT_SCOPE = new SignalScope({});
-};
-
-let OVERRIDE_SCOPE: SignalScope | undefined;
-
-export const getOverrideScope = () => {
-  return OVERRIDE_SCOPE;
-};
-
-export const setOverrideScope = (scope: SignalScope | undefined) => {
-  OVERRIDE_SCOPE = scope;
-};
-
-const getCurrentScope = (): SignalScope => {
-  if (OVERRIDE_SCOPE !== undefined) {
-    return OVERRIDE_SCOPE;
-  }
-
-  const currentConsumer = getCurrentConsumer();
-
-  if (currentConsumer) {
-    const scope = COMPUTED_OWNERS.get(currentConsumer);
-
-    return scope ?? ROOT_SCOPE;
-  }
-
-  return getFrameworkScope() ?? ROOT_SCOPE;
-};
-
-export const withContext = <T>(contexts: SignalStoreMap, fn: () => T): T => {
-  const prevScope = OVERRIDE_SCOPE;
-  const currentScope = getCurrentScope();
-
-  try {
-    OVERRIDE_SCOPE = currentScope.getChild(contexts);
-    return fn();
-  } finally {
-    OVERRIDE_SCOPE = prevScope;
-  }
-};
-
-export const useContext = <T>(context: Context<T>): T => {
-  let scope = OVERRIDE_SCOPE;
-
-  if (scope === undefined) {
-    const currentConsumer = getCurrentConsumer();
-    scope = currentConsumer ? COMPUTED_OWNERS.get(currentConsumer) : undefined;
-  }
-
-  if (scope === undefined) {
-    scope = getFrameworkScope();
-  }
-
-  if (scope === undefined) {
-    throw new Error(
-      'useContext must be used within a signal hook, a withContext, or within a framework-specific context provider.',
-    );
-  }
-
-  return scope.getContext(context) ?? (CONTEXT_DEFAULT_VALUES.get(context) as T);
-};
-
-const getParamsKey = (args: unknown[], opts?: Partial<SignalOptions<any, any[]>>) => {
-  return opts?.paramKey ? opts.paramKey(...args) : args.map(arg => hashValue(arg)).join(', ');
-};
-
-const getComputedKey = (fn: (...args: any[]) => any, params: string) => {
-  const fnId = getObjectId(fn);
-  return `${fnId}(${params})`;
-};
-
-export function computed<T, Args extends unknown[]>(
+export function reactive<T, Args extends unknown[]>(
+  fn: (...args: Args) => T,
+  opts?: Partial<SignalOptionsWithInit<T, Args>>,
+): (...args: Args) => ReactiveValue<T>;
+export function reactive<T, Args extends unknown[]>(
   fn: (...args: Args) => T,
-  opts?: Partial<SignalOptions<T, Args>>,
-): (...args: Args) => T {
-  return (...args) => {
-    const params = getParamsKey(args, opts);
-    const key = getComputedKey(fn, params);
-
-    return useSignalValue(key, () => {
-      const scope = getCurrentScope();
-      return scope.get(
-        createComputedSignal,
-        fn,
-        key,
-        params,
-        args,
-        opts as Partial<SignalOptionsWithInit<unknown, unknown[]>>,
-      ) as T;
-    });
-  };
-}
-
-export type AsyncAwaitableResult<T> = T | Promise<T>;
-
-export function asyncComputed<T, Args extends unknown[]>(
-  fn: (...args: Args) => T | Promise<T>,
-  opts?: SignalOptions<T, Args>,
-): (...args: Args) => AsyncResult<T>;
-export function asyncComputed<T, Args extends unknown[]>(
-  fn: (...args: Args) => T | Promise<T>,
   opts: SignalOptionsWithInit<T, Args>,
-): (...args: Args) => AsyncReady<T>;
-export function asyncComputed<T, Args extends unknown[]>(
-  fn: (...args: Args) => T | Promise<T>,
+): (...args: Args) => ReadyReactiveValue<T>;
+export function reactive<T, Args extends unknown[]>(
+  fn: (...args: Args) => T,
   opts?: Partial<SignalOptionsWithInit<T, Args>>,
-): (...args: Args) => AsyncResult<T> | AsyncReady<T> {
+): (...args: Args) => ReactiveValue<T> {
   return (...args) => {
-    const params = getParamsKey(args, opts);
-    const key = getComputedKey(fn, params);
+    const scope = getCurrentScope();
+    const signal = scope.get(fn as any, args, opts);
 
-    return useSignalValue(key, () => {
-      const scope = getCurrentScope();
-      return scope.get(
-        createAsyncComputedSignal,
-        fn,
-        key,
-        params,
-        args,
-        opts as Partial<SignalOptionsWithInit<unknown, unknown[]>>,
-      ) as AsyncResult<T>;
-    });
+    return useDerivedSignal(signal)!;
   };
 }
 
-export function subscription<T, Args extends unknown[]>(
-  fn: SignalSubscribe<T, Args>,
-  opts?: Partial<SignalOptionsWithInit<T, Args>>,
-): (...args: Args) => T {
-  return (...args) => {
-    const params = getParamsKey(args, opts);
-    const key = getComputedKey(fn, params);
-
-    return useSignalValue(key, () => {
-      const scope = getCurrentScope();
-      return scope.get(
-        createSubscriptionSignal,
-        fn,
-        key,
-        params,
-        args,
-        opts as Partial<SignalOptionsWithInit<unknown, unknown[]>>,
-      ) as T;
-    });
-  };
+export function subscription<T>(subscribe: SignalSubscribe<T>, opts?: SignalOptions<T, unknown[]>): ReactivePromise<T>;
+export function subscription<T>(
+  subscribe: SignalSubscribe<T>,
+  opts: SignalOptionsWithInit<T, unknown[]>,
+): ReadyReactivePromise<T>;
+export function subscription<T>(
+  subscribe: SignalSubscribe<T>,
+  opts?: Partial<SignalOptionsWithInit<T, unknown[]>>,
+): ReactivePromise<T> | ReadyReactivePromise<T> {
+  const scope = getCurrentScope();
+
+  return ReactivePromise.createSubscription(subscribe, scope, opts);
 }
 
-export const asyncTask = <T, Args extends unknown[]>(
+export const task = <T, Args extends unknown[]>(
   fn: (...args: Args) => Promise<T>,
   opts?: Partial<SignalOptionsWithInit<T, Args>>,
-): (<BuildArgs extends unknown[], RunArgs extends Args extends [...BuildArgs, ...infer _Rest] ? _Rest : Args>(
-  ...args: Args extends [...BuildArgs, ...infer _Rest] ? BuildArgs : Args
-) => AsyncTask<T, RunArgs>) => {
-  return (...args) => {
-    const params = getParamsKey(args, opts);
-    const key = getComputedKey(fn, params);
+): ReactiveTask<T, Args> => {
+  const scope = getCurrentScope();
 
-    return useSignalValue(key, () => {
-      const scope = getCurrentScope();
-      return scope.get(
-        createAsyncTaskSignal,
-        fn,
-        key,
-        params,
-        args,
-        opts as Partial<SignalOptionsWithInit<unknown, unknown[]>>,
-      ) as AsyncTask<T>;
-    });
-  };
+  return ReactivePromise.createTask(fn, scope, opts);
 };
 
 export function watcher<T>(
-  fn: (prev: T | undefined) => T,
-  opts?: SignalOptions<T, unknown[]> & { scope?: SignalScope },
-): Watcher<T> {
-  const scope = opts?.scope ?? ROOT_SCOPE;
-
-  const w = createWatcherSignal(fn, opts);
-
-  COMPUTED_OWNERS.set(w as ComputedSignal<unknown>, scope);
-
-  return w;
+  fn: () => T,
+  opts?: SignalOptions<T, unknown[]> & { scope?: SignalScope; tracer?: Tracer },
+): Signal<ReactiveValue<T>> {
+  return createDerivedSignal(fn, undefined, undefined, opts?.scope, opts);
 }

package/src/index.ts

@@ -1,30 +1,13 @@
 export type * from './types.js';
 
-export {
-  createStateSignal,
-  createComputedSignal,
-  createAsyncComputedSignal,
-  createSubscriptionSignal,
-  createWatcherSignal,
-  createAsyncTaskSignal,
-  getCurrentConsumer,
-} from './signals.js';
+export { state, reactive, subscription, task, watcher } from './hooks.js';
 
-export {
-  state,
-  createContext,
-  useContext,
-  withContext,
-  computed,
-  asyncComputed,
-  asyncTask,
-  subscription,
-  watcher,
-  SignalScope,
-  type Context,
-  type SignalStoreMap,
-} from './hooks.js';
+export { isReactivePromise, isReactiveTask, isReactiveSubscription } from './internals/async.js';
+
+export { callback } from './internals/get.js';
+
+export { createContext, useContext, withContexts, SignalScope, CONTEXT_KEY } from './internals/contexts.js';
 
 export { setConfig } from './config.js';
 
-export { hashValue as stringifyArgs } from './utils.js';
+export { hashValue, registerCustomHash } from './internals/utils/hash.js';