@gooddata/sdk-model 11.62.0-alpha.0 → 11.62.0-alpha.2
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/esm/genAI/chat.d.ts +9 -9
- package/esm/genAI/chat.d.ts.map +1 -1
- package/esm/index.d.ts +12 -12
- package/esm/index.d.ts.map +1 -1
- package/esm/index.js +10 -10
- package/esm/publisher/builtinPageLayouts.d.ts +45 -0
- package/esm/publisher/builtinPageLayouts.d.ts.map +1 -0
- package/esm/{reports → publisher}/builtinPageLayouts.js +19 -19
- package/esm/{reports → publisher}/content.d.ts +20 -20
- package/esm/publisher/content.d.ts.map +1 -0
- package/esm/{reports → publisher}/content.js +2 -2
- package/esm/{reports/report.d.ts → publisher/document.d.ts} +28 -28
- package/esm/publisher/document.d.ts.map +1 -0
- package/esm/{reports/report.js → publisher/document.js} +10 -10
- package/esm/publisher/factory.d.ts +65 -0
- package/esm/publisher/factory.d.ts.map +1 -0
- package/esm/{reports → publisher}/factory.js +22 -22
- package/esm/{reports → publisher}/layout.d.ts +15 -15
- package/esm/publisher/layout.d.ts.map +1 -0
- package/esm/{reports → publisher}/layout.js +4 -4
- package/esm/publisher/pageFormat.d.ts +38 -0
- package/esm/publisher/pageFormat.d.ts.map +1 -0
- package/esm/publisher/pageFormat.js +33 -0
- package/esm/{reports → publisher}/pageLayout.d.ts +28 -28
- package/esm/publisher/pageLayout.d.ts.map +1 -0
- package/esm/{reports → publisher}/pageLayout.js +18 -18
- package/esm/{reports → publisher}/slot.d.ts +48 -48
- package/esm/publisher/slot.d.ts.map +1 -0
- package/esm/publisher/slot.js +87 -0
- package/esm/{reports → publisher}/styling.d.ts +39 -39
- package/esm/publisher/styling.d.ts.map +1 -0
- package/esm/publisher/styling.js +58 -0
- package/esm/publisher/variables.d.ts +72 -0
- package/esm/publisher/variables.d.ts.map +1 -0
- package/esm/{reports → publisher}/variables.js +7 -7
- package/esm/sdk-model.d.ts +889 -858
- package/esm/settings/settings.d.ts +13 -0
- package/esm/settings/settings.d.ts.map +1 -1
- package/esm/theme/index.d.ts +68 -51
- package/esm/theme/index.d.ts.map +1 -1
- package/package.json +3 -3
- package/esm/reports/builtinPageLayouts.d.ts +0 -45
- package/esm/reports/builtinPageLayouts.d.ts.map +0 -1
- package/esm/reports/content.d.ts.map +0 -1
- package/esm/reports/factory.d.ts +0 -65
- package/esm/reports/factory.d.ts.map +0 -1
- package/esm/reports/layout.d.ts.map +0 -1
- package/esm/reports/pageFormat.d.ts +0 -38
- package/esm/reports/pageFormat.d.ts.map +0 -1
- package/esm/reports/pageFormat.js +0 -33
- package/esm/reports/pageLayout.d.ts.map +0 -1
- package/esm/reports/report.d.ts.map +0 -1
- package/esm/reports/slot.d.ts.map +0 -1
- package/esm/reports/slot.js +0 -87
- package/esm/reports/styling.d.ts.map +0 -1
- package/esm/reports/styling.js +0 -58
- package/esm/reports/variables.d.ts +0 -72
- package/esm/reports/variables.d.ts.map +0 -1
package/esm/reports/slot.js
DELETED
|
@@ -1,87 +0,0 @@
|
|
|
1
|
-
// (C) 2026 GoodData Corporation
|
|
2
|
-
import { isEmpty } from "lodash-es";
|
|
3
|
-
import { DefaultReportHeadingType, DefaultReportParagraphType, ReportHeadingTypes, ReportParagraphTypes, isReportHeadingType, isReportParagraphType, } from "./styling.js";
|
|
4
|
-
/**
|
|
5
|
-
* List of built-in report slot type names.
|
|
6
|
-
*
|
|
7
|
-
* @alpha
|
|
8
|
-
*/
|
|
9
|
-
export const BuiltInReportSlotTypes = ["visualization", "heading", "paragraph", "image"];
|
|
10
|
-
/**
|
|
11
|
-
* All sizes a text slot can be rendered at, headings first.
|
|
12
|
-
*
|
|
13
|
-
* @alpha
|
|
14
|
-
*/
|
|
15
|
-
export const ReportTextTypes = [...ReportHeadingTypes, ...ReportParagraphTypes];
|
|
16
|
-
/**
|
|
17
|
-
* Sizes the slot can be rendered at, which is what its own type decides.
|
|
18
|
-
*
|
|
19
|
-
* @alpha
|
|
20
|
-
*/
|
|
21
|
-
export function reportTextSlotTypes(slot) {
|
|
22
|
-
return slot.type === "heading" ? ReportHeadingTypes : ReportParagraphTypes;
|
|
23
|
-
}
|
|
24
|
-
/**
|
|
25
|
-
* Size the slot is rendered at.
|
|
26
|
-
*
|
|
27
|
-
* @remarks
|
|
28
|
-
* A slot states its size, and content is an open format: a size the slot cannot carry, and a size
|
|
29
|
-
* from a newer version, both fall back to the default of the slot's own type.
|
|
30
|
-
*
|
|
31
|
-
* @alpha
|
|
32
|
-
*/
|
|
33
|
-
export function reportTextSlotType(slot) {
|
|
34
|
-
const stated = slot.style?.type;
|
|
35
|
-
if (slot.type === "heading") {
|
|
36
|
-
return isReportHeadingType(stated) ? stated : DefaultReportHeadingType;
|
|
37
|
-
}
|
|
38
|
-
return isReportParagraphType(stated) ? stated : DefaultReportParagraphType;
|
|
39
|
-
}
|
|
40
|
-
/**
|
|
41
|
-
* Type-guard testing whether the provided object is an instance of {@link IReportVisualizationSlot}.
|
|
42
|
-
*
|
|
43
|
-
* @alpha
|
|
44
|
-
*/
|
|
45
|
-
export function isReportVisualizationSlot(obj) {
|
|
46
|
-
return !isEmpty(obj) && obj.type === "visualization";
|
|
47
|
-
}
|
|
48
|
-
/**
|
|
49
|
-
* Type-guard testing whether the provided object is an instance of {@link IReportHeadingSlot}.
|
|
50
|
-
*
|
|
51
|
-
* @alpha
|
|
52
|
-
*/
|
|
53
|
-
export function isReportHeadingSlot(obj) {
|
|
54
|
-
return !isEmpty(obj) && obj.type === "heading";
|
|
55
|
-
}
|
|
56
|
-
/**
|
|
57
|
-
* Type-guard testing whether the provided object is an instance of {@link IReportParagraphSlot}.
|
|
58
|
-
*
|
|
59
|
-
* @alpha
|
|
60
|
-
*/
|
|
61
|
-
export function isReportParagraphSlot(obj) {
|
|
62
|
-
return !isEmpty(obj) && obj.type === "paragraph";
|
|
63
|
-
}
|
|
64
|
-
/**
|
|
65
|
-
* Type-guard testing whether the provided object is an instance of {@link IReportTextSlot}.
|
|
66
|
-
*
|
|
67
|
-
* @alpha
|
|
68
|
-
*/
|
|
69
|
-
export function isReportTextSlot(obj) {
|
|
70
|
-
return isReportHeadingSlot(obj) || isReportParagraphSlot(obj);
|
|
71
|
-
}
|
|
72
|
-
/**
|
|
73
|
-
* Type-guard testing whether the provided object is an instance of {@link IReportImageSlot}.
|
|
74
|
-
*
|
|
75
|
-
* @alpha
|
|
76
|
-
*/
|
|
77
|
-
export function isReportImageSlot(obj) {
|
|
78
|
-
return !isEmpty(obj) && obj.type === "image";
|
|
79
|
-
}
|
|
80
|
-
/**
|
|
81
|
-
* Type-guard testing whether the provided object is an instance of {@link ReportSlot}.
|
|
82
|
-
*
|
|
83
|
-
* @alpha
|
|
84
|
-
*/
|
|
85
|
-
export function isReportSlot(obj) {
|
|
86
|
-
return [isReportVisualizationSlot, isReportTextSlot, isReportImageSlot].some((guard) => guard(obj));
|
|
87
|
-
}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"styling.d.ts","sourceRoot":"","sources":["../../src/reports/styling.ts"],"names":[],"mappings":"AAIA;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG,OAAO,GAAG,QAAQ,GAAG,KAAK,CAAC;AAEhE;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACnC,IAAI,EAAE,OAAO,CAAC;IAEd;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACnC,IAAI,EAAE,OAAO,CAAC;IAEd;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,sBAAsB,GAAG,sBAAsB,CAAC;AAE/E;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC5B,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAE9B;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;AAExE;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG,WAAW,GAAG,YAAY,GAAG,WAAW,CAAC;AAE3E;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;AAErE;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,EAAE,iBAAiB,EAAyC,CAAC;AAE5F;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,EAAE,mBAAmB,EAA6C,CAAC;AAEpG;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,EAAE,iBAAwB,CAAC;AAEhE;;;;GAIG;AACH,eAAO,MAAM,0BAA0B,EAAE,mBAAkC,CAAC;AAE5E;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,iBAAiB,CAE9E;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,mBAAmB,CAElF;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACrD;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,eAAe,CAAC,EAAE,sBAAsB,CAAC;IAEzC,aAAa,CAAC,EAAE,sBAAsB,CAAC;CAC1C;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IACzD;;;OAGG;IACH,IAAI,CAAC,EAAE,iBAAiB,CAAC;CAC5B;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC3D;;OAEG;IACH,IAAI,CAAC,EAAE,mBAAmB,CAAC;CAC9B;AAED;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAC9B,eAAe,CAAC,EAAE,sBAAsB,CAAC;IAEzC,aAAa,CAAC,EAAE,sBAAsB,CAAC;CAC1C;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,sBAAsB,CAEnF;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,sBAAsB,CAEnF"}
|
package/esm/reports/styling.js
DELETED
|
@@ -1,58 +0,0 @@
|
|
|
1
|
-
// (C) 2026 GoodData Corporation
|
|
2
|
-
import { isEmpty } from "lodash-es";
|
|
3
|
-
/**
|
|
4
|
-
* All heading sizes, largest first.
|
|
5
|
-
*
|
|
6
|
-
* @alpha
|
|
7
|
-
*/
|
|
8
|
-
export const ReportHeadingTypes = ["h1", "h2", "h3", "h4", "h5", "h6"];
|
|
9
|
-
/**
|
|
10
|
-
* All paragraph sizes, largest first.
|
|
11
|
-
*
|
|
12
|
-
* @alpha
|
|
13
|
-
*/
|
|
14
|
-
export const ReportParagraphTypes = ["largeText", "normalText", "smallText"];
|
|
15
|
-
/**
|
|
16
|
-
* Size a heading slot that states none is rendered at.
|
|
17
|
-
*
|
|
18
|
-
* @alpha
|
|
19
|
-
*/
|
|
20
|
-
export const DefaultReportHeadingType = "h1";
|
|
21
|
-
/**
|
|
22
|
-
* Size a paragraph slot that states none is rendered at.
|
|
23
|
-
*
|
|
24
|
-
* @alpha
|
|
25
|
-
*/
|
|
26
|
-
export const DefaultReportParagraphType = "normalText";
|
|
27
|
-
/**
|
|
28
|
-
* Type-guard testing whether the value is a {@link ReportHeadingType}.
|
|
29
|
-
*
|
|
30
|
-
* @alpha
|
|
31
|
-
*/
|
|
32
|
-
export function isReportHeadingType(value) {
|
|
33
|
-
return ReportHeadingTypes.includes(value);
|
|
34
|
-
}
|
|
35
|
-
/**
|
|
36
|
-
* Type-guard testing whether the value is a {@link ReportParagraphType}.
|
|
37
|
-
*
|
|
38
|
-
* @alpha
|
|
39
|
-
*/
|
|
40
|
-
export function isReportParagraphType(value) {
|
|
41
|
-
return ReportParagraphTypes.includes(value);
|
|
42
|
-
}
|
|
43
|
-
/**
|
|
44
|
-
* Type-guard testing whether the provided object is an instance of {@link IReportColorBackground}.
|
|
45
|
-
*
|
|
46
|
-
* @alpha
|
|
47
|
-
*/
|
|
48
|
-
export function isReportColorBackground(obj) {
|
|
49
|
-
return !isEmpty(obj) && obj.type === "color";
|
|
50
|
-
}
|
|
51
|
-
/**
|
|
52
|
-
* Type-guard testing whether the provided object is an instance of {@link IReportImageBackground}.
|
|
53
|
-
*
|
|
54
|
-
* @alpha
|
|
55
|
-
*/
|
|
56
|
-
export function isReportImageBackground(obj) {
|
|
57
|
-
return !isEmpty(obj) && obj.type === "image";
|
|
58
|
-
}
|
|
@@ -1,72 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* ISO 8601 calendar date (YYYY-MM-DD).
|
|
3
|
-
*
|
|
4
|
-
* @alpha
|
|
5
|
-
*/
|
|
6
|
-
export type ReportDateString = string;
|
|
7
|
-
/**
|
|
8
|
-
* Variables resolved by the rendering runtime; they are never declared or stored.
|
|
9
|
-
*
|
|
10
|
-
* @remarks
|
|
11
|
-
* Referenced from report text as `{name}`. Custom variable names must not collide with these;
|
|
12
|
-
* on collision the built-in wins.
|
|
13
|
-
*
|
|
14
|
-
* @alpha
|
|
15
|
-
*/
|
|
16
|
-
export type ReportBuiltInVariable = "reportName" | "reportDescription" | "periodStart" | "periodEnd" | "reportDateRange" | "reportAttributeFilters" | "exportedAt" | "exportedBy" | "lastModifiedAt" | "lastModifiedBy" | "workspaceName" | "workspaceId" | "totalPages" | "currentPageNumber" | "logo";
|
|
17
|
-
/**
|
|
18
|
-
* All built-in report variable names.
|
|
19
|
-
*
|
|
20
|
-
* @alpha
|
|
21
|
-
*/
|
|
22
|
-
export declare const ReportBuiltInVariables: ReportBuiltInVariable[];
|
|
23
|
-
/**
|
|
24
|
-
* A custom variable declared by report content and given a value by a report.
|
|
25
|
-
*
|
|
26
|
-
* @remarks
|
|
27
|
-
* Referenced from text as `{name}`. Values come from {@link IReportBase.variableValues},
|
|
28
|
-
* falling back to {@link IReportVariableDefinition.defaultValue}.
|
|
29
|
-
*
|
|
30
|
-
* @alpha
|
|
31
|
-
*/
|
|
32
|
-
export interface IReportVariableDefinition {
|
|
33
|
-
/**
|
|
34
|
-
* Variable name as used inside the `{...}` marker. Must match /^[a-zA-Z][a-zA-Z0-9_]*$/.
|
|
35
|
-
* Built-in names ({@link ReportBuiltInVariable}) are reserved.
|
|
36
|
-
*/
|
|
37
|
-
name: string;
|
|
38
|
-
/**
|
|
39
|
-
* Human readable label shown in the editor.
|
|
40
|
-
*/
|
|
41
|
-
title?: string;
|
|
42
|
-
description?: string;
|
|
43
|
-
/**
|
|
44
|
-
* Value used when the report does not provide one. May not contain further
|
|
45
|
-
* placeholders — there is no recursive expansion.
|
|
46
|
-
*/
|
|
47
|
-
defaultValue?: string;
|
|
48
|
-
}
|
|
49
|
-
/**
|
|
50
|
-
* The marker referencing the named variable from report text.
|
|
51
|
-
*
|
|
52
|
-
* @alpha
|
|
53
|
-
*/
|
|
54
|
-
export declare function reportTextPlaceholder(name: string): string;
|
|
55
|
-
/**
|
|
56
|
-
* Collects the distinct `{variable}` names referenced in the text, in order of first occurrence.
|
|
57
|
-
*
|
|
58
|
-
* @alpha
|
|
59
|
-
*/
|
|
60
|
-
export declare function getReportTextPlaceholders(text: string): string[];
|
|
61
|
-
/**
|
|
62
|
-
* Replaces `{variable}` markers with values. Markers with no value are left as-is.
|
|
63
|
-
* Values are inserted verbatim — there is no recursive expansion.
|
|
64
|
-
*
|
|
65
|
-
* @remarks
|
|
66
|
-
* A marker resolves wherever it appears, braces around it included, so there is no escape for a
|
|
67
|
-
* literal `{name}` in report text.
|
|
68
|
-
*
|
|
69
|
-
* @alpha
|
|
70
|
-
*/
|
|
71
|
-
export declare function resolveReportTextPlaceholders(text: string, values: Record<string, string>): string;
|
|
72
|
-
//# sourceMappingURL=variables.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"variables.d.ts","sourceRoot":"","sources":["../../src/reports/variables.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAEtC;;;;;;;;GAQG;AACH,MAAM,MAAM,qBAAqB,GAC3B,YAAY,GACZ,mBAAmB,GACnB,aAAa,GACb,WAAW,GACX,iBAAiB,GACjB,wBAAwB,GACxB,YAAY,GACZ,YAAY,GACZ,gBAAgB,GAChB,gBAAgB,GAChB,eAAe,GACf,aAAa,GACb,YAAY,GACZ,mBAAmB,GACnB,MAAM,CAAC;AAEb;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,EAAE,qBAAqB,EAgBzD,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,WAAW,yBAAyB;IACtC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB;AAID;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE1D;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAShE;AAED;;;;;;;;;GASG;AACH,wBAAgB,6BAA6B,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,CAIlG"}
|