import {z} from 'zod' export type GetApiApiV1ProjectsProjectUuidDashboardsCodeArgs = {projectUuid: string, ids?: Array | undefined, offset?: number | undefined, languageMap?: boolean | undefined}; export type GetApiApiV1ProjectsProjectUuidDashboardsCodeOptions = {baseUrl: string, fetch?: typeof fetch | undefined}; export const spaceMemberRole = z.enum(["viewer", "editor", "admin"]); export const spaceAsCodeGroupAccess = z.object({role: spaceMemberRole, name: z.string()}); export const spaceAsCodeUserAccess = z.object({role: spaceMemberRole, email: z.string()}); export const spaceAsCodeAccess = z.object({groups: z.array(spaceAsCodeGroupAccess), users: z.array(spaceAsCodeUserAccess), projectMemberAccessRole: spaceMemberRole.nullable(), inheritParentPermissions: z.boolean()}); export const contentAsCodeTypeSPACE = z.literal("space"); export const spaceAsCode = z.object({access: spaceAsCodeAccess.optional(), slug: z.string(), spaceName: z.string(), version: z.literal(1).optional(), contentType: contentAsCodeTypeSPACE}); export const partialObjectDeep91XString9358Name63StringOrUndefinedDescription63StringOrUndefinedTiles635840TypeDashboardTileTypesSAVEDCHARTOrDashboardTileTypesSQLCHARTProperties58TitleStringChartNameStringOrTypeDashboardTileTypesMARKDOWNProperties58ContentStringTitleStringOrTypeDashboardTileTypesLOOMProperties58TitleStringOrTypeDashboardTileTypesHEADINGProperties58TextStringOrTypeDashboardTileTypesDATAAPPProperties58TitleString41ArrayOrUndefinedRecurseIntoArraysTrue = z.object({}); export const partialDeepDashboardAsCodeLanguageMapRecurseIntoArraysTrue = z.object({dashboard: partialObjectDeep91XString9358Name63StringOrUndefinedDescription63StringOrUndefinedTiles635840TypeDashboardTileTypesSAVEDCHARTOrDashboardTileTypesSQLCHARTProperties58TitleStringChartNameStringOrTypeDashboardTileTypesMARKDOWNProperties58ContentStringTitleStringOrTypeDashboardTileTypesLOOMProperties58TitleStringOrTypeDashboardTileTypesHEADINGProperties58TextStringOrTypeDashboardTileTypesDATAAPPProperties58TitleString41ArrayOrUndefinedRecurseIntoArraysTrue.optional()}); 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 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 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 omitDashboardFilterRuleId = z.object({label: z.string().optional(), target: dashboardFieldTarget, settings: z.unknown(), disabled: z.boolean().optional(), required: z.boolean().optional(), caseSensitive: z.boolean().optional(), operator: filterOperator, values: z.array(z.unknown()).optional(), includeNull: z.boolean().optional(), tileTargets: dashboardTileTargets.optional(), singleValue: z.boolean().optional(), requiredGroupId: z.string().optional(), lockedTabUuids: z.array(z.string()).optional()}); export const contentAsCodeTypeDASHBOARD = z.literal("dashboard"); export const dashboardChartTileAsCode = z.object({tabUuid: z.string().nullable().optional(), tabSlug: z.string().nullable().optional(), w: z.number().gte(1).lte(36), h: z.number().gte(1), y: z.number().gte(0), x: z.number().gte(0).lte(35), type: z.literal("saved_chart"), tileSlug: z.string().optional(), uuid: z.string().optional(), properties: z.object({title: z.string().optional(), hideTitle: z.boolean().optional(), chartName: z.string().nullable().optional(), chartSlug: z.string().nullable()})}); export const dashboardSqlChartTileAsCode = z.object({tabUuid: z.string().nullable().optional(), tabSlug: z.string().nullable().optional(), w: z.number().gte(1).lte(36), h: z.number().gte(1), y: z.number().gte(0), x: z.number().gte(0).lte(35), type: z.literal("sql_chart"), tileSlug: z.string().optional(), uuid: z.string().optional(), properties: z.object({title: z.string().optional(), hideTitle: z.boolean().optional(), chartName: z.string(), chartSlug: z.string().nullable()})}); export const dashboardMarkdownTileAsCode = z.object({tabUuid: z.string().nullable().optional(), tabSlug: z.string().nullable().optional(), w: z.number().gte(1).lte(36), h: z.number().gte(1), y: z.number().gte(0), x: z.number().gte(0).lte(35), type: z.literal("markdown"), tileSlug: z.string().optional(), uuid: z.string().optional(), properties: z.object({hideFrame: z.boolean().optional(), content: z.string(), title: z.string()})}); export const dashboardLoomTileAsCode = z.object({tabUuid: z.string().nullable().optional(), tabSlug: z.string().nullable().optional(), w: z.number().gte(1).lte(36), h: z.number().gte(1), y: z.number().gte(0), x: z.number().gte(0).lte(35), type: z.literal("loom"), tileSlug: z.string().optional(), uuid: z.string().optional(), properties: z.object({url: z.string(), hideTitle: z.boolean().optional(), title: z.string()})}); export const dashboardHeadingTileAsCode = z.object({tabUuid: z.string().nullable().optional(), tabSlug: z.string().nullable().optional(), w: z.number().gte(1).lte(36), h: z.number().gte(1), y: z.number().gte(0), x: z.number().gte(0).lte(35), type: z.literal("heading"), tileSlug: z.string().optional(), uuid: z.string().optional(), properties: z.object({showDivider: z.boolean().optional(), text: z.string(), title: z.unknown()})}); export const dashboardDataAppTileAsCode = z.object({tabUuid: z.string().nullable().optional(), tabSlug: z.string().nullable().optional(), w: z.number().gte(1).lte(36), h: z.number().gte(1), y: z.number().gte(0), x: z.number().gte(0).lte(35), type: z.literal("data_app"), tileSlug: z.string().optional(), uuid: z.string().optional(), properties: z.object({appDeletedAt: z.string().nullable().optional(), appUuid: z.string(), hideTitle: z.boolean().optional(), title: z.string()})}); export const dashboardTileAsCode = z.union([dashboardChartTileAsCode, dashboardSqlChartTileAsCode, dashboardMarkdownTileAsCode, dashboardLoomTileAsCode, dashboardHeadingTileAsCode, dashboardDataAppTileAsCode]); export const dashboardTabAsCode = z.object({hidden: z.boolean().optional(), order: z.number().gte(0), name: z.string().min(1), uuid: z.string().optional(), slug: z.string().optional()}); export const dashboardAsCode = z.object({description: z.string().optional(), parameters: dashboardParameters.optional(), config: dashboardConfig.optional(), verification: contentVerificationInfo.nullable().optional(), verified: z.boolean().optional(), filters: z.object({tableCalculations: z.array(dashboardFilterRule).optional(), metrics: z.array(dashboardFilterRule).optional(), dimensions: z.array(omitDashboardFilterRuleId).optional()}).optional(), downloadedAt: z.string().optional(), spaceSlug: z.string(), contentType: contentAsCodeTypeDASHBOARD.optional(), version: z.number(), tiles: z.array(dashboardTileAsCode), updatedAt: z.string().optional(), tabs: z.array(dashboardTabAsCode), slug: z.string(), name: z.string().min(1)}); export const apiDashboardAsCodeListResponse = z.object({results: z.object({offset: z.number(), total: z.number(), spaces: z.array(spaceAsCode), missingIds: z.array(z.string()), languageMap: z.array(partialDeepDashboardAsCodeLanguageMapRecurseIntoArraysTrue).optional(), dashboards: z.array(dashboardAsCode)}), 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 }; /** * List dashboards as code (deprecated) * * GET /api/v1/projects/{projectUuid}/dashboards/code */ export const getApiApiV1ProjectsProjectUuidDashboardsCode = async (args: GetApiApiV1ProjectsProjectUuidDashboardsCodeArgs, options: GetApiApiV1ProjectsProjectUuidDashboardsCodeOptions) => { const {baseUrl, fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") for (const item of args.ids ?? []) query.append("ids", String(item)) if (args.offset != null) query.append("offset", String(args.offset)) if (args.languageMap != null) query.append("languageMap", String(args.languageMap)) const url = `${baseUrl.replace(/\/+$/, '')}/api/v1/projects/${encodeURIComponent(String(args.projectUuid))}/dashboards/code${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(apiDashboardAsCodeListResponse, await res.json()) };