import {z} from 'zod' export type DuplicateDashboardParams = {dashboardDesc: string, dashboardName: string}; export type DateZoomTileTarget = {tableName: string | null, fieldId: string | null, controlUuid: string}; export type RecordStringDateZoomTileTarget = {[key: string]: DateZoomTileTarget}; export type DateGranularity = 'Second' | 'Minute' | 'Hour' | 'Day' | 'Week' | 'Month' | 'Quarter' | 'Year'; export type DateZoomControl = {hidden?: boolean | undefined, granularity: DateGranularity | string, name: string, uuid: string}; export type DateZoomConfig = {tileTargets: RecordStringDateZoomTileTarget, controls: Array}; export type DashboardConfig = {requiredFiltersNote?: string | undefined, dateZoomConfig?: DateZoomConfig | undefined, defaultDateZoomGranularity?: (DateGranularity | string) | undefined, dateZoomGranularities?: (Array) | undefined, parameterOrder?: Array | undefined, pinnedParameters?: Array | undefined, isAddFilterDisabled?: boolean | undefined, isDateZoomDisabled: boolean}; export type DashboardTab = {hidden?: boolean | undefined, order: number, name: string, uuid: string}; export type PickUpdatedByUserUserUuid = {userUuid: string}; export type ParameterValue = string | number | Array | Array; export type DashboardParameterValue = {value: ParameterValue, parameterName: string}; export type DashboardParameters = {[key: string]: DashboardParameterValue}; export type AnyType = unknown; export type FilterOperator = 'isNull' | 'notNull' | 'equals' | 'notEquals' | 'startsWith' | 'endsWith' | 'include' | 'doesNotInclude' | 'lessThan' | 'lessThanOrEqual' | 'greaterThan' | 'greaterThanOrEqual' | 'inThePast' | 'notInThePast' | 'inTheNext' | 'inTheCurrent' | 'notInTheCurrent' | 'inBetween' | 'notInBetween' | 'inPeriodToDate'; export type DimensionType = 'string' | 'number' | 'timestamp' | 'date' | 'boolean'; export type DashboardFieldTarget = {fallbackType?: DimensionType | undefined, isSqlColumn?: boolean | undefined, tableName: string, fieldId: string}; export type DashboardTileTarget = DashboardFieldTarget | false; export type DashboardTileTargets = {[key: string]: DashboardTileTarget}; export type DashboardFilterRule = {includeNull?: boolean | undefined, values?: Array | undefined, operator: FilterOperator, id: string, target: DashboardFieldTarget, settings?: AnyType | undefined, disabled?: boolean | undefined, required?: boolean | undefined, caseSensitive?: boolean | undefined, lockedTabUuids?: Array | undefined, requiredGroupId?: string | undefined, singleValue?: boolean | undefined, label?: string | undefined, tileTargets?: DashboardTileTargets | undefined} | {[key: string]: unknown}; export type DashboardFilters = {tableCalculations: Array, metrics: Array, dimensions: Array}; export type ChartKind = 'line' | 'horizontal_bar' | 'vertical_bar' | 'scatter' | 'area' | 'mixed' | 'pie' | 'table' | 'big_number' | 'funnel' | 'custom' | 'treemap' | 'gauge' | 'map' | 'sankey' | 'data_app_viz'; export type CreateDashboardChartTile = {tabUuid?: (string | null) | undefined, w: number, h: number, y: number, x: number, type: 'saved_chart', uuid?: string | undefined, properties: {chartSlug?: (string | null) | undefined, lastVersionChartKind?: (ChartKind | null) | undefined, chartName?: (string | null) | undefined, belongsToDashboard?: boolean | undefined, savedChartUuid: string | null, hideTitle?: boolean | undefined, title?: string | undefined}}; export type CreateDashboardMarkdownTile = {tabUuid?: (string | null) | undefined, w: number, h: number, y: number, x: number, type: 'markdown', uuid?: string | undefined, properties: {hideFrame?: boolean | undefined, content: string, title: string}}; export type CreateDashboardLoomTile = {tabUuid?: (string | null) | undefined, w: number, h: number, y: number, x: number, type: 'loom', uuid?: string | undefined, properties: {url: string, hideTitle?: boolean | undefined, title: string}}; export type CreateDashboardSqlChartTile = {tabUuid?: (string | null) | undefined, w: number, h: number, y: number, x: number, type: 'sql_chart', uuid?: string | undefined, properties: {chartSlug?: (string | null) | undefined, hideTitle?: boolean | undefined, chartName: string, savedSqlUuid: string | null, title?: string | undefined}}; export type CreateDashboardHeadingTile = {tabUuid?: (string | null) | undefined, w: number, h: number, y: number, x: number, type: 'heading', uuid?: string | undefined, properties: {showDivider?: boolean | undefined, text: string, title: unknown}}; export type CreateDashboardDataAppTile = {tabUuid?: (string | null) | undefined, w: number, h: number, y: number, x: number, type: 'data_app', uuid?: string | undefined, properties: {appDeletedAt?: (string | null) | undefined, appUuid: string, hideTitle?: boolean | undefined, title: string}}; export type CreateDashboard = {colorPaletteUuid?: (string | null) | undefined, config?: DashboardConfig | undefined, tabs: Array, spaceUuid?: string | undefined, updatedByUser?: PickUpdatedByUserUserUuid | undefined, pinnedParameters?: Array | undefined, parameters?: DashboardParameters | undefined, filters?: DashboardFilters | undefined, tiles: Array, description?: string | undefined, name: string}; export type CreateApiApiV1ProjectsProjectUuidDashboardsArgs = {projectUuid: string, duplicateFrom?: string | undefined, body: DuplicateDashboardParams | CreateDashboard}; export type CreateApiApiV1ProjectsProjectUuidDashboardsOptions = {baseUrl: string, fetch?: typeof fetch | undefined}; 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 organizationMemberRole = z.enum(["member", "viewer", "interactive_viewer", "editor", "developer", "admin"]); export const projectMemberRole = z.enum(["viewer", "interactive_viewer", "editor", "developer", "admin"]); export const spaceMemberRole = z.enum(["viewer", "editor", "admin"]); export const spaceAccess = z.object({inheritedFrom: z.enum(["organization", "project", "group", "space_group", "parent_space"]).optional(), inheritedRole: z.union([organizationMemberRole, projectMemberRole]).optional(), projectRole: projectMemberRole.optional(), hasDirectAccess: z.boolean(), role: spaceMemberRole, userUuid: z.string()}); export const dashboardTab = z.object({hidden: z.boolean().optional(), order: z.number().gte(0), name: z.string().min(1), uuid: 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 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 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 contentVerificationInfo = z.object({verifiedAt: z.string(), verifiedBy: z.object({lastName: z.string(), firstName: z.string(), userUuid: z.string()})}); export const dashboard = z.object({deletedBy: z.object({lastName: z.string(), firstName: z.string(), userUuid: z.string()}).nullable().optional(), deletedAt: z.string().optional(), colorPaletteUuid: z.string().nullable(), config: dashboardConfig.optional(), slug: z.string(), access: z.array(spaceAccess).nullable(), inheritsFromOrgOrProject: z.boolean(), tabs: z.array(dashboardTab), pinnedListOrder: z.number().nullable(), pinnedListUuid: z.string().nullable(), firstViewedAt: z.union([z.string(), z.string()]).nullable(), views: z.number(), spaceName: z.string(), spaceUuid: z.string(), updatedByUser: updatedByUser.optional(), parameters: dashboardParameters.optional(), filters: dashboardFilters, tiles: z.array(dashboardTile), updatedAt: z.string(), description: z.string().optional(), verification: contentVerificationInfo.nullable(), name: z.string(), uuid: z.string(), versionUuid: z.string(), dashboardVersionId: z.number(), projectUuid: z.string(), organizationUuid: z.string()}); export const apiCreateDashboardResponse = z.object({results: dashboard, 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 }; /** * Create dashboard * * POST /api/v1/projects/{projectUuid}/dashboards */ export const createApiApiV1ProjectsProjectUuidDashboards = async (args: CreateApiApiV1ProjectsProjectUuidDashboardsArgs, options: CreateApiApiV1ProjectsProjectUuidDashboardsOptions) => { const {baseUrl, fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") if (args.duplicateFrom != null) query.append("duplicateFrom", String(args.duplicateFrom)) const url = `${baseUrl.replace(/\/+$/, '')}/api/v1/projects/${encodeURIComponent(String(args.projectUuid))}/dashboards${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "POST", headers, body: JSON.stringify(args.body)}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(apiCreateDashboardResponse, await res.json()) };