@plusscommunities/pluss-feature-builder-web-a 1.0.2-beta.0

package/src/validators/galleryValidators.js

@@ -0,0 +1,345 @@
+/**
+ * Gallery field validation functions
+ * Provides comprehensive validation for image gallery fields
+ */
+
+/**
+ * Validates minimum number of images
+ * @param {Array} images - Array of image URLs or objects
+ * @param {number} min - Minimum required images
+ * @returns {Object} - Validation result with isValid and message
+ */
+export const minImages = (images, min) => {
+	if (!images || !Array.isArray(images)) {
+		return {
+			isValid: false,
+			message: "No images provided",
+		};
+	}
+
+	const validImages = images.filter((img) => img && img !== "");
+	const isValid = validImages.length >= min;
+
+	return {
+		isValid,
+		message: isValid
+			? ""
+			: `Minimum ${min} image${min > 1 ? "s" : ""} required`,
+	};
+};
+
+/**
+ * Validates maximum number of images
+ * @param {Array} images - Array of image URLs or objects
+ * @param {number} max - Maximum allowed images
+ * @returns {Object} - Validation result with isValid and message
+ */
+export const maxImages = (images, max) => {
+	if (!images || !Array.isArray(images)) {
+		return { isValid: true, message: "" };
+	}
+
+	const validImages = images.filter((img) => img && img !== "");
+	const isValid = validImages.length <= max;
+
+	return {
+		isValid,
+		message: isValid ? "" : `Maximum ${max} image${max > 1 ? "s" : ""} allowed`,
+	};
+};
+
+/**
+ * Validates file size for images (if file objects are provided)
+ * @param {Array} images - Array of image URLs or file objects
+ * @param {number} maxSizeMB - Maximum file size in MB
+ * @returns {Object} - Validation result with isValid and message
+ */
+export const fileSize = (images, maxSizeMB) => {
+	if (!images || !Array.isArray(images)) {
+		return { isValid: true, message: "" };
+	}
+
+	const maxSizeBytes = maxSizeMB * 1024 * 1024;
+
+	for (let i = 0; i < images.length; i++) {
+		const image = images[i];
+
+		// Check if image is a file object with size property
+		if (image && typeof image === "object" && image.size) {
+			if (image.size > maxSizeBytes) {
+				return {
+					isValid: false,
+					message: `Image ${i + 1} exceeds ${maxSizeMB}MB limit`,
+				};
+			}
+		}
+	}
+
+	return { isValid: true, message: "" };
+};
+
+/**
+ * Validates file types for images
+ * @param {Array} images - Array of image URLs or file objects
+ * @param {string[]} allowedTypes - Array of allowed MIME types
+ * @returns {Object} - Validation result with isValid and message
+ */
+export const fileType = (images, allowedTypes) => {
+	if (
+		!images ||
+		!Array.isArray(images) ||
+		!allowedTypes ||
+		!Array.isArray(allowedTypes)
+	) {
+		return { isValid: true, message: "" };
+	}
+
+	const allowedExtensions = allowedTypes.flatMap((type) => {
+		// Convert MIME types to extensions for basic validation
+		if (type.includes("jpeg")) return ["jpg", "jpeg"];
+		if (type.includes("png")) return ["png"];
+		if (type.includes("webp")) return ["webp"];
+		if (type.includes("gif")) return ["gif"];
+		return [];
+	});
+
+	for (let i = 0; i < images.length; i++) {
+		const image = images[i];
+
+		if (image && typeof image === "object") {
+			// Check file object type
+			if (image.type && !allowedTypes.includes(image.type)) {
+				return {
+					isValid: false,
+					message: `Image ${i + 1} has unsupported file type`,
+				};
+			}
+		} else if (typeof image === "string") {
+			// Check URL extension (basic validation)
+			const extension = image.split(".").pop()?.toLowerCase();
+			if (extension && !allowedExtensions.includes(extension)) {
+				return {
+					isValid: false,
+					message: `Image ${i + 1} has unsupported file type`,
+				};
+			}
+		}
+	}
+
+	return { isValid: true, message: "" };
+};
+
+/**
+ * Validates aspect ratio for images (basic validation for file objects with dimensions)
+ * @param {Array} images - Array of image URLs or file objects
+ * @param {string} requiredRatio - Required aspect ratio ('16:9', '4:3', '1:1', 'any')
+ * @returns {Object} - Validation result with isValid and message
+ */
+export const aspectRatio = (images, requiredRatio) => {
+	if (
+		!images ||
+		!Array.isArray(images) ||
+		!requiredRatio ||
+		requiredRatio === "any"
+	) {
+		return { isValid: true, message: "" };
+	}
+
+	// Parse required aspect ratio
+	const ratioMap = {
+		"16:9": 16 / 9,
+		"4:3": 4 / 3,
+		"1:1": 1,
+		square: 1,
+		landscape: 16 / 9,
+		portrait: 3 / 4,
+	};
+
+	const targetRatio = ratioMap[requiredRatio.toLowerCase()];
+	if (!targetRatio) {
+		return { isValid: true, message: "" }; // Unknown ratio, skip validation
+	}
+
+	for (let i = 0; i < images.length; i++) {
+		const image = images[i];
+
+		// Only validate if we have dimension information (file objects with naturalWidth/Height)
+		if (image && typeof image === "object") {
+			if (image.naturalWidth && image.naturalHeight) {
+				const imageRatio = image.naturalWidth / image.naturalHeight;
+				const tolerance = 0.1; // 10% tolerance
+
+				if (Math.abs(imageRatio - targetRatio) > tolerance) {
+					return {
+						isValid: false,
+						message: `Image ${i + 1} does not match required aspect ratio (${requiredRatio})`,
+					};
+				}
+			}
+		}
+	}
+
+	return { isValid: true, message: "" };
+};
+
+/**
+ * Validates required field (at least one image)
+ * @param {Array} images - Array of image URLs or objects
+ * @returns {Object} - Validation result with isValid and message
+ */
+export const required = (images) => {
+	if (!images || !Array.isArray(images)) {
+		return {
+			isValid: false,
+			message: "This field is required",
+		};
+	}
+
+	const validImages = images.filter((img) => img && img !== "");
+	const isValid = validImages.length > 0;
+
+	return {
+		isValid,
+		message: isValid ? "" : "At least one image is required",
+	};
+};
+
+/**
+ * Detects duplicate images in array
+ * @param {Array} images - Array of image URLs or objects
+ * @returns {Object} - Validation result with isValid and message
+ */
+export const noDuplicates = (images) => {
+	if (!images || !Array.isArray(images)) {
+		return { isValid: true, message: "" };
+	}
+
+	const validImages = images.filter((img) => img && img !== "");
+	const uniqueImages = [...new Set(validImages)];
+
+	const hasDuplicates = validImages.length !== uniqueImages.length;
+
+	return {
+		isValid: !hasDuplicates,
+		message: hasDuplicates ? "Duplicate images detected" : "",
+	};
+};
+
+/**
+ * Comprehensive gallery field validation
+ * @param {Array} images - Array of image URLs or objects
+ * @param {Object} rules - Validation rules object
+ * @param {boolean} rules.isRequired - Whether field is required
+ * @param {number} rules.minImages - Minimum number of images
+ * @param {number} rules.maxImages - Maximum number of images
+ * @param {string} rules.maxFileSize - Maximum file size (e.g., "5MB")
+ * @param {string[]} rules.allowedTypes - Allowed file types
+ * @param {string} rules.aspectRatio - Required aspect ratio
+ * @param {Function[]} rules.customRules - Custom validation functions
+ * @returns {Object} - Validation result with isValid, errors, and warnings
+ */
+export const validateGallery = (images, rules = {}) => {
+	const errors = [];
+	const warnings = [];
+
+	// Required validation
+	if (rules.isRequired) {
+		const requiredResult = required(images);
+		if (!requiredResult.isValid) {
+			errors.push(requiredResult.message);
+		}
+	}
+
+	// Only validate other rules if there are images or field is required
+	const hasImages = images && images.length > 0;
+	if (!hasImages && !rules.isRequired) {
+		return { isValid: true, errors: [], warnings: [] };
+	}
+
+	// Minimum images validation
+	if (rules.minImages) {
+		const minResult = minImages(images, rules.minImages);
+		if (!minResult.isValid) {
+			errors.push(minResult.message);
+		}
+	}
+
+	// Maximum images validation
+	if (rules.maxImages) {
+		const maxResult = maxImages(images, rules.maxImages);
+		if (!maxResult.isValid) {
+			errors.push(maxResult.message);
+		}
+	}
+
+	// File size validation
+	if (rules.maxFileSize) {
+		const sizeMB = parseFloat(rules.maxFileSize.replace(/[^0-9.]/g, ""));
+		const sizeResult = fileSize(images, sizeMB || 5);
+		if (!sizeResult.isValid) {
+			errors.push(sizeResult.message);
+		}
+	}
+
+	// File type validation
+	if (rules.allowedTypes && rules.allowedTypes.length > 0) {
+		const typeResult = fileType(images, rules.allowedTypes);
+		if (!typeResult.isValid) {
+			errors.push(typeResult.message);
+		}
+	}
+
+	// Aspect ratio validation
+	if (rules.aspectRatio && rules.aspectRatio !== "any") {
+		const ratioResult = aspectRatio(images, rules.aspectRatio);
+		if (!ratioResult.isValid) {
+			warnings.push(ratioResult.message); // Make aspect ratio a warning since it's harder to enforce
+		}
+	}
+
+	// Duplicate validation
+	const duplicateResult = noDuplicates(images);
+	if (!duplicateResult.isValid) {
+		warnings.push(duplicateResult.message);
+	}
+
+	// Custom validation rules
+	if (rules.customRules && Array.isArray(rules.customRules)) {
+		for (const customRule of rules.customRules) {
+			if (typeof customRule === "function") {
+				try {
+					const customResult = customRule(images);
+					if (customResult && typeof customResult === "object") {
+						if (!customResult.isValid) {
+							if (customResult.severity === "warning") {
+								warnings.push(customResult.message);
+							} else {
+								errors.push(customResult.message);
+							}
+						}
+					}
+				} catch (error) {
+					// Custom validation rule failed
+				}
+			}
+		}
+	}
+
+	return {
+		isValid: errors.length === 0,
+		errors,
+		warnings,
+	};
+};
+
+// Export individual validators for specific use cases
+export default {
+	minImages,
+	maxImages,
+	fileSize,
+	fileType,
+	aspectRatio,
+	required,
+	noDuplicates,
+	validateGallery,
+};

