mates-devtools 0.1.0-beta.1

package/dist/types/lib/socket/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./ws";
+//# sourceMappingURL=index.d.ts.map

package/dist/types/lib/socket/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../lib/socket/index.ts"],"names":[],"mappings":"AAAA,cAAc,MAAM,CAAC"}

package/dist/types/lib/socket/ws.d.ts

@@ -0,0 +1,83 @@
+import { atom } from "../Mutables/atom/atom";
+export type WsStatus = "connecting" | "connected" | "disconnected" | "error";
+export type WsConfig = {
+    /** Auto-reconnect on close/error. Default: true */
+    reconnect?: boolean;
+    /** Base delay in ms before first reconnect attempt. Default: 1000 */
+    reconnectDelay?: number;
+    /** Maximum delay cap in ms for exponential backoff. Default: 30_000 */
+    reconnectMaxDelay?: number;
+    /** Maximum number of reconnect attempts. Default: Infinity */
+    reconnectMaxAttempts?: number;
+    /** WebSocket sub-protocols */
+    protocols?: string | string[];
+    /**
+     * Called lazily on each (re)connect to produce extra query-string params.
+     * e.g. () => ({ token: authToken() })
+     */
+    auth?: () => Record<string, string>;
+    /**
+     * If false the socket will not connect automatically on creation.
+     * Call `connection.connect()` manually when you are ready.
+     * Default: true
+     */
+    autoConnect?: boolean;
+};
+type MessageHandler<T> = (data: T) => void;
+export type WsConnection<T = unknown> = {
+    /** Send a value to the server. Objects are JSON-serialised automatically. */
+    send: (data: T | string) => void;
+    /**
+     * Subscribe to incoming messages.
+     * Returns an unsubscribe function.
+     * Prefer `onSocket()` inside components — it auto-cleans up on unmount.
+     */
+    __subscribe: (fn: MessageHandler<T>) => () => void;
+    /** Reactive connection status atom. */
+    status: ReturnType<typeof atom<WsStatus>>;
+    /**
+     * Open (or re-open) the connection.
+     * Called automatically on creation unless `autoConnect: false` is set.
+     * Safe to call after `disconnect()` — it resets the socket so it can
+     * connect again.
+     */
+    connect: () => void;
+    /** Close the connection and stop all reconnect attempts. */
+    disconnect: () => void;
+    /** Internal marker — mirrors __isAtom___, __isEvent___, etc. */
+    readonly __isWs___: true;
+};
+/**
+ * Create a WebSocket connection.
+ *
+ * **Must be called from a component's outer function.**  `ws()` registers a
+ * cleanup handler so the reconnect timer, socket, and all message handlers are
+ * automatically torn down when the component unmounts.  Calling it at module
+ * level or inside an inner function (event handler, timer callback, etc.) is
+ * forbidden because there is no active component host to attach the cleanup to.
+ *
+ * ```ts
+ * // ✅ correct — inside a component's outer function
+ * const MyComponent = () => {
+ *   const sock = ws<ChatMessage>("wss://api.example.com/chat", {
+ *     reconnect: true,
+ *   });
+ *   onSocket((msg) => { messages.update(d => { d.push(msg); }); }, [sock]);
+ *   return () => html`...`;
+ * };
+ *
+ * // ❌ wrong — module level, no host, cleanup is never registered
+ * const chatSocket = ws<ChatMessage>("wss://api.example.com/chat");
+ *
+ * // ❌ wrong — inner function, outer function has already returned
+ * const MyComponent = () => {
+ *   function handleClick() {
+ *     const sock = ws("wss://..."); // throws
+ *   }
+ *   return () => html`<button @click=${handleClick}>…</button>`;
+ * };
+ * ```
+ */
+export declare function ws<T = unknown>(url: string, config?: WsConfig): WsConnection<T>;
+export {};
+//# sourceMappingURL=ws.d.ts.map

