@kaito-http/core 4.0.0-beta.15 → 4.0.0-beta.16

package/dist/{chunk-EPB3QL2T.js → chunk-ISGKY24N.js}

@@ -64,6 +64,16 @@ var BaseSchema = class {
   /** @internal */
   _output;
   def;
+  getSchemaObject() {
+    const schema = {};
+    if (this.def.description !== void 0) {
+      schema.description = this.def.description;
+    }
+    if (this.def.example !== void 0) {
+      schema.example = this.def.example;
+    }
+    return schema;
+  }
   clone(def) {
     return new this.constructor({
       ...this.def,
@@ -107,7 +117,9 @@ var KString = class _KString extends BaseSchema {
     return this.clone({ [check.type]: check });
   }
   toOpenAPI() {
+    const baseSchema = this.getSchemaObject();
     const schema = {
+      ...baseSchema,
       type: "string"
     };
     if (this.def.regex) {
@@ -122,9 +134,6 @@ var KString = class _KString extends BaseSchema {
     if (this.def.max !== void 0) {
       schema.maxLength = this.def.max.val;
     }
-    if (this.def.description) {
-      schema.description = this.def.description;
-    }
     return schema;
   }
   /**
@@ -296,7 +305,11 @@ var KNumber = class _KNumber extends BaseSchema {
     return this.clone({ [check.type]: check });
   }
   toOpenAPI() {
-    const schema = { type: "number" };
+    const baseSchema = this.getSchemaObject();
+    const schema = {
+      ...baseSchema,
+      type: "number"
+    };
     if (this.def.min !== void 0) {
       schema.minimum = this.def.min.val;
     }
@@ -332,9 +345,6 @@ var KNumber = class _KNumber extends BaseSchema {
     if (this.def.format) {
       schema.format = this.def.format.format;
     }
-    if (this.def.description) {
-      schema.description = this.def.description;
-    }
     return schema;
   }
   min(min) {
@@ -398,9 +408,10 @@ var KBoolean = class _KBoolean extends BaseSchema {
     return value;
   }
   toOpenAPI() {
+    const baseSchema = this.getSchemaObject();
     return {
-      type: "boolean",
-      ...this.def.description ? { description: this.def.description } : {}
+      ...baseSchema,
+      type: "boolean"
     };
   }
   parseSafe(json) {
@@ -428,10 +439,11 @@ var KArray = class _KArray extends BaseSchema {
     return this.clone({ [check.type]: check });
   }
   toOpenAPI() {
+    const baseSchema = this.getSchemaObject();
     return {
+      ...baseSchema,
       type: "array",
       items: this.def.items.toOpenAPI(),
-      ...this.def.description ? { description: this.def.description } : {},
       ...this.def.minItems !== void 0 ? { minItems: this.def.minItems.val } : {},
       ...this.def.maxItems !== void 0 ? { maxItems: this.def.maxItems.val } : {},
       ...this.def.uniqueItems !== void 0 ? { uniqueItems: this.def.uniqueItems.val } : {}
@@ -490,9 +502,10 @@ var KNull = class _KNull extends BaseSchema {
     return value;
   }
   toOpenAPI() {
+    const baseSchema = this.getSchemaObject();
     return {
-      type: "null",
-      ...this.def.description ? { description: this.def.description } : {}
+      ...baseSchema,
+      type: "null"
     };
   }
   parseSafe(json) {
@@ -527,7 +540,9 @@ var KObject = class _KObject extends BaseSchema {
     return result;
   }
   toOpenAPI() {
+    const baseSchema = this.getSchemaObject();
     return {
+      ...baseSchema,
       type: "object",
       properties: Object.fromEntries(
         Object.entries(this.def.shape).map((entry) => {
@@ -535,8 +550,7 @@ var KObject = class _KObject extends BaseSchema {
           return [key, value.toOpenAPI()];
         })
       ),
-      required: Object.keys(this.def.shape),
-      ...this.def.description ? { description: this.def.description } : {}
+      required: Object.keys(this.def.shape)
     };
   }
   parseSafe(json) {
@@ -618,6 +632,9 @@ var KRef = class _KRef extends BaseSchema {
     }
     return result;
   }
+  example() {
+    throw new Error("Cannot set an example on a KRef");
+  }
   toOpenAPI() {
     return {
       $ref: `#/components/schemas/${this.def.name}`,
@@ -711,9 +728,10 @@ var KUnion = class _KUnion extends BaseSchema {
     throw new Error("Value does not match any union option for serialization");
   }
   toOpenAPI() {
+    const baseSchema = this.getSchemaObject();
     return {
-      oneOf: this.def.items.map((option) => option.toOpenAPI()),
-      ...this.def.description ? { description: this.def.description } : {}
+      ...baseSchema,
+      oneOf: this.def.items.map((option) => option.toOpenAPI())
     };
   }
   parseSafe(json) {
@@ -749,8 +767,13 @@ var KLiteral = class _KLiteral extends BaseSchema {
     return value;
   }
   toOpenAPI() {
+    const baseSchema = this.getSchemaObject();
     const type = typeof this.def.value;
-    return { type, enum: [this.def.value] };
+    return {
+      ...baseSchema,
+      type,
+      enum: [this.def.value]
+    };
   }
   parseSafe(json) {
     return ParseContext.result((ctx) => {

package/dist/index.cjs

@@ -222,6 +222,16 @@ var BaseSchema = class {
   /** @internal */
   _output;
   def;
+  getSchemaObject() {
+    const schema = {};
+    if (this.def.description !== void 0) {
+      schema.description = this.def.description;
+    }
+    if (this.def.example !== void 0) {
+      schema.example = this.def.example;
+    }
+    return schema;
+  }
   clone(def) {
     return new this.constructor({
       ...this.def,
@@ -265,7 +275,9 @@ var KString = class _KString extends BaseSchema {
     return this.clone({ [check.type]: check });
   }
   toOpenAPI() {
+    const baseSchema = this.getSchemaObject();
     const schema = {
+      ...baseSchema,
       type: "string"
     };
     if (this.def.regex) {
@@ -280,9 +292,6 @@ var KString = class _KString extends BaseSchema {
     if (this.def.max !== void 0) {
       schema.maxLength = this.def.max.val;
     }
-    if (this.def.description) {
-      schema.description = this.def.description;
-    }
     return schema;
   }
   /**
@@ -454,7 +463,11 @@ var KNumber = class _KNumber extends BaseSchema {
     return this.clone({ [check.type]: check });
   }
   toOpenAPI() {
-    const schema = { type: "number" };
+    const baseSchema = this.getSchemaObject();
+    const schema = {
+      ...baseSchema,
+      type: "number"
+    };
     if (this.def.min !== void 0) {
       schema.minimum = this.def.min.val;
     }
@@ -490,9 +503,6 @@ var KNumber = class _KNumber extends BaseSchema {
     if (this.def.format) {
       schema.format = this.def.format.format;
     }
-    if (this.def.description) {
-      schema.description = this.def.description;
-    }
     return schema;
   }
   min(min) {
@@ -556,9 +566,10 @@ var KBoolean = class _KBoolean extends BaseSchema {
     return value;
   }
   toOpenAPI() {
+    const baseSchema = this.getSchemaObject();
     return {
-      type: "boolean",
-      ...this.def.description ? { description: this.def.description } : {}
+      ...baseSchema,
+      type: "boolean"
     };
   }
   parseSafe(json) {
@@ -586,10 +597,11 @@ var KArray = class _KArray extends BaseSchema {
     return this.clone({ [check.type]: check });
   }
   toOpenAPI() {
+    const baseSchema = this.getSchemaObject();
     return {
+      ...baseSchema,
       type: "array",
       items: this.def.items.toOpenAPI(),
-      ...this.def.description ? { description: this.def.description } : {},
       ...this.def.minItems !== void 0 ? { minItems: this.def.minItems.val } : {},
       ...this.def.maxItems !== void 0 ? { maxItems: this.def.maxItems.val } : {},
       ...this.def.uniqueItems !== void 0 ? { uniqueItems: this.def.uniqueItems.val } : {}
@@ -648,9 +660,10 @@ var KNull = class _KNull extends BaseSchema {
     return value;
   }
   toOpenAPI() {
+    const baseSchema = this.getSchemaObject();
     return {
-      type: "null",
-      ...this.def.description ? { description: this.def.description } : {}
+      ...baseSchema,
+      type: "null"
     };
   }
   parseSafe(json) {
@@ -685,7 +698,9 @@ var KObject = class _KObject extends BaseSchema {
     return result;
   }
   toOpenAPI() {
+    const baseSchema = this.getSchemaObject();
     return {
+      ...baseSchema,
       type: "object",
       properties: Object.fromEntries(
         Object.entries(this.def.shape).map((entry) => {
@@ -693,8 +708,7 @@ var KObject = class _KObject extends BaseSchema {
           return [key, value.toOpenAPI()];
         })
       ),
-      required: Object.keys(this.def.shape),
-      ...this.def.description ? { description: this.def.description } : {}
+      required: Object.keys(this.def.shape)
     };
   }
   parseSafe(json) {
@@ -776,6 +790,9 @@ var KRef = class _KRef extends BaseSchema {
     }
     return result;
   }
+  example() {
+    throw new Error("Cannot set an example on a KRef");
+  }
   toOpenAPI() {
     return {
       $ref: `#/components/schemas/${this.def.name}`,
@@ -869,9 +886,10 @@ var KUnion = class _KUnion extends BaseSchema {
     throw new Error("Value does not match any union option for serialization");
   }
   toOpenAPI() {
+    const baseSchema = this.getSchemaObject();
     return {
-      oneOf: this.def.items.map((option) => option.toOpenAPI()),
-      ...this.def.description ? { description: this.def.description } : {}
+      ...baseSchema,
+      oneOf: this.def.items.map((option) => option.toOpenAPI())
     };
   }
   parseSafe(json) {
@@ -907,8 +925,13 @@ var KLiteral = class _KLiteral extends BaseSchema {
     return value;
   }
   toOpenAPI() {
+    const baseSchema = this.getSchemaObject();
     const type = typeof this.def.value;
-    return { type, enum: [this.def.value] };
+    return {
+      ...baseSchema,
+      type,
+      enum: [this.def.value]
+    };
   }
   parseSafe(json) {
     return ParseContext.result((ctx) => {

package/dist/index.js

@@ -16,7 +16,7 @@ import {
   SchemaError,
   isPrimitiveJSONValue,
   k
-} from "./chunk-EPB3QL2T.js";
+} from "./chunk-ISGKY24N.js";
 
 // src/router/router.ts
 import "openapi3-ts/oas31";

package/dist/schema/schema.cjs

@@ -104,6 +104,16 @@ var BaseSchema = class {
   /** @internal */
   _output;
   def;
+  getSchemaObject() {
+    const schema = {};
+    if (this.def.description !== void 0) {
+      schema.description = this.def.description;
+    }
+    if (this.def.example !== void 0) {
+      schema.example = this.def.example;
+    }
+    return schema;
+  }
   clone(def) {
     return new this.constructor({
       ...this.def,
@@ -147,7 +157,9 @@ var KString = class _KString extends BaseSchema {
     return this.clone({ [check.type]: check });
   }
   toOpenAPI() {
+    const baseSchema = this.getSchemaObject();
     const schema = {
+      ...baseSchema,
       type: "string"
     };
     if (this.def.regex) {
@@ -162,9 +174,6 @@ var KString = class _KString extends BaseSchema {
     if (this.def.max !== void 0) {
       schema.maxLength = this.def.max.val;
     }
-    if (this.def.description) {
-      schema.description = this.def.description;
-    }
     return schema;
   }
   /**
@@ -336,7 +345,11 @@ var KNumber = class _KNumber extends BaseSchema {
     return this.clone({ [check.type]: check });
   }
   toOpenAPI() {
-    const schema = { type: "number" };
+    const baseSchema = this.getSchemaObject();
+    const schema = {
+      ...baseSchema,
+      type: "number"
+    };
     if (this.def.min !== void 0) {
       schema.minimum = this.def.min.val;
     }
@@ -372,9 +385,6 @@ var KNumber = class _KNumber extends BaseSchema {
     if (this.def.format) {
       schema.format = this.def.format.format;
     }
-    if (this.def.description) {
-      schema.description = this.def.description;
-    }
     return schema;
   }
   min(min) {
@@ -438,9 +448,10 @@ var KBoolean = class _KBoolean extends BaseSchema {
     return value;
   }
   toOpenAPI() {
+    const baseSchema = this.getSchemaObject();
     return {
-      type: "boolean",
-      ...this.def.description ? { description: this.def.description } : {}
+      ...baseSchema,
+      type: "boolean"
     };
   }
   parseSafe(json) {
@@ -468,10 +479,11 @@ var KArray = class _KArray extends BaseSchema {
     return this.clone({ [check.type]: check });
   }
   toOpenAPI() {
+    const baseSchema = this.getSchemaObject();
     return {
+      ...baseSchema,
       type: "array",
       items: this.def.items.toOpenAPI(),
-      ...this.def.description ? { description: this.def.description } : {},
       ...this.def.minItems !== void 0 ? { minItems: this.def.minItems.val } : {},
       ...this.def.maxItems !== void 0 ? { maxItems: this.def.maxItems.val } : {},
       ...this.def.uniqueItems !== void 0 ? { uniqueItems: this.def.uniqueItems.val } : {}
@@ -530,9 +542,10 @@ var KNull = class _KNull extends BaseSchema {
     return value;
   }
   toOpenAPI() {
+    const baseSchema = this.getSchemaObject();
     return {
-      type: "null",
-      ...this.def.description ? { description: this.def.description } : {}
+      ...baseSchema,
+      type: "null"
     };
   }
   parseSafe(json) {
@@ -567,7 +580,9 @@ var KObject = class _KObject extends BaseSchema {
     return result;
   }
   toOpenAPI() {
+    const baseSchema = this.getSchemaObject();
     return {
+      ...baseSchema,
       type: "object",
       properties: Object.fromEntries(
         Object.entries(this.def.shape).map((entry) => {
@@ -575,8 +590,7 @@ var KObject = class _KObject extends BaseSchema {
           return [key, value.toOpenAPI()];
         })
       ),
-      required: Object.keys(this.def.shape),
-      ...this.def.description ? { description: this.def.description } : {}
+      required: Object.keys(this.def.shape)
     };
   }
   parseSafe(json) {
@@ -658,6 +672,9 @@ var KRef = class _KRef extends BaseSchema {
     }
     return result;
   }
+  example() {
+    throw new Error("Cannot set an example on a KRef");
+  }
   toOpenAPI() {
     return {
       $ref: `#/components/schemas/${this.def.name}`,
@@ -751,9 +768,10 @@ var KUnion = class _KUnion extends BaseSchema {
     throw new Error("Value does not match any union option for serialization");
   }
   toOpenAPI() {
+    const baseSchema = this.getSchemaObject();
     return {
-      oneOf: this.def.items.map((option) => option.toOpenAPI()),
-      ...this.def.description ? { description: this.def.description } : {}
+      ...baseSchema,
+      oneOf: this.def.items.map((option) => option.toOpenAPI())
     };
   }
   parseSafe(json) {
@@ -789,8 +807,13 @@ var KLiteral = class _KLiteral extends BaseSchema {
     return value;
   }
   toOpenAPI() {
+    const baseSchema = this.getSchemaObject();
     const type = typeof this.def.value;
-    return { type, enum: [this.def.value] };
+    return {
+      ...baseSchema,
+      type,
+      enum: [this.def.value]
+    };
   }
   parseSafe(json) {
     return ParseContext.result((ctx) => {

package/dist/schema/schema.d.cts

@@ -51,8 +51,9 @@ declare abstract class BaseSchema<Input extends JSONValue, Output, Def extends B
     abstract parse(json: unknown): Output;
     abstract parseSafe(json: unknown): ParseResult<Output>;
     abstract serialize(value: Output): Input;
-    abstract toOpenAPI(): SchemaObject | ReferenceObject;
     protected readonly def: Def;
+    abstract toOpenAPI(): SchemaObject | ReferenceObject;
+    protected getSchemaObject(): SchemaObject;
     protected clone(def: Partial<Def>): this;
     protected constructor(def: Def);
     or<OtherInput extends JSONValue, OtherOutput, Def extends BaseSchemaDef<OtherInput>>(other: BaseSchema<OtherInput, OtherOutput, Def>): KUnion<(this | BaseSchema<OtherInput, OtherOutput, Def>)["_input"], (this | BaseSchema<OtherInput, OtherOutput, Def>)["_output"]>;
@@ -246,6 +247,7 @@ interface RefDef<Input extends Record<keyof Output, JSONValue>, Output extends R
 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>;
     serialize(value: Output): Input;
+    example(): never;
     toOpenAPI(): ReferenceObject;
     parseSafe(json: unknown): ParseResult<Output>;
     parse(json: unknown): Output;

package/dist/schema/schema.d.ts

@@ -51,8 +51,9 @@ declare abstract class BaseSchema<Input extends JSONValue, Output, Def extends B
     abstract parse(json: unknown): Output;
     abstract parseSafe(json: unknown): ParseResult<Output>;
     abstract serialize(value: Output): Input;
-    abstract toOpenAPI(): SchemaObject | ReferenceObject;
     protected readonly def: Def;
+    abstract toOpenAPI(): SchemaObject | ReferenceObject;
+    protected getSchemaObject(): SchemaObject;
     protected clone(def: Partial<Def>): this;
     protected constructor(def: Def);
     or<OtherInput extends JSONValue, OtherOutput, Def extends BaseSchemaDef<OtherInput>>(other: BaseSchema<OtherInput, OtherOutput, Def>): KUnion<(this | BaseSchema<OtherInput, OtherOutput, Def>)["_input"], (this | BaseSchema<OtherInput, OtherOutput, Def>)["_output"]>;
@@ -246,6 +247,7 @@ interface RefDef<Input extends Record<keyof Output, JSONValue>, Output extends R
 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>;
     serialize(value: Output): Input;
+    example(): never;
     toOpenAPI(): ReferenceObject;
     parseSafe(json: unknown): ParseResult<Output>;
     parse(json: unknown): Output;

package/dist/schema/schema.js

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

package/package.json

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