form-payload 1.5.0 → 1.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "form-payload",
-	"version": "1.5.0",
+	"version": "1.6.0",
 	"description": "Gets form-payload via form.elements",
 	"keywords": [
 		"form",

package/readme.md

@@ -95,5 +95,6 @@ PS. _The library works perfectly with any framework. Just use a valid [HTMLFormE
 | [HTMLSelectElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLSelectElement)     | `multiple`                                                   | ✅       | `Array<string>`                                                                                 |
 | [HTMLOutputElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLOutputElement)     | –                                                            | ✅       | `string`                                                                                        |
 | [HTMLFieldsetElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLFieldsetElement) | –                                                            | ✅       | `Object<name: string, value: unknown>` (recursive values of nested elements)                    |
+| [HTMLFieldsetElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLFieldsetElement) | `[]` in `name` (Ex. `name="shops[]"`)                        | ✅       | `Array<Object<name: string, value: unknown>>` (recursive values of nested elements)             |
 | [HTMLButtonElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLButtonElement)     | –                                                            | ❌       | –                                                                                               |
 | [HTMLObjectElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLObjectElement)     | –                                                            | ❌       | –                                                                                               |

package/src/libs/constants/value-as-array-custom-control-types.constant.d.ts

@@ -1,2 +1,2 @@
-export const VALUE_AS_ARRAY_CUSTOM_CONTROL_TYPES: "checkbox"[];
+export const VALUE_AS_ARRAY_CUSTOM_CONTROL_TYPES: ("checkbox" | "fieldset")[];
 //# sourceMappingURL=value-as-array-custom-control-types.constant.d.ts.map

package/src/libs/constants/value-as-array-custom-control-types.constant.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"value-as-array-custom-control-types.constant.d.ts","sourceRoot":"","sources":["../../../../src/libs/constants/value-as-array-custom-control-types.constant.js"],"names":[],"mappings":"AAEA,+DAAmE"}
+{"version":3,"file":"value-as-array-custom-control-types.constant.d.ts","sourceRoot":"","sources":["../../../../src/libs/constants/value-as-array-custom-control-types.constant.js"],"names":[],"mappings":"AAEA,8EAGE"}

package/src/libs/constants/value-as-array-custom-control-types.constant.js

@@ -1,5 +1,8 @@
 import { ControlType } from '../enums/enums.js';
 
-const VALUE_AS_ARRAY_CUSTOM_CONTROL_TYPES = [ControlType.CHECKBOX];
+const VALUE_AS_ARRAY_CUSTOM_CONTROL_TYPES = [
+	ControlType.CHECKBOX,
+	ControlType.FIELDSET,
+];
 
 export { VALUE_AS_ARRAY_CUSTOM_CONTROL_TYPES };

package/src/packages/get-form-control-payload/get-form-control-payload.d.ts

@@ -1,5 +1,6 @@
-export type HTMLFormControlElement = import('../../libs/types/types.js').HTMLFormControlElement;
+export { getFormControlsPayload } from "./helpers/helpers.js";
 export type HTMLFormOperationalControlElement = import('../../libs/types/types.js').HTMLFormOperationalControlElement;
+/** @typedef {import('../../libs/types/types.js').HTMLFormOperationalControlElement} HTMLFormOperationalControlElement */
 /**
  * @template {unknown} T
  * @param {HTMLFormOperationalControlElement} controlNode
@@ -7,12 +8,4 @@ export type HTMLFormOperationalControlElement = import('../../libs/types/types.j
  * @throws {FormPayloadError}
  */
 export function getFormControlPayload<T extends unknown>(controlNode: HTMLFormOperationalControlElement): T;
-/** @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}
- */
-export function getFormControlsPayload<T extends Record<string, unknown>>(...controlElements: HTMLFormControlElement[]): T;
 //# sourceMappingURL=get-form-control-payload.d.ts.map

package/src/packages/get-form-control-payload/get-form-control-payload.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-form-control-payload.d.ts","sourceRoot":"","sources":["../../../../src/packages/get-form-control-payload/get-form-control-payload.js"],"names":[],"mappings":"qCAiBc,OAAO,2BAA2B,EAAE,sBAAsB;gDAC1D,OAAO,2BAA2B,EAAE,iCAAiC;AAyCnF;;;;;GAKG;AACH,sEAJW,iCAAiC,KAmG3C;AA/ID,mGAAmG;AACnG,yHAAyH;AAEzH;;;;GAIG;AACH,8FAHc,sBAAsB,OAmCnC"}
+{"version":3,"file":"get-form-control-payload.d.ts","sourceRoot":"","sources":["../../../../src/packages/get-form-control-payload/get-form-control-payload.js"],"names":[],"mappings":";gDAcc,OAAO,2BAA2B,EAAE,iCAAiC;AAAnF,yHAAyH;AAEzH;;;;;GAKG;AACH,sEAJW,iCAAiC,KAgG3C"}

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

@@ -1,12 +1,9 @@
 import { ControlType } from '../../libs/enums/enums.js';
 import { FormPayloadError } from '../../libs/exceptions/exceptions.js';
 import {
-	checkHasValueAsArray,
-	checkIsReferToAnotherNode,
-	getAllowedElements,
 	getCheckboxValue,
-	getCleanedValueAsArrayControlName,
 	getDatetimeLocalValue,
+	getFieldsetValue,
 	getFormControlValue,
 	getInputDateValue,
 	getInputEmailValue,
@@ -15,48 +12,8 @@ import {
 	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);
-
-	const elementsValues = /** @type {T} */ ({});
-
-	for (const element of allowedElements) {
-		const isReferToAnotherNode = checkIsReferToAnotherNode(
-			element,
-			allowedElements,
-		);
-
-		if (isReferToAnotherNode) {
-			continue;
-		}
-
-		let key = /** @type {keyof T} */ (element.name);
-		let value = /** @type {T[keyof T]} */ (getFormControlPayload(element));
-		const hasValueAsArray = checkHasValueAsArray(element);
-
-		if (hasValueAsArray) {
-			key = getCleanedValueAsArrayControlName(element);
-
-			value = /** @type {T[keyof T]} */ ([
-				.../** @type {unknown[]} */ (elementsValues[key] ?? []),
-				.../** @type {unknown[]} */ (getFormControlPayload(element)),
-			]);
-		}
-
-		elementsValues[key] = value;
-	}
-
-	return elementsValues;
-};
-
 /**
  * @template {unknown} T
  * @param {HTMLFormOperationalControlElement} controlNode
@@ -143,13 +100,10 @@ const getFormControlPayload = (controlNode) => {
 			);
 		}
 		case ControlType.FIELDSET: {
-			const elements = [
-				.../** @type {HTMLFieldSetElement} */ (controlNode).elements,
-			];
-
 			return /** @type {T} */ (
-				getFormControlsPayload(
-					.../** @type {HTMLFormControlElement[]} */ (elements),
+				getFieldsetValue(
+					getFormControlPayload,
+					/** @type {HTMLFieldSetElement} */ (controlNode),
 				)
 			);
 		}
