emj 0.0.11 → 0.2.0

package/README.md

@@ -25,21 +25,115 @@ _Emoji Object Notation_
 
 ## Use
 
-Call `parse()` to turn Emojion into its original JSON text string, and call
-`generate()` to turn JSON text into Emojion.
+```sh
+npm install emj
+```
+
+`emj` works like the built-in `JSON` object. `parse()` turns Emojion into a
+JavaScript value, and `stringify()` turns a value into Emojion.
+
+```ts
+import { parse, stringify } from 'emj';
+
+const value = parse('🙌😶😠🤑😳👡🐘🐁🦉🦒🐖🦉🦏✋');
+// { name: 'Emojion' }
+
+const emojion = stringify({ created: 2019 });
+// '🙌😖😭😳😠😛😳🤤🕑🕛🕐🕘✋'
+
+parse(stringify({ when: new Date(0), list: [1, undefined] }));
+// { when: '1970-01-01T00:00:00.000Z', list: [1, null] }
+```
+
+It works in Node 10 and later, from CommonJS (`require('emj')`) or ESM.
+
+### `parse(emojion)`
+
+Reads an Emojion document and returns the value it holds: an object, array,
+string, number, boolean or `null`, built the same way `JSON.parse()` would build
+it.
+
+- Objects are plain objects and arrays are plain arrays.
+- A `__proto__` key becomes an ordinary own property; it never sets the
+  prototype. The same goes for any other key that `Object.prototype` has, such
+  as `toString`.
+- When a key repeats, the last value wins.
+- Numbers are converted the way `JSON.parse()` converts them, so `⏰🕛` is `-0`
+  and digits beyond double precision are rounded.
+
+### `stringify(value)`
+
+Writes a value as an Emojion document, following the rules of
+`JSON.stringify()`:
+
+- It calls a value's `toJSON()` method, so a `Date` becomes its ISO string.
+- It unwraps `new Number()`, `new String()` and `new Boolean()`.
+- It writes `NaN`, `Infinity` and `-Infinity` as `null`, and `-0` as `0`.
+- In objects, it skips properties whose value is `undefined`, a function or a
+  symbol. In arrays, it writes them, and holes, as `null`.
+- It writes only own enumerable string keys, so symbol keys are skipped, and a
+  `Map`, `Set` or class instance becomes an object of its own properties.
+
+`stringify()` has no `replacer` or `space` argument, and `parse()` has no
+`reviver`.
+
+### Errors and limits
+
+- `parse()` throws a `SyntaxError` for input that is not valid Emojion. The
+  message names the unexpected emoji and its position.
+- `stringify()` throws a `TypeError` for a `BigInt` (unless `BigInt.prototype`
+  has a `toJSON()`) and for a circular structure.
+- `stringify()` also throws a `TypeError` for a value Emojion cannot hold at
+  all: `undefined`, a function or a symbol on its own, or a `toJSON()` that
+  returns one. `JSON.stringify()` returns `undefined` in those cases, but every
+  Emojion document holds a value.
+- Arrays and objects can be nested up to 512 levels deep. A top-level object
+  doesn't count, because it has no `👉👈`. Past that, `parse()` throws a
+  `SyntaxError` and `stringify()` throws a `RangeError`.
+
+### TypeScript
+
+The package ships type definitions. `parse()` returns the exported `Json` type:
 
 ```ts
-import { generate, parse } from 'emj';
+import type { Json } from 'emj';
+// string | number | boolean | null | Json[] | { [key: string]: Json }
+```
+
+`stringify()` accepts `unknown`, as `JSON.stringify()` accepts any value.
 
-const json = parse('🙌😶😠🤑😳👡🐘🐁🦉🦒🐖🦉🦏✋');
-// '{"name":"Emojion"}'
+### JSON text
 
-const emojion = generate(JSON.stringify({ created: 2019 }));
-// 🙌😖😭😳😠😛😳🤤🕑🕛🕐🕘✋
+To convert between Emojion and JSON text, combine the two with `JSON`:
+
+```ts
+const toJson = (emojion: string) => JSON.stringify(parse(emojion));
+const fromJson = (json: string) => stringify(JSON.parse(json));
 ```
 
