@toreda/strong-types/src/map/parser.ts

Better TypeScript code in fewer lines.

/**
 *	MIT License
 *
 *	Copyright (c) 2019 - 2021 Toreda, Inc.
 *
 *	Permission is hereby granted, free of charge, to any person obtaining a copy
 *	of this software and associated documentation files (the "Software"), to deal
 *	in the Software without restriction, including without limitation the rights
 *	to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 *	copies of the Software, and to permit persons to whom the Software is
 *	furnished to do so, subject to the following conditions:

 * 	The above copyright notice and this permission notice shall be included in all
 * 	copies or substantial portions of the Software.
 *
 * 	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *	IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 *	FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * 	AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 *	LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *	OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * 	SOFTWARE.
 *
 */
import type {Data} from '@toreda/types';

import {StrongMap} from '../map';
import {Strong} from '../strong';
import {MapParserOptions as Options} from './parser/options';
import {MapParserState as State} from './parser/state';

/**
 * Recursively parse provided object properties.
 *
 * @category Strong Map
 */
export class MapParser {
	public parse(map: StrongMap, data?: Data | unknown | null, options?: Options): boolean {
		if (!map) {
			return false;
		}

		if (!data) {
			return false;
		}

		const parseState = new State(options);

		return this.parseMap(map, data, parseState);
	}

	public parseStrongKey(key: Strong, value: unknown, _parseState: State): void {
		if (!key || value === undefined) {
			return;
		}

		if (key.baseType !== 'StrongType') {
			return;
		}

		const strongValue = value as Strong;
		// When value is also a StrongType invoke it to get its value. Otherwise set
		// the strong key with value.
		if (strongValue != null && strongValue.baseType === 'StrongType') {
			key(strongValue());
		} else {
			key(value);
		}
	}

	public parseKey(map: StrongMap, keyName: string, value: unknown, _parseState: State): boolean {
		if (!map) {
			return false;
		}

		if (value === undefined) {
			return false;
		}

		if (typeof keyName !== 'string' || !keyName) {
			return false;
		}

		if (value === null) {
			map[keyName] = null;
			return true;
		}

		let result: Strong | unknown;
		const strongValue = value as Strong;
		if (strongValue.hasOwnProperty('typeId') && strongValue.baseType === 'StrongType') {
			result = strongValue();
		} else {
			result = value;
		}

		if (typeof map[keyName] !== typeof result) {
			return false;
		}

		map[keyName] = result;
		return true;
	}

	/**
	 * Recursively parse map and children.
	 * @param map			Map to match properties against and store parsed values.
	 * @param json			Object to parse into map.
	 * @param parseState	Internal state for current parse.
	 * @returns				Boolean indicating success or failure.
	 *						true	- 	Map parse successful.
	 *						false	-	Map parse not successful.
	 */
	public parseMap(map: StrongMap, data: unknown | null, parseState: State): boolean {
		if (!map) {
			return false;
		}

		if (typeof data === 'undefined' || data === {}) {
			return false;
		}

		const keys: string[] = Object.keys(map);

		for (const keyName of keys) {
			const child = map[keyName];
			const keyValue = (data as Data)[keyName];

			// Skip built-in properties.
			if (!map.hasOwnProperty(keyName)) {
				continue;
			}

			// Child is also a StrongMap. Parse it recursively.
			if (child instanceof StrongMap) {
				this.parseMap(child, keyValue as Data, parseState);
			} else if ((child as Strong)?.baseType === 'StrongType') {
				// Child is a StrongType.
				this.parseStrongKey(child as Strong, keyValue, parseState);
			} else if (typeof child !== 'object') {
				// Child is not a StrongType and not an object.
				this.parseKey(map, keyName, keyValue, parseState);
			}
		}

		return true;
	}
}