@routar/core 1.1.0 → 1.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +67 -20
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +190 -5
- package/dist/index.d.ts +190 -5
- package/dist/index.js +65 -21
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.cjs
CHANGED
|
@@ -126,6 +126,70 @@ function dispatchExecutor(resolver) {
|
|
|
126
126
|
};
|
|
127
127
|
}
|
|
128
128
|
|
|
129
|
+
// src/utils/params.ts
|
|
130
|
+
function serializeParams(params) {
|
|
131
|
+
const result = new URLSearchParams();
|
|
132
|
+
for (const [key, value] of Object.entries(params)) {
|
|
133
|
+
if (value == null) continue;
|
|
134
|
+
if (Array.isArray(value)) {
|
|
135
|
+
for (const item of value) {
|
|
136
|
+
if (item != null) result.append(key, String(item));
|
|
137
|
+
}
|
|
138
|
+
} else if (typeof value === "object") {
|
|
139
|
+
throw new TypeError(
|
|
140
|
+
`serializeParams: value for key "${key}" is a plain object. Serialize it to a string before passing as a query parameter.`
|
|
141
|
+
);
|
|
142
|
+
} else {
|
|
143
|
+
result.append(key, String(value));
|
|
144
|
+
}
|
|
145
|
+
}
|
|
146
|
+
return result;
|
|
147
|
+
}
|
|
148
|
+
|
|
149
|
+
// src/create-fetch-executor.ts
|
|
150
|
+
function createFetchExecutor(baseURL, options) {
|
|
151
|
+
return createExecutor(
|
|
152
|
+
async ({ method, url, params, body, headers, signal }) => {
|
|
153
|
+
const fullURL = new URL(baseURL.replace(/\/$/, "") + url);
|
|
154
|
+
if (params) {
|
|
155
|
+
serializeParams(params).forEach((v, k) => {
|
|
156
|
+
fullURL.searchParams.set(k, v);
|
|
157
|
+
});
|
|
158
|
+
}
|
|
159
|
+
const defaultHeaders = await options?.defaultHeaders?.() ?? {};
|
|
160
|
+
const res = await fetch(fullURL.toString(), {
|
|
161
|
+
method,
|
|
162
|
+
headers: {
|
|
163
|
+
...defaultHeaders,
|
|
164
|
+
...headers,
|
|
165
|
+
...body != null ? { "Content-Type": "application/json" } : {}
|
|
166
|
+
},
|
|
167
|
+
body: body != null ? JSON.stringify(body) : void 0,
|
|
168
|
+
signal
|
|
169
|
+
});
|
|
170
|
+
if (!res.ok) {
|
|
171
|
+
const errorBody = await res.json().catch(() => null);
|
|
172
|
+
throw new HttpError(res.status, res.statusText, errorBody);
|
|
173
|
+
}
|
|
174
|
+
if (res.status === 204 || res.status === 205 || res.status === 304) {
|
|
175
|
+
return null;
|
|
176
|
+
}
|
|
177
|
+
const text = await res.text();
|
|
178
|
+
return text === "" ? null : JSON.parse(text);
|
|
179
|
+
},
|
|
180
|
+
options?.middlewares
|
|
181
|
+
);
|
|
182
|
+
}
|
|
183
|
+
var HttpError = class extends Error {
|
|
184
|
+
constructor(status, statusText, body = null) {
|
|
185
|
+
super(`HTTP ${status}: ${statusText}`);
|
|
186
|
+
this.status = status;
|
|
187
|
+
this.statusText = statusText;
|
|
188
|
+
this.body = body;
|
|
189
|
+
this.name = "HttpError";
|
|
190
|
+
}
|
|
191
|
+
};
|
|
192
|
+
|
|
129
193
|
// src/define-endpoint.ts
|
|
130
194
|
function endpoint(spec) {
|
|
131
195
|
return spec;
|
|
@@ -212,34 +276,17 @@ function anySignal(signals) {
|
|
|
212
276
|
};
|
|
213
277
|
}
|
|
214
278
|
|
|
215
|
-
|
|
216
|
-
function serializeParams(params) {
|
|
217
|
-
const result = new URLSearchParams();
|
|
218
|
-
for (const [key, value] of Object.entries(params)) {
|
|
219
|
-
if (value == null) continue;
|
|
220
|
-
if (Array.isArray(value)) {
|
|
221
|
-
for (const item of value) {
|
|
222
|
-
if (item != null) result.append(key, String(item));
|
|
223
|
-
}
|
|
224
|
-
} else if (typeof value === "object") {
|
|
225
|
-
throw new TypeError(
|
|
226
|
-
`serializeParams: value for key "${key}" is a plain object. Serialize it to a string before passing as a query parameter.`
|
|
227
|
-
);
|
|
228
|
-
} else {
|
|
229
|
-
result.append(key, String(value));
|
|
230
|
-
}
|
|
231
|
-
}
|
|
232
|
-
return result;
|
|
233
|
-
}
|
|
234
|
-
|
|
279
|
+
exports.HttpError = HttpError;
|
|
235
280
|
exports.TimeoutError = TimeoutError;
|
|
236
281
|
exports.ValidationError = ValidationError;
|
|
237
282
|
exports.createApi = createApi;
|
|
238
283
|
exports.createExecutor = createExecutor;
|
|
284
|
+
exports.createFetchExecutor = createFetchExecutor;
|
|
239
285
|
exports.defineMiddleware = defineMiddleware;
|
|
240
286
|
exports.defineRouter = defineRouter;
|
|
241
287
|
exports.dispatchExecutor = dispatchExecutor;
|
|
242
288
|
exports.endpoint = endpoint;
|
|
289
|
+
exports.isRouterDef = isRouterDef;
|
|
243
290
|
exports.joinPaths = joinPaths;
|
|
244
291
|
exports.resolvePath = resolvePath;
|
|
245
292
|
exports.serializeParams = serializeParams;
|
package/dist/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/define-router.ts","../src/utils/path.ts","../src/utils/validate.ts","../src/create-api.ts","../src/create-executor.ts","../src/define-endpoint.ts","../src/middleware.ts","../src/utils/params.ts"],"names":[],"mappings":";;;AAiCO,SAAS,YAAY,KAAA,EAAoD;AAC9E,EAAA,OAAO,QAAA,IAAY,SAAS,WAAA,IAAe,KAAA;AAC7C;AAEO,SAAS,YAAA,CACd,QACA,SAAA,EACuB;AACvB,EAAA,OAAO,EAAE,QAAQ,SAAA,EAAU;AAC7B;;;ACnCO,SAAS,aAAa,QAAA,EAA4B;AACvD,EAAA,MAAM,MAAA,GAAS,QAAA,CACZ,MAAA,CAAO,CAAC,CAAA,KAAM,CAAA,KAAM,EAAE,CAAA,CACtB,IAAA,CAAK,GAAG,CAAA,CACR,OAAA,CAAQ,QAAQ,GAAG,CAAA;AACtB,EAAA,OAAO,MAAA,CAAO,QAAA,CAAS,GAAG,CAAA,IAAK,MAAA,CAAO,MAAA,GAAS,CAAA,GAC3C,MAAA,CAAO,KAAA,CAAM,CAAA,EAAG,EAAE,CAAA,GAClB,MAAA,IAAU,GAAA;AAChB;AAEO,SAAS,WAAA,CACd,cACA,MAAA,EACQ;AACR,EAAA,IAAI,CAAC,QAAQ,OAAO,YAAA;AACpB,EAAA,OAAO,YAAA,CAAa,OAAA,CAAQ,4BAAA,EAA8B,CAAC,GAAG,GAAA,KAAQ;AACpE,IAAA,MAAM,KAAA,GAAQ,OAAO,GAAG,CAAA;AACxB,IAAA,IAAI,KAAA,IAAS,QAAQ,KAAA,KAAU,EAAA,QAAU,IAAI,KAAA,CAAM,CAAA,wBAAA,EAA2B,GAAG,CAAA,CAAE,CAAA;AACnF,IAAA,OAAO,kBAAA,CAAmB,MAAA,CAAO,KAAK,CAAC,CAAA;AAAA,EACzC,CAAC,CAAA;AACH;;;AC3BO,IAAM,eAAA,GAAN,cAA8B,KAAA,CAAM;AAAA,EAGzC,WAAA,CAAY,SAAiB,KAAA,EAAiB;AAC5C,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,IAAA,GAAO,iBAAA;AACZ,IAAA,IAAI,UAAU,MAAA,EAAW;AACvB,MAAA,MAAA,CAAO,cAAA,CAAe,MAAM,OAAA,EAAS;AAAA,QACnC,KAAA,EAAO,KAAA;AAAA,QACP,QAAA,EAAU,KAAA;AAAA,QACV,UAAA,EAAY,KAAA;AAAA,QACZ,YAAA,EAAc;AAAA,OACf,CAAA;AAAA,IACH;AAAA,EACF;AACF;;;ACkFO,SAAS,SAAA,CACd,QAAA,EACA,yBAAA,EAIA,qBAAA,EACA,UAAA,EACyB;AACzB,EAAA,MAAM,EAAE,MAAA,EAAQ,SAAA,EAAW,OAAA,EAAQ,GAAI,WAAA;AAAA,IACrC,yBAAA;AAAA,IACA,qBAAA;AAAA,IACA;AAAA,GACF;AACA,EAAA,OAAO,WAAA,CAAY,QAAA,EAAU,MAAA,EAAQ,SAAA,EAAW,OAAO,CAAA;AACzD;AAEA,SAAS,WAAA,CACP,MAAA,EACA,KAAA,EACA,MAAA,EAKA;AACA,EAAA,IAAI,OAAO,WAAW,QAAA,EAAU;AAC9B,IAAA,IAAI,CAAC,KAAA;AACH,MAAA,MAAM,IAAI,MAAM,+CAA+C,CAAA;AACjE,IAAA,OAAO;AAAA,MACL,MAAA,EAAQ,MAAA;AAAA,MACR,SAAA,EAAW,KAAA;AAAA,MACX,OAAA,EAAS;AAAA,KACX;AAAA,EACF;AACA,EAAA,IAAI,WAAA,CAAY,MAAM,CAAA,EAAG;AACvB,IAAA,OAAO;AAAA,MACL,QAAQ,MAAA,CAAO,MAAA;AAAA,MACf,WAAW,MAAA,CAAO,SAAA;AAAA,MAClB,OAAA,EAAS;AAAA,KACX;AAAA,EACF;AACA,EAAA,OAAO;AAAA,IACL,MAAA,EAAQ,EAAA;AAAA,IACR,SAAA,EAAW,MAAA;AAAA,IACX,OAAA,EAAS;AAAA,GACX;AACF;AAEA,SAAS,cAAA,CACP,SACA,IAAA,EACS;AACT,EAAA,MAAM,IAAI,OAAA,EAAS,QAAA;AACnB,EAAA,IAAI,CAAA,KAAM,MAAA,IAAa,CAAA,KAAM,IAAA,EAAM,OAAO,IAAA;AAC1C,EAAA,IAAI,CAAA,KAAM,OAAO,OAAO,KAAA;AACxB,EAAA,OAAO,CAAA,CAAE,IAAI,CAAA,IAAK,IAAA;AACpB;AAEA,SAAS,WAAA,CACP,QAAA,EACA,MAAA,EACA,SAAA,EACA,OAAA,EACyB;AACzB,EAAA,MAAM,SAAkC,EAAC;AAEzC,EAAA,KAAA,MAAW,CAAC,GAAA,EAAK,KAAK,KAAK,MAAA,CAAO,OAAA,CAAQ,SAAS,CAAA,EAAG;AACpD,IAAA,MAAA,CAAO,GAAG,IAAI,WAAA,CAAY,KAAK,IAC3B,WAAA,CAAY,QAAA,EAAU,UAAU,MAAA,EAAQ,KAAA,CAAM,MAAM,CAAA,EAAG,KAAA,CAAM,WAAW,OAAO,CAAA,GAC/E,gBAAgB,QAAA,EAAU,MAAA,EAAQ,OAAsC,OAAO,CAAA;AAAA,EACrF;AAEA,EAAA,OAAO,MAAA;AACT;AAEA,SAAS,eAAA,CACP,QAAA,EACA,MAAA,EACA,IAAA,EACA,OAAA,EACA;AACA,EAAA,OAAO,OAAO,MAAA,GAAuB,EAAC,EAAG,MAAA,KAAyB;AAChE,IAAA,IAAI,eAAA,GAAgC,MAAA;AACpC,IAAA,IAAI,IAAA,CAAK,OAAA,IAAW,cAAA,CAAe,OAAA,EAAS,SAAS,CAAA,EAAG;AACtD,MAAA,IAAI;AACF,QAAA,eAAA,GAAkB,IAAA,CAAK,OAAA,CAAQ,KAAA,CAAM,MAAM,CAAA;AAAA,MAC7C,SAAS,GAAA,EAAK;AACZ,QAAA,MAAM,IAAI,eAAA,CAAgB,2BAAA,EAA6B,GAAG,CAAA;AAAA,MAC5D;AAAA,IACF;AAEA,IAAA,MAAM,GAAA,GAAM,YAAY,SAAA,CAAU,MAAA,EAAQ,KAAK,IAAI,CAAA,EAAG,iBAAiB,IAAI,CAAA;AAE3E,IAAA,MAAM,GAAA,GAAM,MAAM,QAAA,CAAS,OAAA,CAAQ;AAAA,MACjC,QAAQ,IAAA,CAAK,MAAA;AAAA,MACb,GAAA;AAAA,MACA,QAAQ,eAAA,EAAiB,KAAA;AAAA,MACzB,MAAM,eAAA,EAAiB,IAAA;AAAA,MACvB;AAAA,KACD,CAAA;AAED,IAAA,IAAI,MAAA;AACJ,IAAA,IAAI,cAAA,CAAe,OAAA,EAAS,UAAU,CAAA,EAAG;AACvC,MAAA,IAAI;AACF,QAAA,MAAA,GAAS,IAAA,CAAK,QAAA,CAAS,KAAA,CAAM,GAAG,CAAA;AAAA,MAClC,SAAS,GAAA,EAAK;AACZ,QAAA,MAAM,IAAI,eAAA,CAAgB,4BAAA,EAA8B,GAAG,CAAA;AAAA,MAC7D;AAAA,IACF,CAAA,MAAO;AACL,MAAA,MAAA,GAAS,GAAA;AAAA,IACX;AAEA,IAAA,OAAO,IAAA,CAAK,OAAA,GAAU,IAAA,CAAK,OAAA,CAAQ,MAAM,CAAA,GAAI,MAAA;AAAA,EAC/C,CAAA;AACF;;;AC7LO,SAAS,cAAA,CACd,OAAA,EACA,WAAA,GAAoC,EAAC,EAC3B;AACV,EAAA,MAAM,KAAA,GAAQ,WAAA,CAAY,WAAA,CAExB,CAAC,IAAA,EAAM,EAAA,KAAO,CAAC,IAAA,KAAS,EAAA,CAAG,IAAA,EAAM,IAAI,CAAA,EAAG,OAAO,CAAA;AACjD,EAAA,OAAO,EAAE,SAAS,KAAA,EAAM;AAC1B;AA4BO,SAAS,iBACd,QAAA,EACU;AACV,EAAA,OAAO;AAAA,IACL,SAAS,CAAC,IAAA,KAAS,SAAS,IAAI,CAAA,CAAE,QAAQ,IAAI;AAAA,GAChD;AACF;;;AC4DO,SAAS,SAAS,IAAA,EAAwB;AAC/C,EAAA,OAAO,IAAA;AACT;;;ACzHO,IAAM,YAAA,GAAN,cAA2B,KAAA,CAAM;AAAA,EACtC,YAA4B,EAAA,EAAY;AACtC,IAAA,KAAA,CAAM,CAAA,wBAAA,EAA2B,EAAE,CAAA,EAAA,CAAI,CAAA;AADb,IAAA,IAAA,CAAA,EAAA,GAAA,EAAA;AAE1B,IAAA,IAAA,CAAK,IAAA,GAAO,cAAA;AAAA,EACd;AACF;AAeO,SAAS,iBAAiB,EAAA,EAA4C;AAC3E,EAAA,OAAO,EAAA;AACT;AAoBO,SAAS,SAAA,CACd,OACA,OAAA,EACoB;AACpB,EAAA,OAAO,gBAAA,CAAiB,OAAO,IAAA,EAAM,IAAA,KAAS;AAC5C,IAAA,IAAI,SAAA;AACJ,IAAA,KAAA,IAAS,OAAA,GAAU,CAAA,EAAG,OAAA,IAAW,KAAA,EAAO,OAAA,EAAA,EAAW;AACjD,MAAA,IAAI;AACF,QAAA,OAAO,MAAM,KAAK,IAAI,CAAA;AAAA,MACxB,SAAS,GAAA,EAAK;AACZ,QAAA,SAAA,GAAY,GAAA;AACZ,QAAA,IAAI,YAAY,KAAA,EAAO;AACvB,QAAA,IAAI,SAAS,WAAA,IAAe,CAAC,QAAQ,WAAA,CAAY,GAAA,EAAK,OAAO,CAAA,EAAG;AAAA,MAClE;AAAA,IACF;AACA,IAAA,MAAM,SAAA;AAAA,EACR,CAAC,CAAA;AACH;AAUO,SAAS,YAAY,EAAA,EAAgC;AAC1D,EAAA,OAAO,gBAAA,CAAiB,OAAO,IAAA,EAAM,IAAA,KAAS;AAC5C,IAAA,MAAM,UAAA,GAAa,IAAI,eAAA,EAAgB;AACvC,IAAA,MAAM,KAAA,GAAQ,UAAA,CAAW,MAAM,UAAA,CAAW,KAAA,CAAM,IAAI,YAAA,CAAa,EAAE,CAAC,CAAA,EAAG,EAAE,CAAA;AAEzE,IAAA,MAAM,EAAE,MAAA,EAAQ,OAAA,KAAY,IAAA,CAAK,MAAA,GAC7B,UAAU,CAAC,IAAA,CAAK,QAAQ,UAAA,CAAW,MAAM,CAAC,CAAA,GAC1C,EAAE,QAAQ,UAAA,CAAW,MAAA,EAAQ,SAAS,MAAM;AAAA,IAAC,CAAA,EAAE;AAEnD,IAAA,IAAI;AACF,MAAA,OAAO,MAAM,IAAA,CAAK,EAAE,GAAG,IAAA,EAAM,QAAQ,CAAA;AAAA,IACvC,CAAA,SAAE;AACA,MAAA,YAAA,CAAa,KAAK,CAAA;AAClB,MAAA,OAAA,EAAQ;AAAA,IACV;AAAA,EACF,CAAC,CAAA;AACH;AAYO,SAAS,WAAW,OAAA,EAEJ;AACrB,EAAA,MAAM,GAAA,GAAM,SAAS,GAAA,KAAQ,CAAC,KAAK,IAAA,KAAS,OAAA,CAAQ,GAAA,CAAI,GAAA,EAAK,IAAI,CAAA,CAAA;AACjE,EAAA,OAAO,gBAAA,CAAiB,OAAO,IAAA,EAAM,IAAA,KAAS;AAC5C,IAAA,MAAM,KAAA,GAAQ,KAAK,GAAA,EAAI;AACvB,IAAA,GAAA,CAAI,YAAY,IAAA,CAAK,MAAM,CAAA,CAAA,EAAI,IAAA,CAAK,GAAG,CAAA,CAAA,EAAI;AAAA,MACzC,QAAQ,IAAA,CAAK,MAAA;AAAA,MACb,MAAM,IAAA,CAAK;AAAA,KACZ,CAAA;AACD,IAAA,IAAI;AACF,MAAA,MAAM,MAAA,GAAS,MAAM,IAAA,CAAK,IAAI,CAAA;AAC9B,MAAA,GAAA,CAAI,CAAA,SAAA,EAAY,IAAA,CAAK,MAAM,CAAA,CAAA,EAAI,IAAA,CAAK,GAAG,CAAA,QAAA,EAAM,IAAA,CAAK,GAAA,EAAI,GAAI,KAAK,CAAA,EAAA,CAAI,CAAA;AACnE,MAAA,OAAO,MAAA;AAAA,IACT,SAAS,GAAA,EAAK;AACZ,MAAA,GAAA;AAAA,QACE,CAAA,SAAA,EAAY,IAAA,CAAK,MAAM,CAAA,CAAA,EAAI,IAAA,CAAK,GAAG,CAAA,oBAAA,EAAkB,IAAA,CAAK,GAAA,EAAI,GAAI,KAAK,CAAA,EAAA,CAAA;AAAA,QACvE;AAAA,OACF;AACA,MAAA,MAAM,GAAA;AAAA,IACR;AAAA,EACF,CAAC,CAAA;AACH;AAGA,SAAS,UAAU,OAAA,EAGjB;AACA,EAAA,MAAM,UAAA,GAAa,IAAI,eAAA,EAAgB;AACvC,EAAA,MAAM,OAAA,GAAU,MAAM,UAAA,CAAW,KAAA,EAAM;AACvC,EAAA,MAAM,WAA0B,EAAC;AACjC,EAAA,KAAA,MAAW,KAAK,OAAA,EAAS;AACvB,IAAA,IAAI,EAAE,OAAA,EAAS;AACb,MAAA,UAAA,CAAW,KAAA,EAAM;AACjB,MAAA;AAAA,IACF;AACA,IAAA,CAAA,CAAE,iBAAiB,OAAA,EAAS,OAAA,EAAS,EAAE,IAAA,EAAM,MAAM,CAAA;AACnD,IAAA,QAAA,CAAS,KAAK,CAAC,CAAA;AAAA,EACjB;AACA,EAAA,OAAO;AAAA,IACL,QAAQ,UAAA,CAAW,MAAA;AAAA,IACnB,OAAA,EAAS,MACP,QAAA,CAAS,OAAA,CAAQ,CAAC,CAAA,KAAM;AACtB,MAAA,CAAA,CAAE,mBAAA,CAAoB,SAAS,OAAO,CAAA;AAAA,IACxC,CAAC;AAAA,GACL;AACF;;;ACtJO,SAAS,gBACd,MAAA,EACiB;AACjB,EAAA,MAAM,MAAA,GAAS,IAAI,eAAA,EAAgB;AACnC,EAAA,KAAA,MAAW,CAAC,GAAA,EAAK,KAAK,KAAK,MAAA,CAAO,OAAA,CAAQ,MAAM,CAAA,EAAG;AACjD,IAAA,IAAI,SAAS,IAAA,EAAM;AACnB,IAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,KAAK,CAAA,EAAG;AACxB,MAAA,KAAA,MAAW,QAAQ,KAAA,EAAO;AACxB,QAAA,IAAI,QAAQ,IAAA,EAAM,MAAA,CAAO,OAAO,GAAA,EAAK,MAAA,CAAO,IAAI,CAAC,CAAA;AAAA,MACnD;AAAA,IACF,CAAA,MAAA,IAAW,OAAO,KAAA,KAAU,QAAA,EAAU;AACpC,MAAA,MAAM,IAAI,SAAA;AAAA,QACR,mCAAmC,GAAG,CAAA,kFAAA;AAAA,OACxC;AAAA,IACF,CAAA,MAAO;AACL,MAAA,MAAA,CAAO,MAAA,CAAO,GAAA,EAAK,MAAA,CAAO,KAAK,CAAC,CAAA;AAAA,IAClC;AAAA,EACF;AACA,EAAA,OAAO,MAAA;AACT","file":"index.cjs","sourcesContent":["import type { RouterDef, RouterEndpoints } from \"./types.js\";\n\n/**\n * Groups a set of endpoint specs (and optional nested routers) under a shared\n * URL prefix.\n *\n * The returned {@link RouterDef} can be passed directly to {@link createApi}\n * to produce a fully-typed API client. Nesting another {@link RouterDef} as a\n * value creates a sub-client whose prefix is the concatenation of both prefixes.\n *\n * @param prefix - Base path prepended to every endpoint's `path` (e.g. `'/users'`).\n * @param endpoints - Record of named {@link EndpointSpec}s or nested {@link RouterDef}s.\n *\n * @example\n * ```ts\n * // Flat router\n * export const todoRouter = defineRouter('/todos', {\n * getList: endpoint({ method: 'GET', path: '/', response: TodoListSchema }),\n * getDetail: endpoint({ method: 'GET', path: '/:id', response: TodoSchema }),\n * create: endpoint({ method: 'POST', path: '/', response: TodoSchema }),\n * });\n *\n * // Nested router — api.users.todos.getList() resolves to GET /users/todos/\n * export const userRouter = defineRouter('/users', {\n * getList: endpoint({ method: 'GET', path: '/', response: UserListSchema }),\n * todos: defineRouter('/todos', {\n * getList: endpoint({ method: 'GET', path: '/', response: TodoListSchema }),\n * getDetail: endpoint({ method: 'GET', path: '/:id', response: TodoSchema }),\n * }),\n * });\n * ```\n */\n/** Type guard — distinguishes a {@link RouterDef} from a leaf {@link EndpointSpec} at runtime. */\nexport function isRouterDef(entry: object): entry is RouterDef<RouterEndpoints> {\n return \"prefix\" in entry && \"endpoints\" in entry;\n}\n\nexport function defineRouter<TEndpoints extends RouterEndpoints>(\n prefix: string,\n endpoints: TEndpoints,\n): RouterDef<TEndpoints> {\n return { prefix, endpoints };\n}\n","/**\n * Joins URL path segments, normalising repeated slashes and trailing slashes.\n *\n * **Note:** Intended for relative API paths only. Absolute URLs containing\n * `://` will be collapsed (`https://` → `https:/`). Pass absolute URLs\n * directly to the executor instead of through this helper.\n */\nexport function joinPaths(...segments: string[]): string {\n const joined = segments\n .filter((s) => s !== \"\")\n .join(\"/\")\n .replace(/\\/+/g, \"/\");\n return joined.endsWith(\"/\") && joined.length > 1\n ? joined.slice(0, -1)\n : joined || \"/\";\n}\n\nexport function resolvePath(\n pathTemplate: string,\n params?: Record<string, unknown>,\n): string {\n if (!params) return pathTemplate;\n return pathTemplate.replace(/:([a-zA-Z_][a-zA-Z0-9_]*)/g, (_, key) => {\n const value = params[key];\n if (value == null || value === \"\") throw new Error(`Missing path parameter: ${key}`);\n return encodeURIComponent(String(value));\n });\n}\n","export class ValidationError extends Error {\n readonly cause?: unknown;\n\n constructor(message: string, cause?: unknown) {\n super(message);\n this.name = \"ValidationError\";\n if (cause !== undefined) {\n Object.defineProperty(this, \"cause\", {\n value: cause,\n writable: false,\n enumerable: false,\n configurable: true,\n });\n }\n }\n}\n","import { isRouterDef } from \"./define-router.js\";\nimport type {\n CreateApiOptions,\n EndpointSpec,\n Executor,\n InferResponse,\n RequestShape,\n RouterDef,\n RouterEndpoints,\n ValidatorOutput,\n} from \"./types.js\";\nimport { joinPaths, resolvePath } from \"./utils/path.js\";\nimport { ValidationError } from \"./utils/validate.js\";\n\n/** Callable type for a single endpoint on the generated API client. */\ntype EndpointFn<TSpec extends EndpointSpec<any, any, any>> =\n TSpec[\"request\"] extends { parse: (data: unknown) => infer R }\n ? (params: R, signal?: AbortSignal) => Promise<InferResponse<TSpec>>\n : (\n params?: RequestShape,\n signal?: AbortSignal,\n ) => Promise<InferResponse<TSpec>>;\n\n/**\n * Fully-typed API client produced by {@link createApi}.\n * Nested {@link RouterDef} entries become nested sub-client objects.\n */\ntype ApiClient<TEndpoints extends RouterEndpoints> = {\n [K in keyof TEndpoints]: TEndpoints[K] extends RouterDef<\n infer TNestedEndpoints\n >\n ? ApiClient<TNestedEndpoints>\n : TEndpoints[K] extends EndpointSpec<any, any, any>\n ? EndpointFn<TEndpoints[K]>\n : never;\n};\n\n/**\n * Builds a fully-typed API client from an {@link Executor} and a router\n * (or bare endpoint map).\n *\n * Three call signatures are supported:\n * - `createApi(executor, router)` — preferred; pass the result of {@link defineRouter}.\n * - `createApi(executor, prefix, endpoints)` — inline router without {@link defineRouter}.\n * - `createApi(executor, endpoints)` — no prefix; useful for flat endpoint maps.\n *\n * Each key in `endpoints` becomes a typed async function on the returned client.\n * The function validates the request with `spec.request.parse` (if present),\n * resolves path parameters, calls the executor, validates the response with\n * `spec.response.parse`, and applies `spec.adapter` (if present).\n *\n * @param executor - Transport to use for every HTTP call.\n * @param router - A {@link RouterDef} produced by {@link defineRouter}.\n * @param options - Optional settings (e.g. `validate` to skip schema parsing in production).\n *\n * @example\n * ```ts\n * const todoApi = createApi(executor, todoRouter);\n * const todos = await todoApi.getList({});\n * const todo = await todoApi.getDetail({ path: { id: 1 } });\n *\n * // Skip response validation in production\n * const prodApi = createApi(executor, todoRouter, {\n * validate: { request: true, response: process.env.NODE_ENV !== 'production' },\n * });\n * ```\n */\nexport function createApi<TEndpoints extends RouterEndpoints>(\n executor: Executor,\n router: RouterDef<TEndpoints>,\n options?: CreateApiOptions,\n): ApiClient<TEndpoints>;\n\n/**\n * @param executor - Transport to use for every HTTP call.\n * @param prefix - URL prefix prepended to every endpoint path.\n * @param endpoints - Record of named endpoint specs.\n * @param options - Optional settings.\n */\nexport function createApi<TEndpoints extends RouterEndpoints>(\n executor: Executor,\n prefix: string,\n endpoints: TEndpoints,\n options?: CreateApiOptions,\n): ApiClient<TEndpoints>;\n\n/**\n * @param executor - Transport to use for every HTTP call.\n * @param endpoints - Record of named endpoint specs (no URL prefix).\n * @param options - Optional settings.\n */\nexport function createApi<TEndpoints extends RouterEndpoints>(\n executor: Executor,\n endpoints: TEndpoints,\n options?: CreateApiOptions,\n): ApiClient<TEndpoints>;\n\nexport function createApi(\n executor: Executor,\n routerOrPrefixOrEndpoints:\n | RouterDef<RouterEndpoints>\n | RouterEndpoints\n | string,\n endpointsArgOrOptions?: RouterEndpoints | CreateApiOptions,\n optionsArg?: CreateApiOptions,\n): Record<string, unknown> {\n const { prefix, endpoints, options } = resolveArgs(\n routerOrPrefixOrEndpoints,\n endpointsArgOrOptions,\n optionsArg,\n );\n return buildClient(executor, prefix, endpoints, options);\n}\n\nfunction resolveArgs(\n second: RouterDef<RouterEndpoints> | RouterEndpoints | string,\n third: RouterEndpoints | CreateApiOptions | undefined,\n fourth: CreateApiOptions | undefined,\n): {\n prefix: string;\n endpoints: RouterEndpoints;\n options: CreateApiOptions | undefined;\n} {\n if (typeof second === \"string\") {\n if (!third)\n throw new Error(\"endpoints is required when prefix is provided\");\n return {\n prefix: second,\n endpoints: third as RouterEndpoints,\n options: fourth,\n };\n }\n if (isRouterDef(second)) {\n return {\n prefix: second.prefix,\n endpoints: second.endpoints,\n options: third as CreateApiOptions | undefined,\n };\n }\n return {\n prefix: \"\",\n endpoints: second as RouterEndpoints,\n options: third as CreateApiOptions | undefined,\n };\n}\n\nfunction shouldValidate(\n options: CreateApiOptions | undefined,\n kind: \"request\" | \"response\",\n): boolean {\n const v = options?.validate;\n if (v === undefined || v === true) return true;\n if (v === false) return false;\n return v[kind] ?? true;\n}\n\nfunction buildClient(\n executor: Executor,\n prefix: string,\n endpoints: RouterEndpoints,\n options?: CreateApiOptions,\n): Record<string, unknown> {\n const client: Record<string, unknown> = {};\n\n for (const [key, entry] of Object.entries(endpoints)) {\n client[key] = isRouterDef(entry)\n ? buildClient(executor, joinPaths(prefix, entry.prefix), entry.endpoints, options)\n : buildEndpointFn(executor, prefix, entry as EndpointSpec<any, any, any>, options);\n }\n\n return client;\n}\n\nfunction buildEndpointFn(\n executor: Executor,\n prefix: string,\n spec: EndpointSpec<any, any, any>,\n options: CreateApiOptions | undefined,\n) {\n return async (params: RequestShape = {}, signal?: AbortSignal) => {\n let validatedParams: RequestShape = params;\n if (spec.request && shouldValidate(options, \"request\")) {\n try {\n validatedParams = spec.request.parse(params);\n } catch (err) {\n throw new ValidationError(\"Request validation failed\", err);\n }\n }\n\n const url = resolvePath(joinPaths(prefix, spec.path), validatedParams?.path);\n\n const raw = await executor.execute({\n method: spec.method,\n url,\n params: validatedParams?.query as Record<string, unknown> | undefined,\n body: validatedParams?.body,\n signal,\n });\n\n let result: ValidatorOutput<typeof spec.response>;\n if (shouldValidate(options, \"response\")) {\n try {\n result = spec.response.parse(raw);\n } catch (err) {\n throw new ValidationError(\"Response validation failed\", err);\n }\n } else {\n result = raw;\n }\n\n return spec.adapter ? spec.adapter(result) : result;\n };\n}\n","import type { ExecuteOptions, Executor, ExecutorMiddleware } from \"./types.js\";\n\n/**\n * Creates an {@link Executor} by wrapping a transport function with an\n * optional middleware chain.\n *\n * Middlewares are applied in declaration order — the first middleware is the\n * outermost wrapper and runs first on each request.\n *\n * @param execute - The underlying transport function (fetch, axios, etc.).\n * @param middlewares - Ordered list of middlewares to apply.\n *\n * @example\n * ```ts\n * const executor = createExecutor(\n * async ({ method, url, body }) => {\n * const res = await fetch(url, { method, body: JSON.stringify(body) });\n * return res.json();\n * },\n * [withTimeout(5000), withRetry(3), withLogger()],\n * );\n * ```\n */\nexport function createExecutor(\n execute: (options: ExecuteOptions) => Promise<unknown>,\n middlewares: ExecutorMiddleware[] = [],\n): Executor {\n const chain = middlewares.reduceRight<\n (options: ExecuteOptions) => Promise<unknown>\n >((next, mw) => (opts) => mw(opts, next), execute);\n return { execute: chain };\n}\n\n/**\n * Creates an {@link Executor} that selects the underlying transport at\n * request time based on the result of `resolver`.\n *\n * Use this to unify SSR and CSR behind a single API client — the resolver\n * picks the right executor per request, so `createApi` is called once and\n * works in both environments without duplicate `*ServerApi` instances.\n *\n * The resolver receives the full {@link ExecuteOptions} so it can branch on\n * environment, URL prefix, auth context, or any runtime condition.\n *\n * @param resolver - Called on every request; returns the executor to delegate to.\n *\n * @example\n * ```ts\n * // SSR vs CSR — pick transport based on environment\n * const apiExecutor = dispatchExecutor(() =>\n * typeof window === 'undefined' ? serverExecutor : clientExecutor,\n * );\n *\n * // Route by URL prefix — internal routes use a different transport\n * const apiExecutor = dispatchExecutor((opts) =>\n * opts.url.startsWith('/internal') ? internalExecutor : publicExecutor,\n * );\n * ```\n */\nexport function dispatchExecutor(\n resolver: (opts: ExecuteOptions) => Executor,\n): Executor {\n return {\n execute: (opts) => resolver(opts).execute(opts),\n };\n}\n","import type {\n HttpMethod,\n RequestShape,\n Validator,\n ValidatorOutput,\n} from \"./types.js\";\n\n/**\n * Extracts `:param` segment names from a path template string as a union of\n * string literals.\n *\n * @example\n * ```ts\n * type P = PathParams<'/:userId/posts/:postId'>; // 'userId' | 'postId'\n * ```\n */\nexport type PathParams<TPath extends string> =\n TPath extends `${string}:${infer Param}/${infer Rest}`\n ? Param | PathParams<Rest>\n : TPath extends `${string}:${infer Param}`\n ? Param\n : never;\n\n/**\n * When `TPath` contains dynamic segments (`:param`), requires `request.path`\n * to include all extracted param names. No constraint for static paths.\n */\ntype PathConstraint<TPath extends string> = [PathParams<TPath>] extends [never]\n ? {}\n : { path: Record<PathParams<TPath>, unknown> };\n\n/**\n * Type-safe endpoint definition helper.\n *\n * Use this instead of a plain object literal to get full type inference on\n * `adapter` without requiring explicit annotations or `as any` casts.\n * The four overloads cover every combination of optional `request` validator\n * and optional `adapter` function while keeping all return-type fields\n * required so that TypeScript can narrow them downstream.\n *\n * When `path` contains dynamic segments (e.g. `'/:id'`), TypeScript enforces\n * that `request` includes a matching `path` field with those param names.\n * A mismatch or missing key is a compile-time error.\n *\n * @example\n * ```ts\n * // ✅ path has ':id' → request.path.id is required\n * const getDetail = endpoint({\n * method: 'GET',\n * path: '/:id',\n * request: z.object({ path: z.object({ id: z.number() }) }),\n * response: TodoSchema,\n * adapter: toTodoItem,\n * });\n *\n * // ❌ compile error — 'id' is missing from request.path\n * const broken = endpoint({\n * method: 'GET',\n * path: '/:id',\n * request: z.object({ query: z.object({ foo: z.string() }) }),\n * response: TodoSchema,\n * });\n * ```\n */\n// request O + adapter O\nexport function endpoint<\n TPath extends string,\n TRequest extends RequestShape & PathConstraint<TPath>,\n TResponse extends Validator<unknown>,\n TOut,\n>(spec: {\n method: HttpMethod;\n path: TPath;\n request: Validator<TRequest>;\n response: TResponse;\n adapter: (raw: ValidatorOutput<TResponse>) => TOut;\n}): {\n method: HttpMethod;\n path: string;\n request: Validator<TRequest>;\n response: TResponse;\n adapter: (raw: ValidatorOutput<TResponse>) => TOut;\n};\n\n// request O + adapter X\nexport function endpoint<\n TPath extends string,\n TRequest extends RequestShape & PathConstraint<TPath>,\n TResponse extends Validator<unknown>,\n>(spec: {\n method: HttpMethod;\n path: TPath;\n request: Validator<TRequest>;\n response: TResponse;\n}): {\n method: HttpMethod;\n path: string;\n request: Validator<TRequest>;\n response: TResponse;\n};\n\n// request X + adapter O\nexport function endpoint<TResponse extends Validator<unknown>, TOut>(spec: {\n method: HttpMethod;\n path: string;\n response: TResponse;\n adapter: (raw: ValidatorOutput<TResponse>) => TOut;\n}): {\n method: HttpMethod;\n path: string;\n response: TResponse;\n adapter: (raw: ValidatorOutput<TResponse>) => TOut;\n};\n\n// request X + adapter X\nexport function endpoint<TResponse extends Validator<unknown>>(spec: {\n method: HttpMethod;\n path: string;\n response: TResponse;\n}): {\n method: HttpMethod;\n path: string;\n response: TResponse;\n};\n\nexport function endpoint(spec: unknown): unknown {\n return spec;\n}\n","import type { ExecutorMiddleware } from \"./types.js\";\n\n/**\n * Thrown by {@link withTimeout} when a request exceeds the configured duration.\n * Distinguishable from a user-initiated {@link AbortSignal} cancellation.\n */\nexport class TimeoutError extends Error {\n constructor(public readonly ms: number) {\n super(`Request timed out after ${ms}ms`);\n this.name = \"TimeoutError\";\n }\n}\n\n/**\n * Identity helper that returns the middleware as-is.\n *\n * Wrap your middleware function with this to get full type inference on `opts`\n * and `next` without having to annotate the type manually.\n *\n * @example\n * ```ts\n * const withCorrelationId = defineMiddleware((opts, next) =>\n * next({ ...opts, headers: { ...opts.headers, 'X-Request-Id': crypto.randomUUID() } })\n * );\n * ```\n */\nexport function defineMiddleware(fn: ExecutorMiddleware): ExecutorMiddleware {\n return fn;\n}\n\n/**\n * Retries a failed request up to `count` additional times.\n *\n * By default all errors trigger a retry. Pass `shouldRetry` to skip retries\n * for non-transient errors (e.g. 4xx responses).\n *\n * @param count - Number of retries (not counting the initial attempt).\n * @param options.shouldRetry - Return `false` to stop retrying early.\n * Receives the error and a zero-based `attempt` index (0 = first failure,\n * 1 = second failure, …) so you can limit retries by count or error type.\n *\n * @example\n * ```ts\n * withRetry(3, {\n * shouldRetry: (err) => err instanceof HttpError && err.status >= 500,\n * })\n * ```\n */\nexport function withRetry(\n count: number,\n options?: { shouldRetry?: (error: unknown, attempt: number) => boolean },\n): ExecutorMiddleware {\n return defineMiddleware(async (opts, next) => {\n let lastError: unknown;\n for (let attempt = 0; attempt <= count; attempt++) {\n try {\n return await next(opts);\n } catch (err) {\n lastError = err;\n if (attempt === count) break;\n if (options?.shouldRetry && !options.shouldRetry(err, attempt)) break;\n }\n }\n throw lastError;\n });\n}\n\n/**\n * Aborts a request if it does not complete within `ms` milliseconds.\n *\n * Merges the timeout signal with any existing `AbortSignal` on the request,\n * so whichever fires first wins.\n *\n * @param ms - Timeout in milliseconds.\n */\nexport function withTimeout(ms: number): ExecutorMiddleware {\n return defineMiddleware(async (opts, next) => {\n const controller = new AbortController();\n const timer = setTimeout(() => controller.abort(new TimeoutError(ms)), ms);\n\n const { signal, cleanup } = opts.signal\n ? anySignal([opts.signal, controller.signal])\n : { signal: controller.signal, cleanup: () => {} };\n\n try {\n return await next({ ...opts, signal });\n } finally {\n clearTimeout(timer);\n cleanup();\n }\n });\n}\n\n/**\n * Logs each request and its outcome (success duration or error).\n *\n * @param options.log - Custom logging function. Defaults to `console.log`.\n *\n * @example\n * ```ts\n * withLogger({ log: (msg, data) => logger.debug(msg, data) })\n * ```\n */\nexport function withLogger(options?: {\n log?: (message: string, data?: unknown) => void;\n}): ExecutorMiddleware {\n const log = options?.log ?? ((msg, data) => console.log(msg, data));\n return defineMiddleware(async (opts, next) => {\n const start = Date.now();\n log(`[routar] ${opts.method} ${opts.url}`, {\n params: opts.params,\n body: opts.body,\n });\n try {\n const result = await next(opts);\n log(`[routar] ${opts.method} ${opts.url} — ${Date.now() - start}ms`);\n return result;\n } catch (err) {\n log(\n `[routar] ${opts.method} ${opts.url} — error after ${Date.now() - start}ms`,\n err,\n );\n throw err;\n }\n });\n}\n\n/** Combines multiple AbortSignals into one that aborts when any of them fire. */\nfunction anySignal(signals: AbortSignal[]): {\n signal: AbortSignal;\n cleanup: () => void;\n} {\n const controller = new AbortController();\n const onAbort = () => controller.abort();\n const attached: AbortSignal[] = [];\n for (const s of signals) {\n if (s.aborted) {\n controller.abort();\n break;\n }\n s.addEventListener(\"abort\", onAbort, { once: true });\n attached.push(s);\n }\n return {\n signal: controller.signal,\n cleanup: () =>\n attached.forEach((s) => {\n s.removeEventListener(\"abort\", onAbort);\n }),\n };\n}\n","export function serializeParams(\n params: Record<string, unknown>,\n): URLSearchParams {\n const result = new URLSearchParams();\n for (const [key, value] of Object.entries(params)) {\n if (value == null) continue;\n if (Array.isArray(value)) {\n for (const item of value) {\n if (item != null) result.append(key, String(item));\n }\n } else if (typeof value === \"object\") {\n throw new TypeError(\n `serializeParams: value for key \"${key}\" is a plain object. Serialize it to a string before passing as a query parameter.`,\n );\n } else {\n result.append(key, String(value));\n }\n }\n return result;\n}\n"]}
|
|
1
|
+
{"version":3,"sources":["../src/define-router.ts","../src/utils/path.ts","../src/utils/validate.ts","../src/create-api.ts","../src/create-executor.ts","../src/utils/params.ts","../src/create-fetch-executor.ts","../src/define-endpoint.ts","../src/middleware.ts"],"names":[],"mappings":";;;AAiCO,SAAS,YAAY,KAAA,EAAoD;AAC9E,EAAA,OAAO,QAAA,IAAY,SAAS,WAAA,IAAe,KAAA;AAC7C;AAEO,SAAS,YAAA,CACd,QACA,SAAA,EACuB;AACvB,EAAA,OAAO,EAAE,QAAQ,SAAA,EAAU;AAC7B;;;ACnCO,SAAS,aAAa,QAAA,EAA4B;AACvD,EAAA,MAAM,MAAA,GAAS,QAAA,CACZ,MAAA,CAAO,CAAC,CAAA,KAAM,CAAA,KAAM,EAAE,CAAA,CACtB,IAAA,CAAK,GAAG,CAAA,CACR,OAAA,CAAQ,QAAQ,GAAG,CAAA;AACtB,EAAA,OAAO,MAAA,CAAO,QAAA,CAAS,GAAG,CAAA,IAAK,MAAA,CAAO,MAAA,GAAS,CAAA,GAC3C,MAAA,CAAO,KAAA,CAAM,CAAA,EAAG,EAAE,CAAA,GAClB,MAAA,IAAU,GAAA;AAChB;AAEO,SAAS,WAAA,CACd,cACA,MAAA,EACQ;AACR,EAAA,IAAI,CAAC,QAAQ,OAAO,YAAA;AACpB,EAAA,OAAO,YAAA,CAAa,OAAA,CAAQ,4BAAA,EAA8B,CAAC,GAAG,GAAA,KAAQ;AACpE,IAAA,MAAM,KAAA,GAAQ,OAAO,GAAG,CAAA;AACxB,IAAA,IAAI,KAAA,IAAS,QAAQ,KAAA,KAAU,EAAA,QAAU,IAAI,KAAA,CAAM,CAAA,wBAAA,EAA2B,GAAG,CAAA,CAAE,CAAA;AACnF,IAAA,OAAO,kBAAA,CAAmB,MAAA,CAAO,KAAK,CAAC,CAAA;AAAA,EACzC,CAAC,CAAA;AACH;;;AC3BO,IAAM,eAAA,GAAN,cAA8B,KAAA,CAAM;AAAA,EAGzC,WAAA,CAAY,SAAiB,KAAA,EAAiB;AAC5C,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,IAAA,GAAO,iBAAA;AACZ,IAAA,IAAI,UAAU,MAAA,EAAW;AACvB,MAAA,MAAA,CAAO,cAAA,CAAe,MAAM,OAAA,EAAS;AAAA,QACnC,KAAA,EAAO,KAAA;AAAA,QACP,QAAA,EAAU,KAAA;AAAA,QACV,UAAA,EAAY,KAAA;AAAA,QACZ,YAAA,EAAc;AAAA,OACf,CAAA;AAAA,IACH;AAAA,EACF;AACF;;;AC2GO,SAAS,SAAA,CACd,QAAA,EACA,yBAAA,EAIA,qBAAA,EACA,UAAA,EACyB;AACzB,EAAA,MAAM,EAAE,MAAA,EAAQ,SAAA,EAAW,OAAA,EAAQ,GAAI,WAAA;AAAA,IACrC,yBAAA;AAAA,IACA,qBAAA;AAAA,IACA;AAAA,GACF;AACA,EAAA,OAAO,WAAA,CAAY,QAAA,EAAU,MAAA,EAAQ,SAAA,EAAW,OAAO,CAAA;AACzD;AAEA,SAAS,WAAA,CACP,MAAA,EACA,KAAA,EACA,MAAA,EAKA;AACA,EAAA,IAAI,OAAO,WAAW,QAAA,EAAU;AAC9B,IAAA,IAAI,CAAC,KAAA;AACH,MAAA,MAAM,IAAI,MAAM,+CAA+C,CAAA;AACjE,IAAA,OAAO;AAAA,MACL,MAAA,EAAQ,MAAA;AAAA,MACR,SAAA,EAAW,KAAA;AAAA,MACX,OAAA,EAAS;AAAA,KACX;AAAA,EACF;AACA,EAAA,IAAI,WAAA,CAAY,MAAM,CAAA,EAAG;AACvB,IAAA,OAAO;AAAA,MACL,QAAQ,MAAA,CAAO,MAAA;AAAA,MACf,WAAW,MAAA,CAAO,SAAA;AAAA,MAClB,OAAA,EAAS;AAAA,KACX;AAAA,EACF;AACA,EAAA,OAAO;AAAA,IACL,MAAA,EAAQ,EAAA;AAAA,IACR,SAAA,EAAW,MAAA;AAAA,IACX,OAAA,EAAS;AAAA,GACX;AACF;AAEA,SAAS,cAAA,CACP,SACA,IAAA,EACS;AACT,EAAA,MAAM,IAAI,OAAA,EAAS,QAAA;AACnB,EAAA,IAAI,CAAA,KAAM,MAAA,IAAa,CAAA,KAAM,IAAA,EAAM,OAAO,IAAA;AAC1C,EAAA,IAAI,CAAA,KAAM,OAAO,OAAO,KAAA;AACxB,EAAA,OAAO,CAAA,CAAE,IAAI,CAAA,IAAK,IAAA;AACpB;AAEA,SAAS,WAAA,CACP,QAAA,EACA,MAAA,EACA,SAAA,EACA,OAAA,EACyB;AACzB,EAAA,MAAM,SAAkC,EAAC;AAEzC,EAAA,KAAA,MAAW,CAAC,GAAA,EAAK,KAAK,KAAK,MAAA,CAAO,OAAA,CAAQ,SAAS,CAAA,EAAG;AACpD,IAAA,MAAA,CAAO,GAAG,IAAI,WAAA,CAAY,KAAK,IAC3B,WAAA,CAAY,QAAA,EAAU,UAAU,MAAA,EAAQ,KAAA,CAAM,MAAM,CAAA,EAAG,KAAA,CAAM,WAAW,OAAO,CAAA,GAC/E,gBAAgB,QAAA,EAAU,MAAA,EAAQ,OAAsC,OAAO,CAAA;AAAA,EACrF;AAEA,EAAA,OAAO,MAAA;AACT;AAEA,SAAS,eAAA,CACP,QAAA,EACA,MAAA,EACA,IAAA,EACA,OAAA,EACA;AACA,EAAA,OAAO,OAAO,MAAA,GAAuB,EAAC,EAAG,MAAA,KAAyB;AAChE,IAAA,IAAI,eAAA,GAAgC,MAAA;AACpC,IAAA,IAAI,IAAA,CAAK,OAAA,IAAW,cAAA,CAAe,OAAA,EAAS,SAAS,CAAA,EAAG;AACtD,MAAA,IAAI;AACF,QAAA,eAAA,GAAkB,IAAA,CAAK,OAAA,CAAQ,KAAA,CAAM,MAAM,CAAA;AAAA,MAC7C,SAAS,GAAA,EAAK;AACZ,QAAA,MAAM,IAAI,eAAA,CAAgB,2BAAA,EAA6B,GAAG,CAAA;AAAA,MAC5D;AAAA,IACF;AAEA,IAAA,MAAM,GAAA,GAAM,YAAY,SAAA,CAAU,MAAA,EAAQ,KAAK,IAAI,CAAA,EAAG,iBAAiB,IAAI,CAAA;AAE3E,IAAA,MAAM,GAAA,GAAM,MAAM,QAAA,CAAS,OAAA,CAAQ;AAAA,MACjC,QAAQ,IAAA,CAAK,MAAA;AAAA,MACb,GAAA;AAAA,MACA,QAAQ,eAAA,EAAiB,KAAA;AAAA,MACzB,MAAM,eAAA,EAAiB,IAAA;AAAA,MACvB;AAAA,KACD,CAAA;AAED,IAAA,IAAI,MAAA;AACJ,IAAA,IAAI,cAAA,CAAe,OAAA,EAAS,UAAU,CAAA,EAAG;AACvC,MAAA,IAAI;AACF,QAAA,MAAA,GAAS,IAAA,CAAK,QAAA,CAAS,KAAA,CAAM,GAAG,CAAA;AAAA,MAClC,SAAS,GAAA,EAAK;AACZ,QAAA,MAAM,IAAI,eAAA,CAAgB,4BAAA,EAA8B,GAAG,CAAA;AAAA,MAC7D;AAAA,IACF,CAAA,MAAO;AACL,MAAA,MAAA,GAAS,GAAA;AAAA,IACX;AAEA,IAAA,OAAO,IAAA,CAAK,OAAA,GAAU,IAAA,CAAK,OAAA,CAAQ,MAAM,CAAA,GAAI,MAAA;AAAA,EAC/C,CAAA;AACF;;;ACtNO,SAAS,cAAA,CACd,OAAA,EACA,WAAA,GAAoC,EAAC,EAC3B;AACV,EAAA,MAAM,KAAA,GAAQ,WAAA,CAAY,WAAA,CAExB,CAAC,IAAA,EAAM,EAAA,KAAO,CAAC,IAAA,KAAS,EAAA,CAAG,IAAA,EAAM,IAAI,CAAA,EAAG,OAAO,CAAA;AACjD,EAAA,OAAO,EAAE,SAAS,KAAA,EAAM;AAC1B;AA4BO,SAAS,iBACd,QAAA,EACU;AACV,EAAA,OAAO;AAAA,IACL,SAAS,CAAC,IAAA,KAAS,SAAS,IAAI,CAAA,CAAE,QAAQ,IAAI;AAAA,GAChD;AACF;;;ACjEO,SAAS,gBACd,MAAA,EACiB;AACjB,EAAA,MAAM,MAAA,GAAS,IAAI,eAAA,EAAgB;AACnC,EAAA,KAAA,MAAW,CAAC,GAAA,EAAK,KAAK,KAAK,MAAA,CAAO,OAAA,CAAQ,MAAM,CAAA,EAAG;AACjD,IAAA,IAAI,SAAS,IAAA,EAAM;AACnB,IAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,KAAK,CAAA,EAAG;AACxB,MAAA,KAAA,MAAW,QAAQ,KAAA,EAAO;AACxB,QAAA,IAAI,QAAQ,IAAA,EAAM,MAAA,CAAO,OAAO,GAAA,EAAK,MAAA,CAAO,IAAI,CAAC,CAAA;AAAA,MACnD;AAAA,IACF,CAAA,MAAA,IAAW,OAAO,KAAA,KAAU,QAAA,EAAU;AACpC,MAAA,MAAM,IAAI,SAAA;AAAA,QACR,mCAAmC,GAAG,CAAA,kFAAA;AAAA,OACxC;AAAA,IACF,CAAA,MAAO;AACL,MAAA,MAAA,CAAO,MAAA,CAAO,GAAA,EAAK,MAAA,CAAO,KAAK,CAAC,CAAA;AAAA,IAClC;AAAA,EACF;AACA,EAAA,OAAO,MAAA;AACT;;;AC6BO,SAAS,mBAAA,CACd,SACA,OAAA,EAMU;AACV,EAAA,OAAO,cAAA;AAAA,IACL,OAAO,EAAE,MAAA,EAAQ,GAAA,EAAK,QAAQ,IAAA,EAAM,OAAA,EAAS,QAAO,KAAM;AACxD,MAAA,MAAM,OAAA,GAAU,IAAI,GAAA,CAAI,OAAA,CAAQ,QAAQ,KAAA,EAAO,EAAE,IAAI,GAAG,CAAA;AACxD,MAAA,IAAI,MAAA,EAAQ;AACV,QAAA,eAAA,CAAgB,MAAM,CAAA,CAAE,OAAA,CAAQ,CAAC,GAAG,CAAA,KAAM;AACxC,UAAA,OAAA,CAAQ,YAAA,CAAa,GAAA,CAAI,CAAA,EAAG,CAAC,CAAA;AAAA,QAC/B,CAAC,CAAA;AAAA,MACH;AAEA,MAAA,MAAM,cAAA,GAAkB,MAAM,OAAA,EAAS,cAAA,QAAuB,EAAC;AAE/D,MAAA,MAAM,GAAA,GAAM,MAAM,KAAA,CAAM,OAAA,CAAQ,UAAS,EAAG;AAAA,QAC1C,MAAA;AAAA,QACA,OAAA,EAAS;AAAA,UACP,GAAG,cAAA;AAAA,UACH,GAAG,OAAA;AAAA,UACH,GAAI,IAAA,IAAQ,IAAA,GAAO,EAAE,cAAA,EAAgB,kBAAA,KAAuB;AAAC,SAC/D;AAAA,QACA,MAAM,IAAA,IAAQ,IAAA,GAAO,IAAA,CAAK,SAAA,CAAU,IAAI,CAAA,GAAI,MAAA;AAAA,QAC5C;AAAA,OACD,CAAA;AAED,MAAA,IAAI,CAAC,IAAI,EAAA,EAAI;AACX,QAAA,MAAM,YAAY,MAAM,GAAA,CAAI,MAAK,CAAE,KAAA,CAAM,MAAM,IAAI,CAAA;AACnD,QAAA,MAAM,IAAI,SAAA,CAAU,GAAA,CAAI,MAAA,EAAQ,GAAA,CAAI,YAAY,SAAS,CAAA;AAAA,MAC3D;AACA,MAAA,IAAI,GAAA,CAAI,WAAW,GAAA,IAAO,GAAA,CAAI,WAAW,GAAA,IAAO,GAAA,CAAI,WAAW,GAAA,EAAK;AAClE,QAAA,OAAO,IAAA;AAAA,MACT;AACA,MAAA,MAAM,IAAA,GAAO,MAAM,GAAA,CAAI,IAAA,EAAK;AAC5B,MAAA,OAAO,IAAA,KAAS,EAAA,GAAK,IAAA,GAAO,IAAA,CAAK,MAAM,IAAI,CAAA;AAAA,IAC7C,CAAA;AAAA,IACA,OAAA,EAAS;AAAA,GACX;AACF;AAiBO,IAAM,SAAA,GAAN,cAAwB,KAAA,CAAM;AAAA,EACnC,WAAA,CAEkB,MAAA,EAEA,UAAA,EAEA,IAAA,GAAgB,IAAA,EAChC;AACA,IAAA,KAAA,CAAM,CAAA,KAAA,EAAQ,MAAM,CAAA,EAAA,EAAK,UAAU,CAAA,CAAE,CAAA;AANrB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AAEA,IAAA,IAAA,CAAA,UAAA,GAAA,UAAA;AAEA,IAAA,IAAA,CAAA,IAAA,GAAA,IAAA;AAGhB,IAAA,IAAA,CAAK,IAAA,GAAO,WAAA;AAAA,EACd;AACF;;;ACwCO,SAAS,SAAS,IAAA,EAAwB;AAC/C,EAAA,OAAO,IAAA;AACT;;;AC5JO,IAAM,YAAA,GAAN,cAA2B,KAAA,CAAM;AAAA,EACtC,YAA4B,EAAA,EAAY;AACtC,IAAA,KAAA,CAAM,CAAA,wBAAA,EAA2B,EAAE,CAAA,EAAA,CAAI,CAAA;AADb,IAAA,IAAA,CAAA,EAAA,GAAA,EAAA;AAE1B,IAAA,IAAA,CAAK,IAAA,GAAO,cAAA;AAAA,EACd;AACF;AAeO,SAAS,iBAAiB,EAAA,EAA4C;AAC3E,EAAA,OAAO,EAAA;AACT;AAoBO,SAAS,SAAA,CACd,OACA,OAAA,EACoB;AACpB,EAAA,OAAO,gBAAA,CAAiB,OAAO,IAAA,EAAM,IAAA,KAAS;AAC5C,IAAA,IAAI,SAAA;AACJ,IAAA,KAAA,IAAS,OAAA,GAAU,CAAA,EAAG,OAAA,IAAW,KAAA,EAAO,OAAA,EAAA,EAAW;AACjD,MAAA,IAAI;AACF,QAAA,OAAO,MAAM,KAAK,IAAI,CAAA;AAAA,MACxB,SAAS,GAAA,EAAK;AACZ,QAAA,SAAA,GAAY,GAAA;AACZ,QAAA,IAAI,YAAY,KAAA,EAAO;AACvB,QAAA,IAAI,SAAS,WAAA,IAAe,CAAC,QAAQ,WAAA,CAAY,GAAA,EAAK,OAAO,CAAA,EAAG;AAAA,MAClE;AAAA,IACF;AACA,IAAA,MAAM,SAAA;AAAA,EACR,CAAC,CAAA;AACH;AAwBO,SAAS,YAAY,EAAA,EAAgC;AAC1D,EAAA,OAAO,gBAAA,CAAiB,OAAO,IAAA,EAAM,IAAA,KAAS;AAC5C,IAAA,MAAM,UAAA,GAAa,IAAI,eAAA,EAAgB;AACvC,IAAA,MAAM,KAAA,GAAQ,UAAA,CAAW,MAAM,UAAA,CAAW,KAAA,CAAM,IAAI,YAAA,CAAa,EAAE,CAAC,CAAA,EAAG,EAAE,CAAA;AAEzE,IAAA,MAAM,EAAE,MAAA,EAAQ,OAAA,KAAY,IAAA,CAAK,MAAA,GAC7B,UAAU,CAAC,IAAA,CAAK,QAAQ,UAAA,CAAW,MAAM,CAAC,CAAA,GAC1C,EAAE,QAAQ,UAAA,CAAW,MAAA,EAAQ,SAAS,MAAM;AAAA,IAAC,CAAA,EAAE;AAEnD,IAAA,IAAI;AACF,MAAA,OAAO,MAAM,IAAA,CAAK,EAAE,GAAG,IAAA,EAAM,QAAQ,CAAA;AAAA,IACvC,CAAA,SAAE;AACA,MAAA,YAAA,CAAa,KAAK,CAAA;AAClB,MAAA,OAAA,EAAQ;AAAA,IACV;AAAA,EACF,CAAC,CAAA;AACH;AAYO,SAAS,WAAW,OAAA,EAEJ;AACrB,EAAA,MAAM,GAAA,GAAM,SAAS,GAAA,KAAQ,CAAC,KAAK,IAAA,KAAS,OAAA,CAAQ,GAAA,CAAI,GAAA,EAAK,IAAI,CAAA,CAAA;AACjE,EAAA,OAAO,gBAAA,CAAiB,OAAO,IAAA,EAAM,IAAA,KAAS;AAC5C,IAAA,MAAM,KAAA,GAAQ,KAAK,GAAA,EAAI;AACvB,IAAA,GAAA,CAAI,YAAY,IAAA,CAAK,MAAM,CAAA,CAAA,EAAI,IAAA,CAAK,GAAG,CAAA,CAAA,EAAI;AAAA,MACzC,QAAQ,IAAA,CAAK,MAAA;AAAA,MACb,MAAM,IAAA,CAAK;AAAA,KACZ,CAAA;AACD,IAAA,IAAI;AACF,MAAA,MAAM,MAAA,GAAS,MAAM,IAAA,CAAK,IAAI,CAAA;AAC9B,MAAA,GAAA,CAAI,CAAA,SAAA,EAAY,IAAA,CAAK,MAAM,CAAA,CAAA,EAAI,IAAA,CAAK,GAAG,CAAA,QAAA,EAAM,IAAA,CAAK,GAAA,EAAI,GAAI,KAAK,CAAA,EAAA,CAAI,CAAA;AACnE,MAAA,OAAO,MAAA;AAAA,IACT,SAAS,GAAA,EAAK;AACZ,MAAA,GAAA;AAAA,QACE,CAAA,SAAA,EAAY,IAAA,CAAK,MAAM,CAAA,CAAA,EAAI,IAAA,CAAK,GAAG,CAAA,oBAAA,EAAkB,IAAA,CAAK,GAAA,EAAI,GAAI,KAAK,CAAA,EAAA,CAAA;AAAA,QACvE;AAAA,OACF;AACA,MAAA,MAAM,GAAA;AAAA,IACR;AAAA,EACF,CAAC,CAAA;AACH;AAGA,SAAS,UAAU,OAAA,EAGjB;AACA,EAAA,MAAM,UAAA,GAAa,IAAI,eAAA,EAAgB;AACvC,EAAA,MAAM,OAAA,GAAU,MAAM,UAAA,CAAW,KAAA,EAAM;AACvC,EAAA,MAAM,WAA0B,EAAC;AACjC,EAAA,KAAA,MAAW,KAAK,OAAA,EAAS;AACvB,IAAA,IAAI,EAAE,OAAA,EAAS;AACb,MAAA,UAAA,CAAW,KAAA,EAAM;AACjB,MAAA;AAAA,IACF;AACA,IAAA,CAAA,CAAE,iBAAiB,OAAA,EAAS,OAAA,EAAS,EAAE,IAAA,EAAM,MAAM,CAAA;AACnD,IAAA,QAAA,CAAS,KAAK,CAAC,CAAA;AAAA,EACjB;AACA,EAAA,OAAO;AAAA,IACL,QAAQ,UAAA,CAAW,MAAA;AAAA,IACnB,OAAA,EAAS,MACP,QAAA,CAAS,OAAA,CAAQ,CAAC,CAAA,KAAM;AACtB,MAAA,CAAA,CAAE,mBAAA,CAAoB,SAAS,OAAO,CAAA;AAAA,IACxC,CAAC;AAAA,GACL;AACF","file":"index.cjs","sourcesContent":["import type { RouterDef, RouterEndpoints } from \"./types.js\";\n\n/**\n * Groups a set of endpoint specs (and optional nested routers) under a shared\n * URL prefix.\n *\n * The returned {@link RouterDef} can be passed directly to {@link createApi}\n * to produce a fully-typed API client. Nesting another {@link RouterDef} as a\n * value creates a sub-client whose prefix is the concatenation of both prefixes.\n *\n * @param prefix - Base path prepended to every endpoint's `path` (e.g. `'/users'`).\n * @param endpoints - Record of named {@link EndpointSpec}s or nested {@link RouterDef}s.\n *\n * @example\n * ```ts\n * // Flat router\n * export const todoRouter = defineRouter('/todos', {\n * getList: endpoint({ method: 'GET', path: '/', response: TodoListSchema }),\n * getDetail: endpoint({ method: 'GET', path: '/:id', response: TodoSchema }),\n * create: endpoint({ method: 'POST', path: '/', response: TodoSchema }),\n * });\n *\n * // Nested router — api.users.todos.getList() resolves to GET /users/todos/\n * export const userRouter = defineRouter('/users', {\n * getList: endpoint({ method: 'GET', path: '/', response: UserListSchema }),\n * todos: defineRouter('/todos', {\n * getList: endpoint({ method: 'GET', path: '/', response: TodoListSchema }),\n * getDetail: endpoint({ method: 'GET', path: '/:id', response: TodoSchema }),\n * }),\n * });\n * ```\n */\n/** Type guard — distinguishes a {@link RouterDef} from a leaf {@link EndpointSpec} at runtime. */\nexport function isRouterDef(entry: object): entry is RouterDef<RouterEndpoints> {\n return \"prefix\" in entry && \"endpoints\" in entry;\n}\n\nexport function defineRouter<TEndpoints extends RouterEndpoints>(\n prefix: string,\n endpoints: TEndpoints,\n): RouterDef<TEndpoints> {\n return { prefix, endpoints };\n}\n","/**\n * Joins URL path segments, normalising repeated slashes and trailing slashes.\n *\n * **Note:** Intended for relative API paths only. Absolute URLs containing\n * `://` will be collapsed (`https://` → `https:/`). Pass absolute URLs\n * directly to the executor instead of through this helper.\n */\nexport function joinPaths(...segments: string[]): string {\n const joined = segments\n .filter((s) => s !== \"\")\n .join(\"/\")\n .replace(/\\/+/g, \"/\");\n return joined.endsWith(\"/\") && joined.length > 1\n ? joined.slice(0, -1)\n : joined || \"/\";\n}\n\nexport function resolvePath(\n pathTemplate: string,\n params?: Record<string, unknown>,\n): string {\n if (!params) return pathTemplate;\n return pathTemplate.replace(/:([a-zA-Z_][a-zA-Z0-9_]*)/g, (_, key) => {\n const value = params[key];\n if (value == null || value === \"\") throw new Error(`Missing path parameter: ${key}`);\n return encodeURIComponent(String(value));\n });\n}\n","export class ValidationError extends Error {\n readonly cause?: unknown;\n\n constructor(message: string, cause?: unknown) {\n super(message);\n this.name = \"ValidationError\";\n if (cause !== undefined) {\n Object.defineProperty(this, \"cause\", {\n value: cause,\n writable: false,\n enumerable: false,\n configurable: true,\n });\n }\n }\n}\n","import { isRouterDef } from \"./define-router.js\";\nimport type {\n CreateApiOptions,\n EndpointSpec,\n Executor,\n InferResponse,\n RequestShape,\n RouterDef,\n RouterEndpoints,\n ValidatorOutput,\n} from \"./types.js\";\nimport { joinPaths, resolvePath } from \"./utils/path.js\";\nimport { ValidationError } from \"./utils/validate.js\";\n\n/** Callable type for a single endpoint on the generated API client. */\ntype EndpointFn<TSpec extends EndpointSpec<any, any, any>> =\n TSpec[\"request\"] extends { parse: (data: unknown) => infer R }\n ? (params: R, signal?: AbortSignal) => Promise<InferResponse<TSpec>>\n : (\n params?: RequestShape,\n signal?: AbortSignal,\n ) => Promise<InferResponse<TSpec>>;\n\n/**\n * Fully-typed API client produced by {@link createApi}.\n * Nested {@link RouterDef} entries become nested sub-client objects.\n */\ntype ApiClient<TEndpoints extends RouterEndpoints> = {\n [K in keyof TEndpoints]: TEndpoints[K] extends RouterDef<\n infer TNestedEndpoints\n >\n ? ApiClient<TNestedEndpoints>\n : TEndpoints[K] extends EndpointSpec<any, any, any>\n ? EndpointFn<TEndpoints[K]>\n : never;\n};\n\n/**\n * Builds a fully-typed API client from an {@link Executor} and a router\n * (or bare endpoint map).\n *\n * Three call signatures are supported:\n * - `createApi(executor, router)` — preferred; pass the result of {@link defineRouter}.\n * - `createApi(executor, prefix, endpoints)` — inline router without {@link defineRouter}.\n * - `createApi(executor, endpoints)` — no prefix; useful for flat endpoint maps.\n *\n * Each key in `endpoints` becomes a typed async function on the returned client.\n * The function validates the request with `spec.request.parse` (if present),\n * resolves path parameters, calls the executor, validates the response with\n * `spec.response.parse`, and applies `spec.adapter` (if present).\n *\n * @param executor - Transport to use for every HTTP call.\n * @param router - A {@link RouterDef} produced by {@link defineRouter}.\n * @param options - Optional settings (e.g. `validate` to skip schema parsing in production).\n *\n * @example Basic usage\n * ```ts\n * const todoApi = createApi(executor, todoRouter);\n * const todos = await todoApi.getList({});\n * const todo = await todoApi.getDetail({ path: { id: 1 } });\n * const next = await todoApi.create({ body: { title: 'buy milk' } });\n * ```\n *\n * @example Nested router — access via dot notation\n * ```ts\n * const api = createApi(executor, apiRouter); // apiRouter has users → todos nesting\n * await api.users.getList({});\n * await api.users.todos.getList({});\n * ```\n *\n * @example Cancel in-flight requests with AbortSignal\n * ```ts\n * const controller = new AbortController();\n * const todos = await todoApi.getList({}, controller.signal);\n * controller.abort();\n * ```\n *\n * @example Extract types from the client — no duplication\n * ```ts\n * import type { ApiTypes } from '@routar/core';\n * type TodoApiTypes = ApiTypes<typeof todoApi>;\n * type Todo = TodoApiTypes['getDetail']['response'];\n * type CreateRequest = TodoApiTypes['create']['request'];\n * ```\n *\n * @example Skip response validation in production\n * ```ts\n * const prodApi = createApi(executor, todoRouter, {\n * validate: { request: true, response: process.env.NODE_ENV !== 'production' },\n * });\n * ```\n */\nexport function createApi<TEndpoints extends RouterEndpoints>(\n executor: Executor,\n router: RouterDef<TEndpoints>,\n options?: CreateApiOptions,\n): ApiClient<TEndpoints>;\n\n/**\n * @param executor - Transport to use for every HTTP call.\n * @param prefix - URL prefix prepended to every endpoint path.\n * @param endpoints - Record of named endpoint specs.\n * @param options - Optional settings.\n */\nexport function createApi<TEndpoints extends RouterEndpoints>(\n executor: Executor,\n prefix: string,\n endpoints: TEndpoints,\n options?: CreateApiOptions,\n): ApiClient<TEndpoints>;\n\n/**\n * @param executor - Transport to use for every HTTP call.\n * @param endpoints - Record of named endpoint specs (no URL prefix).\n * @param options - Optional settings.\n */\nexport function createApi<TEndpoints extends RouterEndpoints>(\n executor: Executor,\n endpoints: TEndpoints,\n options?: CreateApiOptions,\n): ApiClient<TEndpoints>;\n\nexport function createApi(\n executor: Executor,\n routerOrPrefixOrEndpoints:\n | RouterDef<RouterEndpoints>\n | RouterEndpoints\n | string,\n endpointsArgOrOptions?: RouterEndpoints | CreateApiOptions,\n optionsArg?: CreateApiOptions,\n): Record<string, unknown> {\n const { prefix, endpoints, options } = resolveArgs(\n routerOrPrefixOrEndpoints,\n endpointsArgOrOptions,\n optionsArg,\n );\n return buildClient(executor, prefix, endpoints, options);\n}\n\nfunction resolveArgs(\n second: RouterDef<RouterEndpoints> | RouterEndpoints | string,\n third: RouterEndpoints | CreateApiOptions | undefined,\n fourth: CreateApiOptions | undefined,\n): {\n prefix: string;\n endpoints: RouterEndpoints;\n options: CreateApiOptions | undefined;\n} {\n if (typeof second === \"string\") {\n if (!third)\n throw new Error(\"endpoints is required when prefix is provided\");\n return {\n prefix: second,\n endpoints: third as RouterEndpoints,\n options: fourth,\n };\n }\n if (isRouterDef(second)) {\n return {\n prefix: second.prefix,\n endpoints: second.endpoints,\n options: third as CreateApiOptions | undefined,\n };\n }\n return {\n prefix: \"\",\n endpoints: second as RouterEndpoints,\n options: third as CreateApiOptions | undefined,\n };\n}\n\nfunction shouldValidate(\n options: CreateApiOptions | undefined,\n kind: \"request\" | \"response\",\n): boolean {\n const v = options?.validate;\n if (v === undefined || v === true) return true;\n if (v === false) return false;\n return v[kind] ?? true;\n}\n\nfunction buildClient(\n executor: Executor,\n prefix: string,\n endpoints: RouterEndpoints,\n options?: CreateApiOptions,\n): Record<string, unknown> {\n const client: Record<string, unknown> = {};\n\n for (const [key, entry] of Object.entries(endpoints)) {\n client[key] = isRouterDef(entry)\n ? buildClient(executor, joinPaths(prefix, entry.prefix), entry.endpoints, options)\n : buildEndpointFn(executor, prefix, entry as EndpointSpec<any, any, any>, options);\n }\n\n return client;\n}\n\nfunction buildEndpointFn(\n executor: Executor,\n prefix: string,\n spec: EndpointSpec<any, any, any>,\n options: CreateApiOptions | undefined,\n) {\n return async (params: RequestShape = {}, signal?: AbortSignal) => {\n let validatedParams: RequestShape = params;\n if (spec.request && shouldValidate(options, \"request\")) {\n try {\n validatedParams = spec.request.parse(params);\n } catch (err) {\n throw new ValidationError(\"Request validation failed\", err);\n }\n }\n\n const url = resolvePath(joinPaths(prefix, spec.path), validatedParams?.path);\n\n const raw = await executor.execute({\n method: spec.method,\n url,\n params: validatedParams?.query as Record<string, unknown> | undefined,\n body: validatedParams?.body,\n signal,\n });\n\n let result: ValidatorOutput<typeof spec.response>;\n if (shouldValidate(options, \"response\")) {\n try {\n result = spec.response.parse(raw);\n } catch (err) {\n throw new ValidationError(\"Response validation failed\", err);\n }\n } else {\n result = raw;\n }\n\n return spec.adapter ? spec.adapter(result) : result;\n };\n}\n","import type { ExecuteOptions, Executor, ExecutorMiddleware } from \"./types.js\";\n\n/**\n * Creates an {@link Executor} by wrapping a transport function with an\n * optional middleware chain.\n *\n * Middlewares are applied in declaration order — the first middleware is the\n * outermost wrapper and runs first on each request.\n *\n * @param execute - The underlying transport function (fetch, axios, etc.).\n * @param middlewares - Ordered list of middlewares to apply.\n *\n * @example\n * ```ts\n * const executor = createExecutor(\n * async ({ method, url, body }) => {\n * const res = await fetch(url, { method, body: JSON.stringify(body) });\n * return res.json();\n * },\n * [withTimeout(5000), withRetry(3), withLogger()],\n * );\n * ```\n */\nexport function createExecutor(\n execute: (options: ExecuteOptions) => Promise<unknown>,\n middlewares: ExecutorMiddleware[] = [],\n): Executor {\n const chain = middlewares.reduceRight<\n (options: ExecuteOptions) => Promise<unknown>\n >((next, mw) => (opts) => mw(opts, next), execute);\n return { execute: chain };\n}\n\n/**\n * Creates an {@link Executor} that selects the underlying transport at\n * request time based on the result of `resolver`.\n *\n * Use this to unify SSR and CSR behind a single API client — the resolver\n * picks the right executor per request, so `createApi` is called once and\n * works in both environments without duplicate `*ServerApi` instances.\n *\n * The resolver receives the full {@link ExecuteOptions} so it can branch on\n * environment, URL prefix, auth context, or any runtime condition.\n *\n * @param resolver - Called on every request; returns the executor to delegate to.\n *\n * @example\n * ```ts\n * // SSR vs CSR — pick transport based on environment\n * const apiExecutor = dispatchExecutor(() =>\n * typeof window === 'undefined' ? serverExecutor : clientExecutor,\n * );\n *\n * // Route by URL prefix — internal routes use a different transport\n * const apiExecutor = dispatchExecutor((opts) =>\n * opts.url.startsWith('/internal') ? internalExecutor : publicExecutor,\n * );\n * ```\n */\nexport function dispatchExecutor(\n resolver: (opts: ExecuteOptions) => Executor,\n): Executor {\n return {\n execute: (opts) => resolver(opts).execute(opts),\n };\n}\n","export function serializeParams(\n params: Record<string, unknown>,\n): URLSearchParams {\n const result = new URLSearchParams();\n for (const [key, value] of Object.entries(params)) {\n if (value == null) continue;\n if (Array.isArray(value)) {\n for (const item of value) {\n if (item != null) result.append(key, String(item));\n }\n } else if (typeof value === \"object\") {\n throw new TypeError(\n `serializeParams: value for key \"${key}\" is a plain object. Serialize it to a string before passing as a query parameter.`,\n );\n } else {\n result.append(key, String(value));\n }\n }\n return result;\n}\n","import type { Executor, ExecutorMiddleware } from \"./types.js\";\nimport { createExecutor } from \"./create-executor.js\";\nimport { serializeParams } from \"./utils/params.js\";\n\n/**\n * Creates an {@link Executor} backed by the browser / Node.js `fetch` API.\n *\n * Suited for SSR environments where you need per-request dynamic headers\n * (e.g. forwarding auth cookies) without sharing state across requests.\n *\n * - Query params are serialized and appended to the URL.\n * - A `Content-Type: application/json` header is added automatically when\n * a request body is present.\n * - Responses with status 204 or `Content-Length: 0` resolve to `null`.\n * - Non-2xx responses throw an {@link HttpError}.\n *\n * @param baseURL - Absolute base URL prepended to every endpoint path.\n * @param options.defaultHeaders - Async factory called on every request to\n * produce headers (e.g. reading cookies in a Next.js server component).\n * @param options.middlewares - Middleware chain applied before the fetch call.\n *\n * @example Minimal — no options needed\n * ```ts\n * const executor = createFetchExecutor('https://api.example.com');\n * ```\n *\n * @example SSR with bearer token\n * ```ts\n * const executor = createFetchExecutor('https://api.example.com', {\n * defaultHeaders: async () => {\n * const token = await getServerToken();\n * return token ? { Authorization: `Bearer ${token}` } : {};\n * },\n * });\n * ```\n *\n * @example Next.js App Router — forward cookies from the incoming request\n * ```ts\n * const executor = createFetchExecutor('https://api.example.com', {\n * defaultHeaders: async () => {\n * const { cookies } = await import('next/headers');\n * const token = (await cookies()).get('access_token')?.value;\n * return token ? { Authorization: `Bearer ${token}` } : {};\n * },\n * middlewares: [withTimeout(8_000), withRetry(2)],\n * });\n * ```\n */\nexport function createFetchExecutor(\n baseURL: string,\n options?: {\n defaultHeaders?: () =>\n | Record<string, string>\n | Promise<Record<string, string>>;\n middlewares?: ExecutorMiddleware[];\n },\n): Executor {\n return createExecutor(\n async ({ method, url, params, body, headers, signal }) => {\n const fullURL = new URL(baseURL.replace(/\\/$/, \"\") + url);\n if (params) {\n serializeParams(params).forEach((v, k) => {\n fullURL.searchParams.set(k, v);\n });\n }\n\n const defaultHeaders = (await options?.defaultHeaders?.()) ?? {};\n\n const res = await fetch(fullURL.toString(), {\n method,\n headers: {\n ...defaultHeaders,\n ...headers,\n ...(body != null ? { \"Content-Type\": \"application/json\" } : {}),\n },\n body: body != null ? JSON.stringify(body) : undefined,\n signal,\n });\n\n if (!res.ok) {\n const errorBody = await res.json().catch(() => null);\n throw new HttpError(res.status, res.statusText, errorBody);\n }\n if (res.status === 204 || res.status === 205 || res.status === 304) {\n return null;\n }\n const text = await res.text();\n return text === \"\" ? null : JSON.parse(text);\n },\n options?.middlewares,\n );\n}\n\n/**\n * Thrown by {@link createFetchExecutor} when the server returns a non-2xx\n * status code.\n *\n * @example\n * ```ts\n * try {\n * await api.getDetail({ path: { id: 999 } });\n * } catch (err) {\n * if (err instanceof HttpError && err.status === 404) {\n * // handle not-found\n * }\n * }\n * ```\n */\nexport class HttpError extends Error {\n constructor(\n /** HTTP status code (e.g. 404, 500). */\n public readonly status: number,\n /** HTTP status text (e.g. \"Not Found\"). */\n public readonly statusText: string,\n /** Parsed response body, or `null` if the body was empty or not JSON. */\n public readonly body: unknown = null,\n ) {\n super(`HTTP ${status}: ${statusText}`);\n this.name = \"HttpError\";\n }\n}\n","import type {\n HttpMethod,\n RequestShape,\n Validator,\n ValidatorOutput,\n} from \"./types.js\";\n\n/**\n * Extracts `:param` segment names from a path template string as a union of\n * string literals.\n *\n * @example\n * ```ts\n * type P = PathParams<'/:userId/posts/:postId'>; // 'userId' | 'postId'\n * ```\n */\nexport type PathParams<TPath extends string> =\n TPath extends `${string}:${infer Param}/${infer Rest}`\n ? Param | PathParams<Rest>\n : TPath extends `${string}:${infer Param}`\n ? Param\n : never;\n\n/**\n * When `TPath` contains dynamic segments (`:param`), requires `request.path`\n * to include all extracted param names. No constraint for static paths.\n */\ntype PathConstraint<TPath extends string> = [PathParams<TPath>] extends [never]\n ? {}\n : { path: Record<PathParams<TPath>, unknown> };\n\n/**\n * Type-safe endpoint definition helper.\n *\n * Use this instead of a plain object literal to get full type inference on\n * `adapter` without requiring explicit annotations or `as any` casts.\n * The four overloads cover every combination of optional `request` validator\n * and optional `adapter` function while keeping all return-type fields\n * required so that TypeScript can narrow them downstream.\n *\n * When `path` contains dynamic segments (e.g. `'/:id'`), TypeScript enforces\n * that `request` includes a matching `path` field with those param names.\n * A mismatch or missing key is a compile-time error.\n *\n * @example Basic GET with no params\n * ```ts\n * const getList = endpoint({ method: 'GET', path: '/', response: z.array(TodoSchema) });\n * ```\n *\n * @example GET with query params\n * ```ts\n * const search = endpoint({\n * method: 'GET',\n * path: '/search',\n * request: z.object({ query: z.object({ q: z.string(), limit: z.number().optional() }) }),\n * response: z.array(TodoSchema),\n * });\n * ```\n *\n * @example POST with body\n * ```ts\n * const create = endpoint({\n * method: 'POST',\n * path: '/',\n * request: z.object({ body: z.object({ title: z.string() }) }),\n * response: TodoSchema,\n * });\n * ```\n *\n * @example Adapter — raw is inferred from the response schema, no cast needed\n * ```ts\n * const getDetail = endpoint({\n * method: 'GET',\n * path: '/:id',\n * request: z.object({ path: z.object({ id: z.number() }) }),\n * response: TodoRawSchema,\n * adapter: (raw) => ({ ...raw, label: `#${raw.id} ${raw.title}` }),\n * });\n * ```\n *\n * @example Path param enforcement\n * ```ts\n * // ✅ path has ':id' → request.path.id is required\n * const getDetail = endpoint({\n * method: 'GET',\n * path: '/:id',\n * request: z.object({ path: z.object({ id: z.number() }) }),\n * response: TodoSchema,\n * });\n *\n * // ❌ compile error — 'id' is missing from request.path\n * const broken = endpoint({\n * method: 'GET',\n * path: '/:id',\n * request: z.object({ query: z.object({ foo: z.string() }) }),\n * response: TodoSchema,\n * });\n * ```\n */\n// request O + adapter O\nexport function endpoint<\n TPath extends string,\n TRequest extends RequestShape & PathConstraint<TPath>,\n TResponse extends Validator<unknown>,\n TOut,\n>(spec: {\n method: HttpMethod;\n path: TPath;\n request: Validator<TRequest>;\n response: TResponse;\n adapter: (raw: ValidatorOutput<TResponse>) => TOut;\n}): {\n method: HttpMethod;\n path: string;\n request: Validator<TRequest>;\n response: TResponse;\n adapter: (raw: ValidatorOutput<TResponse>) => TOut;\n};\n\n// request O + adapter X\nexport function endpoint<\n TPath extends string,\n TRequest extends RequestShape & PathConstraint<TPath>,\n TResponse extends Validator<unknown>,\n>(spec: {\n method: HttpMethod;\n path: TPath;\n request: Validator<TRequest>;\n response: TResponse;\n}): {\n method: HttpMethod;\n path: string;\n request: Validator<TRequest>;\n response: TResponse;\n};\n\n// request X + adapter O\nexport function endpoint<TResponse extends Validator<unknown>, TOut>(spec: {\n method: HttpMethod;\n path: string;\n response: TResponse;\n adapter: (raw: ValidatorOutput<TResponse>) => TOut;\n}): {\n method: HttpMethod;\n path: string;\n response: TResponse;\n adapter: (raw: ValidatorOutput<TResponse>) => TOut;\n};\n\n// request X + adapter X\nexport function endpoint<TResponse extends Validator<unknown>>(spec: {\n method: HttpMethod;\n path: string;\n response: TResponse;\n}): {\n method: HttpMethod;\n path: string;\n response: TResponse;\n};\n\nexport function endpoint(spec: unknown): unknown {\n return spec;\n}\n","import type { ExecutorMiddleware } from \"./types.js\";\n\n/**\n * Thrown by {@link withTimeout} when a request exceeds the configured duration.\n * Distinguishable from a user-initiated {@link AbortSignal} cancellation.\n */\nexport class TimeoutError extends Error {\n constructor(public readonly ms: number) {\n super(`Request timed out after ${ms}ms`);\n this.name = \"TimeoutError\";\n }\n}\n\n/**\n * Identity helper that returns the middleware as-is.\n *\n * Wrap your middleware function with this to get full type inference on `opts`\n * and `next` without having to annotate the type manually.\n *\n * @example\n * ```ts\n * const withCorrelationId = defineMiddleware((opts, next) =>\n * next({ ...opts, headers: { ...opts.headers, 'X-Request-Id': crypto.randomUUID() } })\n * );\n * ```\n */\nexport function defineMiddleware(fn: ExecutorMiddleware): ExecutorMiddleware {\n return fn;\n}\n\n/**\n * Retries a failed request up to `count` additional times.\n *\n * By default all errors trigger a retry. Pass `shouldRetry` to skip retries\n * for non-transient errors (e.g. 4xx responses).\n *\n * @param count - Number of retries (not counting the initial attempt).\n * @param options.shouldRetry - Return `false` to stop retrying early.\n * Receives the error and a zero-based `attempt` index (0 = first failure,\n * 1 = second failure, …) so you can limit retries by count or error type.\n *\n * @example\n * ```ts\n * withRetry(3, {\n * shouldRetry: (err) => err instanceof HttpError && err.status >= 500,\n * })\n * ```\n */\nexport function withRetry(\n count: number,\n options?: { shouldRetry?: (error: unknown, attempt: number) => boolean },\n): ExecutorMiddleware {\n return defineMiddleware(async (opts, next) => {\n let lastError: unknown;\n for (let attempt = 0; attempt <= count; attempt++) {\n try {\n return await next(opts);\n } catch (err) {\n lastError = err;\n if (attempt === count) break;\n if (options?.shouldRetry && !options.shouldRetry(err, attempt)) break;\n }\n }\n throw lastError;\n });\n}\n\n/**\n * Aborts a request if it does not complete within `ms` milliseconds.\n *\n * Merges the timeout signal with any existing `AbortSignal` on the request,\n * so whichever fires first wins.\n *\n * @param ms - Timeout in milliseconds.\n *\n * @example\n * ```ts\n * const executor = createFetchExecutor('https://api.example.com', {\n * middlewares: [withTimeout(5_000)],\n * });\n *\n * // Combine with retry — timeout applies per attempt\n * const executor = createExecutor(transport, [\n * withTimeout(5_000),\n * withRetry(3, { shouldRetry: (err) => !(err instanceof HttpError && err.status < 500) }),\n * withLogger(),\n * ]);\n * ```\n */\nexport function withTimeout(ms: number): ExecutorMiddleware {\n return defineMiddleware(async (opts, next) => {\n const controller = new AbortController();\n const timer = setTimeout(() => controller.abort(new TimeoutError(ms)), ms);\n\n const { signal, cleanup } = opts.signal\n ? anySignal([opts.signal, controller.signal])\n : { signal: controller.signal, cleanup: () => {} };\n\n try {\n return await next({ ...opts, signal });\n } finally {\n clearTimeout(timer);\n cleanup();\n }\n });\n}\n\n/**\n * Logs each request and its outcome (success duration or error).\n *\n * @param options.log - Custom logging function. Defaults to `console.log`.\n *\n * @example\n * ```ts\n * withLogger({ log: (msg, data) => logger.debug(msg, data) })\n * ```\n */\nexport function withLogger(options?: {\n log?: (message: string, data?: unknown) => void;\n}): ExecutorMiddleware {\n const log = options?.log ?? ((msg, data) => console.log(msg, data));\n return defineMiddleware(async (opts, next) => {\n const start = Date.now();\n log(`[routar] ${opts.method} ${opts.url}`, {\n params: opts.params,\n body: opts.body,\n });\n try {\n const result = await next(opts);\n log(`[routar] ${opts.method} ${opts.url} — ${Date.now() - start}ms`);\n return result;\n } catch (err) {\n log(\n `[routar] ${opts.method} ${opts.url} — error after ${Date.now() - start}ms`,\n err,\n );\n throw err;\n }\n });\n}\n\n/** Combines multiple AbortSignals into one that aborts when any of them fire. */\nfunction anySignal(signals: AbortSignal[]): {\n signal: AbortSignal;\n cleanup: () => void;\n} {\n const controller = new AbortController();\n const onAbort = () => controller.abort();\n const attached: AbortSignal[] = [];\n for (const s of signals) {\n if (s.aborted) {\n controller.abort();\n break;\n }\n s.addEventListener(\"abort\", onAbort, { once: true });\n attached.push(s);\n }\n return {\n signal: controller.signal,\n cleanup: () =>\n attached.forEach((s) => {\n s.removeEventListener(\"abort\", onAbort);\n }),\n };\n}\n"]}
|
package/dist/index.d.cts
CHANGED
|
@@ -176,13 +176,38 @@ type ApiClient<TEndpoints extends RouterEndpoints> = {
|
|
|
176
176
|
* @param router - A {@link RouterDef} produced by {@link defineRouter}.
|
|
177
177
|
* @param options - Optional settings (e.g. `validate` to skip schema parsing in production).
|
|
178
178
|
*
|
|
179
|
-
* @example
|
|
179
|
+
* @example Basic usage
|
|
180
180
|
* ```ts
|
|
181
181
|
* const todoApi = createApi(executor, todoRouter);
|
|
182
182
|
* const todos = await todoApi.getList({});
|
|
183
183
|
* const todo = await todoApi.getDetail({ path: { id: 1 } });
|
|
184
|
+
* const next = await todoApi.create({ body: { title: 'buy milk' } });
|
|
185
|
+
* ```
|
|
186
|
+
*
|
|
187
|
+
* @example Nested router — access via dot notation
|
|
188
|
+
* ```ts
|
|
189
|
+
* const api = createApi(executor, apiRouter); // apiRouter has users → todos nesting
|
|
190
|
+
* await api.users.getList({});
|
|
191
|
+
* await api.users.todos.getList({});
|
|
192
|
+
* ```
|
|
193
|
+
*
|
|
194
|
+
* @example Cancel in-flight requests with AbortSignal
|
|
195
|
+
* ```ts
|
|
196
|
+
* const controller = new AbortController();
|
|
197
|
+
* const todos = await todoApi.getList({}, controller.signal);
|
|
198
|
+
* controller.abort();
|
|
199
|
+
* ```
|
|
200
|
+
*
|
|
201
|
+
* @example Extract types from the client — no duplication
|
|
202
|
+
* ```ts
|
|
203
|
+
* import type { ApiTypes } from '@routar/core';
|
|
204
|
+
* type TodoApiTypes = ApiTypes<typeof todoApi>;
|
|
205
|
+
* type Todo = TodoApiTypes['getDetail']['response'];
|
|
206
|
+
* type CreateRequest = TodoApiTypes['create']['request'];
|
|
207
|
+
* ```
|
|
184
208
|
*
|
|
185
|
-
*
|
|
209
|
+
* @example Skip response validation in production
|
|
210
|
+
* ```ts
|
|
186
211
|
* const prodApi = createApi(executor, todoRouter, {
|
|
187
212
|
* validate: { request: true, response: process.env.NODE_ENV !== 'production' },
|
|
188
213
|
* });
|
|
@@ -253,6 +278,85 @@ declare function createExecutor(execute: (options: ExecuteOptions) => Promise<un
|
|
|
253
278
|
*/
|
|
254
279
|
declare function dispatchExecutor(resolver: (opts: ExecuteOptions) => Executor): Executor;
|
|
255
280
|
|
|
281
|
+
/**
|
|
282
|
+
* Creates an {@link Executor} backed by the browser / Node.js `fetch` API.
|
|
283
|
+
*
|
|
284
|
+
* Suited for SSR environments where you need per-request dynamic headers
|
|
285
|
+
* (e.g. forwarding auth cookies) without sharing state across requests.
|
|
286
|
+
*
|
|
287
|
+
* - Query params are serialized and appended to the URL.
|
|
288
|
+
* - A `Content-Type: application/json` header is added automatically when
|
|
289
|
+
* a request body is present.
|
|
290
|
+
* - Responses with status 204 or `Content-Length: 0` resolve to `null`.
|
|
291
|
+
* - Non-2xx responses throw an {@link HttpError}.
|
|
292
|
+
*
|
|
293
|
+
* @param baseURL - Absolute base URL prepended to every endpoint path.
|
|
294
|
+
* @param options.defaultHeaders - Async factory called on every request to
|
|
295
|
+
* produce headers (e.g. reading cookies in a Next.js server component).
|
|
296
|
+
* @param options.middlewares - Middleware chain applied before the fetch call.
|
|
297
|
+
*
|
|
298
|
+
* @example Minimal — no options needed
|
|
299
|
+
* ```ts
|
|
300
|
+
* const executor = createFetchExecutor('https://api.example.com');
|
|
301
|
+
* ```
|
|
302
|
+
*
|
|
303
|
+
* @example SSR with bearer token
|
|
304
|
+
* ```ts
|
|
305
|
+
* const executor = createFetchExecutor('https://api.example.com', {
|
|
306
|
+
* defaultHeaders: async () => {
|
|
307
|
+
* const token = await getServerToken();
|
|
308
|
+
* return token ? { Authorization: `Bearer ${token}` } : {};
|
|
309
|
+
* },
|
|
310
|
+
* });
|
|
311
|
+
* ```
|
|
312
|
+
*
|
|
313
|
+
* @example Next.js App Router — forward cookies from the incoming request
|
|
314
|
+
* ```ts
|
|
315
|
+
* const executor = createFetchExecutor('https://api.example.com', {
|
|
316
|
+
* defaultHeaders: async () => {
|
|
317
|
+
* const { cookies } = await import('next/headers');
|
|
318
|
+
* const token = (await cookies()).get('access_token')?.value;
|
|
319
|
+
* return token ? { Authorization: `Bearer ${token}` } : {};
|
|
320
|
+
* },
|
|
321
|
+
* middlewares: [withTimeout(8_000), withRetry(2)],
|
|
322
|
+
* });
|
|
323
|
+
* ```
|
|
324
|
+
*/
|
|
325
|
+
declare function createFetchExecutor(baseURL: string, options?: {
|
|
326
|
+
defaultHeaders?: () => Record<string, string> | Promise<Record<string, string>>;
|
|
327
|
+
middlewares?: ExecutorMiddleware[];
|
|
328
|
+
}): Executor;
|
|
329
|
+
/**
|
|
330
|
+
* Thrown by {@link createFetchExecutor} when the server returns a non-2xx
|
|
331
|
+
* status code.
|
|
332
|
+
*
|
|
333
|
+
* @example
|
|
334
|
+
* ```ts
|
|
335
|
+
* try {
|
|
336
|
+
* await api.getDetail({ path: { id: 999 } });
|
|
337
|
+
* } catch (err) {
|
|
338
|
+
* if (err instanceof HttpError && err.status === 404) {
|
|
339
|
+
* // handle not-found
|
|
340
|
+
* }
|
|
341
|
+
* }
|
|
342
|
+
* ```
|
|
343
|
+
*/
|
|
344
|
+
declare class HttpError extends Error {
|
|
345
|
+
/** HTTP status code (e.g. 404, 500). */
|
|
346
|
+
readonly status: number;
|
|
347
|
+
/** HTTP status text (e.g. "Not Found"). */
|
|
348
|
+
readonly statusText: string;
|
|
349
|
+
/** Parsed response body, or `null` if the body was empty or not JSON. */
|
|
350
|
+
readonly body: unknown;
|
|
351
|
+
constructor(
|
|
352
|
+
/** HTTP status code (e.g. 404, 500). */
|
|
353
|
+
status: number,
|
|
354
|
+
/** HTTP status text (e.g. "Not Found"). */
|
|
355
|
+
statusText: string,
|
|
356
|
+
/** Parsed response body, or `null` if the body was empty or not JSON. */
|
|
357
|
+
body?: unknown);
|
|
358
|
+
}
|
|
359
|
+
|
|
256
360
|
/**
|
|
257
361
|
* Extracts `:param` segment names from a path template string as a union of
|
|
258
362
|
* string literals.
|
|
@@ -283,7 +387,43 @@ type PathConstraint<TPath extends string> = [PathParams<TPath>] extends [never]
|
|
|
283
387
|
* that `request` includes a matching `path` field with those param names.
|
|
284
388
|
* A mismatch or missing key is a compile-time error.
|
|
285
389
|
*
|
|
286
|
-
* @example
|
|
390
|
+
* @example Basic GET with no params
|
|
391
|
+
* ```ts
|
|
392
|
+
* const getList = endpoint({ method: 'GET', path: '/', response: z.array(TodoSchema) });
|
|
393
|
+
* ```
|
|
394
|
+
*
|
|
395
|
+
* @example GET with query params
|
|
396
|
+
* ```ts
|
|
397
|
+
* const search = endpoint({
|
|
398
|
+
* method: 'GET',
|
|
399
|
+
* path: '/search',
|
|
400
|
+
* request: z.object({ query: z.object({ q: z.string(), limit: z.number().optional() }) }),
|
|
401
|
+
* response: z.array(TodoSchema),
|
|
402
|
+
* });
|
|
403
|
+
* ```
|
|
404
|
+
*
|
|
405
|
+
* @example POST with body
|
|
406
|
+
* ```ts
|
|
407
|
+
* const create = endpoint({
|
|
408
|
+
* method: 'POST',
|
|
409
|
+
* path: '/',
|
|
410
|
+
* request: z.object({ body: z.object({ title: z.string() }) }),
|
|
411
|
+
* response: TodoSchema,
|
|
412
|
+
* });
|
|
413
|
+
* ```
|
|
414
|
+
*
|
|
415
|
+
* @example Adapter — raw is inferred from the response schema, no cast needed
|
|
416
|
+
* ```ts
|
|
417
|
+
* const getDetail = endpoint({
|
|
418
|
+
* method: 'GET',
|
|
419
|
+
* path: '/:id',
|
|
420
|
+
* request: z.object({ path: z.object({ id: z.number() }) }),
|
|
421
|
+
* response: TodoRawSchema,
|
|
422
|
+
* adapter: (raw) => ({ ...raw, label: `#${raw.id} ${raw.title}` }),
|
|
423
|
+
* });
|
|
424
|
+
* ```
|
|
425
|
+
*
|
|
426
|
+
* @example Path param enforcement
|
|
287
427
|
* ```ts
|
|
288
428
|
* // ✅ path has ':id' → request.path.id is required
|
|
289
429
|
* const getDetail = endpoint({
|
|
@@ -291,7 +431,6 @@ type PathConstraint<TPath extends string> = [PathParams<TPath>] extends [never]
|
|
|
291
431
|
* path: '/:id',
|
|
292
432
|
* request: z.object({ path: z.object({ id: z.number() }) }),
|
|
293
433
|
* response: TodoSchema,
|
|
294
|
-
* adapter: toTodoItem,
|
|
295
434
|
* });
|
|
296
435
|
*
|
|
297
436
|
* // ❌ compile error — 'id' is missing from request.path
|
|
@@ -348,6 +487,38 @@ declare function endpoint<TResponse extends Validator<unknown>>(spec: {
|
|
|
348
487
|
response: TResponse;
|
|
349
488
|
};
|
|
350
489
|
|
|
490
|
+
/**
|
|
491
|
+
* Groups a set of endpoint specs (and optional nested routers) under a shared
|
|
492
|
+
* URL prefix.
|
|
493
|
+
*
|
|
494
|
+
* The returned {@link RouterDef} can be passed directly to {@link createApi}
|
|
495
|
+
* to produce a fully-typed API client. Nesting another {@link RouterDef} as a
|
|
496
|
+
* value creates a sub-client whose prefix is the concatenation of both prefixes.
|
|
497
|
+
*
|
|
498
|
+
* @param prefix - Base path prepended to every endpoint's `path` (e.g. `'/users'`).
|
|
499
|
+
* @param endpoints - Record of named {@link EndpointSpec}s or nested {@link RouterDef}s.
|
|
500
|
+
*
|
|
501
|
+
* @example
|
|
502
|
+
* ```ts
|
|
503
|
+
* // Flat router
|
|
504
|
+
* export const todoRouter = defineRouter('/todos', {
|
|
505
|
+
* getList: endpoint({ method: 'GET', path: '/', response: TodoListSchema }),
|
|
506
|
+
* getDetail: endpoint({ method: 'GET', path: '/:id', response: TodoSchema }),
|
|
507
|
+
* create: endpoint({ method: 'POST', path: '/', response: TodoSchema }),
|
|
508
|
+
* });
|
|
509
|
+
*
|
|
510
|
+
* // Nested router — api.users.todos.getList() resolves to GET /users/todos/
|
|
511
|
+
* export const userRouter = defineRouter('/users', {
|
|
512
|
+
* getList: endpoint({ method: 'GET', path: '/', response: UserListSchema }),
|
|
513
|
+
* todos: defineRouter('/todos', {
|
|
514
|
+
* getList: endpoint({ method: 'GET', path: '/', response: TodoListSchema }),
|
|
515
|
+
* getDetail: endpoint({ method: 'GET', path: '/:id', response: TodoSchema }),
|
|
516
|
+
* }),
|
|
517
|
+
* });
|
|
518
|
+
* ```
|
|
519
|
+
*/
|
|
520
|
+
/** Type guard — distinguishes a {@link RouterDef} from a leaf {@link EndpointSpec} at runtime. */
|
|
521
|
+
declare function isRouterDef(entry: object): entry is RouterDef<RouterEndpoints>;
|
|
351
522
|
declare function defineRouter<TEndpoints extends RouterEndpoints>(prefix: string, endpoints: TEndpoints): RouterDef<TEndpoints>;
|
|
352
523
|
|
|
353
524
|
/**
|
|
@@ -400,6 +571,20 @@ declare function withRetry(count: number, options?: {
|
|
|
400
571
|
* so whichever fires first wins.
|
|
401
572
|
*
|
|
402
573
|
* @param ms - Timeout in milliseconds.
|
|
574
|
+
*
|
|
575
|
+
* @example
|
|
576
|
+
* ```ts
|
|
577
|
+
* const executor = createFetchExecutor('https://api.example.com', {
|
|
578
|
+
* middlewares: [withTimeout(5_000)],
|
|
579
|
+
* });
|
|
580
|
+
*
|
|
581
|
+
* // Combine with retry — timeout applies per attempt
|
|
582
|
+
* const executor = createExecutor(transport, [
|
|
583
|
+
* withTimeout(5_000),
|
|
584
|
+
* withRetry(3, { shouldRetry: (err) => !(err instanceof HttpError && err.status < 500) }),
|
|
585
|
+
* withLogger(),
|
|
586
|
+
* ]);
|
|
587
|
+
* ```
|
|
403
588
|
*/
|
|
404
589
|
declare function withTimeout(ms: number): ExecutorMiddleware;
|
|
405
590
|
/**
|
|
@@ -433,4 +618,4 @@ declare class ValidationError extends Error {
|
|
|
433
618
|
constructor(message: string, cause?: unknown);
|
|
434
619
|
}
|
|
435
620
|
|
|
436
|
-
export { type ApiTypes, type CreateApiOptions, type EndpointSpec, type ExecuteOptions, type Executor, type ExecutorMiddleware, type HttpMethod, type InferResponse, type PathParams, type RequestShape, type RouterDef, type RouterEndpoints, type RouterEntry, TimeoutError, ValidationError, type Validator, type ValidatorOutput, createApi, createExecutor, defineMiddleware, defineRouter, dispatchExecutor, endpoint, joinPaths, resolvePath, serializeParams, withLogger, withRetry, withTimeout };
|
|
621
|
+
export { type ApiTypes, type CreateApiOptions, type EndpointSpec, type ExecuteOptions, type Executor, type ExecutorMiddleware, HttpError, type HttpMethod, type InferResponse, type PathParams, type RequestShape, type RouterDef, type RouterEndpoints, type RouterEntry, TimeoutError, ValidationError, type Validator, type ValidatorOutput, createApi, createExecutor, createFetchExecutor, defineMiddleware, defineRouter, dispatchExecutor, endpoint, isRouterDef, joinPaths, resolvePath, serializeParams, withLogger, withRetry, withTimeout };
|
package/dist/index.d.ts
CHANGED
|
@@ -176,13 +176,38 @@ type ApiClient<TEndpoints extends RouterEndpoints> = {
|
|
|
176
176
|
* @param router - A {@link RouterDef} produced by {@link defineRouter}.
|
|
177
177
|
* @param options - Optional settings (e.g. `validate` to skip schema parsing in production).
|
|
178
178
|
*
|
|
179
|
-
* @example
|
|
179
|
+
* @example Basic usage
|
|
180
180
|
* ```ts
|
|
181
181
|
* const todoApi = createApi(executor, todoRouter);
|
|
182
182
|
* const todos = await todoApi.getList({});
|
|
183
183
|
* const todo = await todoApi.getDetail({ path: { id: 1 } });
|
|
184
|
+
* const next = await todoApi.create({ body: { title: 'buy milk' } });
|
|
185
|
+
* ```
|
|
186
|
+
*
|
|
187
|
+
* @example Nested router — access via dot notation
|
|
188
|
+
* ```ts
|
|
189
|
+
* const api = createApi(executor, apiRouter); // apiRouter has users → todos nesting
|
|
190
|
+
* await api.users.getList({});
|
|
191
|
+
* await api.users.todos.getList({});
|
|
192
|
+
* ```
|
|
193
|
+
*
|
|
194
|
+
* @example Cancel in-flight requests with AbortSignal
|
|
195
|
+
* ```ts
|
|
196
|
+
* const controller = new AbortController();
|
|
197
|
+
* const todos = await todoApi.getList({}, controller.signal);
|
|
198
|
+
* controller.abort();
|
|
199
|
+
* ```
|
|
200
|
+
*
|
|
201
|
+
* @example Extract types from the client — no duplication
|
|
202
|
+
* ```ts
|
|
203
|
+
* import type { ApiTypes } from '@routar/core';
|
|
204
|
+
* type TodoApiTypes = ApiTypes<typeof todoApi>;
|
|
205
|
+
* type Todo = TodoApiTypes['getDetail']['response'];
|
|
206
|
+
* type CreateRequest = TodoApiTypes['create']['request'];
|
|
207
|
+
* ```
|
|
184
208
|
*
|
|
185
|
-
*
|
|
209
|
+
* @example Skip response validation in production
|
|
210
|
+
* ```ts
|
|
186
211
|
* const prodApi = createApi(executor, todoRouter, {
|
|
187
212
|
* validate: { request: true, response: process.env.NODE_ENV !== 'production' },
|
|
188
213
|
* });
|
|
@@ -253,6 +278,85 @@ declare function createExecutor(execute: (options: ExecuteOptions) => Promise<un
|
|
|
253
278
|
*/
|
|
254
279
|
declare function dispatchExecutor(resolver: (opts: ExecuteOptions) => Executor): Executor;
|
|
255
280
|
|
|
281
|
+
/**
|
|
282
|
+
* Creates an {@link Executor} backed by the browser / Node.js `fetch` API.
|
|
283
|
+
*
|
|
284
|
+
* Suited for SSR environments where you need per-request dynamic headers
|
|
285
|
+
* (e.g. forwarding auth cookies) without sharing state across requests.
|
|
286
|
+
*
|
|
287
|
+
* - Query params are serialized and appended to the URL.
|
|
288
|
+
* - A `Content-Type: application/json` header is added automatically when
|
|
289
|
+
* a request body is present.
|
|
290
|
+
* - Responses with status 204 or `Content-Length: 0` resolve to `null`.
|
|
291
|
+
* - Non-2xx responses throw an {@link HttpError}.
|
|
292
|
+
*
|
|
293
|
+
* @param baseURL - Absolute base URL prepended to every endpoint path.
|
|
294
|
+
* @param options.defaultHeaders - Async factory called on every request to
|
|
295
|
+
* produce headers (e.g. reading cookies in a Next.js server component).
|
|
296
|
+
* @param options.middlewares - Middleware chain applied before the fetch call.
|
|
297
|
+
*
|
|
298
|
+
* @example Minimal — no options needed
|
|
299
|
+
* ```ts
|
|
300
|
+
* const executor = createFetchExecutor('https://api.example.com');
|
|
301
|
+
* ```
|
|
302
|
+
*
|
|
303
|
+
* @example SSR with bearer token
|
|
304
|
+
* ```ts
|
|
305
|
+
* const executor = createFetchExecutor('https://api.example.com', {
|
|
306
|
+
* defaultHeaders: async () => {
|
|
307
|
+
* const token = await getServerToken();
|
|
308
|
+
* return token ? { Authorization: `Bearer ${token}` } : {};
|
|
309
|
+
* },
|
|
310
|
+
* });
|
|
311
|
+
* ```
|
|
312
|
+
*
|
|
313
|
+
* @example Next.js App Router — forward cookies from the incoming request
|
|
314
|
+
* ```ts
|
|
315
|
+
* const executor = createFetchExecutor('https://api.example.com', {
|
|
316
|
+
* defaultHeaders: async () => {
|
|
317
|
+
* const { cookies } = await import('next/headers');
|
|
318
|
+
* const token = (await cookies()).get('access_token')?.value;
|
|
319
|
+
* return token ? { Authorization: `Bearer ${token}` } : {};
|
|
320
|
+
* },
|
|
321
|
+
* middlewares: [withTimeout(8_000), withRetry(2)],
|
|
322
|
+
* });
|
|
323
|
+
* ```
|
|
324
|
+
*/
|
|
325
|
+
declare function createFetchExecutor(baseURL: string, options?: {
|
|
326
|
+
defaultHeaders?: () => Record<string, string> | Promise<Record<string, string>>;
|
|
327
|
+
middlewares?: ExecutorMiddleware[];
|
|
328
|
+
}): Executor;
|
|
329
|
+
/**
|
|
330
|
+
* Thrown by {@link createFetchExecutor} when the server returns a non-2xx
|
|
331
|
+
* status code.
|
|
332
|
+
*
|
|
333
|
+
* @example
|
|
334
|
+
* ```ts
|
|
335
|
+
* try {
|
|
336
|
+
* await api.getDetail({ path: { id: 999 } });
|
|
337
|
+
* } catch (err) {
|
|
338
|
+
* if (err instanceof HttpError && err.status === 404) {
|
|
339
|
+
* // handle not-found
|
|
340
|
+
* }
|
|
341
|
+
* }
|
|
342
|
+
* ```
|
|
343
|
+
*/
|
|
344
|
+
declare class HttpError extends Error {
|
|
345
|
+
/** HTTP status code (e.g. 404, 500). */
|
|
346
|
+
readonly status: number;
|
|
347
|
+
/** HTTP status text (e.g. "Not Found"). */
|
|
348
|
+
readonly statusText: string;
|
|
349
|
+
/** Parsed response body, or `null` if the body was empty or not JSON. */
|
|
350
|
+
readonly body: unknown;
|
|
351
|
+
constructor(
|
|
352
|
+
/** HTTP status code (e.g. 404, 500). */
|
|
353
|
+
status: number,
|
|
354
|
+
/** HTTP status text (e.g. "Not Found"). */
|
|
355
|
+
statusText: string,
|
|
356
|
+
/** Parsed response body, or `null` if the body was empty or not JSON. */
|
|
357
|
+
body?: unknown);
|
|
358
|
+
}
|
|
359
|
+
|
|
256
360
|
/**
|
|
257
361
|
* Extracts `:param` segment names from a path template string as a union of
|
|
258
362
|
* string literals.
|
|
@@ -283,7 +387,43 @@ type PathConstraint<TPath extends string> = [PathParams<TPath>] extends [never]
|
|
|
283
387
|
* that `request` includes a matching `path` field with those param names.
|
|
284
388
|
* A mismatch or missing key is a compile-time error.
|
|
285
389
|
*
|
|
286
|
-
* @example
|
|
390
|
+
* @example Basic GET with no params
|
|
391
|
+
* ```ts
|
|
392
|
+
* const getList = endpoint({ method: 'GET', path: '/', response: z.array(TodoSchema) });
|
|
393
|
+
* ```
|
|
394
|
+
*
|
|
395
|
+
* @example GET with query params
|
|
396
|
+
* ```ts
|
|
397
|
+
* const search = endpoint({
|
|
398
|
+
* method: 'GET',
|
|
399
|
+
* path: '/search',
|
|
400
|
+
* request: z.object({ query: z.object({ q: z.string(), limit: z.number().optional() }) }),
|
|
401
|
+
* response: z.array(TodoSchema),
|
|
402
|
+
* });
|
|
403
|
+
* ```
|
|
404
|
+
*
|
|
405
|
+
* @example POST with body
|
|
406
|
+
* ```ts
|
|
407
|
+
* const create = endpoint({
|
|
408
|
+
* method: 'POST',
|
|
409
|
+
* path: '/',
|
|
410
|
+
* request: z.object({ body: z.object({ title: z.string() }) }),
|
|
411
|
+
* response: TodoSchema,
|
|
412
|
+
* });
|
|
413
|
+
* ```
|
|
414
|
+
*
|
|
415
|
+
* @example Adapter — raw is inferred from the response schema, no cast needed
|
|
416
|
+
* ```ts
|
|
417
|
+
* const getDetail = endpoint({
|
|
418
|
+
* method: 'GET',
|
|
419
|
+
* path: '/:id',
|
|
420
|
+
* request: z.object({ path: z.object({ id: z.number() }) }),
|
|
421
|
+
* response: TodoRawSchema,
|
|
422
|
+
* adapter: (raw) => ({ ...raw, label: `#${raw.id} ${raw.title}` }),
|
|
423
|
+
* });
|
|
424
|
+
* ```
|
|
425
|
+
*
|
|
426
|
+
* @example Path param enforcement
|
|
287
427
|
* ```ts
|
|
288
428
|
* // ✅ path has ':id' → request.path.id is required
|
|
289
429
|
* const getDetail = endpoint({
|
|
@@ -291,7 +431,6 @@ type PathConstraint<TPath extends string> = [PathParams<TPath>] extends [never]
|
|
|
291
431
|
* path: '/:id',
|
|
292
432
|
* request: z.object({ path: z.object({ id: z.number() }) }),
|
|
293
433
|
* response: TodoSchema,
|
|
294
|
-
* adapter: toTodoItem,
|
|
295
434
|
* });
|
|
296
435
|
*
|
|
297
436
|
* // ❌ compile error — 'id' is missing from request.path
|
|
@@ -348,6 +487,38 @@ declare function endpoint<TResponse extends Validator<unknown>>(spec: {
|
|
|
348
487
|
response: TResponse;
|
|
349
488
|
};
|
|
350
489
|
|
|
490
|
+
/**
|
|
491
|
+
* Groups a set of endpoint specs (and optional nested routers) under a shared
|
|
492
|
+
* URL prefix.
|
|
493
|
+
*
|
|
494
|
+
* The returned {@link RouterDef} can be passed directly to {@link createApi}
|
|
495
|
+
* to produce a fully-typed API client. Nesting another {@link RouterDef} as a
|
|
496
|
+
* value creates a sub-client whose prefix is the concatenation of both prefixes.
|
|
497
|
+
*
|
|
498
|
+
* @param prefix - Base path prepended to every endpoint's `path` (e.g. `'/users'`).
|
|
499
|
+
* @param endpoints - Record of named {@link EndpointSpec}s or nested {@link RouterDef}s.
|
|
500
|
+
*
|
|
501
|
+
* @example
|
|
502
|
+
* ```ts
|
|
503
|
+
* // Flat router
|
|
504
|
+
* export const todoRouter = defineRouter('/todos', {
|
|
505
|
+
* getList: endpoint({ method: 'GET', path: '/', response: TodoListSchema }),
|
|
506
|
+
* getDetail: endpoint({ method: 'GET', path: '/:id', response: TodoSchema }),
|
|
507
|
+
* create: endpoint({ method: 'POST', path: '/', response: TodoSchema }),
|
|
508
|
+
* });
|
|
509
|
+
*
|
|
510
|
+
* // Nested router — api.users.todos.getList() resolves to GET /users/todos/
|
|
511
|
+
* export const userRouter = defineRouter('/users', {
|
|
512
|
+
* getList: endpoint({ method: 'GET', path: '/', response: UserListSchema }),
|
|
513
|
+
* todos: defineRouter('/todos', {
|
|
514
|
+
* getList: endpoint({ method: 'GET', path: '/', response: TodoListSchema }),
|
|
515
|
+
* getDetail: endpoint({ method: 'GET', path: '/:id', response: TodoSchema }),
|
|
516
|
+
* }),
|
|
517
|
+
* });
|
|
518
|
+
* ```
|
|
519
|
+
*/
|
|
520
|
+
/** Type guard — distinguishes a {@link RouterDef} from a leaf {@link EndpointSpec} at runtime. */
|
|
521
|
+
declare function isRouterDef(entry: object): entry is RouterDef<RouterEndpoints>;
|
|
351
522
|
declare function defineRouter<TEndpoints extends RouterEndpoints>(prefix: string, endpoints: TEndpoints): RouterDef<TEndpoints>;
|
|
352
523
|
|
|
353
524
|
/**
|
|
@@ -400,6 +571,20 @@ declare function withRetry(count: number, options?: {
|
|
|
400
571
|
* so whichever fires first wins.
|
|
401
572
|
*
|
|
402
573
|
* @param ms - Timeout in milliseconds.
|
|
574
|
+
*
|
|
575
|
+
* @example
|
|
576
|
+
* ```ts
|
|
577
|
+
* const executor = createFetchExecutor('https://api.example.com', {
|
|
578
|
+
* middlewares: [withTimeout(5_000)],
|
|
579
|
+
* });
|
|
580
|
+
*
|
|
581
|
+
* // Combine with retry — timeout applies per attempt
|
|
582
|
+
* const executor = createExecutor(transport, [
|
|
583
|
+
* withTimeout(5_000),
|
|
584
|
+
* withRetry(3, { shouldRetry: (err) => !(err instanceof HttpError && err.status < 500) }),
|
|
585
|
+
* withLogger(),
|
|
586
|
+
* ]);
|
|
587
|
+
* ```
|
|
403
588
|
*/
|
|
404
589
|
declare function withTimeout(ms: number): ExecutorMiddleware;
|
|
405
590
|
/**
|
|
@@ -433,4 +618,4 @@ declare class ValidationError extends Error {
|
|
|
433
618
|
constructor(message: string, cause?: unknown);
|
|
434
619
|
}
|
|
435
620
|
|
|
436
|
-
export { type ApiTypes, type CreateApiOptions, type EndpointSpec, type ExecuteOptions, type Executor, type ExecutorMiddleware, type HttpMethod, type InferResponse, type PathParams, type RequestShape, type RouterDef, type RouterEndpoints, type RouterEntry, TimeoutError, ValidationError, type Validator, type ValidatorOutput, createApi, createExecutor, defineMiddleware, defineRouter, dispatchExecutor, endpoint, joinPaths, resolvePath, serializeParams, withLogger, withRetry, withTimeout };
|
|
621
|
+
export { type ApiTypes, type CreateApiOptions, type EndpointSpec, type ExecuteOptions, type Executor, type ExecutorMiddleware, HttpError, type HttpMethod, type InferResponse, type PathParams, type RequestShape, type RouterDef, type RouterEndpoints, type RouterEntry, TimeoutError, ValidationError, type Validator, type ValidatorOutput, createApi, createExecutor, createFetchExecutor, defineMiddleware, defineRouter, dispatchExecutor, endpoint, isRouterDef, joinPaths, resolvePath, serializeParams, withLogger, withRetry, withTimeout };
|
package/dist/index.js
CHANGED
|
@@ -124,6 +124,70 @@ function dispatchExecutor(resolver) {
|
|
|
124
124
|
};
|
|
125
125
|
}
|
|
126
126
|
|
|
127
|
+
// src/utils/params.ts
|
|
128
|
+
function serializeParams(params) {
|
|
129
|
+
const result = new URLSearchParams();
|
|
130
|
+
for (const [key, value] of Object.entries(params)) {
|
|
131
|
+
if (value == null) continue;
|
|
132
|
+
if (Array.isArray(value)) {
|
|
133
|
+
for (const item of value) {
|
|
134
|
+
if (item != null) result.append(key, String(item));
|
|
135
|
+
}
|
|
136
|
+
} else if (typeof value === "object") {
|
|
137
|
+
throw new TypeError(
|
|
138
|
+
`serializeParams: value for key "${key}" is a plain object. Serialize it to a string before passing as a query parameter.`
|
|
139
|
+
);
|
|
140
|
+
} else {
|
|
141
|
+
result.append(key, String(value));
|
|
142
|
+
}
|
|
143
|
+
}
|
|
144
|
+
return result;
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
// src/create-fetch-executor.ts
|
|
148
|
+
function createFetchExecutor(baseURL, options) {
|
|
149
|
+
return createExecutor(
|
|
150
|
+
async ({ method, url, params, body, headers, signal }) => {
|
|
151
|
+
const fullURL = new URL(baseURL.replace(/\/$/, "") + url);
|
|
152
|
+
if (params) {
|
|
153
|
+
serializeParams(params).forEach((v, k) => {
|
|
154
|
+
fullURL.searchParams.set(k, v);
|
|
155
|
+
});
|
|
156
|
+
}
|
|
157
|
+
const defaultHeaders = await options?.defaultHeaders?.() ?? {};
|
|
158
|
+
const res = await fetch(fullURL.toString(), {
|
|
159
|
+
method,
|
|
160
|
+
headers: {
|
|
161
|
+
...defaultHeaders,
|
|
162
|
+
...headers,
|
|
163
|
+
...body != null ? { "Content-Type": "application/json" } : {}
|
|
164
|
+
},
|
|
165
|
+
body: body != null ? JSON.stringify(body) : void 0,
|
|
166
|
+
signal
|
|
167
|
+
});
|
|
168
|
+
if (!res.ok) {
|
|
169
|
+
const errorBody = await res.json().catch(() => null);
|
|
170
|
+
throw new HttpError(res.status, res.statusText, errorBody);
|
|
171
|
+
}
|
|
172
|
+
if (res.status === 204 || res.status === 205 || res.status === 304) {
|
|
173
|
+
return null;
|
|
174
|
+
}
|
|
175
|
+
const text = await res.text();
|
|
176
|
+
return text === "" ? null : JSON.parse(text);
|
|
177
|
+
},
|
|
178
|
+
options?.middlewares
|
|
179
|
+
);
|
|
180
|
+
}
|
|
181
|
+
var HttpError = class extends Error {
|
|
182
|
+
constructor(status, statusText, body = null) {
|
|
183
|
+
super(`HTTP ${status}: ${statusText}`);
|
|
184
|
+
this.status = status;
|
|
185
|
+
this.statusText = statusText;
|
|
186
|
+
this.body = body;
|
|
187
|
+
this.name = "HttpError";
|
|
188
|
+
}
|
|
189
|
+
};
|
|
190
|
+
|
|
127
191
|
// src/define-endpoint.ts
|
|
128
192
|
function endpoint(spec) {
|
|
129
193
|
return spec;
|
|
@@ -210,26 +274,6 @@ function anySignal(signals) {
|
|
|
210
274
|
};
|
|
211
275
|
}
|
|
212
276
|
|
|
213
|
-
|
|
214
|
-
function serializeParams(params) {
|
|
215
|
-
const result = new URLSearchParams();
|
|
216
|
-
for (const [key, value] of Object.entries(params)) {
|
|
217
|
-
if (value == null) continue;
|
|
218
|
-
if (Array.isArray(value)) {
|
|
219
|
-
for (const item of value) {
|
|
220
|
-
if (item != null) result.append(key, String(item));
|
|
221
|
-
}
|
|
222
|
-
} else if (typeof value === "object") {
|
|
223
|
-
throw new TypeError(
|
|
224
|
-
`serializeParams: value for key "${key}" is a plain object. Serialize it to a string before passing as a query parameter.`
|
|
225
|
-
);
|
|
226
|
-
} else {
|
|
227
|
-
result.append(key, String(value));
|
|
228
|
-
}
|
|
229
|
-
}
|
|
230
|
-
return result;
|
|
231
|
-
}
|
|
232
|
-
|
|
233
|
-
export { TimeoutError, ValidationError, createApi, createExecutor, defineMiddleware, defineRouter, dispatchExecutor, endpoint, joinPaths, resolvePath, serializeParams, withLogger, withRetry, withTimeout };
|
|
277
|
+
export { HttpError, TimeoutError, ValidationError, createApi, createExecutor, createFetchExecutor, defineMiddleware, defineRouter, dispatchExecutor, endpoint, isRouterDef, joinPaths, resolvePath, serializeParams, withLogger, withRetry, withTimeout };
|
|
234
278
|
//# sourceMappingURL=index.js.map
|
|
235
279
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/define-router.ts","../src/utils/path.ts","../src/utils/validate.ts","../src/create-api.ts","../src/create-executor.ts","../src/define-endpoint.ts","../src/middleware.ts","../src/utils/params.ts"],"names":[],"mappings":";AAiCO,SAAS,YAAY,KAAA,EAAoD;AAC9E,EAAA,OAAO,QAAA,IAAY,SAAS,WAAA,IAAe,KAAA;AAC7C;AAEO,SAAS,YAAA,CACd,QACA,SAAA,EACuB;AACvB,EAAA,OAAO,EAAE,QAAQ,SAAA,EAAU;AAC7B;;;ACnCO,SAAS,aAAa,QAAA,EAA4B;AACvD,EAAA,MAAM,MAAA,GAAS,QAAA,CACZ,MAAA,CAAO,CAAC,CAAA,KAAM,CAAA,KAAM,EAAE,CAAA,CACtB,IAAA,CAAK,GAAG,CAAA,CACR,OAAA,CAAQ,QAAQ,GAAG,CAAA;AACtB,EAAA,OAAO,MAAA,CAAO,QAAA,CAAS,GAAG,CAAA,IAAK,MAAA,CAAO,MAAA,GAAS,CAAA,GAC3C,MAAA,CAAO,KAAA,CAAM,CAAA,EAAG,EAAE,CAAA,GAClB,MAAA,IAAU,GAAA;AAChB;AAEO,SAAS,WAAA,CACd,cACA,MAAA,EACQ;AACR,EAAA,IAAI,CAAC,QAAQ,OAAO,YAAA;AACpB,EAAA,OAAO,YAAA,CAAa,OAAA,CAAQ,4BAAA,EAA8B,CAAC,GAAG,GAAA,KAAQ;AACpE,IAAA,MAAM,KAAA,GAAQ,OAAO,GAAG,CAAA;AACxB,IAAA,IAAI,KAAA,IAAS,QAAQ,KAAA,KAAU,EAAA,QAAU,IAAI,KAAA,CAAM,CAAA,wBAAA,EAA2B,GAAG,CAAA,CAAE,CAAA;AACnF,IAAA,OAAO,kBAAA,CAAmB,MAAA,CAAO,KAAK,CAAC,CAAA;AAAA,EACzC,CAAC,CAAA;AACH;;;AC3BO,IAAM,eAAA,GAAN,cAA8B,KAAA,CAAM;AAAA,EAGzC,WAAA,CAAY,SAAiB,KAAA,EAAiB;AAC5C,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,IAAA,GAAO,iBAAA;AACZ,IAAA,IAAI,UAAU,MAAA,EAAW;AACvB,MAAA,MAAA,CAAO,cAAA,CAAe,MAAM,OAAA,EAAS;AAAA,QACnC,KAAA,EAAO,KAAA;AAAA,QACP,QAAA,EAAU,KAAA;AAAA,QACV,UAAA,EAAY,KAAA;AAAA,QACZ,YAAA,EAAc;AAAA,OACf,CAAA;AAAA,IACH;AAAA,EACF;AACF;;;ACkFO,SAAS,SAAA,CACd,QAAA,EACA,yBAAA,EAIA,qBAAA,EACA,UAAA,EACyB;AACzB,EAAA,MAAM,EAAE,MAAA,EAAQ,SAAA,EAAW,OAAA,EAAQ,GAAI,WAAA;AAAA,IACrC,yBAAA;AAAA,IACA,qBAAA;AAAA,IACA;AAAA,GACF;AACA,EAAA,OAAO,WAAA,CAAY,QAAA,EAAU,MAAA,EAAQ,SAAA,EAAW,OAAO,CAAA;AACzD;AAEA,SAAS,WAAA,CACP,MAAA,EACA,KAAA,EACA,MAAA,EAKA;AACA,EAAA,IAAI,OAAO,WAAW,QAAA,EAAU;AAC9B,IAAA,IAAI,CAAC,KAAA;AACH,MAAA,MAAM,IAAI,MAAM,+CAA+C,CAAA;AACjE,IAAA,OAAO;AAAA,MACL,MAAA,EAAQ,MAAA;AAAA,MACR,SAAA,EAAW,KAAA;AAAA,MACX,OAAA,EAAS;AAAA,KACX;AAAA,EACF;AACA,EAAA,IAAI,WAAA,CAAY,MAAM,CAAA,EAAG;AACvB,IAAA,OAAO;AAAA,MACL,QAAQ,MAAA,CAAO,MAAA;AAAA,MACf,WAAW,MAAA,CAAO,SAAA;AAAA,MAClB,OAAA,EAAS;AAAA,KACX;AAAA,EACF;AACA,EAAA,OAAO;AAAA,IACL,MAAA,EAAQ,EAAA;AAAA,IACR,SAAA,EAAW,MAAA;AAAA,IACX,OAAA,EAAS;AAAA,GACX;AACF;AAEA,SAAS,cAAA,CACP,SACA,IAAA,EACS;AACT,EAAA,MAAM,IAAI,OAAA,EAAS,QAAA;AACnB,EAAA,IAAI,CAAA,KAAM,MAAA,IAAa,CAAA,KAAM,IAAA,EAAM,OAAO,IAAA;AAC1C,EAAA,IAAI,CAAA,KAAM,OAAO,OAAO,KAAA;AACxB,EAAA,OAAO,CAAA,CAAE,IAAI,CAAA,IAAK,IAAA;AACpB;AAEA,SAAS,WAAA,CACP,QAAA,EACA,MAAA,EACA,SAAA,EACA,OAAA,EACyB;AACzB,EAAA,MAAM,SAAkC,EAAC;AAEzC,EAAA,KAAA,MAAW,CAAC,GAAA,EAAK,KAAK,KAAK,MAAA,CAAO,OAAA,CAAQ,SAAS,CAAA,EAAG;AACpD,IAAA,MAAA,CAAO,GAAG,IAAI,WAAA,CAAY,KAAK,IAC3B,WAAA,CAAY,QAAA,EAAU,UAAU,MAAA,EAAQ,KAAA,CAAM,MAAM,CAAA,EAAG,KAAA,CAAM,WAAW,OAAO,CAAA,GAC/E,gBAAgB,QAAA,EAAU,MAAA,EAAQ,OAAsC,OAAO,CAAA;AAAA,EACrF;AAEA,EAAA,OAAO,MAAA;AACT;AAEA,SAAS,eAAA,CACP,QAAA,EACA,MAAA,EACA,IAAA,EACA,OAAA,EACA;AACA,EAAA,OAAO,OAAO,MAAA,GAAuB,EAAC,EAAG,MAAA,KAAyB;AAChE,IAAA,IAAI,eAAA,GAAgC,MAAA;AACpC,IAAA,IAAI,IAAA,CAAK,OAAA,IAAW,cAAA,CAAe,OAAA,EAAS,SAAS,CAAA,EAAG;AACtD,MAAA,IAAI;AACF,QAAA,eAAA,GAAkB,IAAA,CAAK,OAAA,CAAQ,KAAA,CAAM,MAAM,CAAA;AAAA,MAC7C,SAAS,GAAA,EAAK;AACZ,QAAA,MAAM,IAAI,eAAA,CAAgB,2BAAA,EAA6B,GAAG,CAAA;AAAA,MAC5D;AAAA,IACF;AAEA,IAAA,MAAM,GAAA,GAAM,YAAY,SAAA,CAAU,MAAA,EAAQ,KAAK,IAAI,CAAA,EAAG,iBAAiB,IAAI,CAAA;AAE3E,IAAA,MAAM,GAAA,GAAM,MAAM,QAAA,CAAS,OAAA,CAAQ;AAAA,MACjC,QAAQ,IAAA,CAAK,MAAA;AAAA,MACb,GAAA;AAAA,MACA,QAAQ,eAAA,EAAiB,KAAA;AAAA,MACzB,MAAM,eAAA,EAAiB,IAAA;AAAA,MACvB;AAAA,KACD,CAAA;AAED,IAAA,IAAI,MAAA;AACJ,IAAA,IAAI,cAAA,CAAe,OAAA,EAAS,UAAU,CAAA,EAAG;AACvC,MAAA,IAAI;AACF,QAAA,MAAA,GAAS,IAAA,CAAK,QAAA,CAAS,KAAA,CAAM,GAAG,CAAA;AAAA,MAClC,SAAS,GAAA,EAAK;AACZ,QAAA,MAAM,IAAI,eAAA,CAAgB,4BAAA,EAA8B,GAAG,CAAA;AAAA,MAC7D;AAAA,IACF,CAAA,MAAO;AACL,MAAA,MAAA,GAAS,GAAA;AAAA,IACX;AAEA,IAAA,OAAO,IAAA,CAAK,OAAA,GAAU,IAAA,CAAK,OAAA,CAAQ,MAAM,CAAA,GAAI,MAAA;AAAA,EAC/C,CAAA;AACF;;;AC7LO,SAAS,cAAA,CACd,OAAA,EACA,WAAA,GAAoC,EAAC,EAC3B;AACV,EAAA,MAAM,KAAA,GAAQ,WAAA,CAAY,WAAA,CAExB,CAAC,IAAA,EAAM,EAAA,KAAO,CAAC,IAAA,KAAS,EAAA,CAAG,IAAA,EAAM,IAAI,CAAA,EAAG,OAAO,CAAA;AACjD,EAAA,OAAO,EAAE,SAAS,KAAA,EAAM;AAC1B;AA4BO,SAAS,iBACd,QAAA,EACU;AACV,EAAA,OAAO;AAAA,IACL,SAAS,CAAC,IAAA,KAAS,SAAS,IAAI,CAAA,CAAE,QAAQ,IAAI;AAAA,GAChD;AACF;;;AC4DO,SAAS,SAAS,IAAA,EAAwB;AAC/C,EAAA,OAAO,IAAA;AACT;;;ACzHO,IAAM,YAAA,GAAN,cAA2B,KAAA,CAAM;AAAA,EACtC,YAA4B,EAAA,EAAY;AACtC,IAAA,KAAA,CAAM,CAAA,wBAAA,EAA2B,EAAE,CAAA,EAAA,CAAI,CAAA;AADb,IAAA,IAAA,CAAA,EAAA,GAAA,EAAA;AAE1B,IAAA,IAAA,CAAK,IAAA,GAAO,cAAA;AAAA,EACd;AACF;AAeO,SAAS,iBAAiB,EAAA,EAA4C;AAC3E,EAAA,OAAO,EAAA;AACT;AAoBO,SAAS,SAAA,CACd,OACA,OAAA,EACoB;AACpB,EAAA,OAAO,gBAAA,CAAiB,OAAO,IAAA,EAAM,IAAA,KAAS;AAC5C,IAAA,IAAI,SAAA;AACJ,IAAA,KAAA,IAAS,OAAA,GAAU,CAAA,EAAG,OAAA,IAAW,KAAA,EAAO,OAAA,EAAA,EAAW;AACjD,MAAA,IAAI;AACF,QAAA,OAAO,MAAM,KAAK,IAAI,CAAA;AAAA,MACxB,SAAS,GAAA,EAAK;AACZ,QAAA,SAAA,GAAY,GAAA;AACZ,QAAA,IAAI,YAAY,KAAA,EAAO;AACvB,QAAA,IAAI,SAAS,WAAA,IAAe,CAAC,QAAQ,WAAA,CAAY,GAAA,EAAK,OAAO,CAAA,EAAG;AAAA,MAClE;AAAA,IACF;AACA,IAAA,MAAM,SAAA;AAAA,EACR,CAAC,CAAA;AACH;AAUO,SAAS,YAAY,EAAA,EAAgC;AAC1D,EAAA,OAAO,gBAAA,CAAiB,OAAO,IAAA,EAAM,IAAA,KAAS;AAC5C,IAAA,MAAM,UAAA,GAAa,IAAI,eAAA,EAAgB;AACvC,IAAA,MAAM,KAAA,GAAQ,UAAA,CAAW,MAAM,UAAA,CAAW,KAAA,CAAM,IAAI,YAAA,CAAa,EAAE,CAAC,CAAA,EAAG,EAAE,CAAA;AAEzE,IAAA,MAAM,EAAE,MAAA,EAAQ,OAAA,KAAY,IAAA,CAAK,MAAA,GAC7B,UAAU,CAAC,IAAA,CAAK,QAAQ,UAAA,CAAW,MAAM,CAAC,CAAA,GAC1C,EAAE,QAAQ,UAAA,CAAW,MAAA,EAAQ,SAAS,MAAM;AAAA,IAAC,CAAA,EAAE;AAEnD,IAAA,IAAI;AACF,MAAA,OAAO,MAAM,IAAA,CAAK,EAAE,GAAG,IAAA,EAAM,QAAQ,CAAA;AAAA,IACvC,CAAA,SAAE;AACA,MAAA,YAAA,CAAa,KAAK,CAAA;AAClB,MAAA,OAAA,EAAQ;AAAA,IACV;AAAA,EACF,CAAC,CAAA;AACH;AAYO,SAAS,WAAW,OAAA,EAEJ;AACrB,EAAA,MAAM,GAAA,GAAM,SAAS,GAAA,KAAQ,CAAC,KAAK,IAAA,KAAS,OAAA,CAAQ,GAAA,CAAI,GAAA,EAAK,IAAI,CAAA,CAAA;AACjE,EAAA,OAAO,gBAAA,CAAiB,OAAO,IAAA,EAAM,IAAA,KAAS;AAC5C,IAAA,MAAM,KAAA,GAAQ,KAAK,GAAA,EAAI;AACvB,IAAA,GAAA,CAAI,YAAY,IAAA,CAAK,MAAM,CAAA,CAAA,EAAI,IAAA,CAAK,GAAG,CAAA,CAAA,EAAI;AAAA,MACzC,QAAQ,IAAA,CAAK,MAAA;AAAA,MACb,MAAM,IAAA,CAAK;AAAA,KACZ,CAAA;AACD,IAAA,IAAI;AACF,MAAA,MAAM,MAAA,GAAS,MAAM,IAAA,CAAK,IAAI,CAAA;AAC9B,MAAA,GAAA,CAAI,CAAA,SAAA,EAAY,IAAA,CAAK,MAAM,CAAA,CAAA,EAAI,IAAA,CAAK,GAAG,CAAA,QAAA,EAAM,IAAA,CAAK,GAAA,EAAI,GAAI,KAAK,CAAA,EAAA,CAAI,CAAA;AACnE,MAAA,OAAO,MAAA;AAAA,IACT,SAAS,GAAA,EAAK;AACZ,MAAA,GAAA;AAAA,QACE,CAAA,SAAA,EAAY,IAAA,CAAK,MAAM,CAAA,CAAA,EAAI,IAAA,CAAK,GAAG,CAAA,oBAAA,EAAkB,IAAA,CAAK,GAAA,EAAI,GAAI,KAAK,CAAA,EAAA,CAAA;AAAA,QACvE;AAAA,OACF;AACA,MAAA,MAAM,GAAA;AAAA,IACR;AAAA,EACF,CAAC,CAAA;AACH;AAGA,SAAS,UAAU,OAAA,EAGjB;AACA,EAAA,MAAM,UAAA,GAAa,IAAI,eAAA,EAAgB;AACvC,EAAA,MAAM,OAAA,GAAU,MAAM,UAAA,CAAW,KAAA,EAAM;AACvC,EAAA,MAAM,WAA0B,EAAC;AACjC,EAAA,KAAA,MAAW,KAAK,OAAA,EAAS;AACvB,IAAA,IAAI,EAAE,OAAA,EAAS;AACb,MAAA,UAAA,CAAW,KAAA,EAAM;AACjB,MAAA;AAAA,IACF;AACA,IAAA,CAAA,CAAE,iBAAiB,OAAA,EAAS,OAAA,EAAS,EAAE,IAAA,EAAM,MAAM,CAAA;AACnD,IAAA,QAAA,CAAS,KAAK,CAAC,CAAA;AAAA,EACjB;AACA,EAAA,OAAO;AAAA,IACL,QAAQ,UAAA,CAAW,MAAA;AAAA,IACnB,OAAA,EAAS,MACP,QAAA,CAAS,OAAA,CAAQ,CAAC,CAAA,KAAM;AACtB,MAAA,CAAA,CAAE,mBAAA,CAAoB,SAAS,OAAO,CAAA;AAAA,IACxC,CAAC;AAAA,GACL;AACF;;;ACtJO,SAAS,gBACd,MAAA,EACiB;AACjB,EAAA,MAAM,MAAA,GAAS,IAAI,eAAA,EAAgB;AACnC,EAAA,KAAA,MAAW,CAAC,GAAA,EAAK,KAAK,KAAK,MAAA,CAAO,OAAA,CAAQ,MAAM,CAAA,EAAG;AACjD,IAAA,IAAI,SAAS,IAAA,EAAM;AACnB,IAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,KAAK,CAAA,EAAG;AACxB,MAAA,KAAA,MAAW,QAAQ,KAAA,EAAO;AACxB,QAAA,IAAI,QAAQ,IAAA,EAAM,MAAA,CAAO,OAAO,GAAA,EAAK,MAAA,CAAO,IAAI,CAAC,CAAA;AAAA,MACnD;AAAA,IACF,CAAA,MAAA,IAAW,OAAO,KAAA,KAAU,QAAA,EAAU;AACpC,MAAA,MAAM,IAAI,SAAA;AAAA,QACR,mCAAmC,GAAG,CAAA,kFAAA;AAAA,OACxC;AAAA,IACF,CAAA,MAAO;AACL,MAAA,MAAA,CAAO,MAAA,CAAO,GAAA,EAAK,MAAA,CAAO,KAAK,CAAC,CAAA;AAAA,IAClC;AAAA,EACF;AACA,EAAA,OAAO,MAAA;AACT","file":"index.js","sourcesContent":["import type { RouterDef, RouterEndpoints } from \"./types.js\";\n\n/**\n * Groups a set of endpoint specs (and optional nested routers) under a shared\n * URL prefix.\n *\n * The returned {@link RouterDef} can be passed directly to {@link createApi}\n * to produce a fully-typed API client. Nesting another {@link RouterDef} as a\n * value creates a sub-client whose prefix is the concatenation of both prefixes.\n *\n * @param prefix - Base path prepended to every endpoint's `path` (e.g. `'/users'`).\n * @param endpoints - Record of named {@link EndpointSpec}s or nested {@link RouterDef}s.\n *\n * @example\n * ```ts\n * // Flat router\n * export const todoRouter = defineRouter('/todos', {\n * getList: endpoint({ method: 'GET', path: '/', response: TodoListSchema }),\n * getDetail: endpoint({ method: 'GET', path: '/:id', response: TodoSchema }),\n * create: endpoint({ method: 'POST', path: '/', response: TodoSchema }),\n * });\n *\n * // Nested router — api.users.todos.getList() resolves to GET /users/todos/\n * export const userRouter = defineRouter('/users', {\n * getList: endpoint({ method: 'GET', path: '/', response: UserListSchema }),\n * todos: defineRouter('/todos', {\n * getList: endpoint({ method: 'GET', path: '/', response: TodoListSchema }),\n * getDetail: endpoint({ method: 'GET', path: '/:id', response: TodoSchema }),\n * }),\n * });\n * ```\n */\n/** Type guard — distinguishes a {@link RouterDef} from a leaf {@link EndpointSpec} at runtime. */\nexport function isRouterDef(entry: object): entry is RouterDef<RouterEndpoints> {\n return \"prefix\" in entry && \"endpoints\" in entry;\n}\n\nexport function defineRouter<TEndpoints extends RouterEndpoints>(\n prefix: string,\n endpoints: TEndpoints,\n): RouterDef<TEndpoints> {\n return { prefix, endpoints };\n}\n","/**\n * Joins URL path segments, normalising repeated slashes and trailing slashes.\n *\n * **Note:** Intended for relative API paths only. Absolute URLs containing\n * `://` will be collapsed (`https://` → `https:/`). Pass absolute URLs\n * directly to the executor instead of through this helper.\n */\nexport function joinPaths(...segments: string[]): string {\n const joined = segments\n .filter((s) => s !== \"\")\n .join(\"/\")\n .replace(/\\/+/g, \"/\");\n return joined.endsWith(\"/\") && joined.length > 1\n ? joined.slice(0, -1)\n : joined || \"/\";\n}\n\nexport function resolvePath(\n pathTemplate: string,\n params?: Record<string, unknown>,\n): string {\n if (!params) return pathTemplate;\n return pathTemplate.replace(/:([a-zA-Z_][a-zA-Z0-9_]*)/g, (_, key) => {\n const value = params[key];\n if (value == null || value === \"\") throw new Error(`Missing path parameter: ${key}`);\n return encodeURIComponent(String(value));\n });\n}\n","export class ValidationError extends Error {\n readonly cause?: unknown;\n\n constructor(message: string, cause?: unknown) {\n super(message);\n this.name = \"ValidationError\";\n if (cause !== undefined) {\n Object.defineProperty(this, \"cause\", {\n value: cause,\n writable: false,\n enumerable: false,\n configurable: true,\n });\n }\n }\n}\n","import { isRouterDef } from \"./define-router.js\";\nimport type {\n CreateApiOptions,\n EndpointSpec,\n Executor,\n InferResponse,\n RequestShape,\n RouterDef,\n RouterEndpoints,\n ValidatorOutput,\n} from \"./types.js\";\nimport { joinPaths, resolvePath } from \"./utils/path.js\";\nimport { ValidationError } from \"./utils/validate.js\";\n\n/** Callable type for a single endpoint on the generated API client. */\ntype EndpointFn<TSpec extends EndpointSpec<any, any, any>> =\n TSpec[\"request\"] extends { parse: (data: unknown) => infer R }\n ? (params: R, signal?: AbortSignal) => Promise<InferResponse<TSpec>>\n : (\n params?: RequestShape,\n signal?: AbortSignal,\n ) => Promise<InferResponse<TSpec>>;\n\n/**\n * Fully-typed API client produced by {@link createApi}.\n * Nested {@link RouterDef} entries become nested sub-client objects.\n */\ntype ApiClient<TEndpoints extends RouterEndpoints> = {\n [K in keyof TEndpoints]: TEndpoints[K] extends RouterDef<\n infer TNestedEndpoints\n >\n ? ApiClient<TNestedEndpoints>\n : TEndpoints[K] extends EndpointSpec<any, any, any>\n ? EndpointFn<TEndpoints[K]>\n : never;\n};\n\n/**\n * Builds a fully-typed API client from an {@link Executor} and a router\n * (or bare endpoint map).\n *\n * Three call signatures are supported:\n * - `createApi(executor, router)` — preferred; pass the result of {@link defineRouter}.\n * - `createApi(executor, prefix, endpoints)` — inline router without {@link defineRouter}.\n * - `createApi(executor, endpoints)` — no prefix; useful for flat endpoint maps.\n *\n * Each key in `endpoints` becomes a typed async function on the returned client.\n * The function validates the request with `spec.request.parse` (if present),\n * resolves path parameters, calls the executor, validates the response with\n * `spec.response.parse`, and applies `spec.adapter` (if present).\n *\n * @param executor - Transport to use for every HTTP call.\n * @param router - A {@link RouterDef} produced by {@link defineRouter}.\n * @param options - Optional settings (e.g. `validate` to skip schema parsing in production).\n *\n * @example\n * ```ts\n * const todoApi = createApi(executor, todoRouter);\n * const todos = await todoApi.getList({});\n * const todo = await todoApi.getDetail({ path: { id: 1 } });\n *\n * // Skip response validation in production\n * const prodApi = createApi(executor, todoRouter, {\n * validate: { request: true, response: process.env.NODE_ENV !== 'production' },\n * });\n * ```\n */\nexport function createApi<TEndpoints extends RouterEndpoints>(\n executor: Executor,\n router: RouterDef<TEndpoints>,\n options?: CreateApiOptions,\n): ApiClient<TEndpoints>;\n\n/**\n * @param executor - Transport to use for every HTTP call.\n * @param prefix - URL prefix prepended to every endpoint path.\n * @param endpoints - Record of named endpoint specs.\n * @param options - Optional settings.\n */\nexport function createApi<TEndpoints extends RouterEndpoints>(\n executor: Executor,\n prefix: string,\n endpoints: TEndpoints,\n options?: CreateApiOptions,\n): ApiClient<TEndpoints>;\n\n/**\n * @param executor - Transport to use for every HTTP call.\n * @param endpoints - Record of named endpoint specs (no URL prefix).\n * @param options - Optional settings.\n */\nexport function createApi<TEndpoints extends RouterEndpoints>(\n executor: Executor,\n endpoints: TEndpoints,\n options?: CreateApiOptions,\n): ApiClient<TEndpoints>;\n\nexport function createApi(\n executor: Executor,\n routerOrPrefixOrEndpoints:\n | RouterDef<RouterEndpoints>\n | RouterEndpoints\n | string,\n endpointsArgOrOptions?: RouterEndpoints | CreateApiOptions,\n optionsArg?: CreateApiOptions,\n): Record<string, unknown> {\n const { prefix, endpoints, options } = resolveArgs(\n routerOrPrefixOrEndpoints,\n endpointsArgOrOptions,\n optionsArg,\n );\n return buildClient(executor, prefix, endpoints, options);\n}\n\nfunction resolveArgs(\n second: RouterDef<RouterEndpoints> | RouterEndpoints | string,\n third: RouterEndpoints | CreateApiOptions | undefined,\n fourth: CreateApiOptions | undefined,\n): {\n prefix: string;\n endpoints: RouterEndpoints;\n options: CreateApiOptions | undefined;\n} {\n if (typeof second === \"string\") {\n if (!third)\n throw new Error(\"endpoints is required when prefix is provided\");\n return {\n prefix: second,\n endpoints: third as RouterEndpoints,\n options: fourth,\n };\n }\n if (isRouterDef(second)) {\n return {\n prefix: second.prefix,\n endpoints: second.endpoints,\n options: third as CreateApiOptions | undefined,\n };\n }\n return {\n prefix: \"\",\n endpoints: second as RouterEndpoints,\n options: third as CreateApiOptions | undefined,\n };\n}\n\nfunction shouldValidate(\n options: CreateApiOptions | undefined,\n kind: \"request\" | \"response\",\n): boolean {\n const v = options?.validate;\n if (v === undefined || v === true) return true;\n if (v === false) return false;\n return v[kind] ?? true;\n}\n\nfunction buildClient(\n executor: Executor,\n prefix: string,\n endpoints: RouterEndpoints,\n options?: CreateApiOptions,\n): Record<string, unknown> {\n const client: Record<string, unknown> = {};\n\n for (const [key, entry] of Object.entries(endpoints)) {\n client[key] = isRouterDef(entry)\n ? buildClient(executor, joinPaths(prefix, entry.prefix), entry.endpoints, options)\n : buildEndpointFn(executor, prefix, entry as EndpointSpec<any, any, any>, options);\n }\n\n return client;\n}\n\nfunction buildEndpointFn(\n executor: Executor,\n prefix: string,\n spec: EndpointSpec<any, any, any>,\n options: CreateApiOptions | undefined,\n) {\n return async (params: RequestShape = {}, signal?: AbortSignal) => {\n let validatedParams: RequestShape = params;\n if (spec.request && shouldValidate(options, \"request\")) {\n try {\n validatedParams = spec.request.parse(params);\n } catch (err) {\n throw new ValidationError(\"Request validation failed\", err);\n }\n }\n\n const url = resolvePath(joinPaths(prefix, spec.path), validatedParams?.path);\n\n const raw = await executor.execute({\n method: spec.method,\n url,\n params: validatedParams?.query as Record<string, unknown> | undefined,\n body: validatedParams?.body,\n signal,\n });\n\n let result: ValidatorOutput<typeof spec.response>;\n if (shouldValidate(options, \"response\")) {\n try {\n result = spec.response.parse(raw);\n } catch (err) {\n throw new ValidationError(\"Response validation failed\", err);\n }\n } else {\n result = raw;\n }\n\n return spec.adapter ? spec.adapter(result) : result;\n };\n}\n","import type { ExecuteOptions, Executor, ExecutorMiddleware } from \"./types.js\";\n\n/**\n * Creates an {@link Executor} by wrapping a transport function with an\n * optional middleware chain.\n *\n * Middlewares are applied in declaration order — the first middleware is the\n * outermost wrapper and runs first on each request.\n *\n * @param execute - The underlying transport function (fetch, axios, etc.).\n * @param middlewares - Ordered list of middlewares to apply.\n *\n * @example\n * ```ts\n * const executor = createExecutor(\n * async ({ method, url, body }) => {\n * const res = await fetch(url, { method, body: JSON.stringify(body) });\n * return res.json();\n * },\n * [withTimeout(5000), withRetry(3), withLogger()],\n * );\n * ```\n */\nexport function createExecutor(\n execute: (options: ExecuteOptions) => Promise<unknown>,\n middlewares: ExecutorMiddleware[] = [],\n): Executor {\n const chain = middlewares.reduceRight<\n (options: ExecuteOptions) => Promise<unknown>\n >((next, mw) => (opts) => mw(opts, next), execute);\n return { execute: chain };\n}\n\n/**\n * Creates an {@link Executor} that selects the underlying transport at\n * request time based on the result of `resolver`.\n *\n * Use this to unify SSR and CSR behind a single API client — the resolver\n * picks the right executor per request, so `createApi` is called once and\n * works in both environments without duplicate `*ServerApi` instances.\n *\n * The resolver receives the full {@link ExecuteOptions} so it can branch on\n * environment, URL prefix, auth context, or any runtime condition.\n *\n * @param resolver - Called on every request; returns the executor to delegate to.\n *\n * @example\n * ```ts\n * // SSR vs CSR — pick transport based on environment\n * const apiExecutor = dispatchExecutor(() =>\n * typeof window === 'undefined' ? serverExecutor : clientExecutor,\n * );\n *\n * // Route by URL prefix — internal routes use a different transport\n * const apiExecutor = dispatchExecutor((opts) =>\n * opts.url.startsWith('/internal') ? internalExecutor : publicExecutor,\n * );\n * ```\n */\nexport function dispatchExecutor(\n resolver: (opts: ExecuteOptions) => Executor,\n): Executor {\n return {\n execute: (opts) => resolver(opts).execute(opts),\n };\n}\n","import type {\n HttpMethod,\n RequestShape,\n Validator,\n ValidatorOutput,\n} from \"./types.js\";\n\n/**\n * Extracts `:param` segment names from a path template string as a union of\n * string literals.\n *\n * @example\n * ```ts\n * type P = PathParams<'/:userId/posts/:postId'>; // 'userId' | 'postId'\n * ```\n */\nexport type PathParams<TPath extends string> =\n TPath extends `${string}:${infer Param}/${infer Rest}`\n ? Param | PathParams<Rest>\n : TPath extends `${string}:${infer Param}`\n ? Param\n : never;\n\n/**\n * When `TPath` contains dynamic segments (`:param`), requires `request.path`\n * to include all extracted param names. No constraint for static paths.\n */\ntype PathConstraint<TPath extends string> = [PathParams<TPath>] extends [never]\n ? {}\n : { path: Record<PathParams<TPath>, unknown> };\n\n/**\n * Type-safe endpoint definition helper.\n *\n * Use this instead of a plain object literal to get full type inference on\n * `adapter` without requiring explicit annotations or `as any` casts.\n * The four overloads cover every combination of optional `request` validator\n * and optional `adapter` function while keeping all return-type fields\n * required so that TypeScript can narrow them downstream.\n *\n * When `path` contains dynamic segments (e.g. `'/:id'`), TypeScript enforces\n * that `request` includes a matching `path` field with those param names.\n * A mismatch or missing key is a compile-time error.\n *\n * @example\n * ```ts\n * // ✅ path has ':id' → request.path.id is required\n * const getDetail = endpoint({\n * method: 'GET',\n * path: '/:id',\n * request: z.object({ path: z.object({ id: z.number() }) }),\n * response: TodoSchema,\n * adapter: toTodoItem,\n * });\n *\n * // ❌ compile error — 'id' is missing from request.path\n * const broken = endpoint({\n * method: 'GET',\n * path: '/:id',\n * request: z.object({ query: z.object({ foo: z.string() }) }),\n * response: TodoSchema,\n * });\n * ```\n */\n// request O + adapter O\nexport function endpoint<\n TPath extends string,\n TRequest extends RequestShape & PathConstraint<TPath>,\n TResponse extends Validator<unknown>,\n TOut,\n>(spec: {\n method: HttpMethod;\n path: TPath;\n request: Validator<TRequest>;\n response: TResponse;\n adapter: (raw: ValidatorOutput<TResponse>) => TOut;\n}): {\n method: HttpMethod;\n path: string;\n request: Validator<TRequest>;\n response: TResponse;\n adapter: (raw: ValidatorOutput<TResponse>) => TOut;\n};\n\n// request O + adapter X\nexport function endpoint<\n TPath extends string,\n TRequest extends RequestShape & PathConstraint<TPath>,\n TResponse extends Validator<unknown>,\n>(spec: {\n method: HttpMethod;\n path: TPath;\n request: Validator<TRequest>;\n response: TResponse;\n}): {\n method: HttpMethod;\n path: string;\n request: Validator<TRequest>;\n response: TResponse;\n};\n\n// request X + adapter O\nexport function endpoint<TResponse extends Validator<unknown>, TOut>(spec: {\n method: HttpMethod;\n path: string;\n response: TResponse;\n adapter: (raw: ValidatorOutput<TResponse>) => TOut;\n}): {\n method: HttpMethod;\n path: string;\n response: TResponse;\n adapter: (raw: ValidatorOutput<TResponse>) => TOut;\n};\n\n// request X + adapter X\nexport function endpoint<TResponse extends Validator<unknown>>(spec: {\n method: HttpMethod;\n path: string;\n response: TResponse;\n}): {\n method: HttpMethod;\n path: string;\n response: TResponse;\n};\n\nexport function endpoint(spec: unknown): unknown {\n return spec;\n}\n","import type { ExecutorMiddleware } from \"./types.js\";\n\n/**\n * Thrown by {@link withTimeout} when a request exceeds the configured duration.\n * Distinguishable from a user-initiated {@link AbortSignal} cancellation.\n */\nexport class TimeoutError extends Error {\n constructor(public readonly ms: number) {\n super(`Request timed out after ${ms}ms`);\n this.name = \"TimeoutError\";\n }\n}\n\n/**\n * Identity helper that returns the middleware as-is.\n *\n * Wrap your middleware function with this to get full type inference on `opts`\n * and `next` without having to annotate the type manually.\n *\n * @example\n * ```ts\n * const withCorrelationId = defineMiddleware((opts, next) =>\n * next({ ...opts, headers: { ...opts.headers, 'X-Request-Id': crypto.randomUUID() } })\n * );\n * ```\n */\nexport function defineMiddleware(fn: ExecutorMiddleware): ExecutorMiddleware {\n return fn;\n}\n\n/**\n * Retries a failed request up to `count` additional times.\n *\n * By default all errors trigger a retry. Pass `shouldRetry` to skip retries\n * for non-transient errors (e.g. 4xx responses).\n *\n * @param count - Number of retries (not counting the initial attempt).\n * @param options.shouldRetry - Return `false` to stop retrying early.\n * Receives the error and a zero-based `attempt` index (0 = first failure,\n * 1 = second failure, …) so you can limit retries by count or error type.\n *\n * @example\n * ```ts\n * withRetry(3, {\n * shouldRetry: (err) => err instanceof HttpError && err.status >= 500,\n * })\n * ```\n */\nexport function withRetry(\n count: number,\n options?: { shouldRetry?: (error: unknown, attempt: number) => boolean },\n): ExecutorMiddleware {\n return defineMiddleware(async (opts, next) => {\n let lastError: unknown;\n for (let attempt = 0; attempt <= count; attempt++) {\n try {\n return await next(opts);\n } catch (err) {\n lastError = err;\n if (attempt === count) break;\n if (options?.shouldRetry && !options.shouldRetry(err, attempt)) break;\n }\n }\n throw lastError;\n });\n}\n\n/**\n * Aborts a request if it does not complete within `ms` milliseconds.\n *\n * Merges the timeout signal with any existing `AbortSignal` on the request,\n * so whichever fires first wins.\n *\n * @param ms - Timeout in milliseconds.\n */\nexport function withTimeout(ms: number): ExecutorMiddleware {\n return defineMiddleware(async (opts, next) => {\n const controller = new AbortController();\n const timer = setTimeout(() => controller.abort(new TimeoutError(ms)), ms);\n\n const { signal, cleanup } = opts.signal\n ? anySignal([opts.signal, controller.signal])\n : { signal: controller.signal, cleanup: () => {} };\n\n try {\n return await next({ ...opts, signal });\n } finally {\n clearTimeout(timer);\n cleanup();\n }\n });\n}\n\n/**\n * Logs each request and its outcome (success duration or error).\n *\n * @param options.log - Custom logging function. Defaults to `console.log`.\n *\n * @example\n * ```ts\n * withLogger({ log: (msg, data) => logger.debug(msg, data) })\n * ```\n */\nexport function withLogger(options?: {\n log?: (message: string, data?: unknown) => void;\n}): ExecutorMiddleware {\n const log = options?.log ?? ((msg, data) => console.log(msg, data));\n return defineMiddleware(async (opts, next) => {\n const start = Date.now();\n log(`[routar] ${opts.method} ${opts.url}`, {\n params: opts.params,\n body: opts.body,\n });\n try {\n const result = await next(opts);\n log(`[routar] ${opts.method} ${opts.url} — ${Date.now() - start}ms`);\n return result;\n } catch (err) {\n log(\n `[routar] ${opts.method} ${opts.url} — error after ${Date.now() - start}ms`,\n err,\n );\n throw err;\n }\n });\n}\n\n/** Combines multiple AbortSignals into one that aborts when any of them fire. */\nfunction anySignal(signals: AbortSignal[]): {\n signal: AbortSignal;\n cleanup: () => void;\n} {\n const controller = new AbortController();\n const onAbort = () => controller.abort();\n const attached: AbortSignal[] = [];\n for (const s of signals) {\n if (s.aborted) {\n controller.abort();\n break;\n }\n s.addEventListener(\"abort\", onAbort, { once: true });\n attached.push(s);\n }\n return {\n signal: controller.signal,\n cleanup: () =>\n attached.forEach((s) => {\n s.removeEventListener(\"abort\", onAbort);\n }),\n };\n}\n","export function serializeParams(\n params: Record<string, unknown>,\n): URLSearchParams {\n const result = new URLSearchParams();\n for (const [key, value] of Object.entries(params)) {\n if (value == null) continue;\n if (Array.isArray(value)) {\n for (const item of value) {\n if (item != null) result.append(key, String(item));\n }\n } else if (typeof value === \"object\") {\n throw new TypeError(\n `serializeParams: value for key \"${key}\" is a plain object. Serialize it to a string before passing as a query parameter.`,\n );\n } else {\n result.append(key, String(value));\n }\n }\n return result;\n}\n"]}
|
|
1
|
+
{"version":3,"sources":["../src/define-router.ts","../src/utils/path.ts","../src/utils/validate.ts","../src/create-api.ts","../src/create-executor.ts","../src/utils/params.ts","../src/create-fetch-executor.ts","../src/define-endpoint.ts","../src/middleware.ts"],"names":[],"mappings":";AAiCO,SAAS,YAAY,KAAA,EAAoD;AAC9E,EAAA,OAAO,QAAA,IAAY,SAAS,WAAA,IAAe,KAAA;AAC7C;AAEO,SAAS,YAAA,CACd,QACA,SAAA,EACuB;AACvB,EAAA,OAAO,EAAE,QAAQ,SAAA,EAAU;AAC7B;;;ACnCO,SAAS,aAAa,QAAA,EAA4B;AACvD,EAAA,MAAM,MAAA,GAAS,QAAA,CACZ,MAAA,CAAO,CAAC,CAAA,KAAM,CAAA,KAAM,EAAE,CAAA,CACtB,IAAA,CAAK,GAAG,CAAA,CACR,OAAA,CAAQ,QAAQ,GAAG,CAAA;AACtB,EAAA,OAAO,MAAA,CAAO,QAAA,CAAS,GAAG,CAAA,IAAK,MAAA,CAAO,MAAA,GAAS,CAAA,GAC3C,MAAA,CAAO,KAAA,CAAM,CAAA,EAAG,EAAE,CAAA,GAClB,MAAA,IAAU,GAAA;AAChB;AAEO,SAAS,WAAA,CACd,cACA,MAAA,EACQ;AACR,EAAA,IAAI,CAAC,QAAQ,OAAO,YAAA;AACpB,EAAA,OAAO,YAAA,CAAa,OAAA,CAAQ,4BAAA,EAA8B,CAAC,GAAG,GAAA,KAAQ;AACpE,IAAA,MAAM,KAAA,GAAQ,OAAO,GAAG,CAAA;AACxB,IAAA,IAAI,KAAA,IAAS,QAAQ,KAAA,KAAU,EAAA,QAAU,IAAI,KAAA,CAAM,CAAA,wBAAA,EAA2B,GAAG,CAAA,CAAE,CAAA;AACnF,IAAA,OAAO,kBAAA,CAAmB,MAAA,CAAO,KAAK,CAAC,CAAA;AAAA,EACzC,CAAC,CAAA;AACH;;;AC3BO,IAAM,eAAA,GAAN,cAA8B,KAAA,CAAM;AAAA,EAGzC,WAAA,CAAY,SAAiB,KAAA,EAAiB;AAC5C,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,IAAA,GAAO,iBAAA;AACZ,IAAA,IAAI,UAAU,MAAA,EAAW;AACvB,MAAA,MAAA,CAAO,cAAA,CAAe,MAAM,OAAA,EAAS;AAAA,QACnC,KAAA,EAAO,KAAA;AAAA,QACP,QAAA,EAAU,KAAA;AAAA,QACV,UAAA,EAAY,KAAA;AAAA,QACZ,YAAA,EAAc;AAAA,OACf,CAAA;AAAA,IACH;AAAA,EACF;AACF;;;AC2GO,SAAS,SAAA,CACd,QAAA,EACA,yBAAA,EAIA,qBAAA,EACA,UAAA,EACyB;AACzB,EAAA,MAAM,EAAE,MAAA,EAAQ,SAAA,EAAW,OAAA,EAAQ,GAAI,WAAA;AAAA,IACrC,yBAAA;AAAA,IACA,qBAAA;AAAA,IACA;AAAA,GACF;AACA,EAAA,OAAO,WAAA,CAAY,QAAA,EAAU,MAAA,EAAQ,SAAA,EAAW,OAAO,CAAA;AACzD;AAEA,SAAS,WAAA,CACP,MAAA,EACA,KAAA,EACA,MAAA,EAKA;AACA,EAAA,IAAI,OAAO,WAAW,QAAA,EAAU;AAC9B,IAAA,IAAI,CAAC,KAAA;AACH,MAAA,MAAM,IAAI,MAAM,+CAA+C,CAAA;AACjE,IAAA,OAAO;AAAA,MACL,MAAA,EAAQ,MAAA;AAAA,MACR,SAAA,EAAW,KAAA;AAAA,MACX,OAAA,EAAS;AAAA,KACX;AAAA,EACF;AACA,EAAA,IAAI,WAAA,CAAY,MAAM,CAAA,EAAG;AACvB,IAAA,OAAO;AAAA,MACL,QAAQ,MAAA,CAAO,MAAA;AAAA,MACf,WAAW,MAAA,CAAO,SAAA;AAAA,MAClB,OAAA,EAAS;AAAA,KACX;AAAA,EACF;AACA,EAAA,OAAO;AAAA,IACL,MAAA,EAAQ,EAAA;AAAA,IACR,SAAA,EAAW,MAAA;AAAA,IACX,OAAA,EAAS;AAAA,GACX;AACF;AAEA,SAAS,cAAA,CACP,SACA,IAAA,EACS;AACT,EAAA,MAAM,IAAI,OAAA,EAAS,QAAA;AACnB,EAAA,IAAI,CAAA,KAAM,MAAA,IAAa,CAAA,KAAM,IAAA,EAAM,OAAO,IAAA;AAC1C,EAAA,IAAI,CAAA,KAAM,OAAO,OAAO,KAAA;AACxB,EAAA,OAAO,CAAA,CAAE,IAAI,CAAA,IAAK,IAAA;AACpB;AAEA,SAAS,WAAA,CACP,QAAA,EACA,MAAA,EACA,SAAA,EACA,OAAA,EACyB;AACzB,EAAA,MAAM,SAAkC,EAAC;AAEzC,EAAA,KAAA,MAAW,CAAC,GAAA,EAAK,KAAK,KAAK,MAAA,CAAO,OAAA,CAAQ,SAAS,CAAA,EAAG;AACpD,IAAA,MAAA,CAAO,GAAG,IAAI,WAAA,CAAY,KAAK,IAC3B,WAAA,CAAY,QAAA,EAAU,UAAU,MAAA,EAAQ,KAAA,CAAM,MAAM,CAAA,EAAG,KAAA,CAAM,WAAW,OAAO,CAAA,GAC/E,gBAAgB,QAAA,EAAU,MAAA,EAAQ,OAAsC,OAAO,CAAA;AAAA,EACrF;AAEA,EAAA,OAAO,MAAA;AACT;AAEA,SAAS,eAAA,CACP,QAAA,EACA,MAAA,EACA,IAAA,EACA,OAAA,EACA;AACA,EAAA,OAAO,OAAO,MAAA,GAAuB,EAAC,EAAG,MAAA,KAAyB;AAChE,IAAA,IAAI,eAAA,GAAgC,MAAA;AACpC,IAAA,IAAI,IAAA,CAAK,OAAA,IAAW,cAAA,CAAe,OAAA,EAAS,SAAS,CAAA,EAAG;AACtD,MAAA,IAAI;AACF,QAAA,eAAA,GAAkB,IAAA,CAAK,OAAA,CAAQ,KAAA,CAAM,MAAM,CAAA;AAAA,MAC7C,SAAS,GAAA,EAAK;AACZ,QAAA,MAAM,IAAI,eAAA,CAAgB,2BAAA,EAA6B,GAAG,CAAA;AAAA,MAC5D;AAAA,IACF;AAEA,IAAA,MAAM,GAAA,GAAM,YAAY,SAAA,CAAU,MAAA,EAAQ,KAAK,IAAI,CAAA,EAAG,iBAAiB,IAAI,CAAA;AAE3E,IAAA,MAAM,GAAA,GAAM,MAAM,QAAA,CAAS,OAAA,CAAQ;AAAA,MACjC,QAAQ,IAAA,CAAK,MAAA;AAAA,MACb,GAAA;AAAA,MACA,QAAQ,eAAA,EAAiB,KAAA;AAAA,MACzB,MAAM,eAAA,EAAiB,IAAA;AAAA,MACvB;AAAA,KACD,CAAA;AAED,IAAA,IAAI,MAAA;AACJ,IAAA,IAAI,cAAA,CAAe,OAAA,EAAS,UAAU,CAAA,EAAG;AACvC,MAAA,IAAI;AACF,QAAA,MAAA,GAAS,IAAA,CAAK,QAAA,CAAS,KAAA,CAAM,GAAG,CAAA;AAAA,MAClC,SAAS,GAAA,EAAK;AACZ,QAAA,MAAM,IAAI,eAAA,CAAgB,4BAAA,EAA8B,GAAG,CAAA;AAAA,MAC7D;AAAA,IACF,CAAA,MAAO;AACL,MAAA,MAAA,GAAS,GAAA;AAAA,IACX;AAEA,IAAA,OAAO,IAAA,CAAK,OAAA,GAAU,IAAA,CAAK,OAAA,CAAQ,MAAM,CAAA,GAAI,MAAA;AAAA,EAC/C,CAAA;AACF;;;ACtNO,SAAS,cAAA,CACd,OAAA,EACA,WAAA,GAAoC,EAAC,EAC3B;AACV,EAAA,MAAM,KAAA,GAAQ,WAAA,CAAY,WAAA,CAExB,CAAC,IAAA,EAAM,EAAA,KAAO,CAAC,IAAA,KAAS,EAAA,CAAG,IAAA,EAAM,IAAI,CAAA,EAAG,OAAO,CAAA;AACjD,EAAA,OAAO,EAAE,SAAS,KAAA,EAAM;AAC1B;AA4BO,SAAS,iBACd,QAAA,EACU;AACV,EAAA,OAAO;AAAA,IACL,SAAS,CAAC,IAAA,KAAS,SAAS,IAAI,CAAA,CAAE,QAAQ,IAAI;AAAA,GAChD;AACF;;;ACjEO,SAAS,gBACd,MAAA,EACiB;AACjB,EAAA,MAAM,MAAA,GAAS,IAAI,eAAA,EAAgB;AACnC,EAAA,KAAA,MAAW,CAAC,GAAA,EAAK,KAAK,KAAK,MAAA,CAAO,OAAA,CAAQ,MAAM,CAAA,EAAG;AACjD,IAAA,IAAI,SAAS,IAAA,EAAM;AACnB,IAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,KAAK,CAAA,EAAG;AACxB,MAAA,KAAA,MAAW,QAAQ,KAAA,EAAO;AACxB,QAAA,IAAI,QAAQ,IAAA,EAAM,MAAA,CAAO,OAAO,GAAA,EAAK,MAAA,CAAO,IAAI,CAAC,CAAA;AAAA,MACnD;AAAA,IACF,CAAA,MAAA,IAAW,OAAO,KAAA,KAAU,QAAA,EAAU;AACpC,MAAA,MAAM,IAAI,SAAA;AAAA,QACR,mCAAmC,GAAG,CAAA,kFAAA;AAAA,OACxC;AAAA,IACF,CAAA,MAAO;AACL,MAAA,MAAA,CAAO,MAAA,CAAO,GAAA,EAAK,MAAA,CAAO,KAAK,CAAC,CAAA;AAAA,IAClC;AAAA,EACF;AACA,EAAA,OAAO,MAAA;AACT;;;AC6BO,SAAS,mBAAA,CACd,SACA,OAAA,EAMU;AACV,EAAA,OAAO,cAAA;AAAA,IACL,OAAO,EAAE,MAAA,EAAQ,GAAA,EAAK,QAAQ,IAAA,EAAM,OAAA,EAAS,QAAO,KAAM;AACxD,MAAA,MAAM,OAAA,GAAU,IAAI,GAAA,CAAI,OAAA,CAAQ,QAAQ,KAAA,EAAO,EAAE,IAAI,GAAG,CAAA;AACxD,MAAA,IAAI,MAAA,EAAQ;AACV,QAAA,eAAA,CAAgB,MAAM,CAAA,CAAE,OAAA,CAAQ,CAAC,GAAG,CAAA,KAAM;AACxC,UAAA,OAAA,CAAQ,YAAA,CAAa,GAAA,CAAI,CAAA,EAAG,CAAC,CAAA;AAAA,QAC/B,CAAC,CAAA;AAAA,MACH;AAEA,MAAA,MAAM,cAAA,GAAkB,MAAM,OAAA,EAAS,cAAA,QAAuB,EAAC;AAE/D,MAAA,MAAM,GAAA,GAAM,MAAM,KAAA,CAAM,OAAA,CAAQ,UAAS,EAAG;AAAA,QAC1C,MAAA;AAAA,QACA,OAAA,EAAS;AAAA,UACP,GAAG,cAAA;AAAA,UACH,GAAG,OAAA;AAAA,UACH,GAAI,IAAA,IAAQ,IAAA,GAAO,EAAE,cAAA,EAAgB,kBAAA,KAAuB;AAAC,SAC/D;AAAA,QACA,MAAM,IAAA,IAAQ,IAAA,GAAO,IAAA,CAAK,SAAA,CAAU,IAAI,CAAA,GAAI,MAAA;AAAA,QAC5C;AAAA,OACD,CAAA;AAED,MAAA,IAAI,CAAC,IAAI,EAAA,EAAI;AACX,QAAA,MAAM,YAAY,MAAM,GAAA,CAAI,MAAK,CAAE,KAAA,CAAM,MAAM,IAAI,CAAA;AACnD,QAAA,MAAM,IAAI,SAAA,CAAU,GAAA,CAAI,MAAA,EAAQ,GAAA,CAAI,YAAY,SAAS,CAAA;AAAA,MAC3D;AACA,MAAA,IAAI,GAAA,CAAI,WAAW,GAAA,IAAO,GAAA,CAAI,WAAW,GAAA,IAAO,GAAA,CAAI,WAAW,GAAA,EAAK;AAClE,QAAA,OAAO,IAAA;AAAA,MACT;AACA,MAAA,MAAM,IAAA,GAAO,MAAM,GAAA,CAAI,IAAA,EAAK;AAC5B,MAAA,OAAO,IAAA,KAAS,EAAA,GAAK,IAAA,GAAO,IAAA,CAAK,MAAM,IAAI,CAAA;AAAA,IAC7C,CAAA;AAAA,IACA,OAAA,EAAS;AAAA,GACX;AACF;AAiBO,IAAM,SAAA,GAAN,cAAwB,KAAA,CAAM;AAAA,EACnC,WAAA,CAEkB,MAAA,EAEA,UAAA,EAEA,IAAA,GAAgB,IAAA,EAChC;AACA,IAAA,KAAA,CAAM,CAAA,KAAA,EAAQ,MAAM,CAAA,EAAA,EAAK,UAAU,CAAA,CAAE,CAAA;AANrB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AAEA,IAAA,IAAA,CAAA,UAAA,GAAA,UAAA;AAEA,IAAA,IAAA,CAAA,IAAA,GAAA,IAAA;AAGhB,IAAA,IAAA,CAAK,IAAA,GAAO,WAAA;AAAA,EACd;AACF;;;ACwCO,SAAS,SAAS,IAAA,EAAwB;AAC/C,EAAA,OAAO,IAAA;AACT;;;AC5JO,IAAM,YAAA,GAAN,cAA2B,KAAA,CAAM;AAAA,EACtC,YAA4B,EAAA,EAAY;AACtC,IAAA,KAAA,CAAM,CAAA,wBAAA,EAA2B,EAAE,CAAA,EAAA,CAAI,CAAA;AADb,IAAA,IAAA,CAAA,EAAA,GAAA,EAAA;AAE1B,IAAA,IAAA,CAAK,IAAA,GAAO,cAAA;AAAA,EACd;AACF;AAeO,SAAS,iBAAiB,EAAA,EAA4C;AAC3E,EAAA,OAAO,EAAA;AACT;AAoBO,SAAS,SAAA,CACd,OACA,OAAA,EACoB;AACpB,EAAA,OAAO,gBAAA,CAAiB,OAAO,IAAA,EAAM,IAAA,KAAS;AAC5C,IAAA,IAAI,SAAA;AACJ,IAAA,KAAA,IAAS,OAAA,GAAU,CAAA,EAAG,OAAA,IAAW,KAAA,EAAO,OAAA,EAAA,EAAW;AACjD,MAAA,IAAI;AACF,QAAA,OAAO,MAAM,KAAK,IAAI,CAAA;AAAA,MACxB,SAAS,GAAA,EAAK;AACZ,QAAA,SAAA,GAAY,GAAA;AACZ,QAAA,IAAI,YAAY,KAAA,EAAO;AACvB,QAAA,IAAI,SAAS,WAAA,IAAe,CAAC,QAAQ,WAAA,CAAY,GAAA,EAAK,OAAO,CAAA,EAAG;AAAA,MAClE;AAAA,IACF;AACA,IAAA,MAAM,SAAA;AAAA,EACR,CAAC,CAAA;AACH;AAwBO,SAAS,YAAY,EAAA,EAAgC;AAC1D,EAAA,OAAO,gBAAA,CAAiB,OAAO,IAAA,EAAM,IAAA,KAAS;AAC5C,IAAA,MAAM,UAAA,GAAa,IAAI,eAAA,EAAgB;AACvC,IAAA,MAAM,KAAA,GAAQ,UAAA,CAAW,MAAM,UAAA,CAAW,KAAA,CAAM,IAAI,YAAA,CAAa,EAAE,CAAC,CAAA,EAAG,EAAE,CAAA;AAEzE,IAAA,MAAM,EAAE,MAAA,EAAQ,OAAA,KAAY,IAAA,CAAK,MAAA,GAC7B,UAAU,CAAC,IAAA,CAAK,QAAQ,UAAA,CAAW,MAAM,CAAC,CAAA,GAC1C,EAAE,QAAQ,UAAA,CAAW,MAAA,EAAQ,SAAS,MAAM;AAAA,IAAC,CAAA,EAAE;AAEnD,IAAA,IAAI;AACF,MAAA,OAAO,MAAM,IAAA,CAAK,EAAE,GAAG,IAAA,EAAM,QAAQ,CAAA;AAAA,IACvC,CAAA,SAAE;AACA,MAAA,YAAA,CAAa,KAAK,CAAA;AAClB,MAAA,OAAA,EAAQ;AAAA,IACV;AAAA,EACF,CAAC,CAAA;AACH;AAYO,SAAS,WAAW,OAAA,EAEJ;AACrB,EAAA,MAAM,GAAA,GAAM,SAAS,GAAA,KAAQ,CAAC,KAAK,IAAA,KAAS,OAAA,CAAQ,GAAA,CAAI,GAAA,EAAK,IAAI,CAAA,CAAA;AACjE,EAAA,OAAO,gBAAA,CAAiB,OAAO,IAAA,EAAM,IAAA,KAAS;AAC5C,IAAA,MAAM,KAAA,GAAQ,KAAK,GAAA,EAAI;AACvB,IAAA,GAAA,CAAI,YAAY,IAAA,CAAK,MAAM,CAAA,CAAA,EAAI,IAAA,CAAK,GAAG,CAAA,CAAA,EAAI;AAAA,MACzC,QAAQ,IAAA,CAAK,MAAA;AAAA,MACb,MAAM,IAAA,CAAK;AAAA,KACZ,CAAA;AACD,IAAA,IAAI;AACF,MAAA,MAAM,MAAA,GAAS,MAAM,IAAA,CAAK,IAAI,CAAA;AAC9B,MAAA,GAAA,CAAI,CAAA,SAAA,EAAY,IAAA,CAAK,MAAM,CAAA,CAAA,EAAI,IAAA,CAAK,GAAG,CAAA,QAAA,EAAM,IAAA,CAAK,GAAA,EAAI,GAAI,KAAK,CAAA,EAAA,CAAI,CAAA;AACnE,MAAA,OAAO,MAAA;AAAA,IACT,SAAS,GAAA,EAAK;AACZ,MAAA,GAAA;AAAA,QACE,CAAA,SAAA,EAAY,IAAA,CAAK,MAAM,CAAA,CAAA,EAAI,IAAA,CAAK,GAAG,CAAA,oBAAA,EAAkB,IAAA,CAAK,GAAA,EAAI,GAAI,KAAK,CAAA,EAAA,CAAA;AAAA,QACvE;AAAA,OACF;AACA,MAAA,MAAM,GAAA;AAAA,IACR;AAAA,EACF,CAAC,CAAA;AACH;AAGA,SAAS,UAAU,OAAA,EAGjB;AACA,EAAA,MAAM,UAAA,GAAa,IAAI,eAAA,EAAgB;AACvC,EAAA,MAAM,OAAA,GAAU,MAAM,UAAA,CAAW,KAAA,EAAM;AACvC,EAAA,MAAM,WAA0B,EAAC;AACjC,EAAA,KAAA,MAAW,KAAK,OAAA,EAAS;AACvB,IAAA,IAAI,EAAE,OAAA,EAAS;AACb,MAAA,UAAA,CAAW,KAAA,EAAM;AACjB,MAAA;AAAA,IACF;AACA,IAAA,CAAA,CAAE,iBAAiB,OAAA,EAAS,OAAA,EAAS,EAAE,IAAA,EAAM,MAAM,CAAA;AACnD,IAAA,QAAA,CAAS,KAAK,CAAC,CAAA;AAAA,EACjB;AACA,EAAA,OAAO;AAAA,IACL,QAAQ,UAAA,CAAW,MAAA;AAAA,IACnB,OAAA,EAAS,MACP,QAAA,CAAS,OAAA,CAAQ,CAAC,CAAA,KAAM;AACtB,MAAA,CAAA,CAAE,mBAAA,CAAoB,SAAS,OAAO,CAAA;AAAA,IACxC,CAAC;AAAA,GACL;AACF","file":"index.js","sourcesContent":["import type { RouterDef, RouterEndpoints } from \"./types.js\";\n\n/**\n * Groups a set of endpoint specs (and optional nested routers) under a shared\n * URL prefix.\n *\n * The returned {@link RouterDef} can be passed directly to {@link createApi}\n * to produce a fully-typed API client. Nesting another {@link RouterDef} as a\n * value creates a sub-client whose prefix is the concatenation of both prefixes.\n *\n * @param prefix - Base path prepended to every endpoint's `path` (e.g. `'/users'`).\n * @param endpoints - Record of named {@link EndpointSpec}s or nested {@link RouterDef}s.\n *\n * @example\n * ```ts\n * // Flat router\n * export const todoRouter = defineRouter('/todos', {\n * getList: endpoint({ method: 'GET', path: '/', response: TodoListSchema }),\n * getDetail: endpoint({ method: 'GET', path: '/:id', response: TodoSchema }),\n * create: endpoint({ method: 'POST', path: '/', response: TodoSchema }),\n * });\n *\n * // Nested router — api.users.todos.getList() resolves to GET /users/todos/\n * export const userRouter = defineRouter('/users', {\n * getList: endpoint({ method: 'GET', path: '/', response: UserListSchema }),\n * todos: defineRouter('/todos', {\n * getList: endpoint({ method: 'GET', path: '/', response: TodoListSchema }),\n * getDetail: endpoint({ method: 'GET', path: '/:id', response: TodoSchema }),\n * }),\n * });\n * ```\n */\n/** Type guard — distinguishes a {@link RouterDef} from a leaf {@link EndpointSpec} at runtime. */\nexport function isRouterDef(entry: object): entry is RouterDef<RouterEndpoints> {\n return \"prefix\" in entry && \"endpoints\" in entry;\n}\n\nexport function defineRouter<TEndpoints extends RouterEndpoints>(\n prefix: string,\n endpoints: TEndpoints,\n): RouterDef<TEndpoints> {\n return { prefix, endpoints };\n}\n","/**\n * Joins URL path segments, normalising repeated slashes and trailing slashes.\n *\n * **Note:** Intended for relative API paths only. Absolute URLs containing\n * `://` will be collapsed (`https://` → `https:/`). Pass absolute URLs\n * directly to the executor instead of through this helper.\n */\nexport function joinPaths(...segments: string[]): string {\n const joined = segments\n .filter((s) => s !== \"\")\n .join(\"/\")\n .replace(/\\/+/g, \"/\");\n return joined.endsWith(\"/\") && joined.length > 1\n ? joined.slice(0, -1)\n : joined || \"/\";\n}\n\nexport function resolvePath(\n pathTemplate: string,\n params?: Record<string, unknown>,\n): string {\n if (!params) return pathTemplate;\n return pathTemplate.replace(/:([a-zA-Z_][a-zA-Z0-9_]*)/g, (_, key) => {\n const value = params[key];\n if (value == null || value === \"\") throw new Error(`Missing path parameter: ${key}`);\n return encodeURIComponent(String(value));\n });\n}\n","export class ValidationError extends Error {\n readonly cause?: unknown;\n\n constructor(message: string, cause?: unknown) {\n super(message);\n this.name = \"ValidationError\";\n if (cause !== undefined) {\n Object.defineProperty(this, \"cause\", {\n value: cause,\n writable: false,\n enumerable: false,\n configurable: true,\n });\n }\n }\n}\n","import { isRouterDef } from \"./define-router.js\";\nimport type {\n CreateApiOptions,\n EndpointSpec,\n Executor,\n InferResponse,\n RequestShape,\n RouterDef,\n RouterEndpoints,\n ValidatorOutput,\n} from \"./types.js\";\nimport { joinPaths, resolvePath } from \"./utils/path.js\";\nimport { ValidationError } from \"./utils/validate.js\";\n\n/** Callable type for a single endpoint on the generated API client. */\ntype EndpointFn<TSpec extends EndpointSpec<any, any, any>> =\n TSpec[\"request\"] extends { parse: (data: unknown) => infer R }\n ? (params: R, signal?: AbortSignal) => Promise<InferResponse<TSpec>>\n : (\n params?: RequestShape,\n signal?: AbortSignal,\n ) => Promise<InferResponse<TSpec>>;\n\n/**\n * Fully-typed API client produced by {@link createApi}.\n * Nested {@link RouterDef} entries become nested sub-client objects.\n */\ntype ApiClient<TEndpoints extends RouterEndpoints> = {\n [K in keyof TEndpoints]: TEndpoints[K] extends RouterDef<\n infer TNestedEndpoints\n >\n ? ApiClient<TNestedEndpoints>\n : TEndpoints[K] extends EndpointSpec<any, any, any>\n ? EndpointFn<TEndpoints[K]>\n : never;\n};\n\n/**\n * Builds a fully-typed API client from an {@link Executor} and a router\n * (or bare endpoint map).\n *\n * Three call signatures are supported:\n * - `createApi(executor, router)` — preferred; pass the result of {@link defineRouter}.\n * - `createApi(executor, prefix, endpoints)` — inline router without {@link defineRouter}.\n * - `createApi(executor, endpoints)` — no prefix; useful for flat endpoint maps.\n *\n * Each key in `endpoints` becomes a typed async function on the returned client.\n * The function validates the request with `spec.request.parse` (if present),\n * resolves path parameters, calls the executor, validates the response with\n * `spec.response.parse`, and applies `spec.adapter` (if present).\n *\n * @param executor - Transport to use for every HTTP call.\n * @param router - A {@link RouterDef} produced by {@link defineRouter}.\n * @param options - Optional settings (e.g. `validate` to skip schema parsing in production).\n *\n * @example Basic usage\n * ```ts\n * const todoApi = createApi(executor, todoRouter);\n * const todos = await todoApi.getList({});\n * const todo = await todoApi.getDetail({ path: { id: 1 } });\n * const next = await todoApi.create({ body: { title: 'buy milk' } });\n * ```\n *\n * @example Nested router — access via dot notation\n * ```ts\n * const api = createApi(executor, apiRouter); // apiRouter has users → todos nesting\n * await api.users.getList({});\n * await api.users.todos.getList({});\n * ```\n *\n * @example Cancel in-flight requests with AbortSignal\n * ```ts\n * const controller = new AbortController();\n * const todos = await todoApi.getList({}, controller.signal);\n * controller.abort();\n * ```\n *\n * @example Extract types from the client — no duplication\n * ```ts\n * import type { ApiTypes } from '@routar/core';\n * type TodoApiTypes = ApiTypes<typeof todoApi>;\n * type Todo = TodoApiTypes['getDetail']['response'];\n * type CreateRequest = TodoApiTypes['create']['request'];\n * ```\n *\n * @example Skip response validation in production\n * ```ts\n * const prodApi = createApi(executor, todoRouter, {\n * validate: { request: true, response: process.env.NODE_ENV !== 'production' },\n * });\n * ```\n */\nexport function createApi<TEndpoints extends RouterEndpoints>(\n executor: Executor,\n router: RouterDef<TEndpoints>,\n options?: CreateApiOptions,\n): ApiClient<TEndpoints>;\n\n/**\n * @param executor - Transport to use for every HTTP call.\n * @param prefix - URL prefix prepended to every endpoint path.\n * @param endpoints - Record of named endpoint specs.\n * @param options - Optional settings.\n */\nexport function createApi<TEndpoints extends RouterEndpoints>(\n executor: Executor,\n prefix: string,\n endpoints: TEndpoints,\n options?: CreateApiOptions,\n): ApiClient<TEndpoints>;\n\n/**\n * @param executor - Transport to use for every HTTP call.\n * @param endpoints - Record of named endpoint specs (no URL prefix).\n * @param options - Optional settings.\n */\nexport function createApi<TEndpoints extends RouterEndpoints>(\n executor: Executor,\n endpoints: TEndpoints,\n options?: CreateApiOptions,\n): ApiClient<TEndpoints>;\n\nexport function createApi(\n executor: Executor,\n routerOrPrefixOrEndpoints:\n | RouterDef<RouterEndpoints>\n | RouterEndpoints\n | string,\n endpointsArgOrOptions?: RouterEndpoints | CreateApiOptions,\n optionsArg?: CreateApiOptions,\n): Record<string, unknown> {\n const { prefix, endpoints, options } = resolveArgs(\n routerOrPrefixOrEndpoints,\n endpointsArgOrOptions,\n optionsArg,\n );\n return buildClient(executor, prefix, endpoints, options);\n}\n\nfunction resolveArgs(\n second: RouterDef<RouterEndpoints> | RouterEndpoints | string,\n third: RouterEndpoints | CreateApiOptions | undefined,\n fourth: CreateApiOptions | undefined,\n): {\n prefix: string;\n endpoints: RouterEndpoints;\n options: CreateApiOptions | undefined;\n} {\n if (typeof second === \"string\") {\n if (!third)\n throw new Error(\"endpoints is required when prefix is provided\");\n return {\n prefix: second,\n endpoints: third as RouterEndpoints,\n options: fourth,\n };\n }\n if (isRouterDef(second)) {\n return {\n prefix: second.prefix,\n endpoints: second.endpoints,\n options: third as CreateApiOptions | undefined,\n };\n }\n return {\n prefix: \"\",\n endpoints: second as RouterEndpoints,\n options: third as CreateApiOptions | undefined,\n };\n}\n\nfunction shouldValidate(\n options: CreateApiOptions | undefined,\n kind: \"request\" | \"response\",\n): boolean {\n const v = options?.validate;\n if (v === undefined || v === true) return true;\n if (v === false) return false;\n return v[kind] ?? true;\n}\n\nfunction buildClient(\n executor: Executor,\n prefix: string,\n endpoints: RouterEndpoints,\n options?: CreateApiOptions,\n): Record<string, unknown> {\n const client: Record<string, unknown> = {};\n\n for (const [key, entry] of Object.entries(endpoints)) {\n client[key] = isRouterDef(entry)\n ? buildClient(executor, joinPaths(prefix, entry.prefix), entry.endpoints, options)\n : buildEndpointFn(executor, prefix, entry as EndpointSpec<any, any, any>, options);\n }\n\n return client;\n}\n\nfunction buildEndpointFn(\n executor: Executor,\n prefix: string,\n spec: EndpointSpec<any, any, any>,\n options: CreateApiOptions | undefined,\n) {\n return async (params: RequestShape = {}, signal?: AbortSignal) => {\n let validatedParams: RequestShape = params;\n if (spec.request && shouldValidate(options, \"request\")) {\n try {\n validatedParams = spec.request.parse(params);\n } catch (err) {\n throw new ValidationError(\"Request validation failed\", err);\n }\n }\n\n const url = resolvePath(joinPaths(prefix, spec.path), validatedParams?.path);\n\n const raw = await executor.execute({\n method: spec.method,\n url,\n params: validatedParams?.query as Record<string, unknown> | undefined,\n body: validatedParams?.body,\n signal,\n });\n\n let result: ValidatorOutput<typeof spec.response>;\n if (shouldValidate(options, \"response\")) {\n try {\n result = spec.response.parse(raw);\n } catch (err) {\n throw new ValidationError(\"Response validation failed\", err);\n }\n } else {\n result = raw;\n }\n\n return spec.adapter ? spec.adapter(result) : result;\n };\n}\n","import type { ExecuteOptions, Executor, ExecutorMiddleware } from \"./types.js\";\n\n/**\n * Creates an {@link Executor} by wrapping a transport function with an\n * optional middleware chain.\n *\n * Middlewares are applied in declaration order — the first middleware is the\n * outermost wrapper and runs first on each request.\n *\n * @param execute - The underlying transport function (fetch, axios, etc.).\n * @param middlewares - Ordered list of middlewares to apply.\n *\n * @example\n * ```ts\n * const executor = createExecutor(\n * async ({ method, url, body }) => {\n * const res = await fetch(url, { method, body: JSON.stringify(body) });\n * return res.json();\n * },\n * [withTimeout(5000), withRetry(3), withLogger()],\n * );\n * ```\n */\nexport function createExecutor(\n execute: (options: ExecuteOptions) => Promise<unknown>,\n middlewares: ExecutorMiddleware[] = [],\n): Executor {\n const chain = middlewares.reduceRight<\n (options: ExecuteOptions) => Promise<unknown>\n >((next, mw) => (opts) => mw(opts, next), execute);\n return { execute: chain };\n}\n\n/**\n * Creates an {@link Executor} that selects the underlying transport at\n * request time based on the result of `resolver`.\n *\n * Use this to unify SSR and CSR behind a single API client — the resolver\n * picks the right executor per request, so `createApi` is called once and\n * works in both environments without duplicate `*ServerApi` instances.\n *\n * The resolver receives the full {@link ExecuteOptions} so it can branch on\n * environment, URL prefix, auth context, or any runtime condition.\n *\n * @param resolver - Called on every request; returns the executor to delegate to.\n *\n * @example\n * ```ts\n * // SSR vs CSR — pick transport based on environment\n * const apiExecutor = dispatchExecutor(() =>\n * typeof window === 'undefined' ? serverExecutor : clientExecutor,\n * );\n *\n * // Route by URL prefix — internal routes use a different transport\n * const apiExecutor = dispatchExecutor((opts) =>\n * opts.url.startsWith('/internal') ? internalExecutor : publicExecutor,\n * );\n * ```\n */\nexport function dispatchExecutor(\n resolver: (opts: ExecuteOptions) => Executor,\n): Executor {\n return {\n execute: (opts) => resolver(opts).execute(opts),\n };\n}\n","export function serializeParams(\n params: Record<string, unknown>,\n): URLSearchParams {\n const result = new URLSearchParams();\n for (const [key, value] of Object.entries(params)) {\n if (value == null) continue;\n if (Array.isArray(value)) {\n for (const item of value) {\n if (item != null) result.append(key, String(item));\n }\n } else if (typeof value === \"object\") {\n throw new TypeError(\n `serializeParams: value for key \"${key}\" is a plain object. Serialize it to a string before passing as a query parameter.`,\n );\n } else {\n result.append(key, String(value));\n }\n }\n return result;\n}\n","import type { Executor, ExecutorMiddleware } from \"./types.js\";\nimport { createExecutor } from \"./create-executor.js\";\nimport { serializeParams } from \"./utils/params.js\";\n\n/**\n * Creates an {@link Executor} backed by the browser / Node.js `fetch` API.\n *\n * Suited for SSR environments where you need per-request dynamic headers\n * (e.g. forwarding auth cookies) without sharing state across requests.\n *\n * - Query params are serialized and appended to the URL.\n * - A `Content-Type: application/json` header is added automatically when\n * a request body is present.\n * - Responses with status 204 or `Content-Length: 0` resolve to `null`.\n * - Non-2xx responses throw an {@link HttpError}.\n *\n * @param baseURL - Absolute base URL prepended to every endpoint path.\n * @param options.defaultHeaders - Async factory called on every request to\n * produce headers (e.g. reading cookies in a Next.js server component).\n * @param options.middlewares - Middleware chain applied before the fetch call.\n *\n * @example Minimal — no options needed\n * ```ts\n * const executor = createFetchExecutor('https://api.example.com');\n * ```\n *\n * @example SSR with bearer token\n * ```ts\n * const executor = createFetchExecutor('https://api.example.com', {\n * defaultHeaders: async () => {\n * const token = await getServerToken();\n * return token ? { Authorization: `Bearer ${token}` } : {};\n * },\n * });\n * ```\n *\n * @example Next.js App Router — forward cookies from the incoming request\n * ```ts\n * const executor = createFetchExecutor('https://api.example.com', {\n * defaultHeaders: async () => {\n * const { cookies } = await import('next/headers');\n * const token = (await cookies()).get('access_token')?.value;\n * return token ? { Authorization: `Bearer ${token}` } : {};\n * },\n * middlewares: [withTimeout(8_000), withRetry(2)],\n * });\n * ```\n */\nexport function createFetchExecutor(\n baseURL: string,\n options?: {\n defaultHeaders?: () =>\n | Record<string, string>\n | Promise<Record<string, string>>;\n middlewares?: ExecutorMiddleware[];\n },\n): Executor {\n return createExecutor(\n async ({ method, url, params, body, headers, signal }) => {\n const fullURL = new URL(baseURL.replace(/\\/$/, \"\") + url);\n if (params) {\n serializeParams(params).forEach((v, k) => {\n fullURL.searchParams.set(k, v);\n });\n }\n\n const defaultHeaders = (await options?.defaultHeaders?.()) ?? {};\n\n const res = await fetch(fullURL.toString(), {\n method,\n headers: {\n ...defaultHeaders,\n ...headers,\n ...(body != null ? { \"Content-Type\": \"application/json\" } : {}),\n },\n body: body != null ? JSON.stringify(body) : undefined,\n signal,\n });\n\n if (!res.ok) {\n const errorBody = await res.json().catch(() => null);\n throw new HttpError(res.status, res.statusText, errorBody);\n }\n if (res.status === 204 || res.status === 205 || res.status === 304) {\n return null;\n }\n const text = await res.text();\n return text === \"\" ? null : JSON.parse(text);\n },\n options?.middlewares,\n );\n}\n\n/**\n * Thrown by {@link createFetchExecutor} when the server returns a non-2xx\n * status code.\n *\n * @example\n * ```ts\n * try {\n * await api.getDetail({ path: { id: 999 } });\n * } catch (err) {\n * if (err instanceof HttpError && err.status === 404) {\n * // handle not-found\n * }\n * }\n * ```\n */\nexport class HttpError extends Error {\n constructor(\n /** HTTP status code (e.g. 404, 500). */\n public readonly status: number,\n /** HTTP status text (e.g. \"Not Found\"). */\n public readonly statusText: string,\n /** Parsed response body, or `null` if the body was empty or not JSON. */\n public readonly body: unknown = null,\n ) {\n super(`HTTP ${status}: ${statusText}`);\n this.name = \"HttpError\";\n }\n}\n","import type {\n HttpMethod,\n RequestShape,\n Validator,\n ValidatorOutput,\n} from \"./types.js\";\n\n/**\n * Extracts `:param` segment names from a path template string as a union of\n * string literals.\n *\n * @example\n * ```ts\n * type P = PathParams<'/:userId/posts/:postId'>; // 'userId' | 'postId'\n * ```\n */\nexport type PathParams<TPath extends string> =\n TPath extends `${string}:${infer Param}/${infer Rest}`\n ? Param | PathParams<Rest>\n : TPath extends `${string}:${infer Param}`\n ? Param\n : never;\n\n/**\n * When `TPath` contains dynamic segments (`:param`), requires `request.path`\n * to include all extracted param names. No constraint for static paths.\n */\ntype PathConstraint<TPath extends string> = [PathParams<TPath>] extends [never]\n ? {}\n : { path: Record<PathParams<TPath>, unknown> };\n\n/**\n * Type-safe endpoint definition helper.\n *\n * Use this instead of a plain object literal to get full type inference on\n * `adapter` without requiring explicit annotations or `as any` casts.\n * The four overloads cover every combination of optional `request` validator\n * and optional `adapter` function while keeping all return-type fields\n * required so that TypeScript can narrow them downstream.\n *\n * When `path` contains dynamic segments (e.g. `'/:id'`), TypeScript enforces\n * that `request` includes a matching `path` field with those param names.\n * A mismatch or missing key is a compile-time error.\n *\n * @example Basic GET with no params\n * ```ts\n * const getList = endpoint({ method: 'GET', path: '/', response: z.array(TodoSchema) });\n * ```\n *\n * @example GET with query params\n * ```ts\n * const search = endpoint({\n * method: 'GET',\n * path: '/search',\n * request: z.object({ query: z.object({ q: z.string(), limit: z.number().optional() }) }),\n * response: z.array(TodoSchema),\n * });\n * ```\n *\n * @example POST with body\n * ```ts\n * const create = endpoint({\n * method: 'POST',\n * path: '/',\n * request: z.object({ body: z.object({ title: z.string() }) }),\n * response: TodoSchema,\n * });\n * ```\n *\n * @example Adapter — raw is inferred from the response schema, no cast needed\n * ```ts\n * const getDetail = endpoint({\n * method: 'GET',\n * path: '/:id',\n * request: z.object({ path: z.object({ id: z.number() }) }),\n * response: TodoRawSchema,\n * adapter: (raw) => ({ ...raw, label: `#${raw.id} ${raw.title}` }),\n * });\n * ```\n *\n * @example Path param enforcement\n * ```ts\n * // ✅ path has ':id' → request.path.id is required\n * const getDetail = endpoint({\n * method: 'GET',\n * path: '/:id',\n * request: z.object({ path: z.object({ id: z.number() }) }),\n * response: TodoSchema,\n * });\n *\n * // ❌ compile error — 'id' is missing from request.path\n * const broken = endpoint({\n * method: 'GET',\n * path: '/:id',\n * request: z.object({ query: z.object({ foo: z.string() }) }),\n * response: TodoSchema,\n * });\n * ```\n */\n// request O + adapter O\nexport function endpoint<\n TPath extends string,\n TRequest extends RequestShape & PathConstraint<TPath>,\n TResponse extends Validator<unknown>,\n TOut,\n>(spec: {\n method: HttpMethod;\n path: TPath;\n request: Validator<TRequest>;\n response: TResponse;\n adapter: (raw: ValidatorOutput<TResponse>) => TOut;\n}): {\n method: HttpMethod;\n path: string;\n request: Validator<TRequest>;\n response: TResponse;\n adapter: (raw: ValidatorOutput<TResponse>) => TOut;\n};\n\n// request O + adapter X\nexport function endpoint<\n TPath extends string,\n TRequest extends RequestShape & PathConstraint<TPath>,\n TResponse extends Validator<unknown>,\n>(spec: {\n method: HttpMethod;\n path: TPath;\n request: Validator<TRequest>;\n response: TResponse;\n}): {\n method: HttpMethod;\n path: string;\n request: Validator<TRequest>;\n response: TResponse;\n};\n\n// request X + adapter O\nexport function endpoint<TResponse extends Validator<unknown>, TOut>(spec: {\n method: HttpMethod;\n path: string;\n response: TResponse;\n adapter: (raw: ValidatorOutput<TResponse>) => TOut;\n}): {\n method: HttpMethod;\n path: string;\n response: TResponse;\n adapter: (raw: ValidatorOutput<TResponse>) => TOut;\n};\n\n// request X + adapter X\nexport function endpoint<TResponse extends Validator<unknown>>(spec: {\n method: HttpMethod;\n path: string;\n response: TResponse;\n}): {\n method: HttpMethod;\n path: string;\n response: TResponse;\n};\n\nexport function endpoint(spec: unknown): unknown {\n return spec;\n}\n","import type { ExecutorMiddleware } from \"./types.js\";\n\n/**\n * Thrown by {@link withTimeout} when a request exceeds the configured duration.\n * Distinguishable from a user-initiated {@link AbortSignal} cancellation.\n */\nexport class TimeoutError extends Error {\n constructor(public readonly ms: number) {\n super(`Request timed out after ${ms}ms`);\n this.name = \"TimeoutError\";\n }\n}\n\n/**\n * Identity helper that returns the middleware as-is.\n *\n * Wrap your middleware function with this to get full type inference on `opts`\n * and `next` without having to annotate the type manually.\n *\n * @example\n * ```ts\n * const withCorrelationId = defineMiddleware((opts, next) =>\n * next({ ...opts, headers: { ...opts.headers, 'X-Request-Id': crypto.randomUUID() } })\n * );\n * ```\n */\nexport function defineMiddleware(fn: ExecutorMiddleware): ExecutorMiddleware {\n return fn;\n}\n\n/**\n * Retries a failed request up to `count` additional times.\n *\n * By default all errors trigger a retry. Pass `shouldRetry` to skip retries\n * for non-transient errors (e.g. 4xx responses).\n *\n * @param count - Number of retries (not counting the initial attempt).\n * @param options.shouldRetry - Return `false` to stop retrying early.\n * Receives the error and a zero-based `attempt` index (0 = first failure,\n * 1 = second failure, …) so you can limit retries by count or error type.\n *\n * @example\n * ```ts\n * withRetry(3, {\n * shouldRetry: (err) => err instanceof HttpError && err.status >= 500,\n * })\n * ```\n */\nexport function withRetry(\n count: number,\n options?: { shouldRetry?: (error: unknown, attempt: number) => boolean },\n): ExecutorMiddleware {\n return defineMiddleware(async (opts, next) => {\n let lastError: unknown;\n for (let attempt = 0; attempt <= count; attempt++) {\n try {\n return await next(opts);\n } catch (err) {\n lastError = err;\n if (attempt === count) break;\n if (options?.shouldRetry && !options.shouldRetry(err, attempt)) break;\n }\n }\n throw lastError;\n });\n}\n\n/**\n * Aborts a request if it does not complete within `ms` milliseconds.\n *\n * Merges the timeout signal with any existing `AbortSignal` on the request,\n * so whichever fires first wins.\n *\n * @param ms - Timeout in milliseconds.\n *\n * @example\n * ```ts\n * const executor = createFetchExecutor('https://api.example.com', {\n * middlewares: [withTimeout(5_000)],\n * });\n *\n * // Combine with retry — timeout applies per attempt\n * const executor = createExecutor(transport, [\n * withTimeout(5_000),\n * withRetry(3, { shouldRetry: (err) => !(err instanceof HttpError && err.status < 500) }),\n * withLogger(),\n * ]);\n * ```\n */\nexport function withTimeout(ms: number): ExecutorMiddleware {\n return defineMiddleware(async (opts, next) => {\n const controller = new AbortController();\n const timer = setTimeout(() => controller.abort(new TimeoutError(ms)), ms);\n\n const { signal, cleanup } = opts.signal\n ? anySignal([opts.signal, controller.signal])\n : { signal: controller.signal, cleanup: () => {} };\n\n try {\n return await next({ ...opts, signal });\n } finally {\n clearTimeout(timer);\n cleanup();\n }\n });\n}\n\n/**\n * Logs each request and its outcome (success duration or error).\n *\n * @param options.log - Custom logging function. Defaults to `console.log`.\n *\n * @example\n * ```ts\n * withLogger({ log: (msg, data) => logger.debug(msg, data) })\n * ```\n */\nexport function withLogger(options?: {\n log?: (message: string, data?: unknown) => void;\n}): ExecutorMiddleware {\n const log = options?.log ?? ((msg, data) => console.log(msg, data));\n return defineMiddleware(async (opts, next) => {\n const start = Date.now();\n log(`[routar] ${opts.method} ${opts.url}`, {\n params: opts.params,\n body: opts.body,\n });\n try {\n const result = await next(opts);\n log(`[routar] ${opts.method} ${opts.url} — ${Date.now() - start}ms`);\n return result;\n } catch (err) {\n log(\n `[routar] ${opts.method} ${opts.url} — error after ${Date.now() - start}ms`,\n err,\n );\n throw err;\n }\n });\n}\n\n/** Combines multiple AbortSignals into one that aborts when any of them fire. */\nfunction anySignal(signals: AbortSignal[]): {\n signal: AbortSignal;\n cleanup: () => void;\n} {\n const controller = new AbortController();\n const onAbort = () => controller.abort();\n const attached: AbortSignal[] = [];\n for (const s of signals) {\n if (s.aborted) {\n controller.abort();\n break;\n }\n s.addEventListener(\"abort\", onAbort, { once: true });\n attached.push(s);\n }\n return {\n signal: controller.signal,\n cleanup: () =>\n attached.forEach((s) => {\n s.removeEventListener(\"abort\", onAbort);\n }),\n };\n}\n"]}
|