@gooddata/sdk-code-convertors 11.35.0-alpha.5 → 11.35.0-alpha.6

package/esm/to/yamlDashboardToDeclarative.d.ts

@@ -1,23 +1,37 @@
 import { type DeclarativeAnalyticalDashboard, type DeclarativeFilterContext } from "@gooddata/api-client-tiger";
 import type { ContainerWidget, Dashboard, DashboardFilters, Interaction, RichTextWidget, VisualisationWidget, VisualizationSwitcherWidget, Widget } from "@gooddata/sdk-code-schemas/v1";
-import { type IDashboardAttributeFilterConfig, type IDashboardDateFilterConfig, type IDashboardDateFilterConfigItem, type IDashboardFilterGroupsConfig, type IDashboardMeasureValueFilterConfig, type IDashboardPluginLink, type IDrillToAttributeUrl, type IDrillToCustomUrl, type IDrillToDashboard, type IDrillToInsight } from "@gooddata/sdk-model";
+import { type IDashboardAttributeFilterConfig, type IDashboardDateFilter, type IDashboardDateFilterConfig, type IDashboardDateFilterConfigItem, type IDashboardFilterGroupsConfig, type IDashboardMeasureValueFilterConfig, type IDashboardPluginLink, type IDrillToAttributeUrl, type IDrillToCustomUrl, type IDrillToDashboard, type IDrillToInsight, type IFilterContextDefinition } from "@gooddata/sdk-model";
 import { type OverrideDashboardDefinition } from "../from/declarativeDashboardToYaml.js";
 import { type ExportEntities } from "../types.js";
