Merge pull request #24 from oculus42/housekeeping

3.1.0 - add generate

.travis.yml

@@ -1,7 +1,7 @@
 language: node_js
 node_js:
+  - "11"
   - "10"
-  - "9"
   - "8"
   - "6"
   - "4"

CHANGELOG.md

@@ -2,7 +2,20 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## [3.0.0] - 2018-23-24
+## [3.1.0] - 2018-12-08
+### Changed
+- Updated dev packages for vulnerability fixes
+- Added top-level `generate` in [index.js]
+- Added `generate` alias on translators in [index.js]
+- Added tests for `generate`
+- Updated [index.d.ts] definitions
+- Update [README.md] to help clarify the functionality
+
+## [3.0.1] - 2018-10-18
+### Changed
+- Build dependencies update
+
+## [3.0.0] - 2018-03-24
 ### Changed
 - Refactored export in [gruntfile.js] for CodeClimate
 - Refactored export in [index.js] for CodeClimate

index.d.ts

@@ -5,18 +5,24 @@ declare module 'short-uuid' {
     export const constants: {
       flickrBase58: string;
       cookieBase90: string;
-    }
+    };
 
     /** Generate a new regular UUID. */
     export function uuid(): string;
 
+    /** Generate a base 58 short uuid */
+    export function generate(): string;
+
     export interface Translator {
       /** The alphabet used for encoding UUIDs. */
       alphabet: string;
 
       /** Generate a new short UUID using this translator's alphabet. */
       new: () => string;
 
+      /** Generate a new short UUID using this translator's alphabet. */
+      generate: () => string;
+
       /** Generate a new regular UUID. */
       uuid(): string;
 

index.js

@@ -9,6 +9,8 @@ var uuidV4 = require('uuid/v4');
 var flickrBase58 = '123456789abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ';
 var cookieBase90 = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!#$%&'()*+-./:<=>?@[]^_`{|}~";
 
+var toFlickr;
+
 /**
  * Takes a UUID, strips the dashes, and translates.
  * @param {string} longId
@@ -61,9 +63,11 @@ module.exports = (function(){
         // UUIDs are in hex, so we translate to and from.
         var fromHex = anyBase(anyBase.HEX, useAlphabet);
         var toHex = anyBase(useAlphabet, anyBase.HEX);
+        var generate = function() { return shortenUUID(uuidV4(), fromHex); };
 
         return {
-            new: function() { return shortenUUID(uuidV4(), fromHex); },
+            new: generate,
+            generate: generate,
             uuid: uuidV4,
             fromUUID: function(uuid) { return shortenUUID(uuid, fromHex); },
             toUUID: function(shortUuid) { return enlargeUUID(shortUuid, toHex); },
@@ -80,5 +84,14 @@ module.exports = (function(){
     // Expose the generic v4 UUID generator for convenience
     MakeConvertor.uuid = uuidV4;
 
+    // Provide a generic generator
+    MakeConvertor.generate = function() {
+        if (!toFlickr) {
+            // Generate on first use;
+            toFlickr = anyBase(anyBase.HEX, flickrBase58);
+        }
+        return shortenUUID(uuidV4(), toFlickr);
+    };
+
     return MakeConvertor;
 }());

package.json

@@ -1,6 +1,6 @@
 {
   "name": "short-uuid",
-  "version": "3.0.1",
+  "version": "3.1.0",
   "description": "Create and translate standard UUIDs with shorter formats.",
   "main": "index.js",
   "typings": "index.d.ts",

test/index.js

@@ -154,4 +154,25 @@ describe('short-uuid', function(){
 
     });
 
+    describe('generate', function(){
+        it('should generate an ID with the Flickr set', function(){
+            var val = short.generate();
+
+            var b58 = short(short.constants.flickrBase58);
+
+            var expanded = b58.toUUID(val);
+            var shortened = b58.fromUUID(expanded);
+
+            assert.equal(val, shortened, 'Generated Short ID is the same as re-shortened ID');
+
+            assert.ok(validUUIDRegex.test(expanded), 'UUID is valid');
+        });
+
+        it('should reuse the translator', function() {
+            var val = short.generate();
+            // No complex test, this is validating the second-time code path
+            assert.ok(val);
+        })
+    });
+
 });