feat: add v6 method

uuidjs · Jun 4, 2024 · f7efb7f · f7efb7f
1 parent 4710dee
commit f7efb7f
Show file tree

Hide file tree

Showing 22 changed files with 211 additions and 56 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,5 @@
+{
+  "files.autoSave": "afterDelay",
+  "editor.formatOnSave": false,
+  "editor.defaultFormatter": "esbenp.prettier-vscode"
+}
diff --git a/bundlewatch.config.json b/bundlewatch.config.json
@@ -20,6 +20,7 @@
       "path": "./examples/browser-rollup/dist/v5-size.js",
       "maxSize": "1.5 kB"
     },
+    { "path": "./examples/browser-rollup/dist/v6-size.js", "maxSize": "1.3 kB" },
     { "path": "./examples/browser-rollup/dist/v7-size.js", "maxSize": "0.8 kB" },
 
     {
@@ -38,6 +39,10 @@
       "path": "./examples/browser-webpack/dist/v5-size.js",
       "maxSize": "1.5 kB"
     },
+    {
+      "path": "./examples/browser-webpack/dist/v6-size.js",
+      "maxSize": "1.3 kB"
+    },
     { "path": "./examples/browser-webpack/dist/v7-size.js", "maxSize": "0.8 kB" }
   ]
 }
