import {z} from 'zod' export type GetApiApiV1ProjectsProjectUuidCompileLogsJobJobUuidArgs = {projectUuid: string, jobUuid: string}; export type GetApiApiV1ProjectsProjectUuidCompileLogsJobJobUuidOptions = {baseUrl: string, fetch?: typeof fetch | undefined}; export const dbtModelJoinType = z.enum(["inner", "full", "left", "right"]); export const joinRelationship = z.enum(["one-to-many", "many-to-one", "one-to-one", "many-to-many"]); export const compiledExploreJoin = z.object({hidden: z.boolean().optional(), table: z.string(), type: dbtModelJoinType.optional(), sqlOn: z.string(), always: z.boolean().optional(), relationship: joinRelationship.optional(), parameterReferences: z.array(z.string()).optional(), tablesReferences: z.array(z.string()).optional(), compiledSqlOn: z.string()}); export const inlineErrorType = z.enum(["METADATA_PARSE_ERROR", "NO_DIMENSIONS_FOUND", "SKIPPED_JOIN", "MISSING_TABLE", "FIELD_ERROR", "SET_VALIDATION_ERROR", "INVALID_PARAMETER", "DUPLICATE_FIELD_NAME", "WAREHOUSE_COLUMN_ERROR"]); export const inlineError = z.object({message: z.string(), type: inlineErrorType}); 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 defaultTimeDimension = z.object({interval: timeFrames, field: z.string()}); export const fieldGroupType = z.object({aiHint: z.union([z.string(), z.array(z.string())]).optional(), description: z.string().optional(), label: z.string()}); export const recordStringFieldGroupType = z.record(z.string(), fieldGroupType); export const recordStringStringOrStringArray = z.record(z.string(), z.union([z.string(), z.array(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 joinModelRequiredFilterTarget = z.object({tableName: z.string(), fieldRef: z.string()}); export const joinModelRequiredFilterRule = z.object({includeNull: z.boolean().optional(), values: z.array(anyType).optional(), operator: filterOperator, id: z.string(), target: joinModelRequiredFilterTarget, settings: anyType.optional(), disabled: z.boolean().optional(), required: z.boolean().optional(), caseSensitive: z.boolean().optional()}).and(z.record(z.string(), z.unknown())); export const modelRequiredFilterRule = z.union([metricFilterRule, joinModelRequiredFilterRule]); export const orderFieldsByStrategy = z.enum(["LABEL", "INDEX"]); export const fieldSetDefinition = z.object({fields: z.array(z.string())}); export const recordStringFieldSetDefinition = z.record(z.string(), fieldSetDefinition); export const lightdashParameterOption = z.object({value: z.union([z.string(), z.number()]), label: z.string()}); export const parameterValue = z.union([z.string(), z.number(), z.array(z.string()), z.array(z.number())]); export const lightdashProjectParameter = z.object({options_from_dimension: z.object({dimension: z.string(), model: z.string()}).optional(), options: z.union([z.array(z.string()), z.array(z.number()), z.array(lightdashParameterOption)]).optional(), allow_custom_values: z.boolean().optional(), multiple: z.boolean().optional(), default: parameterValue.optional(), type: z.enum(["string", "number", "date"]).optional(), description: z.string().optional(), label: z.string()}); export const recordStringLightdashProjectParameter = z.record(z.string(), lightdashProjectParameter); 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 lineageNodeDependency = z.object({name: z.string(), type: z.enum(["model", "seed", "source"])}); export const lineageGraph = z.record(z.string(), z.array(lineageNodeDependency)); 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 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 customFormatType = z.enum(["default", "percent", "currency", "number", "id", "date", "timestamp", "bytes_si", "bytes_iec", "custom"]); 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 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 compiledMetric = 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()}).and(z.record(z.string(), z.unknown())); export const recordStringCompiledMetric = z.record(z.string(), compiledMetric); 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 compiledDimension = z.object({fieldType: fieldTypeDIMENSION, type: dimensionType, 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())); export const recordStringCompiledDimension = z.record(z.string(), compiledDimension); export const compiledTable = z.object({sqlPath: z.string().optional(), ymlPath: z.string().optional(), dbtPackageName: z.string().optional(), warnings: z.array(inlineError).optional(), aiHint: z.union([z.string(), z.array(z.string())]).optional(), defaultShowUnderlyingValues: z.array(z.string()).optional(), defaultTimeDimension: defaultTimeDimension.optional(), groupDetails: recordStringFieldGroupType.optional(), anyAttributes: recordStringStringOrStringArray.optional(), requiredAttributes: recordStringStringOrStringArray.optional(), hidden: z.boolean().optional(), requiredFilters: z.array(modelRequiredFilterRule).optional(), sqlWhere: z.string().optional(), groupLabel: z.string().optional(), orderFieldsBy: orderFieldsByStrategy.optional(), primaryKey: z.array(z.string()).optional(), sqlTable: z.string(), schema: z.string(), database: z.string(), description: z.string().optional(), originalName: z.string().optional(), label: z.string(), name: z.string(), sets: recordStringFieldSetDefinition.optional(), parameters: recordStringLightdashProjectParameter.optional(), parameterReferences: z.array(z.string()).optional(), uncompiledSqlWhere: z.string().optional(), source: source.optional(), lineageGraph: lineageGraph, metrics: recordStringCompiledMetric, dimensions: recordStringCompiledDimension}); export const supportedDbtAdapter = z.enum(["bigquery", "databricks", "snowflake", "redshift", "postgres", "duckdb", "trino", "clickhouse", "athena", "spark"]); export const exploreType = z.enum(["virtual", "default", "pre_aggregate"]); export const partialRecordTimeFramesString = z.object({RAW: z.string().optional(), YEAR: z.string().optional(), QUARTER: z.string().optional(), MONTH: z.string().optional(), WEEK: z.string().optional(), DAY: z.string().optional(), HOUR: z.string().optional(), MINUTE: z.string().optional(), SECOND: z.string().optional(), MILLISECOND: z.string().optional(), DAY_OF_WEEK_INDEX: z.string().optional(), DAY_OF_MONTH_NUM: z.string().optional(), DAY_OF_YEAR_NUM: z.string().optional(), WEEK_NUM: z.string().optional(), MONTH_NUM: z.string().optional(), QUARTER_NUM: z.string().optional(), YEAR_NUM: z.string().optional(), DAY_OF_WEEK_NAME: z.string().optional(), MONTH_NAME: z.string().optional(), QUARTER_NAME: z.string().optional(), HOUR_OF_DAY_NUM: z.string().optional(), MINUTE_OF_HOUR_NUM: z.string().optional()}); export const parametersValuesMap = z.record(z.string(), parameterValue); export const userAttributeValueMap = z.record(z.string(), z.array(z.string())); export const preAggregateMaterializationRole = z.object({attributes: userAttributeValueMap, email: z.string()}); export const preAggregateDef = z.object({materializationRole: preAggregateMaterializationRole.optional(), refresh: z.object({cron: z.string().optional()}).optional(), maxRows: z.number().optional(), granularity: timeFrames.optional(), timeDimension: z.string().optional(), filters: z.array(metricFilterRule).optional(), metrics: z.array(z.string()), dimensions: z.array(z.string()), name: z.string()}); export const preAggregateSource = z.object({preAggregateName: z.string(), sourceExploreName: z.string()}); export const exploreError = z.object({name: z.string(), label: z.string(), tags: z.array(z.string()).optional(), groupLabel: z.string().optional(), groups: z.array(z.string()).optional(), baseTable: z.string().optional(), joinedTables: z.array(compiledExploreJoin).optional(), tables: z.record(z.string(), compiledTable).optional(), unfilteredTables: z.record(z.string(), compiledTable).optional(), targetDatabase: supportedDbtAdapter.optional(), warehouse: z.string().optional(), databricksCompute: z.string().optional(), ymlPath: z.string().optional(), sqlPath: z.string().optional(), type: exploreType.optional(), caseSensitive: z.boolean().optional(), spotlight: z.object({owner: z.string().optional(), categories: z.array(z.string()).optional(), visibility: z.enum(["show", "hide"])}).optional(), aiHint: z.union([z.string(), z.array(z.string())]).optional(), parameters: recordStringLightdashProjectParameter.optional(), granularityLabels: partialRecordTimeFramesString.optional(), savedParameterValues: parametersValuesMap.optional(), preAggregates: z.array(preAggregateDef).optional(), preAggregateSource: preAggregateSource.optional(), warnings: z.array(inlineError).optional(), errors: z.array(inlineError)}); export const compilationHistoryReport = z.object({baseTableNames: z.array(z.string()), exploresWithErrors: z.array(exploreError), dimensionsCount: z.number(), metricsCount: z.number(), errorExploresCount: z.number(), successfulExploresCount: z.number(), totalExploresCount: z.number()}); export const compilationSource = z.enum(["cli_deploy", "refresh_dbt", "create_project", "project_connection_form"]); export const projectCompileLog = z.object({report: compilationHistoryReport, warehouseType: z.string().nullable(), requestMethod: z.string().nullable(), dbtConnectionType: z.string().nullable(), compilationSource: compilationSource, createdAt: z.string(), organizationUuid: z.string(), userName: z.string().nullable(), userUuid: z.string().nullable(), jobUuid: z.string().nullable(), projectUuid: z.string(), projectCompileLogId: z.string()}); export const apiProjectCompileLogResponse = z.object({results: z.object({log: projectCompileLog.optional()}), 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 compilation log for a specific job * * GET /api/v1/projects/{projectUuid}/compile-logs/job/{jobUuid} */ export const getApiApiV1ProjectsProjectUuidCompileLogsJobJobUuid = async (args: GetApiApiV1ProjectsProjectUuidCompileLogsJobJobUuidArgs, options: GetApiApiV1ProjectsProjectUuidCompileLogsJobJobUuidOptions) => { const {baseUrl, fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") const url = `${baseUrl.replace(/\/+$/, '')}/api/v1/projects/${encodeURIComponent(String(args.projectUuid))}/compile-logs/job/${encodeURIComponent(String(args.jobUuid))}${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(apiProjectCompileLogResponse, await res.json()) };