Feat/uuidv5 generation #61
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,41 +1,44 @@ | ||
| { | ||
| "name": "w3id", | ||
| "version": "1.0.0", | ||
| "description": "", | ||
| "scripts": { | ||
| "test": "vitest", | ||
| "dev": "tsc --watch", | ||
| "check-format": "prettier --check \"src/**/*.ts\"", | ||
| "format": "npx @biomejs/biome format --write ./src", | ||
| "lint": "npx @biomejs/biome lint --write ./src", | ||
| "check": "npx @biomejs/biome check --write ./src", | ||
| "check-types": "tsc --noEmit", | ||
| "build": "npm run build:node && npm run build:browser", | ||
| "build:node": "tsc -p tsconfig.node.json", | ||
| "build:browser": "tsc -p tsconfig.browser.json", | ||
| "postinstall": "npm run build" | ||
| }, | ||
| "keywords": [], | ||
| "author": "", | ||
| "license": "ISC", | ||
| "dependencies": { | ||
| "uuid": "^11.1.0" | ||
| }, | ||
| "devDependencies": { | ||
| "@ngneat/falso": "^7.3.0", | ||
| "@types/node": "^22.13.10", | ||
| "typescript": "^5.8.2", | ||
| "vitest": "^3.0.9" | ||
| }, | ||
| "main": "./dist/node/index.js", | ||
| "module": "./dist/browser/index.js", | ||
| "types": "./dist/types/index.d.ts", | ||
| "exports": { | ||
| ".": { | ||
| "require": "./dist/node/index.js", | ||
| "import": "./dist/browser/index.js", | ||
| "types": "./dist/types/index.d.ts" | ||
| }, | ||
| "./package.json": "./package.json" | ||
| }, | ||
| "files": [ | ||
| "dist/**/*" | ||
| ] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| import { v4 as uuidv4, v5 as uuidv5 } from "uuid"; | ||
|
|
||
| /** | ||
| * Generates a UUIDv5 taking namespace from a random UUIDv4 and taking `name` | ||
| * part as entropy from the creator of the identifier | ||
| * | ||
| * @param {String} entropy | ||
| * @param {String} namespace - uuid namespace | ||
| * @returns string | ||
| */ | ||
|
|
||
| export function generateUuid( | ||
| entropy: string, | ||
| namespace: string = uuidv4(), | ||
|
There was a problem hiding this comment. i think having this default behavior would just lead to mistakes |
||
| ): string { | ||
| return uuidv5(entropy, namespace); | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| import { generateUuid } from "../../src/utils/uuid"; | ||
| import falso from "@ngneat/falso"; | ||
| import { describe, test, expect } from "vitest"; | ||
|
|
||
| describe("UUIDv5 Generation", () => { | ||
| test("Create UUID", () => { | ||
| const id = generateUuid(falso.randText()); | ||
| expect(id).toBeDefined(); | ||
| }); | ||
|
|
||
| test("UUID is deterministic", () => { | ||
| const namespace = falso.randUuid(); | ||
| const entropy = falso.randText(); | ||
| const id = generateUuid(entropy, namespace); | ||
| const id2 = generateUuid(entropy, namespace); | ||
| expect(id).toEqual(id2); | ||
| }); | ||
| }); |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
function name makes it seems like the function has a broad scope, but doc above mentions just v5, its just a nitpick but i think this can be named a little better