@thi.ng/ksuid 3.2.19 → 3.2.21

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2023-12-09T19:12:03Z
+- **Last updated**: 2023-12-18T13:41:19Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/README.md

@@ -112,7 +112,7 @@ For Node.js REPL:
 const ksuid = await import("@thi.ng/ksuid");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 1000 bytes
+Package sizes (brotli'd, pre-treeshake): ESM: 997 bytes
 
 ## Dependencies
 

package/aksuid.js

@@ -2,68 +2,63 @@ import { BASE62 } from "@thi.ng/base-n/62";
 import { assert } from "@thi.ng/errors/assert";
 import { randomBytes, randomBytesFrom } from "@thi.ng/random/random-bytes";
 import { padLeft } from "@thi.ng/strings/pad-left";
-/**
- * Abstract base class for both 32 & 64bit implementations. See {@link KSUID}
- * and {@link KSUID64}.
- */
-export class AKSUID {
-    epochSize;
-    size;
-    encodedSize;
-    base;
-    epoch;
-    tmp;
-    rnd;
-    pad;
-    constructor(epochSize, opts) {
-        this.epochSize = epochSize;
-        this.base = opts.base || BASE62;
-        this.rnd = opts.rnd;
-        this.epoch = opts.epoch;
-        this.size = this.epochSize + opts.bytes;
-        this.encodedSize = this.base.size(2 ** (this.size * 8) - 1);
-        this.pad = padLeft(this.encodedSize, this.base.base[0]);
-        this.tmp = new Uint8Array(this.size);
-    }
-    next() {
-        return this.format(this.nextBinary(this.tmp));
-    }
-    nextBinary(buf) {
-        buf = this.timeOnlyBinary(undefined, buf);
-        return this.rnd
-            ? randomBytesFrom(this.rnd, buf, this.epochSize)
-            : randomBytes(buf, this.epochSize);
-    }
-    timeOnly(epoch) {
-        return this.format(this.timeOnlyBinary(epoch, this.tmp.fill(0, this.epochSize)));
-    }
-    fromEpoch(epoch) {
-        return this.format(this.fromEpochBinary(epoch, this.tmp));
-    }
-    fromEpochBinary(epoch, buf) {
-        buf = this.timeOnlyBinary(epoch, buf);
-        return this.rnd
-            ? randomBytesFrom(this.rnd, buf, this.epochSize)
-            : randomBytes(buf, this.epochSize);
-    }
-    format(buf) {
-        this.ensureSize(buf);
-        return this.pad(this.base.encodeBytes(buf));
-    }
-    ensureSize(buf) {
-        assert(buf.length == this.size, `illegal KSUID size, expected ${this.size} bytes`);
-        return buf;
-    }
-    ensureTime(t, max) {
-        assert(t >= 0, "configured base epoch must be in the past");
-        max && assert(t <= max, `given epoch is out of range ([0...${max}])`);
-        return t;
-    }
-    u32(buf, i = 0) {
-        return (((buf[i] << 24) |
-            (buf[i + 1] << 16) |
-            (buf[i + 2] << 8) |
-            buf[i + 3]) >>>
-            0);
-    }
+class AKSUID {
+  constructor(epochSize, opts) {
+    this.epochSize = epochSize;
+    this.base = opts.base || BASE62;
+    this.rnd = opts.rnd;
+    this.epoch = opts.epoch;
+    this.size = this.epochSize + opts.bytes;
+    this.encodedSize = this.base.size(2 ** (this.size * 8) - 1);
+    this.pad = padLeft(this.encodedSize, this.base.base[0]);
+    this.tmp = new Uint8Array(this.size);
+  }
+  size;
+  encodedSize;
+  base;
+  epoch;
+  tmp;
+  rnd;
+  pad;
+  next() {
+    return this.format(this.nextBinary(this.tmp));
+  }
+  nextBinary(buf) {
+    buf = this.timeOnlyBinary(void 0, buf);
+    return this.rnd ? randomBytesFrom(this.rnd, buf, this.epochSize) : randomBytes(buf, this.epochSize);
+  }
+  timeOnly(epoch) {
+    return this.format(
+      this.timeOnlyBinary(epoch, this.tmp.fill(0, this.epochSize))
+    );
+  }
+  fromEpoch(epoch) {
+    return this.format(this.fromEpochBinary(epoch, this.tmp));
+  }
+  fromEpochBinary(epoch, buf) {
+    buf = this.timeOnlyBinary(epoch, buf);
+    return this.rnd ? randomBytesFrom(this.rnd, buf, this.epochSize) : randomBytes(buf, this.epochSize);
+  }
+  format(buf) {
+    this.ensureSize(buf);
+    return this.pad(this.base.encodeBytes(buf));
+  }
+  ensureSize(buf) {
+    assert(
+      buf.length == this.size,
+      `illegal KSUID size, expected ${this.size} bytes`
+    );
+    return buf;
+  }
+  ensureTime(t, max) {
+    assert(t >= 0, "configured base epoch must be in the past");
+    max && assert(t <= max, `given epoch is out of range ([0...${max}])`);
+    return t;
+  }
+  u32(buf, i = 0) {
+    return (buf[i] << 24 | buf[i + 1] << 16 | buf[i + 2] << 8 | buf[i + 3]) >>> 0;
+  }
 }
+export {
+  AKSUID
+};

package/api.js

@@ -1 +0,0 @@
-export {};

package/ksuid32.js

@@ -1,35 +1,33 @@
 import { AKSUID } from "./aksuid.js";
 const MAX_EPOCH = -1 >>> 0;
-export class KSUID32 extends AKSUID {
-    constructor(opts) {
-        super(4, {
-            epoch: 1600000000000,
-            bytes: 16,
-            ...opts,
-        });
-    }
-    timeOnlyBinary(epoch = Date.now(), buf) {
-        buf = buf || new Uint8Array(this.size);
-        const t = this.ensureTime((epoch - this.epoch) / 1000, MAX_EPOCH) >>> 0;
-        buf[0] = t >>> 24;
-        buf[1] = (t >> 16) & 0xff;
-        buf[2] = (t >> 8) & 0xff;
-        buf[3] = t & 0xff;
-        return buf;
-    }
-    parse(id) {
-        const buf = this.tmp;
-        this.base.decodeBytes(id, buf);
-        return {
-            epoch: this.u32(buf) * 1000 + this.epoch,
-            id: buf.slice(4),
-        };
-    }
+class KSUID32 extends AKSUID {
+  constructor(opts) {
+    super(4, {
+      epoch: 16e11,
+      bytes: 16,
+      ...opts
+    });
+  }
+  timeOnlyBinary(epoch = Date.now(), buf) {
+    buf = buf || new Uint8Array(this.size);
+    const t = this.ensureTime((epoch - this.epoch) / 1e3, MAX_EPOCH) >>> 0;
+    buf[0] = t >>> 24;
+    buf[1] = t >> 16 & 255;
+    buf[2] = t >> 8 & 255;
+    buf[3] = t & 255;
+    return buf;
+  }
+  parse(id) {
+    const buf = this.tmp;
+    this.base.decodeBytes(id, buf);
+    return {
+      epoch: this.u32(buf) * 1e3 + this.epoch,
+      id: buf.slice(4)
+    };
+  }
 }
-/**
- * Creates and returns a new 32bit epoch KSUID generator instance (w/ second
- * time precision).
- *
- * @param opts -
- */
-export const defKSUID32 = (opts) => new KSUID32(opts);
+const defKSUID32 = (opts) => new KSUID32(opts);
+export {
+  KSUID32,
+  defKSUID32
+};

package/ksuid64.js

@@ -1,40 +1,38 @@
 import { AKSUID } from "./aksuid.js";
-export class KSUID64 extends AKSUID {
-    constructor(opts) {
-        super(8, {
-            epoch: 1600000000000,
-            bytes: 12,
-            ...opts,
-        });
-    }
-    timeOnlyBinary(epoch = Date.now(), buf) {
-        buf = buf || new Uint8Array(this.size);
-        const t = this.ensureTime(epoch - this.epoch);
-        const h = (t / 4294967296) >>> 0;
-        const l = (t & 4294967295) >>> 0;
-        buf[0] = h >>> 24;
-        buf[1] = (h >> 16) & 0xff;
-        buf[2] = (h >> 8) & 0xff;
-        buf[3] = h & 0xff;
-        buf[4] = l >>> 24;
-        buf[5] = (l >> 16) & 0xff;
-        buf[6] = (l >> 8) & 0xff;
-        buf[7] = l & 0xff;
-        return buf;
-    }
-    parse(id) {
-        const buf = this.tmp;
-        this.base.decodeBytes(id, buf);
-        return {
-            epoch: this.u32(buf) * 4294967296 + this.u32(buf, 4) + this.epoch,
-            id: buf.slice(8),
-        };
-    }
+class KSUID64 extends AKSUID {
+  constructor(opts) {
+    super(8, {
+      epoch: 16e11,
+      bytes: 12,
+      ...opts
+    });
+  }
+  timeOnlyBinary(epoch = Date.now(), buf) {
+    buf = buf || new Uint8Array(this.size);
+    const t = this.ensureTime(epoch - this.epoch);
+    const h = t / 4294967296 >>> 0;
+    const l = (t & 4294967295) >>> 0;
+    buf[0] = h >>> 24;
+    buf[1] = h >> 16 & 255;
+    buf[2] = h >> 8 & 255;
+    buf[3] = h & 255;
+    buf[4] = l >>> 24;
+    buf[5] = l >> 16 & 255;
+    buf[6] = l >> 8 & 255;
+    buf[7] = l & 255;
+    return buf;
+  }
+  parse(id) {
+    const buf = this.tmp;
+    this.base.decodeBytes(id, buf);
+    return {
+      epoch: this.u32(buf) * 4294967296 + this.u32(buf, 4) + this.epoch,
+      id: buf.slice(8)
+    };
+  }
 }
-/**
- * Creates and returns a new 64bit epoch KSUID generator instance (w/
- * millisecond time precision).
- *
- * @param opts -
- */
-export const defKSUID64 = (opts) => new KSUID64(opts);
+const defKSUID64 = (opts) => new KSUID64(opts);
+export {
+  KSUID64,
+  defKSUID64
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/ksuid",
-  "version": "3.2.19",
+  "version": "3.2.21",
   "description": "Configurable K-sortable unique IDs, ULIDs, binary & base-N encoded, 32/48/64bit time resolutions",
   "type": "module",
   "module": "./index.js",
@@ -25,8 +25,10 @@
   "author": "Karsten Schmidt (https://thi.ng)",
   "license": "Apache-2.0",
   "scripts": {
-    "bench": "tools:node-esm bench/index.ts",
-    "build": "yarn clean && tsc --declaration",
+    "bench": "bun bench/index.ts",
+    "build": "yarn build:esbuild && yarn build:decl",
+    "build:decl": "tsc --declaration --emitDeclarationOnly",
+    "build:esbuild": "esbuild --format=esm --platform=neutral --target=es2022 --tsconfig=tsconfig.json --outdir=. src/**/*.ts",
     "clean": "rimraf --glob '*.js' '*.d.ts' '*.map' doc",
     "doc": "typedoc --excludePrivate --excludeInternal --out doc src/index.ts",
     "doc:ae": "mkdir -p .ae/doc .ae/temp && api-extractor run --local --verbose",
@@ -35,13 +37,14 @@
     "test": "bun test"
   },
   "dependencies": {
-    "@thi.ng/base-n": "^2.5.19",
-    "@thi.ng/errors": "^2.4.5",
-    "@thi.ng/random": "^3.6.17",
-    "@thi.ng/strings": "^3.7.2"
+    "@thi.ng/base-n": "^2.5.21",
+    "@thi.ng/errors": "^2.4.7",
+    "@thi.ng/random": "^3.6.19",
+    "@thi.ng/strings": "^3.7.4"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.38.3",
+    "esbuild": "^0.19.8",
     "rimraf": "^5.0.5",
     "tools": "^0.0.1",
     "typedoc": "^0.25.4",
@@ -73,7 +76,7 @@
     "access": "public"
   },
   "engines": {
-    "node": ">=12.7"
+    "node": ">=18"
   },
   "files": [
     "./*.js",
@@ -112,5 +115,5 @@
     "status": "stable",
     "year": 2020
   },
-  "gitHead": "25f2ac8ff795a432a930119661b364d4d93b59a0\n"
+  "gitHead": "25a42a81fac8603a1e440a7aa8bc343276211ff4\n"
 }

package/ulid.js

@@ -1,47 +1,40 @@
 import { BASE32_CROCKFORD } from "@thi.ng/base-n/32";
 import { AKSUID } from "./aksuid.js";
-export class ULID extends AKSUID {
-    constructor(opts) {
-        super(6, {
-            epoch: 0,
-            bytes: 10,
-            base: BASE32_CROCKFORD,
-            ...opts,
-        });
-    }
-    timeOnlyBinary(epoch = Date.now()) {
-        const buf = new Uint8Array(this.size);
-        const t = this.ensureTime(epoch - this.epoch);
-        const h = (t / 4294967296) >>> 0;
-        const l = (t & 4294967295) >>> 0;
-        buf.set([
-            (h >> 8) & 0xff,
-            h & 0xff,
-            l >>> 24,
-            (l >> 16) & 0xff,
-            (l >> 8) & 0xff,
-            l & 0xff,
-        ]);
-        return buf;
-    }
-    parse(id) {
-        const buf = new Uint8Array(this.size);
-        this.base.decodeBytes(id, buf);
-        return {
-            epoch: ((buf[0] << 8) | buf[1]) * 4294967296 +
-                this.u32(buf, 2) +
-                this.epoch,
-            id: buf.slice(6),
-        };
-    }
+class ULID extends AKSUID {
+  constructor(opts) {
+    super(6, {
+      epoch: 0,
+      bytes: 10,
+      base: BASE32_CROCKFORD,
+      ...opts
+    });
+  }
+  timeOnlyBinary(epoch = Date.now()) {
+    const buf = new Uint8Array(this.size);
+    const t = this.ensureTime(epoch - this.epoch);
+    const h = t / 4294967296 >>> 0;
+    const l = (t & 4294967295) >>> 0;
+    buf.set([
+      h >> 8 & 255,
+      h & 255,
+      l >>> 24,
+      l >> 16 & 255,
+      l >> 8 & 255,
+      l & 255
+    ]);
+    return buf;
+  }
+  parse(id) {
+    const buf = new Uint8Array(this.size);
+    this.base.decodeBytes(id, buf);
+    return {
+      epoch: (buf[0] << 8 | buf[1]) * 4294967296 + this.u32(buf, 2) + this.epoch,
+      id: buf.slice(6)
+    };
+  }
 }
-/**
- * Creates and returns a new ULID generator instance (w/ 48bit epoch millisecond
- * time precision).
- *
- * @remarks
- * https://github.com/ulid/spec
- *
- * @param opts -
- */
-export const defULID = (opts) => new ULID(opts);
+const defULID = (opts) => new ULID(opts);
+export {
+  ULID,
+  defULID
+};