import {z} from 'zod' export type GetApiApiV1ProjectsProjectUuidDataCatalogMetricsWithTimeDimensionsArgs = {projectUuid: string, tableName?: string | undefined}; export type GetApiApiV1ProjectsProjectUuidDataCatalogMetricsWithTimeDimensionsOptions = {baseUrl: string, fetch?: typeof fetch | undefined}; export const fieldTypeMETRIC = z.literal("metric"); 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 sourcePosition = z.object({character: z.number(), line: z.number()}); export const source = z.object({content: z.string(), highlight: z.object({end: sourcePosition, start: sourcePosition}).optional(), range: z.object({end: sourcePosition, start: sourcePosition}), path: z.string()}); 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 format = z.enum(["km", "mi", "si", "usd", "gbp", "eur", "jpy", "dkk", "id", "percent"]); export const numberSeparator = z.enum(["default", "commaPeriod", "spacePeriod", "periodComma", "noSeparatorPeriod", "apostrophePeriod"]); export const fieldUrl = z.object({label: z.string(), url: 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 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 customFormatType = z.enum(["default", "percent", "currency", "number", "id", "date", "timestamp", "bytes_si", "bytes_iec", "custom"]); 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 dimensionType = z.enum(["string", "number", "timestamp", "date", "boolean"]); export const recordStringStringOrStringArray = z.record(z.string(), z.union([z.string(), z.array(z.string())])); export const defaultTimeDimension = z.object({interval: timeFrames, field: z.string()}); export const compiledMetricTimestampFilter = z.object({compiledSql: z.string(), fieldId: z.string(), id: z.string()}); export const compiledMetricRelativeDateFilter = z.object({compiledSql: z.string(), fieldId: z.string(), id: z.string()}); export const fieldCompilationError = z.object({message: z.string()}); export const recordStringRecordStringStringOrStringArray = z.record(z.string(), recordStringStringOrStringArray); export const fieldTypeDIMENSION = z.literal("dimension"); export const timestampDomain = z.enum(["aware", "naive"]); export const recordStringString = z.object({}); export const filterAutocompleteValue = z.object({label: z.string().optional(), value: z.string()}); export const filterAutocompleteConfig = z.object({labelDimension: z.string().optional(), fetchFromWarehouse: z.boolean(), values: z.array(filterAutocompleteValue).optional()}); export const metricWithAssociatedTimeDimension = z.object({fieldType: fieldTypeMETRIC, type: metricType, name: z.string(), label: z.string(), table: z.string(), tableLabel: z.string(), sql: z.string(), description: z.string().optional(), source: source.optional(), hidden: z.boolean(), compact: compactOrAlias.optional(), round: z.number().optional(), format: z.union([format, z.string()]).optional(), separator: numberSeparator.optional(), groupLabel: z.string().optional(), groups: z.array(z.string()).optional(), urls: z.array(fieldUrl).optional(), index: z.number().optional(), tags: z.array(z.string()).optional(), parameterReferences: z.array(z.string()).optional(), showUnderlyingValues: z.array(z.string()).optional(), filters: z.array(metricFilterRule).optional(), percentile: z.number().optional(), distinctKeys: z.array(z.string()).optional(), formatOptions: customFormat.optional(), dimensionReference: z.string().optional(), baseDimensionType: dimensionType.optional(), baseDimensionTimeInterval: timeFrames.optional(), requiredAttributes: recordStringStringOrStringArray.optional(), anyAttributes: recordStringStringOrStringArray.optional(), defaultTimeDimension: defaultTimeDimension.optional(), spotlight: z.object({owner: z.string().optional(), defaultFilter: metricFilterRule.optional(), defaultSegment: z.string().optional(), segmentBy: z.array(z.string()).optional(), filterBy: z.array(z.string()).optional(), categories: z.array(z.string()).optional(), visibility: z.enum(["show", "hide"])}).optional(), drivers: z.array(z.string()).optional(), aiHint: z.union([z.string(), z.array(z.string())]).optional(), richText: z.string().optional(), compiledTimestampFilters: z.array(compiledMetricTimestampFilter).optional(), compiledRelativeDateFilters: z.array(compiledMetricRelativeDateFilter).optional(), compiledDistinctKeys: z.array(z.string()).optional(), compiledValueSql: z.string().optional(), compilationError: fieldCompilationError.optional(), tablesAnyAttributes: recordStringRecordStringStringOrStringArray.optional(), tablesRequiredAttributes: recordStringRecordStringStringOrStringArray.optional(), tablesReferences: z.array(z.string()).optional(), compiledSql: z.string(), availableTimeDimensions: z.array(z.object({fieldType: fieldTypeDIMENSION, type: z.union([z.literal("date"), z.literal("timestamp")]), name: z.string(), label: z.string(), table: z.string(), tableLabel: z.string(), sql: z.string(), description: z.string().optional(), source: source.optional(), hidden: z.boolean(), compact: compactOrAlias.optional(), round: z.number().optional(), format: z.union([format, z.string()]).optional(), separator: numberSeparator.optional(), groupLabel: z.string().optional(), groups: z.array(z.string()).optional(), urls: z.array(fieldUrl).optional(), index: z.number().optional(), tags: z.array(z.string()).optional(), parameterReferences: z.array(z.string()).optional(), group: z.string().optional(), requiredAttributes: recordStringStringOrStringArray.optional(), anyAttributes: recordStringStringOrStringArray.optional(), timeInterval: timeFrames.optional(), timeIntervalLabel: z.string().optional(), timeIntervalBaseDimensionName: z.string().optional(), timeIntervalBaseDimensionType: dimensionType.optional(), customTimeInterval: z.string().optional(), isAdditionalDimension: z.boolean().optional(), skipTimezoneConversion: z.boolean().optional(), timestampDomain: timestampDomain.optional(), colors: recordStringString.optional(), isIntervalBase: z.boolean().optional(), aiHint: z.union([z.string(), z.array(z.string())]).optional(), formatOptions: customFormat.optional(), caseSensitive: z.boolean().optional(), image: z.object({fit: z.string().optional(), height: z.number().optional(), width: z.number().optional(), url: z.string()}).optional(), richText: z.string().optional(), filterAutocomplete: filterAutocompleteConfig.optional(), spotlight: z.object({segmentBy: z.boolean().optional(), filterBy: z.boolean().optional()}).optional(), compiledTimestampFilters: z.array(compiledMetricTimestampFilter).optional(), compiledRelativeDateFilters: z.array(compiledMetricRelativeDateFilter).optional(), compiledDistinctKeys: z.array(z.string()).optional(), compiledValueSql: z.string().optional(), compilationError: fieldCompilationError.optional(), tablesAnyAttributes: recordStringRecordStringStringOrStringArray.optional(), tablesRequiredAttributes: recordStringRecordStringStringOrStringArray.optional(), tablesReferences: z.array(z.string()).optional(), compiledSql: z.string()}).and(z.record(z.string(), z.unknown()))).optional(), timeDimension: z.object({interval: timeFrames, field: z.string(), table: z.string()}).optional()}).and(z.record(z.string(), z.unknown())); export const apiMetricsWithAssociatedTimeDimensionResponse = z.object({results: z.array(metricWithAssociatedTimeDimension), 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 metrics with time dimensions * * GET /api/v1/projects/{projectUuid}/dataCatalog/metrics-with-time-dimensions */ export const getApiApiV1ProjectsProjectUuidDataCatalogMetricsWithTimeDimensions = async (args: GetApiApiV1ProjectsProjectUuidDataCatalogMetricsWithTimeDimensionsArgs, options: GetApiApiV1ProjectsProjectUuidDataCatalogMetricsWithTimeDimensionsOptions) => { const {baseUrl, fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.tableName != null) query.append("tableName", String(args.tableName)) const url = `${baseUrl.replace(/\/+$/, '')}/api/v1/projects/${encodeURIComponent(String(args.projectUuid))}/dataCatalog/metrics-with-time-dimensions${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(apiMetricsWithAssociatedTimeDimensionResponse, await res.json()) };