refactor(project): refactored with more simple APIs

Author: fenying

.gitignore

@@ -1,3 +1,4 @@
-/libs/
-/samples/
+/lib/
+/examples/
 /node_modules/
+typedoc-sidebar.json

.husky/.gitignore

@@ -0,0 +1 @@
+_

.husky/commit-msg

@@ -0,0 +1,5 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx --no-install commitlint --edit "$1"
+npm run typecheck && npm run lint && npm run test

.npmignore

@@ -4,5 +4,12 @@
 /node_modules/
 /.gitignore
 /.npmignore
-/tslint.json
 /tsconfig.json
+/examples/
+/src/examples/
+/.eslintrc
+/.eslintignore
+/utils/
+/.husky/
+/eslint.config.js
+/commitlint.config.js

.vscode/launch.json

@@ -1,5 +1,15 @@
 # Changes Logs
 
+## v2.0.0
+
+- feat(algo): added implements of GUIDv4 algorithm.
+- feat(algo): added implements of GUIDv5 algorithm.
+- fix(algo): allow Snowflake using custom epoch.
+- fix(algo): implement Snowflake-SI with more customization options.
+- deprecate(algo): removed the Snowflake-SI-vA algorithm, which is no longer recommended.
+- test(project): added unit tests.
+- deprecate(deps): removed all runtime dependencies.
+
 ## v1.0.0
 
 - Refactored the project.

CHANGES.md

@@ -1,5 +1,6 @@
 # LiteRT/UUID
 
+[![Strict TypeScript Checked](https://badgen.net/badge/TS/Strict "Strict TypeScript Checked")](https://www.typescriptlang.org)
 [![npm version](https://img.shields.io/npm/v/@litert/uuid.svg?colorB=brightgreen)](https://www.npmjs.com/package/@litert/uuid "Stable Version")
 [![License](https://img.shields.io/npm/l/@litert/uuid.svg?maxAge=2592000?style=plastic)](https://github.com/litert/uuid/blob/master/LICENSE)
 [![node](https://img.shields.io/node/v/@litert/uuid.svg?colorB=brightgreen)](https://nodejs.org/dist/latest-v8.x/)
@@ -10,8 +11,8 @@ A uuid generator library for LiteRT framework.
 
 ## Requirement
 
-- TypeScript v2.7.1 (or newer)
-- Node.js v7.0.0 (or newer)
+- TypeScript v5.0.0 (or newer)
+- Node.js v18.0.0 (or newer)
 
 ## Installation
 
@@ -21,122 +22,36 @@ Install by NPM:
 npm i @litert/uuid --save
 ```
 
-## Algorithms
-
-Following algorithms are supported:
-
-### [Snowflake](https://blog.twitter.com/engineering/en_us/a/2010/announcing-snowflake.html)
-
-A 64-bit integer UUID algorithm provided by Twitter.
-
-### [Snowflake-SI](./docs/en-US/Snowflake-SI.md)
-
-The Snowflake-SI algorithm generates safe integer (52-bits integer) for
-JavaScript, with capacity 128 uuids per milliseconds, and 64 machine parallel
-working.
-
-### [Snowflake-SI-vA](./docs/en-US/Snowflake-SI-vA.md)
-
-A variant of Snowflake-SI algorithm.
-
-## Samples
+## Documents
 
-### Snowflake-SI Usage
+- [English](https://litert.org/projects/uuid.js)
 
-```ts
-import * as libuuid from "@litert/uuid";
-
-const factory = UUID.SnowflakeBI.createFactory();
-
-const makeUUID = factory.create({
-
-    /**
-     * The machine ID.
-     *
-     * By default the uinBitWidth is 8, and the rest 5 bits is left to MID, so
-     * that the mid must be between 0 and 31.
-     */
-    "machineId": 1,
-
-    /**
-     * The base-clock of generator. Is unchangeable once setup.
-     *
-     * And it cannot be earlier than 2003-03-18T07:20:19.225Z.
-     */
-    "baseClock": new Date(2004, 0, 1, 0, 0, 0, 0).getTime(),
-});
+## Algorithms
 
-console.log(makeUUID());                    // Generate a UUID
-console.log(makeUUID());                    // Generate a UUID
-console.log(makeUUID.uinCapacity);          // See the capacity of UUIDs in 1ms
-console.log(makeUUID.machineId);            // See the machine ID.
-console.log(new Date(makeUUID.baseClock));  // See the base-clock
-```
+- [Snowflake](https://blog.twitter.com/engineering/en_us/a/2010/announcing-snowflake.html)
 
-### Snowflake-SI Adjustment
-
-```ts
-import * as libuuid from "@litert/uuid";
-
-const factory = UUID.SnowflakeBI.createFactory();
-
-const makeUUID = factory.create({
-
-    /**
-     * The machine ID.
-     *
-     * Now the uinBitWidth has been set to 12, and only 1 bit is left to MID, so
-     * that the mid can be either 1 or 0.
-     */
-    "mid": 1,
-
-    /**
-     * The base-clock of generator. Is unchangeable once setup.
-     *
-     * And it cannot be earlier than 2003-03-18T07:20:20Z
-     */
-    "baseClock": new Date(2004, 0, 1, 0, 0, 0, 0).getTime(),
-
-    /**
-     * The bit-width of UIN.
-     */
-    "uinBitWidth": 12
-});
-
-console.log(makeUUID());                    // Generate a UUID
-console.log(makeUUID());                    // Generate a UUID
-console.log(makeUUID.uinCapacity);          // See the capacity of UUIDs in 1ms
-console.log(makeUUID.machineId);            // See the machine ID.
-console.log(new Date(makeUUID.baseClock));  // See the base-clock
-```
+    A 64-bit integer UUID algorithm provided by X (Twitter).
 
-### Snowflake-SI-vA Usage
+- [Snowflake-SI](./docs/en-US/Snowflake-SI.md)
 
-```ts
-import * as libuuid from "@litert/uuid";
+    The Snowflake-SI algorithm generates safe integer (53-bits integer) for
+    JavaScript, with capacity 128 uuids per milliseconds, and 64 machine parallel
+    working.
 
-const factory = UUID.SnowflakeBIvA.createFactory();
+- UUIDv4
 
-const makeUUID = factory.create({
+    The UUID version 4 algorithm generates random UUIDs.
 
-    /**
-     * The ID of machine, 0 ~ 1023
-     */
-    "machineId": 333,
+- UUIDv5
 
-    /**
-     * Calculate the cursor of the incremental sequence insides generator by
-     * the last generated UUID.
-     */
-    "cursor": factory.calculateCursor(1562244321456127)
-});
+    The UUID version 5 algorithm generates UUIDs based on SHA-1 hash of a namespace and a name.
 
-console.log(nextUUID());
-console.log(nextUUID());
-console.log(nextUUID.machineId);
-console.log(Number.isSafeInteger(nextUUID()));
+## Examples
 
-```
+- [Snowflake](./src/examples/Snowflake.ts)
+- [Snowflake-SI](./src/examples/SnowflakeSI.ts)
+- [UUIDv4](./src/examples/UUIDv4.ts)
+- [UUIDv5](./src/examples/UUIDv5.ts)
 
 ## License