@trenskow/json-compressor 0.1.0

package/.vscode/launch.json

@@ -0,0 +1,16 @@
+{
+	// Use IntelliSense to learn about possible attributes.
+	// Hover to view descriptions of existing attributes.
+	// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+	"version": "0.2.0",
+	"configurations": [
+		{
+			"type":"node",
+			"request":"launch",
+			"name":"Run tests",
+			"runtimeExecutable":"_mocha",
+			"cwd":"${workspaceFolder}",
+			"args":[]
+		}
+	]
+}

package/LICENSE

@@ -0,0 +1,9 @@
+Copyright 2025 Kristian Trenskow
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,29 @@
+@trenskow/json-compressor
+----
+
+A simple JSON to JSON compressor for JavaScript.
+
+It also preserves circular references – useful for stringifying complex object graphs.
+
+# Usage
+
+Below is an example of how to use.
+
+````javascript
+import { inflate, deflate } from '@trenskow/json-compressor';
+
+const myObject = {
+  hello: 'world'
+};
+
+myObject.circular = myObject;
+
+const json = JSON.stringify(deflate(myObject));
+
+inflate(JSON.parse(JSON)); // Returns copy of original instance (with circular reference preserved).
+````
+
+# License
+
+See license in LICENSE.
+

package/eslint.config.js

@@ -0,0 +1,55 @@
+import globals from 'globals';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import js from '@eslint/js';
+import { FlatCompat } from '@eslint/eslintrc';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const compat = new FlatCompat({
+	baseDirectory: __dirname,
+	recommendedConfig: js.configs.recommended,
+	allConfig: js.configs.all
+});
+
+export default [...compat.extends('eslint:recommended'), {
+	languageOptions: {
+		globals: {
+			...globals.node,
+			...globals.mocha,
+		},
+
+		ecmaVersion: 'latest',
+		sourceType: 'module',
+	},
+
+	rules: {
+		indent: ['error', 'tab', {
+			SwitchCase: 1,
+		}],
+
+		'linebreak-style': ['error', 'unix'],
+		quotes: ['error', 'single'],
+		semi: ['error', 'always'],
+
+		'no-console': ['error', {
+			allow: ['warn', 'error', 'info'],
+		}],
+
+		'no-unused-vars': ['error', {
+			argsIgnorePattern: '^_',
+		}],
+
+		'no-empty': ['error', {
+			allowEmptyCatch: true,
+		}],
+
+		'no-trailing-spaces': ['error', {
+			ignoreComments: true,
+		}],
+
+		'require-atomic-updates': 'off',
+		'no-implicit-globals': ['error'],
+		'eol-last': ['error', 'always'],
+	},
+}];

package/index.js

@@ -0,0 +1,9 @@
+//
+// index.js
+// @trenskow/json-compressor
+//
+// Created by Kristian Trenskow on 2025/12/19
+// For license see LICENSE.
+//
+
+export * from './lib/index.js';

package/lib/index.js

@@ -0,0 +1,196 @@
+//
+// index.js
+// @trenskow/json-compressor
+//
+// Created by Kristian Trenskow on 2025/12/19
+// For license see LICENSE.
+//
+
+import equals from '@trenskow/equals';
+
+const literals = {
+	[undefined]: -1,
+	[null]: -2,
+	[true]: -3,
+	[false]: -4,
+};
+
+const indices = {
+	[-1]: undefined,
+	[-2]: null,
+	[-3]: true,
+	[-4]: false,
+};
+
+const _deflate = (json, output, seen) => {
+
+	const referenceIndex = seen.findIndex((item) => typeof item === 'object' && json === item);
+
+	if (referenceIndex !== -1) {
+		return `"${referenceIndex}"`;
+	}
+
+	const index = seen.findIndex((item) => equals(json, item));
+
+	if (index !== -1) {
+		return index;
+	}
+
+	if (json in literals) {
+		return literals[json];
+	}
+
+	seen.push(json);
+
+	if (typeof json === 'object') {
+
+		if (Array.isArray(json)) {
+			return _deflate.array(json, output, seen);
+		}
+
+		return _deflate.object(json, output, seen);
+
+	}
+
+	output.push(json);
+
+	return output.length - 1;
+
+};
+
+_deflate.array = (json, output, seen) => {
+
+	const result = ['a'];
+
+	output.push(result);
+
+	const index = output.length - 1;
+
+	for (let i = 0; i < json.length; i++) {
+		result.push(_deflate(json[i], output, seen));
+	}
+
+	return index;
+
+};
+
+_deflate.object = (json, output, seen) => {
+
+	const result = ['o'];
+
+	output.push(result);
+
+	const index = output.length - 1;
+
+	for (const key in json) {
+		result.push(_deflate(key, output, seen));
+		result.push(_deflate(json[key], output, seen));
+	}
+
+	return index;
+
+};
+
+const deflate = (json) => {
+
+	const output = [];
+
+	_deflate(json, output, []);
+
+	if (output.length < 2) {
+		return json;
+	}
+
+	return output;
+
+};
+
+const _inflate = (data, index, resolved) => {
+
+	if (index in indices) {
+		return indices[index];
+	}
+
+	if (typeof index === 'string' && index.startsWith('"') && index.endsWith('"')) {
+		return resolved[parseInt(index.slice(1, -1), 10)];
+	}
+
+	const value = data[index];
+
+	if (Array.isArray(value)) {
+
+		if (value[0] === 'a') {
+			return _inflate.array(data, index, value.slice(1), resolved);
+		}
+
+		if (value[0] === 'o') {
+			return _inflate.object(data, index, value.slice(1), resolved);
+		}
+
+		return data;
+
+	}
+
+	return value;
+
+};
+
+_inflate.array = (data, index, value, resolved) => {
+
+	const result = [];
+
+	resolved[index] = result;
+
+	for (let i = 0; i < value.length; i++) {
+		result.push(_inflate(data, value[i], resolved));
+	}
+
+	return result;
+
+};
+
+_inflate.object = (data, index, value, resolved) => {
+
+	if (value.length % 2 !== 0) {
+		return value;
+	}
+
+	const result = {};
+
+	resolved[index] = result;
+
+	for (let i = 0; i < value.length; i += 2) {
+		result[_inflate(data, value[i], resolved)] = _inflate(data, value[i + 1], resolved);
+	}
+
+	return result;
+
+};
+
+const inflate = (data) => {
+
+	if (!Array.isArray(data)) {
+		return data;
+	}
+
+	if (data.length < 2) {
+		return data;
+	}
+
+	if (!Array.isArray(data[0])) {
+		return data;
+	}
+
+	return _inflate(data, 0, {});
+
+};
+
+export {
+	deflate,
+	inflate
+};
+
+export default {
+	deflate,
+	inflate
+};

