@gooddata/sdk-model 11.57.0-alpha.5 → 11.57.0-alpha.7

package/esm/reports/slot.js

@@ -1,25 +1,42 @@
 // (C) 2026 GoodData Corporation
 import { isEmpty } from "lodash-es";
+import { DefaultReportHeadingType, DefaultReportParagraphType, ReportHeadingTypes, ReportParagraphTypes, isReportHeadingType, isReportParagraphType, } from "./styling.js";
 /**
  * List of built-in report slot type names.
  *
  * @alpha
  */
-export const BuiltInReportSlotTypes = ["visualization", "text", "image"];
+export const BuiltInReportSlotTypes = ["visualization", "heading", "paragraph", "image"];
 /**
- * All semantic kinds a text slot can carry.
+ * All sizes a text slot can be rendered at, headings first.
  *
  * @alpha
  */
-export const BuiltInReportTextSlotKinds = [
-    "title",
-    "subtitle",
-    "sectionTitle",
-    "description",
-    "summary",
-    "body",
-    "custom",
-];
+export const ReportTextTypes = [...ReportHeadingTypes, ...ReportParagraphTypes];
+/**
+ * Sizes the slot can be rendered at, which is what its own type decides.
+ *
+ * @alpha
+ */
+export function reportTextSlotTypes(slot) {
+    return slot.type === "heading" ? ReportHeadingTypes : ReportParagraphTypes;
+}
+/**
+ * Size the slot is rendered at.
+ *
+ * @remarks
+ * A slot states its size, and content is an open format: a size the slot cannot carry, and a size
+ * from a newer version, both fall back to the default of the slot's own type.
+ *
+ * @alpha
+ */
+export function reportTextSlotType(slot) {
+    const stated = slot.style?.type;
+    if (slot.type === "heading") {
+        return isReportHeadingType(stated) ? stated : DefaultReportHeadingType;
+    }
+    return isReportParagraphType(stated) ? stated : DefaultReportParagraphType;
+}
 /**
  * Type-guard testing whether the provided object is an instance of {@link IReportVisualizationSlot}.
  *
@@ -28,13 +45,29 @@ export const BuiltInReportTextSlotKinds = [
 export function isReportVisualizationSlot(obj) {
     return !isEmpty(obj) && obj.type === "visualization";
 }
+/**
+ * Type-guard testing whether the provided object is an instance of {@link IReportHeadingSlot}.
+ *
+ * @alpha
+ */
+export function isReportHeadingSlot(obj) {
+    return !isEmpty(obj) && obj.type === "heading";
+}
+/**
+ * Type-guard testing whether the provided object is an instance of {@link IReportParagraphSlot}.
+ *
+ * @alpha
+ */
+export function isReportParagraphSlot(obj) {
+    return !isEmpty(obj) && obj.type === "paragraph";
+}
 /**
  * Type-guard testing whether the provided object is an instance of {@link IReportTextSlot}.
  *
  * @alpha
  */
 export function isReportTextSlot(obj) {
-    return !isEmpty(obj) && obj.type === "text";
+    return isReportHeadingSlot(obj) || isReportParagraphSlot(obj);
 }
 /**
  * Type-guard testing whether the provided object is an instance of {@link IReportImageSlot}.

package/esm/reports/styling.d.ts

@@ -60,11 +60,63 @@ export interface IReportBoxStyle {
     padding?: number;
 }
 /**
- * Styling of a text slot: the paint of its box, plus the ink and placement of the text it owns.
+ * Size a heading is rendered at. Each size is styled by the matching theme text level
+ * (`reports.textStyle.heading.h1` ...).
+ *
+ * @alpha
+ */
+export type ReportHeadingType = "h1" | "h2" | "h3" | "h4" | "h5" | "h6";
+/**
+ * Size a paragraph is rendered at. Each size is styled by the matching theme text level
+ * (`reports.textStyle.paragraph.largeText` ...).
+ *
+ * @alpha
+ */
+export type ReportParagraphType = "largeText" | "normalText" | "smallText";
+/**
+ * Size any report text is rendered at.
+ *
+ * @alpha
+ */
+export type ReportTextType = ReportHeadingType | ReportParagraphType;
+/**
+ * All heading sizes, largest first.
  *
- * @remarks
- * Overrides the ink and placement of the slot's {@link ReportTextSlotKind} defaults; the kind
- * keeps owning semantic typography (size and weight).
+ * @alpha
+ */
+export declare const ReportHeadingTypes: ReportHeadingType[];
+/**
+ * All paragraph sizes, largest first.
+ *
+ * @alpha
+ */
+export declare const ReportParagraphTypes: ReportParagraphType[];
+/**
+ * Size a heading slot that states none is rendered at.
+ *
+ * @alpha
+ */
+export declare const DefaultReportHeadingType: ReportHeadingType;
+/**
+ * Size a paragraph slot that states none is rendered at.
+ *
+ * @alpha
+ */
+export declare const DefaultReportParagraphType: ReportParagraphType;
+/**
+ * Type-guard testing whether the value is a {@link ReportHeadingType}.
+ *
+ * @alpha
+ */
+export declare function isReportHeadingType(value: unknown): value is ReportHeadingType;
+/**
+ * Type-guard testing whether the value is a {@link ReportParagraphType}.
+ *
+ * @alpha
+ */
+export declare function isReportParagraphType(value: unknown): value is ReportParagraphType;
+/**
+ * Styling of a text slot: the paint of its box, plus the ink and placement of the text it owns.
  *
  * @alpha
  */