package/dist/types/lib/socket/ws.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ws.d.ts","sourceRoot":"","sources":["../../../../../lib/socket/ws.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAO7C,MAAM,MAAM,QAAQ,GAAG,YAAY,GAAG,WAAW,GAAG,cAAc,GAAG,OAAO,CAAC;AAE7E,MAAM,MAAM,QAAQ,GAAG;IACrB,mDAAmD;IACnD,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,qEAAqE;IACrE,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,uEAAuE;IACvE,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,8DAA8D;IAC9D,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,8BAA8B;IAC9B,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC9B;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF,KAAK,cAAc,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,CAAC;AAE3C,MAAM,MAAM,YAAY,CAAC,CAAC,GAAG,OAAO,IAAI;IACtC,6EAA6E;IAC7E,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,MAAM,KAAK,IAAI,CAAC;IACjC;;;;OAIG;IACH,WAAW,EAAE,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC,CAAC,KAAK,MAAM,IAAI,CAAC;IACnD,uCAAuC;IACvC,MAAM,EAAE,UAAU,CAAC,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC1C;;;;;OAKG;IACH,OAAO,EAAE,MAAM,IAAI,CAAC;IACpB,4DAA4D;IAC5D,UAAU,EAAE,MAAM,IAAI,CAAC;IACvB,gEAAgE;IAChE,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;CAC1B,CAAC;AAUF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAgB,EAAE,CAAC,CAAC,GAAG,OAAO,EAC5B,GAAG,EAAE,MAAM,EACX,MAAM,GAAE,QAAa,GACpB,YAAY,CAAC,CAAC,CAAC,CAkOjB"}

package/dist/types/lib/ssr/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./ssr-bridge";
+export * from "./ssrFlag";
+//# sourceMappingURL=index.d.ts.map

package/dist/types/lib/ssr/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../lib/ssr/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC"}

package/dist/types/lib/ssr/ssr-bridge.d.ts

@@ -0,0 +1,89 @@
+/**
+ * mates — ssr/ssr-bridge.ts
+ *
+ * A tiny, zero-dependency module that holds two pieces of shared state
+ * needed for the Fetch SSR shortcut:
+ *
+ *   _ssrApiLookup  — a function wired in by mates-ssr at server startup.
+ *                    When set, FetchClient.fetch() calls API handlers
+ *                    directly instead of making real HTTP requests.
+ *
+ *   _ssrRequest    — the original HTTP Request for the current SSR render
+ *                    pass. Set by mates-ssr's server before each renderPage()
+ *                    call so that Fetch can forward cookies / auth headers
+ *                    to directly-called API handlers.
+ *
+ * Why a separate file?
+ *
+ *   mates-ssr's server.ts needs to import these setters at the top level.
+ *   server.ts is re-exported through mates-ssr's index.ts, which is imported
+ *   by the user's mates.config.ts — BEFORE bootRenderer() has been called
+ *   and BEFORE happy-dom has patched globalThis.document.
+ *
+ *   If the setters lived in Fetch.ts, importing them would pull in the entire
+ *   mates bundle (lit-html, x-view custom element, etc.) at config-load time,
+ *   triggering "document is not defined" before the DOM shim is ready.
+ *
+ *   This file has NO imports whatsoever. It is safe to import at any point
+ *   in the process lifecycle, including before bootRenderer().
+ *
+ * Consumers:
+ *   - mates/lib/Fetch/Fetch.ts        reads _ssrApiLookup and _ssrRequest
+ *   - mates-ssr/src/server.ts         writes both via the exported setters
+ *   - mates/lib/index.ts              re-exports the setters as public API
+ */
+/**
+ * The shape of the API handler lookup function supplied by mates-ssr.
+ *
+ * Takes a method ("GET", "POST", …) and a pathname ("/api/users") and
+ * returns the matching handler + route context, or null when nothing matches.
+ */
+export type ApiLookupFn = (method: string, pathname: string) => {
+    handler: (req: Request, ctx: {
+        params: Record<string, string>;
+    }) => Promise<Response>;
+    ctx: {
+        params: Record<string, string>;
+    };
+} | null;
+/**
+ * Wire in the API handler registry from mates-ssr.
+ *
+ * Called once by mates-ssr's startServer() after scanning src/api/.
+ * Pass null on server shutdown to unregister.
+ *
+ * @example
+ * // mates-ssr/src/server.ts
+ * import { setSSRApiLookup } from "mates";
+ * setSSRApiLookup(lookupApiHandler);   // startup
+ * setSSRApiLookup(null);               // shutdown
+ */
+export declare function setSSRApiLookup(fn: ApiLookupFn | null): void;
+/**
+ * Store the original HTTP Request for the current SSR render pass.
+ *
+ * Called by mates-ssr's renderPage() immediately before the component
+ * outer function runs, and cleared (null) in the finally block.
+ *
+ * Fetch.ts reads this to forward cookies and auth headers to directly-
+ * called API handlers so the handler sees real auth state.
+ *
+ * @example
+ * // mates-ssr/src/server.ts
+ * import { setSSRRequest } from "mates";
+ * setSSRRequest(req);      // before render
+ * setSSRRequest(null);     // after render (finally block)
+ */
+export declare function setSSRRequest(req: Request | null): void;
+/**
+ * Returns the currently wired API lookup function, or null when not set.
+ * Called on every FetchClient.fetch() call during SSR.
+ */
+export declare function getSSRApiLookup(): ApiLookupFn | null;
+/**
+ * Returns the original HTTP Request for the current SSR render pass,
+ * or null when called outside an SSR context.
+ * Called by FetchClient.fetch() to forward auth headers.
+ */
+export declare function getSSRRequest(): Request | null;
+//# sourceMappingURL=ssr-bridge.d.ts.map

