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

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

@@ -3,7 +3,7 @@
  *
  * @alpha
  */
-export type PublisherDateString = string;
+export type PublisherDateStringV1 = string;
 /**
  * Variables resolved by the rendering runtime; they are never declared or stored.
  *
@@ -13,26 +13,26 @@ export type PublisherDateString = string;
  *
  * @alpha
  */
-export type PublisherBuiltInVariable = "reportName" | "reportDescription" | "periodStart" | "periodEnd" | "reportDateRange" | "reportAttributeFilters" | "exportedAt" | "exportedBy" | "lastModifiedAt" | "lastModifiedBy" | "workspaceName" | "workspaceId" | "totalPages" | "currentPageNumber" | "logo";
+export type PublisherBuiltInVariableV1 = "reportName" | "reportDescription" | "periodStart" | "periodEnd" | "reportDateRange" | "reportAttributeFilters" | "exportedAt" | "exportedBy" | "lastModifiedAt" | "lastModifiedBy" | "workspaceName" | "workspaceId" | "totalPages" | "currentPageNumber" | "logo";
 /**
  * All built-in document variable names.
  *
  * @alpha
  */
-export declare const PublisherBuiltInVariables: PublisherBuiltInVariable[];
+export declare const PublisherBuiltInVariablesV1: PublisherBuiltInVariableV1[];
 /**
  * A custom variable declared by document content and given a value by a document.
  *
  * @remarks
- * Referenced from text as `{name}`. Values come from {@link IPublisherDocumentBase.variableValues},
- * falling back to {@link IPublisherVariableDefinition.defaultValue}.
+ * Referenced from text as `{name}`. Values come from {@link IPublisherDocumentBaseV1.variableValues},
+ * falling back to {@link IPublisherVariableDefinitionV1.defaultValue}.
  *
  * @alpha
  */
