@ps-aux/api-client-axios 0.7.0-rc.1 → 0.7.0-rc.2

package/dist/node.cjs

@@ -0,0 +1,211 @@
+'use strict';
+
+const fileResFilenameRegex = /filename="([^"]+)"/;
+const getFileNameFromContentDispositionHeader = (contentDispositionHeader) => {
+  if (!contentDispositionHeader) return "download-file";
+  const match = contentDispositionHeader.match(fileResFilenameRegex);
+  const fileName = match ? match[1] : "downloaded-file";
+  return fileName;
+};
+
+const convertToFormData = (payload) => {
+  if (!payload || typeof payload !== "object" || Array.isArray(payload)) {
+    throw new Error("Multipart payload must be an object");
+  }
+  const formData = new FormData();
+  const source = payload;
+  const addProp = (key, value) => {
+    if (value === void 0) {
+      return;
+    }
+    if (Array.isArray(value)) {
+      value.forEach((item) => addProp(key, item));
+      return;
+    }
+    if (isFileList(value)) {
+      for (let i = 0; i < value.length; i += 1) {
+        addProp(key, value.item(i));
+      }
+      return;
+    }
+    if (isBlob(value)) {
+      formData.append(key, value);
+      return;
+    }
+    if (isNodeFileDescriptor(value)) {
+      const file = fileDescriptorToBlob(value);
+      formData.append(key, file, value.name);
+      return;
+    }
+    if (typeof value === "object" && value != null) {
+      throw new Error(
+        `Object serialization into FormData not supported: ${safeStringify(value)}`
+      );
+    }
+    formData.append(key, String(value));
+  };
+  Object.entries(source).forEach(([key, value]) => addProp(key, value));
+  return formData;
+};
+const withoutContentTypeHeader = (headers) => {
+  return Object.fromEntries(
+    Object.entries(headers).filter(
+      ([key]) => key.toLowerCase() !== "content-type"
+    )
+  );
+};
+const isBlob = (value) => {
+  return typeof Blob !== "undefined" && value instanceof Blob;
+};
+const isFileList = (value) => {
+  return typeof FileList !== "undefined" && value instanceof FileList;
+};
+const isNodeFileDescriptor = (value) => {
+  if (!value || typeof value !== "object" || Array.isArray(value)) {
+    return false;
+  }
+  const typed = value;
+  return typeof typed.name === "string" && "file" in typed;
+};
+const fileDescriptorToBlob = (descriptor) => {
+  const { file, type } = descriptor;
+  if (isBlob(file)) {
+    if (type && type !== file.type) {
+      return new Blob([file], { type });
+    }
+    return file;
+  }
+  if (typeof Buffer !== "undefined" && Buffer.isBuffer(file)) {
+    const bytes = new Uint8Array(file.byteLength);
+    bytes.set(file);
+    return new Blob([bytes.buffer], { type });
+  }
+  if (file instanceof ArrayBuffer) {
+    return new Blob([file], { type });
+  }
+  if (ArrayBuffer.isView(file)) {
+    const bytes = new Uint8Array(file.byteLength);
+    bytes.set(new Uint8Array(file.buffer, file.byteOffset, file.byteLength));
+    return new Blob([bytes.buffer], { type });
+  }
+  throw new Error(
+    "Object serialization into FormData not supported: Readable stream file descriptors are not supported"
+  );
+};
+const safeStringify = (value) => {
+  try {
+    return JSON.stringify(value);
+  } catch {
+    return String(value);
+  }
+};
+
+class HttpClientHelper {
+  validateRequest(req) {
+    this.assertRelativePathWithoutQuery(req.path);
+  }
+  assertRelativePathWithoutQuery(path) {
+    if (!path.startsWith("/")) {
+      throw new Error('Request path must start with "/".');
+    }
+    if (path.includes("?")) {
+      throw new Error(
+        "Request path must not contain a query string. Use req.query instead."
+      );
+    }
+  }
+  withQueryString(path, query, querySerializer) {
+    if (!query) {
+      return path;
+    }
+    const queryString = this.serializeQuery(query, querySerializer);
+    if (!queryString) {
+      return path;
+    }
+    return `${path}?${queryString}`;
+  }
+  serializeQuery(query, querySerializer) {
+    if (querySerializer) {
+      return querySerializer(query);
+    }
+    return this.toDefaultQueryString(query);
+  }
+  resolveUrl(path, baseUrl) {
+    if (!baseUrl) {
+      return path;
+    }
+    return new URL(path, baseUrl).toString();
+  }
+  convertToFormData(payload) {
+    return convertToFormData(payload);
+  }
+  withoutContentTypeHeader(headers) {
+    return withoutContentTypeHeader(headers);
+  }
+  getFileNameFromContentDispositionHeader(contentDispositionHeader) {
+    return getFileNameFromContentDispositionHeader(contentDispositionHeader);
+  }
+  toDefaultQueryString(query) {
+    const params = new URLSearchParams();
+    const addValue = (key, value) => {
+      if (value === void 0) return;
+      if (Array.isArray(value)) {
+        value.forEach((item) => addValue(key, item));
+        return;
+      }
+      params.append(key, String(value));
+    };
+    Object.entries(query).forEach(([key, value]) => addValue(key, value));
+    return params.toString();
+  }
+}
+
+const createHttpClient$1 = (axios, opts) => {
+  const { querySerializer } = opts;
+  const helper = new HttpClientHelper();
+  return {
+    request: (req) => {
+      helper.validateRequest(req);
+      const { query, requestContentType, body, headers: reqHeaders } = req;
+      const paramsSerializer = querySerializer ? (r) => helper.serializeQuery(r, querySerializer) : void 0;
+      const isBlobResponse = req.format === "document";
+      const headers = { ...reqHeaders || {} };
+      let data = body;
+      if (requestContentType === "multipart/form-data") {
+        data = helper.convertToFormData(body);
+      } else if (requestContentType) {
+        headers["Content-Type"] = requestContentType;
+      }
+      return axios.request({
+        method: req.method,
+        url: req.path,
+        params: query,
+        paramsSerializer,
+        data,
+        headers,
+        responseType: isBlobResponse ? "arraybuffer" : "json"
+      }).then((r) => {
+        const { data: data2 } = r;
+        if (isBlobResponse) {
+          const contDist = r.headers["content-disposition"];
+          const fileName = helper.getFileNameFromContentDispositionHeader(
+            contDist
+          );
+          const type = r.headers["content-type"];
+          return new File([data2], fileName, {
+            type
+          });
+        }
+        return data2;
+      });
+    }
+  };
+};
+
+const createHttpClient = (axios, opts) => {
+  return createHttpClient$1(axios, {
+    querySerializer: opts.querySerializer
+  });
+};
+
+exports.createHttpClient = createHttpClient;

