@kaito-http/core 4.0.0-beta.21 → 4.0.0-beta.24

package/dist/{chunk-TL3E52YN.js → chunk-IEGYJT4R.js}

@@ -295,6 +295,8 @@ var KString = class _KString extends BaseSchema {
     }
     return result.result;
   }
+  visit() {
+  }
 };
 var KNumber = class _KNumber extends BaseSchema {
   static create = () => new _KNumber({});
@@ -401,6 +403,8 @@ var KNumber = class _KNumber extends BaseSchema {
     }
     return result.result;
   }
+  visit() {
+  }
 };
 var KBoolean = class _KBoolean extends BaseSchema {
   static create = () => new _KBoolean({});
@@ -429,6 +433,8 @@ var KBoolean = class _KBoolean extends BaseSchema {
     }
     return result.result;
   }
+  visit() {
+  }
 };
 var KArray = class _KArray extends BaseSchema {
   static create = (items) => new _KArray({ items });
@@ -495,6 +501,11 @@ var KArray = class _KArray extends BaseSchema {
     }
     return result.result;
   }
+  visit(visitor) {
+    const child = this.def.items;
+    visitor(child);
+    child.visit(visitor);
+  }
 };
 var KNull = class _KNull extends BaseSchema {
   static create = () => new _KNull({});
@@ -523,6 +534,8 @@ var KNull = class _KNull extends BaseSchema {
     }
     return result.result;
   }
+  visit() {
+  }
 };
 var KObject = class _KObject extends BaseSchema {
   static create = (shape) => new _KObject({ shape });
@@ -585,6 +598,12 @@ var KObject = class _KObject extends BaseSchema {
   get shape() {
     return this.def.shape;
   }
+  visit(visitor) {
+    for (const child of Object.values(this.def.shape)) {
+      visitor(child);
+      child.visit(visitor);
+    }
+  }
 };
 var KObjectFromURLSearchParams = class _KObjectFromURLSearchParams extends KObject {
   static create = (shape) => new _KObjectFromURLSearchParams({ shape });
@@ -632,6 +651,12 @@ var KRef = class _KRef extends BaseSchema {
     }
     return result;
   }
+  visit(visitor) {
+    for (const child of Object.values(this.def.shape)) {
+      visitor(child);
+      child.visit(visitor);
+    }
+  }
   example() {
     throw new Error("Cannot set an example on a KRef");
   }
@@ -687,13 +712,21 @@ var KRef = class _KRef extends BaseSchema {
 var KScalar = class _KScalar extends BaseSchema {
   static create = (options) => new _KScalar(options);
   constructor(def) {
-    super(def);
+    super({
+      ...def,
+      example: def.schema.example(),
+      description: def.schema.description()
+    });
   }
   serialize(value) {
     return this.def.toClient(value);
   }
   toOpenAPI() {
-    return this.def.schema.toOpenAPI();
+    return {
+      ...this.def.schema.toOpenAPI(),
+      ...this.def.description ? { description: this.def.description } : {},
+      ...this.def.example ? { example: this.def.example } : {}
+    };
   }
   parseSafe(json) {
     return ParseContext.result((ctx) => {
@@ -708,18 +741,6 @@ var KScalar = class _KScalar extends BaseSchema {
       }
     });
   }
-  example(example) {
-    if (example === void 0) {
-      return this.def.example;
-    }
-    return this.clone({ example });
-  }
-  description(description) {
-    if (description === void 0) {
-      return this.def.schema.description();
-    }
-    return this.clone({ description });
-  }
   parse(json) {
     const result = this.parseSafe(json);
     if (!result.success) {
@@ -727,6 +748,11 @@ var KScalar = class _KScalar extends BaseSchema {
     }
     return result.result;
   }
+  visit(visitor) {
+    const child = this.def.schema;
+    visitor(child);
+    child.visit(visitor);
+  }
 };
 var KUnion = class _KUnion extends BaseSchema {
   static create = (items) => new _KUnion({ items });
@@ -765,6 +791,12 @@ var KUnion = class _KUnion extends BaseSchema {
     }
     return result.result;
   }
+  visit(visitor) {
+    for (const child of this.def.items) {
+      visitor(child);
+      child.visit(visitor);
+    }
+  }
 };
 var KLiteral = class _KLiteral extends BaseSchema {
   parse(json) {
@@ -795,6 +827,8 @@ var KLiteral = class _KLiteral extends BaseSchema {
       return this.def.value;
     });
   }
+  visit() {
+  }
 };
 var k = {
   string: KString.create,

package/dist/index.cjs

@@ -453,6 +453,8 @@ var KString = class _KString extends BaseSchema {
     }
     return result.result;
   }
+  visit() {
+  }
 };
 var KNumber = class _KNumber extends BaseSchema {
   static create = () => new _KNumber({});
@@ -559,6 +561,8 @@ var KNumber = class _KNumber extends BaseSchema {
     }
     return result.result;
   }
