@kubb/ast 5.0.0-alpha.5 → 5.0.0-alpha.51

package/src/constants.ts

@@ -5,7 +5,7 @@ import type { ParameterLocation } from './nodes/parameter.ts'
 import type { SchemaType } from './nodes/schema.ts'
 
 /**
- * Depth for schema traversal in visitor functions.
+ * Traversal depth used by AST visitor utilities.
  */
 export type VisitorDepth = 'shallow' | 'deep'
 
@@ -15,15 +15,40 @@ export const visitorDepths = {
 } as const satisfies Record<VisitorDepth, VisitorDepth>
 
 export const nodeKinds = {
-  root: 'Root',
+  input: 'Input',
+  output: 'Output',
   operation: 'Operation',
   schema: 'Schema',
   property: 'Property',
   parameter: 'Parameter',
   response: 'Response',
-} as const satisfies Record<Lowercase<NodeKind>, NodeKind>
+  functionParameter: 'FunctionParameter',
+  parameterGroup: 'ParameterGroup',
+  functionParameters: 'FunctionParameters',
+  type: 'Type',
+  file: 'File',
+  import: 'Import',
+  export: 'Export',
+  source: 'Source',
+  text: 'Text',
+  break: 'Break',
+} as const satisfies Record<string, NodeKind>
 
+/**
+ * Canonical schema type strings used by AST schema nodes.
+ *
+ * These values are used across the AST as stable discriminators
+ * (for example `schema.type === schemaTypes.object`).
+ *
+ * The map is grouped by intent:
+ * - primitives (`string`, `number`, `boolean`, ...)
+ * - structural/composite (`object`, `array`, `union`, ...)
+ * - special OpenAPI-oriented types (`ref`, `datetime`, `uuid`, ...)
+ */
 export const schemaTypes = {
+  /**
+   * Text value.
+   */
   string: 'string',
   /**
    * Floating-point number (`float`, `double`).
@@ -37,28 +62,110 @@ export const schemaTypes = {
    * 64-bit integer (`int64`). Only used when `integerType` is set to `'bigint'`.
    */
   bigint: 'bigint',
+  /**
+   * Boolean value
+   */
   boolean: 'boolean',
+  /**
+   * Explicit null value.
+   */
   null: 'null',
+  /**
+   * Any value (no type restriction).
+   */
   any: 'any',
+  /**
+   * Unknown value (must be narrowed before usage).
+   */
   unknown: 'unknown',
+  /**
+   * No return value (`void`).
+   */
   void: 'void',
+  /**
+   * Object with named properties.
+   */
   object: 'object',
+  /**
+   * Sequential list of items.
+   */
   array: 'array',
+  /**
+   * Fixed-length list with position-specific items.
+   */
   tuple: 'tuple',
+  /**
+   * "One of" multiple schema members.
+   */
   union: 'union',
+  /**
+   * "All of" multiple schema members.
+   */
   intersection: 'intersection',
+  /**
+   * Enum schema.
+   */
   enum: 'enum',
+  /**
+   * Reference to another schema.
+   */
   ref: 'ref',
+  /**
+   * Calendar date (for example `2026-03-24`).
+   */
   date: 'date',
+  /**
+   * Date-time value (for example `2026-03-24T09:00:00Z`).
+   */
   datetime: 'datetime',
+  /**
+   * Time-only value (for example `09:00:00`).
+   */
   time: 'time',
+  /**
+   * UUID value.
+   */
   uuid: 'uuid',
+  /**
+   * Email address value.
+   */
   email: 'email',
+  /**
+   * URL value.
+   */
   url: 'url',
+  /**
+   * IPv4 address value.
+   */
+  ipv4: 'ipv4',
+  /**
+   * IPv6 address value.
+   */
+  ipv6: 'ipv6',
+  /**
+   * Binary/blob value.
+   */
   blob: 'blob',
+  /**
+   * Impossible value (`never`).
+   */
   never: 'never',
 } as const satisfies Record<SchemaType, SchemaType>
 
+export type ScalarPrimitive = 'string' | 'number' | 'integer' | 'bigint' | 'boolean'
+
+/**
+ * Primitive scalar schema types used when simplifying union members.
+ */
+export const SCALAR_PRIMITIVE_TYPES = new Set<ScalarPrimitive>(['string', 'number', 'integer', 'bigint', 'boolean'])
+
+/**
+ * Returns `true` when `type` is a scalar primitive schema type.
+ */
+export function isScalarPrimitive(type: string): type is ScalarPrimitive {
+  return SCALAR_PRIMITIVE_TYPES.has(type as ScalarPrimitive)
+}
+
 export const httpMethods = {
   get: 'GET',
   post: 'POST',
@@ -78,12 +185,26 @@ export const parameterLocations = {
 } as const satisfies Record<ParameterLocation, ParameterLocation>
 
 /**
- * Default max concurrent visitor calls in `walk`.
+ * Default maximum number of concurrent callbacks used by `walk`.
+ *
+ * 30 is chosen to allow enough parallelism to overlap I/O-bound resolver calls
+ * without overwhelming the event loop or causing excessive memory pressure during
+ * large spec traversals.
+ *
+ * @example
+ * ```ts
+ * walk(root, { concurrency: WALK_CONCURRENCY, root: () => {} })
+ * ```
  */
 export const WALK_CONCURRENCY = 30
 
 /**
- * Fallback status code string for API spec responses.
+ * Fallback response status code used for catch-all responses.
+ *
+ * @example
+ * ```ts
+ * const status = DEFAULT_STATUS_CODE // 'default'
+ * ```
  */
 export const DEFAULT_STATUS_CODE = 'default' as const