@movable/rollup-plugin-manifest-validator 3.2.0-app-validation

package/src/schemas/warningSchemaPackages.js

@@ -0,0 +1,304 @@
+import { studioIcons, fieldTypes, propertyTypes, contextOptionTypes } from './enums';
+
+const strNumBool = ['string', 'number', 'boolean'];
+
+const fieldSchema = {
+  type: 'object',
+  properties: {
+    allows_dynamic: { type: 'boolean' },
+    default: { type: strNumBool },
+    description: { type: 'string' },
+    label: { type: 'string' },
+    max: { type: 'number' },
+    name: { type: 'string' },
+    options: {
+      type: 'array',
+      items: {
+        type: 'object',
+        properties: {
+          value: { type: strNumBool },
+          label: { type: ['string', 'number'] }
+        },
+        required: ['value', 'label'],
+        additionalProperties: false
+      }
+    },
+    placeholder: { type: ['string', 'number'] },
+    preview_text: { type: 'array', items: { type: strNumBool } },
+    provider: { type: 'string' },
+    template: { type: 'string' },
+    type: { type: 'string', enum: fieldTypes },
+    value: { type: strNumBool },
+    heading: { type: 'string' }
+  },
+  required: ['name', 'label', 'type'],
+  additionalProperties: false,
+  allOf: [
+    {
+      if: {
+        properties: { type: { enum: ['number', 'token'] } }
+      },
+      else: {
+        not: { required: ['max'] }
+      }
+    },
+    {
+      if: {
+        properties: { type: { const: 'oAuthAccount' } }
+      },
+      then: {
+        required: ['provider']
+      },
+      else: {
+        not: { required: ['provider'] }
+      }
+    },
+    {
+      if: {
+        properties: { type: { const: 'data-source' } }
+      },
+      else: {
+        not: { required: ['template'] }
+      }
+    },
+    {
+      if: {
+        properties: { type: { enum: ['select', 'radio', 'checkbox'] } }
+      },
+      else: {
+        not: { required: ['options'] }
+      }
+    }
+  ]
+};
+
+const dynamicPropertySchema = {
+  propertyGroupKey: { type: 'string' },
+  propertyPath: { type: 'string' },
+  propertyPreview: { type: strNumBool },
+  propertyFallback: { type: strNumBool },
+  propertyValue: { type: 'string' },
+  context: {
+    type: 'object'
+  }
+};
+
+const toolSchema = {
+  type: 'object',
+  properties: {
+    class_names: { type: 'string' },
+    fields: { type: 'array', items: fieldSchema },
+    icon: { type: 'string', enum: studioIcons },
+    label: { type: 'string' },
+    name: { type: 'string' },
+    type: { type: 'string' },
+    locked: { type: 'boolean' },
+    dynamic_fields: {
+      type: 'array',
+      items: {
+        type: 'object',
+        properties: {
+          type: { type: 'string', enum: propertyTypes },
+          name: { type: 'string' },
+          label: { type: 'string' },
+          allow_static_option: { type: 'boolean' }
+        },
+        required: ['name', 'label'],
+        additionalProperties: false
+      }
+    },
+    defaults: {
+      type: 'object',
+      properties: {
+        dynamicProperty: {
+          type: 'object',
+          properties: dynamicPropertySchema,
+          required: ['propertyPath'],
+          additionalProperties: false
+        },
+        height: { type: 'number' },
+        width: { type: 'number' }
+      },
+      additionalProperties: false
+    }
+  },
+  required: ['name', 'icon', 'label', 'type'],
+  additionalProperties: false
+};
+
+const propertySchema = {
+  type: 'object',
+  properties: {
+    name: { type: 'string' },
+    label: { type: 'string' },
+    description: { type: 'string' },
+    type: { type: 'string', enum: propertyTypes },
+    preview_text: {
+      type: 'array',
+      items: { type: strNumBool }
+    },
+    preview_values: { type: 'array', items: { type: strNumBool } },
+    context_options: {
+      type: 'array',
+      items: {
+        type: 'object',
+        properties: {
+          name: { type: 'string' },
+          type: { type: 'string', enum: contextOptionTypes },
+          description: { type: 'string' },
+          defaultValue: { type: 'number' },
+          options: {
+            type: 'array',
+            minItems: 1,
+            items: {
+              type: 'object',
+              properties: {
+                label: { type: 'string' },
+                value: { type: strNumBool }
+              },
+              required: ['value', 'label'],
+              additionalProperties: false
+            }
+          }
+        },
+        required: ['name', 'type'],
+        additionalProperties: false,
+        allOf: [
+          {
+            if: {
+              properties: { type: { enum: ['select'] } }
+            },
+            then: {
+              required: ['options']
+            }
+          }
+        ]
+      }
+    }
+  },
+  required: ['name', 'label'],
+  additionalProperties: false
+};
+
+export default {
+  type: 'object',
+  properties: {
+    name: { type: 'string' },
+    label: { type: 'string' },
+    query_params: {
+      type: 'object',
+      patternProperties: { '.*': { type: 'string' } }
+    },
+    cold_states: {
+      type: 'array',
+      items: {
+        type: 'object',
+        properties: {
+          name: { type: 'string' },
+          width: { type: 'number' },
+          height: { type: 'number' }
+        },
+        required: ['name'],
+        additionalProperties: false
+      }
+    },
+    integration_ids: {
+      type: 'array',
+      items: {
+        type: 'string',
+        pattern: '^[a-zA-Z0-9]+$',
+        minLength: 15,
+        maxLength: 15
+      }
+    },
+    fields: {
+      type: 'array',
+      items: fieldSchema
+    },
+    field_headings: {
+      type: 'array',
+      items: {
+        type: 'object',
+        required: ['name', 'label'],
+        properties: {
+          name: { type: 'string' },
+          label: { type: 'string' },
+          toggleable: { type: 'boolean' },
+          default_toggle_collapsed: { type: 'boolean' }
+        }
+      }
+    },
+    studio_options: {
+      type: 'object',
+      properties: {
+        prohibit_custom_params: { type: 'boolean' },
+        framework_version: { type: 'string', pattern: '^(\\d+\\.){2}\\d+$' },
+        tools: { type: 'array', items: toolSchema },
+        preview_fields: { type: 'array', items: { type: 'string' } },
+        property_groups: {
+          type: 'array',
+          items: {
+            type: 'object',
+            properties: {
+              name: { type: 'string' },
+              label: { type: 'string' },
+              description: { type: 'string' },
+              properties: { type: 'array', items: propertySchema }
+            },
+            required: ['name', 'label', 'properties'],
+            additionalProperties: false
+          },
+          minItems: 1,
+          maxItems: 1
+        },
+        element_modifiers: {
+          type: 'array',
+          items: {
+            type: 'object',
+            properties: {
+              name: { type: 'string' },
+              label: { type: 'string' },
+              description: { type: 'string' }
+            },
+            required: ['name', 'label'],
+            additionalProperties: false
+          }
+        },
+        property_modifiers: {
+          type: 'array',
+          items: {
+            type: 'object',
+            properties: {
+              name: { type: 'string' },
+              label: { type: 'string' },
+              type: { type: 'string', enum: propertyTypes },
+              preview_text: { type: 'array', items: { type: strNumBool } },
+              description: { type: 'string' },
+              propertyInputs: {
+                type: 'array',
+                items: {
+                  type: 'object',
+                  properties: {
+                    name: { type: 'string' },
+                    variableName: { type: 'string' },
+                    label: { type: 'string' },
+                    allow_static_option: { type: 'boolean' },
+                    type: { type: 'string' }
+                  },
+                  required: ['name', 'label', 'variableName'],
+                  additionalProperties: false
+                }
+              }
+            },
+            required: ['name', 'label'],
+            additionalProperties: false
+          }
+        }
+      },
+      additionalProperties: false
+    }
+  },
+  name: true,
+  required: ['name'],
+  additionalProperties: false
+};

