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

package/esm/reports/builtinPageLayouts.js

@@ -0,0 +1,196 @@
+// (C) 2026 GoodData Corporation
+import { idRef } from "../objRef/factory.js";
+const textSlot = (localIdentifier, kind, hint, content) => ({
+    type: "text",
+    localIdentifier,
+    kind,
+    ...(content === undefined ? { placeholder: { hint } } : { source: { type: "static", content } }),
+});
+const vizSlot = (localIdentifier) => ({
+    type: "visualization",
+    localIdentifier,
+    showTitle: true,
+    placeholder: { hint: "Add a visualization" },
+});
+const logoSlot = (localIdentifier) => ({
+    type: "image",
+    localIdentifier,
+    source: { type: "url", url: "{{logo}}" },
+    fit: "contain",
+    altText: "Logo",
+});
+const slot = (slotId, weight) => ({
+    type: "slotRef",
+    slotId,
+    ...(weight === undefined ? {} : { weight }),
+});
+const row = (children, weight) => ({
+    type: "section",
+    direction: "row",
+    children,
+    ...(weight === undefined ? {} : { weight }),
+});
+const column = (children, weight) => ({
+    type: "section",
+    direction: "column",
+    children,
+    ...(weight === undefined ? {} : { weight }),
+});
+const footerSlots = () => [
+    logoSlot("footerLogo"),
+    textSlot("footerPageNumber", "custom", "", "{{pageNumber}} / {{totalPages}}"),
+];
+const footerRow = () => row([slot("footerLogo", 1), slot("footerPageNumber", 8)], 1);
+const vizGrid = ({ vizRows, gridWeights }, weight) => vizRows.length === 1
+    ? row(vizRows[0].map((id, index) => slot(id, gridWeights?.[index])), weight)
+    : column(vizRows.map((ids) => row(ids.map((id) => slot(id)))), weight);
+const contentPage = (spec) => {
+    const { vizRows, summary } = spec;
+    const body = summary ? row([vizGrid(spec, 2), slot("summary", 1)], 9) : vizGrid(spec, 9);
+    return {
+        kind: "content",
+        layout: column([slot("pageTitle", 2), body, footerRow()]),
+        slots: [
+            textSlot("pageTitle", "title", "Page title"),
+            ...vizRows.flat().map(vizSlot),
+            ...(summary ? [textSlot("summary", "summary", "Add a summary")] : []),
+            ...footerSlots(),
+        ],
+    };
+};
+const vizIds = (count, perRow) => {
+    const rows = [];
+    for (let index = 0; index < count; index++) {
+        const rowIndex = Math.floor(index / perRow);
+        (rows[rowIndex] ??= []).push(`widget${index + 1}`);
+    }
+    return rows;
+};
+// Built-ins are shared singletons served by every backend implementation;
+// freezing makes accidental mutation by a consumer throw instead of corrupting them.
+function deepFreeze(value) {
+    if (value && typeof value === "object" && !Object.isFrozen(value)) {
+        Object.freeze(value);
+        for (const key of Object.keys(value)) {
+            deepFreeze(value[key]);
+        }
+    }
+    return value;
+}
+const builtInPage = (id, title, description, body) => deepFreeze({
+    type: "reportPageLayout",
+    ref: idRef(`builtin.reportPageLayout.${id}`, "reportPageLayout"),
+    title,
+    description,
+    content: { version: "1", ...body },
+    isBuiltIn: true,
+    isLocked: true,
+});
+/**
+ * Built-in cover page: report title and subtitle.
+ *
+ * @alpha
+ */
+export const BuiltInReportPageLayoutCover = builtInPage("cover", "Cover", "Title page", {
+    kind: "cover",
+    layout: column([slot("coverTitle", 2), slot("coverSubtitle", 1), footerRow()]),
+    slots: [
+        textSlot("coverTitle", "title", "Report title", "{{reportTitle}}"),
+        textSlot("coverSubtitle", "subtitle", "Subtitle", "{{periodStart}} – {{periodEnd}}"),
+        ...footerSlots(),
+    ],
+});
+/**
+ * Built-in section divider page.
+ *
+ * @alpha
+ */
+export const BuiltInReportPageLayoutSection = builtInPage("section", "Section", "Section divider page", {
+    kind: "section",
+    layout: column([slot("sectionTitle", 9), footerRow()]),
+    slots: [textSlot("sectionTitle", "sectionTitle", "Section title"), ...footerSlots()],
+});
+const contentPages = [
+    ["viz1", "1 visualization", "Single full-width visualization", { vizRows: vizIds(1, 1) }],
+    [
+        "viz1SummaryRight",
+        "1 visualization + summary",
+        "Single visualization with a summary column on the right",
+        { vizRows: vizIds(1, 1), summary: true },
+    ],
+    ["viz2", "2 visualizations", "Two visualizations side by side", { vizRows: vizIds(2, 2) }],
+    [
+        "viz2Wide",
+        "2 visualizations (wide left)",
+        "Two visualizations, the left one twice as wide",
+        { vizRows: vizIds(2, 2), gridWeights: [2, 1] },
+    ],
+    [
+        "viz2Narrow",
+        "2 visualizations (wide right)",
+        "Two visualizations, the right one twice as wide",
+        { vizRows: vizIds(2, 2), gridWeights: [1, 2] },
+    ],
+    [
+        "viz2SummaryRight",
+        "2 visualizations + summary",
+        "Two visualizations with a summary column on the right",
+        { vizRows: vizIds(2, 2), summary: true },
+    ],
+    ["viz3", "3 visualizations", "Three visualizations side by side", { vizRows: vizIds(3, 3) }],
+    [
+        "viz3SummaryRight",
+        "3 visualizations + summary",
+        "Three visualizations with a summary column on the right",
+        { vizRows: vizIds(3, 3), summary: true },
+    ],
+    ["viz4", "4 visualizations", "Four visualizations in a 2x2 grid", { vizRows: vizIds(4, 2) }],
+    [
+        "viz4SummaryRight",
+        "4 visualizations + summary",
+        "2x2 visualization grid with a summary column on the right",
+        { vizRows: vizIds(4, 2), summary: true },
+    ],
+    ["viz6", "6 visualizations", "Six visualizations in a 2x3 grid", { vizRows: vizIds(6, 2) }],
+    [
+        "viz6SummaryRight",
+        "6 visualizations + summary",
+        "3x2 visualization grid with a summary column on the right",
+        { vizRows: vizIds(6, 2), summary: true },
+    ],
+];
+/**
+ * Built-in content page with six visualizations and a text column on the left.
+ *
+ * @alpha
+ */
+export const BuiltInReportPageLayoutViz6TextLeft = builtInPage("viz6TextLeft", "6 visualizations + text", "Two rows of three visualizations with a text column on the left", {
+    kind: "content",
+    layout: column([
+        slot("pageTitle", 2),
+        column([
+            row([slot("text1", 2), slot("widget1", 3), slot("widget2", 3), slot("widget3", 3)]),
+            row([slot("text2", 2), slot("widget4", 3), slot("widget5", 3), slot("widget6", 3)]),
+        ], 9),
+        footerRow(),
+    ]),
+    slots: [
+        textSlot("pageTitle", "title", "Page title"),
+        textSlot("text1", "body", "Add a text"),
+        textSlot("text2", "body", "Add a text"),
+        ...["widget1", "widget2", "widget3", "widget4", "widget5", "widget6"].map(vizSlot),
+        ...footerSlots(),
+    ],
+});
+/**
+ * All built-in report pages served by the SPI. Built-ins are read-only: they cannot be
+ * edited or deleted, and they are never persisted on the backend.
+ *
+ * @alpha
+ */
+export const BuiltInReportPageLayouts = Object.freeze([
+    BuiltInReportPageLayoutCover,
+    BuiltInReportPageLayoutSection,
+    ...contentPages.map(([id, title, description, spec]) => builtInPage(id, title, description, contentPage(spec))),
+    BuiltInReportPageLayoutViz6TextLeft,
+]);