package/src/values.config.a.js

@@ -0,0 +1,49 @@
+/*
+  "values" defines configurable options for this extension.
+   It can be swapped prior to publishing via copy:set
+*/
+export const values = {
+	featureKey: "feature-builder-a",
+	featureKeyRoute: "/feature-builder-a", // Dynamic route prefix
+	featureId: "feature-builder-a-default", // Fixed ID for the single feature definition
+	reducerKey: "featureBuilderA", // Define reducer 'slice' key.
+	singularName: "Build Your Feature A",
+	description: "Create custom forms for mobile application (Variant A).",
+	emptyText: "No custom forms available",
+	textMenuTitle: "Build Your Feature A",
+	textPermissionFeatureBuilderDefinition: "Build Your Feature A Definition",
+	textPermissionFeatureBuilderContent:
+		"Create and Manage Content in Build Your Feature A",
+
+	// Routes
+	routeFormOverviewStep: "/feature-builder-a/definition/overview",
+	routeFormFieldsStep: "/feature-builder-a/definition/fields",
+	routeFormLayoutStep: "/feature-builder-a/definition/layout",
+	routeListingScreen: "/feature-builder-a/listing",
+	routeCreateListing: "/feature-builder-a/listing/create",
+
+	routeEditListing: "/feature-builder-a/listing/edit/:id",
+
+	// Screen names
+	screenFormOverviewStep: "FormOverviewStepA",
+	screenFormFieldsStep: "FormFieldsStepA",
+	screenFormLayoutStep: "FormLayoutStepA",
+	screenListingScreen: "ListingScreenA",
+
+	// Page names
+	pageCreateListing: "CreateListingPageA",
+	pageEditListing: "EditListingPageA",
+
+	// Permissions
+	permissionFeatureBuilderDefinition: "featureBuilderDefinitionA",
+	permissionFeatureBuilderContent: "featureBuilderContentA",
+
+	// Menu
+	menuIcon: "tool",
+	menuKey: "feature-builder-definition-a",
+	menuIsFontAwesome: true,
+	menuOrder: 20, // Lower number = higher priority
+
+	// Default Values
+	defaultIcon: "star",
+};