package/test/fixtures/invalidField.yml

@@ -0,0 +1,3 @@
+name: bad manifest
+field: bongo
+fields: bingo

package/test/fixtures/master-app-manifest.yml

@@ -0,0 +1,72 @@
+name: master-blaster
+authors:
+  - test-author@movableink.com
+integration_ids:
+  - abcde0123456789
+  - fghij0123456789
+javascript_file: dist/index.js
+html_file: app/index.html
+css_file: app/styles/style.css
+description: this is an app description
+category: 'data: rendering'
+icon_v2: tools
+width: 400
+height: 300
+format: 'jpeg'
+quality: 85
+expose_advanced_options: true
+fields:
+  - name: test-field
+    label: Test Field
+    type: text
+  - name: test-field-with-options
+    label: Test Field With Options
+    type: select
+    value: 0
+    options:
+      - label: '1'
+        value: 0
+      - label: '2'
+        value: 1
+      - label: '3'
+        value: 2
+  - name: dataSourceField
+    type: data-source
+    label: Dr. DataSource
+    template: DD
+studio_options:
+  framework_version: '3.1'
+  tools:
+    - name: Hammer
+      label: For when all you've got are nails.
+      icon: pin
+      type: cool-tool
+  property_groups:
+    - name:  master-blaster
+      label: MB Prop Group
+      properties:
+        - name: mb-prop-group-property
+          label: MB Prop Group Property
+          type: image
+          preview_text:
+            - 5:30 PM
+            - 6:15 PM
+          preview_values:
+            - 33
+            - 99
+          context_options:
+            - name: context-option-1
+              type: select
+              description: I am number 1 context option!
+              defaultValue: 6
+              options:
+                - label: six
+                  value: 6
+                  label: seven
+                  value: 7
+capture_options:
+  timeout: 8s
+  cache_ttl: 60s
+query_params:
+  mb_param1: '[mb:param_1]'
+  mb_param2: '[mb:param_2]'