package/package.json

@@ -0,0 +1,36 @@
+{
+	"name": "@trenskow/json-compressor",
+	"version": "0.1.0",
+	"description": "A simple JSON to JSON compressor for JavaScript.",
+	"keywords": [
+		"json",
+		"compressor",
+		"serialization"
+	],
+	"homepage": "https://github.com/trenskow/json-compressor#readme",
+	"bugs": {
+		"url": "https://github.com/trenskow/json-compressor/issues"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/trenskow/json-compressor.git"
+	},
+	"license": "BSD-2-Clause",
+	"author": "Kristian Trenskow <this.is@kristians.email>",
+	"type": "module",
+	"main": "index.js",
+	"scripts": {
+		"test": "node ./node_modules/mocha/bin/mocha.js ./test/index.js"
+	},
+	"devDependencies": {
+		"@eslint/eslintrc": "^3.3.3",
+		"@eslint/js": "^9.39.2",
+		"chai": "^6.2.1",
+		"eslint": "^9.39.2",
+		"globals": "^16.5.0",
+		"mocha": "^11.7.5"
+	},
+	"dependencies": {
+		"@trenskow/equals": "^0.1.2"
+	}
+}

package/test/index.js

@@ -0,0 +1,89 @@
+//
+// test.js
+// @trenskow/json-compressor
+//
+// Created by Kristian Trenskow on 2025/12/19
+// For license see LICENSE.
+//
+
+import { expect } from 'chai';
+
+import { deflate, inflate } from '../lib/index.js';
+
+describe('@trenskow/json-compressor', () => {
+
+	describe('deflate()', () => {
+
+		it ('should come back with `[-1]`.', () => {
+			expect(deflate(undefined)).to.eql(undefined);
+		});
+
+		it ('should come back with `[-2]`.', () => {
+			expect(deflate(null)).to.eql(null);
+		});
+
+		it ('should come back with `[-3]`.', () => {
+			expect(deflate(true)).to.eql(true);
+		});
+
+		it ('should come back with `[-4]`.', () => {
+			expect(deflate(false)).to.eql(false);
+		});
+
+		it ('should come back with `[[\'o\', 1, 2, 2, 1, 3, -2], \'hello\', \'world\', \'none\']`.', () => {
+			expect(deflate({ hello: 'world', world: 'hello', none: null })).to.eql([['o', 1, 2, 2, 1, 3, -2], 'hello', 'world', 'none']);
+		});
+
+		it ('should come back with `[[\'a\', 1, 2, 2, -2], \'hello\', \'world\']`.', () => {
+			expect(deflate(['hello', 'world', 'world', null])).to.eql([['a', 1, 2, 2, -2], 'hello', 'world']);
+		});
+
+		it ('should come back with circular reference.', () => {
+
+			const arr = ['hello'];
+			arr.push(arr);
+
+			expect(deflate(arr)).to.eql([['a', 1, '"0"'], 'hello']);
+
+		});
+
+	});
+
+	describe('inflate()', () => {
+
+		it ('should come back with `undefined`.', () => {
+			expect(inflate(undefined)).to.eql(undefined);
+		});
+
+		it ('should come back with `null`.', () => {
+			expect(inflate(null)).to.eql(null);
+		});
+
+		it ('should come back with `true`.', () => {
+			expect(inflate(true)).to.eql(true);
+		});
+
+		it ('should come back with `false`.', () => {
+			expect(inflate(false)).to.eql(false);
+		});
+
+		it ('should come back with `{ hello: \'world\', world: \'hello\', none: null }`.', () => {
+			expect(inflate([['o', 1, 2, 2, 1, 3, -2], 'hello', 'world', 'none'])).to.eql({ hello: 'world', world: 'hello', none: null });
+		});
+
+		it ('should come back with `[\'hello\', \'world\', \'world\', null]`.', () => {
+			expect(inflate([['a', 1, 2, 2, -2], 'hello', 'world'])).to.eql(['hello', 'world', 'world', null]);
+		});
+
+		it ('should come back with circular reference.', () => {
+
+			const inflated = inflate([['a', 1, '"0"'], 'hello']);
+
+			expect(inflated[0]).to.eql('hello');
+			expect(inflated[1]).to.eql(inflated);
+
+		});
+
+	});
+
+});