diff --git a/examples/benchmark/benchmark.js b/examples/benchmark/benchmark.js
@@ -66,6 +66,9 @@ export default function benchmark(uuid, Benchmark) {
       .add('uuid.v5()', function () {
         uuid.v5('hello.example.com', uuid.v5.DNS);
       })
+      .add('uuid.v6()', function () {
+        uuid.v6();
+      })
       .add('uuid.v7()', function () {
         uuid.v7();
       })

diff --git a/examples/browser-esmodules/example.js b/examples/browser-esmodules/example.js
@@ -12,6 +12,7 @@ import {
   v3 as uuidv3,
   v4 as uuidv4,
   v5 as uuidv5,
+  v6 as uuidv6,
   v6ToV1 as uuidv6ToV1,
   v7 as uuidv7,
 } from './node_modules/uuid/dist/esm-browser/index.js';
@@ -48,6 +49,8 @@ console.log('uuidv5() URL', uuidv5('http://example.com/hello', uuidv5.URL));
 // const MY_NAMESPACE = '1b671a64-40d5-491e-99b0-da01ff1f3341';
 console.log('uuidv5() MY_NAMESPACE', uuidv5('Hello, World!', MY_NAMESPACE));
 
+console.log('uuidv6()', uuidv6());
+
 // v6 <-> v1 conversion
 const V1_ID = 'f1207660-21d2-11ef-8c4f-419efbd44d48';
 const V6_ID = '1ef21d2f-1207-6660-8c4f-419efbd44d48';
@@ -73,6 +76,7 @@ console.log('uuid.v3() MY_NAMESPACE', uuid.v3('Hello, World!', MY_NAMESPACE));
 console.log('uuid.v5() DNS', uuid.v5('hello.example.com', uuid.v5.DNS));
 console.log('uuid.v5() URL', uuid.v5('http://example.com/hello', uuid.v5.URL));
 console.log('uuid.v5() MY_NAMESPACE', uuid.v5('Hello, World!', MY_NAMESPACE));
+console.log('uuid.v6()', uuid.v6());
 
 console.log('uuid.v1ToV6()', uuid.v1ToV6(V1_ID));
 console.log('uuid.v6ToV1()', uuid.v6ToV1(V6_ID));

diff --git a/examples/browser-rollup/example-all.js b/examples/browser-rollup/example-all.js
@@ -11,6 +11,7 @@ import {
   v3 as uuidv3,
   v4 as uuidv4,
   v5 as uuidv5,
+  v6 as uuidv6,
   v6ToV1 as uuidv6ToV1,
   v7 as uuidv7,
 } from 'uuid';
@@ -52,6 +53,8 @@ testpage(function (addTest, done) {
   // const MY_NAMESPACE = '1b671a64-40d5-491e-99b0-da01ff1f3341';
   addTest('uuidv5() MY_NAMESPACE', uuidv5('Hello, World!', MY_NAMESPACE));
 
+  addTest('uuidv6()', uuidv6());
+
   // v6 <-> v1 conversion
   const V1_ID = 'f1207660-21d2-11ef-8c4f-419efbd44d48';
   const V6_ID = '1ef21d2f-1207-6660-8c4f-419efbd44d48';
@@ -77,6 +80,7 @@ testpage(function (addTest, done) {
   addTest('uuid.v5() DNS', uuid.v5('hello.example.com', uuid.v5.DNS));
   addTest('uuid.v5() URL', uuid.v5('http://example.com/hello', uuid.v5.URL));
   addTest('uuid.v5() MY_NAMESPACE', uuid.v5('Hello, World!', MY_NAMESPACE));
+  addTest('uuid.v6()', uuid.v6());
 
   addTest('uuid.v1ToV6()', uuid.v1ToV6(V1_ID));
   addTest('uuid.v6ToV1()', uuid.v6ToV1(V6_ID));

diff --git a/examples/browser-rollup/rollup.config.js b/examples/browser-rollup/rollup.config.js
@@ -68,6 +68,14 @@ module.exports = [
     },
     plugins,
   },
+  {
+    input: './size-v6.js',
+    output: {
+      file: 'dist/v6-size.js',
+      format: 'cjs',
+    },
+    plugins,
+  },
   {
     input: './size-v7.js',
     output: {

diff --git a/examples/browser-rollup/size-v6.js b/examples/browser-rollup/size-v6.js
@@ -0,0 +1,3 @@
+import { v6 as uuidv6 } from 'uuid';
+
+uuidv6();
diff --git a/examples/browser-webpack/example-all-require.js b/examples/browser-webpack/example-all-require.js
@@ -9,6 +9,7 @@ const {
   v3: uuidv3,
   v4: uuidv4,
   v5: uuidv5,
+  v6: uuidv6,
   v6ToV1: uuidv6ToV1,
   v7: uuidv7,
   validate: uuidValidate,
@@ -58,6 +59,8 @@ testpage(function (addTest, done) {
   // const MY_NAMESPACE = '1b671a64-40d5-491e-99b0-da01ff1f3341';
   addTest('uuidv5() MY_NAMESPACE', uuidv5('Hello, World!', MY_NAMESPACE));
 
+  addTest('uuidv6()', uuidv6());
+
   // Utility functions
   addTest('NIL_UUID', NIL_UUID);
   addTest('MAX_UUID', MAX_UUID);
@@ -77,6 +80,7 @@ testpage(function (addTest, done) {
   addTest('uuid.v5() DNS', uuid.v5('hello.example.com', uuid.v5.DNS));
   addTest('uuid.v5() URL', uuid.v5('http://example.com/hello', uuid.v5.URL));
   addTest('uuid.v5() MY_NAMESPACE', uuid.v5('Hello, World!', MY_NAMESPACE));
+  addTest('uuid.v6()', uuid.v6());
 
   addTest('uuid.v1ToV6()', uuid.v1ToV6(V1_ID));
   addTest('uuid.v6ToV1()', uuid.v6ToV1(V6_ID));

diff --git a/examples/browser-webpack/example-all.js b/examples/browser-webpack/example-all.js
@@ -11,6 +11,7 @@ import {
   v3 as uuidv3,
   v4 as uuidv4,
   v5 as uuidv5,
+  v6 as uuidv6,
   v6ToV1 as uuidv6ToV1,
   v7 as uuidv7,
 } from 'uuid';
@@ -52,6 +53,8 @@ testpage(function (addTest, done) {
   // const MY_NAMESPACE = '1b671a64-40d5-491e-99b0-da01ff1f3341';
   addTest('uuidv5() MY_NAMESPACE', uuidv5('Hello, World!', MY_NAMESPACE));
 
+  addTest('uuidv6()', uuidv6());
+
   // v6 <-> v1 conversion
   const V1_ID = 'f1207660-21d2-11ef-8c4f-419efbd44d48';
   const V6_ID = '1ef21d2f-1207-6660-8c4f-419efbd44d48';
@@ -77,6 +80,7 @@ testpage(function (addTest, done) {
   addTest('uuid.v5() DNS', uuid.v5('hello.example.com', uuid.v5.DNS));
   addTest('uuid.v5() URL', uuid.v5('http://example.com/hello', uuid.v5.URL));
   addTest('uuid.v5() MY_NAMESPACE', uuid.v5('Hello, World!', MY_NAMESPACE));
+  addTest('uuid.v6()', uuid.v6());
 
   addTest('uuid.v1ToV6()', uuid.v1ToV6(V1_ID));
   addTest('uuid.v6ToV1()', uuid.v6ToV1(V6_ID));

diff --git a/examples/browser-webpack/size-v6.js b/examples/browser-webpack/size-v6.js
@@ -0,0 +1,3 @@
+import { v6 as uuidv6 } from 'uuid';
+
+uuidv6();
diff --git a/examples/browser-webpack/webpack.config.js b/examples/browser-webpack/webpack.config.js
@@ -13,6 +13,7 @@ module.exports = {
     'v3-size': './size-v3.js',
     'v4-size': './size-v4.js',
     'v5-size': './size-v5.js',
+    'v6-size': './size-v6.js',
     'v7-size': './size-v7.js',
   },
   // Webpack now produces builds that are incompatible with IE11:

diff --git a/examples/node-commonjs/example.js b/examples/node-commonjs/example.js
@@ -8,6 +8,7 @@ const {
   v3: uuidv3,
   v4: uuidv4,
   v5: uuidv5,
+  v6: uuidv6,
   v6ToV1: uuidv6ToV1,
   v7: uuidv7,
   validate: uuidValidate,
@@ -48,6 +49,8 @@ console.log('uuidv5() URL', uuidv5('http://example.com/hello', uuidv5.URL));
 // const MY_NAMESPACE = '1b671a64-40d5-491e-99b0-da01ff1f3341';
 console.log('uuidv5() MY_NAMESPACE', uuidv5('Hello, World!', MY_NAMESPACE));
 
+console.log('uuidv6()', uuidv6());
+
 // v6 <-> v1 conversion
 const V1_ID = 'f1207660-21d2-11ef-8c4f-419efbd44d48';
 const V6_ID = '1ef21d2f-1207-6660-8c4f-419efbd44d48';
@@ -73,6 +76,7 @@ console.log('uuid.v3() MY_NAMESPACE', uuid.v3('Hello, World!', MY_NAMESPACE));
 console.log('uuid.v5() DNS', uuid.v5('hello.example.com', uuid.v5.DNS));
 console.log('uuid.v5() URL', uuid.v5('http://example.com/hello', uuid.v5.URL));
 console.log('uuid.v5() MY_NAMESPACE', uuid.v5('Hello, World!', MY_NAMESPACE));
+console.log('uuid.v6()', uuid.v6());
 
 console.log('uuid.v1ToV6()', uuid.v1ToV6(V1_ID));
 console.log('uuid.v6ToV1()', uuid.v6ToV1(V6_ID));

diff --git a/examples/node-esmodules/example.mjs b/examples/node-esmodules/example.mjs
@@ -11,6 +11,7 @@ import {
   v3 as uuidv3,
   v4 as uuidv4,
   v5 as uuidv5,
+  v6 as uuidv6,
   v6ToV1 as uuidv6ToV1,
   v7 as uuidv7,
 } from 'uuid';
@@ -48,6 +49,8 @@ console.log('uuidv5() URL', uuidv5('http://example.com/hello', uuidv5.URL));
 // const MY_NAMESPACE = '1b671a64-40d5-491e-99b0-da01ff1f3341';
 console.log('uuidv5() MY_NAMESPACE', uuidv5('Hello, World!', MY_NAMESPACE));
 
+console.log('uuidv6()', uuidv6());
+
 // v6 <-> v1 conversion
 const V1_ID = 'f1207660-21d2-11ef-8c4f-419efbd44d48';
 const V6_ID = '1ef21d2f-1207-6660-8c4f-419efbd44d48';
@@ -73,6 +76,7 @@ console.log('uuid.v3() MY_NAMESPACE', uuid.v3('Hello, World!', MY_NAMESPACE));
 console.log('uuid.v5() DNS', uuid.v5('hello.example.com', uuid.v5.DNS));
 console.log('uuid.v5() URL', uuid.v5('http://example.com/hello', uuid.v5.URL));
 console.log('uuid.v5() MY_NAMESPACE', uuid.v5('Hello, World!', MY_NAMESPACE));
+console.log('uuid.v6()', uuid.v6());
 
 console.log('uuid.v1ToV6()', uuid.v1ToV6(V1_ID));
 console.log('uuid.v6ToV1()', uuid.v6ToV1(V6_ID));

diff --git a/src/index.js b/src/index.js
@@ -7,6 +7,7 @@ export { default as v1ToV6 } from './v1ToV6.js';
 export { default as v3 } from './v3.js';
 export { default as v4 } from './v4.js';
 export { default as v5 } from './v5.js';
+export { default as v6 } from './v6.js';
 export { default as v6ToV1 } from './v6ToV1.js';
 export { default as v7 } from './v7.js';
 export { default as validate } from './validate.js';

diff --git a/src/v1.js b/src/v1.js
@@ -29,7 +29,7 @@ function v1(options, buf, offset) {
     const seedBytes = options.random || (options.rng || rng)();
 
     if (node == null) {
-      // Per 4.5, create and 48-bit node id, (47 random bits + multicast bit = 1)
+      // Per 4.5, create a 48-bit node id, (47 random bits + multicast bit = 1)
       node = _nodeId = [
         seedBytes[0] | 0x01,
         seedBytes[1],

diff --git a/src/v1ToV6.js b/src/v1ToV6.js
@@ -1,43 +1,53 @@
 import parse from './parse.js';
 import rng from './rng.js';
-import stringify from './stringify.js';
-import version from './version.js';
+import { unsafeStringify } from './stringify.js';
 
 /**
- * Convert a v1 UUID to a v6 UUID.
+ * Convert a v1 UUID to a v6 UUID
  *
  * Note: Per https://www.rfc-editor.org/rfc/rfc9562.html#section-5.6-4, the
- * clock_seq and node fields SHOULD be randomized to aid in collision resistance
- * and security.  However. this behavior is not enabled by default for two reasons:
+ * clock_seq and node fields SHOULD be set to random values for each new v6 UUID
+ * to aid in collision resistance and security.  This function does not do this
+ * by default, however, for two reasons:
  *
  * 1. Doing so makes the conversion non-reversible.  I.e. `v6ToV1(v1ToV6(uuid))
  *    !== uuid`.
  * 2. Doing so makes the conversion non-deterministic.  I.e. `v1ToV6(uuid) !==
  *    v1ToV6(uuid)`
  *
- * Callers wishing to enable the RFC-recommended randomization can do so by
- * passing `true` for the second parameter.
+ * Callers needing the RFC-recommended randomization can enable this by passing
+ * `true` for the `randomize` argument.
+ *
+ * @param {string|Uint8Array} uuid - The v1 UUID to convert to v6
+ * @param {boolean} [randomize=false] - Whether to randomize the clock_seq and
+ * node fields
+ * @returns {string|Uint8Array} The v6 UUID as a string or Uint8Array
  */
 export default function v1ToV6(uuid, randomize = false) {
-  if (version(uuid) !== 1) {
-    throw new Error('id is not a valid v1 UUID');
-  }
+  // Non-string UUIDs are documented as being Uint8Arrays, but we don't enforce
+  // that.  They just need to be "array-like".  And some day when we port this
+  // to TypeScript we'll have to take an actual stance on this.
+  const v1Bytes = typeof uuid === 'string' ? parse(uuid) : uuid;
 
-  const v1Bytes = parse(uuid);
+  const v6Bytes = _v1ToV6(v1Bytes);
 
   if (randomize) {
     const rnds = rng();
-    v1Bytes[8] = (rnds[0] & 0x3f) | 0x80;
-    v1Bytes[9] = rnds[1];
-    v1Bytes[10] = rnds[2];
-    v1Bytes[11] = rnds[3];
-    v1Bytes[12] = rnds[4];
-    v1Bytes[13] = rnds[5];
-    v1Bytes[14] = rnds[6];
-    v1Bytes[15] = rnds[7];
+    v6Bytes[8] = (rnds[0] & 0x3f) | 0x80;
+    v6Bytes[9] = rnds[1];
+    v6Bytes[10] = rnds[2];
+    v6Bytes[11] = rnds[3];
+    v6Bytes[12] = rnds[4];
+    v6Bytes[13] = rnds[5];
+    v6Bytes[14] = rnds[6];
+    v6Bytes[15] = rnds[7];
   }
+  return typeof uuid === 'string' ? unsafeStringify(v6Bytes) : v6Bytes;
+}
 
-  const v6Bytes = Uint8Array.from([
+// Do the field transformation needed for v1 -> v6
+function _v1ToV6(v1Bytes, randomize = false) {
+  return Uint8Array.of(
     ((v1Bytes[6] & 0x0f) << 4) | ((v1Bytes[7] >> 4) & 0x0f),
     ((v1Bytes[7] & 0x0f) << 4) | ((v1Bytes[4] & 0xf0) >> 4),
     ((v1Bytes[4] & 0x0f) << 4) | ((v1Bytes[5] & 0xf0) >> 4),
@@ -56,8 +66,6 @@ export default function v1ToV6(uuid, randomize = false) {
     v1Bytes[12],
     v1Bytes[13],
     v1Bytes[14],
-    v1Bytes[15],
-  ]);
-
-  return stringify(v6Bytes);
+    v1Bytes[15]
+  );
 }
diff --git a/src/v6.js b/src/v6.js
@@ -0,0 +1,47 @@
+import { unsafeStringify } from './stringify.js';
+import v1 from './v1.js';
+import v1ToV6 from './v1ToV6.js';
+
+/**
+ *
+ * @param {object} options
+ * @param {Uint8Array=} buf
+ * @param {number=} offset
+ * @returns
+ */
+export default function v6(options, buf, offset = 0) {
+  // v6 is just a v1 UUID with different field layout.
+  let bytes = v1(options, new Uint8Array(16));
+
+  // Reorder the fields to v6 layout.  Per RFC9562, we randomize the clock_seq
+  // and node fields for each UUID.  Randomize node and clock_seq here to get
+  // the RFC-recommended behavior (we restore these below if they're provided in
+  // options.)
+  bytes = v1ToV6(bytes, true);
+
+  // Apply options.clockseq?
+  const clockseq = options?.clockseq;
+  if (clockseq !== undefined) {
+    bytes[8] = ((clockseq >> 8) & 0x3f) | 0x80;
+    bytes[9] = clockseq & 0xff;
+  }
+
+  // Apply options.node?
+  const node = options?.node;
+  if (node !== undefined) {
+    for (let i = 0; i < 6; i++) {
+      bytes[10 + i] = node[i];
+    }
+  }
+
+  if (buf) {
+    // Copy to buffer
+    for (let i = 0; i < 16; i++) {
+      buf[offset + i] = bytes[i];
+    }
+    return buf;
+  }
+
+  // Otherwise return UUID as a string
+  return unsafeStringify(bytes);
+}