@naturalcycles/js-lib 14.168.2 → 14.170.0

package/dist/error/error.util.d.ts

@@ -27,14 +27,16 @@ export declare function _isErrorObject<DATA_TYPE extends ErrorData = ErrorData>(
 export declare function _isErrorLike(o: any): o is ErrorLike;
 /**
  * Convenience function to safely add properties to Error's `data` object
- * (even if it wasn't previously existing)
+ * (even if it wasn't previously existing).
+ * Mutates err.
+ * Returns err for convenience, so you can re-throw it directly.
  *
  * @example
  *
  * try {} catch (err) {
- *   _errorDataAppend(err, {
+ *   throw _errorDataAppend(err, {
  *     httpStatusCode: 401,
  *   })
  * }
  */
-export declare function _errorDataAppend(err: any, data?: ErrorData): void;
+export declare function _errorDataAppend<ERR>(err: ERR, data?: ErrorData): ERR;

package/dist/error/error.util.js

@@ -154,22 +154,25 @@ function _isErrorLike(o) {
 exports._isErrorLike = _isErrorLike;
 /**
  * Convenience function to safely add properties to Error's `data` object
- * (even if it wasn't previously existing)
+ * (even if it wasn't previously existing).
+ * Mutates err.
+ * Returns err for convenience, so you can re-throw it directly.
  *
  * @example
  *
  * try {} catch (err) {
- *   _errorDataAppend(err, {
+ *   throw _errorDataAppend(err, {
  *     httpStatusCode: 401,
  *   })
  * }
  */
 function _errorDataAppend(err, data) {
     if (!data)
-        return;
+        return err;
     err.data = {
         ...err.data,
         ...data,
     };
+    return err;
 }
 exports._errorDataAppend = _errorDataAppend;

package/dist/index.d.ts

@@ -82,6 +82,7 @@ export * from './string/hash.util';
 export * from './env/buildInfo';
 export * from './form.util';
 export * from './semver';
+export * from './web';
 export * from './zod/zod.util';
 export * from './zod/zod.shared.schemas';
 import { z, ZodSchema, ZodError, ZodIssue } from 'zod';

package/dist/index.js

@@ -86,6 +86,7 @@ tslib_1.__exportStar(require("./string/hash.util"), exports);
 tslib_1.__exportStar(require("./env/buildInfo"), exports);
 tslib_1.__exportStar(require("./form.util"), exports);
 tslib_1.__exportStar(require("./semver"), exports);
+tslib_1.__exportStar(require("./web"), exports);
 tslib_1.__exportStar(require("./zod/zod.util"), exports);
 tslib_1.__exportStar(require("./zod/zod.shared.schemas"), exports);
 const zod_1 = require("zod");

package/dist/promise/pRetry.js

@@ -56,8 +56,7 @@ async function pRetry(fn, opt = {}) {
             }
             if (attempt >= maxAttempts || (predicate && !predicate(err, attempt, maxAttempts))) {
                 // Give up
-                (0, __1._errorDataAppend)(err, opt.errorData);
-                throw err;
+                throw (0, __1._errorDataAppend)(err, opt.errorData);
             }
             // Retry after delay
             delay *= delayMultiplier;

package/dist/promise/pTimeout.js

@@ -46,8 +46,7 @@ async function pTimeout(fn, opt) {
                 catch (err) {
                     // keep original stack
                     err.stack = fakeError.stack.replace('Error: TimeoutError', err.name + ': ' + err.message);
-                    (0, error_util_1._errorDataAppend)(err, opt.errorData);
-                    reject(err);
+                    reject((0, error_util_1._errorDataAppend)(err, opt.errorData));
                 }
                 return;
             }

package/dist/web.d.ts

@@ -0,0 +1,18 @@
+/// <reference lib="dom" />
+import { StringMap } from './types';
+/**
+ * Implements WebStorage API by using in-memory storage.
+ * Can be useful in SSR environment or unit tests.
+ *
+ * @experimental
+ */
+export declare class InMemoryWebStorage implements Storage {
+    data: StringMap;
+    constructor(data?: StringMap);
+    getItem(key: string): string | null;
+    setItem(key: string, value: string): void;
+    removeItem(key: string): void;
+    key(index: number): string | null;
+    clear(): void;
+    get length(): number;
+}

package/dist/web.js

@@ -0,0 +1,37 @@
+"use strict";
+/// <reference lib="dom"/>
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InMemoryWebStorage = void 0;
+/**
+ * Implements WebStorage API by using in-memory storage.
+ * Can be useful in SSR environment or unit tests.
+ *
+ * @experimental
+ */
+class InMemoryWebStorage {
+    constructor(data = {}) {
+        this.data = data;
+    }
+    // Not implementing "free property access" now for simplicity,
+    // but can be implemented with Proxy
+    // [ name: string ]: any
+    getItem(key) {
+        return this.data[key] ?? null;
+    }
+    setItem(key, value) {
+        this.data[key] = String(value);
+    }
+    removeItem(key) {
+        delete this.data[key];
+    }
+    key(index) {
+        return Object.keys(this.data)[index] ?? null;
+    }
+    clear() {
+        this.data = {};
+    }
+    get length() {
+        return Object.keys(this.data).length;
+    }
+}
+exports.InMemoryWebStorage = InMemoryWebStorage;

package/dist-esm/error/error.util.js

@@ -141,18 +141,21 @@ export function _isErrorLike(o) {
 }
 /**
  * Convenience function to safely add properties to Error's `data` object
- * (even if it wasn't previously existing)
+ * (even if it wasn't previously existing).
+ * Mutates err.
+ * Returns err for convenience, so you can re-throw it directly.
  *
  * @example
  *
  * try {} catch (err) {
- *   _errorDataAppend(err, {
+ *   throw _errorDataAppend(err, {
  *     httpStatusCode: 401,
  *   })
  * }
  */
 export function _errorDataAppend(err, data) {
     if (!data)
-        return;
+        return err;
     err.data = Object.assign(Object.assign({}, err.data), data);
+    return err;
 }

package/dist-esm/index.js

@@ -82,6 +82,7 @@ export * from './string/hash.util';
 export * from './env/buildInfo';
 export * from './form.util';
 export * from './semver';
+export * from './web';
 export * from './zod/zod.util';
 export * from './zod/zod.shared.schemas';
 import { z, ZodSchema, ZodError } from 'zod';

package/dist-esm/promise/pRetry.js

@@ -52,8 +52,7 @@ export async function pRetry(fn, opt = {}) {
             }
             if (attempt >= maxAttempts || (predicate && !predicate(err, attempt, maxAttempts))) {
                 // Give up
-                _errorDataAppend(err, opt.errorData);
-                throw err;
+                throw _errorDataAppend(err, opt.errorData);
             }
             // Retry after delay
             delay *= delayMultiplier;

package/dist-esm/promise/pTimeout.js

@@ -41,8 +41,7 @@ export async function pTimeout(fn, opt) {
                 catch (err) {
                     // keep original stack
                     err.stack = fakeError.stack.replace('Error: TimeoutError', err.name + ': ' + err.message);
-                    _errorDataAppend(err, opt.errorData);
-                    reject(err);
+                    reject(_errorDataAppend(err, opt.errorData));
                 }
                 return;
             }

package/dist-esm/web.js

@@ -0,0 +1,35 @@
+/// <reference lib="dom"/>
+/**
+ * Implements WebStorage API by using in-memory storage.
+ * Can be useful in SSR environment or unit tests.
+ *
+ * @experimental
+ */
+export class InMemoryWebStorage {
+    constructor(data = {}) {
+        this.data = data;
+    }
+    // Not implementing "free property access" now for simplicity,
+    // but can be implemented with Proxy
+    // [ name: string ]: any
+    getItem(key) {
+        var _a;
+        return (_a = this.data[key]) !== null && _a !== void 0 ? _a : null;
+    }
+    setItem(key, value) {
+        this.data[key] = String(value);
+    }
+    removeItem(key) {
+        delete this.data[key];
+    }
+    key(index) {
+        var _a;
+        return (_a = Object.keys(this.data)[index]) !== null && _a !== void 0 ? _a : null;
+    }
+    clear() {
+        this.data = {};
+    }
+    get length() {
+        return Object.keys(this.data).length;
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/js-lib",
-  "version": "14.168.2",
+  "version": "14.170.0",
   "scripts": {
     "prepare": "husky install",
     "build-prod": "build-prod-esm-cjs",

package/src/error/error.util.ts

@@ -185,21 +185,24 @@ export function _isErrorLike(o: any): o is ErrorLike {
 
 /**
  * Convenience function to safely add properties to Error's `data` object
- * (even if it wasn't previously existing)
+ * (even if it wasn't previously existing).
+ * Mutates err.
+ * Returns err for convenience, so you can re-throw it directly.
  *
  * @example
  *
  * try {} catch (err) {
- *   _errorDataAppend(err, {
+ *   throw _errorDataAppend(err, {
  *     httpStatusCode: 401,
  *   })
  * }
  */
-export function _errorDataAppend(err: any, data?: ErrorData): void {
-  if (!data) return
-
-  err.data = {
-    ...err.data,
+export function _errorDataAppend<ERR>(err: ERR, data?: ErrorData): ERR {
+  if (!data) return err
+  ;(err as any).data = {
+    ...(err as any).data,
     ...data,
   }
+
+  return err
 }

package/src/index.ts

@@ -82,6 +82,7 @@ export * from './string/hash.util'
 export * from './env/buildInfo'
 export * from './form.util'
 export * from './semver'
+export * from './web'
 export * from './zod/zod.util'
 export * from './zod/zod.shared.schemas'
 import { z, ZodSchema, ZodError, ZodIssue } from 'zod'

package/src/promise/pRetry.ts

@@ -163,8 +163,7 @@ export async function pRetry<T>(
 
       if (attempt >= maxAttempts || (predicate && !predicate(err as Error, attempt, maxAttempts))) {
         // Give up
-        _errorDataAppend(err, opt.errorData)
-        throw err
+        throw _errorDataAppend(err, opt.errorData)
       }
 
       // Retry after delay

package/src/promise/pTimeout.ts

@@ -82,8 +82,7 @@ export async function pTimeout<T>(fn: AnyAsyncFunction<T>, opt: PTimeoutOptions)
         } catch (err: any) {
           // keep original stack
           err.stack = fakeError.stack!.replace('Error: TimeoutError', err.name + ': ' + err.message)
-          _errorDataAppend(err, opt.errorData)
-          reject(err)
+          reject(_errorDataAppend(err, opt.errorData))
         }
         return
       }

package/src/web.ts

@@ -0,0 +1,41 @@
+/// <reference lib="dom"/>
+
+import { StringMap } from './types'
+
+/**
+ * Implements WebStorage API by using in-memory storage.
+ * Can be useful in SSR environment or unit tests.
+ *
+ * @experimental
+ */
+export class InMemoryWebStorage implements Storage {
+  constructor(public data: StringMap = {}) {}
+
+  // Not implementing "free property access" now for simplicity,
+  // but can be implemented with Proxy
+  // [ name: string ]: any
+
+  getItem(key: string): string | null {
+    return this.data[key] ?? null
+  }
+
+  setItem(key: string, value: string): void {
+    this.data[key] = String(value)
+  }
+
+  removeItem(key: string): void {
+    delete this.data[key]
+  }
+
+  key(index: number): string | null {
+    return Object.keys(this.data)[index] ?? null
+  }
+
+  clear(): void {
+    this.data = {}
+  }
+
+  get length(): number {
+    return Object.keys(this.data).length
+  }
+}