feat: introduce usePortalModal to PluginLoadedMessage

Author: johannes-lindgren

packages/field-plugin/src/messaging/pluginMessage/pluginToContainerMessage/PluginLoadedMessage.test.ts

@@ -76,6 +76,94 @@ describe('PluginLoadedMessage', () => {
         ).toEqual(false)
       })
     })
+    describe('subscribeState', () => {
+      it('is optional', () => {
+        expect(
+          isPluginLoadedMessage({
+            ...stub,
+            subscribeState: undefined,
+          }),
+        ).toEqual(true)
+      })
+      it('is a boolean', () => {
+        expect(
+          isPluginLoadedMessage({
+            ...stub,
+            subscribeState: true,
+          }),
+        ).toEqual(true)
+        expect(
+          isPluginLoadedMessage({
+            ...stub,
+            subscribeState: false,
+          }),
+        ).toEqual(true)
+        const { subscribeState: _subscribeState, ...subWithoutSubscribeState } = stub
+        expect(isPluginLoadedMessage(subWithoutSubscribeState)).toEqual(true)
+        expect(
+          isPluginLoadedMessage({
+            ...stub,
+            subscribeState: 'false',
+          }),
+        ).toEqual(false)
+        expect(
+          isPluginLoadedMessage({
+            ...stub,
+            subscribeState: 123,
+          }),
+        ).toEqual(false)
+        expect(
+          isPluginLoadedMessage({
+            ...stub,
+            subscribeState: null,
+          }),
+        ).toEqual(false)
+      })
+    })
+    describe('usePortalModal', () => {
+      it('is optional', () => {
+        expect(
+          isPluginLoadedMessage({
+            ...stub,
+            subscribeState: undefined,
+          }),
+        ).toEqual(true)
+      })
+      it('is a boolean', () => {
+        expect(
+          isPluginLoadedMessage({
+            ...stub,
+            subscribeState: true,
+          }),
+        ).toEqual(true)
+        expect(
+          isPluginLoadedMessage({
+            ...stub,
+            subscribeState: false,
+          }),
+        ).toEqual(true)
+        const { subscribeState: _subscribeState, ...subWithoutSubscribeState } = stub
+        expect(isPluginLoadedMessage(subWithoutSubscribeState)).toEqual(true)
+        expect(
+          isPluginLoadedMessage({
+            ...stub,
+            subscribeState: 'false',
+          }),
+        ).toEqual(false)
+        expect(
+          isPluginLoadedMessage({
+            ...stub,
+            subscribeState: 123,
+          }),
+        ).toEqual(false)
+        expect(
+          isPluginLoadedMessage({
+            ...stub,
+            subscribeState: null,
+          }),
+        ).toEqual(false)
+      })
+    })
   })
   describe('constructor', () => {
     it('includes the uid', () => {
@@ -90,5 +178,17 @@ describe('PluginLoadedMessage', () => {
         true,
       )
     })
+    it('sets subscribeState to true', () => {
+      expect(pluginLoadedMessage({ uid, callbackId })).toHaveProperty(
+        'subscribeState',
+        true,
+      )
+    })
+    it('sets usePortalModal to true', () => {
+      expect(pluginLoadedMessage({ uid, callbackId })).toHaveProperty(
+        'usePortalModal',
+        true,
+      )
+    })
   })
 })

packages/field-plugin/src/messaging/pluginMessage/pluginToContainerMessage/PluginLoadedMessage.ts

@@ -5,6 +5,7 @@ export type PluginLoadedMessage = MessageToContainer<'loaded'> & {
   // signals that the field plugin is responsible for its own scrolling in modal mode
   fullHeight?: boolean
   subscribeState?: boolean
+  usePortalModal?: boolean
 }
 export const isPluginLoadedMessage = (
   obj: unknown,
@@ -16,7 +17,10 @@ export const isPluginLoadedMessage = (
     typeof obj.fullHeight === 'boolean') &&
   (!hasKey(obj, 'subscribeState') ||
     typeof obj.subscribeState === 'undefined' ||
-    typeof obj.subscribeState === 'boolean')
+    typeof obj.subscribeState === 'boolean') &&
+  (!hasKey(obj, 'usePortalModal') ||
+    typeof obj.usePortalModal === 'undefined' ||
+    typeof obj.usePortalModal === 'boolean')
 
 export const pluginLoadedMessage = (
   options: Pick<PluginLoadedMessage, 'uid' | 'callbackId'>,
@@ -25,5 +29,6 @@ export const pluginLoadedMessage = (
   event: 'loaded',
   fullHeight: true,
   subscribeState: true,
+  usePortalModal: true,
   ...options,
 })