di-short-mongo-id/lib/objectIdToShortId.js

Short id generation from MongoDB ObjectId's

const utils = require('./utils');
const ObjectId = require('bson').ObjectId;

function objectIdToShortId(id, uppercase) {
  // make sure it's an ObjectId, not just a string
  id = new ObjectId(String(id));

  // time in milliseconds (with precision in seconds)
  let time = id.getTimestamp().getTime();

  // hexadecimal counter converted to a decimal
  let counter = parseInt(id.toHexString().slice(-6), 16);

  // only use the last 3 digits of the counter to serve as our "milliseconds"
  counter = parseInt(counter.toString().slice(-3), 10);

  // add counter as our millisecond precision to our time
  time = time + counter;

  // convert to 32 base string
  let str = utils.toBase(time, 32);

  // slice off the first, least variating, character
  // this lowers the entropy, but brings us to 8 characters, which is nice.
  // This will cause a roll-over once every two years, but the counter and the rest of the timestamp should make it unique (enough)
  str = str.slice(1);

  // reverse the string so that the first characters have the most variation
  str = utils.reverse(str);

  if (uppercase) {
    str = str.toUpperCase();
  }

  return str;
}

module.exports = objectIdToShortId;