import {z} from 'zod' export type UuidOrSlug = string; export type UUID = string; export type CreateApiApiV1DashboardsDashboardUuidOrSlugPromoteArgs = {dashboardUuidOrSlug: UuidOrSlug, projectUuid?: UUID | undefined}; export type CreateApiApiV1DashboardsDashboardUuidOrSlugPromoteOptions = {baseUrl: string, fetch?: typeof fetch | undefined}; export const parameterValue = z.union([z.string(), z.number(), z.array(z.string()), z.array(z.number())]); export const dashboardParameterValue = z.object({value: parameterValue, parameterName: z.string()}); export const dashboardParameters = z.record(z.string(), dashboardParameterValue); 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 dimensionType = z.enum(["string", "number", "timestamp", "date", "boolean"]); 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 contentVerificationInfo = z.object({verifiedAt: z.string(), verifiedBy: z.object({lastName: z.string(), firstName: z.string(), userUuid: z.string()})}); 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 updatedByUser = z.object({userUuid: z.string(), firstName: z.string(), lastName: z.string()}).and(z.record(z.string(), z.unknown())); export const pickDashboardExcludeKeyofDashboardInheritsFromOrgOrProjectOrAccess = 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()}); export const dashboardDAO = pickDashboardExcludeKeyofDashboardInheritsFromOrgOrProjectOrAccess; export const apiPromoteDashboardResponse = z.object({results: dashboardDAO, 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 }; /** * Promote dashboard * * POST /api/v1/dashboards/{dashboardUuidOrSlug}/promote */ export const createApiApiV1DashboardsDashboardUuidOrSlugPromote = async (args: CreateApiApiV1DashboardsDashboardUuidOrSlugPromoteArgs, options: CreateApiApiV1DashboardsDashboardUuidOrSlugPromoteOptions) => { 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))}/promote${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "POST", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(apiPromoteDashboardResponse, await res.json()) };