create-request 0.0.1-beta.9 → 1.1.0

package/dist/library/types.d.ts

@@ -1,10 +1,49 @@
-import { HttpMethod, RequestPriority, CredentialsPolicy, RequestMode, RedirectMode, CacheMode, SameSitePolicy } from "./enums";
-import type { RequestError } from "./RequestError";
+import { HttpMethod, RequestPriority, CredentialsPolicy, RequestMode, RedirectMode, SameSitePolicy } from "./enums";
+import type { RequestError } from "./RequestError.js";
+import type { ResponseWrapper } from "./ResponseWrapper.js";
 export type Body = null | Blob | string | object | FormData | ArrayBuffer | URLSearchParams | ReadableStream;
 export type RetryCallback = (options: {
     attempt: number;
     error: RequestError;
 }) => void | Promise<void>;
+/**
+ * Configuration object passed to request interceptors
+ * Contains all the information needed to make the request
+ */
+export interface RequestConfig {
+    url: string;
+    method: string;
+    headers: Record<string, string>;
+    body?: Body;
+    signal?: AbortSignal;
+    credentials?: RequestCredentials;
+    mode?: RequestMode | string;
+    redirect?: RedirectMode | string;
+    referrer?: string;
+    referrerPolicy?: ReferrerPolicy;
+    keepalive?: boolean;
+    priority?: RequestPriority | string;
+}
+/**
+ * Request interceptor that can modify the request configuration or return an early response
+ * If it returns a Response, the request will be short-circuited and that response will be used
+ * @param config - The request configuration
+ * @returns Modified config, a Response to short-circuit, or a Promise of either
+ */
+export type RequestInterceptor = (config: RequestConfig) => RequestConfig | Response | Promise<RequestConfig | Response>;
+/**
+ * Response interceptor that can transform the response
+ * @param response - The response wrapper
+ * @returns Modified response wrapper or a Promise of it
+ */
+export type ResponseInterceptor = (response: ResponseWrapper) => ResponseWrapper | Promise<ResponseWrapper>;
+/**
+ * Error interceptor that can handle or transform errors
+ * Can return a ResponseWrapper to recover from the error
+ * @param error - The error that occurred
+ * @returns Modified error, a ResponseWrapper to recover, or a Promise of either
+ */
+export type ErrorInterceptor = (error: RequestError) => RequestError | ResponseWrapper | Promise<RequestError | ResponseWrapper>;
 export interface CookieOptions {
     value: string;
     secure?: boolean;
@@ -16,12 +55,15 @@ export interface CookieOptions {
     maxAge?: number;
 }
 export type CookiesRecord = Record<string, string | CookieOptions>;
-export { CacheMode, HttpMethod, RequestMode, RedirectMode, SameSitePolicy, RequestPriority, CredentialsPolicy };
-export interface RequestOptions extends Omit<RequestInit, "signal" | "body" | "method" | "credentials" | "mode" | "redirect" | "cache" | "priority"> {
+export { HttpMethod, RequestMode, RedirectMode, SameSitePolicy, RequestPriority, CredentialsPolicy };
+export interface GraphQLOptions {
+    throwOnError?: boolean;
+}
+export interface RequestOptions extends Omit<RequestInit, "signal" | "body" | "method" | "credentials" | "mode" | "redirect" | "priority"> {
     timeout?: number;
     retries?: number;
     onRetry?: RetryCallback;
-    body?: any;
+    body?: Body;
     credentials?: CredentialsPolicy | RequestCredentials;
     mode?: RequestMode;
     redirect?: RedirectMode | RequestRedirect;

package/dist/library/utils/Config.d.ts

@@ -1,3 +1,4 @@
+import type { RequestInterceptor, ResponseInterceptor, ErrorInterceptor } from "../types.js";
 /**
  * Global configuration for create-request
  */
@@ -9,61 +10,212 @@ export declare class Config {
     private csrfToken;
     private enableAutoXsrf;
     private enableAntiCsrf;
+    private requestInterceptors;
+    private responseInterceptors;
+    private errorInterceptors;
+    private nextInterceptorId;
     private constructor();
     /**
-     * Get the singleton instance
+     * Get the singleton instance of the Config class
+     *
+     * @returns The global configuration instance
+     *
+     * @example
+     * const config = Config.getInstance();
+     * config.setCsrfToken('token123');
      */
     static getInstance(): Config;
     /**
      * Set a global CSRF token to be used for all requests
+     *
+     * @param token - The CSRF token value
+     * @returns The config instance for chaining
+     *
+     * @example
+     * Config.getInstance().setCsrfToken('myToken123');
      */
     setCsrfToken(token: string): Config;
     /**
-     * Get the global CSRF token
+     * Get the global CSRF token that will be automatically applied to requests
+     *
+     * @returns The current CSRF token or null if not set
      */
     getCsrfToken(): string | null;
     /**
-     * Set the CSRF header name (default is X-CSRF-Token)
+     * Set the CSRF header name used when sending the token
+     *
+     * @param name - The header name to use
+     * @returns The config instance for chaining
+     *
+     * @example
+     * Config.getInstance().setCsrfHeaderName('X-My-CSRF-Token');
      */
     setCsrfHeaderName(name: string): Config;
     /**
-     * Get the CSRF header name
+     * Get the configured CSRF header name
+     *
+     * @returns The current CSRF header name
      */
     getCsrfHeaderName(): string;
     /**
-     * Set the XSRF cookie name to look for (default is XSRF-TOKEN)
+     * Set the XSRF cookie name to look for when extracting tokens from cookies
+     *
+     * @param name - The cookie name to look for
+     * @returns The config instance for chaining
+     *
+     * @example
+     * Config.getInstance().setXsrfCookieName('MY-XSRF-COOKIE');
      */
     setXsrfCookieName(name: string): Config;
     /**
-     * Get the XSRF cookie name
+     * Get the configured XSRF cookie name
+     *
+     * @returns The current XSRF cookie name
      */
     getXsrfCookieName(): string;
     /**
-     * Set the XSRF header name to send the token in (default is X-XSRF-TOKEN)
+     * Set the XSRF header name for sending tokens extracted from cookies
+     *
+     * @param name - The header name to use
+     * @returns The config instance for chaining
      */
     setXsrfHeaderName(name: string): Config;
     /**
-     * Get the XSRF header name
+     * Get the configured XSRF header name
+     *
+     * @returns The current XSRF header name
      */
     getXsrfHeaderName(): string;
     /**
-     * Enable or disable automatic XSRF token extraction from cookies
+     * Enable or disable automatic extraction of XSRF tokens from cookies
+     * When enabled, the library will look for XSRF tokens in cookies and
+     * automatically add them to request headers.
+     *
+     * @param enable - Whether to enable this feature
+     * @returns The config instance for chaining
+     *
+     * @example
+     * Config.getInstance().setEnableAutoXsrf(false); // Disable XSRF extraction
      */
     setEnableAutoXsrf(enable: boolean): Config;
     /**
-     * Check if automatic XSRF is enabled
+     * Check if automatic XSRF token extraction is enabled
+     *
+     * @returns True if automatic XSRF is enabled
      */
     isAutoXsrfEnabled(): boolean;
     /**
      * Enable or disable automatic addition of anti-CSRF headers
+     * When enabled, X-Requested-With: XMLHttpRequest will be added to all requests.
+     *
+     * @param enable - Whether to enable this feature
+     * @returns The config instance for chaining
      */
     setEnableAntiCsrf(enable: boolean): Config;
     /**
-     * Check if anti-CSRF is enabled
+     * Check if anti-CSRF protection is enabled
+     *
+     * @returns True if anti-CSRF protection is enabled
      */
     isAntiCsrfEnabled(): boolean;
     /**
-     * Reset all configuration options to their defaults
+     * Add a global request interceptor
+     * Request interceptors can modify the request configuration or return an early response
+     *
+     * @param interceptor - The request interceptor function
+     * @returns The interceptor ID for later removal
+     *
+     * @example
+     * const id = Config.getInstance().addRequestInterceptor((config) => {
+     *   config.headers['X-Custom'] = 'value';
+     *   return config;
+     * });
+     */
+    addRequestInterceptor(interceptor: RequestInterceptor): number;
+    /**
+     * Add a global response interceptor
+     * Response interceptors can transform the response
+     *
+     * @param interceptor - The response interceptor function
+     * @returns The interceptor ID for later removal
+     *
+     * @example
+     * const id = Config.getInstance().addResponseInterceptor((response) => {
+     *   console.log('Response received:', response.status);
+     *   return response;
+     * });
+     */
+    addResponseInterceptor(interceptor: ResponseInterceptor): number;
+    /**
+     * Add a global error interceptor
+     * Error interceptors can handle or transform errors
+     *
+     * @param interceptor - The error interceptor function
+     * @returns The interceptor ID for later removal
+     *
+     * @example
+     * const id = Config.getInstance().addErrorInterceptor((error) => {
+     *   console.error('Request failed:', error);
+     *   throw error;
+     * });
+     */
+    addErrorInterceptor(interceptor: ErrorInterceptor): number;
+    /**
+     * Remove a request interceptor by its ID
+     *
+     * @param id - The interceptor ID returned from addRequestInterceptor
+     *
+     * @example
+     * Config.getInstance().removeRequestInterceptor(id);
+     */
+    removeRequestInterceptor(id: number): void;
+    /**
+     * Remove a response interceptor by its ID
+     *
+     * @param id - The interceptor ID returned from addResponseInterceptor
+     *
+     * @example
+     * Config.getInstance().removeResponseInterceptor(id);
+     */
+    removeResponseInterceptor(id: number): void;
+    /**
+     * Remove an error interceptor by its ID
+     *
+     * @param id - The interceptor ID returned from addErrorInterceptor
+     *
+     * @example
+     * Config.getInstance().removeErrorInterceptor(id);
+     */
+    removeErrorInterceptor(id: number): void;
+    /**
+     * Clear all interceptors (request, response, and error)
+     *
+     * @example
+     * Config.getInstance().clearInterceptors();
+     */
+    clearInterceptors(): void;
+    /**
+     * Get all global request interceptors (in registration order)
+     * @internal
+     */
+    getRequestInterceptors(): RequestInterceptor[];
+    /**
+     * Get all global response interceptors (in registration order)
+     * @internal
+     */
+    getResponseInterceptors(): ResponseInterceptor[];
+    /**
+     * Get all global error interceptors (in registration order)
+     * @internal
+     */
+    getErrorInterceptors(): ErrorInterceptor[];
+    /**
+     * Reset all configuration options to their default values
+     *
+     * @returns The config instance for chaining
+     *
+     * @example
+     * Config.getInstance().reset();
      */
     reset(): Config;
 }

package/dist/library/utils/CookieUtils.d.ts

@@ -1,4 +1,4 @@
-import type { CookiesRecord } from "../types";
+import type { CookiesRecord } from "../types.js";
 export declare class CookieUtils {
     /**
      * Formats cookies for a request

package/dist/library/utils/sizeUtils.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Parse size strings like "10MB" into bytes
+ * Supports KB, MB, and GB units. If no unit is specified, assumes bytes.
+ *
+ * @param size - Size as number (bytes) or string with units (e.g., "5MB")
+ * @returns Size in bytes
+ */
+export declare function parseSize(size: string | number): number;

package/package.json

@@ -1,28 +1,45 @@
 {
   "name": "create-request",
-  "version": "0.0.1-beta.9",
+  "version": "1.1.0",
   "description": "A modern, chainable wrapper for fetch with automatic retries, timeouts, comprehensive error handling, and first-class TypeScript support",
-  "main": "dist/library/index.js",
+  "main": "dist/library/index.cjs",
   "module": "dist/library/index.esm.js",
   "types": "dist/library/index.d.ts",
+  "sideEffects": false,
+  "type": "module",
   "files": [
     "dist/library"
   ],
+  "exports": {
+    ".": {
+      "import": {
+        "default": "./dist/library/index.esm.js",
+        "production": "./dist/library/index.esm.min.js"
+      },
+      "require": {
+        "default": "./dist/library/index.cjs",
+        "production": "./dist/library/index.min.cjs"
+      },
+      "types": "./dist/library/index.d.ts"
+    }
+  },
   "scripts": {
-    "build": "rollup -c",
-    "dev": "rollup -c -w",
-    "test": "tsc -p tsconfig.test.json && node --test --experimental-test-coverage",
-    "test:coverage": "tsc -p tsconfig.test.json && node --test --experimental-test-coverage dist/tests/test/",
-    "pretest": "tsc -p tsconfig.test.json",
-    "prepublishOnly": "npm run check && npm run build",
-    "publish:beta": "npm run check && npm version prerelease --preid=beta && git push origin --tags && npm publish --tag latest",
-    "disabled:publish:patch": "npm version patch && git push origin --tags && npm publish",
-    "disabled:publish:minor": "npm version minor && git push origin --tags && npm publish",
-    "disabled:publish:major": "npm version major && git push origin --tags && npm publish",
-    "lint": "eslint 'src/**/*.ts' 'test/**/*.ts'",
-    "lint:fix": "eslint 'src/**/*.ts' 'test/**/*.ts' --fix",
-    "format": "prettier --write 'src/**/*.ts' 'test/**/*.ts'",
-    "check": "npm run lint && npm run test"
+    "dev": "cross-env BUILD_ENV=development rollup -c rollup.config.js -w",
+    "build": "cross-env BUILD_ENV=production rollup -c rollup.config.js",
+    "analyze": "cross-env ANALYZE=true BUILD_ENV=production rollup -c rollup.config.js",
+    "lint": "eslint 'src/**/*.{js,ts,json}' 'test/**/*.{js,ts,json}'",
+    "lint:fix": "eslint \"**/*.ts\" --ignore-path .eslintignore --fix",
+    "format": "prettier --write \"**/*.{ts,js,json}\"",
+    "check": "concurrently \"npm run lint\" \"npm run test\" \"npm run check:size\"",
+    "check:size": "npx size-limit",
+    "test": "node --import tsx --test test/**/*.test.ts",
+    "test:coverage": "node --import tsx --experimental-test-coverage --test test/**/*.test.ts",
+    "preversion": "npm run check",
+    "prepublishOnly": "npm run build",
+    "publish:beta": "npm version prerelease --preid=beta && git push origin --tags && npm publish --tag latest",
+    "publish:patch": "npm version patch && git push origin --tags && npm publish",
+    "publish:minor": "npm version minor && git push origin --tags && npm publish",
+    "publish:major": "npm version major && git push origin --tags && npm publish"
   },
   "keywords": [
     "fetch",
@@ -34,26 +51,67 @@
   ],
   "author": "Daniel Amenou <amenou.daniel@gmail.com>",
   "license": "MIT",
+  "engines": {
+    "node": ">=18.3.0"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/DanielAmenou/create-request.git"
   },
+  "homepage": "https://github.com/DanielAmenou/create-request#readme",
+  "bugs": {
+    "url": "https://github.com/DanielAmenou/create-request/issues"
+  },
+  "size-limit": [
+    {
+      "path": "dist/library/index.esm.js",
+      "limit": "6 KB",
+      "gzip": true,
+      "name": "ESM Standard"
+    },
+    {
+      "path": "dist/library/index.cjs",
+      "limit": "6.5 KB",
+      "gzip": true,
+      "name": "CJS Standard"
+    },
+    {
+      "path": "dist/library/index.esm.min.js",
+      "limit": "6 KB",
+      "gzip": true,
+      "name": "ESM Minified"
+    },
+    {
+      "path": "dist/library/index.min.cjs",
+      "limit": "6.5 KB",
+      "gzip": true,
+      "name": "CJS Minified"
+    }
+  ],
   "devDependencies": {
     "@rollup/plugin-commonjs": "^22.0.0",
     "@rollup/plugin-node-resolve": "^13.3.0",
+    "@rollup/plugin-terser": "^0.4.3",
     "@rollup/plugin-typescript": "^8.3.2",
+    "@size-limit/preset-small-lib": "^8.2.6",
     "@types/node": "^18.0.0",
     "@typescript-eslint/eslint-plugin": "^6.15.0",
     "@typescript-eslint/parser": "^6.15.0",
+    "concurrently": "^8.2.2",
+    "cross-env": "^7.0.3",
     "eslint": "^8.56.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-import-resolver-typescript": "^3.6.1",
     "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-jsonc": "^2.11.0",
     "eslint-plugin-prettier": "^5.0.1",
     "prettier": "^3.1.1",
     "rollup": "^2.75.5",
     "rollup-plugin-cleaner": "^1.0.0",
+    "rollup-plugin-visualizer": "^5.9.2",
+    "size-limit": "^8.2.6",
     "tslib": "^2.4.0",
+    "tsx": "^4.20.6",
     "typescript": "^4.7.3",
     "undici": "^5.28.5"
   }