+  visit() {
+  }
 };
 var KBoolean = class _KBoolean extends BaseSchema {
   static create = () => new _KBoolean({});
@@ -587,6 +591,8 @@ var KBoolean = class _KBoolean extends BaseSchema {
     }
     return result.result;
   }
+  visit() {
+  }
 };
 var KArray = class _KArray extends BaseSchema {
   static create = (items) => new _KArray({ items });
@@ -653,6 +659,11 @@ var KArray = class _KArray extends BaseSchema {
     }
     return result.result;
   }
+  visit(visitor) {
+    const child = this.def.items;
+    visitor(child);
+    child.visit(visitor);
+  }
 };
 var KNull = class _KNull extends BaseSchema {
   static create = () => new _KNull({});
@@ -681,6 +692,8 @@ var KNull = class _KNull extends BaseSchema {
     }
     return result.result;
   }
+  visit() {
+  }
 };
 var KObject = class _KObject extends BaseSchema {
   static create = (shape) => new _KObject({ shape });
@@ -743,6 +756,12 @@ var KObject = class _KObject extends BaseSchema {
   get shape() {
     return this.def.shape;
   }
+  visit(visitor) {
+    for (const child of Object.values(this.def.shape)) {
+      visitor(child);
+      child.visit(visitor);
+    }
+  }
 };
 var KObjectFromURLSearchParams = class _KObjectFromURLSearchParams extends KObject {
   static create = (shape) => new _KObjectFromURLSearchParams({ shape });
@@ -790,6 +809,12 @@ var KRef = class _KRef extends BaseSchema {
     }
     return result;
   }
+  visit(visitor) {
+    for (const child of Object.values(this.def.shape)) {
+      visitor(child);
+      child.visit(visitor);
+    }
+  }
   example() {
     throw new Error("Cannot set an example on a KRef");
   }
@@ -845,13 +870,21 @@ var KRef = class _KRef extends BaseSchema {
 var KScalar = class _KScalar extends BaseSchema {
   static create = (options) => new _KScalar(options);
   constructor(def) {
-    super(def);
+    super({
+      ...def,
+      example: def.schema.example(),
+      description: def.schema.description()
+    });
   }
   serialize(value) {
     return this.def.toClient(value);
   }
   toOpenAPI() {
-    return this.def.schema.toOpenAPI();
+    return {
+      ...this.def.schema.toOpenAPI(),
+      ...this.def.description ? { description: this.def.description } : {},
+      ...this.def.example ? { example: this.def.example } : {}
+    };
   }
   parseSafe(json) {
     return ParseContext.result((ctx) => {
@@ -866,18 +899,6 @@ var KScalar = class _KScalar extends BaseSchema {
       }
     });
   }
-  example(example) {
-    if (example === void 0) {
-      return this.def.example;
-    }
-    return this.clone({ example });
-  }
-  description(description) {
-    if (description === void 0) {
-      return this.def.schema.description();
-    }
-    return this.clone({ description });
-  }
   parse(json) {
     const result = this.parseSafe(json);
     if (!result.success) {
@@ -885,6 +906,11 @@ var KScalar = class _KScalar extends BaseSchema {
     }
     return result.result;
   }
+  visit(visitor) {
+    const child = this.def.schema;
+    visitor(child);
+    child.visit(visitor);
+  }
 };
 var KUnion = class _KUnion extends BaseSchema {
   static create = (items) => new _KUnion({ items });
@@ -923,6 +949,12 @@ var KUnion = class _KUnion extends BaseSchema {
     }
     return result.result;
   }
+  visit(visitor) {
+    for (const child of this.def.items) {
+      visitor(child);
+      child.visit(visitor);
+    }
+  }
 };
 var KLiteral = class _KLiteral extends BaseSchema {
   parse(json) {
@@ -953,6 +985,8 @@ var KLiteral = class _KLiteral extends BaseSchema {
       return this.def.value;
     });
   }
+  visit() {
+  }
 };
 var k = {
   string: KString.create,
@@ -1173,6 +1207,33 @@ var Router = class _Router {
     servers
   }) => {
     const OPENAPI_VERSION = "3.1.0";
+    const componentsSchemas = {};
+    const addSchemaForRef = (ref) => {
+      const name = ref.name;
+      const properties = Object.fromEntries(Object.entries(ref.shape).map(([key, value]) => [key, value.toOpenAPI()]));
+      const schemaObject = {
+        type: "object",
+        properties,
+        required: Object.keys(ref.shape),
+        ...ref.description() ? { description: ref.description() } : {}
+      };
+      const existing = componentsSchemas[name];
+      if (existing) {
+        if (JSON.stringify(existing) !== JSON.stringify(schemaObject)) {
+          throw new Error(
+            `Conflicting KRef definitions detected for "${name}". OpenAPI components require a single schema per name.`
+          );
+        }
+        return;
+      }
+      componentsSchemas[name] = schemaObject;
+    };
+    function visit(schema, seen = /* @__PURE__ */ new Set()) {
+      if (seen.has(schema)) return;
+      seen.add(schema);
+      if (schema instanceof KRef) addSchemaForRef(schema);
+      schema.visit((child) => visit(child, seen));
+    }
     const paths = {};
     for (const route of this.#state.routes) {
       if (!route.openapi) {
@@ -1194,6 +1255,8 @@ var Router = class _Router {
         default:
           throw new Error(`Unknown output type in route ${route.method} ${route.path}: ${type}`);
       }
+      if (route.openapi.schema) visit(route.openapi.schema);
+      if (route.body) visit(route.body);
       const item = {
         description: route.openapi?.description ?? "Successful response",
         responses: {
@@ -1223,6 +1286,7 @@ var Router = class _Router {
       openapi: OPENAPI_VERSION,
       info,
       paths,
+      ...Object.keys(componentsSchemas).length > 0 ? { components: { schemas: componentsSchemas } } : {},
       servers: Object.entries(servers ?? {}).map((entry) => {
         const [url, description] = entry;
         return {

package/dist/index.js

@@ -16,7 +16,7 @@ import {
   SchemaError,
   isPrimitiveJSONValue,
   k
-} from "./chunk-TL3E52YN.js";
+} from "./chunk-IEGYJT4R.js";
 
 // src/router/router.ts
 import "openapi3-ts/oas31";
@@ -328,6 +328,33 @@ var Router = class _Router {
     servers
   }) => {
     const OPENAPI_VERSION = "3.1.0";
+    const componentsSchemas = {};
+    const addSchemaForRef = (ref) => {
+      const name = ref.name;
+      const properties = Object.fromEntries(Object.entries(ref.shape).map(([key, value]) => [key, value.toOpenAPI()]));
+      const schemaObject = {
+        type: "object",
+        properties,
+        required: Object.keys(ref.shape),
+        ...ref.description() ? { description: ref.description() } : {}
+      };
+      const existing = componentsSchemas[name];
+      if (existing) {
+        if (JSON.stringify(existing) !== JSON.stringify(schemaObject)) {
+          throw new Error(
+            `Conflicting KRef definitions detected for "${name}". OpenAPI components require a single schema per name.`
+          );
+        }
+        return;
+      }
+      componentsSchemas[name] = schemaObject;
+    };
+    function visit(schema, seen = /* @__PURE__ */ new Set()) {
+      if (seen.has(schema)) return;
+      seen.add(schema);
+      if (schema instanceof KRef) addSchemaForRef(schema);
+      schema.visit((child) => visit(child, seen));
+    }
     const paths = {};
     for (const route of this.#state.routes) {
       if (!route.openapi) {
@@ -349,6 +376,8 @@ var Router = class _Router {
         default:
           throw new Error(`Unknown output type in route ${route.method} ${route.path}: ${type}`);
       }
+      if (route.openapi.schema) visit(route.openapi.schema);
+      if (route.body) visit(route.body);
       const item = {
         description: route.openapi?.description ?? "Successful response",
         responses: {
@@ -378,6 +407,7 @@ var Router = class _Router {
       openapi: OPENAPI_VERSION,
       info,
       paths,
+      ...Object.keys(componentsSchemas).length > 0 ? { components: { schemas: componentsSchemas } } : {},
       servers: Object.entries(servers ?? {}).map((entry) => {
         const [url, description] = entry;
         return {

package/dist/schema/schema.cjs

@@ -335,6 +335,8 @@ var KString = class _KString extends BaseSchema {
     }
     return result.result;
   }
+  visit() {
+  }
 };
 var KNumber = class _KNumber extends BaseSchema {
   static create = () => new _KNumber({});
@@ -441,6 +443,8 @@ var KNumber = class _KNumber extends BaseSchema {
     }
     return result.result;
   }
+  visit() {
+  }
 };
 var KBoolean = class _KBoolean extends BaseSchema {
   static create = () => new _KBoolean({});
@@ -469,6 +473,8 @@ var KBoolean = class _KBoolean extends BaseSchema {
     }
     return result.result;
   }
+  visit() {
+  }
 };
 var KArray = class _KArray extends BaseSchema {
   static create = (items) => new _KArray({ items });
@@ -535,6 +541,11 @@ var KArray = class _KArray extends BaseSchema {
     }
     return result.result;
   }
+  visit(visitor) {
+    const child = this.def.items;
+    visitor(child);
+    child.visit(visitor);
+  }
 };
 var KNull = class _KNull extends BaseSchema {
   static create = () => new _KNull({});
@@ -563,6 +574,8 @@ var KNull = class _KNull extends BaseSchema {
     }
     return result.result;
   }
+  visit() {
+  }
 };
 var KObject = class _KObject extends BaseSchema {
   static create = (shape) => new _KObject({ shape });
@@ -625,6 +638,12 @@ var KObject = class _KObject extends BaseSchema {
   get shape() {
     return this.def.shape;
   }
+  visit(visitor) {
+    for (const child of Object.values(this.def.shape)) {
+      visitor(child);
+      child.visit(visitor);
+    }
+  }
 };
 var KObjectFromURLSearchParams = class _KObjectFromURLSearchParams extends KObject {
   static create = (shape) => new _KObjectFromURLSearchParams({ shape });
@@ -672,6 +691,12 @@ var KRef = class _KRef extends BaseSchema {
     }
     return result;
   }
+  visit(visitor) {
+    for (const child of Object.values(this.def.shape)) {
+      visitor(child);
+      child.visit(visitor);
+    }
+  }
   example() {
     throw new Error("Cannot set an example on a KRef");
   }
@@ -727,13 +752,21 @@ var KRef = class _KRef extends BaseSchema {
 var KScalar = class _KScalar extends BaseSchema {
   static create = (options) => new _KScalar(options);
   constructor(def) {
-    super(def);
+    super({
+      ...def,
+      example: def.schema.example(),
+      description: def.schema.description()
+    });
   }
   serialize(value) {
     return this.def.toClient(value);
   }
   toOpenAPI() {
-    return this.def.schema.toOpenAPI();
+    return {
+      ...this.def.schema.toOpenAPI(),
+      ...this.def.description ? { description: this.def.description } : {},
+      ...this.def.example ? { example: this.def.example } : {}
+    };
   }
   parseSafe(json) {
     return ParseContext.result((ctx) => {
@@ -748,18 +781,6 @@ var KScalar = class _KScalar extends BaseSchema {
       }
     });
   }
-  example(example) {
-    if (example === void 0) {
-      return this.def.example;
-    }
-    return this.clone({ example });
-  }
-  description(description) {
-    if (description === void 0) {
-      return this.def.schema.description();
-    }
-    return this.clone({ description });
-  }
   parse(json) {
     const result = this.parseSafe(json);
     if (!result.success) {
@@ -767,6 +788,11 @@ var KScalar = class _KScalar extends BaseSchema {
     }
     return result.result;
   }
+  visit(visitor) {
+    const child = this.def.schema;
+    visitor(child);
+    child.visit(visitor);
+  }
 };
 var KUnion = class _KUnion extends BaseSchema {
   static create = (items) => new _KUnion({ items });
@@ -805,6 +831,12 @@ var KUnion = class _KUnion extends BaseSchema {
     }
     return result.result;
   }
+  visit(visitor) {
+    for (const child of this.def.items) {
+      visitor(child);
+      child.visit(visitor);
+    }
+  }
 };
 var KLiteral = class _KLiteral extends BaseSchema {
   parse(json) {
@@ -835,6 +867,8 @@ var KLiteral = class _KLiteral extends BaseSchema {
       return this.def.value;
     });
   }
+  visit() {
+  }
 };
 var k = {
   string: KString.create,

package/dist/schema/schema.d.cts

@@ -61,6 +61,10 @@ declare abstract class BaseSchema<Input extends JSONValue, Output, Def extends B
     example(): Input | undefined;
     description(description: string): this;
     description(): string | undefined;
+    /**
+     * Traverse immediate children schemas.
+     */
+    abstract visit(visitor: (schema: BaseSchema<any, any, any>) => void): void;
 }
 type Check<T extends string, P extends {} = {}> = {
     type: T;
@@ -142,6 +146,7 @@ declare class KString extends BaseSchema<string, string, StringDef> {
     hostname(message?: string): this;
     parseSafe(json: unknown): ParseResult<string>;
     parse(json: unknown): string;
+    visit(): void;
 }
 type NumberFormat = 'float' | 'double' | 'int32' | 'int64';
 interface NumberChecks {
@@ -176,6 +181,7 @@ declare class KNumber extends BaseSchema<number, number, NumberDef> {
     int64(): this;
     parseSafe(json: unknown): ParseResult<number>;
     parse(json: unknown): number;
+    visit(): void;
 }
 interface BooleanDef extends BaseSchemaDef<boolean> {
 }
@@ -185,6 +191,7 @@ declare class KBoolean extends BaseSchema<boolean, boolean, BooleanDef> {
     toOpenAPI(): SchemaObject | ReferenceObject;
     parseSafe(json: unknown): ParseResult<boolean>;
     parse(json: unknown): boolean;
+    visit(): void;
 }
 interface ArrayChecks {
     minItems?: Check<'minItems', {
@@ -211,6 +218,7 @@ declare class KArray<Input extends JSONValue, Output> extends BaseSchema<Input[]
     notUnique(): this;
     parseSafe(json: unknown): ParseResult<Output[]>;
     parse(json: unknown): Output[];
+    visit(visitor: (schema: BaseSchema<any, any, any>) => void): void;
 }
 interface NullDef extends BaseSchemaDef<null> {
 }
@@ -220,6 +228,7 @@ declare class KNull extends BaseSchema<null, null, NullDef> {
     toOpenAPI(): SchemaObject | ReferenceObject;
     parseSafe(json: unknown): ParseResult<null>;
     parse(json: unknown): null;
+    visit(): void;
 }
 interface ObjectDef<Input extends Record<keyof Output, JSONValue>, Output extends Record<keyof Input, JSONValue>> extends BaseSchemaDef<Input> {
     shape: {
@@ -233,6 +242,7 @@ declare class KObject<Input extends Record<keyof Output, JSONValue>, Output exte
     parseSafe(json: unknown): ParseResult<Output>;
     parse(json: unknown): Output;
     get shape(): { [K in keyof Input]: BaseSchema<Input[K], Output[K], BaseSchemaDef<Input[K]>>; };
+    visit(visitor: (schema: BaseSchema<any, any, any>) => void): void;
 }
 declare class KObjectFromURLSearchParams<Input extends Record<keyof Output, JSONValue>, Output extends Record<keyof Input, JSONValue>> extends KObject<Input, Output> {
     static create: <Input_1 extends Record<keyof Output_1, JSONValue>, Output_1 extends Record<keyof Input_1, JSONValue>>(shape: { [K in keyof Input_1 | keyof Output_1]: BaseSchema<Input_1[K], Output_1[K], BaseSchemaDef<Input_1[K]>>; }) => KObjectFromURLSearchParams<Input_1, Output_1>;
@@ -244,9 +254,10 @@ interface RefDef<Input extends Record<keyof Output, JSONValue>, Output extends R
     name: string;
     summary?: string | undefined;
 }
-declare class KRef<Input extends Record<keyof Output, JSONValue>, Output extends Record<keyof Input, JSONValue>> extends BaseSchema<Input, Output, RefDef<Input, Output>> {
-    static create: <Input_1 extends Record<keyof Output_1, JSONValue>, Output_1 extends Record<keyof Input_1, JSONValue>>(name: string, shape: { [K in keyof Input_1 | keyof Output_1]: BaseSchema<Input_1[K], Output_1[K], BaseSchemaDef<Input_1[K]>>; }) => KRef<Input_1, Output_1>;
+declare class KRef<Input extends Record<keyof Output, JSONValue>, Output extends Record<keyof Input, any>> extends BaseSchema<Input, Output, RefDef<Input, Output>> {
+    static create: <Input_1 extends Record<keyof Output_1, JSONValue>, Output_1 extends Record<keyof Input_1, any>>(name: string, shape: { [K in keyof Input_1 | keyof Output_1]: BaseSchema<Input_1[K], Output_1[K], BaseSchemaDef<Input_1[K]>>; }) => KRef<Input_1, Output_1>;
     serialize(value: Output): Input;
+    visit(visitor: (schema: BaseSchema<any, any, any>) => void): void;
     example(): never;
     toOpenAPI(): ReferenceObject;
     parseSafe(json: unknown): ParseResult<Output>;
@@ -282,11 +293,8 @@ declare class KScalar<ClientRepresentation extends JSONPrimitive, ServerRepresen
     serialize(value: ServerRepresentation): ClientRepresentation;
     toOpenAPI(): SchemaObject | ReferenceObject;
     parseSafe(json: unknown): ParseResult<ServerRepresentation>;
-    example(example: ClientRepresentation): this;
-    example(): ClientRepresentation | undefined;
-    description(description: string): this;
-    description(): string | undefined;
     parse(json: unknown): ServerRepresentation;
+    visit(visitor: (schema: BaseSchema<any, any, any>) => void): void;
 }
 interface UnionDef<Input extends JSONValue, Output> extends BaseSchemaDef<Input> {
     items: [
@@ -301,6 +309,7 @@ declare class KUnion<Input extends JSONValue, Output> extends BaseSchema<Input,
     toOpenAPI(): SchemaObject | ReferenceObject;
     parseSafe(json: unknown): ParseResult<Output>;
     parse(json: unknown): Output;
+    visit(visitor: (schema: BaseSchema<any, any, any>) => void): void;
 }
 interface LiteralDef<Value extends string | number | boolean> extends BaseSchemaDef<Value> {
     value: Value;
@@ -311,6 +320,7 @@ declare class KLiteral<Value extends string | number | boolean> extends BaseSche
     serialize(value: Value): Value;
     toOpenAPI(): SchemaObject;
     parseSafe(json: unknown): ParseResult<Value>;
+    visit(): void;
 }
 declare const k: {
     string: () => KString;
@@ -318,7 +328,7 @@ declare const k: {
     boolean: () => KBoolean;
     array: <ItemsInput extends JSONValue, ItemsOutput, Def extends BaseSchemaDef<ItemsInput>>(items: BaseSchema<ItemsInput, ItemsOutput, Def>) => KArray<ItemsInput, ItemsOutput>;
     null: () => KNull;
-    ref: <Input extends Record<keyof Output, JSONValue>, Output extends Record<keyof Input, JSONValue>>(name: string, shape: { [K in keyof Input | keyof Output]: BaseSchema<Input[K], Output[K], BaseSchemaDef<Input[K]>>; }) => KRef<Input, Output>;
+    ref: <Input extends Record<keyof Output, JSONValue>, Output extends Record<keyof Input, any>>(name: string, shape: { [K in keyof Input | keyof Output]: BaseSchema<Input[K], Output[K], BaseSchemaDef<Input[K]>>; }) => KRef<Input, Output>;
     object: <Input extends Record<keyof Output, any>, Output extends Record<keyof Input, any>>(shape: { [K in keyof Input | keyof Output]: BaseSchema<Input[K], Output[K], BaseSchemaDef<Input[K]>>; }) => KObject<Input, Output>;
     scalar: <ClientRepresentation extends JSONPrimitive, ServerRepresentation>(options: ScalarOptions<ClientRepresentation, ServerRepresentation>) => KScalar<ClientRepresentation, ServerRepresentation>;
     literal: <Value extends string | number | boolean>(value: Value) => KLiteral<Value>;

package/dist/schema/schema.d.ts

@@ -61,6 +61,10 @@ declare abstract class BaseSchema<Input extends JSONValue, Output, Def extends B
     example(): Input | undefined;
     description(description: string): this;
     description(): string | undefined;
+    /**
+     * Traverse immediate children schemas.
+     */
+    abstract visit(visitor: (schema: BaseSchema<any, any, any>) => void): void;
 }
 type Check<T extends string, P extends {} = {}> = {
     type: T;
@@ -142,6 +146,7 @@ declare class KString extends BaseSchema<string, string, StringDef> {
     hostname(message?: string): this;
     parseSafe(json: unknown): ParseResult<string>;
     parse(json: unknown): string;
+    visit(): void;
 }
 type NumberFormat = 'float' | 'double' | 'int32' | 'int64';
 interface NumberChecks {
@@ -176,6 +181,7 @@ declare class KNumber extends BaseSchema<number, number, NumberDef> {
     int64(): this;
     parseSafe(json: unknown): ParseResult<number>;
     parse(json: unknown): number;
+    visit(): void;
 }
 interface BooleanDef extends BaseSchemaDef<boolean> {
 }
@@ -185,6 +191,7 @@ declare class KBoolean extends BaseSchema<boolean, boolean, BooleanDef> {
     toOpenAPI(): SchemaObject | ReferenceObject;
     parseSafe(json: unknown): ParseResult<boolean>;
     parse(json: unknown): boolean;
+    visit(): void;
 }
 interface ArrayChecks {
     minItems?: Check<'minItems', {
@@ -211,6 +218,7 @@ declare class KArray<Input extends JSONValue, Output> extends BaseSchema<Input[]
     notUnique(): this;
     parseSafe(json: unknown): ParseResult<Output[]>;
     parse(json: unknown): Output[];
+    visit(visitor: (schema: BaseSchema<any, any, any>) => void): void;
 }
 interface NullDef extends BaseSchemaDef<null> {
 }
@@ -220,6 +228,7 @@ declare class KNull extends BaseSchema<null, null, NullDef> {
     toOpenAPI(): SchemaObject | ReferenceObject;
     parseSafe(json: unknown): ParseResult<null>;
     parse(json: unknown): null;
+    visit(): void;
 }
 interface ObjectDef<Input extends Record<keyof Output, JSONValue>, Output extends Record<keyof Input, JSONValue>> extends BaseSchemaDef<Input> {
     shape: {
@@ -233,6 +242,7 @@ declare class KObject<Input extends Record<keyof Output, JSONValue>, Output exte
     parseSafe(json: unknown): ParseResult<Output>;
     parse(json: unknown): Output;
     get shape(): { [K in keyof Input]: BaseSchema<Input[K], Output[K], BaseSchemaDef<Input[K]>>; };
+    visit(visitor: (schema: BaseSchema<any, any, any>) => void): void;
 }
 declare class KObjectFromURLSearchParams<Input extends Record<keyof Output, JSONValue>, Output extends Record<keyof Input, JSONValue>> extends KObject<Input, Output> {
     static create: <Input_1 extends Record<keyof Output_1, JSONValue>, Output_1 extends Record<keyof Input_1, JSONValue>>(shape: { [K in keyof Input_1 | keyof Output_1]: BaseSchema<Input_1[K], Output_1[K], BaseSchemaDef<Input_1[K]>>; }) => KObjectFromURLSearchParams<Input_1, Output_1>;
@@ -244,9 +254,10 @@ interface RefDef<Input extends Record<keyof Output, JSONValue>, Output extends R
     name: string;
     summary?: string | undefined;
 }
-declare class KRef<Input extends Record<keyof Output, JSONValue>, Output extends Record<keyof Input, JSONValue>> extends BaseSchema<Input, Output, RefDef<Input, Output>> {
-    static create: <Input_1 extends Record<keyof Output_1, JSONValue>, Output_1 extends Record<keyof Input_1, JSONValue>>(name: string, shape: { [K in keyof Input_1 | keyof Output_1]: BaseSchema<Input_1[K], Output_1[K], BaseSchemaDef<Input_1[K]>>; }) => KRef<Input_1, Output_1>;
+declare class KRef<Input extends Record<keyof Output, JSONValue>, Output extends Record<keyof Input, any>> extends BaseSchema<Input, Output, RefDef<Input, Output>> {
+    static create: <Input_1 extends Record<keyof Output_1, JSONValue>, Output_1 extends Record<keyof Input_1, any>>(name: string, shape: { [K in keyof Input_1 | keyof Output_1]: BaseSchema<Input_1[K], Output_1[K], BaseSchemaDef<Input_1[K]>>; }) => KRef<Input_1, Output_1>;
     serialize(value: Output): Input;
+    visit(visitor: (schema: BaseSchema<any, any, any>) => void): void;
     example(): never;
     toOpenAPI(): ReferenceObject;
     parseSafe(json: unknown): ParseResult<Output>;
@@ -282,11 +293,8 @@ declare class KScalar<ClientRepresentation extends JSONPrimitive, ServerRepresen
     serialize(value: ServerRepresentation): ClientRepresentation;
     toOpenAPI(): SchemaObject | ReferenceObject;
     parseSafe(json: unknown): ParseResult<ServerRepresentation>;
-    example(example: ClientRepresentation): this;
-    example(): ClientRepresentation | undefined;
-    description(description: string): this;
-    description(): string | undefined;
     parse(json: unknown): ServerRepresentation;
+    visit(visitor: (schema: BaseSchema<any, any, any>) => void): void;
 }
 interface UnionDef<Input extends JSONValue, Output> extends BaseSchemaDef<Input> {
     items: [
@@ -301,6 +309,7 @@ declare class KUnion<Input extends JSONValue, Output> extends BaseSchema<Input,
     toOpenAPI(): SchemaObject | ReferenceObject;
     parseSafe(json: unknown): ParseResult<Output>;
     parse(json: unknown): Output;
+    visit(visitor: (schema: BaseSchema<any, any, any>) => void): void;
 }
 interface LiteralDef<Value extends string | number | boolean> extends BaseSchemaDef<Value> {
     value: Value;
@@ -311,6 +320,7 @@ declare class KLiteral<Value extends string | number | boolean> extends BaseSche
     serialize(value: Value): Value;
     toOpenAPI(): SchemaObject;
     parseSafe(json: unknown): ParseResult<Value>;
+    visit(): void;
 }
 declare const k: {
     string: () => KString;
@@ -318,7 +328,7 @@ declare const k: {
     boolean: () => KBoolean;
     array: <ItemsInput extends JSONValue, ItemsOutput, Def extends BaseSchemaDef<ItemsInput>>(items: BaseSchema<ItemsInput, ItemsOutput, Def>) => KArray<ItemsInput, ItemsOutput>;
     null: () => KNull;
-    ref: <Input extends Record<keyof Output, JSONValue>, Output extends Record<keyof Input, JSONValue>>(name: string, shape: { [K in keyof Input | keyof Output]: BaseSchema<Input[K], Output[K], BaseSchemaDef<Input[K]>>; }) => KRef<Input, Output>;
+    ref: <Input extends Record<keyof Output, JSONValue>, Output extends Record<keyof Input, any>>(name: string, shape: { [K in keyof Input | keyof Output]: BaseSchema<Input[K], Output[K], BaseSchemaDef<Input[K]>>; }) => KRef<Input, Output>;
     object: <Input extends Record<keyof Output, any>, Output extends Record<keyof Input, any>>(shape: { [K in keyof Input | keyof Output]: BaseSchema<Input[K], Output[K], BaseSchemaDef<Input[K]>>; }) => KObject<Input, Output>;
     scalar: <ClientRepresentation extends JSONPrimitive, ServerRepresentation>(options: ScalarOptions<ClientRepresentation, ServerRepresentation>) => KScalar<ClientRepresentation, ServerRepresentation>;
     literal: <Value extends string | number | boolean>(value: Value) => KLiteral<Value>;

package/dist/schema/schema.js

@@ -16,7 +16,7 @@ import {
   SchemaError,
   isPrimitiveJSONValue,
   k
-} from "../chunk-TL3E52YN.js";
+} from "../chunk-IEGYJT4R.js";
 export {
   BaseSchema,
   KArray,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@kaito-http/core",
   "type": "module",
-  "version": "4.0.0-beta.21",
+  "version": "4.0.0-beta.24",
   "author": "Alistair Smith <hi@alistair.sh>",
   "repository": "https://github.com/kaito-http/kaito",
   "dependencies": {