@oracle/oraclejet-audit 11.1.3 → 12.1.0

package/meta/metaverlist.json

@@ -1 +1 @@
-{"metaList":{"6.0.0":{"version":"6.0.1","date":"Friday Jul 12, 2019","time":"10:58am pdt"},"5.2.0":{"version":"5.2.3","date":"Friday Jul 12, 2019","time":"10:55am pdt"},"6.1.0":{"version":"6.1.3","date":"Friday Jul 12, 2019","time":"11:00am pdt"},"6.2.0":{"version":"6.2.2","date":"Friday Jul 12, 2019","time":"11:02am pdt"},"7.0.0":{"version":"7.0.1","date":"Friday Jul 12, 2019","time":"11:04am pdt"},"7.1.0":{"version":"7.1.0","date":"Friday Jul 12, 2019","time":"11:06am pdt"},"7.2.0":{"version":"7.2.0","date":"Sunday Feb 16, 2020","time":"10:13pm est"},"7.3.0":{"version":"7.3.0","date":"Tuesday May 05, 2020","time":"12:50am edt"},"8.0.0":{"version":"8.0.0","date":"Sunday Feb 16, 2020","time":"10:51pm est"},"8.1.0":{"version":"8.1.0","date":"Sunday Feb 16, 2020","time":"10:20pm est"},"8.2.0":{"version":"8.2.0","date":"Friday Apr 17, 2020","time":"1:08am utc"},"8.3.0":{"version":"8.3.0","date":"Monday May 04, 2020","time":"4:34pm edt"},"9.0.0":{"version":"9.0.0","date":"Friday Jun 12, 2020","time":"1:57am utc"},"9.1.0":{"version":"9.1.0","date":"Thursday Aug 06, 2020","time":"2:13am utc"},"9.2.0":{"version":"9.2.0","date":"Wednesday Oct 07, 2020","time":"5:41pm utc"},"10.0.0":{"version":"10.0.0","date":"Thursday Jan 07, 2021","time":"9:20pm utc"},"10.1.0":{"version":"10.1.0","date":"Saturday Apr 17, 2021","time":"4:01pm utc"},"11.0.0":{"version":"11.0.0","date":"Friday Jul 02, 2021","time":"3:02am utc"},"11.1.0":{"version":"11.1.3","date":"Friday Dec 10, 2021","time":"9:56pm utc"}}}
+{"metaList":{"6.0.0":{"version":"6.0.1","date":"Friday Jul 12, 2019","time":"10:58am pdt"},"5.2.0":{"version":"5.2.3","date":"Friday Jul 12, 2019","time":"10:55am pdt"},"6.1.0":{"version":"6.1.3","date":"Friday Jul 12, 2019","time":"11:00am pdt"},"6.2.0":{"version":"6.2.2","date":"Friday Jul 12, 2019","time":"11:02am pdt"},"7.0.0":{"version":"7.0.1","date":"Friday Jul 12, 2019","time":"11:04am pdt"},"7.1.0":{"version":"7.1.0","date":"Friday Jul 12, 2019","time":"11:06am pdt"},"7.2.0":{"version":"7.2.0","date":"Sunday Feb 16, 2020","time":"10:13pm est"},"7.3.0":{"version":"7.3.0","date":"Tuesday May 05, 2020","time":"12:50am edt"},"8.0.0":{"version":"8.0.0","date":"Sunday Feb 16, 2020","time":"10:51pm est"},"8.1.0":{"version":"8.1.0","date":"Sunday Feb 16, 2020","time":"10:20pm est"},"8.2.0":{"version":"8.2.0","date":"Friday Apr 17, 2020","time":"1:08am utc"},"8.3.0":{"version":"8.3.0","date":"Monday May 04, 2020","time":"4:34pm edt"},"9.0.0":{"version":"9.0.0","date":"Friday Jun 12, 2020","time":"1:57am utc"},"9.1.0":{"version":"9.1.0","date":"Thursday Aug 06, 2020","time":"2:13am utc"},"9.2.0":{"version":"9.2.0","date":"Wednesday Oct 07, 2020","time":"5:41pm utc"},"10.0.0":{"version":"10.0.0","date":"Thursday Jan 07, 2021","time":"9:20pm utc"},"10.1.0":{"version":"10.1.0","date":"Saturday Apr 17, 2021","time":"4:01pm utc"},"11.0.0":{"version":"11.0.0","date":"Friday Jul 02, 2021","time":"3:02am utc"},"11.1.0":{"version":"11.1.0","date":"Thursday Sep 30, 2021","time":"9:33pm utc"},"12.0.0":{"version":"12.0.0","date":"Friday Feb 04, 2022","time":"2:29am utc"},"12.1.0":{"version":"12.1.0","date":"Saturday Apr 09, 2022","time":"7:54am utc"}}}

package/package.json

@@ -1,68 +1,72 @@
-{
-  "name": "@oracle/oraclejet-audit",
-  "version": "11.1.3",
-  "description": "JET AUDIT FRAMEWORK",
-  "main": "jaf.js",
-  "files": [
-    "jafconfig.json",
-    "*.js",
-    "html",
-    "lib",
-    "libext",
-    "meta",
-    "schema",
-    "rulepacks",
-    "rules",
-    "src",
-    "tests",
-    "types"
-  ],
-  "scripts": {
-    "start": "node jaf.js -e ",
-    "test": "node ./tests/test.js -ut -c ./tests/config/config_base.json",
-    "test-jetwc": "mocha ./tests/jetwc-tests/*.test.js",
-    "test-jetwco": "mocha ./tests/jetwco-tests/*.test.js --timeout 20000",
-    "build": "node ./build/build.js",
-    "metadel": "node ./build/metadel.js",
-    "buildmeta": "node ./build/metabuild.js  --show"
-  },
-  "bin": {
-    "ojaf": "./jaf.js"
-  },
-  "keywords": [
-    "html",
-    "css",
-    "js",
-    "json",
-    "jet",
-    "audit",
-    "lint"
-  ],
-  "Jaf": {
-    "version": "2.15.12"
-  },
-  "license": "UPL-1.0",
-  "dependencies": {
-    "@typescript-eslint/typescript-estree": "4.9.1",
-    "adm-zip": "0.4.16",
-    "ajv": "6.12.6",
-    "css-tree": "1.0.0-alpha.39",
-    "decache": "4.6.0",
-    "espree": "7.3.1",
-    "glob": "7.1.6",
-    "htmlparser2": "3.10.1",
-    "md5": "2.3.0",
-    "mock-http-server": "1.4.2",
-    "parserlib": "1.1.1",
-    "really-relaxed-json": "0.2.24",
-    "semver": "6.3.0",
-    "strip-json-comments": "2.0.1",
-    "sync-request": "6.1.0",
-    "tmp": "0.0.33",
-    "typescript": "4.1.2"
-  },
-  "devDependencies": {
-    "chai": "^4.2.0",
-    "mocha": "^7.2.0"
-  }
-}
+{
+  "name": "@oracle/oraclejet-audit",
+  "version": "12.1.0",
+  "description": "JET AUDIT FRAMEWORK",
+  "main": "jaf.js",
+  "files": [
+    "jafconfig.json",
+    "*.js",
+    "html",
+    "lib",
+    "libext",
+    "meta",
+    "schema",
+    "rulepacks",
+    "rules",
+    "src",
+    "tests",
+    "types"
+  ],
+  "scripts": {
+    "start": "node jaf.js -e ",
+    "test": "node ./tests/test.js -ut -c ./tests/config/config_base.json",
+    "test-jetwc": "mocha ./tests/jetwc-tests/*.test.js --timeout 5000",
+    "test-jetwco": "mocha ./tests/jetwco-tests/*.test.js --timeout 20000",
+    "build": "node ./build/build.js",
+    "metadel": "node ./build/metadel.js",
+    "buildmeta": "node ./build/metabuild.js  --show",
+    "test-oj-sample": "node ./tests/scripts/testCaseAudit oj-sample base",
+    "test-spectra": "node ./tests/scripts/testCaseAudit spectra-components base",
+    "test-cx-common": "node ./tests/scripts/testCaseAudit cx-common base"
+  },
+  "bin": {
+    "ojaf": "./jaf.js"
+  },
+  "keywords": [
+    "html",
+    "css",
+    "js",
+    "json",
+    "jet",
+    "audit",
+    "lint"
+  ],
+  "Jaf": {
+    "version": "3.12.8"
+  },
+  "license": "UPL-1.0",
+  "dependencies": {
+    "@typescript-eslint/typescript-estree": "4.9.1",
+    "adm-zip": "0.4.16",
+    "ajv": "6.12.6",
+    "css-tree": "1.0.0-alpha.39",
+    "decache": "4.6.0",
+    "espree": "7.3.1",
+    "glob": "7.1.6",
+    "htmlparser2": "3.10.1",
+    "markdown-it": "12.2.0",
+    "md5": "2.3.0",
+    "mock-http-server": "1.4.2",
+    "parserlib": "1.1.1",
+    "really-relaxed-json": "0.2.24",
+    "semver": "6.3.0",
+    "strip-json-comments": "2.0.1",
+    "sync-request": "6.1.0",
+    "tmp": "0.0.33",
+    "typescript": "4.1.2"
+  },
+  "devDependencies": {
+    "chai": "^4.2.0",
+    "mocha": "^7.2.0"
+  }
+}

package/rulepacks/csp/csp-html-script-unsafe-inline.js

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2018, 2022, Oracle and/or its affiliates.
  * Licensed under The Universal Permissive License (UPL), Version 1.0
  * as shown at https://oss.oracle.com/licenses/upl/
  */

package/rulepacks/csp/csp-html-style-unsafe-inline.js

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2018, 2022, Oracle and/or its affiliates.
  * Licensed under The Universal Permissive License (UPL), Version 1.0
  * as shown at https://oss.oracle.com/licenses/upl/
  */

package/rulepacks/csp/csp-html-unsafe-expr.js

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2018, 2022, Oracle and/or its affiliates.
  * Licensed under The Universal Permissive License (UPL), Version 1.0
  * as shown at https://oss.oracle.com/licenses/upl/
  */

package/rulepacks/csp/csp-js-script-unsafe-eval.js

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2018, 2022, Oracle and/or its affiliates.
  * Licensed under The Universal Permissive License (UPL), Version 1.0
  * as shown at https://oss.oracle.com/licenses/upl/
  */

package/rulepacks/csp/csp-js-style-unsafe-inline.js

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2018, 2022, Oracle and/or its affiliates.
  * Licensed under The Universal Permissive License (UPL), Version 1.0
  * as shown at https://oss.oracle.com/licenses/upl/
  */

package/rulepacks/csp/csp-ts-script-unsafe-eval.js

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2018, 2022, Oracle and/or its affiliates.
  * Licensed under The Universal Permissive License (UPL), Version 1.0
  * as shown at https://oss.oracle.com/licenses/upl/
  */

package/rulepacks/csp/csp-ts-style-unsafe-inline.js

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2018, 2022, Oracle and/or its affiliates.
  * Licensed under The Universal Permissive License (UPL), Version 1.0
  * as shown at https://oss.oracle.com/licenses/upl/
  */

