@rimbu/common 2.0.0 → 2.0.2

package/dist/esm/range.d.mts

@@ -0,0 +1,35 @@
+/**
+ * A range definition for any type of (orderable) value.
+ * 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 (true) or exclusive (false).<br/>
+ * A Range of type T can have one of the following forms:<br/>
+ * <br/>
+ * - { end: T }<br/>
+ * - { end: [T, boolean] }<br/>
+ * - { start: T }<br/>
+ * - { start: T, end: T }<br/>
+ * - { start: T, end: [T, boolean] }<br/>
+ * - { start: [T, boolean] }<br/>
+ * - { start: [T, boolean], end: T }<br/>
+ * - { start: [T, boolean], end: [T, boolean] }<br/>
+ */
+export type Range<T> = {
+    start: T | [T, boolean];
+    end?: T | [T, boolean];
+    amount?: undefined;
+} | {
+    start?: T | [T, boolean];
+    end: T | [T, boolean];
+    amount?: undefined;
+};
+export declare namespace Range {
+    /**
+     * Simplifies a given `range` `Range` input for easier processing, by returning optional
+     * start and end ranges including whether they are inclusive or exclusive
+     * @param range - the `Range` to use
+     */
+    function getNormalizedRange<T>(range: Range<T>): {
+        start?: [T, boolean] | undefined;
+        end?: [T, boolean] | undefined;
+    };
+}

package/dist/esm/traverse-state.d.mts

@@ -0,0 +1,33 @@
+/**
+ * An object used to track the state of a traversal, e.g. a `forEach`.
+ */
+export interface TraverseState {
+    /**
+     * Returns true if the traversal has been halted by the user.
+     */
+    readonly halted: boolean;
+    /**
+     * Returns the current index of the traversal.
+     */
+    readonly currentIndex: number;
+    /**
+     * Increases the `currentIndex` of this traversal
+     * @returns the next index that the traversal should use
+     */
+    nextIndex(): number;
+    /**
+     * Sets the `halted` value to true.
+     */
+    halt(): void;
+    /**
+     * Sets the `halted` value to false, and resets the `currentIndex`
+     * value to its start value.
+     */
+    reset(): void;
+}
+/**
+ * Returns a new `TraverseState` instance, using optionally given `startIndex` as a start
+ * index value.
+ * @param startIndex - (default: 0) the start index to use
+ */
+export declare function TraverseState(startIndex?: number): TraverseState;

package/dist/esm/types.d.mts

@@ -0,0 +1,31 @@
+/**
+ * Accepts all types of T and U where T extends U,
+ * and result in the upper bound U.
+ */
+export type SuperOf<U, T> = T extends U ? U : never;
+/**
+ * Accepts all types of T and S where S extends T,
+ * and results in the lower bound S.
+ */
+export type SubOf<S, T> = S extends T ? S : never;
+/**
+ * Accepts all types of T and U where T extends U or U extends T.
+ */
+export type RelatedTo<T, U> = T | SuperOf<U, T>;
+/**
+ * Accepts all arrays with at least one element.
+ */
+export type ArrayNonEmpty<T> = [T, ...T[]];
+/**
+ * Accepts all strings with at least one character.
+ */
+export type StringNonEmpty<T> = T extends string ? '' extends T ? never : T : never;
+/**
+ * Utility type to convert some object to a JSON serializable format.
+ * @typeparam V - the `value` type
+ * @typeparam D - the `dataType` tag string type
+ */
+export interface ToJSON<V, D extends string = string> {
+    readonly dataType: D;
+    readonly value: V;
+}

package/dist/esm/update.d.mts

