@tmorin/plantuml-libs 7.1.0 → 8.0.0

package/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 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.
 
+## [8.0.0](https://github.com/tmorin/plantuml-libs/compare/v7.1.0...v8.0.0) (2022-07-16)
+
+
+### ⚠ BREAKING CHANGES
+
+* **aws-q3-2021:** the package is `aws-q3-2021` is removed from the distribution
+
+### Features
+
+* **aws-q2-2022:** add the package ([eed7307](https://github.com/tmorin/plantuml-libs/commit/eed73070f5c863adb8a6160135ecf82a083824a0))
+* **aws-q3-2021:** remove the package ([3443221](https://github.com/tmorin/plantuml-libs/commit/344322191917e3ebba5bc90a3fafb3a0a7a89acf))
+
 ## [7.1.0](https://github.com/tmorin/plantuml-libs/compare/v7.0.0...v7.1.0) (2022-04-01)
 
 

package/README.md

@@ -36,14 +36,13 @@ The resources can be browsed, from GitHub, with Markdown pages directly in the [
 The available packages:
 
 - [AWS (q1-2022)](distribution/aws-q1-2022/README.md)
-- [AWS (q3-2021)](distribution/aws-q3-2021/README.md)
+- [AWS (q2-2022)](distribution/aws-q2-2022/README.md)
 - [Azure](distribution/azure-4/README.md)
 - [C4 Model](distribution/c4model/README.md)
 - [c4model + Nord Theme](distribution/c4nord/README.md)
 - [Domain Storytelling](distribution/domainstorytelling/README.md)
 - [Enterprise Integration Pattern](distribution/eip-1/README.md)
 - [Event Storming](distribution/eventstorming/README.md)
-- [Fontawesome v5](distribution/fontawesome-5/README.md)
 - [Fontawesome v6](distribution/fontawesome-6/README.md)
 - [Gougle Compute Platform](distribution/gcp/README.md)
 - [Homecloud](distribution/homecloud-2/README.md)

package/bin/gdiag.js

@@ -1,55 +1,59 @@
 #!/usr/bin/env node
 
-const P = require('path');
-const F = require('fs');
-const CP = require('child_process');
-const fetch = require('node-fetch')
-const moment = require('moment');
-const glob = require('glob');
+const P = require("path")
+const F = require("fs")
+const CP = require("child_process")
+const fetch = require("node-fetch")
+const moment = require("moment")
+const glob = require("glob")
 
 function getArgs() {
-    return require('yargs')
-        .scriptName('gdiag')
-        .env("GDIAG_")
-        .option('work-directory', {
-            alias: 'wd',
-            default: '.',
-            describe: 'The directory where the PlantUML files will be discovered and rendered.',
-            type: 'string'
-        })
-        .option('tech-directory', {
-            alias: 'td',
-            default: '.gdiag',
-            describe: 'The directory where technical resources will be stored.',
-            type: 'string'
-        })
-        .option('lib-directory', {
-            alias: 'ld',
-            default: P.join(__dirname, '../distribution'),
-            describe: 'The directory where the library is located.',
-            type: 'string'
-        })
-        .option('java-command', {
-            alias: 'jc',
-            default: "java",
-            describe: 'The command of the java binary.',
-            type: 'string'
-        })
-        .option('plantuml-version', {
-            alias: 'pv',
-            default: "1.2021.13",
-            describe: 'The version of PlantUML to use.',
-            type: 'string'
-        })
-        .option('clean', {
-            alias: 'c',
-            default: false,
-            describe: 'Delete recursively the pictures located in the working directory.',
-            type: 'boolean'
-        })
-        .help()
-        .usage('$0', 'Render PlantUML diagrams discovered (*.{puml,plantuml}) in the working directory.')
-        .argv;
+  return require("yargs")
+    .scriptName("gdiag")
+    .env("GDIAG_")
+    .option("work-directory", {
+      alias: "wd",
+      default: ".",
+      describe:
+        "The directory where the PlantUML files will be discovered and rendered.",
+      type: "string",
+    })
+    .option("tech-directory", {
+      alias: "td",
+      default: ".gdiag",
+      describe: "The directory where technical resources will be stored.",
+      type: "string",
+    })
+    .option("lib-directory", {
+      alias: "ld",
+      default: P.join(__dirname, "../distribution"),
+      describe: "The directory where the library is located.",
+      type: "string",
+    })
+    .option("java-command", {
+      alias: "jc",
+      default: "java",
+      describe: "The command of the java binary.",
+      type: "string",
+    })
+    .option("plantuml-version", {
+      alias: "pv",
+      default: "1.2022.6",
+      describe: "The version of PlantUML to use.",
+      type: "string",
+    })
+    .option("clean", {
+      alias: "c",
+      default: false,
+      describe:
+        "Delete recursively the pictures located in the working directory.",
+      type: "boolean",
+    })
+    .help()
+    .usage(
+      "$0",
+      "Render PlantUML diagrams discovered (*.{puml,plantuml}) in the working directory."
+    ).argv
 }
 
 /**
@@ -66,112 +70,113 @@ function getArgs() {
 /**
  * @type Args
  */
-const ARGS = getArgs();
+const ARGS = getArgs()
 
 function getLatestRunFile() {
-    return P.join(ARGS.td, 'LAST_RUN')
+  return P.join(ARGS.td, "LAST_RUN")
 }
 
 async function getLatestRun() {
-    const latestRunFile = getLatestRunFile()
-    if (F.existsSync(latestRunFile)) {
-        const stat = F.statSync(latestRunFile);
-        console.info('ran previously on (%s)', stat.mtime);
-        return moment(stat.mtime);
-    }
-    console.info('never ran previously');
+  const latestRunFile = getLatestRunFile()
+  if (F.existsSync(latestRunFile)) {
+    const stat = F.statSync(latestRunFile)
+    console.info("ran previously on (%s)", stat.mtime)
+    return moment(stat.mtime)
+  }
+  console.info("never ran previously")
 }
 
 async function setLatestRun() {
-    const latestRunFile = getLatestRunFile()
-    F.writeFileSync(latestRunFile, '');
+  const latestRunFile = getLatestRunFile()
+  F.writeFileSync(latestRunFile, "")
 }
 
 async function cleanLatestRun() {
-    const latestRunFile = getLatestRunFile()
-    if (F.existsSync(latestRunFile)) {
-        F.unlinkSync(latestRunFile);
-    }
+  const latestRunFile = getLatestRunFile()
+  if (F.existsSync(latestRunFile)) {
+    F.unlinkSync(latestRunFile)
+  }
 }
 
 async function cleanDirectory(directory, ...patterns) {
-    console.info('clean directory (%s) with (%s)', directory, patterns);
-    for (const pattern of patterns) {
-        const files = glob.sync(pattern, {
-            cwd: directory
-        });
-        for (const file of files) {
-            const filePath = P.join(directory, file);
-            console.info('delete (%s)', filePath);
-            F.unlinkSync(filePath);
-        }
+  console.info("clean directory (%s) with (%s)", directory, patterns)
+  for (const pattern of patterns) {
+    const files = glob.sync(pattern, {
+      cwd: directory,
+    })
+    for (const file of files) {
+      const filePath = P.join(directory, file)
+      console.info("delete (%s)", filePath)
+      F.unlinkSync(filePath)
     }
+  }
 }
 
 async function parseDirectory(directory, latestRun) {
-    console.info('parse directory (%s)', directory);
-    const sources = glob.sync(`**/*.{puml,plantuml}`, {
-        cwd: directory
-    });
-    for (const source of sources) {
-        const file = P.join(directory, source);
-        const stat = F.statSync(file);
-        if (!latestRun || moment(stat.mtime).isAfter(latestRun)) {
-            console.info('process source (%s)', source);
-            await renderPuml(file)
-        }
+  console.info("parse directory (%s)", directory)
+  const sources = glob.sync(`**/*.{puml,plantuml}`, {
+    cwd: directory,
+  })
+  for (const source of sources) {
+    const file = P.join(directory, source)
+    const stat = F.statSync(file)
+    if (!latestRun || moment(stat.mtime).isAfter(latestRun)) {
+      console.info("process source (%s)", source)
+      await renderPuml(file)
     }
+  }
 }
 
 function linkPlantumlLibs() {
-    const src = ARGS.ld;
-    const dst = P.join(ARGS.td, 'plantuml-libs');
-    console.info('link plantuml-libs from (%s) to (%s)', src, dst);
-    if (F.existsSync(dst)) {
-        F.unlinkSync(dst);
-    }
-    F.symlinkSync(src, dst, 'dir');
+  const src = ARGS.ld
+  const dst = P.join(ARGS.td, "plantuml-libs")
+  console.info("link plantuml-libs from (%s) to (%s)", src, dst)
+  if (F.existsSync(dst)) {
+    F.unlinkSync(dst)
+  }
+  F.symlinkSync(src, dst, "dir")
 }
 
 function getPlantumlJarPath() {
-    return P.join(ARGS.td, `plantuml-${ARGS.pv}.jar`)
+  return P.join(ARGS.td, `plantuml-${ARGS.pv}.jar`)
 }
 
 async function downloadPlantUML() {
-    const plantumlVersion = ARGS.pv
-    const plantumlJarPath = getPlantumlJarPath()
-    // https://sourceforge.net/projects/plantuml/files
-    const url = `https://sourceforge.net/projects/plantuml/files/${plantumlVersion}/plantuml.${plantumlVersion}.jar/download`;
-    F.mkdirSync(P.dirname(plantumlJarPath), {recursive: true});
-    if (!F.existsSync(plantumlJarPath)) {
-        console.info('download (%s) to (%s)', url, plantumlJarPath);
-        const resource = await fetch(url);
-        const dest = F.createWriteStream(plantumlJarPath);
-        resource.body.pipe(dest);
-        return new Promise((resolve, reject) => {
-            resource.body.on('end', resolve);
-            resource.body.on('error', reject);
-        });
-    }
+  const plantumlVersion = ARGS.pv
+  const plantumlJarPath = getPlantumlJarPath()
+  // https://sourceforge.net/projects/plantuml/files
+  // https://github.com/plantuml/plantuml/releases/download/v1.2022.6/plantuml-1.2022.6.jar
+  const url = `https://github.com/plantuml/plantuml/releases/download/v${plantumlVersion}/plantuml-${plantumlVersion}.jar`
+  F.mkdirSync(P.dirname(plantumlJarPath), { recursive: true })
+  if (!F.existsSync(plantumlJarPath)) {
+    console.info("download (%s) to (%s)", url, plantumlJarPath)
+    const resource = await fetch(url)
+    const dest = F.createWriteStream(plantumlJarPath)
+    resource.body.pipe(dest)
+    return new Promise((resolve, reject) => {
+      resource.body.on("end", resolve)
+      resource.body.on("error", reject)
+    })
+  }
 }
 
 async function renderPuml(source) {
-    const plantumlJarPath = getPlantumlJarPath()
-    CP.spawnSync(ARGS.jc, ['-jar', plantumlJarPath, source, source], {
-        stdio: 'inherit'
-    })
+  const plantumlJarPath = getPlantumlJarPath()
+  CP.spawnSync(ARGS.jc, ["-jar", plantumlJarPath, source, source], {
+    stdio: "inherit",
+  })
 }
 
 async function execute() {
-    await downloadPlantUML();
-    if (ARGS.c) {
-        await cleanLatestRun();
-        await cleanDirectory(ARGS.wd, '**/*.png');
-    }
-    linkPlantumlLibs();
-    const latestRun = await getLatestRun();
-    await parseDirectory(ARGS.wd, latestRun);
-    await setLatestRun();
+  await downloadPlantUML()
+  if (ARGS.c) {
+    await cleanLatestRun()
+    await cleanDirectory(ARGS.wd, "**/*.png")
+  }
+  linkPlantumlLibs()
+  const latestRun = await getLatestRun()
+  await parseDirectory(ARGS.wd, latestRun)
+  await setLatestRun()
 }
 
-execute().catch(e => console.error('The generation failed', e))
+execute().catch((e) => console.error("The generation failed", e))

package/distribution/README.md

@@ -5,7 +5,7 @@
 The library provides 13 packages.
 
 - [aws-q1-2022](aws-q1-2022/README.md)
-- [aws-q3-2021](aws-q3-2021/README.md)
+- [aws-q2-2022](aws-q2-2022/README.md)
 - [azure-4](azure-4/README.md)
 - [c4model](c4model/README.md)
 - [c4nord](c4nord/README.md)

package/distribution/aws-q2-2022/Architecture/Analytics/AmazonAthena.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('aws-q2-2022/bootstrap')
+
+' loads the Item which embeds the element AmazonAthena
+include('aws-q2-2022/Architecture/Analytics/AmazonAthena')
+
+' renders the element
+AmazonAthena('AmazonAthena', 'Amazon Athena', 'an optional tech label')
+@enduml

package/distribution/aws-q2-2022/Architecture/Analytics/AmazonAthena.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('aws-q2-2022/bootstrap')
+
+' loads the Item which embeds the element AmazonAthena
+include('aws-q2-2022/Architecture/Analytics/AmazonAthena')
+
+' renders the element
+AmazonAthena('AmazonAthena', 'Amazon Athena', 'an optional tech label')
+@enduml

package/distribution/aws-q2-2022/Architecture/Analytics/AmazonAthena.md

@@ -0,0 +1,157 @@
+# AmazonAthena
+
+
+```text
+aws-q2-2022/Architecture/Analytics/AmazonAthena
+```
+
+```text
+include('aws-q2-2022/Architecture/Analytics/AmazonAthena')
+```
+
+
+
+| Illustration | AmazonAthena | AmazonAthenaCard | AmazonAthenaGroup |
+| :---: | :---: | :---: | :---: |
+| ![illustration for Illustration](../../../aws-q2-2022/Architecture/Analytics/AmazonAthena.png) | ![illustration for AmazonAthena](../../../aws-q2-2022/Architecture/Analytics/AmazonAthena.Local.png) | ![illustration for AmazonAthenaCard](../../../aws-q2-2022/Architecture/Analytics/AmazonAthenaCard.Local.png) | ![illustration for AmazonAthenaGroup](../../../aws-q2-2022/Architecture/Analytics/AmazonAthenaGroup.Local.png) |
+
+
+
+
+## AmazonAthena
+
+### 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('aws-q2-2022/bootstrap')
+
+' loads the Item which embeds the element AmazonAthena
+include('aws-q2-2022/Architecture/Analytics/AmazonAthena')
+
+' renders the element
+AmazonAthena('AmazonAthena', 'Amazon Athena', '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('aws-q2-2022/bootstrap')
+
+' loads the Item which embeds the element AmazonAthena
+include('aws-q2-2022/Architecture/Analytics/AmazonAthena')
+
+' renders the element
+AmazonAthena('AmazonAthena', 'Amazon Athena', 'an optional tech label')
+@enduml
+```
+
+## AmazonAthenaCard
+
+### 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('aws-q2-2022/bootstrap')
+
+' loads the Item which embeds the element AmazonAthenaCard
+include('aws-q2-2022/Architecture/Analytics/AmazonAthena')
+
+' renders the element
+AmazonAthenaCard('AmazonAthenaCard', 'Amazon Athena Card', 'an optional description')
+@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('aws-q2-2022/bootstrap')
+
+' loads the Item which embeds the element AmazonAthenaCard
+include('aws-q2-2022/Architecture/Analytics/AmazonAthena')
+
+' renders the element
+AmazonAthenaCard('AmazonAthenaCard', 'Amazon Athena Card', 'an optional description')
+@enduml
+```
+
+## AmazonAthenaGroup
+
+### 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('aws-q2-2022/bootstrap')
+
+' loads the Item which embeds the element AmazonAthenaGroup
+include('aws-q2-2022/Architecture/Analytics/AmazonAthena')
+
+' renders the element
+AmazonAthenaGroup('AmazonAthenaGroup', 'Amazon Athena 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('aws-q2-2022/bootstrap')
+
+' loads the Item which embeds the element AmazonAthenaGroup
+include('aws-q2-2022/Architecture/Analytics/AmazonAthena')
+
+' renders the element
+AmazonAthenaGroup('AmazonAthenaGroup', 'Amazon Athena Group', 'an optional tech label') {
+    note as note
+        the content of the group
+    end note
+}
+@enduml
+```
+

package/distribution/aws-q2-2022/Architecture/Analytics/AmazonAthena.puml

@@ -0,0 +1,27 @@
+' definition of the Item aws-q2-2022/Architecture/Analytics/AmazonAthena
+
+sprite $AmazonAthenaXs [10x10/16z] FOl70S0W4CFe8Dt-ywO7Vzo1TMDEjXIeernIgP3JhH8byMJBzcn3YrVBYf2-CeMufCyjVia9
+
+sprite $AmazonAthenaSm [12x12/16z] JOg54GD020Jd1Ow5_liD8ReZfpGnIFo5fB4x8HFNshx7Px1NcAPVXEu-qvy4FNtrHtu9YAf4PuSjg0xPLsTJ4nfr_mtm
+
+sprite $AmazonAthenaMd [16x16/16z] {
+NSg54G1134BHZH9o_TTxxep-Dt1RdGF0OpVq3xgtq7K7z0gPfkgHLuSIeFZPvHmHezBt9gIbR53r_5ihAJGxkWaCGG1aJMjBEcaOHNBQGBCgXLvRRz1LgzBM
+tk2Swj4tSEqVB
+}
+
+sprite $AmazonAthenaLg [20x20/16z] {
+NSwt0GH120H1n2x3yFd7Uu8_tMPPpIwli4L-z6i7rcd0XTL8SOJQWRLZZ0tCKYyhkWUt578R9couKYDE4s6OY7Ac7-Ok1K0j0Jkiqek3D0RzieYIEOs683D_
+EmxhJqrXsuunGzqj3SwjNoDbCasLiBR68h8gDupT6eyeZiq-IBPziUsBAm
+}
+
+!procedure AmazonAthena($id, $name="", $tech="")
+  IconElement($id, 'IconElement', 'aws-q2-2022/Architecture/Analytics/AmazonAthena', $name, $tech)
+!endprocedure
+
+!procedure AmazonAthenaCard($id, $funcName="", $content="")
+  IconCardElement($id, 'IconCardElement', '<$AmazonAthenaLg>', 'Analytics', $funcName, $content)
+!endprocedure
+
+!procedure AmazonAthenaGroup($id, $name='Amazon Athena', $tech='')
+  IconGroupElement($id, 'AnalyticsFamily', '<$AmazonAthenaLg>', $name, $tech)
+!endprocedure

package/distribution/aws-q2-2022/Architecture/Analytics/AmazonAthenaCard.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('aws-q2-2022/bootstrap')
+
+' loads the Item which embeds the element AmazonAthenaCard
+include('aws-q2-2022/Architecture/Analytics/AmazonAthena')
+
+' renders the element
+AmazonAthenaCard('AmazonAthenaCard', 'Amazon Athena Card', 'an optional description')
+@enduml

package/distribution/aws-q2-2022/Architecture/Analytics/AmazonAthenaCard.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('aws-q2-2022/bootstrap')
+
+' loads the Item which embeds the element AmazonAthenaCard
+include('aws-q2-2022/Architecture/Analytics/AmazonAthena')
+
+' renders the element
+AmazonAthenaCard('AmazonAthenaCard', 'Amazon Athena Card', 'an optional description')
+@enduml

package/distribution/aws-q2-2022/Architecture/Analytics/AmazonAthenaGroup.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('aws-q2-2022/bootstrap')
+
+' loads the Item which embeds the element AmazonAthenaGroup
+include('aws-q2-2022/Architecture/Analytics/AmazonAthena')
+
+' renders the element
+AmazonAthenaGroup('AmazonAthenaGroup', 'Amazon Athena Group', 'an optional tech label') {
+    note as note
+        the content of the group
+    end note
+}
+@enduml

package/distribution/aws-q2-2022/Architecture/Analytics/AmazonAthenaGroup.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('aws-q2-2022/bootstrap')
+
+' loads the Item which embeds the element AmazonAthenaGroup
+include('aws-q2-2022/Architecture/Analytics/AmazonAthena')
+
+' renders the element
+AmazonAthenaGroup('AmazonAthenaGroup', 'Amazon Athena Group', 'an optional tech label') {
+    note as note
+        the content of the group
+    end note
+}
+@enduml