NehoID - Advanced Unique ID Generation Utility

🌟 What Makes NehoID Special?

Unlike other ID generators, NehoID provides:

• Multi-Layer Encoding: Advanced encoding pipeline with 20+ encoding types
• Smart Collision Detection: Built-in collision avoidance with configurable strategies
• Context-Aware Generation: Device, location, and behavior-aware IDs
• Advanced Analytics: Performance monitoring and ID distribution analysis
• Format Migration: Tools to migrate between ID formats
• Batch Operations: High-performance bulk ID generation
• Custom Alphabets: Support for domain-specific character sets
• ID Health Scoring: Validate and score ID quality

📦 Installation

1npm install nehoid
2# or
3yarn add nehoid
4# or
5bun add nehoid

🚀 Quick Start

1import { NehoID } from "nehoid";
2
3// Basic usage
4const id = NehoID.generate();
5console.log(id); // "6a617977416b714d-7938716a56515a52-79764d5a50775555"
6
7// Advanced usage with collision detection
8const safeId = await NehoID.safe({
9  strategy: "retry",
10  maxAttempts: 3,
11  checkFunction: async (id) => !(await database.exists(id)),
12});
13
14// Context-aware ID
15const contextId = NehoID.contextual({
16  includeDevice: true,
17  includeLocation: true,
18  userBehavior: "returning-customer",
19});

🎯 Core Features

1. Multiple ID Types

1// Standard formats
2NehoID.uuid(); // Standard UUID v4
3NehoID.nanoid(); // NanoID compatible
4NehoID.short(); // URL-safe short ID
5NehoID.hex(); // Hexadecimal ID
6
7// Advanced formats
8NehoID.hierarchical(); // Parent-child relationships
9NehoID.temporal(); // Time-ordered IDs
10NehoID.semantic(); // Meaningful prefixes
11NehoID.sequential(); // Database-friendly sequence

2. Smart Collision Detection

1const collisionSafeId = await NehoID.safe({
2  strategy: "exponential-backoff",
3  maxAttempts: 5,
4  checkFunction: async (id) => {
5    return !(await yourDatabase.exists("users", id));
6  },
7});

3. Advanced Encoding Pipeline

1NehoID.generate({
2  encoding: ["base64", "hex", "rot13"], // Multi-layer encoding
3  compression: "lz77", // Optional compression
4  alphabet: "ABCDEFGHIJKLMNOPQR", // Custom alphabet
5  reversible: true, // Enable reverse engineering
6});

4. Batch Operations

1// Generate thousands of IDs efficiently
2const batchIds = NehoID.batch({
3  count: 10000,
4  format: "nano",
5  parallel: true,
6  ensureUnique: true,
7});
8
9// Bulk validation
10const validation = NehoID.validateBatch(existingIds, {
11  checkFormat: true,
12  checkCollisions: true,
13  repairCorrupted: true,
14});

5. Analytics & Monitoring

1// Performance monitoring
2NehoID.startMonitoring();
3const stats = NehoID.getStats();
4/*
5{
6  generated: 15420,
7  collisions: 0,
8  averageGenerationTime: '0.12ms',
9  memoryUsage: '2.1MB',
10  distributionScore: 0.98
11}
12*/
13
14// ID health scoring
15const health = NehoID.healthCheck("your-id-here");
16/*
17{
18  score: 0.95,
19  entropy: 'high',
20  predictability: 'low',
21  recommendations: ['increase_length']
22}
23*/

6. Context-Aware Generation

1// Device-aware IDs
2const deviceId = NehoID.contextual({
3  includeDevice: true, // Device fingerprint
4  includeTimezone: true, // User timezone
5  includeBrowser: true, // Browser info
6  includeScreen: true, // Screen resolution
7});
8
9// Business context
10const businessId = NehoID.semantic({
11  prefix: "ORDER",
12  region: "US-WEST",
13  department: "SALES",
14  year: 2024,
15}); // Result: "ORDER-USWEST-SALES-2024-a7b9c2d4"

7. Migration & Compatibility

1// Migrate old IDs to new format
2const migrated = NehoID.migrate({
3  from: "uuid",
4  to: "nehoid-v2",
5  preserveOrder: true,
6  batchSize: 1000,
7});
8
9// Cross-platform compatibility
10const compatible = NehoID.compatible({
11  platform: ["javascript", "python", "go"],
12  format: "base64",
13  length: 16,
14});

🔧 Advanced Configuration

1import { NehoID, CollisionStrategy, EncodingPipeline } from "nehoid";
2
3// Custom collision strategy
4const customStrategy: CollisionStrategy = {
5  name: "database-check",
6  maxAttempts: 3,
7  backoffType: "exponential",
8  checkFunction: async (id) => {
9    return !(await myDatabase.findById(id));
10  },
11};
12
13// Custom encoding pipeline
14const pipeline = new EncodingPipeline()
15  .addEncoder("base64")
16  .addCompression("gzip")
17  .addEncoder("hex")
18  .enableReversibility();
19
20const id = NehoID.generate({
21  strategy: customStrategy,
22  pipeline: pipeline,
23  metadata: {
24    createdBy: "user-service",
25    version: "2.1.0",
26  },
27});

