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

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

@@ -0,0 +1,295 @@
+import { type FilterContextItem, type IDashboardFilterReference } from "../../dashboard/filterContext.js";
+import { type IPublisherImageWidgetStyleV2, type IPublisherTextStyleV2, type IPublisherTextWidgetStyleV2, type IPublisherVisualizationStyleV2, type PublisherImageSourceV2, type PublisherTextStyleNameV2 } from "./style.js";
+/**
+ * @alpha
+ */
+export declare const PublisherWidgetTypesV2: readonly ["title", "heading", "text", "image", "visualization", "takeaway"];
+/**
+ * @alpha
+ */
+export type PublisherWidgetTypeV2 = (typeof PublisherWidgetTypesV2)[number];
+/**
+ * @alpha
+ */
+export interface IPublisherWidgetPlaceholderV2 {
+    hint?: string;
+    required?: boolean;
+}
+/**
+ * @remarks
+ * Empty content is an absent key; `""` and `null` are invalid.
+ *
+ * @alpha
+ */
+export interface IPublisherWidgetBaseV2 {
+    type: PublisherWidgetTypeV2;
+    /**
+     * Unique within its page. Copying a page keeps widget ids as written. Matches `[A-Za-z0-9_.-]{1,64}`.
+     */
+    id: string;
+    /**
+     * Share of the parent's main axis, greater than 0. Defaults to 1.
+     */
+    proportion?: number;
+    placeholder?: IPublisherWidgetPlaceholderV2;
+    /**
+     * Enforced by the editor, never checked on write.
+     */
+    locked?: boolean;
+}
+/**
+ * Page title: the PowerPoint slide title and the page name for screen readers.
+ *
+ * @remarks
+ * At most one per page. A page without one uses its first heading as the slide title.
+ *
+ * @alpha
+ */
+export interface IPublisherTitleWidgetV2 extends IPublisherWidgetBaseV2 {
+    type: "title";
+    /**
+     * Inline markdown only: strong, emphasis, highlight, strike, links and line breaks.
+     */
+    markdown?: string;
+    /**
+     * `textStyle` defaults to `title`.
+     */
+    style?: IPublisherTextWidgetStyleV2;
+}
+/**
+ * @alpha
+ */
+export type PublisherHeadingLevelV2 = 1 | 2 | 3 | 4 | 5 | 6;
+/**
+ * @alpha
+ */
+export interface IPublisherHeadingWidgetV2 extends IPublisherWidgetBaseV2 {
+    type: "heading";
+    /**
+     * Inline markdown only.
+     */
+    markdown?: string;
+    /**
+     * Outline level below the page title, independent of the text style. Defaults to 1.
+     */
+    level?: PublisherHeadingLevelV2;
+    /**
+     * `textStyle` defaults to {@link publisherHeadingDefaultTextStyleV2} of the level.
+     */
+    style?: IPublisherTextWidgetStyleV2;
+}
+/**
+ * @alpha
+ */
+export interface IPublisherTextWidgetV2 extends IPublisherWidgetBaseV2 {
+    type: "text";
+    /**
+     * Full markdown: paragraphs, lists, quotes and headings.
+     */
+    markdown?: string;
+    /**
+     * Page furniture such as page numbers: kept out of the accessibility tree, PDF tags and AI context.
+     */
+    decorative?: boolean;
+    /**
+     * `textStyle` defaults to `normalText`.
+     */
+    style?: IPublisherTextWidgetStyleV2;
+}
+/**
+ * @alpha
+ */
+export interface IPublisherImageWidgetV2 extends IPublisherWidgetBaseV2 {
+    type: "image";
+    source?: PublisherImageSourceV2;
+    altText?: string;
+    decorative?: boolean;
+    style?: IPublisherImageWidgetStyleV2;
+}
+/**
+ * @alpha
+ */
+export interface IPublisherVisualizationRefV2 {
+    identifier: string;
+    type: "insight";
+}
+/**
+ * @alpha
+ */
+export interface IPublisherDataSetRefV2 {
+    identifier: string;
+    type: "dataSet";
+}
+/**
+ * @alpha
+ */
+export interface IPublisherWidgetTitleV2 {
+    /**
+     * Defaults to `true`.
+     */
+    visible?: boolean;
+    /**
+     * May contain text variables. A visible title without text shows the visualization's own title.
+     */
+    text?: string;
+    style?: IPublisherTextStyleV2;
+}
+/**
+ * @alpha
+ */
+export interface IPublisherAxisDisplayV2 {
+    visible?: boolean;
+    /**
+     * The axis title.
+     */
+    name?: {
+        visible?: boolean;
+        position?: "low" | "middle" | "high";
+    };
+    /**
+     * The tick labels. Rotation is in degrees, -90 to 90.
+     */
+    values?: {
+        visible?: boolean;
+        rotation?: number;
+    };
+    min?: number;
+    max?: number;
+}
+/**
+ * Overrides of the saved visualization's display settings.
+ *
+ * @remarks
+ * A key left out keeps the saved visualization's value. A key the visualization type does not
+ * support is ignored.
+ *
+ * @alpha
+ */
+export interface IPublisherVisualizationDisplayV2 {
+    legend?: {
+        visible?: boolean;
+        position?: "auto" | "top" | "bottom" | "left" | "right";
+    };
+    xAxis?: IPublisherAxisDisplayV2;
+    yAxis?: IPublisherAxisDisplayV2;
+    secondaryYAxis?: IPublisherAxisDisplayV2;
+    gridlines?: {
+        visible?: boolean;
+    };
+    dataLabels?: {
+        visible?: boolean | "auto";
+    };
+    dataPoints?: {
+        visible?: boolean | "auto";
+    };
+}
+/**
+ * @alpha
+ */
+export interface IPublisherVisualizationWidgetV2 extends IPublisherWidgetBaseV2 {
+    type: "visualization";
+    visualization?: IPublisherVisualizationRefV2;
+    title?: IPublisherWidgetTitleV2;
+    /**
+     * Defaults to the visualization's description.
+     */
+    altText?: string;
+    /**
+     * The date dataset that the document period filters.
+     */
+    dateDataSet?: IPublisherDataSetRefV2;
+    ignoreDocumentPeriod?: boolean;
+    filters?: FilterContextItem[];
+    /**
+     * May name a filter the document no longer has.
+     */
+    ignoreDocumentFilters?: IDashboardFilterReference[];
+    display?: IPublisherVisualizationDisplayV2;
+    style?: IPublisherVisualizationStyleV2;
+}
+/**
+ * @alpha
+ */
+export interface IPublisherTakeawayGenerationV2 {
+    /**
+     * Appended to the preset instructions. Sent together with the document's takeaway instructions;
+     * the widget's instructions win on a clash.
+     */
+    instructions?: string;
+    /**
+     * What the AI reads.
+     */
+    context?: {
+        /**
+         * Widget ids on the same page. Defaults to every visualization on the page.
+         */
+        widgets?: string[];
+        /**
+         * Defaults to `true`.
+         */
+        pageTitle?: boolean;
+        /**
+         * Filters and period. Defaults to `true`.
+         */
+        filters?: boolean;
+        /**
+         * Defaults to `false`.
+         */
+        otherPages?: boolean;
+    };
+}
+/**
+ * @alpha
+ */
+export interface IPublisherTakeawayWidgetV2 extends IPublisherWidgetBaseV2 {
+    type: "takeaway";
+    /**
+     * Text defaults to a localized "Takeaway".
+     */
+    title?: IPublisherWidgetTitleV2;
+    /**
+     * The generated or written text.
+     */
+    markdown?: string;
+    generation?: IPublisherTakeawayGenerationV2;
+    style?: IPublisherTextWidgetStyleV2;
+}
+/**
+ * @alpha
+ */
+export type PublisherWidgetV2 = IPublisherTitleWidgetV2 | IPublisherHeadingWidgetV2 | IPublisherTextWidgetV2 | IPublisherImageWidgetV2 | IPublisherVisualizationWidgetV2 | IPublisherTakeawayWidgetV2;
+/**
+ * Text style a heading uses when its style sets none: `h(n+1)` for level n, `h6` for levels 5 and 6.
+ *
+ * @alpha
+ */
+export declare function publisherHeadingDefaultTextStyleV2(level?: PublisherHeadingLevelV2): Extract<PublisherTextStyleNameV2, "h2" | "h3" | "h4" | "h5" | "h6">;
+/**
+ * @alpha
+ */
+export declare function isPublisherWidgetV2(obj: unknown): obj is PublisherWidgetV2;
+/**
+ * @alpha
+ */
+export declare function isPublisherTitleWidgetV2(obj: unknown): obj is IPublisherTitleWidgetV2;
+/**
+ * @alpha
+ */
+export declare function isPublisherHeadingWidgetV2(obj: unknown): obj is IPublisherHeadingWidgetV2;
+/**
+ * @alpha
+ */
+export declare function isPublisherTextWidgetV2(obj: unknown): obj is IPublisherTextWidgetV2;
+/**
+ * @alpha
+ */
+export declare function isPublisherImageWidgetV2(obj: unknown): obj is IPublisherImageWidgetV2;
+/**
+ * @alpha
+ */
+export declare function isPublisherVisualizationWidgetV2(obj: unknown): obj is IPublisherVisualizationWidgetV2;
+/**
+ * @alpha
+ */
+export declare function isPublisherTakeawayWidgetV2(obj: unknown): obj is IPublisherTakeawayWidgetV2;
+//# sourceMappingURL=widget.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"widget.d.ts","sourceRoot":"","sources":["../../../src/publisher/v2/widget.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,iBAAiB,EAAE,KAAK,yBAAyB,EAAE,MAAM,kCAAkC,CAAC;AAE1G,OAAO,EACH,KAAK,4BAA4B,EACjC,KAAK,qBAAqB,EAC1B,KAAK,2BAA2B,EAChC,KAAK,8BAA8B,EACnC,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAChC,MAAM,YAAY,CAAC;AAEpB;;GAEG;AACH,eAAO,MAAM,sBAAsB,YAC/B,OAAO,EACP,SAAS,EACT,MAAM,EACN,OAAO,EACP,eAAe,EACf,UAAU,CACJ,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,OAAO,sBAAsB,CAAC,CAAC,MAAM,CAAC,CAAC;AAE5E;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC1C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;;;;GAKG;AACH,MAAM,WAAW,sBAAsB;IACnC,IAAI,EAAE,qBAAqB,CAAC;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,6BAA6B,CAAC;IAC5C;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,uBAAwB,SAAQ,sBAAsB;IACnE,IAAI,EAAE,OAAO,CAAC;IACd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,2BAA2B,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAE5D;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,sBAAsB;IACrE,IAAI,EAAE,SAAS,CAAC;IAChB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,uBAAuB,CAAC;IAChC;;OAEG;IACH,KAAK,CAAC,EAAE,2BAA2B,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,sBAAsB;IAClE,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,KAAK,CAAC,EAAE,2BAA2B,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,sBAAsB;IACnE,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,CAAC,EAAE,sBAAsB,CAAC;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,KAAK,CAAC,EAAE,4BAA4B,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IACzC,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,SAAS,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACnC,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,SAAS,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACpC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,qBAAqB,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACpC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,IAAI,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,QAAQ,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,CAAA;KAAE,CAAC;IACnE;;OAEG;IACH,MAAM,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAClD,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,gCAAgC;IAC7C,MAAM,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IACxF,KAAK,CAAC,EAAE,uBAAuB,CAAC;IAChC,KAAK,CAAC,EAAE,uBAAuB,CAAC;IAChC,cAAc,CAAC,EAAE,uBAAuB,CAAC;IACzC,SAAS,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC;IAClC,UAAU,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM,CAAA;KAAE,CAAC;IAC5C,UAAU,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM,CAAA;KAAE,CAAC;CAC/C;AAED;;GAEG;AACH,MAAM,WAAW,+BAAgC,SAAQ,sBAAsB;IAC3E,IAAI,EAAE,eAAe,CAAC;IACtB,aAAa,CAAC,EAAE,4BAA4B,CAAC;IAC7C,KAAK,CAAC,EAAE,uBAAuB,CAAC;IAChC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,WAAW,CAAC,EAAE,sBAAsB,CAAC;IACrC,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,OAAO,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAC9B;;OAEG;IACH,qBAAqB,CAAC,EAAE,yBAAyB,EAAE,CAAC;IACpD,OAAO,CAAC,EAAE,gCAAgC,CAAC;IAC3C,KAAK,CAAC,EAAE,8BAA8B,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC3C;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,OAAO,CAAC,EAAE;QACN;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;QACnB;;WAEG;QACH,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB;;WAEG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB;;WAEG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;KACxB,CAAC;CACL;AAED;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,sBAAsB;IACtE,IAAI,EAAE,UAAU,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,uBAAuB,CAAC;IAChC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,8BAA8B,CAAC;IAC5C,KAAK,CAAC,EAAE,2BAA2B,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GACvB,uBAAuB,GACvB,yBAAyB,GACzB,sBAAsB,GACtB,uBAAuB,GACvB,+BAA+B,GAC/B,0BAA0B,CAAC;AAEjC;;;;GAIG;AACH,wBAAgB,kCAAkC,CAC9C,KAAK,GAAE,uBAA2B,GACnC,OAAO,CAAC,wBAAwB,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC,CAcrE;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,iBAAiB,CAM1E;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,uBAAuB,CAErF;AAED;;GAEG;AACH,wBAAgB,0BAA0B,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,yBAAyB,CAEzF;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,sBAAsB,CAEnF;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,uBAAuB,CAErF;AAED;;GAEG;AACH,wBAAgB,gCAAgC,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,+BAA+B,CAErG;AAED;;GAEG;AACH,wBAAgB,2BAA2B,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,0BAA0B,CAE3F"}

