Improve exporting strategy

Author: alizain

cli.js bin/cli.jscli.js renamed to bin/cli.js

@@ -1,12 +1,12 @@
-interface PRNG {
+export interface PRNG {
   (): number
 }
 
-interface ULID {
+export interface ULID {
   (seedTime?: number): string
 }
 
-interface LibError extends Error {
+export interface LibError extends Error {
   source: string
 }
 

index.ts

@@ -0,0 +1,19 @@
+export interface PRNG {
+    (): number;
+}
+export interface ULID {
+    (seedTime?: number): string;
+}
+export interface LibError extends Error {
+    source: string;
+}
+export declare function replaceCharAt(str: string, index: number, char: string): string;
+export declare function incrementBase32(str: string): string;
+export declare function randomChar(prng: PRNG): string;
+export declare function encodeTime(now: number, len: number): string;
+export declare function encodeRandom(len: number, prng: PRNG): string;
+export declare function decodeTime(id: string): number;
+export declare function detectPrng(allowInsecure?: boolean, root?: any): PRNG;
+export declare function factory(currPrng?: PRNG): ULID;
+export declare function monotonicFactory(currPrng?: PRNG): ULID;
+export declare const ulid: ULID;

lib/index.d.ts

@@ -10,13 +10,13 @@ const ENCODING_LEN = ENCODING.length;
 const TIME_MAX = Math.pow(2, 48) - 1;
 const TIME_LEN = 10;
 const RANDOM_LEN = 16;
-function replaceCharAt(str, index, char) {
+export function replaceCharAt(str, index, char) {
     if (index > str.length - 1) {
         return str;
     }
     return str.substr(0, index) + char + str.substr(index + 1);
 }
-function incrementBase32(str) {
+export function incrementBase32(str) {
     let done = undefined;
     let index = str.length;
     let char;
@@ -39,14 +39,14 @@ function incrementBase32(str) {
     }
     throw createError("cannot increment this string");
 }
-function randomChar(prng) {
+export function randomChar(prng) {
     let rand = Math.floor(prng() * ENCODING_LEN);
     if (rand === ENCODING_LEN) {
         rand = ENCODING_LEN - 1;
     }
     return ENCODING.charAt(rand);
 }
-function encodeTime(now, len) {
+export function encodeTime(now, len) {
     if (isNaN(now)) {
         throw new Error(now + " must be a number");
     }
@@ -68,14 +68,14 @@ function encodeTime(now, len) {
     }
     return str;
 }
-function encodeRandom(len, prng) {
+export function encodeRandom(len, prng) {
     let str = "";
     for (; len > 0; len--) {
         str = randomChar(prng) + str;
     }
     return str;
 }
-function decodeTime(id) {
+export function decodeTime(id) {
     if (id.length !== TIME_LEN + RANDOM_LEN) {
         throw createError("malformed ulid");
     }
@@ -95,7 +95,7 @@ function decodeTime(id) {
     }
     return time;
 }
-function detectPrng(allowInsecure = false, root) {
+export function detectPrng(allowInsecure = false, root) {
     if (!root) {
         root = typeof window !== "undefined" ? window : null;
     }
@@ -122,7 +122,7 @@ function detectPrng(allowInsecure = false, root) {
     }
     throw createError("secure crypto unusable, insecure Math.random not allowedW");
 }
-function factory(currPrng) {
+export function factory(currPrng) {
     if (!currPrng) {
         currPrng = detectPrng();
     }
@@ -133,7 +133,7 @@ function factory(currPrng) {
         return encodeTime(seedTime, TIME_LEN) + encodeRandom(RANDOM_LEN, currPrng);
     };
 }
-function monotonicFactory(currPrng) {
+export function monotonicFactory(currPrng) {
     if (!currPrng) {
         currPrng = detectPrng();
     }
@@ -152,6 +152,4 @@ function monotonicFactory(currPrng) {
         return encodeTime(seedTime, TIME_LEN) + newRandom;
     };
 }
-const ulid = factory();
-
-export { replaceCharAt, incrementBase32, randomChar, encodeTime, encodeRandom, decodeTime, detectPrng, factory, monotonicFactory, ulid };
+export const ulid = factory();

dist/ulid.es6.js lib/index.jsdist/ulid.es6.js renamed to lib/index.js

@@ -1,9 +1,10 @@
 {
   "name": "ulid",
   "version": "2.0.1",
-  "description": "A universally unique lexicographically sortable identifier generator",
-  "main": "./dist/ulid.umd.js",
-  "module": "./dist/ulid.es6.js",
+  "description": "A universally-unique, lexicographically-sortable, identifier generator",
+  "main": "./lib/index.umd.js",
+  "module": "./lib/index.js",
+  "types": "./lib/index.d.ts",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/alizain/ulid.git"
@@ -30,9 +31,15 @@
     "typescript": "^2.5.3"
   },
   "scripts": {
-    "build": "./node_modules/.bin/rollup -c",
+    "ts": "./node_modules/.bin/tsc -p .",
+    "umd": "./node_modules/.bin/rollup -c",
+    "build": "npm run ts && npm run umd",
     "test": "./node_modules/.bin/istanbul cover node_modules/mocha/bin/_mocha -- -R spec",
     "perf": "./node_modules/.bin/matcha perf.js"
   },
-  "bin": "./cli.js"
+  "files": [
+    "bin",
+    "lib"
+  ],
+  "bin": "./bin/cli.js"
 }

dist/ulid.umd.js lib/index.umd.jsdist/ulid.umd.js renamed to lib/index.umd.js

@@ -12,20 +12,20 @@ const defaultPlugins = [
   typescript({ typescript: compiler })
 ]
 
-const es6Config = Object.assign({}, defaultConfig, {
-  output: {
-    format: 'es',
-    file: './dist/ulid.es6.js'
-  },
-  plugins: [
-    ...defaultPlugins
-  ]
-})
+// const es6Config = Object.assign({}, defaultConfig, {
+//   output: {
+//     format: 'es',
+//     file: './lib/ulid.es6.js'
+//   },
+//   plugins: [
+//     ...defaultPlugins
+//   ]
+// })
 
 const umdConfig = Object.assign({}, defaultConfig, {
   output: {
     format: 'umd',
-    file: './dist/ulid.umd.js'
+    file: './lib/index.umd.js'
   },
   plugins: [
     ...defaultPlugins,
@@ -34,6 +34,6 @@ const umdConfig = Object.assign({}, defaultConfig, {
 })
 
 export default [
-  es6Config,
+  // es6Config,
   umdConfig
 ]

package.json

@@ -1,6 +1,6 @@
 var assert = require('assert')
 var lolex = require('lolex')
-var ULID = require('./dist/ulid.umd.js')
+var ULID = require('./lib/index.umd.js')
 var ulid = ULID.factory()
 
 

rollup.config.js

@@ -4,8 +4,11 @@
       "ES5", "ES6", "ES7", "DOM"
     ],
     "types": [ "Node" ],
+    "declaration": true,
     "target": "ES6",
-    "module": "ES6"
+    "module": "ES6",
+    "outDir": "./lib"
   },
+  "compileOnSave": true,
   "strict": true
 }