import {z} from 'zod' export type UuidOrSlug = string; export type UUID = string; export type GetApiApiV1DashboardsDashboardUuidOrSlugPromoteDiffArgs = {dashboardUuidOrSlug: UuidOrSlug, projectUuid?: UUID | undefined}; export type GetApiApiV1DashboardsDashboardUuidOrSlugPromoteDiffOptions = {baseUrl: string, fetch?: typeof fetch | undefined}; export const promotedApp = z.object({name: z.string(), uuid: z.string()}); export const promotionAction = z.enum(["no changes", "create", "update", "delete"]); export const promotedSqlChart = z.object({spacePath: z.string(), spaceSlug: z.string(), description: z.string().nullable(), name: z.string(), projectUuid: z.string(), slug: z.string(), oldUuid: z.string(), uuid: z.string()}); export const pickCompiledDimensionLabelOrNameOrTable = z.object({name: z.string(), label: z.string(), table: z.string()}); export const fieldId = z.string(); export const customFormatType = z.enum(["default", "percent", "currency", "number", "id", "date", "timestamp", "bytes_si", "bytes_iec", "custom"]); export const numberSeparator = z.enum(["default", "commaPeriod", "spacePeriod", "periodComma", "noSeparatorPeriod", "apostrophePeriod"]); export const compact = z.enum(["auto", "thousands", "millions", "billions", "trillions", "kilobytes", "megabytes", "gigabytes", "terabytes", "petabytes", "kibibytes", "mebibytes", "gibibytes", "tebibytes", "pebibytes"]); export const compactOrAlias = z.union([compact, z.enum(["K", "thousand", "M", "million", "B", "billion", "T", "trillion", "KB", "kilobyte", "MB", "megabyte", "GB", "gigabyte", "TB", "terabyte", "PB", "petabyte", "KiB", "kibibyte", "MiB", "mebibyte", "GiB", "gibibyte", "TiB", "tebibyte", "PiB", "pebibyte"])]); export const timeFrames = z.enum(["RAW", "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND", "DAY_OF_WEEK_INDEX", "DAY_OF_MONTH_NUM", "DAY_OF_YEAR_NUM", "WEEK_NUM", "MONTH_NUM", "QUARTER_NUM", "YEAR_NUM", "DAY_OF_WEEK_NAME", "MONTH_NAME", "QUARTER_NAME", "HOUR_OF_DAY_NUM", "MINUTE_OF_HOUR_NUM"]); export const customFormat = z.object({type: customFormatType, round: z.number().optional(), separator: numberSeparator.optional(), currency: z.string().optional(), compact: compactOrAlias.optional(), prefix: z.string().optional(), suffix: z.string().optional(), timeInterval: timeFrames.optional(), custom: z.string().optional()}).and(z.record(z.string(), z.unknown())); export const pickDimensionFormatOptions = z.object({formatOptions: customFormat.optional()}); export const dimensionOverrides = z.record(z.string(), pickDimensionFormatOptions); export const pickMetricFormatOptions = z.object({formatOptions: customFormat.optional()}); export const metricOverrides = z.record(z.string(), pickMetricFormatOptions); export const customDimensionTypeBIN = z.literal("bin"); export const binTypeFIXEDNUMBER = z.literal("fixed_number"); export const fixedNumberBinDimension = z.object({id: z.string(), name: z.string(), table: z.string(), type: customDimensionTypeBIN, dimensionId: fieldId, binType: binTypeFIXEDNUMBER, binNumber: z.number()}).and(z.record(z.string(), z.unknown())); export const binTypeFIXEDWIDTH = z.literal("fixed_width"); export const fixedWidthBinDimension = z.object({id: z.string(), name: z.string(), table: z.string(), type: customDimensionTypeBIN, dimensionId: fieldId, binType: binTypeFIXEDWIDTH, binWidth: z.number()}).and(z.record(z.string(), z.unknown())); export const binTypeCUSTOMRANGE = z.literal("custom_range"); export const binRange = z.object({to: z.number().optional(), from: z.number().optional()}); export const customRangeBinDimension = z.object({id: z.string(), name: z.string(), table: z.string(), type: customDimensionTypeBIN, dimensionId: fieldId, binType: binTypeCUSTOMRANGE, customRange: z.array(binRange)}).and(z.record(z.string(), z.unknown())); export const binTypeCUSTOMGROUP = z.literal("custom_group"); export const groupValueMatchType = z.enum(["exact", "startsWith", "endsWith", "includes"]); export const groupValueRule = z.object({value: z.string(), matchType: groupValueMatchType}); export const binGroup = z.object({values: z.array(groupValueRule), name: z.string()}); export const customGroupBinDimension = z.object({id: z.string(), name: z.string(), table: z.string(), type: customDimensionTypeBIN, dimensionId: fieldId, binType: binTypeCUSTOMGROUP, customGroups: z.array(binGroup)}).and(z.record(z.string(), z.unknown())); export const customBinDimension = z.union([fixedNumberBinDimension, fixedWidthBinDimension, customRangeBinDimension, customGroupBinDimension]); export const customDimensionTypeSQL = z.literal("sql"); export const dimensionType = z.enum(["string", "number", "timestamp", "date", "boolean"]); export const customSqlDimension = z.object({id: z.string(), name: z.string(), table: z.string(), type: customDimensionTypeSQL, sql: z.string(), dimensionType: dimensionType}).and(z.record(z.string(), z.unknown())); export const customDimension = z.union([customBinDimension, customSqlDimension]); export const metricType = z.enum(["percentile", "average", "count", "count_distinct", "sum", "sum_distinct", "average_distinct", "min", "max", "percent_of_previous", "percent_of_total", "running_total", "number", "median", "string", "date", "timestamp", "boolean"]); export const format = z.enum(["km", "mi", "si", "usd", "gbp", "eur", "jpy", "dkk", "id", "percent"]); export const anyType = z.unknown(); export const filterOperator = z.enum(["isNull", "notNull", "equals", "notEquals", "startsWith", "endsWith", "include", "doesNotInclude", "lessThan", "lessThanOrEqual", "greaterThan", "greaterThanOrEqual", "inThePast", "notInThePast", "inTheNext", "inTheCurrent", "notInTheCurrent", "inBetween", "notInBetween", "inPeriodToDate"]); export const metricFilterRule = z.object({includeNull: z.boolean().optional(), values: z.array(anyType).optional(), operator: filterOperator, id: z.string(), target: z.object({fieldRef: z.string()}), settings: anyType.optional(), disabled: z.boolean().optional(), required: z.boolean().optional(), caseSensitive: z.boolean().optional()}).and(z.record(z.string(), z.unknown())); export const additionalMetric = z.object({label: z.string().optional(), type: metricType, description: z.string().optional(), sql: z.string(), hidden: z.boolean().optional(), round: z.number().optional(), compact: compactOrAlias.optional(), format: z.union([format, z.string()]).optional(), separator: numberSeparator.optional(), table: z.string(), name: z.string(), index: z.number().optional(), filters: z.array(metricFilterRule).optional(), baseDimensionName: z.string().optional(), baseMetricName: z.string().optional(), uuid: z.string().nullable().optional(), percentile: z.number().optional(), distinctKeys: z.array(z.string()).optional(), formatOptions: customFormat.optional(), generationType: z.literal("periodOverPeriod").optional(), baseMetricId: fieldId.optional(), timeDimensionId: fieldId.optional(), granularity: timeFrames.optional(), periodOffset: z.number().optional()}).and(z.record(z.string(), z.unknown())); export const tableCalculationTotalMode = z.enum(["formula", "sum_of_rows", "none"]); export const tableCalculationType = z.enum(["number", "string", "date", "timestamp", "boolean"]); export const sqlTableCalculation = z.object({totalMode: tableCalculationTotalMode.optional(), type: tableCalculationType.optional(), format: customFormat.optional(), displayName: z.string(), name: z.string(), index: z.number().optional(), sql: z.string()}); export const tableCalculationTemplateTypePERCENTCHANGEFROMPREVIOUS = z.literal("percent_change_from_previous"); export const tableCalculationTemplateTypePERCENTOFPREVIOUSVALUE = z.literal("percent_of_previous_value"); export const tableCalculationTemplateTypePERCENTOFCOLUMNTOTAL = z.literal("percent_of_column_total"); export const tableCalculationTemplateTypeRANKINCOLUMN = z.literal("rank_in_column"); export const tableCalculationTemplateTypeRUNNINGTOTAL = z.literal("running_total"); export const frameBoundaryType = z.enum(["unbounded_preceding", "preceding", "current_row", "following", "unbounded_following"]); export const frameBoundary = z.object({offset: z.number().optional(), type: frameBoundaryType}); export const frameType = z.enum(["rows", "range"]); export const frameClause = z.object({end: frameBoundary, start: frameBoundary.optional(), frameType: frameType}); export const windowFunctionType = z.enum(["row_number", "percent_rank", "cume_dist", "rank", "sum", "avg", "count", "min", "max"]); export const tableCalculationTemplateTypeWINDOWFUNCTION = z.literal("window_function"); export const tableCalculationTemplate = z.union([z.object({partitionBy: z.array(z.string()).optional(), orderBy: z.array(z.object({order: z.enum(["asc", "desc", "null"]).nullable(), fieldId: z.string()})), fieldId: z.string(), type: tableCalculationTemplateTypePERCENTCHANGEFROMPREVIOUS}), z.object({partitionBy: z.array(z.string()).optional(), orderBy: z.array(z.object({order: z.enum(["asc", "desc", "null"]).nullable(), fieldId: z.string()})), fieldId: z.string(), type: tableCalculationTemplateTypePERCENTOFPREVIOUSVALUE}), z.object({partitionBy: z.array(z.string()).optional(), fieldId: z.string(), type: tableCalculationTemplateTypePERCENTOFCOLUMNTOTAL}), z.object({fieldId: z.string(), type: tableCalculationTemplateTypeRANKINCOLUMN}), z.object({fieldId: z.string(), type: tableCalculationTemplateTypeRUNNINGTOTAL}), z.object({frame: frameClause.optional(), partitionBy: z.array(z.string()), orderBy: z.array(z.object({order: z.enum(["asc", "desc", "null"]).nullable(), fieldId: z.string()})), fieldId: z.string().nullable(), windowFunction: windowFunctionType, type: tableCalculationTemplateTypeWINDOWFUNCTION})]); export const templateTableCalculation = z.object({totalMode: tableCalculationTotalMode.optional(), type: tableCalculationType.optional(), format: customFormat.optional(), displayName: z.string(), name: z.string(), index: z.number().optional(), template: tableCalculationTemplate}); export const formulaTableCalculation = z.object({totalMode: tableCalculationTotalMode.optional(), type: tableCalculationType.optional(), format: customFormat.optional(), displayName: z.string(), name: z.string(), index: z.number().optional(), formula: z.string()}); export const tableCalculation = z.union([sqlTableCalculation, templateTableCalculation, formulaTableCalculation]); export const pivotSortAnchor = z.object({value: z.union([z.string(), z.number(), z.boolean()]).nullable(), reference: z.string()}); export const sortField = z.object({pivotValues: z.array(pivotSortAnchor).optional(), nullsFirst: z.boolean().optional(), descending: z.boolean(), fieldId: z.string()}); export const fieldTarget = z.object({fieldId: z.string()}); export const filterRule = z.object({includeNull: z.boolean().optional(), values: z.array(anyType).optional(), operator: filterOperator, id: z.string(), target: fieldTarget, settings: anyType.optional(), disabled: z.boolean().optional(), required: z.boolean().optional(), caseSensitive: z.boolean().optional()}).and(z.record(z.string(), z.unknown())); export const filterGroupItem = z.union([z.lazy(() => filterGroup), filterRule]); export const orFilterGroup = z.object({or: z.array(filterGroupItem), id: z.string()}); export const andFilterGroup = z.object({and: z.array(filterGroupItem), id: z.string()}); export const filterGroup: z.ZodType = z.union([orFilterGroup, andFilterGroup]); export const filters = z.object({tableCalculations: filterGroup.optional(), metrics: filterGroup.optional(), dimensions: filterGroup.optional()}); export const metricQuery = z.object({metadata: z.object({hasADateDimension: pickCompiledDimensionLabelOrNameOrTable}).optional(), pivotDimensions: z.array(fieldId).optional(), timezone: z.string().optional(), dimensionOverrides: dimensionOverrides.optional(), metricOverrides: metricOverrides.optional(), customDimensions: z.array(customDimension).optional(), additionalMetrics: z.array(additionalMetric).optional(), tableCalculations: z.array(tableCalculation), limit: z.number(), sorts: z.array(sortField), filters: filters, metrics: z.array(fieldId), dimensions: z.array(fieldId), exploreName: z.string()}); export const conditionalFormattingTextStyle = z.object({underline: z.boolean().optional(), italic: z.boolean().optional(), bold: z.boolean().optional()}); export const conditionalFormattingColorApplyTo = z.enum(["cell", "text", "row"]); export const conditionalFormattingWithValuesNumberOrString = z.object({includeNull: z.boolean().optional(), values: z.array(z.union([z.number(), z.string()])), operator: filterOperator, id: z.string()}); export const conditionalFormattingWithCompareTargetNumberOrString = z.object({includeNull: z.boolean().optional(), values: z.array(z.union([z.number(), z.string()])).optional(), operator: filterOperator, id: z.string(), compareTarget: fieldTarget.nullable()}); export const conditionalFormattingWithFilterOperator = z.union([conditionalFormattingWithValuesNumberOrString, conditionalFormattingWithCompareTargetNumberOrString]); export const conditionalFormattingConfigWithSingleColor = z.object({textStyle: conditionalFormattingTextStyle.optional(), applyTo: conditionalFormattingColorApplyTo.optional(), rules: z.array(conditionalFormattingWithFilterOperator), darkColor: z.string().optional(), color: z.string(), target: fieldTarget.nullable()}); export const conditionalFormattingMinMaxNumberOrAuto = z.object({max: z.union([z.number(), z.literal("auto")]), min: z.union([z.number(), z.literal("auto")])}); export const conditionalFormattingColorRange = z.object({end: z.string(), start: z.string()}); export const conditionalFormattingConfigWithColorRange = z.object({textStyle: conditionalFormattingTextStyle.optional(), applyTo: conditionalFormattingColorApplyTo.optional(), rule: conditionalFormattingMinMaxNumberOrAuto, color: conditionalFormattingColorRange, target: fieldTarget.nullable()}); export const conditionalFormattingConfig = z.union([conditionalFormattingConfigWithSingleColor, conditionalFormattingConfigWithColorRange]); export const comparisonFormatTypes = z.enum(["raw", "percentage"]); export const bigNumber = z.object({comparisonField: z.string().optional(), conditionalFormattings: z.array(conditionalFormattingConfig).optional(), comparisonLabel: z.string().optional(), flipColors: z.boolean().optional(), comparisonFormat: comparisonFormatTypes.optional(), showComparison: z.boolean().optional(), showTableNamesInLabel: z.boolean().optional(), showBigNumberLabel: z.boolean().optional(), selectedField: z.string().optional(), style: compactOrAlias.optional(), label: z.string().optional()}); export const chartTypeBIGNUMBER = z.literal("big_number"); export const bigNumberConfig = z.object({config: bigNumber.optional(), type: chartTypeBIGNUMBER}); export const rowLimit = z.object({count: z.number(), direction: z.enum(["first", "last"]), mode: z.enum(["show", "hide"])}); export const seriesMetadata = z.object({color: z.string()}); export const recordStringSeriesMetadata = z.record(z.string(), seriesMetadata); export const recordStringBoolean = z.record(z.string(), z.boolean()); export const legendPlacement = z.enum(["custom", "outsideRight", "outsideLeft"]); export const echartsLegend = z.object({selected: recordStringBoolean.optional(), placement: legendPlacement.optional(), icon: z.enum(["circle", "rect", "roundRect", "triangle", "diamond", "pin", "arrow", "none"]).optional(), align: z.enum(["auto", "left", "right"]).optional(), height: z.string().optional(), width: z.string().optional(), left: z.string().optional(), bottom: z.string().optional(), right: z.string().optional(), top: z.string().optional(), orient: z.enum(["horizontal", "vertical"]).optional(), type: z.enum(["plain", "scroll"]).optional(), show: z.boolean().optional()}); export const echartsGrid = z.object({height: z.string().optional(), width: z.string().optional(), left: z.string().optional(), bottom: z.string().optional(), right: z.string().optional(), top: z.string().optional(), containLabel: z.boolean().optional()}); export const markLineData = z.object({dynamicValue: z.literal("average").optional(), label: z.object({position: z.enum(["start", "middle", "end"]).optional(), formatter: z.string().optional()}).optional(), lineStyle: z.object({color: z.string()}).optional(), uuid: z.string(), type: z.string().optional(), value: z.string().optional(), name: z.string().optional(), xAxis: z.string().optional(), yAxis: z.string().optional()}); export const markLine = z.object({label: z.object({formatter: z.string().optional()}).optional(), lineStyle: z.object({type: z.string(), width: z.number(), color: z.string()}).optional(), symbol: z.string().optional(), data: z.array(markLineData)}); export const recordStringUnknown = z.record(z.string(), z.unknown()); export const cartesianSeriesType = z.enum(["line", "bar", "scatter", "area"]); export const pivotValue = z.object({value: z.unknown(), field: z.string()}); export const pivotReference = z.object({pivotValues: z.array(pivotValue).optional(), field: z.string()}); export const series = z.object({isFilteredOut: z.boolean().optional(), markLine: markLine.optional(), smooth: z.boolean().optional(), showSymbol: z.boolean().optional(), areaStyle: recordStringUnknown.optional(), hidden: z.boolean().optional(), label: z.object({showSeriesName: z.boolean().optional(), showLabel: z.boolean().optional(), showValue: z.boolean().optional(), showOverlappingLabels: z.boolean().optional(), position: z.enum(["left", "top", "right", "bottom", "inside"]).optional(), show: z.boolean().optional()}).optional(), yAxisIndex: z.number().optional(), color: z.string().optional(), name: z.string().optional(), stackLabel: z.object({show: z.boolean().optional()}).optional(), stack: z.string().optional(), type: cartesianSeriesType, encode: z.object({y: z.string().optional(), x: z.string().optional(), yRef: pivotReference, xRef: pivotReference})}); export const xAxisSortType = z.enum(["default", "category", "bar_totals"]); export const xAxis = z.object({rotate: z.number().optional(), inverse: z.boolean().optional(), maxOffset: z.string().optional(), minOffset: z.string().optional(), minInterval: z.number().optional(), max: z.string().optional(), min: z.string().optional(), name: z.string().optional(), dataZoomItemCount: z.number().optional(), dataZoomAnchor: z.enum(["start", "end"]).optional(), enableDataZoom: z.boolean().optional(), sortType: xAxisSortType.optional()}); export const axis = z.object({rotate: z.number().optional(), inverse: z.boolean().optional(), maxOffset: z.string().optional(), minOffset: z.string().optional(), minInterval: z.number().optional(), max: z.string().optional(), min: z.string().optional(), name: z.string().optional()}); export const tooltipSortBy = z.enum(["default", "alphabetical", "value_ascending", "value_descending"]); export const eChartsConfig = z.object({legend: echartsLegend.optional(), grid: echartsGrid.optional(), series: z.array(series).optional(), xAxis: z.array(xAxis).optional(), yAxis: z.array(axis).optional(), tooltip: z.string().optional(), tooltipSort: tooltipSortBy.optional(), showAxisTicks: z.boolean().optional(), axisLabelFontSize: z.number().optional(), axisTitleFontSize: z.number().optional()}); export const recordStringString = z.object({}); export const cartesianChartLayout = z.object({xField: z.string().optional(), yField: z.array(z.string()).optional(), flipAxes: z.boolean().optional(), showGridX: z.boolean().optional(), showGridY: z.boolean().optional(), showXAxis: z.boolean().optional(), showYAxis: z.boolean().optional(), showLeftYAxis: z.boolean().optional(), showRightYAxis: z.boolean().optional(), stack: z.union([z.string(), z.boolean()]).optional(), connectNulls: z.boolean().optional(), colorByCategory: z.boolean().optional(), categoryColorOverrides: recordStringString.optional()}); export const cartesianChart = z.object({columnLimit: z.number().optional(), rowLimit: rowLimit.optional(), metadata: recordStringSeriesMetadata.optional(), conditionalFormattings: z.array(conditionalFormattingConfig).optional(), eChartsConfig: eChartsConfig, layout: cartesianChartLayout}); export const chartTypeCARTESIAN = z.literal("cartesian"); export const cartesianChartConfig = z.object({config: cartesianChart.optional(), type: chartTypeCARTESIAN}); export const customVis = z.object({spec: recordStringUnknown.optional()}); export const chartTypeCUSTOM = z.literal("custom"); export const customVisConfig = z.object({config: customVis.optional(), type: chartTypeCUSTOM}); export const pieChartLegendPosition = z.enum(["horizontal", "vertical"]); export const partialPieChartValueOptions = z.object({valueLabel: z.enum(["hidden", "inside", "outside"]).optional(), showValue: z.boolean().optional(), showPercentage: z.boolean().optional()}); export const recordStringPartialPieChartValueOptions = z.record(z.string(), partialPieChartValueOptions); export const pieChartValueLabel = z.enum(["hidden", "inside", "outside"]); export const pieChart = z.object({metadata: recordStringSeriesMetadata.optional(), legendMaxItemLength: z.number().optional(), legendPosition: pieChartLegendPosition.optional(), showLegend: z.boolean().optional(), groupSortOverrides: z.array(z.string()).optional(), groupValueOptionOverrides: recordStringPartialPieChartValueOptions.optional(), groupColorOverrides: recordStringString.optional(), groupLabelOverrides: recordStringString.optional(), showPercentage: z.boolean().optional(), showValue: z.boolean().optional(), valueLabel: pieChartValueLabel.optional(), isDonut: z.boolean().optional(), metricId: z.string().optional(), groupFieldIds: z.array(z.string()).optional()}); export const chartTypePIE = z.literal("pie"); export const pieChartConfig = z.object({config: pieChart.optional(), type: chartTypePIE}); export const funnelChartLegendPosition = z.enum(["horizontal", "vertical"]); export const funnelChartLabelPosition = z.enum(["inside", "left", "right", "hidden"]); export const funnelChartDataInput = z.enum(["row", "column"]); export const funnelChart = z.object({legendPosition: funnelChartLegendPosition.optional(), showLegend: z.boolean().optional(), labels: z.object({showPercentage: z.boolean().optional(), showValue: z.boolean().optional(), position: funnelChartLabelPosition.optional()}).optional(), colorOverrides: recordStringString.optional(), labelOverrides: recordStringString.optional(), metadata: recordStringSeriesMetadata.optional(), fieldId: z.string().optional(), dataInput: funnelChartDataInput.optional()}); export const chartTypeFUNNEL = z.literal("funnel"); export const funnelChartConfig = z.object({config: funnelChart.optional(), type: chartTypeFUNNEL}); export const columnProperties = z.object({width: z.number().optional(), color: z.string().optional(), displayStyle: z.enum(["text", "bar"]).optional(), frozen: z.boolean().optional(), name: z.string().optional(), visible: z.boolean().optional()}); export const recordStringColumnProperties = z.record(z.string(), columnProperties); export const tableChart = z.object({rowLimit: rowLimit.optional(), metricsAsRows: z.boolean().optional(), conditionalFormattings: z.array(conditionalFormattingConfig).optional(), columns: recordStringColumnProperties.optional(), showRowGrouping: z.boolean().optional(), showSubtotalsExpanded: z.boolean().optional(), showSubtotals: z.boolean().optional(), showResultsTotal: z.boolean().optional(), hideRowNumbers: z.boolean().optional(), showTableNames: z.boolean().optional(), showRowCalculation: z.boolean().optional(), showColumnCalculation: z.boolean().optional()}); export const chartTypeTABLE = z.literal("table"); export const tableChartConfig = z.object({config: tableChart.optional(), type: chartTypeTABLE}); export const treemapChart = z.object({endColorThreshold: z.number().optional(), startColorThreshold: z.number().optional(), useDynamicColors: z.boolean().optional(), endColor: z.string().optional(), startColor: z.string().optional(), colorMetricId: z.string().optional(), sizeMetricId: z.string().optional(), groupFieldIds: z.array(z.string()).optional(), leafDepth: z.number().optional(), visibleMin: z.number().optional()}); export const chartTypeTREEMAP = z.literal("treemap"); export const treemapChartConfig = z.object({config: treemapChart.optional(), type: chartTypeTREEMAP}); export const gaugeSection = z.object({color: z.string(), maxFieldId: z.string().optional(), minFieldId: z.string().optional(), max: z.number(), min: z.number()}); export const gaugeChart = z.object({customPercentageLabel: z.string().optional(), showPercentage: z.boolean().optional(), customLabel: z.string().optional(), sections: z.array(gaugeSection).optional(), showAxisLabels: z.boolean().optional(), maxFieldId: z.string().optional(), max: z.number().optional(), min: z.number().optional(), selectedField: z.string().optional()}); export const chartTypeGAUGE = z.literal("gauge"); export const gaugeChartConfig = z.object({config: gaugeChart.optional(), type: chartTypeGAUGE}); export const dataAppVizFieldMapping = z.object({}); export const dataAppVizChart = z.object({fieldMapping: dataAppVizFieldMapping, dataAppVizUuid: z.string()}); export const chartTypeDATAAPPVIZ = z.literal("data_app_viz"); export const dataAppVizChartConfig = z.object({config: dataAppVizChart.optional(), type: chartTypeDATAAPPVIZ}); export const mapFieldConfig = z.object({label: z.string().optional(), visible: z.boolean().optional()}); export const recordStringMapFieldConfig = z.record(z.string(), mapFieldConfig); export const mapTileBackground = z.enum(["none", "openstreetmap", "light", "dark", "satellite", "voyager"]); export const mapHexbinAggregation = z.enum(["sum", "avg", "min", "max"]); export const mapHexbinValueBasis = z.enum(["count", "field"]); export const mapHexbinSizingMode = z.enum(["dynamic", "fixed"]); export const mapChartType = z.enum(["scatter", "area", "heatmap", "hexbin"]); export const mapChartLocation = z.enum(["USA", "world", "europe", "custom"]); export const mapChart = z.object({saveMapExtent: z.boolean().optional(), fieldConfig: recordStringMapFieldConfig.optional(), noDataColor: z.string().optional(), backgroundColor: z.string().optional(), darkModeTileBackground: mapTileBackground.optional(), tileBackground: mapTileBackground.optional(), dataLayerOpacity: z.number().optional(), hexbinConfig: z.object({emptyBinColor: z.string().nullable().optional(), showEmptyBins: z.boolean().optional(), aggregation: mapHexbinAggregation.optional(), valueBasis: mapHexbinValueBasis.optional(), fixedResolution: z.number().optional(), sizingMode: mapHexbinSizingMode.optional(), opacity: z.number().optional()}).optional(), heatmapConfig: z.object({opacity: z.number().optional(), blur: z.number().optional(), radius: z.number().optional()}).optional(), sizeFieldId: z.string().optional(), maxBubbleSize: z.number().optional(), minBubbleSize: z.number().optional(), defaultCenterLon: z.number().optional(), defaultCenterLat: z.number().optional(), defaultZoom: z.number().optional(), colorOverrides: recordStringString.optional(), colorRange: z.array(z.string()).optional(), showLegend: z.boolean().optional(), valueFieldId: z.string().optional(), geoJsonPropertyKey: z.string().optional(), locationFieldId: z.string().optional(), longitudeFieldId: z.string().optional(), latitudeFieldId: z.string().optional(), locationType: mapChartType.optional(), customGeoJsonUrl: z.string().optional(), mapType: mapChartLocation.optional()}); export const chartTypeMAP = z.literal("map"); export const mapChartConfig = z.object({config: mapChart.optional(), type: chartTypeMAP}); export const sankeyNodeLayout = z.enum(["multi-step", "merged", "direct"]); export const sankeyChart = z.object({nodeLayout: sankeyNodeLayout.optional(), orient: z.enum(["horizontal", "vertical"]).optional(), nodeAlign: z.enum(["left", "right", "justify"]).optional(), metricFieldId: z.string().optional(), targetFieldId: z.string().optional(), sourceFieldId: z.string().optional()}); export const chartTypeSANKEY = z.literal("sankey"); export const sankeyChartConfig = z.object({config: sankeyChart.optional(), type: chartTypeSANKEY}); export const chartConfig = z.union([bigNumberConfig, cartesianChartConfig, customVisConfig, pieChartConfig, funnelChartConfig, tableChartConfig, treemapChartConfig, gaugeChartConfig, dataAppVizChartConfig, mapChartConfig, sankeyChartConfig]); export const parameterValue = z.union([z.string(), z.number(), z.array(z.string()), z.array(z.number())]); export const parametersValuesMap = z.record(z.string(), parameterValue); export const contentVerificationInfo = z.object({verifiedAt: z.string(), verifiedBy: z.object({lastName: z.string(), firstName: z.string(), userUuid: z.string()})}); export const updatedByUser = z.object({userUuid: z.string(), firstName: z.string(), lastName: z.string()}).and(z.record(z.string(), z.unknown())); export const colorPaletteSource = z.union([z.object({type: z.literal("config")}), z.object({type: z.literal("default")}), z.object({name: z.string(), uuid: z.string(), type: z.literal("organization")}), z.object({name: z.string(), uuid: z.string(), type: z.literal("project")}), z.object({name: z.string(), uuid: z.string(), type: z.literal("space")}), z.object({name: z.string(), uuid: z.string(), type: z.literal("dashboard")}), z.object({name: z.string(), uuid: z.string(), type: z.literal("chart")})]); export const resolvedProjectColorPalette = z.object({source: colorPaletteSource, paletteName: z.string().nullable(), paletteUuid: z.string().nullable(), darkColors: z.array(z.string()).nullable(), colors: z.array(z.string())}); export const promotedChart = z.object({name: z.string(), description: z.string().optional(), tableName: z.string(), metricQuery: metricQuery, chartConfig: chartConfig, pivotConfig: z.object({rows: z.array(z.string()).optional(), columns: z.array(z.string())}).optional(), slug: z.string(), parameters: parametersValuesMap.optional(), uuid: z.string(), organizationUuid: z.string(), projectUuid: z.string(), pinnedListUuid: z.string().nullable(), pinnedListOrder: z.number().nullable(), verification: contentVerificationInfo.nullable(), updatedAt: z.string(), updatedByUser: updatedByUser.optional(), spaceUuid: z.string(), spaceName: z.string(), colorPaletteUuid: z.string().nullable(), deletedAt: z.string().optional(), deletedBy: z.object({lastName: z.string(), firstName: z.string(), userUuid: z.string()}).nullable().optional(), tableConfig: z.object({columnOrder: z.array(z.string())}), dashboardUuid: z.string().nullable(), dashboardName: z.string().nullable(), colorPalette: z.array(z.string()), resolvedColorPalette: resolvedProjectColorPalette, oldUuid: z.string(), spacePath: z.string(), spaceSlug: z.string()}); export const dashboardParameterValue = z.object({value: parameterValue, parameterName: z.string()}); export const dashboardParameters = z.record(z.string(), dashboardParameterValue); export const dashboardFieldTarget = z.object({fallbackType: dimensionType.optional(), isSqlColumn: z.boolean().optional(), tableName: z.string(), fieldId: z.string()}); export const dashboardTileTarget = z.union([dashboardFieldTarget, z.literal(false)]); export const dashboardTileTargets = z.record(z.string(), dashboardTileTarget); export const dashboardFilterRule = z.object({includeNull: z.boolean().optional(), values: z.array(anyType).optional(), operator: filterOperator, id: z.string(), target: dashboardFieldTarget, settings: anyType.optional(), disabled: z.boolean().optional(), required: z.boolean().optional(), caseSensitive: z.boolean().optional(), lockedTabUuids: z.array(z.string()).optional(), requiredGroupId: z.string().optional(), singleValue: z.boolean().optional(), label: z.string().optional(), tileTargets: dashboardTileTargets.optional()}).and(z.record(z.string(), z.unknown())); export const dashboardFilters = z.object({tableCalculations: z.array(dashboardFilterRule), metrics: z.array(dashboardFilterRule), dimensions: z.array(dashboardFilterRule)}); export const dashboardTab = z.object({hidden: z.boolean().optional(), order: z.number().gte(0), name: z.string().min(1), uuid: z.string()}); export const dateZoomTileTarget = z.object({tableName: z.string().nullable(), fieldId: z.string().nullable(), controlUuid: z.string()}); export const recordStringDateZoomTileTarget = z.record(z.string(), dateZoomTileTarget); export const dateGranularity = z.enum(["Second", "Minute", "Hour", "Day", "Week", "Month", "Quarter", "Year"]); export const dateZoomControl = z.object({hidden: z.boolean().optional(), granularity: z.union([dateGranularity, z.string()]), name: z.string(), uuid: z.string()}); export const dateZoomConfig = z.object({tileTargets: recordStringDateZoomTileTarget, controls: z.array(dateZoomControl)}); export const dashboardConfig = z.object({requiredFiltersNote: z.string().optional(), dateZoomConfig: dateZoomConfig.optional(), defaultDateZoomGranularity: z.union([dateGranularity, z.string()]).optional(), dateZoomGranularities: z.array(z.union([dateGranularity, z.string()])).optional(), parameterOrder: z.array(z.string()).optional(), pinnedParameters: z.array(z.string()).optional(), isAddFilterDisabled: z.boolean().optional(), isDateZoomDisabled: z.boolean()}); export const chartKind = z.enum(["line", "horizontal_bar", "vertical_bar", "scatter", "area", "mixed", "pie", "table", "big_number", "funnel", "custom", "treemap", "gauge", "map", "sankey", "data_app_viz"]); export const dashboardChartTile = z.object({uuid: z.string(), type: z.literal("saved_chart"), x: z.number(), y: z.number(), h: z.number(), w: z.number(), tabUuid: z.string().nullable().optional(), properties: z.object({chartSlug: z.string().nullable().optional(), lastVersionChartKind: chartKind.nullable().optional(), chartName: z.string().nullable().optional(), belongsToDashboard: z.boolean().optional(), savedChartUuid: z.string().nullable(), hideTitle: z.boolean().optional(), title: z.string().optional()})}); export const dashboardMarkdownTile = z.object({uuid: z.string(), type: z.literal("markdown"), x: z.number(), y: z.number(), h: z.number(), w: z.number(), tabUuid: z.string().nullable().optional(), properties: z.object({hideFrame: z.boolean().optional(), content: z.string(), title: z.string()})}); export const dashboardLoomTile = z.object({uuid: z.string(), type: z.literal("loom"), x: z.number(), y: z.number(), h: z.number(), w: z.number(), tabUuid: z.string().nullable().optional(), properties: z.object({url: z.string(), hideTitle: z.boolean().optional(), title: z.string()})}); export const dashboardSqlChartTile = z.object({uuid: z.string(), type: z.literal("sql_chart"), x: z.number(), y: z.number(), h: z.number(), w: z.number(), tabUuid: z.string().nullable().optional(), properties: z.object({chartSlug: z.string().nullable().optional(), hideTitle: z.boolean().optional(), chartName: z.string(), savedSqlUuid: z.string().nullable(), title: z.string().optional()})}); export const dashboardHeadingTile = z.object({uuid: z.string(), type: z.literal("heading"), x: z.number(), y: z.number(), h: z.number(), w: z.number(), tabUuid: z.string().nullable().optional(), properties: z.object({showDivider: z.boolean().optional(), text: z.string(), title: z.unknown()})}); export const dashboardDataAppTile = z.object({uuid: z.string(), type: z.literal("data_app"), x: z.number(), y: z.number(), h: z.number(), w: z.number(), tabUuid: z.string().nullable().optional(), properties: z.object({appDeletedAt: z.string().nullable().optional(), appUuid: z.string(), hideTitle: z.boolean().optional(), title: z.string()})}); export const dashboardTile = z.union([dashboardChartTile, dashboardMarkdownTile, dashboardLoomTile, dashboardSqlChartTile, dashboardHeadingTile, dashboardDataAppTile]); export const promotedDashboard = z.object({name: z.string(), description: z.string().optional(), slug: z.string(), parameters: dashboardParameters.optional(), filters: dashboardFilters, tabs: z.array(dashboardTab), config: dashboardConfig.optional(), uuid: z.string(), organizationUuid: z.string(), projectUuid: z.string(), pinnedListUuid: z.string().nullable(), pinnedListOrder: z.number().nullable(), dashboardVersionId: z.number(), versionUuid: z.string(), verification: contentVerificationInfo.nullable(), updatedAt: z.string(), tiles: z.array(dashboardTile), updatedByUser: updatedByUser.optional(), spaceUuid: z.string(), spaceName: z.string(), views: z.number(), firstViewedAt: z.union([z.string(), z.string()]).nullable(), colorPaletteUuid: z.string().nullable(), deletedAt: z.string().optional(), deletedBy: z.object({lastName: z.string(), firstName: z.string(), userUuid: z.string()}).nullable().optional(), spacePath: z.string(), spaceSlug: z.string()}); export const spaceMemberRole = z.enum(["viewer", "editor", "admin"]); export const promotedSpace = z.object({name: z.string(), slug: z.string(), uuid: z.string(), organizationUuid: z.string(), projectUuid: z.string(), inheritParentPermissions: z.boolean(), projectMemberAccessRole: spaceMemberRole.nullable(), pinnedListUuid: z.string().nullable(), pinnedListOrder: z.number().nullable(), parentSpaceUuid: z.string().nullable(), path: z.string(), deletedBy: z.object({lastName: z.string(), firstName: z.string(), userUuid: z.string()}).optional(), deletedAt: z.string().optional(), appCount: z.number(), childSpaceCount: z.number(), dashboardCount: z.number(), chartCount: z.number()}); export const promotionChanges = z.object({dataApps: z.array(z.object({data: promotedApp, action: promotionAction})).optional(), sqlCharts: z.array(z.object({data: promotedSqlChart, action: promotionAction})).optional(), charts: z.array(z.object({data: promotedChart, action: promotionAction})), dashboards: z.array(z.object({data: promotedDashboard, action: promotionAction})), spaces: z.array(z.object({data: promotedSpace, action: promotionAction}))}); export const apiPromotionChangesResponse = z.object({results: promotionChanges, status: z.literal("ok")}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Get dashboard promotion diff * * GET /api/v1/dashboards/{dashboardUuidOrSlug}/promoteDiff */ export const getApiApiV1DashboardsDashboardUuidOrSlugPromoteDiff = async (args: GetApiApiV1DashboardsDashboardUuidOrSlugPromoteDiffArgs, options: GetApiApiV1DashboardsDashboardUuidOrSlugPromoteDiffOptions) => { const {baseUrl, fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.projectUuid != null) query.append("projectUuid", String(args.projectUuid)) const url = `${baseUrl.replace(/\/+$/, '')}/api/v1/dashboards/${encodeURIComponent(String(args.dashboardUuidOrSlug))}/promoteDiff${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(apiPromotionChangesResponse, await res.json()) };