@gooddata/sdk-model 11.62.0-alpha.3 → 11.62.0

package/esm/publisher/v1/document.js

@@ -0,0 +1,35 @@
+// (C) 2026 GoodData Corporation
+import { isEmpty } from "lodash-es";
+import { isObjRef } from "../../objRef/index.js";
+/**
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherDocumentTemplateDefinitionV1}.
+ *
+ * @alpha
+ */
+export function isPublisherDocumentTemplateDefinitionV1(obj) {
+    return !isEmpty(obj) && obj.type === "reportTemplate";
+}
+/**
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherDocumentTemplateV1}.
+ *
+ * @alpha
+ */
+export function isPublisherDocumentTemplateV1(obj) {
+    return (isPublisherDocumentTemplateDefinitionV1(obj) && isObjRef(obj.ref));
+}
+/**
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherDocumentDefinitionV1}.
+ *
+ * @alpha
+ */
+export function isPublisherDocumentDefinitionV1(obj) {
+    return !isEmpty(obj) && obj.type === "report";
+}
+/**
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherDocumentV1}.
+ *
+ * @alpha
+ */
+export function isPublisherDocumentV1(obj) {
+    return isPublisherDocumentDefinitionV1(obj) && isObjRef(obj.ref);
+}

package/esm/publisher/v1/factory.d.ts

@@ -0,0 +1,65 @@
+import { type IPublisherDocumentContentV1, type IPublisherDocumentPageV1 } from "./content.js";
+import { type IPublisherDocumentDefinitionV1, type IPublisherDocumentTemplateDefinitionV1, type IPublisherDocumentTemplateV1, type IPublisherDocumentV1 } from "./document.js";
+import { type IPublisherPageBodyV1, type IPublisherPageLayoutDefinitionV1, type IPublisherPageLayoutV1 } from "./pageLayout.js";
+import { type PublisherDateStringV1 } from "./variables.js";
+/**
+ * Creates a new page layout definition.
+ *
+ * @alpha
+ */
+export declare function newPublisherPageLayoutDefinitionV1(title: string, body: IPublisherPageBodyV1, modifications?: Partial<Omit<IPublisherPageLayoutDefinitionV1, "type" | "title" | "content">>): IPublisherPageLayoutDefinitionV1;
+/**
+ * Clones a page layout into a page instance embeddable in template/document 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 newPublisherDocumentPageFromLayoutV1(page: IPublisherPageLayoutV1 | IPublisherPageLayoutDefinitionV1, localIdentifier?: string): IPublisherDocumentPageV1;
+/**
+ * Creates document content from page instances.
+ *
+ * @alpha
+ */
+export declare function newPublisherDocumentContentV1(pages: IPublisherDocumentPageV1[], modifications?: Partial<Omit<IPublisherDocumentContentV1, "version" | "pages">>): IPublisherDocumentContentV1;
+/**
+ * Creates a new document template definition.
+ *
+ * @alpha
+ */
+export declare function newPublisherDocumentTemplateDefinitionV1(title: string, content: IPublisherDocumentContentV1, modifications?: Partial<Omit<IPublisherDocumentTemplateDefinitionV1, "type" | "title" | "content">>): IPublisherDocumentTemplateDefinitionV1;
+/**
+ * Creates a document definition from a template.
+ *
+ * @remarks
+ * The template content is deep-copied; no reference to the template is kept, so the
+ * document stays frozen while the template evolves.
+ *
+ * @alpha
+ */
+export declare function newPublisherDocumentDefinitionFromTemplateV1(template: IPublisherDocumentTemplateV1 | IPublisherDocumentTemplateDefinitionV1, options: {
+    title: string;
+    periodStart: PublisherDateStringV1;
+    periodEnd: PublisherDateStringV1;
+}, modifications?: Partial<Omit<IPublisherDocumentDefinitionV1, "type" | "title" | "periodStart" | "periodEnd" | "content">>): IPublisherDocumentDefinitionV1;
+/**
+ * Creates an ad-hoc document definition not based on any template.
+ *
+ * @alpha
+ */
+export declare function newAdHocPublisherDocumentDefinitionV1(options: {
+    title: string;
+    periodStart: PublisherDateStringV1;
+    periodEnd: PublisherDateStringV1;
+    pages?: IPublisherDocumentPageV1[];
+}, modifications?: Partial<Omit<IPublisherDocumentDefinitionV1, "type" | "title" | "periodStart" | "periodEnd" | "content">>): IPublisherDocumentDefinitionV1;
+/**
+ * Convenience accessor for a document or template page by its localIdentifier.
+ *
+ * @alpha
+ */
+export declare function publisherDocumentPageV1(documentOrTemplate: IPublisherDocumentV1 | IPublisherDocumentDefinitionV1 | IPublisherDocumentTemplateV1 | IPublisherDocumentTemplateDefinitionV1, pageLocalIdentifier: string): IPublisherDocumentPageV1 | undefined;
+//# sourceMappingURL=factory.d.ts.map