@@ -160,4 +114,5 @@ const getFormControlPayload = (controlNode) => {
 	});
 };
 
-export { getFormControlPayload, getFormControlsPayload };
+export { getFormControlsPayload } from './helpers/helpers.js';
+export { getFormControlPayload };

package/src/packages/get-form-control-payload/helpers/get-fieldset-value/get-fieldset-value.helper.d.ts

@@ -0,0 +1,14 @@
+export type HTMLFormOperationalControlElement = import('../../../../libs/types/types.js').HTMLFormOperationalControlElement;
+export type HTMLFormControlElement = import('../../../../libs/types/types.js').HTMLFormControlElement;
+/** @typedef {import('../../../../libs/types/types.js').HTMLFormOperationalControlElement} HTMLFormOperationalControlElement */
+/** @typedef {import('../../../../libs/types/types.js').HTMLFormControlElement} HTMLFormControlElement */
+/**
+ * @template {Record<string, unknown>} T
+ * @param {<T extends unknown>(
+ * 	element: HTMLFormOperationalControlElement,
+ * ) => T} getFormControlPayloadCallback
+ * @param {HTMLFieldSetElement} element
+ * @returns {T | [T]}
+ */
+export function getFieldsetValue<T extends Record<string, unknown>>(getFormControlPayloadCallback: <T_1 extends unknown>(element: HTMLFormOperationalControlElement) => T_1, element: HTMLFieldSetElement): T | [T];
+//# sourceMappingURL=get-fieldset-value.helper.d.ts.map

package/src/packages/get-form-control-payload/helpers/get-fieldset-value/get-fieldset-value.helper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-fieldset-value.helper.d.ts","sourceRoot":"","sources":["../../../../../../src/packages/get-form-control-payload/helpers/get-fieldset-value/get-fieldset-value.helper.js"],"names":[],"mappings":"gDAGc,OAAO,iCAAiC,EAAE,iCAAiC;qCAC3E,OAAO,iCAAiC,EAAE,sBAAsB;AAD9E,+HAA+H;AAC/H,yGAAyG;AAEzG;;;;;;;GAOG;AACH,kIALa,iCAAiC,mBAEnC,mBAAmB,WAa7B"}

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

