[{"data":1,"prerenderedAt":2691},["ShallowReactive",2],{"page:\u002Fdocs\u002F5.x\u002Fmigrate\u002Ffrom-hey-api":3},{"id":4,"title":5,"body":6,"description":2674,"extension":2675,"frontmatter":2676,"heading":5,"meta":2682,"navigation":2684,"order":2663,"path":2685,"seo":2686,"sitemap":2687,"source":2688,"stem":2689,"__hash__":2690},"docs\u002Fdocs\u002F5.x\u002Fmigrate\u002Ffrom-hey-api.md","Move from HeyAPI to Kubb",{"type":7,"value":8,"toc":2658},"minimark",[9,13,20,45,50,53,474,478,483,611,615,744],[10,11,12],"p",{},"Start with the types, then replace one HeyAPI plugin at a time: the SDK and client, TanStack Query, and Zod. You can stop after any step.",[10,14,15,19],{},[16,17,18],"code",{},"@hey-api\u002Fopenapi-ts"," 0.99.0 fails on TypeScript 7, which Kubb supports.",[10,21,22,23,26,27,30,31,30,34,30,37,40,41,44],{},"The examples move a HeyAPI config that writes to ",[16,24,25],{},"src\u002Fclient"," with the ",[16,28,29],{},"@hey-api\u002Fclient-fetch",", ",[16,32,33],{},"@hey-api\u002Ftypescript",[16,35,36],{},"@hey-api\u002Fsdk",[16,38,39],{},"@tanstack\u002Freact-query",", and ",[16,42,43],{},"zod"," plugins.",[46,47,49],"h2",{"id":48},"the-config-before-and-after","The config, before and after",[10,51,52],{},"The Kubb config is the result of every step below. Each step adds one plugin to it.",[54,55,56,187],"code-group",{},[57,58,63],"pre",{"language":59,"filename":60,"code":61,"class":62},"typescript","openapi-ts.config.ts","import { defineConfig } from '@hey-api\u002Fopenapi-ts'\n\nexport default defineConfig({\n  input: '.\u002Fopenapi.yaml',\n  output: 'src\u002Fclient',\n  plugins: ['@hey-api\u002Fclient-fetch', '@hey-api\u002Ftypescript', '@hey-api\u002Fsdk', '@tanstack\u002Freact-query', 'zod'],\n})","highlights",[16,64,66,93,94,93,96,93,111,93,128,93,142,93,182],{"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","defineConfig ",[67,84,85],{"style":77},"} ",[67,87,88],{"style":73},"from ",[67,90,92],{"style":91},"color:#032f62;--hls-dark:#9ecbff","'@hey-api\u002Fopenapi-ts'","\n",[67,95],{"class":69,"style":70},[67,97,98,101,104,108],{"class":69,"style":70},[67,99,100],{"style":73},"export ",[67,102,103],{"style":73},"default ",[67,105,107],{"style":106},"color:#6f42c1;--hls-dark:#b392f0","defineConfig",[67,109,110],{"style":77},"({",[67,112,113,116,119,122,125],{"class":69,"style":70},[67,114,115],{"style":77},"  ",[67,117,118],{"style":77},"input",[67,120,121],{"style":73},": ",[67,123,124],{"style":91},"'.\u002Fopenapi.yaml'",[67,126,127],{"style":73},",",[67,129,130,132,135,137,140],{"class":69,"style":70},[67,131,115],{"style":73},[67,133,134],{"style":77},"output",[67,136,121],{"style":73},[67,138,139],{"style":91},"'src\u002Fclient'",[67,141,127],{"style":73},[67,143,144,146,149,151,154,157,159,162,164,167,169,172,174,177,180],{"class":69,"style":70},[67,145,115],{"style":73},[67,147,148],{"style":77},"plugins",[67,150,121],{"style":73},[67,152,153],{"style":77},"[",[67,155,156],{"style":91},"'@hey-api\u002Fclient-fetch'",[67,158,30],{"style":73},[67,160,161],{"style":91},"'@hey-api\u002Ftypescript'",[67,163,30],{"style":73},[67,165,166],{"style":91},"'@hey-api\u002Fsdk'",[67,168,30],{"style":73},[67,170,171],{"style":91},"'@tanstack\u002Freact-query'",[67,173,30],{"style":73},[67,175,176],{"style":91},"'zod'",[67,178,179],{"style":77},"]",[67,181,127],{"style":73},[67,183,184],{"class":69,"style":70},[67,185,186],{"style":77},"})",[57,188,191],{"language":59,"filename":189,"code":190,"class":62},"kubb.config.ts","import { defineConfig } from 'kubb\u002Fconfig'\nimport { adapterOas } from '@kubb\u002Fadapter-oas'\nimport { pluginFetch } from '@kubb\u002Fplugin-fetch'\nimport { pluginReactQuery } from '@kubb\u002Fplugin-react-query'\nimport { pluginTs } from '@kubb\u002Fplugin-ts'\nimport { pluginZod } from '@kubb\u002Fplugin-zod'\n\nexport default defineConfig({\n  input: '.\u002Fopenapi.yaml',\n  output: { path: '.\u002Fsrc\u002Fgen' },\n  adapter: adapterOas({ integerType: 'number' }),\n  plugins: [\n    pluginTs({ output: { path: 'types.ts' } }),\n    \u002F\u002F The Petstore URL is an example. Use your API's URL.\n    pluginFetch({ baseURL: 'https:\u002F\u002Fpetstore3.swagger.io\u002Fapi\u002Fv3', throwOnErrorDefault: false }),\n    pluginReactQuery(),\n    pluginZod(),\n  ],\n})",[16,192,193,93,208,93,224,93,240,93,256,93,272,93,288,93,290,93,300,93,312,93,335,93,362,93,372,93,400,93,408,93,439,93,451,93,462,93,470],{"class":65},[67,194,195,197,199,201,203,205],{"class":69,"style":70},[67,196,74],{"style":73},[67,198,78],{"style":77},[67,200,82],{"style":81},[67,202,85],{"style":77},[67,204,88],{"style":73},[67,206,207],{"style":91},"'kubb\u002Fconfig'",[67,209,210,212,214,217,219,221],{"class":69,"style":70},[67,211,74],{"style":73},[67,213,78],{"style":77},[67,215,216],{"style":81},"adapterOas ",[67,218,85],{"style":77},[67,220,88],{"style":73},[67,222,223],{"style":91},"'@kubb\u002Fadapter-oas'",[67,225,226,228,230,233,235,237],{"class":69,"style":70},[67,227,74],{"style":73},[67,229,78],{"style":77},[67,231,232],{"style":81},"pluginFetch ",[67,234,85],{"style":77},[67,236,88],{"style":73},[67,238,239],{"style":91},"'@kubb\u002Fplugin-fetch'",[67,241,242,244,246,249,251,253],{"class":69,"style":70},[67,243,74],{"style":73},[67,245,78],{"style":77},[67,247,248],{"style":81},"pluginReactQuery ",[67,250,85],{"style":77},[67,252,88],{"style":73},[67,254,255],{"style":91},"'@kubb\u002Fplugin-react-query'",[67,257,258,260,262,265,267,269],{"class":69,"style":70},[67,259,74],{"style":73},[67,261,78],{"style":77},[67,263,264],{"style":81},"pluginTs ",[67,266,85],{"style":77},[67,268,88],{"style":73},[67,270,271],{"style":91},"'@kubb\u002Fplugin-ts'",[67,273,274,276,278,281,283,285],{"class":69,"style":70},[67,275,74],{"style":73},[67,277,78],{"style":77},[67,279,280],{"style":81},"pluginZod ",[67,282,85],{"style":77},[67,284,88],{"style":73},[67,286,287],{"style":91},"'@kubb\u002Fplugin-zod'",[67,289],{"class":69,"style":70},[67,291,292,294,296,298],{"class":69,"style":70},[67,293,100],{"style":73},[67,295,103],{"style":73},[67,297,107],{"style":106},[67,299,110],{"style":77},[67,301,302,304,306,308,310],{"class":69,"style":70},[67,303,115],{"style":77},[67,305,118],{"style":77},[67,307,121],{"style":73},[67,309,124],{"style":91},[67,311,127],{"style":73},[67,313,314,316,318,320,322,325,327,330,333],{"class":69,"style":70},[67,315,115],{"style":73},[67,317,134],{"style":77},[67,319,121],{"style":73},[67,321,78],{"style":77},[67,323,324],{"style":77},"path",[67,326,121],{"style":73},[67,328,329],{"style":91},"'.\u002Fsrc\u002Fgen' ",[67,331,332],{"style":77},"}",[67,334,127],{"style":73},[67,336,337,339,342,344,347,350,353,355,358,360],{"class":69,"style":70},[67,338,115],{"style":73},[67,340,341],{"style":77},"adapter",[67,343,121],{"style":73},[67,345,346],{"style":106},"adapterOas",[67,348,349],{"style":77},"({ ",[67,351,352],{"style":77},"integerType",[67,354,121],{"style":73},[67,356,357],{"style":91},"'number' ",[67,359,186],{"style":77},[67,361,127],{"style":73},[67,363,364,366,368,370],{"class":69,"style":70},[67,365,115],{"style":73},[67,367,148],{"style":77},[67,369,121],{"style":73},[67,371,153],{"style":77},[67,373,374,377,380,382,384,386,388,390,392,395,398],{"class":69,"style":70},[67,375,376],{"style":77},"    ",[67,378,379],{"style":106},"pluginTs",[67,381,349],{"style":77},[67,383,134],{"style":77},[67,385,121],{"style":73},[67,387,78],{"style":77},[67,389,324],{"style":77},[67,391,121],{"style":73},[67,393,394],{"style":91},"'types.ts' ",[67,396,397],{"style":77},"} })",[67,399,127],{"style":73},[67,401,402,404],{"class":69,"style":70},[67,403,376],{"style":73},[67,405,407],{"style":406},"color:#6a737d;--hls-dark:#6a737d","\u002F\u002F The Petstore URL is an example. Use your API's URL.",[67,409,410,412,415,417,420,422,425,427,430,432,435,437],{"class":69,"style":70},[67,411,376],{"style":406},[67,413,414],{"style":106},"pluginFetch",[67,416,349],{"style":77},[67,418,419],{"style":77},"baseURL",[67,421,121],{"style":73},[67,423,424],{"style":91},"'https:\u002F\u002Fpetstore3.swagger.io\u002Fapi\u002Fv3'",[67,426,30],{"style":73},[67,428,429],{"style":77},"throwOnErrorDefault",[67,431,121],{"style":73},[67,433,434],{"style":77},"false ",[67,436,186],{"style":77},[67,438,127],{"style":73},[67,440,441,443,446,449],{"class":69,"style":70},[67,442,376],{"style":73},[67,444,445],{"style":106},"pluginReactQuery",[67,447,448],{"style":77},"()",[67,450,127],{"style":73},[67,452,453,455,458,460],{"class":69,"style":70},[67,454,376],{"style":73},[67,456,457],{"style":106},"pluginZod",[67,459,448],{"style":77},[67,461,127],{"style":73},[67,463,464,466,468],{"class":69,"style":70},[67,465,115],{"style":73},[67,467,179],{"style":77},[67,469,127],{"style":73},[67,471,472],{"class":69,"style":70},[67,473,186],{"style":77},[46,475,477],{"id":476},"what-maps-to-what","What maps to what",[479,480,482],"h3",{"id":481},"config-options","Config options",[484,485,486,499],"table",{},[487,488,489],"thead",{},[490,491,492,496],"tr",{},[493,494,495],"th",{},"HeyAPI",[493,497,498],{},"Kubb",[500,501,502,518,532,548,565,585,598],"tbody",{},[490,503,504,511],{},[505,506,507,30,509],"td",{},[16,508,118],{},[16,510,134],{},[505,512,513,30,515],{},[16,514,118],{},[16,516,517],{},"output.path",[490,519,520,524],{},[505,521,522],{},[16,523,33],{},[505,525,526],{},[527,528,530],"a",{"href":529},"\u002Fextensions\u002Fkubb-labs\u002Fplugin-ts",[16,531,379],{},[490,533,534,541],{},[505,535,536,538,539],{},[16,537,29],{}," with ",[16,540,36],{},[505,542,543],{},[527,544,546],{"href":545},"\u002Fextensions\u002Fkubb-labs\u002Fplugin-fetch",[16,547,414],{},[490,549,550,557],{},[505,551,552,538,555],{},[16,553,554],{},"@hey-api\u002Fclient-axios",[16,556,36],{},[505,558,559],{},[527,560,562],{"href":561},"\u002Fextensions\u002Fkubb-labs\u002Fplugin-axios",[16,563,564],{},"pluginAxios",[490,566,567,575],{},[505,568,569,572,573],{},[16,570,571],{},"validator: true"," on ",[16,574,36],{},[505,576,577,572,583],{},[527,578,580],{"href":579},"\u002Fextensions\u002Fkubb-labs\u002Fplugin-fetch\u002Foptions#validator",[16,581,582],{},"validator",[16,584,414],{},[490,586,587,591],{},[505,588,589],{},[16,590,39],{},[505,592,593],{},[527,594,596],{"href":595},"\u002Fextensions\u002Fkubb-labs\u002Fplugin-react-query",[16,597,445],{},[490,599,600,604],{},[505,601,602],{},[16,603,43],{},[505,605,606],{},[527,607,609],{"href":608},"\u002Fextensions\u002Fkubb-labs\u002Fplugin-zod",[16,610,457],{},[479,612,614],{"id":613},"generated-code","Generated code",[484,616,617,625],{},[487,618,619],{},[490,620,621,623],{},[493,622,495],{},[493,624,498],{},[500,626,627,639,651,663,673,685,702,714,726],{},[490,628,629,634],{},[505,630,631],{},[16,632,633],{},"GetPetByIdData",[505,635,636],{},[16,637,638],{},"GetPetByIdOptions",[490,640,641,646],{},[505,642,643],{},[16,644,645],{},"GetPetByIdData['path']",[505,647,648],{},[16,649,650],{},"GetPetByIdPath",[490,652,653,658],{},[505,654,655],{},[16,656,657],{},"GetPetByIdResponse",[505,659,660],{},[16,661,662],{},"GetPetByIdStatus200Json",[490,664,665,670],{},[505,666,667],{},[16,668,669],{},"getPetById({ path: { petId: 1 } })",[505,671,672],{},"Unchanged",[490,674,675,680],{},[505,676,677],{},[16,678,679],{},"client.setConfig({ baseUrl, auth })",[505,681,682],{},[16,683,684],{},"client.setConfig({ baseURL, auth })",[490,686,687,692],{},[505,688,689],{},[16,690,691],{},"client.interceptors.request.use()",[505,693,694,695,698,699],{},"The same call. Set a header with ",[16,696,697],{},"request.headers['X-Client'] = 'web'",", not ",[16,700,701],{},"request.headers.set()",[490,703,704,709],{},[505,705,706],{},[16,707,708],{},"getPetByIdOptions(...)",[505,710,711],{},[16,712,713],{},"getPetByIdQueryOptions(...)",[490,715,716,721],{},[505,717,718],{},[16,719,720],{},"addPetMutation()",[505,722,723],{},[16,724,725],{},"addPetMutationOptions()",[490,727,728,736],{},[505,729,730,30,733],{},[16,731,732],{},"zPet",[16,734,735],{},"zGetPetByIdPath",[505,737,738,30,741],{},[16,739,740],{},"petSchema",[16,742,743],{},"getPetByIdPathSchema",[745,746,748,752,779,927,934,1057,1075,1164,1167,1252,1255,1259,1266,1344,1359,1449,1469,1817,1820,1861,1917,1927,1931,1955,2030,2036,2317,2321,2341,2416,2428,2580,2596,2641,2645],"steps",{"level":747},"2",[46,749,751],{"id":750},"generate-the-types","Generate the types",[10,753,754,755,758,759,762,763,766,767,770,771,774,775,778],{},"Create this config. It writes every type into ",[16,756,757],{},"src\u002Fgen\u002Ftypes.ts",", like the single ",[16,760,761],{},"types.gen.ts"," from HeyAPI. ",[16,764,765],{},"integerType: 'number'"," keeps ",[16,768,769],{},"int64"," as ",[16,772,773],{},"number",", as HeyAPI does. Kubb's default is ",[16,776,777],{},"bigint",".",[57,780,782],{"language":59,"filename":189,"code":781,"class":62},"import { defineConfig } from 'kubb\u002Fconfig'\nimport { adapterOas } from '@kubb\u002Fadapter-oas'\nimport { pluginTs } from '@kubb\u002Fplugin-ts'\n\nexport default defineConfig({\n  input: '.\u002Fopenapi.yaml',\n  output: { path: '.\u002Fsrc\u002Fgen' },\n  adapter: adapterOas({ integerType: 'number' }),\n  plugins: [pluginTs({ output: { path: 'types.ts' } })],\n})",[16,783,784,93,798,93,812,93,826,93,828,93,838,93,850,93,870,93,892,93,923],{"class":65},[67,785,786,788,790,792,794,796],{"class":69,"style":70},[67,787,74],{"style":73},[67,789,78],{"style":77},[67,791,82],{"style":81},[67,793,85],{"style":77},[67,795,88],{"style":73},[67,797,207],{"style":91},[67,799,800,802,804,806,808,810],{"class":69,"style":70},[67,801,74],{"style":73},[67,803,78],{"style":77},[67,805,216],{"style":81},[67,807,85],{"style":77},[67,809,88],{"style":73},[67,811,223],{"style":91},[67,813,814,816,818,820,822,824],{"class":69,"style":70},[67,815,74],{"style":73},[67,817,78],{"style":77},[67,819,264],{"style":81},[67,821,85],{"style":77},[67,823,88],{"style":73},[67,825,271],{"style":91},[67,827],{"class":69,"style":70},[67,829,830,832,834,836],{"class":69,"style":70},[67,831,100],{"style":73},[67,833,103],{"style":73},[67,835,107],{"style":106},[67,837,110],{"style":77},[67,839,840,842,844,846,848],{"class":69,"style":70},[67,841,115],{"style":77},[67,843,118],{"style":77},[67,845,121],{"style":73},[67,847,124],{"style":91},[67,849,127],{"style":73},[67,851,852,854,856,858,860,862,864,866,868],{"class":69,"style":70},[67,853,115],{"style":73},[67,855,134],{"style":77},[67,857,121],{"style":73},[67,859,78],{"style":77},[67,861,324],{"style":77},[67,863,121],{"style":73},[67,865,329],{"style":91},[67,867,332],{"style":77},[67,869,127],{"style":73},[67,871,872,874,876,878,880,882,884,886,888,890],{"class":69,"style":70},[67,873,115],{"style":73},[67,875,341],{"style":77},[67,877,121],{"style":73},[67,879,346],{"style":106},[67,881,349],{"style":77},[67,883,352],{"style":77},[67,885,121],{"style":73},[67,887,357],{"style":91},[67,889,186],{"style":77},[67,891,127],{"style":73},[67,893,894,896,898,900,902,904,906,908,910,912,914,916,918,921],{"class":69,"style":70},[67,895,115],{"style":73},[67,897,148],{"style":77},[67,899,121],{"style":73},[67,901,153],{"style":77},[67,903,379],{"style":106},[67,905,349],{"style":77},[67,907,134],{"style":77},[67,909,121],{"style":73},[67,911,78],{"style":77},[67,913,324],{"style":77},[67,915,121],{"style":73},[67,917,394],{"style":91},[67,919,920],{"style":77},"} })]",[67,922,127],{"style":73},[67,924,925],{"class":69,"style":70},[67,926,186],{"style":77},[10,928,929,930,933],{},"Install the packages it imports. ",[16,931,932],{},"kubb add"," needs the config to exist, and leaves a plugin that is already in it unchanged:",[54,935,937,968,993,1014,1035],{"sync":936},"package-manager",[57,938,942],{"language":939,"filename":940,"code":941,"class":62},"shell","kubb","npm install -D kubb\nkubb add adapter-oas\nkubb add plugin-ts",[16,943,945,93,953,93,961],{"class":944},"language-shell",[67,946,947,950],{"class":69,"style":70},[67,948,949],{"style":106},"npm ",[67,951,952],{"style":81},"install -D kubb",[67,954,955,958],{"class":69,"style":70},[67,956,957],{"style":106},"kubb ",[67,959,960],{"style":81},"add adapter-oas",[67,962,963,965],{"class":69,"style":70},[67,964,957],{"style":106},[67,966,967],{"style":81},"add plugin-ts",[57,969,972],{"language":939,"filename":970,"code":971,"class":62},"pnpm","pnpm add -D kubb @kubb\u002Fadapter-oas @kubb\u002Fplugin-ts",[16,973,974],{"class":944},[67,975,976,979,982,985,988,990],{"class":69,"style":70},[67,977,978],{"style":106},"pnpm ",[67,980,981],{"style":81},"add -D kubb ",[67,983,984],{"style":81},"@",[67,986,987],{"style":81},"kubb\u002Fadapter-oas ",[67,989,984],{"style":81},[67,991,992],{"style":81},"kubb\u002Fplugin-ts",[57,994,997],{"language":939,"filename":995,"code":996,"class":62},"npm","npm install -D kubb @kubb\u002Fadapter-oas @kubb\u002Fplugin-ts",[16,998,999],{"class":944},[67,1000,1001,1003,1006,1008,1010,1012],{"class":69,"style":70},[67,1002,949],{"style":106},[67,1004,1005],{"style":81},"install -D kubb ",[67,1007,984],{"style":81},[67,1009,987],{"style":81},[67,1011,984],{"style":81},[67,1013,992],{"style":81},[57,1015,1018],{"language":939,"filename":1016,"code":1017,"class":62},"yarn","yarn add -D kubb @kubb\u002Fadapter-oas @kubb\u002Fplugin-ts",[16,1019,1020],{"class":944},[67,1021,1022,1025,1027,1029,1031,1033],{"class":69,"style":70},[67,1023,1024],{"style":106},"yarn ",[67,1026,981],{"style":81},[67,1028,984],{"style":81},[67,1030,987],{"style":81},[67,1032,984],{"style":81},[67,1034,992],{"style":81},[57,1036,1039],{"language":939,"filename":1037,"code":1038,"class":62},"bun","bun add -d kubb @kubb\u002Fadapter-oas @kubb\u002Fplugin-ts",[16,1040,1041],{"class":944},[67,1042,1043,1046,1049,1051,1053,1055],{"class":69,"style":70},[67,1044,1045],{"style":106},"bun ",[67,1047,1048],{"style":81},"add -d kubb ",[67,1050,984],{"style":81},[67,1052,987],{"style":81},[67,1054,984],{"style":81},[67,1056,992],{"style":81},[10,1058,1059,1060,1063,1064,1067,1068,1070,1071,1074],{},"Change your ",[16,1061,1062],{},"generate"," script to ",[16,1065,1066],{},"kubb generate"," and run it. Leave ",[16,1069,25],{}," in place until the last step, because the rest of the app still imports it. Those files stop following the spec once HeyAPI no longer runs. If you pause before the last step, use ",[16,1072,1073],{},"openapi-ts && kubb generate"," as the script:",[54,1076,1077,1123],{},[57,1078,1082],{"language":1079,"filename":1080,"code":1081,"class":62},"json","Before","{\n  \"scripts\": {\n    \"generate\": \"openapi-ts\"\n  }\n}",[16,1083,1085,93,1090,93,1101,93,1113,93,1119],{"class":1084},"language-json",[67,1086,1087],{"class":69,"style":70},[67,1088,1089],{"style":77},"{",[67,1091,1092,1094,1097,1099],{"class":69,"style":70},[67,1093,115],{"style":77},[67,1095,1096],{"style":77},"\"scripts\"",[67,1098,121],{"style":73},[67,1100,1089],{"style":77},[67,1102,1103,1105,1108,1110],{"class":69,"style":70},[67,1104,376],{"style":77},[67,1106,1107],{"style":77},"\"generate\"",[67,1109,121],{"style":73},[67,1111,1112],{"style":91},"\"openapi-ts\"",[67,1114,1115,1117],{"class":69,"style":70},[67,1116,115],{"style":91},[67,1118,332],{"style":77},[67,1120,1121],{"class":69,"style":70},[67,1122,332],{"style":77},[57,1124,1127],{"language":1079,"filename":1125,"code":1126,"class":62},"After","{\n  \"scripts\": {\n    \"generate\": \"kubb generate\"\n  }\n}",[16,1128,1129,93,1133,93,1143,93,1154,93,1160],{"class":1084},[67,1130,1131],{"class":69,"style":70},[67,1132,1089],{"style":77},[67,1134,1135,1137,1139,1141],{"class":69,"style":70},[67,1136,115],{"style":77},[67,1138,1096],{"style":77},[67,1140,121],{"style":73},[67,1142,1089],{"style":77},[67,1144,1145,1147,1149,1151],{"class":69,"style":70},[67,1146,376],{"style":77},[67,1148,1107],{"style":77},[67,1150,121],{"style":73},[67,1152,1153],{"style":91},"\"kubb generate\"",[67,1155,1156,1158],{"class":69,"style":70},[67,1157,115],{"style":91},[67,1159,332],{"style":77},[67,1161,1162],{"class":69,"style":70},[67,1163,332],{"style":77},[10,1165,1166],{},"Then replace the type imports. Schema types keep their names. Kubb exports each part of a request by name, and names a response after its status and media type:",[54,1168,1169,1222],{},[57,1170,1172],{"language":59,"filename":495,"code":1171,"class":62},"import type { GetPetByIdData, GetPetByIdResponse, Pet } from '.\u002Fclient'\n\ntype Path = GetPetByIdData['path']",[16,1173,1174,93,1201,93,1203],{"class":65},[67,1175,1176,1178,1181,1183,1185,1187,1189,1191,1194,1196,1198],{"class":69,"style":70},[67,1177,74],{"style":73},[67,1179,1180],{"style":81},"type ",[67,1182,78],{"style":77},[67,1184,633],{"style":106},[67,1186,30],{"style":73},[67,1188,657],{"style":106},[67,1190,30],{"style":73},[67,1192,1193],{"style":106},"Pet ",[67,1195,85],{"style":77},[67,1197,88],{"style":73},[67,1199,1200],{"style":91},"'.\u002Fclient'",[67,1202],{"class":69,"style":70},[67,1204,1205,1207,1210,1213,1215,1217,1220],{"class":69,"style":70},[67,1206,1180],{"style":73},[67,1208,1209],{"style":106},"Path ",[67,1211,1212],{"style":73},"= ",[67,1214,633],{"style":106},[67,1216,153],{"style":77},[67,1218,1219],{"style":91},"'path'",[67,1221,179],{"style":77},[57,1223,1225],{"language":59,"filename":498,"code":1224,"class":62},"import type { GetPetByIdPath, GetPetByIdStatus200Json, Pet } from '.\u002Fgen\u002Ftypes'",[16,1226,1227],{"class":65},[67,1228,1229,1231,1233,1235,1237,1239,1241,1243,1245,1247,1249],{"class":69,"style":70},[67,1230,74],{"style":73},[67,1232,1180],{"style":81},[67,1234,78],{"style":77},[67,1236,650],{"style":106},[67,1238,30],{"style":73},[67,1240,662],{"style":106},[67,1242,30],{"style":73},[67,1244,1193],{"style":106},[67,1246,85],{"style":77},[67,1248,88],{"style":73},[67,1250,1251],{"style":91},"'.\u002Fgen\u002Ftypes'",[10,1253,1254],{},"Run your type check and fix the imports it reports.",[46,1256,1258],{"id":1257},"replace-the-sdk-and-client","Replace the SDK and client",[10,1260,1261,1262,1265],{},"Add ",[16,1263,1264],{},"@kubb\u002Fplugin-fetch",". It writes one function per operation, and the app needs no client package:",[54,1267,1268,1280,1297,1313,1328],{"sync":936},[57,1269,1271],{"language":939,"filename":940,"code":1270,"class":62},"kubb add plugin-fetch",[16,1272,1273],{"class":944},[67,1274,1275,1277],{"class":69,"style":70},[67,1276,957],{"style":106},[67,1278,1279],{"style":81},"add plugin-fetch",[57,1281,1283],{"language":939,"filename":970,"code":1282,"class":62},"pnpm add -D @kubb\u002Fplugin-fetch",[16,1284,1285],{"class":944},[67,1286,1287,1289,1292,1294],{"class":69,"style":70},[67,1288,978],{"style":106},[67,1290,1291],{"style":81},"add -D ",[67,1293,984],{"style":81},[67,1295,1296],{"style":81},"kubb\u002Fplugin-fetch",[57,1298,1300],{"language":939,"filename":995,"code":1299,"class":62},"npm install -D @kubb\u002Fplugin-fetch",[16,1301,1302],{"class":944},[67,1303,1304,1306,1309,1311],{"class":69,"style":70},[67,1305,949],{"style":106},[67,1307,1308],{"style":81},"install -D ",[67,1310,984],{"style":81},[67,1312,1296],{"style":81},[57,1314,1316],{"language":939,"filename":1016,"code":1315,"class":62},"yarn add -D @kubb\u002Fplugin-fetch",[16,1317,1318],{"class":944},[67,1319,1320,1322,1324,1326],{"class":69,"style":70},[67,1321,1024],{"style":106},[67,1323,1291],{"style":81},[67,1325,984],{"style":81},[67,1327,1296],{"style":81},[57,1329,1331],{"language":939,"filename":1037,"code":1330,"class":62},"bun add -d @kubb\u002Fplugin-fetch",[16,1332,1333],{"class":944},[67,1334,1335,1337,1340,1342],{"class":69,"style":70},[67,1336,1045],{"style":106},[67,1338,1339],{"style":81},"add -d ",[67,1341,984],{"style":81},[67,1343,1296],{"style":81},[10,1345,1346,1348,1349,1352,1353,1355,1356,1358],{},[16,1347,932],{}," adds ",[16,1350,1351],{},"pluginFetch()"," to ",[16,1354,148],{},". With a package manager, add the import and the plugin yourself. Then set its options, with your API's URL as ",[16,1357,419],{},". The Petstore URL is an example:",[57,1360,1362],{"language":59,"filename":189,"code":1361,"class":62},"import { pluginFetch } from '@kubb\u002Fplugin-fetch'\n\n\u002F\u002F ...\nplugins: [\n  pluginTs({ output: { path: 'types.ts' } }),\n  pluginFetch({ baseURL: 'https:\u002F\u002Fpetstore3.swagger.io\u002Fapi\u002Fv3', throwOnErrorDefault: false }),\n],",[16,1363,1364,93,1378,93,1380,93,1385,93,1393,93,1417,93,1443],{"class":65},[67,1365,1366,1368,1370,1372,1374,1376],{"class":69,"style":70},[67,1367,74],{"style":73},[67,1369,78],{"style":77},[67,1371,232],{"style":81},[67,1373,85],{"style":77},[67,1375,88],{"style":73},[67,1377,239],{"style":91},[67,1379],{"class":69,"style":70},[67,1381,1382],{"class":69,"style":70},[67,1383,1384],{"style":406},"\u002F\u002F ...",[67,1386,1387,1389,1391],{"class":69,"style":70},[67,1388,148],{"style":81},[67,1390,121],{"style":73},[67,1392,153],{"style":77},[67,1394,1395,1397,1399,1401,1403,1405,1407,1409,1411,1413,1415],{"class":69,"style":70},[67,1396,115],{"style":77},[67,1398,379],{"style":106},[67,1400,349],{"style":77},[67,1402,134],{"style":77},[67,1404,121],{"style":73},[67,1406,78],{"style":77},[67,1408,324],{"style":77},[67,1410,121],{"style":73},[67,1412,394],{"style":91},[67,1414,397],{"style":77},[67,1416,127],{"style":73},[67,1418,1419,1421,1423,1425,1427,1429,1431,1433,1435,1437,1439,1441],{"class":69,"style":70},[67,1420,115],{"style":73},[67,1422,414],{"style":106},[67,1424,349],{"style":77},[67,1426,419],{"style":77},[67,1428,121],{"style":73},[67,1430,424],{"style":91},[67,1432,30],{"style":73},[67,1434,429],{"style":77},[67,1436,121],{"style":73},[67,1438,434],{"style":77},[67,1440,186],{"style":77},[67,1442,127],{"style":73},[67,1444,1445,1447],{"class":69,"style":70},[67,1446,179],{"style":77},[67,1448,127],{"style":73},[10,1450,1451,1454,1455,1458,1459,1462,1463,1465,1466,1468],{},[16,1452,1453],{},"throwOnErrorDefault: false"," keeps the HeyAPI behavior: an error status resolves with ",[16,1456,1457],{},"error"," set instead of throwing. HeyAPI reads the base URL from the spec's ",[16,1460,1461],{},"servers",". Kubb does not, so set ",[16,1464,419],{},". Run ",[16,1467,1066],{},", then replace each import. The calls keep their shape:",[54,1470,1471,1656],{},[57,1472,1474],{"language":59,"filename":495,"code":1473,"class":62},"import { getPetById } from '.\u002Fclient'\nimport { client } from '.\u002Fclient\u002Fclient.gen'\n\nclient.setConfig({ auth: () => token })\nclient.interceptors.request.use((request) => {\n  request.headers.set('X-Client', 'web')\n  return request\n})\n\nconst { data, error } = await getPetById({ path: { petId: 1 } })",[16,1475,1476,93,1491,93,1507,93,1509,93,1537,93,1568,93,1598,93,1607,93,1611,93,1613],{"class":65},[67,1477,1478,1480,1482,1485,1487,1489],{"class":69,"style":70},[67,1479,74],{"style":73},[67,1481,78],{"style":77},[67,1483,1484],{"style":81},"getPetById ",[67,1486,85],{"style":77},[67,1488,88],{"style":73},[67,1490,1200],{"style":91},[67,1492,1493,1495,1497,1500,1502,1504],{"class":69,"style":70},[67,1494,74],{"style":73},[67,1496,78],{"style":77},[67,1498,1499],{"style":81},"client ",[67,1501,85],{"style":77},[67,1503,88],{"style":73},[67,1505,1506],{"style":91},"'.\u002Fclient\u002Fclient.gen'",[67,1508],{"class":69,"style":70},[67,1510,1511,1514,1516,1519,1521,1524,1526,1529,1532,1535],{"class":69,"style":70},[67,1512,1513],{"style":81},"client",[67,1515,778],{"style":73},[67,1517,1518],{"style":106},"setConfig",[67,1520,349],{"style":77},[67,1522,1523],{"style":77},"auth",[67,1525,121],{"style":73},[67,1527,1528],{"style":77},"() ",[67,1530,1531],{"style":73},"=> ",[67,1533,1534],{"style":81},"token ",[67,1536,186],{"style":77},[67,1538,1539,1541,1543,1546,1548,1551,1553,1556,1559,1561,1564,1566],{"class":69,"style":70},[67,1540,1513],{"style":81},[67,1542,778],{"style":73},[67,1544,1545],{"style":77},"interceptors",[67,1547,778],{"style":73},[67,1549,1550],{"style":77},"request",[67,1552,778],{"style":73},[67,1554,1555],{"style":106},"use",[67,1557,1558],{"style":77},"((",[67,1560,1550],{"style":81},[67,1562,1563],{"style":77},") ",[67,1565,1531],{"style":73},[67,1567,1089],{"style":77},[67,1569,1570,1572,1574,1576,1579,1581,1584,1587,1590,1592,1595],{"class":69,"style":70},[67,1571,115],{"style":77},[67,1573,1550],{"style":81},[67,1575,778],{"style":73},[67,1577,1578],{"style":77},"headers",[67,1580,778],{"style":73},[67,1582,1583],{"style":106},"set",[67,1585,1586],{"style":77},"(",[67,1588,1589],{"style":91},"'X-Client'",[67,1591,30],{"style":73},[67,1593,1594],{"style":91},"'web'",[67,1596,1597],{"style":77},")",[67,1599,1600,1602,1605],{"class":69,"style":70},[67,1601,115],{"style":77},[67,1603,1604],{"style":73},"return ",[67,1606,1550],{"style":81},[67,1608,1609],{"class":69,"style":70},[67,1610,186],{"style":77},[67,1612],{"class":69,"style":70},[67,1614,1615,1618,1620,1623,1625,1628,1630,1632,1635,1638,1640,1642,1644,1646,1649,1651,1654],{"class":69,"style":70},[67,1616,1617],{"style":73},"const ",[67,1619,78],{"style":77},[67,1621,1622],{"style":81},"data",[67,1624,30],{"style":73},[67,1626,1627],{"style":81},"error ",[67,1629,85],{"style":77},[67,1631,1212],{"style":73},[67,1633,1634],{"style":73},"await ",[67,1636,1637],{"style":106},"getPetById",[67,1639,349],{"style":77},[67,1641,324],{"style":77},[67,1643,121],{"style":73},[67,1645,78],{"style":77},[67,1647,1648],{"style":77},"petId",[67,1650,121],{"style":73},[67,1652,1653],{"style":77},"1 ",[67,1655,397],{"style":77},[57,1657,1659],{"language":59,"filename":498,"code":1658,"class":62},"import { client } from '.\u002Fgen\u002F.kubb\u002Fclient'\nimport { getPetById } from '.\u002Fgen\u002Fclients\u002FgetPetById'\n\nclient.setConfig({ auth: () => token })\nclient.interceptors.request.use((request) => {\n  request.headers['X-Client'] = 'web'\n  return request\n})\n\nconst { data, error, status } = await getPetById({ path: { petId: 1 } })",[16,1660,1661,93,1676,93,1691,93,1693,93,1715,93,1741,93,1762,93,1770,93,1774,93,1776],{"class":65},[67,1662,1663,1665,1667,1669,1671,1673],{"class":69,"style":70},[67,1664,74],{"style":73},[67,1666,78],{"style":77},[67,1668,1499],{"style":81},[67,1670,85],{"style":77},[67,1672,88],{"style":73},[67,1674,1675],{"style":91},"'.\u002Fgen\u002F.kubb\u002Fclient'",[67,1677,1678,1680,1682,1684,1686,1688],{"class":69,"style":70},[67,1679,74],{"style":73},[67,1681,78],{"style":77},[67,1683,1484],{"style":81},[67,1685,85],{"style":77},[67,1687,88],{"style":73},[67,1689,1690],{"style":91},"'.\u002Fgen\u002Fclients\u002FgetPetById'",[67,1692],{"class":69,"style":70},[67,1694,1695,1697,1699,1701,1703,1705,1707,1709,1711,1713],{"class":69,"style":70},[67,1696,1513],{"style":81},[67,1698,778],{"style":73},[67,1700,1518],{"style":106},[67,1702,349],{"style":77},[67,1704,1523],{"style":77},[67,1706,121],{"style":73},[67,1708,1528],{"style":77},[67,1710,1531],{"style":73},[67,1712,1534],{"style":81},[67,1714,186],{"style":77},[67,1716,1717,1719,1721,1723,1725,1727,1729,1731,1733,1735,1737,1739],{"class":69,"style":70},[67,1718,1513],{"style":81},[67,1720,778],{"style":73},[67,1722,1545],{"style":77},[67,1724,778],{"style":73},[67,1726,1550],{"style":77},[67,1728,778],{"style":73},[67,1730,1555],{"style":106},[67,1732,1558],{"style":77},[67,1734,1550],{"style":81},[67,1736,1563],{"style":77},[67,1738,1531],{"style":73},[67,1740,1089],{"style":77},[67,1742,1743,1745,1747,1749,1751,1753,1755,1758,1760],{"class":69,"style":70},[67,1744,115],{"style":77},[67,1746,1550],{"style":81},[67,1748,778],{"style":73},[67,1750,1578],{"style":77},[67,1752,153],{"style":77},[67,1754,1589],{"style":91},[67,1756,1757],{"style":77},"] ",[67,1759,1212],{"style":73},[67,1761,1594],{"style":91},[67,1763,1764,1766,1768],{"class":69,"style":70},[67,1765,115],{"style":91},[67,1767,1604],{"style":73},[67,1769,1550],{"style":81},[67,1771,1772],{"class":69,"style":70},[67,1773,186],{"style":77},[67,1775],{"class":69,"style":70},[67,1777,1778,1780,1782,1784,1786,1788,1790,1793,1795,1797,1799,1801,1803,1805,1807,1809,1811,1813,1815],{"class":69,"style":70},[67,1779,1617],{"style":73},[67,1781,78],{"style":77},[67,1783,1622],{"style":81},[67,1785,30],{"style":73},[67,1787,1457],{"style":81},[67,1789,30],{"style":73},[67,1791,1792],{"style":81},"status ",[67,1794,85],{"style":77},[67,1796,1212],{"style":73},[67,1798,1634],{"style":73},[67,1800,1637],{"style":106},[67,1802,349],{"style":77},[67,1804,324],{"style":77},[67,1806,121],{"style":73},[67,1808,78],{"style":77},[67,1810,1648],{"style":77},[67,1812,121],{"style":73},[67,1814,1653],{"style":77},[67,1816,397],{"style":77},[10,1818,1819],{},"Three things differ:",[1821,1822,1823,1836,1855],"ul",{},[1824,1825,1826,1827,1830,1831,1833,1834,778],"li",{},"The result also has ",[16,1828,1829],{},"status",", and a check on it narrows ",[16,1832,1622],{}," and ",[16,1835,1457],{},[1824,1837,1838,1839,1842,1843,1846,1847,1850,1851,778],{},"With ",[16,1840,1841],{},"throwOnError: true"," on a call, HeyAPI throws the error body. Kubb throws a ",[16,1844,1845],{},"ResponseError"," with the body in ",[16,1848,1849],{},"error.data",". See ",[527,1852,1854],{"href":1853},"\u002Fextensions\u002Fkubb-labs\u002Fplugin-fetch\u002Fguides\u002Ferror-handling","Handle errors",[1824,1856,1857,1858,1860],{},"When an operation lists several security schemes, HeyAPI sends the token to each of them. Kubb sends the first one that ",[16,1859,1523],{}," returns a token for, so return the right credential per scheme:",[57,1862,1864],{"language":59,"code":1863,"class":62},"client.setConfig({ auth: (scheme) => (scheme.type === 'apiKey' ? apiKey : token) })",[16,1865,1866],{"class":65},[67,1867,1868,1870,1872,1874,1876,1878,1880,1882,1885,1887,1889,1891,1893,1895,1897,1900,1903,1906,1909,1911,1914],{"class":69,"style":70},[67,1869,1513],{"style":81},[67,1871,778],{"style":73},[67,1873,1518],{"style":106},[67,1875,349],{"style":77},[67,1877,1523],{"style":77},[67,1879,121],{"style":73},[67,1881,1586],{"style":77},[67,1883,1884],{"style":81},"scheme",[67,1886,1563],{"style":77},[67,1888,1531],{"style":73},[67,1890,1586],{"style":77},[67,1892,1884],{"style":81},[67,1894,778],{"style":73},[67,1896,1180],{"style":77},[67,1898,1899],{"style":73},"=== ",[67,1901,1902],{"style":91},"'apiKey' ",[67,1904,1905],{"style":73},"? ",[67,1907,1908],{"style":81},"apiKey ",[67,1910,121],{"style":73},[67,1912,1913],{"style":81},"token",[67,1915,1916],{"style":77},") })",[10,1918,1919,1923,1924,1926],{},[527,1920,1922],{"href":1921},"\u002Fextensions\u002Fkubb-labs\u002Fplugin-fetch\u002Fguides\u002Fconfigure-requests","Configure requests"," covers ",[16,1925,1523],{}," and interceptors.",[46,1928,1930],{"id":1929},"replace-tanstack-query","Replace TanStack Query",[10,1932,1261,1933,1938,1939,1941,1942,1944,1945,1948,1949,1951,1952,1954],{},[527,1934,1935],{"href":595},[16,1936,1937],{},"@kubb\u002Fplugin-react-query",". With a package manager, also import ",[16,1940,445],{}," from ",[16,1943,1937],{}," and add ",[16,1946,1947],{},"pluginReactQuery()"," after ",[16,1950,414],{}," in ",[16,1953,148],{},":",[54,1956,1957,1969,1985,2000,2015],{"sync":936},[57,1958,1960],{"language":939,"filename":940,"code":1959,"class":62},"kubb add plugin-react-query",[16,1961,1962],{"class":944},[67,1963,1964,1966],{"class":69,"style":70},[67,1965,957],{"style":106},[67,1967,1968],{"style":81},"add plugin-react-query",[57,1970,1972],{"language":939,"filename":970,"code":1971,"class":62},"pnpm add -D @kubb\u002Fplugin-react-query",[16,1973,1974],{"class":944},[67,1975,1976,1978,1980,1982],{"class":69,"style":70},[67,1977,978],{"style":106},[67,1979,1291],{"style":81},[67,1981,984],{"style":81},[67,1983,1984],{"style":81},"kubb\u002Fplugin-react-query",[57,1986,1988],{"language":939,"filename":995,"code":1987,"class":62},"npm install -D @kubb\u002Fplugin-react-query",[16,1989,1990],{"class":944},[67,1991,1992,1994,1996,1998],{"class":69,"style":70},[67,1993,949],{"style":106},[67,1995,1308],{"style":81},[67,1997,984],{"style":81},[67,1999,1984],{"style":81},[57,2001,2003],{"language":939,"filename":1016,"code":2002,"class":62},"yarn add -D @kubb\u002Fplugin-react-query",[16,2004,2005],{"class":944},[67,2006,2007,2009,2011,2013],{"class":69,"style":70},[67,2008,1024],{"style":106},[67,2010,1291],{"style":81},[67,2012,984],{"style":81},[67,2014,1984],{"style":81},[57,2016,2018],{"language":939,"filename":1037,"code":2017,"class":62},"bun add -d @kubb\u002Fplugin-react-query",[16,2019,2020],{"class":944},[67,2021,2022,2024,2026,2028],{"class":69,"style":70},[67,2023,1045],{"style":106},[67,2025,1339],{"style":81},[67,2027,984],{"style":81},[67,2029,1984],{"style":81},[10,2031,2032,2033,2035],{},"The plugin writes query and mutation options per operation, as HeyAPI does. Run ",[16,2034,1066],{},", then replace each import:",[54,2037,2038,2178],{},[57,2039,2041],{"language":59,"filename":495,"code":2040,"class":62},"import { useMutation, useQuery } from '@tanstack\u002Freact-query'\nimport { addPetMutation, getPetByIdOptions } from '.\u002Fclient\u002F@tanstack\u002Freact-query.gen'\n\nconst { data } = useQuery(getPetByIdOptions({ path: { petId: 1 } }))\nconst { mutate } = useMutation(addPetMutation())\nmutate({ body: { name: 'Rex', photoUrls: [] } })",[16,2042,2043,93,2063,93,2084,93,2086,93,2124,93,2146],{"class":65},[67,2044,2045,2047,2049,2052,2054,2057,2059,2061],{"class":69,"style":70},[67,2046,74],{"style":73},[67,2048,78],{"style":77},[67,2050,2051],{"style":81},"useMutation",[67,2053,30],{"style":73},[67,2055,2056],{"style":81},"useQuery ",[67,2058,85],{"style":77},[67,2060,88],{"style":73},[67,2062,171],{"style":91},[67,2064,2065,2067,2069,2072,2074,2077,2079,2081],{"class":69,"style":70},[67,2066,74],{"style":73},[67,2068,78],{"style":77},[67,2070,2071],{"style":81},"addPetMutation",[67,2073,30],{"style":73},[67,2075,2076],{"style":81},"getPetByIdOptions ",[67,2078,85],{"style":77},[67,2080,88],{"style":73},[67,2082,2083],{"style":91},"'.\u002Fclient\u002F@tanstack\u002Freact-query.gen'",[67,2085],{"class":69,"style":70},[67,2087,2088,2090,2092,2095,2097,2099,2102,2104,2107,2109,2111,2113,2115,2117,2119,2121],{"class":69,"style":70},[67,2089,1617],{"style":73},[67,2091,78],{"style":77},[67,2093,2094],{"style":81},"data ",[67,2096,85],{"style":77},[67,2098,1212],{"style":73},[67,2100,2101],{"style":106},"useQuery",[67,2103,1586],{"style":77},[67,2105,2106],{"style":106},"getPetByIdOptions",[67,2108,349],{"style":77},[67,2110,324],{"style":77},[67,2112,121],{"style":73},[67,2114,78],{"style":77},[67,2116,1648],{"style":77},[67,2118,121],{"style":73},[67,2120,1653],{"style":77},[67,2122,2123],{"style":77},"} }))",[67,2125,2126,2128,2130,2133,2135,2137,2139,2141,2143],{"class":69,"style":70},[67,2127,1617],{"style":73},[67,2129,78],{"style":77},[67,2131,2132],{"style":81},"mutate ",[67,2134,85],{"style":77},[67,2136,1212],{"style":73},[67,2138,2051],{"style":106},[67,2140,1586],{"style":77},[67,2142,2071],{"style":106},[67,2144,2145],{"style":77},"())",[67,2147,2148,2151,2153,2156,2158,2160,2163,2165,2168,2170,2173,2175],{"class":69,"style":70},[67,2149,2150],{"style":106},"mutate",[67,2152,349],{"style":77},[67,2154,2155],{"style":77},"body",[67,2157,121],{"style":73},[67,2159,78],{"style":77},[67,2161,2162],{"style":77},"name",[67,2164,121],{"style":73},[67,2166,2167],{"style":91},"'Rex'",[67,2169,30],{"style":73},[67,2171,2172],{"style":77},"photoUrls",[67,2174,121],{"style":73},[67,2176,2177],{"style":77},"[] } })",[57,2179,2181],{"language":59,"filename":498,"code":2180,"class":62},"import { useMutation, useQuery } from '@tanstack\u002Freact-query'\nimport { addPetMutationOptions } from '.\u002Fgen\u002Fhooks\u002FuseAddPet'\nimport { getPetByIdQueryOptions } from '.\u002Fgen\u002Fhooks\u002FuseGetPetById'\n\nconst { data } = useQuery(getPetByIdQueryOptions({ path: { petId: 1 } }))\nconst { mutate } = useMutation(addPetMutationOptions())\nmutate({ body: { name: 'Rex', photoUrls: [] } })",[16,2182,2183,93,2201,93,2217,93,2233,93,2235,93,2270,93,2291],{"class":65},[67,2184,2185,2187,2189,2191,2193,2195,2197,2199],{"class":69,"style":70},[67,2186,74],{"style":73},[67,2188,78],{"style":77},[67,2190,2051],{"style":81},[67,2192,30],{"style":73},[67,2194,2056],{"style":81},[67,2196,85],{"style":77},[67,2198,88],{"style":73},[67,2200,171],{"style":91},[67,2202,2203,2205,2207,2210,2212,2214],{"class":69,"style":70},[67,2204,74],{"style":73},[67,2206,78],{"style":77},[67,2208,2209],{"style":81},"addPetMutationOptions ",[67,2211,85],{"style":77},[67,2213,88],{"style":73},[67,2215,2216],{"style":91},"'.\u002Fgen\u002Fhooks\u002FuseAddPet'",[67,2218,2219,2221,2223,2226,2228,2230],{"class":69,"style":70},[67,2220,74],{"style":73},[67,2222,78],{"style":77},[67,2224,2225],{"style":81},"getPetByIdQueryOptions ",[67,2227,85],{"style":77},[67,2229,88],{"style":73},[67,2231,2232],{"style":91},"'.\u002Fgen\u002Fhooks\u002FuseGetPetById'",[67,2234],{"class":69,"style":70},[67,2236,2237,2239,2241,2243,2245,2247,2249,2251,2254,2256,2258,2260,2262,2264,2266,2268],{"class":69,"style":70},[67,2238,1617],{"style":73},[67,2240,78],{"style":77},[67,2242,2094],{"style":81},[67,2244,85],{"style":77},[67,2246,1212],{"style":73},[67,2248,2101],{"style":106},[67,2250,1586],{"style":77},[67,2252,2253],{"style":106},"getPetByIdQueryOptions",[67,2255,349],{"style":77},[67,2257,324],{"style":77},[67,2259,121],{"style":73},[67,2261,78],{"style":77},[67,2263,1648],{"style":77},[67,2265,121],{"style":73},[67,2267,1653],{"style":77},[67,2269,2123],{"style":77},[67,2271,2272,2274,2276,2278,2280,2282,2284,2286,2289],{"class":69,"style":70},[67,2273,1617],{"style":73},[67,2275,78],{"style":77},[67,2277,2132],{"style":81},[67,2279,85],{"style":77},[67,2281,1212],{"style":73},[67,2283,2051],{"style":106},[67,2285,1586],{"style":77},[67,2287,2288],{"style":106},"addPetMutationOptions",[67,2290,2145],{"style":77},[67,2292,2293,2295,2297,2299,2301,2303,2305,2307,2309,2311,2313,2315],{"class":69,"style":70},[67,2294,2150],{"style":106},[67,2296,349],{"style":77},[67,2298,2155],{"style":77},[67,2300,121],{"style":73},[67,2302,78],{"style":77},[67,2304,2162],{"style":77},[67,2306,121],{"style":73},[67,2308,2167],{"style":91},[67,2310,30],{"style":73},[67,2312,2172],{"style":77},[67,2314,121],{"style":73},[67,2316,2177],{"style":77},[46,2318,2320],{"id":2319},"replace-the-zod-schemas","Replace the Zod schemas",[10,2322,1261,2323,1938,2328,1941,2330,1944,2332,1352,2335,2337,2338,2340],{},[527,2324,2325],{"href":608},[16,2326,2327],{},"@kubb\u002Fplugin-zod",[16,2329,457],{},[16,2331,2327],{},[16,2333,2334],{},"pluginZod()",[16,2336,148],{},". The schemas need Zod 4, so upgrade ",[16,2339,43],{}," first if the app is on Zod 3:",[54,2342,2343,2355,2371,2386,2401],{"sync":936},[57,2344,2346],{"language":939,"filename":940,"code":2345,"class":62},"kubb add plugin-zod",[16,2347,2348],{"class":944},[67,2349,2350,2352],{"class":69,"style":70},[67,2351,957],{"style":106},[67,2353,2354],{"style":81},"add plugin-zod",[57,2356,2358],{"language":939,"filename":970,"code":2357,"class":62},"pnpm add -D @kubb\u002Fplugin-zod",[16,2359,2360],{"class":944},[67,2361,2362,2364,2366,2368],{"class":69,"style":70},[67,2363,978],{"style":106},[67,2365,1291],{"style":81},[67,2367,984],{"style":81},[67,2369,2370],{"style":81},"kubb\u002Fplugin-zod",[57,2372,2374],{"language":939,"filename":995,"code":2373,"class":62},"npm install -D @kubb\u002Fplugin-zod",[16,2375,2376],{"class":944},[67,2377,2378,2380,2382,2384],{"class":69,"style":70},[67,2379,949],{"style":106},[67,2381,1308],{"style":81},[67,2383,984],{"style":81},[67,2385,2370],{"style":81},[57,2387,2389],{"language":939,"filename":1016,"code":2388,"class":62},"yarn add -D @kubb\u002Fplugin-zod",[16,2390,2391],{"class":944},[67,2392,2393,2395,2397,2399],{"class":69,"style":70},[67,2394,1024],{"style":106},[67,2396,1291],{"style":81},[67,2398,984],{"style":81},[67,2400,2370],{"style":81},[57,2402,2404],{"language":939,"filename":1037,"code":2403,"class":62},"bun add -d @kubb\u002Fplugin-zod",[16,2405,2406],{"class":944},[67,2407,2408,2410,2412,2414],{"class":69,"style":70},[67,2409,1045],{"style":106},[67,2411,1339],{"style":81},[67,2413,984],{"style":81},[67,2415,2370],{"style":81},[10,2417,2418,2419,2422,2423,1465,2426,2035],{},"Kubb writes one file per schema and ends each name in ",[16,2420,2421],{},"Schema",", where HeyAPI starts it with ",[16,2424,2425],{},"z",[16,2427,1066],{},[54,2429,2430,2501],{},[57,2431,2433],{"language":59,"filename":495,"code":2432,"class":62},"import { zGetPetByIdPath, zPet } from '.\u002Fclient\u002Fzod.gen'\n\nconst pet = zPet.parse(json)\nconst path = zGetPetByIdPath.parse(params)",[16,2434,2435,93,2455,93,2457,93,2479],{"class":65},[67,2436,2437,2439,2441,2443,2445,2448,2450,2452],{"class":69,"style":70},[67,2438,74],{"style":73},[67,2440,78],{"style":77},[67,2442,735],{"style":81},[67,2444,30],{"style":73},[67,2446,2447],{"style":81},"zPet ",[67,2449,85],{"style":77},[67,2451,88],{"style":73},[67,2453,2454],{"style":91},"'.\u002Fclient\u002Fzod.gen'",[67,2456],{"class":69,"style":70},[67,2458,2459,2461,2464,2466,2468,2470,2473,2475,2477],{"class":69,"style":70},[67,2460,1617],{"style":73},[67,2462,2463],{"style":81},"pet ",[67,2465,1212],{"style":73},[67,2467,732],{"style":81},[67,2469,778],{"style":73},[67,2471,2472],{"style":106},"parse",[67,2474,1586],{"style":77},[67,2476,1079],{"style":81},[67,2478,1597],{"style":77},[67,2480,2481,2483,2486,2488,2490,2492,2494,2496,2499],{"class":69,"style":70},[67,2482,1617],{"style":73},[67,2484,2485],{"style":81},"path ",[67,2487,1212],{"style":73},[67,2489,735],{"style":81},[67,2491,778],{"style":73},[67,2493,2472],{"style":106},[67,2495,1586],{"style":77},[67,2497,2498],{"style":81},"params",[67,2500,1597],{"style":77},[57,2502,2504],{"language":59,"filename":498,"code":2503,"class":62},"import { getPetByIdPathSchema } from '.\u002Fgen\u002Fzod\u002FgetPetByIdSchema'\nimport { petSchema } from '.\u002Fgen\u002Fzod\u002FpetSchema'\n\nconst pet = petSchema.parse(json)\nconst path = getPetByIdPathSchema.parse(params)",[16,2505,2506,93,2522,93,2538,93,2540,93,2560],{"class":65},[67,2507,2508,2510,2512,2515,2517,2519],{"class":69,"style":70},[67,2509,74],{"style":73},[67,2511,78],{"style":77},[67,2513,2514],{"style":81},"getPetByIdPathSchema ",[67,2516,85],{"style":77},[67,2518,88],{"style":73},[67,2520,2521],{"style":91},"'.\u002Fgen\u002Fzod\u002FgetPetByIdSchema'",[67,2523,2524,2526,2528,2531,2533,2535],{"class":69,"style":70},[67,2525,74],{"style":73},[67,2527,78],{"style":77},[67,2529,2530],{"style":81},"petSchema ",[67,2532,85],{"style":77},[67,2534,88],{"style":73},[67,2536,2537],{"style":91},"'.\u002Fgen\u002Fzod\u002FpetSchema'",[67,2539],{"class":69,"style":70},[67,2541,2542,2544,2546,2548,2550,2552,2554,2556,2558],{"class":69,"style":70},[67,2543,1617],{"style":73},[67,2545,2463],{"style":81},[67,2547,1212],{"style":73},[67,2549,740],{"style":81},[67,2551,778],{"style":73},[67,2553,2472],{"style":106},[67,2555,1586],{"style":77},[67,2557,1079],{"style":81},[67,2559,1597],{"style":77},[67,2561,2562,2564,2566,2568,2570,2572,2574,2576,2578],{"class":69,"style":70},[67,2563,1617],{"style":73},[67,2565,2485],{"style":81},[67,2567,1212],{"style":73},[67,2569,743],{"style":81},[67,2571,778],{"style":73},[67,2573,2472],{"style":106},[67,2575,1586],{"style":77},[67,2577,2498],{"style":81},[67,2579,1597],{"style":77},[10,2581,2582,2583,2585,2586,2588,2589,572,2593,2595],{},"If ",[16,2584,36],{}," has ",[16,2587,571],{},", set ",[527,2590,2591],{"href":579},[16,2592,582],{},[16,2594,414],{}," so the client checks requests and responses against these schemas:",[57,2597,2599],{"language":59,"filename":189,"code":2598,"class":62},"pluginFetch({ validator: { request: 'zod', params: 'zod', response: 'zod' } }),",[16,2600,2601],{"class":65},[67,2602,2603,2605,2607,2609,2611,2613,2615,2617,2619,2621,2623,2625,2627,2629,2632,2634,2637,2639],{"class":69,"style":70},[67,2604,414],{"style":106},[67,2606,349],{"style":77},[67,2608,582],{"style":77},[67,2610,121],{"style":73},[67,2612,78],{"style":77},[67,2614,1550],{"style":77},[67,2616,121],{"style":73},[67,2618,176],{"style":91},[67,2620,30],{"style":73},[67,2622,2498],{"style":77},[67,2624,121],{"style":73},[67,2626,176],{"style":91},[67,2628,30],{"style":73},[67,2630,2631],{"style":77},"response",[67,2633,121],{"style":73},[67,2635,2636],{"style":91},"'zod' ",[67,2638,397],{"style":77},[67,2640,127],{"style":73},[46,2642,2644],{"id":2643},"remove-heyapi","Remove HeyAPI",[10,2646,2647,2648,2650,2651,1833,2653,2655,2656,778],{},"Once nothing imports from ",[16,2649,25],{},", delete ",[16,2652,25],{},[16,2654,60],{},", and uninstall ",[16,2657,18],{},{"title":2659,"searchDepth":2660,"depth":2660,"links":2661},"",5,[2662,2664,2669,2670,2671,2672,2673],{"id":48,"depth":2663,"text":49},2,{"id":476,"depth":2663,"text":477,"children":2665},[2666,2668],{"id":481,"depth":2667,"text":482},3,{"id":613,"depth":2667,"text":614},{"id":750,"depth":2663,"text":751},{"id":1257,"depth":2663,"text":1258},{"id":1929,"depth":2663,"text":1930},{"id":2319,"depth":2663,"text":2320},{"id":2643,"depth":2663,"text":2644},"Replace HeyAPI (@hey-api\u002Fopenapi-ts) with Kubb. Generate the same types, then swap the SDK, TanStack Query options, and Zod schemas one step at a time.","md",{"layout":2677,"title":5,"description":2674,"outline":2678,"order":2663,"navigation":2679},"doc",[2663,2667],{"title":2680,"icon":2681},"Move from HeyAPI","i-iconoir-git-fork",{"layout":2677,"outline":2683},[2663,2667],{"title":2680,"icon":2681},"\u002Fdocs\u002F5.x\u002Fmigrate\u002Ffrom-hey-api",{"title":5,"description":2674},{"loc":2685},"kubb-labs\u002Fkubb\u002Fdocs\u002F5.x\u002Fmigrate\u002Ffrom-hey-api.md","docs\u002F5.x\u002Fmigrate\u002Ffrom-hey-api","JV7k1x4Q3E8Hj0FkUGYeFB6wlS0XbsKYMalat1qFLC8",1795021320308]