From 2dc2137903b821c4ffedb757a89679327911bb3b Mon Sep 17 00:00:00 2001 From: Rakheyl <89585341+Rakheyl@users.noreply.github.com> Date: Mon, 6 Sep 2021 17:39:29 +0200 Subject: [PATCH] V1.0.0 --- .github/workflows/npm-publish.yml | 50 ++ .gitignore | 747 ++++++++++++++++++++++++++++++ README.md | 89 ++++ package.json | 38 ++ src/index.ts | 131 ++++++ tsconfig.json | 24 + 6 files changed, 1079 insertions(+) create mode 100644 .github/workflows/npm-publish.yml create mode 100644 .gitignore create mode 100644 README.md create mode 100644 package.json create mode 100644 src/index.ts create mode 100644 tsconfig.json diff --git a/.github/workflows/npm-publish.yml b/.github/workflows/npm-publish.yml new file mode 100644 index 0000000..7c0a9b0 --- /dev/null +++ b/.github/workflows/npm-publish.yml @@ -0,0 +1,50 @@ +# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created +# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages + +name: Node.js Package + +on: + release: + types: [created] + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-node@v2 + with: + node-version: 14 + - run: npm test + + publish-gpr: + needs: build + runs-on: ubuntu-latest + permissions: + contents: read + packages: write + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-node@v2 + with: + node-version: 14 + - run: node -e "const fs=require('fs');const path=require('path');const pkg=require('./package.json');pkg.name='@rakheyl/'+pkg.name;fs.writeFileSync(path.join(__dirname,'./package.json'),JSON.stringify(pkg));" + - run: echo "//npm.pkg.github.com/:_authToken=${{ secrets.GITHUB_TOKEN }}" >> .npmrc + - run: npm run build + - run: npm publish --access public --registry=https://npm.pkg.github.com + env: + NPM_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + publish-npm: + needs: [build, publish-gpr] + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-node@v2 + with: + node-version: 14 + registry-url: "https://registry.npmjs.org" + - run: npm run build + - run: npm publish --access public + env: + NODE_AUTH_TOKEN: ${{ secrets.NPM_SECRET }} \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..adfd955 --- /dev/null +++ b/.gitignore @@ -0,0 +1,747 @@ +# Created by https://www.toptal.com/developers/gitignore/api/vim,git,node,linux,windows,sublimetext,visualstudio,webstorm+all,visualstudiocode,macos +# Edit at https://www.toptal.com/developers/gitignore?templates=vim,git,node,linux,windows,sublimetext,visualstudio,webstorm+all,visualstudiocode,macos + +### Git ### +# Created by git for backups. To disable backups in Git: +# $ git config --global mergetool.keepBackup false +*.orig + +# Created by git when using merge tools for conflicts +*.BACKUP.* +*.BASE.* +*.LOCAL.* +*.REMOTE.* +*_BACKUP_*.txt +*_BASE_*.txt +*_LOCAL_*.txt +*_REMOTE_*.txt + +### Linux ### +*~ + +# temporary files which can be created if a process still has a handle open of a deleted file +.fuse_hidden* + +# KDE directory preferences +.directory + +# Linux trash folder which might appear on any partition or disk +.Trash-* + +# .nfs files are created when an open file is removed but is still being accessed +.nfs* + +### macOS ### +# General +.DS_Store +.AppleDouble +.LSOverride + +# Icon must end with two \r +Icon + + +# Thumbnails +._* + +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns +.com.apple.timemachine.donotpresent + +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk + +### Node ### +# Logs +logs +*.log +npm-debug.log* +yarn-debug.log* +yarn-error.log* +lerna-debug.log* +.pnpm-debug.log* + +# Diagnostic reports (https://nodejs.org/api/report.html) +report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json + +# Runtime data +pids +*.pid +*.seed +*.pid.lock + +# Directory for instrumented libs generated by jscoverage/JSCover +lib-cov + +# Coverage directory used by tools like istanbul +coverage +*.lcov + +# nyc test coverage +.nyc_output + +# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) +.grunt + +# Bower dependency directory (https://bower.io/) +bower_components + +# node-waf configuration +.lock-wscript + +# Compiled binary addons (https://nodejs.org/api/addons.html) +build/Release + +# Dependency directories +node_modules/ +jspm_packages/ + +# Snowpack dependency directory (https://snowpack.dev/) +web_modules/ + +# TypeScript cache +*.tsbuildinfo + +# Optional npm cache directory +.npm + +# Optional eslint cache +.eslintcache + +# Microbundle cache +.rpt2_cache/ +.rts2_cache_cjs/ +.rts2_cache_es/ +.rts2_cache_umd/ + +# Optional REPL history +.node_repl_history + +# Output of 'npm pack' +*.tgz + +# Yarn Integrity file +.yarn-integrity + +# dotenv environment variables file +.env +.env.test +.env.production + +# parcel-bundler cache (https://parceljs.org/) +.cache +.parcel-cache + +# Next.js build output +.next +out + +# Nuxt.js build / generate output +.nuxt +dist + +# Gatsby files +.cache/ +# Comment in the public line in if your project uses Gatsby and not Next.js +# https://nextjs.org/blog/next-9-1#public-directory-support +# public + +# vuepress build output +.vuepress/dist + +# Serverless directories +.serverless/ + +# FuseBox cache +.fusebox/ + +# DynamoDB Local files +.dynamodb/ + +# TernJS port file +.tern-port + +# Stores VSCode versions used for testing VSCode extensions +.vscode-test + +# yarn v2 +.yarn/cache +.yarn/unplugged +.yarn/build-state.yml +.yarn/install-state.gz +.pnp.* + +### SublimeText ### +# Cache files for Sublime Text +*.tmlanguage.cache +*.tmPreferences.cache +*.stTheme.cache + +# Workspace files are user-specific +*.sublime-workspace + +# Project files should be checked into the repository, unless a significant +# proportion of contributors will probably not be using Sublime Text +# *.sublime-project + +# SFTP configuration file +sftp-config.json +sftp-config-alt*.json + +# Package control specific files +Package Control.last-run +Package Control.ca-list +Package Control.ca-bundle +Package Control.system-ca-bundle +Package Control.cache/ +Package Control.ca-certs/ +Package Control.merged-ca-bundle +Package Control.user-ca-bundle +oscrypto-ca-bundle.crt +bh_unicode_properties.cache + +# Sublime-github package stores a github token in this file +# https://packagecontrol.io/packages/sublime-github +GitHub.sublime-settings + +### Vim ### +# Swap +[._]*.s[a-v][a-z] +!*.svg # comment out if you don't need vector files +[._]*.sw[a-p] +[._]s[a-rt-v][a-z] +[._]ss[a-gi-z] +[._]sw[a-p] + +# Session +Session.vim +Sessionx.vim + +# Temporary +.netrwhist +# Auto-generated tag files +tags +# Persistent undo +[._]*.un~ + +### VisualStudioCode ### +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json +*.code-workspace + +# Local History for Visual Studio Code +.history/ + +### VisualStudioCode Patch ### +# Ignore all local history of files +.history +.ionide + +### WebStorm+all ### +# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider +# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 + +# User-specific stuff +.idea/**/workspace.xml +.idea/**/tasks.xml +.idea/**/usage.statistics.xml +.idea/**/dictionaries +.idea/**/shelf + +# AWS User-specific +.idea/**/aws.xml + +# Generated files +.idea/**/contentModel.xml + +# Sensitive or high-churn files +.idea/**/dataSources/ +.idea/**/dataSources.ids +.idea/**/dataSources.local.xml +.idea/**/sqlDataSources.xml +.idea/**/dynamic.xml +.idea/**/uiDesigner.xml +.idea/**/dbnavigator.xml + +# Gradle +.idea/**/gradle.xml +.idea/**/libraries + +# Gradle and Maven with auto-import +# When using Gradle or Maven with auto-import, you should exclude module files, +# since they will be recreated, and may cause churn. Uncomment if using +# auto-import. +# .idea/artifacts +# .idea/compiler.xml +# .idea/jarRepositories.xml +# .idea/modules.xml +# .idea/*.iml +# .idea/modules +# *.iml +# *.ipr + +# CMake +cmake-build-*/ + +# Mongo Explorer plugin +.idea/**/mongoSettings.xml + +# File-based project format +*.iws + +# IntelliJ +out/ + +# mpeltonen/sbt-idea plugin +.idea_modules/ + +# JIRA plugin +atlassian-ide-plugin.xml + +# Cursive Clojure plugin +.idea/replstate.xml + +# Crashlytics plugin (for Android Studio and IntelliJ) +com_crashlytics_export_strings.xml +crashlytics.properties +crashlytics-build.properties +fabric.properties + +# Editor-based Rest Client +.idea/httpRequests + +# Android studio 3.1+ serialized cache file +.idea/caches/build_file_checksums.ser + +### WebStorm+all Patch ### +# Ignores the whole .idea folder and all .iml files +# See https://github.com/joeblau/gitignore.io/issues/186 and https://github.com/joeblau/gitignore.io/issues/360 + +.idea/ + +# Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-249601023 + +*.iml +modules.xml +.idea/misc.xml +*.ipr + +# Sonarlint plugin +.idea/sonarlint + +### Windows ### +# Windows thumbnail cache files +Thumbs.db +Thumbs.db:encryptable +ehthumbs.db +ehthumbs_vista.db + +# Dump file +*.stackdump + +# Folder config file +[Dd]esktop.ini + +# Recycle Bin used on file shares +$RECYCLE.BIN/ + +# Windows Installer files +*.cab +*.msi +*.msix +*.msm +*.msp + +# Windows shortcuts +*.lnk + +### VisualStudio ### +## Ignore Visual Studio temporary files, build results, and +## files generated by popular Visual Studio add-ons. +## +## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore + +# User-specific files +*.rsuser +*.suo +*.user +*.userosscache +*.sln.docstates + +# User-specific files (MonoDevelop/Xamarin Studio) +*.userprefs + +# Mono auto generated files +mono_crash.* + +# Build results +[Dd]ebug/ +[Dd]ebugPublic/ +[Rr]elease/ +[Rr]eleases/ +x64/ +x86/ +[Ww][Ii][Nn]32/ +[Aa][Rr][Mm]/ +[Aa][Rr][Mm]64/ +bld/ +[Bb]in/ +[Oo]bj/ +[Ll]og/ +[Ll]ogs/ + +# Visual Studio 2015/2017 cache/options directory +.vs/ +# Uncomment if you have tasks that create the project's static files in wwwroot +#wwwroot/ + +# Visual Studio 2017 auto generated files +Generated\ Files/ + +# MSTest test Results +[Tt]est[Rr]esult*/ +[Bb]uild[Ll]og.* + +# NUnit +*.VisualState.xml +TestResult.xml +nunit-*.xml + +# Build Results of an ATL Project +[Dd]ebugPS/ +[Rr]eleasePS/ +dlldata.c + +# Benchmark Results +BenchmarkDotNet.Artifacts/ + +# .NET Core +project.lock.json +project.fragment.lock.json +artifacts/ + +# ASP.NET Scaffolding +ScaffoldingReadMe.txt + +# StyleCop +StyleCopReport.xml + +# Files built by Visual Studio +*_i.c +*_p.c +*_h.h +*.ilk +*.meta +*.obj +*.iobj +*.pch +*.pdb +*.ipdb +*.pgc +*.pgd +*.rsp +*.sbr +*.tlb +*.tli +*.tlh +*.tmp +*.tmp_proj +*_wpftmp.csproj +*.tlog +*.vspscc +*.vssscc +.builds +*.pidb +*.svclog +*.scc + +# Chutzpah Test files +_Chutzpah* + +# Visual C++ cache files +ipch/ +*.aps +*.ncb +*.opendb +*.opensdf +*.sdf +*.cachefile +*.VC.db +*.VC.VC.opendb + +# Visual Studio profiler +*.psess +*.vsp +*.vspx +*.sap + +# Visual Studio Trace Files +*.e2e + +# TFS 2012 Local Workspace +$tf/ + +# Guidance Automation Toolkit +*.gpState + +# ReSharper is a .NET coding add-in +_ReSharper*/ +*.[Rr]e[Ss]harper +*.DotSettings.user + +# TeamCity is a build add-in +_TeamCity* + +# DotCover is a Code Coverage Tool +*.dotCover + +# AxoCover is a Code Coverage Tool +.axoCover/* +!.axoCover/settings.json + +# Coverlet is a free, cross platform Code Coverage Tool +coverage*.json +coverage*.xml +coverage*.info + +# Visual Studio code coverage results +*.coverage +*.coveragexml + +# NCrunch +_NCrunch_* +.*crunch*.local.xml +nCrunchTemp_* + +# MightyMoose +*.mm.* +AutoTest.Net/ + +# Web workbench (sass) +.sass-cache/ + +# Installshield output folder +[Ee]xpress/ + +# DocProject is a documentation generator add-in +DocProject/buildhelp/ +DocProject/Help/*.HxT +DocProject/Help/*.HxC +DocProject/Help/*.hhc +DocProject/Help/*.hhk +DocProject/Help/*.hhp +DocProject/Help/Html2 +DocProject/Help/html + +# Click-Once directory +publish/ + +# Publish Web Output +*.[Pp]ublish.xml +*.azurePubxml +# Note: Comment the next line if you want to checkin your web deploy settings, +# but database connection strings (with potential passwords) will be unencrypted +*.pubxml +*.publishproj + +# Microsoft Azure Web App publish settings. Comment the next line if you want to +# checkin your Azure Web App publish settings, but sensitive information contained +# in these scripts will be unencrypted +PublishScripts/ + +# NuGet Packages +*.nupkg +# NuGet Symbol Packages +*.snupkg +# The packages folder can be ignored because of Package Restore +**/[Pp]ackages/* +# except build/, which is used as an MSBuild target. +!**/[Pp]ackages/build/ +# Uncomment if necessary however generally it will be regenerated when needed +#!**/[Pp]ackages/repositories.config +# NuGet v3's project.json files produces more ignorable files +*.nuget.props +*.nuget.targets + +# Nuget personal access tokens and Credentials +nuget.config + +# Microsoft Azure Build Output +csx/ +*.build.csdef + +# Microsoft Azure Emulator +ecf/ +rcf/ + +# Windows Store app package directories and files +AppPackages/ +BundleArtifacts/ +Package.StoreAssociation.xml +_pkginfo.txt +*.appx +*.appxbundle +*.appxupload + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!?*.[Cc]ache/ + +# Others +ClientBin/ +~$* +*.dbmdl +*.dbproj.schemaview +*.jfm +*.pfx +*.publishsettings +orleans.codegen.cs + +# Including strong name files can present a security risk +# (https://github.com/github/gitignore/pull/2483#issue-259490424) +#*.snk + +# Since there are multiple workflows, uncomment next line to ignore bower_components +# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) +#bower_components/ + +# RIA/Silverlight projects +Generated_Code/ + +# Backup & report files from converting an old project file +# to a newer Visual Studio version. Backup files are not needed, +# because we have git ;-) +_UpgradeReport_Files/ +Backup*/ +UpgradeLog*.XML +UpgradeLog*.htm +ServiceFabricBackup/ +*.rptproj.bak + +# SQL Server files +*.mdf +*.ldf +*.ndf + +# Business Intelligence projects +*.rdl.data +*.bim.layout +*.bim_*.settings +*.rptproj.rsuser +*- [Bb]ackup.rdl +*- [Bb]ackup ([0-9]).rdl +*- [Bb]ackup ([0-9][0-9]).rdl + +# Microsoft Fakes +FakesAssemblies/ + +# GhostDoc plugin setting file +*.GhostDoc.xml + +# Node.js Tools for Visual Studio +.ntvs_analysis.dat + +# Visual Studio 6 build log +*.plg + +# Visual Studio 6 workspace options file +*.opt + +# Visual Studio 6 auto-generated workspace file (contains which files were open etc.) +*.vbw + +# Visual Studio LightSwitch build output +**/*.HTMLClient/GeneratedArtifacts +**/*.DesktopClient/GeneratedArtifacts +**/*.DesktopClient/ModelManifest.xml +**/*.Server/GeneratedArtifacts +**/*.Server/ModelManifest.xml +_Pvt_Extensions + +# Paket dependency manager +.paket/paket.exe +paket-files/ + +# FAKE - F# Make +.fake/ + +# CodeRush personal settings +.cr/personal + +# Python Tools for Visual Studio (PTVS) +__pycache__/ +*.pyc + +# Cake - Uncomment if you are using it +# tools/** +# !tools/packages.config + +# Tabs Studio +*.tss + +# Telerik's JustMock configuration file +*.jmconfig + +# BizTalk build output +*.btp.cs +*.btm.cs +*.odx.cs +*.xsd.cs + +# OpenCover UI analysis results +OpenCover/ + +# Azure Stream Analytics local run output +ASALocalRun/ + +# MSBuild Binary and Structured Log +*.binlog + +# NVidia Nsight GPU debugger configuration file +*.nvuser + +# MFractors (Xamarin productivity tool) working folder +.mfractor/ + +# Local History for Visual Studio +.localhistory/ + +# BeatPulse healthcheck temp database +healthchecksdb + +# Backup folder for Package Reference Convert tool in Visual Studio 2017 +MigrationBackup/ + +# Ionide (cross platform F# VS Code tools) working folder +.ionide/ + +# Fody - auto-generated XML schema +FodyWeavers.xsd + +# VS Code files for those working on multiple tools + +# Local History for Visual Studio Code + +# Windows Installer files from build outputs + +# JetBrains Rider +*.sln.iml + +### VisualStudio Patch ### +# Additional files built by Visual Studio + +# End of https://www.toptal.com/developers/gitignore/api/vim,git,node,linux,windows,sublimetext,visualstudio,webstorm+all,visualstudiocode,macos \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..81f0beb --- /dev/null +++ b/README.md @@ -0,0 +1,89 @@ +
+
+

