validate.js

/**
 * Validates if the given response is a valid CCXF object.
 *
 * CCXF (Clickswave Common Exchange Format) requires the response to follow:
 * {
 *   status: number (HTTP status code),
 *   message: string,
 *   errors: array,
 *   data: object
 * }
 *
 * Rules:
 *  1. All fields must exist with correct types.
 *  2. `errors` must always be an array.
 *  3. If `status >= 400`, `errors` must contain at least one entry.
 *
 * @param {object} response - The API response to validate.
 * @returns {boolean} - True if valid, otherwise false.
 */
export const validateCCXF = (response) => {
	if (typeof response !== "object" || response === null) {
		return false;
	}

	// Required keys and their expected types
	const types = {
		status: "number",
		message: "string",
		errors: "object",
		data: "object"
	};

	// Check existence and type correctness
	for (const key of Object.keys(types)) {
		if (!(key in response)) return false;

		const expectedType = types[key];
		const actualType = typeof response[key];

		// Special case for errors array
		if (key === "errors") {
			if (!Array.isArray(response.errors)) {
				return false;
			}
		} else if (actualType !== expectedType || response[key] === null) {
			return false;
		}
	}

	// If status >= 400, errors must have at least one item
	if (response.status >= 400 && response.errors.length === 0) {
		return false;
	}

	return true;
};