package/esm/publisher/v1/factory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../../../src/publisher/v1/factory.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,2BAA2B,EAAE,KAAK,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAC/F,OAAO,EACH,KAAK,8BAA8B,EACnC,KAAK,sCAAsC,EAC3C,KAAK,4BAA4B,EACjC,KAAK,oBAAoB,EAC5B,MAAM,eAAe,CAAC;AAEvB,OAAO,EACH,KAAK,oBAAoB,EAEzB,KAAK,gCAAgC,EACrC,KAAK,sBAAsB,EAC9B,MAAM,iBAAiB,CAAC;AAGzB,OAAO,EAAE,KAAK,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AAyC5D;;;;GAIG;AACH,wBAAgB,kCAAkC,CAC9C,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,oBAAoB,EAC1B,aAAa,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,gCAAgC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC,CAAC,GAC9F,gCAAgC,CAQlC;AAED;;;;;;;;;GASG;AACH,wBAAgB,oCAAoC,CAChD,IAAI,EAAE,sBAAsB,GAAG,gCAAgC,EAC/D,eAAe,GAAE,MAAyC,GAC3D,wBAAwB,CAY1B;AAED;;;;GAIG;AACH,wBAAgB,6BAA6B,CACzC,KAAK,EAAE,wBAAwB,EAAE,EACjC,aAAa,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE,SAAS,GAAG,OAAO,CAAC,CAAC,GAChF,2BAA2B,CAM7B;AAED;;;;GAIG;AACH,wBAAgB,wCAAwC,CACpD,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,2BAA2B,EACpC,aAAa,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,sCAAsC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC,CAAC,GACpG,sCAAsC,CAOxC;AAED;;;;;;;;GAQG;AACH,wBAAgB,4CAA4C,CACxD,QAAQ,EAAE,4BAA4B,GAAG,sCAAsC,EAC/E,OAAO,EAAE;IACL,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,qBAAqB,CAAC;IACnC,SAAS,EAAE,qBAAqB,CAAC;CACpC,EACD,aAAa,CAAC,EAAE,OAAO,CACnB,IAAI,CAAC,8BAA8B,EAAE,MAAM,GAAG,OAAO,GAAG,aAAa,GAAG,WAAW,GAAG,SAAS,CAAC,CACnG,GACF,8BAA8B,CAShC;AAED;;;;GAIG;AACH,wBAAgB,qCAAqC,CACjD,OAAO,EAAE;IACL,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,qBAAqB,CAAC;IACnC,SAAS,EAAE,qBAAqB,CAAC;IACjC,KAAK,CAAC,EAAE,wBAAwB,EAAE,CAAC;CACtC,EACD,aAAa,CAAC,EAAE,OAAO,CACnB,IAAI,CAAC,8BAA8B,EAAE,MAAM,GAAG,OAAO,GAAG,aAAa,GAAG,WAAW,GAAG,SAAS,CAAC,CACnG,GACF,8BAA8B,CAShC;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CACnC,kBAAkB,EACZ,oBAAoB,GACpB,8BAA8B,GAC9B,4BAA4B,GAC5B,sCAAsC,EAC5C,mBAAmB,EAAE,MAAM,GAC5B,wBAAwB,GAAG,SAAS,CAEtC"}

package/esm/publisher/{factory.js → v1/factory.js}

@@ -1,6 +1,6 @@
 // (C) 2026 GoodData Corporation