package/dist/node.d.cts

@@ -0,0 +1,39 @@
+import { AxiosInstance } from 'axios';
+
+type KnownRequestContentType = 'application/json' | 'multipart/form-data' | 'application/x-www-form-urlencoded';
+type RequestContentType = KnownRequestContentType | string;
+type QueryValue = string | number | boolean | null | undefined | QueryValue[] | Record<string, any> | unknown;
+type QueryParams = Record<string, QueryValue>;
+type Request = {
+    path: string;
+    method: 'GET' | 'POST' | 'PUT' | 'DELETE';
+    format?: 'json' | 'document';
+    headers?: Record<string, string>;
+    query?: QueryParams;
+    body?: any;
+    requestContentType?: RequestContentType;
+};
+type QuerySerializer = (params: QueryParams) => string;
+
+type HttpClient<RequestParams = never> = {
+    request: <Data>(req: Request, params?: RequestParams) => Promise<Data>;
+};
+
+/// <reference lib="esnext.asynciterable" />
+
+/**
+ * Note: This will add Symbol.observable globally for all TypeScript users,
+ * however, we are no longer polyfilling Symbol.observable
+ */
+declare global {
+    interface SymbolConstructor {
+        readonly observable: symbol;
+    }
+}
+
+declare const createHttpClient: (axios: AxiosInstance, opts: {
+    querySerializer: QuerySerializer | null;
+}) => HttpClient;
+
+export { createHttpClient };
+export type { HttpClient as PromiseHttpClient, QuerySerializer };

