global: snapshot

website/libraries/solid-signals/README.md

@@ -0,0 +1,5 @@
+Compiled version of: https://github.com/solidjs/signals
+
+Head:
+- SHA: 4d75d3f84ce22b560988f3b27a5065c0fd2e69a8
+- Date: Apr 17, 2024

website/libraries/solid-signals/types/constants.d.ts

@@ -0,0 +1,10 @@
+/**
+ * See https://dev.to/modderme123/super-charging-fine-grained-reactive-performance-47ph
+ * State clean corresponds to a node where all the sources are fully up to date
+ * State check corresponds to a node where some sources (including grandparents) may have changed
+ * State dirty corresponds to a node where the direct parents of a node has changed
+ */
+export declare const STATE_CLEAN = 0;
+export declare const STATE_CHECK = 1;
+export declare const STATE_DIRTY = 2;
+export declare const STATE_DISPOSED = 3;

website/libraries/solid-signals/types/core.d.ts

@@ -0,0 +1,143 @@
+/**
+ * Nodes for constructing a graph of reactive values and reactive computations.
+ *
+ * - The graph is acyclic.
+ * - The user inputs new values into the graph by calling .write() on one more computation nodes.
+ * - The user retrieves computed results from the graph by calling .read() on one or more computation nodes.
+ * - The library is responsible for running any necessary computations so that .read() is up to date
+ *   with all prior .write() calls anywhere in the graph.
+ * - We call the input nodes 'roots' and the output nodes 'leaves' of the graph here.
+ * - Changes flow from roots to leaves. It would be effective but inefficient to immediately
+ *   propagate all changes from a root through the graph to descendant leaves. Instead, we defer
+ *   change most change propagation computation until a leaf is accessed. This allows us to
+ *   coalesce computations and skip altogether recalculating unused sections of the graph.
+ * - Each computation node tracks its sources and its observers (observers are other
+ *   elements that have this node as a source). Source and observer links are updated automatically
+ *   as observer computations re-evaluate and call get() on their sources.
+ * - Each node stores a cache state (clean/check/dirty) to support the change propagation algorithm:
+ *
+ * In general, execution proceeds in three passes:
+ *
+ *  1. write() propagates changes down the graph to the leaves
+ *     direct children are marked as dirty and their deeper descendants marked as check
+ *     (no computations are evaluated)
+ *  2. read() requests that parent nodes updateIfNecessary(), which proceeds recursively up the tree
+ *     to decide whether the node is clean (parents unchanged) or dirty (parents changed)
+ *  3. updateIfNecessary() evaluates the computation if the node is dirty (the computations are
+ *     executed in root to leaf order)
+ */
+import { type Flags } from './flags';
+import { Owner } from './owner';
+export interface SignalOptions<T> {
+    name?: string;
+    equals?: ((prev: T, next: T) => boolean) | false;
+}
+export interface MemoOptions<T> extends SignalOptions<T> {
+    initial?: T;
+}
+interface SourceType {
+    _observers: ObserverType[] | null;
+    _updateIfNecessary: () => void;
+    _stateFlags: Flags;
+}
+interface ObserverType {
+    _sources: SourceType[] | null;
+    _notify: (state: number) => void;
+    _handlerMask: Flags;
+    _notifyFlags: (mask: Flags, newFlags: Flags) => void;
+}
+/**
+ * Returns the current observer.
+ */
+export declare function getObserver(): ObserverType | null;
+export declare const UNCHANGED: unique symbol;
+export type UNCHANGED = typeof UNCHANGED;
+export declare class Computation<T = any> extends Owner implements SourceType, ObserverType {
+    _sources: SourceType[] | null;
+    _observers: ObserverType[] | null;
+    _value: T | undefined;
+    _compute: null | (() => T);
+    _name: string | undefined;
+    _equals: false | ((a: T, b: T) => boolean);
+    /** Whether the computation is an error or has ancestors that are unresolved */
+    _stateFlags: number;
+    /** Which flags raised by sources are handled, vs. being passed through. */
+    _handlerMask: number;
+    _error: Computation<boolean> | null;
+    _loading: Computation<boolean> | null;
+    constructor(initialValue: T | undefined, compute: null | (() => T), options?: MemoOptions<T>);
+    _read(): T;
+    /**
+     * Return the current value of this computation
+     * Automatically re-executes the surrounding computation when the value changes
+     */
+    read(): T;
+    /**
+     * Return the current value of this computation
+     * Automatically re-executes the surrounding computation when the value changes
+     *
+     * If the computation has any unresolved ancestors, this function waits for the value to resolve
+     * before continuing
+     */
+    wait(): T;
+    /**
+     * Return true if the computation is the value is dependent on an unresolved promise
+     * Triggers re-execution of the computation when the loading state changes
+     *
+     * This is useful especially when effects want to re-execute when a computation's
+     * loading state changes
+     */
+    loading(): boolean;
+    /**
+     * Return true if the computation is the computation threw an error
+     * Triggers re-execution of the computation when the error state changes
+     */
+    error(): boolean;
+    /** Update the computation with a new value. */
+    write(value: T | ((currentValue: T) => T) | UNCHANGED, flags?: number, raw?: boolean): T;
+    /**
+     * Set the current node's state, and recursively mark all of this node's observers as STATE_CHECK
+     */
+    _notify(state: number): void;
+    /**
+     * Notify the computation that one of its sources has changed flags.
+     *
+     * @param mask A bitmask for which flag(s) were changed.
+     * @param newFlags The source's new flags, masked to just the changed ones.
+     */
+    _notifyFlags(mask: Flags, newFlags: Flags): void;
+    _setError(error: unknown): void;
+    /**
+     * This is the core part of the reactivity system, which makes sure that the values are updated
+     * before they are read. We've also adapted it to return the loading state of the computation,
+     * so that we can propagate that to the computation's observers.
+     *
+     * This function will ensure that the value and states we read from the computation are up to date
+     */
+    _updateIfNecessary(): void;
+    /**
+     * Remove ourselves from the owner graph and the computation graph
+     */
+    _disposeNode(): void;
+}
+/**
+ * Reruns a computation's _compute function, producing a new value and keeping track of dependencies.
+ *
+ * It handles the updating of sources and observers, disposal of previous executions,
+ * and error handling if the _compute function throws. It also sets the node as loading
+ * if it reads any parents that are currently loading.
+ */
+export declare function update<T>(node: Computation<T>): void;
+export declare function isEqual<T>(a: T, b: T): boolean;
+/**
+ * Returns the current value stored inside the given compute function without triggering any
+ * dependencies. Use `untrack` if you want to also disable owner tracking.
+ */
+export declare function untrack<T>(fn: () => T): T;
+/**
+ * A convenient wrapper that calls `compute` with the `owner` and `observer` and is guaranteed
+ * to reset the global context after the computation is finished even if an error is thrown.
+ */
+export declare function compute<T>(owner: Owner | null, compute: (val: T) => T, observer: Computation<T>): T;
+export declare function compute<T>(owner: Owner | null, compute: (val: undefined) => T, observer: null): T;
+export {};

