react-semaphor 0.1.568 → 0.1.570
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +0 -7
- package/dist/analytics-protocol/index.js +434 -454
- package/dist/appearance/index.js +6 -3
- package/dist/appearance-runtime/index.js +1 -1
- package/dist/assistant-context/index.js +1 -1
- package/dist/brand-studio/index.js +572 -436
- package/dist/briefings/index.js +4 -4
- package/dist/chunks/appearance-context-BwBp25ZG.js +162 -0
- package/dist/chunks/appearance-runtime-provider-BRHYELkC.js +80 -0
- package/dist/chunks/assistant-chat-B-Ddyy8b.js +5940 -0
- package/dist/chunks/{bookmark-impact-CJ-65omV.js → bookmark-impact-DCYD-6Fr.js} +2 -2
- package/dist/chunks/{bookmark-state-Du3s13_V.js → bookmark-state-CflS88gq.js} +251 -250
- package/dist/chunks/brand-B4BdpAB_.js +54 -0
- package/dist/chunks/{card-filter-builder-BBuB99GZ.js → card-filter-builder-0VvKmRst.js} +992 -991
- package/dist/chunks/{comparison-window-caption-CMLb3mut.js → comparison-window-caption-PtcDWvkN.js} +252 -253
- package/dist/chunks/{dashboard-YnWZC4dK.js → dashboard-DxGIr1vZ.js} +1 -1
- package/dist/chunks/{dashboard-briefing-launcher-BF89TU2h.js → dashboard-briefing-launcher-B-quOOOQ.js} +253 -253
- package/dist/chunks/{dashboard-controls-atHc1EjP.js → dashboard-controls-Caodx80b.js} +288 -285
- package/dist/chunks/dashboard-json-Ct-AGDHF.js +66 -0
- package/dist/chunks/{dates-CKO05ino.js → dates-B9mL8BHE.js} +16 -15
- package/dist/chunks/edit-Bpdh_P_a.js +226 -0
- package/dist/chunks/{edit-dashboard-visual-DdmTfn-J.js → edit-dashboard-visual-DeDTuYB5.js} +2257 -2270
- package/dist/chunks/{filter-reach-copy-jZGzK_IH.js → filter-reach-copy-BSY33ro5.js} +1440 -1301
- package/dist/chunks/filter-value-text-DvvSNlho.js +146 -0
- package/dist/chunks/index-BVKzKl5d.js +90 -0
- package/dist/chunks/{index-RNaTnE3m.js → index-CV_Kzou0.js} +233 -223
- package/dist/chunks/{index-CPNZW0mu.js → index-y3HUzRNk.js} +76 -77
- package/dist/chunks/{layout-grid-0hIlqEtk.js → layout-grid-8rR-LPTk.js} +1 -1
- package/dist/chunks/{list-filter-DkgoCeBm.js → list-filter-C1-uTgjR.js} +1 -1
- package/dist/chunks/matrix-analytical-definition-dkS8szLM.js +1253 -0
- package/dist/chunks/matrix-member-presentation-DRa-9e6Q.js +169 -0
- package/dist/chunks/{matrix-operation-contract-Eb6elidS.js → matrix-operation-contract-DCVinw1o.js} +122 -122
- package/dist/chunks/{metric-comparison-ChXUFaZu.js → metric-comparison-n9NsIa-2.js} +175 -128
- package/dist/chunks/paintbrush-aR17Z3C9.js +27 -0
- package/dist/chunks/{palette-4vf2BEEg.js → palette-a5FCZKFI.js} +1 -1
- package/dist/chunks/{_commonjsHelpers-DimLPMtv.js → pickers-DkqmtnTL.js} +352 -290
- package/dist/chunks/pivot-result-contract-expectations-C-HnUKYe.js +55 -0
- package/dist/chunks/{pivot-result-identity-BlbLrqaC.js → pivot-result-identity-B89X5xjb.js} +1 -1
- package/dist/chunks/raw-temporal-value-DdT0s47W.js +159 -0
- package/dist/chunks/{report-preferences-dialog-Mbd-I0wV.js → report-preferences-dialog-Yvhv3WX2.js} +95 -97
- package/dist/chunks/{report-runtime-context-DnA_PiKo.js → report-runtime-context-BhPzLTbS.js} +1 -1
- package/dist/chunks/{resolve-dashboard-input-context-Du0fjN3h.js → resolve-dashboard-input-context-Lkbwycwe.js} +5491 -5683
- package/dist/chunks/resolver-DG_tfEpt.js +156 -0
- package/dist/chunks/{save-D6pHmSSP.js → save-D985VvYp.js} +1 -1
- package/dist/chunks/{saved-dashboard-context-y8N6RvjS.js → saved-dashboard-context-DC_TEd6y.js} +6 -6
- package/dist/chunks/schema-C9NPiIru.js +2568 -0
- package/dist/chunks/{semaphor-ready-indicator-BSEdUq40.js → semaphor-ready-indicator-ByFvqHEO.js} +35916 -36001
- package/dist/chunks/{shelf-drop-preview-context-D7QqPl36.js → shelf-drop-preview-context-CjoVaK6J.js} +64 -66
- package/dist/chunks/{stored-dashboard-d3xQYxBD.js → stored-dashboard-C0hekXiI.js} +332 -333
- package/dist/chunks/{code-editor-DJNOsgJH.js → style-sheet-parts-C7qGZuH1.js} +2402 -2040
- package/dist/chunks/{table-export-sheet--DUKWk6o.js → table-export-sheet-CP8zSOhj.js} +1 -1
- package/dist/chunks/{temporal-input-presentation--2r9BLr0.js → temporal-input-presentation-CqbJjIuu.js} +18 -18
- package/dist/chunks/{token-types-C8JymO8s.js → token-types-iKMplaBL.js} +1 -1
- package/dist/chunks/{upload-Cf3wXZT8.js → upload-CiGNKJ_0.js} +1 -1
- package/dist/chunks/validators-B8fpdinG.js +3651 -0
- package/dist/chunks/{variable-draft-DOX03R4A.js → variable-draft-9-huI1h4.js} +4 -4
- package/dist/dashboard/index.js +2 -2
- package/dist/dashboard-authoring/index.js +1888 -1826
- package/dist/format-utils/index.js +230 -231
- package/dist/index.js +349 -353
- package/dist/layouts/index.js +1 -1
- package/dist/report-runtime-context/index.js +1 -1
- package/dist/style.css +1 -1
- package/dist/surfboard/index.js +2 -2
- package/dist/types/appearance/index.d.ts +1 -0
- package/dist/types/brand-studio/brand-studio-draft.d.ts +7 -0
- package/dist/types/brand-studio/index.d.ts +1 -1
- package/dist/types/components/briefings/briefing-author/run-model.d.ts +1 -2
- package/dist/types/components/providers/appearance-runtime-provider.d.ts +4 -1
- package/dist/types/components/sharing-and-management/hooks/use-resource-management.d.ts +0 -2
- package/dist/types/components/sharing-and-management/utils/types.d.ts +0 -72
- package/dist/types/components/surfboard/filter/types.d.ts +5 -4
- package/dist/types/components/ui-custom/date-range-presets.d.ts +1 -17
- package/dist/types/components/visual/data-table/hooks/use-data-table-logic.d.ts +0 -1
- package/dist/types/components/visual/data-table/types/data-table.d.ts +0 -9
- package/dist/types/components/visual/data-table/utils/pagination-utils.d.ts +0 -19
- package/dist/types/components/visual/shared/utils/table-column-order.d.ts +0 -1
- package/dist/types/index.js +9 -9
- package/dist/types/lib/appearance/aliases.d.ts +42 -0
- package/dist/types/lib/appearance/compiler.d.ts +6 -0
- package/dist/types/lib/appearance/defaults.d.ts +6 -0
- package/dist/types/lib/appearance/index.d.ts +2 -0
- package/dist/types/lib/appearance/normalize-organization.d.ts +17 -0
- package/dist/types/lib/appearance/resolver.d.ts +2 -2
- package/dist/types/lib/appearance/types.d.ts +38 -1
- package/dist/types/lib/charts/types.d.ts +6 -2
- package/dist/types/lib/dashboard/semantic-dataset-references.d.ts +0 -1
- package/dist/types/lib/dashboard-inputs/dashboard-input-values.d.ts +0 -2
- package/dist/types/lib/dashboard-variables/types.d.ts +1 -6
- package/dist/types/lib/download-pdf.d.ts +0 -1
- package/dist/types/lib/hooks/use-dashboard.d.ts +3 -4
- package/dist/types/lib/hooks/use-date-filter.d.ts +3 -3
- package/dist/types/lib/matrix-table/matrix-card-adapter.d.ts +1 -1
- package/dist/types/lib/stores/dashboard-store.d.ts +15 -6
- package/dist/types/lib/stores/editor-store.d.ts +0 -1
- package/dist/types/lib/stores/table-actions.d.ts +0 -1
- package/dist/types/lib/table-formatting/table-formatting-css.d.ts +0 -5
- package/dist/types/lib/types/common-types.d.ts +3 -2
- package/dist/types/lib/types/explorer-types.d.ts +2 -2
- package/dist/types/lib/types/index.d.ts +1 -1
- package/dist/types/lib/types/summary-types.d.ts +0 -5
- package/dist/types/lib/utils/card-definition.d.ts +7 -7
- package/dist/types/shared/analytics-protocol/agent-time-window.d.ts +84 -0
- package/dist/types/shared/analytics-protocol/analytics-base-schemas.d.ts +4 -4
- package/dist/types/shared/analytics-protocol/applied-constraints.d.ts +2 -2
- package/dist/types/shared/analytics-protocol/contracts.d.ts +8 -17
- package/dist/types/shared/analytics-protocol/execution-input-schemas.d.ts +10 -10
- package/dist/types/shared/analytics-protocol/fixtures.d.ts +3 -2
- package/dist/types/shared/analytics-protocol/index.d.ts +2 -4
- package/dist/types/shared/analytics-protocol/matrix-definition-contract.d.ts +72 -72
- package/dist/types/shared/analytics-protocol/relative-date/describe.d.ts +18 -0
- package/dist/types/shared/analytics-protocol/relative-date/index.d.ts +7 -0
- package/dist/types/shared/analytics-protocol/relative-date/limits.d.ts +3 -0
- package/dist/types/shared/analytics-protocol/relative-date/presets.d.ts +11 -0
- package/dist/types/shared/analytics-protocol/relative-date/resolve.d.ts +49 -0
- package/dist/types/shared/analytics-protocol/relative-date/schemas.d.ts +76 -0
- package/dist/types/shared/analytics-protocol/relative-date/traits.d.ts +51 -0
- package/dist/types/shared/analytics-protocol/relative-date/window.d.ts +111 -0
- package/dist/types/shared/analytics-protocol/selection-contract.d.ts +1 -1
- package/dist/types/shared/assistant-protocol/context.d.ts +30 -30
- package/dist/types/shared/dashboard-authoring/changes/card-query-part.d.ts +0 -2
- package/dist/types/shared/dashboard-authoring/changes/dashboard-change.d.ts +344 -1772
- package/dist/types/shared/dashboard-authoring/changes/diagnostics.d.ts +4 -1
- package/dist/types/shared/dashboard-authoring/changes/read-card-query.d.ts +8 -4
- package/dist/types/shared/dashboard-authoring/changes/resolve-dashboard-changes.d.ts +9 -0
- package/dist/types/shared/dashboard-authoring/conditional-formatting/schema.d.ts +104 -104
- package/dist/types/shared/dashboard-authoring/control-execution-contract.d.ts +20 -20
- package/dist/types/shared/dashboard-authoring/dashboard-style/bounds.d.ts +17 -0
- package/dist/types/shared/dashboard-authoring/dashboard-style/brand.d.ts +20 -0
- package/dist/types/shared/dashboard-authoring/dashboard-style/edit-words.d.ts +7 -0
- package/dist/types/shared/dashboard-authoring/dashboard-style/edit.d.ts +19 -0
- package/dist/types/shared/dashboard-authoring/dashboard-style/index.d.ts +15 -0
- package/dist/types/shared/dashboard-authoring/dashboard-style/layers.d.ts +19 -0
- package/dist/types/shared/dashboard-authoring/dashboard-style/legacy.d.ts +21 -0
- package/dist/types/shared/dashboard-authoring/dashboard-style/parse.d.ts +18 -0
- package/dist/types/shared/dashboard-authoring/dashboard-style/pickers.d.ts +12 -0
- package/dist/types/shared/dashboard-authoring/dashboard-style/types.d.ts +122 -0
- package/dist/types/shared/dashboard-authoring/dashboard-style/view.d.ts +10 -0
- package/dist/types/shared/dashboard-authoring/index.d.ts +1 -0
- package/dist/types/shared/dashboard-authoring/operations/operation-types.d.ts +11 -0
- package/dist/types/shared/dashboard-authoring/outline/outline-dashboard.d.ts +23 -0
- package/dist/types/shared/dashboard-authoring/outline/outline-filters.d.ts +10 -2
- package/dist/types/shared/format-utils/filter-detail.d.ts +2 -8
- package/dist/types/shared/format-utils/filter-line.d.ts +2 -2
- package/dist/types/shared/format-utils/matrix-continuation.d.ts +10 -10
- package/dist/types/shared/temporal/index.d.ts +0 -2
- package/dist/types/shared/temporal/temporal-parity-fixtures.d.ts +2 -2
- package/package.json +7 -26
- package/DATA_APP_SDK.md +0 -339
- package/dist/chunks/appearance-context-DEYtWinQ.js +0 -126
- package/dist/chunks/appearance-runtime-provider-B-M8gwlZ.js +0 -81
- package/dist/chunks/assistant-chat-BN5I8KuN.js +0 -8849
- package/dist/chunks/color-CJvdlFM_.js +0 -2162
- package/dist/chunks/dashboard-json-Cxp3inxd.js +0 -68
- package/dist/chunks/filter-value-text-7zhmth1S.js +0 -163
- package/dist/chunks/index-CLIro-EG.js +0 -425
- package/dist/chunks/index-CuHybtft.js +0 -51
- package/dist/chunks/matrix-analytical-definition-C9xB_T84.js +0 -717
- package/dist/chunks/matrix-card-BSUeSXpD.js +0 -42
- package/dist/chunks/matrix-member-presentation-DZNgQpUq.js +0 -105
- package/dist/chunks/operators-B3zZoskU.js +0 -66
- package/dist/chunks/pivot-result-contract-expectations-Ddh1rNz5.js +0 -56
- package/dist/chunks/raw-temporal-value-Bqz8wc7L.js +0 -242
- package/dist/chunks/selection-reducer-OaJ-N5uN.js +0 -46
- package/dist/chunks/source-entity-resolution-DF6GulDn.js +0 -607
- package/dist/chunks/validators-wtjw0aw6.js +0 -3332
- package/dist/data-app-sdk/index.js +0 -1412
- package/dist/data-app-sdk-adapters/index.js +0 -361
- package/dist/data-app-sdk-validation/index.js +0 -1031
- package/dist/types/components/sharing-and-management/utils/group-types.d.ts +0 -105
- package/dist/types/data-app-sdk/adapters.d.ts +0 -35
- package/dist/types/data-app-sdk/builders.d.ts +0 -62
- package/dist/types/data-app-sdk/contracts.d.ts +0 -419
- package/dist/types/data-app-sdk/executor.d.ts +0 -5
- package/dist/types/data-app-sdk/field-catalog-validation.d.ts +0 -29
- package/dist/types/data-app-sdk/hooks.d.ts +0 -11
- package/dist/types/data-app-sdk/index.d.ts +0 -9
- package/dist/types/data-app-sdk/provider.d.ts +0 -8
- package/dist/types/data-app-sdk/relationship-aware-field-policy.d.ts +0 -21
- package/dist/types/data-app-sdk/selection.d.ts +0 -2
- package/dist/types/data-app-sdk/validation.d.ts +0 -58
- package/dist/types/data-app-sdk-adapters.d.ts +0 -2
- package/dist/types/data-app-sdk-validation.d.ts +0 -2
- package/dist/types/data-app-sdk.d.ts +0 -2
- package/dist/types/shared/analytics-protocol/relative-date-filter.d.ts +0 -68
- package/dist/types/shared/analytics-protocol/relative-date-label.d.ts +0 -20
- package/dist/types/shared/analytics-protocol/time-window-schema.d.ts +0 -314
- package/dist/types/shared/analytics-protocol/time-window.d.ts +0 -52
- package/dist/types/shared/temporal/relative-date.d.ts +0 -21
- package/dist/types/shared/temporal/time-window-periods.d.ts +0 -21
- package/src/data-app-sdk/README.md +0 -402
|
@@ -197,16 +197,16 @@ export declare const controlDefinitionExecutionSchema: z.ZodEffects<z.ZodObject<
|
|
|
197
197
|
valueColumn: string;
|
|
198
198
|
labelColumn?: string | undefined;
|
|
199
199
|
};
|
|
200
|
-
scope: "
|
|
200
|
+
scope: "dashboard" | "card";
|
|
201
|
+
initialValueStrategy: "saved_default" | "embed_required" | "builtin" | "schedule_snapshot";
|
|
201
202
|
requiredAtExecution: boolean;
|
|
202
|
-
initialValueStrategy: "saved_default" | "builtin" | "embed_required" | "schedule_snapshot";
|
|
203
203
|
defaultValue?: unknown;
|
|
204
204
|
hidden?: boolean | undefined;
|
|
205
|
-
showLabel?: boolean | undefined;
|
|
206
|
-
toolbarWidth?: number | undefined;
|
|
207
205
|
locked?: boolean | undefined;
|
|
208
206
|
helpText?: string | undefined;
|
|
209
|
-
placement?: "toolbar" | "
|
|
207
|
+
placement?: "toolbar" | "advanced" | "card_header" | undefined;
|
|
208
|
+
showLabel?: boolean | undefined;
|
|
209
|
+
toolbarWidth?: number | undefined;
|
|
210
210
|
}, {
|
|
211
211
|
type: "number" | "boolean" | "date" | "text" | "enum" | "multi_enum" | "field_selector" | "metric_selector" | "aggregation_selector" | "grain_selector";
|
|
212
212
|
id: string;
|
|
@@ -240,16 +240,16 @@ export declare const controlDefinitionExecutionSchema: z.ZodEffects<z.ZodObject<
|
|
|
240
240
|
valueColumn: string;
|
|
241
241
|
labelColumn?: string | undefined;
|
|
242
242
|
};
|
|
243
|
-
scope: "
|
|
243
|
+
scope: "dashboard" | "card";
|
|
244
|
+
initialValueStrategy: "saved_default" | "embed_required" | "builtin" | "schedule_snapshot";
|
|
244
245
|
requiredAtExecution: boolean;
|
|
245
|
-
initialValueStrategy: "saved_default" | "builtin" | "embed_required" | "schedule_snapshot";
|
|
246
246
|
defaultValue?: unknown;
|
|
247
247
|
hidden?: boolean | undefined;
|
|
248
|
-
showLabel?: boolean | undefined;
|
|
249
|
-
toolbarWidth?: number | undefined;
|
|
250
248
|
locked?: boolean | undefined;
|
|
251
249
|
helpText?: string | undefined;
|
|
252
|
-
placement?: "toolbar" | "
|
|
250
|
+
placement?: "toolbar" | "advanced" | "card_header" | undefined;
|
|
251
|
+
showLabel?: boolean | undefined;
|
|
252
|
+
toolbarWidth?: number | undefined;
|
|
253
253
|
}>, {
|
|
254
254
|
type: "number" | "boolean" | "date" | "text" | "enum" | "multi_enum" | "field_selector" | "metric_selector" | "aggregation_selector" | "grain_selector";
|
|
255
255
|
id: string;
|
|
@@ -283,16 +283,16 @@ export declare const controlDefinitionExecutionSchema: z.ZodEffects<z.ZodObject<
|
|
|
283
283
|
valueColumn: string;
|
|
284
284
|
labelColumn?: string | undefined;
|
|
285
285
|
};
|
|
286
|
-
scope: "
|
|
286
|
+
scope: "dashboard" | "card";
|
|
287
|
+
initialValueStrategy: "saved_default" | "embed_required" | "builtin" | "schedule_snapshot";
|
|
287
288
|
requiredAtExecution: boolean;
|
|
288
|
-
initialValueStrategy: "saved_default" | "builtin" | "embed_required" | "schedule_snapshot";
|
|
289
289
|
defaultValue?: unknown;
|
|
290
290
|
hidden?: boolean | undefined;
|
|
291
|
-
showLabel?: boolean | undefined;
|
|
292
|
-
toolbarWidth?: number | undefined;
|
|
293
291
|
locked?: boolean | undefined;
|
|
294
292
|
helpText?: string | undefined;
|
|
295
|
-
placement?: "toolbar" | "
|
|
293
|
+
placement?: "toolbar" | "advanced" | "card_header" | undefined;
|
|
294
|
+
showLabel?: boolean | undefined;
|
|
295
|
+
toolbarWidth?: number | undefined;
|
|
296
296
|
}, {
|
|
297
297
|
type: "number" | "boolean" | "date" | "text" | "enum" | "multi_enum" | "field_selector" | "metric_selector" | "aggregation_selector" | "grain_selector";
|
|
298
298
|
id: string;
|
|
@@ -326,16 +326,16 @@ export declare const controlDefinitionExecutionSchema: z.ZodEffects<z.ZodObject<
|
|
|
326
326
|
valueColumn: string;
|
|
327
327
|
labelColumn?: string | undefined;
|
|
328
328
|
};
|
|
329
|
-
scope: "
|
|
329
|
+
scope: "dashboard" | "card";
|
|
330
|
+
initialValueStrategy: "saved_default" | "embed_required" | "builtin" | "schedule_snapshot";
|
|
330
331
|
requiredAtExecution: boolean;
|
|
331
|
-
initialValueStrategy: "saved_default" | "builtin" | "embed_required" | "schedule_snapshot";
|
|
332
332
|
defaultValue?: unknown;
|
|
333
333
|
hidden?: boolean | undefined;
|
|
334
|
-
showLabel?: boolean | undefined;
|
|
335
|
-
toolbarWidth?: number | undefined;
|
|
336
334
|
locked?: boolean | undefined;
|
|
337
335
|
helpText?: string | undefined;
|
|
338
|
-
placement?: "toolbar" | "
|
|
336
|
+
placement?: "toolbar" | "advanced" | "card_header" | undefined;
|
|
337
|
+
showLabel?: boolean | undefined;
|
|
338
|
+
toolbarWidth?: number | undefined;
|
|
339
339
|
}>;
|
|
340
340
|
export declare const controlBindingExecutionSchema: z.ZodDiscriminatedUnion<"target", [z.ZodObject<{
|
|
341
341
|
controlId: z.ZodString;
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { DashboardStyleField } from './types.js';
|
|
2
|
+
type NumberField = 'spacing' | 'canvasPadding' | 'cardCorners' | 'controlCorners' | 'barCorners';
|
|
3
|
+
/** Each number field's bounds and its name in sentences and refusals (SPEC §3.1). */
|
|
4
|
+
export declare const DASHBOARD_STYLE_NUMBER_BOUNDS: Readonly<Record<NumberField, {
|
|
5
|
+
min: number;
|
|
6
|
+
max: number;
|
|
7
|
+
label: string;
|
|
8
|
+
}>>;
|
|
9
|
+
export declare const CHART_COLORS_BOUNDS: {
|
|
10
|
+
readonly min: 1;
|
|
11
|
+
readonly max: 12;
|
|
12
|
+
};
|
|
13
|
+
/** "Spacing is 0 to 24 px.", "Card corners are 0 to 24 px." */
|
|
14
|
+
export declare function boundsSentence(field: NumberField): string;
|
|
15
|
+
export declare function isNumberField(field: DashboardStyleField): field is NumberField;
|
|
16
|
+
export declare function isHexColor(value: unknown): value is string;
|
|
17
|
+
export {};
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { AppearanceSpec } from '../../../lib/appearance/types.js';
|
|
2
|
+
import { DashboardStyleEdit, StyleMode, StyleRefusal } from './types.js';
|
|
3
|
+
/**
|
|
4
|
+
* The dashboard style vocabulary applied to an organization's brand (SPEC §4.4,
|
|
5
|
+
* DS-INV-4): the edit lands on the canonical paths, aliases of those properties are
|
|
6
|
+
* removed, and the spec is saved sparse (API-3). Brand Studio's other fields keep
|
|
7
|
+
* their own writers. Pure.
|
|
8
|
+
*/
|
|
9
|
+
export declare function editBrandStyle(input: {
|
|
10
|
+
spec: AppearanceSpec | null;
|
|
11
|
+
edit: DashboardStyleEdit;
|
|
12
|
+
mode?: StyleMode;
|
|
13
|
+
}): {
|
|
14
|
+
ok: true;
|
|
15
|
+
spec: AppearanceSpec | null;
|
|
16
|
+
sentences: string[];
|
|
17
|
+
} | {
|
|
18
|
+
ok: false;
|
|
19
|
+
refusal: StyleRefusal;
|
|
20
|
+
};
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { DashboardStyle, DashboardStyleEdit } from './types.js';
|
|
2
|
+
/**
|
|
3
|
+
* A dashboard's style in `DashboardStyleEdit` words, as the MCP outline reads it
|
|
4
|
+
* back (SPEC §6): sent as an edit to an unstyled dashboard, it stores the same
|
|
5
|
+
* style. `{}` for a dashboard that sets nothing. Pure.
|
|
6
|
+
*/
|
|
7
|
+
export declare function dashboardStyleAsEdit(style: DashboardStyle | undefined): DashboardStyleEdit;
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { AppearanceLayers } from '../../../lib/appearance/types.js';
|
|
2
|
+
import { DashboardStyle, DashboardStyleEdit, StyleEditOutcome, StyleMode, StyleRefusal } from './types.js';
|
|
3
|
+
/**
|
|
4
|
+
* The one writer of a dashboard's style (SPEC §4.3): checks the edit, applies the
|
|
5
|
+
* reset, then the pickers, then the explicit fields (SPEC §3.2), drops every value
|
|
6
|
+
* equal to what the dashboard inherits for its mode (DSI-2), and describes what
|
|
7
|
+
* changed. Host layers are ignored. Pure.
|
|
8
|
+
*/
|
|
9
|
+
export declare function editDashboardStyle(input: {
|
|
10
|
+
style: DashboardStyle | undefined;
|
|
11
|
+
edit: DashboardStyleEdit;
|
|
12
|
+
layers: AppearanceLayers;
|
|
13
|
+
/** The editor's mode: a reset of a per-mode field clears only it. Omitted (an agent), a reset clears both modes. */
|
|
14
|
+
mode?: StyleMode;
|
|
15
|
+
}): StyleEditOutcome;
|
|
16
|
+
/** The edit's refusal, with its fix, or undefined when every part is valid. */
|
|
17
|
+
export declare function checkStyleEdit(edit: DashboardStyleEdit): StyleRefusal | undefined;
|
|
18
|
+
/** The edit applied to a style: reset, then pickers, then explicit fields (SPEC §3.2). Inherited values are not yet dropped. */
|
|
19
|
+
export declare function applyStyleEdit(style: DashboardStyle, edit: DashboardStyleEdit, mode: StyleMode | undefined): DashboardStyle;
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The one owner of a dashboard's own style (dashboard style DS-D10, SPEC §1): the
|
|
3
|
+
* renderer, the Style panel, Brand Studio, the MCP, save validation, the GitHub
|
|
4
|
+
* restore and the backfill read and write it through these entry points.
|
|
5
|
+
*/
|
|
6
|
+
export { parseDashboardStyle } from './parse.js';
|
|
7
|
+
export { convertLegacyStyle, type LegacyConversionNote } from './legacy.js';
|
|
8
|
+
export { resolveDashboardStyle } from './view.js';
|
|
9
|
+
export { editDashboardStyle } from './edit.js';
|
|
10
|
+
export { dashboardStyleAsEdit } from './edit-words.js';
|
|
11
|
+
export { editBrandStyle } from './brand.js';
|
|
12
|
+
export { dashboardStyleLayers } from './layers.js';
|
|
13
|
+
export { CARD_SURFACES, CORNER_STEPS, SPACING_STEPS } from './pickers.js';
|
|
14
|
+
export { DASHBOARD_STYLE_NUMBER_BOUNDS, CHART_COLORS_BOUNDS } from './bounds.js';
|
|
15
|
+
export type { CanvasFill, CardShadow, CardSurface, CornerStep, DashboardStyle, DashboardStyleEdit, DashboardStyleReading, DashboardStyleView, DashboardStyleField, DashboardStyleValues, HexColor, PerMode, SpacingStep, StyleEditOutcome, StyleIssue, StyleIssueCode, StyleLayerId, StyleMode, StyleRefusal, StyleResetWord, } from './types.js';
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { AppearanceSpec } from '../../../lib/appearance/types.js';
|
|
2
|
+
import { TDashboard } from '../../../lib/types/common-types.js';
|
|
3
|
+
import { DashboardStyle } from './types.js';
|
|
4
|
+
/**
|
|
5
|
+
* A dashboard's style and the brand under it, as the dashboard renders them
|
|
6
|
+
* (dashboard style SPEC §4.6): for `UXProvider`, the MCP's `dashboard.style`
|
|
7
|
+
* change and the outline:
|
|
8
|
+
*
|
|
9
|
+
* - the style: `dashboardStyle` read leniently, or, until cut-over, a
|
|
10
|
+
* `globalStyle`-only dashboard's converted against the brand as stored (DS-D7);
|
|
11
|
+
* - the brand the style inherits (DSI-2, `shows`): the stored one normalized,
|
|
12
|
+
* until the backfill rewrites stored brands (Phase 9 removes both steps).
|
|
13
|
+
*
|
|
14
|
+
* Pure.
|
|
15
|
+
*/
|
|
16
|
+
export declare function dashboardStyleLayers(dashboard: Pick<TDashboard, 'dashboardStyle' | 'globalStyle'>, storedOrganizationAppearance: AppearanceSpec | null | undefined): {
|
|
17
|
+
style: DashboardStyle | undefined;
|
|
18
|
+
organizationAppearance: AppearanceSpec | null;
|
|
19
|
+
};
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import { AppearanceSpec } from '../../../lib/appearance/types.js';
|
|
2
|
+
import { DashboardStyle, DashboardStyleField } from './types.js';
|
|
3
|
+
export type LegacyConversionNote = {
|
|
4
|
+
field: DashboardStyleField;
|
|
5
|
+
kind: 'clamped' | 'dropped_colour' | 'brand_wins' | 'equal_to_inherited';
|
|
6
|
+
detail: string;
|
|
7
|
+
};
|
|
8
|
+
/**
|
|
9
|
+
* A dashboard's `globalStyle` (Customize Dashboard) as a `DashboardStyle` that draws
|
|
10
|
+
* what it draws today under its organization's brand (SPEC §4.5, DS-INV-3). Total:
|
|
11
|
+
* never throws, never skips; out-of-bounds values are clamped, colours that aren't
|
|
12
|
+
* hex dropped, fields the brand wins today and values equal to what the dashboard
|
|
13
|
+
* inherits removed, each with a note. Pass the brand as stored, before it is normalized.
|
|
14
|
+
*/
|
|
15
|
+
export declare function convertLegacyStyle(input: {
|
|
16
|
+
globalStyle: unknown;
|
|
17
|
+
organizationAppearance: AppearanceSpec | null;
|
|
18
|
+
}): {
|
|
19
|
+
style: DashboardStyle | undefined;
|
|
20
|
+
notes: LegacyConversionNote[];
|
|
21
|
+
};
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { DashboardStyle, StyleIssue } from './types.js';
|
|
2
|
+
/**
|
|
3
|
+
* A stored or submitted `dashboardStyle`, checked against SPEC §3.1 (DSI-1, DSI-3):
|
|
4
|
+
* colours lower-cased, empty containers removed. Strict (save) fails on any issue;
|
|
5
|
+
* lenient (load, render) drops the invalid fields and reports them, and never throws.
|
|
6
|
+
* Neither checks DSI-2, which needs the brand; writers keep it.
|
|
7
|
+
*/
|
|
8
|
+
export declare function parseDashboardStyle(value: unknown, mode: 'strict'): {
|
|
9
|
+
ok: true;
|
|
10
|
+
style: DashboardStyle | undefined;
|
|
11
|
+
} | {
|
|
12
|
+
ok: false;
|
|
13
|
+
issues: StyleIssue[];
|
|
14
|
+
};
|
|
15
|
+
export declare function parseDashboardStyle(value: unknown, mode: 'lenient'): {
|
|
16
|
+
style: DashboardStyle | undefined;
|
|
17
|
+
dropped: StyleIssue[];
|
|
18
|
+
};
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { CanvasFill, CardShadow, CardSurface, CornerStep, SpacingStep } from './types.js';
|
|
2
|
+
/** What each picker option writes (SPEC §3.2, DS-D17, DS-D18). */
|
|
3
|
+
export declare const SPACING_STEPS: Readonly<Record<SpacingStep, number>>;
|
|
4
|
+
export declare const CARD_SURFACES: Readonly<Record<CardSurface, {
|
|
5
|
+
cardBorder: 'on' | 'off';
|
|
6
|
+
cardShadow: CardShadow;
|
|
7
|
+
canvas: CanvasFill;
|
|
8
|
+
}>>;
|
|
9
|
+
export declare const CORNER_STEPS: Readonly<Record<CornerStep, {
|
|
10
|
+
cardCorners: number;
|
|
11
|
+
controlCorners: number;
|
|
12
|
+
}>>;
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* A dashboard's own style, in BI words (dashboard style SPEC §3.1): only the fields
|
|
3
|
+
* that differ from what it inherits from the defaults and the organization's brand.
|
|
4
|
+
* Stored as `TDashboard.dashboardStyle`; absent means nothing changed.
|
|
5
|
+
*/
|
|
6
|
+
export type HexColor = `#${string}`;
|
|
7
|
+
export type PerMode<T> = {
|
|
8
|
+
light?: T;
|
|
9
|
+
dark?: T;
|
|
10
|
+
};
|
|
11
|
+
export type StyleMode = 'light' | 'dark';
|
|
12
|
+
/** `muted` and `background` name the scheme's colour tokens; anything else is a colour. */
|
|
13
|
+
export type CanvasFill = 'muted' | 'background' | HexColor;
|
|
14
|
+
export type CardShadow = 'none' | 'subtle' | 'raised';
|
|
15
|
+
export type DashboardStyle = {
|
|
16
|
+
/** Gap between cards, px, integer 0..24. */
|
|
17
|
+
spacing?: number;
|
|
18
|
+
/** Canvas edge to cards, px, integer 0..48. */
|
|
19
|
+
canvasPadding?: number;
|
|
20
|
+
canvas?: PerMode<CanvasFill>;
|
|
21
|
+
cardBorder?: 'on' | 'off';
|
|
22
|
+
cardShadow?: CardShadow;
|
|
23
|
+
/** px, integer 0..24. */
|
|
24
|
+
cardCorners?: number;
|
|
25
|
+
/** px, integer 0..12. */
|
|
26
|
+
controlCorners?: number;
|
|
27
|
+
/** 1..12 colours. */
|
|
28
|
+
chartColors?: PerMode<HexColor[]>;
|
|
29
|
+
/** px, integer 0..24. */
|
|
30
|
+
barCorners?: number;
|
|
31
|
+
};
|
|
32
|
+
export type DashboardStyleField = keyof DashboardStyle;
|
|
33
|
+
/** Every field filled, for one mode. */
|
|
34
|
+
export type DashboardStyleValues = {
|
|
35
|
+
spacing: number;
|
|
36
|
+
canvasPadding: number;
|
|
37
|
+
canvas: CanvasFill;
|
|
38
|
+
cardBorder: 'on' | 'off';
|
|
39
|
+
cardShadow: CardShadow;
|
|
40
|
+
cardCorners: number;
|
|
41
|
+
controlCorners: number;
|
|
42
|
+
chartColors: HexColor[];
|
|
43
|
+
barCorners: number;
|
|
44
|
+
};
|
|
45
|
+
export type StyleIssueCode = 'unknown_field' | 'out_of_range' | 'not_integer' | 'invalid_colour' | 'palette_size' | 'invalid_value';
|
|
46
|
+
export type StyleIssue = {
|
|
47
|
+
field: string;
|
|
48
|
+
code: StyleIssueCode;
|
|
49
|
+
message: string;
|
|
50
|
+
};
|
|
51
|
+
/** The pickers' options (SPEC §3.2): what each writes is in `pickers.ts`. */
|
|
52
|
+
export type SpacingStep = 'none' | 'compact' | 'default' | 'roomy';
|
|
53
|
+
export type CardSurface = 'outlined' | 'raised' | 'open';
|
|
54
|
+
export type CornerStep = 'square' | 'subtle' | 'rounded' | 'round';
|
|
55
|
+
export type StyleResetWord = 'spacing' | 'canvasPadding' | 'canvas' | 'cards' | 'border' | 'shadow' | 'corners' | 'chartColors' | 'barCorners';
|
|
56
|
+
/** The one change vocabulary the panel, Brand Studio and the MCP speak (SPEC §3.2). */
|
|
57
|
+
export type DashboardStyleEdit = {
|
|
58
|
+
reset?: 'all' | StyleResetWord[];
|
|
59
|
+
/** A step sets the gap and the canvas padding together; a number sets the gap only. */
|
|
60
|
+
spacing?: SpacingStep | number;
|
|
61
|
+
canvasPadding?: number;
|
|
62
|
+
/** Border, shadow and canvas (both modes) together. */
|
|
63
|
+
cards?: CardSurface;
|
|
64
|
+
canvas?: CanvasFill | PerMode<CanvasFill>;
|
|
65
|
+
border?: 'on' | 'off';
|
|
66
|
+
shadow?: CardShadow;
|
|
67
|
+
corners?: CornerStep | {
|
|
68
|
+
cards?: number;
|
|
69
|
+
controls?: number;
|
|
70
|
+
};
|
|
71
|
+
chartColors?: HexColor[] | PerMode<HexColor[]>;
|
|
72
|
+
barCorners?: number;
|
|
73
|
+
};
|
|
74
|
+
export type StyleLayerId = 'defaults' | 'organization' | 'dashboard' | 'token' | 'react';
|
|
75
|
+
/**
|
|
76
|
+
* What a dashboard shows for one field, read from a resolved appearance. A brand or
|
|
77
|
+
* host may hold values a dashboard style can't (an hsl canvas, a CSS shadow): those
|
|
78
|
+
* read as they are, and a CSS shadow that is no step reads `custom`.
|
|
79
|
+
*/
|
|
80
|
+
export type DashboardStyleReading = Omit<DashboardStyleValues, 'canvas' | 'cardShadow' | 'chartColors'> & {
|
|
81
|
+
canvas: CanvasFill | (string & {});
|
|
82
|
+
cardShadow: CardShadow | 'custom';
|
|
83
|
+
chartColors: string[];
|
|
84
|
+
};
|
|
85
|
+
/** Everything a reader needs for one mode (SPEC §3.4). */
|
|
86
|
+
export type DashboardStyleView = {
|
|
87
|
+
mode: StyleMode;
|
|
88
|
+
/** Every layer: what viewers of this page see. */
|
|
89
|
+
shows: DashboardStyleReading;
|
|
90
|
+
/** Defaults, organization and dashboard: what the dashboard shows wherever no host overrides it. */
|
|
91
|
+
authored: DashboardStyleReading;
|
|
92
|
+
/** Defaults and organization: what Reset returns to. */
|
|
93
|
+
inherited: DashboardStyleReading;
|
|
94
|
+
/** The layer that won each field in `shows` (DSV-1). */
|
|
95
|
+
source: Record<DashboardStyleField, StyleLayerId>;
|
|
96
|
+
/** Fields whose source is the token or the React prop. */
|
|
97
|
+
hostSet: DashboardStyleField[];
|
|
98
|
+
/** Fields the dashboard sets (per-mode fields: for this mode). */
|
|
99
|
+
changed: DashboardStyleField[];
|
|
100
|
+
/** Fields set, counting each mode of a per-mode field. */
|
|
101
|
+
changeCount: number;
|
|
102
|
+
/** From `authored`; null when no option matches (DSV-2). */
|
|
103
|
+
pickers: {
|
|
104
|
+
spacing: SpacingStep | null;
|
|
105
|
+
cards: CardSurface | null;
|
|
106
|
+
corners: CornerStep | null;
|
|
107
|
+
};
|
|
108
|
+
};
|
|
109
|
+
export type StyleRefusal = {
|
|
110
|
+
field: string;
|
|
111
|
+
code: StyleIssueCode | 'empty_edit';
|
|
112
|
+
message: string;
|
|
113
|
+
fix: string;
|
|
114
|
+
};
|
|
115
|
+
export type StyleEditOutcome = {
|
|
116
|
+
ok: true;
|
|
117
|
+
style: DashboardStyle | undefined;
|
|
118
|
+
sentences: string[];
|
|
119
|
+
} | {
|
|
120
|
+
ok: false;
|
|
121
|
+
refusal: StyleRefusal;
|
|
122
|
+
};
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { AppearanceLayers, NormalizedAppearanceSpec } from '../../../lib/appearance/types.js';
|
|
2
|
+
import { DashboardStyleReading, DashboardStyleView, StyleMode } from './types.js';
|
|
3
|
+
/**
|
|
4
|
+
* A dashboard's style for one mode in BI words (SPEC §4.2): what it shows with every
|
|
5
|
+
* layer, without the host's layers, and without its own style; which layer won each
|
|
6
|
+
* field; and which picker options match. Pure; never throws.
|
|
7
|
+
*/
|
|
8
|
+
export declare function resolveDashboardStyle(layers: AppearanceLayers, mode: StyleMode): DashboardStyleView;
|
|
9
|
+
/** Every field as a resolved appearance draws it for a mode. */
|
|
10
|
+
export declare function readStyle(spec: NormalizedAppearanceSpec, mode: StyleMode): DashboardStyleReading;
|
|
@@ -9,6 +9,7 @@ import { TChartType } from '../../../lib/charts/types.js';
|
|
|
9
9
|
import { CalendarContext } from '../../report-runtime-context/index.js';
|
|
10
10
|
import { CardQueryPart, StatedLabel } from '../changes/card-query-part.js';
|
|
11
11
|
import { FramePlacement } from '../../layouts/index.js';
|
|
12
|
+
import { DashboardStyle } from '../dashboard-style/index.js';
|
|
12
13
|
/**
|
|
13
14
|
* The resolved operations the dashboard reducer applies (MCP dashboard
|
|
14
15
|
* editing SPEC 3.3, 3.8). Every id an operation creates is in it; the reducer
|
|
@@ -135,6 +136,16 @@ export type DashboardOperation = ({
|
|
|
135
136
|
title?: string;
|
|
136
137
|
description?: string | null;
|
|
137
138
|
}
|
|
139
|
+
/**
|
|
140
|
+
* The dashboard's own style as `editDashboardStyle` left it (dashboard style
|
|
141
|
+
* SPEC §4.3), absent when nothing is left, with that writer's sentences:
|
|
142
|
+
* apply sets it as resolved and says what the panel says.
|
|
143
|
+
*/
|
|
144
|
+
| {
|
|
145
|
+
op: 'dashboard.style';
|
|
146
|
+
style?: DashboardStyle;
|
|
147
|
+
sentences: string[];
|
|
148
|
+
}
|
|
138
149
|
/** A sheet at the end, its id from the resolver (building a report SPEC §4.1); the editor adds Document sheets too. */
|
|
139
150
|
| {
|
|
140
151
|
op: 'sheet.add';
|
|
@@ -10,6 +10,9 @@ import { NotEditableReason, OutlineCardSource } from '../changes/read-card-query
|
|
|
10
10
|
import { CardQuery, MatrixColumns } from '../changes/dashboard-change.js';
|
|
11
11
|
import { OutlineFilter } from './outline-filters.js';
|
|
12
12
|
import { CalendarContext } from '../../report-runtime-context/index.js';
|
|
13
|
+
import { AgentTimeWindowRefusal } from '../../analytics-protocol/agent-time-window.js';
|
|
14
|
+
import { AppearanceSpec } from '../../../lib/appearance/types.js';
|
|
15
|
+
import { DashboardStyleEdit, DashboardStyleReading } from '../dashboard-style/index.js';
|
|
13
16
|
/**
|
|
14
17
|
* A dashboard in the change vocabulary (MCP dashboard editing SPEC 3.6,
|
|
15
18
|
* DE-D29, DE-D34): every sheet, every card the shared traversal lists
|
|
@@ -38,6 +41,22 @@ export type OutlineViewer = {
|
|
|
38
41
|
* Without one, such cards are listed under `relationshipPending`.
|
|
39
42
|
*/
|
|
40
43
|
relationshipReach?: DashboardRelationshipReachResolver;
|
|
44
|
+
/**
|
|
45
|
+
* Server side only: the organization's brand as stored (dashboard style
|
|
46
|
+
* SPEC §4.6). A `globalStyle`-only dashboard's style is converted against
|
|
47
|
+
* it, and `shows` reads over it normalized, as the dashboard renders.
|
|
48
|
+
* Without one, over the defaults alone.
|
|
49
|
+
*/
|
|
50
|
+
organizationAppearance?: AppearanceSpec | null;
|
|
51
|
+
};
|
|
52
|
+
/**
|
|
53
|
+
* The dashboard's style (dashboard style SPEC §6): what it sets itself, in
|
|
54
|
+
* `dashboard.style`'s words (empty when it sets nothing and follows the
|
|
55
|
+
* brand), and what it shows in light mode with the brand under it.
|
|
56
|
+
*/
|
|
57
|
+
export type OutlineStyle = {
|
|
58
|
+
set: DashboardStyleEdit;
|
|
59
|
+
shows: DashboardStyleReading;
|
|
41
60
|
};
|
|
42
61
|
export type OutlineCard = ({
|
|
43
62
|
cardId: string;
|
|
@@ -51,6 +70,8 @@ export type OutlineCard = ({
|
|
|
51
70
|
/** Absent only when the outline is truncated. */
|
|
52
71
|
query?: CardQuery;
|
|
53
72
|
matrix?: MatrixColumns;
|
|
73
|
+
/** The query's stored window is one a card can't be saved with now: its refusal and replacements (relative-date-as-of SPEC-B 3.6). */
|
|
74
|
+
timeWindowReadOnly?: AgentTimeWindowRefusal;
|
|
54
75
|
} & CardTypeProperties &
|
|
55
76
|
/** How the card reads and shows, in the shape a change takes; absent when the outline is truncated (card appearance SPEC 3.2). */
|
|
56
77
|
Partial<CardSettingsView>) | OutlineTextCard | ({
|
|
@@ -161,6 +182,8 @@ export type DashboardOutline = {
|
|
|
161
182
|
filters: OutlineFilter[];
|
|
162
183
|
/** Every variable text may name: inputs, report values and data variables with their words and uses (DV-D13). */
|
|
163
184
|
variables: OutlineVariable[];
|
|
185
|
+
/** What `dashboard.style` sets, read back in its words, and what the dashboard shows. */
|
|
186
|
+
style: OutlineStyle;
|
|
164
187
|
/** In the editor's words: what the dashboard holds that no change can state (the parity backlog, DV-D13). */
|
|
165
188
|
editorOnly?: string[];
|
|
166
189
|
/** Queries left out because the dashboard has more than `maxQueryCards` cards (DE-D34). */
|
|
@@ -1,8 +1,10 @@
|
|
|
1
1
|
import { TDashboard } from '../../../lib/types/common-types.js';
|
|
2
2
|
import { DashboardFilterNotReachedReason, DashboardRelationshipReachResolver } from '../../../lib/query-context/dashboard-filter-mapping-resolution.js';
|
|
3
3
|
import { FilterInputEntry } from '../filter-model/index.js';
|
|
4
|
+
import { AgentTimeWindowRefusal } from '../../analytics-protocol/agent-time-window.js';
|
|
5
|
+
import { RelativeDateWindow } from '../../analytics-protocol/relative-date/index.js';
|
|
4
6
|
import { CalendarContext } from '../../report-runtime-context/index.js';
|
|
5
|
-
import { FilterValue
|
|
7
|
+
import { FilterValue } from '../changes/dashboard-change.js';
|
|
6
8
|
/**
|
|
7
9
|
* Every dashboard filter in the change vocabulary (MCP dashboard editing
|
|
8
10
|
* DE-D58, SPEC 3.6). A field filter on one semantic dataset shown on every
|
|
@@ -23,7 +25,13 @@ export type OutlineFilter = {
|
|
|
23
25
|
/** The values it loads with, read through the default owner (a saved default first, else the definition). */
|
|
24
26
|
defaultValues?: FilterValue[];
|
|
25
27
|
/** The window it loads with, only when the loaded default keeps one (a day picker clamps a wider window to a day). */
|
|
26
|
-
defaultPeriod?:
|
|
28
|
+
defaultPeriod?: RelativeDateWindow;
|
|
29
|
+
/**
|
|
30
|
+
* The stored default is one a filter can't be given now (Plan B SPEC-B
|
|
31
|
+
* 3.6): the refusal a write of it gets, and the windows that can replace
|
|
32
|
+
* it. It stays while filter.update leaves defaultPeriod out.
|
|
33
|
+
*/
|
|
34
|
+
defaultPeriodReadOnly?: AgentTimeWindowRefusal;
|
|
27
35
|
/** For a date filter, the picker a viewer gets: one day, one month, or a range. */
|
|
28
36
|
datePicker?: 'day' | 'month' | 'range';
|
|
29
37
|
/** "all": every grid sheet. */
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Operator } from '../../lib/types/explorer-types.js';
|
|
2
2
|
import { TemporalBucketMetadata } from '../analytics-protocol/contracts.js';
|
|
3
|
-
import {
|
|
3
|
+
import { RelativeDateWindow } from '../analytics-protocol/relative-date/index.js';
|
|
4
4
|
/**
|
|
5
5
|
* Filter conditions in full detail, for readers that restate a condition
|
|
6
6
|
* rather than glance at it (analytics agent Plan 1, D3a-4): the one renderer
|
|
@@ -32,7 +32,7 @@ export type FullDetailCondition = {
|
|
|
32
32
|
values: readonly unknown[];
|
|
33
33
|
reading: FilterLiteralReading;
|
|
34
34
|
/** A relative window, authoritative over the bounds it last resolved to. */
|
|
35
|
-
relative?:
|
|
35
|
+
relative?: RelativeDateWindow;
|
|
36
36
|
/** Compared with the field's latest value, resolved at run time. */
|
|
37
37
|
latestValue?: boolean;
|
|
38
38
|
/** The label a visual showed for the value. */
|
|
@@ -62,9 +62,3 @@ export declare function formatFilterLiteral(value: unknown, reading?: FilterLite
|
|
|
62
62
|
export declare function formatFilterLiteralList(values: readonly unknown[], reading?: FilterLiteralReading, max?: number): string;
|
|
63
63
|
/** How many of `count` values a list of at most `max` leaves out. */
|
|
64
64
|
export declare function omittedValueCount(count: number, max?: number): number;
|
|
65
|
-
/**
|
|
66
|
-
* What a relative window covers, in words that leave nothing to a preset
|
|
67
|
-
* name: its anchor (now, or the latest date in the data) and whether it keeps
|
|
68
|
-
* only whole periods.
|
|
69
|
-
*/
|
|
70
|
-
export declare function describeRelativeDateDefinition(relative: RelativeDateFilter): string;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { RelativeDateWindow } from '../analytics-protocol/index.js';
|
|
2
2
|
/**
|
|
3
3
|
* The fields of a filter value the filter line reads. A dashboard filter
|
|
4
4
|
* value fits it; the server builds a run's line from the same saved values.
|
|
@@ -39,7 +39,7 @@ export declare const FILTER_LINE_MAX_LISTED_VALUES = 10;
|
|
|
39
39
|
* card's data model, so one set of dates could be wrong for some cards. Any
|
|
40
40
|
* other relative window prints the dates it resolves to.
|
|
41
41
|
*/
|
|
42
|
-
export declare function readNamedRelativeWindow(filter: FilterLineValue):
|
|
42
|
+
export declare function readNamedRelativeWindow(filter: FilterLineValue): RelativeDateWindow | undefined;
|
|
43
43
|
/**
|
|
44
44
|
* One filter value as a readable condition, operator included: "Region not in
|
|
45
45
|
* (West)", "Amount ≥ 100". Empty for a non-null operation with no values.
|
|
@@ -47,23 +47,23 @@ export declare const matrixBatchResponseSchema: z.ZodDiscriminatedUnion<"kind",
|
|
|
47
47
|
encoding: z.ZodOptional<z.ZodLiteral<"gzip-base64">>;
|
|
48
48
|
}, "strip", z.ZodTypeAny, {
|
|
49
49
|
key: string;
|
|
50
|
-
content: string;
|
|
51
50
|
contentType: string;
|
|
51
|
+
content: string;
|
|
52
52
|
encoding?: "gzip-base64" | undefined;
|
|
53
53
|
}, {
|
|
54
54
|
key: string;
|
|
55
|
-
content: string;
|
|
56
55
|
contentType: string;
|
|
56
|
+
content: string;
|
|
57
57
|
encoding?: "gzip-base64" | undefined;
|
|
58
58
|
}>, {
|
|
59
59
|
key: string;
|
|
60
|
-
content: string;
|
|
61
60
|
contentType: string;
|
|
61
|
+
content: string;
|
|
62
62
|
encoding?: "gzip-base64" | undefined;
|
|
63
63
|
}, {
|
|
64
64
|
key: string;
|
|
65
|
-
content: string;
|
|
66
65
|
contentType: string;
|
|
66
|
+
content: string;
|
|
67
67
|
encoding?: "gzip-base64" | undefined;
|
|
68
68
|
}>, "many">;
|
|
69
69
|
deadlineAt: z.ZodNumber;
|
|
@@ -74,8 +74,8 @@ export declare const matrixBatchResponseSchema: z.ZodDiscriminatedUnion<"kind",
|
|
|
74
74
|
checkpointKey: string;
|
|
75
75
|
objects: {
|
|
76
76
|
key: string;
|
|
77
|
-
content: string;
|
|
78
77
|
contentType: string;
|
|
78
|
+
content: string;
|
|
79
79
|
encoding?: "gzip-base64" | undefined;
|
|
80
80
|
}[];
|
|
81
81
|
}, {
|
|
@@ -85,8 +85,8 @@ export declare const matrixBatchResponseSchema: z.ZodDiscriminatedUnion<"kind",
|
|
|
85
85
|
checkpointKey: string;
|
|
86
86
|
objects: {
|
|
87
87
|
key: string;
|
|
88
|
-
content: string;
|
|
89
88
|
contentType: string;
|
|
89
|
+
content: string;
|
|
90
90
|
encoding?: "gzip-base64" | undefined;
|
|
91
91
|
}[];
|
|
92
92
|
}>, z.ZodObject<{
|
|
@@ -96,13 +96,13 @@ export declare const matrixBatchResponseSchema: z.ZodDiscriminatedUnion<"kind",
|
|
|
96
96
|
deadlineAt: z.ZodNumber;
|
|
97
97
|
}, "strip", z.ZodTypeAny, {
|
|
98
98
|
kind: "committed";
|
|
99
|
-
sequence: number;
|
|
100
99
|
done: boolean;
|
|
100
|
+
sequence: number;
|
|
101
101
|
deadlineAt: number;
|
|
102
102
|
}, {
|
|
103
103
|
kind: "committed";
|
|
104
|
-
sequence: number;
|
|
105
104
|
done: boolean;
|
|
105
|
+
sequence: number;
|
|
106
106
|
deadlineAt: number;
|
|
107
107
|
}>]>;
|
|
108
108
|
/** Count the complete JSON envelope in UTF-8, including escaping and transport fields. */
|
|
@@ -115,14 +115,14 @@ export declare function parseMatrixBatchResponse(value: unknown, input: MatrixBa
|
|
|
115
115
|
checkpointKey: string;
|
|
116
116
|
objects: {
|
|
117
117
|
key: string;
|
|
118
|
-
content: string;
|
|
119
118
|
contentType: string;
|
|
119
|
+
content: string;
|
|
120
120
|
encoding?: "gzip-base64" | undefined;
|
|
121
121
|
}[];
|
|
122
122
|
} | {
|
|
123
123
|
kind: "committed";
|
|
124
|
-
sequence: number;
|
|
125
124
|
done: boolean;
|
|
125
|
+
sequence: number;
|
|
126
126
|
deadlineAt: number;
|
|
127
127
|
};
|
|
128
128
|
export declare const matrixManifestSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
|
|
@@ -1,7 +1,5 @@
|
|
|
1
1
|
export * from './zoned-wall-clock.js';
|
|
2
2
|
export * from './calendar-periods.js';
|
|
3
|
-
export * from './relative-date.js';
|
|
4
|
-
export * from './time-window-periods.js';
|
|
5
3
|
export * from './calendar-day-equality.js';
|
|
6
4
|
export * from './raw-temporal-equality.js';
|
|
7
5
|
export * from './temporal-parity-fixtures.js';
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { StoredRelativeDate } from '../analytics-protocol/relative-date/index.js';
|
|
2
2
|
import { WeekStart } from '../report-runtime-context/index.js';
|
|
3
3
|
import { TemporalUnit } from './calendar-periods.js';
|
|
4
4
|
import { ZonedWallClockTime } from './zoned-wall-clock.js';
|
|
@@ -9,7 +9,7 @@ export type TemporalParityRelativeCase = {
|
|
|
9
9
|
/** The month-aligned fiscal year's first month, when the calendar has one. */
|
|
10
10
|
fiscalStart?: number;
|
|
11
11
|
anchor: string;
|
|
12
|
-
relative:
|
|
12
|
+
relative: StoredRelativeDate;
|
|
13
13
|
expected: [string, string];
|
|
14
14
|
/**
|
|
15
15
|
* The browser's old result where it differed, and the rule that changed
|