2.0.0-alpha.0 • Published 3 weeks ago

@reventlessdev/rescript-uuid

Licence

Apache-2.0

Version

2.0.0-alpha.0

Deps

Size

23 kB

Vulns

Weekly

Stars

Summary Dependency Versions

@reventlessdev/rescript-uuid

Alpha. APIs can change without notice between releases. Pin exact versions and expect breaking changes.

ReScript bindings for uuid - RFC4122 UUID generation.

Installation

Add @reventlessdev/rescript-uuid to your dependencies in package.json:

{
  "dependencies": {
    "@reventlessdev/rescript-uuid": "^1.0.0",
    "uuid": "^9.0.0"
  }
}

Add @reventlessdev/rescript-uuid to dependencies in rescript.json:

{
  "dependencies": [
    "@reventlessdev/rescript-uuid"
  ]
}

Install dependencies:

pnpm install

For general information see this monorepo's readme.

API

`v1()` - Timestamp-based UUID

Generates a UUID v1 (timestamp-based).

let id = Uuid.v1()
// => "2c5ea4c0-4067-11e9-8bad-9b1deb4d3b7d"

`v4()` - Random UUID

Generates a UUID v4 (random).

let id = Uuid.v4()
// => "416ac246-e7ac-49ff-93b4-f7e94d997e6b"

`v3(~name, ~namespace)` - Namespace UUID (MD5)

Generates a UUID v3 (namespace-based with MD5 hash).

// Using predefined DNS namespace
let id = Uuid.v3(~name="hello.example.com", ~namespace=Uuid.Namespace.dns)
// => "9125a8dc-52ee-365b-a5aa-81b0b3681cf6"

// Using predefined URL namespace
let id = Uuid.v3(~name="http://example.com/hello", ~namespace=Uuid.Namespace.url)
// => "c6235813-3ba4-3801-ae84-e0a6ebb7d138"

// Using custom namespace
let myNamespace = Uuid.Namespace.custom("1b671a64-40d5-491e-99b0-da01ff1f3341")
let id = Uuid.v3(~name="mydata", ~namespace=myNamespace)

`v5(~name, ~namespace)` - Namespace UUID (SHA-1)

Generates a UUID v5 (namespace-based with SHA-1 hash).

// Using predefined DNS namespace
let id = Uuid.v5(~name="hello.example.com", ~namespace=Uuid.Namespace.dns)
// => "fdda765f-fc57-5604-a269-52a7df8164ec"

// Using predefined URL namespace
let id = Uuid.v5(~name="http://example.com/hello", ~namespace=Uuid.Namespace.url)
// => "3bbcee75-cecc-5b56-8031-b6641c1ed1f1"

// Using custom namespace
let myNamespace = Uuid.Namespace.custom("1b671a64-40d5-491e-99b0-da01ff1f3341")
let id = Uuid.v5(~name="mydata", ~namespace=myNamespace)

`Namespace` Module

Predefined and custom namespaces for v3 and v5 UUID generation.

Uuid.Namespace.dns  // DNS namespace (6ba7b810-9dad-11d1-80b4-00c04fd430c8)
Uuid.Namespace.url  // URL namespace (6ba7b811-9dad-11d1-80b4-00c04fd430c8)
Uuid.Namespace.custom(uuidString)  // Create custom namespace from UUID string

Complete Example

open Uuid

// Generate different UUID versions
let timestampId = v1()
Js.Console.log2("v1 (timestamp):", timestampId)

let randomId = v4()
Js.Console.log2("v4 (random):", randomId)

let dnsBasedId = v3(~name="example.com", ~namespace=Namespace.dns)
Js.Console.log2("v3 (DNS namespace):", dnsBasedId)

let urlBasedId = v5(~name="https://example.com", ~namespace=Namespace.url)
Js.Console.log2("v5 (URL namespace):", urlBasedId)

// Using custom namespace
let myNamespace = Namespace.custom("1b671a64-40d5-491e-99b0-da01ff1f3341")
let customId = v5(~name="my-resource-name", ~namespace=myNamespace)
Js.Console.log2("v5 (custom namespace):", customId)

UUID Version Comparison

Version	Algorithm	Use Case
v1	Timestamp + MAC address	When you need time-ordered UUIDs
v3	MD5 hash of namespace + name	When you need deterministic UUIDs (legacy)
v4	Random	General purpose, most common
v5	SHA-1 hash of namespace + name	When you need deterministic UUIDs (preferred over v3)

Notes

v4 is the most commonly used version for general purposes
v3 and v5 generate the same UUID for the same name+namespace combination (deterministic)
v5 is preferred over v3 when you need namespace-based UUIDs (SHA-1 vs MD5)
v1 includes timestamp and MAC address, which may have privacy implications

License

Apache-2.0