Merge branch 'main' of github.com:storyblok/field-plugin

.all-contributorsrc

@@ -71,6 +71,15 @@
       "contributions": [
         "code"
       ]
+    },
+    {
+      "login": "ECJ222",
+      "name": "ECJ",
+      "avatar_url": "https://avatars.githubusercontent.com/u/39567763?v=4",
+      "profile": "https://github.com/ECJ222",
+      "contributions": [
+        "code"
+      ]
     }
   ]
 }

.github/workflows/npm-publish-cli.yml

@@ -2,7 +2,7 @@ name: Publish CLI to NPM
 
 on:
   release:
-    types: [created]
+    types: [published]
 
 jobs:
   publish-npm:

.github/workflows/npm-publish-library.yml

@@ -2,7 +2,7 @@ name: Publish library to NPM
 
 on:
   release:
-    types: [created]
+    types: [published]
 
 jobs:
   publish-npm:

README.md

@@ -27,6 +27,7 @@ For more details, please refer to the [documentation](https://www.storyblok.com/
     </tr>
     <tr>
       <td align="center" valign="top" width="16.66%"><a href="https://links.dawntraoz.com/"><img src="https://avatars.githubusercontent.com/u/36744484?v=4?s=100" width="100px;" alt="Alba Silvente Fuentes"/><br /><sub><b>Alba Silvente Fuentes</b></sub></a><br /><a href="#code-Dawntraoz" title="Code">💻</a></td>
+      <td align="center" valign="top" width="16.66%"><a href="https://github.com/ECJ222"><img src="https://avatars.githubusercontent.com/u/39567763?v=4?s=100" width="100px;" alt="ECJ"/><br /><sub><b>ECJ</b></sub></a><br /><a href="#code-ECJ222" title="Code">💻</a></td>
     </tr>
   </tbody>
 </table>

package.json

@@ -8,7 +8,7 @@
     "url": "https://www.storyblok.com/"
   },
   "private": true,
