npm - @zenuml/core - Versions diffs - 2.0.1 → 2.0.3 - Mend

@zenuml/core 2.0.1 → 2.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (12) hide show

package/Integration/vanilla-js/index.html +8 -13
package/README.md +7 -8
package/dist/zenuml/core.common.js +18 -10
package/dist/zenuml/core.common.js.map +1 -1
package/dist/zenuml/core.css +1 -1
package/dist/zenuml/core.umd.js +18 -10
package/dist/zenuml/core.umd.js.map +1 -1
package/dist/zenuml/core.umd.min.js +2 -2
package/dist/zenuml/core.umd.min.js.map +1 -1
package/docs/images/editor-sample.png +0 -0
package/package.json +1 -1
package/tailwind.config.js +1 -0

package/Integration/vanilla-js/index.html CHANGED Viewed

@@ -5,27 +5,22 @@
   <title>Integration ZenUML Library with Vanilla JavaScript</title>
   <script src="https://unpkg.com/vue@2.6.14"></script>
   <script src="https://unpkg.com/vuex@3.6.2"></script>
-  <script src="https://unpkg.com/vue-sequence"></script>
-  <link rel="stylesheet" href="https://unpkg.com/vue-sequence/dist/vue-sequence.css">
+  <script src="https://unpkg.com/@zenuml/core@2.0.1/dist/zenuml/core.umd.min.js"></script>
+  <link rel="stylesheet" href="https://unpkg.com/@zenuml/core@2.0.1/dist/zenuml/core.css">
 </head>
 <body>
-<div id="app" />
+<div id="app"></div>
 <script>
-  Vue.use(Vuex);
-  const VueSequence = window['vue-sequence'].VueSequence;
-  const store = new Vuex.Store(VueSequence.Store());
-  store.dispatch('updateCode',{ code: `
+  const ZenUml = window['zenuml/core'].default;
+  const zenuml = new ZenUml(document.getElementById('app'));
+  const code = `
   @EC2 BookService
   @DynamoDB BookRepository
   BookService.saveBook(1) {
     BookRepository.storeBook()
   }
-  `});
-  new Vue({
-    el: '#app',
-    store,
-    render: h => h(VueSequence.DiagramFrame)
-  });
+  `
+  zenuml.render(code, 'theme-blue')
 </script>
 </body>
 </html>

package/README.md CHANGED Viewed

@@ -1,8 +1,6 @@
-> Note: This repository has been renamed to `core` from `vue-sequence`. This is repository contains the core renderer and other core functionalities including
-export images.
+![editor](./docs/images/editor-sample.png)
 # ZenUML/Core
-ZenUML is JavaScript-based diagramming tool that uses Markdown-inspired text definitions
+ZenUML is JavaScript-based diagramming tool that requires **no server**. It uses Markdown-inspired text definitions
 and a renderer to create and modify sequence diagrams. The main purpose of ZenUML is to
 help documentation catch up with development.
@@ -15,11 +13,12 @@ You can use it ZenUML on your favorite platforms and applications:
 * [JetBrains Plugin](https://plugins.jetbrains.com/plugin/12437-zenuml-support)
 * [Chrome Extension](https://chrome.google.com/webstore/detail/zenuml-sequence/kcpganeflmhffnlofpdmcjklmdpbbmef)
-# Development
+# Integrations
-## TODOs
-- [x] Rename this repository to 'core'
-- [ ] and rename the package to @zenuml/core
+ZenUML can be integrated with your favorite tools and platforms as a library or an embeddable widget.
+Please follow the [integration guide](./docs/asciidoc/integration-guide.adoc) for detailed steps.
+# Development
 ````
 yarn install

package/dist/zenuml/core.common.js CHANGED Viewed

@@ -1319,7 +1319,7 @@ var component = (0,componentNormalizer/* default */.Z)(
 /***/ }),
-/***/ 8168:
+/***/ 8441:
 /***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => {
 "use strict";
@@ -1332,8 +1332,8 @@ __webpack_require__.d(__webpack_exports__, {
   "default": () => (/* binding */ Participant)
 });