package/esm/publisher/v2/widget.js

@@ -0,0 +1,79 @@
+// (C) 2026 GoodData Corporation
+import { isEmpty } from "lodash-es";
+/**
+ * @alpha
+ */
+export const PublisherWidgetTypesV2 = [
+    "title",
+    "heading",
+    "text",
+    "image",
+    "visualization",
+    "takeaway",
+];
+/**
+ * Text style a heading uses when its style sets none: `h(n+1)` for level n, `h6` for levels 5 and 6.
+ *
+ * @alpha
+ */
+export function publisherHeadingDefaultTextStyleV2(level = 1) {
+    switch (level) {
+        case 1:
+            return "h2";
+        case 2:
+            return "h3";
+        case 3:
+            return "h4";
+        case 4:
+            return "h5";
+        case 5:
+        case 6:
+            return "h6";
+    }
+}
+/**
+ * @alpha
+ */
+export function isPublisherWidgetV2(obj) {
+    if (isEmpty(obj)) {
+        return false;
+    }
+    const { type } = obj;
+    return PublisherWidgetTypesV2.some((widgetType) => widgetType === type);
+}
+/**
+ * @alpha
+ */
+export function isPublisherTitleWidgetV2(obj) {
+    return !isEmpty(obj) && obj.type === "title";
+}
+/**
+ * @alpha
+ */
+export function isPublisherHeadingWidgetV2(obj) {
+    return !isEmpty(obj) && obj.type === "heading";
+}
+/**
+ * @alpha
+ */
+export function isPublisherTextWidgetV2(obj) {
+    return !isEmpty(obj) && obj.type === "text";
+}
+/**
+ * @alpha
+ */
+export function isPublisherImageWidgetV2(obj) {
+    return !isEmpty(obj) && obj.type === "image";
+}
+/**
+ * @alpha
+ */
+export function isPublisherVisualizationWidgetV2(obj) {
+    return !isEmpty(obj) && obj.type === "visualization";
+}
+/**
+ * @alpha
+ */
+export function isPublisherTakeawayWidgetV2(obj) {
+    return !isEmpty(obj) && obj.type === "takeaway";
+}