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

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

@@ -0,0 +1,69 @@
+import { type ObjRef } from "../../objRef/index.js";
+import { type IPublisherDocumentPageV2, type IPublisherPageBodyV2 } from "./page.js";
+/**
+ * Generates an id such as `widget_7f3a91c4`.
+ *
+ * @remarks
+ * For a valid id, the prefix uses only `[A-Za-z0-9_.-]`, has at most 55 characters and does not
+ * start with `default.`.
+ *
+ * @alpha
+ */
+export declare function newPublisherIdV2(prefix: string): string;
+/**
+ * Generates a page id such as `page_7f3a91c4`.
+ *
+ * @alpha
+ */
+export declare function newPublisherPageIdV2(): string;
+/**
+ * Generates a section id such as `section_7f3a91c4`.
+ *
+ * @alpha
+ */
+export declare function newPublisherSectionIdV2(): string;
+/**
+ * Generates a widget id such as `widget_7f3a91c4`.
+ *
+ * @alpha
+ */
+export declare function newPublisherWidgetIdV2(): string;
+/**
+ * @alpha
+ */
+export interface INewPublisherDocumentFilterIdOptionsV2 {
+    /**
+     * The label of an attribute filter or the dataset of a date filter, as an identifier ref.
+     */
+    target: ObjRef;
+    /**
+     * Local identifiers of the document's `content.filters`.
+     */
+    usedIds: ReadonlySet<string>;
+}
+/**
+ * Generates a document filter id such as `document_filter_region_name`.
+ *
+ * @remarks
+ * Every character of the target's identifier outside `[A-Za-z0-9_]` becomes `_`, and the id is cut to
+ * 64 characters. When the document already uses the id, `_2`, `_3` and so on is appended, with the
+ * base shortened so the id stays within 64 characters.
+ *
+ * Throws when the target is not an identifier ref.
+ *
+ * @alpha
+ */
+export declare function newPublisherDocumentFilterIdV2({ target, usedIds, }: INewPublisherDocumentFilterIdOptionsV2): string;
+/**
+ * Copies a page template's content into a new document page.
+ *
+ * @remarks
+ * The page is a deep copy with its own page id. Widget ids stay as written, so pages made from
+ * one template share widget ids; a widget is addressed by page id plus widget id.
+ *
+ * A document page can be passed as the template: its `id` is replaced and its `visible` is dropped.
+ *
+ * @alpha
+ */
+export declare function newPublisherDocumentPageFromTemplateV2(body: IPublisherPageBodyV2 & Partial<Pick<IPublisherDocumentPageV2, "id" | "visible">>, id?: string): IPublisherDocumentPageV2;
+//# sourceMappingURL=factory.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../../../src/publisher/v2/factory.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,MAAM,EAAmB,MAAM,uBAAuB,CAAC;AAErE,OAAO,EAAE,KAAK,wBAAwB,EAAE,KAAK,oBAAoB,EAAE,MAAM,WAAW,CAAC;AAErF;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAIvD;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,IAAI,MAAM,CAE7C;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,IAAI,MAAM,CAEhD;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,IAAI,MAAM,CAE/C;AAED;;GAEG;AACH,MAAM,WAAW,sCAAsC;IACnD;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;CAChC;AAID;;;;;;;;;;;GAWG;AACH,wBAAgB,8BAA8B,CAAC,EAC3C,MAAM,EACN,OAAO,GACV,EAAE,sCAAsC,GAAG,MAAM,CAUjD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,sCAAsC,CAClD,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE,IAAI,GAAG,SAAS,CAAC,CAAC,EACtF,EAAE,GAAE,MAA+B,GACpC,wBAAwB,CAG1B"}

package/esm/publisher/v2/factory.js

