@bicharts/chart-host 0.6.102 → 0.6.103

package/dist/types/hostLinks.d.ts

@@ -0,0 +1,11 @@
+/** The clipboard half a host can supply: navigator.clipboard, or anything with the same writeText. */
+export interface ClipboardLike {
+    writeText?: (text: string) => Promise<void>;
+}
+/** The two services, ready to spread into a host's render options: each is absent when the host supplied nothing for it. */
+export interface HostLinkServices {
+    openUrl?: (url: string) => void;
+    copyText?: (text: string) => boolean | Promise<boolean>;
+}
+/** Builds openUrl and copyText from a host's own opener and clipboard. */
+export declare function hostLinkServices(open: ((url: string) => void) | undefined | null, clipboard: ClipboardLike | undefined | null): HostLinkServices;

package/dist/types/index.d.ts

@@ -1,5 +1,7 @@
-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, CONTAINER_SLOT_SCROLL, VIEW_ONLY_UI_STATE_KEYS, withoutViewOnlyKeys, HOST_CONTAINER_CLASS, SELECTION_ACTIVE_CLASS, MARK_SELECTED_CLASS, ACTIVE_TICK_CLASS, DIM_OPACITY_VAR, DIM_OPACITY_DEFAULT, DIM_OPACITY_MIN, 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, type XfilterRefreshDetail, } from "./contract";
+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, NOTE_STYLE_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, CONTAINER_SLOT_SCROLL, VIEW_ONLY_UI_STATE_KEYS, withoutViewOnlyKeys, HOST_CONTAINER_CLASS, SELECTION_ACTIVE_CLASS, MARK_SELECTED_CLASS, ACTIVE_TICK_CLASS, DIM_OPACITY_VAR, DIM_OPACITY_DEFAULT, DIM_OPACITY_MIN, 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, type XfilterRefreshDetail, } from "./contract";
 export { resolveOptions, type ResolveOptionsInput } from "./defaults";
+export { hostLinkServices, type HostLinkServices, type ClipboardLike } from "./hostLinks";
+export { tableToCsv, tableToXlsx, buildExportFile, exportFileName, sheetName as exportSheetName, excelNumberFormat, excelSerial, bytesToBase64, exportFormatsFor, exportTableService, browserSaveFile, EXPORT_FORMATS, XLSX_MIME, CSV_MIME, type ExportTable, type ExportColumn, type ExportColumnType, type ExportCell, type ExportFormat, type ExportFile, type SaveFileService, type ExportTableService, } from "./exportTable";
 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
