@splendidlabz/utils 1.16.0 → 1.17.0

package/LICENSE.md

@@ -0,0 +1,95 @@
+Copyright (c) 2024-present Splendid Labz Pte. Ltd.
+
+Elastic License 2.0
+
+URL: https://www.elastic.co/licensing/elastic-license
+
+## Acceptance
+
+By using the software, you agree to all of the terms and conditions below.
+
+## Copyright License
+
+The licensor grants you a non-exclusive, royalty-free, worldwide,
+non-sublicensable, non-transferable license to use, copy, distribute, make
+available, and prepare derivative works of the software, in each case subject to
+the limitations and conditions below.
+
+## Limitations
+
+You may not provide the software to third parties as a hosted or managed
+service, where the service provides users with access to any substantial set of
+the features or functionality of the software.
+
+You may not move, change, disable, or circumvent the license key functionality
+in the software, and you may not remove or obscure any functionality in the
+software that is protected by the license key.
+
+You may not alter, remove, or obscure any licensing, copyright, or other notices
+of the licensor in the software. Any use of the licensor’s trademarks is subject
+to applicable law.
+
+## Patents
+
+The licensor grants you a license, under any patent claims the licensor can
+license, or becomes able to license, to make, have made, use, sell, offer for
+sale, import and have imported the software, in each case subject to the
+limitations and conditions in this license. This license does not cover any
+patent claims that you cause to be infringed by modifications or additions to
+the software. If you or your company make any written claim that the software
+infringes or contributes to infringement of any patent, your patent license for
+the software granted under these terms ends immediately. If your company makes
+such a claim, your patent license ends immediately for work on behalf of your
+company.
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of the software from you
+also gets a copy of these terms.
+
+If you modify the software, you must include in any modified copies of the
+software prominent notices stating that you have modified the software.
+
+## No Other Rights
+
+These terms do not imply any licenses other than those expressly granted in
+these terms.
+
+## Termination
+
+If you use the software in violation of these terms, such use is not licensed,
+and your licenses will automatically terminate. If the licensor provides you
+with a notice of your violation, and you cease all violation of this license no
+later than 30 days after you receive that notice, your licenses will be
+reinstated retroactively. However, if you violate these terms after such
+reinstatement, any additional violation of these terms will cause your licenses
+to terminate automatically and permanently.
+
+## No Liability
+
+_As far as the law allows, the software comes as is, without any warranty or
+condition, and the licensor will not be liable to you for any damages arising
+out of these terms or the use or nature of the software, under any kind of
+legal claim._
+
+## Definitions
+
+The **licensor** is the entity offering these terms, and the **software** is the
+software the licensor makes available under these terms, including any portion
+of it.
+
+**you** refers to the individual or entity agreeing to these terms.
+
+**your company** is any legal entity, sole proprietorship, or other kind of
+organization that you work for, plus all organizations that have control over,
+are under the control of, or are under common control with that
+organization. **control** means ownership of substantially all the assets of an
+entity, or the power to direct its management and policies by vote, contract, or
+otherwise. Control can be direct or indirect.
+
+**your licenses** are all the licenses granted to you for the software under
+these terms.
+
+**use** means anything you do with the software requiring one of your licenses.
+
+**trademark** means trademarks, service marks, and similar rights.

package/dist/cjs/lib/index.cjs