@@ -0,0 +1,80 @@
+// (C) 2026 GoodData Corporation
+import { invariant } from "ts-invariant";
+import { isIdentifierRef } from "../../objRef/index.js";
+/**
+ * Generates an id such as `widget_7f3a91c4`.
+ *
+ * @remarks
+ * For a valid id, the prefix uses only `[A-Za-z0-9_.-]`, has at most 55 characters and does not
+ * start with `default.`.
+ *
+ * @alpha
+ */
+export function newPublisherIdV2(prefix) {
+    const bytes = crypto.getRandomValues(new Uint8Array(4));
+    const hex = Array.from(bytes, (byte) => byte.toString(16).padStart(2, "0")).join("");
+    return `${prefix}_${hex}`;
+}
+/**
+ * Generates a page id such as `page_7f3a91c4`.
+ *
+ * @alpha
+ */
+export function newPublisherPageIdV2() {
+    return newPublisherIdV2("page");
+}
+/**
+ * Generates a section id such as `section_7f3a91c4`.
+ *
+ * @alpha
+ */
+export function newPublisherSectionIdV2() {
+    return newPublisherIdV2("section");
+}
+/**
+ * Generates a widget id such as `widget_7f3a91c4`.
+ *
+ * @alpha
+ */
+export function newPublisherWidgetIdV2() {
+    return newPublisherIdV2("widget");
+}
+const maxIdLength = 64;
+/**
+ * Generates a document filter id such as `document_filter_region_name`.
+ *
+ * @remarks
+ * Every character of the target's identifier outside `[A-Za-z0-9_]` becomes `_`, and the id is cut to
+ * 64 characters. When the document already uses the id, `_2`, `_3` and so on is appended, with the
+ * base shortened so the id stays within 64 characters.
+ *
+ * Throws when the target is not an identifier ref.
+ *
+ * @alpha
+ */
+export function newPublisherDocumentFilterIdV2({ target, usedIds, }) {
+    invariant(isIdentifierRef(target), "A document filter id needs an identifier ref as its target.");
+    const base = `document_filter_${target.identifier.replace(/[^A-Za-z0-9_]/g, "_")}`;
+    for (let attempt = 1;; attempt++) {
+        const suffix = attempt === 1 ? "" : `_${attempt}`;
+        const id = base.slice(0, maxIdLength - suffix.length) + suffix;
+        if (!usedIds.has(id)) {
+            return id;
+        }
+    }
+}
+/**
+ * Copies a page template's content into a new document page.
+ *
+ * @remarks
+ * The page is a deep copy with its own page id. Widget ids stay as written, so pages made from
+ * one template share widget ids; a widget is addressed by page id plus widget id.
+ *
+ * A document page can be passed as the template: its `id` is replaced and its `visible` is dropped.
+ *
+ * @alpha
+ */
+export function newPublisherDocumentPageFromTemplateV2(body, id = newPublisherPageIdV2()) {
+    const { id: _id, visible: _visible, ...content } = structuredClone(body);
+    return { ...content, id };
+}

package/esm/publisher/v2/layout.d.ts