-type DashboardDefinition = Pick<OverrideDashboardDefinition, "layout" | "plugins" | "dateFilterConfig" | "dateFilterConfigs" | "disableCrossFiltering" | "disableUserFilterSave" | "disableUserFilterReset" | "disableFilterViews" | "attributeFilterConfigs" | "measureValueFilterConfigs" | "filterContextRef" | "tabs" | "activeTabLocalIdentifier"> & {
+/** @internal */
+export type DashboardDefinition = Pick<OverrideDashboardDefinition, "layout" | "plugins" | "dateFilterConfig" | "dateFilterConfigs" | "disableCrossFiltering" | "disableUserFilterSave" | "disableUserFilterReset" | "disableFilterViews" | "attributeFilterConfigs" | "measureValueFilterConfigs" | "filterContextRef" | "tabs" | "activeTabLocalIdentifier"> & {
     version: string;
 };
-type DashboardSection = Required<DashboardDefinition>["layout"]["sections"][number];
-type DashboardWidget = DashboardSection["items"][number];
+/** @internal */
+export type FilterContextDefinition = Pick<IFilterContextDefinition, "filters"> & {
+    version: string;
+};
+/** @internal */
+export type DashboardSection = Required<DashboardDefinition>["layout"]["sections"][number];
+/** @internal */
+export type DashboardWidget = DashboardSection["items"][number];
+/** @internal */
+export type EmptyValueHandling = NonNullable<IDashboardDateFilter["dateFilter"]["emptyValueHandling"]>;
 /** @public */
 export declare function yamlDashboardToDeclarative(entities: ExportEntities, input: Dashboard): {
     dashboard: DeclarativeAnalyticalDashboard;
     filterContext: DeclarativeFilterContext;
     tabFilterContexts?: DeclarativeFilterContext[];
 };
+/** @internal */
 export declare function yamlWidgetItemToDeclarative(entities: ExportEntities, input: Widget, enableSectionHeaders?: boolean): DashboardWidget | null;
+/** @internal */
 export declare function yamlWidgetToDeclarative(entities: ExportEntities, input: VisualisationWidget | RichTextWidget | VisualizationSwitcherWidget | ContainerWidget, enableSectionHeaders?: boolean): DashboardWidget["widget"];
+/** @internal */
 export declare function yamlInteractionToDeclarative(entities: ExportEntities, visualisation: string, input: Interaction): IDrillToInsight | IDrillToDashboard | IDrillToCustomUrl | IDrillToAttributeUrl | null;
+/** @internal */
 export declare function yamlPluginsToDeclarative(plugins: Dashboard["plugins"]): IDashboardPluginLink[] | undefined;
+/** @internal */
 export declare function yamlFilterContextToDeclarative(baseId: string, yamlFilters: DashboardFilters | undefined): {
     filterContext: DeclarativeFilterContext;
     dateFilterConfig: IDashboardDateFilterConfig | undefined;
@@ -26,4 +40,3 @@ export declare function yamlFilterContextToDeclarative(baseId: string, yamlFilte
     measureValueFilterConfigs: IDashboardMeasureValueFilterConfig[] | undefined;
     filterGroupsConfig: IDashboardFilterGroupsConfig | undefined;
 };
-export {};

package/esm/to/yamlDashboardToDeclarative.js

@@ -166,6 +166,7 @@ function yamlSectionToDeclarative(entities, yamlSection, enableSectionHeaders) {
             .filter(Boolean),
     };
 }
+/** @internal */
 export function yamlWidgetItemToDeclarative(entities, input, enableSectionHeaders) {
     const size = yamlSizeToDeclarative(input);
     const widget = yamlWidgetToDeclarative(entities, input, enableSectionHeaders ?? true);
@@ -222,6 +223,7 @@ function yamlInsightWidgetToDeclarative(entities, input) {
         ...(input.ignored_cross_filtering ? { ignoreCrossFiltering: true } : {}),
     };
 }
+/** @internal */
 export function yamlWidgetToDeclarative(entities, input, enableSectionHeaders) {
     if (isContainerWidget(input)) {
         return {
@@ -327,6 +329,7 @@ function yamlWidgetPropertiesToDeclarative(input) {
     }
     return {};
 }
+/** @internal */
 export function yamlInteractionToDeclarative(entities, visualisation, input) {
     const target = entities
         .filter((e) => VisualisationsTypes.includes(e.type))
@@ -506,6 +509,7 @@ function yamlIgnoredFilterToDeclarative(input) {
     }
     return null;
 }
+/** @internal */
 export function yamlPluginsToDeclarative(plugins) {
     return plugins?.map((plugin) => yamlPluginToDeclarative(plugin));
 }
@@ -546,6 +550,7 @@ function flattenFilters(yamlFilters) {
     }
     return result;
 }
+/** @internal */
 export function yamlFilterContextToDeclarative(baseId, yamlFilters) {
     const dateFilterConfig = {};
     const dateFilterConfigs = [];

package/esm/to/yamlDatasetToDeclarative.d.ts

@@ -17,6 +17,7 @@ export declare function buildGrain(entities: ExportEntities, primaryKey?: string
 /**
  * Build declarative references
  */
+/** @internal */
 export declare function buildReferences(entities: ExportEntities, refs?: Dataset["references"]): DeclarativeReference[];
 /**
  * Build declarative workspace data filter references
@@ -25,6 +26,7 @@ export declare function buildWorkspaceDataFilterReferences(refs?: Dataset["works
 /**
  * Build declarative facts out of AaC fields
  */
+/** @internal */
 export declare function buildFacts(fields?: Fields): DeclarativeFact[];
 /**
  * Build declarative aggregated facts out of AaC fields
@@ -33,8 +35,10 @@ export declare function buildAggregatedFacts(fields?: Fields, entities?: ExportE
 /**
  * Build declarative attributes out of AaC fields
  */
+/** @internal */
 export declare function buildAttributes(fields?: Fields, isAuxiliaryDataset?: boolean): DeclarativeAttribute[];
 /**
  * Build declarative attribute labels out of AaC labels
  */
+/** @internal */
 export declare function buildAttributeLabels(labels?: Attribute["labels"], isAuxiliaryDataset?: boolean): DeclarativeLabel[];

package/esm/to/yamlDatasetToDeclarative.js

@@ -126,6 +126,7 @@ export function buildGrain(entities, primaryKey) {
 /**
  * Build declarative references
  */
+/** @internal */
 export function buildReferences(entities, refs = []) {
     const datesId = entities
         .filter((entity) => entity.type === "date")
@@ -189,6 +190,7 @@ export function buildWorkspaceDataFilterReferences(refs = []) {
 /**
  * Build declarative facts out of AaC fields
  */
+/** @internal */
 export function buildFacts(fields) {
     if (!fields) {
         return [];
@@ -271,6 +273,7 @@ export function buildAggregatedFacts(fields, entities = []) {
 /**
  * Build declarative attributes out of AaC fields
  */
+/** @internal */
 export function buildAttributes(fields, isAuxiliaryDataset = false) {
     if (!fields) {
         return [];
@@ -327,6 +330,7 @@ export function buildAttributes(fields, isAuxiliaryDataset = false) {
 /**
  * Build declarative attribute labels out of AaC labels
  */
+/** @internal */
 export function buildAttributeLabels(labels, isAuxiliaryDataset = false) {
     if (!labels) {
         return [];

package/esm/to/yamlVisualisationToDeclarative.d.ts

@@ -2,13 +2,15 @@ import { type DeclarativeVisualizationObject, type JsonApiVisualizationObjectOut
 import type { Filter, QueryFilters, Sorts, Total, Visualisation } from "@gooddata/sdk-code-schemas/v1";
 import { type IAttributeFilterConfigs, type IFilter, type IInsight, type ISortItem, type ITotal } from "@gooddata/sdk-model";
 import { type ExportEntities } from "../types.js";
-type VisualisationDefinition = Pick<IInsight["insight"], "visualizationUrl" | "properties" | "filters" | "buckets" | "sorts" | "attributeFilterConfigs"> & {
+/** @internal */
+export type VisualisationDefinition = Pick<IInsight["insight"], "visualizationUrl" | "properties" | "filters" | "buckets" | "sorts" | "attributeFilterConfigs"> & {
     version: string;
 };
 /** @public */
 export declare function yamlVisualisationToDeclarative(entities: ExportEntities, input: Visualisation): DeclarativeVisualizationObject;
 /** @public */
 export declare function yamlVisualisationToMetadataObject(entities: ExportEntities, input: Visualisation): JsonApiVisualizationObjectOut;
+/** @internal */
 export declare function yamlReportToDeclarative(entities: ExportEntities, input: Visualisation): {
     buckets: VisualisationDefinition["buckets"];
     sorts: VisualisationDefinition["sorts"];
@@ -19,12 +21,16 @@ export declare function yamlReportToDeclarative(entities: ExportEntities, input:
     }>;
     attributeFilterConfigs?: IAttributeFilterConfigs;
 };
+/** @internal */
 export declare function yamlSortsToDeclarative(sort_by: Sorts | undefined, fields: Visualisation["query"]["fields"]): ISortItem[];
+/** @internal */
 export declare function yamlFiltersToDeclarative(entities: ExportEntities, filters_by: QueryFilters | Filter[] | undefined, attributeFilterConfigs?: IAttributeFilterConfigs): {
     filters: IFilter[];
     attributeFilterConfigs: IAttributeFilterConfigs | undefined;
 };
+/** @internal */
 export declare function yamlReportTotalToDeclarative(totals: Total[] | undefined, attributeIdentifier: string): ITotal[];
+/** @internal */
 export declare function yamlBucketsToDeclarative(entities: ExportEntities, input: Visualisation): {
     buckets: VisualisationDefinition["buckets"];
     positions: Array<{
@@ -33,4 +39,3 @@ export declare function yamlBucketsToDeclarative(entities: ExportEntities, input
     }>;
     attrFilterConfig: IAttributeFilterConfigs;
 };
-export {};

package/esm/to/yamlVisualisationToDeclarative.js

@@ -199,6 +199,7 @@ function yamlConfigToDeclarative(def, positions) {
     };
 }
 //REPORT
+/** @internal */
 export function yamlReportToDeclarative(entities, input) {
     const { buckets, positions, attrFilterConfig } = yamlBucketsToDeclarative(entities, input);
     const query = input.query;
@@ -435,6 +436,7 @@ function resolveField(localName, field) {
     return undefined;
 }
 //SORTS
+/** @internal */
 export function yamlSortsToDeclarative(sort_by, fields) {
     if (!sort_by) {
         return [];
@@ -845,6 +847,7 @@ function mergeDeclarativeResults(...results) {
         attributeFilterConfig: Object.assign({}, ...results.map((result) => result.attributeFilterConfig ?? {})),
     };
 }
+/** @internal */
 export function yamlFiltersToDeclarative(entities, filters_by, attributeFilterConfigs = {}) {
     const isArray = Array.isArray(filters_by);
     const { filters, attributeFilterConfig } = mergeDeclarativeResults({ filters: [], attributeFilterConfig: attributeFilterConfigs }, ...(filters_by && !isArray
@@ -858,6 +861,7 @@ export function yamlFiltersToDeclarative(entities, filters_by, attributeFilterCo
     };
 }
 //TOTALS
+/** @internal */
 export function yamlReportTotalToDeclarative(totals = [], attributeIdentifier) {
     return totals.map((total) => {
         return {
@@ -869,6 +873,7 @@ export function yamlReportTotalToDeclarative(totals = [], attributeIdentifier) {
     });
 }
 //BUCKETS
+/** @internal */
 export function yamlBucketsToDeclarative(entities, input) {
     const visBuckets = mapBuckets(input);
     const query = input.query;

package/esm/utils/sharedUtils.d.ts

@@ -17,6 +17,7 @@ export declare function convertIdToTitle(id?: string | null): string;
  */
 export declare function convertTitleToId(title?: string | null): string;
 export declare function convertIdOrTitleToId(id: string, title?: string | null): string;
+/** @public */
 export type FullFields = AttributeField | MetricField | CalculatedMetricField | InlineMetricField | ArithmeticMetricField | PoPMetricField | PreviousPeriodMetricField;
 export declare function getFullField(field: Field): FullFields;
 export declare function getFullBucket(bucket: Bucket): ComplexBucket;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gooddata/sdk-code-convertors",
-  "version": "11.35.0-alpha.5",
+  "version": "11.35.0-alpha.6",
   "description": "GoodData AAC declarative converters",
   "license": "MIT",
   "author": "GoodData",
@@ -26,9 +26,9 @@
   "dependencies": {
     "uuid": "11.1.0",
     "yaml": "^2.2.2",
-    "@gooddata/api-client-tiger": "11.35.0-alpha.5",
-    "@gooddata/sdk-model": "11.35.0-alpha.5",
-    "@gooddata/sdk-code-schemas": "11.35.0-alpha.5"
+    "@gooddata/sdk-model": "11.35.0-alpha.6",
+    "@gooddata/api-client-tiger": "11.35.0-alpha.6",
+    "@gooddata/sdk-code-schemas": "11.35.0-alpha.6"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.55.2",
@@ -50,8 +50,8 @@
     "oxlint-tsgolint": "0.11.4",
     "typescript": "5.9.3",
     "vitest": "4.1.0",
-    "@gooddata/eslint-config": "11.35.0-alpha.5",
-    "@gooddata/oxlint-config": "11.35.0-alpha.5"
+    "@gooddata/eslint-config": "11.35.0-alpha.6",
+    "@gooddata/oxlint-config": "11.35.0-alpha.6"
   },
   "scripts": {
     "_phase:build": "npm run build",
@@ -63,7 +63,7 @@
     "build-ts": "tsgo -p tsconfig.build.json",
     "build-wasm": "bash wasm/build.sh",
     "check-python-types": "node scripts/check-python-types.mjs",
-    "clean": "../../common/scripts/clean-command-state.sh && rm -rf esm coverage *.log tsconfig.tsbuildinfo",
+    "clean": "../../common/scripts/clean-command-state.sh && rm -rf esm coverage temp *.log tsconfig.tsbuildinfo",
     "dep-cruiser": "depcruise --validate .dependency-cruiser.js --output-type err-long src/",
     "format-check": "oxfmt --check .",
     "format-write": "oxfmt .",