@zap-studio/fetch 0.4.7 → 0.5.0
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/CHANGELOG.md +38 -0
- package/LICENSE +1 -1
- package/README.md +276 -32
- package/dist/constants.d.mts +8 -1
- package/dist/constants.d.mts.map +1 -1
- package/dist/constants.mjs +9 -2
- package/dist/constants.mjs.map +1 -1
- package/dist/errors.d.mts +29 -0
- package/dist/errors.d.mts.map +1 -1
- package/dist/errors.mjs +46 -2
- package/dist/errors.mjs.map +1 -0
- package/dist/headers.d.mts +26 -0
- package/dist/headers.d.mts.map +1 -0
- package/dist/headers.mjs +35 -0
- package/dist/headers.mjs.map +1 -0
- package/dist/index.d.mts +28 -10
- package/dist/index.d.mts.map +1 -1
- package/dist/index.mjs +23 -8
- package/dist/index.mjs.map +1 -1
- package/dist/internal.d.mts +33 -0
- package/dist/internal.d.mts.map +1 -0
- package/dist/internal.mjs +73 -0
- package/dist/internal.mjs.map +1 -0
- package/dist/methods.d.mts +23 -0
- package/dist/methods.d.mts.map +1 -0
- package/dist/methods.mjs +53 -0
- package/dist/methods.mjs.map +1 -0
- package/dist/request.d.mts +31 -0
- package/dist/request.d.mts.map +1 -0
- package/dist/request.mjs +39 -0
- package/dist/request.mjs.map +1 -0
- package/dist/types.d.mts +73 -47
- package/dist/types.d.mts.map +1 -1
- package/dist/types.mjs +1 -1
- package/dist/url.d.mts +27 -0
- package/dist/url.d.mts.map +1 -0
- package/dist/url.mjs +56 -0
- package/dist/url.mjs.map +1 -0
- package/package.json +46 -53
- package/bin/intent.js +0 -4
- package/dist/errors-DQfwnwmz.mjs +0 -18
- package/dist/errors-DQfwnwmz.mjs.map +0 -1
- package/dist/utils.d.mts +0 -33
- package/dist/utils.d.mts.map +0 -1
- package/dist/utils.mjs +0 -180
- package/dist/utils.mjs.map +0 -1
- package/skills/zap-fetch-typed-http/SKILL.md +0 -152
package/dist/utils.mjs
DELETED
|
@@ -1,180 +0,0 @@
|
|
|
1
|
-
import { t as FetchError } from "./errors-DQfwnwmz.mjs";
|
|
2
|
-
import { isStandardSchema, standardValidate } from "@zap-studio/validation";
|
|
3
|
-
|
|
4
|
-
//#region src/utils.ts
|
|
5
|
-
/**
|
|
6
|
-
* Merges two HeadersInit objects, with the second one taking precedence
|
|
7
|
-
*
|
|
8
|
-
* @example
|
|
9
|
-
* const baseHeaders = { "Authorization": "Bearer token", "Content-Type": "application/json" };
|
|
10
|
-
* const overrideHeaders = { "Content-Type": "application/xml", "X-Custom-Header": "value" };
|
|
11
|
-
*
|
|
12
|
-
* const merged = mergeHeaders(baseHeaders, overrideHeaders);
|
|
13
|
-
*
|
|
14
|
-
* // Resulting headers:
|
|
15
|
-
* // {
|
|
16
|
-
* // "Authorization": "Bearer token",
|
|
17
|
-
* // "Content-Type": "application/xml",
|
|
18
|
-
* // "X-Custom-Header": "value"
|
|
19
|
-
* // }
|
|
20
|
-
*/
|
|
21
|
-
function mergeHeaders(base, override) {
|
|
22
|
-
if (!(base || override)) return;
|
|
23
|
-
const merged = new Headers(base);
|
|
24
|
-
if (override) {
|
|
25
|
-
const overrideHeaders = new Headers(override);
|
|
26
|
-
for (const [key, value] of overrideHeaders.entries()) merged.set(key, value);
|
|
27
|
-
}
|
|
28
|
-
return merged;
|
|
29
|
-
}
|
|
30
|
-
/**
|
|
31
|
-
* Removes trailing slashes from a string
|
|
32
|
-
*/
|
|
33
|
-
function trimTrailingSlashes(str) {
|
|
34
|
-
let end = str.length;
|
|
35
|
-
while (end > 0 && str[end - 1] === "/") end -= 1;
|
|
36
|
-
return str.slice(0, end);
|
|
37
|
-
}
|
|
38
|
-
/**
|
|
39
|
-
* Removes leading slashes from a string
|
|
40
|
-
*/
|
|
41
|
-
function trimLeadingSlashes(str) {
|
|
42
|
-
let start = 0;
|
|
43
|
-
while (start < str.length && str[start] === "/") start += 1;
|
|
44
|
-
return str.slice(start);
|
|
45
|
-
}
|
|
46
|
-
const ABSOLUTE_URL_PATTERN = /^(?:https?:)?\/\//i;
|
|
47
|
-
/**
|
|
48
|
-
* Checks if a URL is absolute (starts with http://, https://, or //)
|
|
49
|
-
*/
|
|
50
|
-
function isAbsoluteURL(url) {
|
|
51
|
-
return ABSOLUTE_URL_PATTERN.test(url);
|
|
52
|
-
}
|
|
53
|
-
/**
|
|
54
|
-
* Normalizes search parameters into a URLSearchParams object.
|
|
55
|
-
*/
|
|
56
|
-
function normalizeSearchParams(input) {
|
|
57
|
-
if (input === void 0 || input === null) return new URLSearchParams();
|
|
58
|
-
if (input instanceof URLSearchParams) return new URLSearchParams(input);
|
|
59
|
-
if (typeof input === "string") return new URLSearchParams(input);
|
|
60
|
-
if (Array.isArray(input)) return new URLSearchParams(input);
|
|
61
|
-
const params = new URLSearchParams();
|
|
62
|
-
for (const [k, v] of Object.entries(input)) params.set(k, v);
|
|
63
|
-
return params;
|
|
64
|
-
}
|
|
65
|
-
/**
|
|
66
|
-
* Parses a URL string into its path, query, and hash components.
|
|
67
|
-
* Handles both absolute URLs (using URL constructor) and relative paths.
|
|
68
|
-
*/
|
|
69
|
-
function parseUrlComponents(url) {
|
|
70
|
-
if (isAbsoluteURL(url)) try {
|
|
71
|
-
const parsed = new URL(url);
|
|
72
|
-
const pathOnly = `${parsed.origin}${parsed.pathname}`;
|
|
73
|
-
const existingQuery = parsed.search.startsWith("?") ? parsed.search.slice(1) : parsed.search;
|
|
74
|
-
let hash$1 = parsed.hash;
|
|
75
|
-
if (hash$1 === "" && url.endsWith("#")) hash$1 = "#";
|
|
76
|
-
return {
|
|
77
|
-
pathOnly,
|
|
78
|
-
existingQuery,
|
|
79
|
-
hash: hash$1
|
|
80
|
-
};
|
|
81
|
-
} catch {}
|
|
82
|
-
let hash = "";
|
|
83
|
-
let urlWithoutHash = url;
|
|
84
|
-
const hashIndex = url.indexOf("#");
|
|
85
|
-
if (hashIndex !== -1) {
|
|
86
|
-
hash = url.slice(hashIndex);
|
|
87
|
-
urlWithoutHash = url.slice(0, hashIndex);
|
|
88
|
-
}
|
|
89
|
-
const queryIndex = urlWithoutHash.indexOf("?");
|
|
90
|
-
if (queryIndex === -1) return {
|
|
91
|
-
pathOnly: urlWithoutHash,
|
|
92
|
-
existingQuery: "",
|
|
93
|
-
hash
|
|
94
|
-
};
|
|
95
|
-
return {
|
|
96
|
-
pathOnly: urlWithoutHash.slice(0, queryIndex),
|
|
97
|
-
existingQuery: urlWithoutHash.slice(queryIndex + 1),
|
|
98
|
-
hash
|
|
99
|
-
};
|
|
100
|
-
}
|
|
101
|
-
/**
|
|
102
|
-
* Builds a URL with merged search parameters from factory defaults,
|
|
103
|
-
* request options, and existing query parameters.
|
|
104
|
-
*
|
|
105
|
-
* This function takes a base URL, factory search parameters,
|
|
106
|
-
* and request search parameters, and combines them into a single URL.
|
|
107
|
-
*
|
|
108
|
-
* Priority (highest to lowest):
|
|
109
|
-
* 1. Request search parameters (highest priority, overwrites all others)
|
|
110
|
-
* 2. Existing query parameters from the URL (overwrites factory defaults)
|
|
111
|
-
* 3. Factory search parameters (lowest priority, overwritten by all others)
|
|
112
|
-
*
|
|
113
|
-
* If no search parameters are provided, the URL will not have a query string.
|
|
114
|
-
* Any trailing hash/fragment is preserved.
|
|
115
|
-
*/
|
|
116
|
-
function buildUrlWithMergedSearchParams(url, factorySearch, requestSearch) {
|
|
117
|
-
const { pathOnly, existingQuery, hash } = parseUrlComponents(url);
|
|
118
|
-
if (!(factorySearch ?? requestSearch ?? existingQuery)) return url;
|
|
119
|
-
const mergedParams = new URLSearchParams();
|
|
120
|
-
const resourceParams = new URLSearchParams(existingQuery);
|
|
121
|
-
const factoryParams = normalizeSearchParams(factorySearch);
|
|
122
|
-
const reqParams = normalizeSearchParams(requestSearch);
|
|
123
|
-
for (const [k, v] of factoryParams.entries()) mergedParams.set(k, v);
|
|
124
|
-
for (const [k, v] of resourceParams.entries()) mergedParams.set(k, v);
|
|
125
|
-
for (const [k, v] of reqParams.entries()) mergedParams.set(k, v);
|
|
126
|
-
const queryString = mergedParams.toString();
|
|
127
|
-
if (queryString) return `${pathOnly}?${queryString}${hash}`;
|
|
128
|
-
return `${pathOnly}${hash}`;
|
|
129
|
-
}
|
|
130
|
-
/**
|
|
131
|
-
* Internal fetch implementation used by both $fetch and createFetch
|
|
132
|
-
*/
|
|
133
|
-
async function fetchInternal(resource, schema, options, defaults) {
|
|
134
|
-
const { throwOnValidationError = defaults.throwOnValidationError, throwOnFetchError = defaults.throwOnFetchError, headers: requestHeaders, searchParams: requestSearchParams, ...rest } = options || {};
|
|
135
|
-
const mergedHeaders = mergeHeaders(defaults.headers, requestHeaders);
|
|
136
|
-
const init = {
|
|
137
|
-
...rest,
|
|
138
|
-
headers: mergedHeaders
|
|
139
|
-
};
|
|
140
|
-
const isBodyInit = typeof init.body === "string" || init.body instanceof FormData || init.body instanceof URLSearchParams || init.body instanceof Blob || init.body instanceof ArrayBuffer || ArrayBuffer.isView(init.body) || init.body instanceof ReadableStream;
|
|
141
|
-
if (init.body != null && !isBodyInit) {
|
|
142
|
-
init.body = JSON.stringify(init.body);
|
|
143
|
-
const existingHeaders = new Headers(init.headers);
|
|
144
|
-
if (!existingHeaders.has("Content-Type")) existingHeaders.set("Content-Type", "application/json");
|
|
145
|
-
init.headers = existingHeaders;
|
|
146
|
-
}
|
|
147
|
-
let url;
|
|
148
|
-
if (isAbsoluteURL(resource)) url = resource;
|
|
149
|
-
else {
|
|
150
|
-
const base = trimTrailingSlashes(defaults.baseURL);
|
|
151
|
-
const path = trimLeadingSlashes(resource);
|
|
152
|
-
url = base ? `${base}/${path}` : resource;
|
|
153
|
-
}
|
|
154
|
-
url = buildUrlWithMergedSearchParams(url, defaults.searchParams, requestSearchParams);
|
|
155
|
-
const response = await fetch(url, init);
|
|
156
|
-
if (throwOnFetchError && !response.ok) throw new FetchError(`HTTP ${response.status}: ${response.statusText}`, response);
|
|
157
|
-
if (schema) {
|
|
158
|
-
const raw = await response.json();
|
|
159
|
-
if (throwOnValidationError) return standardValidate(schema, raw, { throwOnError: true });
|
|
160
|
-
return standardValidate(schema, raw, { throwOnError: false });
|
|
161
|
-
}
|
|
162
|
-
return response;
|
|
163
|
-
}
|
|
164
|
-
/**
|
|
165
|
-
* Creates an HTTP method helper bound to a fetch function
|
|
166
|
-
*/
|
|
167
|
-
function createMethod(fetchFn, method) {
|
|
168
|
-
function methodFetch(resource, schemaOrOptions, optionsOrUndefined) {
|
|
169
|
-
const [schema, options] = isStandardSchema(schemaOrOptions) ? [schemaOrOptions, optionsOrUndefined] : [void 0, schemaOrOptions];
|
|
170
|
-
return fetchFn(resource, schema, {
|
|
171
|
-
...options,
|
|
172
|
-
method
|
|
173
|
-
});
|
|
174
|
-
}
|
|
175
|
-
return methodFetch;
|
|
176
|
-
}
|
|
177
|
-
|
|
178
|
-
//#endregion
|
|
179
|
-
export { createMethod, fetchInternal, mergeHeaders };
|
|
180
|
-
//# sourceMappingURL=utils.mjs.map
|
package/dist/utils.mjs.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"utils.mjs","names":["hash","url: string"],"sources":["../src/utils.ts"],"sourcesContent":["import type { StandardSchemaV1 } from \"@standard-schema/spec\";\nimport { isStandardSchema, standardValidate } from \"@zap-studio/validation\";\nimport { FetchError } from \"./errors\";\nimport type {\n $Fetch,\n ExtendedRequestInit,\n FetchDefaults,\n SearchParams,\n} from \"./types\";\n\n/**\n * Merges two HeadersInit objects, with the second one taking precedence\n *\n * @example\n * const baseHeaders = { \"Authorization\": \"Bearer token\", \"Content-Type\": \"application/json\" };\n * const overrideHeaders = { \"Content-Type\": \"application/xml\", \"X-Custom-Header\": \"value\" };\n *\n * const merged = mergeHeaders(baseHeaders, overrideHeaders);\n *\n * // Resulting headers:\n * // {\n * // \"Authorization\": \"Bearer token\",\n * // \"Content-Type\": \"application/xml\",\n * // \"X-Custom-Header\": \"value\"\n * // }\n */\nexport function mergeHeaders(\n base: HeadersInit | undefined,\n override: HeadersInit | undefined\n): Headers | undefined {\n if (!(base || override)) {\n return;\n }\n\n const merged = new Headers(base);\n if (override) {\n const overrideHeaders = new Headers(override);\n for (const [key, value] of overrideHeaders.entries()) {\n merged.set(key, value);\n }\n }\n return merged;\n}\n\n/**\n * Removes trailing slashes from a string\n */\nfunction trimTrailingSlashes(str: string): string {\n let end = str.length;\n while (end > 0 && str[end - 1] === \"/\") {\n end -= 1;\n }\n return str.slice(0, end);\n}\n\n/**\n * Removes leading slashes from a string\n */\nfunction trimLeadingSlashes(str: string): string {\n let start = 0;\n while (start < str.length && str[start] === \"/\") {\n start += 1;\n }\n return str.slice(start);\n}\n\nconst ABSOLUTE_URL_PATTERN = /^(?:https?:)?\\/\\//i;\n\n/**\n * Checks if a URL is absolute (starts with http://, https://, or //)\n */\nfunction isAbsoluteURL(url: string): boolean {\n return ABSOLUTE_URL_PATTERN.test(url);\n}\n\n/**\n * Normalizes search parameters into a URLSearchParams object.\n */\nfunction normalizeSearchParams(\n input: SearchParams | undefined\n): URLSearchParams {\n if (input === undefined || input === null) {\n return new URLSearchParams();\n }\n\n if (input instanceof URLSearchParams) {\n return new URLSearchParams(input);\n }\n\n if (typeof input === \"string\") {\n return new URLSearchParams(input);\n }\n\n if (Array.isArray(input)) {\n return new URLSearchParams(input);\n }\n\n const params = new URLSearchParams();\n for (const [k, v] of Object.entries(input)) {\n params.set(k, v);\n }\n\n return params;\n}\n\n/**\n * Parses a URL string into its path, query, and hash components.\n * Handles both absolute URLs (using URL constructor) and relative paths.\n */\nfunction parseUrlComponents(url: string): {\n pathOnly: string;\n existingQuery: string;\n hash: string;\n} {\n // Try parsing as absolute URL first\n if (isAbsoluteURL(url)) {\n try {\n const parsed = new URL(url);\n const pathOnly = `${parsed.origin}${parsed.pathname}`;\n // parsed.search includes the leading \"?\", so strip it\n const existingQuery = parsed.search.startsWith(\"?\")\n ? parsed.search.slice(1)\n : parsed.search;\n // URL constructor normalizes away empty hash, if original URL had # at end, preserve it\n let hash = parsed.hash;\n if (hash === \"\" && url.endsWith(\"#\")) {\n hash = \"#\";\n }\n return { pathOnly, existingQuery, hash };\n } catch {\n // Fall through to manual parsing if URL constructor fails\n }\n }\n\n // Manual parsing for relative URLs or if URL constructor failed\n let hash = \"\";\n let urlWithoutHash = url;\n const hashIndex = url.indexOf(\"#\");\n if (hashIndex !== -1) {\n hash = url.slice(hashIndex);\n urlWithoutHash = url.slice(0, hashIndex);\n }\n\n // Find the first \"?\" to split path and query\n const queryIndex = urlWithoutHash.indexOf(\"?\");\n if (queryIndex === -1) {\n return { pathOnly: urlWithoutHash, existingQuery: \"\", hash };\n }\n\n const pathOnly = urlWithoutHash.slice(0, queryIndex);\n const existingQuery = urlWithoutHash.slice(queryIndex + 1);\n return { pathOnly, existingQuery, hash };\n}\n\n/**\n * Builds a URL with merged search parameters from factory defaults,\n * request options, and existing query parameters.\n *\n * This function takes a base URL, factory search parameters,\n * and request search parameters, and combines them into a single URL.\n *\n * Priority (highest to lowest):\n * 1. Request search parameters (highest priority, overwrites all others)\n * 2. Existing query parameters from the URL (overwrites factory defaults)\n * 3. Factory search parameters (lowest priority, overwritten by all others)\n *\n * If no search parameters are provided, the URL will not have a query string.\n * Any trailing hash/fragment is preserved.\n */\nfunction buildUrlWithMergedSearchParams(\n url: string,\n factorySearch: FetchDefaults[\"searchParams\"] | undefined,\n requestSearch: ExtendedRequestInit[\"searchParams\"] | undefined\n): string {\n const { pathOnly, existingQuery, hash } = parseUrlComponents(url);\n\n // Early return if no search params to merge\n const hasSearchParams = factorySearch ?? requestSearch ?? existingQuery;\n if (!hasSearchParams) {\n return url;\n }\n\n const mergedParams = new URLSearchParams();\n\n const resourceParams = new URLSearchParams(existingQuery);\n const factoryParams = normalizeSearchParams(factorySearch);\n const reqParams = normalizeSearchParams(requestSearch);\n\n for (const [k, v] of factoryParams.entries()) {\n mergedParams.set(k, v);\n }\n\n for (const [k, v] of resourceParams.entries()) {\n mergedParams.set(k, v);\n }\n\n for (const [k, v] of reqParams.entries()) {\n mergedParams.set(k, v);\n }\n\n const queryString = mergedParams.toString();\n if (queryString) {\n return `${pathOnly}?${queryString}${hash}`;\n }\n\n return `${pathOnly}${hash}`;\n}\n\n/**\n * Internal fetch implementation used by both $fetch and createFetch\n */\nexport async function fetchInternal(\n resource: string,\n schema: StandardSchemaV1 | undefined,\n options: ExtendedRequestInit | undefined,\n defaults: FetchDefaults\n): Promise<unknown> {\n const {\n throwOnValidationError = defaults.throwOnValidationError,\n throwOnFetchError = defaults.throwOnFetchError,\n headers: requestHeaders,\n searchParams: requestSearchParams,\n ...rest\n } = options || {};\n\n const mergedHeaders = mergeHeaders(defaults.headers, requestHeaders);\n const init = { ...rest, headers: mergedHeaders } as RequestInit;\n\n const isBodyInit =\n typeof init.body === \"string\" ||\n init.body instanceof FormData ||\n init.body instanceof URLSearchParams ||\n init.body instanceof Blob ||\n init.body instanceof ArrayBuffer ||\n ArrayBuffer.isView(init.body) ||\n init.body instanceof ReadableStream;\n\n // Auto-stringify plain JSON bodies and set default Content-Type\n if (init.body != null && !isBodyInit) {\n init.body = JSON.stringify(init.body);\n\n const existingHeaders = new Headers(init.headers);\n if (!existingHeaders.has(\"Content-Type\")) {\n existingHeaders.set(\"Content-Type\", \"application/json\");\n }\n\n init.headers = existingHeaders;\n }\n\n // For absolute URLs, ignore baseURL entirely\n let url: string;\n if (isAbsoluteURL(resource)) {\n url = resource;\n } else {\n // Normalize URL by avoiding double slashes between baseURL and resource\n const base = trimTrailingSlashes(defaults.baseURL);\n const path = trimLeadingSlashes(resource);\n url = base ? `${base}/${path}` : resource;\n }\n\n // Merge query/search params\n url = buildUrlWithMergedSearchParams(\n url,\n defaults.searchParams,\n requestSearchParams\n );\n\n const response = await fetch(url, init);\n\n if (throwOnFetchError && !response.ok) {\n throw new FetchError(\n `HTTP ${response.status}: ${response.statusText}`,\n response\n );\n }\n\n // For json with schema, validate\n if (schema) {\n const raw = await response.json();\n if (throwOnValidationError) {\n return standardValidate(schema, raw, { throwOnError: true });\n }\n return standardValidate(schema, raw, { throwOnError: false });\n }\n\n // No validation, return raw response data\n return response;\n}\n\n/**\n * Creates an HTTP method helper bound to a fetch function\n */\nexport function createMethod<TFetch extends $Fetch>(\n fetchFn: TFetch,\n method: string\n): $Fetch {\n function methodFetch<TSchema extends StandardSchemaV1>(\n resource: string,\n schema: TSchema,\n options: Omit<ExtendedRequestInit<false>, \"method\">\n ): Promise<StandardSchemaV1.Result<StandardSchemaV1.InferOutput<TSchema>>>;\n\n function methodFetch<TSchema extends StandardSchemaV1>(\n resource: string,\n schema: TSchema,\n options?: Omit<ExtendedRequestInit<true | undefined>, \"method\">\n ): Promise<StandardSchemaV1.InferOutput<TSchema>>;\n\n function methodFetch(\n resource: string,\n options?: Omit<ExtendedRequestInit, \"method\">\n ): Promise<Response>;\n\n function methodFetch(\n resource: string,\n schemaOrOptions?: StandardSchemaV1 | Omit<ExtendedRequestInit, \"method\">,\n optionsOrUndefined?: Omit<ExtendedRequestInit, \"method\">\n ): Promise<unknown> {\n const [schema, options] = isStandardSchema(schemaOrOptions)\n ? [schemaOrOptions, optionsOrUndefined]\n : [undefined, schemaOrOptions];\n\n return (fetchFn as (...args: unknown[]) => Promise<unknown>)(\n resource,\n schema,\n { ...options, method }\n );\n }\n\n return methodFetch;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AA0BA,SAAgB,aACd,MACA,UACqB;AACrB,KAAI,EAAE,QAAQ,UACZ;CAGF,MAAM,SAAS,IAAI,QAAQ,KAAK;AAChC,KAAI,UAAU;EACZ,MAAM,kBAAkB,IAAI,QAAQ,SAAS;AAC7C,OAAK,MAAM,CAAC,KAAK,UAAU,gBAAgB,SAAS,CAClD,QAAO,IAAI,KAAK,MAAM;;AAG1B,QAAO;;;;;AAMT,SAAS,oBAAoB,KAAqB;CAChD,IAAI,MAAM,IAAI;AACd,QAAO,MAAM,KAAK,IAAI,MAAM,OAAO,IACjC,QAAO;AAET,QAAO,IAAI,MAAM,GAAG,IAAI;;;;;AAM1B,SAAS,mBAAmB,KAAqB;CAC/C,IAAI,QAAQ;AACZ,QAAO,QAAQ,IAAI,UAAU,IAAI,WAAW,IAC1C,UAAS;AAEX,QAAO,IAAI,MAAM,MAAM;;AAGzB,MAAM,uBAAuB;;;;AAK7B,SAAS,cAAc,KAAsB;AAC3C,QAAO,qBAAqB,KAAK,IAAI;;;;;AAMvC,SAAS,sBACP,OACiB;AACjB,KAAI,UAAU,UAAa,UAAU,KACnC,QAAO,IAAI,iBAAiB;AAG9B,KAAI,iBAAiB,gBACnB,QAAO,IAAI,gBAAgB,MAAM;AAGnC,KAAI,OAAO,UAAU,SACnB,QAAO,IAAI,gBAAgB,MAAM;AAGnC,KAAI,MAAM,QAAQ,MAAM,CACtB,QAAO,IAAI,gBAAgB,MAAM;CAGnC,MAAM,SAAS,IAAI,iBAAiB;AACpC,MAAK,MAAM,CAAC,GAAG,MAAM,OAAO,QAAQ,MAAM,CACxC,QAAO,IAAI,GAAG,EAAE;AAGlB,QAAO;;;;;;AAOT,SAAS,mBAAmB,KAI1B;AAEA,KAAI,cAAc,IAAI,CACpB,KAAI;EACF,MAAM,SAAS,IAAI,IAAI,IAAI;EAC3B,MAAM,WAAW,GAAG,OAAO,SAAS,OAAO;EAE3C,MAAM,gBAAgB,OAAO,OAAO,WAAW,IAAI,GAC/C,OAAO,OAAO,MAAM,EAAE,GACtB,OAAO;EAEX,IAAIA,SAAO,OAAO;AAClB,MAAIA,WAAS,MAAM,IAAI,SAAS,IAAI,CAClC,UAAO;AAET,SAAO;GAAE;GAAU;GAAe;GAAM;SAClC;CAMV,IAAI,OAAO;CACX,IAAI,iBAAiB;CACrB,MAAM,YAAY,IAAI,QAAQ,IAAI;AAClC,KAAI,cAAc,IAAI;AACpB,SAAO,IAAI,MAAM,UAAU;AAC3B,mBAAiB,IAAI,MAAM,GAAG,UAAU;;CAI1C,MAAM,aAAa,eAAe,QAAQ,IAAI;AAC9C,KAAI,eAAe,GACjB,QAAO;EAAE,UAAU;EAAgB,eAAe;EAAI;EAAM;AAK9D,QAAO;EAAE,UAFQ,eAAe,MAAM,GAAG,WAAW;EAEjC,eADG,eAAe,MAAM,aAAa,EAAE;EACxB;EAAM;;;;;;;;;;;;;;;;;AAkB1C,SAAS,+BACP,KACA,eACA,eACQ;CACR,MAAM,EAAE,UAAU,eAAe,SAAS,mBAAmB,IAAI;AAIjE,KAAI,EADoB,iBAAiB,iBAAiB,eAExD,QAAO;CAGT,MAAM,eAAe,IAAI,iBAAiB;CAE1C,MAAM,iBAAiB,IAAI,gBAAgB,cAAc;CACzD,MAAM,gBAAgB,sBAAsB,cAAc;CAC1D,MAAM,YAAY,sBAAsB,cAAc;AAEtD,MAAK,MAAM,CAAC,GAAG,MAAM,cAAc,SAAS,CAC1C,cAAa,IAAI,GAAG,EAAE;AAGxB,MAAK,MAAM,CAAC,GAAG,MAAM,eAAe,SAAS,CAC3C,cAAa,IAAI,GAAG,EAAE;AAGxB,MAAK,MAAM,CAAC,GAAG,MAAM,UAAU,SAAS,CACtC,cAAa,IAAI,GAAG,EAAE;CAGxB,MAAM,cAAc,aAAa,UAAU;AAC3C,KAAI,YACF,QAAO,GAAG,SAAS,GAAG,cAAc;AAGtC,QAAO,GAAG,WAAW;;;;;AAMvB,eAAsB,cACpB,UACA,QACA,SACA,UACkB;CAClB,MAAM,EACJ,yBAAyB,SAAS,wBAClC,oBAAoB,SAAS,mBAC7B,SAAS,gBACT,cAAc,qBACd,GAAG,SACD,WAAW,EAAE;CAEjB,MAAM,gBAAgB,aAAa,SAAS,SAAS,eAAe;CACpE,MAAM,OAAO;EAAE,GAAG;EAAM,SAAS;EAAe;CAEhD,MAAM,aACJ,OAAO,KAAK,SAAS,YACrB,KAAK,gBAAgB,YACrB,KAAK,gBAAgB,mBACrB,KAAK,gBAAgB,QACrB,KAAK,gBAAgB,eACrB,YAAY,OAAO,KAAK,KAAK,IAC7B,KAAK,gBAAgB;AAGvB,KAAI,KAAK,QAAQ,QAAQ,CAAC,YAAY;AACpC,OAAK,OAAO,KAAK,UAAU,KAAK,KAAK;EAErC,MAAM,kBAAkB,IAAI,QAAQ,KAAK,QAAQ;AACjD,MAAI,CAAC,gBAAgB,IAAI,eAAe,CACtC,iBAAgB,IAAI,gBAAgB,mBAAmB;AAGzD,OAAK,UAAU;;CAIjB,IAAIC;AACJ,KAAI,cAAc,SAAS,CACzB,OAAM;MACD;EAEL,MAAM,OAAO,oBAAoB,SAAS,QAAQ;EAClD,MAAM,OAAO,mBAAmB,SAAS;AACzC,QAAM,OAAO,GAAG,KAAK,GAAG,SAAS;;AAInC,OAAM,+BACJ,KACA,SAAS,cACT,oBACD;CAED,MAAM,WAAW,MAAM,MAAM,KAAK,KAAK;AAEvC,KAAI,qBAAqB,CAAC,SAAS,GACjC,OAAM,IAAI,WACR,QAAQ,SAAS,OAAO,IAAI,SAAS,cACrC,SACD;AAIH,KAAI,QAAQ;EACV,MAAM,MAAM,MAAM,SAAS,MAAM;AACjC,MAAI,uBACF,QAAO,iBAAiB,QAAQ,KAAK,EAAE,cAAc,MAAM,CAAC;AAE9D,SAAO,iBAAiB,QAAQ,KAAK,EAAE,cAAc,OAAO,CAAC;;AAI/D,QAAO;;;;;AAMT,SAAgB,aACd,SACA,QACQ;CAkBR,SAAS,YACP,UACA,iBACA,oBACkB;EAClB,MAAM,CAAC,QAAQ,WAAW,iBAAiB,gBAAgB,GACvD,CAAC,iBAAiB,mBAAmB,GACrC,CAAC,QAAW,gBAAgB;AAEhC,SAAQ,QACN,UACA,QACA;GAAE,GAAG;GAAS;GAAQ,CACvB;;AAGH,QAAO"}
|
|
@@ -1,152 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: zap-fetch-typed-http
|
|
3
|
-
description: >
|
|
4
|
-
Implement type-safe HTTP requests with @zap-studio/fetch using $fetch,
|
|
5
|
-
api.get/post/put/patch/delete, createFetch defaults, searchParams merging,
|
|
6
|
-
and throwOnFetchError/throwOnValidationError return modes.
|
|
7
|
-
type: core
|
|
8
|
-
library: '@zap-studio/fetch'
|
|
9
|
-
library_version: '0.4.6'
|
|
10
|
-
sources:
|
|
11
|
-
- 'zap-studio/monorepo:packages/fetch/README.md'
|
|
12
|
-
- 'zap-studio/monorepo:packages/fetch/src/index.ts'
|
|
13
|
-
- 'zap-studio/monorepo:packages/fetch/src/utils.ts'
|
|
14
|
-
---
|
|
15
|
-
|
|
16
|
-
# @zap-studio/fetch — Typed HTTP Client
|
|
17
|
-
|
|
18
|
-
## Setup
|
|
19
|
-
|
|
20
|
-
```ts
|
|
21
|
-
import { createFetch } from '@zap-studio/fetch';
|
|
22
|
-
import { z } from 'zod';
|
|
23
|
-
|
|
24
|
-
const UserSchema = z.object({
|
|
25
|
-
id: z.number(),
|
|
26
|
-
name: z.string(),
|
|
27
|
-
email: z.string().email(),
|
|
28
|
-
});
|
|
29
|
-
|
|
30
|
-
const { api } = createFetch({
|
|
31
|
-
baseURL: 'https://api.example.com',
|
|
32
|
-
headers: { Authorization: 'Bearer token' },
|
|
33
|
-
searchParams: { locale: 'en' },
|
|
34
|
-
});
|
|
35
|
-
|
|
36
|
-
const user = await api.get('/users/1', UserSchema);
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
## Core Patterns
|
|
40
|
-
|
|
41
|
-
### Return raw `Response` when no schema is provided
|
|
42
|
-
|
|
43
|
-
```ts
|
|
44
|
-
import { $fetch } from '@zap-studio/fetch';
|
|
45
|
-
|
|
46
|
-
const response = await $fetch('https://api.example.com/health');
|
|
47
|
-
const data = await response.json();
|
|
48
|
-
```
|
|
49
|
-
|
|
50
|
-
### Request validated payload via schema
|
|
51
|
-
|
|
52
|
-
```ts
|
|
53
|
-
import { api } from '@zap-studio/fetch';
|
|
54
|
-
import { z } from 'zod';
|
|
55
|
-
|
|
56
|
-
const PostSchema = z.object({ id: z.number(), title: z.string() });
|
|
57
|
-
const post = await api.get('https://api.example.com/posts/1', PostSchema);
|
|
58
|
-
```
|
|
59
|
-
|
|
60
|
-
### Handle non-throw validation mode explicitly
|
|
61
|
-
|
|
62
|
-
```ts
|
|
63
|
-
import { $fetch } from '@zap-studio/fetch';
|
|
64
|
-
import { z } from 'zod';
|
|
65
|
-
|
|
66
|
-
const UserSchema = z.object({ id: z.number() });
|
|
67
|
-
|
|
68
|
-
const result = await $fetch('/users/1', UserSchema, {
|
|
69
|
-
throwOnValidationError: false,
|
|
70
|
-
});
|
|
71
|
-
|
|
72
|
-
if (result.issues) {
|
|
73
|
-
throw new Error('Invalid response payload');
|
|
74
|
-
}
|
|
75
|
-
|
|
76
|
-
console.log(result.value.id);
|
|
77
|
-
```
|
|
78
|
-
|
|
79
|
-
## Common Mistakes
|
|
80
|
-
|
|
81
|
-
### HIGH Assuming `api.get` returns raw `Response`
|
|
82
|
-
|
|
83
|
-
Wrong:
|
|
84
|
-
|
|
85
|
-
```ts
|
|
86
|
-
const res = await api.get('/users/1', { headers: { Authorization: token } });
|
|
87
|
-
const body = await res.json();
|
|
88
|
-
```
|
|
89
|
-
|
|
90
|
-
Correct:
|
|
91
|
-
|
|
92
|
-
```ts
|
|
93
|
-
const user = await api.get('/users/1', UserSchema, {
|
|
94
|
-
headers: { Authorization: token },
|
|
95
|
-
});
|
|
96
|
-
console.log(user.id);
|
|
97
|
-
```
|
|
98
|
-
|
|
99
|
-
`api.*` overloads are schema-based helpers; they return validated payloads, not a `Response`.
|
|
100
|
-
|
|
101
|
-
Source: zap-studio/monorepo:packages/fetch/src/index.ts
|
|
102
|
-
|
|
103
|
-
### HIGH Ignoring validation result branch
|
|
104
|
-
|
|
105
|
-
Wrong:
|
|
106
|
-
|
|
107
|
-
```ts
|
|
108
|
-
const user = await $fetch('/users/1', UserSchema, {
|
|
109
|
-
throwOnValidationError: false,
|
|
110
|
-
});
|
|
111
|
-
console.log(user.id);
|
|
112
|
-
```
|
|
113
|
-
|
|
114
|
-
Correct:
|
|
115
|
-
|
|
116
|
-
```ts
|
|
117
|
-
const result = await $fetch('/users/1', UserSchema, {
|
|
118
|
-
throwOnValidationError: false,
|
|
119
|
-
});
|
|
120
|
-
|
|
121
|
-
if (result.issues) throw new Error('Invalid payload');
|
|
122
|
-
console.log(result.value.id);
|
|
123
|
-
```
|
|
124
|
-
|
|
125
|
-
With `throwOnValidationError: false`, return type is `{ value?, issues? }` and must be narrowed.
|
|
126
|
-
|
|
127
|
-
Source: zap-studio/monorepo:packages/fetch/src/index.ts
|
|
128
|
-
|
|
129
|
-
### MEDIUM Relying on implicit body semantics for non-JSON inputs
|
|
130
|
-
|
|
131
|
-
Wrong:
|
|
132
|
-
|
|
133
|
-
```ts
|
|
134
|
-
await api.post('/users', UserSchema, {
|
|
135
|
-
body: new URLSearchParams({ name: 'Ada' }),
|
|
136
|
-
});
|
|
137
|
-
```
|
|
138
|
-
|
|
139
|
-
Correct:
|
|
140
|
-
|
|
141
|
-
```ts
|
|
142
|
-
await api.post('/users', UserSchema, {
|
|
143
|
-
body: { name: 'Ada' },
|
|
144
|
-
headers: { 'Content-Type': 'application/json' },
|
|
145
|
-
});
|
|
146
|
-
```
|
|
147
|
-
|
|
148
|
-
Only plain object bodies are auto-JSON-stringified; other `BodyInit` forms keep their native encoding behavior.
|
|
149
|
-
|
|
150
|
-
Source: zap-studio/monorepo:packages/fetch/src/utils.ts
|
|
151
|
-
|
|
152
|
-
See also: zap-validation-standard-schema/SKILL.md — response validation result handling.
|