@@ -0,0 +1,48 @@
+import { type IPublisherContainerStyleV2 } from "./style.js";
+import { type PublisherWidgetV2 } from "./widget.js";
+/**
+ * @alpha
+ */
+export type PublisherLayoutNodeV2 = IPublisherContainerV2 | PublisherWidgetV2;
+/**
+ * Row or column of layout nodes.
+ *
+ * @alpha
+ */
+export interface IPublisherContainerV2 {
+    type: "row" | "column";
+    /**
+     * Matches `[A-Za-z0-9_.-]{1,64}`.
+     */
+    id?: string;
+    /**
+     * In reading order. An empty list renders as a spacer.
+     */
+    children: PublisherLayoutNodeV2[];
+    /**
+     * Share of the parent's main axis, greater than 0. Defaults to 1.
+     */
+    proportion?: number;
+    /**
+     * Enforced by the editor, never checked on write.
+     */
+    locked?: boolean;
+    style?: IPublisherContainerStyleV2;
+}
+/**
+ * @alpha
+ */
+export declare function isPublisherContainerV2(obj: unknown): obj is IPublisherContainerV2;
+/**
+ * @alpha
+ */
+export declare function isPublisherRowV2(obj: unknown): obj is IPublisherContainerV2 & {
+    type: "row";
+};
+/**
+ * @alpha
+ */
+export declare function isPublisherColumnV2(obj: unknown): obj is IPublisherContainerV2 & {
+    type: "column";
+};
+//# sourceMappingURL=layout.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"layout.d.ts","sourceRoot":"","sources":["../../../src/publisher/v2/layout.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,0BAA0B,EAAE,MAAM,YAAY,CAAC;AAC7D,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,qBAAqB,GAAG,iBAAiB,CAAC;AAE9E;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IAClC,IAAI,EAAE,KAAK,GAAG,QAAQ,CAAC;IACvB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,QAAQ,EAAE,qBAAqB,EAAE,CAAC;IAClC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,0BAA0B,CAAC;CACtC;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,qBAAqB,CAEjF;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,qBAAqB,GAAG;IAAE,IAAI,EAAE,KAAK,CAAA;CAAE,CAE7F;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,qBAAqB,GAAG;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,CAEnG"}

package/esm/publisher/v2/layout.js

@@ -0,0 +1,20 @@
+// (C) 2026 GoodData Corporation
+import { isEmpty } from "lodash-es";
+/**
+ * @alpha
+ */
+export function isPublisherContainerV2(obj) {
+    return isPublisherRowV2(obj) || isPublisherColumnV2(obj);
+}
+/**
+ * @alpha
+ */
+export function isPublisherRowV2(obj) {
+    return !isEmpty(obj) && obj.type === "row";
+}
+/**
+ * @alpha
+ */
+export function isPublisherColumnV2(obj) {
+    return !isEmpty(obj) && obj.type === "column";
+}

package/esm/publisher/v2/page.d.ts

@@ -0,0 +1,67 @@
+import { type FilterContextItem } from "../../dashboard/filterContext.js";
+import { type PublisherLayoutNodeV2 } from "./layout.js";
+import { type IPublisherPageStyleV2 } from "./style.js";
+/**
+ * @alpha
+ */
+export declare const PublisherPageSizesV2: readonly ["widescreen"];
+/**
+ * Page size. The widescreen design canvas is 1920 × 1080 px.
+ *
+ * @alpha
+ */
+export type PublisherPageSizeV2 = (typeof PublisherPageSizesV2)[number];
+/**
+ * @alpha
+ */
+export declare const DefaultPublisherPageSizeV2: PublisherPageSizeV2;
+/**
+ * @alpha
+ */
+export declare function isPublisherPageSizeV2(value: unknown): value is PublisherPageSizeV2;
+/**
+ * Editor hint; it does not change how the page renders.
+ *
+ * @alpha
+ */
+export type PublisherPageKindV2 = "cover" | "section" | "content";
+/**
+ * Content of one page, as a page template stores it.
+ *
+ * @alpha
+ */
+export interface IPublisherPageBodyV2 {
+    kind?: PublisherPageKindV2;
+    pageSize?: PublisherPageSizeV2;
+    /**
+     * Markdown speaker notes, never drawn on the page.
+     */
+    notes?: string;
+    style?: IPublisherPageStyleV2;
+    layout: PublisherLayoutNodeV2;
+    filters?: FilterContextItem[];
+}
+/**
+ * Page inside a document.
+ *
+ * @alpha
+ */
+export interface IPublisherDocumentPageV2 extends IPublisherPageBodyV2 {
+    /**
+     * Unique in the document. Matches `[A-Za-z0-9_.-]{1,64}`.
+     */
+    id: string;
+    /**
+     * Defaults to `true`. A hidden page is left out of the viewer, exports and page numbers.
+     */
+    visible?: boolean;
+}
+/**
+ * @alpha
+ */
+export declare function isPublisherPageBodyV2(obj: unknown): obj is IPublisherPageBodyV2;
+/**
+ * @alpha
+ */
+export declare function isPublisherDocumentPageV2(obj: unknown): obj is IPublisherDocumentPageV2;
+//# sourceMappingURL=page.d.ts.map

