@fluixi/devtools 0.2.0-alpha.2 → 0.2.0-alpha.4

package/dist/observe.d.ts

@@ -0,0 +1,80 @@
+import { type ReactiveObserver } from '@fluixi/reactive/signal';
+import { type RNode } from './instrument.js';
+import type { ReactiveSourceLocation } from './source.js';
+import { type GraphEvent } from './history.js';
+import { type DomNode } from './dom.js';
+export interface ObservedGraph {
+    readonly graph: Map<number, RNode>;
+    /** Ids whose value or run count moved since the last call. Drives the pulse. */
+    sample(): number[];
+    /**
+     * The cursor as it stands. A consumer folding in deltas keeps the one it was given and
+     * asks for what came after it.
+     */
+    readonly revision: number;
+    /**
+     * Ids that moved after `rev`. Unlike `sample`, asking does not consume anything, so two
+     * consumers reading at their own pace each see every change.
+     */
+    changedSince(rev: number): number[];
+    /** Ids dropped after `rev`. Bounded: a consumer further back than that is told to reload. */
+    removedSince(rev: number): number[];
+    /** Whether `rev` is old enough that the removal log no longer covers it. */
+    outrun(rev: number): boolean;
+    /**
+     * Removals since the last call, draining as it goes.
+     *
+     * Superseded by `removedSince`, and kept because the hook that calls it can be older
+     * than this: a browser extension bundles its own and hands the application's observer
+     * to it. Removing the method outright crashed every panel that had not been reloaded.
+     */
+    takeRemoved(): number[];
+    /** What happened since the last call, in order. Empty when history is off. */
+    takeEvents(): GraphEvent[];
+    /** Where this node reaches the page, for whatever is still on it. */
+    elementsFor(id: number): Element[];
+    /** The node driving `element`, or the nearest ancestor that has one. */
+    nodeAt(element: Element | null): number | undefined;
+    /**
+     * What this node rendered, described so it can be shown by a panel that is not in the
+     * page. Stops wherever another tag begins, naming it.
+     */
+    domFor(id: number): DomNode[];
+    /**
+     * The elements this tag returned, and nothing else. Unlike `elementsFor` there is no
+     * fallback to what the values inside it write to, so two tags can never claim the same
+     * element.
+     */
+    renderedFor(id: number): Element[];
+    /**
+     * Write a signal from outside the application. False when the node is not something that
+     * can be written. A memo is computed, and setting it would be a lie the next run undoes.
+     */
+    setValue(id: number, next: unknown): boolean;
+    detach(): void;
+}
+export interface ObserveOptions {
+    /**
+     * Trimmed off a file name that a dev server serves from its own origin. Defaults to the
+     * page's origin, which is what a preview in an iframe wants too.
+     */
+    origin?: string;
+    /**
+     * How to register. Defaults to this copy of the runtime, so pass the application's own
+     * `observeReactiveNodes` when watching from outside its module graph, since a second copy
+     * of the framework watches a graph nobody is using.
+     */
+    observe?: (observer: ReactiveObserver) => () => void;
+    /** Events kept for the timeline. 0 for a host that only draws the graph. */
+    history?: number;
+    /** One stack capture per binding, at creation. Off for a host that never asks. */
+    bindingSources?: boolean;
+    /**
+     * Put a stack location back in the author's file. A frame reports the compiled position and
+     * knows nothing of the file it was generated from; a host with the source maps closes that.
+     * Only stack-derived locations pass through. A compiler mark is already original.
+     */
+    mapSource?: (location: ReactiveSourceLocation) => ReactiveSourceLocation | undefined;
+}
+export declare function observeGraph(options?: ObserveOptions): ObservedGraph;
+//# sourceMappingURL=observe.d.ts.map

package/dist/observe.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"observe.d.ts","sourceRoot":"","sources":["../src/observe.ts"],"names":[],"mappings":"AAUA,OAAO,EAIL,KAAK,gBAAgB,EACtB,MAAM,yBAAyB,CAAC;AAGjC,OAAO,EAAmE,KAAK,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAC9G,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAE1D,OAAO,EAAiB,KAAK,UAAU,EAAE,MAAM,cAAc,CAAC;AAG9D,OAAO,EAA0B,KAAK,OAAO,EAAE,MAAM,UAAU,CAAC;AAmDhE,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACnC,gFAAgF;IAChF,MAAM,IAAI,MAAM,EAAE,CAAC;IACnB;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B;;;OAGG;IACH,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACpC,6FAA6F;IAC7F,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACpC,4EAA4E;IAC5E,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IAC7B;;;;;;OAMG;IACH,WAAW,IAAI,MAAM,EAAE,CAAC;IACxB,8EAA8E;IAC9E,UAAU,IAAI,UAAU,EAAE,CAAC;IAC3B,qEAAqE;IACrE,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,EAAE,CAAC;IACnC,wEAAwE;IACxE,MAAM,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,GAAG,MAAM,GAAG,SAAS,CAAC;IACpD;;;OAGG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,EAAE,CAAC;IAC9B;;;;OAIG;IACH,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,EAAE,CAAC;IACnC;;;OAGG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC;IAC7C,MAAM,IAAI,IAAI,CAAC;CAChB;AAED,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,gBAAgB,KAAK,MAAM,IAAI,CAAC;IACrD,4EAA4E;IAC5E,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,kFAAkF;IAClF,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;;;OAIG;IACH,SAAS,CAAC,EAAE,CAAC,QAAQ,EAAE,sBAAsB,KAAK,sBAAsB,GAAG,SAAS,CAAC;CACtF;AAsED,wBAAgB,YAAY,CAAC,OAAO,GAAE,cAAmB,GAAG,aAAa,CA4tBxE"}