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

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

@@ -0,0 +1,323 @@
+/**
+ * Length in px on the page's design canvas, zero or more.
+ *
+ * @alpha
+ */
+export type PublisherPxV2 = number;
+/**
+ * Number from 0 to 1.
+ *
+ * @alpha
+ */
+export type PublisherOpacityV2 = number;
+/**
+ * @alpha
+ */
+export type PublisherHorizontalAlignV2 = "left" | "center" | "right";
+/**
+ * @alpha
+ */
+export type PublisherVerticalAlignV2 = "top" | "center" | "bottom";
+/**
+ * Theme color reference or literal color.
+ *
+ * @remarks
+ * A reference is the whole value, never part of a longer string:
+ * `{theme.colors.<list>.<id>}`, where list is `backgrounds`, `texts` or `lines`, or
+ * `{theme.palette.<name>}`, where name is `primary`, `success`, `error` or `warning`.
+ * The ids `default`, `surface`, `inverse`, `muted` and `accent` always resolve.
+ *
+ * A literal is `#rgb`, `#rrggbb`, `#rrggbbaa`, or `rgb()` with 3 or 4 arguments. `#rgba` is invalid.
+ *
+ * @alpha
+ */
+export type PublisherColorValueV2 = string;
+/**
+ * @alpha
+ */
+export type PublisherGapValueV2 = PublisherPxV2 | "{theme.spacing.gap.compact}" | "{theme.spacing.gap.normal}" | "{theme.spacing.gap.spacious}";
+/**
+ * @alpha
+ */
+export type PublisherPaddingValueV2 = PublisherPxV2 | "{theme.spacing.padding.compact}" | "{theme.spacing.padding.normal}" | "{theme.spacing.padding.spacious}";
+/**
+ * @alpha
+ */
+export type PublisherRadiusValueV2 = PublisherPxV2 | "{theme.corners.small}" | "{theme.corners.medium}" | "{theme.corners.large}" | "{theme.corners.full}";
+/**
+ * `{theme.shadows.<name>}` or `none`.
+ *
+ * @alpha
+ */
+export type PublisherShadowValueV2 = string;
+/**
+ * @alpha
+ */
+export type PublisherBorderLineStyleV2 = "solid" | "dashed" | "dotted" | "none";
+/**
+ * Theme image reference or https URL.
+ *
+ * @remarks
+ * A reference is the whole value: `{theme.logo}`, `{theme.coverImage}`, `{theme.assets.logos.<id>}`
+ * or `{theme.assets.images.<id>}`.
+ *
+ * A URL must start with `https://` and may contain text variables; each resolved value is
+ * percent-encoded and the result must still start with `https://`.
+ *
+ * @alpha
+ */
+export type PublisherImageSourceV2 = string;
+/**
+ * @alpha
+ */
+export declare const PublisherTextStyleNamesV2: readonly ["title", "h1", "h2", "h3", "h4", "h5", "h6", "largeText", "normalText", "smallText"];
+/**
+ * Named text style from the theme's `documents.textStyle`.
+ *
+ * @alpha
+ */
+export type PublisherTextStyleNameV2 = (typeof PublisherTextStyleNamesV2)[number];
+/**
+ * @alpha
+ */
+export declare function isPublisherTextStyleNameV2(value: unknown): value is PublisherTextStyleNameV2;
+/**
+ * @alpha
+ */
+export interface IPublisherBackgroundStyleV2 {
+    backgroundColor?: PublisherColorValueV2;
+    /**
+     * Opacity of the background color only.
+     */
+    backgroundOpacity?: PublisherOpacityV2;
+    backgroundImage?: PublisherImageSourceV2;
+    backgroundImageOpacity?: PublisherOpacityV2;
+    /**
+     * Defaults to `cover`.
+     */
+    backgroundFit?: "cover" | "contain" | "fill" | "tile";
+    backgroundHorizontalAlign?: PublisherHorizontalAlignV2;
+    backgroundVerticalAlign?: PublisherVerticalAlignV2;
+    backgroundOffset?: PublisherPxV2;
+    backgroundOffsetTop?: PublisherPxV2;
+    backgroundOffsetRight?: PublisherPxV2;
+    backgroundOffsetBottom?: PublisherPxV2;
+    backgroundOffsetLeft?: PublisherPxV2;
+}
+/**
+ * @remarks
+ * A side key wins over `padding` in any order.
+ *
+ * @alpha
+ */
+export interface IPublisherPaddingStyleV2 {
+    padding?: PublisherPaddingValueV2;
+    paddingTop?: PublisherPaddingValueV2;
+    paddingRight?: PublisherPaddingValueV2;
+    paddingBottom?: PublisherPaddingValueV2;
+    paddingLeft?: PublisherPaddingValueV2;
+}
+/**
+ * @remarks
+ * A side key wins over the matching all-sides key in any order. `borderStyle` defaults to `solid`,
+ * so a width alone draws a line.
+ *
+ * @alpha
+ */
+export interface IPublisherBorderStyleV2 {
+    borderWidth?: PublisherPxV2;
+    borderStyle?: PublisherBorderLineStyleV2;
+    borderColor?: PublisherColorValueV2;
+    borderTopWidth?: PublisherPxV2;
+    borderTopStyle?: PublisherBorderLineStyleV2;
+    borderTopColor?: PublisherColorValueV2;
+    borderRightWidth?: PublisherPxV2;
+    borderRightStyle?: PublisherBorderLineStyleV2;
+    borderRightColor?: PublisherColorValueV2;
+    borderBottomWidth?: PublisherPxV2;
+    borderBottomStyle?: PublisherBorderLineStyleV2;
+    borderBottomColor?: PublisherColorValueV2;
+    borderLeftWidth?: PublisherPxV2;
+    borderLeftStyle?: PublisherBorderLineStyleV2;
+    borderLeftColor?: PublisherColorValueV2;
+}
+/**
+ * @remarks
+ * A corner key wins over `borderRadius` in any order.
+ *
+ * @alpha
+ */
+export interface IPublisherCornerStyleV2 {
+    borderRadius?: PublisherRadiusValueV2;
+    borderTopLeftRadius?: PublisherRadiusValueV2;
+    borderTopRightRadius?: PublisherRadiusValueV2;
+    borderBottomRightRadius?: PublisherRadiusValueV2;
+    borderBottomLeftRadius?: PublisherRadiusValueV2;
+}
+/**
+ * @remarks
+ * The part keys override the named `shadow`, or define a shadow without one.
+ *
+ * @alpha
+ */
+export interface IPublisherShadowStyleV2 {
+    shadow?: PublisherShadowValueV2;
+    /**
+     * px on the design canvas; may be negative.
+     */
+    shadowX?: number;
+    /**
+     * px on the design canvas; may be negative.
+     */
+    shadowY?: number;
+    shadowBlur?: PublisherPxV2;
+    /**
+     * px on the design canvas; may be negative.
+     */
+    shadowSpread?: number;
+    shadowColor?: PublisherColorValueV2;
+    shadowOpacity?: PublisherOpacityV2;
+}
+/**
+ * Box keys. They apply to the node they are set on and never inherit.
+ *
+ * @alpha
+ */
+export interface IPublisherBoxStyleV2 extends IPublisherBackgroundStyleV2, IPublisherPaddingStyleV2, IPublisherBorderStyleV2, IPublisherCornerStyleV2, IPublisherShadowStyleV2 {
+    /**
+     * Opacity of the whole node, content included.
+     */
+    opacity?: PublisherOpacityV2;
+}
+/**
+ * Text keys that a page or container passes down to the content inside, unless a widget sets its own.
+ *
+ * @alpha
+ */
+export interface IPublisherInheritedTextStyleV2 {
+    textStyle?: PublisherTextStyleNameV2;
+    textColor?: PublisherColorValueV2;
+    /**
+     * `justify` applies to text only.
+     */
+    horizontalAlign?: PublisherHorizontalAlignV2 | "justify";
+    verticalAlign?: PublisherVerticalAlignV2;
+}
+/**
+ * @alpha
+ */
+export interface IPublisherTextStyleV2 extends IPublisherInheritedTextStyleV2 {
+    fontSize?: PublisherPxV2;
+    /**
+     * 1 to 1000.
+     */
+    fontWeight?: number;
+    fontStyle?: "normal" | "italic";
+    /**
+     * Multiple of the font size.
+     */
+    lineHeight?: number;
+    /**
+     * In em.
+     */
+    letterSpacing?: number;
+    textTransform?: "none" | "uppercase" | "lowercase" | "capitalize";
+    /**
+     * Defaults to `shrink`.
+     */
+    textOverflow?: "shrink" | "clip" | "ellipsis";
+}
+/**
+ * @alpha
+ */
+export interface IPublisherPageStyleV2 extends IPublisherBackgroundStyleV2, IPublisherPaddingStyleV2, IPublisherInheritedTextStyleV2 {
+    /**
+     * Default gap of every container on the page.
+     */
+    gap?: PublisherGapValueV2;
+}
+/**
+ * @alpha
+ */
+export interface IPublisherContainerStyleV2 extends IPublisherBoxStyleV2, IPublisherInheritedTextStyleV2 {
+    gap?: PublisherGapValueV2;
+}
+/**
+ * @alpha
+ */
+export interface IPublisherTextWidgetStyleV2 extends IPublisherBoxStyleV2, IPublisherTextStyleV2 {
+}
+/**
+ * @alpha
+ */
+export interface IPublisherImageWidgetStyleV2 extends IPublisherBoxStyleV2 {
+    /**
+     * Defaults to `contain`.
+     */
+    fit?: "contain" | "cover" | "fill";
+    horizontalAlign?: PublisherHorizontalAlignV2;
+    verticalAlign?: PublisherVerticalAlignV2;
+}
+/**
+ * @remarks
+ * Each of `chart`, `table` and `headline` applies only while the visualization renders as that kind,
+ * so the style survives a switch from a chart to a table.
+ *
+ * @alpha
+ */
+export interface IPublisherVisualizationStyleV2 extends IPublisherBoxStyleV2 {
+    chart?: IPublisherChartStyleV2;
+    table?: IPublisherTableStyleV2;
+    headline?: IPublisherHeadlineStyleV2;
+}
+/**
+ * @alpha
+ */
+export interface IPublisherChartStyleV2 {
+    fontSize?: PublisherPxV2;
+    textColor?: PublisherColorValueV2;
+    axisLineColor?: PublisherColorValueV2;
+    /**
+     * Color of the axis title.
+     */
+    axisNameColor?: PublisherColorValueV2;
+    axisNameSize?: PublisherPxV2;
+    /**
+     * Color of the tick labels.
+     */
+    axisValueColor?: PublisherColorValueV2;
+    axisValueSize?: PublisherPxV2;
+    gridColor?: PublisherColorValueV2;
+    plotLineColor?: PublisherColorValueV2;
+    legendColor?: PublisherColorValueV2;
+    legendSize?: PublisherPxV2;
+    dataLabelColor?: PublisherColorValueV2;
+    dataLabelSize?: PublisherPxV2;
+}
+/**
+ * @alpha
+ */
+export interface IPublisherTableStyleV2 {
+    fontSize?: PublisherPxV2;
+    rowHeight?: PublisherPxV2;
+    gridColor?: PublisherColorValueV2;
+    valueColor?: PublisherColorValueV2;
+    nullValueColor?: PublisherColorValueV2;
+    headerLabelColor?: PublisherColorValueV2;
+    headerBackgroundColor?: PublisherColorValueV2;
+    totalValueColor?: PublisherColorValueV2;
+    totalBackgroundColor?: PublisherColorValueV2;
+    subtotalBackgroundColor?: PublisherColorValueV2;
+}
+/**
+ * @alpha
+ */
+export interface IPublisherHeadlineStyleV2 {
+    primaryValueColor?: PublisherColorValueV2;
+    primaryValueSize?: PublisherPxV2;
+    secondaryValueColor?: PublisherColorValueV2;
+    secondaryValueSize?: PublisherPxV2;
+    positiveColor?: PublisherColorValueV2;
+    negativeColor?: PublisherColorValueV2;
+}
+//# sourceMappingURL=style.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"style.d.ts","sourceRoot":"","sources":["../../../src/publisher/v2/style.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AAEnC;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC;AAExC;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,KAAK,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAEnE;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC;AAE3C;;GAEG;AACH,MAAM,MAAM,mBAAmB,GACzB,aAAa,GACb,6BAA6B,GAC7B,4BAA4B,GAC5B,8BAA8B,CAAC;AAErC;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAC7B,aAAa,GACb,iCAAiC,GACjC,gCAAgC,GAChC,kCAAkC,CAAC;AAEzC;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAC5B,aAAa,GACb,uBAAuB,GACvB,wBAAwB,GACxB,uBAAuB,GACvB,sBAAsB,CAAC;AAE7B;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,CAAC;AAE5C;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAC;AAEhF;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,CAAC;AAE5C;;GAEG;AACH,eAAO,MAAM,yBAAyB,YAClC,OAAO,EACP,IAAI,EACJ,IAAI,EACJ,IAAI,EACJ,IAAI,EACJ,IAAI,EACJ,IAAI,EACJ,WAAW,EACX,YAAY,EACZ,WAAW,CACL,CAAC;AAEX;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,GAAG,CAAC,OAAO,yBAAyB,CAAC,CAAC,MAAM,CAAC,CAAC;AAElF;;GAEG;AACH,wBAAgB,0BAA0B,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,wBAAwB,CAE5F;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IACxC,eAAe,CAAC,EAAE,qBAAqB,CAAC;IACxC;;OAEG;IACH,iBAAiB,CAAC,EAAE,kBAAkB,CAAC;IACvC,eAAe,CAAC,EAAE,sBAAsB,CAAC;IACzC,sBAAsB,CAAC,EAAE,kBAAkB,CAAC;IAC5C;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,CAAC;IACtD,yBAAyB,CAAC,EAAE,0BAA0B,CAAC;IACvD,uBAAuB,CAAC,EAAE,wBAAwB,CAAC;IACnD,gBAAgB,CAAC,EAAE,aAAa,CAAC;IACjC,mBAAmB,CAAC,EAAE,aAAa,CAAC;IACpC,qBAAqB,CAAC,EAAE,aAAa,CAAC;IACtC,sBAAsB,CAAC,EAAE,aAAa,CAAC;IACvC,oBAAoB,CAAC,EAAE,aAAa,CAAC;CACxC;AAED;;;;;GAKG;AACH,MAAM,WAAW,wBAAwB;IACrC,OAAO,CAAC,EAAE,uBAAuB,CAAC;IAClC,UAAU,CAAC,EAAE,uBAAuB,CAAC;IACrC,YAAY,CAAC,EAAE,uBAAuB,CAAC;IACvC,aAAa,CAAC,EAAE,uBAAuB,CAAC;IACxC,WAAW,CAAC,EAAE,uBAAuB,CAAC;CACzC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,uBAAuB;IACpC,WAAW,CAAC,EAAE,aAAa,CAAC;IAC5B,WAAW,CAAC,EAAE,0BAA0B,CAAC;IACzC,WAAW,CAAC,EAAE,qBAAqB,CAAC;IACpC,cAAc,CAAC,EAAE,aAAa,CAAC;IAC/B,cAAc,CAAC,EAAE,0BAA0B,CAAC;IAC5C,cAAc,CAAC,EAAE,qBAAqB,CAAC;IACvC,gBAAgB,CAAC,EAAE,aAAa,CAAC;IACjC,gBAAgB,CAAC,EAAE,0BAA0B,CAAC;IAC9C,gBAAgB,CAAC,EAAE,qBAAqB,CAAC;IACzC,iBAAiB,CAAC,EAAE,aAAa,CAAC;IAClC,iBAAiB,CAAC,EAAE,0BAA0B,CAAC;IAC/C,iBAAiB,CAAC,EAAE,qBAAqB,CAAC;IAC1C,eAAe,CAAC,EAAE,aAAa,CAAC;IAChC,eAAe,CAAC,EAAE,0BAA0B,CAAC;IAC7C,eAAe,CAAC,EAAE,qBAAqB,CAAC;CAC3C;AAED;;;;;GAKG;AACH,MAAM,WAAW,uBAAuB;IACpC,YAAY,CAAC,EAAE,sBAAsB,CAAC;IACtC,mBAAmB,CAAC,EAAE,sBAAsB,CAAC;IAC7C,oBAAoB,CAAC,EAAE,sBAAsB,CAAC;IAC9C,uBAAuB,CAAC,EAAE,sBAAsB,CAAC;IACjD,sBAAsB,CAAC,EAAE,sBAAsB,CAAC;CACnD;AAED;;;;;GAKG;AACH,MAAM,WAAW,uBAAuB;IACpC,MAAM,CAAC,EAAE,sBAAsB,CAAC;IAChC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,aAAa,CAAC;IAC3B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,qBAAqB,CAAC;IACpC,aAAa,CAAC,EAAE,kBAAkB,CAAC;CACtC;AAED;;;;GAIG;AACH,MAAM,WAAW,oBACb,SACI,2BAA2B,EAC3B,wBAAwB,EACxB,uBAAuB,EACvB,uBAAuB,EACvB,uBAAuB;IAC3B;;OAEG;IACH,OAAO,CAAC,EAAE,kBAAkB,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,8BAA8B;IAC3C,SAAS,CAAC,EAAE,wBAAwB,CAAC;IACrC,SAAS,CAAC,EAAE,qBAAqB,CAAC;IAClC;;OAEG;IACH,eAAe,CAAC,EAAE,0BAA0B,GAAG,SAAS,CAAC;IACzD,aAAa,CAAC,EAAE,wBAAwB,CAAC;CAC5C;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,8BAA8B;IACzE,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAChC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,WAAW,GAAG,YAAY,CAAC;IAClE;;OAEG;IACH,YAAY,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,UAAU,CAAC;CACjD;AAED;;GAEG;AACH,MAAM,WAAW,qBACb,SAAQ,2BAA2B,EAAE,wBAAwB,EAAE,8BAA8B;IAC7F;;OAEG;IACH,GAAG,CAAC,EAAE,mBAAmB,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,oBAAoB,EAAE,8BAA8B;IACpG,GAAG,CAAC,EAAE,mBAAmB,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,oBAAoB,EAAE,qBAAqB;CAAG;AAEnG;;GAEG;AACH,MAAM,WAAW,4BAA6B,SAAQ,oBAAoB;IACtE;;OAEG;IACH,GAAG,CAAC,EAAE,SAAS,GAAG,OAAO,GAAG,MAAM,CAAC;IACnC,eAAe,CAAC,EAAE,0BAA0B,CAAC;IAC7C,aAAa,CAAC,EAAE,wBAAwB,CAAC;CAC5C;AAED;;;;;;GAMG;AACH,MAAM,WAAW,8BAA+B,SAAQ,oBAAoB;IACxE,KAAK,CAAC,EAAE,sBAAsB,CAAC;IAC/B,KAAK,CAAC,EAAE,sBAAsB,CAAC;IAC/B,QAAQ,CAAC,EAAE,yBAAyB,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACnC,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,SAAS,CAAC,EAAE,qBAAqB,CAAC;IAClC,aAAa,CAAC,EAAE,qBAAqB,CAAC;IACtC;;OAEG;IACH,aAAa,CAAC,EAAE,qBAAqB,CAAC;IACtC,YAAY,CAAC,EAAE,aAAa,CAAC;IAC7B;;OAEG;IACH,cAAc,CAAC,EAAE,qBAAqB,CAAC;IACvC,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,SAAS,CAAC,EAAE,qBAAqB,CAAC;IAClC,aAAa,CAAC,EAAE,qBAAqB,CAAC;IACtC,WAAW,CAAC,EAAE,qBAAqB,CAAC;IACpC,UAAU,CAAC,EAAE,aAAa,CAAC;IAC3B,cAAc,CAAC,EAAE,qBAAqB,CAAC;IACvC,aAAa,CAAC,EAAE,aAAa,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACnC,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B,SAAS,CAAC,EAAE,qBAAqB,CAAC;IAClC,UAAU,CAAC,EAAE,qBAAqB,CAAC;IACnC,cAAc,CAAC,EAAE,qBAAqB,CAAC;IACvC,gBAAgB,CAAC,EAAE,qBAAqB,CAAC;IACzC,qBAAqB,CAAC,EAAE,qBAAqB,CAAC;IAC9C,eAAe,CAAC,EAAE,qBAAqB,CAAC;IACxC,oBAAoB,CAAC,EAAE,qBAAqB,CAAC;IAC7C,uBAAuB,CAAC,EAAE,qBAAqB,CAAC;CACnD;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACtC,iBAAiB,CAAC,EAAE,qBAAqB,CAAC;IAC1C,gBAAgB,CAAC,EAAE,aAAa,CAAC;IACjC,mBAAmB,CAAC,EAAE,qBAAqB,CAAC;IAC5C,kBAAkB,CAAC,EAAE,aAAa,CAAC;IACnC,aAAa,CAAC,EAAE,qBAAqB,CAAC;IACtC,aAAa,CAAC,EAAE,qBAAqB,CAAC;CACzC"}

