feat(helper): fix and add tests

Author: BibiSebi

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

@@ -54,6 +54,11 @@ const validateSchema = (manifest: Manifest): void => {
     throw new Error(`When declared, the 'options' property should be an array`)
   }
 
+  //NOTE: accepted empty options case
+  if (manifest.options.length === 0) {
+    return
+  }
+
   validateOptions(manifest.options)
 }
 

packages/manifest-helper/src/__tests__/manifest.test.ts

@@ -37,7 +37,7 @@ describe('manifest', () => {
     )
   })
 
-  it('should raises an exception when `options` is not an array', () => {
+  it('should raise an exception when `options` is not an array', () => {
     vi.mocked(existsSync).mockReturnValue(true)
     vi.mocked(readFileSync).mockReturnValue(
       JSON.stringify({
@@ -50,7 +50,55 @@ describe('manifest', () => {
     )
   })
 
-  it('should raises an exception when any `options item` has no `name` property', () => {
+  it('should raise an exception when `options` is not an array', () => {
+    vi.mocked(existsSync).mockReturnValue(true)
+    vi.mocked(readFileSync).mockReturnValue(
+      JSON.stringify({
+        options: {},
+      }),
+    )
+
+    expect(() => load()).toThrowErrorMatchingInlineSnapshot(
+      `[Error: Error while loading the manifest file: When declared, the 'options' property should be an array]`,
+    )
+  })
+
+  it('should NOT raise an exception when `options` is an empty array', () => {
+    vi.mocked(existsSync).mockReturnValue(true)
+    vi.mocked(readFileSync).mockReturnValue(
+      JSON.stringify({
+        options: [],
+      }),
+    )
+
+    expect(() => load()).not.toThrowError()
+  })
+
+  it('should NOT raise an exception when `options` is an undefined', () => {
+    vi.mocked(existsSync).mockReturnValue(true)
+    vi.mocked(readFileSync).mockReturnValue(
+      JSON.stringify({
+        options: undefined,
+      }),
+    )
+
+    expect(() => load()).not.toThrowError()
+  })
+
+  it('should raise an exception when `options` is not an array', () => {
+    vi.mocked(existsSync).mockReturnValue(true)
+    vi.mocked(readFileSync).mockReturnValue(
+      JSON.stringify({
+        options: null,
+      }),
+    )
+
+    expect(() => load()).toThrowErrorMatchingInlineSnapshot(
+      `[Error: Error while loading the manifest file: When declared, the 'options' property should be an array]`,
+    )
+  })
+
+  it('should raise an exception when any `options item` has no `name` property', () => {
     vi.mocked(existsSync).mockReturnValue(true)
     vi.mocked(readFileSync).mockReturnValue(
       JSON.stringify({
@@ -69,7 +117,7 @@ describe('manifest', () => {
     )
   })
 
-  it('should raises an exception when any `options item` has no `value` property', () => {
+  it('should raise an exception when any `options item` has no `value` property', () => {
     vi.mocked(existsSync).mockReturnValue(true)
     vi.mocked(readFileSync).mockReturnValue(
       JSON.stringify({
@@ -88,6 +136,24 @@ describe('manifest', () => {
     )
   })
 
+  it('should raise an exception when any `options item` --> `value` property is not of type string', () => {
+    vi.mocked(existsSync).mockReturnValue(true)
+    vi.mocked(readFileSync).mockReturnValue(
+      JSON.stringify({
+        options: [
+          {
+            name: 'opt1',
+            value: 1,
+          },
+        ],
+      }),
+    )
+
+    expect(() => load()).toThrowErrorMatchingInlineSnapshot(
+      `[Error: Error while loading the manifest file: Each option must be an object with string properties "name" and "value". The following values need to be corrected: \n {"name":"opt1","value":1} --> Incorrect value type. Must be of type string.]`,
+    )
+  })
+
   it('should be valid but with no `options` defined', () => {
     vi.mocked(existsSync).mockReturnValue(true)
     vi.mocked(readFileSync).mockReturnValue('{}')

packages/manifest-helper/src/manifest.ts

@@ -57,6 +57,11 @@ const validateSchema = (manifest: Manifest): void => {
     throw new Error(`When declared, the 'options' property should be an array`)
   }
 
+  //NOTE: accepted empty options case
+  if (manifest.options.length === 0) {
+    return
+  }
+
   validateOptions(manifest.options)
 }