package/rulepacks/csp/msgid.json

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2018, 2022, Oracle and/or its affiliates.
  * Licensed under The Universal Permissive License (UPL), Version 1.0
  * as shown at https://oss.oracle.com/licenses/upl/
  */

package/rulepacks/csp/rules.json

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2018, 2022, Oracle and/or its affiliates.
  * Licensed under The Universal Permissive License (UPL), Version 1.0
  * as shown at https://oss.oracle.com/licenses/upl/
  */

package/rulepacks/jetwc/jetwc-absolute-jetversion.js

@@ -1,6 +1,6 @@
 /*
- * Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2018, 2022, Oracle and/or its affiliates.
  * Licensed under The Universal Permissive License (UPL), Version 1.0
  * as shown at https://oss.oracle.com/licenses/upl/
  */
-const Utils=require('../jetwc-lib/component-audit-utils');const ruleDef=function(){};ruleDef.prototype.getName=function(){return'jetwc-absolute-jetversion'};ruleDef.prototype.getShortDescription=function(){return'Verify support for some range of JET versions'};ruleDef.prototype.getDescription=function(){return'This rule checks that a component has not be hard-wired to a specific version of JET - e.g. specifies some form of range at least'};ruleDef.prototype.register=function(context){return{compjson:this._doAudit}};ruleDef.prototype._doAudit=function(context){if(context.suppData.obj){let issue;const meta=context.suppData.obj;const fullName=Utils.getComponentFullName(meta);if(context.suppData.obj.jetVersion){if(context.utils.semVerUtils.isValid(meta.jetVersion)){issue=new context.Issue(`Component ${fullName} is hardwired to a specific JET version (${meta.jetVersion}), not a range`);context.reporter.addIssue(issue,context,'minor')}}}};module.exports=ruleDef;
+const Utils=require('../jetwc-lib/jetwcutils-componentAuditUtils');const TsxUtils=require('../jetwc-lib/jetwcutils-tsxUtils');const ruleDef=function(){};ruleDef.prototype.getName=function(){return'jetwc-absolute-jetversion'};ruleDef.prototype.getShortDescription=function(){return'Verify support for some range of JET versions'};ruleDef.prototype.getDescription=function(){return'This rule checks that a component has not be hard-wired to a specific version of JET - e.g. specifies some form of range at least'};ruleDef.prototype.register=function(context){return{compjson:this._doAudit,Program:this._doVComponentAudit}};ruleDef.prototype._doAudit=function(context){if(context.suppData.obj){const meta=context.suppData.obj;const fullName=Utils.getComponentFullName(meta);if(context.suppData.obj.jetVersion){this._versionCheck(context,fullName,meta.jetVersion)}}};ruleDef.prototype._doVComponentAudit=function(context){const componentInfo=TsxUtils.matchToVComponentImpl(context,context.filepath);if(componentInfo&&componentInfo.jetVersion){this._versionCheck(context,componentInfo.fullName,componentInfo.jetVersion)}};ruleDef.prototype._versionCheck=function(context,fullName,version){if(context.utils.semVerUtils.isValid(version)){const issue=new context.Issue(`Component ${fullName} is hardwired to a specific JET version (${version}), not a range`);context.reporter.addIssue(issue,context)}};module.exports=ruleDef;

package/rulepacks/jetwc/jetwc-aria-redefinition.js

@@ -1,6 +1,6 @@
 /*
- * Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2018, 2022, Oracle and/or its affiliates.
  * Licensed under The Universal Permissive License (UPL), Version 1.0
  * as shown at https://oss.oracle.com/licenses/upl/
  */
-const Utils=require('../jetwc-lib/component-audit-utils');const ruleDef=function(){};ruleDef.prototype.getName=function(){return'jetwc-aria-redefinition'};ruleDef.prototype.getShortDescription=function(){return'Ensure that the component does not re-define any WAI-ARIA properties'};ruleDef.prototype.getDescription=function(){return'This rule checks that a component has not overridden or tries to introduce (any custom) WAI-ARIA attributes'};ruleDef.prototype.register=function(context){return{compjson:this._doAudit}};ruleDef.prototype._doAudit=function(context){if(context.suppData.obj){let issue;const meta=context.suppData.obj;const fullName=Utils.getComponentFullName(meta);const componentType=Utils.getComponentType(meta);if(componentType==='composite'&&meta.properties){const ariaDetect=/^aria[A-Z\-].*$/;Object.keys(meta.properties).forEach(propName=>{if(ariaDetect.test(propName)){issue=new context.Issue(`Component ${fullName} defines a WAI-ARIA property ${propName} which is not allowed`);context.reporter.addIssue(issue,context,'minor')}})}}};module.exports=ruleDef;
+const Utils=require('../jetwc-lib/jetwcutils-componentAuditUtils');const TsxUtils=require('../jetwc-lib/jetwcutils-tsxUtils');const ruleDef=function(){};ruleDef.prototype.getName=function(){return'jetwc-aria-redefinition'};ruleDef.prototype.getShortDescription=function(){return'Ensure that the component does not re-define any WAI-ARIA properties'};ruleDef.prototype.getDescription=function(){return'This rule checks that a component has not overridden or tries to introduce (any custom) WAI-ARIA attributes'};ruleDef.prototype.register=function(context){return{compjson:this._doAudit,Program:this._doVComponentAudit}};ruleDef.prototype._doAudit=function(context){if(context.suppData.obj){const meta=context.suppData.obj;const fullName=Utils.getComponentFullName(meta);const componentType=Utils.getComponentType(meta);if(componentType==='composite'){this._checkProps(context,fullName,meta.properties)}}};ruleDef.prototype._doVComponentAudit=function(context){const componentInfo=TsxUtils.matchToVComponentImpl(context,context.filepath);if(componentInfo){this._checkProps(context,componentInfo.fullName,componentInfo.properties)}};ruleDef.prototype._checkProps=function(context,fullName,properties){let issue;if(properties){const ariaDetect=/^aria[A-Z\-].*$/;Object.keys(properties).forEach(propName=>{if(ariaDetect.test(propName)){issue=new context.Issue(`Component ${fullName} defines a WAI-ARIA property ${propName} which is not allowed`);context.reporter.addIssue(issue,context)}})}};module.exports=ruleDef;

package/rulepacks/jetwc/jetwc-bootstrap.js

@@ -1,6 +1,6 @@
 /*
- * Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2018, 2022, Oracle and/or its affiliates.
  * Licensed under The Universal Permissive License (UPL), Version 1.0
  * as shown at https://oss.oracle.com/licenses/upl/
  */
