@abi-software/mapintegratedvuer 1.5.1-beta-1 → 1.5.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abi-software/mapintegratedvuer",
-  "version": "1.5.1-beta-1",
+  "version": "1.5.2",
   "license": "Apache-2.0",
   "scripts": {
     "serve": "vite --host --force",
@@ -50,32 +50,28 @@
     "*.js"
   ],
   "dependencies": {
-    "@abi-software/flatmapvuer": "^1.5.1",
-    "@abi-software/map-side-bar": "^2.4.1",
-    "@abi-software/map-utilities": "^1.1.0",
-    "@abi-software/plotvuer": "1.0.0",
-    "@abi-software/scaffoldvuer": "^1.4.1",
-    "@abi-software/simulationvuer": "2.0.6",
-    "@abi-software/svg-sprite": "1.0.0",
+    "@abi-software/flatmapvuer": "^1.5.6",
+    "@abi-software/map-side-bar": "^2.4.2",
+    "@abi-software/map-utilities": "^1.1.2",
+    "@abi-software/plotvuer": "^1.0.3",
+    "@abi-software/scaffoldvuer": "^1.5.1",
+    "@abi-software/simulationvuer": "^1.0.1",
+    "@abi-software/svg-sprite": "^1.0.1",
     "@element-plus/icons-vue": "^2.3.1",
-    "@pinia/testing": "^0.1.3",
     "@vitejs/plugin-vue": "^4.6.2",
     "css-element-queries": "^1.2.3",
-    "element-plus": "^2.4.4",
+    "element-plus": "2.8.4",
     "marked": "^4.3.0",
     "mitt": "^3.0.1",
     "pinia": "^2.1.7",
     "splitpanes": "^3.1.5",
-    "vue": "^3.5.11",
-    "vue-router": "^4.2.5",
-    "vuex": "^4.1.0",
+    "vue": "^3.4.21",
     "xss": "^1.0.14"
   },
   "devDependencies": {
-    "@cypress/webpack-dev-server": "^3.6.1",
+    "@pinia/testing": "^0.1.3",
     "@vue/test-utils": "^2.4.4",
     "@vuese/markdown-render": "^2.11.3",
-    "@vuese/parser": "^2.10.3",
     "auto-changelog": "^2.4.0",
     "babel-eslint": "^10.0.3",
     "babel-plugin-component": "^1.1.1",
@@ -100,7 +96,9 @@
     "sass": "^1.69.5",
     "vite": "^5.0.10",
     "vitepress": "^1.0.0-rc.45",
-    "vitest": "^1.2.2"
+    "vitest": "^1.2.2",
+    "vue-docgen-api": "^4.79.2",
+    "vue-router": "^4.2.5"
   },
   "eslintConfig": {
     "root": true,

package/src/components/ContentVuer.vue

@@ -121,6 +121,7 @@ export default {
     },
     speciesChanged: function (species) {
       this.activeSpecies = species;
+      this.$emit("species-changed", species);
     },
     receiveSynchronisedEvent: async function (data) {
       this.$refs.viewer?.receiveSynchronisedEvent(data);

package/src/components/MapContent.vue

@@ -64,7 +64,7 @@ export default {
      */
     options: {
       type: Object,
-      default: () => {},
+      default: () => ({}),
       required: true
     },
     /**
@@ -100,7 +100,7 @@ export default {
   },
   methods: {
     /**
-     * @vuese
+     * @public
      * Function to check whether it is in fullscreen mode or not.
      *
      */
@@ -109,9 +109,9 @@ export default {
         document.mozFullScreenElement || document.msFullscreenElement )
     },
     /**
-     * @vuese
+     * @public
      * Function to toggle fullscreen.
-     * @arg fullscreenRequest
+     * @arg `fullscreenReq`
      */
     onFullscreen: function(fullscreenReq) {
       //If a request is sent, try it
@@ -133,7 +133,7 @@ export default {
       }
     },
     /**
-     * @vuese
+     * @public
      * Function to leave fullscreen mode.
      */
     leaveFullscreen: function(){
@@ -150,7 +150,7 @@ export default {
       }
     },
     /**
-     * @vuese
+     * @public
      * Function to go to fullscreen mode.
      */
     goFullscreen: function(){
@@ -172,12 +172,12 @@ export default {
       return this.$refs.flow.getState();
     },
     /**
-     * @vuese
+     * @public
      * Provide a way to set the current view, this is currently limited
      * to setting view for flatmapm, multiflatmap or scaffold.
      * In the case of the multiflatmap, it will not create a new entry and
      * instead change the current entry by setting the state.
-     * @arg state
+     * @arg `state`
      */
     setCurrentEntry: async function(state) {
       if (state && state.type) {
@@ -253,15 +253,16 @@ export default {
       }
     },
     /**
-     * @vuese
+     * @public
      * Open the sidebar with the specified facets and query.
-     * @arg facets, query
+     * @arg `facets`,
+     * @arg `query`
      */
     openSearch: function(facets, query) {
       return this.$refs.flow.openSearch(facets, query);
     },
     /**
-     * @vuese
+     * @public
      * Function to run when the component is mounted.
      */
     flowMounted: function () {

package/src/components/SplitDialog.vue

@@ -15,6 +15,7 @@
         :entry="entry"
         ref="content"
         @resource-selected="resourceSelected"
+        @species-changed="speciesChanged"
         :visible="isIdVisible(entry.id)"
       />
     </div>
@@ -56,6 +57,9 @@ export default {
     resourceSelected: function(result) {
       this.$emit("resource-selected", result);
     },
+    speciesChanged: function (species) {
+      this.$emit("species-changed", species);
+    },
     getClass: function(id) {
       if (this.isIdVisible(id)) {
         return this.getRefsName(id);

package/src/components/SplitFlow.vue

@@ -41,6 +41,7 @@
           :entries="entries"
           ref="splitdialog"
           @resource-selected="resourceSelected"
+          @species-changed="speciesChanged"
         />
       </div>
     </el-main>
@@ -451,6 +452,11 @@ export default {
         this.$refs.splitdialog.sendSynchronisedEvent(result);
       }
     },
+    speciesChanged: function (species) {
+      if (this.$refs.sideBar) {
+        this.$refs.sideBar.close();
+      }
+    },
     tabClicked: function ({id, type}) {
       this.activeDockedId = id;
     },

package/vite.bundle-build.js

@@ -12,12 +12,11 @@ export default defineConfig((configEnv) => {
       fileName: "mapintegratedvuer",
     },
     rollupOptions: {
-      external: ["vue", "pinia", "@abi-software/simulationvuer"],
+      external: ["vue", "pinia"],
       output: {
         globals: {
           vue: "Vue",
           pinia: "pinia",
-          "@abi-software/simulationvuer": "simulationvuer",
         },
       },
     },

package/vuese-generator.js

@@ -8,7 +8,8 @@
 import fs from 'fs'
 import path from 'path'
 import chokidar from 'chokidar'
-import { parser } from '@vuese/parser'
+// import { parser } from '@vuese/parser'
+import { parseSource } from 'vue-docgen-api'
 import { Render } from '@vuese/markdown-render'
 
 const watchMode = process.argv.find((argv) => argv === 'watch')
@@ -22,29 +23,87 @@ function generateMarkdown(file) {
   const fileContent = fs.readFileSync(fileWithPath, 'utf-8')
 
   try {
-    const parserResult = parser(fileContent)
-    const r = new Render(parserResult)
-    const renderResult = r.render()
-    const markdownResult = r.renderMarkdown()
-    const markdownContent = markdownResult.content
-    const componentName = path.basename(fileWithPath, '.vue')
-
-    if (!fs.existsSync(outputDir)) {
-      fs.mkdirSync(outputDir)
-    }
+    // const parserResult = parser(fileContent)
+    const parserResult = parseSource(fileContent, fileWithPath)
+    parserResult.then((result) => {
+      const {
+        displayName: name,
+        description: desc,
+        props,
+        events,
+        methods,
+      } = result
+
+      // transform props to vuese styles
+      const parseResult = {
+        name: name,
+        componentDesc: {
+          default: [desc]
+        },
+        props: transformData(props),
+        events: transformData(events),
+        methods: transformData(methods),
+      }
+      const r = new Render(parseResult)
+      const renderResult = r.render()
+      const markdownResult = r.renderMarkdown()
+      const markdownContent = markdownResult.content
+      const componentName = path.basename(fileWithPath, '.vue')
 
-    fs.writeFile(`${outputDir}/${componentName}.md`, markdownContent, (err) => {
-      if (err) {
-        console.error(`Error writing markdown file for ${componentName}`, err)
-      } else {
-        console.log(`Markdown file for ${componentName} is generated!`)
+      if (!fs.existsSync(outputDir)) {
+        fs.mkdirSync(outputDir)
       }
+
+      fs.writeFile(`${outputDir}/${componentName}.md`, markdownContent, (err) => {
+        if (err) {
+          console.error(`Error writing markdown file for ${componentName}`, err)
+        } else {
+          console.log(`Markdown file for ${componentName} is generated!`)
+        }
+      })
     })
   } catch(e) {
     console.error(e)
   }
 }
 
+function transformData(data = []) {
+  data.forEach((prop) => {
+    prop.name = prop.name
+
+    if (prop.description) {
+      prop.describe = [prop.description.replaceAll('\n', ' ')]
+    }
+
+    if (prop.type) {
+      prop.type = prop.type.name
+    }
+
+    if (prop.defaultValue) {
+      prop.default = prop.defaultValue.value.replaceAll('\n', ' ')
+    }
+
+    // events
+    if (prop.properties) {
+      prop.argumentsDesc = []
+      prop.properties.forEach((param) => {
+        const argName = param.name || param.description
+        prop.argumentsDesc.push(argName)
+      })
+    }
+
+    // methods
+    if (prop.params) {
+      prop.argumentsDesc = []
+      prop.params.forEach((param) => {
+        const argName = param.description || param.name
+        prop.argumentsDesc.push(argName)
+      })
+    }
+  })
+  return data
+}
+
 // To generate markdown files - one time
 components.forEach((component) => {
   console.log(`Write markdown file for ${component} on first load.`)

package/dist/Simulation-vS_R9P47.js

@@ -1,22 +0,0 @@
-import { C as i } from "./ContentMixin-BY38ulup.js";
-import { SimulationVuer as t } from "@abi-software/simulationvuer";
-import { resolveComponent as e, openBlock as r, createBlock as a } from "vue";
-import { _ as m } from "./index-DBVNcOgU.js";
-const c = {
-  name: "Simulation",
-  mixins: [i],
-  components: {
-    SimulationVuer: t
-  }
-};
-function p(o, s, u, l, f, _) {
-  const n = e("SimulationVuer");
-  return r(), a(n, {
-    apiLocation: o.apiLocation,
-    id: o.entry.discoverId
-  }, null, 8, ["apiLocation", "id"]);
-}
-const C = /* @__PURE__ */ m(c, [["render", p]]);
-export {
-  C as default
-};