package/src/values.config.b.js

@@ -0,0 +1,49 @@
+/*
+  "values" defines configurable options for this extension.
+   It can be swapped prior to publishing via copy:set
+*/
+export const values = {
+	featureKey: "feature-builder-b",
+	featureKeyRoute: "/feature-builder-b", // Dynamic route prefix
+	featureId: "feature-builder-b-default", // Fixed ID for the single feature definition
+	reducerKey: "featureBuilderB", // Define reducer 'slice' key.
+	singularName: "Build Your Feature B",
+	description: "Create custom forms for mobile application (Variant B).",
+	emptyText: "No custom forms available",
+	textMenuTitle: "Build Your Feature B",
+	textPermissionFeatureBuilderDefinition: "Build Your Feature B Definition",
+	textPermissionFeatureBuilderContent:
+		"Create and Manage Content in Build Your Feature B",
+
+	// Routes
+	routeFormOverviewStep: "/feature-builder-b/definition/overview",
+	routeFormFieldsStep: "/feature-builder-b/definition/fields",
+	routeFormLayoutStep: "/feature-builder-b/definition/layout",
+	routeListingScreen: "/feature-builder-b/listing",
+	routeCreateListing: "/feature-builder-b/listing/create",
+
+	routeEditListing: "/feature-builder-b/listing/edit/:id",
+
+	// Screen names
+	screenFormOverviewStep: "FormOverviewStepB",
+	screenFormFieldsStep: "FormFieldsStepB",
+	screenFormLayoutStep: "FormLayoutStepB",
+	screenListingScreen: "ListingScreenB",
+
+	// Page names
+	pageCreateListing: "CreateListingPageB",
+	pageEditListing: "EditListingPageB",
+
+	// Permissions
+	permissionFeatureBuilderDefinition: "featureBuilderDefinitionB",
+	permissionFeatureBuilderContent: "featureBuilderContentB",
+
+	// Menu
+	menuIcon: "tool",
+	menuKey: "feature-builder-definition-b",
+	menuIsFontAwesome: true,
+	menuOrder: 20, // Lower number = higher priority
+
+	// Default Values
+	defaultIcon: "star",
+};

