human-ids 1.0.8 → 1.0.10

package/CHANGELOG.md

@@ -4,7 +4,17 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
-## [1.0.7] - 2023-07-07
+## [1.0.10] - 2023-07-07
+
+### Added
+- Added separator customization
+- Added random ordering for segments
+- Added support for custom dictionary
+## [1.0.9] - 2023-07-07
+
+### Changed
+- Changed removed init console.log
+## [1.0.8] - 2023-07-07
 
 ### Changed
 - Changed README.md to correctly display usage information

package/README.md

@@ -30,6 +30,25 @@ npm install human-ids
 ```javascript
 import humanId from 'human-ids'
 
+//If using a custom dictionary
+const customDictionary = {
+  adjectives: {
+    awesome: 'awesome',
+    amazing: 'amazing',
+    // ...
+  },
+  colors: {
+    red: 'red',
+    blue: 'blue',
+    // ...
+  },
+  nouns: {
+    cat: 'cat',
+    dog: 'dog',
+    // ...
+  },
+};
+
 // Initialize the settings object (these are the defaults)
 const settings = {
   lang: 'en',
@@ -55,6 +74,8 @@ The settings object allows you to customize the ID generation process. The avail
     adjective: Set to true to include an adjective in the ID (default: false).
     color: Set to true to include a color in the ID (default: false).
     noun: Set to true to include a noun in the ID (default: false).
+    randomOrder: Set to true to include a random order in the ID segments (default: false).
+    separator: Set to true to change a separator in the ID
     number: An object that configures the number part of the ID:
         min: The minimum value of the number (default: 0).
         max: The maximum value of the number (default: 999).

package/index.d.ts

@@ -4,11 +4,24 @@ declare module 'human-ids' {
     adjective?: boolean;
     color?: boolean;
     noun?: boolean;
+    randomOrder?: boolean;
+    separator?: string;
     number?: {
       min?: number;
       max?: number;
       completeWithZeros?: boolean;
     };
+    dictionary?: {
+      adjectives?: {
+        [key: string]: string[];
+      };
+      colors?: {
+        [key: string]: string[];
+      };
+      nouns?: {
+        [key: string]: string[];
+      }
+    };
   }
 
   function generateId(settings?: IdGeneratorSettings): string;

package/index.js

@@ -5,6 +5,8 @@ const defaultSettings = {
   adjective: true,
   color: true,
   noun: true,
+  randomOrder: false,
+  separator: '-',
   number: {
     min: 0,
     max: 999,
@@ -38,15 +40,15 @@ function generateId(userSettings = {}) {
   }
 
   function getAdjectives() {
-    return dictionaries[lang].adjectives;
+    return settings.dictionary && settings.dictionary.adjectives ? settings.dictionary.adjectives : {};
   }
 
   function getColors() {
-    return dictionaries[lang].colors;
+    return settings.dictionary && settings.dictionary.colors ? settings.dictionary.colors : {};
   }
 
   function getNouns() {
-    return dictionaries[lang].nouns;
+    return settings.dictionary && settings.dictionary.nouns ? settings.dictionary.nouns : {};
   }
 
   const parts = [];
@@ -75,9 +77,11 @@ function generateId(userSettings = {}) {
     parts.push(formattedNumber);
   }
 
-  return parts.join('-');
-}
+  if (settings.randomOrder) {
+    parts.sort(() => Math.random() - 0.5);
+  }
 
-console.log(generateId())
+  return parts.join(`${settings.separator}`);
+}
 
 module.exports = generateId;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "human-ids",
-  "version": "1.0.8",
+  "version": "1.0.10",
   "description": "A library to generate human readable IDs",
   "main": "index.js",
   "scripts": {

package/tests/index.test.js

@@ -2,12 +2,14 @@ const generateId = require('../index');
 
 describe('generateId', () => {
   test('should return a unique ID', () => {
-    const testLength = 1000;
+    const testLength = 1000000;
     const settings = {
       lang: 'en',
       adjective: true,
       color: true,
       noun: true,
+      randomOrder: true,
+      separator: '-',
       number: {
         min: 0,
         max: 9999,
@@ -20,6 +22,8 @@ describe('generateId', () => {
     // Generate testLength IDs
     for (let i = 0; i < testLength; i++) {
       const id = generateId(settings);
+
+      console.log(`${i} ID: ${id}`);
       ids.add(id);
     }