Add front component widget (#17440)

Modified the data model and introduced a seed to introduce front components widgets.
2026-01-26 13:45:58 +01:00
parent e0d4492013
commit 7e7a535af0
36 changed files with 596 additions and 190 deletions
@@ -0,0 +1,39 @@
+import { msg, t } from '@lingui/core/macro';
+import { isDefined } from 'twenty-shared/utils';
+
+import { type FlatPageLayoutWidgetValidationError } from 'src/engine/metadata-modules/flat-page-layout-widget/types/flat-page-layout-widget-validation-error.type';
+import { type FrontComponentConfigurationDTO } from 'src/engine/metadata-modules/page-layout-widget/dtos/front-component-configuration.dto';
+import { WidgetConfigurationType } from 'src/engine/metadata-modules/page-layout-widget/enums/widget-configuration-type.type';
+import { PageLayoutWidgetExceptionCode } from 'src/engine/metadata-modules/page-layout-widget/exceptions/page-layout-widget.exception';
+
+export const validateFrontComponentConfigurationType = (
+  configuration: FrontComponentConfigurationDTO,
+  widgetTitle: string,
+): FlatPageLayoutWidgetValidationError[] => {
+  const errors: FlatPageLayoutWidgetValidationError[] = [];
+
+  if (!isDefined(configuration.configurationType)) {
+    errors.push({
+      code: PageLayoutWidgetExceptionCode.INVALID_PAGE_LAYOUT_WIDGET_DATA,
+      message: t`Configuration type is required for widget "${widgetTitle}"`,
+      userFriendlyMessage: msg`Configuration type is required`,
+    });
+
+    return errors;
+  }
+
+  if (
+    configuration.configurationType !== WidgetConfigurationType.FRONT_COMPONENT
+  ) {
+    const configurationTypeString = String(configuration.configurationType);
+
+    errors.push({
+      code: PageLayoutWidgetExceptionCode.INVALID_PAGE_LAYOUT_WIDGET_DATA,
+      message: t`Invalid configuration type for front component widget "${widgetTitle}". Expected FRONT_COMPONENT, got ${configurationTypeString}`,
+      userFriendlyMessage: msg`Invalid configuration type for front component widget`,
+      value: configuration.configurationType,
+    });
+  }
+
+  return errors;
+};
@@ -0,0 +1,38 @@
+import { msg, t } from '@lingui/core/macro';
+import { isDefined } from 'twenty-shared/utils';
+
+import { type ValidateFlatPageLayoutWidgetTypeSpecificitiesForCreationArgs } from 'src/engine/metadata-modules/flat-page-layout-widget/services/flat-page-layout-widget-type-validator.service';
+import { type FlatPageLayoutWidgetValidationError } from 'src/engine/metadata-modules/flat-page-layout-widget/types/flat-page-layout-widget-validation-error.type';
+import { validateFrontComponentConfigurationType } from 'src/engine/metadata-modules/flat-page-layout-widget/validators/utils/validate-front-component-configuration-type.util';
+import { type FrontComponentConfigurationDTO } from 'src/engine/metadata-modules/page-layout-widget/dtos/front-component-configuration.dto';
+import { PageLayoutWidgetExceptionCode } from 'src/engine/metadata-modules/page-layout-widget/exceptions/page-layout-widget.exception';
+
+export const validateFrontComponentFlatPageLayoutWidgetForCreation = (
+  args: ValidateFlatPageLayoutWidgetTypeSpecificitiesForCreationArgs,
+): FlatPageLayoutWidgetValidationError[] => {
+  const { flatEntityToValidate } = args;
+  const { configuration, title } = flatEntityToValidate;
+  const errors: FlatPageLayoutWidgetValidationError[] = [];
+
+  if (!isDefined(configuration)) {
+    errors.push({
+      code: PageLayoutWidgetExceptionCode.INVALID_PAGE_LAYOUT_WIDGET_DATA,
+      message: t`Configuration is required for front component widget "${title}"`,
+      userFriendlyMessage: msg`Configuration is required for front component widget`,
+    });
+
+    return errors;
+  }
+
+  const frontComponentConfiguration =
+    configuration as FrontComponentConfigurationDTO;
+
+  const configurationTypeErrors = validateFrontComponentConfigurationType(
+    frontComponentConfiguration,
+    title,
+  );
+
+  errors.push(...configurationTypeErrors);
+
+  return errors;
+};
@@ -0,0 +1,30 @@
+import { isDefined } from 'twenty-shared/utils';
+
+import { type ValidateFlatPageLayoutWidgetTypeSpecificitiesForUpdateArgs } from 'src/engine/metadata-modules/flat-page-layout-widget/services/flat-page-layout-widget-type-validator.service';
+import { type FlatPageLayoutWidgetValidationError } from 'src/engine/metadata-modules/flat-page-layout-widget/types/flat-page-layout-widget-validation-error.type';
+import { validateFrontComponentConfigurationType } from 'src/engine/metadata-modules/flat-page-layout-widget/validators/utils/validate-front-component-configuration-type.util';
+import { type FrontComponentConfigurationDTO } from 'src/engine/metadata-modules/page-layout-widget/dtos/front-component-configuration.dto';
+
+export const validateFrontComponentFlatPageLayoutWidgetForUpdate = (
+  args: ValidateFlatPageLayoutWidgetTypeSpecificitiesForUpdateArgs,
+): FlatPageLayoutWidgetValidationError[] => {
+  const { flatEntityToValidate } = args;
+  const { configuration, title } = flatEntityToValidate;
+  const errors: FlatPageLayoutWidgetValidationError[] = [];
+
+  if (!isDefined(configuration)) {
+    return [];
+  }
+
+  const frontComponentConfiguration =
+    configuration as FrontComponentConfigurationDTO;
+
+  const configurationTypeErrors = validateFrontComponentConfigurationType(
+    frontComponentConfiguration,
+    title,
+  );
+
+  errors.push(...configurationTypeErrors);
+
+  return errors;
+};