@@ -21,6 +23,7 @@ export { captureSvgSnapshot, svgToDataUrl, svgNaturalSize, rasterizeSvgToPngData
 export { shouldReview, buildReviewWire, bareBase64, actionFor, type ReviewGate, type ReviewWire, type ReviewVerdict, type ReviewAction } from "./review";
 export { askApplyImprovements, type ReviewDialogOptions, type ReviewDialogText } from "./reviewDialog";
 export { mountProductFeedbackBox, normaliseProductFeedbackText, productFeedbackSendable, buildProductFeedbackPayload, PRODUCT_FEEDBACK_MAX_CHARS, PRODUCT_FEEDBACK_MIN_CHARS, type ProductFeedbackBox, type ProductFeedbackBoxOptions, type ProductFeedbackText, type ProductFeedbackSendResult, type ProductFeedbackPayload, type ProductFeedbackIdentity, type ProductFeedbackHost, } from "./productFeedback";
+export { mountShareRateLine, shareRateLineModel, type ShareRateLine, type ShareRateLineOptions, type ShareRateText, type ShareRateModel, type ShareLink, type ShareAskWire, type ShareTargetWire, } from "./shareRate";
 export { qualifyGroupHeadingFor, newQualifyGroupState, type QualifyGroupRow, type QualifyGroupState, type QualifyGroupHeading, orderRefusalsForDisplay, refusalIsSelectable, hasRefusalsToShow, qualifyRefusalHeadingFor, newQualifyRefusalGroupState, qualifyRefusalReason, QUALIFY_REFUSAL_UNSPECIFIED, refusalIsTileBound, QUALIFY_TILE_REFUSAL_CODES, QUALIFY_TOO_SMALL_HEADING, type QualifyRefusalRow, type QualifyRefusalGroupState, type QualifyRefusalHeading, } from "./qualifyGroups";
 export { qualifyPick, qualifyAuto, qualifyCancel, launchGenerates, launchFavorStyle, chooserFitsViewport, shouldOpenChooserOnGenerate, shouldOpenInlineChooserOnGenerate, canConfirmLaunch, confirmLaunch, qualifyFailureFallsOpen, CHOOSER_MIN_WIDTH_PX, CHOOSER_MIN_HEIGHT_PX, type QualifyLaunchOutcome, type ChooserGateInput, } from "./qualifyLaunch";
 export { normalizeFilterTerm, filterQualifyRows, readQualifyChartRow, readQualifyRefusalRow, DEFAULT_FILTER_MATCH_STYLE, filterMatchStyleOf, type FilterMatchStyle, filterFitsChooser, listNeedsFilter, qualifyFilterGate, inlineFilterGate, FILTER_MIN_TERM_CHARS, FILTER_ROW_PX, FILTER_MIN_WIDTH_PX, FILTER_MIN_HEIGHT_PX, INLINE_FILTER_MIN_ROWS, computeQualifyFilterView, qualifyFilterCountText, type QualifyFilterTier, type QualifyFilterResult, type QualifyFilterRead, type QualifyFilterGateReason, type QualifyFilterGateInput, type QualifyFilterRow, type QualifyFilterGroup, type QualifyFilterView, type QualifyFilterNoteKind, } from "./qualifyFilter";

package/dist/types/shareRate.d.ts

@@ -0,0 +1,90 @@
+/** The block as the service sends it. Either casing is accepted, because the hosts' status calls serialise differently.
+ *  shape-core types the same block on the status answer (GetLicenseStatusResult.shareAsk); it is restated here because
+ *  this package's published declarations import nothing they do not ship, and a typecheck test holds the two equal. */
+export interface ShareAskWire {
+    productUrl?: string;
+    ProductUrl?: string;
+    rateUrl?: string;
+    RateUrl?: string;
+    targets?: ShareTargetWire[];
+    Targets?: ShareTargetWire[];
+}
+export interface ShareTargetWire {
+    id?: string;
+    Id?: string;
+    label?: string;
+    Label?: string;
+    url?: string;
+    Url?: string;
+}
+export interface ShareLink {
+    /** Short network id ("li", "fb", "x"); a host's click counter names it. */
+    id: string;
+    label: string;
+    url: string;
+}
+export interface ShareRateModel {
+    share: ShareLink[];
+    /** The listing to rate; null when the block had none worth drawing. */
+    rateUrl: string | null;
+}
+/**
+ * The links to draw for a service block, or null to draw nothing. Absent block, nothing https, or nothing usable: null.
+ * A target whose URL is not https, whose id is malformed or repeated, or which has no label is dropped; the order the
+ * service sent is kept.
+ */
+export declare function shareRateLineModel(ask: ShareAskWire | null | undefined): ShareRateModel | null;
+/** The words a reader sees. Hosts localize; every field has an English default. Network names come from the service. */
+export interface ShareRateText {
+    /** Before the network links: "Like it? Share it on". */
+    lead?: string;
+    /** Between the network links. */
+    separator?: string;
+    /** Between the share links and the rate link: ", or". */
+    or?: string;
+    /** The rate link after share links: "rate it on AppSource". */
+    rate?: string;
+    /** The rate link when there is nothing to share: "Like it? Rate it on AppSource". */
+    rateAlone?: string;
+    /** After the links: "Your ratings and feedback encourage us to do more." */
+    note?: string;
+    /** Menu layout, first: "Thanks for rating it." */
+    thanks?: string;
+    /** Menu layout, the rate link: "Rate it on AppSource too". */
+    rateToo?: string;
+    /** Menu layout, the toggle that reveals the networks: "Share it". */
+    shareMenu?: string;
+}
+export interface ShareRateLineOptions {
+    /** The service's block, as it arrived. Nothing is drawn when it yields no links. */
+    ask: ShareAskWire | null | undefined;
+    /** Opens a URL through the host's own door. The line never navigates by itself. */
+    open: (url: string) => void;
+    text?: ShareRateText;
+    /** Added to the wrapper so the host can skin it. */
+    className?: string;
+    /** "inline" (the landing line: the networks named in the sentence) or "menu" (after a vote: a short thank-you, the
+     *  rate link, and a "Share it" toggle that reveals the networks). The links, their order and the click contract are
+     *  the same either way. */
+    layout?: "inline" | "menu";
+    /** Menu layout: the "Share it" toggle opened the networks. */
+    onMenu?: () => void;
+    /** Called once, when the line is mounted - the host's "shown" counter. A host that folds the line away counts it
+     *  itself instead and passes nothing here. */
+    onShown?: () => void;
+    /** A network link was clicked. */
+    onShare?: (id: string) => void;
+    /** The rate link was clicked. */
+    onRate?: () => void;
+}
+export interface ShareRateLine {
+    element: HTMLElement;
+    destroy(): void;
+}
+/**
+ * Draw the line inside `container`, or return null (and draw nothing) when the block yields no links. The wrapper carries
+ * `bic-share-rate`; network links `bic-share-rate-share` with `data-target`; the rate link `bic-share-rate-rate`; the
+ * note `bic-share-rate-note`. Every link carries its real href (so it reads as a link, and a reader can copy it), but a
+ * click is cancelled and handed to `open`.
+ */
+export declare function mountShareRateLine(container: HTMLElement, opts: ShareRateLineOptions): ShareRateLine | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bicharts/chart-host",
-  "version": "0.6.102",
+  "version": "0.6.103",
   "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",