package/dist/types/lib/ssr/ssr-bridge.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ssr-bridge.d.ts","sourceRoot":"","sources":["../../../../../lib/ssr/ssr-bridge.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AAIH;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG,CACxB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,KACb;IACH,OAAO,EAAE,CACP,GAAG,EAAE,OAAO,EACZ,GAAG,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAAE,KACpC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACvB,GAAG,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAAE,CAAC;CACzC,GAAG,IAAI,CAAC;AAST;;;;;;;;;;;GAWG;AACH,wBAAgB,eAAe,CAAC,EAAE,EAAE,WAAW,GAAG,IAAI,GAAG,IAAI,CAE5D;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI,GAAG,IAAI,CAEvD;AAID;;;GAGG;AACH,wBAAgB,eAAe,IAAI,WAAW,GAAG,IAAI,CAEpD;AAED;;;;GAIG;AACH,wBAAgB,aAAa,IAAI,OAAO,GAAG,IAAI,CAE9C"}

package/dist/types/lib/ssr/ssrFlag.d.ts

@@ -0,0 +1,38 @@
+/**
+ * mates — SSR mode flag
+ *
+ * A simple global boolean that browser-only hooks check before doing work.
+ * When `setSSRMode(true)` is called (by mates-ssr's renderer before rendering),
+ * hooks like onBlur, onFocus, onResize, onInterval, etc. skip their work
+ * entirely — no event listeners, no timers, no observers.
+ *
+ * This is the lightest possible SSR guard: one boolean check per hook call.
+ *
+ * Usage (inside mates-ssr renderer):
+ *
+ *   import { setSSRMode } from "mates";
+ *
+ *   setSSRMode(true);
+ *   // ... render components ...
+ *   setSSRMode(false);
+ *
+ * Usage (inside a hook):
+ *
+ *   import { isSSR } from "../ssr/ssrFlag";
+ *
+ *   export const onBlur = (fn) => {
+ *     if (isSSR()) return;
+ *     // ... browser-only work ...
+ *   };
+ */
+/**
+ * Enable or disable SSR mode.
+ * When enabled, browser-only hooks become no-ops.
+ */
+export declare function setSSRMode(value: boolean): void;
+/**
+ * Returns true when the framework is running inside an SSR render pass.
+ * Hooks should check this and bail early if true.
+ */
+export declare function isSSR(): boolean;
+//# sourceMappingURL=ssrFlag.d.ts.map

package/dist/types/lib/ssr/ssrFlag.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ssrFlag.d.ts","sourceRoot":"","sources":["../../../../../lib/ssr/ssrFlag.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAIH;;;GAGG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI,CAE/C;AAED;;;GAGG;AACH,wBAAgB,KAAK,IAAI,OAAO,CAE/B"}

package/dist/types/lib/virtualizer/ScrollerController.d.ts

@@ -0,0 +1,54 @@
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+import type { ScrollToCoordinates } from "./layouts/shared/Layout.js";
+type retargetScrollCallback = () => ScrollToCoordinates;
+type endScrollCallback = () => void;
+type Nullable<T> = T | null;
+export declare class ScrollerShim {
+    protected _node: Element | Window;
+    protected _element: Nullable<Element>;
+    constructor(element?: Element);
+    get element(): Element;
+    get scrollTop(): number;
+    get scrollLeft(): number;
+    get scrollHeight(): number;
+    get scrollWidth(): number;
+    get viewportHeight(): number;
+    get viewportWidth(): number;
+    get maxScrollTop(): number;
+    get maxScrollLeft(): number;
+}
+export declare class ScrollerController extends ScrollerShim {
+    private _originalScrollTo;
+    private _originalScrollBy;
+    private _originalScroll;
+    private _clients;
+    private _retarget;
+    private _end;
+    private __destination;
+    constructor(client: unknown, element?: Element);
+    correctingScrollError: boolean;
+    private get _destination();
+    get scrolling(): boolean;
+    scrollTo(options: ScrollToOptions): void;
+    scrollTo(x: number, y: number): void;
+    scrollTo(p1: ScrollToOptions | number, p2?: number): void;
+    scrollBy(options: ScrollToOptions): void;
+    scrollBy(x: number, y: number): void;
+    scrollBy(p1: ScrollToOptions | number, p2?: number): void;
+    private _nativeScrollTo;
+    private _scrollTo;
+    private _setDestination;
+    private _resetScrollState;
+    private _updateManagedScrollTo;
+    managedScrollTo(options: ScrollToOptions, retarget: retargetScrollCallback, end: endScrollCallback): (coordinates: ScrollToCoordinates) => void;
+    correctScrollError(coordinates: ScrollToCoordinates): void;
+    private _checkForArrival;
+    detach(client: unknown): null;
+    private _attach;
+}
+export {};
+//# sourceMappingURL=ScrollerController.d.ts.map

