json-canonicalize/bundles/index.esm.js

JSON canonicalize function

const CircularRootPathName = '$';
function _serialize(obj, options) {
    let buffer = '';
    const vInclude = options && options.include;
    let vExclude = options && options.exclude;
    if (vExclude) {
        if (typeof vExclude === 'string')
            vExclude = [vExclude];
    }
    if (vInclude)
        vInclude.sort();
    const visited = new WeakMap();
    const allowCircular = options && options.allowCircular;
    const filterUndefined = options && options.filterUndefined;
    const undefinedInArrayToNull = options && options.undefinedInArrayToNull;
    serialize(obj, CircularRootPathName);
    return buffer;
    function serialize(object, path) {
        if (object === null ||
            typeof object !== 'object' ||
            object.toJSON != null) {
            /////////////////////////////////////////////////
            // Primitive data type - Use ES6/JSON          //
            /////////////////////////////////////////////////
            buffer += JSON.stringify(object);
        }
        else if (Array.isArray(object)) {
            /////////////////////////////////////////////////
            // Array - Maintain element order              //
            /////////////////////////////////////////////////
            const visitedPath = visited.get(object);
            if (visitedPath !== undefined) {
                if (path.startsWith(visitedPath)) {
                    if (!allowCircular) {
                        throw new Error('Circular reference detected');
                    }
                    buffer += '"[Circular:' + visitedPath + ']"';
                    return;
                }
            }
            visited.set(object, path);
            buffer += '[';
            let next = false;
            object.forEach((element, index) => {
                if (next) {
                    buffer += ',';
                }
                next = true;
                if (undefinedInArrayToNull && element === undefined) {
                    element = null;
                }
                /////////////////////////////////////////
                // Array element - Recursive expansion //
                /////////////////////////////////////////
                serialize(element, `${path}[${index}]`);
            });
            buffer += ']';
        }
        else {
            /////////////////////////////////////////////////
            // Object - Sort properties before serializing //
            /////////////////////////////////////////////////
            const visitedPath = visited.get(object);
            if (visitedPath !== undefined) {
                if (path.startsWith(visitedPath)) {
                    if (!allowCircular) {
                        throw new Error('Circular reference detected');
                    }
                    buffer += '"[Circular:' + visitedPath + ']"';
                    return;
                }
            }
            visited.set(object, path);
            buffer += '{';
            let next = false;
            const addProp = (property) => {
                if (vExclude && vExclude.includes(property)) {
                    return;
                }
                if (next) {
                    buffer += ',';
                }
                next = true;
                ///////////////////////////////////////////////
                // Property names are strings - Use ES6/JSON //
                ///////////////////////////////////////////////
                buffer += JSON.stringify(property);
                buffer += ':';
                //////////////////////////////////////////
                // Property value - Recursive expansion //
                //////////////////////////////////////////
                serialize(object[property], `${path}.${property}`);
            };
            if (path === CircularRootPathName && vInclude) {
                vInclude.forEach((property) => {
                    if (object.hasOwnProperty(property)) {
                        addProp(property);
                    }
                });
            }
            else {
                let vKeys = Object.keys(object);
                if (filterUndefined) {
                    vKeys = vKeys.filter((k) => object[k] !== undefined);
                }
                vKeys.sort();
                vKeys.forEach((property) => {
                    addProp(property);
                });
            }
            buffer += '}';
        }
    }
}

/**
 * The main function for JSON canonicalization. It takes a JavaScript object and returns its canonical string representation.
 *
 * @param obj The JavaScript object to canonicalize.
 * @param allowCircular If `true`, the function will handle circular references in the object by replacing them with `null`. Defaults to `false`.
 * @returns The canonical string representation of the object.
 */
function canonicalize(obj, allowCircular) {
    return _serialize(obj, {
        allowCircular,
        filterUndefined: true,
        undefinedInArrayToNull: true,
    });
}

/**
 * The extended canonicalization function, offering more granular control over the serialization process.
 *
 * @param obj The JavaScript object to canonicalize.
 * @param options An object with the following properties:
 *  - `allowCircular` (boolean, optional): Same as in `canonicalize`.
 *  - `filterUndefined` (boolean, optional): If `true`, `undefined` values in objects will be filtered out. Defaults to `true`.
 *  - `undefinedInArrayToNull` (boolean, optional): If `true`, `undefined` values in arrays will be converted to `null`. Defaults to `true`.
 *  - `include` (string[], optional): An array of property names to include in the canonicalization.
 *  - `exclude` (string[], optional): An array of property names to exclude from the canonicalization.
 * @returns The canonical string representation of the object.
 */
function canonicalizeEx(obj, options) {
    return _serialize(obj, options);
}

export { canonicalize, canonicalizeEx };
//# sourceMappingURL=index.esm.js.map