import {z} from 'zod' export type GetApiApiV1ProjectsProjectUuidSqlChartsCodeArgs = {projectUuid: string, ids?: Array | undefined, offset?: number | undefined}; export type GetApiApiV1ProjectsProjectUuidSqlChartsCodeOptions = {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 stackType = z.enum(["none", "stack", "stack100"]); export const axisSide = z.union([z.literal(0), z.literal(1)]); export const valueLabelPositionOptions = z.enum(["hidden", "top", "bottom", "left", "right", "inside"]); export const cartesianSeriesTypeLINE = z.literal("line"); export const cartesianSeriesTypeBAR = z.literal("bar"); export const format = z.enum(["km", "mi", "si", "usd", "gbp", "eur", "jpy", "dkk", "id", "percent"]); export const vizIndexType = z.enum(["time", "category"]); export const cartesianChartDisplay = z.object({stack: z.union([z.boolean(), stackType]).optional(), legend: z.object({align: z.enum(["start", "center", "end"]), position: z.enum(["top", "bottom", "left", "right"])}).optional(), series: z.record(z.string(), z.object({whichYAxis: axisSide.optional(), valueLabelPosition: valueLabelPositionOptions.optional(), type: z.union([cartesianSeriesTypeLINE, cartesianSeriesTypeBAR]).optional(), color: z.string().optional(), yAxisIndex: z.number().optional(), format: format.optional(), label: z.string().optional()})).optional(), yAxis: z.array(z.object({format: format.optional(), position: z.string().optional(), label: z.string().optional()})).optional(), xAxis: z.object({dateFormat: z.string().optional(), type: vizIndexType.optional(), label: z.string().optional()}).optional()}); export const pivotSortAnchor = z.object({value: z.union([z.string(), z.number(), z.boolean()]).nullable(), reference: z.string()}); export const sortByDirection = z.enum(["ASC", "DESC"]); export const vizSortBy = z.object({pivotValues: z.array(pivotSortAnchor).optional(), nullsFirst: z.boolean().optional(), direction: sortByDirection, reference: z.string()}); export const vizAggregationOptions = z.enum(["sum", "count", "avg", "min", "max", "any"]); export const pivotChartLayout = z.object({stack: z.union([z.boolean(), stackType]).optional(), sortBy: z.array(vizSortBy).optional(), groupBy: z.array(z.object({reference: z.string()})).optional(), y: z.array(z.object({aggregation: vizAggregationOptions, reference: z.string()})), x: z.object({type: vizIndexType, reference: z.string()}).optional()}); export const vizPieChartDisplay = z.object({isDonut: z.boolean().optional()}); export const vizTableDisplay = z.object({}); export const vizColumnConfig = z.object({barConfig: z.object({color: z.string().optional(), max: z.number().optional(), min: z.number().optional()}).optional(), displayStyle: z.enum(["text", "bar"]).optional(), aggregation: vizAggregationOptions.optional(), order: z.number().optional(), frozen: z.boolean(), label: z.string(), reference: z.string(), visible: z.boolean()}); export const vizColumnsConfig = z.record(z.string(), vizColumnConfig); 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 contentAsCodeTypeSQLCHART = z.literal("sql_chart"); export const sqlChartAsCode = z.object({name: z.string(), description: z.string().nullable(), slug: z.string(), limit: z.number(), config: z.union([z.object({type: z.union([z.literal("vertical_bar"), z.literal("line")]), metadata: z.object({version: z.number()}), display: cartesianChartDisplay.optional(), fieldConfig: pivotChartLayout.optional()}), z.object({type: z.literal("pie"), metadata: z.object({version: z.number()}), display: vizPieChartDisplay.optional(), fieldConfig: pivotChartLayout.optional()}), z.object({type: z.literal("table"), metadata: z.object({version: z.number()}), display: vizTableDisplay.optional(), columns: vizColumnsConfig})]), sql: z.string(), chartKind: chartKind, downloadedAt: z.string().optional(), updatedAt: z.string().optional(), spaceSlug: z.string(), contentType: contentAsCodeTypeSQLCHART.optional(), version: z.number()}); export const apiSqlChartAsCodeListResponse = z.object({results: z.object({offset: z.number(), total: z.number(), spaces: z.array(spaceAsCode), missingIds: z.array(z.string()), sqlCharts: z.array(sqlChartAsCode)}), 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 SQL charts as code (deprecated) * * GET /api/v1/projects/{projectUuid}/sqlCharts/code */ export const getApiApiV1ProjectsProjectUuidSqlChartsCode = async (args: GetApiApiV1ProjectsProjectUuidSqlChartsCodeArgs, options: GetApiApiV1ProjectsProjectUuidSqlChartsCodeOptions) => { 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)) const url = `${baseUrl.replace(/\/+$/, '')}/api/v1/projects/${encodeURIComponent(String(args.projectUuid))}/sqlCharts/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(apiSqlChartAsCodeListResponse, await res.json()) };