package/dist/types/lib/virtualizer/ScrollerController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ScrollerController.d.ts","sourceRoot":"","sources":["../../../../../lib/virtualizer/ScrollerController.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AAEtE,KAAK,sBAAsB,GAAG,MAAM,mBAAmB,CAAC;AACxD,KAAK,iBAAiB,GAAG,MAAM,IAAI,CAAC;AACpC,KAAK,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;AAE5B,qBAAa,YAAY;IACvB,SAAS,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAAC;IAClC,SAAS,CAAC,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAQ;gBAEjC,OAAO,CAAC,EAAE,OAAO;IAQ7B,IAAW,OAAO,YAIjB;IAED,IAAW,SAAS,WAEnB;IAED,IAAW,UAAU,WAEpB;IAED,IAAW,YAAY,WAEtB;IAED,IAAW,WAAW,WAErB;IAED,IAAW,cAAc,WAIxB;IAED,IAAW,aAAa,WAIvB;IAED,IAAW,YAAY,WAEtB;IAED,IAAW,aAAa,WAEvB;CACF;AAED,qBAAa,kBAAmB,SAAQ,YAAY;IAClD,OAAO,CAAC,iBAAiB,CAEE;IAC3B,OAAO,CAAC,iBAAiB,CAEE;IAC3B,OAAO,CAAC,eAAe,CAEE;IACzB,OAAO,CAAC,QAAQ,CAAsB;IACtC,OAAO,CAAC,SAAS,CAA0C;IAC3D,OAAO,CAAC,IAAI,CAAqC;IACjD,OAAO,CAAC,aAAa,CAAmC;gBAE5C,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO;IAgBvC,qBAAqB,UAAS;IAErC,OAAO,KAAK,YAAY,GAEvB;IAED,IAAW,SAAS,YAEnB;IAEM,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,IAAI;IACxC,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI;IACpC,QAAQ,CAAC,EAAE,EAAE,eAAe,GAAG,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI;IASzD,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,IAAI;IACxC,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI;IACpC,QAAQ,CAAC,EAAE,EAAE,eAAe,GAAG,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI;IAehE,OAAO,CAAC,eAAe;IAIvB,OAAO,CAAC,SAAS;IAkBjB,OAAO,CAAC,eAAe;IAqBvB,OAAO,CAAC,iBAAiB;IAMzB,OAAO,CAAC,sBAAsB;IAQvB,eAAe,CACpB,OAAO,EAAE,eAAe,EACxB,QAAQ,EAAE,sBAAsB,EAChC,GAAG,EAAE,iBAAiB,iBAXoB,mBAAmB;IAiBxD,kBAAkB,CAAC,WAAW,EAAE,mBAAmB;IAkB1D,OAAO,CAAC,gBAAgB;IAkBjB,MAAM,CAAC,MAAM,EAAE,OAAO;IAgB7B,OAAO,CAAC,OAAO;CAchB"}

package/dist/types/lib/virtualizer/Virtualizer.d.ts

