@barchart/common-node-js/aws/dynamo/schema/definitions/Encryptor.js

Common classes, utilities, and functions for building Node.js servers

const is = require('@barchart/common-js/lang/is');

const EncryptionType = require('./EncryptionType');

module.exports = (() => {
	'use strict';

	/**
	 * The definition an encryption scheme to use for data at rest.
	 *
	 * @public
	 * @param {EncyrptionType} type
	 * @param {String} key
	 */
	class Encryptor {
		constructor(type, key) {
			this._type = type || null;
			this._key = key;
		}

		/**
		 * The algorithm type.
		 *
		 * @public
		 * @returns {EncryptionType}
		 */
		get type() {
			return this._type;
		}

		/**
		 * The key.
		 *
		 * @public
		 * @returns {String}
		 */
		get key() {
			return this._key;
		}

		/**
		 * Throws an {@link Error} if the instance is invalid.
		 *
		 * @public
		 */
		validate() {
			if (!(this._type instanceof EncryptionType)) {
				throw new Error('Encryption type is invalid.');
			}

			if (!(is.string(this._password)) || this._password.length === 0) {
				throw new Error('Password is invalid.');
			}
		}

		toString() {
			return `[Encryptor]`;
		}
	}

	return Encryptor;
})();