-export interface IPublisherVariableDefinition {
+export interface IPublisherVariableDefinitionV1 {
     /**
      * Variable name as used inside the `{...}` marker. Must match /^[a-zA-Z][a-zA-Z0-9_]*$/.
-     * Built-in names ({@link PublisherBuiltInVariable}) are reserved.
+     * Built-in names ({@link PublisherBuiltInVariableV1}) are reserved.
      */
     name: string;
     /**
@@ -51,13 +51,13 @@ export interface IPublisherVariableDefinition {
  *
  * @alpha
  */
-export declare function publisherTextPlaceholder(name: string): string;
+export declare function publisherTextPlaceholderV1(name: string): string;
 /**
  * Collects the distinct `{variable}` names referenced in the text, in order of first occurrence.
  *
  * @alpha
  */
-export declare function getPublisherTextPlaceholders(text: string): string[];
+export declare function getPublisherTextPlaceholdersV1(text: string): string[];
 /**
  * Replaces `{variable}` markers with values. Markers with no value are left as-is.
  * Values are inserted verbatim — there is no recursive expansion.
@@ -68,5 +68,5 @@ export declare function getPublisherTextPlaceholders(text: string): string[];
  *
  * @alpha
  */
-export declare function resolvePublisherTextPlaceholders(text: string, values: Record<string, string>): string;
+export declare function resolvePublisherTextPlaceholdersV1(text: string, values: Record<string, string>): string;
 //# sourceMappingURL=variables.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"variables.d.ts","sourceRoot":"","sources":["../../../src/publisher/v1/variables.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC;AAE3C;;;;;;;;GAQG;AACH,MAAM,MAAM,0BAA0B,GAChC,YAAY,GACZ,mBAAmB,GACnB,aAAa,GACb,WAAW,GACX,iBAAiB,GACjB,wBAAwB,GACxB,YAAY,GACZ,YAAY,GACZ,gBAAgB,GAChB,gBAAgB,GAChB,eAAe,GACf,aAAa,GACb,YAAY,GACZ,mBAAmB,GACnB,MAAM,CAAC;AAEb;;;;GAIG;AACH,eAAO,MAAM,2BAA2B,EAAE,0BAA0B,EAgBnE,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,WAAW,8BAA8B;IAC3C;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB;AAID;;;;GAIG;AACH,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE/D;AAED;;;;GAIG;AACH,wBAAgB,8BAA8B,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CASrE;AAED;;;;;;;;;GASG;AACH,wBAAgB,kCAAkC,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,CAIvG"}

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

@@ -4,7 +4,7 @@
  *
  * @alpha
  */
-export const PublisherBuiltInVariables = [
+export const PublisherBuiltInVariablesV1 = [
     "reportName",
     "reportDescription",
     "periodStart",
@@ -27,7 +27,7 @@ const placeholderRegex = /\{([a-zA-Z][a-zA-Z0-9_]*)\}/g;
  *
  * @alpha
  */
-export function publisherTextPlaceholder(name) {
+export function publisherTextPlaceholderV1(name) {
     return `{${name}}`;
 }
 /**
@@ -35,7 +35,7 @@ export function publisherTextPlaceholder(name) {
  *
  * @alpha
  */
-export function getPublisherTextPlaceholders(text) {
+export function getPublisherTextPlaceholdersV1(text) {
     const names = [];
     for (const match of text.matchAll(placeholderRegex)) {
         const name = match[1];
@@ -55,6 +55,6 @@ export function getPublisherTextPlaceholders(text) {
  *
  * @alpha
  */
-export function resolvePublisherTextPlaceholders(text, values) {
+export function resolvePublisherTextPlaceholdersV1(text, values) {
     return text.replace(placeholderRegex, (marker, name) => Object.prototype.hasOwnProperty.call(values, name) ? values[name] : marker);
 }

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

@@ -0,0 +1,58 @@
+/**
+ * @alpha
+ */
+export interface IPublisherValidationIssueV2 {
+    /**
+     * Where the problem is, for example `content.sections[1].pages[0].layout.children[2].id`.
+     * Empty for the validated value itself.
+     */
+    path: string;
+    message: string;
+}
+export type Issues = IPublisherValidationIssueV2[];
+export type Check = (value: unknown, path: string, issues: Issues) => void;
+interface IField {
+    check: Check;
+    required: boolean;
+}
+interface IOptionalField extends IField {
+    required: false;
+}
+interface IRequiredField extends IField {
+    required: true;
+}
+/**
+ * One field per key of `T`, required exactly where `T` requires the key. With `satisfies`, a key added
+ * to or removed from `T` without the same change here is a compile error.
+ */
+export type KeyTable<T> = {
+    [K in keyof Required<T>]: undefined extends T[K] ? IOptionalField : IRequiredField;
+};
+/**
+ * Also rejects keys that `T` lacks. A key spread in from another table skips the excess property check.
+ */
+type ExactKeyTable<T, Table> = Table & Record<Exclude<keyof Table, keyof Required<T>>, never>;
+export declare function optional(check: Check): IOptionalField;
+export declare function required(check: Check): IRequiredField;
+export declare function joinPath(path: string, segment: string | number): string;
+export declare function isPlainObject(value: unknown): value is Record<string, unknown>;
+export declare function describeValue(value: unknown): string;
+export declare function objectOf<T>(): <Table extends KeyTable<T>>(table: ExactKeyTable<T, Table>) => Check;
+export declare function arrayOf(item: Check): Check;
+export declare function satisfying(predicate: (value: unknown) => boolean, expected: string): Check;
+export declare function isFiniteNumber(value: unknown): value is number;
+export declare function isNonEmptyString(value: unknown): value is string;
+export declare function isLength(value: unknown): value is number;
+export declare function oneOf(values: readonly unknown[]): Check;
+export declare function matching(pattern: RegExp, expected: string): Check;
+export declare function numberIn(min: number, max: number): Check;
+export declare const nonEmptyString: Check;
+export declare const trueOrFalse: Check;
+export declare const finiteNumber: Check;
+export declare const px: Check;
+export declare const opacity: Check;
+export declare const positive: Check;
+export declare const objRef: Check;
+export declare const id: Check;
+export {};
+//# sourceMappingURL=checks.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"checks.d.ts","sourceRoot":"","sources":["../../../src/publisher/v2/checks.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,MAAM,WAAW,2BAA2B;IACxC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,MAAM,GAAG,2BAA2B,EAAE,CAAC;AAEnD,MAAM,MAAM,KAAK,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;AAE3E,UAAU,MAAM;IACZ,KAAK,EAAE,KAAK,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC;CACrB;AAED,UAAU,cAAe,SAAQ,MAAM;IACnC,QAAQ,EAAE,KAAK,CAAC;CACnB;AAED,UAAU,cAAe,SAAQ,MAAM;IACnC,QAAQ,EAAE,IAAI,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI;KACrB,CAAC,IAAI,MAAM,QAAQ,CAAC,CAAC,CAAC,GAAG,SAAS,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,cAAc,GAAG,cAAc;CACrF,CAAC;AAEF;;GAEG;AACH,KAAK,aAAa,CAAC,CAAC,EAAE,KAAK,IAAI,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,KAAK,EAAE,MAAM,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;AAE9F,wBAAgB,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,cAAc,CAErD;AAED,wBAAgB,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,cAAc,CAErD;AAED,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAKvE;AAED,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAE9E;AAID,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAMpD;AAED,wBAAgB,QAAQ,CAAC,CAAC,KAAK,CAAC,KAAK,SAAS,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,aAAa,CAAC,CAAC,EAAE,KAAK,CAAC,KAAK,KAAK,CA+BlG;AAED,wBAAgB,OAAO,CAAC,IAAI,EAAE,KAAK,GAAG,KAAK,CAQ1C;AAED,wBAAgB,UAAU,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,OAAO,EAAE,QAAQ,EAAE,MAAM,GAAG,KAAK,CAM1F;AAED,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAE9D;AAED,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAEhE;AAED,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAExD;AAED,wBAAgB,KAAK,CAAC,MAAM,EAAE,SAAS,OAAO,EAAE,GAAG,KAAK,CAEvD;AAED,wBAAgB,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,KAAK,CAEjE;AAED,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,KAAK,CAKxD;AAED,eAAO,MAAM,cAAc,OAAqD,CAAC;AACjF,eAAO,MAAM,WAAW,OAAqE,CAAC;AAC9F,eAAO,MAAM,YAAY,OAAgD,CAAC;AAC1E,eAAO,MAAM,EAAE,OAAgD,CAAC;AAChE,eAAO,MAAM,OAAO,OAAiB,CAAC;AACtC,eAAO,MAAM,QAAQ,OAAuF,CAAC;AAC7G,eAAO,MAAM,MAAM,OAA8C,CAAC;AAClE,eAAO,MAAM,EAAE,OAA4E,CAAC"}

package/esm/publisher/v2/checks.js

@@ -0,0 +1,100 @@
+// (C) 2026 GoodData Corporation
+import { isObjRef } from "../../objRef/index.js";
+export function optional(check) {
+    return { check, required: false };
+}
+export function required(check) {
+    return { check, required: true };
+}
+export function joinPath(path, segment) {
+    if (typeof segment === "number") {
+        return `${path}[${segment}]`;
+    }
+    return path === "" ? segment : `${path}.${segment}`;
+}
+export function isPlainObject(value) {
+    return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+const maxDescriptionLength = 80;
+export function describeValue(value) {
+    const description = value === null ? "null" : Array.isArray(value) ? "an array" : (JSON.stringify(value) ?? typeof value);
+    return description.length > maxDescriptionLength
+        ? `${description.slice(0, maxDescriptionLength - 1)}…`
+        : description;
+}
+export function objectOf() {
+    return (table) => {
+        const fields = table;
+        return (value, path, issues) => {
+            if (!isPlainObject(value)) {
+                issues.push({ path, message: `Expected an object, got ${describeValue(value)}.` });
+                return;
+            }
+            for (const [key, fieldValue] of Object.entries(value)) {
+                const keyPath = joinPath(path, key);
+                const field = Object.hasOwn(fields, key) ? fields[key] : undefined;
+                if (field === undefined) {
+                    issues.push({ path: keyPath, message: `Unknown key "${key}".` });
+                }
+                else if (fieldValue === null || fieldValue === "") {
+                    issues.push({
+                        path: keyPath,
+                        message: field.required
+                            ? `Expected a value, got ${describeValue(fieldValue)}.`
+                            : "Leave the key out instead of an empty value.",
+                    });
+                }
+                else if (fieldValue !== undefined) {
+                    field.check(fieldValue, keyPath, issues);
+                }
+            }
+            for (const [key, field] of Object.entries(fields)) {
+                if (field.required && value[key] === undefined) {
+                    issues.push({ path: joinPath(path, key), message: `Missing required key "${key}".` });
+                }
+            }
+        };
+    };
+}
+export function arrayOf(item) {
+    return (value, path, issues) => {
+        if (!Array.isArray(value)) {
+            issues.push({ path, message: `Expected an array, got ${describeValue(value)}.` });
+            return;
+        }
+        value.forEach((element, i) => item(element, joinPath(path, i), issues));
+    };
+}
+export function satisfying(predicate, expected) {
+    return (value, path, issues) => {
+        if (!predicate(value)) {
+            issues.push({ path, message: `Expected ${expected}, got ${describeValue(value)}.` });
+        }
+    };
+}
+export function isFiniteNumber(value) {
+    return typeof value === "number" && Number.isFinite(value);
+}
+export function isNonEmptyString(value) {
+    return typeof value === "string" && value !== "";
+}
+export function isLength(value) {
+    return isFiniteNumber(value) && value >= 0;
+}
+export function oneOf(values) {
+    return satisfying((value) => values.includes(value), values.map((v) => JSON.stringify(v)).join(", "));
+}
+export function matching(pattern, expected) {
+    return satisfying((value) => isNonEmptyString(value) && pattern.test(value), expected);
+}
+export function numberIn(min, max) {
+    return satisfying((value) => isFiniteNumber(value) && value >= min && value <= max, `a number from ${min} to ${max}`);
+}
+export const nonEmptyString = satisfying(isNonEmptyString, "a non-empty string");
+export const trueOrFalse = satisfying((value) => typeof value === "boolean", "true or false");
+export const finiteNumber = satisfying(isFiniteNumber, "a finite number");
+export const px = satisfying(isLength, "a length of 0 or more");
+export const opacity = numberIn(0, 1);
+export const positive = satisfying((value) => isFiniteNumber(value) && value > 0, "a number greater than 0");
+export const objRef = satisfying(isObjRef, "an object reference");
+export const id = matching(/^[A-Za-z0-9_.-]{1,64}$/, "an id matching [A-Za-z0-9_.-]{1,64}");

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

@@ -0,0 +1,154 @@
+import { type IDashboardAttributeFilterConfig } from "../../dashboard/dashboard.js";
+import { type FilterContextItem } from "../../dashboard/filterContext.js";
+import { type DateFilterGranularity } from "../../dateFilterConfig/index.js";
+import { type IPublisherDocumentPageV2, type PublisherPageSizeV2 } from "./page.js";
+import { type IPublisherBackgroundStyleV2, type PublisherGapValueV2 } from "./style.js";
+import { type IPublisherTakeawayGenerationV2 } from "./widget.js";
+/**
+ * @alpha
+ */
+export type PublisherContentVersionV2 = "2";
+/**
+ * Both ends are inclusive.
+ *
+ * @alpha
+ */
+export interface IPublisherAbsolutePeriodV2 {
+    type: "absolute";
+    granularity: "GDC.time.date";
+    /**
+     * `YYYY-MM-DD`.
+     */
+    from: string;
+    /**
+     * `YYYY-MM-DD`.
+     */
+    to: string;
+}
+/**
+ * Both ends are inclusive.
+ *
+ * @alpha
+ */
+export interface IPublisherRelativePeriodV2 {
+    type: "relative";
+    granularity: DateFilterGranularity;
+    /**
+     * Offset in `granularity` units from the current one, for example `-1`.
+     */
+    from: number;
+    to: number;
+}
+/**
+ * Reported period, in the dashboard date filter grammar without a dataset.
+ *
+ * @alpha
+ */
+export type PublisherPeriodV2 = IPublisherAbsolutePeriodV2 | IPublisherRelativePeriodV2;
+/**
+ * @alpha
+ */
+export declare function isPublisherAbsolutePeriodV2(obj: unknown): obj is IPublisherAbsolutePeriodV2;
+/**
+ * @alpha
+ */
+export declare function isPublisherRelativePeriodV2(obj: unknown): obj is IPublisherRelativePeriodV2;
+/**
+ * @alpha
+ */
+export interface IPublisherDocumentDefaultsV2 {
+    /**
+     * Applies to every page without its own `pageSize`.
+     */
+    pageSize?: PublisherPageSizeV2;
+    takeaway?: {
+        /**
+         * Combined with each takeaway widget's own `generation`.
+         */
+        generation?: IPublisherTakeawayGenerationV2;
+    };
+    /**
+     * Document templates only. A document stores its period on the entity.
+     */
+    period?: PublisherPeriodV2;
+}
+/**
+ * Style of the area behind the pages. Exports ignore it.
+ *
+ * @alpha
+ */
+export interface IPublisherDocumentStyleV2 extends IPublisherBackgroundStyleV2 {
+    /**
+     * Space between pages in the viewer and the editor.
+     */
+    gap?: PublisherGapValueV2;
+}
+/**
+ * Named group of pages.
+ *
+ * @alpha
+ */
+export interface IPublisherSectionV2 {
+    /**
+     * Unique in the document. Matches `[A-Za-z0-9_.-]{1,64}`.
+     */
+    id: string;
+    title?: string;
+    description?: string;
+    pages: IPublisherDocumentPageV2[];
+}
+/**
+ * Keys shared by both shapes of document content.
+ *
+ * @alpha
+ */
+export interface IPublisherDocumentContentBaseV2 {
+    defaults?: IPublisherDocumentDefaultsV2;
+    /**
+     * Date filters name their `dataSet`. At most one filter per attribute or date dataset.
+     */
+    filters?: FilterContextItem[];
+    attributeFilterConfigs?: IDashboardAttributeFilterConfig[];
+    style?: IPublisherDocumentStyleV2;
+    /**
+     * Overrides the workspace locale for this document, for example `de-DE`.
+     */
+    locale?: string;
+    /**
+     * Overrides the workspace format locale used for dates, for example `de-DE`.
+     */
+    formatLocale?: string;
+}
+/**
+ * Document content stored as a flat list of pages.
+ *
+ * @alpha
+ */
+export interface IPublisherDocumentPagesContentV2 extends IPublisherDocumentContentBaseV2 {
+    pages: IPublisherDocumentPageV2[];
+    sections?: never;
+}
+/**
+ * Document content stored as sections of pages.
+ *
+ * @alpha
+ */
+export interface IPublisherDocumentSectionsContentV2 extends IPublisherDocumentContentBaseV2 {
+    sections: IPublisherSectionV2[];
+    pages?: never;
+}
+/**
+ * Content of a document or a document template. It holds `pages` or `sections`, never both.
+ *
+ * @alpha
+ */
+export type PublisherDocumentContentV2 = IPublisherDocumentPagesContentV2 | IPublisherDocumentSectionsContentV2;
+/**
+ * @alpha
+ */
+export declare function isPublisherDocumentPagesContentV2(obj: unknown): obj is IPublisherDocumentPagesContentV2;
+/**
+ * @alpha
+ */
+export declare function isPublisherDocumentSectionsContentV2(obj: unknown): obj is IPublisherDocumentSectionsContentV2;
+//# sourceMappingURL=content.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"content.d.ts","sourceRoot":"","sources":["../../../src/publisher/v2/content.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,+BAA+B,EAAE,MAAM,8BAA8B,CAAC;AACpF,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAC1E,OAAO,EAAE,KAAK,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AAE7E,OAAO,EAAE,KAAK,wBAAwB,EAAE,KAAK,mBAAmB,EAAE,MAAM,WAAW,CAAC;AACpF,OAAO,EAAE,KAAK,2BAA2B,EAAE,KAAK,mBAAmB,EAAE,MAAM,YAAY,CAAC;AACxF,OAAO,EAAE,KAAK,8BAA8B,EAAE,MAAM,aAAa,CAAC;AAElE;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,GAAG,CAAC;AAE5C;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACvC,IAAI,EAAE,UAAU,CAAC;IACjB,WAAW,EAAE,eAAe,CAAC;IAC7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACvC,IAAI,EAAE,UAAU,CAAC;IACjB,WAAW,EAAE,qBAAqB,CAAC;IACnC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,0BAA0B,GAAG,0BAA0B,CAAC;AAExF;;GAEG;AACH,wBAAgB,2BAA2B,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,0BAA0B,CAE3F;AAED;;GAEG;AACH,wBAAgB,2BAA2B,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,0BAA0B,CAE3F;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IACzC;;OAEG;IACH,QAAQ,CAAC,EAAE,mBAAmB,CAAC;IAC/B,QAAQ,CAAC,EAAE;QACP;;WAEG;QACH,UAAU,CAAC,EAAE,8BAA8B,CAAC;KAC/C,CAAC;IACF;;OAEG;IACH,MAAM,CAAC,EAAE,iBAAiB,CAAC;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAA0B,SAAQ,2BAA2B;IAC1E;;OAEG;IACH,GAAG,CAAC,EAAE,mBAAmB,CAAC;CAC7B;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,wBAAwB,EAAE,CAAC;CACrC;AAED;;;;GAIG;AACH,MAAM,WAAW,+BAA+B;IAC5C,QAAQ,CAAC,EAAE,4BAA4B,CAAC;IACxC;;OAEG;IACH,OAAO,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAC9B,sBAAsB,CAAC,EAAE,+BAA+B,EAAE,CAAC;IAC3D,KAAK,CAAC,EAAE,yBAAyB,CAAC;IAClC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,gCAAiC,SAAQ,+BAA+B;IACrF,KAAK,EAAE,wBAAwB,EAAE,CAAC;IAClC,QAAQ,CAAC,EAAE,KAAK,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,mCAAoC,SAAQ,+BAA+B;IACxF,QAAQ,EAAE,mBAAmB,EAAE,CAAC;IAChC,KAAK,CAAC,EAAE,KAAK,CAAC;CACjB;AAED;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,GAChC,gCAAgC,GAChC,mCAAmC,CAAC;AAE1C;;GAEG;AACH,wBAAgB,iCAAiC,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,gCAAgC,CAMvG;AAED;;GAEG;AACH,wBAAgB,oCAAoC,CAChD,GAAG,EAAE,OAAO,GACb,GAAG,IAAI,mCAAmC,CAM5C"}

package/esm/publisher/v2/content.js

@@ -0,0 +1,34 @@
+// (C) 2026 GoodData Corporation
+import { isEmpty } from "lodash-es";
+/**
+ * @alpha
+ */
+export function isPublisherAbsolutePeriodV2(obj) {
+    return !isEmpty(obj) && obj.type === "absolute";
+}
+/**
+ * @alpha
+ */
+export function isPublisherRelativePeriodV2(obj) {
+    return !isEmpty(obj) && obj.type === "relative";
+}
+/**
+ * @alpha
+ */
+export function isPublisherDocumentPagesContentV2(obj) {
+    if (isEmpty(obj)) {
+        return false;
+    }
+    const { pages, sections } = obj;
+    return Array.isArray(pages) && sections === undefined;
+}
+/**
+ * @alpha
+ */
+export function isPublisherDocumentSectionsContentV2(obj) {
+    if (isEmpty(obj)) {
+        return false;
+    }
+    const { sections, pages } = obj;
+    return Array.isArray(sections) && pages === undefined;
+}

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

@@ -0,0 +1,116 @@
+import { type IAuditableDates, type IAuditableUsers } from "../../base/metadata.js";
+import { type ObjRef } from "../../objRef/index.js";
+import { type PublisherContentVersionV2, type PublisherDocumentContentV2, type PublisherPeriodV2 } from "./content.js";
+import { type IPublisherPageBodyV2 } from "./page.js";
+/**
+ * Fields shared by the definitions of all Publisher entities.
+ *
+ * @alpha
+ */
+export interface IPublisherEntityDefinitionBaseV2 {
+    /**
+     * Present when updating an existing entity.
+     */
+    ref?: ObjRef;
+    title: string;
+    description?: string;
+    tags?: string[];
+    version: PublisherContentVersionV2;
+}
+/**
+ * Fields shared by all persisted Publisher entities.
+ *
+ * @alpha
+ */
+export interface IPublisherEntityMetadataV2 extends IAuditableDates, IAuditableUsers {
+    ref: ObjRef;
+    /**
+     * When true, the object comes from a parent workspace and is not editable
+     * in the current workspace.
+     */
+    isLocked?: boolean;
+}
+/**
+ * Payload for creating or updating a document.
+ *
+ * @alpha
+ */
+export interface IPublisherDocumentDefinitionV2 extends IPublisherEntityDefinitionBaseV2 {
+    type: "document";
+    period: PublisherPeriodV2;
+    /**
+     * A document created from a template gets a deep copy of its content and keeps no reference to it.
+     */
+    content: PublisherDocumentContentV2;
+}
+/**
+ * Document metadata object.
+ *
+ * @alpha
+ */
+export interface IPublisherDocumentV2 extends IPublisherDocumentDefinitionV2, IPublisherEntityMetadataV2 {
+    ref: ObjRef;
+}
+/**
+ * Payload for creating or updating a document template.
+ *
+ * @alpha
+ */
+export interface IPublisherDocumentTemplateDefinitionV2 extends IPublisherEntityDefinitionBaseV2 {
+    type: "documentTemplate";
+    content: PublisherDocumentContentV2;
+}
+/**
+ * Document template metadata object.
+ *
+ * @alpha
+ */
+export interface IPublisherDocumentTemplateV2 extends IPublisherDocumentTemplateDefinitionV2, IPublisherEntityMetadataV2 {
+    ref: ObjRef;
+}
+/**
+ * Payload for creating or updating a page template.
+ *
+ * @alpha
+ */
+export interface IPublisherPageTemplateDefinitionV2 extends IPublisherEntityDefinitionBaseV2 {
+    type: "pageTemplate";
+    content: IPublisherPageBodyV2;
+}
+/**
+ * Page template metadata object.
+ *
+ * @alpha
+ */
+export interface IPublisherPageTemplateV2 extends IPublisherPageTemplateDefinitionV2, IPublisherEntityMetadataV2 {
+    ref: ObjRef;
+    /**
+     * True for the default page templates the backend serves. Their ids start with `default.`.
+     */
+    isDefault?: boolean;
+}
+/**
+ * @alpha
+ */
+export declare function isPublisherDocumentDefinitionV2(obj: unknown): obj is IPublisherDocumentDefinitionV2;
+/**
+ * @alpha
+ */
+export declare function isPublisherDocumentV2(obj: unknown): obj is IPublisherDocumentV2;
+/**
+ * @alpha
+ */
+export declare function isPublisherDocumentTemplateDefinitionV2(obj: unknown): obj is IPublisherDocumentTemplateDefinitionV2;
+/**
+ * @alpha
+ */
+export declare function isPublisherDocumentTemplateV2(obj: unknown): obj is IPublisherDocumentTemplateV2;
+/**
+ * @alpha
+ */
+export declare function isPublisherPageTemplateDefinitionV2(obj: unknown): obj is IPublisherPageTemplateDefinitionV2;
+/**
+ * @alpha
+ */
+export declare function isPublisherPageTemplateV2(obj: unknown): obj is IPublisherPageTemplateV2;
+//# sourceMappingURL=document.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"document.d.ts","sourceRoot":"","sources":["../../../src/publisher/v2/document.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,eAAe,EAAE,KAAK,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACpF,OAAO,EAAE,KAAK,MAAM,EAAY,MAAM,uBAAuB,CAAC;AAE9D,OAAO,EACH,KAAK,yBAAyB,EAC9B,KAAK,0BAA0B,EAC/B,KAAK,iBAAiB,EACzB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,KAAK,oBAAoB,EAAE,MAAM,WAAW,CAAC;AAEtD;;;;GAIG;AACH,MAAM,WAAW,gCAAgC;IAC7C;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,OAAO,EAAE,yBAAyB,CAAC;CACtC;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA2B,SAAQ,eAAe,EAAE,eAAe;IAChF,GAAG,EAAE,MAAM,CAAC;IACZ;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,8BAA+B,SAAQ,gCAAgC;IACpF,IAAI,EAAE,UAAU,CAAC;IACjB,MAAM,EAAE,iBAAiB,CAAC;IAC1B;;OAEG;IACH,OAAO,EAAE,0BAA0B,CAAC;CACvC;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAqB,SAAQ,8BAA8B,EAAE,0BAA0B;IACpG,GAAG,EAAE,MAAM,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,WAAW,sCAAuC,SAAQ,gCAAgC;IAC5F,IAAI,EAAE,kBAAkB,CAAC;IACzB,OAAO,EAAE,0BAA0B,CAAC;CACvC;AAED;;;;GAIG;AACH,MAAM,WAAW,4BACb,SAAQ,sCAAsC,EAAE,0BAA0B;IAC1E,GAAG,EAAE,MAAM,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,WAAW,kCAAmC,SAAQ,gCAAgC;IACxF,IAAI,EAAE,cAAc,CAAC;IACrB,OAAO,EAAE,oBAAoB,CAAC;CACjC;AAED;;;;GAIG;AACH,MAAM,WAAW,wBACb,SAAQ,kCAAkC,EAAE,0BAA0B;IACtE,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;GAEG;AACH,wBAAgB,+BAA+B,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,8BAA8B,CAEnG;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,oBAAoB,CAE/E;AAED;;GAEG;AACH,wBAAgB,uCAAuC,CACnD,GAAG,EAAE,OAAO,GACb,GAAG,IAAI,sCAAsC,CAE/C;AAED;;GAEG;AACH,wBAAgB,6BAA6B,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,4BAA4B,CAE/F;AAED;;GAEG;AACH,wBAAgB,mCAAmC,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,kCAAkC,CAE3G;AAED;;GAEG;AACH,wBAAgB,yBAAyB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,wBAAwB,CAEvF"}

package/esm/publisher/v2/document.js

@@ -0,0 +1,47 @@
+// (C) 2026 GoodData Corporation
+import { isEmpty } from "lodash-es";
+import { isObjRef } from "../../objRef/index.js";
+/**
+ * @alpha
+ */
+export function isPublisherDocumentDefinitionV2(obj) {
+    return isPublisherEntityDefinitionV2(obj, "document");
+}
+/**
+ * @alpha
+ */
+export function isPublisherDocumentV2(obj) {
+    return isPublisherDocumentDefinitionV2(obj) && isObjRef(obj.ref);
+}
+/**
+ * @alpha
+ */
+export function isPublisherDocumentTemplateDefinitionV2(obj) {
+    return isPublisherEntityDefinitionV2(obj, "documentTemplate");
+}
+/**
+ * @alpha
+ */
+export function isPublisherDocumentTemplateV2(obj) {
+    return isPublisherDocumentTemplateDefinitionV2(obj) && isObjRef(obj.ref);
+}
+/**
+ * @alpha
+ */
+export function isPublisherPageTemplateDefinitionV2(obj) {
+    return isPublisherEntityDefinitionV2(obj, "pageTemplate");
+}
+/**
+ * @alpha
+ */
+export function isPublisherPageTemplateV2(obj) {
+    return isPublisherPageTemplateDefinitionV2(obj) && isObjRef(obj.ref);
+}
+const contentVersion = "2";
+function isPublisherEntityDefinitionV2(obj, type) {
+    if (isEmpty(obj)) {
+        return false;
+    }
+    const entity = obj;
+    return entity.type === type && entity.version === contentVersion;
+}