@rimbu/base 2.0.0 → 2.0.1

package/dist/esm/plain-object.d.mts

@@ -0,0 +1,62 @@
+/**
+ * Matches any type of function
+ */
+export type AnyFunc = (...args: any[]) => any;
+/**
+ * Gives true if the given type T is a function, false otherwise.
+ * @typeparam T - the input type
+ */
+export type IsAnyFunc<T> = AnyFunc extends T ? true : false;
+/**
+ * A predicate type for any record that resolves to true if any of the record
+ * properties is a function, false otherwise.
+ * This is useful to have a coarse discrimination between pure data objects and class instances.
+ * @typeparam T - the input type
+ */
+export type IsObjWithoutFunctions<T> = AnyFunc extends T[keyof T] ? false : true;
+/**
+ * A predicate type that resolves to true if the given type satisfies:
+ * - it is an object type (not a primitive)
+ * - it is not a function
+ * - it is not iterable
+ * - it does not have any properties that are functions
+ * Otherwise, it resolves to false
+ * @typeparam T - the input type
+ */
+export type IsPlainObj<T> = T extends null | undefined | number | string | boolean | bigint | symbol | AnyFunc | Iterable<any> | AsyncIterable<any> ? false : IsObjWithoutFunctions<T>;
+/**
+ * Utility type that will only accept objects that are considered 'plain objects' according
+ * to the `IsPlainObj` predicate type.
+ * @typeparam T - the value type to test
+ */
+export type PlainObj<T> = IsPlainObj<T> extends true ? T : never;
+/**
+ * Utility type that will only return true if the input type T is equal to `any`.
+ * @typeparam T - the value type to test
+ */
+export type IsAny<T> = 0 extends 1 & T ? true : false;
+/**
+ * Utility type that will only return true if the input type T is a (readonly) array.
+ * @typeparm T - the value type to test
+ */
+export type IsArray<T> = T extends readonly any[] ? true : false;
+/**
+ * Utility type to exclude any types that are iterable. Useful in cases where
+ * plain objects are required as inputs but not arrays.
+ */
+export type NotIterable = {
+    [Symbol.iterator]?: never;
+};
+/**
+ * Companion function to the `IsRecord<T>` type that checks whether the given object is a pure
+ * data object.
+ * @param obj - the object to check
+ * @returns true if the given object is a pure data object
+ * @note does not check whether a record's properties are not functions
+ */
+export declare function isPlainObj(obj: any): obj is object;
+/**
+ * Returns true if the given object is Iterable
+ * @param obj - the object to check
+ */
+export declare function isIterable(obj: any): obj is Iterable<unknown>;

package/dist/esm/rimbu-error.d.mts

@@ -0,0 +1,16 @@
+import { ErrBase } from '@rimbu/common';
+export declare class EmptyCollectionAssumedNonEmptyError extends ErrBase.CustomError {
+    constructor();
+}
+export declare class ModifiedBuilderWhileLoopingOverItError extends ErrBase.CustomError {
+    constructor();
+}
+export declare class InvalidStateError extends ErrBase.CustomError {
+    constructor();
+}
+export declare class InvalidUsageError extends ErrBase.CustomError {
+}
+export declare function throwEmptyCollectionAssumedNonEmptyError(): never;
+export declare function throwModifiedBuilderWhileLoopingOverItError(): never;
+export declare function throwInvalidStateError(): never;
+export declare function throwInvalidUsageError(msg: string): never;

package/dist/esm/token.d.mts

@@ -0,0 +1,2 @@
+export declare const Token: unique symbol;
+export type Token = typeof Token;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rimbu/base",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "Utilities to implement Rimbu collections",
   "keywords": [
     "array",
@@ -29,14 +29,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"
+      },
+      "bun": "./dist/bun/main/index.mts"
     }
   },
   "files": [
@@ -46,15 +50,17 @@
   "scripts": {
     "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/base && mv deno_dist ../../deno_dist/base",
     "bundle:deno-clean": "rimraf _deno_prepare",
     "bundle:esm": "tsc --p tsconfig.esm.json",
-    "bundle:types": "tsc --p tsconfig.types.json",
     "clean": "rimraf dist",
     "format": "yarn format:base --write",
     "format:base": "prettier \"{!CHANGELOG.md}|**/**/*.{ts,tsx,js,mts,mjs,json,md}\"",
@@ -67,10 +73,10 @@
     "typecheck": "tsc"
   },
   "dependencies": {
-    "@rimbu/common": "^2.0.0"
+    "@rimbu/common": "^2.0.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d107c858cf84cb27544685cef981067f2fe1612d"
+  "gitHead": "b7ed656d2c55d1a715d6a3f52e364e68cb98c759"
 }