@zap-studio/fetch 0.5.4 → 0.5.6

package/dist/types.d.mts

@@ -1,169 +0,0 @@
-import { StandardSchemaV1 } from "@zap-studio/validation";
-
-//#region src/types.d.ts
-/**
-* Accepted `fetch` input type (`string`, `URL`, or `Request`).
-*/
-type FetchInput = Parameters<typeof fetch>[0];
-type URLSearchParamsInput = ConstructorParameters<typeof URLSearchParams>[0];
-type RequestBodyInit = RequestInit & {
-  json?: never;
-};
-type JsonBodyInit = Omit<RequestInit, "body"> & {
-  /**
-  * JSON body convenience. When provided, this is JSON-stringified into `body`.
-  * @default undefined
-  */
-  json: unknown;
-  body?: never;
-};
-type CustomRequestInit = {
-  /**
-  * Per-request query/search params
-  * @default undefined
-  */
-  searchParams?: URLSearchParamsInput;
-  /**
-  * Whether to throw a FetchError on HTTP errors (non-2xx responses)
-  * @default true
-  */
-  throwOnFetchError?: boolean;
-  /**
-  * Whether to throw a ValidationError on validation errors
-  * @default true
-  */
-  throwOnValidationError?: boolean;
-};
-/**
-* Extended RequestInit type to include custom fetch options
-*
-* @example
-* const options: ExtendedRequestInit = {
-*   method: "POST",
-*   json: { name: "Ada" },
-*   throwOnFetchError: true,
-* };
-*/
-type ExtendedRequestInit = (RequestBodyInit | JsonBodyInit) & CustomRequestInit;
-/**
-* Internal defaults used by fetchInternal
-*
-* @example
-* const defaults: FetchDefaults = {
-*   baseURL: "https://api.example.com",
-*   throwOnFetchError: true,
-*   throwOnValidationError: true,
-* };
-*/
-interface FetchDefaults {
-  /**
-  * Base URL to prepend to all requests
-  * @default ""
-  */
-  baseURL: string;
-  /**
-  * Default headers to include in all requests (can be overridden per request)
-  * @default undefined
-  */
-  headers?: HeadersInit;
-  /**
-  * Default query/search params applied to every request (can be overridden per request)
-  * @default undefined
-  */
-  searchParams?: URLSearchParamsInput;
-  /**
-  * Whether to throw a `FetchError` on HTTP errors (non-2xx responses)
-  * @default true
-  */
-  throwOnFetchError: boolean;
-  /**
-  * Whether to throw a `ValidationError` on validation errors
-  * @default true
-  */
-  throwOnValidationError: boolean;
-}
-/**
-* Type-safe fetch function with Standard Schema validation support
-*/
-interface $Fetch {
-  /**
-  * Fetch with schema validation and throwOnValidationError: false
-  * @param input - URL or path to fetch
-  * @param schema - Standard Schema for response validation
-  * @param options - Extended request options with throwOnValidationError: false
-  * @returns Standard Schema Result object with value or issues
-  * @throws {FetchError} When `throwOnFetchError` is `true` and the response is not ok.
-  * @throws {TypeError} When request construction, JSON request serialization, headers,
-  *   search params, native `fetch`, or `response.json()` body reading fail with a
-  *   `TypeError`.
-  * @throws {DOMException} When native `fetch` or `response.json()` rejects an aborted
-  *   request/body read as an `AbortError` DOMException.
-  * @throws {SyntaxError} When `response.json()` cannot parse the response body.
-  * @throws Any error thrown or rejected by the provided Standard Schema validator.
-  */
-  <TSchema extends StandardSchemaV1>(input: FetchInput, schema: TSchema, options: ExtendedRequestInit & {
-    throwOnValidationError: false;
-  }): Promise<StandardSchemaV1.Result<StandardSchemaV1.InferOutput<TSchema>>>;
-  /**
-  * Fetch with schema validation and throwOnValidationError: true or undefined (default)
-  * @param input - URL or path to fetch
-  * @param schema - Standard Schema for response validation
-  * @param options - Extended request options
-  * @returns Validated data of type TSchema
-  * @throws {FetchError} When `throwOnFetchError` is `true` and the response is not ok.
-  * @throws {ValidationError} When validation returns issues.
-  * @throws {TypeError} When request construction, JSON request serialization, headers,
-  *   search params, native `fetch`, or `response.json()` body reading fail with a
-  *   `TypeError`.
-  * @throws {DOMException} When native `fetch` or `response.json()` rejects an aborted
-  *   request/body read as an `AbortError` DOMException.
-  * @throws {SyntaxError} When `response.json()` cannot parse the response body.
-  * @throws Any error thrown or rejected by the provided Standard Schema validator.
-  */
-  <TSchema extends StandardSchemaV1>(input: FetchInput, schema: TSchema, options?: ExtendedRequestInit & {
-    throwOnValidationError?: true;
-  }): Promise<StandardSchemaV1.InferOutput<TSchema>>;
-  /**
-  * Fetch without schema validation
-  * @param input - URL or path to fetch
-  * @param options - Extended request options
-  * @returns Raw Response object
-  * @throws {FetchError} When `throwOnFetchError` is `true` and the response is not ok.
-  * @throws {TypeError} When request construction, JSON request serialization, headers,
-  *   search params, or native `fetch` fail with a `TypeError`.
-  * @throws {DOMException} When native `fetch` rejects an aborted request as an
-  *   `AbortError` DOMException.
-  */
-  (input: FetchInput, options?: ExtendedRequestInit): Promise<Response>;
-}
-/**
-* API HTTP method-specific fetch functions
-*
-* @example
-* const user = await api.get("/users/1", UserSchema);
-*/
-interface ApiMethods {
-  /**
-  * DELETE method fetch function
-  */
-  delete: $Fetch;
-  /**
-  * GET method fetch function
-  */
-  get: $Fetch;
-  /**
-  * PATCH method fetch function
-  */
-  patch: $Fetch;
-  /**
-  * POST method fetch function
-  */
-  post: $Fetch;
-  /**
-  * PUT method fetch function
-  */
-  put: $Fetch;
-}
-//#endregion
-export { $Fetch, ApiMethods, ExtendedRequestInit, FetchDefaults, FetchInput };
-//# sourceMappingURL=types.d.mts.map

