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

package/esm/reports/slot.js

@@ -1,87 +0,0 @@
-// (C) 2026 GoodData Corporation
-import { isEmpty } from "lodash-es";
-import { DefaultReportHeadingType, DefaultReportParagraphType, ReportHeadingTypes, ReportParagraphTypes, isReportHeadingType, isReportParagraphType, } from "./styling.js";
-/**
- * List of built-in report slot type names.
- *
- * @alpha
- */
-export const BuiltInReportSlotTypes = ["visualization", "heading", "paragraph", "image"];
-/**
- * All sizes a text slot can be rendered at, headings first.
- *
- * @alpha
- */
-export const ReportTextTypes = [...ReportHeadingTypes, ...ReportParagraphTypes];
-/**
- * Sizes the slot can be rendered at, which is what its own type decides.
- *
- * @alpha
- */
-export function reportTextSlotTypes(slot) {
-    return slot.type === "heading" ? ReportHeadingTypes : ReportParagraphTypes;
-}
-/**
- * Size the slot is rendered at.
- *
- * @remarks
- * A slot states its size, and content is an open format: a size the slot cannot carry, and a size
- * from a newer version, both fall back to the default of the slot's own type.
- *
- * @alpha
- */
-export function reportTextSlotType(slot) {
-    const stated = slot.style?.type;
-    if (slot.type === "heading") {
-        return isReportHeadingType(stated) ? stated : DefaultReportHeadingType;
-    }
-    return isReportParagraphType(stated) ? stated : DefaultReportParagraphType;
-}
-/**
- * Type-guard testing whether the provided object is an instance of {@link IReportVisualizationSlot}.
- *
- * @alpha
- */
-export function isReportVisualizationSlot(obj) {
-    return !isEmpty(obj) && obj.type === "visualization";
-}
-/**
- * Type-guard testing whether the provided object is an instance of {@link IReportHeadingSlot}.
- *
- * @alpha
- */
-export function isReportHeadingSlot(obj) {
-    return !isEmpty(obj) && obj.type === "heading";
-}
-/**
- * Type-guard testing whether the provided object is an instance of {@link IReportParagraphSlot}.
- *
- * @alpha
- */
-export function isReportParagraphSlot(obj) {
-    return !isEmpty(obj) && obj.type === "paragraph";
-}
-/**
- * Type-guard testing whether the provided object is an instance of {@link IReportTextSlot}.
- *
- * @alpha
- */
-export function isReportTextSlot(obj) {
-    return isReportHeadingSlot(obj) || isReportParagraphSlot(obj);
-}
-/**
- * Type-guard testing whether the provided object is an instance of {@link IReportImageSlot}.
- *
- * @alpha
- */
-export function isReportImageSlot(obj) {
-    return !isEmpty(obj) && obj.type === "image";
-}
-/**
- * Type-guard testing whether the provided object is an instance of {@link ReportSlot}.
- *
- * @alpha
- */
-export function isReportSlot(obj) {
-    return [isReportVisualizationSlot, isReportTextSlot, isReportImageSlot].some((guard) => guard(obj));
-}

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

@@ -1 +0,0 @@
-{"version":3,"file":"styling.d.ts","sourceRoot":"","sources":["../../src/reports/styling.ts"],"names":[],"mappings":"AAIA;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG,OAAO,GAAG,QAAQ,GAAG,KAAK,CAAC;AAEhE;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACnC,IAAI,EAAE,OAAO,CAAC;IAEd;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACnC,IAAI,EAAE,OAAO,CAAC;IAEd;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,sBAAsB,GAAG,sBAAsB,CAAC;AAE/E;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC5B,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAE9B;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;AAExE;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG,WAAW,GAAG,YAAY,GAAG,WAAW,CAAC;AAE3E;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;AAErE;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,EAAE,iBAAiB,EAAyC,CAAC;AAE5F;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,EAAE,mBAAmB,EAA6C,CAAC;AAEpG;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,EAAE,iBAAwB,CAAC;AAEhE;;;;GAIG;AACH,eAAO,MAAM,0BAA0B,EAAE,mBAAkC,CAAC;AAE5E;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,iBAAiB,CAE9E;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,mBAAmB,CAElF;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACrD;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,eAAe,CAAC,EAAE,sBAAsB,CAAC;IAEzC,aAAa,CAAC,EAAE,sBAAsB,CAAC;CAC1C;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IACzD;;;OAGG;IACH,IAAI,CAAC,EAAE,iBAAiB,CAAC;CAC5B;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC3D;;OAEG;IACH,IAAI,CAAC,EAAE,mBAAmB,CAAC;CAC9B;AAED;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAC9B,eAAe,CAAC,EAAE,sBAAsB,CAAC;IAEzC,aAAa,CAAC,EAAE,sBAAsB,CAAC;CAC1C;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,sBAAsB,CAEnF;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,sBAAsB,CAEnF"}

