feat(SHAPE-8085): apply review feedback

storyblok · Jan 17, 2025 · 3f85b24 · 3f85b24
1 parent f8fd00b
commit 3f85b24
Show file tree

Hide file tree

Showing 7 changed files with 54 additions and 63 deletions.
diff --git a/packages/demo/src/components/PromptAI.tsx b/packages/demo/src/components/PromptAI.tsx
@@ -2,7 +2,7 @@ import {
   Button,
   Checkbox,
   FormControl,
-  FormLabel,
+  FormControlLabel,
   MenuItem,
   Stack,
   TextField,
@@ -84,13 +84,15 @@ export const PromptAI: PluginComponent = (props) => {
           onChange={(e) => setPromptTone(e.target.value)}
         />
         <FormControl>
-          <FormLabel htmlFor="based-on-current-story-checkbox">
-            Based on the current story:
-          </FormLabel>
-          <Checkbox
-            id="based-on-current-story-checkbox"
-            value={promptBasedOnCurrentStory}
-            onChange={(e) => setPromptBasedOnCurrentStory(e.target.checked)}
+          <FormControlLabel
+            label="Based on the current story"
+            control={
+              <Checkbox
+                value={promptBasedOnCurrentStory}
+                onChange={(e) => setPromptBasedOnCurrentStory(e.target.checked)}
+              />
+            }
+            sx={{ ml: '-9px' }}
           />
         </FormControl>
         <Typography>

diff --git a/packages/field-plugin/src/createFieldPlugin/createPluginActions/createPluginActions.test.ts b/packages/field-plugin/src/createFieldPlugin/createPluginActions/createPluginActions.test.ts
@@ -260,7 +260,7 @@ describe('createPluginActions', () => {
       expect(postToContainer).toHaveBeenLastCalledWith(
         expect.objectContaining({
           event: 'promptAI',
-          payload: promptAIPayload,
+          promptAIPayload,
         } satisfies Partial<PluginPromptAIMessage>),
       )
     })

diff --git a/packages/field-plugin/src/createFieldPlugin/createPluginActions/createPluginActions.ts b/packages/field-plugin/src/createFieldPlugin/createPluginActions/createPluginActions.ts
@@ -8,16 +8,16 @@ import {
   getUserContextMessage,
   heightChangeMessage,
   modalChangeMessage,
-  OnAssetSelectMessage,
-  OnContextRequestMessage,
-  OnUserContextRequestMessage,
-  OnLoadedMessage,
-  OnStateChangeMessage,
-  OnUnknownPluginMessage,
   pluginLoadedMessage,
   getPluginPromptAIMessage,
   valueChangeMessage,
-  OnPromptAIMessage,
+  type OnAssetSelectMessage,
+  type OnContextRequestMessage,
+  type OnUserContextRequestMessage,
+  type OnLoadedMessage,
+  type OnStateChangeMessage,
+  type OnUnknownPluginMessage,
+  type OnPromptAIMessage,
   type PromptAIPayload,
 } from '../../messaging'
 import { FieldPluginActions, Initialize } from '../FieldPluginActions'

diff --git a/...teFieldPlugin/createPluginActions/createPluginMessageListener/handlePluginMessage.test.ts b/...teFieldPlugin/createPluginActions/createPluginMessageListener/handlePluginMessage.test.ts
@@ -160,8 +160,8 @@ describe('handlePluginMessage', () => {
     expect(callbacks.onLoaded).not.toHaveBeenCalled()
     expect(callbacks.onStateChange).not.toHaveBeenCalled()
     expect(callbacks.onContextRequest).not.toHaveBeenCalled()
-    expect(callbacks.onAssetSelect).not.toHaveBeenCalledWith(data)
-    expect(callbacks.onPromptAI).toHaveBeenCalled()
+    expect(callbacks.onAssetSelect).not.toHaveBeenCalled()
+    expect(callbacks.onPromptAI).toHaveBeenCalledWith(data)
     expect(callbacks.onUnknownMessage).not.toHaveBeenCalled()
   })
 })
diff --git a/...field-plugin/src/messaging/pluginMessage/pluginToContainerMessage/PromptAIMessage.test.ts b/...field-plugin/src/messaging/pluginMessage/pluginToContainerMessage/PromptAIMessage.test.ts
@@ -11,7 +11,7 @@ const stub: PluginPromptAIMessage = {
   action: 'prompt-ai',
   event: 'promptAI',
   uid,
-  payload: {
+  promptAIPayload: {
     action: 'prompt',
     text: 'Some text to prompt',
   },
@@ -36,7 +36,7 @@ describe('PromptAIMessage', () => {
         }),
       ).toEqual(false)
     })
