human-ids 1.0.1 → 1.0.3

package/CHANGELOG.md

@@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+## [1.0.3] - 2023-07-07
+
+### Added
+- Added default settings
+## [1.0.2] - 2023-07-07
+
+### Changed
+- Refactor into function
 ## [1.0.1] - 2023-07-07
 
 ### Added

package/index.d.ts

@@ -0,0 +1,19 @@
+declare module 'human-ids' {
+  export interface IdGeneratorSettings {
+    lang: string;
+    adjective?: boolean;
+    color?: boolean;
+    noun?: boolean;
+    number?: {
+      min?: number;
+      max?: number;
+      completeWithZeros?: boolean;
+      sets?: number;
+    };
+  }
+
+  export default class IdGenerator {
+    constructor(settings?: IdGeneratorSettings);
+    generateId(): string;
+  }
+}

package/index.js

@@ -1,71 +1,83 @@
 const dictionaries = require('./dictionaries');
 
-class IdGenerator {
-  constructor(settings = {}) {
-    this.lang = dictionaries[settings.lang] ? settings.lang : dictionaries[settings.lang?.split('-')[0]] ? settings.lang?.split('-')[0] : 'en';
-    this.useAdjective = settings.adjective || false;
-    this.useColor = settings.color || false;
-    this.useNoun = settings.noun || false;
-    this.numberMin = settings.number && settings.number.min !== undefined ? settings.number.min : 0;
-    this.numberMax = settings.number && settings.number.max !== undefined ? settings.number.max : 999;
-    this.numberSets = settings.number && settings.number.sets || 1;
-    this.completeWithZeros = settings.number && settings.number.completeWithZeros || false;
-  }
+const defaultSettings = {
+  lang: 'en',
+  adjective: true,
+  color: true,
+  noun: true,
+  number: {
+    min: 0,
+    max: 999,
+    sets: 1,
+    completeWithZeros: false,
+  },
+};
+
+function generateId(userSettings = {}) {
+  const settings = Object.assign({}, defaultSettings, userSettings);
+  const lang = dictionaries[settings.lang] ? settings.lang : dictionaries[settings.lang?.split('-')[0]] ? settings.lang?.split('-')[0] : 'en';
+  const useAdjective = settings.adjective || false;
+  const useColor = settings.color || false;
+  const useNoun = settings.noun || false;
+  const numberMin = settings.number && settings.number.min !== undefined ? settings.number.min : 0;
+  const numberMax = settings.number && settings.number.max !== undefined ? settings.number.max : 999;
+  const numberSets = settings.number && settings.number.sets || 1;
+  const completeWithZeros = settings.number && settings.number.completeWithZeros || false;
 
-  getRandomNumber(min, max) {
+  function getRandomNumber(min, max) {
     return Math.floor(Math.random() * (max - min + 1)) + min;
   }
 
-  formatNumber(number) {
-    if (this.completeWithZeros) {
-      const maxNumberLength = this.numberMax.toString().length;
+  function formatNumber(number) {
+    if (completeWithZeros) {
+      const maxNumberLength = numberMax.toString().length;
       return number.toString().padStart(maxNumberLength, '0');
     } else {
       return number.toString();
     }
   }
 
-  getAdjectives() {
-    return dictionaries[this.lang].adjectives;
+  function getAdjectives() {
+    return dictionaries[lang].adjectives;
   }
 
-  getColors() {
-    return dictionaries[this.lang].colors;
+  function getColors() {
+    return dictionaries[lang].colors;
   }
 
-  getNouns() {
-    return dictionaries[this.lang].nouns;
+  function getNouns() {
+    return dictionaries[lang].nouns;
   }
 
-  generateId() {
-    const parts = [];
-
-    if (this.useAdjective) {
-      const adjectives = Object.values(this.getAdjectives());
-      const adjective = adjectives[Math.floor(Math.random() * adjectives.length)];
-      parts.push(adjective);
-    }
+  const parts = [];
 
-    if (this.useColor) {
-      const colors = Object.values(this.getColors());
-      const color = colors[Math.floor(Math.random() * colors.length)];
-      parts.push(color);
-    }
+  if (useAdjective) {
+    const adjectives = Object.values(getAdjectives());
+    const adjective = adjectives[Math.floor(Math.random() * adjectives.length)];
+    parts.push(adjective);
+  }
 
-    if (this.useNoun) {
-      const nouns = Object.values(this.getNouns());
-      const noun = nouns[Math.floor(Math.random() * nouns.length)];
-      parts.push(noun);
-    }
+  if (useColor) {
+    const colors = Object.values(getColors());
+    const color = colors[Math.floor(Math.random() * colors.length)];
+    parts.push(color);
+  }
 
-    for (let i = 0; i < this.numberSets; i++) {
-      const number = this.getRandomNumber(this.numberMin, this.numberMax);
-      const formattedNumber = this.formatNumber(number);
-      parts.push(formattedNumber);
-    }
+  if (useNoun) {
+    const nouns = Object.values(getNouns());
+    const noun = nouns[Math.floor(Math.random() * nouns.length)];
+    parts.push(noun);
+  }
 
-    return parts.join('-');
+  for (let i = 0; i < numberSets; i++) {
+    const number = getRandomNumber(numberMin, numberMax);
+    const formattedNumber = formatNumber(number);
+    parts.push(formattedNumber);
   }
+
+  return parts.join('-');
 }
 
-module.exports = IdGenerator;
+console.log(generateId())
+
+module.exports = generateId;

package/package.json

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

package/test-report.html

@@ -257,4 +257,4 @@ header {
   font-size: 1rem;
   padding: 0 0.5rem;
 }
-</style></head><body><div class="jesthtml-content"><header><h1 id="title">Test Report</h1></header><div id="metadata-container"><div id="timestamp">Started: 2023-07-07 11:15:36</div><div id="summary"><div id="suite-summary"><div class="summary-total">Suites (1)</div><div class="summary-passed  summary-empty">0 passed</div><div class="summary-failed ">1 failed</div><div class="summary-pending  summary-empty">0 pending</div></div><div id="test-summary"><div class="summary-total">Tests (1)</div><div class="summary-passed  summary-empty">0 passed</div><div class="summary-failed ">1 failed</div><div class="summary-pending  summary-empty">0 pending</div></div></div></div><div id="suite-1" class="suite-container"><input id="collapsible-0" type="checkbox" class="toggle" checked="checked"/><label for="collapsible-0"><div class="suite-info"><div class="suite-path">/Users/jcmujica/Code/jc/human-ids/tests/index.test.js</div><div class="suite-time warn">247.141s</div></div></label><div class="suite-tests"><div class="test-result failed"><div class="test-info"><div class="test-suitename">IdGenerator</div><div class="test-title">generateId should return a unique ID</div><div class="test-status">failed</div><div class="test-duration">246.948s</div></div></div></div></div></div></body></html>
+</style></head><body><div class="jesthtml-content"><header><h1 id="title">Test Report</h1></header><div id="metadata-container"><div id="timestamp">Started: 2023-07-07 12:23:52</div><div id="summary"><div id="suite-summary"><div class="summary-total">Suites (1)</div><div class="summary-passed ">1 passed</div><div class="summary-failed  summary-empty">0 failed</div><div class="summary-pending  summary-empty">0 pending</div></div><div id="test-summary"><div class="summary-total">Tests (1)</div><div class="summary-passed ">1 passed</div><div class="summary-failed  summary-empty">0 failed</div><div class="summary-pending  summary-empty">0 pending</div></div></div></div><div id="suite-1" class="suite-container"><input id="collapsible-0" type="checkbox" class="toggle" checked="checked"/><label for="collapsible-0"><div class="suite-info"><div class="suite-path">/Users/jcmujica/Code/jc/human-ids/tests/index.test.js</div><div class="suite-time">0.185s</div></div></label><div class="suite-tests"><div class="test-result passed"><div class="test-info"><div class="test-suitename">generateId</div><div class="test-title">should return a unique ID</div><div class="test-status">passed</div><div class="test-duration">0.005s</div></div></div></div></div></div></body></html>

package/tests/index.test.js

@@ -1,8 +1,8 @@
-const IdGenerator = require('../index');
+const generateId = require('../index');
 
-describe('IdGenerator', () => {
-  test('generateId should return a unique ID', () => {
-    const testLength = 1000000;
+describe('generateId', () => {
+  test('should return a unique ID', () => {
+    const testLength = 1000;
     const settings = {
       lang: 'en',
       adjective: true,
@@ -15,12 +15,11 @@ describe('IdGenerator', () => {
       }
     };
 
-    const idGenerator = new IdGenerator(settings);
     const ids = new Set();
 
-    // Generate 1000 IDs
+    // Generate testLength IDs
     for (let i = 0; i < testLength; i++) {
-      const id = idGenerator.generateId();
+      const id = generateId(settings);
       ids.add(id);
     }