safe-wrapper 2.0.0 → 2.1.0

package/README.md

@@ -1,22 +1,30 @@
 ## safe-wrapper
 
+[![npm version](https://img.shields.io/npm/v/safe-wrapper.svg)](https://www.npmjs.com/package/safe-wrapper)
+[![License](https://img.shields.io/npm/l/safe-wrapper.svg)](https://github.com/mcking-07/safe-wrapper/blob/main/LICENSE)
+[![Build Status](https://github.com/mcking-07/safe-wrapper/workflows/publish/badge.svg)](https://github.com/mcking-07/safe-wrapper/actions)
+[![npm downloads](https://img.shields.io/npm/dm/safe-wrapper.svg)](https://www.npmjs.com/package/safe-wrapper)
+
 safe-wrapper is a lightweight utility for javascript that simplifies error handling for both synchronous and asynchronous functions. inspired by the [safe assignment operator proposal](https://github.com/arthurfiorette/proposal-safe-assignment-operator), this utility allows for graceful error management by wrapping functions in a way that enables error handling without the need for explicit `try-catch` blocks.
 
-#### Features
+### Features
 
 - handles synchronous and asynchronous functions.
 - supports specifying error types to control which errors are caught and handled.
-- returns consistent responses in `[error, result]` format where error is null if no error occurred.
+- returns a consistent response in `[error, result]` format,
+  - `error`: null if successful, else an error (or transformed object).
+  - `result`: return value (sync) or resolved value (async) when successful, else null.
+- supports custom error transformation for advanced error handling.
 
-#### Installation
+### Installation
 
-```
+```sh
 npm install safe-wrapper
 ```
 
-#### Usage
+### Usage
 
-import `safe` from `safe-wrapper` to use it with any function. 
+import `safe` from `safe-wrapper` to use it with any function.
 
 the `safe` function takes a target function (synchronous or asynchronous) and returns a function which handles errors and returns a response in a consistent way. the function returns an array `[error, result]`, where `error` is an instance of the specified error type or `null` if successful, and `result` is the result of the function when there is no error.
 
@@ -86,6 +94,56 @@ const safeSync = safe(sync, [TypeError, RangeError]);
 const [error, result] = safeSync(args);
 ```
 
+#### using synchronous custom error transformer
+
+you can provide a custom error transformer function to modify how errors are handled:
+
+```javascript
+import { safe } from 'safe-wrapper';
+
+const transformer = (error) => ({
+  code: error.name,
+  message: error.message,
+  timestamp: new Date()
+});
+
+const safeWithTransform = safe(
+  () => { throw new Error('custom sync error'); },
+  [Error],
+  transformer
+);
+
+const [error, result] = safeWithTransform();
+// error will be: { code: 'Error', message: 'custom sync error', timestamp: Date }
+```
+
+#### using asynchronous custom error transformer
+
+you can provide an asynchronous custom error transformer to modify how errors are handled.
+
+```javascript
+import { safe } from 'safe-wrapper';
+
+const transformer = async (error) => {
+  await report(error);
+
+  return {
+    code: error.name,
+    message: error.message,
+    timestamp: new Date()
+  }
+}
+
+const safeWithTransform = safe(
+  async () => { throw new Error('custom async error'); },
+  [Error],
+  transformer
+);
+
+const [error, result] = await safeWithTransform();
+// error will be: { code: 'Error', message: 'custom async error', timestamp: Date }
+```
+
 #### wrapping built-in functions
 
 we can also wrap built-in functions, like `JSON.parse`, `Object.keys`, and more.
@@ -99,14 +157,14 @@ const [error, result] = safeJsonParse('invalid_json');
 const [error, result] = safe(Object.keys, [TypeError])(null);
 ```
 
-#### API Reference
+### API Reference
+
+`safe(action, types, transformer)`
 
-`safe(action, types)`
 - parameters
   - action (function): function to be wrapped. it can either be synchronous or asynchronous.
-  - types (array, optional): an array of error types to catch. if no types are specified, all errors are caught.
+  - types (array, optional): an array of error types to catch. if no types are specified, all errors are caught. each element must be a valid error constructor.
+  - transformer (function, optional): a function that takes an error object and returns a transformed version of it. if not provided, the original error is used.
 - returns `[error, result]`
-  - error (error | null): the error object if error occurred, otherwise null.
-  - result (any): the result of the action function if no error occurred, otherwise null.
-
-this structure keeps it concise, approachable, and clear for all levels of users.
+  - error (error | null): the error object if error occurred, otherwise null. if an transformer is provided, this will be the transformed error.
+  - result (result | null): the result of the action function if no error occurred, otherwise null.

package/lib/index.cjs

@@ -1 +1 @@
-"use strict";var o=Object.defineProperty;var l=Object.getOwnPropertyDescriptor;var a=Object.getOwnPropertyNames;var h=Object.prototype.hasOwnProperty;var f=(t,n)=>{for(var r in n)o(t,r,{get:n[r],enumerable:!0})},i=(t,n,r,e)=>{if(n&&typeof n=="object"||typeof n=="function")for(let c of a(n))!h.call(t,c)&&c!==r&&o(t,c,{get:()=>n[c],enumerable:!(e=l(n,c))||e.enumerable});return t};var b=t=>i(o({},"__esModule",{value:!0}),t);var m={};f(m,{safe:()=>g});module.exports=b(m);var s=({error:t=null,data:n=null,result:r=null})=>[t,r||n],u=(t,n=[])=>{if(!n.length||n.some(e=>t instanceof e))return s({error:t});throw t},g=(t,n=[])=>(...r)=>{try{let e=t(...r);return e instanceof Promise?e.then(c=>s({data:c})).catch(c=>u(c,n)):s({result:e})}catch(e){return u(e,n)}};
+"use strict";var f=Object.defineProperty;var d=Object.getOwnPropertyDescriptor;var a=Object.getOwnPropertyNames;var h=Object.prototype.hasOwnProperty;var l=(n,e)=>{for(var t in e)f(n,t,{get:e[t],enumerable:!0})},m=(n,e,t,o)=>{if(e&&typeof e=="object"||typeof e=="function")for(let c of a(e))!h.call(n,c)&&c!==t&&f(n,c,{get:()=>e[c],enumerable:!(o=d(e,c))||o.enumerable});return n};var p=n=>m(f({},"__esModule",{value:!0}),n);var y={};l(y,{safe:()=>g});module.exports=p(y);var r=({error:n=null,data:e=null,result:t=void 0})=>[n,t!==void 0?t:e],s=n=>n instanceof Promise||typeof n?.then=="function",b=n=>(...e)=>{try{let t=n(...e);return s(t)?t.then(o=>r({error:o})).catch(o=>r({error:o})):r({error:t})}catch(t){return r({error:t})}},i=(n,e=[],t=void 0)=>{let o=!e.length||e.some(u=>n instanceof u),c=t!==void 0&&typeof t=="function";if(o)return c?b(t)(n):r({error:n});throw n},g=(n,e=[],t=void 0)=>(...o)=>{try{let c=n(...o);return s(c)?c.then(u=>r({data:u})).catch(u=>i(u,e,t)):r({result:c})}catch(c){return i(c,e,t)}};

package/lib/index.d.ts

@@ -1,7 +1,13 @@
 /**
  * safely executes a synchronous or asynchronous action, handles any errors that occur and returns the result in a consistent response structure.
- * @param {Function} action - the function to be wrapped, which can either be synchronous or asynchronous.
- * @param {Array<ErrorConstructor>} [types = []] - an optional array of error types to check against.
- * @returns {Promise<[Error, null] | [null, any]> | [Error, null] | [null, any]} - a tuple where the first element is null, if the execution was successful, or an error object if an error occurred. the second element is the result of the action, if available.
+ *
+ * @template R,
+ * @template [T = Error]
+ *
+ * @param {(...args: any[]) => R} action - the function to be wrapped.
+ * @param {Array<ErrorConstructor>} [types = []] - an optional array of error types to catch.
+ * @param {(error: Error) => Promise<T> | T} [transformer] - an optional function to transform the error object.
+ *
+ * @returns {(...args: Parameters<typeof action>) => R extends Promise<infer U> ? Promise<[T, null] | [null, U]> : [T, null] | [null, R]} - a tuple where the first element is the error object, if available, or the transformed error object, if a transformer function is provided. the second element is the result of the action, if available.
  */
-export function safe(action: Function, types?: ErrorConstructor[] | undefined): Promise<[Error, null] | [null, any]> | [Error, null] | [null, any];
+export function safe<R, T = Error>(action: (...args: any[]) => R, types?: Array<ErrorConstructor>, transformer?: (error: Error) => Promise<T> | T): (...args: Parameters<typeof action>) => R extends Promise<infer U> ? Promise<[T, null] | [null, U]> : [T, null] | [null, R];

package/lib/index.mjs

@@ -1 +1 @@
-var o=({error:n=null,data:t=null,result:r=null})=>[n,r||t],s=(n,t=[])=>{if(!t.length||t.some(e=>n instanceof e))return o({error:n});throw n},u=(n,t=[])=>(...r)=>{try{let e=n(...r);return e instanceof Promise?e.then(c=>o({data:c})).catch(c=>s(c,t)):o({result:e})}catch(e){return s(e,t)}};export{u as safe};
+var r=({error:t=null,data:e=null,result:n=void 0})=>[t,n!==void 0?n:e],i=t=>t instanceof Promise||typeof t?.then=="function",s=t=>(...e)=>{try{let n=t(...e);return i(n)?n.then(c=>r({error:c})).catch(c=>r({error:c})):r({error:n})}catch(n){return r({error:n})}},f=(t,e=[],n=void 0)=>{let c=!e.length||e.some(u=>t instanceof u),o=n!==void 0&&typeof n=="function";if(c)return o?s(n)(t):r({error:t});throw t},d=(t,e=[],n=void 0)=>(...c)=>{try{let o=t(...c);return i(o)?o.then(u=>r({data:u})).catch(u=>f(u,e,n)):r({result:o})}catch(o){return f(o,e,n)}};export{d as safe};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "safe-wrapper",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "a js-util for safely wrapping synchronous and asynchronous functions to handle errors based on specified types.",
   "type": "module",
   "main": "lib/index.cjs",