[2570] Allow details view to change its content

Bug: eclipse-sirius#2570
Signed-off-by: William Piers <[email protected]>

packages/forms/frontend/sirius-components-forms/src/index.ts

@@ -30,5 +30,8 @@ export * from './propertysections/getTextDecorationLineValue';
 export * from './propertysections/useClickHandler';
 export * from './representations/FormRepresentation';
 export * from './views/DetailsView';
+export * from './views/DetailsViewConfiguration';
+export * from './views/DetailsViewConfiguration.types';
+export * from './views/FormConverter.types';
 export * from './views/RelatedElementsView';
 export * from './views/RepresentationsView';

packages/forms/frontend/sirius-components-forms/src/views/DetailsView.tsx

@@ -11,8 +11,10 @@
  *     Obeo - initial API and implementation
  *******************************************************************************/
 import { WorkbenchViewComponentProps } from '@eclipse-sirius/sirius-components-core';
+import { useDetailsViewConfiguration } from './DetailsViewConfiguration';
 import { FormBasedView } from './FormBasedView';
 
-export const DetailsView = (props: WorkbenchViewComponentProps) => (
-  <FormBasedView {...props} subscriptionName="propertiesEvent" />
-);
+export const DetailsView = (props: WorkbenchViewComponentProps) => {
+  const { converter } = useDetailsViewConfiguration();
+  return <FormBasedView {...props} subscriptionName="propertiesEvent" converter={converter} />;
+};

packages/forms/frontend/sirius-components-forms/src/views/DetailsViewConfiguration.tsx

@@ -0,0 +1,27 @@
+/*******************************************************************************
+ * Copyright (c) 2023 Obeo.
+ * This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v2.0
+ * which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *     Obeo - initial API and implementation
+ *******************************************************************************/
+
+import React from 'react';
+import { DetailsViewConfigurationProps, UseDetailsViewConfigurationValue } from './DetailsViewConfiguration.types';
+import { DetailsViewContext } from './DetailsViewContext';
+
+export const DetailsViewConfiguration = ({ children, converter }: DetailsViewConfigurationProps) => {
+  return <DetailsViewContext.Provider value={{ converter }}>{children}</DetailsViewContext.Provider>;
+};
+
+export const useDetailsViewConfiguration = (): UseDetailsViewConfigurationValue => {
+  const { converter } = React.useContext<UseDetailsViewConfigurationValue>(DetailsViewContext);
+  return {
+    converter,
+  };
+};

packages/forms/frontend/sirius-components-forms/src/views/DetailsViewConfiguration.types.ts

@@ -0,0 +1,24 @@
+/*******************************************************************************
+ * Copyright (c) 2023 Obeo.
+ * This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v2.0
+ * which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *     Obeo - initial API and implementation
+ *******************************************************************************/
+
+import { ReactNode } from 'react';
+import { FormConverter } from './FormConverter.types';
+
+export interface DetailsViewConfigurationProps {
+  converter: FormConverter;
+  children: ReactNode;
+}
+
+export interface UseDetailsViewConfigurationValue {
+  converter: FormConverter;
+}

packages/forms/frontend/sirius-components-forms/src/views/DetailsViewContext.tsx

@@ -0,0 +1,25 @@
+/*******************************************************************************
+ * Copyright (c) 2023 Obeo.
+ * This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v2.0
+ * which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *     Obeo - initial API and implementation
+ *******************************************************************************/
+import React from 'react';
+import { DetailsViewContextValue } from './DetailsViewContext.types';
+import { FormConverter } from './FormConverter.types';
+
+const converter: FormConverter = {
+  convert: (form) => form,
+};
+
+const defaultContext: DetailsViewContextValue = {
+  converter,
+};
+
+export const DetailsViewContext = React.createContext(defaultContext);

packages/forms/frontend/sirius-components-forms/src/views/DetailsViewContext.types.ts

@@ -0,0 +1,17 @@
+/*******************************************************************************
+ * Copyright (c) 2023 Obeo.
+ * This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v2.0
+ * which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *     Obeo - initial API and implementation
+ *******************************************************************************/
+
+import { FormConverter } from './FormConverter.types';
+export interface DetailsViewContextValue {
+  converter: FormConverter;
+}

packages/forms/frontend/sirius-components-forms/src/views/FormBasedView.tsx

@@ -80,6 +80,7 @@ export const FormBasedView = ({
   setSelection,
   readOnly,
   subscriptionName,
+  converter,
 }: FormBasedViewProps) => {
   const classes = useFormBasedViewStyles();
   const [{ value, context }, dispatch] = useMachine<FormBasedViewContext, FormBasedViewEvent>(formBasedViewMachine);
@@ -156,7 +157,7 @@ export const FormBasedView = ({
     content = (
       <Form
         editingContextId={editingContextId}
-        form={form}
+        form={converter.convert(form)}
         widgetSubscriptions={widgetSubscriptions}
         setSelection={setSelection}
         readOnly={readOnly}

packages/forms/frontend/sirius-components-forms/src/views/FormBasedView.types.tsx

@@ -11,11 +11,13 @@
  *     Obeo - initial API and implementation
  *******************************************************************************/
 import { Selection, WorkbenchViewComponentProps } from '@eclipse-sirius/sirius-components-core';
+import { FormConverter } from './FormConverter.types';
 
 export interface FormBasedViewProps extends WorkbenchViewComponentProps {
   editingContextId: string;
   selection: Selection;
   setSelection: (selection: Selection) => void;
   readOnly: boolean;
   subscriptionName: string;
+  converter: FormConverter;
 }

packages/forms/frontend/sirius-components-forms/src/views/FormConverter.types.ts

@@ -0,0 +1,18 @@
+/*******************************************************************************
+ * Copyright (c) 2023 Obeo.
+ * This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v2.0
+ * which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *     Obeo - initial API and implementation
+ *******************************************************************************/
+
+import { GQLForm } from '../form/FormEventFragments.types';
+
+export interface FormConverter {
+  convert(form: GQLForm): GQLForm;
+}