package/esm/reports/content.d.ts

@@ -0,0 +1,54 @@
+import { type FilterContextItem } from "../dashboard/filterContext.js";
+import { type IReportPageBody } from "./pageLayout.js";
+import { type IReportVariableDefinition } from "./variables.js";
+/**
+ * Page instance embedded in template/report content: a deep clone of a page body
+ * plus its own identity.
+ *
+ * @remarks
+ * Cloning a {@link IReportPageLayout} into content assigns the localIdentifier and regenerates
+ * slot localIdentifiers (with the layout slotIds) so repeated use of one page stays unique.
+ * Deliberately carries NO reference back to the source page — later page edits never
+ * affect existing templates or reports.
+ *
+ * @alpha
+ */
+export interface IReportContentPage extends IReportPageBody {
+    /**
+     * Identifier unique within the content; stable across template-to-report copy and reordering.
+     */
+    localIdentifier: string;
+}
+/**
+ * Versioned content shared verbatim by report templates and reports.
+ *
+ * @alpha
+ */
+export interface IReportContent {
+    /**
+     * Content model version, for stored-content evolution.
+     */
+    version: "1";
+    /**
+     * Ordered pages of the document.
+     */
+    pages: IReportContentPage[];
+    /**
+     * Content-level default filters; pages and slots may extend or override them.
+     * The report period is NOT stored here — it is derived from periodStart/periodEnd
+     * at execution time.
+     */
+    filters?: FilterContextItem[];
+    /**
+     * Custom variable declarations. Values live on the report
+     * ({@link IReportBase.variableValues}).
+     */
+    variables?: IReportVariableDefinition[];
+}
+/**
+ * Type-guard testing whether the provided object is an instance of {@link IReportContent}.
+ *
+ * @alpha
+ */
+export declare function isReportContentV1(obj: unknown): obj is IReportContent;
+//# sourceMappingURL=content.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"content.d.ts","sourceRoot":"","sources":["../../src/reports/content.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAEvE,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,iBAAiB,CAAC;AACvD,OAAO,EAAE,KAAK,yBAAyB,EAAE,MAAM,gBAAgB,CAAC;AAEhE;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,kBAAmB,SAAQ,eAAe;IACvD;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;CAC3B;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC3B;;OAEG;IACH,OAAO,EAAE,GAAG,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,kBAAkB,EAAE,CAAC;IAE5B;;;;OAIG;IACH,OAAO,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAE9B;;;OAGG;IACH,SAAS,CAAC,EAAE,yBAAyB,EAAE,CAAC;CAC3C;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,cAAc,CAMrE"}