package/esm/publisher/v2/style.js

@@ -0,0 +1,22 @@
+// (C) 2026 GoodData Corporation
+/**
+ * @alpha
+ */
+export const PublisherTextStyleNamesV2 = [
+    "title",
+    "h1",
+    "h2",
+    "h3",
+    "h4",
+    "h5",
+    "h6",
+    "largeText",
+    "normalText",
+    "smallText",
+];
+/**
+ * @alpha
+ */
+export function isPublisherTextStyleNameV2(value) {
+    return PublisherTextStyleNamesV2.some((name) => name === value);
+}

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

@@ -0,0 +1,26 @@
+import { type IPublisherValidationIssueV2 } from "./checks.js";
+/**
+ * Validates a page body, such as a page template's content: every key, value and node type, at most
+ * one title widget, and widget ids unique in the page.
+ *
+ * @alpha
+ */
+export declare function validatePublisherPageBodyV2(body: unknown): IPublisherValidationIssueV2[];
+/**
+ * Validates the content of a document or a document template: every key, value and node type,
+ * exactly one of `pages` and `sections`, page and section ids unique in the document, a `dataSet` on
+ * every date filter, at most one filter per attribute display form or date dataset, and the page
+ * rules on every page.
+ *
+ * @alpha
+ */
+export declare function validatePublisherDocumentContentV2(content: unknown): IPublisherValidationIssueV2[];
+/**
+ * Validates a document, document template or page template, as a definition or as a persisted
+ * object: everything its content validator checks, `version` `"2"`, `defaults.period` set on document
+ * templates only, and the `default.` id prefix left to the backend's default page templates.
+ *
+ * @alpha
+ */
+export declare function validatePublisherEntityV2(entity: unknown): IPublisherValidationIssueV2[];
+//# sourceMappingURL=validation.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../../../src/publisher/v2/validation.ts"],"names":[],"mappings":"AAUA,OAAO,EAAc,KAAK,2BAA2B,EAAY,MAAM,aAAa,CAAC;AAiBrF;;;;;GAKG;AACH,wBAAgB,2BAA2B,CAAC,IAAI,EAAE,OAAO,GAAG,2BAA2B,EAAE,CAKxF;AAED;;;;;;;GAOG;AACH,wBAAgB,kCAAkC,CAAC,OAAO,EAAE,OAAO,GAAG,2BAA2B,EAAE,CAKlG;AAED;;;;;;GAMG;AACH,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,OAAO,GAAG,2BAA2B,EAAE,CAExF"}

