@forge/manifest 13.7.0-next.0 → 13.7.0-next.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @forge/manifest
 
+## 13.7.0-next.1
+
+### Patch Changes
+
+- e17be5e: Add validation linting for dashboard modules
+
 ## 13.7.0-next.0
 
 ### Minor Changes

package/out/validators/modules-validator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"modules-validator.d.ts","sourceRoot":"","sources":["../../src/validators/modules-validator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,cAAc,EAAE,wBAAwB,EAAsC,MAAM,UAAU,CAAC;AAWxH,OAAO,EAEL,cAAc,EAMf,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AA4B3D,qBAAa,gBACX,YAAW,kBAAkB,CAAC,cAAc,CAAC,cAAc,CAAC,GAAG,SAAS,EAAE,cAAc,CAAC;IAGzF,OAAO,CAAC,oBAAoB,CAAsE;IAE5F,QAAQ,CACZ,QAAQ,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,SAAS,GACnD,OAAO,CAAC,wBAAwB,CAAC,cAAc,CAAC,CAAC;IAwEpD,OAAO,CAAC,uBAAuB;IAO/B,OAAO,CAAC,iBAAiB;IAkBzB,OAAO,CAAC,4BAA4B;IAapC,OAAO,CAAC,uBAAuB;IAe/B,OAAO,CAAC,uBAAuB;IAiB/B,OAAO,CAAC,4BAA4B;IA0BpC,OAAO,CAAC,mBAAmB;IA2E3B,OAAO,CAAC,4BAA4B;IA2BpC,OAAO,CAAC,yBAAyB;CAoClC"}
+{"version":3,"file":"modules-validator.d.ts","sourceRoot":"","sources":["../../src/validators/modules-validator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,cAAc,EAAE,wBAAwB,EAAsC,MAAM,UAAU,CAAC;AAWxH,OAAO,EAEL,cAAc,EAMf,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AA6B3D,qBAAa,gBACX,YAAW,kBAAkB,CAAC,cAAc,CAAC,cAAc,CAAC,GAAG,SAAS,EAAE,cAAc,CAAC;IAGzF,OAAO,CAAC,oBAAoB,CAAsE;IAE5F,QAAQ,CACZ,QAAQ,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,SAAS,GACnD,OAAO,CAAC,wBAAwB,CAAC,cAAc,CAAC,CAAC;IAyEpD,OAAO,CAAC,uBAAuB;IAO/B,OAAO,CAAC,iBAAiB;IAkBzB,OAAO,CAAC,4BAA4B;IAapC,OAAO,CAAC,uBAAuB;IAe/B,OAAO,CAAC,uBAAuB;IAiB/B,OAAO,CAAC,4BAA4B;IA0BpC,OAAO,CAAC,mBAAmB;IA2E3B,OAAO,CAAC,4BAA4B;IA2BpC,OAAO,CAAC,yBAAyB;CAoClC"}

package/out/validators/modules-validator.js

@@ -27,6 +27,7 @@ const automation_1 = require("./modules-validators/automation");
 const graph_1 = require("./modules-validators/graph");
 const validate_global_ui_1 = require("./modules-validators/global/validate-global-ui");
 const validate_global_full_page_1 = require("./modules-validators/global/validate-global-full-page");
+const dashboards_1 = require("./modules-validators/dashboards");
 class ModulesValidator {
     functionHandlerRegex = /^([\p{Alpha}\d_-]+(?:\/[\p{Alpha}\d_-]+)*)\.([\p{Alpha}\d_-]+)$/u;
     async validate(manifest) {
@@ -39,7 +40,7 @@ class ModulesValidator {
         let validationErrors = [...this.connectModuleValidation(manifest)];
         if (manifest.typedContent.modules) {
             const { typedContent: { modules, connectModules, remotes, permissions, services, providers }, yamlContentByLine, filePath } = manifest;
-            validationErrors = validationErrors.concat(this.checkUnsupportedModules(manifest.typedContent.modules, yamlContentByLine), this.functionKeyLength(modules, yamlContentByLine), this.minimumModuleCountValidation(modules, yamlContentByLine), this.functionKeyDefinedValidation(modules, yamlContentByLine), this.endpointValidations(modules, yamlContentByLine, remotes, permissions?.scopes || [], services), this.duplicateModuleKeyValidation(modules, connectModules || {}, yamlContentByLine), this.functionHandlerValidation(modules, yamlContentByLine, filePath, (0, utils_1.getHandlersDirectory)(manifest.typedContent)), (0, validate_workflow_1.validateJiraWorkflowValidator)(modules, yamlContentByLine), (0, validate_workflow_1.validateJiraWorkflowCondition)(modules, yamlContentByLine), (0, ui_modifications_1.validateUiModificationsModule)(modules, yamlContentByLine), (0, validate_full_admin_page_1.validateJiraFullAdminPage)(modules, yamlContentByLine), (0, validate_full_page_1.validateJiraFullPage)(modules, yamlContentByLine), (0, validate_full_page_module_1.validateJiraFullPageModule)(modules, yamlContentByLine), (0, validate_custom_field_1.validateJiraCustomField)(modules, yamlContentByLine), (0, confluence_1.validateConfluenceModules)(modules, yamlContentByLine), (0, bitbucket_1.validateBitbucketModules)(modules, yamlContentByLine), (0, validate_trigger_1.validateJiraTriggers)(modules, yamlContentByLine), (0, remote_1.validateRemoteModules)(modules, yamlContentByLine), (0, dataResidency_1.validateMigrationDataResidencyModule)(modules, remotes, yamlContentByLine), (0, validateModuleScopes_1.validateModuleScopes)(modules, yamlContentByLine, permissions), (0, rovo_1.validateRovoModules)(modules, (0, path_1.dirname)(filePath), yamlContentByLine), (0, automation_1.validateAutomationModules)(modules, yamlContentByLine), (0, validate_timetrackingprovider_module_1.validateJiraTimeTrackingModule)(modules, yamlContentByLine), (0, validate_command_1.validateJiraCommandModule)(modules, yamlContentByLine), (0, validate_action_validator_1.validateJiraActionValidator)(modules, yamlContentByLine), (0, validate_global_background_script_1.validateJiraGlobalBackgroundScript)(modules, yamlContentByLine), (0, graph_1.validateGraphModules)(modules, providers, yamlContentByLine), (0, validate_global_ui_1.validateGlobalUi)(modules, yamlContentByLine), (0, validate_global_full_page_1.validateGlobalFullPage)(modules, yamlContentByLine));
+            validationErrors = validationErrors.concat(this.checkUnsupportedModules(manifest.typedContent.modules, yamlContentByLine), this.functionKeyLength(modules, yamlContentByLine), this.minimumModuleCountValidation(modules, yamlContentByLine), this.functionKeyDefinedValidation(modules, yamlContentByLine), this.endpointValidations(modules, yamlContentByLine, remotes, permissions?.scopes || [], services), this.duplicateModuleKeyValidation(modules, connectModules || {}, yamlContentByLine), this.functionHandlerValidation(modules, yamlContentByLine, filePath, (0, utils_1.getHandlersDirectory)(manifest.typedContent)), (0, validate_workflow_1.validateJiraWorkflowValidator)(modules, yamlContentByLine), (0, validate_workflow_1.validateJiraWorkflowCondition)(modules, yamlContentByLine), (0, ui_modifications_1.validateUiModificationsModule)(modules, yamlContentByLine), (0, validate_full_admin_page_1.validateJiraFullAdminPage)(modules, yamlContentByLine), (0, validate_full_page_1.validateJiraFullPage)(modules, yamlContentByLine), (0, validate_full_page_module_1.validateJiraFullPageModule)(modules, yamlContentByLine), (0, validate_custom_field_1.validateJiraCustomField)(modules, yamlContentByLine), (0, confluence_1.validateConfluenceModules)(modules, yamlContentByLine), (0, bitbucket_1.validateBitbucketModules)(modules, yamlContentByLine), (0, validate_trigger_1.validateJiraTriggers)(modules, yamlContentByLine), (0, remote_1.validateRemoteModules)(modules, yamlContentByLine), (0, dataResidency_1.validateMigrationDataResidencyModule)(modules, remotes, yamlContentByLine), (0, validateModuleScopes_1.validateModuleScopes)(modules, yamlContentByLine, permissions), (0, rovo_1.validateRovoModules)(modules, (0, path_1.dirname)(filePath), yamlContentByLine), (0, automation_1.validateAutomationModules)(modules, yamlContentByLine), (0, validate_timetrackingprovider_module_1.validateJiraTimeTrackingModule)(modules, yamlContentByLine), (0, validate_command_1.validateJiraCommandModule)(modules, yamlContentByLine), (0, validate_action_validator_1.validateJiraActionValidator)(modules, yamlContentByLine), (0, validate_global_background_script_1.validateJiraGlobalBackgroundScript)(modules, yamlContentByLine), (0, graph_1.validateGraphModules)(modules, providers, yamlContentByLine), (0, dashboards_1.validateDashboardModules)(modules, yamlContentByLine), (0, validate_global_ui_1.validateGlobalUi)(modules, yamlContentByLine), (0, validate_global_full_page_1.validateGlobalFullPage)(modules, yamlContentByLine));
         }
         else {
             const { typedContent: { connectModules }, yamlContentByLine } = manifest;

package/out/validators/modules-validators/dashboards/index.d.ts

@@ -0,0 +1,2 @@
+export { validateDashboardModules } from './validate-dashboard-modules';
+//# sourceMappingURL=index.d.ts.map

package/out/validators/modules-validators/dashboards/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/validators/modules-validators/dashboards/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC"}

package/out/validators/modules-validators/dashboards/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateDashboardModules = void 0;
+var validate_dashboard_modules_1 = require("./validate-dashboard-modules");
+Object.defineProperty(exports, "validateDashboardModules", { enumerable: true, get: function () { return validate_dashboard_modules_1.validateDashboardModules; } });

package/out/validators/modules-validators/dashboards/validate-dashboard-modules.d.ts

@@ -0,0 +1,4 @@
+import { Modules } from '../../../schema/manifest';
+import { ValidationError } from '../../../types';
+export declare const validateDashboardModules: (modules: Modules, yamlContentByLine?: string[]) => ValidationError[];
+//# sourceMappingURL=validate-dashboard-modules.d.ts.map

package/out/validators/modules-validators/dashboards/validate-dashboard-modules.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-dashboard-modules.d.ts","sourceRoot":"","sources":["../../../../src/validators/modules-validators/dashboards/validate-dashboard-modules.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAC;AAEnD,OAAO,EAAkB,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAyDjE,eAAO,MAAM,wBAAwB,GAAI,SAAS,OAAO,EAAE,oBAAoB,MAAM,EAAE,KAAG,eAAe,EAoBxG,CAAC"}

package/out/validators/modules-validators/dashboards/validate-dashboard-modules.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateDashboardModules = void 0;
+const text_1 = require("../../../text");
+const types_1 = require("../../../types");
+const utils_1 = require("../../../utils");
+const DASHBOARD_MODULE_ALLOWED_PROPERTIES = [
+    {
+        moduleType: types_1.AllModuleTypes.DashboardsWidget,
+        allowedProperties: new Set([
+            'key',
+            'title',
+            'description',
+            'thumbnail',
+            'resource',
+            'render',
+            'edit',
+            'resolver',
+            'aiContext'
+        ])
+    },
+    {
+        moduleType: types_1.AllModuleTypes.DashboardsFilter,
+        allowedProperties: new Set(['key', 'title', 'icon', 'function', 'resource', 'render', 'edit', 'resolver'])
+    },
+    {
+        moduleType: types_1.AllModuleTypes.DashboardsBackgroundScript,
+        allowedProperties: new Set(['key', 'resource', 'render', 'resolver'])
+    }
+];
+const isRecord = (value) => typeof value === 'object' && value !== null && !Array.isArray(value);
+const buildAdditionalPropertyError = (moduleType, additionalProperty, moduleKey, yamlContentByLine) => ({
+    message: text_1.errors.schemaError(undefined, [moduleType], text_1.errors.schema.additionalProperties(additionalProperty)),
+    reference: text_1.References.Modules,
+    level: 'error',
+    ...(0, utils_1.findPosition)(additionalProperty, yamlContentByLine ?? [], moduleKey)
+});
+const validateAllowedProperties = (moduleType, module, allowedProperties, moduleKey, yamlContentByLine) => Object.keys(module)
+    .filter((property) => !allowedProperties.has(property))
+    .map((property) => buildAdditionalPropertyError(moduleType, property, moduleKey, yamlContentByLine));
+const validateDashboardModules = (modules, yamlContentByLine) => {
+    const validationErrors = [];
+    DASHBOARD_MODULE_ALLOWED_PROPERTIES.forEach(({ moduleType, allowedProperties }) => {
+        const dashboardModules = modules[moduleType];
+        if (!Array.isArray(dashboardModules)) {
+            return;
+        }
+        dashboardModules.filter(isRecord).forEach((module) => {
+            const moduleKey = typeof module.key === 'string' ? module.key : undefined;
+            validationErrors.push(...validateAllowedProperties(moduleType, module, allowedProperties, moduleKey, yamlContentByLine));
+        });
+    });
+    return validationErrors;
+};
+exports.validateDashboardModules = validateDashboardModules;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/manifest",
-  "version": "13.7.0-next.0",
+  "version": "13.7.0-next.1",
   "description": "Definitions and validations of the Forge manifest",
   "main": "out/index.js",
   "scripts": {