jsonschema-key-compression 1.6.1 → 2.0.0

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+## Unreleased
+
+- FIX: `createCompressedJsonSchema()` did not compress the `properties`, `required` and `items` of nested schemas whose `type` is a type-array like `['object', 'null']` or `['array', 'null']`, or whose `type` is omitted. Because `createCompressionTable()` and `compressObject()` do compress these keys, a compressed object did not validate against its compressed schema.
+- FIX: `createCompressedJsonSchema()` did not compress property names inside of `allOf`, `anyOf`, `oneOf`, `not`, `patternProperties`, `additionalItems`, `dependencies` and `definitions`. The compression-table is not changed by this, so already compressed data stays compatible.
+- FIX: `createCompressionTable()` with `ignoreProperties` removed the decompression entry of a different property when an ignored property name was equal to a generated compressed key like `b`. `decompressObject()` then left that key compressed.
+- FIX: `createCompressedJsonSchema()` did not compress object values inside of `enum`. A property with an enum of allowed objects rejected every compressed document, because the enum still listed the uncompressed property names.
+- FIX: The performance test measured the creation of the random test-data (and for decompress also the compression) as part of the compress and decompress timings, which reported about 2 to 3 times too high numbers. The timer now only covers the measured operation, after an untimed warm-up. The benchmark schema also describes `shoppingCartItems` as an array now, like the test-data has it.
+- PERFORMANCE: `compressObject()` is about 60% faster and `decompressObject()` about 50% faster. Keys are looked up directly instead of being split on `[` for every key, the flagged compressed keys are cached per compression-table instead of being concatenated on every use, and primitive values are no longer passed through a recursive call.
+- PERFORMANCE: `createCompressionTable()` is about 30% faster because the property names of nested schemas are collected into a single set instead of creating a new set and array copy on each nesting level.
+- ADD: Enum-compression. When it is enabled, the value of a property is stored as the index of that value inside of the `enum` of the property. It is opt-in with the fourth parameter of `createCompressionTable()` so that data which was compressed without it stays readable. Only unambiguous string-enums are compressed, and the indexes are assigned in the alphabetical order of the values so that sorting and range-queries keep working. `compressQuery()` transforms the compared values and resolves a `$regex` into the matching indexes.
+- ADD: A general consistency test that runs random mango-queries (via mingo) and schema validation (via ajv) on random documents of a complex schema, to ensure that compressed and non-compressed data behave the same.

package/README.md

@@ -62,15 +62,18 @@ The efficiency depends on the amount and length of the attribute names.
 * Just using gzip on the json would result in **180 chars**
 * Using gzip+key-compression ends in a string with only **127 chars**
 