package/esm/reports/content.js

@@ -0,0 +1,12 @@
+// (C) 2026 GoodData Corporation
+import { isEmpty } from "lodash-es";
+/**
+ * Type-guard testing whether the provided object is an instance of {@link IReportContent}.
+ *
+ * @alpha
+ */
+export function isReportContentV1(obj) {
+    return (!isEmpty(obj) &&
+        obj.version === "1" &&
+        Array.isArray(obj.pages));
+}

package/esm/reports/factory.d.ts

@@ -0,0 +1,65 @@
+import { type IReportContent, type IReportContentPage } from "./content.js";
+import { type IReportPageBody, type IReportPageLayout, type IReportPageLayoutDefinition } from "./pageLayout.js";
+import { type IReport, type IReportDefinition, type IReportTemplate, type IReportTemplateDefinition } from "./report.js";
+import { type ReportDateString } from "./variables.js";
+/**
+ * Creates a new report page definition.
+ *
+ * @alpha
+ */
+export declare function newReportPageLayoutDefinition(title: string, body: IReportPageBody, modifications?: Partial<Omit<IReportPageLayoutDefinition, "type" | "title" | "content">>): IReportPageLayoutDefinition;
+/**
+ * Clones a report page into a page instance embeddable in template/report content.
+ *
+ * @remarks
+ * The body is deep-copied and detached from the source page — no reference is kept.
+ * Slot localIdentifiers (and the layout slotIds pointing at them) are prefixed with the
+ * page-instance localIdentifier, so one page used repeatedly in the same content stays unique.
+ *
+ * @alpha
+ */
+export declare function newReportContentPageFromLayout(page: IReportPageLayout | IReportPageLayoutDefinition, localIdentifier?: string): IReportContentPage;
+/**
+ * Creates report content from page instances.
+ *
+ * @alpha
+ */
+export declare function newReportContent(pages: IReportContentPage[], modifications?: Partial<Omit<IReportContent, "version" | "pages">>): IReportContent;
+/**
+ * Creates a new report template definition.
+ *
+ * @alpha
+ */
+export declare function newReportTemplateDefinition(title: string, content: IReportContent, modifications?: Partial<Omit<IReportTemplateDefinition, "type" | "title" | "content">>): IReportTemplateDefinition;
+/**
+ * Creates a report definition from a template.
+ *
+ * @remarks
+ * The template content is deep-copied; no reference to the template is kept, so the
+ * report stays frozen while the template evolves.
+ *
+ * @alpha
+ */
+export declare function newReportDefinitionFromTemplate(template: IReportTemplate | IReportTemplateDefinition, options: {
+    title: string;
+    periodStart: ReportDateString;
+    periodEnd: ReportDateString;
+}, modifications?: Partial<Omit<IReportDefinition, "type" | "title" | "periodStart" | "periodEnd" | "content">>): IReportDefinition;
+/**
+ * Creates an ad-hoc report definition not based on any template.
+ *
+ * @alpha
+ */
+export declare function newAdHocReportDefinition(options: {
+    title: string;
+    periodStart: ReportDateString;
+    periodEnd: ReportDateString;
+    pages?: IReportContentPage[];
+}, modifications?: Partial<Omit<IReportDefinition, "type" | "title" | "periodStart" | "periodEnd" | "content">>): IReportDefinition;
+/**
+ * Convenience accessor for a report or template page by its localIdentifier.
+ *
+ * @alpha
+ */
+export declare function reportContentPage(reportOrTemplate: IReport | IReportDefinition | IReportTemplate | IReportTemplateDefinition, pageLocalIdentifier: string): IReportContentPage | undefined;
+//# sourceMappingURL=factory.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../../src/reports/factory.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAE5E,OAAO,EACH,KAAK,eAAe,EACpB,KAAK,iBAAiB,EAEtB,KAAK,2BAA2B,EACnC,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACH,KAAK,OAAO,EACZ,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,yBAAyB,EACjC,MAAM,aAAa,CAAC;AAErB,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AA2BvD;;;;GAIG;AACH,wBAAgB,6BAA6B,CACzC,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,eAAe,EACrB,aAAa,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC,CAAC,GACzF,2BAA2B,CAQ7B;AAED;;;;;;;;;GASG;AACH,wBAAgB,8BAA8B,CAC1C,IAAI,EAAE,iBAAiB,GAAG,2BAA2B,EACrD,eAAe,GAAE,MAAsC,GACxD,kBAAkB,CAapB;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAC5B,KAAK,EAAE,kBAAkB,EAAE,EAC3B,aAAa,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,SAAS,GAAG,OAAO,CAAC,CAAC,GACnE,cAAc,CAMhB;AAED;;;;GAIG;AACH,wBAAgB,2BAA2B,CACvC,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,cAAc,EACvB,aAAa,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC,CAAC,GACvF,yBAAyB,CAO3B;AAED;;;;;;;;GAQG;AACH,wBAAgB,+BAA+B,CAC3C,QAAQ,EAAE,eAAe,GAAG,yBAAyB,EACrD,OAAO,EAAE;IACL,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,gBAAgB,CAAC;IAC9B,SAAS,EAAE,gBAAgB,CAAC;CAC/B,EACD,aAAa,CAAC,EAAE,OAAO,CACnB,IAAI,CAAC,iBAAiB,EAAE,MAAM,GAAG,OAAO,GAAG,aAAa,GAAG,WAAW,GAAG,SAAS,CAAC,CACtF,GACF,iBAAiB,CASnB;AAED;;;;GAIG;AACH,wBAAgB,wBAAwB,CACpC,OAAO,EAAE;IACL,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,gBAAgB,CAAC;IAC9B,SAAS,EAAE,gBAAgB,CAAC;IAC5B,KAAK,CAAC,EAAE,kBAAkB,EAAE,CAAC;CAChC,EACD,aAAa,CAAC,EAAE,OAAO,CACnB,IAAI,CAAC,iBAAiB,EAAE,MAAM,GAAG,OAAO,GAAG,aAAa,GAAG,WAAW,GAAG,SAAS,CAAC,CACtF,GACF,iBAAiB,CASnB;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC7B,gBAAgB,EAAE,OAAO,GAAG,iBAAiB,GAAG,eAAe,GAAG,yBAAyB,EAC3F,mBAAmB,EAAE,MAAM,GAC5B,kBAAkB,GAAG,SAAS,CAEhC"}

