Metadata modules for PageLayoutTab PageLayoutWidget (#16662)

# Introduction Creating dedicated folders and module for both `page-layout-tab` and `page-layout-widget` The addition diff with deletion is due to the module being added
2025-12-18 12:15:29 +01:00
parent db960cf509
commit 47a8a15598
130 changed files with 301 additions and 238 deletions
@@ -0,0 +1,88 @@
+import { type MessageDescriptor } from '@lingui/core';
+import { msg } from '@lingui/core/macro';
+import { assertUnreachable } from 'twenty-shared/utils';
+
+import { CustomException } from 'src/utils/custom-exception';
+
+export enum PageLayoutWidgetExceptionCode {
+  PAGE_LAYOUT_WIDGET_NOT_FOUND = 'PAGE_LAYOUT_WIDGET_NOT_FOUND',
+  INVALID_PAGE_LAYOUT_WIDGET_DATA = 'INVALID_PAGE_LAYOUT_WIDGET_DATA',
+}
+
+export enum PageLayoutWidgetExceptionMessageKey {
+  PAGE_LAYOUT_WIDGET_NOT_FOUND = 'PAGE_LAYOUT_WIDGET_NOT_FOUND',
+  TITLE_REQUIRED = 'TITLE_REQUIRED',
+  PAGE_LAYOUT_TAB_ID_REQUIRED = 'PAGE_LAYOUT_TAB_ID_REQUIRED',
+  PAGE_LAYOUT_TAB_NOT_FOUND = 'PAGE_LAYOUT_TAB_NOT_FOUND',
+  PAGE_LAYOUT_WIDGET_NOT_DELETED = 'PAGE_LAYOUT_WIDGET_NOT_DELETED',
+  GRID_POSITION_REQUIRED = 'GRID_POSITION_REQUIRED',
+  INVALID_WIDGET_GRID_POSITION = 'INVALID_WIDGET_GRID_POSITION',
+  INVALID_WIDGET_CONFIGURATION = 'INVALID_WIDGET_CONFIGURATION',
+}
+
+const pageLayoutWidgetExceptionUserFriendlyMessages: Record<
+  PageLayoutWidgetExceptionCode,
+  MessageDescriptor
+> = {
+  [PageLayoutWidgetExceptionCode.PAGE_LAYOUT_WIDGET_NOT_FOUND]: msg`Page layout widget not found.`,
+  [PageLayoutWidgetExceptionCode.INVALID_PAGE_LAYOUT_WIDGET_DATA]: msg`Invalid page layout widget data.`,
+};
+
+export class PageLayoutWidgetException extends CustomException<PageLayoutWidgetExceptionCode> {
+  constructor(
+    message: string,
+    code: PageLayoutWidgetExceptionCode,
+    { userFriendlyMessage }: { userFriendlyMessage?: MessageDescriptor } = {},
+  ) {
+    super(message, code, {
+      userFriendlyMessage:
+        userFriendlyMessage ??
+        pageLayoutWidgetExceptionUserFriendlyMessages[code],
+    });
+  }
+}
+
+export const generatePageLayoutWidgetExceptionMessage = (
+  key: PageLayoutWidgetExceptionMessageKey,
+  widgetTitle?: string,
+  widgetType?: string,
+  detailedError?: string,
+): string => {
+  switch (key) {
+    case PageLayoutWidgetExceptionMessageKey.PAGE_LAYOUT_WIDGET_NOT_FOUND:
+      return `Page layout widget with ID "${widgetTitle}" not found`;
+    case PageLayoutWidgetExceptionMessageKey.TITLE_REQUIRED:
+      return 'Page layout widget title is required';
+    case PageLayoutWidgetExceptionMessageKey.PAGE_LAYOUT_TAB_ID_REQUIRED:
+      return 'Page layout tab ID is required';
+    case PageLayoutWidgetExceptionMessageKey.PAGE_LAYOUT_TAB_NOT_FOUND:
+      return 'Page layout tab not found';
+    case PageLayoutWidgetExceptionMessageKey.PAGE_LAYOUT_WIDGET_NOT_DELETED:
+      return 'Page layout widget is not deleted and cannot be restored';
+    case PageLayoutWidgetExceptionMessageKey.GRID_POSITION_REQUIRED:
+      return 'Grid position is required';
+    case PageLayoutWidgetExceptionMessageKey.INVALID_WIDGET_GRID_POSITION:
+      if (widgetTitle && detailedError) {
+        return `Invalid grid position for widget "${widgetTitle}": ${detailedError}`;
+      }
+      if (detailedError) {
+        return `Invalid grid position: ${detailedError}`;
+      }
+
+      return 'Invalid widget grid position';
+    case PageLayoutWidgetExceptionMessageKey.INVALID_WIDGET_CONFIGURATION:
+      if (widgetTitle && widgetType && detailedError) {
+        return `Invalid configuration for widget "${widgetTitle}" of type ${widgetType}: ${detailedError}`;
+      }
+      if (widgetTitle && widgetType) {
+        return `Invalid configuration for widget "${widgetTitle}" of type ${widgetType}`;
+      }
+      if (widgetType) {
+        return `Invalid configuration for widget type ${widgetType}`;
+      }
+
+      return 'Invalid widget configuration';
+    default:
+      assertUnreachable(key);
+  }
+};