@ind-rcg/modeler-sfdx-cli-plugin 246.1042.2 → 246.1046.0

package/README.md

@@ -8,12 +8,12 @@ This plugin is an enhancement of the sfdx cli and provide you features to custom
 ```sh
 # Install the plugin on your local system
 $ sf plugins install @ind-rcg/modeler-sfdx-cli-plugin
-# ---- OR ----
+# --- OR ---
 $ sfdx plugins install @ind-rcg/modeler-sfdx-cli-plugin
 
 # Verify that installation was successful
 $ sf plugins
-# ---- OR ----
+# --- OR ---
 $ sfdx plugins
 # Output: @ind-rcg/modeler-sfdx-cli-plugin xxx.xxxx.x (x being the version number which was installed)
 ...

package/lib/utils/generateManifestHelper.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.getFingerprints=void 0;const fsHelper_1=require("./fsHelper"),constants_1=require("../constants"),sha256=require("crypto-js/sha256"),encHex=require("crypto-js/enc-hex"),path=require("path"),walkSync=require("klaw-sync");function getFingerprints(e){const t={};return walkSync(e,{nodir:!0}).forEach((r=>{const s=path.relative(e,r.path).split(path.sep).join(path.posix.sep);if(s===constants_1.WorkspaceConstants.MANIFEST_FILE)return;const n=(0,fsHelper_1.readTextFile)(r.path);t[s]=sha256(n).toString(encHex)})),t}exports.getFingerprints=getFingerprints;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.getFingerprints=exports.DEFAULT_FINGERPRINT=exports.CORE_LOCALES=void 0;const fsHelper_1=require("./fsHelper"),constants_1=require("../constants"),sha256=require("crypto-js/sha256"),encHex=require("crypto-js/enc-hex"),path=require("path"),walkSync=require("klaw-sync");function getFingerprints(e){const t={};return walkSync(e,{nodir:!0}).forEach((r=>{const s=path.relative(e,r.path).split(path.sep).join(path.posix.sep);if(s===constants_1.WorkspaceConstants.MANIFEST_FILE)return;const n=(0,fsHelper_1.readTextFile)(r.path);t[s]=sha256(n).toString(encHex)})),exports.CORE_LOCALES.forEach((e=>{const r=["Locale",`${e}.locale.xml`].join(path.posix.sep);t[r]||(t[r]=exports.DEFAULT_FINGERPRINT)})),t}exports.CORE_LOCALES=["br","da","de","en","es","fi","fr","gb","hu","in","it","ja","ko","mx","nl","no","pt","ru","sv","th","tw","vi","zh"],exports.DEFAULT_FINGERPRINT="N.A.",exports.getFingerprints=getFingerprints;

package/lib/utils/templateEngine.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.TemplateEngine=exports.Utils=exports.TemplateEngineContext=exports.ValidationSet=exports.NON_MODULES=exports.TemplateEngineState=exports.ResourceType=exports.ContractType=exports.QuestionType=exports.Namespace=exports.NameIdentifier=void 0;const _=require("lodash"),inquirer=require("inquirer"),path=require("path"),walkSync=require("klaw-sync"),fsHelper_1=require("./fsHelper"),templateHelper_1=require("./templateHelper");var NameIdentifier,Namespace,QuestionType,ContractType;!function(e){e.Core="",e.Custom="My"}(NameIdentifier=exports.NameIdentifier||(exports.NameIdentifier={})),function(e){e.Core="CORE",e.Custom="CUSTOM"}(Namespace=exports.Namespace||(exports.Namespace={})),function(e){e.Type="TYPE",e.Name="NAME",e.Module="MODULE",e.FullName="FULL_NAME",e.Option="OPTION",e.Confirmation="CONFIRMATION"}(QuestionType=exports.QuestionType||(exports.QuestionType={})),function(e){e.Module="module",e.BusinessObject="businessobject",e.ListObject="listobject",e.LookupObject="lookupobject",e.DataSource="datasource"}(ContractType=exports.ContractType||(exports.ContractType={}));const ContractTypes=[ContractType.Module,ContractType.BusinessObject,ContractType.ListObject,ContractType.LookupObject,ContractType.DataSource];var ResourceType,TemplateEngineState;!function(e){e.File="file",e.Folder="folder",e.Tree="tree"}(ResourceType=exports.ResourceType||(exports.ResourceType={})),function(e){e[e.NEW=0]="NEW",e[e.DONE=1]="DONE",e[e.FAILED=2]="FAILED",e[e.ABORTED=3]="ABORTED"}(TemplateEngineState=exports.TemplateEngineState||(exports.TemplateEngineState={})),exports.NON_MODULES=["Application","BusinessObjectHelpers","ExternalFiles","Images","Locale","Plugins","SharedWebData","UI Plugins"];class ValidationSet{constructor(e){this.validations=e}validate(e){let t=!0;return _.forEach(this.validations,(r=>{let s=r(e);_.isBoolean(s)||!s||(t=s)})),t}}exports.ValidationSet=ValidationSet;class TemplateEngineContext{constructor(e){this.resourceTemplateDefinition=this.__loadResourceTemplateDefinition(),this.resourceOptions=this.__createResourceOptionsMap(),this.workspace=e}__loadResourceTemplateDefinition(){return(0,fsHelper_1.readJsonFile)((0,templateHelper_1.getTemplateDefinitionsFilePath)())}__createResourceOptionsMap(){let e=new Map;return _.forIn(this.resourceTemplateDefinition,(t=>{let r=t;_.forEach(r.options,(t=>{let r=t;e.set(r.name,r)}))})),e}getResourceTemplateTypes(){return ContractTypes}getResourceTemplateTypeData(e){return this.resourceTemplateDefinition[e]}getResourceTemplateOption(e){return this.resourceOptions.get(e)}getWorkspace(){return this.workspace}getModules(){let e=this.workspace.getSourcePath(),t=walkSync(e,{depthLimit:0,nofile:!0}),r=_.map(t,(t=>path.relative(e,t.path)));return _.without(r,...exports.NON_MODULES)}getWorkspaceParameters(){return{CUSTOM:this.workspace.isProjectWorkspace()?NameIdentifier.Custom:NameIdentifier.Core,NAMESPACE:this.workspace.isProjectWorkspace()?Namespace.Custom:Namespace.Core}}getResourceName(e,t,r){let s;switch(e){case ContractType.BusinessObject:case ContractType.ListObject:case ContractType.LookupObject:s=`${r}${t}`;break;case ContractType.DataSource:s=r===NameIdentifier.Custom&&t.indexOf(r)>=0?t:`${r}${t}`;break;default:s=`${t}`}return s}}exports.TemplateEngineContext=TemplateEngineContext;class Utils{static parseStringEnumValue(e,t){let r=Object.keys(t).find((r=>t[r]===e));return t[r]}}exports.Utils=Utils;class TemplateEngine{constructor(e){this.context=new TemplateEngineContext(e)}getResourceTypeOptions(e){return _.map(e,(e=>e.name))}convertAnswersToParameters(e){let t={};return _.forIn(e,((e,r)=>{t[r.toUpperCase()]=e})),t}evaluateFunctionSpec(e,t){let r=e.fn,s=e.args;s=_.map(s,(e=>this.replaceTemplateParameters(e,t)));let a=this.context[r].apply(this.context,s);return e.allowNone&&_.isArrayLike(a)&&a.push({name:"(none)",value:""}),a}resolveParameter(e,t){let r;return r="string"==typeof e?this.replaceTemplateParameters(e,t):this.evaluateFunctionSpec(e,t),r}resolveOptionParameters(e,t){_.isNil(e)||_.forIn(e,((e,r)=>{let s=this.resolveParameter(e,t);t[r]=s}))}resolveReturnParameters(e,t){if(!_.isNil(e)){let r=this.setupParameters(e,t);_.merge(e,r)}}setupParameters(e,t){let r={};return _.isNil(e)||_.forIn(e,((e,s)=>{let a=this.resolveParameter(e,t);r[s]=a})),r}replaceTemplateParameters(e,t){let r=e;return _.forIn(t,((e,t)=>{if("string"==typeof e){let s=new RegExp(_.join(["\\${",t,"}"],""),"gm"),a=e;r=_.replace(r,s,a)}})),r}expandResources(e){let t=[];return _.forEach(e,(e=>{switch(e.type){case ResourceType.File:this.expandFileResource(e,t);break;case ResourceType.Folder:this.expandFolderResource(e,t);break;case ResourceType.Tree:this.expandTreeResource(e,t)}})),t}resolveResources(e,t){let r=[];return _.forEach(e,(e=>{let s=_.clone(e);s.target=this.replaceTemplateParameters(s.target,t),s.type===ResourceType.File&&this.loadResourceFileData(s,t),r.push(s)})),r}getResourceSourcePath(e){return e&&e.source?(0,fsHelper_1.joinPaths)((0,templateHelper_1.getContractTemplatesPath)(),e.source):null}getResourceTargetPath(e){return(0,fsHelper_1.joinPaths)(this.context.getWorkspace().getSourcePath(),e.target)}loadResourceFileData(e,t){if(e.type===ResourceType.File){let r=(0,fsHelper_1.readTextFile)(e.source);r=this.replaceTemplateParameters(r,t),e.data=r}}createResource(e,t,r){return{type:e,source:t,target:r}}expandFileResource(e,t){let r=this.createResource(ResourceType.File,this.getResourceSourcePath(e),this.getResourceTargetPath(e));t.push(r)}expandFolderResource(e,t){let r=this.createResource(ResourceType.Folder,this.getResourceSourcePath(e),this.getResourceTargetPath(e));t.push(r)}expandTreeResource(e,t){let r=this.getResourceSourcePath(e),s=this.getResourceTargetPath(e);this.expandFolderResource(e,t);let a=walkSync(r,{filter:e=>!e.stats.isFile()||!e.path.endsWith(".md")});_.forEach(a,(e=>{let a;e.stats.isFile()?a=ResourceType.File:e.stats.isDirectory()&&(a=ResourceType.Folder);let o=e.path,i=(0,fsHelper_1.joinPaths)(s,path.relative(r,e.path)),n=this.createResource(a,o,i);t.push(n)}))}createResources(e){_.forEach(e,(e=>{e.type===ResourceType.File?(0,fsHelper_1.ensureFileExists)(e.target,e.data):(0,fsHelper_1.ensureFolderExists)(e.target)}))}canCreateResources(e,t){let r=!0,s=null,a=_.filter(e,(e=>e.type===ResourceType.File));return _.forEach(a,(e=>{if(r&&(0,fsHelper_1.existsFile)(e.target)){r=!1,s=_.first(a).target;let e=(0,fsHelper_1.parentPath)(this.context.getWorkspace().getBasePath());switch(t){case ContractType.BusinessObject:case ContractType.ListObject:case ContractType.LookupObject:s=(0,fsHelper_1.parentPath)(s);case ContractType.DataSource:}s=(0,fsHelper_1.relativePath)(e,s)}})),{success:r,path:s}}async processResourceOption(e,t,r,s){let a=!1;_.isNil(r)&&(a=!0,r=[]);let o={option:e,main:a,parameters:null,resources:null},i=_.clone(t);_.isNil(s)||(i=_.merge(i,s));let n=this.convertAnswersToParameters(i);n=_.merge(n,this.context.getWorkspaceParameters()),this.resolveOptionParameters(e.parameters,n),this.resolveReturnParameters(e.returnParameters,n);let p=this.expandResources(e.resources);if(o.parameters=n,o.resources=p,r.push(o),e?.includes)for(let t=0;t<e.includes.length;t++){const s=e.includes[t];let a=s.name,p=this.context.getResourceTemplateOption(a),c=this.setupParameters(s?.parameters,n);await this.processResourceOption(p,i,r,c),p?.returnParameters&&(o.parameters=_.merge(o.parameters,p.returnParameters))}if(o.main){let e=[];_.forEach(r,(t=>{const r=this.resolveResources(t.resources,t.parameters);e=e.concat(r)})),p=e}return{resources:p,parameters:n}}validateName(e){let t=[];t.push((e=>!(e.length<3||e.length>26)||"Use a minimum of 3 and a maximum of 26 characters containing alphanumeric and the underscore symbol.")),t.push((e=>!!new RegExp("^[a-zA-Z0-9_]+$","g").test(e)||"Use alphanumeric characters and the underscore symbol.")),t.push((e=>!new RegExp(NameIdentifier.Custom,"gi").test(e)||`Avoid using '${NameIdentifier.Custom}' in name value.`));let r=new ValidationSet(t);return r.validate.bind(r)}async askForResourceType(e,t){return inquirer.prompt([{name:QuestionType.Type,message:"Select the resource you want to add.",type:"list",choices:e}],t)}async askForResourceName(e){let t=_.get(e,QuestionType.Type);return inquirer.prompt([{name:QuestionType.Name,message:`Specify a name for the ${t}:`,type:"input",validate:this.validateName(t)}],e)}async askForModule(e,t){let r=_.get(t,QuestionType.Name),s=_.get(t,QuestionType.Type);return inquirer.prompt([{name:QuestionType.Module,message:`Select the module to which ${s} '${r}' should be added.`,type:"list",choices:e}],t)}async askForOption(e,t){let r=_.get(t,QuestionType.Name),s=_.get(t,QuestionType.Type);return inquirer.prompt([{name:QuestionType.Option,message:`Select a suitable option for ${s} '${r}'.`,type:"list",choices:e}],t)}async askForConfirmation(e){let t=_.get(e,QuestionType.Name),r=_.get(e,QuestionType.Type);return inquirer.prompt([{name:QuestionType.Confirmation,message:`Do you really want to create the ${r} '${t}'?`,type:"confirm"}],e)}async processRequest(e){let t={State:TemplateEngineState.NEW,Message:"",Type:"",Name:"",Files:[]};try{let r=await this.askForResourceType(this.context.getResourceTemplateTypes(),e);r=await this.askForResourceName(r);let s=_.get(r,QuestionType.Type),a=Utils.parseStringEnumValue(s,ContractType),o=this.context.getResourceTemplateTypeData(a);if(o){!0===o.moduleRequired&&(r=await this.askForModule(this.context.getModules(),r));let e,s=o.options;if(1===s.length){let e={};e[QuestionType.Option]=s[0].name,r=_.merge(r,e)}r=await this.askForOption(this.getResourceTypeOptions(s),r);let a=_.get(r,QuestionType.Option);e=this.context.getResourceTemplateOption(a);let i=await this.processResourceOption(e,r),n=_.get(i.parameters,QuestionType.FullName,"");_.isEmpty(n)&&(n=_.get(i.parameters,QuestionType.Name));let p=_.get(i.parameters,QuestionType.Type);t.Name=n,t.Type=p;let c=this.canCreateResources(i.resources,p);if(c.success){r=await this.askForConfirmation(r),!0===_.get(r,QuestionType.Confirmation)?(this.createResources(i.resources),t.State=TemplateEngineState.DONE,t.Files=_.compact(_.map(i.resources,(e=>{if(e.type===ResourceType.File)return e.target})))):t.State=TemplateEngineState.ABORTED}else t.State=TemplateEngineState.FAILED,t.Message=`The ${p} '${n}' already exists at ${c.path}. To create a new ${p}, re-run the command and specify a unique name.`}}catch(e){t.State=TemplateEngineState.FAILED,t.Message=e.toString()}return t}}exports.TemplateEngine=TemplateEngine;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.TemplateEngine=exports.Utils=exports.TemplateEngineContext=exports.ValidationSet=exports.NON_MODULES=exports.TemplateEngineState=exports.ResourceType=exports.ResourceAction=exports.ContractType=exports.QuestionType=exports.Namespace=exports.NameIdentifier=void 0;const _=require("lodash"),inquirer=require("inquirer"),path=require("path"),walkSync=require("klaw-sync"),fsHelper_1=require("./fsHelper"),templateHelper_1=require("./templateHelper"),xmlHelper_1=require("./xmlHelper");var NameIdentifier,Namespace,QuestionType,ContractType;!function(e){e.Core="",e.Custom="My"}(NameIdentifier=exports.NameIdentifier||(exports.NameIdentifier={})),function(e){e.Core="CORE",e.Custom="CUSTOM"}(Namespace=exports.Namespace||(exports.Namespace={})),function(e){e.Type="TYPE",e.Name="NAME",e.Module="MODULE",e.FullName="FULL_NAME",e.Option="OPTION",e.Confirmation="CONFIRMATION"}(QuestionType=exports.QuestionType||(exports.QuestionType={})),function(e){e.Module="module",e.BusinessObject="businessobject",e.ListObject="listobject",e.LookupObject="lookupobject",e.DataSource="datasource",e.BusinessLogic="businesslogic"}(ContractType=exports.ContractType||(exports.ContractType={}));const ContractTypes=[ContractType.Module,ContractType.BusinessObject,ContractType.ListObject,ContractType.LookupObject,ContractType.DataSource,ContractType.BusinessLogic];var ResourceAction,ResourceType,TemplateEngineState;!function(e){e.Add="add",e.Update="update"}(ResourceAction=exports.ResourceAction||(exports.ResourceAction={})),function(e){e.File="file",e.Folder="folder",e.Tree="tree"}(ResourceType=exports.ResourceType||(exports.ResourceType={})),function(e){e[e.NEW=0]="NEW",e[e.DONE=1]="DONE",e[e.FAILED=2]="FAILED",e[e.ABORTED=3]="ABORTED"}(TemplateEngineState=exports.TemplateEngineState||(exports.TemplateEngineState={})),exports.NON_MODULES=["Application","BusinessObjectHelpers","ExternalFiles","Images","Locale","Plugins","SharedWebData","UI Plugins"];class ValidationSet{constructor(e){this.validations=e}validate(e){let t=!0;return _.forEach(this.validations,(r=>{let s=r(e);_.isBoolean(s)||!s||(t=s)})),t}}exports.ValidationSet=ValidationSet;class TemplateEngineContext{constructor(e){this.resourceTemplateDefinition=this.__loadResourceTemplateDefinition(),this.resourceOptions=this.__createResourceOptionsMap(),this.workspace=e}__loadResourceTemplateDefinition(){return(0,fsHelper_1.readJsonFile)((0,templateHelper_1.getTemplateDefinitionsFilePath)())}__createResourceOptionsMap(){let e=new Map;return _.forIn(this.resourceTemplateDefinition,(t=>{let r=t;_.forEach(r.options,(t=>{let r=t;e.set(r.name,r)}))})),e}getResourceTemplateTypes(){return ContractTypes}getResourceTemplateTypeData(e){return this.resourceTemplateDefinition[e]}getResourceTemplateOption(e){return this.resourceOptions.get(e)}getWorkspace(){return this.workspace}getModules(){let e=this.workspace.getSourcePath(),t=walkSync(e,{depthLimit:0,nofile:!0}),r=_.map(t,(t=>path.relative(e,t.path)));return _.without(r,...exports.NON_MODULES)}getReferenceObjects(e){let t=this.workspace.getSourcePath(),r=(0,fsHelper_1.joinPaths)(t,e,"BO"),s=[];return(0,fsHelper_1.existsFolder)(r)&&(s=walkSync(r,{depthLimit:0,nofile:!0})),_.map(s,(e=>path.relative(r,e.path)))}getWorkspaceParameters(){return{CUSTOM:this.workspace.isProjectWorkspace()?NameIdentifier.Custom:NameIdentifier.Core,NAMESPACE:this.workspace.isProjectWorkspace()?Namespace.Custom:Namespace.Core}}getResourceName(e,t,r){let s;switch(e){case ContractType.BusinessObject:case ContractType.ListObject:case ContractType.LookupObject:case ContractType.BusinessLogic:s=`${r}${t}`;break;case ContractType.DataSource:s=r===NameIdentifier.Custom&&t.indexOf(r)>=0?t:`${r}${t}`;break;default:s=`${t}`}return s}getMethodName(e){return _.lowerFirst(e)}getMethodFileName(e){return _.upperFirst(e)}getReferenceObjectMethodFolder(e,t){let r,s=this.workspace.getSourcePath(),a=(0,fsHelper_1.joinPaths)(s,e,"BO",t);return r=(0,fsHelper_1.existsFolder)((0,fsHelper_1.joinPaths)(a,"Mv1"))?"Mv1":"Mv2",r}getReferenceObjectBaseType(e){let t;return t=e.startsWith("Lo")?ContractType.ListObject:e.startsWith("Lu")?ContractType.LookupObject:ContractType.BusinessObject,t}}exports.TemplateEngineContext=TemplateEngineContext;class Utils{static parseStringEnumValue(e,t){let r=Object.keys(t).find((r=>t[r]===e));return t[r]}}exports.Utils=Utils;class TemplateEngine{constructor(e){this.context=new TemplateEngineContext(e)}getResourceTypeOptions(e){return _.map(e,(e=>e.name))}convertAnswersToParameters(e){let t={};return _.forIn(e,((e,r)=>{t[r.toUpperCase()]=e})),t}evaluateFunctionSpec(e,t){let r=e.fn,s=e.args;s=_.map(s,(e=>this.replaceTemplateParameters(e,t)));let a=this.context[r].apply(this.context,s);return e.allowNone&&_.isArrayLike(a)&&a.push({name:"(none)",value:""}),a}resolveParameter(e,t){let r;return r="string"==typeof e?this.replaceTemplateParameters(e,t):this.evaluateFunctionSpec(e,t),r}resolveOptionParameters(e,t){_.isNil(e)||_.forIn(e,((e,r)=>{let s=this.resolveParameter(e,t);t[r]=s}))}resolveReturnParameters(e,t){if(!_.isNil(e)){let r=this.setupParameters(e,t);_.merge(e,r)}}setupParameters(e,t){let r={};return _.isNil(e)||_.forIn(e,((e,s)=>{let a=this.resolveParameter(e,t);r[s]=a})),r}replaceTemplateParameters(e,t){let r=e;return _.forIn(t,((e,t)=>{if("string"==typeof e){let s=new RegExp(_.join(["\\${",t,"}"],""),"gm"),a=e;r=_.replace(r,s,a)}})),r}expandResources(e){let t=[];return _.forEach(e,(e=>{switch(e.type){case ResourceType.File:this.expandFileResource(e,t);break;case ResourceType.Folder:this.expandFolderResource(e,t);break;case ResourceType.Tree:this.expandTreeResource(e,t)}})),t}resolveResources(e,t){let r=[];return _.forEach(e,(e=>{let s=_.clone(e);s.target=this.replaceTemplateParameters(s.target,t),s.type===ResourceType.File&&this.prepareResourceFileData(s,t),r.push(s)})),r}getResourceSourcePath(e){return e&&e.source?(0,fsHelper_1.joinPaths)((0,templateHelper_1.getContractTemplatesPath)(),e.source):null}getResourceTargetPath(e){return(0,fsHelper_1.joinPaths)(this.context.getWorkspace().getSourcePath(),e.target)}prepareResourceFileData(e,t){if(e.type===ResourceType.File){let r;if(e.action===ResourceAction.Add)r=(0,fsHelper_1.readTextFile)(e.source);else if(e.action===ResourceAction.Update){let s=path.basename(e.target);if(r=(0,fsHelper_1.readTextFile)(e.target),!r)return e.state.error=!0,void(e.state.message=`Error loading '${s}' contract for XML templating.`);let a=e.tpl;if(a){a.data=this.replaceTemplateParameters(a.data,t);try{r=(0,xmlHelper_1.applyXmlTemplating)(a,r)}catch(t){let r="";t&&(r=t.message),e.state.error=!0,e.state.message=`Error during XML templating of '${s}' contract${_.isEmpty(r)?"":" -> "}${r}`}}}r=this.replaceTemplateParameters(r,t),e.data=r}}createResource(e,t,r,s){return{type:e,action:t,state:{error:!1,message:""},source:r,target:s}}expandFileResource(e,t){let r=Object.assign({},e,{action:e.action||ResourceAction.Add,state:{error:!1,message:""},source:this.getResourceSourcePath(e),target:this.getResourceTargetPath(e)});t.push(r)}expandFolderResource(e,t){let r=this.createResource(ResourceType.Folder,ResourceAction.Add,this.getResourceSourcePath(e),this.getResourceTargetPath(e));t.push(r)}expandTreeResource(e,t){let r=this.getResourceSourcePath(e),s=this.getResourceTargetPath(e);this.expandFolderResource(e,t);let a=walkSync(r,{filter:e=>!e.stats.isFile()||!e.path.endsWith(".md")});_.forEach(a,(e=>{let a;e.stats.isFile()?a=ResourceType.File:e.stats.isDirectory()&&(a=ResourceType.Folder);let o=e.path,i=(0,fsHelper_1.joinPaths)(s,path.relative(r,e.path)),n=this.createResource(a,ResourceAction.Add,o,i);t.push(n)}))}createResources(e){_.forEach(e,(e=>{switch(e.action||ResourceAction.Add){case ResourceAction.Add:e.type===ResourceType.File?(0,fsHelper_1.ensureFileExists)(e.target,e.data):(0,fsHelper_1.ensureFolderExists)(e.target);break;case ResourceAction.Update:e.type===ResourceType.File&&(0,fsHelper_1.writeFile)(e.target,e.data)}}))}canCreateResources(e,t,r){let s=!0,a=null,o=_.filter(e,(e=>e?.state.error));if(_.isEmpty(o)){let o=_.filter(e,(e=>e.type===ResourceType.File&&e.action===ResourceAction.Add)),i=null;_.forEach(o,(e=>{if(s&&(0,fsHelper_1.existsFile)(e.target)){s=!1,i=_.first(o).target;let e=(0,fsHelper_1.parentPath)(this.context.getWorkspace().getBasePath());switch(t){case ContractType.BusinessObject:case ContractType.ListObject:case ContractType.LookupObject:i=(0,fsHelper_1.parentPath)(i);case ContractType.DataSource:case ContractType.BusinessLogic:}i=(0,fsHelper_1.relativePath)(e,i)}})),s||(a=`The ${t} '${r}' already exists at ${i}. To create a new ${t}, re-run the command and specify a unique name.`)}else s=!1,a=_.join(_.map(o,(e=>e?.state.message)),"\n");return{success:s,message:a}}async processResourceOption(e,t,r,s){let a=!1;_.isNil(r)&&(a=!0,r=[]);let o={option:e,main:a,parameters:null,resources:null},i=_.clone(t);_.isNil(s)||(i=_.merge(i,s)),e?.questions&&(i=await this.askAdditionalQuestions(e.questions,i));let n=this.convertAnswersToParameters(i);n=_.merge(n,this.context.getWorkspaceParameters()),this.resolveOptionParameters(e.parameters,n),this.resolveReturnParameters(e.returnParameters,n);let p=this.expandResources(e.resources);if(o.parameters=n,o.resources=p,r.push(o),e?.includes)for(let t=0;t<e.includes.length;t++){const s=e.includes[t];let a=s.name,p=this.context.getResourceTemplateOption(a),c=this.setupParameters(s?.parameters,n);await this.processResourceOption(p,i,r,c),p?.returnParameters&&(o.parameters=_.merge(o.parameters,p.returnParameters))}if(o.main){let e=[];_.forEach(r,(t=>{const r=this.resolveResources(t.resources,t.parameters);e=e.concat(r)})),p=e}return{resources:p,parameters:n}}validateName(e){let t=[];t.push((e=>!(e.length<3||e.length>26)||"Use a minimum of 3 and a maximum of 26 characters containing alphanumeric and the underscore symbol.")),t.push((e=>!!new RegExp("^[a-zA-Z0-9_]+$","g").test(e)||"Use alphanumeric characters and the underscore symbol.")),t.push((e=>!new RegExp(NameIdentifier.Custom,"gi").test(e)||`Avoid using '${NameIdentifier.Custom}' in name value.`));let r=new ValidationSet(t);return r.validate.bind(r)}async askForResourceType(e,t){return inquirer.prompt([{name:QuestionType.Type,message:"Select the resource you want to add.",type:"list",choices:e}],t)}async askForResourceName(e){let t=_.get(e,QuestionType.Type);return inquirer.prompt([{name:QuestionType.Name,message:`Specify a name for the ${t}:`,type:"input",validate:this.validateName(t)}],e)}async askForModule(e,t){let r=_.get(t,QuestionType.Name),s=_.get(t,QuestionType.Type);return inquirer.prompt([{name:QuestionType.Module,message:`Select the module to which ${s} '${r}' should be added.`,type:"list",choices:e}],t)}async askForOption(e,t){let r=_.get(t,QuestionType.Name),s=_.get(t,QuestionType.Type);return inquirer.prompt([{name:QuestionType.Option,message:`Select a suitable option for ${s} '${r}'.`,type:"list",choices:e}],t)}buildOptionQuestions(e,t){let r=_.cloneDeep(e),s=this.convertAnswersToParameters(t);return _.forEach(r,(e=>{e.choices=this.evaluateFunctionSpec(e.choices,s)})),r}async askAdditionalQuestions(e,t){let r=this.buildOptionQuestions(e,t);return inquirer.prompt(r,t)}async askForConfirmation(e){let t=_.get(e,QuestionType.Name),r=_.get(e,QuestionType.Type);return inquirer.prompt([{name:QuestionType.Confirmation,message:`Do you really want to create the ${r} '${t}'?`,type:"confirm"}],e)}async processRequest(e){let t={State:TemplateEngineState.NEW,Message:"",Type:"",Name:"",Files:[]};try{let r=await this.askForResourceType(this.context.getResourceTemplateTypes(),e);r=await this.askForResourceName(r);let s=_.get(r,QuestionType.Type),a=Utils.parseStringEnumValue(s,ContractType),o=this.context.getResourceTemplateTypeData(a);if(o){!0===o.moduleRequired&&(r=await this.askForModule(this.context.getModules(),r));let e,s=o.options;if(1===s.length){let e={};e[QuestionType.Option]=s[0].name,r=_.merge(r,e)}r=await this.askForOption(this.getResourceTypeOptions(s),r);let a=_.get(r,QuestionType.Option);e=this.context.getResourceTemplateOption(a);let i=await this.processResourceOption(e,r),n=_.get(i.parameters,QuestionType.FullName,"");_.isEmpty(n)&&(n=_.get(i.parameters,QuestionType.Name));let p=_.get(i.parameters,QuestionType.Type);t.Name=n,t.Type=p;let c=this.canCreateResources(i.resources,p,n);if(c.success){r=await this.askForConfirmation(r),!0===_.get(r,QuestionType.Confirmation)?(this.createResources(i.resources),t.State=TemplateEngineState.DONE,t.Files=_.compact(_.map(i.resources,(e=>{if(e.type===ResourceType.File)return e.target})))):t.State=TemplateEngineState.ABORTED}else t.State=TemplateEngineState.FAILED,t.Message=c.message}}catch(e){t.State=TemplateEngineState.FAILED,t.Message=e.toString()}return t}}exports.TemplateEngine=TemplateEngine;

package/lib/utils/xmlHelper.js

@@ -0,0 +1 @@
+"use strict";let libxmljs;var XmlTemplatingError;function applyXmlTemplating(r,l){libxmljs||(libxmljs=require("libxmljs"));let t,e,m,o=null;try{t=libxmljs.parseXmlString(l)}catch(r){throw new Error(XmlTemplatingError.XML_DOCUMENT_PARSING_ERROR)}try{if(e=t.get(r.xpath),!e)throw new Error}catch(r){throw new Error(XmlTemplatingError.XML_ELEMENT_LOOKUP_ERROR)}try{m=libxmljs.parseXmlString(r.data)}catch(r){throw new Error(XmlTemplatingError.XML_FRAGMENT_PARSING_ERROR)}try{e.addChild(m.root()),o=t.root().toString({declaration:!1,selfCloseEmpty:!0,whitespace:!1,type:"xml"})}catch(r){throw new Error(XmlTemplatingError.XML_MANIPULATION_ERROR)}return o}Object.defineProperty(exports,"__esModule",{value:!0}),exports.applyXmlTemplating=exports.XmlTemplatingError=void 0,function(r){r.XML_DOCUMENT_PARSING_ERROR="Error parsing xmlDocument.",r.XML_ELEMENT_LOOKUP_ERROR="Error getting xmlElement.",r.XML_FRAGMENT_PARSING_ERROR="Error parsing xmlFragment.",r.XML_MANIPULATION_ERROR="Error adding xmlFragment to xmlElement."}(XmlTemplatingError=exports.XmlTemplatingError||(exports.XmlTemplatingError={})),exports.applyXmlTemplating=applyXmlTemplating;

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "246.1042.2",
+  "version": "246.1046.0",
   "commands": {
     "modeler:workspace:add": {
       "id": "modeler:workspace:add",

package/package.json

@@ -1,14 +1,14 @@
 {
     "name": "@ind-rcg/modeler-sfdx-cli-plugin",
     "displayName": "modeler-sfdx-cli-plugin",
-    "version": "246.1042.2",
+    "version": "246.1046.0",
     "author": "Salesforce",
     "license": "BSD-3-Clause",
     "description": "This plugin is an enhancement of the sfdx cli and provide you features to customize the Consumer Goods Cloud Mobility application. This version will be the replacement for the Consumer Goods Mobile Modeler which was hosted on a Windows Server machine.",
     "dependencies": {
         "@ind-rcg/backend": "246.1008.0",
-        "@ind-rcg/framework": "246.1014.0",
-        "@ind-rcg/generator": "246.1018.0",
+        "@ind-rcg/framework": "246.1015.0",
+        "@ind-rcg/generator": "246.1019.0",
         "@oclif/core": "2.9.4",
         "@salesforce/core": "4.1.0",
         "@salesforce/sf-plugins-core": "3.1.3",
@@ -19,14 +19,12 @@
         "jszip": "3.10.1",
         "klaw-sync": "6.0.0",
         "latest-version": "7.0.0",
+        "libxmljs": "0.19.10",
         "lodash": "4.17.21",
         "rxjs": "5.4.1",
         "tree-kill": "1.2.2",
         "tslib": "2.4.0"
     },
-    "resolutions": {
-        "@ind-rcg/plugins-printengine": "246.1010.0"
-    },
     "devDependencies": {
         "@istanbuljs/nyc-config-typescript": "1.0.2",
         "@oclif/test": "2.1.1",
@@ -35,6 +33,7 @@
         "@types/chai": "4.3.3",
         "@types/fs-extra": "9.0.13",
         "@types/klaw-sync": "6.0.1",
+        "@types/libxmljs": "0.18.8",
         "@types/mocha": "8.2.3",
         "@typescript-eslint/eslint-plugin": "5.31.0",
         "@typescript-eslint/parser": "5.31.0",
@@ -95,14 +94,14 @@
         "test-all": "nyc mocha --extension .ts --require ts-node/register  --forbid-only \"test/**/*.test.ts\" \"test/**/*.test.nut.ts\"",
         "test-unit": "nyc mocha --extension .ts --require ts-node/register --forbid-only \"test/**/*.test.ts\"",
         "test-nut": "nyc mocha --extension .ts --require ts-node/register --forbid-only \"test/**/*.test.nut.ts\"",
-        "test-single": "nyc mocha --extension .ts --require ts-node/register --forbid-only \"test/**/validate.test.ts\"",
+        "test-single": "nyc mocha --extension .ts --require ts-node/register --forbid-only \"test/**/xmlHelper.test.ts\"",
         "posttest": "yarn lint",
         "version": "oclif readme && git add README.md",
         "readme": "oclif readme",
         "uglify": "uglifyjs-folder lib -e -x .js -o lib --log-level error"
     },
     "sfdx": {
-        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@ind-rcg/modeler-sfdx-cli-plugin/246.1042.2.crt",
-        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@ind-rcg/modeler-sfdx-cli-plugin/246.1042.2.sig"
+        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@ind-rcg/modeler-sfdx-cli-plugin/246.1046.0.crt",
+        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@ind-rcg/modeler-sfdx-cli-plugin/246.1046.0.sig"
     }
 }

package/templates/contractTemplates/BL_BusinessLogic/${REFERENCE_OBJECT}.${NAME}.bl.js

@@ -0,0 +1,53 @@
+"use strict";
+
+///////////////////////////////////////////////////////////////////////////////////////////////
+//                 IMPORTANT - DO NOT MODIFY AUTO-GENERATED CODE OR COMMENTS                 //
+//Parts of this file are auto-generated and modifications to those sections will be          //
+//overwritten. You are allowed to modify:                                                    //
+// - the tags in the jsDoc as described in the corresponding section                         //
+// - the function name and its parameters                                                    //
+// - the function body between the insertion ranges                                          //
+//         "Add your customizing javaScript code below / above"                              //
+//                                                                                           //
+///////////////////////////////////////////////////////////////////////////////////////////////
+
+/**
+ * Use the following jsDoc tags to describe the BL function. Setting these tags will
+ * change the runtime behavior in the mobile app. The values specified in the tags determine
+ * the name of the contract file. The filename format is “@this . @function .bl.js”.
+ * For example, LoVisit.BeforeLoadAsync.bl.js
+ * -> function: Name of the businessLogic function.
+ * -> this: The LO, BO, or LU object that this function belongs to (and it is part of the filename).
+ * -> kind: Type of object this function belongs to. Most common value is "businessobject".
+ * -> async: If declared as async then the function should return a promise.
+ * -> param: List of parameters the function accepts. Make sure the parameters match the function signature.
+ * -> namespace: Use CORE or CUSTOM. If you are a Salesforce client or an implementation partner, always use CUSTOM to enable a seamless release upgrade.
+ * -> extends: Base class of the LO, BO, and LU objects that this function belongs to.
+ * -> maxRuntime: Maximum time this function is allowed to run, takes integer value in ms. If the max time is exceeded, error is logged.
+ * -> returns: Type and variable name in which the return value is stored.
+ * @function ${METHOD_NAME}
+ * @this ${REFERENCE_OBJECT}
+ * @kind ${REFERENCE_OBJECT_BASE_TYPE}
+ * @namespace ${NAMESPACE}
+ */
+function ${METHOD_NAME}(){
+    var me = this;
+    ///////////////////////////////////////////////////////////////////////////////////////////////
+    //                                                                                           //
+    //               Add your customizing javaScript code below.                                 //
+    //                                                                                           //
+    ///////////////////////////////////////////////////////////////////////////////////////////////
+    
+    
+    
+		
+   
+  
+    ///////////////////////////////////////////////////////////////////////////////////////////////
+    //                                                                                           //
+    //               Add your customizing javaScript code above.                                 //
+    //                                                                                           //
+    ///////////////////////////////////////////////////////////////////////////////////////////////
+
+    
+}

package/templates/contractTemplates/BL_BusinessLogic/${REFERENCE_OBJECT}.${NAME}Async.bl.js

@@ -0,0 +1,52 @@
+"use strict";
+
+///////////////////////////////////////////////////////////////////////////////////////////////
+//                 IMPORTANT - DO NOT MODIFY AUTO-GENERATED CODE OR COMMENTS                 //
+//Parts of this file are auto-generated and modifications to those sections will be          //
+//overwritten. You are allowed to modify:                                                    //
+// - the tags in the jsDoc as described in the corresponding section                         //
+// - the function name and its parameters                                                    //
+// - the function body between the insertion ranges                                          //
+//         "Add your customizing javaScript code below / above"                              //
+//                                                                                           //
+///////////////////////////////////////////////////////////////////////////////////////////////
+
+/**
+ * Use the following jsDoc tags to describe the BL function. Setting these tags will
+ * change the runtime behavior in the mobile app. The values specified in the tags determine
+ * the name of the contract file. The filename format is “@this . @function .bl.js”.
+ * For example, LoVisit.BeforeLoadAsync.bl.js
+ * -> function: Name of the businessLogic function.
+ * -> this: The LO, BO, or LU object that this function belongs to (and it is part of the filename).
+ * -> kind: Type of object this function belongs to. Most common value is "businessobject".
+ * -> async: If declared as async then the function should return a promise.
+ * -> param: List of parameters the function accepts. Make sure the parameters match the function signature.
+ * -> namespace: Use CORE or CUSTOM. If you are a Salesforce client or an implementation partner, always use CUSTOM to enable a seamless release upgrade.
+ * -> extends: Base class of the LO, BO, and LU objects that this function belongs to.
+ * -> maxRuntime: Maximum time this function is allowed to run, takes integer value in ms. If the max time is exceeded, error is logged.
+ * -> returns: Type and variable name in which the return value is stored.
+ * @function ${METHOD_NAME}
+ * @this ${REFERENCE_OBJECT}
+ * @kind ${REFERENCE_OBJECT_BASE_TYPE}
+ * @async
+ * @namespace ${NAMESPACE}
+ * @returns promise
+ */
+function ${METHOD_NAME}(){
+    var me = this;
+    ///////////////////////////////////////////////////////////////////////////////////////////////
+    //                                                                                           //
+    //               Add your customizing javaScript code below.                                 //
+    //                                                                                           //
+    ///////////////////////////////////////////////////////////////////////////////////////////////
+    
+    var promise=when.resolve();
+
+    ///////////////////////////////////////////////////////////////////////////////////////////////
+    //                                                                                           //
+    //               Add your customizing javaScript code above.                                 //
+    //                                                                                           //
+    ///////////////////////////////////////////////////////////////////////////////////////////////
+
+    return promise;
+}

package/templates/contractTemplates/BL_BusinessLogic/BusinessLogic.md

@@ -0,0 +1,4 @@
+# Business Logic (BL) Contract Definition
+
+## Description
+The Business Logic Contract specifies a Method used by any of the Business Objects (BO, LO, LU) in the Mobility Application.

package/templates/templateDefinitions.json

@@ -163,5 +163,124 @@
                 ]
             }
         ]
+    },
+    "businesslogic": {
+        "moduleRequired": true,
+        "options": [
+            {
+                "name": "method",
+                "questions": [
+                    {
+                        "name"   : "REFERENCE_OBJECT",
+                        "message": "Select the reference object to which you want to add the businesslogic method.",
+                        "type"   : "list",
+                        "choices": {
+                            "fn"        : "getReferenceObjects",
+                            "args"      : ["${MODULE}"]
+                        }
+                    }
+                ],
+                "parameters": {
+                    "NAME": {
+                        "fn"    : "getResourceName",
+                        "args"  : ["${TYPE}", "${NAME}", "${CUSTOM}"]
+                    },                    
+                    "METHOD_NAME": {
+                        "fn"    : "getMethodName",
+                        "args"  : ["${NAME}"]
+                    },
+                    "METHOD_FILE_NAME": {
+                        "fn"    : "getMethodFileName",
+                        "args"  : ["${NAME}"]
+                    },
+                    "FULL_NAME": "${REFERENCE_OBJECT}.${METHOD_FILE_NAME}",
+                    "MV": {
+                        "fn"    : "getReferenceObjectMethodFolder",
+                        "args"  : ["${TYPE}", "${REFERENCE_OBJECT}"]
+                    },
+                    "REFERENCE_OBJECT_BASE_TYPE": {
+                        "fn"    : "getReferenceObjectBaseType",
+                        "args"  : ["${REFERENCE_OBJECT}"]
+                    }
+                },
+                "resources": [
+                    {
+                        "type": "folder",
+                        "target": "${MODULE}/BO/${REFERENCE_OBJECT}/${MV}"
+                    },
+                    {
+                        "type": "file",
+                        "source": "BL_BusinessLogic/${REFERENCE_OBJECT}.${NAME}.bl.js",
+                        "target": "${MODULE}/BO/${REFERENCE_OBJECT}/${MV}/${FULL_NAME}.bl.js"
+                    },
+                    {
+                        "type": "file",
+                        "action": "update",
+                        "target": "${MODULE}/BO/${REFERENCE_OBJECT}/${REFERENCE_OBJECT}.${REFERENCE_OBJECT_BASE_TYPE}.xml",
+                        "tpl" : {
+                            "xpath" : "//Methods[1]",
+                            "data"  : "<Method name=\"${METHOD_NAME}\" />"
+                        }
+                    }
+                ]
+            },
+            {
+                "name": "async method",
+                "questions": [
+                    {
+                        "name"   : "REFERENCE_OBJECT",
+                        "message": "Select the reference object to which you want to add the businesslogic method.",
+                        "type"   : "list",
+                        "choices": {
+                            "fn"        : "getReferenceObjects",
+                            "args"      : ["${MODULE}"]
+                        }
+                    }
+                ],
+                "parameters": {
+                    "NAME": {
+                        "fn"    : "getResourceName",
+                        "args"  : ["${TYPE}", "${NAME}", "${CUSTOM}"]
+                    },
+                    "METHOD_NAME": {
+                        "fn"    : "getMethodName",
+                        "args"  : ["${NAME}"]
+                    },
+                    "METHOD_FILE_NAME": {
+                        "fn"    : "getMethodFileName",
+                        "args"  : ["${NAME}"]
+                    },
+                    "FULL_NAME": "${REFERENCE_OBJECT}.${METHOD_FILE_NAME}",
+                    "MV": {
+                        "fn"    : "getReferenceObjectMethodFolder",
+                        "args"  : ["${TYPE}", "${REFERENCE_OBJECT}"]
+                    },
+                    "REFERENCE_OBJECT_BASE_TYPE": {
+                        "fn"    : "getReferenceObjectBaseType",
+                        "args"  : ["${REFERENCE_OBJECT}"]
+                    }
+                },
+                "resources": [
+                    {
+                        "type": "folder",
+                        "target": "${MODULE}/BO/${REFERENCE_OBJECT}/${MV}"
+                    },
+                    {
+                        "type": "file",
+                        "source": "BL_BusinessLogic/${REFERENCE_OBJECT}.${NAME}Async.bl.js",
+                        "target": "${MODULE}/BO/${REFERENCE_OBJECT}/${MV}/${FULL_NAME}.bl.js"
+                    },
+                    {
+                        "type": "file",
+                        "action": "update",
+                        "target": "${MODULE}/BO/${REFERENCE_OBJECT}/${REFERENCE_OBJECT}.${REFERENCE_OBJECT_BASE_TYPE}.xml",
+                        "tpl" : {
+                            "xpath" : "//Methods[1]",
+                            "data"  : "<Method name=\"${METHOD_NAME}\" />"
+                        }
+                    }
+                ]
+            }
+        ]
     }
 }