feat: add support for MAX uuid (new in RFC9562)

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## Unreleased
+
+### Features
+
+- Add `MAX` constant ([#714](https://github.com/uuidjs/uuid/issues/714))
+
 ## [9.0.0](https://github.com/uuidjs/uuid/compare/v8.3.2...v9.0.0) (2022-09-05)
 
 ### ⚠ BREAKING CHANGES

README.md

@@ -53,6 +53,7 @@ For timestamp UUIDs, namespace UUIDs, and other options read on ...
 |  |  |  |
 | --- | --- | --- |
 | [`uuid.NIL`](#uuidnil) | The nil UUID string (all zeros) | New in `[email protected]` |
+| [`uuid.MAX`](#uuidmax) | The max UUID string (all ones) | New in `[email protected]` |
 | [`uuid.parse()`](#uuidparsestr) | Convert UUID string to array of bytes | New in `[email protected]` |
 | [`uuid.stringify()`](#uuidstringifyarr-offset) | Convert array of bytes to UUID string | New in `[email protected]` |
 | [`uuid.v1()`](#uuidv1options-buffer-offset) | Create a version 1 (timestamp) UUID |  |
@@ -76,6 +77,18 @@ import { NIL as NIL_UUID } from 'uuid';
 NIL_UUID; // ⇨ '00000000-0000-0000-0000-000000000000'
 ```
 
+### uuid.MAX
+
+The max UUID string (all zeros).
+
+Example:
+
+```javascript
+import { MAX as MAX_UUID } from 'uuid';
+
+MAX_UUID; // ⇨ 'ffffffff-ffff-ffff-ffff-ffffffffffff'
+```
+
 ### uuid.parse(str)
 
 Convert UUID string to array of bytes

README_js.md

@@ -67,6 +67,7 @@ For timestamp UUIDs, namespace UUIDs, and other options read on ...
 |  |  |  |
 | --- | --- | --- |
 | [`uuid.NIL`](#uuidnil) | The nil UUID string (all zeros) | New in `[email protected]` |
+| [`uuid.MAX`](#uuidmax) | The max UUID string (all ones) | New in `[email protected]` |
 | [`uuid.parse()`](#uuidparsestr) | Convert UUID string to array of bytes | New in `[email protected]` |
 | [`uuid.stringify()`](#uuidstringifyarr-offset) | Convert array of bytes to UUID string | New in `[email protected]` |
 | [`uuid.v1()`](#uuidv1options-buffer-offset) | Create a version 1 (timestamp) UUID |  |
@@ -90,6 +91,18 @@ import { NIL as NIL_UUID } from 'uuid';
 NIL_UUID; // RESULT
 ```
 
+### uuid.MAX
+
+The max UUID string (all zeros).
+
+Example:
+
+```javascript --run
+import { MAX as MAX_UUID } from 'uuid';
+
+MAX_UUID; // RESULT
+```
+
 ### uuid.parse(str)
 
 Convert UUID string to array of bytes

examples/browser-esmodules/example.js

@@ -1,5 +1,6 @@
 import {
   NIL as NIL_UUID,
+  MAX as MAX_UUID,
   parse as uuidParse,
   stringify as uuidStringify,
   v1 as uuidv1,
@@ -43,6 +44,7 @@ console.log('uuidv5() MY_NAMESPACE', uuidv5('Hello, World!', MY_NAMESPACE));
 
 // Utility functions
 console.log('NIL_UUID', NIL_UUID);
+console.log('MAX_UUID', MAX_UUID);
 console.log('uuidParse()', uuidParse(MY_NAMESPACE));
 console.log('uuidStringify()', uuidStringify(uuidParse(MY_NAMESPACE)));
 console.log('uuidValidate()', uuidValidate(MY_NAMESPACE));
@@ -60,6 +62,7 @@ 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.NIL', uuid.NIL);
+console.log('uuid.MAX', uuid.MAX);
 console.log('uuid.parse()', uuid.parse(MY_NAMESPACE));
 console.log('uuid.stringify()', uuid.stringify(uuid.parse(MY_NAMESPACE)));
 console.log('uuid.validate()', uuid.validate(MY_NAMESPACE));

examples/browser-rollup/example-all.js

@@ -1,5 +1,6 @@
 import {
   NIL as NIL_UUID,
+  MAX as MAX_UUID,
   parse as uuidParse,
   stringify as uuidStringify,
   v1 as uuidv1,
@@ -48,6 +49,7 @@ testpage(function (addTest, done) {
 
   // Utility functions
   addTest('NIL_UUID', NIL_UUID);
+  addTest('MAX_UUID', MAX_UUID);
   addTest('uuidParse()', uuidParse(MY_NAMESPACE));
   addTest('uuidStringify()', uuidStringify(uuidParse(MY_NAMESPACE)));
   addTest('uuidValidate()', uuidValidate(MY_NAMESPACE));
@@ -65,6 +67,7 @@ testpage(function (addTest, done) {
   addTest('uuid.v5() MY_NAMESPACE', uuid.v5('Hello, World!', MY_NAMESPACE));
 
   addTest('uuid.NIL', uuid.NIL);
+  addTest('uuid.MAX', uuid.MAX);
   addTest('uuid.parse()', uuid.parse(MY_NAMESPACE));
   addTest('uuid.stringify()', uuid.stringify(uuid.parse(MY_NAMESPACE)));
   addTest('uuid.validate()', uuid.validate(MY_NAMESPACE));

examples/browser-webpack/example-all-require.js

@@ -1,6 +1,7 @@
 const uuid = require('uuid');
 const {
   NIL: NIL_UUID,
+  MAX: MAX_UUID,
   parse: uuidParse,
   stringify: uuidStringify,
   v1: uuidv1,
@@ -48,6 +49,7 @@ testpage(function (addTest, done) {
 
   // Utility functions
   addTest('NIL_UUID', NIL_UUID);
+  addTest('MAX_UUID', MAX_UUID);
   addTest('uuidParse()', uuidParse(MY_NAMESPACE));
   addTest('uuidStringify()', uuidStringify(uuidParse(MY_NAMESPACE)));
   addTest('uuidValidate()', uuidValidate(MY_NAMESPACE));
@@ -65,6 +67,7 @@ testpage(function (addTest, done) {
   addTest('uuid.v5() MY_NAMESPACE', uuid.v5('Hello, World!', MY_NAMESPACE));
 
   addTest('uuid.NIL', uuid.NIL);
+  addTest('uuid.MAX', uuid.MAX);
   addTest('uuid.parse()', uuid.parse(MY_NAMESPACE));
   addTest('uuid.stringify()', uuid.stringify(uuid.parse(MY_NAMESPACE)));
   addTest('uuid.validate()', uuid.validate(MY_NAMESPACE));

examples/browser-webpack/example-all.js

@@ -1,5 +1,6 @@
 import {
   NIL as NIL_UUID,
+  MAX as MAX_UUID,
   parse as uuidParse,
   stringify as uuidStringify,
   v1 as uuidv1,
@@ -48,6 +49,7 @@ testpage(function (addTest, done) {
 
   // Utility functions
   addTest('NIL_UUID', NIL_UUID);
+  addTest('MAX_UUID', MAX_UUID);
   addTest('uuidParse()', uuidParse(MY_NAMESPACE));
   addTest('uuidStringify()', uuidStringify(uuidParse(MY_NAMESPACE)));
   addTest('uuidValidate()', uuidValidate(MY_NAMESPACE));
@@ -65,6 +67,7 @@ testpage(function (addTest, done) {
   addTest('uuid.v5() MY_NAMESPACE', uuid.v5('Hello, World!', MY_NAMESPACE));
 
   addTest('uuid.NIL', uuid.NIL);
+  addTest('uuid.MAX', uuid.MAX);
   addTest('uuid.parse()', uuid.parse(MY_NAMESPACE));
   addTest('uuid.stringify()', uuid.stringify(uuid.parse(MY_NAMESPACE)));
   addTest('uuid.validate()', uuid.validate(MY_NAMESPACE));

examples/node-commonjs/example.js

@@ -1,5 +1,6 @@
 const {
   NIL: NIL_UUID,
+  MAX: MAX_UUID,
   parse: uuidParse,
   stringify: uuidStringify,
   v1: uuidv1,
@@ -44,6 +45,7 @@ console.log('uuidv5() MY_NAMESPACE', uuidv5('Hello, World!', MY_NAMESPACE));
 
 // Utility functions
 console.log('NIL_UUID', NIL_UUID);
+console.log('MAX_UUID', MAX_UUID);
 console.log('uuidParse()', uuidParse(MY_NAMESPACE));
 console.log('uuidStringify()', uuidStringify(uuidParse(MY_NAMESPACE)));
 console.log('uuidValidate()', uuidValidate(MY_NAMESPACE));
@@ -61,6 +63,7 @@ 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.NIL', uuid.NIL);
+console.log('uuid.MAX', uuid.MAX);
 console.log('uuid.parse()', uuid.parse(MY_NAMESPACE));
 console.log('uuid.stringify()', uuid.stringify(uuid.parse(MY_NAMESPACE)));
 console.log('uuid.validate()', uuid.validate(MY_NAMESPACE));

examples/node-esmodules/example.mjs

@@ -1,5 +1,6 @@
 import {
   NIL as NIL_UUID,
+  MAX as MAX_UUID,
   parse as uuidParse,
   stringify as uuidStringify,
   v1 as uuidv1,
@@ -43,6 +44,7 @@ console.log('uuidv5() MY_NAMESPACE', uuidv5('Hello, World!', MY_NAMESPACE));
 
 // Utility functions
 console.log('NIL_UUID', NIL_UUID);
+console.log('MAX_UUID', MAX_UUID);
 console.log('uuidParse()', uuidParse(MY_NAMESPACE));
 console.log('uuidStringify()', uuidStringify(uuidParse(MY_NAMESPACE)));
 console.log('uuidValidate()', uuidValidate(MY_NAMESPACE));
@@ -60,6 +62,7 @@ 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.NIL', uuid.NIL);
+console.log('uuid.MAX', uuid.MAX);
 console.log('uuid.parse()', uuid.parse(MY_NAMESPACE));
 console.log('uuid.stringify()', uuid.stringify(uuid.parse(MY_NAMESPACE)));
 console.log('uuid.validate()', uuid.validate(MY_NAMESPACE));

src/index.js

@@ -3,6 +3,7 @@ export { default as v3 } from './v3.js';
 export { default as v4 } from './v4.js';
 export { default as v5 } from './v5.js';
 export { default as NIL } from './nil.js';
+export { default as MAX } from './max.js';
 export { default as version } from './version.js';
 export { default as validate } from './validate.js';
 export { default as stringify } from './stringify.js';

src/max.js

@@ -0,0 +1 @@
+export default 'ffffffff-ffff-ffff-ffff-ffffffffffff';

test/browser/browser.spec.js

@@ -13,6 +13,7 @@ const v5url = (result) => expect(result).toBe('3bbcee75-cecc-5b56-8031-b6641c1ed
 const v5custom = (result) => expect(result).toBe('c49c5142-4d9a-5940-a926-612ede0ec632');
 
 const nil = (result) => expect(result).toBe('00000000-0000-0000-0000-000000000000');
+const max = (result) => expect(result).toBe('ffffffff-ffff-ffff-ffff-ffffffffffff');
 const parse = (result) =>
   expect(result).toEqual('85,35,141,21,201,38,69,152,180,157,207,78,145,59,161,60');
 const stringify = (result) => expect(result).toBe('55238d15-c926-4598-b49d-cf4e913ba13c');
@@ -30,6 +31,7 @@ const expectations = {
   'uuidv5() MY_NAMESPACE': v5custom,
 
   NIL_UUID: nil,
+  MAX_UUID: max,
   'uuidParse()': parse,
   'uuidStringify()': stringify,
   'uuidValidate()': validate,
@@ -45,6 +47,7 @@ const expectations = {
   'uuid.v5() MY_NAMESPACE': v5custom,
 
   'uuid.NIL': nil,
+  'uuid.MAX': max,
   'uuid.parse()': parse,
   'uuid.stringify()': stringify,
   'uuid.validate()': validate,

test/unit/validate.test.js

@@ -1,10 +1,12 @@
 import assert from 'assert';
 import validate from '../../src/validate.js';
 import NIL from '../../src/nil.js';
+import MAX from '../../src/max.js';
 
 describe('validate', () => {
   test('validate uuid', () => {
     assert.strictEqual(validate(NIL), true);
+    assert.strictEqual(validate(MAX), false);
 
     assert.strictEqual(validate('d9428888-122b-11e1-b85c-61cd3cbb3210'), true);
 

test/unit/version.test.js

@@ -1,6 +1,7 @@
 import assert from 'assert';
 import version from '../../src/version.js';
 import NIL from '../../src/nil.js';
+import MAX from '../../src/max.js';
 
 describe('version', () => {
   test('check uuid version', () => {
@@ -18,6 +19,8 @@ describe('version', () => {
 
     assert.throws(() => version(''));
 
+    assert.throws(() => version(MAX));
+
     assert.throws(() => version('invalid uuid string'));
 
     assert.throws(() => {

wrapper.mjs

@@ -4,6 +4,7 @@ export const v3 = uuid.v3;
 export const v4 = uuid.v4;
 export const v5 = uuid.v5;
 export const NIL = uuid.NIL;
+export const MAX = uuid.MAX;
 export const version = uuid.version;
 export const validate = uuid.validate;
 export const stringify = uuid.stringify;