package/esm/reports/styling.js

@@ -1,58 +0,0 @@
-// (C) 2026 GoodData Corporation
-import { isEmpty } from "lodash-es";
-/**
- * All heading sizes, largest first.
- *
- * @alpha
- */
-export const ReportHeadingTypes = ["h1", "h2", "h3", "h4", "h5", "h6"];
-/**
- * All paragraph sizes, largest first.
- *
- * @alpha
- */
-export const ReportParagraphTypes = ["largeText", "normalText", "smallText"];
-/**
- * Size a heading slot that states none is rendered at.
- *
- * @alpha
- */
-export const DefaultReportHeadingType = "h1";
-/**
- * Size a paragraph slot that states none is rendered at.
- *
- * @alpha
- */
-export const DefaultReportParagraphType = "normalText";
-/**
- * Type-guard testing whether the value is a {@link ReportHeadingType}.
- *
- * @alpha
- */
-export function isReportHeadingType(value) {
-    return ReportHeadingTypes.includes(value);
-}
-/**
- * Type-guard testing whether the value is a {@link ReportParagraphType}.
- *
- * @alpha
- */
-export function isReportParagraphType(value) {
-    return ReportParagraphTypes.includes(value);
-}
-/**
- * Type-guard testing whether the provided object is an instance of {@link IReportColorBackground}.
- *
- * @alpha
- */
-export function isReportColorBackground(obj) {
-    return !isEmpty(obj) && obj.type === "color";
-}
-/**
- * Type-guard testing whether the provided object is an instance of {@link IReportImageBackground}.
- *
- * @alpha
- */
-export function isReportImageBackground(obj) {
-    return !isEmpty(obj) && obj.type === "image";
-}

package/esm/reports/variables.d.ts

@@ -1,72 +0,0 @@
-/**
- * ISO 8601 calendar date (YYYY-MM-DD).
- *
- * @alpha
- */
-export type ReportDateString = string;
-/**
- * Variables resolved by the rendering runtime; they are never declared or stored.
- *
- * @remarks
- * Referenced from report text as `{name}`. Custom variable names must not collide with these;
- * on collision the built-in wins.
- *
- * @alpha
- */
-export type ReportBuiltInVariable = "reportName" | "reportDescription" | "periodStart" | "periodEnd" | "reportDateRange" | "reportAttributeFilters" | "exportedAt" | "exportedBy" | "lastModifiedAt" | "lastModifiedBy" | "workspaceName" | "workspaceId" | "totalPages" | "currentPageNumber" | "logo";
-/**
- * All built-in report variable names.
- *
- * @alpha
- */
-export declare const ReportBuiltInVariables: ReportBuiltInVariable[];
-/**
- * A custom variable declared by report content and given a value by a report.
- *
- * @remarks
- * Referenced from text as `{name}`. Values come from {@link IReportBase.variableValues},
- * falling back to {@link IReportVariableDefinition.defaultValue}.
- *
- * @alpha
- */
-export interface IReportVariableDefinition {
-    /**
-     * Variable name as used inside the `{...}` marker. Must match /^[a-zA-Z][a-zA-Z0-9_]*$/.
-     * Built-in names ({@link ReportBuiltInVariable}) are reserved.
-     */
-    name: string;
-    /**
-     * Human readable label shown in the editor.
-     */
-    title?: string;
-    description?: string;
-    /**
-     * Value used when the report does not provide one. May not contain further
-     * placeholders — there is no recursive expansion.
-     */
-    defaultValue?: string;
-}
-/**
- * The marker referencing the named variable from report text.
- *
- * @alpha
- */
-export declare function reportTextPlaceholder(name: string): string;
-/**
- * Collects the distinct `{variable}` names referenced in the text, in order of first occurrence.
- *
- * @alpha
- */
-export declare function getReportTextPlaceholders(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 report text.
- *
- * @alpha
- */
-export declare function resolveReportTextPlaceholders(text: string, values: Record<string, string>): string;
-//# sourceMappingURL=variables.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"variables.d.ts","sourceRoot":"","sources":["../../src/reports/variables.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAEtC;;;;;;;;GAQG;AACH,MAAM,MAAM,qBAAqB,GAC3B,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,sBAAsB,EAAE,qBAAqB,EAgBzD,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,WAAW,yBAAyB;IACtC;;;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,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE1D;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAShE;AAED;;;;;;;;;GASG;AACH,wBAAgB,6BAA6B,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,CAIlG"}