+ + NPM Repository +

+

+ + GitHub issues + + + GitHub license + + + node-current + + + NPM version + +

+
+ +# Snowflake-UUID + +[Twitter's Snowflake](https://github.com/twitter-archive/snowflake/tree/snowflake-2010) generator for NodeJS. + +- Speedy +- Lightweight +- Zero dependencies + +Snowflake-UUID can generate unique Id numbers at high scale with some simple guarantees. + +## Installing + +``` +npm install snowflake-uuid +// or +yarn add snowflake-uuid +// or +pnpm add snowflake-uuid +``` + +## Example + +```js +import { Worker } from 'snowflake-uuid'; +// const { Worker } = require('snowflake-uuid'); + +const generator = new Worker(0, 1, { + workerIdBits: 5, + datacenterIdBits: 5, + sequenceBits: 12, +}); + +generator.nextId(); // 87559690812260352n +generator.nextId().toString(); // 87559690833231872 + +generator.getCurrentSequence(); // 0n +generator.getDatacenterId(); // 1n +generator.getLastTimestamp(); // 1630335057075n +generator.getWorkerId(); // 0n +``` + +Generated IDs are [BigInt](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt) and can be easily converted into strings. + +## Constructor Options + +| Property | Description | Optional? | Type | Default Value | +| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------- | --------- | ---------------- | ------------- | +| workerId | Id for the worker | Yes | Number or BigInt | 0 | +| datacenterId | Identifier of the datacenter to which the worker belongs | Yes | Number or BigInt | 0 | +| options | Custom options for the worker | Yes | Object | undefined | +| options.epoch | Custom epoch for timestamp generation. By default, the number of milliseconds since the first second of 2021 | Yes | Number or BigInt | 1609459200000 | +| options.workerIdBits | Number of usable bits for Worker Id. 5 by default, allows up to 31 Workers | Yes | Number or BigInt | 5 | +| options.datacenterIdBits | Number of usable bits for Datacenter Id. 5 by default, allows up to 31 Datacenters | Yes | Number or BigInt | 5 | +| options.sequence | For every Id that is generated on that process, this number is incremented | Yes | Number or BigInt | 0 | +| options.sequenceBits | Number of usable bits for Sequence Id. 12 by default, allows up to 4095 generations per millisecond per Worker per Datacenter | Yes | Number or BigInt | 12 | + +## Useful Links + +- [Twitter's Snowflake repository](https://github.com/twitter-archive/snowflake/tree/snowflake-2010) +- [Announcing Snowflake](https://blog.twitter.com/engineering/en_us/a/2010/announcing-snowflake.html) +- [Twitter Ids](https://developer.twitter.com/en/docs/twitter-ids) +- [The GitHub repo](https://github.com/rakheyl/snowflake-uuid) +- [The NPM package](https://www.npmjs.com/package/snowflake-uuid) + +## License + +Refer to the [LICENSE](LICENSE) file. diff --git a/package.json b/package.json new file mode 100644 index 0000000..15a2b37 --- /dev/null +++ b/package.json @@ -0,0 +1,38 @@ +{ + "author": { + "name": "Rakheyl", + "url": "https://github.com/rakheyl/" + }, + "bugs": { + "url": "https://github.com/rakheyl/snowflake-uuid/issues" + }, + "description": "Twitter's Snowflake generator implementation for NodeJS", + "engines": { + "node": ">=12.0.0" + }, + "files": [ + "/dist" + ], + "homepage": "https://github.com/rakheyl/snowflake-uuid#readme", + "keywords": [ + "snowflake", + "uuid", + "id" + ], + "license": "GPL-3.0-or-later", + "main": "./dist/index.js", + "name": "snowflake-uuid", + "repository": { + "type": "git", + "url": "git+https://github.com/rakheyl/snowflake-uuid.git" + }, + "scripts": { + "build": "npx tsc", + "test": "npx tsc && node ./lib/index.js" + }, + "types": "./dist/index.d.ts", + "version": "1.0.0", + "devDependencies": { + "typescript": "^4.4.2" + } +} \ No newline at end of file diff --git a/src/index.ts b/src/index.ts new file mode 100644 index 0000000..e124666 --- /dev/null +++ b/src/index.ts @@ -0,0 +1,131 @@ +'use strict'; + +type Snowflake = bigint | number; + +interface WorkerOptions { + epoch?: Snowflake; + workerIdBits?: Snowflake; + datacenterIdBits?: Snowflake; + sequence?: Snowflake; + sequenceBits?: Snowflake; +} + +export class Worker { + #epoch: bigint; + #workerId: bigint; + #workerIdBits: bigint; + #maxWorkerId: bigint; + #datacenterId: bigint; + #datacenterIdBits: bigint; + #maxDatacenterId: bigint; + #sequence: bigint; + #sequenceBits: bigint; + #workerIdShift: bigint; + #datacenterIdShift: bigint; + #timestampLeftShift: bigint; + #sequenceMask: bigint; + #lastTimestamp: bigint = -1n; + + constructor(workerId: Snowflake = 0n, datacenterId: Snowflake = 0n, options?: WorkerOptions) { + // Epoch + this.#epoch = BigInt(options?.epoch ?? 1609459200000); + + // Worker + this.#workerId = BigInt(workerId); + this.#workerIdBits = BigInt(options?.workerIdBits ?? 5); + this.#maxWorkerId = -1n ^ (-1n << this.#workerIdBits); + if (this.#workerId < 0 || this.#workerId > this.#maxWorkerId) { + throw new Error( + 'With ' + + this.#workerIdBits.toString() + + " bits, worker id can't be greater than " + + this.#maxWorkerId.toString() + + ' or less than 0', + ); + } + + // Datacenter + this.#datacenterId = BigInt(datacenterId); + this.#datacenterIdBits = BigInt(options?.datacenterIdBits ?? 5); + this.#maxDatacenterId = -1n ^ (-1n << this.#datacenterIdBits); + if (this.#datacenterId > this.#maxDatacenterId || this.#datacenterId < 0) { + throw new Error( + 'With ' + + this.#datacenterIdBits.toString() + + " bits, datacenter id can't be greater than " + + this.#maxDatacenterId.toString() + + ' or less than 0', + ); + } + + // Sequence + this.#sequence = BigInt(options?.sequence ?? 0); + this.#sequenceBits = BigInt(options?.sequenceBits ?? 12); + this.#sequenceMask = -1n ^ (-1n << this.#sequenceBits); + + // Shift + this.#workerIdShift = this.#sequenceBits; + this.#datacenterIdShift = this.#sequenceBits + this.#workerIdBits; + this.#timestampLeftShift = this.#sequenceBits + this.#workerIdBits + this.#datacenterIdBits; + } + + get workerId(): bigint { + return this.#workerId; + } + + get datacenterId(): bigint { + return this.#datacenterId; + } + + get currentSequence(): bigint { + return this.#sequence; + } + + get lastTimestamp(): bigint { + return this.#lastTimestamp; + } + + nextId(): bigint { + let timestamp = Worker.now(); + + if (timestamp < this.#lastTimestamp) { + throw new Error( + "Clock moved backwards. Can't generate new ID for " + + (this.#lastTimestamp - timestamp).toString() + + 'milliseconds.', + ); + } + + if (timestamp === this.#lastTimestamp) { + this.#sequence = (this.#sequence + 1n) & this.#sequenceMask; + if (this.#sequence === 0n) { + timestamp = this.tilNextMillis(this.#lastTimestamp); + } + } else { + this.#sequence = 0n; + } + + this.#lastTimestamp = timestamp; + + return ( + ((timestamp - this.#epoch) << this.#timestampLeftShift) | + (this.#datacenterId << this.#datacenterIdShift) | + (this.#workerId << this.#workerIdShift) | + this.#sequence + ); + } + + tilNextMillis(lastTimestamp: bigint): bigint { + let timestamp; + + do { + timestamp = Worker.now(); + } while (timestamp <= lastTimestamp); + + return timestamp; + } + + static now(): bigint { + return BigInt(Date.now()); + } +} diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..a63841d --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,24 @@ +{ + "compilerOptions": { + "target": "ESNext" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */, + "module": "CommonJS" /* Specify what module code is generated. */, + "resolveJsonModule": true /* Enable importing .json files */, + "declaration": true /* Generate .d.ts files from TypeScript and JavaScript files in your project. */, + "outDir": "./dist" /* Specify an output folder for all emitted files. */, + "removeComments": true /* Disable emitting comments. */, + "newLine": "lf" /* Set the newline character for emitting files. */, + "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */, + "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */, + "strict": true /* Enable all strict type-checking options. */, + "noImplicitAny": true /* Enable error reporting for expressions and declarations with an implied `any` type.. */, + "strictNullChecks": true /* When type checking, take into account `null` and `undefined`. */, + "strictFunctionTypes": true /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */, + "strictBindCallApply": true /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */, + "strictPropertyInitialization": true /* Check for class properties that are declared but not set in the constructor. */, + "noImplicitThis": true /* Enable error reporting when `this` is given the type `any`. */, + "alwaysStrict": true /* Ensure 'use strict' is always emitted. */, + "noUnusedLocals": true /* Enable error reporting when a local variables aren't read. */, + "noUnusedParameters": true /* Raise an error when a function parameter isn't read */ + }, + "include": ["./src"] +}