@rimbu/common 1.1.0 → 2.0.1

package/dist/cjs/err.cjs

@@ -1,55 +1,62 @@
 "use strict";
-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/err.mts
-var err_exports = {};
-__export(err_exports, {
-  Err: () => Err,
-  ErrBase: () => ErrBase
-});
-module.exports = __toCommonJS(err_exports);
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ErrBase = exports.Err = void 0;
+var tslib_1 = require("tslib");
+/**
+ * Throws an `Err.ForcedError` error when called.
+ * @example
+ * ```ts
+ * const emptyMap = HashMap.empty<number, string>()
+ * emptyMap.get(5, Err);
+ * // throws: Err.CustomError(message: 'Err: forced to throw error')
+ * ```
+ */
 function Err() {
-  return ErrBase.msg("Err: Forced to throw error")();
+    return ErrBase.msg('Err: Forced to throw error')();
 }
+exports.Err = Err;
 var ErrBase;
-((ErrBase2) => {
-  class CustomError {
-    constructor(message) {
-      this.message = message;
+(function (ErrBase) {
+    /**
+     * A custom error instance.
+     */
+    var CustomError = /** @class */ (function () {
+        function CustomError(message) {
+            this.message = message;
+        }
+        Object.defineProperty(CustomError.prototype, "name", {
+            get: function () {
+                return this.constructor.name;
+            },
+            enumerable: false,
+            configurable: true
+        });
+        return CustomError;
+    }());
+    ErrBase.CustomError = CustomError;
+    var ForcedError = /** @class */ (function (_super) {
+        tslib_1.__extends(ForcedError, _super);
+        function ForcedError() {
+            return _super !== null && _super.apply(this, arguments) || this;
+        }
+        return ForcedError;
+    }(CustomError));
+    ErrBase.ForcedError = ForcedError;
+    /**
+     * Returns a function that, when called, throws an `Err.ForcedError` with the given `message` string.
+     * @param message - the message to put in the `Err.ForcedError` instance.
+     * @example
+     * ```ts
+     * const emptyMap = HashMap.empty<number, string>()
+     * emptyMap.get(5, ErrBase.msg('not found'));
+     * // throws: Err.CustomError(message: 'not found')
+     * ```
+     */
+    function msg(message) {
+        return function () {
+            throw new ErrBase.ForcedError(message);
+        };
     }
-    get name() {
-      return this.constructor.name;
-    }
-  }
-  ErrBase2.CustomError = CustomError;
-  class ForcedError extends CustomError {
-  }
-  ErrBase2.ForcedError = ForcedError;
-  function msg(message) {
-    return function() {
-      throw new ErrBase2.ForcedError(message);
-    };
-  }
-  ErrBase2.msg = msg;
-})(ErrBase || (ErrBase = {}));
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  Err,
-  ErrBase
-});
+    ErrBase.msg = msg;
+})(ErrBase || (exports.ErrBase = ErrBase = {}));
+//# sourceMappingURL=err.cjs.map

package/dist/cjs/err.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"err.cjs","sourceRoot":"","sources":["../../_cjs_prepare/err.cts"],"names":[],"mappings":";;;;AAAA;;;;;;;;GAQG;AACH,SAAgB,GAAG;IACjB,OAAO,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC,EAAE,CAAC;AACrD,CAAC;AAFD,kBAEC;AAED,IAAiB,OAAO,CA6BvB;AA7BD,WAAiB,OAAO;IACtB;;OAEG;IACH;QACE,qBAAqB,OAAe;YAAf,YAAO,GAAP,OAAO,CAAQ;QAAG,CAAC;QAExC,sBAAI,6BAAI;iBAAR;gBACE,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;YAC/B,CAAC;;;WAAA;QACH,kBAAC;IAAD,CAAC,AAND,IAMC;IANqB,mBAAW,cAMhC,CAAA;IAED;QAAiC,uCAAW;QAA5C;;QAA8C,CAAC;QAAD,kBAAC;IAAD,CAAC,AAA/C,CAAiC,WAAW,GAAG;IAAlC,mBAAW,cAAuB,CAAA;IAE/C;;;;;;;;;OASG;IACH,SAAgB,GAAG,CAAC,OAAe;QACjC,OAAO;YACL,MAAM,IAAI,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QACzC,CAAC,CAAC;IACJ,CAAC;IAJe,WAAG,MAIlB,CAAA;AACH,CAAC,EA7BgB,OAAO,uBAAP,OAAO,QA6BvB"}