@@ -0,0 +1,214 @@
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+import { RangeChangedEvent, UnpinnedEvent, VisibilityChangedEvent } from "./events.js";
+import type { ChildMeasurements, ItemBox, LayoutConfigValue, LayoutHostMessage, MeasureChildFunction, StateChangedMessage } from "./layouts/shared/Layout.js";
+/**
+ * Call this function to provide a `ResizeObserver` polyfill for Virtualizer to use.
+ * @param Ctor Constructor for a `ResizeObserver` polyfill (recommend using the one provided with the Virtualizer package)
+ */
+export declare function provideResizeObserver(Ctor: typeof ResizeObserver): void;
+export declare const virtualizerRef: unique symbol;
+declare global {
+    interface HTMLElementEventMap {
+        rangeChanged: RangeChangedEvent;
+        visibilityChanged: VisibilityChangedEvent;
+        unpinned: UnpinnedEvent;
+    }
+}
+export interface VirtualizerHostElement extends HTMLElement {
+    [virtualizerRef]?: Virtualizer;
+}
+/**
+ * A very limited proxy object for a virtualizer child,
+ * returned by Virtualizer.element(idx: number). Introduced
+ * to enable scrolling a virtual element into view using
+ * a call that looks and behaves essentially the same as for
+ * a real Element. May be useful for other things later.
+ */
+export interface VirtualizerChildElementProxy {
+    scrollIntoView: (options?: ScrollIntoViewOptions) => void;
+}
+export interface VirtualizerConfig {
+    layout?: LayoutConfigValue;
+    /**
+     * The parent of all child nodes to be rendered.
+     */
+    hostElement: VirtualizerHostElement;
+    scroller?: boolean;
+}
+/**
+ * Provides virtual scrolling boilerplate.
+ *
+ * Extensions of this class must set hostElement and layout.
+ *
+ * Extensions of this class must also override VirtualRepeater's DOM
+ * manipulation methods.
+ */
+export declare class Virtualizer {
+    private _benchmarkStart;
+    private _layout;
+    private _clippingAncestors;
+    /**
+     * Layout provides these values, we set them on _render().
+     * TODO @straversi: Can we find an XOR type, usable for the key here?
+     */
+    private _scrollSize;
+    /**
+     * Difference between scroll target's current and required scroll offsets.
+     * Provided by layout.
+     */
+    private _scrollError;
+    /**
+     * A list of the positions (top, left) of the children in the current range.
+     */
+    private _childrenPos;
+    private _childMeasurements;
+    private _toBeMeasured;
+    private _rangeChanged;
+    private _itemsChanged;
+    private _visibilityChanged;
+    /**
+     * The HTMLElement that hosts the virtualizer. Set by hostElement.
+     */
+    protected _hostElement?: VirtualizerHostElement;
+    private _scrollerController;
+    private _isScroller;
+    private _sizer;
+    /**
+     * Resize observer attached to hostElement.
+     */
+    private _hostElementRO;
+    /**
+     * Resize observer attached to children.
+     */
+    private _childrenRO;
+    private _mutationObserver;
+    private _scrollEventListeners;
+    private _scrollEventListenerOptions;
+    private _loadListener;
+    /**
+     * Index of element to scroll into view, plus scroll
+     * behavior options, as imperatively specified via
+     * `element(index).scrollIntoView()`
+     */
+    private _scrollIntoViewTarget;
+    private _updateScrollIntoViewCoordinates;
+    /**
+     * Items to render. Set by items.
+     */
+    private _items;
+    /**
+     * Index of the first child in the range, not necessarily the first visible child.
+     * TODO @straversi: Consider renaming these.
+     */
+    protected _first: number;
+    /**
+     * Index of the last child in the range.
+     */
+    protected _last: number;
+    /**
+     * Index of the first item intersecting the viewport.
+     */
+    private _firstVisible;
+    /**
+     * Index of the last item intersecting the viewport.
+     */
+    private _lastVisible;
+    protected _scheduled: WeakSet<Function>;
+    /**
+     * Invoked at the end of each render cycle: children in the range are
+     * measured, and their dimensions passed to this callback. Use it to layout
+     * children as needed.
+     */
+    protected _measureCallback: ((sizes: ChildMeasurements) => void) | null;
+    protected _measureChildOverride: MeasureChildFunction | null;
+    /**
+     * State for `layoutComplete` promise
+     */
+    private _layoutCompletePromise;
+    private _layoutCompleteResolver;
+    private _layoutCompleteRejecter;
+    private _pendingLayoutComplete;
+    /**
+     * Layout initialization is async because we dynamically load
+     * the default layout if none is specified. This state is to track
+     * whether init is complete.
+     */
+    private _layoutInitialized;
+    /**
+     * Track connection state to guard against errors / unnecessary work
+     */
+    private _connected;
+    constructor(config: VirtualizerConfig);
+    set items(items: Array<unknown> | undefined);
+    _init(config: VirtualizerConfig): void;
+    private _initObservers;
+    _initHostElement(config: VirtualizerConfig): void;
+    connected(): void;
+    _observeAndListen(): void;
+    disconnected(): void;
+    private _applyVirtualizerStyles;
+    _getSizer(): HTMLElement;
+    updateLayoutConfig(layoutConfig: LayoutConfigValue): Promise<boolean>;
+    private _initLayout;
+    startBenchmarking(): void;
+    stopBenchmarking(): {
+        timeElapsed: number;
+        virtualizationTime: number;
+    } | null;
+    private _measureChildren;
+    /**
+     * Returns the width, height, and margins of the given child.
+     */
+    _measureChild(element: Element): ItemBox;
+    protected _schedule(method: Function): Promise<void>;
+    _updateDOM(state: StateChangedMessage): Promise<void>;
+    _finishDOMUpdate(): void;
+    _updateLayout(): void;
+    private _handleScrollEvent;
+    handleEvent(event: CustomEvent): void;
+    _handleLayoutMessage(message: LayoutHostMessage): void;
+    get _children(): Array<HTMLElement>;
+    private _updateView;
+    /**
+     * Styles the host element so that its size reflects the
+     * total size of all items.
+     */
+    private _sizeHostElement;
+    /**
+     * Sets the top and left transform style of the children from the values in
+     * pos.
+     */
+    private _positionChildren;
+    private _adjustRange;
+    private _correctScrollError;
+    element(index: number): VirtualizerChildElementProxy | undefined;
+    private _scrollElementIntoView;
+    /**
+     * If we are smoothly scrolling to an element and the target element
+     * is in the DOM, we update our target coordinates as needed
+     */
+    private _checkScrollIntoViewTarget;
+    /**
+     * Emits a rangechange event with the current first, last, firstVisible, and
+     * lastVisible.
+     */
+    private _notifyRange;
+    private _notifyVisibility;
+    get layoutComplete(): Promise<void>;
+    private _rejectLayoutCompletePromise;
+    private _scheduleLayoutComplete;
+    private _resolveLayoutCompletePromise;
+    private _resetLayoutCompleteState;
+    /**
+     * Render and update the view at the next opportunity with the given
+     * hostElement size.
+     */
+    private _hostElementSizeChanged;
+    private _childLoaded;
+    private _childrenSizeChanged;
+}
+//# sourceMappingURL=Virtualizer.d.ts.map