-import { isPublisherLayoutSection } from "./layout.js";
-import { isPublisherImageBackground } from "./styling.js";
+import { isPublisherLayoutSectionV1 } from "./layout.js";
+import { isPublisherImageBackgroundV1 } from "./styling.js";
 function generatePublisherLocalId(prefix) {
     const unique = typeof crypto !== "undefined" && typeof crypto.randomUUID === "function"
         ? crypto.randomUUID().replace(/-/g, "").slice(0, 12)
@@ -11,7 +11,7 @@ function deepClone(value) {
     return JSON.parse(JSON.stringify(value));
 }
 function prefixBackgroundSlotId(style, prefix) {
-    if (!style?.background || !isPublisherImageBackground(style.background)) {
+    if (!style?.background || !isPublisherImageBackgroundV1(style.background)) {
         return style;
     }
     return {
@@ -20,7 +20,7 @@ function prefixBackgroundSlotId(style, prefix) {
     };
 }
 function prefixLayoutSlotIds(node, prefix) {
-    if (isPublisherLayoutSection(node)) {
+    if (isPublisherLayoutSectionV1(node)) {
         return {
             ...node,
             ...(node.style === undefined ? {} : { style: prefixBackgroundSlotId(node.style, prefix) }),
@@ -37,7 +37,7 @@ function prefixLayoutSlotIds(node, prefix) {
  *
  * @alpha
  */
-export function newPublisherPageLayoutDefinition(title, body, modifications) {
+export function newPublisherPageLayoutDefinitionV1(title, body, modifications) {
     const content = { version: "1", ...body };
     return {
         type: "reportPageLayout",
@@ -56,7 +56,7 @@ export function newPublisherPageLayoutDefinition(title, body, modifications) {
  *
  * @alpha
  */
-export function newPublisherDocumentPageFromLayout(page, localIdentifier = generatePublisherLocalId("page")) {
+export function newPublisherDocumentPageFromLayoutV1(page, localIdentifier = generatePublisherLocalId("page")) {
     const { version: _version, ...body } = deepClone(page.content);
     return {
         ...body,
@@ -74,7 +74,7 @@ export function newPublisherDocumentPageFromLayout(page, localIdentifier = gener
  *
  * @alpha
  */
-export function newPublisherDocumentContent(pages, modifications) {
+export function newPublisherDocumentContentV1(pages, modifications) {
     return {
         version: "1",
         pages,
@@ -86,7 +86,7 @@ export function newPublisherDocumentContent(pages, modifications) {
  *
  * @alpha
  */
-export function newPublisherDocumentTemplateDefinition(title, content, modifications) {
+export function newPublisherDocumentTemplateDefinitionV1(title, content, modifications) {
     return {
         type: "reportTemplate",
         title,
@@ -103,7 +103,7 @@ export function newPublisherDocumentTemplateDefinition(title, content, modificat
  *
  * @alpha
  */
-export function newPublisherDocumentDefinitionFromTemplate(template, options, modifications) {
+export function newPublisherDocumentDefinitionFromTemplateV1(template, options, modifications) {
     return {
         type: "report",
         title: options.title,
@@ -118,13 +118,13 @@ export function newPublisherDocumentDefinitionFromTemplate(template, options, mo
  *
  * @alpha
  */
-export function newAdHocPublisherDocumentDefinition(options, modifications) {
+export function newAdHocPublisherDocumentDefinitionV1(options, modifications) {
     return {
         type: "report",
         title: options.title,
         periodStart: options.periodStart,
         periodEnd: options.periodEnd,
-        content: newPublisherDocumentContent(options.pages ?? []),
+        content: newPublisherDocumentContentV1(options.pages ?? []),
         ...modifications,
     };
 }
@@ -133,6 +133,6 @@ export function newAdHocPublisherDocumentDefinition(options, modifications) {
  *
  * @alpha
  */
-export function publisherDocumentPage(documentOrTemplate, pageLocalIdentifier) {
+export function publisherDocumentPageV1(documentOrTemplate, pageLocalIdentifier) {
     return documentOrTemplate.content.pages.find((page) => page.localIdentifier === pageLocalIdentifier);
 }

package/esm/publisher/{layout.d.ts → v1/layout.d.ts}

@@ -1,18 +1,18 @@
-import { type IPublisherBoxStyle } from "./styling.js";
+import { type IPublisherBoxStyleV1 } from "./styling.js";
 /**
  * Node of a page layout: a recursive row/column split tree (flexbox semantics)
  * over a fixed page. Leaves assign their area to slots; the tree carries geometry and
- * box paint, slot content lives in {@link IPublisherPageBody.slots}.
+ * box paint, slot content lives in {@link IPublisherPageBodyV1.slots}.
  *
  * @alpha
  */
-export type PublisherPageLayoutNode = IPublisherLayoutSection | IPublisherLayoutSlotRef;
+export type PublisherPageLayoutNodeV1 = IPublisherLayoutSectionV1 | IPublisherLayoutSlotRefV1;
 /**
  * Fields common to all page layout nodes.
  *
  * @alpha
  */
-export interface IPublisherLayoutNodeBase {
+export interface IPublisherLayoutNodeBaseV1 {
     /**
      * 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.
@@ -24,41 +24,41 @@ export interface IPublisherLayoutNodeBase {
  *
  * @alpha
  */
-export interface IPublisherLayoutSection extends IPublisherLayoutNodeBase {
+export interface IPublisherLayoutSectionV1 extends IPublisherLayoutNodeBaseV1 {
     type: "section";
     /**
      * "row" lays children out horizontally, "column" vertically.
      */
     direction: "row" | "column";
-    children: PublisherPageLayoutNode[];
+    children: PublisherPageLayoutNodeV1[];
     /**
      * Paint of this section's box. Never affects how children are laid out.
      */
-    style?: IPublisherBoxStyle;
+    style?: IPublisherBoxStyleV1;
 }
 /**
  * A leaf assigning its area to a slot. The slot fills the area completely.
  *
  * @alpha
  */
-export interface IPublisherLayoutSlotRef extends IPublisherLayoutNodeBase {
+export interface IPublisherLayoutSlotRefV1 extends IPublisherLayoutNodeBaseV1 {
     type: "slotRef";
     /**
-     * Local identifier of a slot in {@link IPublisherPageBody.slots}.
+     * Local identifier of a slot in {@link IPublisherPageBodyV1.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 IPublisherLayoutSection}.
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherLayoutSectionV1}.
  *
  * @alpha
  */
-export declare function isPublisherLayoutSection(obj: unknown): obj is IPublisherLayoutSection;
+export declare function isPublisherLayoutSectionV1(obj: unknown): obj is IPublisherLayoutSectionV1;
 /**
- * Type-guard testing whether the provided object is an instance of {@link IPublisherLayoutSlotRef}.
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherLayoutSlotRefV1}.
  *
  * @alpha
  */
-export declare function isPublisherLayoutSlotRef(obj: unknown): obj is IPublisherLayoutSlotRef;
+export declare function isPublisherLayoutSlotRefV1(obj: unknown): obj is IPublisherLayoutSlotRefV1;
 //# sourceMappingURL=layout.d.ts.map

package/esm/publisher/v1/layout.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"layout.d.ts","sourceRoot":"","sources":["../../../src/publisher/v1/layout.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAEzD;;;;;;GAMG;AACH,MAAM,MAAM,yBAAyB,GAAG,yBAAyB,GAAG,yBAAyB,CAAC;AAE9F;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACvC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAA0B,SAAQ,0BAA0B;IACzE,IAAI,EAAE,SAAS,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,KAAK,GAAG,QAAQ,CAAC;IAE5B,QAAQ,EAAE,yBAAyB,EAAE,CAAC;IAEtC;;OAEG;IACH,KAAK,CAAC,EAAE,oBAAoB,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAA0B,SAAQ,0BAA0B;IACzE,IAAI,EAAE,SAAS,CAAC;IAEhB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;CAClB;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,yBAAyB,CAEzF;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,yBAAyB,CAEzF"}

package/esm/publisher/{layout.js → v1/layout.js}

@@ -1,18 +1,18 @@
 // (C) 2026 GoodData Corporation
 import { isEmpty } from "lodash-es";
 /**
- * Type-guard testing whether the provided object is an instance of {@link IPublisherLayoutSection}.
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherLayoutSectionV1}.
  *
  * @alpha
  */
-export function isPublisherLayoutSection(obj) {
+export function isPublisherLayoutSectionV1(obj) {
     return !isEmpty(obj) && obj.type === "section";
 }
 /**
- * Type-guard testing whether the provided object is an instance of {@link IPublisherLayoutSlotRef}.
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherLayoutSlotRefV1}.
  *
  * @alpha
  */
-export function isPublisherLayoutSlotRef(obj) {
+export function isPublisherLayoutSlotRefV1(obj) {
     return !isEmpty(obj) && obj.type === "slotRef";
 }

package/esm/publisher/{pageFormat.d.ts → v1/pageFormat.d.ts}

@@ -8,31 +8,31 @@
  *
  * @alpha
  */
-export type PublisherPageFormat = "widescreen" | "a4Portrait" | "letterPortrait";
+export type PublisherPageFormatV1 = "widescreen" | "a4Portrait" | "letterPortrait";
 /**
  * Format assumed by a page that declares none, which keeps pages authored before formats existed
  * on the shape they were designed for.
  *
  * @alpha
  */
-export declare const DefaultPublisherPageFormat: PublisherPageFormat;
+export declare const DefaultPublisherPageFormatV1: PublisherPageFormatV1;
 /**
  * List of built-in page format names.
  *
  * @alpha
  */
-export declare const PublisherPageFormats: PublisherPageFormat[];
+export declare const PublisherPageFormatsV1: PublisherPageFormatV1[];
 /**
  * Width divided by height for each page format: 16:9 for a widescreen page, ISO A4 (210 x 297 mm) and
  * US Letter (8.5 x 11 in) upright.
  *
  * @alpha
  */
-export declare const PublisherPageFormatAspectRatios: Record<PublisherPageFormat, number>;
+export declare const PublisherPageFormatAspectRatiosV1: Record<PublisherPageFormatV1, number>;
 /**
- * Type-guard testing whether the provided value is a {@link PublisherPageFormat}.
+ * Type-guard testing whether the provided value is a {@link PublisherPageFormatV1}.
  *
  * @alpha
  */
-export declare function isPublisherPageFormat(value: unknown): value is PublisherPageFormat;
+export declare function isPublisherPageFormatV1(value: unknown): value is PublisherPageFormatV1;
 //# sourceMappingURL=pageFormat.d.ts.map

package/esm/publisher/v1/pageFormat.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pageFormat.d.ts","sourceRoot":"","sources":["../../../src/publisher/v1/pageFormat.ts"],"names":[],"mappings":"AAEA;;;;;;;;;GASG;AACH,MAAM,MAAM,qBAAqB,GAAG,YAAY,GAAG,YAAY,GAAG,gBAAgB,CAAC;AAEnF;;;;;GAKG;AACH,eAAO,MAAM,4BAA4B,EAAE,qBAAoC,CAAC;AAEhF;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,EAAE,qBAAqB,EAAmD,CAAC;AAE9G;;;;;GAKG;AACH,eAAO,MAAM,iCAAiC,EAAE,MAAM,CAAC,qBAAqB,EAAE,MAAM,CAInF,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,qBAAqB,CAEtF"}

package/esm/publisher/{pageFormat.js → v1/pageFormat.js}

@@ -5,29 +5,29 @@
  *
  * @alpha
  */
-export const DefaultPublisherPageFormat = "widescreen";
+export const DefaultPublisherPageFormatV1 = "widescreen";
 /**
  * List of built-in page format names.
  *
  * @alpha
  */
-export const PublisherPageFormats = ["widescreen", "a4Portrait", "letterPortrait"];
+export const PublisherPageFormatsV1 = ["widescreen", "a4Portrait", "letterPortrait"];
 /**
  * Width divided by height for each page format: 16:9 for a widescreen page, ISO A4 (210 x 297 mm) and
  * US Letter (8.5 x 11 in) upright.
  *
  * @alpha
  */
-export const PublisherPageFormatAspectRatios = {
+export const PublisherPageFormatAspectRatiosV1 = {
     widescreen: 16 / 9,
     a4Portrait: 210 / 297,
     letterPortrait: 8.5 / 11,
 };
 /**
- * Type-guard testing whether the provided value is a {@link PublisherPageFormat}.
+ * Type-guard testing whether the provided value is a {@link PublisherPageFormatV1}.
  *
  * @alpha
  */
-export function isPublisherPageFormat(value) {
-    return typeof value === "string" && PublisherPageFormats.includes(value);
+export function isPublisherPageFormatV1(value) {
+    return typeof value === "string" && PublisherPageFormatsV1.includes(value);
 }

package/esm/publisher/{pageLayout.d.ts → v1/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 PublisherPageLayoutNode } from "./layout.js";
-import { type PublisherPageFormat } from "./pageFormat.js";
-import { type PublisherSlot } from "./slot.js";
-import { type IPublisherBoxStyle } from "./styling.js";
+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 PublisherPageLayoutNodeV1 } from "./layout.js";
+import { type PublisherPageFormatV1 } from "./pageFormat.js";
+import { type PublisherSlotV1 } from "./slot.js";
+import { type IPublisherBoxStyleV1 } from "./styling.js";
 /**
  * Body of a document page: geometry (flex split tree) plus the slots it places.
  *
  * @remarks
- * This is both the content of the standalone {@link IPublisherPageLayout} object and the shape
- * embedded in template/document content ({@link IPublisherDocumentPage}).
+ * This is both the content of the standalone {@link IPublisherPageLayoutV1} object and the shape
+ * embedded in template/document content ({@link IPublisherDocumentPageV1}).
  *
  * 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 IPublisherBoxStyle } from "./styling.js";
  *
  * @alpha
  */
-export interface IPublisherPageBody {
+export interface IPublisherPageBodyV1 {
     /**
      * 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 IPublisherPageBody {
     kind?: "cover" | "section" | "content";
     /**
      * Page proportions the layout was authored for. Defaults to
-     * {@link DefaultPublisherPageFormat}.
+     * {@link DefaultPublisherPageFormatV1}.
      */
-    format?: PublisherPageFormat;
+    format?: PublisherPageFormatV1;
     /**
      * Paint of the page itself, behind everything the layout places.
      */
-    style?: IPublisherBoxStyle;
+    style?: IPublisherBoxStyleV1;
     /**
      * Root of the page layout tree.
      */
-    layout: PublisherPageLayoutNode;
+    layout: PublisherPageLayoutNodeV1;
     /**
      * All slots referenced by the layout, flat, keyed by localIdentifier.
      */
-    slots: PublisherSlot[];
+    slots: PublisherSlotV1[];
     /**
      * Page-level filters: merged over content-level filters (a filter targeting the
      * same object replaces the inherited one); slot filters apply on top.
@@ -52,7 +52,7 @@ export interface IPublisherPageBody {
  *
  * @alpha
  */
-export interface IPublisherPageLayoutContent extends IPublisherPageBody {
+export interface IPublisherPageLayoutContentV1 extends IPublisherPageBodyV1 {
     /**
      * Content model version, for stored-content evolution.
      */
@@ -63,7 +63,7 @@ export interface IPublisherPageLayoutContent extends IPublisherPageBody {
  *
  * @alpha
  */
-export interface IPublisherPageLayoutDefinition {
+export interface IPublisherPageLayoutDefinitionV1 {
     type: "reportPageLayout";
     /**
      * Present when updating an existing page.
@@ -72,14 +72,14 @@ export interface IPublisherPageLayoutDefinition {
     title: string;
     description?: string;
     tags?: string[];
-    content: IPublisherPageLayoutContent;
+    content: IPublisherPageLayoutContentV1;
 }
 /**
  * Reusable page layout metadata object.
  *
  * @alpha
  */
-export interface IPublisherPageLayout extends IPublisherPageLayoutDefinition, IAuditableDates, IAuditableUsers {
+export interface IPublisherPageLayoutV1 extends IPublisherPageLayoutDefinitionV1, IAuditableDates, IAuditableUsers {
     ref: ObjRef;
     /**
      * When true, the object comes from a parent workspace and is not editable
@@ -93,29 +93,29 @@ export interface IPublisherPageLayout extends IPublisherPageLayoutDefinition, IA
     isBuiltIn?: boolean;
 }
 /**
- * Type-guard testing whether the provided object is an instance of {@link IPublisherPageLayoutDefinition}.
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherPageLayoutDefinitionV1}.
  *
  * @alpha
  */
-export declare function isPublisherPageLayoutDefinition(obj: unknown): obj is IPublisherPageLayoutDefinition;
+export declare function isPublisherPageLayoutDefinitionV1(obj: unknown): obj is IPublisherPageLayoutDefinitionV1;
 /**
- * Type-guard testing whether the provided object is an instance of {@link IPublisherPageLayout}.
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherPageLayoutV1}.
  *
  * @alpha
  */
-export declare function isPublisherPageLayout(obj: unknown): obj is IPublisherPageLayout;
+export declare function isPublisherPageLayoutV1(obj: unknown): obj is IPublisherPageLayoutV1;
 /**
- * Type-guard testing whether the provided object is an instance of {@link IPublisherPageLayoutContent}.
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherPageLayoutContentV1}.
  *
  * @alpha
  */
-export declare function isPublisherPageLayoutContentV1(obj: unknown): obj is IPublisherPageLayoutContent;
+export declare function isPublisherPageLayoutContentV1(obj: unknown): obj is IPublisherPageLayoutContentV1;
 /**
  * Validation issue found in a page body.
  *
  * @alpha
  */
-export interface IPublisherPageBodyValidationIssue {
+export interface IPublisherPageBodyValidationIssueV1 {
     severity: "error" | "warning";
     message: string;
 }
@@ -129,5 +129,5 @@ export interface IPublisherPageBodyValidationIssue {
  *
  * @alpha
  */
-export declare function validatePublisherPageBody(body: IPublisherPageBody): IPublisherPageBodyValidationIssue[];
+export declare function validatePublisherPageBodyV1(body: IPublisherPageBodyV1): IPublisherPageBodyValidationIssueV1[];
 //# sourceMappingURL=pageLayout.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pageLayout.d.ts","sourceRoot":"","sources":["../../../src/publisher/v1/pageLayout.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,eAAe,EAAE,KAAK,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACpF,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAC1E,OAAO,EAAE,KAAK,MAAM,EAAY,MAAM,uBAAuB,CAAC;AAE9D,OAAO,EACH,KAAK,yBAAyB,EAGjC,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,KAAK,qBAAqB,EAA2B,MAAM,iBAAiB,CAAC;AACtF,OAAO,EAAE,KAAK,eAAe,EAAiD,MAAM,WAAW,CAAC;AAChG,OAAO,EAAE,KAAK,oBAAoB,EAAgC,MAAM,cAAc,CAAC;AAEvF;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,oBAAoB;IACjC;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,SAAS,CAAC;IAEvC;;;OAGG;IACH,MAAM,CAAC,EAAE,qBAAqB,CAAC;IAE/B;;OAEG;IACH,KAAK,CAAC,EAAE,oBAAoB,CAAC;IAE7B;;OAEG;IACH,MAAM,EAAE,yBAAyB,CAAC;IAElC;;OAEG;IACH,KAAK,EAAE,eAAe,EAAE,CAAC;IAEzB;;;OAGG;IACH,OAAO,CAAC,EAAE,iBAAiB,EAAE,CAAC;CACjC;AAED;;;;GAIG;AACH,MAAM,WAAW,6BAA8B,SAAQ,oBAAoB;IACvE;;OAEG;IACH,OAAO,EAAE,GAAG,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,gCAAgC;IAC7C,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,6BAA6B,CAAC;CAC1C;AAED;;;;GAIG;AACH,MAAM,WAAW,sBACb,SAAQ,gCAAgC,EAAE,eAAe,EAAE,eAAe;IAC1E,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,iCAAiC,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,gCAAgC,CAEvG;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,sBAAsB,CAEnF;AAED;;;;GAIG;AACH,wBAAgB,8BAA8B,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,6BAA6B,CAOjG;AAED;;;;GAIG;AACH,MAAM,WAAW,mCAAmC;IAChD,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B,OAAO,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;;;GASG;AACH,wBAAgB,2BAA2B,CACvC,IAAI,EAAE,oBAAoB,GAC3B,mCAAmC,EAAE,CA+FvC"}

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

@@ -1,28 +1,28 @@
 // (C) 2026 GoodData Corporation
 import { isEmpty } from "lodash-es";
-import { isObjRef } from "../objRef/index.js";
-import { isPublisherLayoutSection, isPublisherLayoutSlotRef, } from "./layout.js";
-import { isPublisherPageFormat } from "./pageFormat.js";
-import { isPublisherImageSlot, isPublisherTextSlot } from "./slot.js";
-import { isPublisherImageBackground } from "./styling.js";
+import { isObjRef } from "../../objRef/index.js";
+import { isPublisherLayoutSectionV1, isPublisherLayoutSlotRefV1, } from "./layout.js";
+import { isPublisherPageFormatV1 } from "./pageFormat.js";
+import { isPublisherImageSlotV1, isPublisherTextSlotV1 } from "./slot.js";
+import { isPublisherImageBackgroundV1 } from "./styling.js";
 /**
- * Type-guard testing whether the provided object is an instance of {@link IPublisherPageLayoutDefinition}.
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherPageLayoutDefinitionV1}.
  *
  * @alpha
  */
-export function isPublisherPageLayoutDefinition(obj) {
+export function isPublisherPageLayoutDefinitionV1(obj) {
     return !isEmpty(obj) && obj.type === "reportPageLayout";
 }
 /**
- * Type-guard testing whether the provided object is an instance of {@link IPublisherPageLayout}.
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherPageLayoutV1}.
  *
  * @alpha
  */
-export function isPublisherPageLayout(obj) {
-    return isPublisherPageLayoutDefinition(obj) && isObjRef(obj.ref);
+export function isPublisherPageLayoutV1(obj) {
+    return isPublisherPageLayoutDefinitionV1(obj) && isObjRef(obj.ref);
 }
 /**
- * Type-guard testing whether the provided object is an instance of {@link IPublisherPageLayoutContent}.
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherPageLayoutContentV1}.
  *
  * @alpha
  */
@@ -42,9 +42,9 @@ export function isPublisherPageLayoutContentV1(obj) {
  *
  * @alpha
  */
-export function validatePublisherPageBody(body) {
+export function validatePublisherPageBodyV1(body) {
     const issues = [];
-    if (body.format !== undefined && !isPublisherPageFormat(body.format)) {
+    if (body.format !== undefined && !isPublisherPageFormatV1(body.format)) {
         issues.push({ severity: "error", message: `Unknown page format "${body.format}".` });
     }
     const checkLength = (name, value) => {
@@ -70,7 +70,7 @@ export function validatePublisherPageBody(body) {
     const checkBoxStyle = (style, isDrawn) => {
         checkLength("Border radius", style?.borderRadius);
         checkLength("Padding", style?.padding);
-        if (!style?.background || !isPublisherImageBackground(style.background)) {
+        if (!style?.background || !isPublisherImageBackgroundV1(style.background)) {
             return;
         }
         const { slotId } = style.background;
@@ -82,7 +82,7 @@ export function validatePublisherPageBody(body) {
             });
             return;
         }
-        if (!isPublisherImageSlot(slot)) {
+        if (!isPublisherImageSlotV1(slot)) {
             issues.push({
                 severity: "error",
                 message: `Background references slot "${slotId}" which is not an image slot.`,
@@ -102,7 +102,7 @@ export function validatePublisherPageBody(body) {
                 message: `Layout node weight must be positive, got ${node.weight}.`,
             });
         }
-        if (isPublisherLayoutSlotRef(node)) {
+        if (isPublisherLayoutSlotRefV1(node)) {
             referencedIds.add(node.slotId);
             if (!slotIds.has(node.slotId)) {
                 issues.push({
@@ -111,14 +111,14 @@ export function validatePublisherPageBody(body) {
                 });
             }
         }
-        else if (isPublisherLayoutSection(node)) {
+        else if (isPublisherLayoutSectionV1(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(isPublisherTextSlot)) {
+    for (const slot of body.slots.filter(isPublisherTextSlotV1)) {
         checkBoxStyle(slot.style, referencedIds.has(slot.localIdentifier));
     }
     for (const slotId of slotIds) {