@@ -0,0 +1,27 @@
+import { VALUE_AS_ARRAY_IDENTIFIER } from '../../../../libs/constants/constants.js';
+import { getFormControlsPayload } from '../get-form-controls-payload/get-form-controls-payload.js';
+
+/** @typedef {import('../../../../libs/types/types.js').HTMLFormOperationalControlElement} HTMLFormOperationalControlElement */
+/** @typedef {import('../../../../libs/types/types.js').HTMLFormControlElement} HTMLFormControlElement */
+
+/**
+ * @template {Record<string, unknown>} T
+ * @param {<T extends unknown>(
+ * 	element: HTMLFormOperationalControlElement,
+ * ) => T} getFormControlPayloadCallback
+ * @param {HTMLFieldSetElement} element
+ * @returns {T | [T]}
+ */
+const getFieldsetValue = (getFormControlPayloadCallback, element) => {
+	const elements = [.../** @type {HTMLFieldSetElement} */ (element).elements];
+	const fieldsetValue = getFormControlsPayload(
+		getFormControlPayloadCallback,
+		.../** @type {HTMLFormControlElement[]} */ (elements),
+	);
+
+	const hasArrayValue = element.name.endsWith(VALUE_AS_ARRAY_IDENTIFIER);
+
+	return /** @type {T} */ (hasArrayValue ? [fieldsetValue] : fieldsetValue);
+};
+
+export { getFieldsetValue };

package/src/packages/get-form-control-payload/helpers/get-form-controls-payload/get-form-controls-payload.d.ts

@@ -0,0 +1,14 @@
+export type HTMLFormOperationalControlElement = import('../../../../libs/types/types.js').HTMLFormOperationalControlElement;
+export type HTMLFormControlElement = import('../../../../libs/types/types.js').HTMLFormControlElement;
+/** @typedef {import('../../../../libs/types/types.js').HTMLFormOperationalControlElement} HTMLFormOperationalControlElement */
+/** @typedef {import('../../../../libs/types/types.js').HTMLFormControlElement} HTMLFormControlElement */
+/**
+ * @template {Record<string, unknown>} T
+ * @param {<T extends unknown>(
+ * 	element: HTMLFormOperationalControlElement,
+ * ) => T} getFormControlPayloadCallback
+ * @param {...HTMLFormControlElement} controlElements
+ * @returns {T}
+ */
+export function getFormControlsPayload<T extends Record<string, unknown>>(getFormControlPayloadCallback: <T_1 extends unknown>(element: HTMLFormOperationalControlElement) => T_1, ...controlElements: HTMLFormControlElement[]): T;
+//# sourceMappingURL=get-form-controls-payload.d.ts.map

package/src/packages/get-form-control-payload/helpers/get-form-controls-payload/get-form-controls-payload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-form-controls-payload.d.ts","sourceRoot":"","sources":["../../../../../../src/packages/get-form-control-payload/helpers/get-form-controls-payload/get-form-controls-payload.js"],"names":[],"mappings":"gDAKc,OAAO,iCAAiC,EAAE,iCAAiC;qCAC3E,OAAO,iCAAiC,EAAE,sBAAsB;AAD9E,+HAA+H;AAC/H,yGAAyG;AAEzG;;;;;;;GAOG;AACH,wIALa,iCAAiC,8BAEhC,sBAAsB,OAgDnC"}

package/src/packages/get-form-control-payload/helpers/get-form-controls-payload/get-form-controls-payload.js

