@richardmcquiston01/dashboard-widgets-toolkit 0.13.0 → 0.15.0

package/dist/{storage-DNB7gjvT.d.ts → storage-DwJ-vGJg.d.ts}

@@ -738,6 +738,112 @@ declare function tableDetailData(data: TableWidgetData): DetailData;
  */
 declare function deriveDetailData(data: WidgetData, locale?: Locale): DetailData | undefined;
 
+/**
+ * Alternate views: other ways to show the same data. A widget declares
+ * `views`, each one built from the widget's own payload by a named,
+ * parameterized conversion (data, not functions, so definitions stay JSON).
+ * Switching is instant: no second load. Pure functions, no I/O.
+ */
+
+/** The key of the widget's own kind, always available as a view. */
+declare const BASE_VIEW_KEY = "base";
+/** Most views one widget may declare, the base view not counted. */
+declare const MAX_WIDGET_VIEWS = 8;
+/** How a view is built from the widget's payload. */
+type ViewConversion = {
+    readonly type: 'tableToBarList';
+    /** Column index of the bar labels. */
+    readonly label: number;
+    /** Column index of the bar values (cells need a numeric `value`). */
+    readonly value: number;
+} | {
+    readonly type: 'tableToGraph';
+    /** Column index of the x labels. */
+    readonly label: number;
+    /** Column indexes of the series (cells need a numeric `value`). */
+    readonly values: readonly number[];
+    readonly chartType: 'bar' | 'line';
+    /** How the numbers read. Default `number`. */
+    readonly valueFormat?: ValueFormat;
+    readonly currency?: string;
+} | {
+    readonly type: 'barListToTable';
+    /** Heading of the label column. Default "Name". */
+    readonly labelHeading?: string;
+    /** Heading of the value column. Default "Value". */
+    readonly valueHeading?: string;
+} | {
+    readonly type: 'graphToTable';
+} | {
+    readonly type: 'barListToGraph';
+    readonly chartType: 'bar' | 'line';
+    /** Name of the one series. Default "Value". */
+    readonly seriesName?: string;
+    readonly valueFormat?: ValueFormat;
+    readonly currency?: string;
+};
+/** The kinds a conversion reads and produces. */
+declare const VIEW_CONVERSIONS: Readonly<Record<ViewConversion['type'], {
+    from: WidgetKind;
+    to: WidgetKind;
+}>>;
+/** One alternate way to show a widget. */
+interface WidgetView {
+    /** Unique within the widget; not `base`. Stored in the viewer's settings. */
+    readonly key: string;
+    /** What the viewer sees in the View field, e.g. "Bars". */
+    readonly label: string;
+    /** What this view renders; must match what the conversion produces. */
+    readonly kind: WidgetKind;
+    /** Builds this view from the widget's payload. */
+    readonly convert: ViewConversion;
+}
+/** What these functions need from a definition. */
+type ViewsItem = Pick<WidgetDefinition, 'key' | 'kind'> & Partial<Pick<WidgetDefinition, 'views' | 'defaultView' | 'baseViewLabel'>>;
+/** A kind's plain name, used for the base view unless `baseViewLabel` is set. */
+declare function kindLabel(kind: WidgetKind): string;
+/** Whether the definition offers a choice of views. */
+declare function hasViews(item: Pick<ViewsItem, 'views'>): boolean;
+/** The view with this key, or undefined (`base` is not a declared view). */
+declare function findView(item: Pick<ViewsItem, 'views'>, key: string): WidgetView | undefined;
+/** Every view a viewer may pick: the base first, then the declared ones. */
+declare function viewChoices(item: ViewsItem): readonly {
+    key: string;
+    label: string;
+    kind: WidgetKind;
+}[];
+/**
+ * The view in effect: the viewer's pick when the definition declares it,
+ * else `defaultView`, else the base. Always a valid key.
+ */
+declare function effectiveViewKey(item: ViewsItem, chosen: string | undefined): string;
+/** The kind the widget renders as under this view key. */
+declare function viewKind(item: ViewsItem, chosen: string | undefined): WidgetKind;
+/** Options for `convertView`. */
+interface ConvertViewOptions {
+    /** Locale for numbers a conversion has to format (graph to table). */
+    readonly locale?: Locale;
+}
+/**
+ * Builds a view's payload from the widget's payload. The error names the
+ * widget, the view and what to fix, for example `Widget "top-products" view
+ * "bars": row 3, column 2 ("Sold") has no numeric value. Add value to the
+ * cells.` Never throws.
+ */
+declare function convertView(widgetKey: string, view: Pick<WidgetView, 'key' | 'convert'>, data: WidgetData, options?: ConvertViewOptions): Result<WidgetData>;
+/**
+ * What a view keeps of a table, for the dialog: "Shows Name and Sold only."
+ * Empty when the view loses nothing worth saying.
+ */
+declare function viewNote(view: WidgetView, data: WidgetData | undefined): string;
+/**
+ * The widget as the chosen view shows it: the payload converted and the
+ * definition's `kind` set to the view's kind, so renderers work unchanged.
+ * A widget that isn't `ok`, or whose view is the base, comes back as is; a
+ * failed conversion becomes an `error` widget naming the fix.
+ */
+declare function applyView<W extends DashboardWidget>(widget: W, chosen: string | undefined, options?: ConvertViewOptions): DashboardWidget;
+
 /** A size hint for grid layouts; renderers may map it to column spans. */
 declare const WIDGET_SIZES: readonly ["small", "medium", "large", "full"];
 type WidgetSize = (typeof WIDGET_SIZES)[number];
