@gooddata/sdk-model 11.61.0 → 11.62.0-alpha.1

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

@@ -3,16 +3,16 @@
  *
  * @alpha
  */
-export type ReportContentAlignment = "start" | "center" | "end";
+export type PublisherContentAlignment = "start" | "center" | "end";
 /**
  * Solid color painted behind a section's or page's content.
  *
  * @alpha
  */
-export interface IReportColorBackground {
+export interface IPublisherColorBackground {
     type: "color";
     /**
-     * CSS color value. Absolute: report styling states brand colors directly and does not
+     * CSS color value. Absolute: document styling states brand colors directly and does not
      * follow the workspace theme.
      */
     color: string;
@@ -22,10 +22,10 @@ export interface IReportColorBackground {
  *
  * @alpha
  */
-export interface IReportImageBackground {
+export interface IPublisherImageBackground {
     type: "image";
     /**
-     * Local identifier of an image slot in {@link IReportPageBody.slots}. Routing the image
+     * Local identifier of an image slot in {@link IPublisherPageBody.slots}. Routing the image
      * through a slot keeps it template-fillable and gives it the slot's placeholder metadata.
      * A reference that is missing or resolves to a non-image slot paints no background.
      */
@@ -36,24 +36,24 @@ export interface IReportImageBackground {
  *
  * @alpha
  */
-export type ReportBackground = IReportColorBackground | IReportImageBackground;
+export type PublisherBackground = IPublisherColorBackground | IPublisherImageBackground;
 /**
  * Paint of the box itself. Never affects the geometry of the box or its children —
  * geometry always comes from layout weights.
  *
  * @alpha
  */
-export interface IReportBoxStyle {
-    background?: ReportBackground;
+export interface IPublisherBoxStyle {
+    background?: PublisherBackground;
     /**
-     * Corner radius in percent of the page width — the same relative unit the rest of a report page
+     * Corner radius in percent of the page width — the same relative unit the rest of a document page
      * is sized in, so the corners keep their proportion however large the page is rendered.
      * Content reaching into a rounded corner is clipped.
      */
     borderRadius?: number;
     /**
      * Inset of the box's own content, in percent of the page width like
-     * {@link IReportBoxStyle.borderRadius}. Insets only inward — siblings and the layout
+     * {@link IPublisherBoxStyle.borderRadius}. Insets only inward — siblings and the layout
      * gaps around the box are untouched. A box that paints a background usually wants one;
      * a full-bleed box (an image-backed cover) wants none, which is why no default exists.
      */
@@ -65,91 +65,91 @@ export interface IReportBoxStyle {
  *
  * @alpha
  */
-export type ReportHeadingType = "h1" | "h2" | "h3" | "h4" | "h5" | "h6";
+export type PublisherHeadingType = "h1" | "h2" | "h3" | "h4" | "h5" | "h6";
 /**
  * Size a paragraph is rendered at. Each size is styled by the matching theme text level
  * (`reports.textStyle.paragraph.largeText` ...).
  *
  * @alpha
  */
-export type ReportParagraphType = "largeText" | "normalText" | "smallText";
+export type PublisherParagraphType = "largeText" | "normalText" | "smallText";
 /**
- * Size any report text is rendered at.
+ * Size any document text is rendered at.
  *
  * @alpha
  */
-export type ReportTextType = ReportHeadingType | ReportParagraphType;
+export type PublisherTextType = PublisherHeadingType | PublisherParagraphType;
 /**
  * All heading sizes, largest first.
  *
  * @alpha
  */
-export declare const ReportHeadingTypes: ReportHeadingType[];
+export declare const PublisherHeadingTypes: PublisherHeadingType[];
 /**
  * All paragraph sizes, largest first.
  *
  * @alpha
  */
-export declare const ReportParagraphTypes: ReportParagraphType[];
+export declare const PublisherParagraphTypes: PublisherParagraphType[];
 /**
  * Size a heading slot that states none is rendered at.
  *
  * @alpha
  */
-export declare const DefaultReportHeadingType: ReportHeadingType;
+export declare const DefaultPublisherHeadingType: PublisherHeadingType;
 /**
  * Size a paragraph slot that states none is rendered at.
  *
  * @alpha
  */
-export declare const DefaultReportParagraphType: ReportParagraphType;
+export declare const DefaultPublisherParagraphType: PublisherParagraphType;
 /**
- * Type-guard testing whether the value is a {@link ReportHeadingType}.
+ * Type-guard testing whether the value is a {@link PublisherHeadingType}.
  *
  * @alpha
  */
-export declare function isReportHeadingType(value: unknown): value is ReportHeadingType;
+export declare function isPublisherHeadingType(value: unknown): value is PublisherHeadingType;
 /**
- * Type-guard testing whether the value is a {@link ReportParagraphType}.
+ * Type-guard testing whether the value is a {@link PublisherParagraphType}.
  *
  * @alpha
  */
-export declare function isReportParagraphType(value: unknown): value is ReportParagraphType;
+export declare function isPublisherParagraphType(value: unknown): value is PublisherParagraphType;
 /**
  * Styling of a text slot: the paint of its box, plus the ink and placement of the text it owns.
  *
  * @alpha
  */
-export interface IReportTextStyle extends IReportBoxStyle {
+export interface IPublisherTextStyle extends IPublisherBoxStyle {
     /**
-     * CSS color value. Absolute, like {@link IReportColorBackground.color}.
+     * CSS color value. Absolute, like {@link IPublisherColorBackground.color}.
      */
     color?: string;
-    horizontalAlign?: ReportContentAlignment;
-    verticalAlign?: ReportContentAlignment;
+    horizontalAlign?: PublisherContentAlignment;
+    verticalAlign?: PublisherContentAlignment;
 }
 /**
  * Styling of a heading slot.
  *
  * @alpha
  */
-export interface IReportHeadingStyle extends IReportTextStyle {
+export interface IPublisherHeadingStyle extends IPublisherTextStyle {
     /**
-     * Defaults to {@link DefaultReportHeadingType}. The size owns the semantic typography that goes
+     * Defaults to {@link DefaultPublisherHeadingType}. The size owns the semantic typography that goes
      * with it; the rest of the style overrides ink and placement on top of it.
      */
-    type?: ReportHeadingType;
+    type?: PublisherHeadingType;
 }
 /**
  * Styling of a paragraph slot.
  *
  * @alpha
  */
-export interface IReportParagraphStyle extends IReportTextStyle {
+export interface IPublisherParagraphStyle extends IPublisherTextStyle {
     /**
-     * Defaults to {@link DefaultReportParagraphType}.
+     * Defaults to {@link DefaultPublisherParagraphType}.
      */
-    type?: ReportParagraphType;
+    type?: PublisherParagraphType;
 }
 /**
  * Where the drawn image sits when it does not fill its box, and which part of it is kept when it
@@ -157,20 +157,20 @@ export interface IReportParagraphStyle extends IReportTextStyle {
  *
  * @alpha
  */
-export interface IReportImageStyle {
-    horizontalAlign?: ReportContentAlignment;
-    verticalAlign?: ReportContentAlignment;
+export interface IPublisherImageStyle {
+    horizontalAlign?: PublisherContentAlignment;
+    verticalAlign?: PublisherContentAlignment;
 }
 /**
- * Type-guard testing whether the provided object is an instance of {@link IReportColorBackground}.
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherColorBackground}.
  *
  * @alpha
  */
-export declare function isReportColorBackground(obj: unknown): obj is IReportColorBackground;
+export declare function isPublisherColorBackground(obj: unknown): obj is IPublisherColorBackground;
 /**
- * Type-guard testing whether the provided object is an instance of {@link IReportImageBackground}.
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherImageBackground}.
  *
  * @alpha
  */
-export declare function isReportImageBackground(obj: unknown): obj is IReportImageBackground;
+export declare function isPublisherImageBackground(obj: unknown): obj is IPublisherImageBackground;
 //# sourceMappingURL=styling.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"styling.d.ts","sourceRoot":"","sources":["../../src/publisher/styling.ts"],"names":[],"mappings":"AAIA;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG,OAAO,GAAG,QAAQ,GAAG,KAAK,CAAC;AAEnE;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACtC,IAAI,EAAE,OAAO,CAAC;IAEd;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACtC,IAAI,EAAE,OAAO,CAAC;IAEd;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,yBAAyB,GAAG,yBAAyB,CAAC;AAExF;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IAC/B,UAAU,CAAC,EAAE,mBAAmB,CAAC;IAEjC;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;AAE3E;;;;;GAKG;AACH,MAAM,MAAM,sBAAsB,GAAG,WAAW,GAAG,YAAY,GAAG,WAAW,CAAC;AAE9E;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,oBAAoB,GAAG,sBAAsB,CAAC;AAE9E;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,EAAE,oBAAoB,EAAyC,CAAC;AAElG;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,EAAE,sBAAsB,EAA6C,CAAC;AAE1G;;;;GAIG;AACH,eAAO,MAAM,2BAA2B,EAAE,oBAA2B,CAAC;AAEtE;;;;GAIG;AACH,eAAO,MAAM,6BAA6B,EAAE,sBAAqC,CAAC;AAElF;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,oBAAoB,CAEpF;AAED;;;;GAIG;AACH,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,sBAAsB,CAExF;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAoB,SAAQ,kBAAkB;IAC3D;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,eAAe,CAAC,EAAE,yBAAyB,CAAC;IAE5C,aAAa,CAAC,EAAE,yBAAyB,CAAC;CAC7C;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAuB,SAAQ,mBAAmB;IAC/D;;;OAGG;IACH,IAAI,CAAC,EAAE,oBAAoB,CAAC;CAC/B;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAyB,SAAQ,mBAAmB;IACjE;;OAEG;IACH,IAAI,CAAC,EAAE,sBAAsB,CAAC;CACjC;AAED;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACjC,eAAe,CAAC,EAAE,yBAAyB,CAAC;IAE5C,aAAa,CAAC,EAAE,yBAAyB,CAAC;CAC7C;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/styling.js

@@ -0,0 +1,58 @@
+// (C) 2026 GoodData Corporation
+import { isEmpty } from "lodash-es";
+/**
+ * All heading sizes, largest first.
+ *
+ * @alpha
+ */
+export const PublisherHeadingTypes = ["h1", "h2", "h3", "h4", "h5", "h6"];
+/**
+ * All paragraph sizes, largest first.
+ *
+ * @alpha
+ */
+export const PublisherParagraphTypes = ["largeText", "normalText", "smallText"];
+/**
+ * Size a heading slot that states none is rendered at.
+ *
+ * @alpha
+ */
+export const DefaultPublisherHeadingType = "h1";
+/**
+ * Size a paragraph slot that states none is rendered at.
+ *
+ * @alpha
+ */
+export const DefaultPublisherParagraphType = "normalText";
+/**
+ * Type-guard testing whether the value is a {@link PublisherHeadingType}.
+ *
+ * @alpha
+ */
+export function isPublisherHeadingType(value) {
+    return PublisherHeadingTypes.includes(value);
+}
+/**
+ * Type-guard testing whether the value is a {@link PublisherParagraphType}.
+ *
+ * @alpha
+ */
+export function isPublisherParagraphType(value) {
+    return PublisherParagraphTypes.includes(value);
+}
+/**
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherColorBackground}.
+ *
+ * @alpha
+ */
+export function isPublisherColorBackground(obj) {
+    return !isEmpty(obj) && obj.type === "color";
+}
+/**
+ * Type-guard testing whether the provided object is an instance of {@link IPublisherImageBackground}.
+ *
+ * @alpha
+ */
+export function isPublisherImageBackground(obj) {
+    return !isEmpty(obj) && obj.type === "image";
+}

package/esm/publisher/variables.d.ts

@@ -0,0 +1,72 @@
+/**
+ * ISO 8601 calendar date (YYYY-MM-DD).
+ *
+ * @alpha
+ */
+export type PublisherDateString = string;
+/**
+ * Variables resolved by the rendering runtime; they are never declared or stored.
+ *
+ * @remarks
+ * Referenced from document text as `{name}`. Custom variable names must not collide with these;
+ * on collision the built-in wins.
+ *
+ * @alpha
+ */
+export type PublisherBuiltInVariable = "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[];
+/**
+ * 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}.
+ *
+ * @alpha
+ */
+export interface IPublisherVariableDefinition {
+    /**
+     * Variable name as used inside the `{...}` marker. Must match /^[a-zA-Z][a-zA-Z0-9_]*$/.
+     * Built-in names ({@link PublisherBuiltInVariable}) are reserved.
+     */
+    name: string;
+    /**
+     * Human readable label shown in the editor.
+     */
+    title?: string;
+    description?: string;
+    /**
+     * Value used when the document does not provide one. May not contain further
+     * placeholders — there is no recursive expansion.
+     */
+    defaultValue?: string;
+}
+/**
+ * The marker referencing the named variable from document text.
+ *
+ * @alpha
+ */
+export declare function publisherTextPlaceholder(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[];
+/**
+ * Replaces `{variable}` markers with values. Markers with no value are left as-is.
+ * Values are inserted verbatim — there is no recursive expansion.
+ *
+ * @remarks
+ * A marker resolves wherever it appears, braces around it included, so there is no escape for a
+ * literal `{name}` in document text.
+ *
+ * @alpha
+ */
+export declare function resolvePublisherTextPlaceholders(text: string, values: Record<string, string>): string;
+//# sourceMappingURL=variables.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"variables.d.ts","sourceRoot":"","sources":["../../src/publisher/variables.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC;AAEzC;;;;;;;;GAQG;AACH,MAAM,MAAM,wBAAwB,GAC9B,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,yBAAyB,EAAE,wBAAwB,EAgB/D,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,WAAW,4BAA4B;IACzC;;;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,wBAAwB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE7D;AAED;;;;GAIG;AACH,wBAAgB,4BAA4B,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CASnE;AAED;;;;;;;;;GASG;AACH,wBAAgB,gCAAgC,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,CAIrG"}

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

@@ -1,10 +1,10 @@
 // (C) 2026 GoodData Corporation
 /**
- * All built-in report variable names.
+ * All built-in document variable names.
  *
  * @alpha
  */
-export const ReportBuiltInVariables = [
+export const PublisherBuiltInVariables = [
     "reportName",
     "reportDescription",
     "periodStart",
@@ -23,11 +23,11 @@ export const ReportBuiltInVariables = [
 ];
 const placeholderRegex = /\{([a-zA-Z][a-zA-Z0-9_]*)\}/g;
 /**
- * The marker referencing the named variable from report text.
+ * The marker referencing the named variable from document text.
  *
  * @alpha
  */
-export function reportTextPlaceholder(name) {
+export function publisherTextPlaceholder(name) {
     return `{${name}}`;
 }
 /**
@@ -35,7 +35,7 @@ export function reportTextPlaceholder(name) {
  *
  * @alpha
  */
-export function getReportTextPlaceholders(text) {
+export function getPublisherTextPlaceholders(text) {
     const names = [];
     for (const match of text.matchAll(placeholderRegex)) {
         const name = match[1];
@@ -51,10 +51,10 @@ export function getReportTextPlaceholders(text) {
  *
  * @remarks
  * A marker resolves wherever it appears, braces around it included, so there is no escape for a
- * literal `{name}` in report text.
+ * literal `{name}` in document text.
  *
  * @alpha
  */
-export function resolveReportTextPlaceholders(text, values) {
+export function resolvePublisherTextPlaceholders(text, values) {
     return text.replace(placeholderRegex, (marker, name) => Object.prototype.hasOwnProperty.call(values, name) ? values[name] : marker);
 }