package/test/fixtures/master-package-manifest.yml

@@ -0,0 +1,100 @@
+name: master-blaster
+label: Master Blaster
+query_params:
+  mb_param1: '[mb:param_1]'
+  mb_param2: '[mb:param_2]'
+integration_ids:
+  - abcde0123456789
+  - fghij0123456789
+cold_states:
+  - name: default
+    width: 500
+    height: 500
+  - name: beyond_thunderdome
+fields:
+  - name: selectField
+    label: Mr. Selectfield
+    type: select
+    description: I am a Select Field
+    allows_dynamic: true
+    options:
+      - label: opt1
+        value: true
+      - label: opt2
+        value: 2
+      - label: opt3
+        value: three
+    default: three
+    preview_text:
+      - Alo!
+  - name: textField
+    label: Mrs. Textfield
+    type: text
+    placeholder: Let me hold that for you.
+    default: true
+    preview_text:
+      - Strings
+  - name: tokenField
+    label: Dr. Tokenfield
+    value: Panama
+    type: token
+    max: 50
+    preview_text:
+      - Bools
+  - name: oAuthField
+    type: oAuthAccount
+    label: Sir O'Authfield
+    default: 6
+    provider: The Royal Family
+  - name: dataSourceField
+    type: data-source
+    label: Dr. DataSource
+    template: DD
+studio_options:
+  prohibit_custom_params: false
+  framework_version: 2.29.0
+  tools:
+    - name: Hammer
+      label: For when all you've got are nails.
+      icon: pin
+      type: cool-tool
+  property_groups:
+    - name:  master-blaster
+      label: MB Prop Group
+      properties:
+        - name: mb-prop-group-property
+          label: MB Prop Group Property
+          type: image
+          preview_text:
+            - 5:30 PM
+            - 6:15 PM
+          preview_values:
+            - 33
+            - 99
+          context_options: 
+            - name: context-option-1
+              type: select
+              description: I am number 1 context option!
+              defaultValue: 6
+              options: 
+                - label: six
+                  value: 6
+                  label: seven
+                  value: 7
+  element_modifiers:
+    - name: element-modifier-1 
+      label: Element Modifier 1 
+      description: Increases or decreases complexity score
+  property_modifiers:
+    - name: property-modifier-1
+      label: Property Modifier 1
+      type: text
+      description: Initiates spin cycle
+      preview_text:
+        - Spin spin spin
+      propertyInputs:
+        - name: primaryInput
+          variableName: primaryInput
+          label: Primary String
+          allow_static_option: true
+          type: any

package/test/fixtures/noName.yml

@@ -0,0 +1 @@
+cat: dog

package/test/helpers/lib.js