website/libraries/solid-signals/types/effect.d.ts

@@ -0,0 +1,25 @@
+import { Computation, type MemoOptions } from './core';
+/**
+ * By default, changes are batched on the microtask queue which is an async process. You can flush
+ * the queue synchronously to get the latest updates by calling `flushSync()`.
+ */
+export declare function flushSync(): void;
+/**
+ * Effects are the leaf nodes of our reactive graph. When their sources change, they are
+ * automatically added to the queue of effects to re-execute, which will cause them to fetch their
+ * sources and recompute
+ */
+export declare class Effect<T = any> extends Computation<T> {
+    constructor(initialValue: T, compute: () => T, options?: MemoOptions<T>);
+    _notify(state: number): void;
+    write(value: T): T;
+    _setError(error: unknown): void;
+}
+export declare class RenderEffect<T = any> extends Computation<T> {
+    effect: (val: T) => void;
+    modified: boolean;
+    constructor(initialValue: T, compute: () => T, effect: (val: T) => void, options?: MemoOptions<T>);
+    _notify(state: number): void;
+    write(value: T): T;
+    _setError(error: unknown): void;
+}

website/libraries/solid-signals/types/error.d.ts

@@ -0,0 +1,11 @@
+export declare class NotReadyError extends Error {
+}
+export declare class NoOwnerError extends Error {
+    constructor();
+}
+export declare class ContextNotFoundError extends Error {
+    constructor();
+}
+export interface ErrorHandler {
+    (error: unknown): void;
+}

website/libraries/solid-signals/types/flags.d.ts

@@ -0,0 +1,8 @@
+export type Flags = number;
+export declare const ERROR_OFFSET = 0;
+export declare const ERROR_BIT: number;
+export declare const ERROR: unique symbol;
+export declare const LOADING_OFFSET = 1;
+export declare const LOADING_BIT: number;
+export declare const LOADING: unique symbol;
+export declare const DEFAULT_FLAGS: number;

website/libraries/solid-signals/types/index.d.ts

@@ -0,0 +1,8 @@
+export { ContextNotFoundError, NoOwnerError, NotReadyError, type ErrorHandler, } from './error';
+export { Owner, createContext, getContext, setContext, hasContext, getOwner, setOwner, onCleanup, type Context, type ContextRecord, type Disposable, } from './owner';
+export { Computation, compute, getObserver, isEqual, untrack, type MemoOptions, type SignalOptions, } from './core';
+export { flushSync, Effect, RenderEffect } from './effect';
+export { indexArray, mapArray, type Maybe } from './map';
+export { createSelector, type SelectorOptions, type SelectorSignal, } from './selector';
+export * from './signals';
+export * from './store';