package/esm/reports/factory.js

@@ -0,0 +1,126 @@
+// (C) 2026 GoodData Corporation
+import { isReportLayoutSection } from "./layout.js";
+function generateReportLocalId(prefix) {
+    const unique = typeof crypto !== "undefined" && typeof crypto.randomUUID === "function"
+        ? crypto.randomUUID().replace(/-/g, "").slice(0, 12)
+        : Math.random().toString(36).slice(2, 14);
+    return `${prefix}_${unique}`;
+}
+function deepClone(value) {
+    return JSON.parse(JSON.stringify(value));
+}
+function prefixLayoutSlotIds(node, prefix) {
+    if (isReportLayoutSection(node)) {
+        return {
+            ...node,
+            children: node.children.map((child) => prefixLayoutSlotIds(child, prefix)),
+        };
+    }
+    return {
+        ...node,
+        slotId: `${prefix}_${node.slotId}`,
+    };
+}
+/**
+ * Creates a new report page definition.
+ *
+ * @alpha
+ */
+export function newReportPageLayoutDefinition(title, body, modifications) {
+    const content = { version: "1", ...body };
+    return {
+        type: "reportPageLayout",
+        title,
+        content,
+        ...modifications,
+    };
+}
+/**
+ * Clones a report page into a page instance embeddable in template/report content.
+ *
+ * @remarks
+ * The body is deep-copied and detached from the source page — no reference is kept.
+ * Slot localIdentifiers (and the layout slotIds pointing at them) are prefixed with the
+ * page-instance localIdentifier, so one page used repeatedly in the same content stays unique.
+ *
+ * @alpha
+ */
+export function newReportContentPageFromLayout(page, localIdentifier = generateReportLocalId("page")) {
+    const { version: _version, ...body } = deepClone(page.content);
+    return {
+        ...body,
+        localIdentifier,
+        layout: prefixLayoutSlotIds(body.layout, localIdentifier),
+        slots: body.slots.map((slot) => ({
+            ...slot,
+            localIdentifier: `${localIdentifier}_${slot.localIdentifier}`,
+        })),
+    };
+}
+/**
+ * Creates report content from page instances.
+ *
+ * @alpha
+ */
+export function newReportContent(pages, modifications) {
+    return {
+        version: "1",
+        pages,
+        ...modifications,
+    };
+}
+/**
+ * Creates a new report template definition.
+ *
+ * @alpha
+ */
+export function newReportTemplateDefinition(title, content, modifications) {
+    return {
+        type: "reportTemplate",
+        title,
+        content,
+        ...modifications,
+    };
+}
+/**
+ * Creates a report definition from a template.
+ *
+ * @remarks
+ * The template content is deep-copied; no reference to the template is kept, so the
+ * report stays frozen while the template evolves.
+ *
+ * @alpha
+ */
+export function newReportDefinitionFromTemplate(template, options, modifications) {
+    return {
+        type: "report",
+        title: options.title,
+        periodStart: options.periodStart,
+        periodEnd: options.periodEnd,
+        content: deepClone(template.content),
+        ...modifications,
+    };
+}
+/**
+ * Creates an ad-hoc report definition not based on any template.
+ *
+ * @alpha
+ */
+export function newAdHocReportDefinition(options, modifications) {
+    return {
+        type: "report",
+        title: options.title,
+        periodStart: options.periodStart,
+        periodEnd: options.periodEnd,
+        content: newReportContent(options.pages ?? []),
+        ...modifications,
+    };
+}
+/**
+ * Convenience accessor for a report or template page by its localIdentifier.
+ *
+ * @alpha
+ */
+export function reportContentPage(reportOrTemplate, pageLocalIdentifier) {
+    return reportOrTemplate.content.pages.find((page) => page.localIdentifier === pageLocalIdentifier);
+}