package/src/values.config.c.js

@@ -0,0 +1,49 @@
+/*
+  "values" defines configurable options for this extension.
+   It can be swapped prior to publishing via copy:set
+*/
+export const values = {
+	featureKey: "feature-builder-c",
+	featureKeyRoute: "/feature-builder-c", // Dynamic route prefix
+	featureId: "feature-builder-c-default", // Fixed ID for the single feature definition
+	reducerKey: "featureBuilderC", // Define reducer 'slice' key.
+	singularName: "Build Your Feature C",
+	description: "Create custom forms for mobile application (Variant C).",
+	emptyText: "No custom forms available",
+	textMenuTitle: "Build Your Feature C",
+	textPermissionFeatureBuilderDefinition: "Build Your Feature C Definition",
+	textPermissionFeatureBuilderContent:
+		"Create and Manage Content in Build Your Feature C",
+
+	// Routes
+	routeFormOverviewStep: "/feature-builder-c/definition/overview",
+	routeFormFieldsStep: "/feature-builder-c/definition/fields",
+	routeFormLayoutStep: "/feature-builder-c/definition/layout",
+	routeListingScreen: "/feature-builder-c/listing",
+	routeCreateListing: "/feature-builder-c/listing/create",
+
+	routeEditListing: "/feature-builder-c/listing/edit/:id",
+
+	// Screen names
+	screenFormOverviewStep: "FormOverviewStepC",
+	screenFormFieldsStep: "FormFieldsStepC",
+	screenFormLayoutStep: "FormLayoutStepC",
+	screenListingScreen: "ListingScreenC",
+
+	// Page names
+	pageCreateListing: "CreateListingPageC",
+	pageEditListing: "EditListingPageC",
+
+	// Permissions
+	permissionFeatureBuilderDefinition: "featureBuilderDefinitionC",
+	permissionFeatureBuilderContent: "featureBuilderContentC",
+
+	// Menu
+	menuIcon: "tool",
+	menuKey: "feature-builder-definition-c",
+	menuIsFontAwesome: true,
+	menuOrder: 20, // Lower number = higher priority
+
+	// Default Values
+	defaultIcon: "star",
+};

