juri-cutlery

juri-cutlery
====

__NOTE__: This is a fork of the original juri package, which appears to be unmaintained. The sole purpose of this repo is to fix bugs rather than add features/expand on the API. If the original repo comes back to life, it is highly likely this package will be abandoned without notice in favour of that package.

Differences
-----------

1. Negative numbers serialise properly

Installation
------------

``
npm install juri-cutlery
`

Below is the original README, presented without modification.


juri
====

Encodes JSON objects into compact, human readable strings that are safe for use in URIs.

Juri works with Node.js and with browserify.

Installation
------------

`
npm install juri
`

Example
-----

Say you have data like this:

`javascript
{ zh:
{ name: 'China',
continent: 'Asia',
flagColors: [ 'red', 'yellow' ],
leader: { name: '习 近平-习', title: 'President', term: 137 },
population: 1370000000 },
in:
{ name: 'India',
continent: '',
a: true,
b: false,
c: null,
emptyArray: [],
emptyObject: {},
flagColors: [ 'orange', 'white', 'green' ],
leader: { name: 'Narendra\nModi.', title: 'Prime Minister', term: 119 },
population: 1190000000 },
array: [ 'asdf', [ 3, 4 ] ] }
`

Encode this using juri:

`
var juri = require("juri")();

juri.encode(object);
`

to get a string like:

`
(zh:(name:China,continent:Asia,flagColors:(red,yellow),leader:(name:'4vW_8@H5vp~F4vW',title:President,term:+29),population:+29+7),in:(name:India,continent:'',a:++,b:--,c:+-,emptyArray:(),emptyObject:(:),flagColors:(orange,white,green),leader:(name:Narendra~1Modi.,title:Prime_Minister,term:+1t),population:+1t+7)&array=(asdf,(+3,+4)))
`

or as a query string (juri.encodeQString(object)):

`
zh=(name:China,continent:Asia,flagColors:(red,yellow),leader:(name:'4vW_8@H5vp~F4vW',title:President,term:+29),population:+29+7)&in=(name:India,continent:'',a:++,b:--,c:+-,emptyArray:(),emptyObject:(:),flagColors:(orange,white,green),leader:(name:Narendra~1Modi.,title:Prime_Minister,term:+1t),population:+1t+7)&array=(asdf,(+3,+4))
`

which are around 55% smaller than the equivalent URL-encoded JSON.

A dictionary of up to 64 commonly repeated strings (e.g. key names, enum values, or even commonly repeated words) can be passed to the encoder and decoder to compress even further, at the cost of reduced human-readability.

For example,

`javascript
var dictionary = [
"red", "yellow", "orange", "blue", "green", "white",
"Asia", "North America", "South America",
"name", "continent", "flagColors",
"leader", "title", "term", "population", "平" ];

var juri = require("juri")(dictionary);

juri.encodeQString(object);
`

This gives:

`
zh=(n:China,c:A,f:(r,y),l:(n:'4vW_8@H0~F4vW',t:President,e:+29),p:
+29+7)&in=(n:India,c:'',a:++,b:--,c:+-,emptyArray:(),emptyObject:(:),f:(o,
w,g),l:(n:Narendra~1Modi.,t:Prime_Minister,e:+1t),p*:+1t+7)&array=(asdf,
(+3,+4))
`

It’s still somewhat human readable: n is name, c is country etc. This example was compressed to almost 30% of the size of URL-encoded JSON.

Differences from Rison
----------------------

Juri is similar to Rison but improves upon it
in many ways.

- Strings are unquoted and encoded efficiently instead of relying on percent-
encoding. Spaces are replaced with underscores (not %20), punctuation uses
two-byte escape sequences, and runs of non-latin characters are encoded with
Base64 which takes about 40% less space than percent-encoding.

- Numbers are encoded with modified Base64 alphabet whose first 16 characters are
0-9 and A-F. This keeps small numbers human readable while large ones (like
timestamps) are represented with 50% fewer bytes. All numbers are prefixed with
a sign (+ or -) and use exponent notation where it's shorter.

- Juri does not require special markers like !(...)` to distinguish between
objects and arrays; this saves characters in deeply nested structures and
is more readable.