@@ -0,0 +1,64 @@
+import { checkHasValueAsArray } from '../check-has-value-as-array/check-has-value-as-array.helper.js';
+import { checkIsReferToAnotherNode } from '../check-is-refer-to-another-node/check-is-refer-to-another-node.helper.js';
+import { getAllowedElements } from '../get-allowed-elements/get-allowed-elements.helper.js';
+import { getCleanedValueAsArrayControlName } from '../get-cleaned-value-as-array-control-name/get-cleaned-value-as-array-control-name.helper.js';
+
+/** @typedef {import('../../../../libs/types/types.js').HTMLFormOperationalControlElement} HTMLFormOperationalControlElement */
+/** @typedef {import('../../../../libs/types/types.js').HTMLFormControlElement} HTMLFormControlElement */
+
+/**
+ * @template {Record<string, unknown>} T
+ * @param {<T extends unknown>(
+ * 	element: HTMLFormOperationalControlElement,
+ * ) => T} getFormControlPayloadCallback
+ * @param {...HTMLFormControlElement} controlElements
+ * @returns {T}
+ */
+const getFormControlsPayload = (
+	getFormControlPayloadCallback,
+	...controlElements
+) => {
+	const allowedElements = getAllowedElements(controlElements);
+
+	const elementsValues = /** @type {T} */ ({});
+
+	for (const element of allowedElements) {
+		const isReferToAnotherNode = checkIsReferToAnotherNode(
+			element,
+			allowedElements,
+		);
+
+		if (isReferToAnotherNode) {
+			continue;
+		}
+
+		const hasValueAsArray = checkHasValueAsArray(element);
+
+		if (hasValueAsArray) {
+			const key = /** @type {keyof T} */ (
+				getCleanedValueAsArrayControlName(element)
+			);
+			const value = /** @type {T[keyof T]} */ ([
+				.../** @type {unknown[]} */ (elementsValues[key] ?? []),
+				.../** @type {unknown[]} */ (
+					getFormControlPayloadCallback(element)
+				),
+			]);
+
+			elementsValues[key] = value;
+
+			continue;
+		}
+
+		const key = /** @type {keyof T} */ (element.name);
+		const value = /** @type {T[keyof T]} */ (
+			getFormControlPayloadCallback(element)
+		);
+
+		elementsValues[key] = value;
+	}
+
+	return elementsValues;
+};
+
+export { getFormControlsPayload };

package/src/packages/get-form-control-payload/helpers/helpers.d.ts

@@ -5,6 +5,8 @@ export { getCheckboxValue } from "./get-checkbox-value/get-checkbox-value.helper
 export { getCleanedValueAsArrayControlName } from "./get-cleaned-value-as-array-control-name/get-cleaned-value-as-array-control-name.helper.js";
 export { getFormControlValue } from "./get-control-value/get-control-value.helper.js";
 export { getDatetimeLocalValue } from "./get-datatime-local-value/get-datatime-local-value.helper.js";
+export { getFieldsetValue } from "./get-fieldset-value/get-fieldset-value.helper.js";
+export { getFormControlsPayload } from "./get-form-controls-payload/get-form-controls-payload.js";
 export { getInputDateValue } from "./get-input-date-value/get-input-date-value.helper.js";
 export { getInputEmailValue } from "./get-input-email-value/get-input-email-value.helper.js";
 export { getInputFileValue } from "./get-input-file-value/get-input-file-value.helper.js";

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

@@ -5,6 +5,8 @@ export { getCheckboxValue } from './get-checkbox-value/get-checkbox-value.helper
 export { getCleanedValueAsArrayControlName } from './get-cleaned-value-as-array-control-name/get-cleaned-value-as-array-control-name.helper.js';
 export { getFormControlValue } from './get-control-value/get-control-value.helper.js';
 export { getDatetimeLocalValue } from './get-datatime-local-value/get-datatime-local-value.helper.js';
+export { getFieldsetValue } from './get-fieldset-value/get-fieldset-value.helper.js';
+export { getFormControlsPayload } from './get-form-controls-payload/get-form-controls-payload.js';
 export { getInputDateValue } from './get-input-date-value/get-input-date-value.helper.js';
 export { getInputEmailValue } from './get-input-email-value/get-input-email-value.helper.js';
 export { getInputFileValue } from './get-input-file-value/get-input-file-value.helper.js';

package/src/packages/get-form-payload/get-form-payload.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-form-payload.d.ts","sourceRoot":"","sources":["../../../../src/packages/get-form-payload/get-form-payload.js"],"names":[],"mappings":"qCAEc,OAAO,2BAA2B,EAAE,sBAAsB;AAAxE,mGAAmG;AAEnG;;;;GAIG;AACH,4EAHW,eAAe,KASzB"}
+{"version":3,"file":"get-form-payload.d.ts","sourceRoot":"","sources":["../../../../src/packages/get-form-payload/get-form-payload.js"],"names":[],"mappings":"qCAKc,OAAO,2BAA2B,EAAE,sBAAsB;AAAxE,mGAAmG;AAEnG;;;;GAIG;AACH,4EAHW,eAAe,KASzB"}

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

@@ -1,4 +1,7 @@
-import { getFormControlsPayload } from '../get-form-control-payload/get-form-control-payload.js';
+import {
+	getFormControlPayload,
+	getFormControlsPayload,
+} from '../get-form-control-payload/get-form-control-payload.js';
 
 /** @typedef {import('../../libs/types/types.js').HTMLFormControlElement} HTMLFormControlElement */
 
@@ -12,7 +15,7 @@ const getFormPayload = (formNode) => {
 		...formNode.elements,
 	]);
 
-	return getFormControlsPayload(...elements);
+	return getFormControlsPayload(getFormControlPayload, ...elements);
 };
 
 export { getFormPayload };