package/src/values.config.d.js

@@ -0,0 +1,49 @@
+/*
+  "values" defines configurable options for this extension.
+   It can be swapped prior to publishing via copy:set
+*/
+export const values = {
+	featureKey: "feature-builder-d",
+	featureKeyRoute: "/feature-builder-d", // Dynamic route prefix
+	featureId: "feature-builder-d-default", // Fixed ID for the single feature definition
+	reducerKey: "featureBuilderD", // Define reducer 'slice' key.
+	singularName: "Build Your Feature D",
+	description: "Create custom forms for mobile application (Variant D).",
+	emptyText: "No custom forms available",
+	textMenuTitle: "Build Your Feature D",
+	textPermissionFeatureBuilderDefinition: "Build Your Feature D Definition",
+	textPermissionFeatureBuilderContent:
+		"Create and Manage Content in Build Your Feature D",
+
+	// Routes
+	routeFormOverviewStep: "/feature-builder-d/definition/overview",
+	routeFormFieldsStep: "/feature-builder-d/definition/fields",
+	routeFormLayoutStep: "/feature-builder-d/definition/layout",
+	routeListingScreen: "/feature-builder-d/listing",
+	routeCreateListing: "/feature-builder-d/listing/create",
+
+	routeEditListing: "/feature-builder-d/listing/edit/:id",
+
+	// Screen names
+	screenFormOverviewStep: "FormOverviewStepD",
+	screenFormFieldsStep: "FormFieldsStepD",
+	screenFormLayoutStep: "FormLayoutStepD",
+	screenListingScreen: "ListingScreenD",
+
+	// Page names
+	pageCreateListing: "CreateListingPageD",
+	pageEditListing: "EditListingPageD",
+
+	// Permissions
+	permissionFeatureBuilderDefinition: "featureBuilderDefinitionD",
+	permissionFeatureBuilderContent: "featureBuilderContentD",
+
+	// Menu
+	menuIcon: "tool",
+	menuKey: "feature-builder-definition-d",
+	menuIsFontAwesome: true,
+	menuOrder: 20, // Lower number = higher priority
+
+	// Default Values
+	defaultIcon: "star",
+};

package/src/values.config.js

@@ -0,0 +1,49 @@
+/*
+  "values" defines configurable options for this extension.
+   It can be swapped prior to publishing via copy:set
+*/
+export const values = {
+	featureKey: "feature-builder-a",
+	featureKeyRoute: "/feature-builder-a", // Dynamic route prefix
+	featureId: "feature-builder-a-default", // Fixed ID for the single feature definition
+	reducerKey: "featureBuilderA", // Define reducer 'slice' key.
+	singularName: "Build Your Feature A",
+	description: "Create custom forms for mobile application (Variant A).",
+	emptyText: "No custom forms available",
+	textMenuTitle: "Build Your Feature A",
+	textPermissionFeatureBuilderDefinition: "Build Your Feature A Definition",
+	textPermissionFeatureBuilderContent:
+		"Create and Manage Content in Build Your Feature A",
+
+	// Routes
+	routeFormOverviewStep: "/feature-builder-a/definition/overview",
+	routeFormFieldsStep: "/feature-builder-a/definition/fields",
+	routeFormLayoutStep: "/feature-builder-a/definition/layout",
+	routeListingScreen: "/feature-builder-a/listing",
+	routeCreateListing: "/feature-builder-a/listing/create",
+
+	routeEditListing: "/feature-builder-a/listing/edit/:id",
+
+	// Screen names
+	screenFormOverviewStep: "FormOverviewStepA",
+	screenFormFieldsStep: "FormFieldsStepA",
+	screenFormLayoutStep: "FormLayoutStepA",
+	screenListingScreen: "ListingScreenA",
+
+	// Page names
+	pageCreateListing: "CreateListingPageA",
+	pageEditListing: "EditListingPageA",
+
+	// Permissions
+	permissionFeatureBuilderDefinition: "featureBuilderDefinitionA",
+	permissionFeatureBuilderContent: "featureBuilderContentA",
+
+	// Menu
+	menuIcon: "tool",
+	menuKey: "feature-builder-definition-a",
+	menuIsFontAwesome: true,
+	menuOrder: 20, // Lower number = higher priority
+
+	// Default Values
+	defaultIcon: "star",
+};