package/esm/publisher/v2/page.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"page.d.ts","sourceRoot":"","sources":["../../../src/publisher/v2/page.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAE1E,OAAO,EAAE,KAAK,qBAAqB,EAA0B,MAAM,aAAa,CAAC;AACjF,OAAO,EAAE,KAAK,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAGxD;;GAEG;AACH,eAAO,MAAM,oBAAoB,YAAI,YAAY,CAAU,CAAC;AAE5D;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,OAAO,oBAAoB,CAAC,CAAC,MAAM,CAAC,CAAC;AAExE;;GAEG;AACH,eAAO,MAAM,0BAA0B,EAAE,mBAAkC,CAAC;AAE5E;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,mBAAmB,CAElF;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,OAAO,GAAG,SAAS,GAAG,SAAS,CAAC;AAElE;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACjC,IAAI,CAAC,EAAE,mBAAmB,CAAC;IAC3B,QAAQ,CAAC,EAAE,mBAAmB,CAAC;IAC/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,qBAAqB,CAAC;IAC9B,MAAM,EAAE,qBAAqB,CAAC;IAC9B,OAAO,CAAC,EAAE,iBAAiB,EAAE,CAAC;CACjC;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB;IAClE;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,oBAAoB,CAM/E;AAED;;GAEG;AACH,wBAAgB,yBAAyB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,wBAAwB,CAEvF"}

package/esm/publisher/v2/page.js

@@ -0,0 +1,34 @@
+// (C) 2026 GoodData Corporation
+import { isEmpty } from "lodash-es";
+import { isPublisherContainerV2 } from "./layout.js";
+import { isPublisherWidgetV2 } from "./widget.js";
+/**
+ * @alpha
+ */
+export const PublisherPageSizesV2 = ["widescreen"];
+/**
+ * @alpha
+ */
+export const DefaultPublisherPageSizeV2 = "widescreen";
+/**
+ * @alpha
+ */
+export function isPublisherPageSizeV2(value) {
+    return PublisherPageSizesV2.some((size) => size === value);
+}
+/**
+ * @alpha
+ */
+export function isPublisherPageBodyV2(obj) {
+    if (isEmpty(obj)) {
+        return false;
+    }
+    const { layout } = obj;
+    return isPublisherContainerV2(layout) || isPublisherWidgetV2(layout);
+}
+/**
+ * @alpha
+ */
+export function isPublisherDocumentPageV2(obj) {
+    return isPublisherPageBodyV2(obj) && typeof obj.id === "string";
+}

package/esm/publisher/v2/sections.d.ts

@@ -0,0 +1,34 @@
+import { type IPublisherSectionV2, type PublisherDocumentContentV2 } from "./content.js";
+/**
+ * Returns the sections of document content. Content stored as `pages` becomes one untitled section
+ * with a generated id.
+ *
+ * @remarks
+ * For content stored as `pages`, each call returns a new section id. Read once and keep the result
+ * for as long as the section must stay the same one.
+ *
+ * @alpha
+ */
+export declare function publisherDocumentContentSectionsV2(content: PublisherDocumentContentV2): IPublisherSectionV2[];
+/**
+ * @alpha
+ */
+export interface IPublisherDocumentContentSetSectionsOptionsV2 {
+    /**
+     * Content the sections were read from. Its other keys are kept.
+     */
+    content: PublisherDocumentContentV2;
+    sections: IPublisherSectionV2[];
+}
+/**
+ * Writes sections back into document content, in the shape the content was read in.
+ *
+ * @remarks
+ * The result holds `sections` when the content held `sections`, when there is more than one section,
+ * or when the only section has a title or description. Otherwise it holds `pages`, and the section's
+ * id is dropped.
+ *
+ * @alpha
+ */
+export declare function publisherDocumentContentSetSectionsV2({ content, sections, }: IPublisherDocumentContentSetSectionsOptionsV2): PublisherDocumentContentV2;
+//# sourceMappingURL=sections.d.ts.map