+The [enum-compression](#enum-compression) saves additional space,
+the longer the values of the enums are the more it saves.
+
 You can reproduce these results by running `npm run test:efficiency`.
 
 ## Performance
 
-The compression works pretty fast. Here are some time measurements on a single intel i7 CPU.
+The compression works pretty fast. Here are some time measurements on a single CPU core of a Node.js 22 process. Only the measured operation is timed, the creation of the test-data is not part of the measurement.
 
-* Creating a compression-table from the schema of the object above takes about `0.02ms`
-* Compressing the example-object from above takes about `0.021ms`
-* Decompressing takes about `0.027ms` per object
+* Creating a compression-table from the schema of the object above takes about `0.005ms`
+* Compressing the example-object from above takes about `0.0025ms`
+* Decompressing takes about `0.002ms` per object
 
 You can reproduce these results by running `npm run test:performance`.
 
@@ -103,11 +106,64 @@ Creates a compression-table from the [json-schema](https://json-schema.org/).
 
 ```js
 import {
-    createCompressionTable
+    createCompressionTable,
+    DEFAULT_COMPRESSION_FLAG
 } from 'jsonschema-key-compression';
 const compressionTable = createCompressionTable(jsonSchema);
+
+// all parameters
+const compressionTable = createCompressionTable(
+    jsonSchema,
+    DEFAULT_COMPRESSION_FLAG, // the character that marks a compressed key
+    ['myProperty'],           // property-names that must not be compressed
+    true                      // enable the enum-compression, see below
+);
+```
+
+### Enum-compression
+
+Enum-compression stores the value of a property as the index of that value
+inside of the `enum` of the property. With the enum `['admin', 'editor', 'viewer']`
+the value `'editor'` is stored as the number `1`.
+
+It is opt-in with the fourth parameter of `createCompressionTable()`,
+so that data which was compressed without it stays readable.
+
+```js
+const compressionTable = createCompressionTable(
+    jsonSchema,
+    DEFAULT_COMPRESSION_FLAG,
+    [],
+    true
+);
+
+compressObject(compressionTable, {
+    userRole: 'editor',
+    colorTags: ['red', 'blue']
+});
+// > { '|b': 1, '|a': [2, 0] }
 ```
 
+A property is only enum-compressed when it is safe to do so:
+* All values of the enum must be strings. A number inside of the enum could not be
+  told apart from an index, and strings are where the saved space is.
+* The property name must have the same enum everywhere in the schema.
+  A name that is used with different enums, or that has no enum somewhere else,
+  is left alone because the same number would otherwise mean different things.
+* Properties in `ignoreProperties` are not enum-compressed.
+
+The enum-values are sorted before the indexes are assigned, so the order of the indexes
+is the alphabetical order of the values. Because of this, `sort` and the range-operators
+`$gt`, `$gte`, `$lt` and `$lte` keep working on compressed data.
+`compressQuery()` also transforms the values of `$eq`, `$ne`, `$in`, `$nin`, `$all`,
+`$not` and `$elemMatch`, and resolves a `$regex` into the `$in` of the matching indexes.
+The operators `$type` and `$mod` are not transformed, they would run on the
+number of the compressed value.
+
+Enum-compression assumes that the data matches the schema.
+A document that stores a number where the schema defines an enum of strings
+cannot be told apart from an already compressed value.
+
 ### compressObject
 Compress a json-object based on its schema.
 
@@ -232,3 +288,7 @@ console.dir(compressedSchema);
  */
 
 ```
+
+## About
+
+This module was originally created for the [RxDB compression plugin](https://rxdb.info/key-compression.html) but in theory it can be used in any json based state management system or database.

package/dist/es/compress.d.ts

@@ -22,5 +22,7 @@ export declare function compressedAndFlaggedKey(table: CompressionTable, key: st
 export declare function compressQuery(table: CompressionTable, query: MangoQuery): MangoQuery;
 /**
  * @recursive
+ * @param enumValues The enum of the property that the selector belongs to,
+ * so that the compared values can be enum-compressed.
  */
-export declare function compressQuerySelector(table: CompressionTable, selector: any): any;
+export declare function compressQuerySelector(table: CompressionTable, selector: any, enumValues?: string[]): any;

package/dist/es/compress.js

@@ -1,3 +1,4 @@
+import { compressEnumValue } from './enum-compression';
 /**
  * compress the keys of an object via the compression-table
  * @recursive
@@ -5,21 +6,35 @@
 export function compressObject(table, obj) {
     if (typeof obj !== 'object' || obj === null)
         return obj;
-    else if (Array.isArray(obj)) {
+    if (Array.isArray(obj)) {
         // array
-        return obj
-            .map(function (item) { return compressObject(table, item); });
+        var retArray = new Array(obj.length);
+        for (var index = 0; index < obj.length; index++) {
+            var item = obj[index];
+            // primitives do not need a recursive call
+            retArray[index] = (typeof item === 'object' && item !== null) ? compressObject(table, item) : item;
+        }
+        return retArray;
     }
-    else {
-        // object
-        var ret_1 = {};
-        Object.keys(obj).forEach(function (key) {
-            var compressedKey = compressedAndFlaggedKey(table, key);
-            var value = compressObject(table, obj[key]);
-            ret_1[compressedKey] = value;
-        });
-        return ret_1;
+    // object
+    var ret = {};
+    var keys = Object.keys(obj);
+    var enumCompression = table.enumCompression;
+    for (var index = 0; index < keys.length; index++) {
+        var key = keys[index];
+        var value = obj[key];
+        var enumValues = enumCompression && enumCompression.get(key);
+        if (enumValues && (typeof value === 'string' || Array.isArray(value))) {
+            ret[compressedAndFlaggedKey(table, key)] = compressEnumValue(enumValues, value);
+        }
+        else {
+            // primitives do not need a recursive call
+            ret[compressedAndFlaggedKey(table, key)] = (typeof value === 'object' && value !== null) ?
+                compressObject(table, value) :
+                value;
+        }
     }
+    return ret;
 }
 /**
  * transform an object-path
@@ -42,22 +57,45 @@ export function throwErrorIfCompressionFlagUsed(table, key) {
             table.compressionFlag + ' on key ' + key);
     }
 }
+/**
+ * Cache of the flagged compressed keys per table,
+ * so that the flag does not have to be concatenated on each use.
+ * The cache is keyed by the table object, so a table must not be
+ * mutated after it has been used for compression.
+ */
+var flaggedKeysCache = new WeakMap();
+function getFlaggedKeys(table) {
+    var flaggedKeys = flaggedKeysCache.get(table);
+    if (!flaggedKeys) {
+        var newFlaggedKeys_1 = new Map();
+        table.compressedToUncompressed.forEach(function (compressedKey, key) {
+            newFlaggedKeys_1.set(key, table.compressionFlag + compressedKey);
+        });
+        flaggedKeysCache.set(table, newFlaggedKeys_1);
+        flaggedKeys = newFlaggedKeys_1;
+    }
+    return flaggedKeys;
+}
 export function compressedAndFlaggedKey(table, key) {
     throwErrorIfCompressionFlagUsed(table, key);
     /**
      * keys could be array-accessors like myArray[4]
-     * we have to split and readd the squared brackets value
+     * so the part before the squared bracket is looked up
+     * and the bracket part is re-added.
+     * Most keys have no bracket, so the plain lookup is the fast path.
      */
-    var splitSquaredBrackets = key.split('[');
-    key = splitSquaredBrackets.shift();
-    var compressedKey = table.compressedToUncompressed.get(key);
-    if (!compressedKey) {
-        return key;
+    var flaggedKeys = getFlaggedKeys(table);
+    var bracketIndex = key.indexOf('[');
+    if (bracketIndex === -1) {
+        var directFlaggedKey = flaggedKeys.get(key);
+        return directFlaggedKey ? directFlaggedKey : key;
     }
-    else {
-        var readdSquared = splitSquaredBrackets.length ? '[' + splitSquaredBrackets.join('[') : '';
-        return table.compressionFlag + compressedKey + readdSquared;
+    var plainKey = key.slice(0, bracketIndex);
+    var flaggedKey = flaggedKeys.get(plainKey);
+    if (!flaggedKey) {
+        return key;
     }
+    return flaggedKey + key.slice(bracketIndex);
 }
 /**
  * compress a mango-query
@@ -108,33 +146,133 @@ export function compressQuery(table, query) {
     }
     return ret;
 }
+/**
+ * Operators whose value is a document-value and therefore
+ * has to be enum-compressed like the documents themselves.
+ * Any other operator, like $type or $mod, gets its value unchanged.
+ */
+var ENUM_VALUE_OPERATORS = [
+    '$eq',
+    '$ne',
+    '$gt',
+    '$gte',
+    '$lt',
+    '$lte',
+    '$in',
+    '$nin',
+    '$all',
+    '$not',
+    '$elemMatch'
+];
+/**
+ * Returns the enum of the property that the path points to,
+ * or undefined when that property is not enum-compressed.
+ */
+function enumValuesOfPath(table, path) {
+    var enumCompression = table.enumCompression;
+    if (!enumCompression) {
+        return undefined;
+    }
+    var splitted = path.split('.');
+    var lastKey = splitted[splitted.length - 1];
+    var bracketIndex = lastKey.indexOf('[');
+    if (bracketIndex !== -1) {
+        lastKey = lastKey.slice(0, bracketIndex);
+    }
+    return enumCompression.get(lastKey);
+}
+/**
+ * A regular expression cannot run on the compressed number of an enum-value,
+ * so it is resolved up front into the indexes of the matching enum-values.
+ */
+function enumIndexesOfRegex(enumValues, pattern, options) {
+    var source;
+    var flags;
+    if (pattern instanceof RegExp) {
+        source = pattern.source;
+        flags = (pattern.ignoreCase ? 'i' : '') + (pattern.multiline ? 'm' : '');
+    }
+    else {
+        source = String(pattern);
+        flags = '';
+    }
+    if (typeof options === 'string') {
+        flags = options;
+    }
+    /**
+     * The global flags make .test() stateful
+     * and are meaningless for a full check of a single value.
+     */
+    flags = flags.replace(/[gy]/g, '');
+    var regex = new RegExp(source, flags);
+    var indexes = [];
+    for (var i = 0; i < enumValues.length; i++) {
+        if (regex.test(enumValues[i])) {
+            indexes.push(i);
+        }
+    }
+    return indexes;
+}
 /**
  * @recursive
+ * @param enumValues The enum of the property that the selector belongs to,
+ * so that the compared values can be enum-compressed.
  */
-export function compressQuerySelector(table, selector) {
+export function compressQuerySelector(table, selector, enumValues) {
     if (Array.isArray(selector)) {
-        return selector.map(function (item) { return compressQuerySelector(table, item); });
+        return selector.map(function (item) { return compressQuerySelector(table, item, enumValues); });
     }
     else if (selector instanceof RegExp) {
         return selector;
     }
     else if (typeof selector === 'object' && selector !== null) {
-        var ret_2 = {};
+        var ret_1 = {};
+        /**
+         * $regex and its $options are replaced by a single $in
+         * with the indexes of the matching enum-values.
+         */
+        var regexIndexes_1;
+        if (enumValues && typeof selector['$regex'] !== 'undefined') {
+            regexIndexes_1 = enumIndexesOfRegex(enumValues, selector['$regex'], selector['$options']);
+        }
         Object.keys(selector).forEach(function (key) {
+            if (regexIndexes_1 && (key === '$regex' || key === '$options')) {
+                return;
+            }
             var useKey;
+            var useEnumValues;
             if (key.startsWith('$')) {
                 // operator
                 useKey = key;
+                useEnumValues = ENUM_VALUE_OPERATORS.indexOf(key) === -1 ? undefined : enumValues;
             }
             else {
                 // property path
                 useKey = compressedPath(table, key);
+                useEnumValues = enumValuesOfPath(table, key);
+            }
+            var value = selector[key];
+            if (useEnumValues && value instanceof RegExp) {
+                ret_1[useKey] = {
+                    $in: enumIndexesOfRegex(useEnumValues, value, undefined)
+                };
+            }
+            else {
+                ret_1[useKey] = compressQuerySelector(table, value, useEnumValues);
             }
-            ret_2[useKey] = compressQuerySelector(table, selector[key]);
         });
-        return ret_2;
+        if (regexIndexes_1) {
+            var alreadyIn_1 = ret_1['$in'];
+            ret_1['$in'] = Array.isArray(alreadyIn_1) ?
+                regexIndexes_1.filter(function (index) { return alreadyIn_1.includes(index); }) :
+                regexIndexes_1;
+        }
+        return ret_1;
     }
     else {
+        if (enumValues) {
+            return compressEnumValue(enumValues, selector);
+        }
         return selector;
     }
 }

package/dist/es/compress.js.map

@@ -1 +1 @@
-{"version":3,"file":"compress.js","sourceRoot":"","sources":["../../src/compress.ts"],"names":[],"mappings":"AAMA;;;GAGG;AACH,MAAM,UAAU,cAAc,CAC1B,KAAuB,EACvB,GAAoB;IAEpB,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI;QAAE,OAAO,GAAG,CAAC;SACnD,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QACzB,QAAQ;QACR,OAAO,GAAG;aACL,GAAG,CAAC,UAAA,IAAI,IAAI,OAAA,cAAc,CAAC,KAAK,EAAE,IAAI,CAAC,EAA3B,CAA2B,CAAC,CAAC;KACjD;SAAM;QACH,SAAS;QACT,IAAM,KAAG,GAAoB,EAAE,CAAC;QAChC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,UAAA,GAAG;YACxB,IAAM,aAAa,GAAG,uBAAuB,CACzC,KAAK,EACL,GAAG,CACN,CAAC;YACF,IAAM,KAAK,GAAG,cAAc,CACxB,KAAK,EACL,GAAG,CAAC,GAAG,CAAC,CACX,CAAC;YACF,KAAG,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC;QAC/B,CAAC,CAAC,CAAC;QACH,OAAO,KAAG,CAAC;KACd;AACL,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,cAAc,CAC1B,KAAuB,EACvB,IAAY;IAEZ,IAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACjC,OAAO,QAAQ;SACV,GAAG,CAAC,UAAA,MAAM;QACP,IAAM,aAAa,GAAG,uBAAuB,CACzC,KAAK,EACL,MAAM,CACT,CAAC;QACF,OAAO,aAAa,CAAC;IACzB,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACrB,CAAC;AAED,MAAM,UAAU,+BAA+B,CAC3C,KAAuB,EACvB,GAAW;IAEX,IAAI,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE;QACvC,MAAM,IAAI,KAAK,CACX,gEAAgE;YAChE,KAAK,CAAC,eAAe,GAAG,UAAU,GAAG,GAAG,CAC3C,CAAC;KACL;AACL,CAAC;AAED,MAAM,UAAU,uBAAuB,CACnC,KAAuB,EACvB,GAAW;IAEX,+BAA+B,CAC3B,KAAK,EACL,GAAG,CACN,CAAC;IAEF;;;OAGG;IACH,IAAM,oBAAoB,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC5C,GAAG,GAAG,oBAAoB,CAAC,KAAK,EAAY,CAAC;IAE7C,IAAM,aAAa,GAAG,KAAK,CAAC,wBAAwB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC9D,IAAI,CAAC,aAAa,EAAE;QAChB,OAAO,GAAG,CAAC;KACd;SAAM;QACH,IAAM,YAAY,GAAG,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,GAAG,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7F,OAAO,KAAK,CAAC,eAAe,GAAG,aAAa,GAAG,YAAY,CAAC;KAC/D;AACL,CAAC;AAGD;;;;GAIG;AACH,MAAM,UAAU,aAAa,CACzB,KAAuB,EACvB,KAAiB;IAEjB,IAAM,GAAG,GAAe;QACpB,QAAQ,EAAE,qBAAqB,CAC3B,KAAK,EACL,KAAK,CAAC,QAAQ,CACjB;KACJ,CAAC;IACF,IAAI,KAAK,CAAC,IAAI;QAAE,GAAG,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;IACtC,IAAI,KAAK,CAAC,KAAK;QAAE,GAAG,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;IAEzC,IAAI,KAAK,CAAC,MAAM,EAAE;QACd,GAAG,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM;aACpB,GAAG,CAAC,UAAA,KAAK,IAAI,OAAA,cAAc,CACxB,KAAK,EACL,KAAK,CACR,EAHa,CAGb,CAAC,CAAC;KACV;IAED,IAAI,KAAK,CAAC,IAAI,EAAE;QACZ,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;YAC3B,GAAG,CAAC,IAAI,GAAI,KAAK,CAAC,IAAc,CAAC,GAAG,CAAC,UAAC,IAAkB;gBACpD,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;oBAC1B,IAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;oBACtC,IAAI,QAAQ,EAAE;wBACV,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;qBACzB;oBACD,IAAI,eAAe,GAAG,cAAc,CAChC,KAAK,EACL,IAAI,CACP,CAAC;oBACF,IAAI,QAAQ,EAAE;wBACV,eAAe,GAAG,GAAG,GAAG,eAAe,CAAC;qBAC3C;oBACD,OAAO,eAAe,CAAC;iBAC1B;qBAAM;oBACH,OAAO,qBAAqB,CACxB,KAAK,EACL,IAAI,CACP,CAAC;iBACL;YACL,CAAC,CAAC,CAAC;SACN;aAAM;YACH,IAAM,gBAAc,GAAQ,EAAE,CAAC;YAC/B,qDAAqD;YACrD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,UAAA,GAAG;gBAC/B,IAAM,SAAS,GAAI,KAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBAC3C,IAAM,eAAe,GAAG,cAAc,CAClC,KAAK,EACL,GAAG,CACN,CAAC;gBACF,gBAAc,CAAC,eAAe,CAAC,GAAG,SAAS,CAAC;YAChD,CAAC,CAAC,CAAC;YACH,GAAG,CAAC,IAAI,GAAG,gBAAc,CAAC;SAC7B;KACJ;IACD,OAAO,GAAG,CAAC;AACf,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,qBAAqB,CACjC,KAAuB,EACvB,QAAa;IAEb,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;QACzB,OAAO,QAAQ,CAAC,GAAG,CAAC,UAAA,IAAI,IAAI,OAAA,qBAAqB,CAAC,KAAK,EAAE,IAAI,CAAC,EAAlC,CAAkC,CAAC,CAAC;KACnE;SAAM,IAAI,QAAQ,YAAY,MAAM,EAAE;QACnC,OAAO,QAAQ,CAAC;KACnB;SAAM,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,IAAI,EAAE;QAC1D,IAAM,KAAG,GAAQ,EAAE,CAAC;QACpB,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,UAAA,GAAG;YAC7B,IAAI,MAAM,CAAC;YACX,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;gBACrB,WAAW;gBACX,MAAM,GAAG,GAAG,CAAC;aAChB;iBAAM;gBACH,gBAAgB;gBAChB,MAAM,GAAG,cAAc,CACnB,KAAK,EACL,GAAG,CACN,CAAC;aACL;YACD,KAAG,CAAC,MAAM,CAAC,GAAG,qBAAqB,CAC/B,KAAK,EACL,QAAQ,CAAC,GAAG,CAAC,CAChB,CAAC;QACN,CAAC,CAAC,CAAC;QACH,OAAO,KAAG,CAAC;KACd;SAAM;QACH,OAAO,QAAQ,CAAC;KACnB;AACL,CAAC"}
+{"version":3,"file":"compress.js","sourceRoot":"","sources":["../../src/compress.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAEvD;;;GAGG;AACH,MAAM,UAAU,cAAc,CAC1B,KAAuB,EACvB,GAAoB;IAEpB,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI;QAAE,OAAO,GAAG,CAAC;IACxD,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QACrB,QAAQ;QACR,IAAM,QAAQ,GAA8B,IAAI,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAClE,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC;YAC9C,IAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC;YACxB,0CAA0C;YAC1C,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,KAAK,EAAE,IAAI,CAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;QAC9G,CAAC;QACD,OAAO,QAAQ,CAAC;IACpB,CAAC;IACD,SAAS;IACT,IAAM,GAAG,GAA4B,EAAE,CAAC;IACxC,IAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC9B,IAAM,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC;IAC9C,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC;QAC/C,IAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAW,CAAC;QAClC,IAAM,KAAK,GAAI,GAA+B,CAAC,GAAG,CAAC,CAAC;QACpD,IAAM,UAAU,GAAG,eAAe,IAAI,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/D,IAAI,UAAU,IAAI,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;YACpE,GAAG,CAAC,uBAAuB,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,GAAG,iBAAiB,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;QACpF,CAAC;aAAM,CAAC;YACJ,0CAA0C;YAC1C,GAAG,CAAC,uBAAuB,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC;gBACtF,cAAc,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;gBAC9B,KAAK,CAAC;QACd,CAAC;IACL,CAAC;IACD,OAAO,GAAG,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,cAAc,CAC1B,KAAuB,EACvB,IAAY;IAEZ,IAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACjC,OAAO,QAAQ;SACV,GAAG,CAAC,UAAA,MAAM;QACP,IAAM,aAAa,GAAG,uBAAuB,CACzC,KAAK,EACL,MAAM,CACT,CAAC;QACF,OAAO,aAAa,CAAC;IACzB,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACrB,CAAC;AAED,MAAM,UAAU,+BAA+B,CAC3C,KAAuB,EACvB,GAAW;IAEX,IAAI,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE,CAAC;QACxC,MAAM,IAAI,KAAK,CACX,gEAAgE;YAChE,KAAK,CAAC,eAAe,GAAG,UAAU,GAAG,GAAG,CAC3C,CAAC;IACN,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACH,IAAM,gBAAgB,GAAmD,IAAI,OAAO,EAAE,CAAC;AACvF,SAAS,cAAc,CAAC,KAAuB;IAC3C,IAAI,WAAW,GAAG,gBAAgB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAC9C,IAAI,CAAC,WAAW,EAAE,CAAC;QACf,IAAM,gBAAc,GAAwB,IAAI,GAAG,EAAE,CAAC;QACtD,KAAK,CAAC,wBAAwB,CAAC,OAAO,CAAC,UAAC,aAAa,EAAE,GAAG;YACtD,gBAAc,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,eAAe,GAAG,aAAa,CAAC,CAAC;QACnE,CAAC,CAAC,CAAC;QACH,gBAAgB,CAAC,GAAG,CAAC,KAAK,EAAE,gBAAc,CAAC,CAAC;QAC5C,WAAW,GAAG,gBAAc,CAAC;IACjC,CAAC;IACD,OAAO,WAAW,CAAC;AACvB,CAAC;AAED,MAAM,UAAU,uBAAuB,CACnC,KAAuB,EACvB,GAAW;IAEX,+BAA+B,CAC3B,KAAK,EACL,GAAG,CACN,CAAC;IACF;;;;;OAKG;IACH,IAAM,WAAW,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC;IAC1C,IAAM,YAAY,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACtC,IAAI,YAAY,KAAK,CAAC,CAAC,EAAE,CAAC;QACtB,IAAM,gBAAgB,GAAG,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC9C,OAAO,gBAAgB,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,GAAG,CAAC;IACrD,CAAC;IACD,IAAM,QAAQ,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;IAC5C,IAAM,UAAU,GAAG,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC7C,IAAI,CAAC,UAAU,EAAE,CAAC;QACd,OAAO,GAAG,CAAC;IACf,CAAC;IACD,OAAO,UAAU,GAAG,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;AAChD,CAAC;AAGD;;;;GAIG;AACH,MAAM,UAAU,aAAa,CACzB,KAAuB,EACvB,KAAiB;IAEjB,IAAM,GAAG,GAAe;QACpB,QAAQ,EAAE,qBAAqB,CAC3B,KAAK,EACL,KAAK,CAAC,QAAQ,CACjB;KACJ,CAAC;IACF,IAAI,KAAK,CAAC,IAAI;QAAE,GAAG,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;IACtC,IAAI,KAAK,CAAC,KAAK;QAAE,GAAG,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;IAEzC,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;QACf,GAAG,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM;aACpB,GAAG,CAAC,UAAA,KAAK,IAAI,OAAA,cAAc,CACxB,KAAK,EACL,KAAK,CACR,EAHa,CAGb,CAAC,CAAC;IACX,CAAC;IAED,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;QACb,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5B,GAAG,CAAC,IAAI,GAAI,KAAK,CAAC,IAAc,CAAC,GAAG,CAAC,UAAC,IAAkB;gBACpD,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;oBAC3B,IAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;oBACtC,IAAI,QAAQ,EAAE,CAAC;wBACX,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;oBAC1B,CAAC;oBACD,IAAI,eAAe,GAAG,cAAc,CAChC,KAAK,EACL,IAAI,CACP,CAAC;oBACF,IAAI,QAAQ,EAAE,CAAC;wBACX,eAAe,GAAG,GAAG,GAAG,eAAe,CAAC;oBAC5C,CAAC;oBACD,OAAO,eAAe,CAAC;gBAC3B,CAAC;qBAAM,CAAC;oBACJ,OAAO,qBAAqB,CACxB,KAAK,EACL,IAAI,CACP,CAAC;gBACN,CAAC;YACL,CAAC,CAAC,CAAC;QACP,CAAC;aAAM,CAAC;YACJ,IAAM,gBAAc,GAAQ,EAAE,CAAC;YAC/B,qDAAqD;YACrD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,UAAA,GAAG;gBAC/B,IAAM,SAAS,GAAI,KAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBAC3C,IAAM,eAAe,GAAG,cAAc,CAClC,KAAK,EACL,GAAG,CACN,CAAC;gBACF,gBAAc,CAAC,eAAe,CAAC,GAAG,SAAS,CAAC;YAChD,CAAC,CAAC,CAAC;YACH,GAAG,CAAC,IAAI,GAAG,gBAAc,CAAC;QAC9B,CAAC;IACL,CAAC;IACD,OAAO,GAAG,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,IAAM,oBAAoB,GAAa;IACnC,KAAK;IACL,KAAK;IACL,KAAK;IACL,MAAM;IACN,KAAK;IACL,MAAM;IACN,KAAK;IACL,MAAM;IACN,MAAM;IACN,MAAM;IACN,YAAY;CACf,CAAC;AAEF;;;GAGG;AACH,SAAS,gBAAgB,CACrB,KAAuB,EACvB,IAAY;IAEZ,IAAM,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC;IAC9C,IAAI,CAAC,eAAe,EAAE,CAAC;QACnB,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,IAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACjC,IAAI,OAAO,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAW,CAAC;IACtD,IAAM,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC1C,IAAI,YAAY,KAAK,CAAC,CAAC,EAAE,CAAC;QACtB,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;IAC7C,CAAC;IACD,OAAO,eAAe,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;AACxC,CAAC;AAED;;;GAGG;AACH,SAAS,kBAAkB,CACvB,UAAoB,EACpB,OAAY,EACZ,OAAY;IAEZ,IAAI,MAAc,CAAC;IACnB,IAAI,KAAa,CAAC;IAClB,IAAI,OAAO,YAAY,MAAM,EAAE,CAAC;QAC5B,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QACxB,KAAK,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC7E,CAAC;SAAM,CAAC;QACJ,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;QACzB,KAAK,GAAG,EAAE,CAAC;IACf,CAAC;IACD,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAC9B,KAAK,GAAG,OAAO,CAAC;IACpB,CAAC;IACD;;;OAGG;IACH,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IACnC,IAAM,KAAK,GAAG,IAAI,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACxC,IAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACzC,IAAI,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAW,CAAC,EAAE,CAAC;YACtC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACpB,CAAC;IACL,CAAC;IACD,OAAO,OAAO,CAAC;AACnB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,qBAAqB,CACjC,KAAuB,EACvB,QAAa,EACb,UAAqB;IAErB,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC1B,OAAO,QAAQ,CAAC,GAAG,CAAC,UAAA,IAAI,IAAI,OAAA,qBAAqB,CAAC,KAAK,EAAE,IAAI,EAAE,UAAU,CAAC,EAA9C,CAA8C,CAAC,CAAC;IAChF,CAAC;SAAM,IAAI,QAAQ,YAAY,MAAM,EAAE,CAAC;QACpC,OAAO,QAAQ,CAAC;IACpB,CAAC;SAAM,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;QAC3D,IAAM,KAAG,GAAQ,EAAE,CAAC;QACpB;;;WAGG;QACH,IAAI,cAAkC,CAAC;QACvC,IAAI,UAAU,IAAI,OAAO,QAAQ,CAAC,QAAQ,CAAC,KAAK,WAAW,EAAE,CAAC;YAC1D,cAAY,GAAG,kBAAkB,CAC7B,UAAU,EACV,QAAQ,CAAC,QAAQ,CAAC,EAClB,QAAQ,CAAC,UAAU,CAAC,CACvB,CAAC;QACN,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,UAAA,GAAG;YAC7B,IAAI,cAAY,IAAI,CAAC,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,UAAU,CAAC,EAAE,CAAC;gBAC3D,OAAO;YACX,CAAC;YACD,IAAI,MAAM,CAAC;YACX,IAAI,aAAa,CAAC;YAClB,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBACtB,WAAW;gBACX,MAAM,GAAG,GAAG,CAAC;gBACb,aAAa,GAAG,oBAAoB,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC;YACtF,CAAC;iBAAM,CAAC;gBACJ,gBAAgB;gBAChB,MAAM,GAAG,cAAc,CACnB,KAAK,EACL,GAAG,CACN,CAAC;gBACF,aAAa,GAAG,gBAAgB,CAC5B,KAAK,EACL,GAAG,CACN,CAAC;YACN,CAAC;YACD,IAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;YAC5B,IAAI,aAAa,IAAI,KAAK,YAAY,MAAM,EAAE,CAAC;gBAC3C,KAAG,CAAC,MAAM,CAAC,GAAG;oBACV,GAAG,EAAE,kBAAkB,CAAC,aAAa,EAAE,KAAK,EAAE,SAAS,CAAC;iBAC3D,CAAC;YACN,CAAC;iBAAM,CAAC;gBACJ,KAAG,CAAC,MAAM,CAAC,GAAG,qBAAqB,CAC/B,KAAK,EACL,KAAK,EACL,aAAa,CAChB,CAAC;YACN,CAAC;QACL,CAAC,CAAC,CAAC;QACH,IAAI,cAAY,EAAE,CAAC;YACf,IAAM,WAAS,GAAG,KAAG,CAAC,KAAK,CAAC,CAAC;YAC7B,KAAG,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,WAAS,CAAC,CAAC,CAAC;gBACnC,cAAY,CAAC,MAAM,CAAC,UAAA,KAAK,IAAI,OAAA,WAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAzB,CAAyB,CAAC,CAAC,CAAC;gBACzD,cAAY,CAAC;QACrB,CAAC;QACD,OAAO,KAAG,CAAC;IACf,CAAC;SAAM,CAAC;QACJ,IAAI,UAAU,EAAE,CAAC;YACb,OAAO,iBAAiB,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QACnD,CAAC;QACD,OAAO,QAAQ,CAAC;IACpB,CAAC;AACL,CAAC"}

package/dist/es/create-compressed-json-schema.d.ts

@@ -1,2 +1,11 @@
 import type { JsonSchema, CompressionTable } from './types';
+/**
+ * Transforms the schema so that it describes the compressed objects.
+ * It recurses into all keywords that can contain sub-schemas,
+ * independent of the 'type' field. This mirrors how compressObject() works,
+ * which compresses every key that is known to the compression-table,
+ * wherever the key occurs in the document. For example a nullable nested object
+ * has type: ['object', 'null'] and its properties must still be compressed,
+ * and properties inside of oneOf/anyOf/allOf must be compressed as well.
+ */
 export declare function createCompressedJsonSchema(compressionTable: CompressionTable, schema: JsonSchema): JsonSchema;

package/dist/es/create-compressed-json-schema.js

@@ -1,38 +1,148 @@
 import { flatClone } from './util';
-import { compressedPath } from './compress';
+import { compressedPath, compressObject } from './compress';
+/**
+ * A value that is enum-compressed is stored as the index of the value,
+ * so the type of the property changes from string to number.
+ */
+function toNumberType(type) {
+    if (!type) {
+        return type;
+    }
+    if (Array.isArray(type)) {
+        return type.map(function (single) { return single === 'string' ? 'number' : single; });
+    }
+    return type === 'string' ? 'number' : type;
+}
+/**
+ * Replaces the enum-values of an enum-compressed property
+ * by the indexes that the compressed documents contain.
+ * The enum can sit at the property itself or at the items of an array-property.
+ * @recursive
+ */
+function compressEnumOfSchema(schema, enumValues) {
+    var ret = schema;
+    if (Array.isArray(schema.enum)) {
+        ret = flatClone(schema);
+        ret.enum = enumValues.map(function (_value, index) { return index; });
+        ret.type = toNumberType(schema.type);
+    }
+    var items = ret.items;
+    if (items && !Array.isArray(items) && Array.isArray(items.enum)) {
+        if (ret === schema) {
+            ret = flatClone(schema);
+        }
+        ret.items = compressEnumOfSchema(items, enumValues);
+    }
+    return ret;
+}
+/**
+ * Transforms the schema so that it describes the compressed objects.
+ * It recurses into all keywords that can contain sub-schemas,
+ * independent of the 'type' field. This mirrors how compressObject() works,
+ * which compresses every key that is known to the compression-table,
+ * wherever the key occurs in the document. For example a nullable nested object
+ * has type: ['object', 'null'] and its properties must still be compressed,
+ * and properties inside of oneOf/anyOf/allOf must be compressed as well.
+ */
 export function createCompressedJsonSchema(compressionTable, schema) {
-    if (schema.type === 'array' && schema.items) {
-        var cloned = flatClone(schema);
+    var hasNested = schema.items ||
+        schema.additionalItems ||
+        schema.properties ||
+        schema.patternProperties ||
+        schema.required ||
+        schema.allOf ||
+        schema.anyOf ||
+        schema.oneOf ||
+        schema.not ||
+        schema.dependencies ||
+        schema.definitions ||
+        schema.enum;
+    if (!hasNested) {
+        // no deeper fields in the schema
+        return schema;
+    }
+    var cloned = flatClone(schema);
+    var enumCompression = compressionTable.enumCompression;
+    var compressSchema = function (subSchema) { return createCompressedJsonSchema(compressionTable, subSchema); };
+    var compressKey = function (key) { return compressedPath(compressionTable, key); };
+    var compressSchemaMap = function (schemaMap, compressKeys) {
+        var ret = {};
+        // do not use Object.entries, it is transpiled shitty
+        Object.keys(schemaMap).forEach(function (key) {
+            var useKey = compressKeys ? compressKey(key) : key;
+            var subSchema = compressSchema(schemaMap[key]);
+            /**
+             * Only real property names can be enum-compressed,
+             * the keys of patternProperties and definitions are no property names.
+             */
+            var enumValues = (compressKeys && enumCompression) ? enumCompression.get(key) : undefined;
+            ret[useKey] = enumValues ? compressEnumOfSchema(subSchema, enumValues) : subSchema;
+        });
+        return ret;
+    };
+    if (schema.items) {
         if (Array.isArray(schema.items)) {
-            var newItems = schema.items.map(function (item) { return createCompressedJsonSchema(compressionTable, item); });
-            cloned.items = newItems;
+            cloned.items = schema.items.map(compressSchema);
         }
         else {
-            var newItems = createCompressedJsonSchema(compressionTable, schema.items);
-            cloned.items = newItems;
+            cloned.items = compressSchema(schema.items);
         }
-        return cloned;
     }
-    else if (schema.type === 'object' && schema.properties) {
-        var cloned = flatClone(schema);
-        // compress all property names
-        var newProperties_1 = {};
-        // do not use Object.entries, it is transpiled shitty
-        Object.keys(schema.properties).forEach(function (key) {
-            var property = schema.properties[key];
-            var compressedKey = compressedPath(compressionTable, key);
-            newProperties_1[compressedKey] = createCompressedJsonSchema(compressionTable, property);
+    if (schema.additionalItems && typeof schema.additionalItems === 'object') {
+        cloned.additionalItems = compressSchema(schema.additionalItems);
+    }
+    // compress all property names
+    if (schema.properties) {
+        cloned.properties = compressSchemaMap(schema.properties, true);
+    }
+    // the patterns are not property names, only the sub-schemas are compressed
+    if (schema.patternProperties) {
+        cloned.patternProperties = compressSchemaMap(schema.patternProperties, false);
+    }
+    // also compress the required array
+    if (schema.required) {
+        cloned.required = schema.required.map(compressKey);
+    }
+    if (schema.allOf) {
+        cloned.allOf = schema.allOf.map(compressSchema);
+    }
+    if (schema.anyOf) {
+        cloned.anyOf = schema.anyOf.map(compressSchema);
+    }
+    if (schema.oneOf) {
+        cloned.oneOf = schema.oneOf.map(compressSchema);
+    }
+    if (schema.not) {
+        cloned.not = compressSchema(schema.not);
+    }
+    /**
+     * dependencies are keyed by property name
+     * and contain either a list of property names
+     * or a sub-schema
+     */
+    if (schema.dependencies) {
+        var dependencies_1 = schema.dependencies;
+        var newDependencies_1 = {};
+        Object.keys(dependencies_1).forEach(function (key) {
+            var dependency = dependencies_1[key];
+            newDependencies_1[compressKey(key)] = Array.isArray(dependency) ?
+                dependency.map(compressKey) :
+                compressSchema(dependency);
         });
-        cloned.properties = newProperties_1;
-        // also compress the required array
-        if (cloned.required) {
-            cloned.required = cloned.required.map(function (key) { return compressedPath(compressionTable, key); });
-        }
-        return cloned;
+        cloned.dependencies = newDependencies_1;
     }
-    else {
-        // no deeper fields in the schema
-        return schema;
+    // definition names are not property names, only the sub-schemas are compressed
+    if (schema.definitions) {
+        cloned.definitions = compressSchemaMap(schema.definitions, false);
+    }
+    /**
+     * enum values are document fragments,
+     * so object values contain property names that must be compressed.
+     * Primitive values are returned unchanged by compressObject().
+     */
+    if (schema.enum) {
+        cloned.enum = schema.enum.map(function (value) { return compressObject(compressionTable, value); });
     }
+    return cloned;
 }
 //# sourceMappingURL=create-compressed-json-schema.js.map

package/dist/es/create-compressed-json-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-compressed-json-schema.js","sourceRoot":"","sources":["../../src/create-compressed-json-schema.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE5C,MAAM,UAAU,0BAA0B,CACtC,gBAAkC,EAClC,MAAkB;IAElB,IAAI,MAAM,CAAC,IAAI,KAAK,OAAO,IAAI,MAAM,CAAC,KAAK,EAAE;QACzC,IAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;QACjC,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE;YAC7B,IAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,UAAA,IAAI,IAAI,OAAA,0BAA0B,CAChE,gBAAgB,EAChB,IAAI,CACP,EAHyC,CAGzC,CAAC,CAAC;YACH,MAAM,CAAC,KAAK,GAAG,QAAQ,CAAC;SAC3B;aAAM;YACH,IAAM,QAAQ,GAAG,0BAA0B,CACvC,gBAAgB,EAChB,MAAM,CAAC,KAAK,CACf,CAAC;YACF,MAAM,CAAC,KAAK,GAAG,QAAQ,CAAC;SAC3B;QACD,OAAO,MAAM,CAAC;KACjB;SAAM,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,IAAI,MAAM,CAAC,UAAU,EAAE;QACtD,IAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;QAEjC,8BAA8B;QAC9B,IAAM,eAAa,GAEf,EAAE,CAAC;QACP,qDAAqD;QACrD,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,UAAA,GAAG;YACtC,IAAM,QAAQ,GAAI,MAAc,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;YACjD,IAAM,aAAa,GAAG,cAAc,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAC;YAC5D,eAAa,CAAC,aAAa,CAAC,GAAG,0BAA0B,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC;QAC1F,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,UAAU,GAAG,eAAa,CAAC;QAElC,mCAAmC;QACnC,IAAI,MAAM,CAAC,QAAQ,EAAE;YACjB,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAA,GAAG,IAAI,OAAA,cAAc,CAAC,gBAAgB,EAAE,GAAG,CAAC,EAArC,CAAqC,CAAC,CAAC;SACvF;QAED,OAAO,MAAM,CAAC;KACjB;SAAM;QACH,iCAAiC;QACjC,OAAO,MAAM,CAAC;KACjB;AACL,CAAC"}
+{"version":3,"file":"create-compressed-json-schema.js","sourceRoot":"","sources":["../../src/create-compressed-json-schema.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,EACH,cAAc,EACd,cAAc,EACjB,MAAM,YAAY,CAAC;AAEpB;;;GAGG;AACH,SAAS,YAAY,CACjB,IAAqD;IAErD,IAAI,CAAC,IAAI,EAAE,CAAC;QACR,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACtB,OAAO,IAAI,CAAC,GAAG,CAAC,UAAA,MAAM,IAAI,OAAA,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAvC,CAAuC,CAAC,CAAC;IACvE,CAAC;IACD,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;AAC/C,CAAC;AAED;;;;;GAKG;AACH,SAAS,oBAAoB,CACzB,MAAkB,EAClB,UAAoB;IAEpB,IAAI,GAAG,GAAG,MAAM,CAAC;IACjB,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;QAC7B,GAAG,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;QACxB,GAAG,CAAC,IAAI,GAAG,UAAU,CAAC,GAAG,CAAC,UAAC,MAAM,EAAE,KAAK,IAAK,OAAA,KAAK,EAAL,CAAK,CAAC,CAAC;QACpD,GAAG,CAAC,IAAI,GAAG,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC;IACD,IAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;IACxB,IAAI,KAAK,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QAC9D,IAAI,GAAG,KAAK,MAAM,EAAE,CAAC;YACjB,GAAG,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;QAC5B,CAAC;QACD,GAAG,CAAC,KAAK,GAAG,oBAAoB,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;IACxD,CAAC;IACD,OAAO,GAAG,CAAC;AACf,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,0BAA0B,CACtC,gBAAkC,EAClC,MAAkB;IAElB,IAAM,SAAS,GAAG,MAAM,CAAC,KAAK;QAC1B,MAAM,CAAC,eAAe;QACtB,MAAM,CAAC,UAAU;QACjB,MAAM,CAAC,iBAAiB;QACxB,MAAM,CAAC,QAAQ;QACf,MAAM,CAAC,KAAK;QACZ,MAAM,CAAC,KAAK;QACZ,MAAM,CAAC,KAAK;QACZ,MAAM,CAAC,GAAG;QACV,MAAM,CAAC,YAAY;QACnB,MAAM,CAAC,WAAW;QAClB,MAAM,CAAC,IAAI,CAAC;IAChB,IAAI,CAAC,SAAS,EAAE,CAAC;QACb,iCAAiC;QACjC,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,IAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;IACjC,IAAM,eAAe,GAAG,gBAAgB,CAAC,eAAe,CAAC;IACzD,IAAM,cAAc,GAAG,UAAC,SAAqB,IAAK,OAAA,0BAA0B,CAAC,gBAAgB,EAAE,SAAS,CAAC,EAAvD,CAAuD,CAAC;IAC1G,IAAM,WAAW,GAAG,UAAC,GAAW,IAAK,OAAA,cAAc,CAAC,gBAAgB,EAAE,GAAG,CAAC,EAArC,CAAqC,CAAC;IAC3E,IAAM,iBAAiB,GAAG,UACtB,SAAsC,EACtC,YAAqB;QAErB,IAAM,GAAG,GAAgC,EAAE,CAAC;QAC5C,qDAAqD;QACrD,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,UAAA,GAAG;YAC9B,IAAM,MAAM,GAAG,YAAY,CAAC,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;YACrD,IAAM,SAAS,GAAG,cAAc,CAAC,SAAS,CAAC,GAAG,CAAe,CAAC,CAAC;YAC/D;;;eAGG;YACH,IAAM,UAAU,GAAG,CAAC,YAAY,IAAI,eAAe,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5F,GAAG,CAAC,MAAM,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,oBAAoB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACvF,CAAC,CAAC,CAAC;QACH,OAAO,GAAG,CAAC;IACf,CAAC,CAAC;IAEF,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9B,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QACpD,CAAC;aAAM,CAAC;YACJ,MAAM,CAAC,KAAK,GAAG,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAChD,CAAC;IACL,CAAC;IACD,IAAI,MAAM,CAAC,eAAe,IAAI,OAAO,MAAM,CAAC,eAAe,KAAK,QAAQ,EAAE,CAAC;QACvE,MAAM,CAAC,eAAe,GAAG,cAAc,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;IACpE,CAAC;IAED,8BAA8B;IAC9B,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;QACpB,MAAM,CAAC,UAAU,GAAG,iBAAiB,CAAC,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;IACnE,CAAC;IACD,2EAA2E;IAC3E,IAAI,MAAM,CAAC,iBAAiB,EAAE,CAAC;QAC3B,MAAM,CAAC,iBAAiB,GAAG,iBAAiB,CAAC,MAAM,CAAC,iBAAiB,EAAE,KAAK,CAAC,CAAC;IAClF,CAAC;IACD,mCAAmC;IACnC,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;QAClB,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IACvD,CAAC;IAED,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IACpD,CAAC;IACD,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IACpD,CAAC;IACD,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IACpD,CAAC;IACD,IAAI,MAAM,CAAC,GAAG,EAAE,CAAC;QACb,MAAM,CAAC,GAAG,GAAG,cAAc,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC5C,CAAC;IAED;;;;OAIG;IACH,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;QACtB,IAAM,cAAY,GAAG,MAAM,CAAC,YAAY,CAAC;QACzC,IAAM,iBAAe,GAA2C,EAAE,CAAC;QACnE,MAAM,CAAC,IAAI,CAAC,cAAY,CAAC,CAAC,OAAO,CAAC,UAAA,GAAG;YACjC,IAAM,UAAU,GAAG,cAAY,CAAC,GAAG,CAA0B,CAAC;YAC9D,iBAAe,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC;gBAC3D,UAAU,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC;gBAC7B,cAAc,CAAC,UAAU,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,YAAY,GAAG,iBAAe,CAAC;IAC1C,CAAC;IAED,+EAA+E;IAC/E,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;QACrB,MAAM,CAAC,WAAW,GAAG,iBAAiB,CAAC,MAAM,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IACtE,CAAC;IAED;;;;OAIG;IACH,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;QACd,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,UAAA,KAAK,IAAI,OAAA,cAAc,CAAC,gBAAgB,EAAE,KAAK,CAAC,EAAvC,CAAuC,CAAC,CAAC;IACpF,CAAC;IAED,OAAO,MAAM,CAAC;AAClB,CAAC"}

package/dist/es/create-compression-table.d.ts

@@ -6,7 +6,13 @@ import type { CompressionTable, JsonSchema, TableType } from './types';
  * compression-flag, an error will be thrown.
  */
 export declare const DEFAULT_COMPRESSION_FLAG = "|";
-export declare function createCompressionTable(schema: JsonSchema, compressionFlag?: string, ignoreProperties?: string[]): CompressionTable;
+/**
+ * @param compressEnums If true, the values of string-enums are compressed
+ * into the index of the value inside of the enum.
+ * This changes the stored format, so it is opt-in
+ * to keep already compressed data readable.
+ */
+export declare function createCompressionTable(schema: JsonSchema, compressionFlag?: string, ignoreProperties?: string[], compressEnums?: boolean): CompressionTable;
 /**
  * Returns a list of all property names that occur in the schema.
  * @returns Set of strings to ensure uniqueness.