package/src/webapi/featuresActions.js

@@ -0,0 +1,90 @@
+import { PlussCore } from "../feature.config";
+const { Helper, Session } = PlussCore;
+
+const { getUrl } = Helper;
+const { authedFunction } = Session;
+
+export const featureDefinitionActions = {
+	/**
+	 * Get the single feature definition by ID
+	 * Path: {id}
+	 */
+	getSingle: async (id, site) => {
+		const query = { id, site };
+		return authedFunction({
+			method: "GET",
+			url: getUrl("feature-builder", "definition/get/single", query),
+		});
+	},
+
+	/**
+	 * Creates a new feature definition with the provided configuration
+	 *
+	 * @param {string} id - The unique identifier for the new feature definition
+	 * @param {string} site - The site ID where the feature definition will be created
+	 * @param {FeatureDefinition} featureDefinition - The feature definition data to create
+	 * @returns {Promise<ApiResponse>} Promise resolving to API response with created feature definition
+	 * @throws {Error} When creation fails due to validation or API errors
+	 *
+	 */
+	create: async (id, site, featureDefinition) => {
+		return authedFunction({
+			method: "POST",
+			url: getUrl("feature-builder", "definition/update/create"),
+			data: { id, site, featureDefinition },
+		});
+	},
+
+	/**
+	 * Updates an existing feature definition with new configuration
+	 *
+	 * @param {FeatureDefinition} featureDefinitionData - The updated feature definition data
+	 * @param {string} featureDefinitionData.id - The unique identifier of the feature definition to update
+	 * @param {string} [featureDefinitionData.displayName] - Updated display name
+	 * @param {Field[]} [featureDefinitionData.fields] - Updated field definitions
+	 * @param {Object} [featureDefinitionData.layout] - Updated layout configuration
+	 * @param {string} site - The site ID where the feature definition exists
+	 * @returns {Promise<ApiResponse>} Promise resolving to API response with updated feature definition
+	 * @throws {Error} When update fails due to validation or API errors
+	 *
+	 * @example
+	 * try {
+	 *   const response = await featureDefinitionActions.edit(
+	 *     {
+	 *       id: 'feature-123',
+	 *       displayName: 'Updated Form',
+	 *       fields: [...]
+	 *     },
+	 *     'site-123'
+	 *   );
+	 */
+	edit: async (featureDefinitionData, site) => {
+		// Ensure site is included in the request body
+		const dataWithSite = {
+			site: site,
+			...featureDefinitionData,
+		};
+		return authedFunction({
+			method: "POST",
+			url: getUrl("feature-builder", "definition/update/edit"),
+			data: dataWithSite,
+		});
+	},
+
+	/**
+	 * Soft deletes a feature definition (marks as deleted but doesn't permanently remove)
+	 *
+	 * @param {string} id - The unique identifier of the feature definition to delete
+	 * @param {string} site - The site ID where the feature definition exists
+	 * @returns {Promise<ApiResponse>} Promise resolving to API response confirming deletion
+	 * @throws {Error} When deletion fails or feature definition is not found
+	 *
+	 */
+	delete: async (id, site) => {
+		return authedFunction({
+			method: "POST",
+			url: getUrl("feature-builder", "definition/update/delete"),
+			data: { id, site },
+		});
+	},
+};

package/src/webapi/helper.js

@@ -0,0 +1,4 @@
+import { PlussCore } from "../feature.config";
+
+const { Helper } = PlussCore;
+export const getUrl = Helper.getUrl;