feat(sandbox): move validation to a better place -> manifest.ts

Author: BibiSebi

packages/field-plugin/helpers/vite/src/manifest.ts

@@ -1,5 +1,6 @@
 import { existsSync, readFileSync } from 'fs'
 import { resolve } from 'path'
+import { isEmpty, isOptionObject, isString } from './validation/manifest.ts'
 
 export const MANIFEST_FILE_NAME = 'field-plugin.config.json'
 export const MANIFEST_FULL_PATH = resolve(process.cwd(), MANIFEST_FILE_NAME)
@@ -48,12 +49,40 @@ const validateSchema = (manifest: Manifest): void => {
     throw new Error(`When declared, the 'options' property should be an array`)
   }
 
-  manifest.options?.forEach((option) => {
-    if (!('name' in option && 'value' in option)) {
-      throw new Error(
-        `Some of the defined 'options' are invalid. ` +
-          `Please, make sure they contain a 'name' and 'value' properties`,
+  validateOptions(manifest.options)
+  return
+}
+
+const validateOptions = (options: unknown[]): void => {
+  const incorrectValues: string[] = []
+
+  for (const option of options) {
+    if (!isOptionObject(option)) {
+      incorrectValues.push(
+        `${JSON.stringify(option)} --> Incorrect object value. Must be of type {"name": string, "value": string}.`,
       )
+      continue
     }
-  })
+
+    if (!isString(option.value)) {
+      incorrectValues.push(
+        `${JSON.stringify(option)} --> Incorrect value type. Must be of type string.`,
+      )
+      continue
+    }
+
+    if (isEmpty(option.value)) {
+      incorrectValues.push(
+        `${JSON.stringify(option)} --> Incorrect value. Must not be empty.`,
+      )
+      continue
+    }
+  }
+
+  if (incorrectValues.length > 0) {
+    throw new Error(
+      'ERROR: Each option must be an object with string properties "name" and "value". The following values need to be corrected: \n ' +
+        incorrectValues.join('\n '),
+    )
+  }
 }

packages/field-plugin/helpers/vite/src/sandbox.ts

@@ -3,7 +3,6 @@ import { bold, red } from './utils/text'
 import { arrows } from './utils/arrows'
 import { load, manifestExists, MANIFEST_FILE_NAME } from './manifest'
 import type { Manifest } from './manifest'
-import { isFieldPluginOption } from '@storyblok/field-plugin'
 
 export const SANDBOX_BASE_URL = `https://plugin-sandbox.storyblok.com/field-plugin`
 
@@ -12,47 +11,6 @@ export type SandboxQueryParams = {
   manifest: Manifest | null
 }
 
-const areOptionsValid = (options: unknown): boolean => {
-  if (!Array.isArray(options) || options.length === 0) {
-    displayManifestErrorLoading(
-      new Error('ERROR: Manifest options must be an array of objects'),
-    )
-    return false
-  }
-
-  const incorrectValues: string[] = []
-
-  for (const option of options) {
-    if (!isFieldPluginOption(option)) {
-      incorrectValues.push(JSON.stringify(option))
-    }
-  }
-
-  if (incorrectValues.length > 0) {
-    displayManifestErrorLoading(
-      new Error(
-        'ERROR: Each option must be an object with string properties "name" and "value". The following values need to be corrected: \n ' +
-          incorrectValues.join(',\n '),
-      ),
-    )
-    return false
-  }
-
-  return true
-}
-
-const isManifestValid = (manifest: unknown): boolean => {
-  if (typeof manifest !== 'object' || manifest === null) {
-    return false
-  }
-
-  if ('options' in manifest && manifest.options !== null) {
-    return areOptionsValid(manifest.options)
-  }
-
-  return true
-}
-
 export const buildQueryString = (params: SandboxQueryParams) => {
   const queryParams: querystring.ParsedUrlQueryInput = {
     url: params.url,
@@ -62,10 +20,6 @@ export const buildQueryString = (params: SandboxQueryParams) => {
     return querystring.stringify(queryParams)
   }
 
-  if (!isManifestValid(params.manifest)) {
-    throw Error('Invalid manifest')
-  }
-
   queryParams.manifest = JSON.stringify(params.manifest)
 }
 

packages/field-plugin/helpers/vite/src/validation/manifest.ts

@@ -0,0 +1,11 @@
+import { ManifestOption } from '../manifest.ts'
+
+export const isString = (value: unknown) => typeof value === 'string'
+
+export const isEmpty = (value: string) => value === ''
+
+export const isOptionObject = (option: unknown): option is ManifestOption =>
+  typeof option === 'object' &&
+  option !== null &&
+  'name' in option &&
+  'value' in option