feat: add immutable default dictionaries

README.md

@@ -52,7 +52,7 @@ Also, the following changes might generate errors in some edge-cases:
 
 ### New Features 🥳
 
-We have added the ability to generate UUIDs that contain a timestamp which can be extracted:
+The ability to generate UUIDs that contain a timestamp which can be extracted:
 
 ```js
 const uid = new ShortUniqueId();
@@ -65,6 +65,34 @@ console.log(uid.parseStamp(uidWithTimestamp));
 // 2021-05-03T06:24:58.000Z
 ```
 
+Default dictionaries (generated on the spot to reduce memory footprint and
+avoid dictionary injection vulnerabilities):
+
+- number
+- alpha
+- alpha_lower
+- alpha_upper
+- **alphanum** _(default when no dictionary is provided to `new ShortUniqueId()`)_
+- alphanum_lower
+- alphanum_upper
+- hex
+
+```js
+// instantiate using one of the default dictionary strings
+const uid = new ShortUniqueId({
+  dictionary: 'hex', // the default
+});
+
+console.log(uid.dict.join());
+// 0,1,2,3,4,5,6,7,8,9,a,b,c,d,e,f
+
+// or change the dictionary after instantiation
+uid.setDictionary('alpha_upper');
+
+console.log(uid.dict.join());
+// A,B,C,D,E,F,G,H,I,J,K,L,M,N,O,P,Q,R,S,T,U,V,W,X,Y,Z
+```
+
 ### Use in CLI
 
 ```sh
@@ -85,16 +113,22 @@ $ short-unique-id -h
 
 ### Use as module
 
+Add to your project:
+
 ```js
 // Deno (web module) Import
 import ShortUniqueId from 'https://cdn.jsdelivr.net/npm/short-unique-id@latest/src/index.ts';
 
 // ES6 / TypeScript Import
 import ShortUniqueId from 'short-unique-id';
 
-//or Node.js require
+// Node.js require
 const ShortUniqueId = require('short-unique-id');
+```
+
+Instantiate and use:
 
+```js
 //Instantiate
 const uid = new ShortUniqueId();
 
@@ -108,7 +142,7 @@ console.log(uid.seq());
 ### Use in browser
 
 ```html
-<!-- Import -->
+<!-- Add source (minified 6.9K) -->
 <script src="https://cdn.jsdelivr.net/npm/short-unique-id@latest/dist/short-unique-id.min.js"></script>
 
 <!-- Usage -->

bin/short-unique-id

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 const fs = require('fs');
 const assert = require('assert');
-const { default: ShortUniqueId } = require('short-unique-id');
+const ShortUniqueId = require('short-unique-id');
 
 const [,, ...args] = process.argv;
 

dist/dist.d.ts

@@ -0,0 +1,2 @@
+import ShortUniqueId from './';
+export default ShortUniqueId;

dist/short-unique-id.d.ts

@@ -1,3 +1,7 @@
+interface ShortUniqueIdRanges {
+    [k: string]: [number, number];
+}
+declare type defaultDictionaries = 'number' | 'alpha' | 'alpha_lower' | 'alpha_upper' | 'alphanum' | 'alphanum_lower' | 'alphanum_upper' | 'hex';
 /**
  * ```js
  * {
@@ -10,7 +14,7 @@
  */
 export interface ShortUniqueIdOptions {
     /** User-defined character dictionary */
-    dictionary: string[];
+    dictionary: string[] | defaultDictionaries;
     /** If true, sequentialUUID use the dictionary in the given order */
     shuffle: boolean;
     /** If true the instance will console.log useful info */
@@ -96,9 +100,24 @@ export default class ShortUniqueId extends Function {
     upperBound: number;
     dictLength: number;
     uuidLength: number;
+    protected _digit_first_ascii: number;
+    protected _digit_last_ascii: number;
+    protected _alpha_lower_first_ascii: number;
+    protected _alpha_lower_last_ascii: number;
+    protected _hex_last_ascii: number;
+    protected _alpha_upper_first_ascii: number;
+    protected _alpha_upper_last_ascii: number;
+    protected _number_dict_ranges: ShortUniqueIdRanges;
+    protected _alpha_dict_ranges: ShortUniqueIdRanges;
+    protected _alpha_lower_dict_ranges: ShortUniqueIdRanges;
+    protected _alpha_upper_dict_ranges: ShortUniqueIdRanges;
+    protected _alphanum_dict_ranges: ShortUniqueIdRanges;
+    protected _alphanum_lower_dict_ranges: ShortUniqueIdRanges;
+    protected _alphanum_upper_dict_ranges: ShortUniqueIdRanges;
+    protected _hex_dict_ranges: ShortUniqueIdRanges;
     protected log: (...args: any[]) => void;
     /** Change the dictionary after initialization. */
-    setDictionary: (dictionary: string[]) => void;
+    setDictionary: (dictionary: string[] | defaultDictionaries, shuffle?: boolean | undefined) => void;
     seq: () => string;
     /**
      * Generates UUID based on internal counter that's incremented after each ID generation.
@@ -219,3 +238,4 @@ export default class ShortUniqueId extends Function {
     parseStamp: (stamp: string) => Date;
     constructor(argOptions?: Partial<ShortUniqueIdOptions>);
 }
+export {};