-const path=require('path');const Utils=require('../jetwc-lib/component-audit-utils');const ruleDef=function(){};ruleDef.prototype.getName=function(){return'jetwc-bootstrap'};ruleDef.prototype.getShortDescription=function(){return'Bootstrap processing for the JETWC rulset'};ruleDef.prototype.getDescription=function(){return'This rule is for internal use by the ruleset and should not be disabled'};ruleDef.prototype.register=function(context){this.componentRoots=context.config.components;this.auditBase=context.config.base;return{startupRP:this._getAllVisibleComponents,closedownRP:this._reportDiagnostics}};ruleDef.prototype._getAllVisibleComponents=function(context){console.info(`${context.rulePack.getPackInfo().prefix}       : ${context.rulePack.getPackInfo().version}`);let masterComponentList=[];const projectPathInfo=Utils.getKeyPathInfoForRulepack(context,this.auditBase);if(projectPathInfo.exchangeCacheFolder){masterComponentList=masterComponentList.concat(this._getComponents(projectPathInfo.exchangeCacheFolder,false,false,context))}if(this.componentRoots&&this.componentRoots.length>0){this.componentRoots.forEach(root=>{masterComponentList=masterComponentList.concat(this._getComponents(root,true,projectPathInfo.isBuiltOutput,context))})}else{masterComponentList=masterComponentList.concat(this._getComponents(projectPathInfo.jsSource,true,projectPathInfo.isBuiltOutput,context));if(projectPathInfo.tsSource){masterComponentList=masterComponentList.concat(this._getComponents(projectPathInfo.tsSource,true,false,context))}}const componentRootFolder=context.rulePack.getRuleOptions().componentRoot||projectPathInfo.componentRootFolder;const allComponentsMap=masterComponentList.reduce((wmap,component)=>{if(!projectPathInfo.isBuiltOutput||projectPathInfo.isBuiltOutput&&!wmap.has(component.fullName)){wmap.set(component.fullName,component)}return wmap},new Map);const referenceComponents=new Map;const componentPaths=new Map;allComponentsMap.forEach(component=>{component.language=Utils.detectComponentSourceType(context,component.rootFolder);switch(component.type){case'reference':referenceComponents.set(component.fullName,component.ba);break;case'composite':case'resource':if(component.local){if(component.dependencies){Object.values(component.dependencies).forEach(dependencyName=>{if(allComponentsMap.has(dependencyName)){const proxyPaths=allComponentsMap.get(dependencyName).requirePaths;proxyPaths.forEach(path=>{component.requirePaths.add(path)})}})}componentPaths.set(component.rootFolder,component.fullName)}break;}});context.rulePack.setExtension({rulepackVersion:context.rulePack.getPackInfo().version,bootStrap:true,platform:Utils.isWindows?'Windows':'Unix-like',componentHome:`/${componentRootFolder}/`,auditBuildOutput:projectPathInfo.isBuiltOutput,discoveredPaths:projectPathInfo,componentRoots:this.componentRoots,allReferenceComponents:referenceComponents,allComponents:allComponentsMap,auditableComponentPaths:componentPaths,allAuditableFilePaths:new Map})};ruleDef.prototype._getComponents=function(rootDir,isLocal,builtOutput,auditContext){let componentArray=[];if(auditContext.utils.fsUtils.pathExistsSync(rootDir)){const compFileStructure=auditContext.utils.fsUtils.readDir(rootDir);compFileStructure.forEach(l1file=>{let componentInfo;if(!l1file.isFile&&l1file.files.length>0){l1file.files.forEach(l2file=>{if(!builtOutput){if(l2file.isFile&&l2file.name==='component.json'){componentInfo=Utils.extractComponentInfoFromJSONFile(auditContext,path.join(rootDir,l1file.name),'component.json',isLocal);componentArray.push(componentInfo);if(componentInfo.type==='pack'){const packMembers=this._getComponents(Utils.toJAFPath(path.join(rootDir,l1file.name)),isLocal,false,auditContext);componentArray=componentArray.concat(packMembers)}}}else{if(!l2file.isFile&&l2file.files.length>0){l2file.files.forEach(l3file=>{if(l3file.isFile&&l3file.name==='component.json'){componentInfo=Utils.extractComponentInfoFromJSONFile(auditContext,path.join(rootDir,l1file.name,l2file.name),'component.json',isLocal);if(!componentInfo.pack){componentArray.push(componentInfo);if(componentInfo.type==='pack'){const packMembers=this._getComponents(Utils.toJAFPath(path.join(rootDir,l1file.name,l2file.name)),isLocal,false,auditContext);componentArray=componentArray.concat(packMembers)}}}})}}})}else{if(l1file.isFile&&l1file.name==='component.json'){componentInfo=Utils.extractComponentInfoFromJSONFile(auditContext,rootDir,'component.json',isLocal);if(componentInfo.type!=='pack'){componentArray.push(componentInfo)}if(componentInfo.pack){console.warn(`Warning: It is recommended that your components list is configured with the pack root rather than individual pack members.  This will ensure that the entire pack will be processed correctly (${rootDir})`)}}}})}return componentArray};ruleDef.prototype._reportDiagnostics=function(context){const opts=context.rulePack.getRuleOptions();const diagnostics=context.rulePack.getExtension();if(!opts.testMode){let foundVMMapping=0;let candidateLocal=0;diagnostics.allComponents.forEach((component,compName)=>{if(component.local&&component.type==='composite'){candidateLocal++;if(component.viewModel&&component.viewModel.resolved){foundVMMapping++}}});if(foundVMMapping!==candidateLocal){console.error(`Error: Audit was only able to map ${foundVMMapping} out of ${candidateLocal} components to their viewModels. Some audits will be unable to operate.`)}}if(opts.debug&&opts.diagnosticFile){console.log(`Writing JETWC diagnostics to ${opts.diagnosticFile}.json`);const dFile=Utils.toJAFPath(path.join(path.resolve('.'),opts.diagnosticFile+'.json'));context.utils.fsUtils.writeJsonSync(diagnostics,dFile,{spaces:2,replacer:Utils.diagnosticReplacer})}};module.exports=ruleDef;
+const path=require('path');const Utils=require('../jetwc-lib/jetwcutils-componentAuditUtils');const componentFinder=require('../jetwc-lib/jetwcutils-componentFinder');const TsxUtils=require('../jetwc-lib/jetwcutils-tsxUtils');const preCompiler=require('../jetwc-lib/jetwcutils-preCompiler');const ruleDef=function(){};ruleDef.prototype.getName=function(){return'jetwc-bootstrap'};ruleDef.prototype.getShortDescription=function(){return'Bootstrap processing for the JETWC rulset'};ruleDef.prototype.getDescription=function(){return'This rule is for internal use by the ruleset and should not be disabled'};ruleDef.prototype.register=function(context){this.componentRoots=context.config.components;this.auditBase=context.config.base;this.typeScriptCompile=context.config.typescript&&context.config.typescript.compile;return{startupRP:this._getAllVisibleComponents,closedownRP:this._reportDiagnostics}};ruleDef.prototype._getAllVisibleComponents=function(context){const{msgLib}=context.utils;msgLib.info(`builtinJetWcRules (${context.rulePack.getPackInfo().prefix}): ${context.rulePack.getPackInfo().version}`);const projectPathInfo=Utils.getKeyPathInfoForRulepack(context,this.auditBase);const componentRootFolder=context.rulePack.getRuleOptions().componentRoot||projectPathInfo.componentRootFolder;let precompileCache;if(this.typeScriptCompile){precompileCache=preCompiler.getPrecompileCacheIfNeeded(context,this.auditBase,projectPathInfo.tsSource,projectPathInfo.componentRootFolder)}const masterComponentList=componentFinder.findAllComponents(context,projectPathInfo,this.componentRoots,precompileCache);if(masterComponentList&&masterComponentList.length>0){const allComponentsMap=masterComponentList.reduce((wmap,component)=>{if(!projectPathInfo.isBuiltOutput||projectPathInfo.isBuiltOutput&&!wmap.has(component.fullName)){wmap.set(component.fullName,component)}return wmap},new Map);const referenceComponents=new Map;const componentPaths=new Map;allComponentsMap.forEach(component=>{component.language=Utils.detectComponentSourceType(context,component.rootFolder,component.vcomponent);switch(component.type){case'reference':referenceComponents.set(component.fullName,component.ba);break;case'composite':case'resource':if(component.local){if(component.dependencies){Object.values(component.dependencies).forEach(dependency=>{if(allComponentsMap.has(dependency.name)){const proxyPaths=allComponentsMap.get(dependency.name).requirePaths;proxyPaths.forEach(path=>{component.requirePaths.add(path)})}else{msgLib.debug(`JETWC: missing dependency lookup for ${dependency.name} when resolving requirePaths`)}})}componentPaths.set(component.rootFolder,component.fullName)}break;}});context.rulePack.setExtension({rulepackVersion:context.rulePack.getPackInfo().version,bootStrap:true,platform:Utils.isWindows?'Windows':'Unix-like',precompiled:this.typeScriptCompile,componentHome:`/${componentRootFolder}/`,auditBuildOutput:projectPathInfo.isBuiltOutput,discoveredPaths:projectPathInfo,componentRoots:this.componentRoots,allReferenceComponents:referenceComponents,allComponents:allComponentsMap,auditableComponentPaths:componentPaths,allAuditableFilePaths:new Map})}else{msgLib.error(`No components have been discovered from the JAF configuration for the ${context.rulePack.getPackInfo().prefix} ruleset to process. You will need to configure the "components" array to point at your component root folder`);Utils.disableRulePack(context)}};ruleDef.prototype._reportDiagnostics=function(context){const msg=context.utils.msgLib;const opts=context.rulePack.getRuleOptions();const diagnostics=context.rulePack.getExtension();if(!opts.testMode){let foundVMMapping=0;let candidateLocal=0;if(diagnostics&&diagnostics.allComponents&&diagnostics.allComponents.length>0){diagnostics.allComponents.forEach((component,compName)=>{if(component.local&&component.type==='composite'){candidateLocal++;if(component.viewModel&&component.viewModel.resolved){foundVMMapping++}}});if(foundVMMapping!==candidateLocal){msgLib.error(`Error: Audit was only able to map ${foundVMMapping} out of ${candidateLocal} components to their viewModels. Some audits will be unable to operate.`)}}}if(opts.debug&&opts.diagnosticFile&&diagnostics){msgLib.msg(`Writing JETWC diagnostics to ${opts.diagnosticFile}.json`);const dFile=Utils.toJAFPath(path.join(path.resolve('.'),opts.diagnosticFile+'.json'));context.utils.fsUtils.writeJsonSync(diagnostics,dFile,{spaces:2,replacer:Utils.diagnosticReplacer})}};module.exports=ruleDef;

package/rulepacks/jetwc/jetwc-compjson-bp-ar.js

@@ -1,6 +1,6 @@
 /*
- * Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2018, 2022, Oracle and/or its affiliates.
  * Licensed under The Universal Permissive License (UPL), Version 1.0
  * as shown at https://oss.oracle.com/licenses/upl/
  */
-const path=require('path');const Utils=require('../jetwc-lib/component-audit-utils');const helperPos=require('../../rules/jet/helpers/json-propname-pos');const helperProp=require('../../rules/jet/helpers/bp-checkPropType');const ruleDef=function(){};ruleDef.prototype.getName=function(){return'jetwc-compjson-bp-ar'};ruleDef.prototype.getShortDescription=function(){return'Web component component.json metadata should follow best practices and avoid plain \'array\' type properties'};ruleDef.prototype.getDescription=function(){return'For best practices, web components should avoid use of unqualified property type \'array\', and provide a more complete definition of the API using a closure type definition'};ruleDef.prototype.register=function(context){if(context.rulePack.isRuleEnabled('oj-cca-compjson-bp-ar','JET')){return false}else{return{compjson:this._doAudit}}};ruleDef.prototype._doAudit=function(context){if(context.suppData.obj){const meta=context.suppData.obj;const componentName=Utils.getComponentFullName(meta);const componentType=Utils.getComponentType(meta);if(componentType==='composite'){const properties=meta.properties;if(properties){const arrayProps=helperProp(properties,'a');if(arrayProps){for(let i=0;i<arrayProps.length;i++){const checkProperty=arrayProps[i];const checkPropertyType=Utils.getPropertyAttributeFromPath(context,componentName,checkProperty,'type');if(checkPropertyType.toLowerCase()==='array'){if(!Utils.shouldIgnoreCheck(context,'jetwc-compjson-bp-ar',componentName,'properties',checkProperty)){const issue=new context.Issue(`property '${checkProperty}' is defined with unqualified type 'array'. Provide a more complete API definition using a closure type definition.`);const pos=helperPos(context,checkProperty);issue.setPosition(pos.row,pos.col,pos.index,pos.index?pos.index+6:0);context.reporter.addIssue(issue,context,'info')}}}}}}}};module.exports=ruleDef;
+const path=require('path');const Utils=require('../jetwc-lib/jetwcutils-componentAuditUtils');const helperProp=require('../../rules/jet/helpers/bp-checkPropType');const TsxUtils=require('../jetwc-lib/jetwcutils-tsxUtils');const ruleDef=function(){};ruleDef.prototype.getName=function(){return'jetwc-compjson-bp-ar'};ruleDef.prototype.getShortDescription=function(){return'Web component component.json metadata should follow best practices and avoid plain \'array\' type properties'};ruleDef.prototype.getDescription=function(){return'For best practices, web components should avoid use of unqualified property type \'array\', and provide a more complete definition of the API using a closure type definition'};ruleDef.prototype.register=function(context){if(context.rulePack.isRuleEnabled('oj-cca-compjson-bp-ar','JET')){return false}else{return{compjson:this._doAudit,Program:this._doVComponentAudit}}};ruleDef.prototype._doAudit=function(context){if(context.suppData.obj){const meta=context.suppData.obj;const fullName=Utils.getComponentFullName(meta);const componentType=Utils.getComponentType(meta);if(componentType==='composite'){this._checkProps(context,fullName,meta.properties)}}};ruleDef.prototype._doVComponentAudit=function(context){const componentInfo=TsxUtils.matchToVComponentImpl(context,context.filepath);if(componentInfo){this._checkProps(context,componentInfo.fullName,componentInfo.properties)}};ruleDef.prototype._checkProps=function(context,fullName,properties){if(properties){const arrayProps=helperProp(properties,'a');if(arrayProps){for(let i=0;i<arrayProps.length;i++){const checkProperty=arrayProps[i];const checkPropertyType=Utils.getPropertyAttributeFromPath(context,fullName,checkProperty,'type');if(checkPropertyType.toLowerCase()==='array'){if(!Utils.shouldIgnoreCheck(context,'jetwc-compjson-bp-ar',fullName,'properties',checkProperty)){const issue=new context.Issue(`property '${checkProperty}' is defined with unqualified type 'array'. Provide a more complete API definition using a closure type definition.`);context.reporter.addIssue(issue,context)}}}}}};module.exports=ruleDef;

package/rulepacks/jetwc/jetwc-compjson-bp-obj.js

@@ -1,6 +1,6 @@
 /*
- * Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2018, 2022, Oracle and/or its affiliates.
  * Licensed under The Universal Permissive License (UPL), Version 1.0
  * as shown at https://oss.oracle.com/licenses/upl/
  */