package/dist/types/lib/virtualizer/Virtualizer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Virtualizer.d.ts","sourceRoot":"","sources":["../../../../../lib/virtualizer/Virtualizer.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EACL,iBAAiB,EACjB,aAAa,EACb,sBAAsB,EACvB,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,EAEV,iBAAiB,EAGjB,OAAO,EAEP,iBAAiB,EAEjB,iBAAiB,EAGjB,oBAAoB,EAGpB,mBAAmB,EACpB,MAAM,4BAA4B,CAAC;AAYpC;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,OAAO,cAAc,QAEhE;AAED,eAAO,MAAM,cAAc,eAA2B,CAAC;AAGvD,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,mBAAmB;QAC3B,YAAY,EAAE,iBAAiB,CAAC;QAChC,iBAAiB,EAAE,sBAAsB,CAAC;QAC1C,QAAQ,EAAE,aAAa,CAAC;KACzB;CACF;AAED,MAAM,WAAW,sBAAuB,SAAQ,WAAW;IACzD,CAAC,cAAc,CAAC,CAAC,EAAE,WAAW,CAAC;CAChC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,4BAA4B;IAC3C,cAAc,EAAE,CAAC,OAAO,CAAC,EAAE,qBAAqB,KAAK,IAAI,CAAC;CAC3D;AAUD,MAAM,WAAW,iBAAiB;IAChC,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAE3B;;OAEG;IACH,WAAW,EAAE,sBAAsB,CAAC;IAEpC,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAID;;;;;;;GAOG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,eAAe,CAAuB;IAE9C,OAAO,CAAC,OAAO,CAAuB;IAEtC,OAAO,CAAC,kBAAkB,CAAqB;IAE/C;;;OAGG;IACH,OAAO,CAAC,WAAW,CAAqB;IAExC;;;OAGG;IACH,OAAO,CAAC,YAAY,CAA8C;IAElE;;OAEG;IACH,OAAO,CAAC,YAAY,CAA+B;IAGnD,OAAO,CAAC,kBAAkB,CAAkC;IAE5D,OAAO,CAAC,aAAa,CAAmC;IAExD,OAAO,CAAC,aAAa,CAAQ;IAE7B,OAAO,CAAC,aAAa,CAAQ;IAE7B,OAAO,CAAC,kBAAkB,CAAQ;IAElC;;OAEG;IACH,SAAS,CAAC,YAAY,CAAC,EAAE,sBAAsB,CAAC;IAEhD,OAAO,CAAC,mBAAmB,CAAmC;IAE9D,OAAO,CAAC,WAAW,CAAS;IAE5B,OAAO,CAAC,MAAM,CAA4B;IAE1C;;OAEG;IACH,OAAO,CAAC,cAAc,CAA+B;IAErD;;OAEG;IACH,OAAO,CAAC,WAAW,CAA+B;IAElD,OAAO,CAAC,iBAAiB,CAAiC;IAE1D,OAAO,CAAC,qBAAqB,CAA4B;IACzD,OAAO,CAAC,2BAA2B,CAEjC;IAIF,OAAO,CAAC,aAAa,CAAgC;IAErD;;;;OAIG;IACH,OAAO,CAAC,qBAAqB,CAA6C;IAE1E,OAAO,CAAC,gCAAgC,CAExB;IAEhB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAsB;IAEpC;;;OAGG;IACH,SAAS,CAAC,MAAM,SAAM;IAEtB;;OAEG;IACH,SAAS,CAAC,KAAK,SAAM;IAErB;;OAEG;IACH,OAAO,CAAC,aAAa,CAAM;IAE3B;;OAEG;IACH,OAAO,CAAC,YAAY,CAAM;IAE1B,SAAS,CAAC,UAAU,oBAA2B;IAE/C;;;;OAIG;IACH,SAAS,CAAC,gBAAgB,EAAE,CAAC,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,CAAC,GAAG,IAAI,CAChE;IAEP,SAAS,CAAC,qBAAqB,EAAE,oBAAoB,GAAG,IAAI,CAAQ;IAEpE;;OAEG;IACH,OAAO,CAAC,sBAAsB,CAA8B;IAC5D,OAAO,CAAC,uBAAuB,CAAyB;IACxD,OAAO,CAAC,uBAAuB,CAAyB;IACxD,OAAO,CAAC,sBAAsB,CAAuB;IAErD;;;;OAIG;IACH,OAAO,CAAC,kBAAkB,CAA8B;IAExD;;OAEG;IACH,OAAO,CAAC,UAAU,CAAS;gBAEf,MAAM,EAAE,iBAAiB;IAerC,IAAI,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,SAAS,EAM1C;IAED,KAAK,CAAC,MAAM,EAAE,iBAAiB;IAY/B,OAAO,CAAC,cAAc;IAYtB,gBAAgB,CAAC,MAAM,EAAE,iBAAiB;IAO1C,SAAS;IAkBT,iBAAiB;IAqBjB,YAAY;IAsBZ,OAAO,CAAC,uBAAuB;IAmB/B,SAAS;IA6BH,kBAAkB,CAAC,YAAY,EAAE,iBAAiB;YA2B1C,WAAW;IAiDzB,iBAAiB;IAMjB,gBAAgB;;;;IAmBhB,OAAO,CAAC,gBAAgB;IAgBxB;;OAEG;IACH,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO;cAOxB,SAAS,CAAC,MAAM,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IASpD,UAAU,CAAC,KAAK,EAAE,mBAAmB;IAiB3C,gBAAgB;IAchB,aAAa;IAkBb,OAAO,CAAC,kBAAkB;IAgB1B,WAAW,CAAC,KAAK,EAAE,WAAW;IAe9B,oBAAoB,CAAC,OAAO,EAAE,iBAAiB;IAY/C,IAAI,SAAS,IAAI,KAAK,CAAC,WAAW,CAAC,CAUlC;IAED,OAAO,CAAC,WAAW;IAoDnB;;;OAGG;IACH,OAAO,CAAC,gBAAgB;IAiBxB;;;OAGG;IACH,OAAO,CAAC,iBAAiB;YAuBX,YAAY;IAc1B,OAAO,CAAC,mBAAmB;IAYpB,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,4BAA4B,GAAG,SAAS;IAYvE,OAAO,CAAC,sBAAsB;IAqB9B;;;OAGG;IACH,OAAO,CAAC,0BAA0B;IASlC;;;OAGG;IACH,OAAO,CAAC,YAAY;IAMpB,OAAO,CAAC,iBAAiB;IASzB,IAAW,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC,CASzC;IAED,OAAO,CAAC,4BAA4B;IAOpC,OAAO,CAAC,uBAAuB;IAW/B,OAAO,CAAC,6BAA6B;IAOrC,OAAO,CAAC,yBAAyB;IAOjC;;;OAGG;IACH,OAAO,CAAC,uBAAuB;IAS/B,OAAO,CAAC,YAAY;IAOpB,OAAO,CAAC,oBAAoB;CAmB7B"}