package/dist/node.d.mts

@@ -0,0 +1,39 @@
+import { AxiosInstance } from 'axios';
+
+type KnownRequestContentType = 'application/json' | 'multipart/form-data' | 'application/x-www-form-urlencoded';
+type RequestContentType = KnownRequestContentType | string;
+type QueryValue = string | number | boolean | null | undefined | QueryValue[] | Record<string, any> | unknown;
+type QueryParams = Record<string, QueryValue>;
+type Request = {
+    path: string;
+    method: 'GET' | 'POST' | 'PUT' | 'DELETE';
+    format?: 'json' | 'document';
+    headers?: Record<string, string>;
+    query?: QueryParams;
+    body?: any;
+    requestContentType?: RequestContentType;
+};
+type QuerySerializer = (params: QueryParams) => string;
+
+type HttpClient<RequestParams = never> = {
+    request: <Data>(req: Request, params?: RequestParams) => Promise<Data>;
+};
+
+/// <reference lib="esnext.asynciterable" />
+
+/**
+ * Note: This will add Symbol.observable globally for all TypeScript users,
+ * however, we are no longer polyfilling Symbol.observable
+ */
+declare global {
+    interface SymbolConstructor {
+        readonly observable: symbol;
+    }
+}
+
+declare const createHttpClient: (axios: AxiosInstance, opts: {
+    querySerializer: QuerySerializer | null;
+}) => HttpClient;
+
+export { createHttpClient };
+export type { HttpClient as PromiseHttpClient, QuerySerializer };

package/dist/node.d.ts

@@ -1,5 +1,24 @@
 import { AxiosInstance } from 'axios';
 