website/libraries/solid-signals/types/map.d.ts

@@ -0,0 +1,26 @@
+import type { Accessor } from './signals';
+export type Maybe<T> = T | void | null | undefined | false;
+/**
+ * Reactive map helper that caches each item by index to reduce unnecessary mapping on updates.
+ * It only runs the mapping function once per item and adds/removes as needed. In a non-keyed map
+ * like this the index is fixed but value can change (opposite of a keyed map).
+ *
+ * Prefer `mapArray` when referential checks are required.
+ *
+ * @see {@link https://github.com/solidjs/x-reactivity#indexarray}
+ */
+export declare function indexArray<Item, MappedItem>(list: Accessor<Maybe<readonly Item[]>>, map: (value: Accessor<Item>, index: number) => MappedItem, options?: {
+    name?: string;
+}): Accessor<MappedItem[]>;
+/**
+ * Reactive map helper that caches each list item by reference to reduce unnecessary mapping on
+ * updates. It only runs the mapping function once per item and then moves or removes it as needed.
+ * In a keyed map like this the value is fixed but the index changes (opposite of non-keyed map).
+ *
+ * Prefer `indexArray` when working with primitives to avoid unnecessary re-renders.
+ *
+ * @see {@link https://github.com/solidjs/x-reactivity#maparray}
+ */
+export declare function mapArray<Item, MappedItem>(list: Accessor<Maybe<readonly Item[]>>, map: (value: Item, index: Accessor<number>) => MappedItem, options?: {
+    name?: string;
+}): Accessor<MappedItem[]>;

website/libraries/solid-signals/types/owner.d.ts

@@ -0,0 +1,88 @@
+/**
+ * Owner tracking is used to enable nested tracking scopes with automatic cleanup.
+ * We also use owners to also keep track of which error handling context we are in.
+ *
+ * If you write the following
+ *
+ *   const a = createOwner(() => {
+ *     const b = createOwner(() => {});
+ *
+ *     const c = createOwner(() => {
+ *       const d = createOwner(() => {});
+ *     });
+ *
+ *     const e = createOwner(() => {});
+ *   });
+ *
+ * The owner tree will look like this:
+ *
+ *    a
+ *   /|\
+ *  b-c-e
+ *    |
+ *    d
+ *
+ * Following the _nextSibling pointers of each owner will first give you its children, and then its siblings (in reverse).
+ * a -> e -> c -> d -> b
+ *
+ * Note that the owner tree is largely orthogonal to the reactivity tree, and is much closer to the component tree.
+ */
+import { type ErrorHandler } from './error';
+export type ContextRecord = Record<string | symbol, unknown>;
+export interface Disposable {
+    (): void;
+}
+/**
+ * Returns the currently executing parent owner.
+ */
+export declare function getOwner(): Owner | null;
+export declare function setOwner(owner: Owner | null): Owner | null;
+export declare class Owner {
+    _parent: Owner | null;
+    _nextSibling: Owner | null;
+    _prevSibling: Owner | null;
+    _state: number;
+    _disposal: Disposable | Disposable[] | null;
+    _context: ContextRecord;
+    _handlers: ErrorHandler[] | null;
+    constructor(signal?: boolean);
+    append(child: Owner): void;
+    dispose(this: Owner, self?: boolean): void;
+    _disposeNode(): void;
+    emptyDisposal(): void;
+    handleError(error: unknown): void;
+}
+export interface Context<T> {
+    readonly id: symbol;
+    readonly defaultValue: T | undefined;
+}
+/**
+ * Context provides a form of dependency injection. It is used to save from needing to pass
+ * data as props through intermediate components. This function creates a new context object
+ * that can be used with `getContext` and `setContext`.
+ *
+ * A default value can be provided here which will be used when a specific value is not provided
+ * via a `setContext` call.
+ */
+export declare function createContext<T>(defaultValue?: T, description?: string): Context<T>;
+/**
+ * Attempts to get a context value for the given key.
+ *
+ * @throws `NoOwnerError` if there's no owner at the time of call.
+ * @throws `ContextNotFoundError` if a context value has not been set yet.
+ */
+export declare function getContext<T>(context: Context<T>, owner?: Owner | null): T;
+/**
+ * Attempts to set a context value on the parent scope with the given key.
+ *
+ * @throws `NoOwnerError` if there's no owner at the time of call.
+ */
+export declare function setContext<T>(context: Context<T>, value?: T, owner?: Owner | null): void;
+/**
+ * Whether the given context is currently defined.
+ */
+export declare function hasContext(context: Context<any>, owner?: Owner | null): boolean;
+/**
+ * Runs the given function when the parent owner computation is being disposed.
+ */
+export declare function onCleanup(disposable: Disposable): void;

