[{"data":1,"prerenderedAt":1075},["ShallowReactive",2],{"page:\u002Fextensions\u002Fkubb-labs\u002Fplugin-valibot\u002Fguides\u002Fcustomization":3},{"id":4,"frontmatter":5,"title":6,"heading":6,"body":7,"path":1074,"source":4},"extensions\u002Fkubb-labs\u002Fplugin-valibot\u002Fguides\u002Fcustomization.md",{},"Customize generated schemas",{"type":8,"value":9,"toc":1060},"minimark",[10,14,33,38,53,280,285,289,300,580,590,594,631,646,650,660],[11,12,13],"p",{},"Prefix inferred types, change Valibot calls, and encode custom request types.",[11,15,16,17,21,22,27,28,32],{},"Add each change to ",[18,19,20],"code",{},"pluginValibot()"," in the ",[23,24,26],"a",{"href":25},"https:\u002F\u002Fkubb.dev\u002Fextensions\u002Fkubb-labs\u002Fplugin-valibot#example","Valibot plugin configuration",". ",[23,29,31],{"href":30},"https:\u002F\u002Fkubb.dev\u002Fextensions\u002Fkubb-labs\u002Fplugin-valibot\u002Foptions#format-and-type-mappings","Format and type mappings"," covers the default Valibot calls.",[34,35,37],"h2",{"id":36},"prefix-inferred-types","Prefix inferred types",[11,39,40,41,44,45,48,49,52],{},"Turn on ",[18,42,43],{},"inferred"," and override ",[18,46,47],{},"resolver.schema.typeName",". The callback receives the schema name, such as ",[18,50,51],{},"Pet",", and returns the type name.",[54,55,56,208,249],"code-group",{},[57,58,63],"pre",{"language":59,"filename":60,"code":61,"class":62},"typescript","kubb.config.ts","import { pluginValibot } from '@kubb\u002Fplugin-valibot'\n\npluginValibot({\n  inferred: true,\n  resolver: {\n    schema: {\n      typeName(name) {\n        return 'Api' + name\n      },\n    },\n  },\n})","highlights",[18,64,66,93,94,93,96,93,105,93,121,93,133,93,145,93,162,93,178,93,187,93,195,93,203],{"class":65},"language-typescript",[67,68,71,75,79,83,86,89],"span",{"class":69,"style":70},"line","display: inline",[67,72,74],{"style":73},"color:#d73a49;--hls-dark:#f97583","import ",[67,76,78],{"style":77},"color:#005cc5;--hls-dark:#79b8ff","{ ",[67,80,82],{"style":81},"color:#24292e;--hls-dark:#e1e4e8","pluginValibot ",[67,84,85],{"style":77},"} ",[67,87,88],{"style":73},"from ",[67,90,92],{"style":91},"color:#032f62;--hls-dark:#9ecbff","'@kubb\u002Fplugin-valibot'","\n",[67,95],{"class":69,"style":70},[67,97,98,102],{"class":69,"style":70},[67,99,101],{"style":100},"color:#6f42c1;--hls-dark:#b392f0","pluginValibot",[67,103,104],{"style":77},"({",[67,106,107,110,112,115,118],{"class":69,"style":70},[67,108,109],{"style":77},"  ",[67,111,43],{"style":77},[67,113,114],{"style":73},": ",[67,116,117],{"style":77},"true",[67,119,120],{"style":73},",",[67,122,123,125,128,130],{"class":69,"style":70},[67,124,109],{"style":73},[67,126,127],{"style":77},"resolver",[67,129,114],{"style":73},[67,131,132],{"style":77},"{",[67,134,135,138,141,143],{"class":69,"style":70},[67,136,137],{"style":77},"    ",[67,139,140],{"style":77},"schema",[67,142,114],{"style":73},[67,144,132],{"style":77},[67,146,147,150,153,156,159],{"class":69,"style":70},[67,148,149],{"style":77},"      ",[67,151,152],{"style":100},"typeName",[67,154,155],{"style":77},"(",[67,157,158],{"style":81},"name",[67,160,161],{"style":77},") {",[67,163,164,167,170,173,176],{"class":69,"style":70},[67,165,166],{"style":77},"        ",[67,168,169],{"style":73},"return ",[67,171,172],{"style":91},"'Api' ",[67,174,175],{"style":73},"+ ",[67,177,158],{"style":81},[67,179,180,182,185],{"class":69,"style":70},[67,181,149],{"style":81},[67,183,184],{"style":77},"}",[67,186,120],{"style":73},[67,188,189,191,193],{"class":69,"style":70},[67,190,137],{"style":73},[67,192,184],{"style":77},[67,194,120],{"style":73},[67,196,197,199,201],{"class":69,"style":70},[67,198,109],{"style":73},[67,200,184],{"style":77},[67,202,120],{"style":73},[67,204,205],{"class":69,"style":70},[67,206,207],{"style":77},"})",[57,209,212],{"language":59,"filename":210,"code":211,"class":62},"Before","export type PetSchemaType = v.InferOutput\u003Ctypeof petSchema>",[18,213,214],{"class":65},[67,215,216,219,222,225,228,231,234,237,240,243,246],{"class":69,"style":70},[67,217,218],{"style":73},"export ",[67,220,221],{"style":73},"type ",[67,223,224],{"style":100},"PetSchemaType ",[67,226,227],{"style":73},"= ",[67,229,230],{"style":81},"v",[67,232,233],{"style":73},".",[67,235,236],{"style":77},"InferOutput",[67,238,239],{"style":73},"\u003C",[67,241,242],{"style":73},"typeof ",[67,244,245],{"style":81},"petSchema",[67,247,248],{"style":73},">",[57,250,253],{"language":59,"filename":251,"code":252,"class":62},"After","export type ApiPet = v.InferOutput\u003Ctypeof petSchema>",[18,254,255],{"class":65},[67,256,257,259,261,264,266,268,270,272,274,276,278],{"class":69,"style":70},[67,258,218],{"style":73},[67,260,221],{"style":73},[67,262,263],{"style":100},"ApiPet ",[67,265,227],{"style":73},[67,267,230],{"style":81},[67,269,233],{"style":73},[67,271,236],{"style":77},[67,273,239],{"style":73},[67,275,242],{"style":73},[67,277,245],{"style":81},[67,279,248],{"style":73},[11,281,282,283,233],{},"The schema constant stays ",[18,284,245],{},[34,286,288],{"id":287},"use-numbers-for-int64-fields","Use numbers for int64 fields",[11,290,291,292,295,296,299],{},"Replace the ",[18,293,294],{},"bigint"," printer handler to validate ",[18,297,298],{},"int64"," fields as integers.",[54,301,302,397,539],{},[57,303,305],{"language":59,"filename":60,"code":304,"class":62},"import { pluginValibot } from '@kubb\u002Fplugin-valibot'\n\npluginValibot({\n  printer: {\n    nodes: {\n      bigint() {\n        return 'v.pipe(v.number(), v.integer())'\n      },\n    },\n  },\n})",[18,306,307,93,321,93,323,93,329,93,340,93,351,93,360,93,369,93,377,93,385,93,393],{"class":65},[67,308,309,311,313,315,317,319],{"class":69,"style":70},[67,310,74],{"style":73},[67,312,78],{"style":77},[67,314,82],{"style":81},[67,316,85],{"style":77},[67,318,88],{"style":73},[67,320,92],{"style":91},[67,322],{"class":69,"style":70},[67,324,325,327],{"class":69,"style":70},[67,326,101],{"style":100},[67,328,104],{"style":77},[67,330,331,333,336,338],{"class":69,"style":70},[67,332,109],{"style":77},[67,334,335],{"style":77},"printer",[67,337,114],{"style":73},[67,339,132],{"style":77},[67,341,342,344,347,349],{"class":69,"style":70},[67,343,137],{"style":77},[67,345,346],{"style":77},"nodes",[67,348,114],{"style":73},[67,350,132],{"style":77},[67,352,353,355,357],{"class":69,"style":70},[67,354,149],{"style":77},[67,356,294],{"style":100},[67,358,359],{"style":77},"() {",[67,361,362,364,366],{"class":69,"style":70},[67,363,166],{"style":77},[67,365,169],{"style":73},[67,367,368],{"style":91},"'v.pipe(v.number(), v.integer())'",[67,370,371,373,375],{"class":69,"style":70},[67,372,149],{"style":91},[67,374,184],{"style":77},[67,376,120],{"style":73},[67,378,379,381,383],{"class":69,"style":70},[67,380,137],{"style":73},[67,382,184],{"style":77},[67,384,120],{"style":73},[67,386,387,389,391],{"class":69,"style":70},[67,388,109],{"style":73},[67,390,184],{"style":77},[67,392,120],{"style":73},[67,394,395],{"class":69,"style":70},[67,396,207],{"style":77},[57,398,400],{"language":59,"filename":210,"code":399,"class":62},"id: v.pipe(\n  v.union([v.bigint(), v.number(), v.string()]),\n  v.toBigint(),\n  v.minValue(BigInt('-9223372036854775808')),\n  v.maxValue(BigInt('9223372036854775807')),\n),",[18,401,402,93,418,93,467,93,482,93,508,93,532],{"class":65},[67,403,404,407,409,411,413,416],{"class":69,"style":70},[67,405,406],{"style":81},"id",[67,408,114],{"style":73},[67,410,230],{"style":81},[67,412,233],{"style":73},[67,414,415],{"style":100},"pipe",[67,417,155],{"style":77},[67,419,420,422,424,426,429,432,434,436,438,441,444,446,448,451,453,455,457,459,462,465],{"class":69,"style":70},[67,421,109],{"style":77},[67,423,230],{"style":81},[67,425,233],{"style":73},[67,427,428],{"style":100},"union",[67,430,431],{"style":77},"([",[67,433,230],{"style":81},[67,435,233],{"style":73},[67,437,294],{"style":100},[67,439,440],{"style":77},"()",[67,442,443],{"style":73},", ",[67,445,230],{"style":81},[67,447,233],{"style":73},[67,449,450],{"style":100},"number",[67,452,440],{"style":77},[67,454,443],{"style":73},[67,456,230],{"style":81},[67,458,233],{"style":73},[67,460,461],{"style":100},"string",[67,463,464],{"style":77},"()])",[67,466,120],{"style":73},[67,468,469,471,473,475,478,480],{"class":69,"style":70},[67,470,109],{"style":73},[67,472,230],{"style":81},[67,474,233],{"style":73},[67,476,477],{"style":100},"toBigint",[67,479,440],{"style":77},[67,481,120],{"style":73},[67,483,484,486,488,490,493,495,498,500,503,506],{"class":69,"style":70},[67,485,109],{"style":73},[67,487,230],{"style":81},[67,489,233],{"style":73},[67,491,492],{"style":100},"minValue",[67,494,155],{"style":77},[67,496,497],{"style":100},"BigInt",[67,499,155],{"style":77},[67,501,502],{"style":91},"'-9223372036854775808'",[67,504,505],{"style":77},"))",[67,507,120],{"style":73},[67,509,510,512,514,516,519,521,523,525,528,530],{"class":69,"style":70},[67,511,109],{"style":73},[67,513,230],{"style":81},[67,515,233],{"style":73},[67,517,518],{"style":100},"maxValue",[67,520,155],{"style":77},[67,522,497],{"style":100},[67,524,155],{"style":77},[67,526,527],{"style":91},"'9223372036854775807'",[67,529,505],{"style":77},[67,531,120],{"style":73},[67,533,534,537],{"class":69,"style":70},[67,535,536],{"style":77},")",[67,538,120],{"style":73},[57,540,542],{"language":59,"filename":251,"code":541,"class":62},"id: v.pipe(v.number(), v.integer()),",[18,543,544],{"class":65},[67,545,546,548,550,552,554,556,558,560,562,564,566,568,570,572,575,578],{"class":69,"style":70},[67,547,406],{"style":81},[67,549,114],{"style":73},[67,551,230],{"style":81},[67,553,233],{"style":73},[67,555,415],{"style":100},[67,557,155],{"style":77},[67,559,230],{"style":81},[67,561,233],{"style":73},[67,563,450],{"style":100},[67,565,440],{"style":77},[67,567,443],{"style":73},[67,569,230],{"style":81},[67,571,233],{"style":73},[67,573,574],{"style":100},"integer",[67,576,577],{"style":77},"())",[67,579,120],{"style":73},[11,581,582,583,589],{},"To change the TypeScript type as well, set ",[23,584,586],{"href":585},"https:\u002F\u002Fkubb.dev\u002Fextensions\u002Fkubb-labs\u002Fadapter-oas\u002Foptions#integertype",[18,587,588],{},"integerType: 'number'"," on the adapter.",[34,591,593],{"id":592},"remove-descriptions","Remove descriptions",[11,595,596,597,443,600,603,604,607,608,443,611,614,615,618,619,623,624,627,628,630],{},"A schema with a ",[18,598,599],{},"title",[18,601,602],{},"description",", or ",[18,605,606],{},"examples"," in the spec carries them as ",[18,609,610],{},"v.title()",[18,612,613],{},"v.description()",", and ",[18,616,617],{},"v.metadata({ examples })",". The description is also the JSDoc comment above the schema const, so an editor shows it on hover. Pass the ",[23,620,622],{"href":621},"https:\u002F\u002Fkubb.dev\u002Fextensions\u002Fkubb-labs\u002Fplugin-ts\u002Fguides\u002Fcustomization#remove-descriptions","description-removal macro"," to ",[18,625,626],{},"pluginValibot({ macros: [dropDescriptions] })"," to leave out the ",[18,629,613],{}," calls.",[632,633,635,636,639,640,642,643,645],"blockquote",{"as":634},"note","A ",[18,637,638],{},"$ref"," to a described component keeps its ",[18,641,613],{}," call, because a macro does not visit the schema a ",[18,644,638],{}," points to.",[34,647,649],{"id":648},"encode-custom-types","Encode custom types",[11,651,652,653,656,657,233],{},"A printer handler that reads ",[18,654,655],{},"this.options.direction"," decodes response values and encodes request values. This example converts ISO time strings to ",[18,658,659],{},"Temporal.PlainTime",[661,662,664,669,680,820,840,844,850,1046,1050],"steps",{"level":663},"3",[665,666,668],"h3",{"id":667},"write-a-direction-aware-handler","Write a direction-aware handler",[11,670,671,672,675,676,679],{},"Return one expression for ",[18,673,674],{},"'encode'"," (request bodies and parameters) and another for ",[18,677,678],{},"'decode'"," (responses).",[57,681,683],{"language":59,"filename":60,"code":682,"class":62},"import { pluginValibot } from '@kubb\u002Fplugin-valibot'\n\npluginValibot({\n  inferred: true,\n  printer: {\n    nodes: {\n      time() {\n        return this.options.direction === 'encode'\n          ? 'v.pipe(v.instance(Temporal.PlainTime), v.transform((value) => value.toString()))'\n          : 'v.pipe(v.string(), v.isoTime(), v.transform((value) => Temporal.PlainTime.from(value)))'\n      },\n    },\n  },\n})",[18,684,685,93,699,93,701,93,707,93,719,93,729,93,739,93,748,93,772,93,783,93,792,93,800,93,808,93,816],{"class":65},[67,686,687,689,691,693,695,697],{"class":69,"style":70},[67,688,74],{"style":73},[67,690,78],{"style":77},[67,692,82],{"style":81},[67,694,85],{"style":77},[67,696,88],{"style":73},[67,698,92],{"style":91},[67,700],{"class":69,"style":70},[67,702,703,705],{"class":69,"style":70},[67,704,101],{"style":100},[67,706,104],{"style":77},[67,708,709,711,713,715,717],{"class":69,"style":70},[67,710,109],{"style":77},[67,712,43],{"style":77},[67,714,114],{"style":73},[67,716,117],{"style":77},[67,718,120],{"style":73},[67,720,721,723,725,727],{"class":69,"style":70},[67,722,109],{"style":73},[67,724,335],{"style":77},[67,726,114],{"style":73},[67,728,132],{"style":77},[67,730,731,733,735,737],{"class":69,"style":70},[67,732,137],{"style":77},[67,734,346],{"style":77},[67,736,114],{"style":73},[67,738,132],{"style":77},[67,740,741,743,746],{"class":69,"style":70},[67,742,149],{"style":77},[67,744,745],{"style":100},"time",[67,747,359],{"style":77},[67,749,750,752,754,757,759,762,764,767,770],{"class":69,"style":70},[67,751,166],{"style":77},[67,753,169],{"style":73},[67,755,756],{"style":81},"this",[67,758,233],{"style":73},[67,760,761],{"style":77},"options",[67,763,233],{"style":73},[67,765,766],{"style":77},"direction ",[67,768,769],{"style":73},"=== ",[67,771,674],{"style":91},[67,773,774,777,780],{"class":69,"style":70},[67,775,776],{"style":91},"          ",[67,778,779],{"style":73},"? ",[67,781,782],{"style":91},"'v.pipe(v.instance(Temporal.PlainTime), v.transform((value) => value.toString()))'",[67,784,785,787,789],{"class":69,"style":70},[67,786,776],{"style":91},[67,788,114],{"style":73},[67,790,791],{"style":91},"'v.pipe(v.string(), v.isoTime(), v.transform((value) => Temporal.PlainTime.from(value)))'",[67,793,794,796,798],{"class":69,"style":70},[67,795,149],{"style":91},[67,797,184],{"style":77},[67,799,120],{"style":73},[67,801,802,804,806],{"class":69,"style":70},[67,803,137],{"style":73},[67,805,184],{"style":77},[67,807,120],{"style":73},[67,809,810,812,814],{"class":69,"style":70},[67,811,109],{"style":73},[67,813,184],{"style":77},[67,815,120],{"style":73},[67,817,818],{"class":69,"style":70},[67,819,207],{"style":77},[11,821,822,823,443,825,614,828,831,832,443,834,614,836,839],{},"The formats ",[18,824,745],{},[18,826,827],{},"date",[18,829,830],{},"date-time"," use the ",[18,833,745],{},[18,835,827],{},[18,837,838],{},"datetime"," handlers.",[665,841,843],{"id":842},"check-the-generated-schemas","Check the generated schemas",[11,845,846,847,849],{},"Kubb writes a response schema and an input schema, also for schemas reached through a ",[18,848,638],{},":",[57,851,854],{"language":59,"filename":852,"code":853,"class":62},"src\u002Fgen\u002Fvalibot\u002FslotSchema.ts","export const slotSchema = v.object({\n  startsAt: v.pipe(v.string(), v.isoTime(), v.transform((value) => Temporal.PlainTime.from(value))),\n})\n\nexport const slotInputSchema = v.object({\n  startsAt: v.pipe(v.instance(Temporal.PlainTime), v.transform((value) => value.toString())),\n})",[18,855,856,93,877,93,956,93,960,93,962,93,981,93,1042],{"class":65},[67,857,858,860,863,866,868,870,872,875],{"class":69,"style":70},[67,859,218],{"style":73},[67,861,862],{"style":73},"const ",[67,864,865],{"style":81},"slotSchema ",[67,867,227],{"style":73},[67,869,230],{"style":81},[67,871,233],{"style":73},[67,873,874],{"style":100},"object",[67,876,104],{"style":77},[67,878,879,881,884,886,888,890,892,894,896,898,900,902,904,906,908,911,913,915,917,919,922,925,928,931,934,937,939,942,944,947,949,951,954],{"class":69,"style":70},[67,880,109],{"style":77},[67,882,883],{"style":77},"startsAt",[67,885,114],{"style":73},[67,887,230],{"style":81},[67,889,233],{"style":73},[67,891,415],{"style":100},[67,893,155],{"style":77},[67,895,230],{"style":81},[67,897,233],{"style":73},[67,899,461],{"style":100},[67,901,440],{"style":77},[67,903,443],{"style":73},[67,905,230],{"style":81},[67,907,233],{"style":73},[67,909,910],{"style":100},"isoTime",[67,912,440],{"style":77},[67,914,443],{"style":73},[67,916,230],{"style":81},[67,918,233],{"style":73},[67,920,921],{"style":100},"transform",[67,923,924],{"style":77},"((",[67,926,927],{"style":81},"value",[67,929,930],{"style":77},") ",[67,932,933],{"style":73},"=> ",[67,935,936],{"style":100},"Temporal",[67,938,233],{"style":73},[67,940,941],{"style":77},"PlainTime",[67,943,233],{"style":73},[67,945,946],{"style":100},"from",[67,948,155],{"style":77},[67,950,927],{"style":81},[67,952,953],{"style":77},")))",[67,955,120],{"style":73},[67,957,958],{"class":69,"style":70},[67,959,207],{"style":77},[67,961],{"class":69,"style":70},[67,963,964,966,968,971,973,975,977,979],{"class":69,"style":70},[67,965,218],{"style":73},[67,967,862],{"style":73},[67,969,970],{"style":81},"slotInputSchema ",[67,972,227],{"style":73},[67,974,230],{"style":81},[67,976,233],{"style":73},[67,978,874],{"style":100},[67,980,104],{"style":77},[67,982,983,985,987,989,991,993,995,997,999,1001,1004,1006,1008,1010,1012,1014,1016,1018,1020,1022,1024,1026,1028,1030,1032,1034,1037,1040],{"class":69,"style":70},[67,984,109],{"style":77},[67,986,883],{"style":77},[67,988,114],{"style":73},[67,990,230],{"style":81},[67,992,233],{"style":73},[67,994,415],{"style":100},[67,996,155],{"style":77},[67,998,230],{"style":81},[67,1000,233],{"style":73},[67,1002,1003],{"style":100},"instance",[67,1005,155],{"style":77},[67,1007,936],{"style":100},[67,1009,233],{"style":73},[67,1011,941],{"style":77},[67,1013,536],{"style":77},[67,1015,443],{"style":73},[67,1017,230],{"style":81},[67,1019,233],{"style":73},[67,1021,921],{"style":100},[67,1023,924],{"style":77},[67,1025,927],{"style":81},[67,1027,930],{"style":77},[67,1029,933],{"style":73},[67,1031,927],{"style":81},[67,1033,233],{"style":73},[67,1035,1036],{"style":100},"toString",[67,1038,1039],{"style":77},"()))",[67,1041,120],{"style":73},[67,1043,1044],{"class":69,"style":70},[67,1045,207],{"style":77},[665,1047,1049],{"id":1048},"provide-temporal","Provide Temporal",[11,1051,1052,1053,1055,1056,1059],{},"The generated files use ",[18,1054,936],{}," as a global. Load a polyfill, such as ",[18,1057,1058],{},"temporal-polyfill\u002Fglobal",", before the schemas run where the runtime has none.",{"title":1061,"searchDepth":1062,"depth":1062,"links":1063},"",5,[1064,1066,1067,1068],{"id":36,"depth":1065,"text":37},2,{"id":287,"depth":1065,"text":288},{"id":592,"depth":1065,"text":593},{"id":648,"depth":1065,"text":649,"children":1069},[1070,1072,1073],{"id":667,"depth":1071,"text":668},3,{"id":842,"depth":1071,"text":843},{"id":1048,"depth":1071,"text":1049},"\u002Fextensions\u002Fkubb-labs\u002Fplugin-valibot\u002Fguides\u002Fcustomization",1795015656226]