package/esm/reports/layout.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Node of a report page layout: a recursive row/column split tree (flexbox semantics)
+ * over a fixed page. Leaves assign their area to slots; the tree carries only geometry,
+ * slot content lives in {@link IReportPageBody.slots}.
+ *
+ * @alpha
+ */
+export type ReportPageLayoutNode = IReportLayoutSection | IReportLayoutSlotRef;
+/**
+ * Fields common to all report layout nodes.
+ *
+ * @alpha
+ */
+export interface IReportLayoutNodeBase {
+    /**
+     * Fractional weight of this node inside its parent (flex-grow semantics).
+     * Defaults to 1. Example: sibling weights [2, 1] render a 2/3 + 1/3 split.
+     */
+    weight?: number;
+}
+/**
+ * A container splitting its area into children laid out along a direction.
+ *
+ * @alpha
+ */
+export interface IReportLayoutSection extends IReportLayoutNodeBase {
+    type: "section";
+    /**
+     * "row" lays children out horizontally, "column" vertically.
+     */
+    direction: "row" | "column";
+    children: ReportPageLayoutNode[];
+}
+/**
+ * A leaf assigning its area to a slot. The slot fills the area completely.
+ *
+ * @alpha
+ */
+export interface IReportLayoutSlotRef extends IReportLayoutNodeBase {
+    type: "slotRef";
+    /**
+     * Local identifier of a slot in {@link IReportPageBody.slots}.
+     * A slotId with no matching slot renders as an empty area.
+     */
+    slotId: string;
+}
+/**
+ * Type-guard testing whether the provided object is an instance of {@link IReportLayoutSection}.
+ *
+ * @alpha
+ */
+export declare function isReportLayoutSection(obj: unknown): obj is IReportLayoutSection;
+/**
+ * Type-guard testing whether the provided object is an instance of {@link IReportLayoutSlotRef}.
+ *
+ * @alpha
+ */
+export declare function isReportLayoutSlotRef(obj: unknown): obj is IReportLayoutSlotRef;
+//# sourceMappingURL=layout.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"layout.d.ts","sourceRoot":"","sources":["../../src/reports/layout.ts"],"names":[],"mappings":"AAIA;;;;;;GAMG;AACH,MAAM,MAAM,oBAAoB,GAAG,oBAAoB,GAAG,oBAAoB,CAAC;AAE/E;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IAClC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAqB,SAAQ,qBAAqB;IAC/D,IAAI,EAAE,SAAS,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,KAAK,GAAG,QAAQ,CAAC;IAE5B,QAAQ,EAAE,oBAAoB,EAAE,CAAC;CACpC;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAqB,SAAQ,qBAAqB;IAC/D,IAAI,EAAE,SAAS,CAAC;IAEhB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;CAClB;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,oBAAoB,CAE/E;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,oBAAoB,CAE/E"}

