@richardmcquiston01/dashboard-widgets-toolkit 0.15.0 → 0.17.0

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

@@ -431,6 +431,14 @@ interface ProviderOptions {
      * and check them again on the server.
      */
     readonly options: OptionValues;
+    /**
+     * The view being loaded: `base` (the widget's own kind) unless the viewer
+     * chose a view the provider supplies (a `views` entry without `convert`), in
+     * which case it is that view's key and the payload must be of that view's
+     * kind. Converted views never reach the provider: they are built from the
+     * `base` payload.
+     */
+    readonly view: string;
 }
 /**
  * Loads one widget's payload. May be sync or async; may throw. The third
@@ -450,6 +458,11 @@ interface OkWidget {
     readonly stale?: boolean;
     /** The widget's resolved option values; present when it declares options. */
     readonly options?: OptionValues;
+    /**
+     * The view this data was loaded for (`base` or a provider-supplied view's
+     * key); present when the widget declares `views`.
+     */
+    readonly view?: string;
 }
 interface EmptyWidget {
     readonly definition: WidgetDefinition;
@@ -500,6 +513,13 @@ interface ResolveOptions extends OptionContext {
      * and the option's default is used.
      */
     readonly optionValues?: Readonly<Record<string, Readonly<Record<string, unknown>> | undefined>>;
+    /**
+     * The view each widget shows, by widget key. Only views the provider
+     * supplies matter here (the provider is asked for that view); converted
+     * views are applied later from the base payload. An empty string means no
+     * choice (the widget's `defaultView`).
+     */
+    readonly viewValues?: Readonly<Record<string, string | undefined>>;
     /**
      * Validate each provider's payload with `validateWidgetData` (and check
      * its kind matches the definition). Default true; turn off only for
@@ -668,7 +688,7 @@ interface DetailQuery {
     readonly pageSize: number;
 }
 /** What a detail provider receives beyond the usual arguments. */
-interface DetailProviderOptions extends ProviderOptions {
+interface DetailProviderOptions extends Omit<ProviderOptions, 'view'> {
     readonly query: DetailQuery;
 }
 /**
@@ -795,8 +815,14 @@ interface WidgetView {
     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;
+    /**
+     * Builds this view from the widget's payload. Leave it out and the provider
+     * supplies the view instead: it is called with `options.view` set to this
+     * view's key and returns a payload of `kind`. That costs one load per view
+     * (cached apart), and is the way to show data a conversion can't build, such
+     * as a trend behind a KPI.
+     */
+    readonly convert?: ViewConversion;
 }
 /** What these functions need from a definition. */
 type ViewsItem = Pick<WidgetDefinition, 'key' | 'kind'> & Partial<Pick<WidgetDefinition, 'views' | 'defaultView' | 'baseViewLabel'>>;
@@ -812,6 +838,8 @@ declare function viewChoices(item: ViewsItem): readonly {
     label: string;
     kind: WidgetKind;
 }[];
+/** Whether the provider supplies this view's payload (it has no `convert`). */
+declare function isProviderView(view: Pick<WidgetView, 'convert'>): boolean;
 /**
  * The view in effect: the viewer's pick when the definition declares it,
  * else `defaultView`, else the base. Always a valid key.
@@ -819,6 +847,14 @@ declare function viewChoices(item: ViewsItem): readonly {
 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;
+/**
+ * The view the provider is asked for under the viewer's choice: the chosen
+ * view when the provider supplies it, else `base` (converted views are built
+ * from the base payload, so switching among them never reloads).
+ */
+declare function loadViewKey(item: ViewsItem, chosen: string | undefined): string;
+/** The kind of payload the provider returns for `loadViewKey`. */
+declare function loadViewKind(item: ViewsItem, chosen: string | undefined): WidgetKind;
 /** Options for `convertView`. */
 interface ConvertViewOptions {
     /** Locale for numbers a conversion has to format (graph to table). */
@@ -837,10 +873,13 @@ declare function convertView(widgetKey: string, view: Pick<WidgetView, 'key' | '
  */
 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.
+ * The widget as the chosen view shows it. A converted view gets the payload
+ * converted; a view the provider supplies already holds its own payload. The
+ * definition's `kind` becomes the view's kind, so renderers work unchanged. A
+ * failed conversion becomes an `error` widget naming the fix, and data that
+ * was loaded for a different view (a switch is still loading) shows as
+ * `loading` rather than in the wrong shape. A widget that isn't `ok`, or whose
+ * view is the base, comes back as is.
  */
 declare function applyView<W extends DashboardWidget>(widget: W, chosen: string | undefined, options?: ConvertViewOptions): DashboardWidget;
 
@@ -931,6 +970,11 @@ interface WidgetDefinition {
     readonly defaultView?: string;
     /** What the base view is called in the View field. Default: its kind's name. */
     readonly baseViewLabel?: string;
+    /**
+     * Set on a clone (see `clones.ts`): the key of the widget it copies. Its
+     * data comes from that widget's provider. Authors never set it.
+     */
+    readonly sourceKey?: string;
 }
 /** What a viewer may not do to a locked widget. */
 interface WidgetLock {
@@ -942,6 +986,8 @@ interface WidgetLock {
     readonly minimize?: boolean;
     /** Can't be given a title, width or option values of the viewer's own. */
     readonly options?: boolean;
+    /** Can't be duplicated into a clone. */
+    readonly clone?: boolean;
 }
 /** `WidgetLock` with every default filled in. */
 type ResolvedWidgetLock = Required<WidgetLock>;
@@ -961,70 +1007,63 @@ declare function sortDefinitions<D extends WidgetDefinition>(definitions: readon
 /** Whether a widget is active and visible to someone with these roles. */
 declare function isWidgetVisibleTo(definition: WidgetDefinition, roles: readonly string[] | undefined): boolean;
 
-/** The parts of a widget definition that decide its place in a grid. */
-interface GridItem {
-    readonly key: string;
-    readonly defaultSize?: WidgetSize;
-    readonly fill?: WidgetFill;
-    readonly width?: number;
-}
-/** Columns in a grid that uses widget `width`. */
-declare const WIDTH_COLUMNS = 12;
-/** Smallest and largest `width`, in twelfths of a row. */
-declare const MIN_WIDGET_WIDTH = 2;
-declare const MAX_WIDGET_WIDTH = 12;
-/** Whether `value` is a valid widget `width`: an integer from 2 to 12. */
-declare function isWidgetWidth(value: unknown): value is number;
-/** The width (in twelfths) a `defaultSize` stands for. Default `medium`. */
-declare function widthForSize(size: WidgetSize | undefined): number;
-/** The 12-column width of an item: its `width`, else from its size. */
-declare function itemWidth(item: GridItem): number;
-/** Whether a grid of `items` should use 12 columns (any item sets `width`). */
-declare function usesWidthColumns(items: readonly GridItem[]): boolean;
-/** Whether the widget should take the columns left over in its row. */
-declare function fillsWidth(fill: WidgetFill | undefined): boolean;
-/** Whether the widget should stretch to the height of its row. */
-declare function fillsHeight(fill: WidgetFill | undefined): boolean;
 /**
- * Columns a size takes in a grid of `columns` tracks: `large` spans
- * `largeSpan` (default 2), `full` spans every column, anything else one.
+ * Clones: copies of a widget a viewer made to keep it twice with different
+ * settings (another view, width or option values). A clone is stored as
+ * `{ key, from }` in `layout.clones`, its settings under its own key in
+ * `layout.settings`, and it shares the original's provider. Pure functions,
+ * no I/O.
  */
-declare function baseColumnSpan(size: WidgetSize | undefined, columns: number, largeSpan?: number): number;
+
+/** A widget the viewer made from another. */
+interface WidgetClone {
+    /** Unique across definitions and clones: `from#1`, `from#2`, ... */
+    readonly key: string;
+    /** The original's key. Always an original, never another clone. */
+    readonly from: string;
+}
 /**
- * Places `items` in a grid of `columns` tracks the way a sparse grid
- * auto-places them (left to right, wrapping to a new row when an item does
- * not fit), then gives the columns left over in each row to the items that
- * `fill` their width, shared evenly (earlier items get the remainder).
- *
- * Returns the column span for each width-filling item, keyed by `key`. Items
- * that do not fill width keep their normal size and are not in the map.
+ * Most clones `parseLayout` keeps: a safety ceiling against malformed or
+ * hostile JSON, not a product limit (a page's capacity is the real limit).
  */
-declare function fillColumnSpans(items: readonly GridItem[], columns: number, largeSpan?: number): Map<string, number>;
+declare const MAX_PARSED_CLONES = 500;
+/** What these functions need from a definition. */
+type CloneItem = Pick<WidgetDefinition, 'key'> & Partial<Pick<WidgetDefinition, 'title' | 'locked' | 'sourceKey'>>;
+/** Options for the clone functions. */
+interface CloneOptions {
+    /** Keep clones that a widget's `locked.clone` forbids (an administrator). */
+    readonly overrideLocks?: boolean;
+}
 /**
- * Like `fillColumnSpans` for a 12-column grid: each item starts at its
- * `width` (see `itemWidth`) and width-fillers share the leftover twelfths.
+ * Reads the `clones` field of a saved layout. Anything malformed is dropped
+ * (wrong types, empty or repeated keys, a clone of itself). Returns undefined
+ * when nothing usable is left.
  */
-declare function fillWidthSpans(items: readonly GridItem[]): Map<string, number>;
-/** One row of a placed grid: the widgets in it and their final column spans. */
-interface PlacedRow {
-    readonly keys: readonly string[];
-    /** Column spans, in `keys` order, after width-fillers took the leftovers. */
-    readonly spans: readonly number[];
-}
+declare function parseClones(raw: unknown): readonly WidgetClone[] | undefined;
+/** The JSON-ready form of `layout.clones`; undefined when there are none. */
+declare function serializeClones(clones: readonly WidgetClone[] | undefined): WidgetClone[] | undefined;
+/** The number in a clone key (`orders#3` is 3), or undefined. */
+declare function cloneNumber(key: string): number | undefined;
 /**
- * The rows `items` occupy in a 12-column grid, exactly as `fillWidthSpans`
- * places them: left to right, a widget that doesn't fit in the rest of a row
- * starts the next row whole (a widget is never split), and width-fillers then
- * grow into the leftover columns. Growth never changes how many rows there
- * are.
+ * The clones that can exist for these definitions: the original is a real
+ * widget (not itself a clone), the key doesn't shadow another widget, and the
+ * original's `locked.clone` allows it. Returns the same array when nothing is
+ * dropped. Clones already present as definitions (see `withClones`) count as
+ * valid, so the function is idempotent.
  */
-declare function placeRows(items: readonly GridItem[]): readonly PlacedRow[];
+declare function cleanClones<D extends CloneItem>(definitions: readonly D[], clones: readonly WidgetClone[] | undefined, options?: CloneOptions): readonly WidgetClone[] | undefined;
 /**
- * How many of `items`, in order, fit in `maxRows` rows of a 12-column grid.
- * Placement is left to right, so this is the length of the longest prefix
- * whose rows number at most `maxRows`.
+ * The definitions with each clone added right after its original. A clone's
+ * definition copies the original's, with its own key, `sourceKey` set to the
+ * original, the title "Original (#n)" and no locks (a clone is the viewer's
+ * to move, hide and delete). Settings still apply on top (`effectiveDefinitions`).
+ * Pass the result to `useWidgets` so clones load, and to the settings and
+ * layout functions. Idempotent; returns the same array when there are no
+ * clones to add.
  */
-declare function fitCount(items: readonly GridItem[], maxRows: number): number;
+declare function withClones<D extends CloneItem>(definitions: readonly D[], layout: {
+    readonly clones?: readonly WidgetClone[];
+}, options?: CloneOptions): readonly D[];
 
 /**
  * A viewer's own choices for a widget: a title, a width and values for the
@@ -1110,6 +1149,18 @@ declare function optionValuesFromLayout(definitions: readonly Pick<SettingsItem,
 }, options?: {
     readonly overrideLocks?: boolean;
 }): Record<string, Readonly<Record<string, OptionValue>>>;
+/**
+ * What to pass `useWidgets({ viewValues })` so views the provider supplies
+ * follow the layout: for every widget that declares one, the viewer's chosen
+ * view key, or an empty string for no choice (its `defaultView`). Listing
+ * every such widget means a cleared choice reaches the loader too. Widgets
+ * with only converted views are left out: they need no provider call.
+ */
+declare function viewValuesFromLayout(definitions: readonly Pick<SettingsItem, 'key' | 'views' | 'locked'>[], layout: {
+    readonly settings?: LayoutSettings;
+}, options?: {
+    readonly overrideLocks?: boolean;
+}): Record<string, string>;
 /** Fields `setWidgetSettings` can change; `undefined` clears one. */
 interface WidgetSettingsPatch {
     readonly title?: string | undefined;
@@ -1192,6 +1243,12 @@ interface DashboardLayout {
      * widget key. See `settings.ts`. Absent when they chose nothing.
      */
     readonly settings?: LayoutSettings;
+    /**
+     * Widgets the viewer made from others, as `{ key, from }`. Their settings
+     * live in `settings` under their own key. See `clones.ts`. Absent when
+     * there are none.
+     */
+    readonly clones?: readonly WidgetClone[];
 }
 /** One page of a paged layout: the same lists as a layout, plus a name. */
 interface LayoutPage {
@@ -1290,6 +1347,71 @@ interface EnforceLocksOptions {
  */
 declare function enforceLocks<T extends LayoutItem>(definitions: readonly T[], layout: DashboardLayout, options?: EnforceLocksOptions): DashboardLayout;
 
+/** The parts of a widget definition that decide its place in a grid. */
+interface GridItem {
+    readonly key: string;
+    readonly defaultSize?: WidgetSize;
+    readonly fill?: WidgetFill;
+    readonly width?: number;
+}
+/** Columns in a grid that uses widget `width`. */
+declare const WIDTH_COLUMNS = 12;
+/** Smallest and largest `width`, in twelfths of a row. */
+declare const MIN_WIDGET_WIDTH = 2;
+declare const MAX_WIDGET_WIDTH = 12;
+/** Whether `value` is a valid widget `width`: an integer from 2 to 12. */
+declare function isWidgetWidth(value: unknown): value is number;
+/** The width (in twelfths) a `defaultSize` stands for. Default `medium`. */
+declare function widthForSize(size: WidgetSize | undefined): number;
+/** The 12-column width of an item: its `width`, else from its size. */
+declare function itemWidth(item: GridItem): number;
+/** Whether a grid of `items` should use 12 columns (any item sets `width`). */
+declare function usesWidthColumns(items: readonly GridItem[]): boolean;
+/** Whether the widget should take the columns left over in its row. */
+declare function fillsWidth(fill: WidgetFill | undefined): boolean;
+/** Whether the widget should stretch to the height of its row. */
+declare function fillsHeight(fill: WidgetFill | undefined): boolean;
+/**
+ * Columns a size takes in a grid of `columns` tracks: `large` spans
+ * `largeSpan` (default 2), `full` spans every column, anything else one.
+ */
+declare function baseColumnSpan(size: WidgetSize | undefined, columns: number, largeSpan?: number): number;
+/**
+ * Places `items` in a grid of `columns` tracks the way a sparse grid
+ * auto-places them (left to right, wrapping to a new row when an item does
+ * not fit), then gives the columns left over in each row to the items that
+ * `fill` their width, shared evenly (earlier items get the remainder).
+ *
+ * Returns the column span for each width-filling item, keyed by `key`. Items
+ * that do not fill width keep their normal size and are not in the map.
+ */
+declare function fillColumnSpans(items: readonly GridItem[], columns: number, largeSpan?: number): Map<string, number>;
+/**
+ * Like `fillColumnSpans` for a 12-column grid: each item starts at its
+ * `width` (see `itemWidth`) and width-fillers share the leftover twelfths.
+ */
+declare function fillWidthSpans(items: readonly GridItem[]): Map<string, number>;
+/** One row of a placed grid: the widgets in it and their final column spans. */
+interface PlacedRow {
+    readonly keys: readonly string[];
+    /** Column spans, in `keys` order, after width-fillers took the leftovers. */
+    readonly spans: readonly number[];
+}
+/**
+ * The rows `items` occupy in a 12-column grid, exactly as `fillWidthSpans`
+ * places them: left to right, a widget that doesn't fit in the rest of a row
+ * starts the next row whole (a widget is never split), and width-fillers then
+ * grow into the leftover columns. Growth never changes how many rows there
+ * are.
+ */
+declare function placeRows(items: readonly GridItem[]): readonly PlacedRow[];
+/**
+ * How many of `items`, in order, fit in `maxRows` rows of a 12-column grid.
+ * Placement is left to right, so this is the length of the longest prefix
+ * whose rows number at most `maxRows`.
+ */
+declare function fitCount(items: readonly GridItem[], maxRows: number): number;
+
 /**
  * Pages of widgets: a dashboard split into pages, like the home screens of a
  * phone. Each page is a small layout (order, hidden, minimized) with a name
@@ -1591,4 +1713,4 @@ interface LayoutPersistence {
  */
 declare function createLayoutPersistence(adapter: StorageAdapter, options?: LayoutPersistenceOptions): LayoutPersistence;
 
-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 };
+export { DEFAULT_MAX_LAYOUT_BYTES as $, type AlertListWidgetData as A, type BarListWidgetData as B, type CloneOptions as C, type DashboardWidget as D, type BooleanOption as E, type CachedPayload as F, type GraphWidgetData as G, type ChoiceOption as H, type CloneItem as I, type ColorOption as J, type KpiWidgetData as K, type Locale as L, type ColumnsOption as M, type NiceDomain as N, type OptionValues as O, type PageItem as P, type ConflictPolicy as Q, type ResolvedTableControls as R, type StoreScope as S, type TableWidgetData as T, type ConvertViewOptions as U, DATE_RANGE_PRESETS as V, type WidgetSize as W, DEFAULT_COMPARISON_LABEL as X, DEFAULT_CURRENCY as Y, DEFAULT_DETAIL_PAGE_SIZE as Z, DEFAULT_EMPTY_TEXT as _, type WidgetFill as a, type SortOption as a$, DEFAULT_PAGE_KEY as a0, DEFAULT_PAGE_ROWS as a1, DETAIL_MODES as a2, type DateRangeOption as a3, type DateRangePreset as a4, type DeltaDirection as a5, type DeltaSentiment as a6, type DetailCell as a7, type DetailColumn as a8, type DetailMode as a9, MAX_PARSED_CLONES as aA, MAX_PARSED_PAGES as aB, MAX_PARSED_SETTINGS as aC, MAX_TEXT_OPTION_LENGTH as aD, MAX_WIDGET_OPTIONS as aE, MAX_WIDGET_TITLE_LENGTH as aF, MAX_WIDGET_VIEWS as aG, MAX_WIDGET_WIDTH as aH, MIN_WIDGET_WIDTH as aI, type NormalizeSettingsOptions as aJ, type NumberOption as aK, OPTION_KEY_PATTERN as aL, type Ok as aM, type OkWidget as aN, type OptionContext as aO, type OptionValue as aP, type PageRoom as aQ, type PlacedRow as aR, type ProviderOptions as aS, type ResolvedDetailOptions as aT, type ResolvedWidget as aU, type ResolvedWidgetLock as aV, type RetryOptions as aW, type SaveOptions as aX, type SavedLayout as aY, type SettingsItem as aZ, type SortDirection as a_, type DetailPage as aa, type DetailProvider as ab, type DetailProviders as ac, EMPTY_LAYOUT as ad, type EmptyWidget as ae, type EncodingOptions as af, type EnforceLocksOptions as ag, type Err as ah, type ErrorWidget as ai, type FormatOptions as aj, type GraphPoint as ak, type GraphSeries as al, type GridItem as am, type KpiDelta as an, type KpiDeltaOptions as ao, LAYOUT_ENVELOPE_VERSION as ap, type LayoutItem as aq, type LayoutPage as ar, type LayoutPersistenceOptions as as, type LayoutSettings as at, type LoadedLayout as au, type LoadingWidget as av, MAX_DETAIL_PAGE_SIZE as aw, MAX_GRAPH_SERIES as ax, MAX_PAGE_ROWS as ay, MAX_PAGE_TITLE_LENGTH as az, type WidgetDefinition as b, hasPages as b$, type StorageAdapter as b0, type StorageLogEvent as b1, type StoreErrorCode as b2, type StoreResult as b3, type StoredValue as b4, type TableCell as b5, type TableColumn as b6, type TextOption as b7, VALUE_FORMATS as b8, VIEW_CONVERSIONS as b9, clearWidgetSettings as bA, cloneNumber as bB, coerceOptionValue as bC, convertView as bD, createLayoutPersistence as bE, defaultDetailQuery as bF, defaultOptionValue as bG, defineWidget as bH, deriveDetailData as bI, describeUnknownError as bJ, effectiveDefinitions as bK, effectiveViewKey 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, findView as bW, fitCount as bX, formatCount as bY, formatPercentChange as bZ, formatValue as b_, type ValueFormat as ba, type ViewConversion as bb, type ViewsItem as bc, WIDGET_FILLS as bd, WIDGET_KINDS as be, WIDGET_OPTION_TYPES as bf, WIDGET_SIZES as bg, WIDTH_COLUMNS as bh, type WidgetCache as bi, type WidgetDataOf as bj, type WidgetDetailOptions as bk, type WidgetEmptyState as bl, type WidgetLock as bm, type WidgetOption as bn, type WidgetProvider as bo, type WidgetStatus as bp, type WidgetTableControls as bq, type WidgetView as br, addPage as bs, applyClientOptions as bt, applySettings as bu, applyView as bv, assignPages as bw, baseColumnSpan as bx, cacheKeyFor as by, cleanClones as bz, type DetailProviderOptions as c, resolveTableControls as c$, hasViews as c0, hiddenWidgets as c1, hideWidget as c2, isClientApplied as c3, isColumnKeyFor as c4, isFlexible as c5, isHidden as c6, isIsoInterval as c7, isMinimized as c8, isOptionsLocked as c9, normalizeTitle as cA, ok as cB, optionValuesFor as cC, optionValuesFromLayout as cD, optionsCacheSuffix as cE, pageLayout as cF, pageList as cG, pageOf as cH, pageRoom as cI, pageWidgets as cJ, parseClones as cK, parseDetailQuery as cL, parseLayout as cM, parseSettings as cN, parseSortValue as cO, percentChange as cP, placeRows as cQ, pruneLayout as cR, queryRows as cS, readOnly as cT, removePage as cU, renamePage as cV, resolveDateRange as cW, resolveDetailOptions as cX, resolveOptionValues as cY, resolvePageKey as cZ, resolvePayload as c_, isProviderView as ca, isTitleInUse as cb, isWidgetEmptyState as cc, isWidgetKind as cd, isWidgetVisibleTo as ce, isWidgetWidth as cf, itemWidth as cg, kindLabel as ch, kpiDelta as ci, labelStride as cj, loadViewKey as ck, loadViewKind as cl, loadingWidgets as cm, memoryAdapter as cn, minimizeWidget as co, movePage as cp, moveWidget as cq, moveWidgetBy as cr, moveWidgetDown as cs, moveWidgetToPage as ct, moveWidgetUp as cu, nextPageKey as cv, niceDomain as cw, niceStep as cx, normalizeLayout as cy, normalizeSettings as cz, type DetailData as d, resolveWidget as d0, resolveWidgetLock as d1, resolveWidgetUnapplied as d2, resolveWidgets as d3, restoreWidget as d4, sameOptionValues as d5, serializeClones as d6, serializeDetailQuery as d7, serializeLayout as d8, serializeSettings as d9, withPageLayout as dA, withPrefix as dB, withReadCache as dC, withRetry as dD, setWidgetSettings as da, shareOf as db, showWidget as dc, sortDefinitions as dd, sortFromOptions as de, tableDetailData as df, toggleHidden as dg, toggleMinimized as dh, usesWidthColumns as di, utf8Length as dj, validateDetailData as dk, viewChoices as dl, viewKind as dm, viewNote as dn, viewValuesFromLayout as dp, visibleWidgets as dq, widgetOptionValues as dr, widgetsFor as ds, widthForSize as dt, widthRange as du, widthShareLabel as dv, withClones as dw, withEncoding as dx, withFallback as dy, withLogging as dz, 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 PageOptions as r, type Result as s, type WidgetClone as t, type WidgetKind as u, type WidgetPayload as v, type AddPageOptions as w, type AlertListItem as x, BASE_VIEW_KEY as y, type BarListItem as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@richardmcquiston01/dashboard-widgets-toolkit",
-  "version": "0.15.0",
+  "version": "0.17.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",