@thi.ng/random 3.8.5 → 4.0.1

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-07-19T14:56:21Z
+- **Last updated**: 2024-07-22T14:42:28Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,16 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+# [4.0.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/random@4.0.0) (2024-07-22)
+
+#### 🛑 Breaking changes
+
+- migrate/remove UUID functions ([#486](https://github.com/thi-ng/umbrella/issues/486)) ([2ec753e](https://github.com/thi-ng/umbrella/commit/2ec753e))
+- BREAKING CHANGE: migrate UUID functions to [@thi.ng/uuid](https://github.com/thi-ng/umbrella/tree/main/packages/uuid) pkg
+  - remove obsolete files
+  - update deps/pkg
+  - update readme
+
 ## [3.8.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/random@3.8.0) (2024-05-08)
 
 #### 🚀 Features

package/README.md

@@ -7,7 +7,7 @@
 [![Mastodon Follow](https://img.shields.io/mastodon/follow/109331703950160316?domain=https%3A%2F%2Fmastodon.thi.ng&style=social)](https://mastodon.thi.ng/@toxi)
 
 > [!NOTE]
-> This is one of 189 standalone projects, maintained as part
+> This is one of 198 standalone projects, maintained as part
 > of the [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo
 > and anti-framework.
 >
@@ -31,6 +31,12 @@
 
 Pseudo-random number generators w/ unified API, distributions, weighted choices, ID generation.
 
+> [!IMPORTANT]
+> In July 2024 this package was restructured and split-up to extract some
+> features into smaller more focused packages:
+>
+> - [@thi.ng/uuid](https://thi.ng/uuid)
+
 This package provides the `IRandom` interface and various (mostly seedable)
 pseudo-random number generator implementations, incl. `IRandom` wrappers for
 `Math.random()` and `window.crypto`:
@@ -62,7 +68,6 @@ Partially ported from C implementations taken from [c.thi.ng](http://c.thi.ng).
 - [`randomID()`](https://github.com/thi-ng/umbrella/tree/develop/packages/random/src/random-id.ts)
 - [`weightedRandom()` / `weightedRandomKey()`](https://github.com/thi-ng/umbrella/tree/develop/packages/random/src/weighted-random.ts)
 - [`uniqueIndices()` / `uniqueValuesFrom()`](https://github.com/thi-ng/umbrella/tree/develop/packages/random/src/unique-indices.ts)
-- [`uuidv4Bytes()` / `uuid()`](https://github.com/thi-ng/umbrella/tree/develop/packages/random/src/uuid.ts)
 
 ## Status
 
@@ -104,14 +109,14 @@ For Node.js REPL:
 const rnd = await import("@thi.ng/random");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 2.02 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 1.92 KB
 
 ## Dependencies
 
 - [@thi.ng/api](https://github.com/thi-ng/umbrella/tree/develop/packages/api)
-- [@thi.ng/checks](https://github.com/thi-ng/umbrella/tree/develop/packages/checks)
 - [@thi.ng/errors](https://github.com/thi-ng/umbrella/tree/develop/packages/errors)
-- [@thi.ng/hex](https://github.com/thi-ng/umbrella/tree/develop/packages/hex)
+
+Note: @thi.ng/api is in _most_ cases a type-only import (not used at runtime)
 
 ## Usage examples
 

package/crypto.d.ts

@@ -2,8 +2,8 @@ import type { IBuffered, ICopy } from "@thi.ng/api";
 import { ARandom } from "./arandom.js";
 /**
  * Currently browser only, a `window.crypto` backed {@link IRandom}
- * implementation. Random values are buffered to minimize overhead. Buffer size
- * is configurable via ctor.
+ * implementation. Random values are repeatedly buffered to minimize overhead.
+ * Buffer size is configurable via ctor.
  *
  * @remarks
  * Internally uses {@link randomBytes} to source values, which falls back to

package/index.d.ts

@@ -14,7 +14,6 @@ export * from "./sfc32.js";
 export * from "./smush32.js";
 export * from "./system.js";
 export * from "./unique-indices.js";
-export * from "./uuid.js";
 export * from "./weighted-probability.js";
 export * from "./weighted-random.js";
 export * from "./xorshift128.js";

package/index.js

@@ -14,7 +14,6 @@ export * from "./sfc32.js";
 export * from "./smush32.js";
 export * from "./system.js";
 export * from "./unique-indices.js";
-export * from "./uuid.js";
 export * from "./weighted-probability.js";
 export * from "./weighted-random.js";
 export * from "./xorshift128.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/random",
-  "version": "3.8.5",
+  "version": "4.0.1",
   "description": "Pseudo-random number generators w/ unified API, distributions, weighted choices, ID generation",
   "type": "module",
   "module": "./index.js",
@@ -36,10 +36,8 @@
     "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.11.6",
-    "@thi.ng/checks": "^3.6.8",
-    "@thi.ng/errors": "^2.5.12",
-    "@thi.ng/hex": "^2.3.50"
+    "@thi.ng/api": "^8.11.7",
+    "@thi.ng/errors": "^2.5.13"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.47.0",
@@ -62,7 +60,6 @@
     "typedarray",
     "typescript",
     "weighted",
-    "uuid",
     "uniform"
   ],
   "publishConfig": {
@@ -131,9 +128,6 @@
     "./unique-indices": {
       "default": "./unique-indices.js"
     },
-    "./uuid": {
-      "default": "./uuid.js"
-    },
     "./weighted-probability": {
       "default": "./weighted-probability.js"
     },
@@ -160,5 +154,5 @@
       "ksuid"
     ]
   },
-  "gitHead": "c7aaa453b01a45e5235517db9d2a283b97abac96\n"
+  "gitHead": "bd22b0826134b79064169371665b4d6caa9b6066\n"
 }

package/random-bytes.js

@@ -1,4 +1,3 @@
-import { hasCrypto } from "@thi.ng/checks/has-crypto";
 import { SYSTEM } from "./system.js";
 const randomBytesFrom = (rnd, buf, start = 0, end = buf.length) => {
   for (let i = start; i < end; i++) {
@@ -6,7 +5,7 @@ const randomBytesFrom = (rnd, buf, start = 0, end = buf.length) => {
   }
   return buf;
 };
-const randomBytes = hasCrypto() ? (buf, start = 0, end = buf.length) => (window.crypto.getRandomValues(buf.subarray(start, end)), buf) : (buf, start, end) => randomBytesFrom(SYSTEM, buf, start, end);
+const randomBytes = typeof window !== "undefined" && window["crypto"] !== void 0 ? (buf, start = 0, end = buf.length) => (window.crypto.getRandomValues(buf.subarray(start, end)), buf) : (buf, start, end) => randomBytesFrom(SYSTEM, buf, start, end);
 export {
   randomBytes,
   randomBytesFrom

package/uuid.d.ts

@@ -1,19 +0,0 @@
-import type { IRandom } from "./api.js";
-/**
- * Depending on if `rnd` is given, uses {@link randomBytesFrom} or
- * {@link randomBytes} to fill given (optional) byte array with a new UUIDv4.
- * Creates new Uint8Array if none given.
- *
- * @param buf -
- * @param rnd -
- */
-export declare const uuidv4Bytes: (buf?: Uint8Array, rnd?: IRandom) => Uint8Array;
-/**
- * Returns a UUID string, either from given byte array, or if omitted, using a
- * new UUID v4 produced by {@link uuidv4Bytes}.
- *
- * @param id - byte array
- * @param i - start index
- */
-export declare const uuid: (id?: ArrayLike<number>, i?: number) => string;
-//# sourceMappingURL=uuid.d.ts.map

package/uuid.js

@@ -1,15 +0,0 @@
-import { uuid as $uuid } from "@thi.ng/hex";
-import { randomBytes, randomBytesFrom } from "./random-bytes.js";
-const uuidv4Bytes = (buf, rnd) => {
-  buf = buf || new Uint8Array(16);
-  buf = rnd ? randomBytesFrom(rnd, buf) : randomBytes(buf);
-  buf[6] = 64 | buf[6] & 15;
-  buf[8] = 128 | buf[8] & 63;
-  return buf;
-};
-const __buf = new Uint8Array(16);
-const uuid = (id, i = 0) => $uuid(id || uuidv4Bytes(__buf), i);
-export {
-  uuid,
-  uuidv4Bytes
-};