Add modules

.gitignore

@@ -0,0 +1,3 @@
+.tmp
+dist
+node_modules

JSONCrush.d.ts

@@ -0,0 +1,3 @@
+//Typescript type definitions for JSONCrush
+export type JSONCrush = (string: string, maxSubstringLength?: number) => string;
+export type JSONUncrush = (string: string) => string;

README.md

@@ -11,9 +11,26 @@ This simple system allows for excellent compression of uri encoded JSON strings
 
 # [TRY THE LIVE DEMO!](https://killedbyapixel.github.io/JSONCrush)
 
+# Install
+
+```bash
+npm install https://github.com/KilledByAPixel/JSONCrush.git
+```
+
+`npm install` creates modules for Common JS, ES Module, and UMD modules in `/dist` folder.
+
+Alternatively, include JSONCrush.js or JSONCrush.min.js in your script;
+
 # How to Use
 
-* Include JSONCrush.js or JSONCrush.min.js in your script
+```js
+//NodeJS: Require
+const {JSONCrush, JSONUncrush} = require('JSONCrush');
+
+//ES Module import
+import {JSONCrush, JSONUncrush} from 'JSONCrush';
+```
+
 * Pass a JSON string to JSONCrush to compress it into an encoded URI component.
 * This result can be safely used in a URL.
 * To decode, first call searchParams.get() or decodeURIComponent() on the string before uncrushing.

package.json

@@ -0,0 +1,38 @@
+{
+  "name": "JSONCrush",
+  "version": "1.0.1",
+  "description": "Compress JSON in URL friendly strings",
+  "main": "dist/JSONCrush.cjs.js",
+  "module": "dist/JSONCrush.esm.js",
+  "browser": "dist/JSONCrush.umd.js",
+  "types": "JSONCrush.d.ts",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "rollup -c",
+    "preinstall": "npm install --ignore-scripts && npm run build"
+  },
+  "engines": {
+    "node": ">=10.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/KilledByAPixel/JSONCrush.git"
+  },
+  "keywords": [
+    "JSON",
+    "URL",
+    "URI",
+    "compression"
+  ],
+  "author": "KilledByAPixel",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/KilledByAPixel/JSONCrush/issues"
+  },
+  "homepage": "https://github.com/KilledByAPixel/JSONCrush",
+  "devDependencies": {
+    "graceful-fs": "^4.2.4",
+    "rollup": "^2.36.1"
+  },
+  "dependencies": {}
+}

rollup.config.js

@@ -0,0 +1,30 @@
+import pkg from './package.json';
+import * as path from 'path';
+import {readFileSync, writeFileSync, existsSync, mkdirSync} from 'graceful-fs';
+
+//Before exporting rollup config:
+//* The rollup input requires a statement with exports for modules
+//* The input ./JSONCrush.js does not have exports because it may be used in
+//  contexts that do not support it. (such as ClosureCompiler)
+//* This sources JSONCrush.js, appends `exports` statement, and writes result to
+//  target .tmp/JSONCrush.js
+//* Note .tmp is in .gitignore
+const inputFileName = 'JSONCrush.js';
+const input = path.join(__dirname, inputFileName);
+const tmpDir = path.join(__dirname, '.tmp');
+if (!existsSync(tmpDir)) { mkdirSync(tmpDir); }
+const tmpInput = path.join(tmpDir, inputFileName);
+writeFileSync(tmpInput, readFileSync(input) + '\nexport {JSONCrush, JSONUncrush};');
+
+//Minimal rollup config to wrap JSONCrush in the module types cjs, es and umd
+export default {
+    input: tmpInput,
+    output: [
+        // CommonJS (for Node)
+        { file: pkg.main, format: 'cjs' },
+        // ES Module
+        { file: pkg.module, format: 'es' },
+        // browser-friendly UMD build
+        { name: 'JSONCrush', file: pkg.browser, format: 'umd' }
+    ]
+};