@@ -0,0 +1,10 @@
+export const MANIFEST_PATH = 'test/fixtures/master-package-manifest.yml';
+export const MANIFEST_PATH_APPS = 'test/fixtures/master-app-manifest.yml';
+
+export const SHOULD_NOT_HAVE_PROPERTY_MESSAGE = 'should NOT have additional properties';
+export const ALLOWED_VALUES_MESSAGE = 'should be equal to one of the allowed values';
+export { TOP_LEVEL_PROHIBITED_PROPERTY_MESSAGE as TOP_LEVEL_PROHIBITED_PROPERTY_MESSAGE } from '../../src/packages/utils/package-manifest-validator';
+export { TOP_LEVEL_PROHIBITED_PROPERTY_MESSAGE as TOP_LEVEL_PROHIBITED_PROPERTY_MESSAGE_APP } from '../../src/apps/utils/app-manifest-validator';
+
+export const generateShouldHavePropertyMessage = (property) =>
+  `should have required property '${property}'`;

package/test/plugins/app-manifest-validation.js

@@ -0,0 +1,34 @@
+import { describe, it } from 'mocha';
+import { expect } from 'chai';
+import { rollup } from 'rollup';
+import { manifestValidatorPluginApps } from '../../src/apps';
+import { MANIFEST_PATH_APPS } from '../helpers/lib';
+
+describe('appManifestValidator plugin', async () => {
+  it('watches the manifest', async () => {
+    const bundler = await rollup({
+      input: 'test/fixtures/blankFile.js',
+      plugins: [manifestValidatorPluginApps({ manifestPath: MANIFEST_PATH_APPS })]
+    });
+
+    await bundler.generate({});
+
+    expect(bundler.watchFiles.includes(MANIFEST_PATH_APPS)).to.be.true;
+  });
+
+  it('throws errors', async () => {
+    try {
+      await rollup({
+        input: 'test/fixtures/blankFile.js',
+        plugins: [manifestValidatorPluginApps({ manifestPath: 'test/fixtures/noName.yml' })]
+      });
+
+      // ensure catch
+      expect(false).to.be.true;
+    } catch ({ message: fullMessage }) {
+      expect(fullMessage).to.contain('should NOT have additional properties');
+      expect(fullMessage).to.contain("should have required property 'name'");
+      expect(fullMessage).to.contain("should have required property 'authors'");
+    }
+  });
+});

package/test/plugins/package-manifest-validation.js

@@ -0,0 +1,62 @@
+import { describe, it } from 'mocha';
+import { expect } from 'chai';
+import { rollup } from 'rollup';
+import { manifestValidatorPluginPackages } from '../../src/packages';
+import { MANIFEST_PATH } from '../helpers/lib';
+
+describe('pacakgeManifestValidator plugin', async () => {
+  it('watches the manifest', async () => {
+    const bundler = await rollup({
+      input: 'test/fixtures/blankFile.js',
+      plugins: [manifestValidatorPluginPackages({ manifestPath: MANIFEST_PATH })]
+    });
+
+    await bundler.generate({});
+
+    expect(bundler.watchFiles.includes(MANIFEST_PATH)).to.be.true;
+  });
+
+  it('throws errors', async () => {
+    try {
+      await rollup({
+        input: 'test/fixtures/blankFile.js',
+        plugins: [manifestValidatorPluginPackages({ manifestPath: 'test/fixtures/noName.yml' })]
+      });
+
+      // ensure catch
+      expect(false).to.be.true;
+    } catch ({ message: fullMessage }) {
+      const [{ message }] = JSON.parse(fullMessage.replace(/INVALID PACKAGE MANIFEST:|\n/g, ''));
+      expect(message).to.equal("should have required property 'name'");
+    }
+  });
+
+  it('warns', async () => {
+    const warnings = [];
+
+    await rollup({
+      onwarn: (warning) => {
+        warnings.push(warning.toString());
+      },
+      input: 'test/fixtures/blankFile.js',
+      plugins: [manifestValidatorPluginPackages({ manifestPath: 'test/fixtures/invalidField.yml' })]
+    });
+
+    expect(warnings).to.include.members([
+      "(at position 1 plugin) 'PACKAGE MANIFEST VALIDATION WARNING': {\n" +
+        ' "message": "should NOT have additional properties",\n' +
+        ' "dataPath": "package-manifest.yml",\n' +
+        ' "params": {\n' +
+        '  "additionalProperty": "field"\n' +
+        ' }\n' +
+        '}',
+      "(at position 1 plugin) 'PACKAGE MANIFEST VALIDATION WARNING': {\n" +
+        ' "message": "should be array",\n' +
+        ' "dataPath": ".fields",\n' +
+        ' "params": {\n' +
+        '  "type": "array"\n' +
+        ' }\n' +
+        '}'
+    ]);
+  });
+});