package/dist/types.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.mts","names":[],"sources":["../src/types.ts"],"mappings":";;;;;AAWkD;KAAtC,UAAA,GAAa,UAAA,QAAkB,KAAA;AAAA,KAEtC,oBAAA,GAAuB,qBAAA,QAA6B,eAAA;AAAA,KAEpD,eAAA,GAAkB,WAAA;EACrB,IAAA;AAAA;AAAA,KAGG,YAAA,GAAe,IAAA,CAAK,WAAA;;;;AAHvB;EAQA,IAAA;EACA,IAAA;AAAA;AAAA,KAGG,iBAAA;;;;;EAKH,YAAA,GAAe,oBAAA;EARf;;;;EAaA,iBAAA;;;;;EAKA,sBAAA;AAAA;;;;;;;;;;;KAaU,mBAAA,IAAuB,eAAA,GAAkB,YAAA,IAAgB,iBAAA;;AAYrE;;;;;;;;;UAAiB,aAAA;;;;AA+BjB;EA1BE,OAAA;;;;;EAKA,OAAA,GAAU,WAAA;;;;;EAKV,YAAA,GAAe,oBAAA;;;;;EAKf,iBAAA;;;;;EAKA,sBAAA;AAAA;;;;UAMe,MAAA;;;;;;;;;;;;;;;;mBAgBE,gBAAA,EACf,KAAA,EAAO,UAAA,EACP,MAAA,EAAQ,OAAA,EACR,OAAA,EAAS,mBAAA;IAAwB,sBAAA;EAAA,IAChC,OAAA,CAAQ,gBAAA,CAAiB,MAAA,CAAO,gBAAA,CAAiB,WAAA,CAAY,OAAA;;;;;;;;;;;;;;;;AA8ClE;mBA5BmB,gBAAA,EACf,KAAA,EAAO,UAAA,EACP,MAAA,EAAQ,OAAA,EACR,OAAA,GAAU,mBAAA;IACR,sBAAA;EAAA,IAED,OAAA,CAAQ,gBAAA,CAAiB,WAAA,CAAY,OAAA;;;;;;;;;;;;GAavC,KAAA,EAAO,UAAA,EAAY,OAAA,GAAU,mBAAA,GAAsB,OAAA,CAAQ,QAAA;AAAA;;;;;;;UAS7C,UAAA;;;;EAIf,MAAA,EAAQ,MAAA;;;;EAIR,GAAA,EAAK,MAAA;;;;EAIL,KAAA,EAAO,MAAA;;;;EAIP,IAAA,EAAM,MAAA;;;;EAIN,GAAA,EAAK,MAAA;AAAA"}

