import {z} from 'zod' export type GetApiApiOrgIdStreamsStreamNameSchemaArgs = {org_id: string, stream_name: string, type?: string | undefined, keyword?: string | undefined, offset?: number | undefined, limit?: number | undefined}; export type GetApiApiOrgIdStreamsStreamNameSchemaOptions = {baseUrl: string, Authorization?: string | undefined, fetch?: typeof fetch | undefined}; export const metricType = z.enum(["Unknown", "Counter", "Gauge", "Histogram", "GaugeHistogram", "ExponentialHistogram", "Summary", "Info", "StateSet", "Empty"]); export const metadata = z.object({help: z.string(), metric_family_name: z.string(), metric_type: metricType, unit: z.string()}); export const patternAssociation = z.object({apply_at: z.string(), description: z.string(), field: z.string(), pattern: z.string(), pattern_id: z.string(), pattern_name: z.string(), policy: z.string()}); export const streamField = z.object({name: z.string(), type: z.string()}); export const crossLinkField = z.object({alias: z.string().nullable().optional(), name: z.string()}); export const crossLink = z.object({fields: z.array(crossLinkField).optional(), name: z.string(), url: z.string()}); export const distinctField = z.object({added_ts: z.number().int(), name: z.string()}); export const timeRange = z.object({end: z.number().int(), start: z.number().int()}); export const streamPartitionType = z.union([z.literal("value"), z.object({hash: z.number().int().gte(0)}), z.literal("prefix")]); export const streamPartition = z.object({disabled: z.boolean().optional(), field: z.string(), types: streamPartitionType.optional()}); export const partitionTimeLevel = z.enum(["unset", "hourly", "daily"]); export const partitionTimeLevelChange = z.object({level: partitionTimeLevel, since: z.number().int()}); export const streamPartitionTimeLevel = z.object({changes: z.array(partitionTimeLevelChange).optional(), dynamic: z.boolean().nullable().optional()}); export const storageType = z.enum(["normal", "compliance"]); export const streamSettings = z.object({approx_partition: z.boolean().optional(), bloom_filter_fields: z.array(z.string()).optional(), cross_links: z.array(crossLink).optional(), data_retention: z.number().int().optional(), defined_schema_fields: z.array(z.string()).optional(), distinct_value_fields: z.array(distinctField).optional(), enable_distinct_fields: z.boolean().optional(), enable_log_patterns_extraction: z.boolean().optional(), extended_retention_days: z.array(timeRange).optional(), flatten_level: z.number().int().nullable().optional(), full_text_search_keys: z.array(z.string()).optional(), index_all_values: z.boolean().optional(), index_fields: z.array(z.string()).optional(), index_fields_updated_at: z.record(z.string(), z.number().int()).optional(), index_original_data: z.boolean().optional(), index_updated_at: z.number().int().optional(), is_llm_stream: z.boolean().optional(), max_query_range: z.number().int().optional(), partition_keys: z.array(streamPartition).optional(), partition_time_level: streamPartitionTimeLevel.optional(), storage_type: storageType.optional(), store_original_data: z.boolean().optional()}); export const streamStats = z.object({compressed_size: z.number(), created_at: z.number().int(), doc_num: z.number().int(), doc_time_max: z.number().int(), doc_time_min: z.number().int(), file_num: z.number().int(), index_size: z.number(), mindex_size: z.number().optional(), storage_size: z.number()}); export const streamType = z.enum(["logs", "metrics", "traces", "profiles", "service_graph", "enrichment_tables", "file_list", "metadata", "index"]); export const stream = z.object({inherited_retention_days: z.number().int().nullable().optional(), is_derived: z.boolean().nullable().optional(), is_internal: z.boolean().optional(), metrics_meta: metadata.nullable().optional(), name: z.string(), pattern_associations: z.array(patternAssociation).optional(), schema: z.array(streamField), settings: streamSettings, stats: streamStats, storage_type: z.string(), stream_type: streamType, total_fields: z.number().int().gte(0), uds_schema: z.array(streamField).optional()}); 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 stream schema * * GET /api/{org_id}/streams/{stream_name}/schema */ export const getApiApiOrgIdStreamsStreamNameSchema = async (args: GetApiApiOrgIdStreamsStreamNameSchemaArgs, options: GetApiApiOrgIdStreamsStreamNameSchemaOptions) => { const {baseUrl, fetch: fetchFn = fetch, Authorization} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.type != null) query.append("type", String(args.type)) if (args.keyword != null) query.append("keyword", String(args.keyword)) if (args.offset != null) query.append("offset", String(args.offset)) if (args.limit != null) query.append("limit", String(args.limit)) if (Authorization !== undefined) headers.set("Authorization", Authorization) const url = `${baseUrl.replace(/\/+$/, '')}/api/${encodeURIComponent(String(args.org_id))}/streams/${encodeURIComponent(String(args.stream_name))}/schema${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(stream, await res.json()) };