@gooddata/sdk-model 11.62.0-alpha.0 → 11.62.0-alpha.2

package/esm/{reports → publisher}/pageLayout.d.ts

@@ -1,16 +1,16 @@
 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 ReportPageFormat } from "./pageFormat.js";
-import { type ReportSlot } from "./slot.js";
-import { type IReportBoxStyle } from "./styling.js";
+import { type PublisherPageLayoutNode } from "./layout.js";
+import { type PublisherPageFormat } from "./pageFormat.js";
+import { type PublisherSlot } from "./slot.js";
+import { type IPublisherBoxStyle } from "./styling.js";
 /**
- * Body of a report page: geometry (flex split tree) plus the slots it places.
+ * Body of a document 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}).
+ * This is both the content of the standalone {@link IPublisherPageLayout} object and the shape
+ * embedded in template/document content ({@link IPublisherDocumentPage}).
  *
  * There is no header/footer chrome: page title, description, footer, page numbers and
  * logos are ordinary slots in the layout tree (text slots with `{currentPageNumber}`/`{totalPages}`,
@@ -18,7 +18,7 @@ import { type IReportBoxStyle } from "./styling.js";
  *
  * @alpha
  */
-export interface IReportPageBody {
+export interface IPublisherPageBody {
     /**
      * Editor hint only (template galleries, default styling, AI context).
      * Renderers must not branch layout logic on it — geometry always comes from `layout`.
@@ -26,21 +26,21 @@ export interface IReportPageBody {
     kind?: "cover" | "section" | "content";
     /**
      * Page proportions the layout was authored for. Defaults to
-     * {@link DefaultReportPageFormat}.
+     * {@link DefaultPublisherPageFormat}.
      */
-    format?: ReportPageFormat;
+    format?: PublisherPageFormat;
     /**
      * Paint of the page itself, behind everything the layout places.
      */
-    style?: IReportBoxStyle;
+    style?: IPublisherBoxStyle;
     /**
      * Root of the page layout tree.
      */
-    layout: ReportPageLayoutNode;
+    layout: PublisherPageLayoutNode;
     /**
      * All slots referenced by the layout, flat, keyed by localIdentifier.
      */
-    slots: ReportSlot[];
+    slots: PublisherSlot[];
     /**
      * Page-level filters: merged over content-level filters (a filter targeting the
      * same object replaces the inherited one); slot filters apply on top.
@@ -52,18 +52,18 @@ export interface IReportPageBody {
  *
  * @alpha
  */
-export interface IReportPageLayoutContent extends IReportPageBody {
+export interface IPublisherPageLayoutContent extends IPublisherPageBody {
     /**
      * Content model version, for stored-content evolution.
      */
     version: "1";
 }
 /**
- * Payload for creating or updating a report page.
+ * Payload for creating or updating a page layout.
  *
  * @alpha
  */
-export interface IReportPageLayoutDefinition {
+export interface IPublisherPageLayoutDefinition {
     type: "reportPageLayout";
     /**
      * Present when updating an existing page.
@@ -72,14 +72,14 @@ export interface IReportPageLayoutDefinition {
     title: string;
     description?: string;
     tags?: string[];
-    content: IReportPageLayoutContent;
+    content: IPublisherPageLayoutContent;
 }
 /**
- * Reusable report page metadata object.
+ * Reusable page layout metadata object.
  *
  * @alpha
  */
-export interface IReportPageLayout extends IReportPageLayoutDefinition, IAuditableDates, IAuditableUsers {
+export interface IPublisherPageLayout extends IPublisherPageLayoutDefinition, IAuditableDates, IAuditableUsers {
     ref: ObjRef;
     /**
      * When true, the object comes from a parent workspace and is not editable
@@ -93,29 +93,29 @@ export interface IReportPageLayout extends IReportPageLayoutDefinition, IAuditab
     isBuiltIn?: boolean;
 }
 /**
- * Type-guard testing whether the provided object is an instance of {@link IReportPageLayoutDefinition}.
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherPageLayoutDefinition}.
  *
  * @alpha
  */
-export declare function isReportPageLayoutDefinition(obj: unknown): obj is IReportPageLayoutDefinition;
+export declare function isPublisherPageLayoutDefinition(obj: unknown): obj is IPublisherPageLayoutDefinition;
 /**
- * Type-guard testing whether the provided object is an instance of {@link IReportPageLayout}.
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherPageLayout}.
  *
  * @alpha
  */
-export declare function isReportPageLayout(obj: unknown): obj is IReportPageLayout;
+export declare function isPublisherPageLayout(obj: unknown): obj is IPublisherPageLayout;
 /**
- * Type-guard testing whether the provided object is an instance of {@link IReportPageLayoutContent}.
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherPageLayoutContent}.
  *
  * @alpha
  */
-export declare function isReportPageLayoutContentV1(obj: unknown): obj is IReportPageLayoutContent;
+export declare function isPublisherPageLayoutContentV1(obj: unknown): obj is IPublisherPageLayoutContent;
 /**
- * Validation issue found in a report page body.
+ * Validation issue found in a page body.
  *
  * @alpha
  */
-export interface IReportPageBodyValidationIssue {
+export interface IPublisherPageBodyValidationIssue {
     severity: "error" | "warning";
     message: string;
 }
@@ -129,5 +129,5 @@ export interface IReportPageBodyValidationIssue {
  *
  * @alpha
  */
-export declare function validateReportPageBody(body: IReportPageBody): IReportPageBodyValidationIssue[];
+export declare function validatePublisherPageBody(body: IPublisherPageBody): IPublisherPageBodyValidationIssue[];
 //# sourceMappingURL=pageLayout.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pageLayout.d.ts","sourceRoot":"","sources":["../../src/publisher/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,EACH,KAAK,uBAAuB,EAG/B,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,KAAK,mBAAmB,EAAyB,MAAM,iBAAiB,CAAC;AAClF,OAAO,EAAE,KAAK,aAAa,EAA6C,MAAM,WAAW,CAAC;AAC1F,OAAO,EAAE,KAAK,kBAAkB,EAA8B,MAAM,cAAc,CAAC;AAEnF;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,kBAAkB;IAC/B;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,SAAS,CAAC;IAEvC;;;OAGG;IACH,MAAM,CAAC,EAAE,mBAAmB,CAAC;IAE7B;;OAEG;IACH,KAAK,CAAC,EAAE,kBAAkB,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,uBAAuB,CAAC;IAEhC;;OAEG;IACH,KAAK,EAAE,aAAa,EAAE,CAAC;IAEvB;;;OAGG;IACH,OAAO,CAAC,EAAE,iBAAiB,EAAE,CAAC;CACjC;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA4B,SAAQ,kBAAkB;IACnE;;OAEG;IACH,OAAO,EAAE,GAAG,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,8BAA8B;IAC3C,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,2BAA2B,CAAC;CACxC;AAED;;;;GAIG;AACH,MAAM,WAAW,oBACb,SAAQ,8BAA8B,EAAE,eAAe,EAAE,eAAe;IACxE,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,+BAA+B,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,8BAA8B,CAEnG;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,oBAAoB,CAE/E;AAED;;;;GAIG;AACH,wBAAgB,8BAA8B,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,2BAA2B,CAO/F;AAED;;;;GAIG;AACH,MAAM,WAAW,iCAAiC;IAC9C,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B,OAAO,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;;;GASG;AACH,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,kBAAkB,GAAG,iCAAiC,EAAE,CA+FvG"}

package/esm/{reports → publisher}/pageLayout.js

@@ -1,32 +1,32 @@
 // (C) 2026 GoodData Corporation
 import { isEmpty } from "lodash-es";
 import { isObjRef } from "../objRef/index.js";
-import { isReportLayoutSection, isReportLayoutSlotRef } from "./layout.js";
-import { isReportPageFormat } from "./pageFormat.js";
-import { isReportImageSlot, isReportTextSlot } from "./slot.js";
-import { isReportImageBackground } from "./styling.js";
+import { isPublisherLayoutSection, isPublisherLayoutSlotRef, } from "./layout.js";
+import { isPublisherPageFormat } from "./pageFormat.js";
+import { isPublisherImageSlot, isPublisherTextSlot } from "./slot.js";
+import { isPublisherImageBackground } from "./styling.js";
 /**
- * Type-guard testing whether the provided object is an instance of {@link IReportPageLayoutDefinition}.
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherPageLayoutDefinition}.
  *
  * @alpha
  */
-export function isReportPageLayoutDefinition(obj) {
+export function isPublisherPageLayoutDefinition(obj) {
     return !isEmpty(obj) && obj.type === "reportPageLayout";
 }
 /**
- * Type-guard testing whether the provided object is an instance of {@link IReportPageLayout}.
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherPageLayout}.
  *
  * @alpha
  */
-export function isReportPageLayout(obj) {
-    return isReportPageLayoutDefinition(obj) && isObjRef(obj.ref);
+export function isPublisherPageLayout(obj) {
+    return isPublisherPageLayoutDefinition(obj) && isObjRef(obj.ref);
 }
 /**
- * Type-guard testing whether the provided object is an instance of {@link IReportPageLayoutContent}.
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherPageLayoutContent}.
  *
  * @alpha
  */
-export function isReportPageLayoutContentV1(obj) {
+export function isPublisherPageLayoutContentV1(obj) {
     return (!isEmpty(obj) &&
         obj.version === "1" &&
         !isEmpty(obj.layout) &&
@@ -42,9 +42,9 @@ export function isReportPageLayoutContentV1(obj) {
  *
  * @alpha
  */
-export function validateReportPageBody(body) {
+export function validatePublisherPageBody(body) {
     const issues = [];
-    if (body.format !== undefined && !isReportPageFormat(body.format)) {
+    if (body.format !== undefined && !isPublisherPageFormat(body.format)) {
         issues.push({ severity: "error", message: `Unknown page format "${body.format}".` });
     }
     const checkLength = (name, value) => {
@@ -70,7 +70,7 @@ export function validateReportPageBody(body) {
     const checkBoxStyle = (style, isDrawn) => {
         checkLength("Border radius", style?.borderRadius);
         checkLength("Padding", style?.padding);
-        if (!style?.background || !isReportImageBackground(style.background)) {
+        if (!style?.background || !isPublisherImageBackground(style.background)) {
             return;
         }
         const { slotId } = style.background;
@@ -82,7 +82,7 @@ export function validateReportPageBody(body) {
             });
             return;
         }
-        if (!isReportImageSlot(slot)) {
+        if (!isPublisherImageSlot(slot)) {
             issues.push({
                 severity: "error",
                 message: `Background references slot "${slotId}" which is not an image slot.`,
@@ -102,7 +102,7 @@ export function validateReportPageBody(body) {
                 message: `Layout node weight must be positive, got ${node.weight}.`,
             });
         }
-        if (isReportLayoutSlotRef(node)) {
+        if (isPublisherLayoutSlotRef(node)) {
             referencedIds.add(node.slotId);
             if (!slotIds.has(node.slotId)) {
                 issues.push({
@@ -111,14 +111,14 @@ export function validateReportPageBody(body) {
                 });
             }
         }
-        else if (isReportLayoutSection(node)) {
+        else if (isPublisherLayoutSection(node)) {
             checkBoxStyle(node.style, true);
             node.children.forEach(visit);
         }
     };
     visit(body.layout);
     // After the layout, so a slot the layout never places cannot vouch for the image it names.
-    for (const slot of body.slots.filter(isReportTextSlot)) {
+    for (const slot of body.slots.filter(isPublisherTextSlot)) {
         checkBoxStyle(slot.style, referencedIds.has(slot.localIdentifier));
     }
     for (const slotId of slotIds) {

package/esm/{reports → publisher}/slot.d.ts

@@ -1,24 +1,24 @@
 import { type FilterContextItem, type IDashboardFilterReference } from "../dashboard/filterContext.js";
 import { type VisualizationProperties } from "../insight/index.js";
 import { type ObjRef } from "../objRef/index.js";
-import { type IReportHeadingStyle, type IReportImageStyle, type IReportParagraphStyle, type ReportTextType } from "./styling.js";
+import { type IPublisherHeadingStyle, type IPublisherImageStyle, type IPublisherParagraphStyle, type PublisherTextType } from "./styling.js";
 /**
- * Metadata of a slot that is intentionally left unfilled in a report page or template.
+ * Metadata of a slot that is intentionally left unfilled in a page layout or template.
  *
  * @alpha
  */
-export interface IReportSlotPlaceholder {
+export interface IPublisherSlotPlaceholder {
     /**
      * Authoring hint shown in the empty slot.
      */
     hint?: string;
     /**
-     * When true, a report is not considered complete until this slot is filled.
+     * When true, a document is not considered complete until this slot is filled.
      */
     required?: boolean;
 }
 /**
- * Structural base of every report slot.
+ * Structural base of every document slot.
  *
  * @remarks
  * Parsers written against this base can skip slot types introduced by a newer
@@ -26,25 +26,25 @@ export interface IReportSlotPlaceholder {
  *
  * @alpha
  */
-export interface IReportSlotBase {
+export interface IPublisherSlotBase {
     type: string;
     /**
      * Identifier unique within the page body. The layout tree references it, and it is
-     * the join key when a report fills a template's slots. Regenerated when a page is
+     * the join key when a document fills a template's slots. Regenerated when a page is
      * cloned into template content so repeated use of one page stays unique.
      */
     localIdentifier: string;
     /**
      * Present when the slot is an unfilled placeholder.
      */
-    placeholder?: IReportSlotPlaceholder;
+    placeholder?: IPublisherSlotPlaceholder;
 }
 /**
  * Slot rendering an insight, with its own filter context.
  *
  * @alpha
  */
-export interface IReportVisualizationSlot extends IReportSlotBase {
+export interface IPublisherVisualizationSlot extends IPublisherSlotBase {
     type: "visualization";
     /**
      * Insight to render. Undefined = declared-but-empty slot; renderers show a placeholder.
@@ -69,13 +69,13 @@ export interface IReportVisualizationSlot extends IReportSlotBase {
      */
     ignoredFilters?: IDashboardFilterReference[];
     /**
-     * Date dataset the report's period (periodStart/periodEnd) is applied to as an
+     * Date dataset the document's period (periodStart/periodEnd) is applied to as an
      * absolute date filter at execution time. Undefined = backend date-dataset
      * auto-resolution applies.
      */
     dateDataSet?: ObjRef;
     /**
-     * When true, the implicit date filter derived from the report's period is not
+     * When true, the implicit date filter derived from the document's period is not
      * applied to this slot.
      */
     ignoreReportPeriod?: boolean;
@@ -85,7 +85,7 @@ export interface IReportVisualizationSlot extends IReportSlotBase {
  *
  * @alpha
  */
-export interface IReportStaticTextSource {
+export interface IPublisherStaticTextSource {
     type: "static";
     /**
      * Markdown content with `{variable}` placeholders. Stored raw — placeholders are
@@ -94,18 +94,18 @@ export interface IReportStaticTextSource {
     content: string;
 }
 /**
- * Text generated by AI at report-build time.
+ * Text generated by AI at document-build time.
  *
  * @alpha
  */
-export interface IReportAiTextSource {
+export interface IPublisherAiTextSource {
     type: "ai";
     /**
      * Instruction for the generator. Supports `{variables}`.
      */
     prompt: string;
     /**
-     * Materialized generation result (markdown), stored so the report renders
+     * Materialized generation result (markdown), stored so the document renders
      * deterministically without re-invoking AI. Absent until first generation.
      */
     content?: string;
@@ -119,7 +119,7 @@ export interface IReportAiTextSource {
  *
  * @alpha
  */
-export type ReportTextSource = IReportStaticTextSource | IReportAiTextSource;
+export type PublisherTextSource = IPublisherStaticTextSource | IPublisherAiTextSource;
 /**
  * Slot rendering a heading.
  *
@@ -129,39 +129,39 @@ export type ReportTextSource = IReportStaticTextSource | IReportAiTextSource;
  *
  * @alpha
  */
-export interface IReportHeadingSlot extends IReportSlotBase {
+export interface IPublisherHeadingSlot extends IPublisherSlotBase {
     type: "heading";
-    style?: IReportHeadingStyle;
+    style?: IPublisherHeadingStyle;
     /**
      * Undefined = declared-but-empty slot.
      */
-    source?: ReportTextSource;
+    source?: PublisherTextSource;
 }
 /**
  * Slot rendering prose, written as markdown.
  *
  * @alpha
  */
-export interface IReportParagraphSlot extends IReportSlotBase {
+export interface IPublisherParagraphSlot extends IPublisherSlotBase {
     type: "paragraph";
-    style?: IReportParagraphStyle;
+    style?: IPublisherParagraphStyle;
     /**
      * Undefined = declared-but-empty slot.
      */
-    source?: ReportTextSource;
+    source?: PublisherTextSource;
 }
 /**
  * Slot rendering text of either kind.
  *
  * @alpha
  */
-export type IReportTextSlot = IReportHeadingSlot | IReportParagraphSlot;
+export type IPublisherTextSlot = IPublisherHeadingSlot | IPublisherParagraphSlot;
 /**
  * What an image slot displays.
  *
  * @alpha
  */
-export type ReportImageSource = {
+export type PublisherImageSource = {
     type: "url";
     /**
      * Image URL. Supports `{variables}` — a logo slot uses `{logo}`.
@@ -180,52 +180,52 @@ export type ReportImageSource = {
  *
  * @alpha
  */
-export type ReportImageFit = "contain" | "cover" | "fill";
+export type PublisherImageFit = "contain" | "cover" | "fill";
 /**
  * Slot rendering an image.
  *
  * @alpha
  */
-export interface IReportImageSlot extends IReportSlotBase {
+export interface IPublisherImageSlot extends IPublisherSlotBase {
     type: "image";
     /**
      * Undefined = declared-but-empty slot.
      */
-    source?: ReportImageSource;
+    source?: PublisherImageSource;
     altText?: string;
     /**
      * How the image fills the slot area. Defaults to "contain".
      */
-    fit?: ReportImageFit;
+    fit?: PublisherImageFit;
     /**
      * Placement overrides for the drawn image; centered on both axes by default.
      */
-    style?: IReportImageStyle;
+    style?: IPublisherImageStyle;
 }
 /**
- * All slot types of report content version 1.
+ * All slot types of document content version 1.
  *
  * @alpha
  */
-export type ReportSlot = IReportVisualizationSlot | IReportTextSlot | IReportImageSlot;
+export type PublisherSlot = IPublisherVisualizationSlot | IPublisherTextSlot | IPublisherImageSlot;
 /**
- * List of built-in report slot type names.
+ * List of built-in document slot type names.
  *
  * @alpha
  */
-export declare const BuiltInReportSlotTypes: string[];
+export declare const BuiltInPublisherSlotTypes: string[];
 /**
  * All sizes a text slot can be rendered at, headings first.
  *
  * @alpha
  */
-export declare const ReportTextTypes: ReportTextType[];
+export declare const PublisherTextTypes: PublisherTextType[];
 /**
  * Sizes the slot can be rendered at, which is what its own type decides.
  *
  * @alpha
  */
-export declare function reportTextSlotTypes(slot: IReportTextSlot): ReportTextType[];
+export declare function publisherTextSlotTypes(slot: IPublisherTextSlot): PublisherTextType[];
 /**
  * Size the slot is rendered at.
  *
@@ -235,41 +235,41 @@ export declare function reportTextSlotTypes(slot: IReportTextSlot): ReportTextTy
  *
  * @alpha
  */
-export declare function reportTextSlotType(slot: IReportTextSlot): ReportTextType;
+export declare function publisherTextSlotType(slot: IPublisherTextSlot): PublisherTextType;
 /**
- * Type-guard testing whether the provided object is an instance of {@link IReportVisualizationSlot}.
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherVisualizationSlot}.
  *
  * @alpha
  */
-export declare function isReportVisualizationSlot(obj: unknown): obj is IReportVisualizationSlot;
+export declare function isPublisherVisualizationSlot(obj: unknown): obj is IPublisherVisualizationSlot;
 /**
- * Type-guard testing whether the provided object is an instance of {@link IReportHeadingSlot}.
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherHeadingSlot}.
  *
  * @alpha
  */
-export declare function isReportHeadingSlot(obj: unknown): obj is IReportHeadingSlot;
+export declare function isPublisherHeadingSlot(obj: unknown): obj is IPublisherHeadingSlot;
 /**
- * Type-guard testing whether the provided object is an instance of {@link IReportParagraphSlot}.
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherParagraphSlot}.
  *
  * @alpha
  */
-export declare function isReportParagraphSlot(obj: unknown): obj is IReportParagraphSlot;
+export declare function isPublisherParagraphSlot(obj: unknown): obj is IPublisherParagraphSlot;
 /**
- * Type-guard testing whether the provided object is an instance of {@link IReportTextSlot}.
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherTextSlot}.
  *
  * @alpha
  */
-export declare function isReportTextSlot(obj: unknown): obj is IReportTextSlot;
+export declare function isPublisherTextSlot(obj: unknown): obj is IPublisherTextSlot;
 /**
- * Type-guard testing whether the provided object is an instance of {@link IReportImageSlot}.
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherImageSlot}.
  *
  * @alpha
  */
-export declare function isReportImageSlot(obj: unknown): obj is IReportImageSlot;
+export declare function isPublisherImageSlot(obj: unknown): obj is IPublisherImageSlot;
 /**
- * Type-guard testing whether the provided object is an instance of {@link ReportSlot}.
+ * Type-guard testing whether the provided object is an instance of {@link PublisherSlot}.
  *
  * @alpha
  */
-export declare function isReportSlot(obj: unknown): obj is ReportSlot;
+export declare function isPublisherSlot(obj: unknown): obj is PublisherSlot;
 //# sourceMappingURL=slot.d.ts.map

package/esm/publisher/slot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"slot.d.ts","sourceRoot":"","sources":["../../src/publisher/slot.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,iBAAiB,EAAE,KAAK,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AACvG,OAAO,EAAE,KAAK,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AACnE,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAEjD,OAAO,EAGH,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,wBAAwB,EAG7B,KAAK,iBAAiB,EAGzB,MAAM,cAAc,CAAC;AAEtB;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACtC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,kBAAkB;IAC/B,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE,yBAAyB,CAAC;CAC3C;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA4B,SAAQ,kBAAkB;IACnE,IAAI,EAAE,eAAe,CAAC;IAEtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,uBAAuB,CAAC;IAErC;;;OAGG;IACH,OAAO,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,yBAAyB,EAAE,CAAC;IAE7C;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACvC,IAAI,EAAE,QAAQ,CAAC;IAEf;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACnC,IAAI,EAAE,IAAI,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,0BAA0B,GAAG,sBAAsB,CAAC;AAEtF;;;;;;;;GAQG;AACH,MAAM,WAAW,qBAAsB,SAAQ,kBAAkB;IAC7D,IAAI,EAAE,SAAS,CAAC;IAEhB,KAAK,CAAC,EAAE,sBAAsB,CAAC;IAE/B;;OAEG;IACH,MAAM,CAAC,EAAE,mBAAmB,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAwB,SAAQ,kBAAkB;IAC/D,IAAI,EAAE,WAAW,CAAC;IAElB,KAAK,CAAC,EAAE,wBAAwB,CAAC;IAEjC;;OAEG;IACH,MAAM,CAAC,EAAE,mBAAmB,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,qBAAqB,GAAG,uBAAuB,CAAC;AAEjF;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAC1B;IACI,IAAI,EAAE,KAAK,CAAC;IAEZ;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACf,GACD;IACI,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACf,CAAC;AAER;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,CAAC;AAE7D;;;;GAIG;AACH,MAAM,WAAW,mBAAoB,SAAQ,kBAAkB;IAC3D,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAE9B,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,GAAG,CAAC,EAAE,iBAAiB,CAAC;IAExB;;OAEG;IACH,KAAK,CAAC,EAAE,oBAAoB,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,2BAA2B,GAAG,kBAAkB,GAAG,mBAAmB,CAAC;AAEnG;;;;GAIG;AACH,eAAO,MAAM,yBAAyB,EAAE,MAAM,EAAuD,CAAC;AAEtG;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,EAAE,iBAAiB,EAA2D,CAAC;AAE9G;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,kBAAkB,GAAG,iBAAiB,EAAE,CAEpF;AAED;;;;;;;;GAQG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,kBAAkB,GAAG,iBAAiB,CAMjF;AAED;;;;GAIG;AACH,wBAAgB,4BAA4B,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,2BAA2B,CAE7F;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,qBAAqB,CAEjF;AAED;;;;GAIG;AACH,wBAAgB,wBAAwB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,uBAAuB,CAErF;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,kBAAkB,CAE3E;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,mBAAmB,CAE7E;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,aAAa,CAIlE"}

package/esm/publisher/slot.js

@@ -0,0 +1,87 @@
+// (C) 2026 GoodData Corporation
+import { isEmpty } from "lodash-es";
+import { DefaultPublisherHeadingType, DefaultPublisherParagraphType, PublisherHeadingTypes, PublisherParagraphTypes, isPublisherHeadingType, isPublisherParagraphType, } from "./styling.js";
+/**
+ * List of built-in document slot type names.
+ *
+ * @alpha
+ */
+export const BuiltInPublisherSlotTypes = ["visualization", "heading", "paragraph", "image"];
+/**
+ * All sizes a text slot can be rendered at, headings first.
+ *
+ * @alpha
+ */
+export const PublisherTextTypes = [...PublisherHeadingTypes, ...PublisherParagraphTypes];
+/**
+ * Sizes the slot can be rendered at, which is what its own type decides.
+ *
+ * @alpha
+ */
+export function publisherTextSlotTypes(slot) {
+    return slot.type === "heading" ? PublisherHeadingTypes : PublisherParagraphTypes;
+}
+/**
+ * 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 publisherTextSlotType(slot) {
+    const stated = slot.style?.type;
+    if (slot.type === "heading") {
+        return isPublisherHeadingType(stated) ? stated : DefaultPublisherHeadingType;
+    }
+    return isPublisherParagraphType(stated) ? stated : DefaultPublisherParagraphType;
+}
+/**
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherVisualizationSlot}.
+ *
+ * @alpha
+ */
+export function isPublisherVisualizationSlot(obj) {
+    return !isEmpty(obj) && obj.type === "visualization";
+}
+/**
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherHeadingSlot}.
+ *
+ * @alpha
+ */
+export function isPublisherHeadingSlot(obj) {
+    return !isEmpty(obj) && obj.type === "heading";
+}
+/**
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherParagraphSlot}.
+ *
+ * @alpha
+ */
+export function isPublisherParagraphSlot(obj) {
+    return !isEmpty(obj) && obj.type === "paragraph";
+}
+/**
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherTextSlot}.
+ *
+ * @alpha
+ */
+export function isPublisherTextSlot(obj) {
+    return isPublisherHeadingSlot(obj) || isPublisherParagraphSlot(obj);
+}
+/**
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherImageSlot}.
+ *
+ * @alpha
+ */
+export function isPublisherImageSlot(obj) {
+    return !isEmpty(obj) && obj.type === "image";
+}
+/**
+ * Type-guard testing whether the provided object is an instance of {@link PublisherSlot}.
+ *
+ * @alpha
+ */
+export function isPublisherSlot(obj) {
+    return [isPublisherVisualizationSlot, isPublisherTextSlot, isPublisherImageSlot].some((guard) => guard(obj));
+}