@sefranke/sf-mendix-sdk-helper

This package can make your development life using the Mendix SDK a bit easier.

Intro

During development of making scripts using the Mendix SDK I was repeating my self over and over again. Creating microflow parameters, creating translations for text templates, creating sequence flows. So that's why I created this module. It helps me to create flows a bit faster, even without the use of the serializer (although you can use that from this package also).

How to use

TODO

Release notes

v1.7.1 (latest)

• Added parameter to constructor: pat?:string You can now use a PAT when using the constructor. When omitted, Mendix will use the default way of checking for PAT using the environment variable.

v1.7.0

• Fixed bug with createForEachLoop. Adding parameters for list variable name and variable name. createLoopForEach(, , , , <microflow?/>, <size? />)

v1.6.4

• Added createAttributeEnumStored(, , <defaultValue?/>, <documentation?/>)

v1.6.3

• Added createEnumeration(<qualifiedEnumerationName>, <values >, <pathFolder?>)
• Added getOrCreateEnumeration(<qualifiedEnumerationName>, <values >, <pathFolder?>)

v1.6.2

• Added pathFolder to queue creation

v1.6.1

• Added createQueueSettings(<qualifiedQueueName>,<retries>,<interval?>,<intervalType?>,<maximumInterval>)
• Added createTaskQueue(<qualifiedQueueName>,<threads>,<clusterWide>)
• Added getOrCreateTaskQueue(<qualifiedQueueName>,<threads>,<clusterWide>)
• Added createQueuedMicroflowCall(<qualifiedMicroflowName>,<mfParams>,<queueSettings>,<relativeMiddlePoint>,<microflow?>,<size?>,<caption?>)
• Changed relativeMiddlePoint handling. When using a location object, you can pass that one now.

v1.6.0

• Changed createChangeObjectAction, added commit parameter. (BACKWARD COMPATIBILITY BREAK!)

v1.5.2

• Added: createAttributeIntegerStored(<name>,<defaultValue>,<documentation?>,<>)
• Added: createAttributeDecimalStored(<name>,<defaultValue>,<documentation?>,<>)

v1.5.1

• createAttribute(<attributeName>, <attributeType>, <valueType>, <documentation?>) Create an attribute with given parameters.
• The following shortcut functions were added.
  • createAttributeStringStored(<name>,<length>,<defaultValue?>,<documentation?>)
  • createAttributeBooleanStored(<name>,<defaultValue>,<documentation?>,<>)
  • createAttributeDateTimeStored(<name>,<localized>,<defaultValue?>,<documentation?>)

v1.5.0

• Added some logic to make it easier to keep track of the location location/relativeMiddlePoint in domainmodel/microflows.

  • getLocationsForModule(<moduleName>)
  • getDomainModelLocation(<moduleName>)
  • getFlowLocation(<moduleName>)

  ...
  
  // Get de flow location.
  const locFlow = sh.getFlowLocation('MyFirstModule');
  
  ...
  
  // Move 200 to the right.
  locFlow.x += 200;
  
  // Use the new location with an activity.
  const anno1 = sh.createAnnotation('This is some annotation!', {x: locFlow.x, y: locFlow.y});
  
  // Move 200 to the right.
  locFlow.x += 200;
  
  // Add another activity.
  ...
  

v1.4.0

• getModel() is not async anymore. The actual retrieve of the model is done right after the onlineWorkingCopy is created.

• Added: getRepo()

• Added: createDomainModelAnnotation(<qualifiedModuleName>, <caption>, <location>, <width?>) Create an annotation in the domain model.

• Added: createMicroflowAnnotation(<caption>,<relativeMiddlePoint>,<microflow>,<size>);

• Added: createAssociation(<qualifiedMOduleName>, <associationName>, <type>, ,<owner>, <connection>,<deleteBehavior?>) Create an association in the domain model.

• Added optional parameter generalization to createEntity and getOrCreateEntity

• Deprecated: createAnnotation(<caption>,<relativeMiddlePoint>,<microflow>,<size>) To be more consitent in naming, we added createMicroflowAnnotation(<caption>,<relativeMiddlePoint>,<microflow>,<size>).

v1.3.3

• Fixed bug in branch name (SVN)

v1.3.2

• Fixed logging. Less output at lvlInfo and lvlDebug.
• Removing deprecated versions from README.md

v1.3.1

• Fixed bug when using branchname and/or commitID when being ''.