@eliware/snowflake 1.1.3 → 1.1.5

package/README.md

@@ -14,6 +14,10 @@ A production-ready, BigInt-safe Snowflake ID generator for Node.js. IDs are retu
 - Range validation and timestamp-capacity checks.
 - Native ESM, TypeScript declarations, and no runtime dependencies.
 
+## Requirements
+
+- Node.js 26 or newer
+
 ## Installation
 
 ```bash
@@ -50,14 +54,28 @@ For Kubernetes, assign each replica a stable `workerId` from configuration. `pro
 
 The exports `generate` and `snowflake` are ready-to-use default generators. `constants` exposes the bit layout and default epoch.
 
+## TypeScript
+
+TypeScript declarations are included for all public exports and options.
+
+## Errors / Troubleshooting
+
+Configuration values outside the supported ranges throw `RangeError`; a non-function clock throws `TypeError`; timestamps before the epoch or beyond Snowflake capacity throw `RangeError`. Configure unique `workerId` and `processId` values across distributed generators.
+
 ## Testing and linting
 
 ```bash
 npm test
 npm run test:gaps
 npm run lint
+npm run typecheck
+npm run pack
 ```
 
+## Security
+
+Snowflake IDs are unique identifiers, not secrets. Do not use them as authentication tokens or assume they conceal timestamp and deployment information.
+
 ## License
 
 MIT © Eli Sterling, eliware.org

package/examples/example.mjs

@@ -0,0 +1,10 @@
+// ESM example: example.mjs
+import generate, { createSnowflakeGenerator } from './index.mjs';
+
+console.log('Default generate():', generate());
+
+const genWorker1 = createSnowflakeGenerator({ workerId: 1 });
+console.log('Worker 1 generate():', genWorker1());
+
+// Exported generator can be used anywhere in your app to create unique IDs
+export default generate;

package/package.json

@@ -1,15 +1,15 @@
 {
     "name": "@eliware/snowflake",
     "type": "module",
-    "version": "1.1.3",
+    "version": "1.1.5",
     "description": "A minimal Node.js Snowflake ID generator (Discord-compatible). Provides BigInt-safe generators with configurable epoch and worker ID.",
-    "main": "index.mjs",
     "types": "index.d.ts",
     "files": [
         "index.mjs",
         "index.d.ts",
         "README.md",
-        "LICENSE"
+        "LICENSE",
+        "examples"
     ],
     "exports": {
         ".": {
@@ -19,8 +19,10 @@
     },
     "scripts": {
         "test": "npx --node-options=\"--experimental-vm-modules --no-warnings\" jest --detectOpenHandles --silent --coverage",
-        "test:gaps": "npm test -- --coverageReporters=text 2>&1 | awk '!/100%/'",
-        "lint": "npx oxlint ."
+        "test:gaps": "npm test 2>&1 | grep '|' | grep -vF '|     100 |      100 |     100 |     100 |'",
+        "lint": "npx oxlint .",
+        "typecheck": "tsc --project tsconfig.json",
+        "pack": "npm pack --dry-run"
     },
     "repository": {
         "type": "git",
@@ -43,7 +45,8 @@
     },
     "homepage": "https://github.com/eliware/snowflake#readme",
     "devDependencies": {
-        "jest": "^30.4.2"
+        "jest": "^30.4.2",
+        "typescript": "^7.0.2"
     },
     "jest": {
         "testEnvironment": "node",
@@ -51,8 +54,5 @@
             "**/?(*.)+(spec|test).[jt]s?(x)",
             "**/?(*.)+(spec|test).mjs"
         ]
-    },
-    "dependencies": {
-        "@eliware/common": "^1.1.4"
     }
 }