@bicharts/chart-host 0.6.77 → 0.6.79

package/dist/index.mjs

@@ -5,7 +5,7 @@ import {
   formatSourceDateFor,
   isExcelDateFormat,
   normaliseAggregation
-} from "./chunk-QOKQUXVV.mjs";
+} from "./chunk-M7VM6F73.mjs";
 import {
   ANNOTATION_CLASS,
   ANNOTATION_LAYER_CLASS,
@@ -28,7 +28,6 @@ import {
   LIGHT_TEXT,
   MAX_FRAME_GROW_FACTOR,
   MIN_CONTRAST,
-  MIN_HIT_BAND_PX,
   MIN_RAMP_FILLS,
   PAGE_MATCH_TOLERANCE,
   PHANTOM_FRACTION,
@@ -37,7 +36,6 @@ import {
   PILL_OPAQUE_ALPHA,
   SAME_SHADE_DELTA_E,
   SCROLL_SLACK_PX,
-  SELECTION_GLYPH_CLASS,
   STRADDLE_COLS,
   STRADDLE_MIN_SHARE,
   STRADDLE_PILL_ALPHA,
@@ -56,13 +54,10 @@ import {
   cellSuppressesNormalize,
   censusClippedText,
   censusColourSpread,
-  censusHitBands,
   censusMarks,
   censusValuePlacement,
   clearGeoCache,
-  clearSelectionGlyphs,
   clippedTextFlag,
-  collectD3GlyphCenters,
   colourSpreadFlag,
   compileRenderFn,
   compositeOver,
@@ -70,53 +65,41 @@ import {
   contrastRatio,
   createChartGroup,
   createChartHost,
-  createMarkResolver,
   ctmScaleOf,
   decideLabelColor,
   deltaEHex,
-  ensureCrossfilterHitTargets,
   explainRenderFailure,
   fitReadingFor,
   fitRenderedChart,
   geoAssetFor,
   geoFromCache,
   glyphSampleGrid,
-  hitBandFlag,
   invalidSentinelReason,
   isBlankRender,
   isHorizontalLabelRow,
-  isInsideControl,
   isInvalidSentinelError,
   isPhantomBox,
   isPillBackdropAlpha,
   labelBand,
   loadGeo,
-  markKeyOf,
   measureContainerBoxes,
   minContrastOver,
   needsScroll,
   newIdScope,
-  nextClickedMarks,
-  nextSelection,
   noopViewStateProvider,
-  paintSelectionGlyphs,
   pickColorOver,
   pillBacksGlyph,
   pinScrolledAxis,
   planAxisPin,
   planFrameGrow,
-  planSelectionPaint,
   registerGeo,
   registerGeoAsset,
   relativeLuminance,
   requiredD3Plugins,
   resolveAutoColorScale,
   resolveOptions,
-  rowIdxsFromMark,
-  sameRowSet,
   scopeChartIds,
   scrollFitFor,
-  selectionRuleOf,
   sessionViewStateProvider,
   straddleSampleGrid,
   straddles,
@@ -128,12 +111,31 @@ import {
   toSourceRows,
   unpinScrolledAxis,
   valuePlacementFlag
-} from "./chunk-IMNZYSIC.mjs";
+} from "./chunk-BFN4NY22.mjs";
 import {
   _3,
   l,
   o
-} from "./chunk-H2P63UMG.mjs";
+} from "./chunk-L554L6HF.mjs";
+import {
+  MIN_HIT_BAND_PX,
+  SELECTION_GLYPH_CLASS,
+  censusHitBands,
+  clearSelectionGlyphs,
+  collectD3GlyphCenters,
+  createMarkResolver,
+  ensureCrossfilterHitTargets,
+  hitBandFlag,
+  isInsideControl,
+  markKeyOf,
+  nextClickedMarks,
+  nextSelection,
+  paintSelectionGlyphs,
+  planSelectionPaint,
+  rowIdxsFromMark,
+  sameRowSet,
+  selectionRuleOf
+} from "./chunk-MGAO2DR7.mjs";
 import "./chunk-A2GMXZP7.mjs";
 import {
   ACTIVE_TICK_CLASS,
@@ -259,6 +261,10 @@ var OPTIONS_VOCABULARY = Object.freeze({
 var LIVE_OPTION_KEYS = Object.freeze(
   Object.keys(OPTIONS_VOCABULARY).filter((k2) => OPTIONS_VOCABULARY[k2].timing === "live" || OPTIONS_VOCABULARY[k2].timing === "live-and-next-generate")
 );
+function codeReadsOption(code, key) {
+  if (!code || !Object.prototype.hasOwnProperty.call(OPTIONS_VOCABULARY, key)) return false;
+  return new RegExp(`\\boptions\\.${key}\\b`).test(code);
+}
 function wireLimitCount(count) {
   const n2 = typeof count === "number" ? count : count == null || count === "" ? NaN : Number(count);
   return Number.isFinite(n2) && n2 > 0 ? n2 : null;
@@ -2430,6 +2436,7 @@ export {
   clearSelectionGlyphs,
   clippedTextFlag,
   codeReadsDatesInLocalTime,
+  codeReadsOption,
   collectD3GlyphCenters,
   colourSpreadFlag,
   compileRenderFn,

package/dist/react.mjs

@@ -22,8 +22,9 @@ import {
   loadGeo,
   syncMemberSelection,
   toSourceRows
-} from "./chunk-IMNZYSIC.mjs";
-import "./chunk-H2P63UMG.mjs";
+} from "./chunk-BFN4NY22.mjs";
+import "./chunk-L554L6HF.mjs";
+import "./chunk-MGAO2DR7.mjs";
 import "./chunk-A2GMXZP7.mjs";
 import "./chunk-7JWL6LYE.mjs";
 import "./chunk-GHODWOAL.mjs";

package/dist/types/adapters/d3.d.ts

@@ -0,0 +1,3 @@
+import type { RendererAdapter } from "./types";
+/** The adapter for a chart drawn with D3: a mark is a DOM element, and its rows are in `data-row-idx`. */
+export declare function createD3Adapter(): RendererAdapter<Element>;

package/dist/types/adapters/index.d.ts

@@ -0,0 +1,3 @@
+export { NULL_ADAPTER } from "./types";
+export type { AdapterEvent, AdapterHit, AdapterScene, MarkHandle, MarkInfo, MarkRole, PaintRequest, RendererAdapter, AdapterId, RowTable, } from "./types";
+export { createD3Adapter } from "./d3";

package/dist/types/adapters/types.d.ts

@@ -0,0 +1,108 @@
+import type { RendererId } from "../host/services";
+import type { SelectionModifiers, SelectionPaintPlan, SelectionRule, GlyphCenter } from "../selection";
+/** What a renderer calls a mark. Opaque to the core: D3 an Element, Plotly {curve, point}, Vega a scenegraph item. */
+export type MarkHandle = unknown;
+/** What a mark is for: a data mark, a legend swatch, or an axis label that filters. */
+export type MarkRole = "mark" | "legend" | "axis";
+/** Which renderer an adapter binds: the same vocabulary a host declares it supports (host/services.ts). */
+export type AdapterId = RendererId | "NONE";
+/** The rows a renderer that works in values (Vega) resolves a click against. */
+export interface RowTable {
+    rows: readonly Record<string, unknown>[];
+    columns: readonly {
+        name?: string;
+        isMeasure?: boolean;
+    }[];
+}
+/** Everything an adapter may need about the chart it is bound to. */
+export interface AdapterScene {
+    container: HTMLElement;
+    doc: Document;
+    /** How many rows the chart has: the bound a renderer that reads row numbers from its own data must check. */
+    rowCount?: number;
+    /** The row table, for a renderer whose marks name values. */
+    table?: RowTable;
+    /** The diagnostics sink; the resolution logic logs through it and never throws. */
+    log(tag: string, data?: object): void;
+}
+/** One mark as the core sees it. */
+export interface MarkInfo<H = MarkHandle> {
+    handle: H;
+    role: MarkRole;
+    /** The data rows the mark stands for. */
+    rows: readonly number[];
+    /** The mark's identity under the "clicked-marks" selection rule. */
+    key: string;
+}
+/** A click as the core hands it over. `native` is whatever the renderer's own event is. */
+export interface AdapterEvent {
+    native: unknown;
+    clientX?: number;
+    clientY?: number;
+    modifiers: SelectionModifiers;
+}
+/**
+ * What a click turned out to be. The four are different gestures and the core answers each differently, so an
+ * adapter must say which:
+ *   mark    - a mark (furniture included; `role` says which);
+ *   control - inside a control the chart drew: neither a selection nor a click on empty canvas;
+ *   empty   - the empty canvas: the core MAY clear the selection (D3);
+ *   ignored - a click that resolves to nothing the adapter can use: log it and change nothing (Vega).
+ */
+export type AdapterHit<H = MarkHandle> = {
+    kind: "mark";
+    mark: MarkInfo<H>;
+} | {
+    kind: "control";
+} | {
+    kind: "empty";
+} | {
+    kind: "ignored";
+    reason: string;
+};
+/** A request to draw a selection. `plan` is present when the renderer's marks can be listed (D3). */
+export interface PaintRequest<H = MarkHandle> {
+    selection: ReadonlySet<number>;
+    active: boolean;
+    dimOpacity: number;
+    plan?: {
+        marks: readonly MarkInfo<H>[];
+        result: SelectionPaintPlan;
+    };
+}
+/**
+ * One renderer's binding. Every capability but identity is optional, because renderers differ in what they own: a
+ * renderer that subscribes to its own click events implements `bind` and leaves `hit` out; one the core's container
+ * listener serves implements `hit`.
+ */
+export interface RendererAdapter<H = MarkHandle> {
+    readonly id: AdapterId;
+    /** Who delivers clicks: the core's container listener, the adapter's own subscription, or nobody. */
+    readonly input: "container-click" | "adapter-bound" | "none";
+    /** Subscribe to the renderer's own click events; returns the unsubscribe. */
+    bind?(scene: AdapterScene, onHit: (hit: AdapterHit<H>, modifiers: SelectionModifiers) => void): () => void;
+    /** Every mark the chart drew, as opaque handles. */
+    marks?(scene: AdapterScene): readonly MarkInfo<H>[];
+    /** Resolve a click to what it hit. */
+    hit?(event: AdapterEvent, scene: AdapterScene): AdapterHit<H>;
+    /** The data rows a mark stands for. */
+    rowsOf?(handle: H, scene: AdapterScene, role?: MarkRole): number[];
+    /** How a selection lights this chart's marks; "any-row" when the chart declared nothing. */
+    declaredRule?(scene: AdapterScene): SelectionRule;
+    /** Draw a selection. */
+    paint?(request: PaintRequest<H>, scene: AdapterScene): void | Promise<void>;
+    /** Where each selected mark's glyph goes, in pixels from `base`. */
+    glyphAnchors?(base: {
+        left: number;
+        top: number;
+    }, scene: AdapterScene): GlyphCenter[];
+    /** Make the render hittable after it draws; returns what it changed. */
+    prepare?(scene: AdapterScene): unknown;
+    /** A behavior tag and detail for the render, or null when there is nothing to say. */
+    census?(scene: AdapterScene): {
+        flag: string;
+        detail: object;
+    } | null;
+}
+/** No marks and no binding: legal, and what a chart that cannot be selected from is. */
+export declare const NULL_ADAPTER: RendererAdapter;

package/dist/types/index.d.ts

@@ -1,6 +1,6 @@
 export { HOST_CONTRACT_VERSION, GEO_POINT_PRECISIONS, MARK_CLASS, LEGEND_MARK_CLASS, AXIS_FILTER_CLASS, ROW_IDX_ATTR, LIFT_SELECTED_CLASS, CONTROL_CLASS, NO_ROW_MARKS_ATTR, SELECTION_RULE_ATTR, SELECTION_RULE_CLICKED_MARKS, MARK_KEY_ATTR, CONTAINER_SLOT_CLICKED_MARKS, SNAPSHOT_SVG_ATTR, XFILTER_REFRESH_EVENT, CONTAINER_SLOT_ANIM_STOP, CONTAINER_SLOT_XF_CLEAR, CONTAINER_SLOT_INITIAL_XF_MARK, CONTAINER_SLOT_UI_STATE, VIEW_ONLY_UI_STATE_KEYS, withoutViewOnlyKeys, HOST_CONTAINER_CLASS, SELECTION_ACTIVE_CLASS, MARK_SELECTED_CLASS, ACTIVE_TICK_CLASS, DIM_OPACITY_VAR, DIM_OPACITY_DEFAULT, chartOwnsTimeline, periodTickSuppressesFeedback, ANIM_PLAY_SPEED_DEFAULT, ANIM_PLAY_SPEED_MIN, ANIM_PLAY_SPEED_MAX, ANIM_LOOP_DELAY_DEFAULT, ANIM_LOOP_DELAY_MIN, ANIM_MAX_IDEAL_FRAMES_DEFAULT, ANIM_MAX_IDEAL_FRAMES_MIN, ANIM_MAX_IDEAL_FRAMES_MAX, ANIMATION_OPTION_KEYS, COLOR_SCALE_SELF_CLAMP_PCT_DEFAULT, COLOR_SCALE_SELF_CLAMP_PCT_MIN, COLOR_SCALE_SELF_CLAMP_PCT_MAX, FLIP_MODE_DEFAULT, FLIP_INTERVAL_MIN_MS, FLIP_INTERVAL_MAX_MS, FLIP_DIRECTION_DEFAULT, APPROXIMATE_POSITIONS_DEFAULT, VALUE_AXIS_BASELINE_DEFAULT, SEASONAL_MARKERS_DEFAULT, MAX_MAP_POINTS_DEFAULT, type GeoPointPrecision, type GeoMapKind, type TimelineStyle, type FlipMode, type FlipDirection, type ApproximatePositions, type ValueAxisBaseline, type SeasonalMarkers, type ColorScaleScope, type RenderOptions, type ViewStateProvider, type ChartControlChange, } from "./contract";
 export { resolveOptions, type ResolveOptionsInput } from "./defaults";
-export { OPTIONS_VOCABULARY, LIVE_OPTION_KEYS, MAX_MAP_POINTS_MIN, MAX_MAP_POINTS_MAX, LIMIT_COUNT_MAX, wireLimitCount, type OptionVocabularyEntry, type OptionTiming, type OptionWire, type OptionKey, } from "./optionsVocabulary";
+export { OPTIONS_VOCABULARY, LIVE_OPTION_KEYS, MAX_MAP_POINTS_MIN, MAX_MAP_POINTS_MAX, LIMIT_COUNT_MAX, wireLimitCount, codeReadsOption, type OptionVocabularyEntry, type OptionTiming, type OptionWire, type OptionKey, } from "./optionsVocabulary";
 export { loadGeo, geoFromCache, registerGeo, registerGeoAsset, geoAssetFor, clearGeoCache, type GeoAssetName, } from "./geoLazy";
 /** REPLACE the bundled city gazetteer with another packed table. Rarely needed — see the
  *  note above registerCityTable in shape-core's geoPoint.ts before using it. */
@@ -14,6 +14,7 @@ export type { Controls, ControlInfo, ControlsAttachment } from "./controls";
 export { createChartGroup, toSourceRows, syncMemberSelection, type ChartGroup, type ChartGroupMember, type ChartGroupSelection, type ChartGroupChange, type ChartGroupMemberOptions, type ChartGroupSourceOptions, type ChartGroupPayload } from "./group";
 export type { Filter, FilterScope, FilterOptions, FilterKey, FilterChangeReason, FilterBinding, BindFilterOptions, VegaInteractionEvent, PageView } from "./filterScope";
 export { createMarkResolver, isInsideControl, rowIdxsFromMark, nextSelection, selectionRuleOf, markKeyOf, planSelectionPaint, nextClickedMarks, sameRowSet, type SelectionRule, type ClickedMarks, type SelectionPaintMark, type SelectionPaintMode, type SelectionPaintPlan, collectD3GlyphCenters, clearSelectionGlyphs, paintSelectionGlyphs, SELECTION_GLYPH_CLASS, type MarkResolver, type MarkResolverEnv, type GlyphCenter, type SelectionGlyphStyle, type SelectionModifiers, } from "./selection";
+export type { AdapterEvent, AdapterHit, AdapterId, AdapterScene, MarkHandle, MarkInfo, MarkRole, PaintRequest, RendererAdapter, RowTable, } from "./adapters/types";
 export { planTrivialChart, compileTrivialSource, type TrivialPlan, type TrivialShapeKind } from "./trivial";
 export { captureSvgSnapshot, svgToDataUrl, svgNaturalSize, rasterizeSvgToPngDataUrl, tableHostOf, chartSvgOf, htmlToSvgDataUrl, htmlNaturalSize, type SnapshotOptions } from "./snapshot";
 export { shouldReview, buildReviewWire, bareBase64, actionFor, type ReviewGate, type ReviewWire, type ReviewVerdict, type ReviewAction } from "./review";

package/dist/types/optionsVocabulary.d.ts

@@ -91,6 +91,14 @@ export declare const OPTIONS_VOCABULARY: Readonly<{
 export type OptionKey = keyof typeof OPTIONS_VOCABULARY;
 /** The keys whose change repaints the chart on screen, in table order. */
 export declare const LIVE_OPTION_KEYS: readonly OptionKey[];
+/**
+ * Does this chart's code read the shared option `key`?
+ * A host uses it to show a control only for a chart that
+ * will respond to it - a switch on a chart that ignores it
+ * does nothing. Generated code reads options as
+ * `options.<key>`, so the property access is the test.
+ */
+export declare function codeReadsOption(code: string | null | undefined, key: OptionKey): boolean;
 /**
  * THE LIMIT COUNT A REQUEST CARRIES: a positive count, or null - never 0. The server reads any value it
  * receives as the reader's own limit (and 0 as a limit of zero), so "no limit" must arrive as no value.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bicharts/chart-host",
-  "version": "0.6.77",
+  "version": "0.6.79",
   "description": "Run a BIC-generated D3 chart in any web host: compiles the generated render() function, applies the shared option defaults, resolves mark clicks (through tooltip overlays), owns the selection affordance, and translates row indices between cross-filtered charts. The same contract the BIC Power BI visual implements, minus Power BI. React bindings at @bicharts/chart-host/react.",
   "license": "Apache-2.0",
   "type": "module",
@@ -49,6 +49,11 @@
       "import": "./dist/card.mjs",
       "default": "./dist/card.mjs"
     },
+    "./adapters": {
+      "types": "./dist/types/adapters/index.d.ts",
+      "import": "./dist/adapters.mjs",
+      "default": "./dist/adapters.mjs"
+    },
     "./dax": {
       "types": "./dist/types/dax.d.ts",
       "import": "./dist/dax.mjs",