-    it('has a payload', () => {
+    it('has a promptAIPayload', () => {
       expect(
         isPluginPromptAIMessage({
           ...stub,
@@ -45,15 +45,15 @@ describe('PromptAIMessage', () => {
       expect(
         isPluginPromptAIMessage({
           ...stub,
-          payload: undefined,
+          promptAIPayload: undefined,
         }),
       ).toEqual(false)
     })
-    it('has the payload all required fields', () => {
+    it('has the promptAIPayload all required fields', () => {
       expect(
         isPluginPromptAIMessage({
           ...stub,
-          payload: {
+          promptAIPayload: {
             action: '',
           },
         }),
@@ -62,7 +62,7 @@ describe('PromptAIMessage', () => {
       expect(
         isPluginPromptAIMessage({
           ...stub,
-          payload: {
+          promptAIPayload: {
             text: '',
           },
         }),
@@ -71,7 +71,7 @@ describe('PromptAIMessage', () => {
       expect(
         isPluginPromptAIMessage({
           ...stub,
-          payload: {
+          promptAIPayload: {
             action: 'prompt',
             text: 'random text',
           },
@@ -81,7 +81,7 @@ describe('PromptAIMessage', () => {
       expect(
         isPluginPromptAIMessage({
           ...stub,
-          payload: {
+          promptAIPayload: {
             action: 'prompt',
             text: 123,
           },
@@ -91,7 +91,7 @@ describe('PromptAIMessage', () => {
       expect(
         isPluginPromptAIMessage({
           ...stub,
-          payload: {
+          promptAIPayload: {
             action: null,
             text: 123,
           },
@@ -101,19 +101,19 @@ describe('PromptAIMessage', () => {
       expect(
         isPluginPromptAIMessage({
           ...stub,
-          payload: {
+          promptAIPayload: {
             action: null,
             text: null,
           },
         }),
       ).toEqual(false)
     })
-    it('has the payload a language in case of translation', () => {
+    it('has the promptAIPayload a language in case of translation', () => {
       expect(
         isPluginPromptAIMessage({
           ...stub,
-          payload: {
-            ...stub.payload,
+          promptAIPayload: {
+            ...stub.promptAIPayload,
             action: 'translate',
           },
         }),
@@ -122,20 +122,20 @@ describe('PromptAIMessage', () => {
       expect(
         isPluginPromptAIMessage({
           ...stub,
-          payload: {
-            ...stub.payload,
+          promptAIPayload: {
+            ...stub.promptAIPayload,
             action: 'translate',
             language: 'en',
           },
         }),
       ).toEqual(true)
     })
-    it('has the payload a tone in case of tone adjustment', () => {
+    it('has the promptAIPayload a tone in case of tone adjustment', () => {
       expect(
         isPluginPromptAIMessage({
           ...stub,
-          payload: {
-            ...stub.payload,
+          promptAIPayload: {
+            ...stub.promptAIPayload,
             action: 'adjust-tone',
           },
         }),
@@ -144,8 +144,8 @@ describe('PromptAIMessage', () => {
       expect(
         isPluginPromptAIMessage({
           ...stub,
-          payload: {
-            ...stub.payload,
+          promptAIPayload: {
+            ...stub.promptAIPayload,
             action: 'adjust-tone',
             tone: 'academic',
           },
@@ -156,13 +156,13 @@ describe('PromptAIMessage', () => {
   describe('constructor', () => {
     it('includes the uid', () => {
       expect(
-        getPluginPromptAIMessage(stub.payload, { uid, callbackId }),
+        getPluginPromptAIMessage(stub.promptAIPayload, { uid, callbackId }),
       ).toHaveProperty('uid', uid)
     })
-    it('includes the payload was added to the message', () => {
+    it('includes the promptAIPayload', () => {
       expect(
-        getPluginPromptAIMessage(stub.payload, { uid, callbackId }),
-      ).toHaveProperty('payload')
+        getPluginPromptAIMessage(stub.promptAIPayload, { uid, callbackId }),
+      ).toHaveProperty('promptAIPayload')
     })
   })
 })
diff --git a/...ages/field-plugin/src/messaging/pluginMessage/pluginToContainerMessage/PromptAIMessage.ts b/...ages/field-plugin/src/messaging/pluginMessage/pluginToContainerMessage/PromptAIMessage.ts
@@ -4,21 +4,7 @@ import {
   type MessageToContainer,
 } from './MessageToContainer'
 
-export type PromptAIAction =
-  | 'prompt'
-  | 'complete'
-  | 'shorten'
-  | 'extend'
-  | 'rephrase'
-  | 'summarize'
-  | 'simplify'
-  | 'translate'
-  | 'tldr'
-  | 'adjust-tone'
-  | 'emojify'
-  | 'fix_spelling_and_grammar'
-
-export const promptAIActionsList: PromptAIAction[] = [
+export const promptAIActionsList = [
   'prompt',
   'complete',
   'shorten',
@@ -31,7 +17,9 @@ export const promptAIActionsList: PromptAIAction[] = [
   'adjust-tone',
   'emojify',
   'fix_spelling_and_grammar',
-]
+] as const
+
+export type PromptAIAction = (typeof promptAIActionsList)[number]
 
 export type PromptAIPayload = {
   action: PromptAIAction
@@ -48,16 +36,16 @@ export type PluginPromptAIMessage = Omit<
   'action'
 > & {
   action: 'prompt-ai'
-  payload: PromptAIPayload
+  promptAIPayload: PromptAIPayload
 }
 
 export const isPluginPromptAIMessage = (
   obj: unknown,
 ): obj is PluginPromptAIMessage =>
   isMessageToContainer(obj) &&
   obj.event === 'promptAI' &&
-  hasKey(obj, 'payload') &&
-  isPromptAIPayloadValid(obj.payload as PromptAIPayload)
+  hasKey(obj, 'promptAIPayload') &&
+  isPromptAIPayloadValid(obj.promptAIPayload as PromptAIPayload)
 
 export const isPromptAIPayloadValid = (promptAIPayload: PromptAIPayload) =>
   promptAIPayload !== null &&
@@ -83,5 +71,5 @@ export const getPluginPromptAIMessage = (
   action: 'prompt-ai',
   event: 'promptAI',
   ...options,
-  payload: { ...message },
+  promptAIPayload: { ...message },
 })
diff --git a/packages/lib-helpers/test/src/index.ts b/packages/lib-helpers/test/src/index.ts
@@ -117,7 +117,8 @@ const getContainer = (sendToFieldPlugin: (data: unknown) => void) => {
           callbackId: data.callbackId,
           aiResponse: {
             ok: true,
-            answer: 'Fake AI answer for the prompt: ' + data.payload.text,
+            answer:
+              'Fake AI answer for the prompt: ' + data.promptAIPayload.text,
           },
         })
       } else if (isGetUserContextMessage(data)) {