-const path=require('path');const Utils=require('../jetwc-lib/component-audit-utils');const helperPos=require('../../rules/jet/helpers/json-propname-pos');const helperProp=require('../../rules/jet/helpers/bp-checkPropType');const ruleDef=function(){};ruleDef.prototype.getName=function(){return'jetwc-compjson-bp-obj'};ruleDef.prototype.getShortDescription=function(){return'Web component component.json metadata should follow best practices and avoid \'object\' type properties'};ruleDef.prototype.getDescription=function(){return'For best practices, web components should avoid use of the property type \'object\' without sub-properties, and provide a more complete definition of the API either using sub-properties or using a closure type definition'};ruleDef.prototype.register=function(context){if(context.rulePack.isRuleEnabled('oj-cca-compjson-bp-obj','JET')){return false}else{return{compjson:this._doAudit}}};ruleDef.prototype._doAudit=function(context){if(context.suppData.obj){const meta=context.suppData.obj;const componentName=Utils.getComponentFullName(meta);const componentType=Utils.getComponentType(meta);if(componentType==='composite'){const properties=meta.properties;if(properties){const objectProps=helperProp(properties,'o');if(objectProps){for(let i=0;i<objectProps.length;i++){const checkProperty=objectProps[i];if(!this._hasSub_properties(properties,checkProperty)){if(!Utils.shouldIgnoreCheck(context,'jetwc-compjson-bp-obj',componentName,'properties',checkProperty)){const issue=new context.Issue(`property '${checkProperty}' of  type 'object' has no sub-properties. Provide a more complete API definition using sub-properties or a closure type definition`);const pos=helperPos(context,checkProperty);issue.setPosition(pos.row,pos.col,pos.index,pos.index?pos.index+6:0);context.reporter.addIssue(issue,context,'info')}}}}}}}};ruleDef.prototype._hasSub_properties=function(props,prop){var subprop,a,i;if(!prop.includes('.')){return!!props[prop].properties}a=prop.split('.');for(i=0;i<a.length;i++){subprop=props[a[i]];if(subprop&&subprop.properties){if(a.length-1===i){return true}props=subprop.properties;continue}break}return false};module.exports=ruleDef;
+const Utils=require('../jetwc-lib/jetwcutils-componentAuditUtils');const helperProp=require('../../rules/jet/helpers/bp-checkPropType');const TsxUtils=require('../jetwc-lib/jetwcutils-tsxUtils');const ruleDef=function(){};ruleDef.prototype.getName=function(){return'jetwc-compjson-bp-obj'};ruleDef.prototype.getShortDescription=function(){return'Web component component.json metadata should follow best practices and avoid \'object\' type properties'};ruleDef.prototype.getDescription=function(){return'For best practices, web components should avoid use of the property type \'object\' without sub-properties, and provide a more complete definition of the API either using sub-properties or using a closure type definition'};ruleDef.prototype.register=function(context){if(context.rulePack.isRuleEnabled('oj-cca-compjson-bp-obj','JET')){return false}else{return{compjson:this._doAudit,Program:this._doVComponentAudit}}};ruleDef.prototype._doAudit=function(context){if(context.suppData.obj){const meta=context.suppData.obj;const fullName=Utils.getComponentFullName(meta);const componentType=Utils.getComponentType(meta);if(componentType==='composite'){this._checkProps(context,fullName,meta.properties)}}};ruleDef.prototype._doVComponentAudit=function(context){const componentInfo=TsxUtils.matchToVComponentImpl(context,context.filepath);if(componentInfo){this._checkProps(context,componentInfo.fullName,componentInfo.properties)}};ruleDef.prototype._checkProps=function(context,fullName,properties){if(properties){const objectProps=helperProp(properties,'o');if(objectProps){for(let i=0;i<objectProps.length;i++){const checkProperty=objectProps[i];if(!this._hasSub_properties(properties,checkProperty)){if(!Utils.shouldIgnoreCheck(context,'jetwc-compjson-bp-obj',fullName,'properties',checkProperty)){const issue=new context.Issue(`property '${checkProperty}' of type 'object' has no sub-properties. Provide a more complete API definition using sub-properties or a closure type definition`);context.reporter.addIssue(issue,context)}}}}}};ruleDef.prototype._hasSub_properties=function(props,prop){var subprop,a,i;if(!prop.includes('.')){return!!props[prop].properties}a=prop.split('.');for(i=0;i<a.length;i++){subprop=props[a[i]];if(subprop&&subprop.properties){if(a.length-1===i){return true}props=subprop.properties;continue}break}return false};module.exports=ruleDef;

package/rulepacks/jetwc/jetwc-component-dependencies.js

@@ -1,6 +1,6 @@
 /*
- * Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2018, 2022, Oracle and/or its affiliates.
  * Licensed under The Universal Permissive License (UPL), Version 1.0
  * as shown at https://oss.oracle.com/licenses/upl/
  */
-const Utils=require('../jetwc-lib/component-audit-utils');const ruleDef=function(){};ruleDef.prototype.getName=function(){return'jetwc-component-dependencies'};ruleDef.prototype.getShortDescription=function(){return'Validate the stated dependencies for a component'};ruleDef.prototype.getDescription=function(){return'This rule checks that any dependencies defined for a component actually exist in the context of the project and are correct'};ruleDef.prototype.register=function(context){return{compjson:this._doAudit}};ruleDef.prototype._doAudit=function(context){if(context.rulePack.getExtension()&&context.rulePack.getExtension().hasOwnProperty('allComponents')){const componentMetadata=context.suppData.obj;const componentType=Utils.getComponentType(componentMetadata);const allVisibleComponents=context.rulePack.getExtension().allComponents;if(componentMetadata){let issue;if(componentMetadata.dependencies){Object.keys(componentMetadata.dependencies).forEach(dependency=>{const dependentVersion=componentMetadata.dependencies[dependency];if(componentType==='pack'){if(!context.utils.semVerUtils.isValid(dependentVersion)){issue=new context.Issue(`Pack dependency '${dependency}':'${componentMetadata.dependencies[dependency]}' in ${componentMetadata.name} must be an absolute semver version not a range`);issue.setMsgKey(context.ruleName+'_1');context.reporter.addIssue(issue,context,'blocker')}}else{if(!context.utils.semVerUtils.isValidRange(dependentVersion)){issue=new context.Issue(`Component dependency '${dependency}':'${componentMetadata.dependencies[dependency]}' in ${componentMetadata.name} is not a valid semver or semver range`);issue.setMsgKey(context.ruleName+'_2');context.reporter.addIssue(issue,context,'blocker')}else{if(componentMetadata.type&&componentMetadata.type==='demo'&&context.utils.semVerUtils.isValid(dependentVersion)){issue=new context.Issue(`Demo component ${componentMetadata.name} depends on an absolute version of '${dependency}':'${componentMetadata.dependencies[dependency]}', range support is preferred for demos`);issue.setMsgKey(context.ruleName+'_3');context.reporter.addIssue(issue,context,'info')}}}if(!issue){if(!allVisibleComponents.has(dependency)){issue=new context.Issue(`Component dependency '${dependency}':'${componentMetadata.dependencies[dependency]}' in '${componentMetadata.name}' has no match in the project`);issue.setMsgKey(context.ruleName+'_4');context.reporter.addIssue(issue,context,'blocker')}else{const availableVersion=allVisibleComponents.get(dependency).version;if(!context.utils.semVerUtils.satisfiesRange(availableVersion,dependentVersion)){issue=new context.Issue(`Component dependency '${dependency}' in '${componentMetadata.name}' exists in the project but the versions are mismatched. Requested:'${dependentVersion}', version available in project: '${availableVersion}'`);issue.setMsgKey(context.ruleName+'_5');context.reporter.addIssue(issue,context,'blocker')}}}})}}}else{Utils.reportMissingBootstrapInfo(context,'allComponents')}};module.exports=ruleDef;
+const Utils=require('../jetwc-lib/jetwcutils-componentAuditUtils');const TsxUtils=require('../jetwc-lib/jetwcutils-tsxUtils');const ruleDef=function(){};ruleDef.prototype.getName=function(){return'jetwc-component-dependencies'};ruleDef.prototype.getShortDescription=function(){return'Validate the stated dependencies for a component'};ruleDef.prototype.getDescription=function(){return'This rule checks that any dependencies defined for a component actually exist in the context of the project and are correct'};ruleDef.prototype.register=function(context){return{compjson:this._doAudit,Program:this._doVComponentAudit}};ruleDef.prototype._doAudit=function(context){if(context.rulePack.getExtension()&&context.rulePack.getExtension().hasOwnProperty('allComponents')){const componentMetadata=context.suppData.obj;const componentType=Utils.getComponentType(componentMetadata);if(componentMetadata){let issue;if(componentMetadata.dependencies){Object.keys(componentMetadata.dependencies).forEach(dependency=>{const dependentVersion=componentMetadata.dependencies[dependency];if(componentType==='pack'){if(!context.utils.semVerUtils.isValid(dependentVersion)){issue=new context.Issue(`Pack dependency '${dependency}':'${componentMetadata.dependencies[dependency]}' in ${componentMetadata.name} must be an absolute semver version not a range`);issue.setMsgKey(context.ruleName+'_1');context.reporter.addIssue(issue,context)}}else{if(!context.utils.semVerUtils.isValidRange(dependentVersion)){issue=new context.Issue(`Component dependency '${dependency}':'${componentMetadata.dependencies[dependency]}' in ${componentMetadata.name} is not a valid semver or semver range`);issue.setMsgKey(context.ruleName+'_2');context.reporter.addIssue(issue,context)}else{if(componentMetadata.type&&componentMetadata.type==='demo'&&context.utils.semVerUtils.isValid(dependentVersion)){issue=new context.Issue(`Demo component ${componentMetadata.name} depends on an absolute version of '${dependency}':'${componentMetadata.dependencies[dependency]}', range support is preferred for demos`);issue.setMsgKey(context.ruleName+'_3');context.reporter.addIssue(issue,context,'info')}}}if(!issue){this._validateDependency(context,componentMetadata.name,dependency,componentMetadata.dependencies[dependency])}})}}}else{Utils.reportMissingBootstrapInfo(context,'allComponents')}};ruleDef.prototype._doVComponentAudit=function(context){const componentInfo=TsxUtils.matchToVComponentImpl(context,context.filepath);if(componentInfo){if(componentInfo.dependencies){componentInfo.dependencies.forEach(dependency=>{this._validateDependency(context,componentInfo.fullName,dependency.name,dependency.range)})}}};ruleDef.prototype._validateDependency=function(context,fullName,dependencyName,dependencyVersion){const allVisibleComponents=context.rulePack.getExtension().allComponents;if(!allVisibleComponents.has(dependencyName)){issue=new context.Issue(`Component dependency '${dependencyName}':'${dependencyVersion}' in '${fullName}' has no match in the project`);issue.setMsgKey(context.ruleName+'_4');context.reporter.addIssue(issue,context)}else{const availableVersion=allVisibleComponents.get(dependencyName).version;if(!context.utils.semVerUtils.satisfiesRange(availableVersion,dependencyVersion)){issue=new context.Issue(`Component dependency '${dependencyName}' in '${fullName}' exists in the project but the versions are mismatched. Requested:'${dependencyVersion}', version available in project: '${availableVersion}'`);issue.setMsgKey(context.ruleName+'_5');context.reporter.addIssue(issue,context)}}};module.exports=ruleDef;

