@routar/axios 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/axios
+
+Axios-based executor for [routar](https://github.com/kbmin1129/routar) — transport adapter using Axios.
+
+## Install
+
+```bash
+npm install @routar/core @routar/axios axios
+```
+
+See the [main README](https://github.com/kbmin1129/routar) for full documentation.

package/dist/index.cjs

@@ -0,0 +1,29 @@
+'use strict';
+
+var core = require('@routar/core');
+
+// src/create-axios-executor.ts
+function resolveInstance(input) {
+  if ("interceptors" in input) {
+    return input;
+  }
+  return input();
+}
+function createAxiosExecutor(instanceOrFactory, options) {
+  return core.createExecutor(async ({ method, url, params, body, headers, signal }) => {
+    const instance = await resolveInstance(instanceOrFactory);
+    const { data } = await instance.request({
+      method,
+      url,
+      params,
+      data: body,
+      headers,
+      signal
+    });
+    return data;
+  }, options?.middlewares);
+}
+
+exports.createAxiosExecutor = createAxiosExecutor;
+//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/create-axios-executor.ts"],"names":["createExecutor"],"mappings":";;;;;AAwBA,SAAS,gBAAgB,KAAA,EAAkE;AAEzF,EAAA,IAAI,kBAAmB,KAAA,EAAkB;AACvC,IAAA,OAAO,KAAA;AAAA,EACT;AACA,EAAA,OAAQ,KAAA,EAA0B;AACpC;AA6BO,SAAS,mBAAA,CACd,mBACA,OAAA,EAGU;AACV,EAAA,OAAOA,mBAAA,CAAe,OAAO,EAAE,MAAA,EAAQ,KAAK,MAAA,EAAQ,IAAA,EAAM,OAAA,EAAS,MAAA,EAAO,KAAM;AAC9E,IAAA,MAAM,QAAA,GAAW,MAAM,eAAA,CAAgB,iBAAiB,CAAA;AACxD,IAAA,MAAM,EAAE,IAAA,EAAK,GAAI,MAAM,SAAS,OAAA,CAAQ;AAAA,MACtC,MAAA;AAAA,MACA,GAAA;AAAA,MACA,MAAA;AAAA,MACA,IAAA,EAAM,IAAA;AAAA,MACN,OAAA;AAAA,MACA;AAAA,KACD,CAAA;AACD,IAAA,OAAO,IAAA;AAAA,EACT,CAAA,EAAG,SAAS,WAAW,CAAA;AACzB","file":"index.cjs","sourcesContent":["import type { Executor, ExecutorMiddleware } from '@routar/core';\nimport { createExecutor } from '@routar/core';\nimport type { AxiosInstance } from 'axios';\n\n/** Zero-argument factory that returns an Axios instance (optionally async). */\ntype InstanceFactory = () => AxiosInstance | Promise<AxiosInstance>;\n\n/**\n * Accepted input for {@link createAxiosExecutor}.\n *\n * Pass a pre-configured `AxiosInstance` for CSR (the same instance is reused\n * across requests, which preserves interceptors and connection pooling).\n * Pass a factory function for SSR so a fresh instance — with per-request\n * headers or tokens — can be created on each call.\n */\nexport type InstanceOrFactory = AxiosInstance | InstanceFactory;\n\n/**\n * Discriminates between an `AxiosInstance` and a plain factory function.\n *\n * `AxiosInstance` is itself callable, so `typeof input === 'function'` cannot\n * distinguish the two. Duck-typing via `interceptors` works because Axios\n * always attaches it to instances, while user-supplied factories do not.\n */\nfunction resolveInstance(input: InstanceOrFactory): AxiosInstance | Promise<AxiosInstance> {\n  // AxiosInstance is callable but always has `interceptors`; plain factory functions do not.\n  if ('interceptors' in (input as object)) {\n    return input as AxiosInstance;\n  }\n  return (input as InstanceFactory)();\n}\n\n/**\n * Creates an {@link Executor} backed by Axios.\n *\n * Suited for CSR where a single shared `AxiosInstance` is preferred (fast,\n * interceptor-friendly). Also supports SSR via a factory that produces a\n * fresh instance per request, allowing dynamic per-request auth headers.\n *\n * Axios error objects (`AxiosError`) propagate unchanged through the executor\n * so you can inspect `err.response`, `err.code`, etc. in middleware or\n * callers — use `withRetry`'s `shouldRetry` option to skip retries on 4xx.\n *\n * @param instanceOrFactory - A pre-built `AxiosInstance` (CSR) or a factory\n *   function that returns one (SSR / per-request config).\n * @param options.middlewares - Middleware chain applied before the Axios call.\n *\n * @example\n * ```ts\n * // CSR — shared instance\n * const executor = createAxiosExecutor(axios.create({ baseURL: 'https://api.example.com' }));\n *\n * // SSR — factory\n * const executor = createAxiosExecutor(async () => {\n *   const token = await getServerToken();\n *   return axios.create({ baseURL: 'https://api.example.com', headers: { Authorization: `Bearer ${token}` } });\n * });\n * ```\n */\nexport function createAxiosExecutor(\n  instanceOrFactory: InstanceOrFactory,\n  options?: {\n    middlewares?: ExecutorMiddleware[];\n  },\n): Executor {\n  return createExecutor(async ({ method, url, params, body, headers, signal }) => {\n    const instance = await resolveInstance(instanceOrFactory);\n    const { data } = await instance.request({\n      method,\n      url,\n      params,\n      data: body,\n      headers,\n      signal,\n    });\n    return data;\n  }, options?.middlewares);\n}\n"]}

package/dist/index.d.cts

@@ -0,0 +1,46 @@
+import { ExecutorMiddleware, Executor } from '@routar/core';
+import { AxiosInstance } from 'axios';
+
+/** Zero-argument factory that returns an Axios instance (optionally async). */
+type InstanceFactory = () => AxiosInstance | Promise<AxiosInstance>;
+/**
+ * Accepted input for {@link createAxiosExecutor}.
+ *
+ * Pass a pre-configured `AxiosInstance` for CSR (the same instance is reused
+ * across requests, which preserves interceptors and connection pooling).
+ * Pass a factory function for SSR so a fresh instance — with per-request
+ * headers or tokens — can be created on each call.
+ */
+type InstanceOrFactory = AxiosInstance | InstanceFactory;
+/**
+ * Creates an {@link Executor} backed by Axios.
+ *
+ * Suited for CSR where a single shared `AxiosInstance` is preferred (fast,
+ * interceptor-friendly). Also supports SSR via a factory that produces a
+ * fresh instance per request, allowing dynamic per-request auth headers.
+ *
+ * Axios error objects (`AxiosError`) propagate unchanged through the executor
+ * so you can inspect `err.response`, `err.code`, etc. in middleware or
+ * callers — use `withRetry`'s `shouldRetry` option to skip retries on 4xx.
+ *
+ * @param instanceOrFactory - A pre-built `AxiosInstance` (CSR) or a factory
+ *   function that returns one (SSR / per-request config).
+ * @param options.middlewares - Middleware chain applied before the Axios call.
+ *
+ * @example
+ * ```ts
+ * // CSR — shared instance
+ * const executor = createAxiosExecutor(axios.create({ baseURL: 'https://api.example.com' }));
+ *
+ * // SSR — factory
+ * const executor = createAxiosExecutor(async () => {
+ *   const token = await getServerToken();
+ *   return axios.create({ baseURL: 'https://api.example.com', headers: { Authorization: `Bearer ${token}` } });
+ * });
+ * ```
+ */
+declare function createAxiosExecutor(instanceOrFactory: InstanceOrFactory, options?: {
+    middlewares?: ExecutorMiddleware[];
+}): Executor;
+
+export { createAxiosExecutor };

package/dist/index.d.ts

@@ -0,0 +1,46 @@
+import { ExecutorMiddleware, Executor } from '@routar/core';
+import { AxiosInstance } from 'axios';
+
+/** Zero-argument factory that returns an Axios instance (optionally async). */
+type InstanceFactory = () => AxiosInstance | Promise<AxiosInstance>;
+/**
+ * Accepted input for {@link createAxiosExecutor}.
+ *
+ * Pass a pre-configured `AxiosInstance` for CSR (the same instance is reused
+ * across requests, which preserves interceptors and connection pooling).
+ * Pass a factory function for SSR so a fresh instance — with per-request
+ * headers or tokens — can be created on each call.
+ */
+type InstanceOrFactory = AxiosInstance | InstanceFactory;
+/**
+ * Creates an {@link Executor} backed by Axios.
+ *
+ * Suited for CSR where a single shared `AxiosInstance` is preferred (fast,
+ * interceptor-friendly). Also supports SSR via a factory that produces a
+ * fresh instance per request, allowing dynamic per-request auth headers.
+ *
+ * Axios error objects (`AxiosError`) propagate unchanged through the executor
+ * so you can inspect `err.response`, `err.code`, etc. in middleware or
+ * callers — use `withRetry`'s `shouldRetry` option to skip retries on 4xx.
+ *
+ * @param instanceOrFactory - A pre-built `AxiosInstance` (CSR) or a factory
+ *   function that returns one (SSR / per-request config).
+ * @param options.middlewares - Middleware chain applied before the Axios call.
+ *
+ * @example
+ * ```ts
+ * // CSR — shared instance
+ * const executor = createAxiosExecutor(axios.create({ baseURL: 'https://api.example.com' }));
+ *
+ * // SSR — factory
+ * const executor = createAxiosExecutor(async () => {
+ *   const token = await getServerToken();
+ *   return axios.create({ baseURL: 'https://api.example.com', headers: { Authorization: `Bearer ${token}` } });
+ * });
+ * ```
+ */
+declare function createAxiosExecutor(instanceOrFactory: InstanceOrFactory, options?: {
+    middlewares?: ExecutorMiddleware[];
+}): Executor;
+
+export { createAxiosExecutor };

package/dist/index.js

@@ -0,0 +1,27 @@
+import { createExecutor } from '@routar/core';
+
+// src/create-axios-executor.ts
+function resolveInstance(input) {
+  if ("interceptors" in input) {
+    return input;
+  }
+  return input();
+}
+function createAxiosExecutor(instanceOrFactory, options) {
+  return createExecutor(async ({ method, url, params, body, headers, signal }) => {
+    const instance = await resolveInstance(instanceOrFactory);
+    const { data } = await instance.request({
+      method,
+      url,
+      params,
+      data: body,
+      headers,
+      signal
+    });
+    return data;
+  }, options?.middlewares);
+}
+
+export { createAxiosExecutor };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/create-axios-executor.ts"],"names":[],"mappings":";;;AAwBA,SAAS,gBAAgB,KAAA,EAAkE;AAEzF,EAAA,IAAI,kBAAmB,KAAA,EAAkB;AACvC,IAAA,OAAO,KAAA;AAAA,EACT;AACA,EAAA,OAAQ,KAAA,EAA0B;AACpC;AA6BO,SAAS,mBAAA,CACd,mBACA,OAAA,EAGU;AACV,EAAA,OAAO,cAAA,CAAe,OAAO,EAAE,MAAA,EAAQ,KAAK,MAAA,EAAQ,IAAA,EAAM,OAAA,EAAS,MAAA,EAAO,KAAM;AAC9E,IAAA,MAAM,QAAA,GAAW,MAAM,eAAA,CAAgB,iBAAiB,CAAA;AACxD,IAAA,MAAM,EAAE,IAAA,EAAK,GAAI,MAAM,SAAS,OAAA,CAAQ;AAAA,MACtC,MAAA;AAAA,MACA,GAAA;AAAA,MACA,MAAA;AAAA,MACA,IAAA,EAAM,IAAA;AAAA,MACN,OAAA;AAAA,MACA;AAAA,KACD,CAAA;AACD,IAAA,OAAO,IAAA;AAAA,EACT,CAAA,EAAG,SAAS,WAAW,CAAA;AACzB","file":"index.js","sourcesContent":["import type { Executor, ExecutorMiddleware } from '@routar/core';\nimport { createExecutor } from '@routar/core';\nimport type { AxiosInstance } from 'axios';\n\n/** Zero-argument factory that returns an Axios instance (optionally async). */\ntype InstanceFactory = () => AxiosInstance | Promise<AxiosInstance>;\n\n/**\n * Accepted input for {@link createAxiosExecutor}.\n *\n * Pass a pre-configured `AxiosInstance` for CSR (the same instance is reused\n * across requests, which preserves interceptors and connection pooling).\n * Pass a factory function for SSR so a fresh instance — with per-request\n * headers or tokens — can be created on each call.\n */\nexport type InstanceOrFactory = AxiosInstance | InstanceFactory;\n\n/**\n * Discriminates between an `AxiosInstance` and a plain factory function.\n *\n * `AxiosInstance` is itself callable, so `typeof input === 'function'` cannot\n * distinguish the two. Duck-typing via `interceptors` works because Axios\n * always attaches it to instances, while user-supplied factories do not.\n */\nfunction resolveInstance(input: InstanceOrFactory): AxiosInstance | Promise<AxiosInstance> {\n  // AxiosInstance is callable but always has `interceptors`; plain factory functions do not.\n  if ('interceptors' in (input as object)) {\n    return input as AxiosInstance;\n  }\n  return (input as InstanceFactory)();\n}\n\n/**\n * Creates an {@link Executor} backed by Axios.\n *\n * Suited for CSR where a single shared `AxiosInstance` is preferred (fast,\n * interceptor-friendly). Also supports SSR via a factory that produces a\n * fresh instance per request, allowing dynamic per-request auth headers.\n *\n * Axios error objects (`AxiosError`) propagate unchanged through the executor\n * so you can inspect `err.response`, `err.code`, etc. in middleware or\n * callers — use `withRetry`'s `shouldRetry` option to skip retries on 4xx.\n *\n * @param instanceOrFactory - A pre-built `AxiosInstance` (CSR) or a factory\n *   function that returns one (SSR / per-request config).\n * @param options.middlewares - Middleware chain applied before the Axios call.\n *\n * @example\n * ```ts\n * // CSR — shared instance\n * const executor = createAxiosExecutor(axios.create({ baseURL: 'https://api.example.com' }));\n *\n * // SSR — factory\n * const executor = createAxiosExecutor(async () => {\n *   const token = await getServerToken();\n *   return axios.create({ baseURL: 'https://api.example.com', headers: { Authorization: `Bearer ${token}` } });\n * });\n * ```\n */\nexport function createAxiosExecutor(\n  instanceOrFactory: InstanceOrFactory,\n  options?: {\n    middlewares?: ExecutorMiddleware[];\n  },\n): Executor {\n  return createExecutor(async ({ method, url, params, body, headers, signal }) => {\n    const instance = await resolveInstance(instanceOrFactory);\n    const { data } = await instance.request({\n      method,\n      url,\n      params,\n      data: body,\n      headers,\n      signal,\n    });\n    return data;\n  }, options?.middlewares);\n}\n"]}

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@routar/axios",
+  "version": "0.1.0",
+  "description": "Axios-based executor for routar — transport adapter using Axios",
+  "keywords": ["api", "http", "typescript", "axios", "routar", "executor"],
+  "author": "Kyungbae Min",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/minr2kb/routar.git",
+    "directory": "packages/axios"
+  },
+  "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": {
+    "axios": ">=1.0.0",
+    "@routar/core": "^0.1.0"
+  },
+  "devDependencies": {
+    "@routar/core": "workspace:*",
+    "axios": "^1.16.1",
+    "tsup": "^8.0.0",
+    "typescript": "^6.0.0"
+  },
+  "publishConfig": { "access": "public" }
+}