-;// CONCATENATED MODULE: ./node_modules/@vue/vue-loader-v15/lib/loaders/templateLoader.js??vue-loader-options!./node_modules/@vue/vue-loader-v15/lib/index.js??vue-loader-options!./src/components/lifeline/Participant.vue?vue&type=template&id=37971538&scoped=true&
-var render = function () {var _vm=this;var _h=_vm.$createElement;var _c=_vm._self._c||_h;return _c('div',{ref:"participant",staticClass:"relative participant flex flex-col justify-center z-10 h-10",class:{'selected': _vm.selected, 'border-transparent': !!_vm.icon},style:({backgroundColor: _vm.backgroundColor, color: _vm.color}),on:{"click":_vm.onSelect}},[(!!_vm.icon)?_c('img',{staticClass:"absolute left-1/2 transform -translate-x-1/2 -translate-y-full h-8",attrs:{"src":_vm.icon,"alt":("icon for " + (_vm.entity.name))}}):_vm._e(),_c('div',{staticClass:"h-5 flex flex-col justify-center"},[(_vm.stereotype)?_c('label',{staticClass:"interface"},[_vm._v("«"+_vm._s(_vm.stereotype)+"»")]):_vm._e(),_c('label',{staticClass:"name"},[_vm._v(_vm._s(_vm.entity.label || _vm.entity.name))])])])}
+;// CONCATENATED MODULE: ./node_modules/@vue/vue-loader-v15/lib/loaders/templateLoader.js??vue-loader-options!./node_modules/@vue/vue-loader-v15/lib/index.js??vue-loader-options!./src/components/lifeline/Participant.vue?vue&type=template&id=7caf2a4e&scoped=true&
+var render = function () {var _vm=this;var _h=_vm.$createElement;var _c=_vm._self._c||_h;return _c('div',{ref:"participant",staticClass:"relative participant flex flex-col justify-center z-10 h-10",class:{'selected': _vm.selected, 'border-transparent': !!_vm.icon},style:({backgroundColor: _vm.backgroundColor, color: _vm.color}),on:{"click":_vm.onSelect}},[(!!_vm.icon)?_c('img',{staticClass:"absolute left-1/2 transform -translate-x-1/2 -translate-y-full h-8",attrs:{"src":_vm.icon,"alt":("icon for " + (_vm.entity.name))}}):_vm._e(),_c('div',{staticClass:"h-5 group flex flex-col justify-center"},[_c('span',{staticClass:"absolute hidden rounded-lg transform -translate-y-8 bg-gray-400 px-2 py-1 text-center text-sm text-white group-hover:flex"},[_vm._v(" "+_vm._s(_vm.comment)+" ")]),(_vm.stereotype)?_c('label',{staticClass:"interface"},[_vm._v("«"+_vm._s(_vm.stereotype)+"»")]):_vm._e(),_c('label',{staticClass:"name"},[_vm._v(_vm._s(_vm.entity.label || _vm.entity.name))])])])}
 var staticRenderFns = []
@@ -1357,7 +1357,7 @@ var component = (0,componentNormalizer/* default */.Z)(
   staticRenderFns,
   false,
   null,
-  "37971538",
+  "7caf2a4e",
   null
 )
@@ -26510,7 +26510,7 @@ exports.ParticipantType = ParticipantType;
   ParticipantType[ParticipantType["Undefined"] = 14] = "Undefined";
 })(ParticipantType || (exports.ParticipantType = ParticipantType = {}));
 class Participant {
-  constructor(name, isStarter, stereotype, width, groupId, label, explicit, type, color) {
+  constructor(name, isStarter, stereotype, width, groupId, label, explicit, type, color, comment) {
     this.name = name;
     this.stereotype = stereotype;
     this.width = width;
@@ -26520,6 +26520,7 @@ class Participant {
     this.label = label;
     this.type = type;
     this.color = color;
+    this.comment = comment;
   }
   Type() {
     var _a;
@@ -26559,8 +26560,8 @@ class Participants {
   constructor() {
     this.participants = new Map();
   }
-  Add(name, isStarter, stereotype, width, groupId, label, explicit, type, color) {
-    const participant = new Participant(name, isStarter, stereotype, width, groupId, label, explicit, type, color);
+  Add(name, isStarter, stereotype, width, groupId, label, explicit, type, color, comment) {
+    const participant = new Participant(name, isStarter, stereotype, width, groupId, label, explicit, type, color, comment);
     this.participants.set(name, (0, _mergeWith.default)({}, this.Get(name), participant, (a, b) => a || b));
   }
   // Returns an array of participants that are deduced from messages
@@ -27534,7 +27535,7 @@ exports.Z = void 0;
 //
 //
-const commitHash = "15a40b5";
+const commitHash = "6eb04bb";
 const gitBranch = "main";
 var _default = {
   name: "Debug",
@@ -29010,7 +29011,7 @@ Object.defineProperty(exports, "X", ({
 exports.Z = void 0;
 var _logger = _interopRequireDefault(__webpack_require__(3416));
 var _vuex = __webpack_require__(629);
-var _Participant = _interopRequireDefault(__webpack_require__(8168));
+var _Participant = _interopRequireDefault(__webpack_require__(8441));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 //
 //
@@ -29268,6 +29269,9 @@ var _Color = __webpack_require__(7271);
 //
 //
 //
+//
+//
+//
 const iconPath = {
   actor: __webpack_require__(4347),
@@ -29355,6 +29359,9 @@ var _default = {
     stereotype() {
       return this.entity.stereotype;
     },
+    comment() {
+      return this.entity.comment;
+    },
     icon() {
       var _this$entity$type;
       return iconPath[(_this$entity$type = this.entity.type) === null || _this$entity$type === void 0 ? void 0 : _this$entity$type.toLowerCase()];
@@ -35432,7 +35439,8 @@ let onParticipant = function (ctx) {
   const label = ctx.label && ((_ctx$label = ctx.label()) === null || _ctx$label === void 0 ? void 0 : (_ctx$label$name = _ctx$label.name()) === null || _ctx$label$name === void 0 ? void 0 : _ctx$label$name.getFormattedText());
   const explicit = true;
   const color = (_ctx$COLOR = ctx.COLOR()) === null || _ctx$COLOR === void 0 ? void 0 : _ctx$COLOR.getText();
-  participants.Add(participant, false, stereotype, width, groupId, label, explicit, type, color);
+  const comment = ctx.getComment();
+  participants.Add(participant, false, stereotype, width, groupId, label, explicit, type, color, comment);
 };
 ToCollector.prototype.enterParticipant = onParticipant;
 let onTo = function (ctx) {