package/dist/types.mjs

@@ -1 +0,0 @@
-export {};

package/dist/url.d.mts

@@ -1,27 +0,0 @@
-import { ExtendedRequestInit, FetchDefaults } from "./types.mjs";
-
-//#region src/url.d.ts
-/**
-* Resolves final request URL by applying baseURL and layered search params.
-*
-* Search param precedence:
-* 1. `defaults.searchParams`
-* 2. search params already present in `resourceUrl`
-* 3. per-request `searchParams`
-*
-* @example
-* const finalUrl = resolveRequestUrl(
-*   "/users?page=2",
-*   { ...defaults, baseURL: "https://api.example.com", searchParams: { locale: "en" } },
-*   { page: "3" },
-* );
-* // https://api.example.com/users?locale=en&page=3
-*
-* @throws {TypeError} When `baseURL` and `resourceUrl` cannot be resolved by
-*   `URL`, or when default/per-request search params cannot be converted by
-*   `URLSearchParams`.
-*/
-declare function resolveRequestUrl(resourceUrl: string, defaults: FetchDefaults, searchParams: ExtendedRequestInit["searchParams"] | undefined): string;
-//#endregion
-export { resolveRequestUrl };
-//# sourceMappingURL=url.d.mts.map

package/dist/url.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"url.d.mts","names":[],"sources":["../src/url.ts"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;iBA4BgB,iBAAA,CACd,WAAA,UACA,QAAA,EAAU,aAAA,EACV,YAAA,EAAc,mBAAA"}

package/dist/url.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"url.mjs","names":[],"sources":["../src/url.ts"],"sourcesContent":["/**\n * URL resolution and query merging utilities.\n *\n * @module @zap-studio/fetch/url\n */\n\nimport type { ExtendedRequestInit, FetchDefaults } from \"./types.js\";\n\n/**\n * Resolves final request URL by applying baseURL and layered search params.\n *\n * Search param precedence:\n * 1. `defaults.searchParams`\n * 2. search params already present in `resourceUrl`\n * 3. per-request `searchParams`\n *\n * @example\n * const finalUrl = resolveRequestUrl(\n *   \"/users?page=2\",\n *   { ...defaults, baseURL: \"https://api.example.com\", searchParams: { locale: \"en\" } },\n *   { page: \"3\" },\n * );\n * // https://api.example.com/users?locale=en&page=3\n *\n * @throws {TypeError} When `baseURL` and `resourceUrl` cannot be resolved by\n *   `URL`, or when default/per-request search params cannot be converted by\n *   `URLSearchParams`.\n */\nexport function resolveRequestUrl(\n  resourceUrl: string,\n  defaults: FetchDefaults,\n  searchParams: ExtendedRequestInit[\"searchParams\"] | undefined,\n): string {\n  const url = defaults.baseURL\n    ? new URL(resourceUrl, ensureTrailingSlash(defaults.baseURL)).toString()\n    : resourceUrl;\n\n  return resolveSearchParams(url, defaults.searchParams, searchParams);\n}\n\n/**\n * Resolves search params by applying default params, URL params, then request params.\n */\nfunction resolveSearchParams(\n  url: string,\n  defaultSearchParams: FetchDefaults[\"searchParams\"] | undefined,\n  searchParams: ExtendedRequestInit[\"searchParams\"] | undefined,\n): string {\n  if (!defaultSearchParams && searchParams === undefined) {\n    return url;\n  }\n\n  const hashIndex = url.indexOf(\"#\");\n  const hasFragment = hashIndex >= 0;\n  const urlWithoutHash = hasFragment ? url.slice(0, hashIndex) : url;\n  const hash = hasFragment ? url.slice(hashIndex + 1) : \"\";\n  const queryIndex = urlWithoutHash.indexOf(\"?\");\n  const pathname = queryIndex >= 0 ? urlWithoutHash.slice(0, queryIndex) : urlWithoutHash;\n  const urlSearchParams = queryIndex >= 0 ? urlWithoutHash.slice(queryIndex + 1) : undefined;\n  const resolvedSearchParams = new URLSearchParams();\n\n  mergeSearchParams(resolvedSearchParams, defaultSearchParams);\n  mergeSearchParams(resolvedSearchParams, urlSearchParams);\n  mergeSearchParams(resolvedSearchParams, searchParams);\n\n  const resolvedSearch = resolvedSearchParams.toString();\n  const fragmentSuffix = hasFragment ? `#${hash}` : \"\";\n\n  if (!resolvedSearch) {\n    return `${pathname}${fragmentSuffix}`;\n  }\n\n  return `${pathname}?${resolvedSearch}${fragmentSuffix}`;\n}\n\n/**\n * Ensures a URL has a trailing slash for relative URL resolution.\n */\nfunction ensureTrailingSlash(url: string): string {\n  return url.endsWith(\"/\") ? url : `${url}/`;\n}\n\n/**\n * Copies search params into target, overriding duplicate keys.\n */\nfunction mergeSearchParams(\n  target: URLSearchParams,\n  source: ExtendedRequestInit[\"searchParams\"] | undefined,\n): void {\n  for (const [key, value] of new URLSearchParams(source)) {\n    target.set(key, value);\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AA4BA,SAAgB,kBACd,aACA,UACA,cACQ;AAKR,QAAO,oBAJK,SAAS,UACjB,IAAI,IAAI,aAAa,oBAAoB,SAAS,QAAQ,CAAC,CAAC,UAAU,GACtE,aAE4B,SAAS,cAAc,aAAa;;;;;AAMtE,SAAS,oBACP,KACA,qBACA,cACQ;AACR,KAAI,CAAC,uBAAuB,iBAAiB,KAAA,EAC3C,QAAO;CAGT,MAAM,YAAY,IAAI,QAAQ,IAAI;CAClC,MAAM,cAAc,aAAa;CACjC,MAAM,iBAAiB,cAAc,IAAI,MAAM,GAAG,UAAU,GAAG;CAC/D,MAAM,OAAO,cAAc,IAAI,MAAM,YAAY,EAAE,GAAG;CACtD,MAAM,aAAa,eAAe,QAAQ,IAAI;CAC9C,MAAM,WAAW,cAAc,IAAI,eAAe,MAAM,GAAG,WAAW,GAAG;CACzE,MAAM,kBAAkB,cAAc,IAAI,eAAe,MAAM,aAAa,EAAE,GAAG,KAAA;CACjF,MAAM,uBAAuB,IAAI,iBAAiB;AAElD,mBAAkB,sBAAsB,oBAAoB;AAC5D,mBAAkB,sBAAsB,gBAAgB;AACxD,mBAAkB,sBAAsB,aAAa;CAErD,MAAM,iBAAiB,qBAAqB,UAAU;CACtD,MAAM,iBAAiB,cAAc,IAAI,SAAS;AAElD,KAAI,CAAC,eACH,QAAO,GAAG,WAAW;AAGvB,QAAO,GAAG,SAAS,GAAG,iBAAiB;;;;;AAMzC,SAAS,oBAAoB,KAAqB;AAChD,QAAO,IAAI,SAAS,IAAI,GAAG,MAAM,GAAG,IAAI;;;;;AAM1C,SAAS,kBACP,QACA,QACM;AACN,MAAK,MAAM,CAAC,KAAK,UAAU,IAAI,gBAAgB,OAAO,CACpD,QAAO,IAAI,KAAK,MAAM"}