package/dist/types/lib/virtualizer/events.d.ts

@@ -0,0 +1,27 @@
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+export declare class RangeChangedEvent extends Event {
+    static eventName: string;
+    first: number;
+    last: number;
+    constructor(range: Range);
+}
+export declare class VisibilityChangedEvent extends Event {
+    static eventName: string;
+    first: number;
+    last: number;
+    constructor(range: Range);
+}
+export declare class UnpinnedEvent extends Event {
+    static eventName: string;
+    constructor();
+}
+interface Range {
+    first: number;
+    last: number;
+}
+export {};
+//# sourceMappingURL=events.d.ts.map

package/dist/types/lib/virtualizer/events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../../../../lib/virtualizer/events.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,qBAAa,iBAAkB,SAAQ,KAAK;IAC1C,MAAM,CAAC,SAAS,SAAkB;IAElC,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;gBAED,KAAK,EAAE,KAAK;CAKzB;AAED,qBAAa,sBAAuB,SAAQ,KAAK;IAC/C,MAAM,CAAC,SAAS,SAAuB;IAEvC,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;gBAED,KAAK,EAAE,KAAK;CAKzB;AAED,qBAAa,aAAc,SAAQ,KAAK;IACtC,MAAM,CAAC,SAAS,SAAc;;CAK/B;AAED,UAAU,KAAK;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd"}

