react-semaphor 0.1.563 → 0.1.565
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/DATA_APP_SDK.md +3 -3
- package/README.md +2 -2
- package/dist/analytics-protocol/index.js +8 -8
- package/dist/assistant-context/index.js +3 -2
- package/dist/brand-studio/index.js +28 -29
- package/dist/briefings/index.js +4 -4
- package/dist/chunks/{assistant-chat-iIp02_77.js → assistant-chat-DNfb5fbF.js} +294 -294
- package/dist/chunks/{bookmark-impact-D4Kl4amw.js → bookmark-impact-CHr7b1J2.js} +2 -2
- package/dist/chunks/bookmark-state-ByODVqee.js +1613 -0
- package/dist/chunks/card-filter-builder-CcEcfaYz.js +4100 -0
- package/dist/chunks/{switch-BW4yXSYs.js → code-editor-DJNOsgJH.js} +463 -442
- package/dist/chunks/{comparison-window-caption-D1EUXzaR.js → comparison-window-caption-CMLb3mut.js} +451 -419
- package/dist/chunks/{dashboard-CmqeP3QZ.js → dashboard-CtIfxycc.js} +1 -1
- package/dist/chunks/dashboard-briefing-launcher-D3mc6peE.js +4910 -0
- package/dist/chunks/{dashboard-controls-B253nJS-.js → dashboard-controls-BFv0zdws.js} +684 -674
- package/dist/chunks/{dashboard-json-osQuinUZ.js → dashboard-json-CXn_3OYb.js} +4 -4
- package/dist/chunks/{dates-DFY7Gfss.js → dates-DcRxw17S.js} +13 -13
- package/dist/chunks/{edit-dashboard-visual-CMar-NhA.js → edit-dashboard-visual-Y6HatqBd.js} +7704 -10337
- package/dist/chunks/filter-reach-copy-DbggA5B7.js +4673 -0
- package/dist/chunks/{filter-value-text-CPwFkrMz.js → filter-value-text-7zhmth1S.js} +2 -2
- package/dist/chunks/{index-CNGkfUp4.js → index-DDa_rklN.js} +69 -64
- package/dist/chunks/index-RNaTnE3m.js +585 -0
- package/dist/chunks/{layout-grid-BM65viQh.js → layout-grid-0hIlqEtk.js} +1 -1
- package/dist/chunks/{list-filter-BoeLBfL3.js → list-filter-DkgoCeBm.js} +1 -1
- package/dist/chunks/{matrix-analytical-definition-hEucouWM.js → matrix-analytical-definition-C9xB_T84.js} +18 -18
- package/dist/chunks/{matrix-card-CCh9JjP1.js → matrix-card-BSUeSXpD.js} +2 -2
- package/dist/chunks/{matrix-member-presentation-DsAUbuoL.js → matrix-member-presentation-DZNgQpUq.js} +1 -1
- package/dist/chunks/{matrix-operation-contract-DsLdFdSa.js → matrix-operation-contract-Eb6elidS.js} +1 -1
- package/dist/chunks/{metric-comparison-Bnso1cm1.js → metric-comparison-ChXUFaZu.js} +1 -1
- package/dist/chunks/{palette-p1XSJFgB.js → palette-4vf2BEEg.js} +1 -1
- package/dist/chunks/{pivot-result-contract-expectations-B53jqszr.js → pivot-result-contract-expectations-Ddh1rNz5.js} +4 -4
- package/dist/chunks/{pivot-result-identity-Dq5jm-EC.js → pivot-result-identity-BlbLrqaC.js} +1 -1
- package/dist/chunks/{report-preferences-dialog-l54wJyYE.js → report-preferences-dialog-Db-b04B4.js} +122 -131
- package/dist/chunks/{report-runtime-context-BITkNSDa.js → report-runtime-context-DnA_PiKo.js} +1 -1
- package/dist/chunks/resolve-dashboard-input-context-C18J-YZC.js +21394 -0
- package/dist/chunks/{save-CHV1B1fL.js → save-D6pHmSSP.js} +1 -1
- package/dist/chunks/saved-dashboard-context-DhC_EVus.js +629 -0
- package/dist/chunks/{selection-reducer-Bz5aywT4.js → selection-reducer-OaJ-N5uN.js} +1 -1
- package/dist/chunks/{semaphor-ready-indicator-C3EQEiD9.js → semaphor-ready-indicator-T6TsiBMT.js} +80879 -80744
- package/dist/chunks/{shelf-drop-preview-context-BODiBlqT.js → shelf-drop-preview-context-CNWL_b0S.js} +407 -407
- package/dist/chunks/{source-entity-resolution-DdDVXFB8.js → source-entity-resolution-DF6GulDn.js} +1 -1
- package/dist/chunks/stored-dashboard-IdmtrNkA.js +5026 -0
- package/dist/chunks/{table-export-sheet-bSXxGn-v.js → table-export-sheet--DUKWk6o.js} +1 -1
- package/dist/chunks/{temporal-input-presentation-sk9gqLi6.js → temporal-input-presentation--2r9BLr0.js} +392 -377
- package/dist/chunks/{token-types-BUK06hU2.js → token-types-C8JymO8s.js} +1 -1
- package/dist/chunks/{upload-BnmuyPqW.js → upload-Cf3wXZT8.js} +1 -1
- package/dist/chunks/{validators-BIM0FE31.js → validators-wtjw0aw6.js} +7 -7
- package/dist/chunks/variable-draft-3xseULxR.js +241 -0
- package/dist/dashboard/index.js +2 -2
- package/dist/dashboard-authoring/index.js +2226 -1704
- package/dist/data-app-sdk/index.js +4 -4
- package/dist/data-app-sdk-adapters/index.js +2 -2
- package/dist/data-app-sdk-validation/index.js +5 -5
- package/dist/format-utils/index.js +174 -167
- package/dist/index.js +190 -188
- package/dist/layouts/index.js +1 -1
- package/dist/pdf-export-policy/index.js +80 -28
- package/dist/pdf-table-layout/index.js +65 -65
- 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/briefings/attachment-outcomes.d.ts +1 -1
- package/dist/types/components/activity/activity-bell.d.ts +5 -1
- package/dist/types/components/activity/activity-types.d.ts +12 -4
- package/dist/types/components/dashboard-variables/data-variables-menu.d.ts +8 -0
- package/dist/types/components/dashboard-variables/variable-editor-host.d.ts +1 -0
- package/dist/types/components/index.d.ts +2 -0
- package/dist/types/index.js +5 -5
- package/dist/types/lib/dashboard-inputs/build-normalized-dashboard-inputs.d.ts +62 -0
- package/dist/types/lib/dashboard-inputs/dashboard-filter-mapping-authoring.d.ts +33 -2
- package/dist/types/lib/dashboard-inputs/filter-settings.d.ts +7 -2
- package/dist/types/lib/dashboard-inputs/prepare-loaded-dashboard.d.ts +4 -2
- package/dist/types/lib/dashboard-variables/data-text.d.ts +33 -0
- package/dist/types/lib/dashboard-variables/types.d.ts +207 -0
- package/dist/types/lib/document/document-edits.d.ts +16 -1
- package/dist/types/lib/document/document-panel-target.d.ts +1 -1
- package/dist/types/lib/document/document-section-query-options.d.ts +29 -0
- package/dist/types/lib/document/document-table-data-policy.d.ts +0 -1
- package/dist/types/lib/hooks/use-dashboard-frame-query.d.ts +92 -0
- package/dist/types/lib/query-context/build-card-query-context.d.ts +6 -0
- package/dist/types/lib/query-context/describe-card-execution-snapshot.d.ts +1 -0
- package/dist/types/lib/query-context/use-semantic-execution-payload-for-cards.d.ts +24 -0
- package/dist/types/lib/stores/dashboard-store.d.ts +36 -0
- package/dist/types/lib/text-variables/temporal-input-text.d.ts +28 -0
- package/dist/types/lib/text-variables/text-variable-types.d.ts +72 -0
- package/dist/types/lib/types/common-types.d.ts +155 -51
- package/dist/types/lib/utils/card-definition.d.ts +2 -2
- package/dist/types/shared/assistant-context/index.d.ts +1 -1
- package/dist/types/shared/assistant-context/saved-dashboard-context.d.ts +51 -1
- package/dist/types/shared/dashboard-authoring/card-query-request.d.ts +7 -1
- package/dist/types/shared/dashboard-authoring/card-settings/resolve-card-highlights.d.ts +10 -0
- package/dist/types/shared/dashboard-authoring/changes/card-query-part.d.ts +7 -1
- package/dist/types/shared/dashboard-authoring/changes/dashboard-change.d.ts +1088 -431
- package/dist/types/shared/dashboard-authoring/changes/diagnostics.d.ts +18 -1
- package/dist/types/shared/dashboard-authoring/changes/read-card-query.d.ts +8 -1
- package/dist/types/shared/dashboard-authoring/changes/resolve-dashboard-changes.d.ts +1 -1
- package/dist/types/shared/dashboard-authoring/conditional-formatting/kpi.d.ts +10 -0
- package/dist/types/shared/dashboard-authoring/conditional-formatting/schema.d.ts +40 -40
- package/dist/types/shared/dashboard-authoring/control-execution-contract.d.ts +16 -16
- package/dist/types/shared/dashboard-authoring/dashboard-card-source-index.d.ts +1 -0
- package/dist/types/shared/dashboard-authoring/dashboard-filter-targets.d.ts +29 -0
- package/dist/types/shared/dashboard-authoring/dashboard-input-scope.d.ts +7 -4
- package/dist/types/shared/dashboard-authoring/dashboard-variable-card.d.ts +159 -0
- package/dist/types/shared/dashboard-authoring/dashboard-variable-changes.d.ts +61 -0
- package/dist/types/shared/dashboard-authoring/document-section-cards.d.ts +7 -0
- package/dist/types/shared/dashboard-authoring/filter-model/index.d.ts +2 -0
- package/dist/types/shared/dashboard-authoring/filter-model/read-dashboard-filter-model.d.ts +10 -0
- package/dist/types/shared/dashboard-authoring/index.d.ts +6 -0
- package/dist/types/shared/dashboard-authoring/measure-calculations/comparison.d.ts +2 -0
- package/dist/types/shared/dashboard-authoring/measure-calculations/schemas.d.ts +1 -1
- package/dist/types/shared/dashboard-authoring/operations/operation-sentences.d.ts +1 -1
- package/dist/types/shared/dashboard-authoring/operations/operation-types.d.ts +50 -3
- package/dist/types/shared/dashboard-authoring/outline/outline-dashboard.d.ts +48 -1
- package/dist/types/shared/dashboard-authoring/outline/outline-filters.d.ts +2 -2
- package/dist/types/shared/dashboard-authoring/text-card-words/blocks.d.ts +87 -13
- package/dist/types/shared/dashboard-authoring/text-card-words/chip-colors.d.ts +23 -0
- package/dist/types/shared/dashboard-authoring/text-card-words/index.d.ts +90 -8
- package/dist/types/shared/dashboard-authoring/text-card-words/rich-content.d.ts +31 -3
- package/dist/types/shared/dashboard-authoring/text-card-words/variable-words.d.ts +8 -0
- package/dist/types/shared/dashboard-authoring/variable-draft.d.ts +125 -0
- package/dist/types/shared/dashboard-authoring/variable-editability.d.ts +24 -0
- package/dist/types/shared/dashboard-authoring/variable-references.d.ts +39 -0
- package/dist/types/shared/format-utils/document-print.d.ts +4 -2
- package/dist/types/shared/format-utils/index.d.ts +1 -0
- package/dist/types/shared/format-utils/pdf-capacity-lines.d.ts +17 -0
- package/dist/types/shared/format-utils/pdf-delivery.d.ts +8 -1
- package/dist/types/shared/format-utils/pdf-export-policy.d.ts +74 -6
- package/dist/types/shared/format-utils/presentation-execution.d.ts +9 -0
- package/package.json +2 -2
- package/src/data-app-sdk/README.md +3 -3
- package/dist/chunks/bookmark-state-CWeoGbrx.js +0 -743
- package/dist/chunks/braces-DzgoQC64.js +0 -23
- package/dist/chunks/dashboard-briefing-launcher-TYlSW77S.js +0 -3828
- package/dist/chunks/filter-reach-copy-CvV7W5dd.js +0 -3965
- package/dist/chunks/global-date-filter-utils-N1kcsOFE.js +0 -16722
- package/dist/chunks/index-CJW5BdWT.js +0 -583
- package/dist/chunks/resolve-dashboard-input-context-DaDrZGuA.js +0 -8214
- package/dist/chunks/saved-dashboard-context-DFYBrE6O.js +0 -564
- package/dist/chunks/use-create-flow-overlay-state-BXY8-Cyz.js +0 -1436
package/dist/surfboard/index.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { a, R as s, D as o } from "../chunks/report-preferences-dialog-
|
|
2
|
-
import { C as f, E as D } from "../chunks/bookmark-state-
|
|
1
|
+
import { a, R as s, D as o } from "../chunks/report-preferences-dialog-Db-b04B4.js";
|
|
2
|
+
import { C as f, E as D } from "../chunks/bookmark-state-ByODVqee.js";
|
|
3
3
|
export {
|
|
4
4
|
f as CONTROL_CARD_DEFAULT_VALUE,
|
|
5
5
|
a as DisplayFormatPreferencesFields,
|
|
@@ -4,7 +4,7 @@ import { BriefingAttachmentFormat } from './index.js';
|
|
|
4
4
|
* RA-D14). The app decides the code and writes the customer line; the run
|
|
5
5
|
* card reads both back from the run.
|
|
6
6
|
*/
|
|
7
|
-
export declare const BRIEFING_ATTACHMENT_OMISSION_CODES: readonly ["PDF_ROW_LIMIT_EXCEEDED", "PDF_SIZE_LIMIT_EXCEEDED", "TABLE_COMPLETENESS_UNVERIFIED", "CARD_QUERY_FAILED", "RENDER_NOT_READY", "RENDER_TIMED_OUT", "EXPORT_JOB_FAILED", "ATTACHMENT_UNAVAILABLE", "EXCEL_LIMIT_EXCEEDED", "EXPORT_ROW_LIMIT_EXCEEDED", "EXPORT_COUNT_UNAVAILABLE", "EXPORT_NO_ROWS", "IMAGE_TOO_LARGE", "DOCUMENT_PAGE_OVERFLOW", "DOCUMENT_ROW_LIMIT_EXCEEDED", "DOCUMENT_SECTION_SETUP", "REPORT_INPUTS_MISSING"];
|
|
7
|
+
export declare const BRIEFING_ATTACHMENT_OMISSION_CODES: readonly ["PDF_ROW_LIMIT_EXCEEDED", "PDF_SIZE_LIMIT_EXCEEDED", "PDF_PAGE_LIMIT_EXCEEDED", "TABLE_COMPLETENESS_UNVERIFIED", "CARD_QUERY_FAILED", "RENDER_NOT_READY", "RENDER_TIMED_OUT", "EXPORT_JOB_FAILED", "ATTACHMENT_UNAVAILABLE", "EXCEL_LIMIT_EXCEEDED", "EXPORT_ROW_LIMIT_EXCEEDED", "EXPORT_COUNT_UNAVAILABLE", "EXPORT_NO_ROWS", "IMAGE_TOO_LARGE", "DOCUMENT_PAGE_OVERFLOW", "DOCUMENT_ROW_LIMIT_EXCEEDED", "DOCUMENT_SECTION_SETUP", "REPORT_INPUTS_MISSING", "REPORT_NEEDS_RESAVE"];
|
|
8
8
|
export type BriefingAttachmentOmissionCode = (typeof BRIEFING_ATTACHMENT_OMISSION_CODES)[number];
|
|
9
9
|
/** One left-out attachment, as recorded on the run and read by every channel. */
|
|
10
10
|
export type BriefingOmittedAttachment = {
|
|
@@ -7,5 +7,9 @@ import { default as React } from 'react';
|
|
|
7
7
|
export declare function ActivityBell({ variant }: {
|
|
8
8
|
variant?: 'outline' | 'ghost';
|
|
9
9
|
}): React.JSX.Element;
|
|
10
|
-
/**
|
|
10
|
+
/**
|
|
11
|
+
* Every export and Briefing run the person started (SPEC §2.5), and every
|
|
12
|
+
* browser-only export while it runs (SA-D1): running first, newest started
|
|
13
|
+
* first, then finished runs. Mounted only while open.
|
|
14
|
+
*/
|
|
11
15
|
export declare function ActivityTray(): React.JSX.Element;
|
|
@@ -28,10 +28,11 @@ export type ActivityData = {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* A browser-only export (a direct file or a PDF) while it runs or its dialog
|
|
31
|
-
* shows it (BA-D5).
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
31
|
+
* shows it (BA-D5, amended by sync-exports-in-activity SA-D1). A tray row
|
|
32
|
+
* while it runs, never after: the server does not know it. Finishing after
|
|
33
|
+
* its dialog's line was shown and closed raises the one notice and removes
|
|
34
|
+
* it; finishing before the line first shows it (a synchronous file) or while
|
|
35
|
+
* it shows it raises none, and the line shows the result.
|
|
35
36
|
*/
|
|
36
37
|
export type BrowserExport = {
|
|
37
38
|
/** 'browser:' + a random id; also the attempt's watch id. */
|
|
@@ -52,6 +53,8 @@ export type BrowserExport = {
|
|
|
52
53
|
rows?: number;
|
|
53
54
|
fileSize?: number;
|
|
54
55
|
};
|
|
56
|
+
/** Stops it where its dialog's Cancel export can (a table read, SA-D3); null otherwise. */
|
|
57
|
+
cancel: (() => void) | null;
|
|
55
58
|
};
|
|
56
59
|
export type TrackInput = {
|
|
57
60
|
kind: 'export';
|
|
@@ -110,6 +113,9 @@ export type WatchedWork = {
|
|
|
110
113
|
export type ActivitySnapshot = {
|
|
111
114
|
/** Running first, then newest finishedAt; cleared rows excluded. */
|
|
112
115
|
rows: readonly ActivityRow[];
|
|
116
|
+
/** Running browser-only exports, newest first: tray rows beside `rows` (SA-D1), read only by the tray and the bell. */
|
|
117
|
+
browserRows: readonly BrowserExport[];
|
|
118
|
+
/** Running runs and running browser-only exports (SA-D2). */
|
|
113
119
|
runningCount: number;
|
|
114
120
|
hasUnseenFinished: boolean;
|
|
115
121
|
/** Shows M34. */
|
|
@@ -133,8 +139,10 @@ export type BrowserExportWork = {
|
|
|
133
139
|
};
|
|
134
140
|
export type ActivityApi = {
|
|
135
141
|
track(input: TrackInput): void;
|
|
142
|
+
/** `cancel`: what its dialog's Cancel export calls, when it can (a table read); its tray row offers it too. */
|
|
136
143
|
begin(input: {
|
|
137
144
|
title: string;
|
|
145
|
+
cancel?: () => void;
|
|
138
146
|
}): BrowserExportWork;
|
|
139
147
|
clearFinished(): void;
|
|
140
148
|
dismissNotice(id: string): void;
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
/** The ⋮ menu's Data variables entry: its words, how many there are, and how to open the list. */
|
|
2
|
+
export declare function useDataVariablesMenuEntry(): {
|
|
3
|
+
label: string;
|
|
4
|
+
count: number;
|
|
5
|
+
open: () => void;
|
|
6
|
+
};
|
|
7
|
+
/** The Data variables list, anchored where it is mounted (beside the ⋮ button). */
|
|
8
|
+
export declare function DataVariablesListHost(): import("react").JSX.Element;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare function VariableEditorHost(): import("react").JSX.Element | null;
|
|
@@ -72,6 +72,8 @@ export { DashboardControlsSettings } from './surfboard/controls/dashboard-contro
|
|
|
72
72
|
export { DocumentControlsSettings } from './document-sheet/document-controls-settings.js';
|
|
73
73
|
export { DashboardFilterControlsButton } from './surfboard/controls/dashboard-filter-controls-button.js';
|
|
74
74
|
export { DashboardFilterControlsLauncher } from './surfboard/controls/dashboard-filter-controls-launcher.js';
|
|
75
|
+
export { DataVariablesListHost, useDataVariablesMenuEntry } from './dashboard-variables/data-variables-menu.js';
|
|
76
|
+
export { VariableEditorHost } from './dashboard-variables/variable-editor-host.js';
|
|
75
77
|
export * from '../lib/types/briefing-types.js';
|
|
76
78
|
export * from '../lib/api/briefings-api.js';
|
|
77
79
|
export * from '../lib/briefings/briefing-form-model.js';
|
package/dist/types/index.js
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import { B as s, x as r, C as l, E as o, V as i, j as n, c as d, g as m, f as u, b as c, e as E, d as C, a as T, w as p, v as D, h as A, l as I, u as _, s as F, m as S, n as b, p as L, k as f, o as N, q as R, i as y, r as g, t as h } from "../chunks/bookmark-state-
|
|
2
|
-
import { C as M, D as O, L as V, e as w, g as k, j as U, h as B, k as K, d as z, b as v, i as Y, c as q, n as G, f as P } from "../chunks/validators-
|
|
3
|
-
import { D as j } from "../chunks/token-types-
|
|
4
|
-
import { r as J, a as X } from "../chunks/pivot-result-identity-
|
|
5
|
-
import { D as Z } from "../chunks/report-runtime-context-
|
|
1
|
+
import { B as s, x as r, C as l, E as o, V as i, j as n, c as d, g as m, f as u, b as c, e as E, d as C, a as T, w as p, v as D, h as A, l as I, u as _, s as F, m as S, n as b, p as L, k as f, o as N, q as R, i as y, r as g, t as h } from "../chunks/bookmark-state-ByODVqee.js";
|
|
2
|
+
import { C as M, D as O, L as V, e as w, g as k, j as U, h as B, k as K, d as z, b as v, i as Y, c as q, n as G, f as P } from "../chunks/validators-wtjw0aw6.js";
|
|
3
|
+
import { D as j } from "../chunks/token-types-C8JymO8s.js";
|
|
4
|
+
import { r as J, a as X } from "../chunks/pivot-result-identity-BlbLrqaC.js";
|
|
5
|
+
import { D as Z } from "../chunks/report-runtime-context-DnA_PiKo.js";
|
|
6
6
|
const e = [
|
|
7
7
|
"concatenate",
|
|
8
8
|
"conditional-category",
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
import { DashboardInputValues, NormalizedDashboardInput, TCard, TDashboard } from '../types/common-types.js';
|
|
2
|
+
import { FilterModelIssueCode } from '../../shared/dashboard-authoring/index.js';
|
|
3
|
+
import { TransientInputContext } from './transient-input-context.js';
|
|
4
|
+
export type BuildNormalizedDashboardInputsInput = {
|
|
5
|
+
dashboard: Pick<TDashboard, 'inputs' | 'filters' | 'controls' | 'sheets' | 'variables'>;
|
|
6
|
+
card?: TCard | null;
|
|
7
|
+
/**
|
|
8
|
+
* Carried definitions for a runtime resolution. Authoring callers leave it
|
|
9
|
+
* out: a carried definition is never part of the dashboard being edited.
|
|
10
|
+
*/
|
|
11
|
+
transientContexts?: readonly TransientInputContext[];
|
|
12
|
+
};
|
|
13
|
+
export type BuildNormalizedDashboardInputsOutput = {
|
|
14
|
+
authoredInputs: NormalizedDashboardInput[];
|
|
15
|
+
compatibilityInputs: NormalizedDashboardInput[];
|
|
16
|
+
/** Carried definitions, already normalized and self-contained. */
|
|
17
|
+
transientInputs: NormalizedDashboardInput[];
|
|
18
|
+
allInputs: NormalizedDashboardInput[];
|
|
19
|
+
};
|
|
20
|
+
export declare function requiresDashboardInputResolution({ dashboard, dashboardInputValues, transientContexts, }: {
|
|
21
|
+
dashboard: Pick<TDashboard, 'inputs' | 'filters' | 'controls' | 'defaultInputValues' | 'sheets'>;
|
|
22
|
+
dashboardInputValues?: DashboardInputValues;
|
|
23
|
+
/**
|
|
24
|
+
* Carried definitions are inputs of this resolution too, so a dashboard with
|
|
25
|
+
* no inputs of its own still has to resolve them. Required so that every
|
|
26
|
+
* caller decides.
|
|
27
|
+
*/
|
|
28
|
+
transientContexts: readonly TransientInputContext[] | undefined;
|
|
29
|
+
}): boolean;
|
|
30
|
+
export declare function buildNormalizedDashboardInputs({ dashboard, card, transientContexts, }: BuildNormalizedDashboardInputsInput): BuildNormalizedDashboardInputsOutput;
|
|
31
|
+
/** An Input the tolerant normalization rejected, kept identifiable. */
|
|
32
|
+
export type RejectedDashboardInput = {
|
|
33
|
+
inputId: string;
|
|
34
|
+
filterId?: string;
|
|
35
|
+
label: string;
|
|
36
|
+
message: string;
|
|
37
|
+
/** Set when the filter model left the input out for a rule other than the contract. */
|
|
38
|
+
modelIssueCode?: Exclude<FilterModelIssueCode, 'contract'>;
|
|
39
|
+
};
|
|
40
|
+
export type TolerantNormalizedDashboardInputs = {
|
|
41
|
+
/** Every Input that normalized without an issue. */
|
|
42
|
+
inputs: NormalizedDashboardInput[];
|
|
43
|
+
/** Inputs the contract reported, none of which is in `inputs`. */
|
|
44
|
+
rejected: RejectedDashboardInput[];
|
|
45
|
+
/** Filter ids of every filter Input known on the dashboard, rejected included. */
|
|
46
|
+
knownFilterIds: ReadonlySet<string>;
|
|
47
|
+
};
|
|
48
|
+
/**
|
|
49
|
+
* Tolerant counterpart of `buildNormalizedDashboardInputs` for option loading
|
|
50
|
+
* and authoring diagnostics: the same authored and compatibility assembly, but
|
|
51
|
+
* an Input the contract reports is rejected (never partially kept) and its
|
|
52
|
+
* identity is retained so an explicit reference to it can fail with a typed
|
|
53
|
+
* error and authors can see why. The dashboard-level part is computed once
|
|
54
|
+
* per immutable dashboard object; card inline inputs are lifted per call.
|
|
55
|
+
*/
|
|
56
|
+
export declare function buildNormalizedDashboardInputsTolerantly({ dashboard, card, }: Pick<BuildNormalizedDashboardInputsInput, 'dashboard' | 'card'>): TolerantNormalizedDashboardInputs;
|
|
57
|
+
/**
|
|
58
|
+
* Every Input the dashboard defines, its own and each card's inline ones, by
|
|
59
|
+
* id, computed once per immutable dashboard object (tolerant: rejected Inputs
|
|
60
|
+
* are left out).
|
|
61
|
+
*/
|
|
62
|
+
export declare function listDashboardInputsTolerantly(dashboard: Pick<TDashboard, 'inputs' | 'filters' | 'controls' | 'sheets' | 'variables'>): readonly NormalizedDashboardInput[];
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { TFilter } from '../../components/surfboard/filter/types.js';
|
|
2
|
-
import { DashboardInputScope, TCard, TDashboard } from '../types/common-types.js';
|
|
2
|
+
import { DashboardInputScope, DataVariable, TCard, TDashboard } from '../types/common-types.js';
|
|
3
3
|
import { DashboardFilterApplication, DashboardFilterCardApplication, DashboardFilterRelationshipTarget, DashboardFilterFieldTarget, DashboardFilterTarget, DashboardFilterTargetField, DashboardFilterOptionSource, FilterReachPreviewCard, FilterReachCardPreview, FilterReachPathOption } from '../../shared/dashboard-authoring/index.js';
|
|
4
4
|
import { SemaphorRelationshipRoute, SemaphorSkippedConstraintReason } from '../../shared/analytics-protocol/index.js';
|
|
5
5
|
import { FilterRef, ReachedCard } from '../../shared/dashboard-authoring/filter-model/index.js';
|
|
@@ -166,6 +166,9 @@ export type DashboardFilterMappingRowState = 'pendingSource' | 'automatic' | 'su
|
|
|
166
166
|
| 'chooseRoute'
|
|
167
167
|
/** Waiting for the server's relationship answer, or it failed. */
|
|
168
168
|
| 'relationshipChecking';
|
|
169
|
+
/** Where a row's card is. */
|
|
170
|
+
/** The Cards tab's Variables band: a reserved group id no sheet has (data variables DV-D35, 1b). */
|
|
171
|
+
export declare const VARIABLES_MAPPING_GROUP_ID = "__variables__";
|
|
169
172
|
/**
|
|
170
173
|
* One card in the Cards tab: the author's decision and what runs for it
|
|
171
174
|
* (`DashboardFilterCardState`), made only by `cardRow`. Every reader (the
|
|
@@ -176,6 +179,8 @@ export type DashboardFilterMappingDraftRow = DashboardFilterCardState & {
|
|
|
176
179
|
cardId: string;
|
|
177
180
|
/** The panel reads the title and meta line from it. */
|
|
178
181
|
card: TCard;
|
|
182
|
+
/** Set on a data variable's row (its `card` is the projected card, DV-D30). */
|
|
183
|
+
variable?: DataVariable;
|
|
179
184
|
sheetId: string;
|
|
180
185
|
sheetKind: 'dashboard' | 'document';
|
|
181
186
|
sectionId?: string;
|
|
@@ -328,10 +333,34 @@ export type DashboardFilterMappingRowView = {
|
|
|
328
333
|
throughRelationships: boolean;
|
|
329
334
|
};
|
|
330
335
|
export type DashboardFilterMappingGroup = {
|
|
336
|
+
/** A tab's id, or `VARIABLES_MAPPING_GROUP_ID` for the Variables band. */
|
|
331
337
|
sheetId: string;
|
|
332
338
|
sheetTitle: string;
|
|
333
339
|
sheetKind: 'dashboard' | 'document';
|
|
340
|
+
/** What the rows are; cards unless said otherwise. */
|
|
341
|
+
unit?: 'card' | 'variable';
|
|
334
342
|
rows: DashboardFilterMappingDraftRow[];
|
|
343
|
+
/**
|
|
344
|
+
* The text on this tab that shows variables, each with the variables it
|
|
345
|
+
* shows: a filter reaches the questions, not the text, so a text card of
|
|
346
|
+
* words is not a row of its own (a variable has one mapping, shown under
|
|
347
|
+
* every text it appears in).
|
|
348
|
+
*/
|
|
349
|
+
texts?: DashboardFilterMappingText[];
|
|
350
|
+
};
|
|
351
|
+
/** A text card, or a Document's text, and the rows of the variables it shows. */
|
|
352
|
+
export type DashboardFilterMappingText = {
|
|
353
|
+
id: string;
|
|
354
|
+
title: string;
|
|
355
|
+
kind: 'card' | 'document';
|
|
356
|
+
rows: DashboardFilterMappingDraftRow[];
|
|
357
|
+
};
|
|
358
|
+
/** A data variable the filter reaches, with the card its fields are matched on and the tabs it reaches it on. */
|
|
359
|
+
export type ReachedVariableTarget = {
|
|
360
|
+
variableId: string;
|
|
361
|
+
variable: DataVariable;
|
|
362
|
+
card: TCard;
|
|
363
|
+
sheetIds: string[];
|
|
335
364
|
};
|
|
336
365
|
export type DashboardFilterMappingIssueCode = 'inputNotFound' | 'globalDateUnsupported' | 'unsupportedOuterScope' | 'unsupportedRuntimeScope' | 'missingDecision' | 'invalidTarget' | 'metadataUnavailable';
|
|
337
366
|
export type DashboardFilterMappingIssue = {
|
|
@@ -370,8 +399,10 @@ export type DashboardFilterMappingDraft = {
|
|
|
370
399
|
scope: Exclude<DashboardInputScope, {
|
|
371
400
|
kind: 'documentSections';
|
|
372
401
|
}>;
|
|
373
|
-
/** The cards the rows were built for; the catalogs hook fetches metadata for exactly these
|
|
402
|
+
/** The cards the rows were built for; the catalogs hook fetches metadata for exactly these and `variables`. */
|
|
374
403
|
cards: readonly ReachedCard[];
|
|
404
|
+
/** The data variables the filter reaches (DV-D30), listed under one Variables band. */
|
|
405
|
+
variables: readonly ReachedVariableTarget[];
|
|
375
406
|
/** One group per reached tab, in dashboard tab order; rows in `cards` order. */
|
|
376
407
|
groups: DashboardFilterMappingGroup[];
|
|
377
408
|
summary: DashboardFilterMappingStatusSummary;
|
|
@@ -8,6 +8,8 @@ import { DataSource, Field } from '../types/explorer-types.js';
|
|
|
8
8
|
import { DashboardFilterMappingDraft, DashboardFilterMappingIssue } from './dashboard-filter-mapping-authoring.js';
|
|
9
9
|
import { DashboardInputRuntimeTarget } from './dashboard-input-values.js';
|
|
10
10
|
import { DefaultsCalendar } from '../utils/filter-default-value-utils.js';
|
|
11
|
+
/** What the namespace owner reads to name a new or renamed input. */
|
|
12
|
+
type NameSpaceDashboard = Pick<TDashboard, 'inputs' | 'filters' | 'controls' | 'sheets' | 'variables'>;
|
|
11
13
|
/**
|
|
12
14
|
* Filter settings (one filter model M4, SPEC 4.5): every settings write of a
|
|
13
15
|
* filter input, in one transaction. `applyFilterSettingsChange` is the pure
|
|
@@ -106,7 +108,8 @@ export declare function buildFilterInputFromField(params: {
|
|
|
106
108
|
connectionId?: string;
|
|
107
109
|
connectionType?: string;
|
|
108
110
|
scope: DashboardInputScope;
|
|
109
|
-
|
|
111
|
+
/** The dashboard the input joins: its name is unique in the one namespace (DV-D18). */
|
|
112
|
+
dashboard: NameSpaceDashboard;
|
|
110
113
|
createId?: () => string;
|
|
111
114
|
/** The filter's label (and variable name); default the field's label. */
|
|
112
115
|
label?: string;
|
|
@@ -122,7 +125,8 @@ export declare function buildFilterInputFromDefinition(params: {
|
|
|
122
125
|
filter: TFilter;
|
|
123
126
|
label?: string;
|
|
124
127
|
scope: DashboardInputScope;
|
|
125
|
-
|
|
128
|
+
/** The dashboard the input joins: its name is unique in the one namespace (DV-D18). */
|
|
129
|
+
dashboard: NameSpaceDashboard;
|
|
126
130
|
createId?: () => string;
|
|
127
131
|
}): EmbeddedFilterDashboardInput;
|
|
128
132
|
/** The pure core (SPEC 4.5). Never partially applies. */
|
|
@@ -199,3 +203,4 @@ export declare function applyFilterAuthoringSettingsToStorage(params: {
|
|
|
199
203
|
input: Pick<DashboardInput, 'id' | 'runtimeScope'>;
|
|
200
204
|
settings?: ReturnType<typeof resolveFilterAuthoringSettings>;
|
|
201
205
|
}): DashboardFilterStorageState;
|
|
206
|
+
export {};
|
|
@@ -13,6 +13,8 @@ import { TDashboard } from '../types/common-types.js';
|
|
|
13
13
|
* input ids before the upgrade (`upgradeToStoredDashboard`, ledger P5-11).
|
|
14
14
|
* Last, every Pivot and Hierarchical card the converter can carry exactly
|
|
15
15
|
* loads as a Matrix card (pivot-aggregate-to-matrix PM-D1, PM-D3): in memory
|
|
16
|
-
* only, stored as Matrix when someone saves.
|
|
16
|
+
* only, stored as Matrix when someone saves. First of all, older text cards'
|
|
17
|
+
* input refs are read as `input` (data variables DV-D12), so no runtime sees
|
|
18
|
+
* the old shape.
|
|
17
19
|
*/
|
|
18
|
-
export declare function prepareLoadedDashboard<TDashboardShape extends TDashboard>(
|
|
20
|
+
export declare function prepareLoadedDashboard<TDashboardShape extends TDashboard>(received: TDashboardShape): TDashboardShape;
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import { DataVariable, TextVariablePresentation } from '../types/common-types.js';
|
|
2
|
+
import { TemporalTextPresentationContext } from '../text-variables/temporal-input-text.js';
|
|
3
|
+
import { VariableAnswer, VariableCell } from '../../shared/dashboard-authoring/dashboard-variable-card.js';
|
|
4
|
+
import { ResolvedVariable, VariableCatalogEntry } from './types.js';
|
|
5
|
+
import { ComparisonUnavailableReason } from '../../shared/analytics-protocol/metric-comparison.js';
|
|
6
|
+
type DataEntry = Extract<VariableCatalogEntry, {
|
|
7
|
+
kind: 'data';
|
|
8
|
+
}>;
|
|
9
|
+
/**
|
|
10
|
+
* A compared variable's answer as the variable dialog previews it, in the
|
|
11
|
+
* chip's own readings (the Show control's): the value, the previous value and
|
|
12
|
+
* the change ("$412", "$389", "up 6%"). `unavailable` with the server's
|
|
13
|
+
* reason when there is no comparison here (P3b-05), `noPrevious` when the
|
|
14
|
+
* earlier period has nothing; undefined for a variable without a comparison.
|
|
15
|
+
*/
|
|
16
|
+
export declare function comparisonReading(variable: DataVariable, answer: VariableAnswer, context: TemporalTextPresentationContext): {
|
|
17
|
+
value: string;
|
|
18
|
+
previous: string;
|
|
19
|
+
change: string;
|
|
20
|
+
} | {
|
|
21
|
+
unavailable: ComparisonUnavailableReason;
|
|
22
|
+
} | 'noPrevious' | undefined;
|
|
23
|
+
/** One cell as the reader sees it. */
|
|
24
|
+
export declare function formatVariableCell(cell: VariableCell, presentation: TextVariablePresentation | undefined, context: TemporalTextPresentationContext): string;
|
|
25
|
+
/**
|
|
26
|
+
* A chip's presentation over its variable's (P3a-08, P3a-34): field by field,
|
|
27
|
+
* and the words of units and sign words box by box, so a box the chip leaves
|
|
28
|
+
* empty reads the variable's word, as the control's placeholder shows it.
|
|
29
|
+
*/
|
|
30
|
+
export declare function chipOverVariable(chip: TextVariablePresentation | undefined, variable: TextVariablePresentation | undefined): TextVariablePresentation | undefined;
|
|
31
|
+
/** A data ref resolved against the place's answers. */
|
|
32
|
+
export declare function resolveDataAnswer(entry: DataEntry, part: string, answer: VariableAnswer | undefined, presentation: TextVariablePresentation | undefined, context: TemporalTextPresentationContext): ResolvedVariable;
|
|
33
|
+
export {};
|
|
@@ -0,0 +1,207 @@
|
|
|
1
|
+
import { ControlDefinition, ControlOption, DashboardInputExportKey, DataVariable, DocumentInputDefinition, ReportValueKey, ResolvedDashboardInput, TextVariablePresentation, VariableRef } from '../types/common-types.js';
|
|
2
|
+
import { TFilterValue } from '../../components/surfboard/filter/types.js';
|
|
3
|
+
import { TemporalTextPresentationContext } from '../text-variables/temporal-input-text.js';
|
|
4
|
+
import { TextVariableChipFace } from '../text-variables/text-variable-types.js';
|
|
5
|
+
import { TemporalInputValue } from '../../shared/format-utils/temporal-input-presentation.js';
|
|
6
|
+
import { VariableAnswer, VariableCell } from '../../shared/dashboard-authoring/dashboard-variable-card.js';
|
|
7
|
+
/** Where text sits. A data variable is derived once per place that references it (DV-D29). */
|
|
8
|
+
export type VariablePlace = {
|
|
9
|
+
kind: 'sheet';
|
|
10
|
+
sheetId: string;
|
|
11
|
+
} | {
|
|
12
|
+
kind: 'document';
|
|
13
|
+
sheetId: string;
|
|
14
|
+
};
|
|
15
|
+
/** One reference to a variable at a place (data variables 1a collects them). */
|
|
16
|
+
export type VariableReference = {
|
|
17
|
+
ref: VariableRef;
|
|
18
|
+
place: VariablePlace;
|
|
19
|
+
where: {
|
|
20
|
+
kind: 'card';
|
|
21
|
+
cardId: string;
|
|
22
|
+
} | {
|
|
23
|
+
kind: 'header' | 'footer';
|
|
24
|
+
blockId: string;
|
|
25
|
+
} | {
|
|
26
|
+
kind: 'section';
|
|
27
|
+
sectionId: string;
|
|
28
|
+
};
|
|
29
|
+
};
|
|
30
|
+
/**
|
|
31
|
+
* The inputs a place's text can name. A text card's are its target's
|
|
32
|
+
* resolved inputs, as today; a Document's are its input bar's.
|
|
33
|
+
*/
|
|
34
|
+
export type CatalogInputs = {
|
|
35
|
+
kind: 'card';
|
|
36
|
+
inputs: readonly ResolvedDashboardInput[];
|
|
37
|
+
} | {
|
|
38
|
+
kind: 'document';
|
|
39
|
+
inputs: readonly DocumentInputDefinition[];
|
|
40
|
+
};
|
|
41
|
+
/** One input as text sees it: its value, and the definition that formats it. */
|
|
42
|
+
export type CatalogInput = {
|
|
43
|
+
id: string;
|
|
44
|
+
label: string;
|
|
45
|
+
variableName: string;
|
|
46
|
+
/** Picks the chip's icon and the picker's group. */
|
|
47
|
+
valueKind: 'filter' | 'date' | 'control';
|
|
48
|
+
temporal: boolean;
|
|
49
|
+
/** Parts the input's definition adds to its defaults. */
|
|
50
|
+
savedExports: readonly string[];
|
|
51
|
+
} & ({
|
|
52
|
+
kind: 'filter';
|
|
53
|
+
dataType?: string;
|
|
54
|
+
} | {
|
|
55
|
+
kind: 'control';
|
|
56
|
+
control: ControlDefinition;
|
|
57
|
+
});
|
|
58
|
+
export type VariableCatalogEntry = {
|
|
59
|
+
kind: 'input';
|
|
60
|
+
key: string;
|
|
61
|
+
name: string;
|
|
62
|
+
label: string;
|
|
63
|
+
input: CatalogInput;
|
|
64
|
+
/** Every part the input has, in order. */
|
|
65
|
+
parts: readonly DashboardInputExportKey[];
|
|
66
|
+
defaultPart: 'label';
|
|
67
|
+
group: 'filters' | 'controls';
|
|
68
|
+
} | {
|
|
69
|
+
kind: 'report';
|
|
70
|
+
key: string;
|
|
71
|
+
name: ReportValueKey;
|
|
72
|
+
label: string;
|
|
73
|
+
reportKey: ReportValueKey;
|
|
74
|
+
group: 'report';
|
|
75
|
+
} | {
|
|
76
|
+
kind: 'data';
|
|
77
|
+
key: string;
|
|
78
|
+
name: string;
|
|
79
|
+
label: string;
|
|
80
|
+
variable: DataVariable;
|
|
81
|
+
/** Its parts as the query names them; a SQL variable's come with its answer. */
|
|
82
|
+
parts: readonly string[];
|
|
83
|
+
defaultPart: string;
|
|
84
|
+
group: 'data';
|
|
85
|
+
/** Text at this place already uses it: listed first in the picker (DV-D3). */
|
|
86
|
+
usedHere: boolean;
|
|
87
|
+
};
|
|
88
|
+
/** Everything text at a place may name: its inputs, the dashboard's data variables and its report values. */
|
|
89
|
+
export type VariableCatalog = {
|
|
90
|
+
entries: readonly VariableCatalogEntry[];
|
|
91
|
+
/** `input:<id>`, `data:<id>`, `report:<key>`. */
|
|
92
|
+
byKey: ReadonlyMap<string, VariableCatalogEntry>;
|
|
93
|
+
/** An input's variable name; a report key unless an input holds that name. */
|
|
94
|
+
byName: ReadonlyMap<string, VariableCatalogEntry>;
|
|
95
|
+
};
|
|
96
|
+
/** What the printer knows. A dashboard tab has no pages. */
|
|
97
|
+
export type ReportValues = {
|
|
98
|
+
generatedAt: string;
|
|
99
|
+
timezone?: string;
|
|
100
|
+
generatedAtFormat?: string;
|
|
101
|
+
pageNumber?: number;
|
|
102
|
+
pageCount?: number;
|
|
103
|
+
/** The canvas has rows still to load, so the count reads "8+". */
|
|
104
|
+
pageCountIsPartial?: boolean;
|
|
105
|
+
};
|
|
106
|
+
/** A place's input values, from whichever runtime the place has. */
|
|
107
|
+
export type PlaceInputs = {
|
|
108
|
+
kind: 'card';
|
|
109
|
+
inputs: readonly ResolvedDashboardInput[];
|
|
110
|
+
/** Option labels the place has loaded, by input id. */
|
|
111
|
+
controlOptions?: Readonly<Record<string, ControlOption[]>>;
|
|
112
|
+
} | {
|
|
113
|
+
kind: 'document';
|
|
114
|
+
inputs: readonly DocumentInputDefinition[];
|
|
115
|
+
filterValues: Readonly<Record<string, TFilterValue | undefined>>;
|
|
116
|
+
controlValues: Readonly<Record<string, unknown>>;
|
|
117
|
+
controlOptions?: Readonly<Record<string, ControlOption[]>>;
|
|
118
|
+
};
|
|
119
|
+
/** One input's text, resolved once per context. */
|
|
120
|
+
export type InputText = {
|
|
121
|
+
exports: Readonly<Partial<Record<DashboardInputExportKey, string | number | boolean | null>>>;
|
|
122
|
+
/** A date input's value, formatted per reader at render. */
|
|
123
|
+
temporal?: TemporalInputValue;
|
|
124
|
+
};
|
|
125
|
+
/** The data variables' answers at a place (DV-D32), by variable id. */
|
|
126
|
+
export type VariableAnswers = {
|
|
127
|
+
byId: ReadonlyMap<string, VariableAnswer>;
|
|
128
|
+
/** Some referenced variable is still loading (print readiness). */
|
|
129
|
+
pending: boolean;
|
|
130
|
+
};
|
|
131
|
+
export type VariableTextContext = {
|
|
132
|
+
catalog: VariableCatalog;
|
|
133
|
+
inputs: ReadonlyMap<string, InputText>;
|
|
134
|
+
report: ReportValues;
|
|
135
|
+
answers: VariableAnswers;
|
|
136
|
+
presentation: TemporalTextPresentationContext;
|
|
137
|
+
};
|
|
138
|
+
export type ResolvedVariable = {
|
|
139
|
+
status: 'text';
|
|
140
|
+
text: string;
|
|
141
|
+
entry: VariableCatalogEntry;
|
|
142
|
+
part: string | null;
|
|
143
|
+
cell?: VariableCell;
|
|
144
|
+
/**
|
|
145
|
+
* The value in its canonical form, never as a reader sees it (data
|
|
146
|
+
* variables P4-16): a data cell's value, a list's items joined with a
|
|
147
|
+
* comma, an input part as the input's text holds it (a date as its ISO
|
|
148
|
+
* bound), a report value as stored. A link's address carries it.
|
|
149
|
+
*/
|
|
150
|
+
raw: string | number | boolean | null;
|
|
151
|
+
/** A chip's colours by rule (DV-D23): both renderers apply them. */
|
|
152
|
+
style?: VariableTextStyle;
|
|
153
|
+
} | {
|
|
154
|
+
status: 'loading';
|
|
155
|
+
entry: VariableCatalogEntry;
|
|
156
|
+
}
|
|
157
|
+
/** No answer to show: readers see the variable's empty text or nothing (DV-D27). */
|
|
158
|
+
| {
|
|
159
|
+
status: 'none';
|
|
160
|
+
entry: VariableCatalogEntry;
|
|
161
|
+
/** `noWindow`: a comparison part where no date window reaches the place (P3b-05). */
|
|
162
|
+
why: 'noRows' | 'moreThanOne' | 'held' | 'failed' | 'noWindow';
|
|
163
|
+
detail?: string;
|
|
164
|
+
} | {
|
|
165
|
+
status: 'broken';
|
|
166
|
+
label: string;
|
|
167
|
+
why: 'unknownVariable' | 'unknownPart' | 'noPages' | 'queryBroken';
|
|
168
|
+
/** The variable, when it still exists (a data variable's empty text applies). */
|
|
169
|
+
entry?: VariableCatalogEntry;
|
|
170
|
+
};
|
|
171
|
+
/** A value's colours by rule: a text and a background colour (P3b-06). */
|
|
172
|
+
export type VariableTextStyle = {
|
|
173
|
+
color?: string;
|
|
174
|
+
backgroundColor?: string;
|
|
175
|
+
};
|
|
176
|
+
/** A run of rendered text: the reader's words, or a variable's value. */
|
|
177
|
+
export type RenderedTextPart = {
|
|
178
|
+
type: 'text' | 'variable';
|
|
179
|
+
value: string;
|
|
180
|
+
format?: {
|
|
181
|
+
bold?: boolean;
|
|
182
|
+
italic?: boolean;
|
|
183
|
+
underline?: boolean;
|
|
184
|
+
};
|
|
185
|
+
/** A variable's colours by rule (DV-D23). */
|
|
186
|
+
style?: VariableTextStyle;
|
|
187
|
+
/** The address of the link the part sits in, its variables filled (DV-D24). */
|
|
188
|
+
href?: string;
|
|
189
|
+
/** Authoring: how a variable reads as a chip. */
|
|
190
|
+
chip?: TextVariableChipFace;
|
|
191
|
+
/** A data variable still loading: readers see a short placeholder (DV-D27). */
|
|
192
|
+
loading?: boolean;
|
|
193
|
+
/** Authoring: a wording block, read as its face (DV-D20). */
|
|
194
|
+
wording?: boolean;
|
|
195
|
+
};
|
|
196
|
+
export type RenderedText = {
|
|
197
|
+
parts: RenderedTextPart[];
|
|
198
|
+
/** The reader's text, for plain-text uses and height estimates. */
|
|
199
|
+
plain: string;
|
|
200
|
+
/** A data variable in this text is still loading (print readiness, DV-D32). */
|
|
201
|
+
pending: boolean;
|
|
202
|
+
};
|
|
203
|
+
/** A stored variable inline, as both text shapes hold it. */
|
|
204
|
+
export type StoredVariableInline = {
|
|
205
|
+
ref: VariableRef;
|
|
206
|
+
presentation?: TextVariablePresentation;
|
|
207
|
+
};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { DocumentDefinition, DocumentKpiSection, DocumentSection, DocumentTableSection, DocumentTextContent, DocumentTextStyle, TCard, TDashboard } from '../types/common-types.js';
|
|
1
|
+
import { DocumentDefinition, DocumentKpiSection, DocumentSection, DocumentTableSection, DocumentTextContent, DocumentTextRegionBlock, DocumentTextStyle, TCard, TDashboard } from '../types/common-types.js';
|
|
2
2
|
import { Field } from '../types/explorer-types.js';
|
|
3
3
|
import { DashboardCardLocation } from '../../shared/dashboard-authoring/document-section-cards.js';
|
|
4
4
|
import { DocumentPanelTarget } from './document-panel-target.js';
|
|
@@ -41,6 +41,18 @@ export type DocumentEdit = {
|
|
|
41
41
|
sectionId: string;
|
|
42
42
|
content: DocumentTextContent;
|
|
43
43
|
style?: DocumentTextStyle;
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* A header or footer line by its role (data variables spec S-4): the
|
|
47
|
+
* region panels and the MCP's `document.text` operation write a line here.
|
|
48
|
+
* A missing region is created enabled; a missing line is added.
|
|
49
|
+
*/
|
|
50
|
+
| {
|
|
51
|
+
type: 'updateRegionText';
|
|
52
|
+
region: 'header' | 'footer';
|
|
53
|
+
role: DocumentRegionTextRole;
|
|
54
|
+
content: DocumentTextContent;
|
|
55
|
+
style?: DocumentTextStyle;
|
|
44
56
|
} | {
|
|
45
57
|
type: 'updateTableOptions';
|
|
46
58
|
sectionId: string;
|
|
@@ -76,6 +88,9 @@ export type DocumentEdit = {
|
|
|
76
88
|
cardId: string;
|
|
77
89
|
toIndex: number;
|
|
78
90
|
};
|
|
91
|
+
export type DocumentRegionTextRole = NonNullable<DocumentTextRegionBlock['role']>;
|
|
92
|
+
/** The lines each region has, by role: what `updateRegionText` accepts. */
|
|
93
|
+
export declare const DOCUMENT_REGION_TEXT_ROLES: Record<'header' | 'footer', readonly DocumentRegionTextRole[]>;
|
|
79
94
|
export type DocumentEditResult = {
|
|
80
95
|
document: DocumentDefinition;
|
|
81
96
|
/** Where the panel goes next: the inserted, moved or edited section, or a removed section's neighbor. */
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import { TFilterValue } from '../../components/surfboard/filter/types.js';
|
|
2
|
+
import { DashboardCardQueryOptions } from '../hooks/use-dashboard-frame-query.js';
|
|
3
|
+
import { ControlDefinition, DashboardInputValues } from '../types/common-types.js';
|
|
4
|
+
import { TableTotalsRequest } from '../types/explorer-types.js';
|
|
5
|
+
/** Inputs, filters and controls the Document sheet has already resolved for its sections. */
|
|
6
|
+
export type DocumentSectionRuntime = {
|
|
7
|
+
documentFilterValues: TFilterValue[];
|
|
8
|
+
documentControlDefinitions: ControlDefinition[];
|
|
9
|
+
documentControlValues: Record<string, unknown>;
|
|
10
|
+
documentDashboardInputValues?: DashboardInputValues;
|
|
11
|
+
};
|
|
12
|
+
/**
|
|
13
|
+
* Query options for every card of a Document section, so table and KPI
|
|
14
|
+
* sections run their cards in the same section runtime: section-scoped inputs,
|
|
15
|
+
* document filter and control values, and no carried dashboard context. A
|
|
16
|
+
* data variable in the Document's text runs in the same runtime with its
|
|
17
|
+
* sheet and no section (data variables DV-D29).
|
|
18
|
+
*/
|
|
19
|
+
export declare function buildDocumentSectionQueryOptions({ sheetId, sectionId, runtime, tableTotalsRequest, }: {
|
|
20
|
+
/** The Document tab; a section's cards run at the selected tab when absent. */
|
|
21
|
+
sheetId?: string;
|
|
22
|
+
/** Absent for the Document's text: no section's scoped inputs reach it. */
|
|
23
|
+
sectionId?: string;
|
|
24
|
+
runtime: DocumentSectionRuntime;
|
|
25
|
+
/** Flat-table grand totals; table sections only. */
|
|
26
|
+
tableTotalsRequest?: TableTotalsRequest;
|
|
27
|
+
}): DashboardCardQueryOptions;
|
|
28
|
+
/** The query key marker every Document section query carries. */
|
|
29
|
+
export declare const DOCUMENT_SECTION_QUERY_MARKER = "documentSection";
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import { TCard } from '../types/common-types.js';
|
|
2
2
|
export type DocumentTableDataPolicy = 'preview-window' | 'export-full-with-cap';
|
|
3
|
-
export declare const DOCUMENT_TABLE_EXPORT_MAX_ROWS = 10000;
|
|
4
3
|
export declare const DOCUMENT_TABLE_EXPORT_QUERY_CHUNK_SIZE = 500;
|
|
5
4
|
export declare const DOCUMENT_TABLE_PREVIEW_QUERY_CHUNK_SIZE = 250;
|
|
6
5
|
export declare function isDocumentFlatTableAcquisitionCard(card: TCard): boolean;
|