-Both functions use JSON text so every valid JSON value can round-trip without
-losing type information.
+### Migrating from 0.1
+
+In 0.1, both functions worked with JSON text. In 0.2 they work with values.
+
+| 0.1                               | 0.2                              |
+| --------------------------------- | -------------------------------- |
+| `JSON.parse(parse(emojion))`      | `parse(emojion)`                 |
+| `parse(emojion)`                  | `JSON.stringify(parse(emojion))` |
+| `generate(json)`                  | `stringify(JSON.parse(json))`    |
+| `generate(JSON.stringify(value))` | `stringify(value)`               |
+
+- `generate()` is gone. Use `stringify()`, which takes a value, not JSON text.
+  Passing JSON text to `stringify()` writes it as a string, so make sure every
+  old `generate(json)` call becomes `stringify(JSON.parse(json))`.
+- `parse()` returns a value, not a string. If you kept the 0.1 JSON text without
+  parsing it, note that a repeated key was in the text twice; now only the last
+  value is kept, as `JSON.parse()` would have done.
+- `stringify()` applies the `JSON.stringify()` rules above itself. A `BigInt`, a
+  circular structure, or a top-level `undefined`, function or symbol throws a
+  `TypeError` from `stringify()` rather than from your own `JSON.stringify()`
+  call (or, for a top-level `undefined`, rather than passing `undefined` on).
+- The `RangeError` for deep nesting now says "Value nesting exceeds 512 levels"
+  instead of "JSON nesting exceeds 512 levels".
 
 ## Syntax
 
@@ -48,7 +142,8 @@ Emojion, you're a winner in this author's eyes. Emojion documents end with `✋`
 — because... stop.
 
 Objects are enclosed by `👉` and `👈`, arrays are enclosed by `🤜` and `🤛`, and
-array items are separated by `🤝`.
+array items are separated by `🤝`. A top-level object has no `👉` and `👈`. A
+document can also hold one array, string, number, boolean, or `null`.
 
 Keys are encoded with face emoji, such as `😠`, `🥺`, `😖`, `😺`, `😸`, and `😽`
 (`a`, `b`, `c`, `1`, `2`, `3` ). Capital letters are prefixed with `👠`. `🗝`