website/libraries/solid-signals/types/selector.d.ts

@@ -0,0 +1,15 @@
+import type { Accessor } from './signals';
+export interface SelectorSignal<T> {
+    (key: T): Boolean;
+}
+export interface SelectorOptions<Key, Value> {
+    name?: string;
+    equals?: (key: Key, value: Value | undefined) => boolean;
+}
+/**
+ * Creates a signal that observes the given `source` and returns a new signal who only notifies
+ * observers when entering or exiting a specified key.
+ *
+ * @see {@link https://github.com/solidjs/x-reactivity#createselector}
+ */
+export declare function createSelector<Source, Key = Source>(source: Accessor<Source>, options?: SelectorOptions<Key, Source>): SelectorSignal<Key>;

website/libraries/solid-signals/types/signals.d.ts

@@ -0,0 +1,55 @@
+import type { MemoOptions, SignalOptions } from './core';
+import { Owner } from './owner';
+export interface Accessor<T> {
+    (): T;
+}
+export interface Setter<T> {
+    (value: T | SetValue<T>): T;
+}
+export interface SetValue<T> {
+    (currentValue: T): T;
+}
+export type Signal<T> = [read: Accessor<T>, write: Setter<T>];
+/**
+ * Wraps the given value into a signal. The signal will return the current value when invoked
+ * `fn()`, and provide a simple write API via `write()`. The value can now be observed
+ * when used inside other computations created with `computed` and `effect`.
+ */
+export declare function createSignal<T>(initialValue: T, options?: SignalOptions<T>): Signal<T>;
+export declare function createAsync<T>(fn: () => Promise<T>, initial?: T, options?: SignalOptions<T>): Accessor<T>;
+/**
+ * Creates a new computation whose value is computed and returned by the given function. The given
+ * compute function is _only_ re-run when one of it's dependencies are updated. Dependencies are
+ * are all signals that are read during execution.
+ */
+export declare function createMemo<T>(compute: () => T, initialValue?: T, options?: MemoOptions<T>): Accessor<T>;
+/**
+ * Invokes the given function each time any of the signals that are read inside are updated
+ * (i.e., their value changes). The effect is immediately invoked on initialization.
+ */
+export declare function createEffect<T>(effect: () => T, initialValue?: T, options?: {
+    name?: string;
+}): void;
+/**
+ * Invokes the given function each time any of the signals that are read inside are updated
+ * (i.e., their value changes). The effect is immediately invoked on initialization.
+ */
+export declare function createRenderEffect<T>(compute: () => T, effect: (v: T) => T, initialValue?: T, options?: {
+    name?: string;
+}): void;
+/**
+ * Creates a computation root which is given a `dispose()` function to dispose of all inner
+ * computations.
+ */
+export declare function createRoot<T>(init: ((dispose: () => void) => T) | (() => T)): T;
+/**
+ * Runs the given function in the given owner so that error handling and cleanups continue to work.
+ *
+ * Warning: Usually there are simpler ways of modeling a problem that avoid using this function
+ */
+export declare function runWithOwner<T>(owner: Owner | null, run: () => T): T | undefined;
+/**
+ * Runs the given function when an error is thrown in a child owner. If the error is thrown again
+ * inside the error handler, it will trigger the next available parent owner handler.
+ */
+export declare function catchError<T>(fn: () => T, handler: (error: unknown) => void): void;

website/libraries/solid-signals/types/store.d.ts

@@ -0,0 +1,22 @@
+export type Store<T> = Readonly<T>;
+export type StoreSetter<T> = (fn: (state: T) => void) => void;
+export type StoreNode = Record<PropertyKey, any>;
+export declare namespace SolidStore {
+    interface Unwrappable {
+    }
+}
+export type NotWrappable = string | number | bigint | symbol | boolean | Function | null | undefined | SolidStore.Unwrappable[keyof SolidStore.Unwrappable];
+export declare function isWrappable<T>(obj: T | NotWrappable): obj is T;
+/**
+ * Returns the underlying data in the store without a proxy.
+ * @param item store proxy object
+ * @example
+ * ```js
+ * const initial = {z...};
+ * const [state, setState] = createStore(initial);
+ * initial === state; // => false
+ * initial === unwrap(state); // => true
+ * ```
+ */
+export declare function unwrap<T>(item: T, set?: Set<unknown>): T;
+export declare function createStore<T extends object = {}>(store: T | Store<T>): [get: Store<T>, set: StoreSetter<T>];

website/libraries/solid-signals/types/utils.d.ts

@@ -0,0 +1 @@
+export declare function isUndefined(value: any): value is undefined;