package/rulepacks/jetwc/jetwc-component-displayname.js

@@ -1,6 +1,6 @@
 /*
- * Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2018, 2022, Oracle and/or its affiliates.
  * Licensed under The Universal Permissive License (UPL), Version 1.0
  * as shown at https://oss.oracle.com/licenses/upl/
  */
-const Utils=require('../jetwc-lib/component-audit-utils');const ruleDef=function(){};ruleDef.prototype.getName=function(){return'jetwc-component-displayname'};ruleDef.prototype.getShortDescription=function(){return'Check component has display name defined'};ruleDef.prototype.getDescription=function(){return'This rule checks that the component has a display name supplied to make the user experience in Visual Builder and Exchange as useful as possible'};ruleDef.prototype.register=function(context){if(context.rulePack.isRuleEnabled('oj-cca-compjson-bp-dsplyname','JET')){return false}else{return{compjson:this._doAudit}}};ruleDef.prototype._doAudit=function(context){if(context.suppData.obj){let issue;const meta=context.suppData.obj;if(!meta.hasOwnProperty('displayName')){issue=new context.Issue(`displayName for component should be defined`);context.reporter.addIssue(issue,context,'info')}}};module.exports=ruleDef;
+const Utils=require('../jetwc-lib/jetwcutils-componentAuditUtils');const TsxUtils=require('../jetwc-lib/jetwcutils-tsxUtils');const ruleDef=function(){};ruleDef.prototype.getName=function(){return'jetwc-component-displayname'};ruleDef.prototype.getShortDescription=function(){return'Check component has display name defined'};ruleDef.prototype.getDescription=function(){return'This rule checks that the component has a display name supplied to make the user experience in Visual Builder and Exchange as useful as possible'};ruleDef.prototype.register=function(context){if(context.rulePack.isRuleEnabled('oj-cca-compjson-bp-dsplyname','JET')){return false}else{return{compjson:this._doAudit,Program:this._doVComponentAudit}}};ruleDef.prototype._doAudit=function(context){if(context.suppData.obj){this._checkDisplayName(context,context.suppData.obj)}};ruleDef.prototype._checkDisplayName=function(context,meta){let issue;if(!meta.hasOwnProperty('displayName')||meta.displayName===undefined||meta.displayName.length===0){issue=new context.Issue(`displayName for component should be defined`);context.reporter.addIssue(issue,context)}};ruleDef.prototype._doVComponentAudit=function(context){const componentInfo=TsxUtils.matchToVComponentImpl(context,context.filepath);if(componentInfo){this._checkDisplayName(context,componentInfo)}};module.exports=ruleDef;

package/rulepacks/jetwc/jetwc-component-foldername.js

@@ -1,6 +1,6 @@
 /*
- * Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2018, 2022, Oracle and/or its affiliates.
  * Licensed under The Universal Permissive License (UPL), Version 1.0
  * as shown at https://oss.oracle.com/licenses/upl/
  */
-const path=require('path');const Utils=require('../jetwc-lib/component-audit-utils');const ruleDef=function(){};ruleDef.prototype.getName=function(){return'jetwc-component-foldername'};ruleDef.prototype.getShortDescription=function(){return'Ensure components are defined in the correctly named folder'};ruleDef.prototype.getDescription=function(){return'This rule applies to both singleton and JET Pack components and verifies that they are correctly named in the folder structure based on their type'};ruleDef.prototype.register=function(context){return{compjson:this._doAudit}};ruleDef.prototype._doAudit=function(context){if(context.rulePack.getExtension()&&context.rulePack.getExtension().hasOwnProperty('auditBuildOutput')){if(context.suppData.obj){let issue;const meta=context.suppData.obj;const fullName=Utils.getComponentFullName(meta);const componentName=meta.name;const componentVersion=meta.version;const pathSegments=context.filepath.split('/');const componentFolder=pathSegments[pathSegments.length-2];const componentParentFolder=pathSegments[pathSegments.length-3];let expectedFolder;const processingBuilt=context.rulePack.getExtension().auditBuildOutput;if(!processingBuilt||meta.pack){expectedFolder=componentName}else{expectedFolder=componentVersion}if(componentFolder!==expectedFolder){issue=new context.Issue(`${processingBuilt?'For built output ':''}Component '${fullName}' should be defined in a folder called '${processingBuilt?componentName+path.sep:''}${expectedFolder}' not '${processingBuilt?componentParentFolder+path.sep:''}${componentFolder}' for referencing to work correctly`);context.reporter.addIssue(issue,context,'blocker')}}}else{Utils.reportMissingBootstrapInfo(context,'auditBuildOutput')}};module.exports=ruleDef;
+const path=require('path');const Utils=require('../jetwc-lib/jetwcutils-componentAuditUtils');const TsxUtils=require('../jetwc-lib/jetwcutils-tsxUtils');const ruleDef=function(){};ruleDef.prototype.getName=function(){return'jetwc-component-foldername'};ruleDef.prototype.getShortDescription=function(){return'Ensure components are defined in the correctly named folder'};ruleDef.prototype.getDescription=function(){return'This rule applies to both singleton and JET Pack components and verifies that they are correctly named in the folder structure based on their type'};ruleDef.prototype.register=function(context){return{compjson:this._doAudit,Program:this._doVComponentAudit}};ruleDef.prototype._doAudit=function(context){if(context.rulePack.getExtension()&&context.rulePack.getExtension().hasOwnProperty('auditBuildOutput')){if(context.suppData.obj){let issue;const meta=context.suppData.obj;const fullName=Utils.getComponentFullName(meta);const componentName=meta.name;const componentVersion=meta.version;const pathSegments=context.filepath.split('/');const componentFolder=pathSegments[pathSegments.length-2];const componentParentFolder=pathSegments[pathSegments.length-3];let expectedFolder;const processingBuilt=context.rulePack.getExtension().auditBuildOutput;if(!processingBuilt||meta.pack){expectedFolder=componentName}else{expectedFolder=componentVersion}if(componentFolder!==expectedFolder){issue=new context.Issue(`${processingBuilt?'For built output ':''}Component '${fullName}' should be defined in a folder called '${processingBuilt?componentName+path.sep:''}${expectedFolder}' not '${processingBuilt?componentParentFolder+path.sep:''}${componentFolder}' for referencing to work correctly`);context.reporter.addIssue(issue,context)}}}else{Utils.reportMissingBootstrapInfo(context,'auditBuildOutput')}};ruleDef.prototype._doVComponentAudit=function(context){const componentInfo=TsxUtils.matchToVComponentImpl(context,context.filepath);if(componentInfo){const fullName=componentInfo.fullName;let expectedPath=componentInfo.pack?componentInfo.name:componentInfo.fullName;const pathSegments=context.filepath.split('/');const componentFolder=pathSegments[pathSegments.length-2];const parentFolder=pathSegments[pathSegments.length-3];if(componentFolder!==expectedPath){issue=new context.Issue(`Component '${fullName}' should be defined in a folder called '${expectedPath}' not '${componentFolder}' for referencing to work correctly`);context.reporter.addIssue(issue,context)}}};module.exports=ruleDef;

package/rulepacks/jetwc/jetwc-component-location.js

@@ -1,6 +1,6 @@
 /*
- * Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2018, 2022, Oracle and/or its affiliates.
  * Licensed under The Universal Permissive License (UPL), Version 1.0
  * as shown at https://oss.oracle.com/licenses/upl/
  */
