fcad-core-dragon 2.0.0-beta.1 → 2.0.0-beta.3

package/src/router/routes.js

@@ -1,337 +1,312 @@
-import Router from 'vue-router'
-import AppCompViewDisplay from '../components/AppCompViewDisplay.vue'
-import store from '../module/store'
-import { fileAssets } from '../shared/generalfuncs'
-import ModuleView from '@/views/ModuleView.vue'
-import SummaryView from '@/views/SummaryView.vue'
-/**
- * The router Module defines the routes of the App by:
- * loading the required files for module and activities pages,
- * dynamically creating the navigation route of module base on the file in VIEWS folder
- * dynamically creating the navigation routes of activities and branchings base on the files contained in the MODULE
- * Creating Redirection routes for navigation error
- * Adding the pages for the module in the STORE
- */
-
-const defaultRoutes = [] // routes of the app
-let errorType = null
-let viewRoute = null // holder for views routes
-let mappedFiles = null // routes definitions
-
-/**
- * 1- Preparing the router to catch failing navigation error from browser by
- * Redefining the Router push method
- * ref: https://stackoverflow.com/questions/57837758/ navigationduplicated-navigating-to-current-location-search-is-not-allowed
- */
-const originalPush = Router.prototype.push
-Router.prototype.push = function push(location) {
-  return originalPush.call(this, location).catch((err) => err)
-}
-
-// Creating 1st route: redirection for none existing route to home(Module)
-defaultRoutes.push({
-  path: '*',
-  redirect: {
-    name: '404'
-  }
-})
-
-/**
- * 2 - Creating the 2nd route: The App module route
- */
-// Load all the files in the VIEWS folder
-
-const defaultRoute = {
-  path: '/',
-  component: AppCompViewDisplay,
-  children: [],
-  meta: {}
-}
-
-if (fileAssets.getViews().length > 0) {
-  let hasModule = false
-  let hasSummary = false
-  let fileRef = null
-  let splitted = null
-  let fileName = null
-  let fileContent = null
-
-  for (let view of fileAssets.getViews()) {
-    fileRef = view.replace(/(\.\/)/g, '')
-    splitted = fileRef.split('/')
-    fileName = splitted[splitted.length - 1].replace(/(\.vue)/g, '')
-    fileContent = fileAssets.fetchFileContent(`./${fileRef}`).default
-
-    // Create route for the views
-    viewRoute = {
-      name: fileName.toLowerCase(),
-
-      meta: {}
-    }
-
-    if (fileName.toLowerCase() === 'moduleview' && fileContent.data) {
-      viewRoute.path = ''
-      viewRoute.name = 'module'
-      // viewRoute.meta.type = 'normal'
-      viewRoute.component = ModuleView
-      viewRoute.children = []
-      viewRoute.meta.children = []
-      hasModule = true
-    }
-
-    if (fileName.toLowerCase() == 'summaryview' && fileContent.data) {
-      viewRoute.path = '/menu'
-      viewRoute.name = 'menu'
-      viewRoute.component = SummaryView
-      viewRoute.meta.type = 'menu'
-      viewRoute.meta.id = 'pg_menu'
-      hasSummary = true
-    }
-
-    defaultRoute.children.push(viewRoute)
-  }
-  // Create activities routes for the ModuleView
-  if (hasModule) {
-    const moduleRoute = defaultRoute.children.find((r) => r.name == 'module') //Get ModuleView route
-    //================== Routes For Activities ================//
-    // Load files in module folder
-    const _allFiles = fileAssets.getActivities()
-    mappedFiles = fileAssets.buildMapTree(_allFiles)
-    let abstractRouteForActivity = {}
-    if (!mappedFiles.size) errorType = 'errorPage'
-
-    //There is a file in the module folder
-    /**
-     * Define a route for each Activity and its pages
-     * Set all nested routes in Activities
-     * Set the activies routes as children of module route
-     */
-    let activityCount = 0
-
-    const buildRouteWithNested = ($arr, $folderName, ctx = '') => {
-      let bCounter = 0 //branch counter
-
-      let mainRoute = {}
-      for (const [key, value] of $arr) {
-        let pgIDtoNum = parseInt(key.slice(1))
-        let firstEl = $arr.entries().next().value
-
-        if (value.constructor === Map)
-          buildRouteWithNested(value, $folderName, ctx)
-
-        if (key == firstEl[0]) {
-          //Define the main route  according to 1st page id
-          mainRoute = (() => {
-            //1st Page is branching
-            if (key == 'P01')
-              return {
-                path: `page-1`,
-                name: `${ctx.replace('-', '_')}`,
-                component: () =>
-                  import(
-                    /* webpackChunkName: "home" */
-                    `@/${firstEl[1].ref}`
-                  ),
-                children: [],
-                meta: {
-                  id: firstEl[0],
-                  type: 'branching',
-                  activity_ref: $folderName, // Axx
-                  children: []
-                }
-              }
-
-            return {
-              path: `page-${pgIDtoNum}`,
-              name: `${ctx.replace('-', '_')}.page_${pgIDtoNum}`,
-              component: () =>
-                import(
-                  /* webpackChunkName: "home" */
-                  `@/${firstEl[1].ref}`
-                ),
-              children: [],
-              meta: {
-                id: firstEl[0],
-                type: 'branching',
-                activity_ref: $folderName, // Axx
-                parent: {
-                  _ref: 'P01',
-                  _path: ctx, // activite-xx
-                  _namedRoute: ctx.replace('-', '_') // activite_xx
-                },
-                children: []
-              }
-            }
-          })()
-        } else {
-          bCounter += 1
-          // build abstract route for branching
-          let branchRoute = {
-            path: `branche-${bCounter}`,
-            name: `${mainRoute.name}.branche_${bCounter}`,
-            component: () =>
-              import(
-                /* webpackChunkName: "gpNested" */
-                `@/${value.ref}`
-              ),
-            meta: {
-              id: key,
-              type: 'branch_page',
-              activity_ref: $folderName,
-              _branchingRef: `${firstEl[0]}.branch_${bCounter}`,
-              parent: {
-                _ref: firstEl[0],
-                _path: mainRoute.path,
-                _namedRoute: mainRoute.name
-              }
-            }
-          }
-          mainRoute.children.push(branchRoute)
-          mainRoute.meta.children.push({
-            _ref: key,
-            _path: branchRoute.path,
-            _namedRoute: branchRoute.name
-          })
-        }
-      }
-
-      return mainRoute
-    }
-
-    for (const [$folderName, $pages] of mappedFiles) {
-      let activityPageCount = 0 // page counter
-      //build a abstract route for each folder/activity
-      abstractRouteForActivity = {
-        component: AppCompViewDisplay,
-        meta: {
-          id: $folderName,
-          children: []
-        },
-        children: []
-      }
-      //Define the path for each folder
-      if ($folderName === 'A00') {
-        abstractRouteForActivity.path = 'introduction'
-      } else if ($folderName === 'A99') {
-        abstractRouteForActivity.path = 'conclusion'
-      } else {
-        activityCount++
-        abstractRouteForActivity.path = `activite-${activityCount}`
-      }
-
-      //Build the Route for each page of the Activity
-      for (const [$pageRef, $page] of $pages) {
-        let activityRoute
-        activityPageCount++
-
-        if ($page.constructor === Object) {
-          let firstPage = $pages.entries().next().value
-          if ($pageRef == firstPage[0]) {
-            activityRoute = {
-              path: 'page-1',
-              name: abstractRouteForActivity.path.replace('-', '_'), //activite_xx
-              component: () =>
-                import(/* webpackChunkName: "gpNested" */ `@/${$page.ref}`),
-              meta: {
-                id: `${$pageRef}`,
-                activity_ref: $folderName,
-                type: (() => {
-                  return abstractRouteForActivity.path.includes('activite')
-                    ? 'normal'
-                    : abstractRouteForActivity.path
-                })(),
-                parent: {
-                  _ref: `${$pageRef}`,
-                  _path: abstractRouteForActivity.path,
-                  _namedRoute: abstractRouteForActivity.path.replace('-', '_')
-                }
-              }
-            }
-          } else {
-            activityRoute = {
-              path: `page-${activityPageCount}`,
-              name: (() => {
-                let str = abstractRouteForActivity.path.replace('-', '_')
-
-                if (activityPageCount > 1)
-                  str = `${str}.page_${activityPageCount}`
-
-                return str
-              })(),
-              component: () =>
-                import(/* webpackChunkName: "gpNested" */ `@/${$page.ref}`),
-              meta: {
-                id: $pageRef,
-                activity_ref: $folderName,
-                type: (() => {
-                  return abstractRouteForActivity.path.includes('activite')
-                    ? 'normal'
-                    : abstractRouteForActivity.path
-                })(),
-                parent: {
-                  _ref: `${$pageRef}`,
-                  _path: abstractRouteForActivity.path,
-                  _namedRoute: abstractRouteForActivity.path.replace('-', '_')
-                }
-              }
-            }
-          }
-        }
-        //Handling Branching Routes
-        if ($page.constructor === Map) {
-          const ctx = abstractRouteForActivity.path
-          activityRoute = buildRouteWithNested($page, $folderName, ctx)
-        }
-        //add page route into activity children
-        abstractRouteForActivity.children.push(activityRoute)
-
-        //add page route reference into in activity meta
-        abstractRouteForActivity.meta.children.push({
-          _ref: activityRoute.meta.id,
-          _path: activityRoute.path,
-          _namedRoute: activityRoute.name
-        })
-      }
-
-      moduleRoute.meta.children.push({
-        _ref: $folderName,
-        _path: abstractRouteForActivity.path,
-        _namedRoute: abstractRouteForActivity.path.replace('-', '_')
-      })
-
-      moduleRoute.children.push(abstractRouteForActivity)
-    }
-
-    // Add register Module pages to store
-    store.state.thisModule.activities = mappedFiles
-    // Set Module route as child of abstract route. Module will render inside abstract component
-  } else errorType = 'errorModule'
-  if (!hasSummary) errorType = 'errorMenu'
-} else errorType = 'errorModule'
-if (!errorType) {
-  defaultRoutes.push(defaultRoute)
-  defaultRoutes.push({
-    path: '/',
-    component: () =>
-      import(
-        /* webpackChunkName: "gpNested" */ `../components/AppBaseErrorDisplay.vue`
-      ),
-    props: {
-      errorMessage: errorType
-    }
-  })
-}
-// Routes for errors : 404
-defaultRoutes.push({
-  path: '/404',
-  name: '404',
-  component: () =>
-    import(
-      /* webpackChunkName: "gpNested" */ `../components/AppBaseErrorDisplay.vue`
-    ),
-  props: {
-    errorMessage: '404'
-  }
-})
-
-export default defaultRoutes
+import AppCompViewDisplay from '../components/AppCompViewDisplay.vue'
+import { fileAssets } from '../shared/generalfuncs'
+//import ModuleView from '@/views/ModuleView.vue' // Uncomment for Production
+// import SummaryView from '@/views/SummaryView.vue' // Uncomment for Production
+
+//import ModuleView from '../externalComps/ModuleView.vue' //Only for unit-Testing
+//import SummaryView from '../externalComps/SummaryView.vue' //Only for unit-Testing
+
+/**
+ * The router Module defines the routes of the App by:
+ * loading the required files for module and activities pages,
+ * dynamically creating the navigation route of module base on the file in VIEWS folder
+ * dynamically creating the navigation routes of activities and branchings base on the files contained in the MODULE
+ * Creating Redirection routes for navigation error
+ * Adding the pages for the module in the STORE
+ */
+
+const defaultRoutes = [] // routes of the app
+let errorType = null
+let viewRoute = null // holder for views routes
+let mappedFiles = null // routes definitions
+
+// Creating 1st route: redirection for none existing route to home(Module)
+defaultRoutes.push({
+  path: '/:pathMatch(.*)*',
+  redirect: {
+    name: '404'
+  }
+})
+
+/**
+ * 2 - Creating the 2nd route: The App module route
+ */
+// Load all the files in the VIEWS folder
+
+const defaultRoute = {
+  path: '/',
+  component: AppCompViewDisplay,
+  children: [],
+  meta: {}
+}
+
+if (fileAssets.getViews().length > 0) {
+  let hasModule = false
+  let hasSummary = false
+  let fileRef = null
+  let splitted = null
+  let fileName = null
+  let fileContent = null
+
+  for (let view of fileAssets.getViews()) {
+    fileRef = view.name.replace(/(\.\/)/g, '')
+    splitted = fileRef.split('/')
+    fileName = splitted[splitted.length - 1].replace(/(\.vue)/g, '')
+    fileContent = view.content
+
+    // Create route for the views
+    viewRoute = {
+      name: fileName.toLowerCase(),
+
+      meta: {}
+    }
+
+    if (fileName.toLowerCase() === 'moduleview' && fileContent.data) {
+      viewRoute.path = ''
+      viewRoute.name = 'module'
+      viewRoute.component = () => import(`@/views/ModuleView.vue`)
+      viewRoute.children = []
+      viewRoute.meta.children = []
+      hasModule = true
+    }
+
+    if (fileName.toLowerCase() == 'summaryview' && fileContent.data) {
+      viewRoute.path = '/menu'
+      viewRoute.name = 'menu'
+      viewRoute.component = () => import(`@/views/SummaryView.vue`)
+      viewRoute.meta.type = 'menu'
+      viewRoute.meta.id = 'pg_menu'
+      hasSummary = true
+    }
+
+    defaultRoute.children.push(viewRoute)
+  }
+
+  // Create activities routes for the ModuleView
+  if (hasModule) {
+    const moduleRoute = defaultRoute.children.find((r) => r.name == 'module') //Get ModuleView route
+    //================== Routes For Activities ================//
+    // Load files in module folder
+    const _allFiles = fileAssets.getActivities()
+
+    mappedFiles = fileAssets.buildMapTree(_allFiles)
+    let abstractRouteForActivity = {}
+    if (!mappedFiles.size) errorType = 'errorPage'
+
+    //There is a file in the module folder
+    /**
+     * Define a route for each Activity and its pages
+     * Set all nested routes in Activities
+     * Set the activies routes as children of module route
+     */
+    let activityCount = 0
+
+    const buildRouteWithNested = ($arr, $folderName, ctx = '') => {
+      let bCounter = 0 //branch counter
+
+      let mainRoute = {}
+      for (const [key, value] of $arr) {
+        let pgIDtoNum = parseInt(key.slice(1))
+        let firstEl = $arr.entries().next().value
+
+        if (value.constructor === Map)
+          buildRouteWithNested(value, $folderName, ctx)
+
+        if (key == firstEl[0]) {
+          //Define the main route  according to 1st page id
+          mainRoute = (() => {
+            //1st Page is branching
+
+            if (key == 'P01')
+              return {
+                path: `page-1`,
+                name: `${ctx.replace('-', '_')}`,
+                component: () => import(`@/${firstEl[1].ref}.vue`),
+                children: [],
+                meta: {
+                  id: firstEl[0],
+                  type: 'branching',
+                  activity_ref: $folderName, // Axx
+                  children: []
+                }
+              }
+
+            return {
+              path: `page-${pgIDtoNum}`,
+              name: `${ctx.replace('-', '_')}.page_${pgIDtoNum}`,
+              component: () => import(`@/${firstEl[1].ref}.vue`),
+              children: [],
+              meta: {
+                id: firstEl[0],
+                type: 'branching',
+                activity_ref: $folderName, // Axx
+                parent: {
+                  _ref: 'P01',
+                  _path: ctx, // activite-xx
+                  _namedRoute: ctx.replace('-', '_') // activite_xx
+                },
+                children: []
+              }
+            }
+          })()
+        } else {
+          bCounter += 1
+          // build abstract route for branching
+          let branchRoute = {
+            path: `branche-${bCounter}`,
+            name: `${mainRoute.name}.branche_${bCounter}`,
+            component: () => import(`@/${value.ref}.vue`),
+            meta: {
+              id: key,
+              type: 'branch_page',
+              activity_ref: $folderName,
+              _branchingRef: `${firstEl[0]}.branch_${bCounter}`,
+              parent: {
+                _ref: firstEl[0],
+                _path: mainRoute.path,
+                _namedRoute: mainRoute.name
+              }
+            }
+          }
+          mainRoute.children.push(branchRoute)
+          mainRoute.meta.children.push({
+            _ref: key,
+            _path: branchRoute.path,
+            _namedRoute: branchRoute.name
+          })
+        }
+      }
+
+      return mainRoute
+    }
+
+    for (const [$folderName, $pages] of mappedFiles) {
+      let activityPageCount = 0 // page counter
+      //build a abstract route for each folder/activity
+      abstractRouteForActivity = {
+        component: AppCompViewDisplay,
+        meta: {
+          id: $folderName,
+          children: []
+        },
+        children: []
+      }
+      //Define the path for each folder
+      if ($folderName === 'A00') {
+        abstractRouteForActivity.path = 'introduction'
+      } else if ($folderName === 'A99') {
+        abstractRouteForActivity.path = 'conclusion'
+      } else {
+        activityCount++
+        abstractRouteForActivity.path = `activite-${activityCount}`
+      }
+
+      //Build the Route for each page of the Activity
+      for (const [$pageRef, $page] of $pages) {
+        let activityRoute
+        activityPageCount++
+
+        if ($page.constructor === Object) {
+          let firstPage = $pages.entries().next().value
+          if ($pageRef == firstPage[0]) {
+            activityRoute = {
+              path: 'page-1',
+              name: abstractRouteForActivity.path.replace('-', '_'), //activite_xx
+              component: () => import(`@/${$page.ref}.vue`),
+              meta: {
+                id: `${$pageRef}`,
+                activity_ref: $folderName,
+                type: (() => {
+                  return abstractRouteForActivity.path.includes('activite')
+                    ? 'normal'
+                    : abstractRouteForActivity.path
+                })(),
+                parent: {
+                  _ref: `${$pageRef}`,
+                  _path: abstractRouteForActivity.path,
+                  _namedRoute: abstractRouteForActivity.path.replace('-', '_')
+                }
+              }
+            }
+          } else {
+            activityRoute = {
+              path: `page-${activityPageCount}`,
+              name: (() => {
+                let str = abstractRouteForActivity.path.replace('-', '_')
+
+                if (activityPageCount > 1)
+                  str = `${str}.page_${activityPageCount}`
+
+                return str
+              })(),
+              component: () => import(`@/${$page.ref}.vue`),
+              meta: {
+                id: $pageRef,
+                activity_ref: $folderName,
+                type: (() => {
+                  return abstractRouteForActivity.path.includes('activite')
+                    ? 'normal'
+                    : abstractRouteForActivity.path
+                })(),
+                parent: {
+                  _ref: `${$pageRef}`,
+                  _path: abstractRouteForActivity.path,
+                  _namedRoute: abstractRouteForActivity.path.replace('-', '_')
+                }
+              }
+            }
+          }
+        }
+        //Handling Branching Routes
+        if ($page.constructor === Map) {
+          const ctx = abstractRouteForActivity.path
+          activityRoute = buildRouteWithNested($page, $folderName, ctx)
+        }
+        //add page route into activity children
+        abstractRouteForActivity.children.push(activityRoute)
+
+        //add page route reference into in activity meta
+        abstractRouteForActivity.meta.children.push({
+          _ref: activityRoute.meta.id,
+          _path: activityRoute.path,
+          _namedRoute: activityRoute.name
+        })
+      }
+
+      moduleRoute.meta.children.push({
+        _ref: $folderName,
+        _path: abstractRouteForActivity.path,
+        _namedRoute: abstractRouteForActivity.path.replace('-', '_')
+      })
+
+      moduleRoute.children.push(abstractRouteForActivity)
+    }
+  } else errorType = 'errorModule'
+  if (!hasSummary) errorType = 'errorMenu'
+} else errorType = 'errorModule'
+
+if (!errorType) {
+  defaultRoutes.push(defaultRoute)
+} else
+  defaultRoutes.push({
+    path: '/',
+    component: () => import(`../components/AppBaseErrorDisplay.vue`),
+    props: {
+      errorGroup: 'application',
+      errorType: errorType
+    }
+  })
+
+// Routes for errors : 404
+defaultRoutes.push({
+  path: '/404',
+  name: '404',
+  component: () => import(`../components/AppBaseErrorDisplay.vue`),
+  props: {
+    errorGroup: 'application',
+    errorType: '404'
+  }
+})
+
+export default defaultRoutes
+export { mappedFiles }