[minor] add UuidV4 type and improve comments on UUID functions

electrovir · Jul 10, 2024 · a494982 · a494982
1 parent 1d925a4
commit a494982
Show file tree

Hide file tree

Showing 14 changed files with 67 additions and 64 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "augment-vir",
-    "version": "29.2.0",
+    "version": "29.3.0",
     "private": true,
     "homepage": "https://github.com/electrovir/augment-vir",
     "bugs": {

diff --git a/packages/browser-testing/package.json b/packages/browser-testing/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/browser-testing",
-    "version": "29.2.0",
+    "version": "29.3.0",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/common",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"
@@ -23,8 +23,8 @@
         "test:coverage": "npm test"
     },
     "dependencies": {
-        "@augment-vir/common": "^29.2.0",
-        "@augment-vir/testing": "^29.2.0",
+        "@augment-vir/common": "^29.3.0",
+        "@augment-vir/testing": "^29.3.0",
         "@open-wc/testing": "^4.0.0",
         "@types/mocha": "^10.0.7",
         "@web/test-runner-commands": "^0.9.0",

diff --git a/packages/browser/package.json b/packages/browser/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/browser",
-    "version": "29.2.0",
+    "version": "29.3.0",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/browser",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"
@@ -24,12 +24,12 @@
         "test:watch": "web-test-runner --color --config configs/web-test-runner.config.mjs --watch"
     },
     "dependencies": {
-        "@augment-vir/common": "^29.2.0",
+        "@augment-vir/common": "^29.3.0",
         "html-spec-tags": "^2.2.0",
         "run-time-assertions": "^1.5.1"
     },
     "devDependencies": {
-        "@augment-vir/browser-testing": "^29.2.0",
+        "@augment-vir/browser-testing": "^29.3.0",
         "@open-wc/testing": "^4.0.0",
         "@types/chai": "^4.3.16",
         "@types/mocha": "^10.0.7",

diff --git a/packages/chai/package.json b/packages/chai/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/chai",
-    "version": "29.2.0",
+    "version": "29.3.0",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/common",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"
@@ -23,8 +23,8 @@
         "test:coverage": "npm test"
     },
     "dependencies": {
-        "@augment-vir/common": "^29.2.0",
-        "@augment-vir/testing": "^29.2.0",
+        "@augment-vir/common": "^29.3.0",
+        "@augment-vir/testing": "^29.3.0",
         "type-fest": "^4.20.1"
     },
     "devDependencies": {

diff --git a/packages/common-tests/package.json b/packages/common-tests/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common-tests",
-    "version": "29.2.0",
+    "version": "29.3.0",
     "private": true,
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/common-tests",
     "bugs": {
@@ -22,9 +22,9 @@
         "test:types": "tsc --noEmit"
     },
     "devDependencies": {
-        "@augment-vir/chai": "^29.2.0",
-        "@augment-vir/common": "^29.2.0",
-        "@augment-vir/node-js": "^29.2.0",
+        "@augment-vir/chai": "^29.3.0",
+        "@augment-vir/common": "^29.3.0",
+        "@augment-vir/node-js": "^29.3.0",
         "@electrovir/nyc": "^15.1.0-fix0",
         "@istanbuljs/nyc-config-typescript": "^1.0.2",
         "@types/chai": "^4.3.16",

diff --git a/packages/common/package.json b/packages/common/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common",
-    "version": "29.2.0",
+    "version": "29.3.0",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/common",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"

diff --git a/packages/common/src/augments/random.ts b/packages/common/src/augments/random.ts
@@ -63,11 +63,6 @@ export function randomBoolean(percentLikelyToBeTrue: number = 50): boolean {
     );
 }
 
-/** Creates a cryptographically secure uuid. */
-export function createUuid() {
-    return crypto.randomUUID();
-}
-
 const validStringCharacters = [
     'a',
     'b',

diff --git a/packages/common/src/augments/string/uuid.ts b/packages/common/src/augments/string/uuid.ts
@@ -1,5 +1,13 @@
+export type UuidV4 = ReturnType<typeof createUuid>;
+
 const uuidRegExp = /[\d\w]{8}-[\d\w]{4}-[\d\w]{4}-[\d\w]{4}-[\d\w]{12}/;
 
+/** Checks if the input string is a valid v4 UUID. */
 export function isUuid(maybeUuid: string): boolean {
     return !!maybeUuid.match(uuidRegExp);
 }
+
+/** Creates a cryptographically secure v4 UUID using `crypto.randomUUID`. */
+export function createUuid() {
+    return crypto.randomUUID();
+}
diff --git a/packages/docker/package.json b/packages/docker/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/docker",
-    "version": "29.2.0",
+    "version": "29.3.0",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/docker",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"
@@ -22,8 +22,8 @@
         "test:coverage": "npm test"
     },
     "dependencies": {
-        "@augment-vir/common": "^29.2.0",
-        "@augment-vir/node-js": "^29.2.0"
+        "@augment-vir/common": "^29.3.0",
+        "@augment-vir/node-js": "^29.3.0"
     },
     "devDependencies": {
         "typescript": "5.5.2"

diff --git a/packages/node-js/package.json b/packages/node-js/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/node-js",
-    "version": "29.2.0",
+    "version": "29.3.0",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/node-js",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"
@@ -22,7 +22,7 @@
         "test:coverage": "npm test coverage"
     },
     "dependencies": {
-        "@augment-vir/common": "^29.2.0",
+        "@augment-vir/common": "^29.3.0",
         "ansi-colors": "^4.1.3",
         "axios": "^1.7.2",
         "fs-extra": "^11.2.0",
@@ -31,7 +31,7 @@
         "type-fest": "^4.20.1"
     },
     "devDependencies": {
-        "@augment-vir/chai": "^29.2.0",
+        "@augment-vir/chai": "^29.3.0",
         "@electrovir/nyc": "^15.1.0-fix0",
         "@istanbuljs/nyc-config-typescript": "^1.0.2",
         "@types/chai": "^4.3.16",

diff --git a/packages/prisma-node-js/package.json b/packages/prisma-node-js/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/prisma-node-js",
-    "version": "29.2.0",
+    "version": "29.3.0",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/prisma-node-js",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"
@@ -22,8 +22,8 @@
         "test:coverage": "npm test"
     },
     "dependencies": {
-        "@augment-vir/common": "^29.2.0",
-        "@augment-vir/node-js": "^29.2.0",
+        "@augment-vir/common": "^29.3.0",
+        "@augment-vir/node-js": "^29.3.0",
         "type-fest": "^4.20.1"
     },
     "devDependencies": {

diff --git a/packages/scripts/package.json b/packages/scripts/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/scripts",
-    "version": "29.2.0",
+    "version": "29.3.0",
     "private": true,
     "license": "MIT",
     "author": {
@@ -14,8 +14,8 @@
         "verify": "ts-node src/index.ts"
     },
     "dependencies": {
-        "@augment-vir/common": "^29.2.0",
-        "@augment-vir/node-js": "^29.2.0"
+        "@augment-vir/common": "^29.3.0",
+        "@augment-vir/node-js": "^29.3.0"
     },
     "devDependencies": {
         "@electrovir/nyc": "^15.1.0-fix0",

diff --git a/packages/testing/package.json b/packages/testing/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/testing",
-    "version": "29.2.0",
+    "version": "29.3.0",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/testing",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"
@@ -23,7 +23,7 @@
         "test:coverage": "npm test coverage"
     },
     "dependencies": {
-        "@augment-vir/common": "^29.2.0",
+        "@augment-vir/common": "^29.3.0",
         "expect-type": "^0.15.0",
         "type-fest": "^4.20.1"
     },