package/esm/publisher/v2/sections.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sections.d.ts","sourceRoot":"","sources":["../../../src/publisher/v2/sections.ts"],"names":[],"mappings":"AAEA,OAAO,EACH,KAAK,mBAAmB,EACxB,KAAK,0BAA0B,EAElC,MAAM,cAAc,CAAC;AAGtB;;;;;;;;;GASG;AACH,wBAAgB,kCAAkC,CAC9C,OAAO,EAAE,0BAA0B,GACpC,mBAAmB,EAAE,CAKvB;AAED;;GAEG;AACH,MAAM,WAAW,6CAA6C;IAC1D;;OAEG;IACH,OAAO,EAAE,0BAA0B,CAAC;IACpC,QAAQ,EAAE,mBAAmB,EAAE,CAAC;CACnC;AAED;;;;;;;;;GASG;AACH,wBAAgB,qCAAqC,CAAC,EAClD,OAAO,EACP,QAAQ,GACX,EAAE,6CAA6C,GAAG,0BAA0B,CAM5E"}

package/esm/publisher/v2/sections.js

@@ -0,0 +1,40 @@
+// (C) 2026 GoodData Corporation
+import { isPublisherDocumentSectionsContentV2, } from "./content.js";
+import { newPublisherSectionIdV2 } from "./factory.js";
+/**
+ * Returns the sections of document content. Content stored as `pages` becomes one untitled section
+ * with a generated id.
+ *
+ * @remarks
+ * For content stored as `pages`, each call returns a new section id. Read once and keep the result
+ * for as long as the section must stay the same one.
+ *
+ * @alpha
+ */
+export function publisherDocumentContentSectionsV2(content) {
+    if (isPublisherDocumentSectionsContentV2(content)) {
+        return content.sections;
+    }
+    return [{ id: newPublisherSectionIdV2(), pages: content.pages }];
+}
+/**
+ * Writes sections back into document content, in the shape the content was read in.
+ *
+ * @remarks
+ * The result holds `sections` when the content held `sections`, when there is more than one section,
+ * or when the only section has a title or description. Otherwise it holds `pages`, and the section's
+ * id is dropped.
+ *
+ * @alpha
+ */
+export function publisherDocumentContentSetSectionsV2({ content, sections, }) {
+    const { pages: _pages, sections: _sections, ...rest } = content;
+    if (isPublisherDocumentSectionsContentV2(content) || needsSections(sections)) {
+        return { ...rest, sections };
+    }
+    return { ...rest, pages: sections.flatMap((section) => section.pages) };
+}
+function needsSections(sections) {
+    return (sections.length > 1 ||
+        sections.some(({ title, description }) => title !== undefined || description !== undefined));
+}

package/esm/publisher/v2/structure.d.ts

@@ -0,0 +1,5 @@
+import { type Check, type Issues } from "./checks.js";
+export declare const checkPageBody: Check;
+export declare const checkDocumentContent: Check;
+export declare function checkEntity(value: unknown, path: string, issues: Issues): void;
+//# sourceMappingURL=structure.d.ts.map

package/esm/publisher/v2/structure.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"structure.d.ts","sourceRoot":"","sources":["../../../src/publisher/v2/structure.ts"],"names":[],"mappings":"AAeA,OAAO,EACH,KAAK,KAAK,EACV,KAAK,MAAM,EAuBd,MAAM,aAAa,CAAC;AAgjBrB,eAAO,MAAM,aAAa,OAAiD,CAAC;AAqE5E,eAAO,MAAM,oBAAoB,OAW/B,CAAC;AAyCH,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAU9E"}