@routar/fetch 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Kyungbae Min
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,11 @@
+# @routar/fetch
+
+Fetch-based executor for [routar](https://github.com/kbmin1129/routar) — transport adapter using the native `fetch` API.
+
+## Install
+
+```bash
+npm install @routar/core @routar/fetch
+```
+
+See the [main README](https://github.com/kbmin1129/routar) for full documentation.

package/dist/index.cjs

@@ -0,0 +1,44 @@
+'use strict';
+
+var core = require('@routar/core');
+
+// src/create-fetch-executor.ts
+function createFetchExecutor(baseURL, options) {
+  return core.createExecutor(async ({ method, url, params, body, headers, signal }) => {
+    const fullURL = new URL(url, baseURL);
+    if (params) {
+      core.serializeParams(params).forEach((v, k) => fullURL.searchParams.set(k, v));
+    }
+    const defaultHeaders = await options?.defaultHeaders?.() ?? {};
+    const res = await fetch(fullURL.toString(), {
+      method,
+      headers: {
+        ...body != null ? { "Content-Type": "application/json" } : {},
+        ...defaultHeaders,
+        ...headers
+      },
+      body: body != null ? JSON.stringify(body) : void 0,
+      signal
+    });
+    if (!res.ok) {
+      throw new HttpError(res.status, res.statusText);
+    }
+    if (res.status === 204 || res.headers.get("content-length") === "0") {
+      return null;
+    }
+    return res.json();
+  }, options?.middlewares);
+}
+var HttpError = class extends Error {
+  constructor(status, statusText) {
+    super(`HTTP ${status}: ${statusText}`);
+    this.status = status;
+    this.statusText = statusText;
+    this.name = "HttpError";
+  }
+};
+
+exports.HttpError = HttpError;
+exports.createFetchExecutor = createFetchExecutor;
+//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/create-fetch-executor.ts"],"names":["createExecutor","serializeParams"],"mappings":";;;;;AA8BO,SAAS,mBAAA,CACd,SACA,OAAA,EAIU;AACV,EAAA,OAAOA,mBAAA,CAAe,OAAO,EAAE,MAAA,EAAQ,KAAK,MAAA,EAAQ,IAAA,EAAM,OAAA,EAAS,MAAA,EAAO,KAAM;AAC9E,IAAA,MAAM,OAAA,GAAU,IAAI,GAAA,CAAI,GAAA,EAAK,OAAO,CAAA;AACpC,IAAA,IAAI,MAAA,EAAQ;AACV,MAAAC,oBAAA,CAAgB,MAAM,CAAA,CAAE,OAAA,CAAQ,CAAC,CAAA,EAAG,CAAA,KAAM,OAAA,CAAQ,YAAA,CAAa,GAAA,CAAI,CAAA,EAAG,CAAC,CAAC,CAAA;AAAA,IAC1E;AAEA,IAAA,MAAM,cAAA,GAAkB,MAAM,OAAA,EAAS,cAAA,QAAuB,EAAC;AAE/D,IAAA,MAAM,GAAA,GAAM,MAAM,KAAA,CAAM,OAAA,CAAQ,UAAS,EAAG;AAAA,MAC1C,MAAA;AAAA,MACA,OAAA,EAAS;AAAA,QACP,GAAI,IAAA,IAAQ,IAAA,GAAO,EAAE,cAAA,EAAgB,kBAAA,KAAuB,EAAC;AAAA,QAC7D,GAAG,cAAA;AAAA,QACH,GAAG;AAAA,OACL;AAAA,MACA,MAAM,IAAA,IAAQ,IAAA,GAAO,IAAA,CAAK,SAAA,CAAU,IAAI,CAAA,GAAI,MAAA;AAAA,MAC5C;AAAA,KACD,CAAA;AAED,IAAA,IAAI,CAAC,IAAI,EAAA,EAAI;AACX,MAAA,MAAM,IAAI,SAAA,CAAU,GAAA,CAAI,MAAA,EAAQ,IAAI,UAAU,CAAA;AAAA,IAChD;AACA,IAAA,IAAI,GAAA,CAAI,WAAW,GAAA,IAAO,GAAA,CAAI,QAAQ,GAAA,CAAI,gBAAgB,MAAM,GAAA,EAAK;AACnE,MAAA,OAAO,IAAA;AAAA,IACT;AACA,IAAA,OAAO,IAAI,IAAA,EAAK;AAAA,EAClB,CAAA,EAAG,SAAS,WAAW,CAAA;AACzB;AAiBO,IAAM,SAAA,GAAN,cAAwB,KAAA,CAAM;AAAA,EACnC,WAAA,CAEkB,QAEA,UAAA,EAChB;AACA,IAAA,KAAA,CAAM,CAAA,KAAA,EAAQ,MAAM,CAAA,EAAA,EAAK,UAAU,CAAA,CAAE,CAAA;AAJrB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AAEA,IAAA,IAAA,CAAA,UAAA,GAAA,UAAA;AAGhB,IAAA,IAAA,CAAK,IAAA,GAAO,WAAA;AAAA,EACd;AACF","file":"index.cjs","sourcesContent":["import type { Executor, ExecutorMiddleware } from '@routar/core';\nimport { createExecutor, serializeParams } from '@routar/core';\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\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 */\nexport function createFetchExecutor(\n  baseURL: string,\n  options?: {\n    defaultHeaders?: () => Record<string, string> | Promise<Record<string, string>>;\n    middlewares?: ExecutorMiddleware[];\n  },\n): Executor {\n  return createExecutor(async ({ method, url, params, body, headers, signal }) => {\n    const fullURL = new URL(url, baseURL);\n    if (params) {\n      serializeParams(params).forEach((v, k) => fullURL.searchParams.set(k, v));\n    }\n\n    const defaultHeaders = (await options?.defaultHeaders?.()) ?? {};\n\n    const res = await fetch(fullURL.toString(), {\n      method,\n      headers: {\n        ...(body != null ? { 'Content-Type': 'application/json' } : {}),\n        ...defaultHeaders,\n        ...headers,\n      },\n      body: body != null ? JSON.stringify(body) : undefined,\n      signal,\n    });\n\n    if (!res.ok) {\n      throw new HttpError(res.status, res.statusText);\n    }\n    if (res.status === 204 || res.headers.get('content-length') === '0') {\n      return null;\n    }\n    return res.json();\n  }, options?.middlewares);\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  ) {\n    super(`HTTP ${status}: ${statusText}`);\n    this.name = 'HttpError';\n  }\n}\n"]}

package/dist/index.d.cts

@@ -0,0 +1,61 @@
+import { ExecutorMiddleware, Executor } from '@routar/core';
+
+/**
+ * Creates an {@link Executor} backed by the browser / Node.js `fetch` API.
+ *
+ * Suited for SSR environments where you need per-request dynamic headers
+ * (e.g. forwarding auth cookies) without sharing state across requests.
+ *
+ * - Query params are serialized and appended to the URL.
+ * - A `Content-Type: application/json` header is added automatically when
+ *   a request body is present.
+ * - Responses with status 204 or `Content-Length: 0` resolve to `null`.
+ * - Non-2xx responses throw an {@link HttpError}.
+ *
+ * @param baseURL - Absolute base URL prepended to every endpoint path.
+ * @param options.defaultHeaders - Async factory called on every request to
+ *   produce headers (e.g. reading cookies in a Next.js server component).
+ * @param options.middlewares - Middleware chain applied before the fetch call.
+ *
+ * @example
+ * ```ts
+ * const executor = createFetchExecutor('https://api.example.com', {
+ *   defaultHeaders: async () => {
+ *     const token = await getServerToken();
+ *     return token ? { Authorization: `Bearer ${token}` } : {};
+ *   },
+ * });
+ * ```
+ */
+declare function createFetchExecutor(baseURL: string, options?: {
+    defaultHeaders?: () => Record<string, string> | Promise<Record<string, string>>;
+    middlewares?: ExecutorMiddleware[];
+}): Executor;
+/**
+ * Thrown by {@link createFetchExecutor} when the server returns a non-2xx
+ * status code.
+ *
+ * @example
+ * ```ts
+ * try {
+ *   await api.getDetail({ path: { id: 999 } });
+ * } catch (err) {
+ *   if (err instanceof HttpError && err.status === 404) {
+ *     // handle not-found
+ *   }
+ * }
+ * ```
+ */
+declare class HttpError extends Error {
+    /** HTTP status code (e.g. 404, 500). */
+    readonly status: number;
+    /** HTTP status text (e.g. "Not Found"). */
+    readonly statusText: string;
+    constructor(
+    /** HTTP status code (e.g. 404, 500). */
+    status: number, 
+    /** HTTP status text (e.g. "Not Found"). */
+    statusText: string);
+}
+
+export { HttpError, createFetchExecutor };

package/dist/index.d.ts

@@ -0,0 +1,61 @@
+import { ExecutorMiddleware, Executor } from '@routar/core';
+
+/**
+ * Creates an {@link Executor} backed by the browser / Node.js `fetch` API.
+ *
+ * Suited for SSR environments where you need per-request dynamic headers
+ * (e.g. forwarding auth cookies) without sharing state across requests.
+ *
+ * - Query params are serialized and appended to the URL.
+ * - A `Content-Type: application/json` header is added automatically when
+ *   a request body is present.
+ * - Responses with status 204 or `Content-Length: 0` resolve to `null`.
+ * - Non-2xx responses throw an {@link HttpError}.
+ *
+ * @param baseURL - Absolute base URL prepended to every endpoint path.
+ * @param options.defaultHeaders - Async factory called on every request to
+ *   produce headers (e.g. reading cookies in a Next.js server component).
+ * @param options.middlewares - Middleware chain applied before the fetch call.
+ *
+ * @example
+ * ```ts
+ * const executor = createFetchExecutor('https://api.example.com', {
+ *   defaultHeaders: async () => {
+ *     const token = await getServerToken();
+ *     return token ? { Authorization: `Bearer ${token}` } : {};
+ *   },
+ * });
+ * ```
+ */
+declare function createFetchExecutor(baseURL: string, options?: {
+    defaultHeaders?: () => Record<string, string> | Promise<Record<string, string>>;
+    middlewares?: ExecutorMiddleware[];
+}): Executor;
+/**
+ * Thrown by {@link createFetchExecutor} when the server returns a non-2xx
+ * status code.
+ *
+ * @example
+ * ```ts
+ * try {
+ *   await api.getDetail({ path: { id: 999 } });
+ * } catch (err) {
+ *   if (err instanceof HttpError && err.status === 404) {
+ *     // handle not-found
+ *   }
+ * }
+ * ```
+ */
+declare class HttpError extends Error {
+    /** HTTP status code (e.g. 404, 500). */
+    readonly status: number;
+    /** HTTP status text (e.g. "Not Found"). */
+    readonly statusText: string;
+    constructor(
+    /** HTTP status code (e.g. 404, 500). */
+    status: number, 
+    /** HTTP status text (e.g. "Not Found"). */
+    statusText: string);
+}
+
+export { HttpError, createFetchExecutor };

package/dist/index.js

@@ -0,0 +1,41 @@
+import { createExecutor, serializeParams } from '@routar/core';
+
+// src/create-fetch-executor.ts
+function createFetchExecutor(baseURL, options) {
+  return createExecutor(async ({ method, url, params, body, headers, signal }) => {
+    const fullURL = new URL(url, baseURL);
+    if (params) {
+      serializeParams(params).forEach((v, k) => fullURL.searchParams.set(k, v));
+    }
+    const defaultHeaders = await options?.defaultHeaders?.() ?? {};
+    const res = await fetch(fullURL.toString(), {
+      method,
+      headers: {
+        ...body != null ? { "Content-Type": "application/json" } : {},
+        ...defaultHeaders,
+        ...headers
+      },
+      body: body != null ? JSON.stringify(body) : void 0,
+      signal
+    });
+    if (!res.ok) {
+      throw new HttpError(res.status, res.statusText);
+    }
+    if (res.status === 204 || res.headers.get("content-length") === "0") {
+      return null;
+    }
+    return res.json();
+  }, options?.middlewares);
+}
+var HttpError = class extends Error {
+  constructor(status, statusText) {
+    super(`HTTP ${status}: ${statusText}`);
+    this.status = status;
+    this.statusText = statusText;
+    this.name = "HttpError";
+  }
+};
+
+export { HttpError, createFetchExecutor };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/create-fetch-executor.ts"],"names":[],"mappings":";;;AA8BO,SAAS,mBAAA,CACd,SACA,OAAA,EAIU;AACV,EAAA,OAAO,cAAA,CAAe,OAAO,EAAE,MAAA,EAAQ,KAAK,MAAA,EAAQ,IAAA,EAAM,OAAA,EAAS,MAAA,EAAO,KAAM;AAC9E,IAAA,MAAM,OAAA,GAAU,IAAI,GAAA,CAAI,GAAA,EAAK,OAAO,CAAA;AACpC,IAAA,IAAI,MAAA,EAAQ;AACV,MAAA,eAAA,CAAgB,MAAM,CAAA,CAAE,OAAA,CAAQ,CAAC,CAAA,EAAG,CAAA,KAAM,OAAA,CAAQ,YAAA,CAAa,GAAA,CAAI,CAAA,EAAG,CAAC,CAAC,CAAA;AAAA,IAC1E;AAEA,IAAA,MAAM,cAAA,GAAkB,MAAM,OAAA,EAAS,cAAA,QAAuB,EAAC;AAE/D,IAAA,MAAM,GAAA,GAAM,MAAM,KAAA,CAAM,OAAA,CAAQ,UAAS,EAAG;AAAA,MAC1C,MAAA;AAAA,MACA,OAAA,EAAS;AAAA,QACP,GAAI,IAAA,IAAQ,IAAA,GAAO,EAAE,cAAA,EAAgB,kBAAA,KAAuB,EAAC;AAAA,QAC7D,GAAG,cAAA;AAAA,QACH,GAAG;AAAA,OACL;AAAA,MACA,MAAM,IAAA,IAAQ,IAAA,GAAO,IAAA,CAAK,SAAA,CAAU,IAAI,CAAA,GAAI,MAAA;AAAA,MAC5C;AAAA,KACD,CAAA;AAED,IAAA,IAAI,CAAC,IAAI,EAAA,EAAI;AACX,MAAA,MAAM,IAAI,SAAA,CAAU,GAAA,CAAI,MAAA,EAAQ,IAAI,UAAU,CAAA;AAAA,IAChD;AACA,IAAA,IAAI,GAAA,CAAI,WAAW,GAAA,IAAO,GAAA,CAAI,QAAQ,GAAA,CAAI,gBAAgB,MAAM,GAAA,EAAK;AACnE,MAAA,OAAO,IAAA;AAAA,IACT;AACA,IAAA,OAAO,IAAI,IAAA,EAAK;AAAA,EAClB,CAAA,EAAG,SAAS,WAAW,CAAA;AACzB;AAiBO,IAAM,SAAA,GAAN,cAAwB,KAAA,CAAM;AAAA,EACnC,WAAA,CAEkB,QAEA,UAAA,EAChB;AACA,IAAA,KAAA,CAAM,CAAA,KAAA,EAAQ,MAAM,CAAA,EAAA,EAAK,UAAU,CAAA,CAAE,CAAA;AAJrB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AAEA,IAAA,IAAA,CAAA,UAAA,GAAA,UAAA;AAGhB,IAAA,IAAA,CAAK,IAAA,GAAO,WAAA;AAAA,EACd;AACF","file":"index.js","sourcesContent":["import type { Executor, ExecutorMiddleware } from '@routar/core';\nimport { createExecutor, serializeParams } from '@routar/core';\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\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 */\nexport function createFetchExecutor(\n  baseURL: string,\n  options?: {\n    defaultHeaders?: () => Record<string, string> | Promise<Record<string, string>>;\n    middlewares?: ExecutorMiddleware[];\n  },\n): Executor {\n  return createExecutor(async ({ method, url, params, body, headers, signal }) => {\n    const fullURL = new URL(url, baseURL);\n    if (params) {\n      serializeParams(params).forEach((v, k) => fullURL.searchParams.set(k, v));\n    }\n\n    const defaultHeaders = (await options?.defaultHeaders?.()) ?? {};\n\n    const res = await fetch(fullURL.toString(), {\n      method,\n      headers: {\n        ...(body != null ? { 'Content-Type': 'application/json' } : {}),\n        ...defaultHeaders,\n        ...headers,\n      },\n      body: body != null ? JSON.stringify(body) : undefined,\n      signal,\n    });\n\n    if (!res.ok) {\n      throw new HttpError(res.status, res.statusText);\n    }\n    if (res.status === 204 || res.headers.get('content-length') === '0') {\n      return null;\n    }\n    return res.json();\n  }, options?.middlewares);\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  ) {\n    super(`HTTP ${status}: ${statusText}`);\n    this.name = 'HttpError';\n  }\n}\n"]}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@routar/fetch",
+  "version": "0.1.0",
+  "description": "Fetch-based executor for routar — transport adapter using the native fetch API",
+  "keywords": ["api", "http", "typescript", "fetch", "routar", "executor"],
+  "author": "Kyungbae Min",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/minr2kb/routar.git",
+    "directory": "packages/fetch"
+  },
+  "homepage": "https://github.com/minr2kb/routar#readme",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": ["dist", "README.md", "LICENSE"],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch"
+  },
+  "peerDependencies": {
+    "@routar/core": "^0.1.0"
+  },
+  "devDependencies": {
+    "@routar/core": "workspace:*",
+    "tsup": "^8.5.1"
+  },
+  "publishConfig": { "access": "public" }
+}