package/dist/types/lib/virtualizer/layouts/flow.d.ts

@@ -0,0 +1,123 @@
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+import { BaseLayout } from "./shared/BaseLayout.js";
+import type { BaseLayoutConfig, ChildMeasurements, LayoutHostSink, Margins, Positions, ScrollDirection, Size } from "./shared/Layout.js";
+type ItemBounds = {
+    pos: number;
+    size: number;
+};
+type FlowLayoutConstructor = {
+    prototype: FlowLayout;
+    new (hostSink: LayoutHostSink, config?: BaseLayoutConfig): FlowLayout;
+};
+type FlowLayoutSpecifier = BaseLayoutConfig & {
+    type: FlowLayoutConstructor;
+};
+type FlowLayoutSpecifierFactory = (config?: BaseLayoutConfig) => FlowLayoutSpecifier;
+export declare const flow: FlowLayoutSpecifierFactory;
+declare class MetricsCache {
+    private _childSizeCache;
+    private _marginSizeCache;
+    private _metricsCache;
+    update(metrics: {
+        [key: number]: Size & Margins;
+    }, direction: ScrollDirection): void;
+    get averageChildSize(): number;
+    get totalChildSize(): number;
+    get averageMarginSize(): number;
+    get totalMarginSize(): number;
+    getLeadingMarginValue(index: number, direction: ScrollDirection): number;
+    getChildSize(index: number): number | undefined;
+    getMarginSize(index: number): number | undefined;
+    clear(): void;
+}
+export declare class FlowLayout extends BaseLayout<BaseLayoutConfig> {
+    /**
+     * Initial estimate of item size
+     */
+    _itemSize: Size;
+    /**
+     * Indices of children mapped to their (position and length) in the scrolling
+     * direction. Used to keep track of children that are in range.
+     */
+    _physicalItems: Map<number, ItemBounds>;
+    /**
+     * Used in tandem with _physicalItems to track children in range across
+     * reflows.
+     */
+    _newPhysicalItems: Map<number, ItemBounds>;
+    /**
+     * Width and height of children by their index.
+     */
+    _metricsCache: MetricsCache;
+    /**
+     * anchorIdx is the anchor around which we reflow. It is designed to allow
+     * jumping to any point of the scroll size. We choose it once and stick with
+     * it until stable. _first and _last are deduced around it.
+     */
+    _anchorIdx: number | null;
+    /**
+     * Position in the scrolling direction of the anchor child.
+     */
+    _anchorPos: number | null;
+    /**
+     * Whether all children in range were in range during the previous reflow.
+     */
+    _stable: boolean;
+    private _measureChildren;
+    _estimate: boolean;
+    get measureChildren(): boolean;
+    /**
+     * Determine the average size of all children represented in the sizes
+     * argument.
+     */
+    updateItemSizes(sizes: ChildMeasurements): void;
+    /**
+     * Set the average item size based on the total length and number of children
+     * in range.
+     */
+    _getPhysicalItem(idx: number): ItemBounds | undefined;
+    _getSize(idx: number): number | undefined;
+    _getAverageSize(): number;
+    _estimatePosition(idx: number): number;
+    /**
+     * Returns the position in the scrolling direction of the item at idx.
+     * Estimates it if the item at idx is not in the DOM.
+     */
+    _getPosition(idx: number): number;
+    _calculateAnchor(lower: number, upper: number): number;
+    _getAnchor(lower: number, upper: number): number;
+    /**
+     * Updates _first and _last based on items that should be in the current
+     * viewed range.
+     */
+    _getActiveItems(): void;
+    /**
+     * Sets the range to empty.
+     */
+    _clearItems(): void;
+    _getItems(): void;
+    _calculateError(): number;
+    _reflow(): void;
+    _resetReflowState(): void;
+    _updateScrollSize(): void;
+    /**
+     * Returns the average size (precise or estimated) of an item in the scrolling direction,
+     * including any surrounding space.
+     */
+    protected get _delta(): number;
+    /**
+     * Returns the top and left positioning of the item at idx.
+     */
+    _getItemPosition(idx: number): Positions;
+    /**
+     * Returns the height and width of the item at idx.
+     */
+    _getItemSize(idx: number): Size;
+    _viewDim2Changed(): void;
+}
+export {};
+//# sourceMappingURL=flow.d.ts.map