@tmorin/plantuml-libs 6.1.1 → 6.2.0

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [6.2.0](https://github.com/tmorin/plantuml-libs/compare/v6.1.1...v6.2.0) (2021-12-06)
+
+
+### Features
+
+* **eip-1:** add new items for the Message Construction module + increase size about some existing items ([470e6c1](https://github.com/tmorin/plantuml-libs/commit/470e6c16c936a75a1902cfbffc8d6777c2c9780f))
+
 ### [6.1.1](https://github.com/tmorin/plantuml-libs/compare/v6.1.0...v6.1.1) (2021-12-04)
 
 

package/distribution/eip-1/MessageConstruction/QueryMessage.Local.puml

@@ -0,0 +1,17 @@
+@startuml
+' configures the library
+!global $INCLUSION_MODE="local"
+!global $LIB_BASE_LOCATION="../.."
+
+' loads the library's bootstrap
+!include $LIB_BASE_LOCATION/bootstrap.puml
+
+' loads the package bootstrap
+include('eip-1/bootstrap')
+
+' loads the Item which embeds the element QueryMessage
+include('eip-1/MessageConstruction/QueryMessage')
+
+' renders the element
+QueryMessage('QueryMessage', 'Query Message', 'an optional tech label')
+@enduml

package/distribution/eip-1/MessageConstruction/QueryMessage.Remote.puml

@@ -0,0 +1,16 @@
+@startuml
+' configures the library
+!global $LIB_BASE_LOCATION="https://raw.githubusercontent.com/tmorin/plantuml-libs/master/distribution"
+
+' loads the library's bootstrap
+!include $LIB_BASE_LOCATION/bootstrap.puml
+
+' loads the package bootstrap
+include('eip-1/bootstrap')
+
+' loads the Item which embeds the element QueryMessage
+include('eip-1/MessageConstruction/QueryMessage')
+
+' renders the element
+QueryMessage('QueryMessage', 'Query Message', 'an optional tech label')
+@enduml

package/distribution/eip-1/MessageConstruction/QueryMessage.md

@@ -0,0 +1,114 @@
+# QueryMessage
+
+
+```text
+eip-1/MessageConstruction/QueryMessage
+```
+
+```text
+include('eip-1/MessageConstruction/QueryMessage')
+```
+
+
+
+| Illustration | QueryMessage | QueryMessageGroup |
+| :---: | :---: | :---: |
+| ![illustration for Illustration](../../eip-1/MessageConstruction/QueryMessage.png) | ![illustration for QueryMessage](../../eip-1/MessageConstruction/QueryMessage.Local.png) | ![illustration for QueryMessageGroup](../../eip-1/MessageConstruction/QueryMessageGroup.Local.png) |
+
+
+
+
+## QueryMessage
+
+### Load remotely
+```plantuml
+@startuml
+' configures the library
+!global $LIB_BASE_LOCATION="https://raw.githubusercontent.com/tmorin/plantuml-libs/master/distribution"
+
+' loads the library's bootstrap
+!include $LIB_BASE_LOCATION/bootstrap.puml
+
+' loads the package bootstrap
+include('eip-1/bootstrap')
+
+' loads the Item which embeds the element QueryMessage
+include('eip-1/MessageConstruction/QueryMessage')
+
+' renders the element
+QueryMessage('QueryMessage', 'Query Message', 'an optional tech label')
+@enduml
+```
+
+### Load locally
+```plantuml
+@startuml
+' configures the library
+!global $INCLUSION_MODE="local"
+!global $LIB_BASE_LOCATION="../.."
+
+' loads the library's bootstrap
+!include $LIB_BASE_LOCATION/bootstrap.puml
+
+' loads the package bootstrap
+include('eip-1/bootstrap')
+
+' loads the Item which embeds the element QueryMessage
+include('eip-1/MessageConstruction/QueryMessage')
+
+' renders the element
+QueryMessage('QueryMessage', 'Query Message', 'an optional tech label')
+@enduml
+```
+
+## QueryMessageGroup
+
+### Load remotely
+```plantuml
+@startuml
+' configures the library
+!global $LIB_BASE_LOCATION="https://raw.githubusercontent.com/tmorin/plantuml-libs/master/distribution"
+
+' loads the library's bootstrap
+!include $LIB_BASE_LOCATION/bootstrap.puml
+
+' loads the package bootstrap
+include('eip-1/bootstrap')
+
+' loads the Item which embeds the element QueryMessageGroup
+include('eip-1/MessageConstruction/QueryMessage')
+
+' renders the element
+QueryMessageGroup('QueryMessageGroup', 'Query Message Group', 'an optional tech label') {
+    note as note
+        the content of the group
+    end note
+}
+@enduml
+```
+
+### Load locally
+```plantuml
+@startuml
+' configures the library
+!global $INCLUSION_MODE="local"
+!global $LIB_BASE_LOCATION="../.."
+
+' loads the library's bootstrap
+!include $LIB_BASE_LOCATION/bootstrap.puml
+
+' loads the package bootstrap
+include('eip-1/bootstrap')
+
+' loads the Item which embeds the element QueryMessageGroup
+include('eip-1/MessageConstruction/QueryMessage')
+
+' renders the element
+QueryMessageGroup('QueryMessageGroup', 'Query Message Group', 'an optional tech label') {
+    note as note
+        the content of the group
+    end note
+}
+@enduml
+```
+

package/distribution/eip-1/MessageConstruction/QueryMessage.puml

@@ -0,0 +1,17 @@
+' definition of the Item eip-1/MessageConstruction/QueryMessage
+
+sprite $QueryMessageXs [15x10/16z] Oy06M55uxEpiw5mKFffUT2u71mSAbuq3MPw3dmsB0m
+
+sprite $QueryMessageSm [18x12/16z] Oy056D45sDdPCKMO2QbXO6CWIeIHaH5DX9C7HI4BAoi_6mUwHaus7Cu7
+
+sprite $QueryMessageMd [25x16/16z] hScr0S0m4C10i_sy_xJXAamgTUvzjPQ3Vo1rx164wU-MtPyWo2IxOCLe0oLdNM2J5CPTG29YTr4F
+
+sprite $QueryMessageLg [31x20/16z] jSkr5S104CJGCImVz5-jAJMJql-4pwBk26LgdsMEzxILfOStUEO6k_KYE8hmCvFExR9pBkRxxCPrctiYIliyvroh7h2gHU2RHW
+
+!procedure QueryMessage($id, $name="", $tech="")
+  IconElement($id, 'IconElement', 'eip-1/MessageConstruction/QueryMessage', $name, $tech)
+!endprocedure
+
+!procedure QueryMessageGroup($id, $name='Query Message', $tech='')
+  IconGroupElement($id, 'IconGroupElement', '<$QueryMessageLg>', $name, $tech)
+!endprocedure

package/distribution/eip-1/MessageConstruction/QueryMessageGroup.Local.puml

@@ -0,0 +1,21 @@
+@startuml
+' configures the library
+!global $INCLUSION_MODE="local"
+!global $LIB_BASE_LOCATION="../.."
+
+' loads the library's bootstrap
+!include $LIB_BASE_LOCATION/bootstrap.puml
+
+' loads the package bootstrap
+include('eip-1/bootstrap')
+
+' loads the Item which embeds the element QueryMessageGroup
+include('eip-1/MessageConstruction/QueryMessage')
+
+' renders the element
+QueryMessageGroup('QueryMessageGroup', 'Query Message Group', 'an optional tech label') {
+    note as note
+        the content of the group
+    end note
+}
+@enduml

package/distribution/eip-1/MessageConstruction/QueryMessageGroup.Remote.puml

@@ -0,0 +1,20 @@
+@startuml
+' configures the library
+!global $LIB_BASE_LOCATION="https://raw.githubusercontent.com/tmorin/plantuml-libs/master/distribution"
+
+' loads the library's bootstrap
+!include $LIB_BASE_LOCATION/bootstrap.puml
+
+' loads the package bootstrap
+include('eip-1/bootstrap')
+
+' loads the Item which embeds the element QueryMessageGroup
+include('eip-1/MessageConstruction/QueryMessage')
+
+' renders the element
+QueryMessageGroup('QueryMessageGroup', 'Query Message Group', 'an optional tech label') {
+    note as note
+        the content of the group
+    end note
+}
+@enduml

package/distribution/eip-1/MessageConstruction/README.md

@@ -1,6 +1,6 @@
 # MessageConstruction
 
-The module contains 8 items.
+The module contains 10 items.
 
 
 
@@ -13,6 +13,8 @@ The module contains 8 items.
 | ![illustration of eip-1/MessageConstruction/MessageExpiration](../../eip-1/MessageConstruction/MessageExpiration.png) | [eip-1/MessageConstruction/MessageExpiration](../../eip-1/MessageConstruction/MessageExpiration.md) |
 | ![illustration of eip-1/MessageConstruction/MessageReturnAddress](../../eip-1/MessageConstruction/MessageReturnAddress.png) | [eip-1/MessageConstruction/MessageReturnAddress](../../eip-1/MessageConstruction/MessageReturnAddress.md) |
 | ![illustration of eip-1/MessageConstruction/MessageSequence](../../eip-1/MessageConstruction/MessageSequence.png) | [eip-1/MessageConstruction/MessageSequence](../../eip-1/MessageConstruction/MessageSequence.md) |
+| ![illustration of eip-1/MessageConstruction/QueryMessage](../../eip-1/MessageConstruction/QueryMessage.png) | [eip-1/MessageConstruction/QueryMessage](../../eip-1/MessageConstruction/QueryMessage.md) |
+| ![illustration of eip-1/MessageConstruction/ResultMessage](../../eip-1/MessageConstruction/ResultMessage.png) | [eip-1/MessageConstruction/ResultMessage](../../eip-1/MessageConstruction/ResultMessage.md) |
 | ![illustration of eip-1/MessageConstruction/ReturnAddress](../../eip-1/MessageConstruction/ReturnAddress.png) | [eip-1/MessageConstruction/ReturnAddress](../../eip-1/MessageConstruction/ReturnAddress.md) |
 
 

package/distribution/eip-1/MessageConstruction/ResultMessage.Local.puml

@@ -0,0 +1,17 @@
+@startuml
+' configures the library
+!global $INCLUSION_MODE="local"
+!global $LIB_BASE_LOCATION="../.."
+
+' loads the library's bootstrap
+!include $LIB_BASE_LOCATION/bootstrap.puml
+
+' loads the package bootstrap
+include('eip-1/bootstrap')
+
+' loads the Item which embeds the element ResultMessage
+include('eip-1/MessageConstruction/ResultMessage')
+
+' renders the element
+ResultMessage('ResultMessage', 'Result Message', 'an optional tech label')
+@enduml

package/distribution/eip-1/MessageConstruction/ResultMessage.Remote.puml

@@ -0,0 +1,16 @@
+@startuml
+' configures the library
+!global $LIB_BASE_LOCATION="https://raw.githubusercontent.com/tmorin/plantuml-libs/master/distribution"
+
+' loads the library's bootstrap
+!include $LIB_BASE_LOCATION/bootstrap.puml
+
+' loads the package bootstrap
+include('eip-1/bootstrap')
+
+' loads the Item which embeds the element ResultMessage
+include('eip-1/MessageConstruction/ResultMessage')
+
+' renders the element
+ResultMessage('ResultMessage', 'Result Message', 'an optional tech label')
+@enduml

package/distribution/eip-1/MessageConstruction/ResultMessage.md

@@ -0,0 +1,114 @@
+# ResultMessage
+
+
+```text
+eip-1/MessageConstruction/ResultMessage
+```
+
+```text
+include('eip-1/MessageConstruction/ResultMessage')
+```
+
+
+
+| Illustration | ResultMessage | ResultMessageGroup |
+| :---: | :---: | :---: |
+| ![illustration for Illustration](../../eip-1/MessageConstruction/ResultMessage.png) | ![illustration for ResultMessage](../../eip-1/MessageConstruction/ResultMessage.Local.png) | ![illustration for ResultMessageGroup](../../eip-1/MessageConstruction/ResultMessageGroup.Local.png) |
+
+
+
+
+## ResultMessage
+
+### Load remotely
+```plantuml
+@startuml
+' configures the library
+!global $LIB_BASE_LOCATION="https://raw.githubusercontent.com/tmorin/plantuml-libs/master/distribution"
+
+' loads the library's bootstrap
+!include $LIB_BASE_LOCATION/bootstrap.puml
+
+' loads the package bootstrap
+include('eip-1/bootstrap')
+
+' loads the Item which embeds the element ResultMessage
+include('eip-1/MessageConstruction/ResultMessage')
+
+' renders the element
+ResultMessage('ResultMessage', 'Result Message', 'an optional tech label')
+@enduml
+```
+
+### Load locally
+```plantuml
+@startuml
+' configures the library
+!global $INCLUSION_MODE="local"
+!global $LIB_BASE_LOCATION="../.."
+
+' loads the library's bootstrap
+!include $LIB_BASE_LOCATION/bootstrap.puml
+
+' loads the package bootstrap
+include('eip-1/bootstrap')
+
+' loads the Item which embeds the element ResultMessage
+include('eip-1/MessageConstruction/ResultMessage')
+
+' renders the element
+ResultMessage('ResultMessage', 'Result Message', 'an optional tech label')
+@enduml
+```
+
+## ResultMessageGroup
+
+### Load remotely
+```plantuml
+@startuml
+' configures the library
+!global $LIB_BASE_LOCATION="https://raw.githubusercontent.com/tmorin/plantuml-libs/master/distribution"
+
+' loads the library's bootstrap
+!include $LIB_BASE_LOCATION/bootstrap.puml
+
+' loads the package bootstrap
+include('eip-1/bootstrap')
+
+' loads the Item which embeds the element ResultMessageGroup
+include('eip-1/MessageConstruction/ResultMessage')
+
+' renders the element
+ResultMessageGroup('ResultMessageGroup', 'Result Message Group', 'an optional tech label') {
+    note as note
+        the content of the group
+    end note
+}
+@enduml
+```
+
+### Load locally
+```plantuml
+@startuml
+' configures the library
+!global $INCLUSION_MODE="local"
+!global $LIB_BASE_LOCATION="../.."
+
+' loads the library's bootstrap
+!include $LIB_BASE_LOCATION/bootstrap.puml
+
+' loads the package bootstrap
+include('eip-1/bootstrap')
+
+' loads the Item which embeds the element ResultMessageGroup
+include('eip-1/MessageConstruction/ResultMessage')
+
+' renders the element
+ResultMessageGroup('ResultMessageGroup', 'Result Message Group', 'an optional tech label') {
+    note as note
+        the content of the group
+    end note
+}
+@enduml
+```
+

package/distribution/eip-1/MessageConstruction/ResultMessage.puml

@@ -0,0 +1,17 @@
+' definition of the Item eip-1/MessageConstruction/ResultMessage
+
+sprite $ResultMessageXs [15x10/16z] Oy06M55uxEpiw5mKFffUT2u71mSobvsL1KKt2uAB
+
+sprite $ResultMessageSm [18x12/16z] Oy056D45sDdPCKMO2QbXO6CWIeIHaH5DX8kN1Lc4XPMLcvy5NICB2mxd0m
+
+sprite $ResultMessageMd [25x16/16z] hScr0S0m30LHiqLV-syRAiDqvRtmljxRmJ-GFlS8ql9tg-5F03DZ5w0a6sYr0buds0OKtmLHLGiNZG
+
+sprite $ResultMessageLg [31x20/16z] jSkr5S0m40JH5HoO-wzMTA6P9lrly5aKZb1A-omrtbClhOStkBB3Rb44Hn5-PjBQBlV5OxVFF0oqpP68HfwNdHjsQt_4fHxVb04
+
+!procedure ResultMessage($id, $name="", $tech="")
+  IconElement($id, 'IconElement', 'eip-1/MessageConstruction/ResultMessage', $name, $tech)
+!endprocedure
+
+!procedure ResultMessageGroup($id, $name='Result Message', $tech='')
+  IconGroupElement($id, 'IconGroupElement', '<$ResultMessageLg>', $name, $tech)
+!endprocedure

package/distribution/eip-1/MessageConstruction/ResultMessageGroup.Local.puml

@@ -0,0 +1,21 @@
+@startuml
+' configures the library
+!global $INCLUSION_MODE="local"
+!global $LIB_BASE_LOCATION="../.."
+
+' loads the library's bootstrap
+!include $LIB_BASE_LOCATION/bootstrap.puml
+
+' loads the package bootstrap
+include('eip-1/bootstrap')
+
+' loads the Item which embeds the element ResultMessageGroup
+include('eip-1/MessageConstruction/ResultMessage')
+
+' renders the element
+ResultMessageGroup('ResultMessageGroup', 'Result Message Group', 'an optional tech label') {
+    note as note
+        the content of the group
+    end note
+}
+@enduml

package/distribution/eip-1/MessageConstruction/ResultMessageGroup.Remote.puml

@@ -0,0 +1,20 @@
+@startuml
+' configures the library
+!global $LIB_BASE_LOCATION="https://raw.githubusercontent.com/tmorin/plantuml-libs/master/distribution"
+
+' loads the library's bootstrap
+!include $LIB_BASE_LOCATION/bootstrap.puml
+
+' loads the package bootstrap
+include('eip-1/bootstrap')
+
+' loads the Item which embeds the element ResultMessageGroup
+include('eip-1/MessageConstruction/ResultMessage')
+
+' renders the element
+ResultMessageGroup('ResultMessageGroup', 'Result Message Group', 'an optional tech label') {
+    note as note
+        the content of the group
+    end note
+}
+@enduml

package/distribution/eip-1/README.md

@@ -18,7 +18,7 @@ include('eip-1/bootstrap')
 
 The package provides 7 modules.
 
-- [eip-1/MessageConstruction](../eip-1/MessageConstruction/README.md) with 8 items
+- [eip-1/MessageConstruction](../eip-1/MessageConstruction/README.md) with 10 items
 - [eip-1/MessageRouting](../eip-1/MessageRouting/README.md) with 11 items
 - [eip-1/MessageTransformation](../eip-1/MessageTransformation/README.md) with 5 items
 - [eip-1/MessagingChannels](../eip-1/MessagingChannels/README.md) with 5 items

package/distribution/eip-1/simple.puml

@@ -17,7 +17,7 @@ include('eip-1/MessagingChannels/DatatypeChannel')
 include('eip-1/MessagingSystems/MessageChannel')
 include('eip-1/MessagingEndpoints/CompetingConsumers')
 include('eip-1/MessagingEndpoints/Application')
-include('eip-1/MessageConstruction/DocumentMessage')
+include('eip-1/MessageConstruction/ResultMessage')
 
 Application('producer', 'producer')
 CommandMessage('cmd', 'a command')
@@ -26,7 +26,7 @@ DatatypeChannel('queue', 'command queue', 'DatatypeChannel')
 CompetingConsumers('handler', 'command handler', 'CompetingConsumers')
 MessageChannel('bus', 'event bus', 'MessageChannel')
 MessageChannel('channel', 'result channel', 'MessageChannel')
-DocumentMessage('result', 'a result')
+ResultMessage('result', 'a result')
 
 producer -> cmd
 cmd -> queue

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tmorin/plantuml-libs",
-  "version": "6.1.1",
+  "version": "6.2.0",
   "description": "A set of resources for [PlantUML](https://plantuml.com) to define diagrams for AWS, Azure, EIP ...",
   "license": "MIT",
   "homepage": "https://github.com/tmorin/plantuml-libs#readme",
@@ -52,7 +52,7 @@
     "@types/fs-extra": "^9.0.13",
     "@types/glob": "^7.2.0",
     "@types/lodash": "^4.14.176",
-    "@types/node": "^14.17.33",
+    "@types/node": "^16.11.11",
     "@types/node-fetch": "^2.5.12",
     "@types/yaml": "^1.9.7",
     "@types/yargs": "^17.0.5",