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

package/dist/schemas/erroringSchemaPackages.js

@@ -0,0 +1,17 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _default = {
+  type: 'object',
+  properties: {
+    name: {
+      type: 'string'
+    }
+  },
+  required: ['name'],
+  prohibited: ['clickthrough_dynamic_property']
+};
+exports.default = _default;

package/dist/schemas/index.js

@@ -0,0 +1,39 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "erroringSchemaApps", {
+  enumerable: true,
+  get: function () {
+    return _erroringSchemaApps.default;
+  }
+});
+Object.defineProperty(exports, "erroringSchemaPackages", {
+  enumerable: true,
+  get: function () {
+    return _erroringSchemaPackages.default;
+  }
+});
+Object.defineProperty(exports, "warningSchemaApps", {
+  enumerable: true,
+  get: function () {
+    return _warningSchemaApps.default;
+  }
+});
+Object.defineProperty(exports, "warningSchemaPackages", {
+  enumerable: true,
+  get: function () {
+    return _warningSchemaPackages.default;
+  }
+});
+
+var _warningSchemaApps = _interopRequireDefault(require("./warningSchemaApps"));
+
+var _erroringSchemaApps = _interopRequireDefault(require("./erroringSchemaApps"));
+
+var _warningSchemaPackages = _interopRequireDefault(require("./warningSchemaPackages"));
+
+var _erroringSchemaPackages = _interopRequireDefault(require("./erroringSchemaPackages"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

package/dist/schemas/warningSchemaApps.js

@@ -0,0 +1,8 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _default = {};
+exports.default = _default;

package/dist/schemas/warningSchemaPackages.js

@@ -0,0 +1,504 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _enums = require("./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: _enums.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: _enums.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: _enums.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: _enums.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: _enums.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
+};
+var _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: _enums.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
+};
+exports.default = _default;

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@movable/rollup-plugin-manifest-validator",
+  "version": "3.2.0-app-validation",
+  "description": "Validates app-manifest and package-manifest.yml",
+  "main": "dist",
+  "keywords": [],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/movableink/studio-framework/tree/master/packages/rollup-plugin-manifest-validator.git"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "Movable Ink"
+  },
+  "scripts": {
+    "test": "mocha --recursive",
+    "dev": "yarn test -w",
+    "build": "./node_modules/.bin/babel src --out-dir dist",
+    "prepublish": "yarn run build"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.13.16",
+    "@babel/core": "^7.14.0",
+    "@babel/preset-env": "^7.20.2",
+    "@babel/register": "^7.13.16",
+    "chai": "^4.3.4",
+    "mocha": "^8.3.2",
+    "rollup": "^2.52.2"
+  },
+  "dependencies": {
+    "ajv": "6.12.6",
+    "ajv-keywords": "^3.0.0",
+    "yamljs": "^0.3.0"
+  },
+  "volta": {
+    "extends": "../../package.json"
+  },
+  "gitHead": "4480978dc5c4fdc28f0dd55f569fe6d8344f6469"
+}

package/src/apps/index.js

@@ -0,0 +1,3 @@
+import manifestValidatorPluginApps from './plugins/app-manifest-validator';
+
+export { manifestValidatorPluginApps };

package/src/apps/plugins/app-manifest-validator.js

@@ -0,0 +1,22 @@
+import YAML from 'yamljs';
+import { readFileSync } from 'fs';
+import appManifestValidator from '../utils/app-manifest-validator';
+
+const formatJSON = (j) => JSON.stringify(j, null, 1);
+
+export default ({ manifestPath }) => ({
+  buildStart() {
+    this.addWatchFile(manifestPath);
+
+    const manifest = YAML.parse(readFileSync(manifestPath).toString('utf-8'));
+    const { warnings, errors } = appManifestValidator(manifest);
+
+    if (errors.length) {
+      this.error({ message: `INVALID APP MANIFEST: ${formatJSON(errors)}` });
+    }
+
+    warnings.forEach((w) =>
+      this.warn({ message: `'APP MANIFEST VALIDATION WARNING': ${formatJSON(w)}` })
+    );
+  }
+});

package/src/apps/utils/app-manifest-validator.js

@@ -0,0 +1,31 @@
+import { warningValidator, erroringValidator } from '../validators';
+
+export const TOP_LEVEL_PROHIBITED_PROPERTY_MESSAGE =
+  'Manifest has a prohibited keyword at the top level.';
+const TOP_LEVEL_PATH = 'app-manifest.yml';
+
+const parseValidationItem = ({ message, dataPath, params, keyword }) => {
+  const validation = {
+    message,
+    dataPath,
+    params
+  };
+
+  if (!dataPath) {
+    validation.dataPath = TOP_LEVEL_PATH;
+    if (keyword === 'prohibited') validation.message = TOP_LEVEL_PROHIBITED_PROPERTY_MESSAGE;
+  }
+
+  return validation;
+};
+
+export default function validateManifest(manifest) {
+  warningValidator(manifest);
+  erroringValidator(manifest);
+  const warnings = warningValidator.errors ?? [];
+  const errors = erroringValidator.errors ?? [];
+  return {
+    warnings: warnings.map(parseValidationItem),
+    errors: errors.map(parseValidationItem)
+  };
+}

package/src/apps/validators/ajvCompiler.js

@@ -0,0 +1,28 @@
+import Ajv from 'ajv';
+import ajvKeywords from 'ajv-keywords';
+
+const compiler = new Ajv({ allErrors: true });
+ajvKeywords(compiler);
+
+compiler.addKeyword('name', {
+  schema: false,
+  validate: function validation(data) {
+    const { name: appName } = data;
+    const propertyGroup = data.studio_options?.property_groups?.[0];
+    if (propertyGroup?.name) {
+      validation.errors = [
+        {
+          message: 'property_group name must match app name',
+          keyword: 'invalidPropertyGroupName',
+          params: { name: propertyGroup.name },
+          dataPath: '.studio_options.propertyGroups[0]'
+        }
+      ];
+      return propertyGroup.name === appName;
+    }
+    return true;
+  },
+  errors: true
+});
+
+export default compiler;

package/src/apps/validators/erroringValidator.js

@@ -0,0 +1,4 @@
+import ajvCompiler from './ajvCompiler';
+import { erroringSchemaApps } from '../../schemas';
+
+export default ajvCompiler.compile(erroringSchemaApps);

package/src/apps/validators/index.js

@@ -0,0 +1,4 @@
+import warningValidator from './warningValidator';
+import erroringValidator from './erroringValidator';
+
+export { warningValidator, erroringValidator };