feat(feo): add widget rehistry interceptor

navnotes.md

@@ -40,3 +40,9 @@ search entries need a `frontendRef` attribute. Without the attribute, we can mod
 ## frontendRef
 
 Service tile entries need a `frontendRef` attribute. Without the attribute, we can modify/add frontend entries, but we can't remove them
+
+# Widget registry interceptor
+
+## frontendRef
+
+Widget registry entries need a `frontendRef` attribute. Without the attribute, we can modify/add frontend entries, but we can't remove them

packages/config-utils/src/feo/feo-types.ts

@@ -113,6 +113,13 @@ export type ServiceCategory = {
   id: string;
   groups: ServiceGroup[];
 };
+
+export type ChromeWidgetEntry = {
+  scope: string;
+  module: string;
+  frontendRef: string;
+};
+
 export type CRDObject = {
   metadata: {
     name: string;
@@ -123,6 +130,7 @@ export type CRDObject = {
     module: ChromeModule;
     searchEntries?: ChromeStaticSearchEntry[];
     serviceTiles?: ServiceTile[];
+    widgetRegistry?: ChromeWidgetEntry[];
   };
 };
 

packages/config-utils/src/feo/widget-registry-interceptor.test.ts

@@ -0,0 +1,35 @@
+import { FrontendCRD } from './feo-types';
+import widgetRegistryInterceptor from './widget-registry-interceptor';
+
+describe('Widget registry interceptor', () => {
+  it('should replace the widget registry with the one from the server', () => {
+    const frontendName = 'name';
+    const widgetEntries = [
+      { module: 'module1', scope: 'scope1', frontendRef: frontendName },
+      { module: 'module1', scope: 'scope2', frontendRef: frontendName },
+      { module: 'module2', scope: 'scope1', frontendRef: 'foo' },
+    ];
+    const frontendCrd: FrontendCRD = {
+      objects: [
+        {
+          metadata: {
+            name: 'name',
+          },
+          spec: {
+            module: {
+              manifestLocation: 'location',
+            },
+            widgetRegistry: [{ module: 'module1', scope: 'scope1', frontendRef: frontendName }],
+          },
+        },
+      ],
+    };
+
+    const result = widgetRegistryInterceptor(widgetEntries, frontendCrd);
+
+    expect(result).toEqual([
+      { module: 'module2', scope: 'scope1', frontendRef: 'foo' },
+      { module: 'module1', scope: 'scope1', frontendRef: frontendName },
+    ]);
+  });
+});

packages/config-utils/src/feo/widget-registry-interceptor.ts

@@ -0,0 +1,10 @@
+import { ChromeWidgetEntry, FrontendCRD } from './feo-types';
+
+function widgetRegistryInterceptor(widgetEntries: ChromeWidgetEntry[], frontendCrd: FrontendCRD): ChromeWidgetEntry[] {
+  const frontendName = frontendCrd.objects[0].metadata.name;
+  const result = widgetEntries.filter((entry) => entry.frontendRef !== frontendName);
+
+  return [...result, ...(frontendCrd.objects[0].spec.widgetRegistry ?? [])];
+}
+
+export default widgetRegistryInterceptor;