@hueest/xray 0.2.0 → 0.4.0

package/dist/serialize-B--oY2bV.d.ts

@@ -1,143 +0,0 @@
-import { n as MergedPlate, s as ViewCapture, t as LeafKind } from "./plate-Bv6W-GkA.js";
-
-//#region src/serialize.d.ts
-/**
- * Browser-side capture: walk a live rendered subtree into a Plate — one node
- * tree plus one self-contained, scoped CSS string (ADR 0003). The CSS is
- * lifted from the author rules that matched each node, rewritten to
- * plate-local selectors — it carries `@media` for free and keeps layout live
- * (the M1 bake-off winner; ADR 0005).
- */
-interface CaptureOptions {
-  /** Plate name; comes from the virtual-module specifier. */
-  name: string;
-  /**
-   * Optional programmable capture walker (ADR 0018). The declarative `data-xr-*`
-   * annotations cover the 90%; this is the escape hatch for the 10% a markup
-   * attribute cannot express. Capture-only: it shapes the resulting `PlateNode`
-   * tree but is never persisted into the Plate, and the production adapter never
-   * captures so it ignores this entirely.
-   */
-  walker?: XrayCaptureWalker;
-  /**
-   * Whether the top-level capture roots ARE this plate's own boundary, so the
-   * stitch guard must be SKIPPED for them (ADR 0006/0014, finding #6). True ONLY
-   * for a MANUAL root: there `site.el` is the consumer's own element and its
-   * `data-xr-boundary` marks the boundary of THIS plate, so the root must be
-   * serialized as a real Entry (its box/classes/padding/border) rather than a
-   * stitch-to-itself. Defaults to `false` — the auto path, where the top-level
-   * roots are the wrapper's CHILDREN and any boundary marker on a direct-child
-   * root is a NESTED `<Skeleton>` that MUST stitch (the capture-leak guard).
-   */
-  captureRootIsBoundary?: boolean;
-}
-declare const WALKER_RESULT: unique symbol;
-/**
- * A capture-walk decision. Obtainable ONLY from `ctx.ignore()/bone()/walk()` or
- * `next()` — a consumer cannot hand-build one, so arbitrary `PlateNode`s can
- * never cross the capture boundary (ADR 0018: helpers expose decisions, never
- * raw `PlateNode`s, so xray keeps ownership of the Plate format). Opaque by
- * design: it wraps the internal `PlateNode | null` with zero runtime cost and is
- * unwrapped only inside the engine.
- */
-interface WalkerResult {
-  readonly [WALKER_RESULT]: true;
-}
-/**
- * The context handed to a capture walker's `element` hook (ADR 0018). Every
- * member is a HELPER that returns an opaque `WalkerResult` decision — a walker
- * NEVER hand-builds a `PlateNode`. `el` is the element under consideration; the
- * helpers either drop it, collapse it to one measured Bone, or defer to the
- * built-in walk.
- */
-interface CaptureWalkerContext {
-  /** The element currently being classified. */
-  el: Element;
-  /** Drop this element and its entire subtree (no bone). */
-  ignore: () => WalkerResult;
-  /**
-   * Collapse this element's subtree into ONE measured Bone leaf. `kind` omitted
-   * shares the default classifier's kind-inference heuristic (ADR 0018, Q4).
-   */
-  bone: (opts?: {
-    kind?: LeafKind;
-  }) => WalkerResult;
-  /**
-   * Run the built-in walk for this element: the annotation walker, then the
-   * default classifier (and recurse into the subtree). The decision `next()`
-   * would produce if the walker deferred without inspecting it.
-   */
-  walk: () => WalkerResult;
-}
-/**
- * The programmable capture walker (ADR 0018), v1. `element` is the ONLY hook
- * implemented in v1; `text`/`declarations`/`media`/`list` are RESERVED in the
- * type for future versions and intentionally unimplemented — declaring them now
- * keeps a later addition non-breaking. `next()` runs the downstream decision
- * (annotation walker, then default classifier) and RETURNS it as an opaque
- * `WalkerResult`, which a walker returns verbatim to defer (ADR 0018, Q3).
- */
-interface XrayCaptureWalker {
-  /**
-   * Called for every non-boundary element (the stitch guard runs first and is
-   * unreachable here, ADR 0006). Return one of `ctx.ignore()`, `ctx.bone()`,
-   * `ctx.walk()`, or the `next()` result — the `WalkerResult` type makes a
-   * hand-built `PlateNode` a compile error.
-   */
-  element?: (ctx: CaptureWalkerContext, next: () => WalkerResult) => WalkerResult;
-  /** RESERVED for a future version; not honored in v1. */
-  text?: never;
-  /** RESERVED for a future version; not honored in v1. */
-  declarations?: never;
-  /** RESERVED for a future version; not honored in v1. */
-  media?: never;
-  /** RESERVED for a future version; not honored in v1. */
-  list?: never;
-}
-/**
- * Typed identity wrapper for authoring a capture walker (ADR 0018) — the
- * `defineConfig` pattern. It returns its argument unchanged at runtime; its only
- * job is to infer and check the `XrayCaptureWalker` shape at the call site so an
- * author gets completion and a typo in a hook name is caught.
- */
-declare function defineXrayCaptureWalker(walker: XrayCaptureWalker): XrayCaptureWalker;
-/**
- * Capture the rendered subtree(s) under a Skeleton into a Plate. `roots` are
- * the component's top-level elements (the children of the layout-neutral
- * wrapper); the synthetic root node (id 0) stands in for the wrapper itself.
- */
-declare function capture(roots: readonly Element[], options: CaptureOptions): MergedPlate;
-/**
- * Thrown when a subtree has more nodes than the capture limit — almost always
- * a `<Skeleton>` sitting too high in the tree. Raised after the cheap walk and
- * before the O(rules × nodes) CSS extraction, so an oversized capture is
- * refused without freezing the main thread on it.
- */
-declare class CaptureTooLargeError extends Error {
-  readonly nodeCount: number;
-  /** Folds the oversized-capture warning into the shared diagnostics vocabulary (diagnostics.ts). */
-  readonly code: "too-large";
-  constructor(nodeCount: number);
-}
-interface CaptureRegimeOptions {
-  /** Refuse (throw `CaptureTooLargeError`) before CSS extraction if the walk exceeds this. */
-  maxNodes?: number;
-  /** Optional programmable capture walker (ADR 0018); capture-only, never persisted. */
-  walker?: XrayCaptureWalker;
-  /**
-   * Whether the top-level roots ARE this plate's own boundary, so the stitch
-   * guard is skipped for them (ADR 0006/0014, finding #6). True ONLY for a
-   * MANUAL root; defaults to `false`, the auto path where a boundary marker on a
-   * direct-child root is a NESTED `<Skeleton>` that MUST stitch. See `walkAll`.
-   */
-  captureRootIsBoundary?: boolean;
-}
-/**
- * Capture one view's worth of a component: the tree plus id-form rules,
- * with the viewport width it was taken at. The caller (the dev client)
- * derives the view interval and ships it off; `capture` is the
- * single-view convenience on top.
- */
-declare function captureRegime(roots: readonly Element[], options?: CaptureRegimeOptions): ViewCapture;
-//#endregion
-export { WalkerResult as a, captureRegime as c, CaptureWalkerContext as i, defineXrayCaptureWalker as l, CaptureRegimeOptions as n, XrayCaptureWalker as o, CaptureTooLargeError as r, capture as s, CaptureOptions as t };