package/esm/reports/layout.js

@@ -0,0 +1,18 @@
+// (C) 2026 GoodData Corporation
+import { isEmpty } from "lodash-es";
+/**
+ * Type-guard testing whether the provided object is an instance of {@link IReportLayoutSection}.
+ *
+ * @alpha
+ */
+export function isReportLayoutSection(obj) {
+    return !isEmpty(obj) && obj.type === "section";
+}
+/**
+ * Type-guard testing whether the provided object is an instance of {@link IReportLayoutSlotRef}.
+ *
+ * @alpha
+ */
+export function isReportLayoutSlotRef(obj) {
+    return !isEmpty(obj) && obj.type === "slotRef";
+}

package/esm/reports/pageLayout.d.ts

@@ -0,0 +1,120 @@
+import { type IAuditableDates, type IAuditableUsers } from "../base/metadata.js";
+import { type FilterContextItem } from "../dashboard/filterContext.js";
+import { type ObjRef } from "../objRef/index.js";
+import { type ReportPageLayoutNode } from "./layout.js";
+import { type ReportSlot } from "./slot.js";
+/**
+ * Body of a report page: geometry (flex split tree) plus the slots it places.
+ *
+ * @remarks
+ * This is both the content of the standalone {@link IReportPageLayout} object and the shape
+ * embedded in template/report content ({@link IReportContentPage}).
+ *
+ * There is no header/footer chrome: page title, description, footer, page numbers and
+ * logos are ordinary slots in the layout tree (text slots with `{{pageNumber}}`/`{{totalPages}}`,
+ * an image slot with `{{logo}}`). Every slot fills its layout area completely.
+ *
+ * @alpha
+ */
+export interface IReportPageBody {
+    /**
+     * Editor hint only (template galleries, default styling, AI context).
+     * Renderers must not branch layout logic on it — geometry always comes from `layout`.
+     */
+    kind?: "cover" | "section" | "content";
+    /**
+     * Root of the page layout tree.
+     */
+    layout: ReportPageLayoutNode;
+    /**
+     * All slots referenced by the layout, flat, keyed by localIdentifier.
+     */
+    slots: ReportSlot[];
+    /**
+     * Page-level filters: merged over content-level filters (a filter targeting the
+     * same object replaces the inherited one); slot filters apply on top.
+     */
+    filters?: FilterContextItem[];
+}
+/**
+ * Stored content of the reportPage entity.
+ *
+ * @alpha
+ */
+export interface IReportPageLayoutContent extends IReportPageBody {
+    /**
+     * Content model version, for stored-content evolution.
+     */
+    version: "1";
+}
+/**
+ * Payload for creating or updating a report page.
+ *
+ * @alpha
+ */
+export interface IReportPageLayoutDefinition {
+    type: "reportPageLayout";
+    /**
+     * Present when updating an existing page.
+     */
+    ref?: ObjRef;
+    title: string;
+    description?: string;
+    tags?: string[];
+    content: IReportPageLayoutContent;
+}
+/**
+ * Reusable report page metadata object.
+ *
+ * @alpha
+ */
+export interface IReportPageLayout extends IReportPageLayoutDefinition, IAuditableDates, IAuditableUsers {
+    ref: ObjRef;
+    /**
+     * When true, the object comes from a parent workspace and is not editable
+     * in the current workspace.
+     */
+    isLocked?: boolean;
+    /**
+     * Predefined page shipped with the product, populated by the SPI. Never sent to or
+     * stored on the backend; UI must disable deletion and editing of built-in pages.
+     */
+    isBuiltIn?: boolean;
+}
+/**
+ * Type-guard testing whether the provided object is an instance of {@link IReportPageLayoutDefinition}.
+ *
+ * @alpha
+ */
+export declare function isReportPageLayoutDefinition(obj: unknown): obj is IReportPageLayoutDefinition;
+/**
+ * Type-guard testing whether the provided object is an instance of {@link IReportPageLayout}.
+ *
+ * @alpha
+ */
+export declare function isReportPageLayout(obj: unknown): obj is IReportPageLayout;
+/**
+ * Type-guard testing whether the provided object is an instance of {@link IReportPageLayoutContent}.
+ *
+ * @alpha
+ */
+export declare function isReportPageLayoutContentV1(obj: unknown): obj is IReportPageLayoutContent;
+/**
+ * Validation issue found in a report page body.
+ *
+ * @alpha
+ */
+export interface IReportPageBodyValidationIssue {
+    severity: "error" | "warning";
+    message: string;
+}
+/**
+ * Validates the structural invariants of a page body the type system cannot express:
+ * slot localIdentifiers are unique, layout weights are positive, every slot is placed
+ * by the layout, and every layout slotId resolves (unresolved ones are warnings —
+ * they render as empty areas).
+ *
+ * @alpha
+ */
+export declare function validateReportPageBody(body: IReportPageBody): IReportPageBodyValidationIssue[];
+//# sourceMappingURL=pageLayout.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pageLayout.d.ts","sourceRoot":"","sources":["../../src/reports/pageLayout.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,eAAe,EAAE,KAAK,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACjF,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AACvE,OAAO,EAAE,KAAK,MAAM,EAAY,MAAM,oBAAoB,CAAC;AAE3D,OAAO,EAAE,KAAK,oBAAoB,EAAgD,MAAM,aAAa,CAAC;AACtG,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,WAAW,CAAC;AAE5C;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,eAAe;IAC5B;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,SAAS,CAAC;IAEvC;;OAEG;IACH,MAAM,EAAE,oBAAoB,CAAC;IAE7B;;OAEG;IACH,KAAK,EAAE,UAAU,EAAE,CAAC;IAEpB;;;OAGG;IACH,OAAO,CAAC,EAAE,iBAAiB,EAAE,CAAC;CACjC;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAyB,SAAQ,eAAe;IAC7D;;OAEG;IACH,OAAO,EAAE,GAAG,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IACxC,IAAI,EAAE,kBAAkB,CAAC;IAEzB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,KAAK,EAAE,MAAM,CAAC;IAEd,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhB,OAAO,EAAE,wBAAwB,CAAC;CACrC;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAkB,SAAQ,2BAA2B,EAAE,eAAe,EAAE,eAAe;IACpG,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;;;GAIG;AACH,wBAAgB,4BAA4B,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,2BAA2B,CAE7F;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,iBAAiB,CAEzE;AAED;;;;GAIG;AACH,wBAAgB,2BAA2B,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,wBAAwB,CAOzF;AAED;;;;GAIG;AACH,MAAM,WAAW,8BAA8B;IAC3C,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B,OAAO,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,eAAe,GAAG,8BAA8B,EAAE,CA8C9F"}