-const path=require('path');const Utils=require('../jetwc-lib/component-audit-utils');const ruleDef=function(){};ruleDef.prototype.getName=function(){return'jetwc-component-location'};ruleDef.prototype.getShortDescription=function(){return'Ensure components are defined in the correct folder structure'};ruleDef.prototype.getDescription=function(){return'This rule applies to both singleton and JET Pack components and verifies that they are correctly placed in the folder structure based on their naming'};ruleDef.prototype.register=function(context){return{compjson:this._doAudit}};ruleDef.prototype._doAudit=function(context){if(context.rulePack.getExtension()&&context.rulePack.getExtension().hasOwnProperty('auditBuildOutput')){if(context.suppData.obj){let issue;const meta=context.suppData.obj;const componentParentPack=meta.pack;const componentName=meta.name;const fullName=Utils.getComponentFullName(meta);const pathSegments=context.filepath.split('/');const componentRoot=context.rulePack.getExtension().componentHome;const sepStrip=/\//g;const parentFolder=pathSegments[pathSegments.length-3];const grandParentFolder=pathSegments[pathSegments.length-4];let expectedParent;let expectedGrandParent;const processingBuilt=context.rulePack.getExtension().auditBuildOutput;if(processingBuilt){if(componentParentPack){expectedParent=Utils.componentInfo(context,componentParentPack).version;expectedGrandParent=componentParentPack}else{expectedParent=componentName;expectedGrandParent=componentRoot.replace(sepStrip,'');;}}else{if(componentParentPack){expectedParent=componentParentPack;expectedGrandParent=componentRoot.replace(sepStrip,'')}else{expectedParent=componentRoot.replace(sepStrip,'')}}if(parentFolder!==expectedParent){if(!processingBuilt){issue=new context.Issue(`Component '${fullName}' should be defined in a folder which is a child of '${expectedParent}'`);issue.setMsgKey(context.ruleName+'_1')}else{issue=new context.Issue(`Built component '${fullName}' should be present in a folder which is a child of '${expectedGrandParent}${path.sep}${expectedParent}'`);issue.setMsgKey(context.ruleName+'_3')}}if(!issue){if(expectedGrandParent&&grandParentFolder!==expectedGrandParent){issue=new context.Issue(`Parent folder for ${processingBuilt?'built':''} component '${fullName}' should be present in a folder called '${expectedGrandParent}'`);issue.setMsgKey(context.ruleName+'_2')}}if(issue){context.reporter.addIssue(issue,context,'blocker')}}}else{Utils.reportMissingBootstrapInfo(context,'auditBuildOutput')}};module.exports=ruleDef;
+const path=require('path');const Utils=require('../jetwc-lib/jetwcutils-componentAuditUtils');const TsxUtils=require('../jetwc-lib/jetwcutils-tsxUtils');const ruleDef=function(){};ruleDef.prototype.getName=function(){return'jetwc-component-location'};ruleDef.prototype.getShortDescription=function(){return'Ensure components are defined in the correct folder structure'};ruleDef.prototype.getDescription=function(){return'This rule applies to both singleton and JET Pack components and verifies that they are correctly placed in the folder structure based on their naming'};ruleDef.prototype.register=function(context){return{compjson:this._doAudit}};ruleDef.prototype._doAudit=function(context){if(context.rulePack.getExtension()&&context.rulePack.getExtension().hasOwnProperty('auditBuildOutput')){if(context.suppData.obj){let issue;const meta=context.suppData.obj;const componentParentPack=meta.pack;const componentName=meta.name;const fullName=Utils.getComponentFullName(meta);const pathSegments=context.filepath.split('/');const componentRoot=context.rulePack.getExtension().componentHome;const sepStrip=/\//g;const parentFolder=pathSegments[pathSegments.length-3];const grandParentFolder=pathSegments[pathSegments.length-4];let expectedParent;let expectedGrandParent;const processingBuilt=context.rulePack.getExtension().auditBuildOutput;if(processingBuilt){if(componentParentPack){expectedParent=Utils.componentInfo(context,componentParentPack).version;expectedGrandParent=componentParentPack}else{expectedParent=componentName;expectedGrandParent=componentRoot.replace(sepStrip,'')}}else{if(componentParentPack){expectedParent=componentParentPack;expectedGrandParent=componentRoot.replace(sepStrip,'')}else{expectedParent=componentRoot.replace(sepStrip,'')}}if(parentFolder!==expectedParent){if(!processingBuilt){issue=new context.Issue(`Component '${fullName}' should be defined in a folder which is a child of '${expectedParent}'`);issue.setMsgKey(context.ruleName+'_1')}else{issue=new context.Issue(`Built component '${fullName}' should be present in a folder which is a child of '${expectedGrandParent}${path.sep}${expectedParent}'`);issue.setMsgKey(context.ruleName+'_3')}}if(!issue){if(expectedGrandParent&&grandParentFolder!==expectedGrandParent){issue=new context.Issue(`Parent folder for ${processingBuilt?'built':''} component '${fullName}' should be present in a folder called '${expectedGrandParent}'`);issue.setMsgKey(context.ruleName+'_2')}}if(issue){context.reporter.addIssue(issue,context)}}}else{Utils.reportMissingBootstrapInfo(context,'auditBuildOutput')}};module.exports=ruleDef;

package/rulepacks/jetwc/jetwc-component-type.js

@@ -1,6 +1,6 @@
 /*
- * Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2018, 2022, Oracle and/or its affiliates.
  * Licensed under The Universal Permissive License (UPL), Version 1.0
  * as shown at https://oss.oracle.com/licenses/upl/
  */
-const Utils=require('../jetwc-lib/component-audit-utils');const ruleDef=function(){};ruleDef.prototype.getName=function(){return'jetwc-component-type'};ruleDef.prototype.getShortDescription=function(){return'Check component has an explicit type defined'};ruleDef.prototype.getDescription=function(){return'This rule checks that the component explicitly defines a type attribute rather than relying on the original fallback behavior and assuming composite'};ruleDef.prototype.register=function(context){return{compjson:this._doAudit}};ruleDef.prototype._doAudit=function(context){if(context.suppData.obj){let issue;const meta=context.suppData.obj;if(!meta.hasOwnProperty('type')){issue=new context.Issue(`type for component should be explicitly defined rather than assuming the default`);context.reporter.addIssue(issue,context,'info')}}};module.exports=ruleDef;
+const Utils=require('../jetwc-lib/jetwcutils-componentAuditUtils');const ruleDef=function(){};ruleDef.prototype.getName=function(){return'jetwc-component-type'};ruleDef.prototype.getShortDescription=function(){return'Check component has an explicit type defined'};ruleDef.prototype.getDescription=function(){return'This rule checks that the component explicitly defines a type attribute rather than relying on the original fallback behavior and assuming composite'};ruleDef.prototype.register=function(context){return{compjson:this._doAudit}};ruleDef.prototype._doAudit=function(context){if(context.suppData.obj){let issue;const meta=context.suppData.obj;if(!meta.hasOwnProperty('type')){issue=new context.Issue(`type for component should be explicitly defined rather than assuming the default`);context.reporter.addIssue(issue,context)}}};module.exports=ruleDef;

package/rulepacks/jetwc/jetwc-css-oj-complete.js

@@ -0,0 +1,6 @@
+/*
+ * Copyright (c) 2018, 2022, Oracle and/or its affiliates.
+ * Licensed under The Universal Permissive License (UPL), Version 1.0
+ * as shown at https://oss.oracle.com/licenses/upl/
+ */
+const Utils=require('../jetwc-lib/jetwcutils-componentAuditUtils');const ruleDef=function(){};ruleDef.prototype.getName=function(){return'jetwc-css-oj-complete'};ruleDef.prototype.getShortDescription=function(){return'Verify that a component CSS implementation includes the standard definition for hiding itself before it is fully initialized'};ruleDef.prototype.getDescription=function(){return'All custom components should include a selector definition for the component tag that ensures that it is hidden until the oj-complete marker class is applied. This is managed through the use of the :not(.oj-complete) pseudo-class setting the visibility to hidden'};ruleDef.prototype.register=function(context){return{startaudit:this._ruleSetup,'css-selector':this._detectNotSelector,endaudit:this._reportUnmatchedComponents}};ruleDef.prototype._ruleSetup=function(context){this.validOjCompleteSelectors=new Set};ruleDef.prototype._detectNotSelector=function(context,selector){if(selector.type==='Selector'&&selector.children.length===2&&selector.children[0].type==='TypeSelector'&&selector.children[1].type==='PseudoClassSelector'&&selector.children[1].name==='not'){const selectorComponentName=selector.children[0].name;const componentInfo=Utils.componentInfo(context,selectorComponentName);if(componentInfo&&selector.children[1].children.length>0&&selector.children[1].children[0].type==='SelectorList'&&selector.children[1].children[0].children.length>0&&selector.children[1].children[0].children[0].type==='Selector'&&selector.children[1].children[0].children[0].children.length>0&&selector.children[1].children[0].children[0].children[0].type==='ClassSelector'&&selector.children[1].children[0].children[0].children[0].name==='oj-complete'){this.validOjCompleteSelectors.add(selectorComponentName)}}};ruleDef.prototype._reportUnmatchedComponents=function(context){const allComponents=context.rulePack.getExtension().allComponents;debugger;if(allComponents){for(const[componentName,componentDef]of allComponents.entries()){if(componentDef.type==='composite'){const fullName=componentDef.fullName;if(!this.validOjCompleteSelectors.has(fullName)){if(!Utils.shouldIgnoreCheck(context,this.getName(),fullName)){const issue=new context.Issue(`Component '${fullName}' does not have a defined CSS sector for :not(.oj-complete)`);context.reporter.addIssue(issue,context)}}}}}};module.exports=ruleDef;

package/rulepacks/jetwc/jetwc-data-property-prefix.js

@@ -1,6 +1,6 @@
 /*
- * Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2018, 2022, Oracle and/or its affiliates.
  * Licensed under The Universal Permissive License (UPL), Version 1.0
  * as shown at https://oss.oracle.com/licenses/upl/
  */
-const Utils=require('../jetwc-lib/component-audit-utils');const ruleDef=function(){};ruleDef.prototype.getName=function(){return'jetwc-data-property-prefix'};ruleDef.prototype.getShortDescription=function(){return'Ensure that the component does not define properties with a data* prefix'};ruleDef.prototype.getDescription=function(){return'This rule checks that a component has not defined any property that once translated to an attribute becomes a data-* attribute. This involves checking the property name of top level properties only for the prefix of data followed by an uppercase letter. The property name data on its own is OK'};ruleDef.prototype.register=function(context){return{compjson:this._doAudit}};ruleDef.prototype._doAudit=function(context){if(context.suppData.obj){let issue;const meta=context.suppData.obj;const fullName=Utils.getComponentFullName(meta);const componentType=Utils.getComponentType(meta);if(componentType==='composite'&&meta.properties){const dataDetect=/^data[A-Z\-].*$/;Object.keys(meta.properties).forEach(propName=>{if(dataDetect.test(propName)){issue=new context.Issue(`Component ${fullName} defines a data prefixed property ${propName} which is not allowed`);context.reporter.addIssue(issue,context,'minor')}})}}};module.exports=ruleDef;
+const Utils=require('../jetwc-lib/jetwcutils-componentAuditUtils');const TsxUtils=require('../jetwc-lib/jetwcutils-tsxUtils');const ruleDef=function(){};ruleDef.prototype.getName=function(){return'jetwc-data-property-prefix'};ruleDef.prototype.getShortDescription=function(){return'Ensure that the component does not define properties with a data* prefix'};ruleDef.prototype.getDescription=function(){return'This rule checks that a component has not defined any property that once translated to an attribute becomes a data-* attribute. This involves checking the property name of top level properties only for the prefix of data followed by an uppercase letter. The property name data on its own is OK'};ruleDef.prototype.register=function(context){return{compjson:this._doAudit,Program:this._doVComponentAudit}};ruleDef.prototype._doAudit=function(context){if(context.suppData.obj){const meta=context.suppData.obj;const fullName=Utils.getComponentFullName(meta);const componentType=Utils.getComponentType(meta);if(componentType==='composite'){this._checkProps(context,fullName,meta.properties)}}};ruleDef.prototype._doVComponentAudit=function(context){const componentInfo=TsxUtils.matchToVComponentImpl(context,context.filepath);if(componentInfo){this._checkProps(context,componentInfo.fullName,componentInfo.properties)}};ruleDef.prototype._checkProps=function(context,fullName,properties){let issue;if(properties){const dataDetect=/^data[A-Z\-].*$/;Object.keys(properties).forEach(propName=>{if(dataDetect.test(propName)){issue=new context.Issue(`Component ${fullName} defines a data prefixed property ${propName} which is not allowed`);context.reporter.addIssue(issue,context)}})}};module.exports=ruleDef;

package/rulepacks/jetwc/jetwc-deprecated-lifecycle.js

@@ -1,6 +1,6 @@
 /*
- * Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2018, 2022, Oracle and/or its affiliates.
  * Licensed under The Universal Permissive License (UPL), Version 1.0
  * as shown at https://oss.oracle.com/licenses/upl/
  */
-const Utils=require('../jetwc-lib/component-audit-utils');const ruleDef=function(){};ruleDef.prototype.getName=function(){return'jetwc-deprecated-lifecycle'};ruleDef.prototype.getShortDescription=function(){return'Checks for deprecated component lifecycle definitions'};ruleDef.prototype.getDescription=function(){return'This rule ensures that the component does not still declare deprecated lifecycle methods such as attached'};ruleDef.prototype.register=function(context){return{FunctionExpression:Utils.setupFileMethodMapping.bind(Utils),ArrowFunctionExpression:Utils.setupFileMethodMapping.bind(Utils),CallExpression:Utils.deriveViewModels.bind(Utils),MethodDefinition:Utils.setupFileMethodMappingFromMethodDefintion.bind(Utils),closedownRP:this._doAudit}};ruleDef.prototype._doAudit=function(context){let issue;context.rulePack.getExtension().allComponents.forEach(compInfo=>{const vmMethods=Utils.getVMMethodsForLocalComposite(context,compInfo);if(vmMethods&&(vmMethods.has('attached')||vmMethods.has('detached')||vmMethods.has('initialize')||vmMethods.has('dispose'))){issue=new context.Issue(`Component '${compInfo.fullName}' still defines one or more of the following deprecated lifecycle methods: attached(), detached(), dispose(), initialize()`);context.reporter.addIssue(issue,context,'major')}})};module.exports=ruleDef;
+const Utils=require('../jetwc-lib/jetwcutils-componentAuditUtils');const ruleDef=function(){};ruleDef.prototype.getName=function(){return'jetwc-deprecated-lifecycle'};ruleDef.prototype.getShortDescription=function(){return'Checks for deprecated component lifecycle definitions'};ruleDef.prototype.getDescription=function(){return'This rule ensures that the component does not still declare deprecated lifecycle methods such as attached'};ruleDef.prototype.register=function(context){return{FunctionExpression:Utils.setupFileMethodMapping.bind(Utils),ArrowFunctionExpression:Utils.setupFileMethodMapping.bind(Utils),CallExpression:Utils.deriveViewModels.bind(Utils),MethodDefinition:Utils.setupFileMethodMappingFromMethodDefintion.bind(Utils),closedownRP:this._doAudit}};ruleDef.prototype._doAudit=function(context){let issue;if(context.rulePack.getExtension()){context.rulePack.getExtension().allComponents.forEach(compInfo=>{const vmMethods=Utils.getVMMethodsForLocalComposite(context,compInfo);if(vmMethods&&(vmMethods.has('attached')||vmMethods.has('detached')||vmMethods.has('initialize')||vmMethods.has('dispose'))){issue=new context.Issue(`Component '${compInfo.fullName}' still defines one or more of the following deprecated lifecycle methods: attached(), detached(), dispose(), initialize()`);context.reporter.addIssue(issue,context)}})}};module.exports=ruleDef;

package/rulepacks/jetwc/jetwc-disabled-property.js

@@ -1,6 +1,6 @@
 /*
- * Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2018, 2022, Oracle and/or its affiliates.
  * Licensed under The Universal Permissive License (UPL), Version 1.0
  * as shown at https://oss.oracle.com/licenses/upl/
  */
-const Utils=require('../jetwc-lib/component-audit-utils');const ruleDef=function(){};ruleDef.prototype.getName=function(){return'jetwc-disabled-property'};ruleDef.prototype.getShortDescription=function(){return'Check component does not use the problematic disabled property'};ruleDef.prototype.getDescription=function(){return'This rule checks that a component does not define a property called disabled which can cause issues with IE'};ruleDef.prototype.register=function(context){return{compjson:this._doAudit}};ruleDef.prototype._doAudit=function(context){if(context.suppData.obj){let issue;const meta=context.suppData.obj;const fullName=Utils.getComponentFullName(meta);const componentType=Utils.getComponentType(meta);if(componentType==='composite'){if(meta.properties&&meta.properties.hasOwnProperty('disabled')){var deprecated=false;if(meta.properties.disabled.hasOwnProperty('status')){var statusArray=meta.properties.disabled.status;statusArray.forEach(status=>{if(status.hasOwnProperty('type')){if(status.type==='deprecated'){deprecated=true}}})}if(!deprecated){issue=new context.Issue(`Component ${fullName} defines a property called 'disabled' this can cause problems with Internet Explorer and we recommend 'disable' as a replacement property name`);context.reporter.addIssue(issue,context,'minor')}}}}};module.exports=ruleDef;
+const Utils=require('../jetwc-lib/jetwcutils-componentAuditUtils');const ruleDef=function(){};ruleDef.prototype.getName=function(){return'jetwc-disabled-property'};ruleDef.prototype.getShortDescription=function(){return'Check component does not use the problematic disabled property'};ruleDef.prototype.getDescription=function(){return'This rule checks that a component does not define a property called disabled which can cause issues with IE'};ruleDef.prototype.register=function(context){return{compjson:this._doAudit}};ruleDef.prototype._doAudit=function(context){if(context.suppData.obj){let issue;const meta=context.suppData.obj;const fullName=Utils.getComponentFullName(meta);const componentType=Utils.getComponentType(meta);if(componentType==='composite'){if(meta.properties&&meta.properties.hasOwnProperty('disabled')){var deprecated=false;if(meta.properties.disabled.hasOwnProperty('status')){var statusArray=meta.properties.disabled.status;statusArray.forEach(status=>{if(status.hasOwnProperty('type')){if(status.type==='deprecated'){deprecated=true}}})}if(!deprecated){issue=new context.Issue(`Component ${fullName} defines a property called 'disabled' this can cause problems with Internet Explorer and we recommend 'disable' as a replacement property name`);context.reporter.addIssue(issue,context)}}}}};module.exports=ruleDef;

package/rulepacks/jetwc/jetwc-displayname.js

@@ -1,6 +1,6 @@
 /*
- * Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2018, 2022, Oracle and/or its affiliates.
  * Licensed under The Universal Permissive License (UPL), Version 1.0
  * as shown at https://oss.oracle.com/licenses/upl/
  */
-const Utils=require('../jetwc-lib/component-audit-utils');const ruleDef=function(){};ruleDef.prototype.getName=function(){return'jetwc-displayname'};ruleDef.prototype.getShortDescription=function(){return'Check component display name will work with Visual Builder'};ruleDef.prototype.getDescription=function(){return'This rule checks both the length and the number of words of the display name - configurable'};ruleDef.prototype.register=function(context){return{compjson:this._doAudit}};ruleDef.prototype._doAudit=function(context){if(context.suppData.obj){let issue;const meta=context.suppData.obj;const fullName=Utils.getComponentFullName(meta);const componentType=Utils.getComponentType(meta);const ruleOptions=context.rulePack.getRuleOptions();let limits;let elimits;let plimits;switch(componentType){case'composite':elimits=ruleOptions.limits.event;plimits=ruleOptions.limits.property;case'vbcs-pattern':limits=ruleOptions.limits.component;break;case'vbcs-template':limits=ruleOptions.limits.template;break;}if(limits){const displayName=meta.displayName;if(displayName){if(displayName.length>limits.length){this._lengthError(context,fullName,componentType,limits.length)}if(displayName.split(' ').length>limits.words){this._wordCountError(context,fullName,componentType,limits.words)}}}this.checkByAttributeType(context,fullName,componentType,plimits,meta,'properties','property');this.checkByAttributeType(context,fullName,componentType,elimits,meta,'events','event')}};ruleDef.prototype._lengthError=function(context,component,type,limit,scope){issue=new context.Issue(`displayName property for Component ${component}${scope?' ('+scope+')':''} exceeds the defined length limit of ${limit} for a ${type}`);issue.setMsgKey(context.ruleName+'_1');context.reporter.addIssue(issue,context,'info')};ruleDef.prototype._wordCountError=function(context,component,type,limit,scope){issue=new context.Issue(`displayName property for Component ${component}${scope?' ('+scope+')':''} exceeds the defined word count of ${limit} for a ${type}`);issue.setMsgKey(context.ruleName+'_2');context.reporter.addIssue(issue,context,'info')};ruleDef.prototype.checkByAttributeType=function(context,fullName,componentType,limits,meta,attributeType,typeName){if(limits&&meta[attributeType]){Object.keys(meta[attributeType]).forEach(cName=>{const cDN=meta[attributeType][cName].displayName;if(cDN){if(cDN.length>limits.length){this._lengthError(context,fullName,componentType+' '+typeName,limits.length,attributeType+'=>'+cName)}if(cDN.split(' ').length>limits.words){this._wordCountError(context,fullName,componentType+' '+typeName,limits.words,attributeType+'=>'+cName)}}})}};module.exports=ruleDef;
+const Utils=require('../jetwc-lib/jetwcutils-componentAuditUtils');const TsxUtils=require('../jetwc-lib/jetwcutils-tsxUtils');const ruleDef=function(){};ruleDef.prototype.getName=function(){return'jetwc-displayname'};ruleDef.prototype.getShortDescription=function(){return'Check component display name will work with Visual Builder'};ruleDef.prototype.getDescription=function(){return'This rule checks both the length and the number of words of the display name - configurable'};ruleDef.prototype.register=function(context){return{compjson:this._doAudit,Program:this._doVComponentAudit}};ruleDef.prototype._doAudit=function(context){if(context.suppData.obj){let issue;const meta=context.suppData.obj;const fullName=Utils.getComponentFullName(meta);const componentType=Utils.getComponentType(meta);this._checkDisplayNames(context,fullName,componentType,meta.displayName,meta.properties,meta.events,meta.slots)}};ruleDef.prototype._doVComponentAudit=function(context){const componentInfo=TsxUtils.matchToVComponentImpl(context,context.filepath);if(componentInfo){this._checkDisplayNames(context,componentInfo.fullName,componentInfo.type,componentInfo.displayName,componentInfo.properties,componentInfo.events,componentInfo.slots)}};ruleDef.prototype._checkDisplayNames=function(context,fullName,componentType,displayName,properties,events,slots){const ruleOptions=context.rulePack.getRuleOptions();let limits;let elimits;let plimits;let slimits;switch(componentType){case'composite':elimits=ruleOptions.limits.event;plimits=ruleOptions.limits.property;slimits=ruleOptions.limits.slot;case'vbcs-pattern':limits=ruleOptions.limits.component;break;case'vbcs-template':limits=ruleOptions.limits.template;break;}if(limits&&displayName){if(displayName.length>limits.length){this._lengthError(context,fullName,componentType,limits.length)}if(displayName.split(' ').length>limits.words){this._wordCountError(context,fullName,componentType,limits.words)}}if(plimits&&properties){this.checkByAttributeType(context,fullName,componentType,plimits,properties,'properties','property')}if(elimits&&events){this.checkByAttributeType(context,fullName,componentType,elimits,events,'events','event')}if(slimits&&slots){this.checkByAttributeType(context,fullName,componentType,slimits,slots,'slots','slot')}};ruleDef.prototype._lengthError=function(context,component,type,limit,scope){issue=new context.Issue(`displayName property for Component ${component}${scope?' ('+scope+')':''} exceeds the defined length limit of ${limit} for a ${type}`);issue.setMsgKey(context.ruleName+'_1');context.reporter.addIssue(issue,context)};ruleDef.prototype._wordCountError=function(context,component,type,limit,scope){issue=new context.Issue(`displayName property for Component ${component}${scope?' ('+scope+')':''} exceeds the defined word count of ${limit} for a ${type}`);issue.setMsgKey(context.ruleName+'_2');context.reporter.addIssue(issue,context)};ruleDef.prototype.checkByAttributeType=function(context,fullName,componentType,limits,meta,attributeType,typeName){Object.keys(meta).forEach(cName=>{const cDN=meta[cName].displayName;if(cDN){if(cDN.length>limits.length){this._lengthError(context,fullName,componentType+' '+typeName,limits.length,attributeType+'=>'+cName)}if(cDN.split(' ').length>limits.words){this._wordCountError(context,fullName,componentType+' '+typeName,limits.words,attributeType+'=>'+cName)}}})};module.exports=ruleDef;

package/rulepacks/jetwc/jetwc-dynamic-slot-context.js

@@ -1,6 +1,6 @@
 /*
- * Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2018, 2022, Oracle and/or its affiliates.
  * Licensed under The Universal Permissive License (UPL), Version 1.0
  * as shown at https://oss.oracle.com/licenses/upl/
  */
-const Utils=require('../jetwc-lib/component-audit-utils');const ruleDef=function(){};ruleDef.prototype.getName=function(){return'jetwc-dynamic-slot-context'};ruleDef.prototype.getShortDescription=function(){return'Check properties have valid dynamicSlotDef values'};ruleDef.prototype.getDescription=function(){return'Ensures that any property that defines itself as a dynamic slot discriminant using the dynamicSlotDef attribute is using a valid context defined within the dynamicSlots set for the component'};ruleDef.prototype.register=function(context){return{compjson:this._doAudit}};ruleDef.prototype._doAudit=function(context){if(context.suppData.obj){const meta=context.suppData.obj;const fullName=Utils.getComponentFullName(meta);const componentType=Utils.getComponentType(meta);if(componentType==='composite'){if(meta.properties){Object.keys(meta.properties).forEach(propName=>{let issueNoticed=false;const prop=meta.properties[propName];if(prop.hasOwnProperty('dynamicSlotDef')){if(meta.dynamicSlots){if(!meta.dynamicSlots.hasOwnProperty(prop.dynamicSlotDef)){issueNoticed=true}}else{issueNoticed=true}}if(issueNoticed){const issue=new context.Issue(`Component ${fullName} property ${propName} references an invalid dynamic-slot`);context.reporter.addIssue(issue,context,'major')}})}}}};module.exports=ruleDef;
+const Utils=require('../jetwc-lib/jetwcutils-componentAuditUtils');const ruleDef=function(){};ruleDef.prototype.getName=function(){return'jetwc-dynamic-slot-context'};ruleDef.prototype.getShortDescription=function(){return'Check properties have valid dynamicSlotDef values'};ruleDef.prototype.getDescription=function(){return'Ensures that any property that defines itself as a dynamic slot discriminant using the dynamicSlotDef attribute is using a valid context defined within the dynamicSlots set for the component'};ruleDef.prototype.register=function(context){return{compjson:this._doAudit}};ruleDef.prototype._doAudit=function(context){if(context.suppData.obj){const meta=context.suppData.obj;const fullName=Utils.getComponentFullName(meta);const componentType=Utils.getComponentType(meta);if(componentType==='composite'){if(meta.properties){Object.keys(meta.properties).forEach(propName=>{let issueNoticed=false;const prop=meta.properties[propName];if(prop.hasOwnProperty('dynamicSlotDef')){if(meta.dynamicSlots){if(!meta.dynamicSlots.hasOwnProperty(prop.dynamicSlotDef)){issueNoticed=true}}else{issueNoticed=true}}if(issueNoticed){const issue=new context.Issue(`Component ${fullName} property ${propName} references an invalid dynamic-slot`);context.reporter.addIssue(issue,context)}})}}}};module.exports=ruleDef;

package/rulepacks/jetwc/jetwc-dynamic-slots-naming.js

@@ -1,6 +1,6 @@
 /*
- * Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2018, 2022, Oracle and/or its affiliates.
  * Licensed under The Universal Permissive License (UPL), Version 1.0
  * as shown at https://oss.oracle.com/licenses/upl/
  */
-const path=require("path");const Utils=require("../jetwc-lib/component-audit-utils");const ruleDef=function(){};ruleDef.prototype.getName=function(){return"jetwc-dynamic-slots-naming"};ruleDef.prototype.getShortDescription=function(){return"Verify dynamic slots are named correctly"};ruleDef.prototype.getDescription=function(){return"This rule checks that any dynamic slot contexts have the correct naming convention"};ruleDef.prototype.register=function(context){return{compjson:this._doAudit}};ruleDef.prototype._doAudit=function(context){if(context.suppData.obj){const meta=context.suppData.obj;const fullName=Utils.getComponentFullName(meta);const componentType=Utils.getComponentType(meta);if(componentType==="composite"){if(meta.dynamicSlots){Object.keys(meta.dynamicSlots).forEach(ctxName=>{if(!ctxName.endsWith("Context")){const issue=new context.Issue(`Component ${fullName} dynamicSlot ${ctxName} is not named according to the standards with a Context suffix`);context.reporter.addIssue(issue,context,"minor")}})}}}};module.exports=ruleDef;
+const path=require("path");const Utils=require("../jetwc-lib/jetwcutils-componentAuditUtils");const ruleDef=function(){};ruleDef.prototype.getName=function(){return"jetwc-dynamic-slots-naming"};ruleDef.prototype.getShortDescription=function(){return"Verify dynamic slots are named correctly"};ruleDef.prototype.getDescription=function(){return"This rule checks that any dynamic slot contexts have the correct naming convention"};ruleDef.prototype.register=function(context){return{compjson:this._doAudit}};ruleDef.prototype._doAudit=function(context){if(context.suppData.obj){const meta=context.suppData.obj;const fullName=Utils.getComponentFullName(meta);const componentType=Utils.getComponentType(meta);if(componentType==="composite"){if(meta.dynamicSlots){Object.keys(meta.dynamicSlots).forEach(ctxName=>{if(!ctxName.endsWith("Context")){const issue=new context.Issue(`Component ${fullName} dynamicSlot ${ctxName} is not named according to the standards with a Context suffix`);context.reporter.addIssue(issue,context)}})}}}};module.exports=ruleDef;

package/rulepacks/jetwc/jetwc-event-displayname.js

@@ -1,6 +1,6 @@
 /*
- * Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2018, 2022, Oracle and/or its affiliates.
  * Licensed under The Universal Permissive License (UPL), Version 1.0
  * as shown at https://oss.oracle.com/licenses/upl/
  */
-const Utils=require('../jetwc-lib/component-audit-utils');const ruleDef=function(){};ruleDef.prototype.getName=function(){return'jetwc-event-displayname'};ruleDef.prototype.getShortDescription=function(){return'Check component has display name defined for events'};ruleDef.prototype.getDescription=function(){return'This rule checks that events have a display name supplied to make the user experience in Visual Builder as useful as possible'};ruleDef.prototype.register=function(context){return{compjson:this._doAudit}};ruleDef.prototype._doAudit=function(context){if(context.suppData.obj){let issue;const meta=context.suppData.obj;const fullName=Utils.getComponentFullName(meta);const componentType=Utils.getComponentType(meta);if(componentType==='composite'&&meta.events){Object.keys(meta.events).forEach(eventName=>{if(!meta.events[eventName].displayName){issue=new context.Issue(`displayName for event '${eventName}' should be defined`);context.reporter.addIssue(issue,context,'info')}})}}};module.exports=ruleDef;
+const Utils=require('../jetwc-lib/jetwcutils-componentAuditUtils');const TsxUtils=require('../jetwc-lib/jetwcutils-tsxUtils');const ruleDef=function(){};ruleDef.prototype.getName=function(){return'jetwc-event-displayname'};ruleDef.prototype.getShortDescription=function(){return'Check component has display name defined for events'};ruleDef.prototype.getDescription=function(){return'This rule checks that events have a display name supplied to make the user experience in Visual Builder as useful as possible'};ruleDef.prototype.register=function(context){return{compjson:this._doAudit,Program:this._doVComponentAudit}};ruleDef.prototype._doAudit=function(context){if(context.suppData.obj){const meta=context.suppData.obj;const componentType=Utils.getComponentType(meta);if(componentType==='composite'){this._checkEvents(context,meta.events)}}};ruleDef.prototype._doVComponentAudit=function(context){const componentInfo=TsxUtils.matchToVComponentImpl(context,context.filepath);if(componentInfo){this._checkEvents(context,componentInfo.events)}};ruleDef.prototype._checkEvents=function(context,events){let issue;if(events){Object.keys(events).forEach(eventName=>{if(!events[eventName].displayName){issue=new context.Issue(`displayName for event '${eventName}' should be defined`);context.reporter.addIssue(issue,context)}})}};module.exports=ruleDef;

package/rulepacks/jetwc/jetwc-events.js

@@ -1,6 +1,6 @@
 /*
- * Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2018, 2022, Oracle and/or its affiliates.
  * Licensed under The Universal Permissive License (UPL), Version 1.0
  * as shown at https://oss.oracle.com/licenses/upl/
  */
-const path=require('path');const Utils=require('../jetwc-lib/component-audit-utils');const ruleDef=function(){};ruleDef.prototype.getName=function(){return'jetwc-events'};ruleDef.prototype.getShortDescription=function(){return'Checks that any events raised are declared'};ruleDef.prototype.getDescription=function(){return'This rule ensures that all events omitted from a component are declared in the metadata'};ruleDef.prototype.register=function(context){return{CallExpression:this._doAudit}};ruleDef.prototype._doAudit=function(context,node){let issue;if(node.callee.type==='MemberExpression'&&node.callee.property.type==='Identifier'&&node.callee.property.name==='dispatchEvent'){if(node.arguments[0].type==='CallExpression'||node.arguments[0].type==='NewExpression'){if(node.arguments[0].callee.name==='CustomEvent'){const eventNameNode=node.arguments[0].arguments[0];if(eventNameNode.type==='Literal'){const eventName=eventNameNode.value;const withinComponent=Utils.matchComponentPath(context,path.dirname(context.filepath));const componentInfo=Utils.componentInfo(context,withinComponent);if(withinComponent&&componentInfo.type==='composite'){if(!componentInfo.events||!componentInfo.events.hasOwnProperty(eventName)){issue=new context.Issue(`Event '${eventName}' raised for component ${withinComponent} has not been declared in the component metadata`);issue.setMsgKey(context.ruleName+'_1');context.reporter.addIssue(issue,context,'major')}}else{issue=new context.Issue(`Custom event '${eventName}' raised by code outside of a web component and so cannot be verified against any component API`);issue.setMsgKey(context.ruleName+'_2');context.reporter.addIssue(issue,context,'major')}}}}}};module.exports=ruleDef;
+const path=require('path');const Utils=require('../jetwc-lib/jetwcutils-componentAuditUtils');const ruleDef=function(){};ruleDef.prototype.getName=function(){return'jetwc-events'};ruleDef.prototype.getShortDescription=function(){return'Checks that any events raised are declared'};ruleDef.prototype.getDescription=function(){return'This rule ensures that all events omitted from a component are declared in the metadata'};ruleDef.prototype.register=function(context){return{CallExpression:this._doAudit}};ruleDef.prototype._doAudit=function(context,node){const NT=context.utils.AstUtils.getNodeTypes();let issue;if(node.callee.type===NT.MEMBER_EXPR&&node.callee.property.type===NT.IDENTIFIER&&node.callee.property.name==='dispatchEvent'){if(node.arguments[0].type===NT.CALL_EXPR||node.arguments[0].type===NT.NEW_EXPR){if(node.arguments[0].callee.name==='CustomEvent'){const eventNameNode=node.arguments[0].arguments[0];if(eventNameNode.type===NT.LITERAL){const eventName=eventNameNode.value;const withinComponent=Utils.matchComponentPath(context,path.dirname(context.filepath));const componentInfo=Utils.componentInfo(context,withinComponent);if(withinComponent&&componentInfo.type==='composite'){if(!componentInfo.events||!componentInfo.events.hasOwnProperty(eventName)){issue=new context.Issue(`Event '${eventName}' raised for component ${withinComponent} has not been declared in the component metadata`);issue.setMsgKey(context.ruleName+'_1');context.reporter.addIssue(issue,context)}}else{issue=new context.Issue(`Custom event '${eventName}' raised by code outside of a web component and so cannot be verified against any component API`);issue.setMsgKey(context.ruleName+'_2');context.reporter.addIssue(issue,context)}}}}}};module.exports=ruleDef;