@@ -76,6 +128,29 @@ export interface IReportTextStyle extends IReportBoxStyle {
     horizontalAlign?: ReportContentAlignment;
     verticalAlign?: ReportContentAlignment;
 }
+/**
+ * Styling of a heading slot.
+ *
+ * @alpha
+ */
+export interface IReportHeadingStyle extends IReportTextStyle {
+    /**
+     * Defaults to {@link DefaultReportHeadingType}. The size owns the semantic typography that goes
+     * with it; the rest of the style overrides ink and placement on top of it.
+     */
+    type?: ReportHeadingType;
+}
+/**
+ * Styling of a paragraph slot.
+ *
+ * @alpha
+ */
+export interface IReportParagraphStyle extends IReportTextStyle {
+    /**
+     * Defaults to {@link DefaultReportParagraphType}.
+     */
+    type?: ReportParagraphType;
+}
 /**
  * Where the drawn image sits when it does not fill its box, and which part of it is kept when it
  * is cropped to fill one.

package/esm/reports/styling.d.ts.map

@@ -1 +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;;;;;;;;GAQG;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;;;;;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"}
+{"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

@@ -1,5 +1,45 @@
 // (C) 2026 GoodData Corporation
 import { isEmpty } from "lodash-es";
+/**
+ * All heading sizes, largest first.
+ *
+ * @alpha
+ */
+export const ReportHeadingTypes = ["h1", "h2", "h3", "h4", "h5", "h6"];
+/**
+ * All paragraph sizes, largest first.
+ *
+ * @alpha
+ */
+export const ReportParagraphTypes = ["largeText", "normalText", "smallText"];
+/**
+ * Size a heading slot that states none is rendered at.
+ *
+ * @alpha
+ */
+export const DefaultReportHeadingType = "h1";
+/**
+ * Size a paragraph slot that states none is rendered at.
+ *
+ * @alpha
+ */
+export const DefaultReportParagraphType = "normalText";
+/**
+ * Type-guard testing whether the value is a {@link ReportHeadingType}.
+ *
+ * @alpha
+ */
+export function isReportHeadingType(value) {
+    return ReportHeadingTypes.includes(value);
+}
+/**
+ * Type-guard testing whether the value is a {@link ReportParagraphType}.
+ *
+ * @alpha
+ */
+export function isReportParagraphType(value) {
+    return ReportParagraphTypes.includes(value);
+}
 /**
  * Type-guard testing whether the provided object is an instance of {@link IReportColorBackground}.
  *

package/esm/reports/variables.d.ts

@@ -13,7 +13,7 @@ export type ReportDateString = string;
  *
  * @alpha
  */
-export type ReportBuiltInVariable = "reportName" | "reportDescription" | "periodStart" | "periodEnd" | "reportDateRange" | "reportAttributeFilters" | "exportedAt" | "exportedBy" | "lastModifiedAt" | "lastModifiedBy" | "workspaceName" | "workspaceId" | "totalPages" | "currentPageNumber" | "logo" | "logoInverse";
+export type ReportBuiltInVariable = "reportName" | "reportDescription" | "periodStart" | "periodEnd" | "reportDateRange" | "reportAttributeFilters" | "exportedAt" | "exportedBy" | "lastModifiedAt" | "lastModifiedBy" | "workspaceName" | "workspaceId" | "totalPages" | "currentPageNumber" | "logo";
 /**
  * All built-in report variable names.
  *

package/esm/reports/variables.d.ts.map

@@ -1 +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,GACN,aAAa,CAAC;AAEpB;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,EAAE,qBAAqB,EAiBzD,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"}
+{"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"}

package/esm/reports/variables.js

@@ -20,7 +20,6 @@ export const ReportBuiltInVariables = [
     "totalPages",
     "currentPageNumber",
     "logo",
-    "logoInverse",
 ];
 const placeholderRegex = /\{([a-zA-Z][a-zA-Z0-9_]*)\}/g;
 /**