Small UID

!GitHub branch check runs

> _Small UID_ is a small, url-safe, user-friendly unique, lexicographically
> sortable id generator.

UUIDs are frequently used as database _Primary Key_ in software development.
However, they aren't the best choice mainly due to their random sorting and the
resulting fragmentation in databases indexes.

Using ULIDs is generally a very good
alternative, solving most of UUID flaws.

Twitter's Snowflake is another option if you want to generate roughly sortable
uid. But, Snowflake is not using random numbers instead it used machine id to
generate the uid. It's a good choice if you integrate it into a distributed
systems and doesn't really need randomness.

Small UIDs are also an ideal alternative **when you do not need as much
uniqueness and want shorter "user-friendly" encoded strings**.

Introduction

Small UIDs are short unique identifiers especially designed to be used as
efficient database _Primary Key_:

- Half smaller than UUID / ULID (64-bit)
- Lexicographically sortable
- Encodable as a short user-friendly and URL-safe base-64 string (a-zA-Z0-9_-)
- User-friendly strings are generated in a way to be always very different (no
shared prefix due to similar timestamps)

| | Small UID | ULID | UUID v4 |
| ------------------------- | :-----------------: | :-------------------: | :-------: |
| Size | 64 bits | 128 bits | 128 bits |
| Monotonic sort order | Yes *** | Yes | No |
| Random bits | 20 | 80 | 122 |
| Collision odds ** | 1,024 _/ ms*_ | 1.099e+12 _/ ms*_ | 2.305e+18 |

* _theorical number of generated uids before the first expected collision._\
** _the uid includes a timestamp, so collisions may occur only during
the same millisecond._\
*** _monotonic sort order, but random order when generated at the
same millisecond._

They are internally stored as _64-bit_ integers (_44-bit_ timestamp followed by
_20 random bits_):

|-----------------------| |------------|
Timestamp Randomness
44 bits 20 bits

The random number suffix still guarantees a decent amount of uniqueness when
many ids are created in the same millisecond (up to 1,048,576 different values)
and you may only expect collision if you're generating more than 1024 random ids
during the same millisecond.

$3

Because of the sequential timestamp, _Small UIDs_ are naturally sorted
chronologically. It improves indexing when inserting values in databases,
new ids being appended to the end of the table without reshuffling existing data
(read more
in this article).

However, sort order within the same millisecond is not guaranteed because of
the random bits suffix.

Guaranteed monotonicity for javascript version is planned.

This project is loose reimplementation of
Small-UID by
Mediagone with the only difference is the string
encoding for this one is base64-url instead of base62 for enabling wider
usecases.

Typescript

For cloudflare worker you should use the pure js version.

> Documentation in JSR

$3

#### Generating Small UID

``typescript
import { SmallUid } from "small-uid";
// import { SmallUid } from "small-uid/pure";

const uid = SmallUid.gen();
console.log(uid.string); // prints the base64url encoded string
console.log(uid.value); // prints the underlying integer value
`

#### Using other RNG implementations

`typescript
// Os rng, slow but secure
const uid = SmallUid.gen("secure");
// CSPRNG, fast and reasonably secure. Same as default.
const uid = SmallUid.gen("secure_fast");
// Using Math.random(), fast but insecure
const uid = SmallUid.gen("insecure");
`

#### Generating Small UID from a 64-bit integer

`typescript
const smallUidValue: bigint = 0x123456789abcdefn;
const uid = new SmallUid(smallUidValue);
console.log(uid.string); // prints the base64url encoded string
console.log(uid.value); // prints the underlying numeric value
`

#### Generating Small UID from a string

`typescript
const smallUidString = "XxXxXxXxXxX";
const uid = new SmallUid(smallUidString);
console.log(uid.string); // prints the base64url encoded string
console.log(uid.value); // prints the underlying numeric value
``