📊 Performance Benchmarks

Operation	NehoID	uuid	nanoid	shortid
Generate 1K IDs	0.8ms	1.2ms	1.0ms	2.1ms
Batch 100K IDs	45ms	78ms	62ms	180ms
Collision Check	0.1ms	N/A	N/A	N/A
Memory Usage	1.2MB	2.1MB	1.8MB	3.2MB

🛠 API Reference

Core Methods

• NehoID.generate(options?) - Generate basic ID
• NehoID.safe(options) - Generate with collision detection
• NehoID.batch(options) - Bulk generation
• NehoID.validate(id, options?) - Validate ID format
• NehoID.healthCheck(id) - Score ID quality

Specialized Generators

• NehoID.uuid() - Standard UUID
• NehoID.nanoid(length?) - NanoID format
• NehoID.short(length?) - Short URL-safe ID
• NehoID.hex(length?) - Hexadecimal ID
• NehoID.contextual(options) - Context-aware ID
• NehoID.semantic(options) - Semantic/meaningful ID

Utilities

• NehoID.decode(id) - Reverse engineer ID (if reversible)
• NehoID.migrate(options) - Migrate ID formats
• NehoID.compatible(options) - Cross-platform compatible IDs
• NehoID.startMonitoring() - Enable performance monitoring
• NehoID.getStats() - Get generation statistics

🔒 Security Features

• Cryptographically secure random generation
• Timing attack resistance
• No predictable patterns
• Optional encryption layer
• Audit trail support

🌐 Framework Integrations

1// Express.js middleware
2app.use(
3  NehoID.middleware({
4    header: "X-Request-ID",
5    format: "short",
6  })
7);
8
9// Database ORM integration
10const User = model("User", {
11  id: {
12    type: String,
13    default: () => NehoID.generate({ prefix: "usr" }),
14  },
15});

🚀 Advanced V2 Features

NehoID V2 introduces a set of advanced ID generation capabilities for specialized use cases:

1import { NehoId } from "nehoid";
2
3// Quantum-entangled IDs
4const quantumId = NehoId.quantum({ 
5  entanglementGroup: "user-session",
6  coherenceTime: 60000 // 1 minute
7});
8
9// Biometric-based IDs
10const bioId = NehoId.biometric({
11  fingerprint: "fp_data_hash",
12  keystrokeDynamics: [0.32, 0.45, 0.67]
13});
14
15// Blockchain-verified IDs
16const blockchainId = NehoId.blockchain({
17  networkId: "main-net",
18  consensusType: "proof-of-stake"
19});
20
21// Pattern-embedded IDs
22const patternId = NehoId.patternEmbedded("user-behavior-pattern");
23
24// Recursive IDs (nested structure)
25const recursiveId = NehoId.recursive(3); // depth of 3
26
27// Fractal IDs (self-similar patterns)
28const fractalId = NehoId.fractal(4, 0.8); // 4 iterations, 0.8 complexity

Combination Methods

1// Ultimate ID: combines quantum, biometric, and ML features
2const ultimateId = NehoId.ultimate({
3  quantumGroup: "secure-session",
4  biometricData: { fingerprint: "fp_hash", voicePrint: "vp_hash" },
5  mlFeatures: [0.7, 0.2, 0.9]
6});
7
8// Cosmic DNA ID: combines astronomical and genetic features
9const cosmicDnaId = NehoId.cosmicDNA("orion", 5);
10
11// Predictive sequence: time-series based IDs
12const predictiveSequence = NehoId.predictiveSequence(5);
13console.log(predictiveSequence.baseId); // Base ID
14console.log(predictiveSequence.sequenceIds); // Array of sequence IDs
15const materializedId = predictiveSequence.materialize(2); // Materialize the 3rd ID

Dynamic ID Systems

1// Adaptive ID system that evolves over time
2const adaptiveSystem = NehoId.createAdaptiveSystem({});
3const adaptiveId1 = adaptiveSystem.generateNext();
4const adaptiveId2 = adaptiveSystem.generateNext("user-login");
5console.log(adaptiveSystem.getEvolutionHistory());
6
7// Fluid ID pool with transformations
8const fluidPool = NehoId.createFluidPool(50);
9const fluidId = fluidPool.draw();
10fluidPool.replenish(10);

📝 License

MIT License - see LICENSE file for details

🤝 Contributing

We welcome contributions! See CONTRIBUTING.md for guidelines.

📞 Support

• 📧 Email: support@nehonix.space
• 🐛 Issues: GitHub Issues
• 📖 Docs: Full Documentation