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

package/.mocharc.yml

@@ -0,0 +1,3 @@
+require:
+  - 'regenerator-runtime'
+  - '@babel/register'

package/babel.config.json

@@ -0,0 +1,11 @@
+{
+  "presets": [
+    [
+      "@babel/preset-env",
+      {
+        "targets": { "safari": "16" },
+        "bugfixes": true
+      }
+    ]
+  ]
+}

package/dist/apps/index.js

@@ -0,0 +1,15 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "manifestValidatorPluginApps", {
+  enumerable: true,
+  get: function () {
+    return _appManifestValidator.default;
+  }
+});
+
+var _appManifestValidator = _interopRequireDefault(require("./plugins/app-manifest-validator"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

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

@@ -0,0 +1,44 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _yamljs = _interopRequireDefault(require("yamljs"));
+
+var _fs = require("fs");
+
+var _appManifestValidator = _interopRequireDefault(require("../utils/app-manifest-validator"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const formatJSON = j => JSON.stringify(j, null, 1);
+
+var _default = ({
+  manifestPath
+}) => ({
+  buildStart() {
+    this.addWatchFile(manifestPath);
+
+    const manifest = _yamljs.default.parse((0, _fs.readFileSync)(manifestPath).toString('utf-8'));
+
+    const {
+      warnings,
+      errors
+    } = (0, _appManifestValidator.default)(manifest);
+
+    if (errors.length) {
+      this.error({
+        message: `INVALID APP MANIFEST: ${formatJSON(errors)}`
+      });
+    }
+
+    warnings.forEach(w => this.warn({
+      message: `'APP MANIFEST VALIDATION WARNING': ${formatJSON(w)}`
+    }));
+  }
+
+});
+
+exports.default = _default;

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

@@ -0,0 +1,44 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.TOP_LEVEL_PROHIBITED_PROPERTY_MESSAGE = void 0;
+exports.default = validateManifest;
+
+var _validators = require("../validators");
+
+const TOP_LEVEL_PROHIBITED_PROPERTY_MESSAGE = 'Manifest has a prohibited keyword at the top level.';
+exports.TOP_LEVEL_PROHIBITED_PROPERTY_MESSAGE = TOP_LEVEL_PROHIBITED_PROPERTY_MESSAGE;
+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;
+};
+
+function validateManifest(manifest) {
+  (0, _validators.warningValidator)(manifest);
+  (0, _validators.erroringValidator)(manifest);
+  const warnings = _validators.warningValidator.errors ?? [];
+  const errors = _validators.erroringValidator.errors ?? [];
+  return {
+    warnings: warnings.map(parseValidationItem),
+    errors: errors.map(parseValidationItem)
+  };
+}

package/dist/apps/validators/ajvCompiler.js

@@ -0,0 +1,43 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _ajv = _interopRequireDefault(require("ajv"));
+
+var _ajvKeywords = _interopRequireDefault(require("ajv-keywords"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const compiler = new _ajv.default({
+  allErrors: true
+});
+(0, _ajvKeywords.default)(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
+});
+var _default = compiler;
+exports.default = _default;

package/dist/apps/validators/erroringValidator.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _ajvCompiler = _interopRequireDefault(require("./ajvCompiler"));
+
+var _schemas = require("../../schemas");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+var _default = _ajvCompiler.default.compile(_schemas.erroringSchemaApps);
+
+exports.default = _default;

package/dist/apps/validators/index.js

@@ -0,0 +1,23 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "erroringValidator", {
+  enumerable: true,
+  get: function () {
+    return _erroringValidator.default;
+  }
+});
+Object.defineProperty(exports, "warningValidator", {
+  enumerable: true,
+  get: function () {
+    return _warningValidator.default;
+  }
+});
+
+var _warningValidator = _interopRequireDefault(require("./warningValidator"));
+
+var _erroringValidator = _interopRequireDefault(require("./erroringValidator"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

package/dist/apps/validators/warningValidator.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _ajvCompiler = _interopRequireDefault(require("./ajvCompiler"));
+
+var _schemas = require("../../schemas");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+var _default = _ajvCompiler.default.compile(_schemas.warningSchemaApps);
+
+exports.default = _default;

package/dist/index.js

@@ -0,0 +1,21 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "manifestValidatorPluginApps", {
+  enumerable: true,
+  get: function () {
+    return _apps.manifestValidatorPluginApps;
+  }
+});
+Object.defineProperty(exports, "manifestValidatorPluginPackages", {
+  enumerable: true,
+  get: function () {
+    return _packages.manifestValidatorPluginPackages;
+  }
+});
+
+var _packages = require("./packages");
+
+var _apps = require("./apps");

package/dist/packages/index.js

@@ -0,0 +1,15 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "manifestValidatorPluginPackages", {
+  enumerable: true,
+  get: function () {
+    return _packageManifestValidator.default;
+  }
+});
+
+var _packageManifestValidator = _interopRequireDefault(require("./plugins/package-manifest-validator"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

package/dist/packages/plugins/package-manifest-validator.js

@@ -0,0 +1,44 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _yamljs = _interopRequireDefault(require("yamljs"));
+
+var _fs = require("fs");
+
+var _packageManifestValidator = _interopRequireDefault(require("../utils/package-manifest-validator"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const formatJSON = j => JSON.stringify(j, null, 1);
+
+var _default = ({
+  manifestPath
+}) => ({
+  buildStart() {
+    this.addWatchFile(manifestPath);
+
+    const manifest = _yamljs.default.parse((0, _fs.readFileSync)(manifestPath).toString('utf-8'));
+
+    const {
+      warnings,
+      errors
+    } = (0, _packageManifestValidator.default)(manifest);
+
+    if (errors.length) {
+      this.error({
+        message: `INVALID PACKAGE MANIFEST: ${formatJSON(errors)}`
+      });
+    }
+
+    warnings.forEach(w => this.warn({
+      message: `'PACKAGE MANIFEST VALIDATION WARNING': ${formatJSON(w)}`
+    }));
+  }
+
+});
+
+exports.default = _default;

package/dist/packages/utils/package-manifest-validator.js

@@ -0,0 +1,44 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.TOP_LEVEL_PROHIBITED_PROPERTY_MESSAGE = void 0;
+exports.default = validateManifest;
+
+var _validators = require("../validators");
+
+const TOP_LEVEL_PROHIBITED_PROPERTY_MESSAGE = 'Manifest has a prohibited keyword at the top level.';
+exports.TOP_LEVEL_PROHIBITED_PROPERTY_MESSAGE = TOP_LEVEL_PROHIBITED_PROPERTY_MESSAGE;
+const TOP_LEVEL_PATH = 'package-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;
+};
+
+function validateManifest(manifest) {
+  (0, _validators.warningValidator)(manifest);
+  (0, _validators.erroringValidator)(manifest);
+  const warnings = _validators.warningValidator.errors ?? [];
+  const errors = _validators.erroringValidator.errors ?? [];
+  return {
+    warnings: warnings.map(parseValidationItem),
+    errors: errors.map(parseValidationItem)
+  };
+}

package/dist/packages/validators/ajvCompiler.js

@@ -0,0 +1,43 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _ajv = _interopRequireDefault(require("ajv"));
+
+var _ajvKeywords = _interopRequireDefault(require("ajv-keywords"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const compiler = new _ajv.default({
+  allErrors: true
+});
+(0, _ajvKeywords.default)(compiler);
+compiler.addKeyword('name', {
+  schema: false,
+  validate: function validation(data) {
+    const {
+      name: packageName
+    } = data;
+    const propertyGroup = data.studio_options?.property_groups?.[0];
+
+    if (propertyGroup?.name) {
+      validation.errors = [{
+        message: 'property_group name must match package name',
+        keyword: 'invalidPropertyGroupName',
+        params: {
+          name: propertyGroup.name
+        },
+        dataPath: '.studio_options.propertyGroups[0]'
+      }];
+      return propertyGroup.name === packageName;
+    }
+
+    return true;
+  },
+  errors: true
+});
+var _default = compiler;
+exports.default = _default;

package/dist/packages/validators/erroringValidator.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _ajvCompiler = _interopRequireDefault(require("./ajvCompiler"));
+
+var _schemas = require("../../schemas");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+var _default = _ajvCompiler.default.compile(_schemas.erroringSchemaPackages);
+
+exports.default = _default;

package/dist/packages/validators/index.js

@@ -0,0 +1,23 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "erroringValidator", {
+  enumerable: true,
+  get: function () {
+    return _erroringValidator.default;
+  }
+});
+Object.defineProperty(exports, "warningValidator", {
+  enumerable: true,
+  get: function () {
+    return _warningValidator.default;
+  }
+});
+
+var _warningValidator = _interopRequireDefault(require("./warningValidator"));
+
+var _erroringValidator = _interopRequireDefault(require("./erroringValidator"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

package/dist/packages/validators/warningValidator.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _ajvCompiler = _interopRequireDefault(require("./ajvCompiler"));
+
+var _schemas = require("../../schemas");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+var _default = _ajvCompiler.default.compile(_schemas.warningSchemaPackages);
+
+exports.default = _default;

package/dist/schemas/enums.js

@@ -0,0 +1,14 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.studioIcons = exports.propertyTypes = exports.fieldTypes = exports.contextOptionTypes = void 0;
+const contextOptionTypes = ['select', 'text', 'hidden'];
+exports.contextOptionTypes = contextOptionTypes;
+const propertyTypes = ['text', 'image', 'link', 'api', 'boolean'];
+exports.propertyTypes = propertyTypes;
+const fieldTypes = ['asset', 'checkbox', 'color', 'data-source', 'data-source-package', 'date', 'datetime', 'dynamic-text', 'font', 'image', 'map', 'number', 'oauth2', 'oAuthAccount', 'radio', 'select', 'text', 'token', 'upload', 'url'];
+exports.fieldTypes = fieldTypes;
+const studioIcons = ['align-bottom', 'align-center', 'align-left', 'align-middle', 'align-right', 'align-top', 'arrange-center', 'arrange-left', 'arrange-right', 'arrows-select', 'avatar', 'bar-chart', 'barcode', 'calendar', 'cart', 'chatter', 'clock', 'code', 'condensed-view', 'copy', 'countdown-timer', 'countdown', 'crop', 'cursor-grab', 'cursor-move', 'cursor', 'distribute-horizontal', 'distribute-vertical', 'dropdown-arrow', 'duplicate', 'expanded-view', 'external-link', 'globe', 'grab', 'image-layer', 'image', 'images', 'instagram', 'local-time', 'locked', 'map-helper', 'maps', 'media-library', 'minus', 'move', 'olapic', 'param', 'personal', 'picture', 'pie-chart', 'pin', 'pinterest', 'plus', 'polling', 'proximity-pin', 'QR', 'qr-code', 'redo', 'rotate', 'rss', 'settings', 'shape', 'sharing', 'square', 'text-center', 'text-justify', 'text-layer', 'text-left', 'text-right', 'text-tool', 'text-vector', 'text', 'tools', 'trash', 'twitter-favorite', 'twitter-retweet', 'twitter-username', 'twitter', 'undo', 'unlocked', 'vector-square', 'vector-tool', 'video', 'weather-average', 'weather-city', 'weather-day', 'weather-description', 'weather-high-temp', 'weather-icon', 'weather', 'workspace-barcode', 'workspace-favorites', 'workspace-instagram', 'workspace-olapic', 'workspace-picture', 'workspace-pinterest', 'workspace-qr-code', 'workspace-retweets', 'workspace-weather'];
+exports.studioIcons = studioIcons;