@@ -775,6 +881,14 @@ interface WidgetDefinition {
      * give widgets more room automatically.
      */
     readonly width?: number;
+    /**
+     * The narrowest and widest a viewer may make the widget (integers from 2 to
+     * 12, `minWidth <= width <= maxWidth`). A table that needs room sets
+     * `minWidth: 6`; a KPI tile that looks silly wide sets `maxWidth: 4`.
+     * Without them the full 2 to 12 range applies.
+     */
+    readonly minWidth?: number;
+    readonly maxWidth?: number;
     /**
      * Gives the widget a detail view: a full list with sorting, filtering and
      * paging. `true` uses defaults. The data comes from a detail provider.
@@ -790,8 +904,8 @@ interface WidgetDefinition {
     /** Fill free space in the row (height, width or both). Default: none. */
     readonly fill?: WidgetFill;
     /**
-     * Keeps viewers from rearranging this widget. `true` locks everything:
-     * move, hide and minimize. Use an object to lock only some; fields left out
+     * Keeps viewers from changing this widget. `true` locks everything:
+     * move, hide, minimize and options. Use an object to lock only some; fields left out
      * are not locked.
      */
     readonly locked?: boolean | WidgetLock;
@@ -807,6 +921,16 @@ interface WidgetDefinition {
      * `ProviderOptions.options`. See `options.ts`.
      */
     readonly options?: readonly WidgetOption[];
+    /**
+     * Other ways to show this widget, built from its payload by a named
+     * conversion (a table as bars or a chart). The widget's own `kind` is
+     * always available as the view `base`. See `views.ts`.
+     */
+    readonly views?: readonly WidgetView[];
+    /** The view shown until a viewer picks another: `base` or a `views` key. Default `base`. */
+    readonly defaultView?: string;
+    /** What the base view is called in the View field. Default: its kind's name. */
+    readonly baseViewLabel?: string;
 }
 /** What a viewer may not do to a locked widget. */
 interface WidgetLock {
@@ -816,6 +940,8 @@ interface WidgetLock {
     readonly hide?: boolean;
     /** Can't be collapsed to its header. */
     readonly minimize?: boolean;
+    /** Can't be given a title, width or option values of the viewer's own. */
+    readonly options?: boolean;
 }
 /** `WidgetLock` with every default filled in. */
 type ResolvedWidgetLock = Required<WidgetLock>;
@@ -900,6 +1026,136 @@ declare function placeRows(items: readonly GridItem[]): readonly PlacedRow[];
  */
 declare function fitCount(items: readonly GridItem[], maxRows: number): number;
 
+/**
+ * A viewer's own choices for a widget: a title, a width and values for the
+ * options its author declared. They live in the layout (`layout.settings`),
+ * so the consumer's existing persistence saves them, and they override what
+ * the definition says without changing it. Pure functions, no I/O.
+ */
+
+/** What one viewer chose for one widget. Every field is optional. */
+interface WidgetViewerSettings {
+    /** Replaces the widget's title. Plain text, at most 80 characters. */
+    readonly title?: string;
+    /** Share of the row in twelfths, within the definition's min and max. */
+    readonly width?: number;
+    /** May grow into the columns left over in its row (see `fill`). */
+    readonly flexible?: boolean;
+    /** Values for declared options, by option key. */
+    readonly options?: Readonly<Record<string, OptionValue>>;
+    /** The view to show: `base` or a key from the definition's `views`. */
+    readonly view?: string;
+}
+/** Viewer settings by widget key. */
+type LayoutSettings = Readonly<Record<string, WidgetViewerSettings>>;
+/** Longest title a viewer can give a widget; longer ones are cut. */
+declare const MAX_WIDGET_TITLE_LENGTH = 80;
+/**
+ * Most widgets `parseLayout` keeps settings for: a safety ceiling against
+ * malformed or hostile JSON, not a product limit.
+ */
+declare const MAX_PARSED_SETTINGS = 500;
+/** What these functions need from a definition. */
+type SettingsItem = Pick<WidgetDefinition, 'key'> & Partial<Pick<WidgetDefinition, 'title' | 'width' | 'minWidth' | 'maxWidth' | 'fill' | 'locked' | 'options' | 'views' | 'defaultView'>>;
+/**
+ * Reads the `settings` field of a saved layout. Anything malformed is
+ * dropped (wrong types, titles over the limit are cut, widths outside 2 to
+ * 12), never an error. Returns undefined when nothing usable is left.
+ */
+declare function parseSettings(raw: unknown): LayoutSettings | undefined;
+/** The JSON-ready form of `layout.settings`; fields keep a stable order. */
+declare function serializeSettings(settings: LayoutSettings | undefined): Record<string, WidgetViewerSettings> | undefined;
+/** The narrowest and widest share a widget may take. */
+declare function widthRange(item: Pick<SettingsItem, 'minWidth' | 'maxWidth'>): {
+    readonly min: number;
+    readonly max: number;
+};
+/** A width as a share of the row: 2 is `1/6`, 6 is `1/2`, 12 is `Full`. */
+declare function widthShareLabel(width: number): string;
+/** Whether the lock on this widget forbids viewer settings. */
+declare function isOptionsLocked(item: Pick<SettingsItem, 'locked'>): boolean;
+/** Whether the widget grows into free columns: the viewer's choice, else its `fill`. */
+declare function isFlexible(item: Pick<SettingsItem, 'fill'>, settings: WidgetViewerSettings | undefined): boolean;
+/**
+ * The definition as this viewer sees it: their title, their width (kept
+ * within the definition's limits) and their choice of Flexible applied on
+ * top of the author's. Returns the same object when there is nothing to
+ * apply. Options are not part of the definition; read them with
+ * `widgetOptionValues`.
+ */
+declare function applySettings<D extends SettingsItem>(definition: D, settings: WidgetViewerSettings | undefined): D;
+/**
+ * The definitions with each viewer's settings applied. A widget whose lock
+ * forbids options (`locked.options`) ignores them, so a saved layout can't
+ * reach around a lock. Pass `overrideLocks` for an administrator.
+ */
+declare function effectiveDefinitions<D extends SettingsItem>(definitions: readonly D[], layout: {
+    readonly settings?: LayoutSettings;
+}, options?: {
+    readonly overrideLocks?: boolean;
+}): D[];
+/**
+ * The chosen option values for a widget, resolved: the viewer's where valid,
+ * else the author's defaults. Empty when it declares no options.
+ */
+declare function widgetOptionValues(definition: Pick<SettingsItem, 'options'>, settings: WidgetViewerSettings | undefined): OptionValues;
+/**
+ * What to pass `useWidgets({ optionValues })` so the data follows the
+ * layout: for every widget that declares options, the viewer's chosen
+ * values (empty when they haven't chosen, which means the defaults). Every
+ * such widget is listed so Reset sends its defaults back to the provider.
+ */
+declare function optionValuesFromLayout(definitions: readonly Pick<SettingsItem, 'key' | 'options' | 'locked'>[], layout: {
+    readonly settings?: LayoutSettings;
+}, options?: {
+    readonly overrideLocks?: boolean;
+}): Record<string, Readonly<Record<string, OptionValue>>>;
+/** Fields `setWidgetSettings` can change; `undefined` clears one. */
+interface WidgetSettingsPatch {
+    readonly title?: string | undefined;
+    readonly width?: number | undefined;
+    readonly flexible?: boolean | undefined;
+    /** Replaces all of the widget's option values (`undefined` clears them). */
+    readonly options?: Readonly<Record<string, OptionValue>> | undefined;
+    /** The view key (`base` or a declared view); `undefined` clears it. */
+    readonly view?: string | undefined;
+}
+type LayoutWithSettings<L> = L & {
+    readonly settings?: LayoutSettings;
+};
+/**
+ * A layout with `patch` applied to one widget's settings. Fields the patch
+ * names as `undefined` are cleared; others stay. An entry left empty is
+ * removed. Returns the same layout when nothing changes.
+ */
+declare function setWidgetSettings<L extends object>(layout: LayoutWithSettings<L>, key: string, patch: WidgetSettingsPatch): LayoutWithSettings<L>;
+/** A layout without one widget's settings (Reset to defaults). */
+declare function clearWidgetSettings<L extends object>(layout: LayoutWithSettings<L>, key: string): LayoutWithSettings<L>;
+/** Lower-cased, trimmed and Unicode-normalized, for comparing titles. */
+declare function normalizeTitle(title: string): string;
+/**
+ * Whether another widget already shows `title`: compared trimmed,
+ * case-insensitive and Unicode-normalized, against the other widgets'
+ * effective titles. A dialog uses it to refuse a duplicate.
+ */
+declare function isTitleInUse<D extends SettingsItem>(definitions: readonly D[], layout: {
+    readonly settings?: LayoutSettings;
+}, key: string, title: string): boolean;
+/** Options for `normalizeSettings`. */
+interface NormalizeSettingsOptions {
+    /** Keep settings that a widget's `locked.options` forbids. */
+    readonly overrideLocks?: boolean;
+}
+/**
+ * Cleans a layout's settings against the definitions, for a save endpoint:
+ * drops settings of unknown widgets and of widgets locked against options,
+ * clamps widths to `minWidth` and `maxWidth`, trims titles, drops option
+ * values the definition didn't declare or that aren't valid for their
+ * option, and makes titles unique by appending "(#n)". Idempotent; returns
+ * the same layout when nothing changes.
+ */
+declare function normalizeSettings<D extends SettingsItem, L extends object>(definitions: readonly D[], layout: LayoutWithSettings<L>, options?: NormalizeSettingsOptions): LayoutWithSettings<L>;
+
 /**
  * A viewer's dashboard customization: order, hidden and minimized widgets.
  * Pure functions over a small JSON-serialisable object. Persist it however
@@ -931,6 +1187,11 @@ interface DashboardLayout {
      * empty. See `pages.ts`.
      */
     readonly pages?: readonly LayoutPage[];
+    /**
+     * What the viewer chose for each widget (title, width, option values), by
+     * widget key. See `settings.ts`. Absent when they chose nothing.
+     */
+    readonly settings?: LayoutSettings;
 }
 /** One page of a paged layout: the same lists as a layout, plus a name. */
 interface LayoutPage {
@@ -1330,4 +1591,4 @@ interface LayoutPersistence {
  */
 declare function createLayoutPersistence(adapter: StorageAdapter, options?: LayoutPersistenceOptions): LayoutPersistence;
 
-export { type DetailCell as $, type AlertListWidgetData as A, type BarListWidgetData as B, type CachedPayload as C, type DashboardWidget as D, DATE_RANGE_PRESETS as E, DEFAULT_COMPARISON_LABEL as F, type GraphWidgetData as G, DEFAULT_CURRENCY as H, DEFAULT_DETAIL_PAGE_SIZE as I, DEFAULT_EMPTY_TEXT as J, type KpiWidgetData as K, type Locale as L, DEFAULT_MAX_LAYOUT_BYTES as M, type NiceDomain as N, type OptionValues as O, type PageItem as P, DEFAULT_PAGE_KEY as Q, type ResolvedTableControls as R, type StoreScope as S, type TableWidgetData as T, DEFAULT_PAGE_ROWS as U, DETAIL_MODES as V, type WidgetSize as W, type DateRangeOption as X, type DateRangePreset as Y, type DeltaDirection as Z, type DeltaSentiment as _, type WidgetFill as a, WIDGET_SIZES as a$, type DetailColumn as a0, type DetailMode as a1, type DetailPage as a2, type DetailProvider as a3, type DetailProviders as a4, EMPTY_LAYOUT as a5, type EmptyWidget as a6, type EncodingOptions as a7, type EnforceLocksOptions as a8, type Err as a9, type OptionContext as aA, type OptionValue as aB, type PageOptions as aC, type PageRoom as aD, type PlacedRow as aE, type ProviderOptions as aF, type ResolvedDetailOptions as aG, type ResolvedWidget as aH, type ResolvedWidgetLock as aI, type RetryOptions as aJ, type SaveOptions as aK, type SavedLayout as aL, type SortDirection as aM, type SortOption as aN, type StorageAdapter as aO, type StorageLogEvent as aP, type StoreErrorCode as aQ, type StoreResult as aR, type StoredValue as aS, type TableCell as aT, type TableColumn as aU, type TextOption as aV, VALUE_FORMATS as aW, type ValueFormat as aX, WIDGET_FILLS as aY, WIDGET_KINDS as aZ, WIDGET_OPTION_TYPES as a_, type ErrorWidget as aa, type FormatOptions as ab, type GraphPoint as ac, type GraphSeries as ad, type GridItem as ae, type KpiDelta as af, type KpiDeltaOptions as ag, LAYOUT_ENVELOPE_VERSION as ah, type LayoutItem as ai, type LayoutPage as aj, type LayoutPersistenceOptions as ak, type LoadedLayout as al, type LoadingWidget as am, MAX_DETAIL_PAGE_SIZE as an, MAX_GRAPH_SERIES as ao, MAX_PAGE_ROWS as ap, MAX_PAGE_TITLE_LENGTH as aq, MAX_PARSED_PAGES as ar, MAX_TEXT_OPTION_LENGTH as as, MAX_WIDGET_OPTIONS as at, MAX_WIDGET_WIDTH as au, MIN_WIDGET_WIDTH as av, type NumberOption as aw, OPTION_KEY_PATTERN as ax, type Ok as ay, type OkWidget as az, type WidgetDefinition as b, normalizeLayout as b$, WIDTH_COLUMNS as b0, type WidgetCache as b1, type WidgetDataOf as b2, type WidgetDetailOptions as b3, type WidgetEmptyState as b4, type WidgetLock as b5, type WidgetOption as b6, type WidgetProvider as b7, type WidgetStatus as b8, type WidgetTableControls as b9, hasPages as bA, hiddenWidgets as bB, hideWidget as bC, isClientApplied as bD, isColumnKeyFor as bE, isHidden as bF, isIsoInterval as bG, isMinimized as bH, isWidgetEmptyState as bI, isWidgetKind as bJ, isWidgetVisibleTo as bK, isWidgetWidth as bL, itemWidth as bM, kpiDelta as bN, labelStride as bO, loadingWidgets as bP, memoryAdapter as bQ, minimizeWidget as bR, movePage as bS, moveWidget as bT, moveWidgetBy as bU, moveWidgetDown as bV, moveWidgetToPage as bW, moveWidgetUp as bX, nextPageKey as bY, niceDomain as bZ, niceStep as b_, addPage as ba, applyClientOptions as bb, assignPages as bc, baseColumnSpan as bd, cacheKeyFor as be, coerceOptionValue as bf, createLayoutPersistence as bg, defaultDetailQuery as bh, defaultOptionValue as bi, defineWidget as bj, deriveDetailData as bk, describeUnknownError as bl, emptyTextFor as bm, emptyWidget as bn, enforceLocks as bo, err as bp, failedWidget as bq, fillColumnSpans as br, fillWidthSpans as bs, fillsHeight as bt, fillsWidth as bu, finalizeWidget as bv, fitCount as bw, formatCount as bx, formatPercentChange as by, formatValue as bz, type DetailProviderOptions as c, ok as c0, optionValuesFor as c1, optionsCacheSuffix as c2, pageLayout as c3, pageList as c4, pageOf as c5, pageRoom as c6, pageWidgets as c7, parseDetailQuery as c8, parseLayout as c9, tableDetailData as cA, toggleHidden as cB, toggleMinimized as cC, usesWidthColumns as cD, utf8Length as cE, validateDetailData as cF, visibleWidgets as cG, widgetsFor as cH, widthForSize as cI, withEncoding as cJ, withFallback as cK, withLogging as cL, withPageLayout as cM, withPrefix as cN, withReadCache as cO, withRetry as cP, parseSortValue as ca, percentChange as cb, placeRows as cc, pruneLayout as cd, queryRows as ce, readOnly as cf, removePage as cg, renamePage as ch, resolveDateRange as ci, resolveDetailOptions as cj, resolveOptionValues as ck, resolvePageKey as cl, resolvePayload as cm, resolveTableControls as cn, resolveWidget as co, resolveWidgetLock as cp, resolveWidgetUnapplied as cq, resolveWidgets as cr, restoreWidget as cs, sameOptionValues as ct, serializeDetailQuery as cu, serializeLayout as cv, shareOf as cw, showWidget as cx, sortDefinitions as cy, sortFromOptions as cz, type DetailData as d, type DetailQuery as e, type DashboardLayout as f, type GaugeWidgetData as g, type DetailSort as h, type TextWidgetData as i, type WidgetData as j, type LayoutPersistence as k, type NormalizeOptions as l, type ResolveOptions as m, type WidgetContext as n, type WidgetProviders as o, type Result as p, type WidgetKind as q, type WidgetPayload as r, type AddPageOptions as s, type AlertListItem as t, type BarListItem as u, type BooleanOption as v, type ChoiceOption as w, type ColorOption as x, type ColumnsOption as y, type ConflictPolicy as z };
+export { type DateRangeOption as $, type AlertListWidgetData as A, type BarListWidgetData as B, type CachedPayload as C, type DashboardWidget as D, type ColorOption as E, type ColumnsOption as F, type GraphWidgetData as G, type ConflictPolicy as H, type ConvertViewOptions as I, DATE_RANGE_PRESETS as J, type KpiWidgetData as K, type Locale as L, DEFAULT_COMPARISON_LABEL as M, type NiceDomain as N, type OptionValues as O, type PageItem as P, DEFAULT_CURRENCY as Q, type ResolvedTableControls as R, type StoreScope as S, type TableWidgetData as T, DEFAULT_DETAIL_PAGE_SIZE as U, DEFAULT_EMPTY_TEXT as V, type WidgetSize as W, DEFAULT_MAX_LAYOUT_BYTES as X, DEFAULT_PAGE_KEY as Y, DEFAULT_PAGE_ROWS as Z, DETAIL_MODES as _, type WidgetFill as a, type StoreResult as a$, type DateRangePreset as a0, type DeltaDirection as a1, type DeltaSentiment as a2, type DetailCell as a3, type DetailColumn as a4, type DetailMode as a5, type DetailPage as a6, type DetailProvider as a7, type DetailProviders as a8, EMPTY_LAYOUT as a9, MAX_WIDGET_TITLE_LENGTH as aA, MAX_WIDGET_VIEWS as aB, MAX_WIDGET_WIDTH as aC, MIN_WIDGET_WIDTH as aD, type NormalizeSettingsOptions as aE, type NumberOption as aF, OPTION_KEY_PATTERN as aG, type Ok as aH, type OkWidget as aI, type OptionContext as aJ, type OptionValue as aK, type PageOptions as aL, type PageRoom as aM, type PlacedRow as aN, type ProviderOptions as aO, type ResolvedDetailOptions as aP, type ResolvedWidget as aQ, type ResolvedWidgetLock as aR, type RetryOptions as aS, type SaveOptions as aT, type SavedLayout as aU, type SettingsItem as aV, type SortDirection as aW, type SortOption as aX, type StorageAdapter as aY, type StorageLogEvent as aZ, type StoreErrorCode as a_, type EmptyWidget as aa, type EncodingOptions as ab, type EnforceLocksOptions as ac, type Err as ad, type ErrorWidget as ae, type FormatOptions as af, type GraphPoint as ag, type GraphSeries as ah, type GridItem as ai, type KpiDelta as aj, type KpiDeltaOptions as ak, LAYOUT_ENVELOPE_VERSION as al, type LayoutItem as am, type LayoutPage as an, type LayoutPersistenceOptions as ao, type LayoutSettings as ap, type LoadedLayout as aq, type LoadingWidget as ar, MAX_DETAIL_PAGE_SIZE as as, MAX_GRAPH_SERIES as at, MAX_PAGE_ROWS as au, MAX_PAGE_TITLE_LENGTH as av, MAX_PARSED_PAGES as aw, MAX_PARSED_SETTINGS as ax, MAX_TEXT_OPTION_LENGTH as ay, MAX_WIDGET_OPTIONS as az, type WidgetDefinition as b, isFlexible as b$, type StoredValue as b0, type TableCell as b1, type TableColumn as b2, type TextOption as b3, VALUE_FORMATS as b4, VIEW_CONVERSIONS as b5, type ValueFormat as b6, type ViewConversion as b7, type ViewsItem as b8, WIDGET_FILLS as b9, defaultOptionValue as bA, defineWidget as bB, deriveDetailData as bC, describeUnknownError as bD, effectiveDefinitions as bE, effectiveViewKey as bF, emptyTextFor as bG, emptyWidget as bH, enforceLocks as bI, err as bJ, failedWidget as bK, fillColumnSpans as bL, fillWidthSpans as bM, fillsHeight as bN, fillsWidth as bO, finalizeWidget as bP, findView as bQ, fitCount as bR, formatCount as bS, formatPercentChange as bT, formatValue as bU, hasPages as bV, hasViews as bW, hiddenWidgets as bX, hideWidget as bY, isClientApplied as bZ, isColumnKeyFor as b_, WIDGET_KINDS as ba, WIDGET_OPTION_TYPES as bb, WIDGET_SIZES as bc, WIDTH_COLUMNS as bd, type WidgetCache as be, type WidgetDataOf as bf, type WidgetDetailOptions as bg, type WidgetEmptyState as bh, type WidgetLock as bi, type WidgetOption as bj, type WidgetProvider as bk, type WidgetStatus as bl, type WidgetTableControls as bm, type WidgetView as bn, addPage as bo, applyClientOptions as bp, applySettings as bq, applyView as br, assignPages as bs, baseColumnSpan as bt, cacheKeyFor as bu, clearWidgetSettings as bv, coerceOptionValue as bw, convertView as bx, createLayoutPersistence as by, defaultDetailQuery as bz, type DetailProviderOptions as c, setWidgetSettings as c$, isHidden as c0, isIsoInterval as c1, isMinimized as c2, isOptionsLocked as c3, isTitleInUse as c4, isWidgetEmptyState as c5, isWidgetKind as c6, isWidgetVisibleTo as c7, isWidgetWidth as c8, itemWidth as c9, pageWidgets as cA, parseDetailQuery as cB, parseLayout as cC, parseSettings as cD, parseSortValue as cE, percentChange as cF, placeRows as cG, pruneLayout as cH, queryRows as cI, readOnly as cJ, removePage as cK, renamePage as cL, resolveDateRange as cM, resolveDetailOptions as cN, resolveOptionValues as cO, resolvePageKey as cP, resolvePayload as cQ, resolveTableControls as cR, resolveWidget as cS, resolveWidgetLock as cT, resolveWidgetUnapplied as cU, resolveWidgets as cV, restoreWidget as cW, sameOptionValues as cX, serializeDetailQuery as cY, serializeLayout as cZ, serializeSettings as c_, kindLabel as ca, kpiDelta as cb, labelStride as cc, loadingWidgets as cd, memoryAdapter as ce, minimizeWidget as cf, movePage as cg, moveWidget as ch, moveWidgetBy as ci, moveWidgetDown as cj, moveWidgetToPage as ck, moveWidgetUp as cl, nextPageKey as cm, niceDomain as cn, niceStep as co, normalizeLayout as cp, normalizeSettings as cq, normalizeTitle as cr, ok as cs, optionValuesFor as ct, optionValuesFromLayout as cu, optionsCacheSuffix as cv, pageLayout as cw, pageList as cx, pageOf as cy, pageRoom as cz, type DetailData as d, shareOf as d0, showWidget as d1, sortDefinitions as d2, sortFromOptions as d3, tableDetailData as d4, toggleHidden as d5, toggleMinimized as d6, usesWidthColumns as d7, utf8Length as d8, validateDetailData as d9, viewChoices as da, viewKind as db, viewNote as dc, visibleWidgets as dd, widgetOptionValues as de, widgetsFor as df, widthForSize as dg, widthRange as dh, widthShareLabel as di, withEncoding as dj, withFallback as dk, withLogging as dl, withPageLayout as dm, withPrefix as dn, withReadCache as dp, withRetry as dq, type DetailQuery as e, type DashboardLayout as f, type WidgetViewerSettings as g, type WidgetSettingsPatch as h, type GaugeWidgetData as i, type DetailSort as j, type TextWidgetData as k, type WidgetData as l, type LayoutPersistence as m, type NormalizeOptions as n, type ResolveOptions as o, type WidgetContext as p, type WidgetProviders as q, type Result as r, type WidgetKind as s, type WidgetPayload as t, type AddPageOptions as u, type AlertListItem as v, BASE_VIEW_KEY as w, type BarListItem as x, type BooleanOption as y, type ChoiceOption as z };

package/dist/styles.css

@@ -935,3 +935,149 @@
     display: inline-flex;
   }
 }
+
+/* Options dialog --------------------------------------------------------- */
+
+:where(.dwt-options-dialog) {
+  margin: auto;
+  box-sizing: border-box;
+  width: min(520px, 100vw - 32px);
+  max-height: calc(100vh - 32px);
+  padding: 0;
+  overflow: auto;
+  color: var(--dwt-text);
+  background: var(--dwt-surface);
+  border: 1px solid var(--dwt-border);
+  border-radius: var(--dwt-radius, 8px);
+  font-family: var(--dwt-font);
+}
+
+:where(.dwt-options-dialog)::backdrop {
+  background: rgba(0, 0, 0, 0.5);
+}
+
+:where(.dwt-options) {
+  display: flex;
+  flex-direction: column;
+  gap: 14px;
+  padding: 20px;
+}
+
+:where(.dwt-options-heading) {
+  margin: 0;
+  font-size: 1.125rem;
+}
+
+:where(.dwt-options-field) {
+  display: flex;
+  flex-direction: column;
+  gap: 4px;
+  font-size: 0.875rem;
+}
+
+:where(.dwt-options-field label, .dwt-options-group legend) {
+  color: var(--dwt-text-secondary);
+}
+
+:where(.dwt-options-field input, .dwt-options-field select) {
+  box-sizing: border-box;
+  max-width: 100%;
+  min-height: 32px;
+  padding: 4px 8px;
+  color: var(--dwt-text);
+  background: var(--dwt-surface);
+  border: 1px solid var(--dwt-border);
+  border-radius: 6px;
+  font: inherit;
+}
+
+:where(.dwt-options-field input[type='color']) {
+  width: 56px;
+  padding: 2px;
+}
+
+:where(.dwt-options-pair) {
+  display: flex;
+  flex-wrap: wrap;
+  gap: 8px;
+}
+
+:where(.dwt-options-check) {
+  display: flex;
+  align-items: center;
+  gap: 8px;
+  font-size: 0.875rem;
+}
+
+:where(.dwt-options-group, .dwt-options-columns) {
+  display: flex;
+  flex-direction: column;
+  gap: 12px;
+  margin: 0;
+  padding: 12px;
+  border: 1px solid var(--dwt-border);
+  border-radius: 6px;
+}
+
+:where(.dwt-options-columns) {
+  padding: 8px 12px;
+  font-size: 0.875rem;
+}
+
+:where(.dwt-options-columns ul) {
+  margin: 0;
+  padding: 0;
+  list-style: none;
+}
+
+:where(.dwt-options-columns li) {
+  display: flex;
+  align-items: center;
+  justify-content: space-between;
+  gap: 8px;
+  min-height: 32px;
+}
+
+:where(.dwt-options-columns label) {
+  display: flex;
+  align-items: center;
+  gap: 8px;
+}
+
+:where(.dwt-options-move) {
+  display: inline-flex;
+  gap: 4px;
+}
+
+:where(.dwt-options-error) {
+  margin: 0;
+  color: var(--dwt-bad);
+  font-size: 0.8125rem;
+}
+
+:where(.dwt-options-actions) {
+  display: flex;
+  flex-wrap: wrap;
+  align-items: center;
+  gap: 8px;
+}
+
+:where(.dwt-options-actions button:disabled) {
+  opacity: 0.5;
+  cursor: default;
+}
+
+@media (max-width: 640px) {
+  :where(.dwt-options-dialog) {
+    width: 100vw;
+    max-width: 100vw;
+    max-height: 100vh;
+    border-radius: 0;
+  }
+}
+
+:where(.dwt-button-primary) {
+  color: var(--dwt-surface);
+  background: var(--dwt-link);
+  border-color: transparent;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@richardmcquiston01/dashboard-widgets-toolkit",
-  "version": "0.13.0",
+  "version": "0.15.0",
   "description": "Framework-agnostic dashboard widget toolkit: typed widget definitions and data payloads (KPI, gauge, table, bar list, alert list, chart), user layout (order, hide, minimise), and React renderers. Bring your own data providers.",
   "keywords": [
     "dashboard",