style: edit folder structure fp-54 (#77)

* style: edit folder structure fp-54

* style: clarify functions names fp-54

readme.md

@@ -50,14 +50,14 @@ npm install form-payload
 
 ```js
 // index.js
-import { getFormValues, getControlValue } from 'form-payload';
+import { getFormPayload, getFormControlPayload } from 'form-payload';
 
 const { general: generalFormNode, mailing: mailingFormNode } = document.forms;
 
 generalFormNode.addEventListener('submit', (evt) => {
   evt.preventDefault();
 
-  console.log(getFormValues(generalFormNode));
+  console.log(getFormPayload(generalFormNode));
   // {
   //   name: 'Jon',
   //   birthday: Sat Mar 27 2021 18:06:42 GMT+0200 (Eastern European Standard Time),
@@ -69,7 +69,7 @@ generalFormNode.addEventListener('submit', (evt) => {
 });
 
 mailingFormNode.addEventListener('change', (evt) => {
-  console.log(getControlValue(evt.target));
+  console.log(getFormControlPayload(evt.target));
   // '[email protected]'
 });
 ```
@@ -81,21 +81,21 @@ _It doesn't matter which framework you use, you just need to pass the valid [HTM
 ### React
 
 ```jsx
-import { getFormValues, getControlValue, ControlType } from 'form-payload';
+import { getFormPayload, getFormControlPayload, ControlType } from 'form-payload';
 
 const SimpleForm = () => {
   const handleSubmit = (evt: React.FormEvent<HTMLFormElement>) => {
     evt.preventDefault();
 
-    console.log(getFormValues(evt.target as HTMLFormElement));
+    console.log(getFormPayload(evt.target as HTMLFormElement));
     // {
     //   name: 'Jon',
     //   birthday: Sat Mar 27 2021 18:06:42 GMT+0200 (Eastern European Standard Time),
     // }
   };
 
   const handleChange = (evt: React.ChangeEvent<HTMLInputElement>) => {
-    console.log(getControlValue(evt.target));
+    console.log(getFormControlPayload(evt.target));
     // '[email protected]'
   };
 

src/index.js

@@ -1,19 +1,4 @@
-import { getElementsValues } from './helpers/helpers.js';
-
-/** @typedef {import('./common/types/types.js').HTMLFormControlElement} HTMLFormControlElement */
-
-/**
- * @template {Record<string, unknown>} T
- * @param {HTMLFormElement} formNode
- * @returns {T}
- */
-const getFormValues = (formNode) => {
-	return getElementsValues(
-		/** @type {HTMLFormControlElement[]} */ ([...formNode.elements]),
-	);
-};
-
-export { getFormValues };
-export { ControlType } from './common/enums/enums.js';
-export { FormPayloadError } from './exceptions/exceptions.js';
-export { getControlValue } from './helpers/helpers.js';
+export { ControlType } from './libs/enums/enums.js';
+export { FormPayloadError } from './libs/exceptions/exceptions.js';
+export { getFormControlPayload } from './packages/get-form-control-payload/get-form-control-payload.js';
+export { getFormPayload } from './packages/get-form-payload/get-form-payload.js';

src/libs/exceptions/exceptions.js

@@ -0,0 +1 @@
+export { FormPayloadError } from './form-payload-error.exception.js';

src/packages/get-form-control-payload/get-form-control-payload.js

@@ -0,0 +1,120 @@
+import { ControlType } from '../../libs/enums/enums.js';
+import { FormPayloadError } from '../../libs/exceptions/exceptions.js';
+import {
+	checkIsReferToAnotherNode,
+	getAllowedElements,
+	getCheckboxValue,
+	getFormControlValue,
+	getInputDateValue,
+	getInputFileValue,
+	getInputNumericValue,
+	getMultiSelectValues,
+} from './helpers/helpers.js';
+
+/** @typedef {import('../../libs/types/types.js').HTMLFormControlElement} HTMLFormControlElement */
+/** @typedef {import('../../libs/types/types.js').HTMLFormOperationalControlElement} HTMLFormOperationalControlElement */
+
+/**
+ * @template {Record<string, unknown>} T
+ * @param {...HTMLFormControlElement} controlElements
+ * @returns {T}
+ */
+const getFormControlsPayload = (...controlElements) => {
+	const allowedElements = getAllowedElements(controlElements);
+
+	let elementsValues = /** @type {T} */ ({});
+
+	for (const element of allowedElements) {
+		const isReferToAnotherNode = checkIsReferToAnotherNode(
+			element,
+			...allowedElements,
+		);
+
+		if (isReferToAnotherNode) {
+			continue;
+		}
+
+		elementsValues = {
+			...elementsValues,
+			[element.name]: getFormControlPayload(element),
+		};
+	}
+
+	return elementsValues;
+};
+
+/**
+ * @param {HTMLFormOperationalControlElement} controlNode
+ * @returns {unknown}
+ * @throws {FormPayloadError}
+ */
+const getFormControlPayload = (controlNode) => {
+	switch (controlNode.type) {
+		case ControlType.COLOR:
+		case ControlType.EMAIL:
+		case ControlType.HIDDEN:
+		case ControlType.PASSWORD:
+		case ControlType.RADIO:
+		case ControlType.SEARCH:
+		case ControlType.TEL:
+		case ControlType.TEXT:
+		case ControlType.URL:
+		case ControlType.OUTPUT:
+		case ControlType.TEXTAREA:
+		case ControlType.SELECT_ONE: {
+			return getFormControlValue(
+				/**
+				 * @type {HTMLInputElement
+				 * 	| HTMLOutputElement
+				 * 	| HTMLTextAreaElement
+				 * 	| HTMLSelectElement}
+				 */ (controlNode),
+			);
+		}
+		case ControlType.DATE:
+		case ControlType.DATETIME_LOCAL:
+		case ControlType.MONTH:
+		case ControlType.TIME:
+		case ControlType.WEEK: {
+			return getInputDateValue(
+				/** @type {HTMLInputElement} */ (controlNode),
+			);
+		}
+		case ControlType.NUMBER:
+		case ControlType.RANGE: {
+			return getInputNumericValue(
+				/** @type {HTMLInputElement} */ (controlNode),
+			);
+		}
+		case ControlType.CHECKBOX: {
+			return getCheckboxValue(
+				/** @type {HTMLInputElement} */ (controlNode),
+			);
+		}
+		case ControlType.SELECT_MULTIPLE: {
+			return getMultiSelectValues(
+				/** @type {HTMLSelectElement} */ (controlNode),
+			);
+		}
+		case ControlType.FILE: {
+			return getInputFileValue(
+				/** @type {HTMLInputElement} */ (controlNode),
+			);
+		}
+		case ControlType.FIELDSET: {
+			const elements = [
+				.../** @type {HTMLFieldSetElement} */ (controlNode).elements,
+			];
+
+			return getFormControlsPayload(
+				.../** @type {HTMLFormControlElement[]} */ (elements),
+			);
+		}
+	}
+
+	throw new FormPayloadError({
+		message: 'Unknown control type.',
+	});
+};
+
+export { getFormControlPayload, getFormControlsPayload };

src/helpers/get-control-value/helpers/check-is-refer-to-another-node/check-is-refer-to-another-node.helper.js → src/packages/get-form-control-payload/helpers/check-is-refer-to-another-node/check-is-refer-to-another-node.helper.js

@@ -1,4 +1,4 @@
-/** @typedef {import('../../../../common/types/types.js').HTMLFormOperationalControlElement} HTMLFormOperationalControlElement */
+/** @typedef {import('../../../../libs/types/types.js').HTMLFormOperationalControlElement} HTMLFormOperationalControlElement */
 
 /**
  * @template {HTMLFormOperationalControlElement} T

src/helpers/get-control-value/helpers/get-allowed-elements/get-allowed-elements.helper.js → src/packages/get-form-control-payload/helpers/get-allowed-elements/get-allowed-elements.helper.js

@@ -1,10 +1,10 @@
 import {
 	BANNED_CONTROL_TYPES,
 	BANNED_FORM_OPERATIONAL_CONTROL_ELEMENTS,
-} from '../../../../common/constants/constants.js';
+} from '../../../../libs/constants/constants.js';
 
-/** @typedef {import('../../../../common/types/types.js').HTMLFormControlElement} HTMLFormControlElement */
-/** @typedef {import('../../../../common/types/types.js').HTMLFormOperationalControlElement} HTMLFormOperationalControlElement */
+/** @typedef {import('../../../../libs/types/types.js').HTMLFormControlElement} HTMLFormControlElement */
+/** @typedef {import('../../../../libs/types/types.js').HTMLFormOperationalControlElement} HTMLFormOperationalControlElement */
 
 const checkControlFunctionMap = /** @type {const} */ ({
 	/**

src/packages/get-form-control-payload/helpers/get-checkbox-value/get-checkbox-value.helper.js

@@ -0,0 +1,9 @@
+/**
+ * @param {HTMLInputElement} element
+ * @returns {boolean}
+ */
+const getCheckboxValue = (element) => {
+	return element.checked;
+};
+
+export { getCheckboxValue };

src/packages/get-form-control-payload/helpers/get-control-value/get-control-value.helper.js

@@ -0,0 +1,12 @@
+/**
+ * @param {HTMLInputElement
+ * 	| HTMLOutputElement
+ * 	| HTMLTextAreaElement
+ * 	| HTMLSelectElement} element
+ * @returns {string}
+ */
+const getFormControlValue = (element) => {
+	return element.value;
+};
+
+export { getFormControlValue };

src/packages/get-form-control-payload/helpers/get-input-date-value/get-input-date-value.helper.js

@@ -0,0 +1,9 @@
+/**
+ * @param {HTMLInputElement} element
+ * @returns {Date | null}
+ */
+const getInputDateValue = (element) => {
+	return element.valueAsDate;
+};
+
+export { getInputDateValue };