package/esm/publisher/v2/validation.js

@@ -0,0 +1,157 @@
+// (C) 2026 GoodData Corporation
+import { dashboardAttributeFilterItemDisplayForm, isDashboardAttributeFilterItem, isDashboardDateFilter, } from "../../dashboard/filterContext.js";
+import { areObjRefsEqual, isIdentifierRef } from "../../objRef/index.js";
+import { joinPath } from "./checks.js";
+import { isPublisherContainerV2 } from "./layout.js";
+import { checkDocumentContent, checkEntity, checkPageBody } from "./structure.js";
+import { isPublisherTitleWidgetV2 } from "./widget.js";
+/**
+ * Validates a page body, such as a page template's content: every key, value and node type, at most
+ * one title widget, and widget ids unique in the page.
+ *
+ * @alpha
+ */
+export function validatePublisherPageBodyV2(body) {
+    return validate(body, {
+        structure: checkPageBody,
+        rules: (value) => pageIssues(value, ""),
+    });
+}
+/**
+ * Validates the content of a document or a document template: every key, value and node type,
+ * exactly one of `pages` and `sections`, page and section ids unique in the document, a `dataSet` on
+ * every date filter, at most one filter per attribute display form or date dataset, and the page
+ * rules on every page.
+ *
+ * @alpha
+ */
+export function validatePublisherDocumentContentV2(content) {
+    return validate(content, {
+        structure: checkDocumentContent,
+        rules: (value) => contentIssues(value, ""),
+    });
+}
+/**
+ * Validates a document, document template or page template, as a definition or as a persisted
+ * object: everything its content validator checks, `version` `"2"`, `defaults.period` set on document
+ * templates only, and the `default.` id prefix left to the backend's default page templates.
+ *
+ * @alpha
+ */
+export function validatePublisherEntityV2(entity) {
+    return validate(entity, { structure: checkEntity, rules: entityIssues });
+}
+function validate(value, { structure, rules }) {
+    const issues = [];
+    structure(value, "", issues);
+    // The rules read the value through its model type, which is sound only once the structure passed.
+    return issues.length > 0 ? issues : rules(value);
+}
+function entityIssues(entity) {
+    const issues = [];
+    if (isReservedRef(entity)) {
+        issues.push({
+            path: "ref",
+            message: `Ids starting with "${reservedIdPrefix}" are reserved for the default page templates.`,
+        });
+    }
+    if (entity.type === "pageTemplate") {
+        return [...issues, ...pageIssues(entity.content, "content")];
+    }
+    if (entity.type === "document" && entity.content.defaults?.period !== undefined) {
+        issues.push({
+            path: "content.defaults.period",
+            message: "Only a document template sets a default period; a document sets its own period.",
+        });
+    }
+    return [...issues, ...contentIssues(entity.content, "content")];
+}
+const reservedIdPrefix = "default.";
+function isReservedRef(entity) {
+    const { ref } = entity;
+    if (!isIdentifierRef(ref) || !ref.identifier.startsWith(reservedIdPrefix)) {
+        return false;
+    }
+    return !(entity.type === "pageTemplate" && "isDefault" in entity && entity.isDefault === true);
+}
+function contentIssues(content, path) {
+    const issues = [];
+    const { pages, sections } = content;
+    if (pages !== undefined && sections !== undefined) {
+        issues.push({ path, message: "Content holds pages or sections, never both." });
+    }
+    else if (pages === undefined && sections === undefined) {
+        issues.push({ path, message: "Content holds pages or sections." });
+    }
+    const pagesWithPaths = [
+        ...(pages ?? []).map((page, i) => [
+            page,
+            joinPath(path, `pages[${i}]`),
+        ]),
+        ...(sections ?? []).flatMap((section, s) => section.pages.map((page, i) => [
+            page,
+            joinPath(path, `sections[${s}].pages[${i}]`),
+        ])),
+    ];
+    issues.push(...duplicateIdIssues((sections ?? []).map((section, s) => [section.id, joinPath(path, `sections[${s}].id`)]), "section"), ...duplicateIdIssues(pagesWithPaths.map(([page, pagePath]) => [page.id, joinPath(pagePath, "id")]), "page"), ...filterIssues(content.filters ?? [], joinPath(path, "filters")), ...pagesWithPaths.flatMap(([page, pagePath]) => pageIssues(page, pagePath)));
+    return issues;
+}
+function pageIssues(body, path) {
+    const widgets = layoutWidgets(body.layout, joinPath(path, "layout"));
+    const titlePaths = widgets
+        .filter(([node]) => isPublisherTitleWidgetV2(node))
+        .map(([, nodePath]) => nodePath);
+    return [
+        ...titlePaths.slice(1).map((titlePath) => ({
+            path: titlePath,
+            message: "A page holds at most one title widget.",
+        })),
+        ...duplicateIdIssues(widgets.map(([node, nodePath]) => [node.id, joinPath(nodePath, "id")]), "widget"),
+    ];
+}
+function layoutWidgets(node, path) {
+    if (isPublisherContainerV2(node)) {
+        return node.children.flatMap((child, i) => layoutWidgets(child, joinPath(path, `children[${i}]`)));
+    }
+    return [[node, path]];
+}
+function duplicateIdIssues(idsWithPaths, kind) {
+    const seen = new Set();
+    return idsWithPaths.flatMap(([id, path]) => {
+        if (seen.has(id)) {
+            return [{ path, message: `Duplicate ${kind} id "${id}".` }];
+        }
+        seen.add(id);
+        return [];
+    });
+}
+function filterIssues(filters, path) {
+    const issues = [];
+    const displayForms = [];
+    const dataSets = [];
+    filters.forEach((filter, i) => {
+        const filterPath = joinPath(path, i);
+        if (isDashboardAttributeFilterItem(filter)) {
+            if (!addIfNew(dashboardAttributeFilterItemDisplayForm(filter), displayForms)) {
+                issues.push({ path: filterPath, message: "At most one filter per attribute display form." });
+            }
+        }
+        else if (isDashboardDateFilter(filter)) {
+            const { dataSet } = filter.dateFilter;
+            if (dataSet === undefined) {
+                issues.push({ path: filterPath, message: "A document date filter names its dataSet." });
+            }
+            else if (!addIfNew(dataSet, dataSets)) {
+                issues.push({ path: filterPath, message: "At most one filter per date dataset." });
+            }
+        }
+    });
+    return issues;
+}
+function addIfNew(target, seen) {
+    if (seen.some((ref) => areObjRefsEqual(ref, target))) {
+        return false;
+    }
+    seen.push(target);
+    return true;
+}