Skip to content

Latest commit

 

History

History
324 lines (245 loc) · 11.9 KB

README.md

File metadata and controls

324 lines (245 loc) · 11.9 KB
Raw

💙 weird json npm visitors+++ npm

A menagerie of strange, encoded JSONs, for connoisseurs.

what?

TLDR - JSON superset, supporting BigInts, TypedArrays, null, undefined, Symbol and more.

WeirdJSON is a JavaScript / Node.JS library that allows you to serialize any JavaScript object to a "JSON-like" but extended, text representation. With weird-json, you can easily encode complex and unconventional data structures, including support for BigInts, TypedArrays, null, undefined, and Symbol. weird-json comes in a variety of flavors, including deepCopy, JSON36, JSON46, and JSON64, so you can choose the best option for your specific needs. Whether you're a JSON connoisseur or just looking to handle some weird data, weird-json has you covered!

features

Comes in a variety of flavors:

  • deepCopy - clones an object as deeply as possible. (Limitations: No support for functions because of closure inequality, no preservation of prototype chain for custom objects but all JavaScript builtin objects supported on the browser are handled (but not DOM/CSSOM API objects like Node, or XMLHttpRequest, CSSStyleSheetDeclaration), no cloning of unregistered Symbols (i.e, not created with Symbol.for), no support for WeakSet nor WeakMap. See limitationisms for details.
  • JSON36 - JSON46 but coded down to (case-insensitive) A-Z0-9
  • JSON46 - Supports the full 17-plane Unicode 13, and codes it down to ASCII without Base64. HUZZAH!
  • JSON64 - JSON46 but encoded with irradix to a special base64

Simple example:

> JSON36.stringify({a:[NaN, 1.23e72]})
'dga002pabdeawacas1dk23edj72adfdh'
> JSON36.parse('dga002pabdeawacas1dk23edj72adfdh')
{ a: [ NaN, 1.23e+72 ] }
> JSON36.stringify(489572349583759234857234958237459348734934958374n)
'aoda0m5nl54p8yz1dcdby79z5ddxhjvv7qexya'
> JSON36.parse('aoda0m5nl54p8yz1dcdby79z5ddxhjvv7qexya')
489572349583759234857234958237459348734934958374n

usagistics

$ npm i --save weird-json
$ node -r esm
Welcome to Node.js v14.15.1.
Type ".help" for more information.
> const {deepCopy} = require('weird-json');
> deepCopy(new Array(1,2,{c:3}))
[ 1, 2, { c: 3 } ]
> import {deepCopy as deepCopy2} from 'weird-json';
> deepCopy(new Array(1,2,{c:3}))
[ 1, 2, { lostWorld: 'JPark' } ]

testimoanials

Go where no Unicode JSON has gone before. Go where only ASCII can!

— J. (Son) F. Kennedy

You stole our previous alphabet!

— NATO

get to know the current JSONs-in-residence

The merry little band of tricksters: JSON46, JSON36, JSON37 and the ever-affable, JSON38

JSON46

Forged in the fires of Mordor, the hand-polished 46 runic sigils of our exclusive 46 line cover all your possible use cases. You can make a Chinese JSON, an emoji JSON, and then safely protect it and in the darkness bind it so only 36 alphanumerics plus 7 unique JSON structural symbols, plus 3 highly-coveted numeric specifiers (e, + and -) are present.

Features:

  • alphabet: a-z, 0-9, :,"[]{}.+-
  • JSON superset, supports BigInt, TypedArrays, null, undefined and Symbol

Complete ASCII. Complete URL safe. But not safe enough? Try JSON36. 🎉

JSON36

Like JSON46, but encoded again into the 36ers: a-z, 0-9. Fully NATO compliant.

JSON37

Like JSON46, but compressed with LZW, then encoded into the 36ers: a-z, 0-9 plus . Also, NATO phonetic alphabet compliant.

JSON38

Like JSON37, but separated into stanzas separted by - dash. Also, NATO phonetic alphabet OK.

JSON64

Like JSON46, but instead of being coded down to ASCII we leave the unicode in, then encode it in a special Base64 powered by irradix that uses bit packing.

examplings

From the tests:

  // simple example

  const b = {
    hi: "💉💎 or 👦🏻👓⚡嗨，我唔係Gpt - 3寫嘅。 你叫咩名呀?"
  };
  const bStr = JSON46.stringify(b);
  const bStr2 = JSON36.stringify(b);
  const bObj = JSON36.parse(bStr2);

  /***

  {
    bStr: '{"002w002x":"2qvd2qvi000w00330036000w2que2qrf2qtv07mp0gyw1edo0jdd0gt00fr6001z00340038000w0019000w001f0i5n0gzp09he000w0fog0gkr0gq10glp0gn4001r"}',
    bStr2: 'dga002w002xaba2qvdd2qvi000w00330036000w2que2qrf2qtv07mp0gyw1eddo0jdddd0gt00fr6001z00340038000w0019000w001f0i5n0gzp09he000w0fog0gkr0gq10glp0gn4001radh'
  }

  { bObj: { hi: '💉💎 or 👦🏻👓⚡嗨，我唔係Gpt - 3寫嘅。 你叫咩名呀?' } }

  ***/

  // more involved example

  const a = {
    name: 'Cris',
    age: 36,
    eo: {},
    ea: [],
    wo: {[NaN]:true},
    mmm: undefined,
    code: 3948573458972n,
    hello: true,
    xy: new Uint16Array(),
    great: null,
    hi: NaN,
    xchakka: -Infinity,
    bigExp: 2.95e77,
    smallExp: 1.93e-81,
    azza: new Uint8Array([9,10,11]),
    happiness: [
      { object: 999999n, z: NaN, p: Symbol.for("hello-kitty") },
      null,
      "CRIS",
      238947,
      undefined,
      NaN,
      2234.1231,
      34589358794234233498752345789345n,
      { great: [true, false] },
      [ "ok", Infinity ],
      new Float64Array([1.123e+123, 9.06233419e-94])
    ]
  };
  
  const aStr = JSON46.stringify(a);
  
  /***
  
  '{"0032002p0031002t":"001v0036002x0037","002p002v002t":"r10","003100310031":"u","002r0033002s002t":"o1edy6os2k","002w002t003000300033":"a","002v0036002t002p0038":"v","002w002x":"w","003c002r002w002p002z002z002p":"z-","002q002x002v001x003c0034":"s2.95e+77","00370031002p00300030001x003c0034":"s1.93e-81","002p003e003e002p":"x19.a.b","002w002p00340034002x0032002t00370037":[{"0033002q002y002t002r0038":"olflr","003e":"w","0034":"y002w002t0030003000330019002z002x00380038003d"},"v","001v002a0021002b","r54df","u","w","r1q2.4fjcq9k7","o2l5hrv15xy2864k787t7l",{"002v0036002t002p0038":["a","b"]},["0033002z","z+"],"x81.123e+123f9.06233419e-94"]}'
  
  ***/
  
  // or, in pretty printed form
  
  /***
  
  {
    "0032002p0031002t": "001v0036002x0037",
    "002p002v002t": "r10",
    "003100310031": "u",
    "002r0033002s002t": "o1edy6os2k",
    "002w002t003000300033": "a",
    "002v0036002t002p0038": "v",
    "002w002x": "w",
    "003c002r002w002p002z002z002p": "z-",
    "002q002x002v001x003c0034": "s2.95e+77",
    "00370031002p00300030001x003c0034": "s1.93e-81",
    "002p003e003e002p": "x19.a.b",
    "002w002p00340034002x0032002t00370037": [
      {
        "0033002q002y002t002r0038": "olflr",
        "003e": "w",
        "0034": "y002w002t0030003000330019002z002x00380038003d"
      },
      "v",
      "001v002a0021002b",
      "r54df",
      "u",
      "w",
      "r1q2.4fjcq9k7",
      "o2l5hrv15xy2864k787t7l",
      {
        "002v0036002t002p0038": [
          "a",
          "b"
        ]
      },
      [
        "0033002z",
        "z+"
      ],
      "x81.123e+123f9.06233419e-94"
    ]
  }

  ***/
  
  const aStr2 = JSON36.stringify(a);
  
  /***
  
  'dga0032002p0031002taba001v0036002x0037aca002p002v002tabar10aca003100310031abauaca002r0033002s002tabao1eddy6os2kaca002w002t003000300033abadaaca002v0036002t002p0038abavaca002w002xabawaca003dc002r002w002p002z002z002pabazdiaca002q002x002v001x003dc0034abas2dk95edj77aca00370031002p00300030001x003dc0034abas1dk93edi81aca002p003e003e002pabax19dkdadkdbaca002w002p00340034002x0032002t00370037abdedga0033002q002y002t002r0038abaolflraca003eabawaca0034abay002w002t0030003000330019002z002x00380038003ddadhcavaca001v002da0021002dbacar54ddfacauacawacar1q2dk4fjdcq9k7acao2l5hrv15xy2864k787t7lacdga002v0036002t002p0038abdeadaacadbadfdhcdea0033002zacazdjadfcax81dk123edj123f9dk06233419edi94adfdh'
  
  ***/
  
  const revivedA = JSON36.parse(aStr2);
 
  console.log(util.inspect(revivedA, false, null, true)); 
  // tada
  
  {
    name: 'Cris',
    age: 36,
    eo: {},
    ea: [],
    wo: {[NaN]:true},
    mmm: undefined,
    code: 3948573458972n,
    hello: true,
    xy: new Uint16Array(),
    great: null,
    hi: NaN,
    xchakka: -Infinity,
    bigExp: 2.95e77,
    smallExp: 1.93e-81,
    azza: new Uint8Array([9,10,11]),
    happiness: [
      { object: 999999n, z: NaN, p: Symbol.for("hello-kitty") },
      null,
      "CRIS",
      238947,
      undefined,
      NaN,
      2234.1231,
      34589358794234233498752345789345n,
      { great: [true, false] },
      [ "ok", Infinity ],
      new Float64Array([1.123e+123, 9.06233419e-94])
    ]
  };
  

  // in node
  require('assert').deepStrictEqual(a, aObj); // fine
  require('assert').deepStrictEqual(b, bObj); // fine

designagistics

  • can I have a JSON format that effortlessly supports Unicode everywhere without any problems?
  • can I have a text and coding format to make everything ASCII for transport that isn't affected by different apis for base64 in node JS and the browser?
  • can I have a JSON that supports Bigints and typed arrays as well as null undefined and symbols?
  • is there a encoding to ASCII text that I can easily access in JavaScript in the browser and in node without writing it myself nor importing a dependency?
  • what if I want to say JSON over the telephone or radio?

All these encoding designs are inspired by the availability of base 36 in Node and Browser, and also in people's brains.

get

Them all:

$ npm i --save weird-json

usagisms

import {JSON36, JSON46, PrimeCode} from 'weird-json';

technicalisters

We aim for equality based on assert.deepStrictEqual, which has the following specifications:

  • Primitive values are compared using the SameValue Comparison, used by Object.is().
  • Type tags of objects should be the same.
  • [[Prototype]] of objects are compared using the Strict Equality Comparison.
  • Only enumerable "own" properties are considered.
  • Error names and messages are always compared, even if these are not enumerable properties.
  • Enumerable own Symbol properties are compared as well.
  • Object wrappers are compared both as objects and unwrapped values.
  • Object properties are compared unordered.
  • Map keys and Set items are compared unordered.
  • Recursion stops when both sides differ or both sides encounter a circular reference.
  • WeakMap and WeakSet comparison does not rely on their values. See below for further details.

roadiest mappings

  • add support for BigInt
  • add support for NaN, Infinity, null and undefined
  • add typedarray support
  • support floating point exponent notification
  • add symbol support
  • add support for Map and Set
  • Add support for Date
  • add deepCopy
  • implement json37, and json38
  • optimize speed
  • support Node.JS built-ins like Buffer, etc
  • revive prototype chain for instances of custom class or prototypal inheritance

preeori artus / anteeori artusismus

limitationisms

NO support for:

  • WeakSet nor WeakMap, because values collected in these will have no other references on revivial, and so will not make sense to be in WeakMap nor WeakSet, and will not be guaranteed to be in there. Explore if you can use Map or Set instead.
  • unregistered Symbols. Because these will fail the equality test (DeepStrictEquality), by design of Symbol. Use registered Symbol's (Symbol.for) instead.
  • Functions. Because scope cannot be serialized in JavaScript at this time, and also because functions fail the equality test (DeepStrictEquality)

licensing

Dual Licensed under APache-2.0 and the Artistic License. You can choose.