-  "license": "UNLICENSED",
+  "license": "MIT",
   "workspaces": [
     "packages/*",
     "packages/cli/templates/*",

packages/cli/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@storyblok/field-plugin-cli",
-  "version": "1.4.0",
+  "version": "1.5.1",
+  "license": "MIT",
   "type": "module",
   "bin": {
     "field-plugin": "./bin.js"

packages/cli/templates/js/package.json

@@ -10,7 +10,7 @@
     "deploy": "npm run build && npx @storyblok/field-plugin-cli@latest deploy"
   },
   "dependencies": {
-    "@storyblok/field-plugin": "1.3.0"
+    "@storyblok/field-plugin": "1.4.2"
   },
   "devDependencies": {
     "vite": "5.4.8",

packages/cli/templates/react/package.json

@@ -12,7 +12,7 @@
     "deploy": "npm run build && npx @storyblok/field-plugin-cli@latest deploy"
   },
   "dependencies": {
-    "@storyblok/field-plugin": "1.3.0",
+    "@storyblok/field-plugin": "1.4.2",
     "react": "^18.3.1",
     "react-dom": "^18.3.1"
   },

packages/cli/templates/vue2/package.json

@@ -12,7 +12,7 @@
     "deploy": "npm run build && npx @storyblok/field-plugin-cli@latest deploy"
   },
   "dependencies": {
-    "@storyblok/field-plugin": "1.3.0",
+    "@storyblok/field-plugin": "1.4.2",
     "vue": "^2.7.14"
   },
   "devDependencies": {

packages/cli/templates/vue3/package.json

@@ -11,7 +11,7 @@
     "deploy": "npm run build && npx @storyblok/field-plugin-cli@latest deploy"
   },
   "dependencies": {
-    "@storyblok/field-plugin": "1.3.0",
+    "@storyblok/field-plugin": "1.4.2",
     "vue": "^3.2.47"
   },
   "devDependencies": {

packages/field-plugin/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@storyblok/field-plugin",
-  "version": "1.4.0",
+  "version": "1.4.2",
   "description": "SDK for creating Field Plugins for Storyblok.",
+  "license": "MIT",
   "sideEffects": false,
   "files": [
     "dist"

packages/field-plugin/src/createFieldPlugin/FieldPluginData.ts

@@ -8,6 +8,7 @@ export type FieldPluginData<Content> = {
   content: Content
   options: Record<string, string>
   spaceId: number | undefined
+  userId: number | undefined
   interfaceLang: string
   storyLang: string
   story: StoryData

packages/field-plugin/src/createFieldPlugin/createPluginActions/createPluginActions.test.ts

@@ -70,6 +70,7 @@ describe('createPluginActions', () => {
         interfaceLanguage: 'en',
         model: randomString,
         spaceId: null,
+        userId: undefined,
         blockId: undefined,
         releases: [],
         releaseId: undefined,

packages/field-plugin/src/createFieldPlugin/createPluginActions/createPluginMessageListener/handlePluginMessage.test.ts

@@ -60,6 +60,7 @@ describe('handlePluginMessage', () => {
       interfaceLanguage: 'en',
       model: 123,
       spaceId: 1234,
+      userId: 2345,
       story: { content: {} },
       schema: { options: [], field_type: 'avh', translatable: false },
       storyId: 1344,

packages/field-plugin/src/createFieldPlugin/createPluginActions/partialPluginStateFromStateChangeMessage.ts

@@ -23,6 +23,7 @@ export const pluginStateFromStateChangeMessage = <Content>(
   return {
     interfaceLang: message.interfaceLanguage,
     spaceId: message.spaceId ?? undefined,
+    userId: message.userId ?? undefined,
     story: message.story ?? undefined,
     storyId: message.storyId ?? undefined,
     storyLang: message.language === '' ? 'default' : message.language,

packages/field-plugin/src/messaging/pluginMessage/containerToPluginMessage/LoadedMessage.test.ts

@@ -5,6 +5,7 @@ const stub: LoadedMessage = {
   action: 'loaded',
   uid: '-preview',
   spaceId: null,
+  userId: undefined,
   model: undefined,
   isModalOpen: false,
   token: null,
@@ -18,7 +19,7 @@ const stub: LoadedMessage = {
   releaseId: undefined,
 }
 
-describe('StateChangedMessage', () => {
+describe('LoadedMessage', () => {
   it('should validate', () => {
     expect(isLoadedMessage(stub)).toEqual(true)
   })
@@ -128,4 +129,38 @@ describe('StateChangedMessage', () => {
       ).toEqual(true)
     })
   })
+  describe('The "userId" property', () => {
+    it('is a number', () => {
+      expect(
+        isLoadedMessage({
+          ...stub,
+          userId: 123,
+        }),
+      ).toEqual(true)
+    })
+    it('is undefined', () => {
+      expect(
+        isLoadedMessage({
+          ...stub,
+          userId: undefined,
+        }),
+      ).toEqual(true)
+    })
+    it('is not null', () => {
+      expect(
+        isLoadedMessage({
+          ...stub,
+          userId: null,
+        }),
+      ).toEqual(false)
+    })
+    it('is not a string', () => {
+      expect(
+        isLoadedMessage({
+          ...stub,
+          userId: '123',
+        }),
+      ).toEqual(false)
+    })
+  })
 })

packages/field-plugin/src/messaging/pluginMessage/containerToPluginMessage/LoadedMessage.ts

@@ -13,6 +13,7 @@ export type LoadedMessage = MessageToPlugin<'loaded'> & {
   language: string
   interfaceLanguage: string
   spaceId: number | null
+  userId: number | undefined
   story: StoryData
   storyId: number | undefined
   blockId: string | undefined
@@ -33,6 +34,8 @@ export const isLoadedMessage = (data: unknown): data is LoadedMessage =>
   typeof data.language === 'string' &&
   hasKey(data, 'schema') &&
   isFieldPluginSchema(data.schema) &&
+  hasKey(data, 'userId') &&
+  (typeof data.userId === 'number' || typeof data.userId === 'undefined') &&
   hasKey(data, 'story') &&
   isStoryData(data.story) &&
   hasKey(data, 'isModalOpen') &&

packages/field-plugin/src/messaging/pluginMessage/containerToPluginMessage/StateChangedMessage.test.ts

@@ -0,0 +1,166 @@
+import { isStateMessage, StateChangedMessage } from './StateChangedMessage'
+import { FieldPluginSchema } from './FieldPluginSchema'
+
+const stub: StateChangedMessage = {
+  action: 'state-changed',
+  uid: '-preview',
+  spaceId: null,
+  userId: undefined,
+  model: undefined,
+  isModalOpen: false,
+  token: null,
+  storyId: undefined,
+  blockId: undefined,
+  story: { content: {} },
+  language: '',
+  interfaceLanguage: 'en',
+  schema: { options: [], field_type: 'blah', translatable: false },
+  releases: [],
+  releaseId: undefined,
+}
+
+describe('StateChangedMessage', () => {
+  it('should validate', () => {
+    expect(isStateMessage(stub)).toEqual(true)
+  })
+  describe('The "action" property', () => {
+    it('equals "loaded"', () => {
+      expect(
+        isStateMessage({
+          ...stub,
+          action: 'anotherString',
+        }),
+      ).toEqual(false)
+    })
+  })
+  describe('the "uid" property', () => {
+    it('is a string', () => {
+      expect(
+        isStateMessage({
+          ...stub,
+          uid: 'anything',
+        }),
+      ).toEqual(true)
+    })
+    it('is not undefined', () => {
+      expect(
+        isStateMessage({
+          ...stub,
+          uid: undefined,
+        }),
+      ).toEqual(false)
+    })
+    it('is not null', () => {
+      expect(
+        isStateMessage({
+          ...stub,
+          uid: null,
+        }),
+      ).toEqual(false)
+    })
+    it('is not a number', () => {
+      expect(
+        isStateMessage({
+          ...stub,
+          uid: 123,
+        }),
+      ).toEqual(false)
+    })
+  })
+
+  describe('the "language" property', () => {
+    it('is a string', () => {
+      expect(
+        isStateMessage({
+          ...stub,
+          language: 'anything',
+        }),
+      ).toEqual(true)
+    })
+    it('is not undefined', () => {
+      expect(
+        isStateMessage({
+          ...stub,
+          language: undefined,
+        }),
+      ).toEqual(false)
+    })
+    it('is not null', () => {
+      expect(
+        isStateMessage({
+          ...stub,
+          language: null,
+        }),
+      ).toEqual(false)
+    })
+    it('is not a number', () => {
+      expect(
+        isStateMessage({
+          ...stub,
+          language: 123,
+        }),
+      ).toEqual(false)
+    })
+  })
+  describe('The "schema" property', () => {
+    it('is required', () => {
+      expect(
+        isStateMessage({
+          ...stub,
+          schema: undefined,
+        }),
+      ).toEqual(false)
+    })
+    it('must be a schema', () => {
+      expect(
+        isStateMessage({
+          ...stub,
+          schema: {
+            field_type: 'my-field',
+            options: [
+              {
+                name: 'a',
+                value: 'ab',
+              },
+            ],
+            translatable: false,
+          } as FieldPluginSchema,
+        }),
+      ).toEqual(true)
+    })
+  })
+  describe('The "userId" property', () => {
+    it('is a number', () => {
+      expect(
+        isStateMessage({
+          ...stub,
+          userId: 123,
+        }),
+      ).toEqual(true)
+    })
+    it('is undefined', () => {
+      expect(
+        isStateMessage({
+          ...stub,
+          userId: undefined,
+        }),
+      ).toEqual(true)
+    })
+    it('is not null', () => {
+      expect(
+        isStateMessage({
+          ...stub,
+          userId: null,
+        }),
+      ).toEqual(false)
+    })
+    it('is not a string', () => {
+      expect(
+        isStateMessage({
+          ...stub,
+          userId: '123',
+        }),
+      ).toEqual(false)
+    })
+  })
+})

packages/field-plugin/src/messaging/pluginMessage/containerToPluginMessage/StateChangedMessage.ts

@@ -13,6 +13,7 @@ export type StateChangedMessage = MessageToPlugin<'state-changed'> & {
   language: string
   interfaceLanguage: string
   spaceId: number | null
+  userId: number | undefined
   story: StoryData
   storyId: number | undefined
   blockId: string | undefined
@@ -33,6 +34,8 @@ export const isStateMessage = (data: unknown): data is StateChangedMessage =>
   typeof data.language === 'string' &&
   hasKey(data, 'schema') &&
   isFieldPluginSchema(data.schema) &&
+  hasKey(data, 'userId') &&
+  (typeof data.userId === 'number' || typeof data.userId === 'undefined') &&
   hasKey(data, 'story') &&
   isStoryData(data.story) &&
   hasKey(data, 'isModalOpen') &&