lissa 1.0.3 → 1.0.5

package/README.md

@@ -478,8 +478,9 @@ Decide if the occurred error should trigger a retry.
 The given errorType helps preselecting error types. Return false to not
 trigger a retry. Return nothing if the given errorType is correct. Return
 a string to redefine the errorType or use a custom one. The number of
-maximum retries can be configured as `on${errorType}`. Return "CustomError"
-and define the retries as { onCustomError: 3 }
+maximum retries can be configured as `on${errorType}` or `@${errorType}`.
+Return "CustomError" and define the retries as { onCustomError: 3 } or
+as { '@CustomError': 3 }.
 
 ```js
 Lissa.retry({

package/lib/index.d.ts

@@ -6,14 +6,21 @@ import { RequestInit, HeadersInit, BodyInit, Headers } from 'undici-types';
 
 export type JsonPrimitive = null | string | number | boolean;
 
-export type JsonObject = {
-	[key: string]: Json;
-};
+export type JsonObject = Record<string, Json>;
 
 export type JsonArray = Json[];
 
 export type Json = JsonPrimitive | JsonObject | JsonArray;
 
+
+export type JsonStringifyablePrimitive = null | undefined | string | number | boolean;
+
+export type JsonStringifyableObject = Record<string, JsonStringifyable>;
+
+export type JsonStringifyableArray = JsonStringifyable[];
+
+export type JsonStringifyable = JsonStringifyablePrimitive | JsonStringifyableObject | JsonStringifyableArray | { toJSON(): JsonStringifyable };
+
 /*
  * Param typing (like json but it supports dates if paramsSerializer is set to extended mode)
  */
@@ -49,7 +56,7 @@ export type LissaOptionsInit = Omit<RequestInit, 'method' | 'body'> & {
 	timeout?: number;
 	onUploadProgress?: (uploaded: number, total: number) => void;
 	onDownloadProgress?: (downloaded: number, total: number) => void;
-	body?: BodyInit | JsonObject;
+	body?: BodyInit | JsonStringifyableObject;
 };
 
 export type LissaOptions = Omit<LissaOptionsInit, 'headers'> & {
@@ -140,7 +147,7 @@ export declare class LissaRequest extends Promise<ResultValue> {
 	 *
 	 * The body gets json stringified if it is a plain object
 	 */
-	body(body: BodyInit | JsonObject): LissaRequest;
+	body(body: BodyInit | JsonStringifyableObject): LissaRequest;
 
 	/**
 	 * Set request timeout in milliseconds
@@ -207,7 +214,7 @@ interface MakeRequest {
 	 */
 	post(
 		url?: string,
-		body?: BodyInit | JsonObject,
+		body?: BodyInit | JsonStringifyableObject,
 		options?: Omit<LissaOptionsInit, 'method' | 'url' | 'body'>
 	): LissaRequest;
 
@@ -216,7 +223,7 @@ interface MakeRequest {
 	 */
 	put(
 		url?: string,
-		body?: BodyInit | JsonObject,
+		body?: BodyInit | JsonStringifyableObject,
 		options?: Omit<LissaOptionsInit, 'method' | 'url' | 'body'>
 	): LissaRequest;
 
@@ -225,7 +232,7 @@ interface MakeRequest {
 	 */
 	patch(
 		url?: string,
-		body?: BodyInit | JsonObject,
+		body?: BodyInit | JsonStringifyableObject,
 		options?: Omit<LissaOptionsInit, 'method' | 'url' | 'body'>
 	): LissaRequest;
 
@@ -421,14 +428,14 @@ export declare const retry: (options?: RetryOptions) => Plugin;
 
 export type CustomRetryError = {
 	/** custom retry type have to be returned by shouldRetry hook */
-	[K in `on${string}`]: number;
+	[K in `@${string}`]: number;
 };
 
 export type RetryOptions = CustomRetryError & {
-	onConnectionError?: number;
-	onGatewayError?: number;
-	on429?: number;
-	onServerError?: number;
+	'@ConnectionError'?: number;
+	'@GatewayError'?: number;
+	'@429'?: number;
+	'@ServerError'?: number;
 
 	/**
 	 * Decide if the occurred error should trigger a retry.
@@ -436,8 +443,9 @@ export type RetryOptions = CustomRetryError & {
 	 * The given errorType helps preselecting error types. Return false to not
 	 * trigger a retry. Return nothing if the given errorType is correct. Return
 	 * a string to redefine the errorType or use a custom one. The number of
-	 * maximum retries can be configured as `on${errorType}`. Return "CustomError"
-	 * and define the retries as { onCustomError: 3 }
+	 * maximum retries can be configured as `on${errorType}` or `@${errorType}`.
+	 * Return "CustomError" and define the retries as { onCustomError: 3 } or
+	 * as { '@CustomError': 3 }.
 	 */
 	shouldRetry?: (
 		errorType: void | 'ConnectionError' | 'GatewayError' | '429' | 'ServerError',

package/lib/plugins/retry.js

@@ -42,7 +42,7 @@ export default (options = {}) => (lissa) => {
 		}
 
 		// Return nothing to hand over the error to the next onError hook
-		if (retry.attempt > (options[`on${errorType}`] || 0)) return;
+		if (retry.attempt > (options[`@${errorType}`] ?? options[`on${errorType}`] ?? 0)) return;
 
 		await new Promise(resolve => setTimeout(resolve, retry.delay));
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lissa",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "A lightweight, extensible HTTP client for modern JavaScript applications with fluent api syntax, hooks, plugins and more.",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",