@@ -58,16 +153,20 @@ Strings are encoded with animals and plants, such as `🐜`, `🐝`, `🐄`, `
 `🌱`, and `🌵` (`a`, `b`, `c`, `1`, `2`, `3` ). Capital letters are prefixed
 with `👡`. `🧵` represents an empty string.
 
-Numbers are encoded with with clocks, such as `🕛`, `🕐`, and `🕑` (`0`, `1`,
-`2`). Decimal points are encoded with `⛳️` and negative numbers are prefixed
-with `⏰` (because alarms are annoying).
+Numbers are encoded with clocks, such as `🕛`, `🕐`, and `🕑` (`0`, `1`, `2`).
+Decimal points are encoded with `⛳️` and negative numbers are prefixed with `⏰`
+(because alarms are annoying). Exponents are prefixed with `🚀` (because they
+make numbers take off), so `1e-7` is `🕐🚀⏰🕖`.
 
 `💚` is `true`, `💔` is `false`, and `🕳` is `null`.
 
 In keys, Unicode characters can be encoded using `🌎` followed by fruit, such as
 `🌎🍏🍊🍈🍓` for `U+0398` (which is `Θ`). In values, Unicode characters are
 encoded using `🗺` followed by office supplies, such as `🗺🖋🖊🧷🔎` for `U+0394`
-(which is `Δ`).
+(which is `Δ`). An encoded character can use up to six of these digits.
+
+Whitespace and emoji variation selectors are ignored. Arrays and objects can be
+nested up to 512 levels deep.
 
 See [`characters.ts`](./src/characters.ts) for the full character map.
 
@@ -99,35 +198,9 @@ When your coworker tells you YAML is "too hard to read".
 
 ## Tech
 
-Emojion is built with the excellent
-[Moo lexer](https://www.npmjs.com/package/moo) and
-[Nearley parser](https://nearley.js.org) engines.
-
-## Publishing
-
-Emojion is a maintained joke package: its premise is intentionally absurd, but
-its runtime dependencies and published security posture are maintained like any
-other library. Garden keeps development tooling and compatible lockfile
-resolutions current while runtime-range changes remain deliberate.
-
-Garden dispatches [`Prepare Release`](./.github/workflows/prepare-release.yml)
-with an exact semantic version. The tag is the release source of truth; the
-publisher checks out that immutable tag and stamps the package manifest only in
-its packaging worktree before publishing to npm and creating the matching GitHub
-Release. Routine releases are batched to at most one per week.
-
-Publishing uses npm Trusted Publishing.
-
-Configure the `emj` package on npm with this trusted publisher:
-
-- Provider: GitHub Actions
-- Organization or user: `agorischek`
-- Repository: `emojion`
-- Workflow filename: `publish.yml`
-- Environment name: leave blank
-
-You can also configure it from an authenticated npm CLI:
-
-```sh
-npx npm@latest trust github emj --repo agorischek/emojion --file publish.yml
-```
+Emojion has no runtime dependencies. `parse()` reads each document in a single
+pass with a hand-written parser that builds values as it goes, and `stringify()`
+walks the value directly; neither goes through JSON text. Run `npm run bench` to
+measure their speed next to `JSON.parse()` and `JSON.stringify()`, or
+`npm run bench:ab -- <ref> <ref>` to compare two versions. See
+[`bench/RESULTS.md`](./bench/RESULTS.md) for measurements.

package/lib/characters.d.ts

@@ -0,0 +1,165 @@
+export declare const characters: {
+    document: {
+        arrayClose: string;
+        arrayDelimit: string;
+        arrayOpen: string;
+        end: string;
+        indent: string;
+        outdent: string;
+        start: string;
+    };
+    keys: {
+        letters: {
+            a: string;
+            b: string;
+            c: string;
+            d: string;
+            e: string;
+            f: string;
+            g: string;
+            h: string;
+            i: string;
+            j: string;
+            k: string;
+            l: string;
+            m: string;
+            n: string;
+            o: string;
+            p: string;
+            q: string;
+            r: string;
+            s: string;
+            t: string;
+            u: string;
+            v: string;
+            w: string;
+            x: string;
+            y: string;
+            z: string;
+        };
+        modifiers: {
+            unicode: string;
+            upperCase: string;
+        };
+        numerals: {
+            0: string;
+            1: string;
+            2: string;
+            3: string;
+            4: string;
+            5: string;
+            6: string;
+            7: string;
+            8: string;
+            9: string;
+        };
+        other: {
+            empty: string;
+        };
+        unicode: {
+            0: string;
+            1: string;
+            2: string;
+            3: string;
+            4: string;
+            5: string;
+            6: string;
+            7: string;
+            8: string;
+            9: string;
+            a: string;
+            b: string;
+            c: string;
+            d: string;
+            e: string;
+            f: string;
+        };
+    };
+    values: {
+        booleans: {
+            false: string;
+            true: string;
+        };
+        letters: {
+            a: string;
+            b: string;
+            c: string;
+            d: string;
+            e: string;
+            f: string;
+            g: string;
+            h: string;
+            i: string;
+            j: string;
+            k: string;
+            l: string;
+            m: string;
+            n: string;
+            o: string;
+            p: string;
+            q: string;
+            r: string;
+            s: string;
+            t: string;
+            u: string;
+            v: string;
+            w: string;
+            x: string;
+            y: string;
+            z: string;
+        };
+        modifiers: {
+            unicode: string;
+            upperCase: string;
+            negative: string;
+        };
+        numbers: {
+            0: string;
+            1: string;
+            2: string;
+            3: string;
+            4: string;
+            5: string;
+            6: string;
+            7: string;
+            8: string;
+            9: string;
+            '.': string;
+            e: string;
+        };
+        numerals: {
+            0: string;
+            1: string;
+            2: string;
+            3: string;
+            4: string;
+            5: string;
+            6: string;
+            7: string;
+            8: string;
+            9: string;
+        };
+        other: {
+            null: string;
+            emptyString: string;
+        };
+        unicode: {
+            0: string;
+            1: string;
+            2: string;
+            3: string;
+            4: string;
+            5: string;
+            6: string;
+            7: string;
+            8: string;
+            9: string;
+            a: string;
+            b: string;
+            c: string;
+            d: string;
+            e: string;
+            f: string;
+        };
+    };
+};

package/lib/characters.js

@@ -0,0 +1,169 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.characters = void 0;
+exports.characters = {
+    document: {
+        arrayClose: '🤛',
+        arrayDelimit: '🤝',
+        arrayOpen: '🤜',
+        end: '✋',
+        indent: '👉',
+        outdent: '👈',
+        start: '🙌',
+    },
+    keys: {
+        letters: {
+            a: '😠',
+            b: '🥺',
+            c: '😖',
+            d: '🤤',
+            e: '😳',
+            f: '🙁',
+            g: '🤪',
+            h: '😃',
+            i: '🤔',
+            j: '😂',
+            k: '😚',
+            l: '🥰',
+            m: '🤑',
+            n: '😶',
+            o: '😮',
+            p: '🥳',
+            q: '🤫',
+            r: '😭',
+            s: '😢',
+            t: '😛',
+            u: '🙃',
+            v: '😁',
+            w: '😉',
+            x: '😵',
+            y: '🤩',
+            z: '🤐',
+        },
+        modifiers: {
+            unicode: '🌎',
+            upperCase: '👠',
+        },
+        numerals: {
+            0: '🐱',
+            1: '😺',
+            2: '😸',
+            3: '😽',
+            4: '😻',
+            5: '😹',
+            6: '😿',
+            7: '😾',
+            8: '😼',
+            9: '🙀',
+        },
+        other: {
+            empty: '🗝',
+        },
+        unicode: {
+            0: '🍏',
+            1: '🍎',
+            2: '🍐',
+            3: '🍊',
+            4: '🍋',
+            5: '🍌',
+            6: '🍉',
+            7: '🍇',
+            8: '🍓',
+            9: '🍈',
+            a: '🍒',
+            b: '🍑',
+            c: '🥭',
+            d: '🍍',
+            e: '🥥',
+            f: '🥝',
+        },
+    },
+    values: {
+        booleans: {
+            false: '💔',
+            true: '💚',
+        },
+        letters: {
+            a: '🐜',
+            b: '🐝',
+            c: '🐄',
+            d: '🐬',
+            e: '🐘',
+            f: '🐟',
+            g: '🐐',
+            h: '🦔',
+            i: '🐖',
+            j: '🦒',
+            k: '🦘',
+            l: '🦞',
+            m: '🐁',
+            n: '🦏',
+            o: '🦉',
+            p: '🦚',
+            q: '🦑',
+            r: '🦝',
+            s: '🐌',
+            t: '🐢',
+            u: '🦋',
+            v: '🕊',
+            w: '🐋',
+            x: '🐂',
+            y: '🦃',
+            z: '🦓',
+        },
+        modifiers: {
+            unicode: '🗺',
+            upperCase: '👡',
+            negative: '⏰',
+        },
+        numbers: {
+            0: '🕛',
+            1: '🕐',
+            2: '🕑',
+            3: '🕒',
+            4: '🕓',
+            5: '🕔',
+            6: '🕕',
+            7: '🕖',
+            8: '🕗',
+            9: '🕘',
+            '.': '⛳️',
+            e: '🚀',
+        },
+        numerals: {
+            0: '🌻',
+            1: '🌷',
+            2: '🌱',
+            3: '🌵',
+            4: '🍀',
+            5: '🌺',
+            6: '🌾',
+            7: '🌿',
+            8: '🌼',
+            9: '🌹',
+        },
+        other: {
+            null: '🕳',
+            emptyString: '🧵',
+        },
+        unicode: {
+            0: '🖋',
+            1: '🖌',
+            2: '🖍',
+            3: '🖊',
+            4: '🔎',
+            5: '📐',
+            6: '📏',
+            7: '📍',
+            8: '📌',
+            9: '🧷',
+            a: '📎',
+            b: '📁',
+            c: '📓',
+            d: '📒',
+            e: '📕',
+            f: '📋',
+        },
+    },
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2hhcmFjdGVycy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9jaGFyYWN0ZXJzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFhLFFBQUEsVUFBVSxHQUFHO0lBQ3hCLFFBQVEsRUFBRTtRQUNSLFVBQVUsRUFBRSxJQUFJO1FBQ2hCLFlBQVksRUFBRSxJQUFJO1FBQ2xCLFNBQVMsRUFBRSxJQUFJO1FBQ2YsR0FBRyxFQUFFLEdBQUc7UUFDUixNQUFNLEVBQUUsSUFBSTtRQUNaLE9BQU8sRUFBRSxJQUFJO1FBQ2IsS0FBSyxFQUFFLElBQUk7S0FDWjtJQUNELElBQUksRUFBRTtRQUNKLE9BQU8sRUFBRTtZQUNQLENBQUMsRUFBRSxJQUFJO1lBQ1AsQ0FBQyxFQUFFLElBQUk7WUFDUCxDQUFDLEVBQUUsSUFBSTtZQUNQLENBQUMsRUFBRSxJQUFJO1lBQ1AsQ0FBQyxFQUFFLElBQUk7WUFDUCxDQUFDLEVBQUUsSUFBSTtZQUNQLENBQUMsRUFBRSxJQUFJO1lBQ1AsQ0FBQyxFQUFFLElBQUk7WUFDUCxDQUFDLEVBQUUsSUFBSTtZQUNQLENBQUMsRUFBRSxJQUFJO1lBQ1AsQ0FBQyxFQUFFLElBQUk7WUFDUCxDQUFDLEVBQUUsSUFBSTtZQUNQLENBQUMsRUFBRSxJQUFJO1lBQ1AsQ0FBQyxFQUFFLElBQUk7WUFDUCxDQUFDLEVBQUUsSUFBSTtZQUNQLENBQUMsRUFBRSxJQUFJO1lBQ1AsQ0FBQyxFQUFFLElBQUk7WUFDUCxDQUFDLEVBQUUsSUFBSTtZQUNQLENBQUMsRUFBRSxJQUFJO1lBQ1AsQ0FBQyxFQUFFLElBQUk7WUFDUCxDQUFDLEVBQUUsSUFBSTtZQUNQLENBQUMsRUFBRSxJQUFJO1lBQ1AsQ0FBQyxFQUFFLElBQUk7WUFDUCxDQUFDLEVBQUUsSUFBSTtZQUNQLENBQUMsRUFBRSxJQUFJO1lBQ1AsQ0FBQyxFQUFFLElBQUk7U0FDUjtRQUNELFNBQVMsRUFBRTtZQUNULE9BQU8sRUFBRSxJQUFJO1lBQ2IsU0FBUyxFQUFFLElBQUk7U0FDaEI7UUFDRCxRQUFRLEVBQUU7WUFDUixDQUFDLEVBQUUsSUFBSTtZQUNQLENBQUMsRUFBRSxJQUFJO1lBQ1AsQ0FBQyxFQUFFLElBQUk7WUFDUCxDQUFDLEVBQUUsSUFBSTtZQUNQLENBQUMsRUFBRSxJQUFJO1lBQ1AsQ0FBQyxFQUFFLElBQUk7WUFDUCxDQUFDLEVBQUUsSUFBSTtZQUNQLENBQUMsRUFBRSxJQUFJO1lBQ1AsQ0FBQyxFQUFFLElBQUk7WUFDUCxDQUFDLEVBQUUsSUFBSTtTQUNSO1FBQ0QsS0FBSyxFQUFFO1lBQ0wsS0FBSyxFQUFFLElBQUk7U0FDWjtRQUNELE9BQU8sRUFBRTtZQUNQLENBQUMsRUFBRSxJQUFJO1lBQ1AsQ0FBQyxFQUFFLElBQUk7WUFDUCxDQUFDLEVBQUUsSUFBSTtZQUNQLENBQUMsRUFBRSxJQUFJO1lBQ1AsQ0FBQyxFQUFFLElBQUk7WUFDUCxDQUFDLEVBQUUsSUFBSTtZQUNQLENBQUMsRUFBRSxJQUFJO1lBQ1AsQ0FBQyxFQUFFLElBQUk7WUFDUCxDQUFDLEVBQUUsSUFBSTtZQUNQLENBQUMsRUFBRSxJQUFJO1lBQ1AsQ0FBQyxFQUFFLElBQUk7WUFDUCxDQUFDLEVBQUUsSUFBSTtZQUNQLENBQUMsRUFBRSxJQUFJO1lBQ1AsQ0FBQyxFQUFFLElBQUk7WUFDUCxDQUFDLEVBQUUsSUFBSTtZQUNQLENBQUMsRUFBRSxJQUFJO1NBQ1I7S0FDRjtJQUNELE1BQU0sRUFBRTtRQUNOLFFBQVEsRUFBRTtZQUNSLEtBQUssRUFBRSxJQUFJO1lBQ1gsSUFBSSxFQUFFLElBQUk7U0FDWDtRQUNELE9BQU8sRUFBRTtZQUNQLENBQUMsRUFBRSxJQUFJO1lBQ1AsQ0FBQyxFQUFFLElBQUk7WUFDUCxDQUFDLEVBQUUsSUFBSTtZQUNQLENBQUMsRUFBRSxJQUFJO1lBQ1AsQ0FBQyxFQUFFLElBQUk7WUFDUCxDQUFDLEVBQUUsSUFBSTtZQUNQLENBQUMsRUFBRSxJQUFJO1lBQ1AsQ0FBQyxFQUFFLElBQUk7WUFDUCxDQUFDLEVBQUUsSUFBSTtZQUNQLENBQUMsRUFBRSxJQUFJO1lBQ1AsQ0FBQyxFQUFFLElBQUk7WUFDUCxDQUFDLEVBQUUsSUFBSTtZQUNQLENBQUMsRUFBRSxJQUFJO1lBQ1AsQ0FBQyxFQUFFLElBQUk7WUFDUCxDQUFDLEVBQUUsSUFBSTtZQUNQLENBQUMsRUFBRSxJQUFJO1lBQ1AsQ0FBQyxFQUFFLElBQUk7WUFDUCxDQUFDLEVBQUUsSUFBSTtZQUNQLENBQUMsRUFBRSxJQUFJO1lBQ1AsQ0FBQyxFQUFFLElBQUk7WUFDUCxDQUFDLEVBQUUsSUFBSTtZQUNQLENBQUMsRUFBRSxJQUFJO1lBQ1AsQ0FBQyxFQUFFLElBQUk7WUFDUCxDQUFDLEVBQUUsSUFBSTtZQUNQLENBQUMsRUFBRSxJQUFJO1lBQ1AsQ0FBQyxFQUFFLElBQUk7U0FDUjtRQUNELFNBQVMsRUFBRTtZQUNULE9BQU8sRUFBRSxJQUFJO1lBQ2IsU0FBUyxFQUFFLElBQUk7WUFDZixRQUFRLEVBQUUsR0FBRztTQUNkO1FBQ0QsT0FBTyxFQUFFO1lBQ1AsQ0FBQyxFQUFFLElBQUk7WUFDUCxDQUFDLEVBQUUsSUFBSTtZQUNQLENBQUMsRUFBRSxJQUFJO1lBQ1AsQ0FBQyxFQUFFLElBQUk7WUFDUCxDQUFDLEVBQUUsSUFBSTtZQUNQLENBQUMsRUFBRSxJQUFJO1lBQ1AsQ0FBQyxFQUFFLElBQUk7WUFDUCxDQUFDLEVBQUUsSUFBSTtZQUNQLENBQUMsRUFBRSxJQUFJO1lBQ1AsQ0FBQyxFQUFFLElBQUk7WUFDUCxHQUFHLEVBQUUsSUFBSTtZQUNULENBQUMsRUFBRSxJQUFJO1NBQ1I7UUFDRCxRQUFRLEVBQUU7WUFDUixDQUFDLEVBQUUsSUFBSTtZQUNQLENBQUMsRUFBRSxJQUFJO1lBQ1AsQ0FBQyxFQUFFLElBQUk7WUFDUCxDQUFDLEVBQUUsSUFBSTtZQUNQLENBQUMsRUFBRSxJQUFJO1lBQ1AsQ0FBQyxFQUFFLElBQUk7WUFDUCxDQUFDLEVBQUUsSUFBSTtZQUNQLENBQUMsRUFBRSxJQUFJO1lBQ1AsQ0FBQyxFQUFFLElBQUk7WUFDUCxDQUFDLEVBQUUsSUFBSTtTQUNSO1FBQ0QsS0FBSyxFQUFFO1lBQ0wsSUFBSSxFQUFFLElBQUk7WUFDVixXQUFXLEVBQUUsSUFBSTtTQUNsQjtRQUNELE9BQU8sRUFBRTtZQUNQLENBQUMsRUFBRSxJQUFJO1lBQ1AsQ0FBQyxFQUFFLElBQUk7WUFDUCxDQUFDLEVBQUUsSUFBSTtZQUNQLENBQUMsRUFBRSxJQUFJO1lBQ1AsQ0FBQyxFQUFFLElBQUk7WUFDUCxDQUFDLEVBQUUsSUFBSTtZQUNQLENBQUMsRUFBRSxJQUFJO1lBQ1AsQ0FBQyxFQUFFLElBQUk7WUFDUCxDQUFDLEVBQUUsSUFBSTtZQUNQLENBQUMsRUFBRSxJQUFJO1lBQ1AsQ0FBQyxFQUFFLElBQUk7WUFDUCxDQUFDLEVBQUUsSUFBSTtZQUNQLENBQUMsRUFBRSxJQUFJO1lBQ1AsQ0FBQyxFQUFFLElBQUk7WUFDUCxDQUFDLEVBQUUsSUFBSTtZQUNQLENBQUMsRUFBRSxJQUFJO1NBQ1I7S0FDRjtDQUNGLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyJleHBvcnQgY29uc3QgY2hhcmFjdGVycyA9IHtcbiAgZG9jdW1lbnQ6IHtcbiAgICBhcnJheUNsb3NlOiAn8J+kmycsXG4gICAgYXJyYXlEZWxpbWl0OiAn8J+knScsXG4gICAgYXJyYXlPcGVuOiAn8J+knCcsXG4gICAgZW5kOiAn4pyLJyxcbiAgICBpbmRlbnQ6ICfwn5GJJyxcbiAgICBvdXRkZW50OiAn8J+RiCcsXG4gICAgc3RhcnQ6ICfwn5mMJyxcbiAgfSxcbiAga2V5czoge1xuICAgIGxldHRlcnM6IHtcbiAgICAgIGE6ICfwn5igJyxcbiAgICAgIGI6ICfwn6W6JyxcbiAgICAgIGM6ICfwn5iWJyxcbiAgICAgIGQ6ICfwn6SkJyxcbiAgICAgIGU6ICfwn5izJyxcbiAgICAgIGY6ICfwn5mBJyxcbiAgICAgIGc6ICfwn6SqJyxcbiAgICAgIGg6ICfwn5iDJyxcbiAgICAgIGk6ICfwn6SUJyxcbiAgICAgIGo6ICfwn5iCJyxcbiAgICAgIGs6ICfwn5iaJyxcbiAgICAgIGw6ICfwn6WwJyxcbiAgICAgIG06ICfwn6SRJyxcbiAgICAgIG46ICfwn5i2JyxcbiAgICAgIG86ICfwn5iuJyxcbiAgICAgIHA6ICfwn6WzJyxcbiAgICAgIHE6ICfwn6SrJyxcbiAgICAgIHI6ICfwn5itJyxcbiAgICAgIHM6ICfwn5iiJyxcbiAgICAgIHQ6ICfwn5ibJyxcbiAgICAgIHU6ICfwn5mDJyxcbiAgICAgIHY6ICfwn5iBJyxcbiAgICAgIHc6ICfwn5iJJyxcbiAgICAgIHg6ICfwn5i1JyxcbiAgICAgIHk6ICfwn6SpJyxcbiAgICAgIHo6ICfwn6SQJyxcbiAgICB9LFxuICAgIG1vZGlmaWVyczoge1xuICAgICAgdW5pY29kZTogJ/CfjI4nLFxuICAgICAgdXBwZXJDYXNlOiAn8J+RoCcsXG4gICAgfSxcbiAgICBudW1lcmFsczoge1xuICAgICAgMDogJ/CfkLEnLFxuICAgICAgMTogJ/CfmLonLFxuICAgICAgMjogJ/CfmLgnLFxuICAgICAgMzogJ/CfmL0nLFxuICAgICAgNDogJ/CfmLsnLFxuICAgICAgNTogJ/CfmLknLFxuICAgICAgNjogJ/CfmL8nLFxuICAgICAgNzogJ/CfmL4nLFxuICAgICAgODogJ/CfmLwnLFxuICAgICAgOTogJ/CfmYAnLFxuICAgIH0sXG4gICAgb3RoZXI6IHtcbiAgICAgIGVtcHR5OiAn8J+XnScsXG4gICAgfSxcbiAgICB1bmljb2RlOiB7XG4gICAgICAwOiAn8J+NjycsXG4gICAgICAxOiAn8J+NjicsXG4gICAgICAyOiAn8J+NkCcsXG4gICAgICAzOiAn8J+NiicsXG4gICAgICA0OiAn8J+NiycsXG4gICAgICA1OiAn8J+NjCcsXG4gICAgICA2OiAn8J+NiScsXG4gICAgICA3OiAn8J+NhycsXG4gICAgICA4OiAn8J+NkycsXG4gICAgICA5OiAn8J+NiCcsXG4gICAgICBhOiAn8J+NkicsXG4gICAgICBiOiAn8J+NkScsXG4gICAgICBjOiAn8J+lrScsXG4gICAgICBkOiAn8J+NjScsXG4gICAgICBlOiAn8J+lpScsXG4gICAgICBmOiAn8J+lnScsXG4gICAgfSxcbiAgfSxcbiAgdmFsdWVzOiB7XG4gICAgYm9vbGVhbnM6IHtcbiAgICAgIGZhbHNlOiAn8J+SlCcsXG4gICAgICB0cnVlOiAn8J+SmicsXG4gICAgfSxcbiAgICBsZXR0ZXJzOiB7XG4gICAgICBhOiAn8J+QnCcsXG4gICAgICBiOiAn8J+QnScsXG4gICAgICBjOiAn8J+QhCcsXG4gICAgICBkOiAn8J+QrCcsXG4gICAgICBlOiAn8J+QmCcsXG4gICAgICBmOiAn8J+QnycsXG4gICAgICBnOiAn8J+QkCcsXG4gICAgICBoOiAn8J+mlCcsXG4gICAgICBpOiAn8J+QlicsXG4gICAgICBqOiAn8J+mkicsXG4gICAgICBrOiAn8J+mmCcsXG4gICAgICBsOiAn8J+mnicsXG4gICAgICBtOiAn8J+QgScsXG4gICAgICBuOiAn8J+mjycsXG4gICAgICBvOiAn8J+miScsXG4gICAgICBwOiAn8J+mmicsXG4gICAgICBxOiAn8J+mkScsXG4gICAgICByOiAn8J+mnScsXG4gICAgICBzOiAn8J+QjCcsXG4gICAgICB0OiAn8J+QoicsXG4gICAgICB1OiAn8J+miycsXG4gICAgICB2OiAn8J+ViicsXG4gICAgICB3OiAn8J+QiycsXG4gICAgICB4OiAn8J+QgicsXG4gICAgICB5OiAn8J+mgycsXG4gICAgICB6OiAn8J+mkycsXG4gICAgfSxcbiAgICBtb2RpZmllcnM6IHtcbiAgICAgIHVuaWNvZGU6ICfwn5e6JyxcbiAgICAgIHVwcGVyQ2FzZTogJ/CfkaEnLFxuICAgICAgbmVnYXRpdmU6ICfij7AnLFxuICAgIH0sXG4gICAgbnVtYmVyczoge1xuICAgICAgMDogJ/CflZsnLFxuICAgICAgMTogJ/CflZAnLFxuICAgICAgMjogJ/CflZEnLFxuICAgICAgMzogJ/CflZInLFxuICAgICAgNDogJ/CflZMnLFxuICAgICAgNTogJ/CflZQnLFxuICAgICAgNjogJ/CflZUnLFxuICAgICAgNzogJ/CflZYnLFxuICAgICAgODogJ/CflZcnLFxuICAgICAgOTogJ/CflZgnLFxuICAgICAgJy4nOiAn4puz77iPJyxcbiAgICAgIGU6ICfwn5qAJyxcbiAgICB9LFxuICAgIG51bWVyYWxzOiB7XG4gICAgICAwOiAn8J+MuycsXG4gICAgICAxOiAn8J+MtycsXG4gICAgICAyOiAn8J+MsScsXG4gICAgICAzOiAn8J+MtScsXG4gICAgICA0OiAn8J+NgCcsXG4gICAgICA1OiAn8J+MuicsXG4gICAgICA2OiAn8J+MvicsXG4gICAgICA3OiAn8J+MvycsXG4gICAgICA4OiAn8J+MvCcsXG4gICAgICA5OiAn8J+MuScsXG4gICAgfSxcbiAgICBvdGhlcjoge1xuICAgICAgbnVsbDogJ/CflbMnLFxuICAgICAgZW1wdHlTdHJpbmc6ICfwn6e1JyxcbiAgICB9LFxuICAgIHVuaWNvZGU6IHtcbiAgICAgIDA6ICfwn5aLJyxcbiAgICAgIDE6ICfwn5aMJyxcbiAgICAgIDI6ICfwn5aNJyxcbiAgICAgIDM6ICfwn5aKJyxcbiAgICAgIDQ6ICfwn5SOJyxcbiAgICAgIDU6ICfwn5OQJyxcbiAgICAgIDY6ICfwn5OPJyxcbiAgICAgIDc6ICfwn5ONJyxcbiAgICAgIDg6ICfwn5OMJyxcbiAgICAgIDk6ICfwn6e3JyxcbiAgICAgIGE6ICfwn5OOJyxcbiAgICAgIGI6ICfwn5OBJyxcbiAgICAgIGM6ICfwn5OTJyxcbiAgICAgIGQ6ICfwn5OSJyxcbiAgICAgIGU6ICfwn5OVJyxcbiAgICAgIGY6ICfwn5OLJyxcbiAgICB9LFxuICB9LFxufTtcbiJdfQ==

package/lib/generator.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Write a value as an Emojion document, as `JSON.stringify()` writes JSON
+ * text, following the same rules:
+ *
+ * - It calls a value's `toJSON(key)` method, so a `Date` becomes its ISO
+ *   string.
+ * - It unwraps `new Number()`, `new String()` and `new Boolean()`.
+ * - It writes `NaN`, `Infinity` and `-Infinity` as `null`, and `-0` as `0`.
+ * - It skips `undefined`, functions and symbols in objects, and writes them
+ *   (and array holes) as `null` in arrays.
+ * - It writes only own enumerable string keys.
+ *
+ * @param value - The value to write.
+ * @returns The Emojion document, from `🙌` to `✋`.
+ * @throws {TypeError} For a BigInt (unless `BigInt.prototype.toJSON` is
+ * defined), for a circular structure, and for a value Emojion cannot hold at
+ * all: `undefined`, a function or a symbol on its own. (`JSON.stringify()`
+ * returns `undefined` for those; every Emojion document holds a value.)
+ * @throws {RangeError} If arrays and objects nest more than 512 levels deep.
+ *
+ * @example
+ * stringify({ created: 2019 });
+ * //=> '🙌😖😭😳😠😛😳🤤🕑🕛🕐🕘✋'
+ *
+ * @example
+ * stringify([1, undefined, new Date(0)]);
+ * //=> the same document as stringify([1, null, '1970-01-01T00:00:00.000Z'])
+ */
+export declare const stringify: (value: unknown) => string;