package/dist/cjs/index-range.cjs

@@ -1,114 +1,110 @@
 "use strict";
-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/index-range.mts
-var index_range_exports = {};
-__export(index_range_exports, {
-  IndexRange: () => IndexRange
-});
-module.exports = __toCommonJS(index_range_exports);
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IndexRange = void 0;
+var tslib_1 = require("tslib");
 var IndexRange;
-((IndexRange2) => {
-  function getIndexRangeIndices(range) {
-    if (void 0 !== range.amount) {
-      if (void 0 === range.start)
-        return [0, range.amount - 1];
-      if (Array.isArray(range.start)) {
-        const [start2, includeStart] = range.start;
-        if (includeStart)
-          return [start2, start2 + range.amount - 1];
-        return [start2 + 1, start2 + 1 + range.amount - 1];
-      }
-      return [range.start, range.start + range.amount - 1];
-    }
-    let start = 0;
-    let end = void 0;
-    if (`start` in range) {
-      if (Array.isArray(range.start)) {
-        if (range.start[1])
-          start = range.start[0];
-        else
-          start = range.start[0] + 1;
-      } else
-        start = range.start ?? 0;
-    }
-    if (`end` in range) {
-      if (Array.isArray(range.end)) {
-        if (range.end[1])
-          end = range.end[0];
-        else
-          end = range.end[0] - 1;
-      } else
-        end = range.end;
-    }
-    return [start, end];
-  }
-  IndexRange2.getIndexRangeIndices = getIndexRangeIndices;
-  function getIndicesFor(range, length) {
-    if (length <= 0)
-      return "empty";
-    let start = 0;
-    let end = length - 1;
-    if (void 0 !== range.start) {
-      if (Array.isArray(range.start)) {
-        start = range.start[0];
-        if (!range.start[1])
-          start++;
-      } else
-        start = range.start;
-      if (start >= length || -start > length)
-        return "empty";
-      if (start < 0)
-        start = length + start;
+(function (IndexRange) {
+    /**
+     * Returns, given the `range` `IndexRange`, a normalized tuple containing the
+     * start index, and optionally an end index.
+     * @param range - the `IndexRange` to use
+     */
+    function getIndexRangeIndices(range) {
+        var _a;
+        if (undefined !== range.amount) {
+            if (undefined === range.start)
+                return [0, range.amount - 1];
+            if (Array.isArray(range.start)) {
+                var _b = tslib_1.__read(range.start, 2), start_1 = _b[0], includeStart = _b[1];
+                if (includeStart)
+                    return [start_1, start_1 + range.amount - 1];
+                return [start_1 + 1, start_1 + 1 + range.amount - 1];
+            }
+            return [range.start, range.start + range.amount - 1];
+        }
+        var start = 0;
+        var end = undefined;
+        if ("start" in range) {
+            if (Array.isArray(range.start)) {
+                if (range.start[1])
+                    start = range.start[0];
+                else
+                    start = range.start[0] + 1;
+            }
+            else
+                start = (_a = range.start) !== null && _a !== void 0 ? _a : 0;
+        }
+        if ("end" in range) {
+            if (Array.isArray(range.end)) {
+                if (range.end[1])
+                    end = range.end[0];
+                else
+                    end = range.end[0] - 1;
+            }
+            else
+                end = range.end;
+        }
+        return [start, end];
     }
-    if (void 0 !== range.amount) {
-      if (range.amount <= 0)
-        return "empty";
-      if (void 0 === range.start) {
-        if (range.amount >= length)
-          return "all";
-        return [0, Math.min(end, range.amount - 1)];
-      }
-      end = start + range.amount - 1;
-    } else if (void 0 !== range.end) {
-      if (Array.isArray(range.end)) {
-        end = range.end[0];
-        if (!range.end[1]) {
-          if (end === 0)
-            return "empty";
-          end--;
+    IndexRange.getIndexRangeIndices = getIndexRangeIndices;
+    /**
+     * Returns, given the `range` `IndexRange`, and a target maximum `length`, the actual index range.
+     * This can be one of three options:
+     * - 'empty': there are no elements within the range
+     * - 'all': all elements are within the range
+     * - [start: number, end: number]: an inclusive range of element indices within the given range
+     * @param range - the `IndexRange` to use
+     * @param length - the target maximum length
+     */
+    function getIndicesFor(range, length) {
+        if (length <= 0)
+            return 'empty';
+        var start = 0;
+        var end = length - 1;
+        if (undefined !== range.start) {
+            if (Array.isArray(range.start)) {
+                start = range.start[0];
+                if (!range.start[1])
+                    start++;
+            }
+            else
+                start = range.start;
+            if (start >= length || -start > length)
+                return 'empty';
+            if (start < 0)
+                start = length + start;
+        }
+        if (undefined !== range.amount) {
+            if (range.amount <= 0)
+                return 'empty';
+            if (undefined === range.start) {
+                if (range.amount >= length)
+                    return 'all';
+                return [0, Math.min(end, range.amount - 1)];
+            }
+            end = start + range.amount - 1;
+        }
+        else if (undefined !== range.end) {
+            if (Array.isArray(range.end)) {
+                end = range.end[0];
+                if (!range.end[1]) {
+                    if (end === 0)
+                        return 'empty';
+                    end--;
+                }
+            }
+            else
+                end = range.end;
+            if (end < 0)
+                end = length + end;
         }
-      } else
-        end = range.end;
-      if (end < 0)
-        end = length + end;
+        if (end < start)
+            return 'empty';
+        end = Math.min(length - 1, end);
+        if (start === 0 && end === length - 1)
+            return 'all';
+        return [start, end];
     }
-    if (end < start)
-      return "empty";
-    end = Math.min(length - 1, end);
-    if (start === 0 && end === length - 1)
-      return "all";
-    return [start, end];
-  }
-  IndexRange2.getIndicesFor = getIndicesFor;
-})(IndexRange || (IndexRange = {}));
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  IndexRange
-});
+    IndexRange.getIndicesFor = getIndicesFor;
+})(IndexRange || (exports.IndexRange = IndexRange = {}));
+//# sourceMappingURL=index-range.cjs.map

package/dist/cjs/index-range.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-range.cjs","sourceRoot":"","sources":["../../_cjs_prepare/index-range.cts"],"names":[],"mappings":";;;;AAwBA,IAAiB,UAAU,CA+F1B;AA/FD,WAAiB,UAAU;IACzB;;;;OAIG;IACH,SAAgB,oBAAoB,CAClC,KAAiB;;QAEjB,IAAI,SAAS,KAAK,KAAK,CAAC,MAAM,EAAE,CAAC;YAC/B,IAAI,SAAS,KAAK,KAAK,CAAC,KAAK;gBAAE,OAAO,CAAC,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YAE5D,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzB,IAAA,KAAA,eAAwB,KAAK,CAAC,KAAK,IAAA,EAAlC,OAAK,QAAA,EAAE,YAAY,QAAe,CAAC;gBAC1C,IAAI,YAAY;oBAAE,OAAO,CAAC,OAAK,EAAE,OAAK,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;gBAC3D,OAAO,CAAC,OAAK,GAAG,CAAC,EAAE,OAAK,GAAG,CAAC,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YACnD,CAAC;YACD,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QACvD,CAAC;QAED,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,IAAI,GAAG,GAAuB,SAAS,CAAC;QAExC,IAAI,OAAO,IAAI,KAAK,EAAE,CAAC;YACrB,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC/B,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;oBAAE,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;;oBACtC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;YAClC,CAAC;;gBAAM,KAAK,GAAG,MAAA,KAAK,CAAC,KAAK,mCAAI,CAAC,CAAC;QAClC,CAAC;QAED,IAAI,KAAK,IAAI,KAAK,EAAE,CAAC;YACnB,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC7B,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;oBAAE,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;;oBAChC,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;YAC9B,CAAC;;gBAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC;QACzB,CAAC;QAED,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACtB,CAAC;IAhCe,+BAAoB,uBAgCnC,CAAA;IAED;;;;;;;;OAQG;IACH,SAAgB,aAAa,CAC3B,KAAiB,EACjB,MAAc;QAEd,IAAI,MAAM,IAAI,CAAC;YAAE,OAAO,OAAO,CAAC;QAEhC,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,IAAI,GAAG,GAAG,MAAM,GAAG,CAAC,CAAC;QAErB,IAAI,SAAS,KAAK,KAAK,CAAC,KAAK,EAAE,CAAC;YAC9B,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC/B,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBACvB,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;oBAAE,KAAK,EAAE,CAAC;YAC/B,CAAC;;gBAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;YAE3B,IAAI,KAAK,IAAI,MAAM,IAAI,CAAC,KAAK,GAAG,MAAM;gBAAE,OAAO,OAAO,CAAC;YACvD,IAAI,KAAK,GAAG,CAAC;gBAAE,KAAK,GAAG,MAAM,GAAG,KAAK,CAAC;QACxC,CAAC;QAED,IAAI,SAAS,KAAK,KAAK,CAAC,MAAM,EAAE,CAAC;YAC/B,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC;gBAAE,OAAO,OAAO,CAAC;YACtC,IAAI,SAAS,KAAK,KAAK,CAAC,KAAK,EAAE,CAAC;gBAC9B,IAAI,KAAK,CAAC,MAAM,IAAI,MAAM;oBAAE,OAAO,KAAK,CAAC;gBACzC,OAAO,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;YAC9C,CAAC;YAED,GAAG,GAAG,KAAK,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;QACjC,CAAC;aAAM,IAAI,SAAS,KAAK,KAAK,CAAC,GAAG,EAAE,CAAC;YACnC,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC7B,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;gBACnB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;oBAClB,IAAI,GAAG,KAAK,CAAC;wBAAE,OAAO,OAAO,CAAC;oBAC9B,GAAG,EAAE,CAAC;gBACR,CAAC;YACH,CAAC;;gBAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC;YAEvB,IAAI,GAAG,GAAG,CAAC;gBAAE,GAAG,GAAG,MAAM,GAAG,GAAG,CAAC;QAClC,CAAC;QAED,IAAI,GAAG,GAAG,KAAK;YAAE,OAAO,OAAO,CAAC;QAChC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;QAEhC,IAAI,KAAK,KAAK,CAAC,IAAI,GAAG,KAAK,MAAM,GAAG,CAAC;YAAE,OAAO,KAAK,CAAC;QAEpD,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACtB,CAAC;IA7Ce,wBAAa,gBA6C5B,CAAA;AACH,CAAC,EA/FgB,UAAU,0BAAV,UAAU,QA+F1B"}

package/dist/cjs/index-range.d.cts

@@ -0,0 +1,42 @@
+import type { Range } from './internal.cjs';
+/**
+ * A flexible range specification for numeric indices.
+ * If a start or end is defined, a tuple can be used where the second item is a boolean
+ * indicating whether that end is inclusive or exclusive.<br/>
+ * An IndexRange can have one of the following forms:<br/>
+ * <br/>
+ * - { amount: number }<br/>
+ * - { start: number }<br/>
+ * - { start: number, amount: number }<br/>
+ * - { start: number, end: number }<br/>
+ * - { start: number, end: [number, boolean] }<br/>
+ * - { start: [number, boolean] }<br/>
+ * - { start: [number, boolean], amount: number }<br/>
+ * - { start: [number, boolean], end: number }<br/>
+ * - { start: [number, boolean], end: [number, boolean] }<br/>
+ * - { end: number }<br/>
+ * - { end: [number, boolean] }<br/>
+ */
+export type IndexRange = {
+    amount: number;
+    start?: number | [number, boolean];
+    end?: undefined;
+} | Range<number>;
+export declare namespace IndexRange {
+    /**
+     * Returns, given the `range` `IndexRange`, a normalized tuple containing the
+     * start index, and optionally an end index.
+     * @param range - the `IndexRange` to use
+     */
+    function getIndexRangeIndices(range: IndexRange): [number, number | undefined];
+    /**
+     * Returns, given the `range` `IndexRange`, and a target maximum `length`, the actual index range.
+     * This can be one of three options:
+     * - 'empty': there are no elements within the range
+     * - 'all': all elements are within the range
+     * - [start: number, end: number]: an inclusive range of element indices within the given range
+     * @param range - the `IndexRange` to use
+     * @param length - the target maximum length
+     */
+    function getIndicesFor(range: IndexRange, length: number): [number, number] | 'empty' | 'all';
+}