# @dreamystify/fingrprint

> A distributed, k-sortable unique ID generation system using Redis and Lua, inspired by Icicle.

Latest version **2.0.0** (published 2025-09-28) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @dreamystify/fingrprint
pnpm add @dreamystify/fingrprint
yarn add @dreamystify/fingrprint
bun add @dreamystify/fingrprint
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2025-09-28 |
| First published | 2022-07-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 76.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Dreamystify |
| Maintainers | corey_lylyk |
| Keywords | k-sortable, id, generator, bigint |

## Links

- npm: https://www.npmjs.com/package/@dreamystify/fingrprint
- Repository: https://github.com/Dreamystify/fingrprint
- Homepage: https://github.com/Dreamystify/fingrprint#readme
- Issues: https://github.com/Dreamystify/fingrprint/issues
- npm.io page: https://npm.io/package/@dreamystify/fingrprint

## Dependencies (3)

- [redis](https://npm.io/package/redis.md) ^4.6.7
- [ioredis](https://npm.io/package/ioredis.md) ^5.4.2
- [big-integer](https://npm.io/package/big-integer.md) ^1.6.51

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 2.0.0 (latest) — 2025-09-28
- 1.0.1 — 2025-02-26
- 0.1.28 — 2025-01-29
- 0.1.27 — 2025-01-29
- 0.1.26 — 2024-11-07
- 0.1.25 — 2024-11-07
- 0.1.24 — 2024-11-07
- 0.1.23 — 2024-11-07
- 0.1.22 — 2024-11-07
- 0.1.21 — 2024-10-30
- 0.1.20 — 2024-10-29
- 0.1.19 — 2024-10-29
- 0.1.17 — 2024-10-23
- 0.1.12 — 2024-08-22
- 0.1.11 — 2024-08-22
- … 8 more at https://npm.io/package/@dreamystify/fingrprint/versions

## README

<div align="center">
  <br/>
  <img src="./img/logo.png" width="300" />
  <br/>
  <br/>
  <p>
    A distributed, k-sortable unique ID generation system using Redis and Lua, inspired by Icicle.
  </p>
  <p>
  <a href="https://badge.fury.io/js/@dreamystify%2Ffingrprint"><img src="https://badge.fury.io/js/@dreamystify%2Ffingrprint.svg" alt="npm version" height="18"></a>
  <a href='https://coveralls.io/github/Dreamystify/fingrprint?branch=main'><img src='https://coveralls.io/repos/github/Dreamystify/fingrprint/badge.svg?branch=main' alt='Coverage Status' height="18"/></a>

  </p>
</div>

## Getting started

**Prerequisites**

* Node.js v18+ (ES modules support required)
* Redis v7+ (or a Redis Cluster for distributed mode)

```sh
# Initialize the repo (if applicable)
./.scripts/init.sh
```

## Installation

```sh
npm install @dreamystify/fingrprint
```

To build the package locally with esbuild, run:

```sh
npm run build
```

## ES Modules Support

This package is built as an ES module and requires Node.js v18+ with ES modules support. When using this package:

- Use `import` statements instead of `require()`
- Ensure your `package.json` has `"type": "module"` or use `.mjs` file extensions
- The package exports are optimized for ES module resolution

## Usage

The Fingrprint library supports three connection modes: standalone, Sentinel, and Cluster. Below are examples for each mode.

### Standalone Mode

```javascript
import { Fingrprint } from '@dreamystify/fingrprint';

(async () => {
  // Initialize Fingrprint with standalone Redis
  const fingrprint = await Fingrprint.initialize({
    host: 'localhost',
    port: 6379,
    username: 'yourUsername',    // if using authentication
    password: 'yourPassword',    // if using authentication
    database: 0,
  });

  // Generate a single unique ID
  const id = await fingrprint.getId();
  console.log('Generated ID:', id);
  
  // Generate a batch of 3 IDs
  const ids = await fingrprint.getIds(3);
  console.log('Generated IDs:', ids);
})();
```

### Sentinel Mode

```javascript
import { Fingrprint } from '@dreamystify/fingrprint';

(async () => {
  // Initialize Fingrprint using Redis Sentinel
  const fingrprint = await Fingrprint.initialize({
    sentinels: [
      { host: 'sentinel1', port: 26379 },
      { host: 'sentinel2', port: 26379 }
    ],
    name: 'mymaster',             // name of your master instance
    username: 'yourUsername',     // for the master
    password: 'yourPassword',     // for the master
    sentinelUsername: 'sentinelUser',    // if your Sentinel requires authentication
    sentinelPassword: 'sentinelPassword',// if your Sentinel requires authentication
    database: 0,
  });

  const id = await fingrprint.getId();
  console.log('Generated ID:', id);
})();
```

### Cluster Mode

```javascript
import { Fingrprint } from '@dreamystify/fingrprint';

(async () => {
  // Initialize Fingrprint using Redis Cluster
  const fingrprint = await Fingrprint.initialize({
    clusterNodes: [
      { host: 'redis-cluster-node1', port: 6379 },
      { host: 'redis-cluster-node2', port: 6379 },
      { host: 'redis-cluster-node3', port: 6379 }
    ],
    username: 'yourUsername',   // for cluster authentication
    password: 'yourPassword',   // for cluster authentication
    database: 0,
  });

  const id = await fingrprint.getId();
  console.log('Generated ID:', id);
})();
```

### Sharding Configuration

```javascript
import { Fingrprint } from '@dreamystify/fingrprint';

(async () => {
  // Initialize Fingrprint with a custom shard configuration (for standalone mode)
  const fingrprint = await Fingrprint.initialize({
    host: 'localhost',
    port: 6379,
    username: 'yourUsername',
    password: 'yourPassword',
    database: 0,
    // Optionally set a fixed shard ID via environment variable:
    // FINGRPRINT_SHARD_ID_KEY: '{fingrprint}-shard-id',
    // FINGRPRINT_SHARD_ID: '1',
  });

  const id = await fingrprint.getId();
  console.log('Generated ID:', id);
})();
```

In Cluster mode, the library automatically assigns shard IDs to master nodes based on the cluster topology. You can later query each node (using redis-cli) to see the assigned shard IDs:

```sh
docker run -it --rm --network redis_cluster redis:7.0.2 redis-cli -a yourPassword --cluster call redis-cluster-node1:6379 GET '{fingrprint}-shard-id'
```

## Error Handling

Fingrprint emits events for errors. It is designed to let your application handle logging and error processing in a way that suits your needs. For example:

```javascript
fingrprint.on('error', (error) => {
  console.error('Fingrprint error:', error.error);
});

fingrprint.on('connect', () => {
  console.log('Fingrprint connected to Redis');
});
```

## Events

| Event Constant                    | Event String                    | Description                                                                                           |
| --------------------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `CLIENT_CREATED`                  | `clientCreated`                 | Emitted when the Redis client instance is successfully created.                                     |
| `CONNECTED`                       | `connected`                     | Emitted when the client has successfully connected to Redis.                                        |
| `SCRIPT_LOADED`                   | `scriptLoaded`                  | Emitted when a Lua script is successfully loaded on a Redis node.                                     |
| `NODE_ADDED`                      | `nodeAdded`                     | Emitted when a new node is detected in a cluster.                                                   |
| `NODE_REMOVED`                    | `nodeRemoved`                   | Emitted when a node is removed from a cluster.                                                      |
| `CLUSTER_NODE_ADDED`              | `+node`                         | Emitted when a new cluster node is added (internal cluster topology event).                         |
| `CLUSTER_NODE_REMOVED`            | `-node`                         | Emitted when a cluster node is removed (internal cluster topology event).                           |
| `ERROR`                           | `error`                         | Emitted when an error occurs within the Fingrprint library.                                         |
| **Redis Connection Events**       |                                 |                                                                                                       |
| `CONNECT`                         | `connect`                       | Emitted when a connection is established.                                                           |
| `CONNECTING`                      | `connecting`                    | Emitted when the client is attempting to establish a connection.                                    |
| `RECONNECTING`                    | `reconnecting`                  | Emitted when the client is attempting to reconnect after a disconnect or error.                     |
| `DISCONNECTED`                    | `disconnected`                  | Emitted when the client has been disconnected.                                                      |
| `WAIT`                            | `wait`                          | Emitted when the client is waiting (typically during retry/backoff).                                |
| `READY`                           | `ready`                         | Emitted when the client is ready to accept commands.                                                |
| `CLOSE`                           | `close`                         | Emitted when the connection is closed.                                                              |
| `END`                             | `end`                           | Emitted when the connection has ended.                                                              |
| `RECONNECTED`                     | `reconnected`                   | Emitted when the client has successfully reconnected.                                             |
| `RECONNECTION_ATTEMPTS_REACHED`   | `reconnectionAttemptsReached`   | Emitted when the maximum number of reconnection attempts is reached and no further retries occur.   |

## Testing

```sh
# Start the testing environment
ahoy start

# Run the tests with coverage
npm test

# Run tests with coverage reporting
npm run coverage

# Stop the testing environment
ahoy stop
```

### Testing Sentinel and Cluster

```sh
# Start the testing environment
ahoy start

# Check docker logs 
ahoy logs

# Stop the testing environment
ahoy stop
```

## Kudos

The project was inspired by [Icicle](https://github.com/intenthq/icicle), just setup for node.js.

---
_Source: https://npm.io/package/@dreamystify/fingrprint · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._