@@ -98,6 +98,7 @@ __export(lib_exports, {
   sanitizeObject: () => sanitizeObject,
   scatter: () => scatter,
   seededRandom: () => seededRandom,
+  settle: () => settle,
   shuffle: () => shuffle,
   singular: () => singular,
   sizeOf: () => sizeOf,
@@ -1097,6 +1098,35 @@ function reject(props, { includeStack = true } = {}) {
   return Promise.reject(omitEmpty(err));
 }
 
+// src/lib/promises/settle.js
+async function settle(promise) {
+  try {
+    return toSettled(await promise, null);
+  } catch (error) {
+    return toSettled(null, error);
+  }
+}
+function toSettled(result, error) {
+  const settled = Object.defineProperties(
+    { result, error },
+    {
+      r: { value: result },
+      e: { value: error },
+      [Symbol.iterator]: {
+        value: function* () {
+          yield result;
+          yield error;
+        }
+      }
+    }
+  );
+  return (
+    /** @type {Settled<T>} */
+    /** @type {unknown} */
+    settled
+  );
+}
+
 // src/lib/sse.js
 function createSSE({ event, data, id, retry }) {
   const eventString = event ? `event: ${event}
@@ -1791,6 +1821,7 @@ function getSymbolValue(object, description) {
   sanitizeObject,
   scatter,
   seededRandom,
+  settle,
   shuffle,
   singular,
   sizeOf,

package/dist/cjs/lib/promises/index.cjs

@@ -19,7 +19,8 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/lib/promises/index.js
 var promises_exports = {};
 __export(promises_exports, {
-  reject: () => reject
+  reject: () => reject,
+  settle: () => settle
 });
 module.exports = __toCommonJS(promises_exports);
 
@@ -139,7 +140,37 @@ function reject(props, { includeStack = true } = {}) {
   };
   return Promise.reject(omitEmpty(err));
 }
+
+// src/lib/promises/settle.js
+async function settle(promise) {
+  try {
+    return toSettled(await promise, null);
+  } catch (error) {
+    return toSettled(null, error);
+  }
+}
+function toSettled(result, error) {
+  const settled = Object.defineProperties(
+    { result, error },
+    {
+      r: { value: result },
+      e: { value: error },
+      [Symbol.iterator]: {
+        value: function* () {
+          yield result;
+          yield error;
+        }
+      }
+    }
+  );
+  return (
+    /** @type {Settled<T>} */
+    /** @type {unknown} */
+    settled
+  );
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  reject
+  reject,
+  settle
 });

package/dist/cjs/lib/promises/settle.cjs

@@ -0,0 +1,55 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/lib/promises/settle.js
+var settle_exports = {};
+__export(settle_exports, {
+  settle: () => settle
+});
+module.exports = __toCommonJS(settle_exports);
+async function settle(promise) {
+  try {
+    return toSettled(await promise, null);
+  } catch (error) {
+    return toSettled(null, error);
+  }
+}
+function toSettled(result, error) {
+  const settled = Object.defineProperties(
+    { result, error },
+    {
+      r: { value: result },
+      e: { value: error },
+      [Symbol.iterator]: {
+        value: function* () {
+          yield result;
+          yield error;
+        }
+      }
+    }
+  );
+  return (
+    /** @type {Settled<T>} */
+    /** @type {unknown} */
+    settled
+  );
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  settle
+});

package/dist/esm/lib/promises/index.js

@@ -1 +1,2 @@
 export * from "./reject.js";
+export * from "./settle.js";

package/dist/esm/lib/promises/settle.js

@@ -0,0 +1,30 @@
+async function settle(promise) {
+  try {
+    return toSettled(await promise, null);
+  } catch (error) {
+    return toSettled(null, error);
+  }
+}
+function toSettled(result, error) {
+  const settled = Object.defineProperties(
+    { result, error },
+    {
+      r: { value: result },
+      e: { value: error },
+      [Symbol.iterator]: {
+        value: function* () {
+          yield result;
+          yield error;
+        }
+      }
+    }
+  );
+  return (
+    /** @type {Settled<T>} */
+    /** @type {unknown} */
+    settled
+  );
+}
+export {
+  settle
+};

package/dist/types/lib/index.d.cts

@@ -38,6 +38,7 @@ export { sizeOf } from './objects/size.cjs';
 export { splitObject } from './objects/split.cjs';
 export { trimValues } from './objects/trim-values.cjs';
 export { reject } from './promises/reject.cjs';
+export { Settled, settle } from './promises/settle.cjs';
 export { createSSE, parseSSE } from './sse.cjs';
 export { toCamel, toKebab, toLower, toPascal, toSentence, toSlug, toTitle, toUpper } from './strings/convert-case/convert-case.cjs';
 export { markdown, treatMarkdownWhitespace } from './strings/markdown.cjs';

package/dist/types/lib/promises/index.d.cts

@@ -1 +1,2 @@
 export { reject } from './reject.cjs';
+export { Settled, settle } from './settle.cjs';

package/dist/types/lib/promises/settle.d.cts

@@ -0,0 +1,21 @@
+/**
+ * @template T
+ * @typedef {{ result: T | null, error: unknown, r: T | null, e: unknown } & [T | null, unknown]} Settled
+ */
+/**
+ * settle
+ * Awaits a promise and returns its error instead of throwing.
+ *
+ * @template T
+ * @param {Promise<T>} promise
+ * @returns {Promise<Settled<T>>}
+ */
+declare function settle<T>(promise: Promise<T>): Promise<Settled<T>>;
+type Settled<T> = {
+    result: T | null;
+    error: unknown;
+    r: T | null;
+    e: unknown;
+} & [T | null, unknown];
+
+export { type Settled, settle };

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@splendidlabz/utils",
-  "version": "1.16.0",
+  "version": "1.17.0",
   "description": "",
+  "license": "Elastic-2.0",
   "type": "module",
   "homepage": "https://splendidlabz.com/docs/utils",
   "sideEffects": false,
@@ -67,7 +68,7 @@
     "sanitize-html": "^2.17.3"
   },
   "devDependencies": {
-    "@splendidlabz/eslint-config": "2.1.6",
+    "@splendidlabz/eslint-config": "2.2.0",
     "np": "^11.1.0",
     "tsup": "^8.5.1",
     "typescript": "^6.0.3",