@toolkit-f/snowflake-id 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/dist/index.cjs +2 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +65 -0
- package/dist/index.d.ts +65 -0
- package/dist/index.js +2 -0
- package/dist/index.js.map +1 -0
- package/package.json +65 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 MAULIK MK
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/dist/index.cjs
ADDED
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
'use strict';var m=1023,c=4095n,i=12n,o=22n,s=17040672e5;var a=class{constructor(e){this.sequence=0n;this.lastTimestamp=-1;let{machineId:n,epoch:r=17040672e5,clockMoveBackAction:f="throw"}=e;if(n<0||n>1023||!Number.isInteger(n))throw new Error(`machineId must be integer 0-1023, got ${n}`);if(r<0||r>Date.now())throw new Error("epoch cannot be in the future");this.machineIdShifted=BigInt(n)<<i,this.epoch=r,this.clockMoveBackAction=f;}nextId(){let e=Date.now();if(e<this.lastTimestamp){let n=this.lastTimestamp-e;if(this.clockMoveBackAction==="wait"&&n<=50)for(;e<=this.lastTimestamp;)e=Date.now();else throw new Error(`Clock moved backwards by ${n}ms`)}if(e===this.lastTimestamp){if(this.sequence=this.sequence+1n&c,this.sequence===0n)for(;e<=this.lastTimestamp;)e=Date.now();}else this.sequence=0n;return this.lastTimestamp=e,BigInt(e-this.epoch)<<o|this.machineIdShifted|this.sequence}nextIdString(){return this.nextId().toString()}getMachineId(){return Number(this.machineIdShifted>>i)}getEpoch(){return this.epoch}getSequence(){return Number(this.sequence)}getLastTimestamp(){return this.lastTimestamp}};function p(t){return new a(t)}var g=c,u=BigInt(1023);function I(t,e=17040672e5){if(typeof t=="string"&&!/^\d+$/.test(t))throw new Error(`Invalid Snowflake ID: "${t}"`);let n=typeof t=="string"?BigInt(t):t,r=Number(n>>o)+e;return {id:n,timestamp:new Date(r),timestampMs:r,machineId:Number(n>>i&u),sequence:Number(n&g)}}function l(t){return {id:t.id.toString(),timestamp:t.timestamp.toISOString(),timestampMs:t.timestampMs,machineId:t.machineId,sequence:t.sequence}}function S(t,e=17040672e5){let n=typeof t=="string"?BigInt(t):t;return new Date(Number(n>>o)+e)}function h(t){let e=typeof t=="string"?BigInt(t):t;return Number(e>>i&u)}function w(t){let e=typeof t=="string"?BigInt(t):t;return Number(e&g)}function k(t,e=17040672e5,n=false){if(typeof t=="string"){if(!/^\d+$/.test(t))return false;try{t=BigInt(t);}catch{return false}}if(typeof t!="bigint"||t<0n)return false;if(n)return true;let r=Number(t>>o)+e;return r>=e&&r<=Date.now()+1e3}function E(t){return t.toString()}function M(t){if(!/^\d+$/.test(t))throw new Error(`Invalid Snowflake ID string: "${t}"`);return BigInt(t)}function T(t,e){let n=typeof t=="string"?BigInt(t):t,r=typeof e=="string"?BigInt(e):e;return n<r?-1:n>r?1:0}function b(t,e=0,n=0,r=17040672e5){let f=typeof t=="number"?t:t.getTime();return BigInt(f-r)<<o|BigInt(e)<<i|BigInt(n)}exports.DEFAULT_EPOCH=s;exports.MACHINE_ID_SHIFT=i;exports.MAX_MACHINE_ID=m;exports.MAX_SEQUENCE=c;exports.SnowflakeGenerator=a;exports.TIMESTAMP_SHIFT=o;exports.compareSnowflakes=T;exports.createGenerator=p;exports.getMachineId=h;exports.getSequence=w;exports.getTimestamp=S;exports.isValidSnowflake=k;exports.parseSnowflake=I;exports.snowflakeFromTimestamp=b;exports.snowflakeToString=E;exports.stringToSnowflake=M;exports.stringifySnowflakeParts=l;//# sourceMappingURL=index.cjs.map
|
|
2
|
+
//# sourceMappingURL=index.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/core/generator.ts","../src/utils/index.ts"],"names":["MAX_MACHINE_ID","MAX_SEQUENCE","MACHINE_ID_SHIFT","TIMESTAMP_SHIFT","DEFAULT_EPOCH","SnowflakeGenerator","config","machineId","epoch","clockMoveBackAction","ts","drift","createGenerator","SEQUENCE_MASK","MACHINE_ID_MASK","parseSnowflake","id","sfId","timestampMs","stringifySnowflakeParts","parts","getTimestamp","getMachineId","getSequence","isValidSnowflake","relaxed","snowflakeToString","stringToSnowflake","str","compareSnowflakes","a","b","idA","idB","snowflakeFromTimestamp","date","sequence"],"mappings":"aAEA,IAAMA,CAAAA,CAAiB,IAAA,CACjBC,CAAAA,CAAe,KAAA,CACfC,CAAAA,CAAmB,GAAA,CACnBC,CAAAA,CAAkB,GAAA,CAClBC,CAAAA,CAAgB,WAMf,IAAMC,CAAAA,CAAN,KAAyB,CAO5B,WAAA,CAAYC,CAAAA,CAAyB,CAHrC,IAAA,CAAQ,QAAA,CAAW,EAAA,CACnB,IAAA,CAAQ,aAAA,CAAgB,EAAA,CAGpB,GAAM,CAAE,SAAA,CAAAC,CAAAA,CAAW,KAAA,CAAAC,CAAAA,CAAQ,UAAA,CAAe,mBAAA,CAAAC,CAAAA,CAAsB,OAAQ,CAAA,CAAIH,CAAAA,CAE5E,GAAIC,CAAAA,CAAY,CAAA,EAAKA,CAAAA,CAAY,IAAA,EAAkB,CAAC,MAAA,CAAO,SAAA,CAAUA,CAAS,CAAA,CAC1E,MAAM,IAAI,KAAA,CAAM,CAAA,sCAAA,EAAyCA,CAAS,CAAA,CAAE,CAAA,CAGxE,GAAIC,CAAAA,CAAQ,CAAA,EAAKA,CAAAA,CAAQ,IAAA,CAAK,GAAA,EAAI,CAC9B,MAAM,IAAI,KAAA,CAAM,+BAA+B,CAAA,CAGnD,IAAA,CAAK,gBAAA,CAAmB,MAAA,CAAOD,CAAS,CAAA,EAAKL,CAAAA,CAC7C,IAAA,CAAK,KAAA,CAAQM,CAAAA,CACb,IAAA,CAAK,mBAAA,CAAsBC,EAC/B,CAKA,MAAA,EAAiB,CACb,IAAIC,CAAAA,CAAK,IAAA,CAAK,GAAA,EAAI,CAElB,GAAIA,CAAAA,CAAK,IAAA,CAAK,aAAA,CAAe,CACzB,IAAMC,CAAAA,CAAQ,IAAA,CAAK,aAAA,CAAgBD,CAAAA,CAEnC,GAAI,IAAA,CAAK,mBAAA,GAAwB,MAAA,EAAUC,CAAAA,EAAS,EAAA,CAChD,KAAOD,CAAAA,EAAM,IAAA,CAAK,aAAA,EACdA,CAAAA,CAAK,IAAA,CAAK,GAAA,EAAI,CAAA,KAGlB,MAAM,IAAI,KAAA,CAAM,CAAA,yBAAA,EAA4BC,CAAK,CAAA,EAAA,CAAI,CAE7D,CAEA,GAAID,CAAAA,GAAO,IAAA,CAAK,aAAA,CAAA,CAEZ,GADA,IAAA,CAAK,QAAA,CAAY,IAAA,CAAK,QAAA,CAAW,GAAMT,CAAAA,CACnC,IAAA,CAAK,QAAA,GAAa,EAAA,CAClB,KAAOS,CAAAA,EAAM,IAAA,CAAK,aAAA,EACdA,CAAAA,CAAK,IAAA,CAAK,GAAA,GAAI,CAAA,KAItB,IAAA,CAAK,QAAA,CAAW,EAAA,CAGpB,OAAA,IAAA,CAAK,aAAA,CAAgBA,CAAAA,CACb,MAAA,CAAOA,CAAAA,CAAK,IAAA,CAAK,KAAK,CAAA,EAAKP,CAAAA,CAAmB,IAAA,CAAK,gBAAA,CAAmB,IAAA,CAAK,QACvF,CAEA,YAAA,EAAuB,CACnB,OAAO,IAAA,CAAK,MAAA,EAAO,CAAE,QAAA,EACzB,CAEA,YAAA,EAAuB,CACnB,OAAO,MAAA,CAAO,IAAA,CAAK,gBAAA,EAAoBD,CAAgB,CAC3D,CAEA,QAAA,EAAmB,CACf,OAAO,IAAA,CAAK,KAChB,CAEA,WAAA,EAAsB,CAClB,OAAO,MAAA,CAAO,IAAA,CAAK,QAAQ,CAC/B,CAEA,gBAAA,EAA2B,CACvB,OAAO,KAAK,aAChB,CACJ,EAEO,SAASU,CAAAA,CAAgBN,CAAAA,CAA6C,CACzE,OAAO,IAAID,CAAAA,CAAmBC,CAAM,CACxC,CClFA,IAAMO,CAAAA,CAAgBZ,CAAAA,CAChBa,CAAAA,CAAkB,MAAA,CAAO,IAAc,CAAA,CAEtC,SAASC,CAAAA,CAAeC,CAAAA,CAAqBR,CAAAA,CAAQ,UAAA,CAA+B,CACvF,GAAI,OAAOQ,CAAAA,EAAO,QAAA,EAAY,CAAC,OAAA,CAAQ,IAAA,CAAKA,CAAE,CAAA,CAC1C,MAAM,IAAI,KAAA,CAAM,CAAA,uBAAA,EAA0BA,CAAE,CAAA,CAAA,CAAG,CAAA,CAGnD,IAAMC,CAAAA,CAAO,OAAOD,CAAAA,EAAO,QAAA,CAAW,MAAA,CAAOA,CAAE,CAAA,CAAIA,CAAAA,CAC7CE,CAAAA,CAAc,MAAA,CAAOD,CAAAA,EAAQd,CAAe,CAAA,CAAIK,CAAAA,CAEtD,OAAO,CACH,EAAA,CAAIS,CAAAA,CACJ,SAAA,CAAW,IAAI,IAAA,CAAKC,CAAW,CAAA,CAC/B,WAAA,CAAAA,CAAAA,CACA,SAAA,CAAW,MAAA,CAAQD,CAAAA,EAAQf,CAAAA,CAAoBY,CAAe,CAAA,CAC9D,QAAA,CAAU,MAAA,CAAOG,CAAAA,CAAOJ,CAAa,CACzC,CACJ,CAEO,SAASM,CAAAA,CAAwBC,CAAAA,CAA2C,CAC/E,OAAO,CACH,EAAA,CAAIA,CAAAA,CAAM,EAAA,CAAG,QAAA,EAAS,CACtB,SAAA,CAAWA,CAAAA,CAAM,SAAA,CAAU,WAAA,EAAY,CACvC,WAAA,CAAaA,CAAAA,CAAM,WAAA,CACnB,SAAA,CAAWA,CAAAA,CAAM,SAAA,CACjB,QAAA,CAAUA,CAAAA,CAAM,QACpB,CACJ,CAEO,SAASC,CAAAA,CAAaL,CAAAA,CAAqBR,CAAAA,CAAQ,UAAA,CAAqB,CAC3E,IAAMS,CAAAA,CAAO,OAAOD,CAAAA,EAAO,QAAA,CAAW,MAAA,CAAOA,CAAE,CAAA,CAAIA,CAAAA,CACnD,OAAO,IAAI,IAAA,CAAK,MAAA,CAAOC,CAAAA,EAAQd,CAAe,EAAIK,CAAK,CAC3D,CAEO,SAASc,CAAAA,CAAaN,CAAAA,CAA6B,CACtD,IAAMC,CAAAA,CAAO,OAAOD,CAAAA,EAAO,QAAA,CAAW,MAAA,CAAOA,CAAE,CAAA,CAAIA,CAAAA,CACnD,OAAO,MAAA,CAAQC,CAAAA,EAAQf,CAAAA,CAAoBY,CAAe,CAC9D,CAEO,SAASS,CAAAA,CAAYP,CAAAA,CAA6B,CACrD,IAAMC,CAAAA,CAAO,OAAOD,CAAAA,EAAO,QAAA,CAAW,MAAA,CAAOA,CAAE,CAAA,CAAIA,CAAAA,CACnD,OAAO,MAAA,CAAOC,CAAAA,CAAOJ,CAAa,CACtC,CAKO,SAASW,CAAAA,CAAiBR,CAAAA,CAAaR,CAAAA,CAAQ,UAAA,CAAeiB,CAAAA,CAAU,KAAA,CAAgB,CAC3F,GAAI,OAAOT,CAAAA,EAAO,QAAA,CAAU,CACxB,GAAI,CAAC,OAAA,CAAQ,IAAA,CAAKA,CAAE,CAAA,CAAG,OAAO,MAAA,CAC9B,GAAI,CACAA,CAAAA,CAAK,MAAA,CAAOA,CAAE,EAClB,CAAA,KAAQ,CACJ,OAAO,MACX,CACJ,CAEA,GAAI,OAAOA,CAAAA,EAAO,QAAA,EAAYA,CAAAA,CAAK,EAAA,CAAI,OAAO,MAAA,CAC9C,GAAIS,CAAAA,CAAS,OAAO,KAAA,CAEpB,IAAMf,CAAAA,CAAK,MAAA,CAAOM,CAAAA,EAAMb,CAAe,CAAA,CAAIK,CAAAA,CAC3C,OAAOE,CAAAA,EAAMF,CAAAA,EAASE,CAAAA,EAAM,IAAA,CAAK,GAAA,EAAI,CAAI,GAC7C,CAEO,SAASgB,CAAAA,CAAkBV,CAAAA,CAAoB,CAClD,OAAOA,CAAAA,CAAG,QAAA,EACd,CAEO,SAASW,CAAAA,CAAkBC,CAAAA,CAAqB,CACnD,GAAI,CAAC,OAAA,CAAQ,IAAA,CAAKA,CAAG,CAAA,CACjB,MAAM,IAAI,KAAA,CAAM,CAAA,8BAAA,EAAiCA,CAAG,CAAA,CAAA,CAAG,CAAA,CAE3D,OAAO,MAAA,CAAOA,CAAG,CACrB,CAEO,SAASC,CAAAA,CAAkBC,CAAAA,CAAoBC,CAAAA,CAAgC,CAClF,IAAMC,CAAAA,CAAM,OAAOF,CAAAA,EAAM,QAAA,CAAW,MAAA,CAAOA,CAAC,CAAA,CAAIA,CAAAA,CAC1CG,CAAAA,CAAM,OAAOF,CAAAA,EAAM,QAAA,CAAW,MAAA,CAAOA,CAAC,CAAA,CAAIA,CAAAA,CAChD,OAAOC,CAAAA,CAAMC,CAAAA,CAAM,EAAA,CAAKD,CAAAA,CAAMC,CAAAA,CAAM,EAAI,CAC5C,CAEO,SAASC,CAAAA,CACZC,CAAAA,CACA5B,CAAAA,CAAY,CAAA,CACZ6B,CAAAA,CAAW,CAAA,CACX5B,CAAAA,CAAQ,UAAA,CACF,CACN,IAAME,CAAAA,CAAK,OAAOyB,CAAAA,EAAS,QAAA,CAAWA,CAAAA,CAAOA,CAAAA,CAAK,OAAA,EAAQ,CAC1D,OAAQ,MAAA,CAAOzB,CAAAA,CAAKF,CAAK,CAAA,EAAKL,CAAAA,CAAoB,MAAA,CAAOI,CAAS,CAAA,EAAKL,CAAAA,CAAoB,MAAA,CAAOkC,CAAQ,CAC9G","file":"index.cjs","sourcesContent":["import type { SnowflakeConfig } from '../types/type';\n\nconst MAX_MACHINE_ID = 1023;\nconst MAX_SEQUENCE = 4095n;\nconst MACHINE_ID_SHIFT = 12n;\nconst TIMESTAMP_SHIFT = 22n;\nconst DEFAULT_EPOCH = 1704067200000;\nconst MAX_CLOCK_WAIT_MS = 50;\n\n/**\n * Generates 64-bit, time-sortable unique IDs.\n */\nexport class SnowflakeGenerator {\n private readonly machineIdShifted: bigint;\n private readonly epoch: number;\n private readonly clockMoveBackAction: 'throw' | 'wait';\n private sequence = 0n;\n private lastTimestamp = -1;\n\n constructor(config: SnowflakeConfig) {\n const { machineId, epoch = DEFAULT_EPOCH, clockMoveBackAction = 'throw' } = config;\n\n if (machineId < 0 || machineId > MAX_MACHINE_ID || !Number.isInteger(machineId)) {\n throw new Error(`machineId must be integer 0-1023, got ${machineId}`);\n }\n\n if (epoch < 0 || epoch > Date.now()) {\n throw new Error(`epoch cannot be in the future`);\n }\n\n this.machineIdShifted = BigInt(machineId) << MACHINE_ID_SHIFT;\n this.epoch = epoch;\n this.clockMoveBackAction = clockMoveBackAction;\n }\n\n /**\n * @throws Error if the system clock drifts backwards.\n */\n nextId(): bigint {\n let ts = Date.now();\n\n if (ts < this.lastTimestamp) {\n const drift = this.lastTimestamp - ts;\n\n if (this.clockMoveBackAction === 'wait' && drift <= MAX_CLOCK_WAIT_MS) {\n while (ts <= this.lastTimestamp) {\n ts = Date.now();\n }\n } else {\n throw new Error(`Clock moved backwards by ${drift}ms`);\n }\n }\n\n if (ts === this.lastTimestamp) {\n this.sequence = (this.sequence + 1n) & MAX_SEQUENCE;\n if (this.sequence === 0n) {\n while (ts <= this.lastTimestamp) {\n ts = Date.now();\n }\n }\n } else {\n this.sequence = 0n;\n }\n\n this.lastTimestamp = ts;\n return (BigInt(ts - this.epoch) << TIMESTAMP_SHIFT) | this.machineIdShifted | this.sequence;\n }\n\n nextIdString(): string {\n return this.nextId().toString();\n }\n\n getMachineId(): number {\n return Number(this.machineIdShifted >> MACHINE_ID_SHIFT);\n }\n\n getEpoch(): number {\n return this.epoch;\n }\n\n getSequence(): number {\n return Number(this.sequence);\n }\n\n getLastTimestamp(): number {\n return this.lastTimestamp;\n }\n}\n\nexport function createGenerator(config: SnowflakeConfig): SnowflakeGenerator {\n return new SnowflakeGenerator(config);\n}\n\nexport {\n MAX_SEQUENCE,\n MACHINE_ID_SHIFT,\n TIMESTAMP_SHIFT,\n DEFAULT_EPOCH,\n MAX_MACHINE_ID,\n};","import type { SnowflakeParts, SnowflakePartsJSON } from '../types/type';\nimport {\n MACHINE_ID_SHIFT,\n TIMESTAMP_SHIFT,\n DEFAULT_EPOCH,\n MAX_SEQUENCE,\n MAX_MACHINE_ID\n} from '../core/generator';\n\nconst SEQUENCE_MASK = MAX_SEQUENCE;\nconst MACHINE_ID_MASK = BigInt(MAX_MACHINE_ID);\n\nexport function parseSnowflake(id: bigint | string, epoch = DEFAULT_EPOCH): SnowflakeParts {\n if (typeof id === 'string' && !/^\\d+$/.test(id)) {\n throw new Error(`Invalid Snowflake ID: \"${id}\"`);\n }\n\n const sfId = typeof id === 'string' ? BigInt(id) : id;\n const timestampMs = Number(sfId >> TIMESTAMP_SHIFT) + epoch;\n\n return {\n id: sfId,\n timestamp: new Date(timestampMs),\n timestampMs,\n machineId: Number((sfId >> MACHINE_ID_SHIFT) & MACHINE_ID_MASK),\n sequence: Number(sfId & SEQUENCE_MASK),\n };\n}\n\nexport function stringifySnowflakeParts(parts: SnowflakeParts): SnowflakePartsJSON {\n return {\n id: parts.id.toString(),\n timestamp: parts.timestamp.toISOString(),\n timestampMs: parts.timestampMs,\n machineId: parts.machineId,\n sequence: parts.sequence,\n };\n}\n\nexport function getTimestamp(id: bigint | string, epoch = DEFAULT_EPOCH): Date {\n const sfId = typeof id === 'string' ? BigInt(id) : id;\n return new Date(Number(sfId >> TIMESTAMP_SHIFT) + epoch);\n}\n\nexport function getMachineId(id: bigint | string): number {\n const sfId = typeof id === 'string' ? BigInt(id) : id;\n return Number((sfId >> MACHINE_ID_SHIFT) & MACHINE_ID_MASK);\n}\n\nexport function getSequence(id: bigint | string): number {\n const sfId = typeof id === 'string' ? BigInt(id) : id;\n return Number(sfId & SEQUENCE_MASK);\n}\n\n/**\n * @param relaxed - Skip timestamp range check.\n */\nexport function isValidSnowflake(id: unknown, epoch = DEFAULT_EPOCH, relaxed = false): boolean {\n if (typeof id === 'string') {\n if (!/^\\d+$/.test(id)) return false;\n try {\n id = BigInt(id);\n } catch {\n return false;\n }\n }\n\n if (typeof id !== 'bigint' || id < 0n) return false;\n if (relaxed) return true;\n\n const ts = Number(id >> TIMESTAMP_SHIFT) + epoch;\n return ts >= epoch && ts <= Date.now() + 1000;\n}\n\nexport function snowflakeToString(id: bigint): string {\n return id.toString();\n}\n\nexport function stringToSnowflake(str: string): bigint {\n if (!/^\\d+$/.test(str)) {\n throw new Error(`Invalid Snowflake ID string: \"${str}\"`);\n }\n return BigInt(str);\n}\n\nexport function compareSnowflakes(a: bigint | string, b: bigint | string): -1 | 0 | 1 {\n const idA = typeof a === 'string' ? BigInt(a) : a;\n const idB = typeof b === 'string' ? BigInt(b) : b;\n return idA < idB ? -1 : idA > idB ? 1 : 0;\n}\n\nexport function snowflakeFromTimestamp(\n date: Date | number,\n machineId = 0,\n sequence = 0,\n epoch = DEFAULT_EPOCH\n): bigint {\n const ts = typeof date === 'number' ? date : date.getTime();\n return (BigInt(ts - epoch) << TIMESTAMP_SHIFT) | (BigInt(machineId) << MACHINE_ID_SHIFT) | BigInt(sequence);\n}"]}
|
package/dist/index.d.cts
ADDED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
interface SnowflakeConfig {
|
|
2
|
+
/** Unique ID for this machine/worker (0-1023). */
|
|
3
|
+
machineId: number;
|
|
4
|
+
/** Custom epoch (milliseconds). Defaults to Jan 1, 2024. */
|
|
5
|
+
epoch?: number;
|
|
6
|
+
/** Behavior when system clock drifts backwards. */
|
|
7
|
+
clockMoveBackAction?: 'throw' | 'wait';
|
|
8
|
+
}
|
|
9
|
+
interface SnowflakeParts {
|
|
10
|
+
id: bigint;
|
|
11
|
+
timestamp: Date;
|
|
12
|
+
timestampMs: number;
|
|
13
|
+
machineId: number;
|
|
14
|
+
sequence: number;
|
|
15
|
+
}
|
|
16
|
+
interface SnowflakePartsJSON {
|
|
17
|
+
id: string;
|
|
18
|
+
timestamp: string;
|
|
19
|
+
timestampMs: number;
|
|
20
|
+
machineId: number;
|
|
21
|
+
sequence: number;
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
declare const MAX_MACHINE_ID = 1023;
|
|
25
|
+
declare const MAX_SEQUENCE = 4095n;
|
|
26
|
+
declare const MACHINE_ID_SHIFT = 12n;
|
|
27
|
+
declare const TIMESTAMP_SHIFT = 22n;
|
|
28
|
+
declare const DEFAULT_EPOCH = 1704067200000;
|
|
29
|
+
/**
|
|
30
|
+
* Generates 64-bit, time-sortable unique IDs.
|
|
31
|
+
*/
|
|
32
|
+
declare class SnowflakeGenerator {
|
|
33
|
+
private readonly machineIdShifted;
|
|
34
|
+
private readonly epoch;
|
|
35
|
+
private readonly clockMoveBackAction;
|
|
36
|
+
private sequence;
|
|
37
|
+
private lastTimestamp;
|
|
38
|
+
constructor(config: SnowflakeConfig);
|
|
39
|
+
/**
|
|
40
|
+
* @throws Error if the system clock drifts backwards.
|
|
41
|
+
*/
|
|
42
|
+
nextId(): bigint;
|
|
43
|
+
nextIdString(): string;
|
|
44
|
+
getMachineId(): number;
|
|
45
|
+
getEpoch(): number;
|
|
46
|
+
getSequence(): number;
|
|
47
|
+
getLastTimestamp(): number;
|
|
48
|
+
}
|
|
49
|
+
declare function createGenerator(config: SnowflakeConfig): SnowflakeGenerator;
|
|
50
|
+
|
|
51
|
+
declare function parseSnowflake(id: bigint | string, epoch?: number): SnowflakeParts;
|
|
52
|
+
declare function stringifySnowflakeParts(parts: SnowflakeParts): SnowflakePartsJSON;
|
|
53
|
+
declare function getTimestamp(id: bigint | string, epoch?: number): Date;
|
|
54
|
+
declare function getMachineId(id: bigint | string): number;
|
|
55
|
+
declare function getSequence(id: bigint | string): number;
|
|
56
|
+
/**
|
|
57
|
+
* @param relaxed - Skip timestamp range check.
|
|
58
|
+
*/
|
|
59
|
+
declare function isValidSnowflake(id: unknown, epoch?: number, relaxed?: boolean): boolean;
|
|
60
|
+
declare function snowflakeToString(id: bigint): string;
|
|
61
|
+
declare function stringToSnowflake(str: string): bigint;
|
|
62
|
+
declare function compareSnowflakes(a: bigint | string, b: bigint | string): -1 | 0 | 1;
|
|
63
|
+
declare function snowflakeFromTimestamp(date: Date | number, machineId?: number, sequence?: number, epoch?: number): bigint;
|
|
64
|
+
|
|
65
|
+
export { DEFAULT_EPOCH, MACHINE_ID_SHIFT, MAX_MACHINE_ID, MAX_SEQUENCE, type SnowflakeConfig, SnowflakeGenerator, type SnowflakeParts, type SnowflakePartsJSON, TIMESTAMP_SHIFT, compareSnowflakes, createGenerator, getMachineId, getSequence, getTimestamp, isValidSnowflake, parseSnowflake, snowflakeFromTimestamp, snowflakeToString, stringToSnowflake, stringifySnowflakeParts };
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
interface SnowflakeConfig {
|
|
2
|
+
/** Unique ID for this machine/worker (0-1023). */
|
|
3
|
+
machineId: number;
|
|
4
|
+
/** Custom epoch (milliseconds). Defaults to Jan 1, 2024. */
|
|
5
|
+
epoch?: number;
|
|
6
|
+
/** Behavior when system clock drifts backwards. */
|
|
7
|
+
clockMoveBackAction?: 'throw' | 'wait';
|
|
8
|
+
}
|
|
9
|
+
interface SnowflakeParts {
|
|
10
|
+
id: bigint;
|
|
11
|
+
timestamp: Date;
|
|
12
|
+
timestampMs: number;
|
|
13
|
+
machineId: number;
|
|
14
|
+
sequence: number;
|
|
15
|
+
}
|
|
16
|
+
interface SnowflakePartsJSON {
|
|
17
|
+
id: string;
|
|
18
|
+
timestamp: string;
|
|
19
|
+
timestampMs: number;
|
|
20
|
+
machineId: number;
|
|
21
|
+
sequence: number;
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
declare const MAX_MACHINE_ID = 1023;
|
|
25
|
+
declare const MAX_SEQUENCE = 4095n;
|
|
26
|
+
declare const MACHINE_ID_SHIFT = 12n;
|
|
27
|
+
declare const TIMESTAMP_SHIFT = 22n;
|
|
28
|
+
declare const DEFAULT_EPOCH = 1704067200000;
|
|
29
|
+
/**
|
|
30
|
+
* Generates 64-bit, time-sortable unique IDs.
|
|
31
|
+
*/
|
|
32
|
+
declare class SnowflakeGenerator {
|
|
33
|
+
private readonly machineIdShifted;
|
|
34
|
+
private readonly epoch;
|
|
35
|
+
private readonly clockMoveBackAction;
|
|
36
|
+
private sequence;
|
|
37
|
+
private lastTimestamp;
|
|
38
|
+
constructor(config: SnowflakeConfig);
|
|
39
|
+
/**
|
|
40
|
+
* @throws Error if the system clock drifts backwards.
|
|
41
|
+
*/
|
|
42
|
+
nextId(): bigint;
|
|
43
|
+
nextIdString(): string;
|
|
44
|
+
getMachineId(): number;
|
|
45
|
+
getEpoch(): number;
|
|
46
|
+
getSequence(): number;
|
|
47
|
+
getLastTimestamp(): number;
|
|
48
|
+
}
|
|
49
|
+
declare function createGenerator(config: SnowflakeConfig): SnowflakeGenerator;
|
|
50
|
+
|
|
51
|
+
declare function parseSnowflake(id: bigint | string, epoch?: number): SnowflakeParts;
|
|
52
|
+
declare function stringifySnowflakeParts(parts: SnowflakeParts): SnowflakePartsJSON;
|
|
53
|
+
declare function getTimestamp(id: bigint | string, epoch?: number): Date;
|
|
54
|
+
declare function getMachineId(id: bigint | string): number;
|
|
55
|
+
declare function getSequence(id: bigint | string): number;
|
|
56
|
+
/**
|
|
57
|
+
* @param relaxed - Skip timestamp range check.
|
|
58
|
+
*/
|
|
59
|
+
declare function isValidSnowflake(id: unknown, epoch?: number, relaxed?: boolean): boolean;
|
|
60
|
+
declare function snowflakeToString(id: bigint): string;
|
|
61
|
+
declare function stringToSnowflake(str: string): bigint;
|
|
62
|
+
declare function compareSnowflakes(a: bigint | string, b: bigint | string): -1 | 0 | 1;
|
|
63
|
+
declare function snowflakeFromTimestamp(date: Date | number, machineId?: number, sequence?: number, epoch?: number): bigint;
|
|
64
|
+
|
|
65
|
+
export { DEFAULT_EPOCH, MACHINE_ID_SHIFT, MAX_MACHINE_ID, MAX_SEQUENCE, type SnowflakeConfig, SnowflakeGenerator, type SnowflakeParts, type SnowflakePartsJSON, TIMESTAMP_SHIFT, compareSnowflakes, createGenerator, getMachineId, getSequence, getTimestamp, isValidSnowflake, parseSnowflake, snowflakeFromTimestamp, snowflakeToString, stringToSnowflake, stringifySnowflakeParts };
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
var m=1023,c=4095n,i=12n,o=22n,s=17040672e5;var a=class{constructor(e){this.sequence=0n;this.lastTimestamp=-1;let{machineId:n,epoch:r=17040672e5,clockMoveBackAction:f="throw"}=e;if(n<0||n>1023||!Number.isInteger(n))throw new Error(`machineId must be integer 0-1023, got ${n}`);if(r<0||r>Date.now())throw new Error("epoch cannot be in the future");this.machineIdShifted=BigInt(n)<<i,this.epoch=r,this.clockMoveBackAction=f;}nextId(){let e=Date.now();if(e<this.lastTimestamp){let n=this.lastTimestamp-e;if(this.clockMoveBackAction==="wait"&&n<=50)for(;e<=this.lastTimestamp;)e=Date.now();else throw new Error(`Clock moved backwards by ${n}ms`)}if(e===this.lastTimestamp){if(this.sequence=this.sequence+1n&c,this.sequence===0n)for(;e<=this.lastTimestamp;)e=Date.now();}else this.sequence=0n;return this.lastTimestamp=e,BigInt(e-this.epoch)<<o|this.machineIdShifted|this.sequence}nextIdString(){return this.nextId().toString()}getMachineId(){return Number(this.machineIdShifted>>i)}getEpoch(){return this.epoch}getSequence(){return Number(this.sequence)}getLastTimestamp(){return this.lastTimestamp}};function p(t){return new a(t)}var g=c,u=BigInt(1023);function I(t,e=17040672e5){if(typeof t=="string"&&!/^\d+$/.test(t))throw new Error(`Invalid Snowflake ID: "${t}"`);let n=typeof t=="string"?BigInt(t):t,r=Number(n>>o)+e;return {id:n,timestamp:new Date(r),timestampMs:r,machineId:Number(n>>i&u),sequence:Number(n&g)}}function l(t){return {id:t.id.toString(),timestamp:t.timestamp.toISOString(),timestampMs:t.timestampMs,machineId:t.machineId,sequence:t.sequence}}function S(t,e=17040672e5){let n=typeof t=="string"?BigInt(t):t;return new Date(Number(n>>o)+e)}function h(t){let e=typeof t=="string"?BigInt(t):t;return Number(e>>i&u)}function w(t){let e=typeof t=="string"?BigInt(t):t;return Number(e&g)}function k(t,e=17040672e5,n=false){if(typeof t=="string"){if(!/^\d+$/.test(t))return false;try{t=BigInt(t);}catch{return false}}if(typeof t!="bigint"||t<0n)return false;if(n)return true;let r=Number(t>>o)+e;return r>=e&&r<=Date.now()+1e3}function E(t){return t.toString()}function M(t){if(!/^\d+$/.test(t))throw new Error(`Invalid Snowflake ID string: "${t}"`);return BigInt(t)}function T(t,e){let n=typeof t=="string"?BigInt(t):t,r=typeof e=="string"?BigInt(e):e;return n<r?-1:n>r?1:0}function b(t,e=0,n=0,r=17040672e5){let f=typeof t=="number"?t:t.getTime();return BigInt(f-r)<<o|BigInt(e)<<i|BigInt(n)}export{s as DEFAULT_EPOCH,i as MACHINE_ID_SHIFT,m as MAX_MACHINE_ID,c as MAX_SEQUENCE,a as SnowflakeGenerator,o as TIMESTAMP_SHIFT,T as compareSnowflakes,p as createGenerator,h as getMachineId,w as getSequence,S as getTimestamp,k as isValidSnowflake,I as parseSnowflake,b as snowflakeFromTimestamp,E as snowflakeToString,M as stringToSnowflake,l as stringifySnowflakeParts};//# sourceMappingURL=index.js.map
|
|
2
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/core/generator.ts","../src/utils/index.ts"],"names":["MAX_MACHINE_ID","MAX_SEQUENCE","MACHINE_ID_SHIFT","TIMESTAMP_SHIFT","DEFAULT_EPOCH","SnowflakeGenerator","config","machineId","epoch","clockMoveBackAction","ts","drift","createGenerator","SEQUENCE_MASK","MACHINE_ID_MASK","parseSnowflake","id","sfId","timestampMs","stringifySnowflakeParts","parts","getTimestamp","getMachineId","getSequence","isValidSnowflake","relaxed","snowflakeToString","stringToSnowflake","str","compareSnowflakes","a","b","idA","idB","snowflakeFromTimestamp","date","sequence"],"mappings":"AAEA,IAAMA,CAAAA,CAAiB,IAAA,CACjBC,CAAAA,CAAe,KAAA,CACfC,CAAAA,CAAmB,GAAA,CACnBC,CAAAA,CAAkB,GAAA,CAClBC,CAAAA,CAAgB,WAMf,IAAMC,CAAAA,CAAN,KAAyB,CAO5B,WAAA,CAAYC,CAAAA,CAAyB,CAHrC,IAAA,CAAQ,QAAA,CAAW,EAAA,CACnB,IAAA,CAAQ,aAAA,CAAgB,EAAA,CAGpB,GAAM,CAAE,SAAA,CAAAC,CAAAA,CAAW,KAAA,CAAAC,CAAAA,CAAQ,UAAA,CAAe,mBAAA,CAAAC,CAAAA,CAAsB,OAAQ,CAAA,CAAIH,CAAAA,CAE5E,GAAIC,CAAAA,CAAY,CAAA,EAAKA,CAAAA,CAAY,IAAA,EAAkB,CAAC,MAAA,CAAO,SAAA,CAAUA,CAAS,CAAA,CAC1E,MAAM,IAAI,KAAA,CAAM,CAAA,sCAAA,EAAyCA,CAAS,CAAA,CAAE,CAAA,CAGxE,GAAIC,CAAAA,CAAQ,CAAA,EAAKA,CAAAA,CAAQ,IAAA,CAAK,GAAA,EAAI,CAC9B,MAAM,IAAI,KAAA,CAAM,+BAA+B,CAAA,CAGnD,IAAA,CAAK,gBAAA,CAAmB,MAAA,CAAOD,CAAS,CAAA,EAAKL,CAAAA,CAC7C,IAAA,CAAK,KAAA,CAAQM,CAAAA,CACb,IAAA,CAAK,mBAAA,CAAsBC,EAC/B,CAKA,MAAA,EAAiB,CACb,IAAIC,CAAAA,CAAK,IAAA,CAAK,GAAA,EAAI,CAElB,GAAIA,CAAAA,CAAK,IAAA,CAAK,aAAA,CAAe,CACzB,IAAMC,CAAAA,CAAQ,IAAA,CAAK,aAAA,CAAgBD,CAAAA,CAEnC,GAAI,IAAA,CAAK,mBAAA,GAAwB,MAAA,EAAUC,CAAAA,EAAS,EAAA,CAChD,KAAOD,CAAAA,EAAM,IAAA,CAAK,aAAA,EACdA,CAAAA,CAAK,IAAA,CAAK,GAAA,EAAI,CAAA,KAGlB,MAAM,IAAI,KAAA,CAAM,CAAA,yBAAA,EAA4BC,CAAK,CAAA,EAAA,CAAI,CAE7D,CAEA,GAAID,CAAAA,GAAO,IAAA,CAAK,aAAA,CAAA,CAEZ,GADA,IAAA,CAAK,QAAA,CAAY,IAAA,CAAK,QAAA,CAAW,GAAMT,CAAAA,CACnC,IAAA,CAAK,QAAA,GAAa,EAAA,CAClB,KAAOS,CAAAA,EAAM,IAAA,CAAK,aAAA,EACdA,CAAAA,CAAK,IAAA,CAAK,GAAA,GAAI,CAAA,KAItB,IAAA,CAAK,QAAA,CAAW,EAAA,CAGpB,OAAA,IAAA,CAAK,aAAA,CAAgBA,CAAAA,CACb,MAAA,CAAOA,CAAAA,CAAK,IAAA,CAAK,KAAK,CAAA,EAAKP,CAAAA,CAAmB,IAAA,CAAK,gBAAA,CAAmB,IAAA,CAAK,QACvF,CAEA,YAAA,EAAuB,CACnB,OAAO,IAAA,CAAK,MAAA,EAAO,CAAE,QAAA,EACzB,CAEA,YAAA,EAAuB,CACnB,OAAO,MAAA,CAAO,IAAA,CAAK,gBAAA,EAAoBD,CAAgB,CAC3D,CAEA,QAAA,EAAmB,CACf,OAAO,IAAA,CAAK,KAChB,CAEA,WAAA,EAAsB,CAClB,OAAO,MAAA,CAAO,IAAA,CAAK,QAAQ,CAC/B,CAEA,gBAAA,EAA2B,CACvB,OAAO,KAAK,aAChB,CACJ,EAEO,SAASU,CAAAA,CAAgBN,CAAAA,CAA6C,CACzE,OAAO,IAAID,CAAAA,CAAmBC,CAAM,CACxC,CClFA,IAAMO,CAAAA,CAAgBZ,CAAAA,CAChBa,CAAAA,CAAkB,MAAA,CAAO,IAAc,CAAA,CAEtC,SAASC,CAAAA,CAAeC,CAAAA,CAAqBR,CAAAA,CAAQ,UAAA,CAA+B,CACvF,GAAI,OAAOQ,CAAAA,EAAO,QAAA,EAAY,CAAC,OAAA,CAAQ,IAAA,CAAKA,CAAE,CAAA,CAC1C,MAAM,IAAI,KAAA,CAAM,CAAA,uBAAA,EAA0BA,CAAE,CAAA,CAAA,CAAG,CAAA,CAGnD,IAAMC,CAAAA,CAAO,OAAOD,CAAAA,EAAO,QAAA,CAAW,MAAA,CAAOA,CAAE,CAAA,CAAIA,CAAAA,CAC7CE,CAAAA,CAAc,MAAA,CAAOD,CAAAA,EAAQd,CAAe,CAAA,CAAIK,CAAAA,CAEtD,OAAO,CACH,EAAA,CAAIS,CAAAA,CACJ,SAAA,CAAW,IAAI,IAAA,CAAKC,CAAW,CAAA,CAC/B,WAAA,CAAAA,CAAAA,CACA,SAAA,CAAW,MAAA,CAAQD,CAAAA,EAAQf,CAAAA,CAAoBY,CAAe,CAAA,CAC9D,QAAA,CAAU,MAAA,CAAOG,CAAAA,CAAOJ,CAAa,CACzC,CACJ,CAEO,SAASM,CAAAA,CAAwBC,CAAAA,CAA2C,CAC/E,OAAO,CACH,EAAA,CAAIA,CAAAA,CAAM,EAAA,CAAG,QAAA,EAAS,CACtB,SAAA,CAAWA,CAAAA,CAAM,SAAA,CAAU,WAAA,EAAY,CACvC,WAAA,CAAaA,CAAAA,CAAM,WAAA,CACnB,SAAA,CAAWA,CAAAA,CAAM,SAAA,CACjB,QAAA,CAAUA,CAAAA,CAAM,QACpB,CACJ,CAEO,SAASC,CAAAA,CAAaL,CAAAA,CAAqBR,CAAAA,CAAQ,UAAA,CAAqB,CAC3E,IAAMS,CAAAA,CAAO,OAAOD,CAAAA,EAAO,QAAA,CAAW,MAAA,CAAOA,CAAE,CAAA,CAAIA,CAAAA,CACnD,OAAO,IAAI,IAAA,CAAK,MAAA,CAAOC,CAAAA,EAAQd,CAAe,EAAIK,CAAK,CAC3D,CAEO,SAASc,CAAAA,CAAaN,CAAAA,CAA6B,CACtD,IAAMC,CAAAA,CAAO,OAAOD,CAAAA,EAAO,QAAA,CAAW,MAAA,CAAOA,CAAE,CAAA,CAAIA,CAAAA,CACnD,OAAO,MAAA,CAAQC,CAAAA,EAAQf,CAAAA,CAAoBY,CAAe,CAC9D,CAEO,SAASS,CAAAA,CAAYP,CAAAA,CAA6B,CACrD,IAAMC,CAAAA,CAAO,OAAOD,CAAAA,EAAO,QAAA,CAAW,MAAA,CAAOA,CAAE,CAAA,CAAIA,CAAAA,CACnD,OAAO,MAAA,CAAOC,CAAAA,CAAOJ,CAAa,CACtC,CAKO,SAASW,CAAAA,CAAiBR,CAAAA,CAAaR,CAAAA,CAAQ,UAAA,CAAeiB,CAAAA,CAAU,KAAA,CAAgB,CAC3F,GAAI,OAAOT,CAAAA,EAAO,QAAA,CAAU,CACxB,GAAI,CAAC,OAAA,CAAQ,IAAA,CAAKA,CAAE,CAAA,CAAG,OAAO,MAAA,CAC9B,GAAI,CACAA,CAAAA,CAAK,MAAA,CAAOA,CAAE,EAClB,CAAA,KAAQ,CACJ,OAAO,MACX,CACJ,CAEA,GAAI,OAAOA,CAAAA,EAAO,QAAA,EAAYA,CAAAA,CAAK,EAAA,CAAI,OAAO,MAAA,CAC9C,GAAIS,CAAAA,CAAS,OAAO,KAAA,CAEpB,IAAMf,CAAAA,CAAK,MAAA,CAAOM,CAAAA,EAAMb,CAAe,CAAA,CAAIK,CAAAA,CAC3C,OAAOE,CAAAA,EAAMF,CAAAA,EAASE,CAAAA,EAAM,IAAA,CAAK,GAAA,EAAI,CAAI,GAC7C,CAEO,SAASgB,CAAAA,CAAkBV,CAAAA,CAAoB,CAClD,OAAOA,CAAAA,CAAG,QAAA,EACd,CAEO,SAASW,CAAAA,CAAkBC,CAAAA,CAAqB,CACnD,GAAI,CAAC,OAAA,CAAQ,IAAA,CAAKA,CAAG,CAAA,CACjB,MAAM,IAAI,KAAA,CAAM,CAAA,8BAAA,EAAiCA,CAAG,CAAA,CAAA,CAAG,CAAA,CAE3D,OAAO,MAAA,CAAOA,CAAG,CACrB,CAEO,SAASC,CAAAA,CAAkBC,CAAAA,CAAoBC,CAAAA,CAAgC,CAClF,IAAMC,CAAAA,CAAM,OAAOF,CAAAA,EAAM,QAAA,CAAW,MAAA,CAAOA,CAAC,CAAA,CAAIA,CAAAA,CAC1CG,CAAAA,CAAM,OAAOF,CAAAA,EAAM,QAAA,CAAW,MAAA,CAAOA,CAAC,CAAA,CAAIA,CAAAA,CAChD,OAAOC,CAAAA,CAAMC,CAAAA,CAAM,EAAA,CAAKD,CAAAA,CAAMC,CAAAA,CAAM,EAAI,CAC5C,CAEO,SAASC,CAAAA,CACZC,CAAAA,CACA5B,CAAAA,CAAY,CAAA,CACZ6B,CAAAA,CAAW,CAAA,CACX5B,CAAAA,CAAQ,UAAA,CACF,CACN,IAAME,CAAAA,CAAK,OAAOyB,CAAAA,EAAS,QAAA,CAAWA,CAAAA,CAAOA,CAAAA,CAAK,OAAA,EAAQ,CAC1D,OAAQ,MAAA,CAAOzB,CAAAA,CAAKF,CAAK,CAAA,EAAKL,CAAAA,CAAoB,MAAA,CAAOI,CAAS,CAAA,EAAKL,CAAAA,CAAoB,MAAA,CAAOkC,CAAQ,CAC9G","file":"index.js","sourcesContent":["import type { SnowflakeConfig } from '../types/type';\n\nconst MAX_MACHINE_ID = 1023;\nconst MAX_SEQUENCE = 4095n;\nconst MACHINE_ID_SHIFT = 12n;\nconst TIMESTAMP_SHIFT = 22n;\nconst DEFAULT_EPOCH = 1704067200000;\nconst MAX_CLOCK_WAIT_MS = 50;\n\n/**\n * Generates 64-bit, time-sortable unique IDs.\n */\nexport class SnowflakeGenerator {\n private readonly machineIdShifted: bigint;\n private readonly epoch: number;\n private readonly clockMoveBackAction: 'throw' | 'wait';\n private sequence = 0n;\n private lastTimestamp = -1;\n\n constructor(config: SnowflakeConfig) {\n const { machineId, epoch = DEFAULT_EPOCH, clockMoveBackAction = 'throw' } = config;\n\n if (machineId < 0 || machineId > MAX_MACHINE_ID || !Number.isInteger(machineId)) {\n throw new Error(`machineId must be integer 0-1023, got ${machineId}`);\n }\n\n if (epoch < 0 || epoch > Date.now()) {\n throw new Error(`epoch cannot be in the future`);\n }\n\n this.machineIdShifted = BigInt(machineId) << MACHINE_ID_SHIFT;\n this.epoch = epoch;\n this.clockMoveBackAction = clockMoveBackAction;\n }\n\n /**\n * @throws Error if the system clock drifts backwards.\n */\n nextId(): bigint {\n let ts = Date.now();\n\n if (ts < this.lastTimestamp) {\n const drift = this.lastTimestamp - ts;\n\n if (this.clockMoveBackAction === 'wait' && drift <= MAX_CLOCK_WAIT_MS) {\n while (ts <= this.lastTimestamp) {\n ts = Date.now();\n }\n } else {\n throw new Error(`Clock moved backwards by ${drift}ms`);\n }\n }\n\n if (ts === this.lastTimestamp) {\n this.sequence = (this.sequence + 1n) & MAX_SEQUENCE;\n if (this.sequence === 0n) {\n while (ts <= this.lastTimestamp) {\n ts = Date.now();\n }\n }\n } else {\n this.sequence = 0n;\n }\n\n this.lastTimestamp = ts;\n return (BigInt(ts - this.epoch) << TIMESTAMP_SHIFT) | this.machineIdShifted | this.sequence;\n }\n\n nextIdString(): string {\n return this.nextId().toString();\n }\n\n getMachineId(): number {\n return Number(this.machineIdShifted >> MACHINE_ID_SHIFT);\n }\n\n getEpoch(): number {\n return this.epoch;\n }\n\n getSequence(): number {\n return Number(this.sequence);\n }\n\n getLastTimestamp(): number {\n return this.lastTimestamp;\n }\n}\n\nexport function createGenerator(config: SnowflakeConfig): SnowflakeGenerator {\n return new SnowflakeGenerator(config);\n}\n\nexport {\n MAX_SEQUENCE,\n MACHINE_ID_SHIFT,\n TIMESTAMP_SHIFT,\n DEFAULT_EPOCH,\n MAX_MACHINE_ID,\n};","import type { SnowflakeParts, SnowflakePartsJSON } from '../types/type';\nimport {\n MACHINE_ID_SHIFT,\n TIMESTAMP_SHIFT,\n DEFAULT_EPOCH,\n MAX_SEQUENCE,\n MAX_MACHINE_ID\n} from '../core/generator';\n\nconst SEQUENCE_MASK = MAX_SEQUENCE;\nconst MACHINE_ID_MASK = BigInt(MAX_MACHINE_ID);\n\nexport function parseSnowflake(id: bigint | string, epoch = DEFAULT_EPOCH): SnowflakeParts {\n if (typeof id === 'string' && !/^\\d+$/.test(id)) {\n throw new Error(`Invalid Snowflake ID: \"${id}\"`);\n }\n\n const sfId = typeof id === 'string' ? BigInt(id) : id;\n const timestampMs = Number(sfId >> TIMESTAMP_SHIFT) + epoch;\n\n return {\n id: sfId,\n timestamp: new Date(timestampMs),\n timestampMs,\n machineId: Number((sfId >> MACHINE_ID_SHIFT) & MACHINE_ID_MASK),\n sequence: Number(sfId & SEQUENCE_MASK),\n };\n}\n\nexport function stringifySnowflakeParts(parts: SnowflakeParts): SnowflakePartsJSON {\n return {\n id: parts.id.toString(),\n timestamp: parts.timestamp.toISOString(),\n timestampMs: parts.timestampMs,\n machineId: parts.machineId,\n sequence: parts.sequence,\n };\n}\n\nexport function getTimestamp(id: bigint | string, epoch = DEFAULT_EPOCH): Date {\n const sfId = typeof id === 'string' ? BigInt(id) : id;\n return new Date(Number(sfId >> TIMESTAMP_SHIFT) + epoch);\n}\n\nexport function getMachineId(id: bigint | string): number {\n const sfId = typeof id === 'string' ? BigInt(id) : id;\n return Number((sfId >> MACHINE_ID_SHIFT) & MACHINE_ID_MASK);\n}\n\nexport function getSequence(id: bigint | string): number {\n const sfId = typeof id === 'string' ? BigInt(id) : id;\n return Number(sfId & SEQUENCE_MASK);\n}\n\n/**\n * @param relaxed - Skip timestamp range check.\n */\nexport function isValidSnowflake(id: unknown, epoch = DEFAULT_EPOCH, relaxed = false): boolean {\n if (typeof id === 'string') {\n if (!/^\\d+$/.test(id)) return false;\n try {\n id = BigInt(id);\n } catch {\n return false;\n }\n }\n\n if (typeof id !== 'bigint' || id < 0n) return false;\n if (relaxed) return true;\n\n const ts = Number(id >> TIMESTAMP_SHIFT) + epoch;\n return ts >= epoch && ts <= Date.now() + 1000;\n}\n\nexport function snowflakeToString(id: bigint): string {\n return id.toString();\n}\n\nexport function stringToSnowflake(str: string): bigint {\n if (!/^\\d+$/.test(str)) {\n throw new Error(`Invalid Snowflake ID string: \"${str}\"`);\n }\n return BigInt(str);\n}\n\nexport function compareSnowflakes(a: bigint | string, b: bigint | string): -1 | 0 | 1 {\n const idA = typeof a === 'string' ? BigInt(a) : a;\n const idB = typeof b === 'string' ? BigInt(b) : b;\n return idA < idB ? -1 : idA > idB ? 1 : 0;\n}\n\nexport function snowflakeFromTimestamp(\n date: Date | number,\n machineId = 0,\n sequence = 0,\n epoch = DEFAULT_EPOCH\n): bigint {\n const ts = typeof date === 'number' ? date : date.getTime();\n return (BigInt(ts - epoch) << TIMESTAMP_SHIFT) | (BigInt(machineId) << MACHINE_ID_SHIFT) | BigInt(sequence);\n}"]}
|
package/package.json
ADDED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@toolkit-f/snowflake-id",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"publishConfig": {
|
|
5
|
+
"access": "public"
|
|
6
|
+
},
|
|
7
|
+
"description": "Unique ID Generator For NodeJS",
|
|
8
|
+
"main": "./dist/index.cjs",
|
|
9
|
+
"module": "./dist/index.js",
|
|
10
|
+
"types": "./dist/index.d.ts",
|
|
11
|
+
"exports": {
|
|
12
|
+
".": {
|
|
13
|
+
"types": {
|
|
14
|
+
"import": "./dist/index.d.ts",
|
|
15
|
+
"require": "./dist/index.d.cts"
|
|
16
|
+
},
|
|
17
|
+
"import": "./dist/index.js",
|
|
18
|
+
"require": "./dist/index.cjs"
|
|
19
|
+
}
|
|
20
|
+
},
|
|
21
|
+
"files": [
|
|
22
|
+
"dist",
|
|
23
|
+
"LICENSE",
|
|
24
|
+
"README.md"
|
|
25
|
+
],
|
|
26
|
+
"engines": {
|
|
27
|
+
"node": ">=18.0.0"
|
|
28
|
+
},
|
|
29
|
+
"scripts": {
|
|
30
|
+
"build": "tsup",
|
|
31
|
+
"test": "vitest run",
|
|
32
|
+
"test:bm": "vitest run tests/benchmark.test.ts",
|
|
33
|
+
"test:co": "vitest run tests/collision.test.ts",
|
|
34
|
+
"test:ut": "vitest run tests/utils.test.ts",
|
|
35
|
+
"test:watch": "vitest --watch",
|
|
36
|
+
"test:dist:js": "node tests/dist.js"
|
|
37
|
+
},
|
|
38
|
+
"repository": {
|
|
39
|
+
"type": "git",
|
|
40
|
+
"url": "git+https://github.com/maulik-mk/Snowflake-Id.git"
|
|
41
|
+
},
|
|
42
|
+
"keywords": [
|
|
43
|
+
"snowflake",
|
|
44
|
+
"id",
|
|
45
|
+
"uuid",
|
|
46
|
+
"unique-id",
|
|
47
|
+
"distributed",
|
|
48
|
+
"typescript",
|
|
49
|
+
"generator"
|
|
50
|
+
],
|
|
51
|
+
"author": "Maulik M. K.",
|
|
52
|
+
"license": "MIT",
|
|
53
|
+
"type": "module",
|
|
54
|
+
"bugs": {
|
|
55
|
+
"url": "https://github.com/maulik-mk/Snowflake-Id/issues"
|
|
56
|
+
},
|
|
57
|
+
"homepage": "https://github.com/maulik-mk/Snowflake-Id#readme",
|
|
58
|
+
"devDependencies": {
|
|
59
|
+
"@types/node": "^25.0.9",
|
|
60
|
+
"tsup": "^8.5.1",
|
|
61
|
+
"tsx": "^4.21.0",
|
|
62
|
+
"typescript": "^5.9.3",
|
|
63
|
+
"vitest": "^4.0.17"
|
|
64
|
+
}
|
|
65
|
+
}
|