+type KnownRequestContentType = 'application/json' | 'multipart/form-data' | 'application/x-www-form-urlencoded';
+type RequestContentType = KnownRequestContentType | string;
+type QueryValue = string | number | boolean | null | undefined | QueryValue[] | Record<string, any> | unknown;
+type QueryParams = Record<string, QueryValue>;
+type Request = {
+    path: string;
+    method: 'GET' | 'POST' | 'PUT' | 'DELETE';
+    format?: 'json' | 'document';
+    headers?: Record<string, string>;
+    query?: QueryParams;
+    body?: any;
+    requestContentType?: RequestContentType;
+};
+type QuerySerializer = (params: QueryParams) => string;
+
+type HttpClient<RequestParams = never> = {
+    request: <Data>(req: Request, params?: RequestParams) => Promise<Data>;
+};
+
 /// <reference lib="esnext.asynciterable" />
 
 /**
@@ -12,28 +31,9 @@ declare global {
     }
 }
 
-type RequestContentType = 'application/json' | 'multipart/form-data';
-type Request = {
-    path: string;
-    method: 'GET' | 'POST' | 'PUT' | 'DELETE';
-    format?: 'json' | 'document';
-    headers?: Record<string, string>;
-    query?: Record<string, unknown>;
-    body?: any;
-    requestContentType?: RequestContentType;
-};
-type QuerySerializer = (req: {
-    queryParams: Record<string, unknown>;
-}) => {
-    queryString: string;
-};
-type PromiseHttpClient<RequestParams = never> = {
-    request: <Data>(req: Request, params?: RequestParams) => Promise<Data>;
-};
-
 declare const createHttpClient: (axios: AxiosInstance, opts: {
     querySerializer: QuerySerializer | null;
-}) => PromiseHttpClient;
+}) => HttpClient;
 
 export { createHttpClient };
-export type { PromiseHttpClient, QuerySerializer };
+export type { HttpClient as PromiseHttpClient, QuerySerializer };

package/dist/node.mjs

@@ -0,0 +1,209 @@
+const fileResFilenameRegex = /filename="([^"]+)"/;
+const getFileNameFromContentDispositionHeader = (contentDispositionHeader) => {
+  if (!contentDispositionHeader) return "download-file";
+  const match = contentDispositionHeader.match(fileResFilenameRegex);
+  const fileName = match ? match[1] : "downloaded-file";
+  return fileName;
+};
+
+const convertToFormData = (payload) => {
+  if (!payload || typeof payload !== "object" || Array.isArray(payload)) {
+    throw new Error("Multipart payload must be an object");
+  }
+  const formData = new FormData();
+  const source = payload;
+  const addProp = (key, value) => {
+    if (value === void 0) {
+      return;
+    }
+    if (Array.isArray(value)) {
+      value.forEach((item) => addProp(key, item));
+      return;
+    }
+    if (isFileList(value)) {
+      for (let i = 0; i < value.length; i += 1) {
+        addProp(key, value.item(i));
+      }
+      return;
+    }
+    if (isBlob(value)) {
+      formData.append(key, value);
+      return;
+    }
+    if (isNodeFileDescriptor(value)) {
+      const file = fileDescriptorToBlob(value);
+      formData.append(key, file, value.name);
+      return;
+    }
+    if (typeof value === "object" && value != null) {
+      throw new Error(
+        `Object serialization into FormData not supported: ${safeStringify(value)}`
+      );
+    }
+    formData.append(key, String(value));
+  };
+  Object.entries(source).forEach(([key, value]) => addProp(key, value));
+  return formData;
+};
+const withoutContentTypeHeader = (headers) => {
+  return Object.fromEntries(
+    Object.entries(headers).filter(
+      ([key]) => key.toLowerCase() !== "content-type"
+    )
+  );
+};
+const isBlob = (value) => {
+  return typeof Blob !== "undefined" && value instanceof Blob;
+};
+const isFileList = (value) => {
+  return typeof FileList !== "undefined" && value instanceof FileList;
+};
+const isNodeFileDescriptor = (value) => {
+  if (!value || typeof value !== "object" || Array.isArray(value)) {
+    return false;
+  }
+  const typed = value;
+  return typeof typed.name === "string" && "file" in typed;
+};
+const fileDescriptorToBlob = (descriptor) => {
+  const { file, type } = descriptor;
+  if (isBlob(file)) {
+    if (type && type !== file.type) {
+      return new Blob([file], { type });
+    }
+    return file;
+  }
+  if (typeof Buffer !== "undefined" && Buffer.isBuffer(file)) {
+    const bytes = new Uint8Array(file.byteLength);
+    bytes.set(file);
+    return new Blob([bytes.buffer], { type });
+  }
+  if (file instanceof ArrayBuffer) {
+    return new Blob([file], { type });
+  }
+  if (ArrayBuffer.isView(file)) {
+    const bytes = new Uint8Array(file.byteLength);
+    bytes.set(new Uint8Array(file.buffer, file.byteOffset, file.byteLength));
+    return new Blob([bytes.buffer], { type });
+  }
+  throw new Error(
+    "Object serialization into FormData not supported: Readable stream file descriptors are not supported"
+  );
+};
+const safeStringify = (value) => {
+  try {
+    return JSON.stringify(value);
+  } catch {
+    return String(value);
+  }
+};
+
+class HttpClientHelper {
+  validateRequest(req) {
+    this.assertRelativePathWithoutQuery(req.path);
+  }
+  assertRelativePathWithoutQuery(path) {
+    if (!path.startsWith("/")) {
+      throw new Error('Request path must start with "/".');
+    }
+    if (path.includes("?")) {
+      throw new Error(
+        "Request path must not contain a query string. Use req.query instead."
+      );
+    }
+  }
+  withQueryString(path, query, querySerializer) {
+    if (!query) {
+      return path;
+    }
+    const queryString = this.serializeQuery(query, querySerializer);
+    if (!queryString) {
+      return path;
+    }
+    return `${path}?${queryString}`;
+  }
+  serializeQuery(query, querySerializer) {
+    if (querySerializer) {
+      return querySerializer(query);
+    }
+    return this.toDefaultQueryString(query);
+  }
+  resolveUrl(path, baseUrl) {
+    if (!baseUrl) {
+      return path;
+    }
+    return new URL(path, baseUrl).toString();
+  }
+  convertToFormData(payload) {
+    return convertToFormData(payload);
+  }
+  withoutContentTypeHeader(headers) {
+    return withoutContentTypeHeader(headers);
+  }
+  getFileNameFromContentDispositionHeader(contentDispositionHeader) {
+    return getFileNameFromContentDispositionHeader(contentDispositionHeader);
+  }
+  toDefaultQueryString(query) {
+    const params = new URLSearchParams();
+    const addValue = (key, value) => {
+      if (value === void 0) return;
+      if (Array.isArray(value)) {
+        value.forEach((item) => addValue(key, item));
+        return;
+      }
+      params.append(key, String(value));
+    };
+    Object.entries(query).forEach(([key, value]) => addValue(key, value));
+    return params.toString();
+  }
+}
+
+const createHttpClient$1 = (axios, opts) => {
+  const { querySerializer } = opts;
+  const helper = new HttpClientHelper();
+  return {
+    request: (req) => {
+      helper.validateRequest(req);
+      const { query, requestContentType, body, headers: reqHeaders } = req;
+      const paramsSerializer = querySerializer ? (r) => helper.serializeQuery(r, querySerializer) : void 0;
+      const isBlobResponse = req.format === "document";
+      const headers = { ...reqHeaders || {} };
+      let data = body;
+      if (requestContentType === "multipart/form-data") {
+        data = helper.convertToFormData(body);
+      } else if (requestContentType) {
+        headers["Content-Type"] = requestContentType;
+      }
+      return axios.request({
+        method: req.method,
+        url: req.path,
+        params: query,
+        paramsSerializer,
+        data,
+        headers,
+        responseType: isBlobResponse ? "arraybuffer" : "json"
+      }).then((r) => {
+        const { data: data2 } = r;
+        if (isBlobResponse) {
+          const contDist = r.headers["content-disposition"];
+          const fileName = helper.getFileNameFromContentDispositionHeader(
+            contDist
+          );
+          const type = r.headers["content-type"];
+          return new File([data2], fileName, {
+            type
+          });
+        }
+        return data2;
+      });
+    }
+  };
+};
+
+const createHttpClient = (axios, opts) => {
+  return createHttpClient$1(axios, {
+    querySerializer: opts.querySerializer
+  });
+};
+
+export { createHttpClient };

package/package.json

@@ -1,12 +1,10 @@
 {
   "name": "@ps-aux/api-client-axios",
-  "version": "0.7.0-rc.1",
-  "main": "dist/node.js",
-  "module": "dist/node.esm.js",
-  "browser": "dist/browser.esm.js",
-  "types": "dist/node.d.ts",
+  "version": "0.7.0-rc.2",
+  "main": "dist/node.cjs",
+  "type": "module",
   "scripts": {
-    "build": "rollup -c",
+    "build": "npm run clean && rollup -c",
     "clean": "rm -rf dist",
     "lint": "eslint",
     "prepublishOnly": "echo \"Publishing disabled for this repo. Use CI workflow.\" && exit 1",
@@ -16,11 +14,8 @@
   },
   "author": "psaux",
   "license": "MIT",
-  "dependencies": {
-    "form-data": "^4.0.0"
-  },
   "peerDependencies": {
-    "axios": "^1.5.0"
+    "axios": "^1.13.5"
   },
   "devDependencies": {
     "axios": "^1.5.0"
@@ -46,7 +41,7 @@
     "url": "https://github.com/ps-aux/api-tests/issues"
   },
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=20.0.0"
   },
   "publishConfig": {
     "access": "public"
@@ -58,13 +53,24 @@
   "exports": {
     ".": {
       "browser": {
-        "types": "./dist/browser.d.ts",
-        "import": "./dist/browser.esm.js",
-        "require": "./dist/browser.js"
+        "import": {
+          "types": "./dist/browser.d.mts",
+          "default": "./dist/browser.mjs"
+        },
+        "require": {
+          "types": "./dist/browser.d.cts",
+          "default": "./dist/browser.cjs"
+        }
+      },
+      "import": {
+        "types": "./dist/node.d.mts",
+        "default": "./dist/node.mjs"
+      },
+      "require": {
+        "types": "./dist/node.d.cts",
+        "default": "./dist/node.cjs"
       },
-      "types": "./dist/node.d.ts",
-      "import": "./dist/node.esm.js",
-      "require": "./dist/node.js"
+      "default": "./dist/node.mjs"
     }
   },
   "sideEffects": false