@@ -0,0 +1,18 @@
+/**
+ * A value of type T, or a function taking a value of type T and returning a new value of type T.
+ */
+export type Update<T> = T | ((value: T) => T);
+/**
+ * Returns the result of given `update` parameter, where it can either directly give a new value,
+ * or it is a function receiving the given `value`, and returns a new value.
+ * @param value - the current value
+ * @param update - an `Update` value, either a new value or a function receiving the old value
+ * and returning a new one.
+ * @example
+ * ```ts
+ * Update(1, 2)          // => 2
+ * Update(1, () => 10)   // => 10
+ * Update(1, v => v + 1) // => 2
+ * ```
+ */
+export declare function Update<T>(value: T, update: Update<T>): T;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rimbu/common",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "description": "Common types and objects used in many other Rimbu packages",
   "keywords": [
     "common",
@@ -31,14 +31,18 @@
   "type": "module",
   "main": "./dist/cjs/index.cjs",
   "module": "./dist/esm/index.mjs",
-  "types": "./dist/types/index.d.mts",
+  "types": "./dist/cjs/index.d.cts",
   "exports": {
     ".": {
-      "types": "./dist/types/index.d.mts",
       "bun": "./dist/bun/index.mts",
-      "import": "./dist/esm/index.mjs",
-      "require": "./dist/cjs/index.cjs",
-      "default": "./dist/esm/index.mjs"
+      "import": {
+        "types": "./dist/esm/index.d.mts",
+        "default": "./dist/esm/index.mjs"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.cts",
+        "default": "./dist/cjs/index.cjs"
+      }
     }
   },
   "files": [
@@ -46,19 +50,22 @@
     "src"
   ],
   "scripts": {
+    "b": "duel",
     "build": "yarn clean && yarn bundle",
     "build:deno": "yarn bundle:deno-prepare && yarn bundle:deno-convert && yarn bundle:deno-move && yarn bundle:deno-clean",
-    "bundle": "yarn bundle:cjs && yarn bundle:esm && yarn bundle:types && yarn bundle:bun",
-    "bundle:bun": "node ../../config/bunnify.mjs",
-    "bundle:cjs": "tsup src --format cjs --clean -d dist/cjs --loader '.mts=ts'",
+    "bundle": "yarn bundle:cjs && yarn bundle:esm && yarn bundle:bun",
+    "bundle:bun": "node ../../config/bunnify.mjs -mode bun",
+    "bundle:cjs": "yarn bundle:cjs-prepare && yarn bundle:cjs-build && yarn bundle:cjs-clean",
+    "bundle:cjs-prepare": "node ../../config/bunnify.mjs -mode cjs",
+    "bundle:cjs-build": "tsc -p tsconfig.cjs.json",
+    "bundle:cjs-clean": "rimraf _cjs_prepare",
     "bundle:deno-prepare": "node ../../config/prepare-denoify.mjs",
     "bundle:deno-convert": "denoify --src _deno_prepare/src",
     "bundle:deno-move": "rimraf ../../deno_dist/common && mv deno_dist ../../deno_dist/common",
     "bundle:deno-clean": "rimraf _deno_prepare",
     "bundle:esm": "tsc --p tsconfig.esm.json",
-    "bundle:types": "tsc --p tsconfig.types.json",
     "clean": "rimraf dist",
-    "extract-api": "ts-node ../../config/api-extractor.ts ./api-extractor.json",
+    "extract-api": "tsx ../../config/api-extractor.ts config/api-extractor.main.json",
     "format": "yarn format:base --write",
     "format:base": "prettier \"{!CHANGELOG.md}|**/**/*.{ts,tsx,js,mts,mjs,json,md}\"",
     "format:check": "yarn format:base --check",
@@ -75,5 +82,5 @@
   "dependencies": {
     "tslib": "^2.6.2"
   },
-  "gitHead": "d107c858cf84cb27544685cef981067f2fe1612d"
+  "gitHead": "f18ddf964507dbd10790da3cd4deef8f455a178e"
 }

package/src/err.mts

@@ -18,7 +18,7 @@ export namespace ErrBase {
   export abstract class CustomError {
     constructor(readonly message: string) {}
 
-    get name() {
+    get name(): string {
       return this.constructor.name;
     }
   }