refs #5895 config

jsdoc.json

@@ -0,0 +1,16 @@
+{
+    "plugins": [],
+    "source": {
+        "include": ["src"],
+        "includePattern": ".js$ .vue$",
+        "excludePattern": "(node_modules\\/docs)"
+    },
+    "templates": {
+        "cleverLinks": false,
+        "monospaceLinks": false
+    },
+    "opts": {
+        "recurse": true,
+        "destination": "./doc"
+    }
+}

package-lock.json

@@ -1,17 +1,18 @@
 {
     "name": "salix-front",
-    "version": "23.40.01",
+    "version": "23.48.01",
     "lockfileVersion": 3,
     "requires": true,
     "packages": {
         "": {
             "name": "salix-front",
-            "version": "0.0.1",
+            "version": "23.48.01",
             "dependencies": {
-                "@quasar/cli": "^2.2.1",
+                "@quasar/cli": "^2.3.0",
                 "@quasar/extras": "^1.16.4",
                 "axios": "^1.4.0",
                 "chromium": "^3.0.3",
+                "jsdoc": "^4.0.2",
                 "pinia": "^2.1.3",
                 "quasar": "^2.12.0",
                 "validator": "^13.9.0",
@@ -778,6 +779,17 @@
             "integrity": "sha512-XPSJHWmi394fuUuzDnGz1wiKqWfo1yXecHQMRf2l6hztTO+nPru658AyDngaBe7isIxEkRsPR3FZh+s7iVa4Uw==",
             "dev": true
         },
+        "node_modules/@jsdoc/salty": {
+            "version": "0.2.6",
+            "resolved": "https://registry.npmjs.org/@jsdoc/salty/-/salty-0.2.6.tgz",
+            "integrity": "sha512-aA+awb5yoml8TQ3CzI5Ue7sM3VMRC4l1zJJW4fgZ8OCL1wshJZhNzaf0PL85DSnOUw6QuFgeHGD/eq/xwwAF2g==",
+            "dependencies": {
+                "lodash": "^4.17.21"
+            },
+            "engines": {
+                "node": ">=v12.0.0"
+            }
+        },
         "node_modules/@nodelib/fs.scandir": {
             "version": "2.1.5",
             "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz",
@@ -946,9 +958,9 @@
             }
         },
         "node_modules/@quasar/cli": {
-            "version": "2.2.1",
+            "version": "2.3.0",
-            "resolved": "https://registry.npmjs.org/@quasar/cli/-/cli-2.2.1.tgz",
+            "resolved": "https://registry.npmjs.org/@quasar/cli/-/cli-2.3.0.tgz",
-            "integrity": "sha512-PMwJ76IeeNRRBw+08hUMjhqGC6JKJ/t1zIb+IOiyR5D4rkBR26Ha/Z46OD3KfwUprq4Q8s4ieB1+d3VY8FhPKg==",
+            "integrity": "sha512-DNFDemicj3jXe5+Ib+5w9Bwj1U3yoHQkqn0bU/qysIl/p0MmGA1yqOfUF0V4fw/5or1dfCvStIA/oZxUcC+2pQ==",
             "dependencies": {
                 "@quasar/ssl-certificate": "^1.0.0",
                 "ci-info": "^3.8.0",
@@ -1272,6 +1284,25 @@
                 "@types/node": "*"
             }
         },
+        "node_modules/@types/linkify-it": {
+            "version": "3.0.5",
+            "resolved": "https://registry.npmjs.org/@types/linkify-it/-/linkify-it-3.0.5.tgz",
+            "integrity": "sha512-yg6E+u0/+Zjva+buc3EIb+29XEg4wltq7cSmd4Uc2EE/1nUVmxyzpX6gUXD0V8jIrG0r7YeOGVIbYRkxeooCtw=="
+        },
+        "node_modules/@types/markdown-it": {
+            "version": "12.2.3",
+            "resolved": "https://registry.npmjs.org/@types/markdown-it/-/markdown-it-12.2.3.tgz",
+            "integrity": "sha512-GKMHFfv3458yYy+v/N8gjufHO6MSZKCOXpZc5GXIWWy8uldwfmPn98vp81gZ5f9SVw8YYBctgfJ22a2d7AOMeQ==",
+            "dependencies": {
+                "@types/linkify-it": "*",
+                "@types/mdurl": "*"
+            }
+        },
+        "node_modules/@types/mdurl": {
+            "version": "1.0.5",
+            "resolved": "https://registry.npmjs.org/@types/mdurl/-/mdurl-1.0.5.tgz",
+            "integrity": "sha512-6L6VymKTzYSrEf4Nev4Xa1LCHKrlTlYCBMTlQKFuddo1CvQcE52I0mwfOJayueUC7MJuXOeHTcIU683lzd0cUA=="
+        },
         "node_modules/@types/mime": {
             "version": "3.0.1",
             "resolved": "https://registry.npmjs.org/@types/mime/-/mime-3.0.1.tgz",
@@ -1818,8 +1849,7 @@
         "node_modules/argparse": {
             "version": "2.0.1",
             "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz",
-            "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==",
+            "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q=="
-            "dev": true
         },
         "node_modules/array-flatten": {
             "version": "1.1.1",
@@ -2011,8 +2041,7 @@
         "node_modules/bluebird": {
             "version": "3.7.2",
             "resolved": "https://registry.npmjs.org/bluebird/-/bluebird-3.7.2.tgz",
-            "integrity": "sha512-XpNj6GDQzdfW+r2Wnn7xiSAd7TM3jzkxGXBGTtWKuSXv1xUV+azxAm8jdWZN06QTQk+2N2XB9jRDkvbmQmcRtg==",
+            "integrity": "sha512-XpNj6GDQzdfW+r2Wnn7xiSAd7TM3jzkxGXBGTtWKuSXv1xUV+azxAm8jdWZN06QTQk+2N2XB9jRDkvbmQmcRtg=="
-            "dev": true
         },
         "node_modules/blueimp-md5": {
             "version": "2.19.0",
@@ -2425,6 +2454,17 @@
             "integrity": "sha512-4tYFyifaFfGacoiObjJegolkwSU4xQNGbVgUiNYVUxbQ2x2lUsFvY4hVgVzGiIe6WLOPqycWXA40l+PWsxthUw==",
             "dev": true
         },
+        "node_modules/catharsis": {
+            "version": "0.9.0",
+            "resolved": "https://registry.npmjs.org/catharsis/-/catharsis-0.9.0.tgz",
+            "integrity": "sha512-prMTQVpcns/tzFgFVkVp6ak6RykZyWb3gu8ckUpd6YkTlacOd3DXGJjIpD4Q6zJirizvaiAjSSHlOsA+6sNh2A==",
+            "dependencies": {
+                "lodash": "^4.17.15"
+            },
+            "engines": {
+                "node": ">= 10"
+            }
+        },
         "node_modules/chai": {
             "version": "4.3.7",
             "resolved": "https://registry.npmjs.org/chai/-/chai-4.3.7.tgz",
@@ -3783,6 +3823,14 @@
                 "node": ">=8.6"
             }
         },
+        "node_modules/entities": {
+            "version": "2.1.0",
+            "resolved": "https://registry.npmjs.org/entities/-/entities-2.1.0.tgz",
+            "integrity": "sha512-hCx1oky9PFrJ611mf0ifBLBRW8lUUVRlFolb5gWRfIELabBlbp9xZvrqZLZAs+NxFnbfQoeGd8wDkygjg7U85w==",
+            "funding": {
+                "url": "https://github.com/fb55/entities?sponsor=1"
+            }
+        },
         "node_modules/esbuild": {
             "version": "0.14.51",
             "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.14.51.tgz",
@@ -5729,12 +5777,67 @@
                 "js-yaml": "bin/js-yaml.js"
             }
         },
+        "node_modules/js2xmlparser": {
+            "version": "4.0.2",
+            "resolved": "https://registry.npmjs.org/js2xmlparser/-/js2xmlparser-4.0.2.tgz",
+            "integrity": "sha512-6n4D8gLlLf1n5mNLQPRfViYzu9RATblzPEtm1SthMX1Pjao0r9YI9nw7ZIfRxQMERS87mcswrg+r/OYrPRX6jA==",
+            "dependencies": {
+                "xmlcreate": "^2.0.4"
+            }
+        },
         "node_modules/jsbn": {
             "version": "0.1.1",
             "resolved": "https://registry.npmjs.org/jsbn/-/jsbn-0.1.1.tgz",
             "integrity": "sha512-UVU9dibq2JcFWxQPA6KCqj5O42VOmAY3zQUfEKxU0KpTGXwNoCjkX1e13eHNvw/xPynt6pU0rZ1htjWTNTSXsg==",
             "dev": true
         },
+        "node_modules/jsdoc": {
+            "version": "4.0.2",
+            "resolved": "https://registry.npmjs.org/jsdoc/-/jsdoc-4.0.2.tgz",
+            "integrity": "sha512-e8cIg2z62InH7azBBi3EsSEqrKx+nUtAS5bBcYTSpZFA+vhNPyhv8PTFZ0WsjOPDj04/dOLlm08EDcQJDqaGQg==",
+            "dependencies": {
+                "@babel/parser": "^7.20.15",
+                "@jsdoc/salty": "^0.2.1",
+                "@types/markdown-it": "^12.2.3",
+                "bluebird": "^3.7.2",
+                "catharsis": "^0.9.0",
+                "escape-string-regexp": "^2.0.0",
+                "js2xmlparser": "^4.0.2",
+                "klaw": "^3.0.0",
+                "markdown-it": "^12.3.2",
+                "markdown-it-anchor": "^8.4.1",
+                "marked": "^4.0.10",
+                "mkdirp": "^1.0.4",
+                "requizzle": "^0.2.3",
+                "strip-json-comments": "^3.1.0",
+                "underscore": "~1.13.2"
+            },
+            "bin": {
+                "jsdoc": "jsdoc.js"
+            },
+            "engines": {
+                "node": ">=12.0.0"
+            }
+        },
+        "node_modules/jsdoc/node_modules/escape-string-regexp": {
+            "version": "2.0.0",
+            "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-2.0.0.tgz",
+            "integrity": "sha512-UpzcLCXolUWcNu5HtVMHYdXJjArjsF9C0aNnquZYY4uW/Vu0miy5YoWvbV345HauVvcAUnpRuhMMcqTcGOY2+w==",
+            "engines": {
+                "node": ">=8"
+            }
+        },
+        "node_modules/jsdoc/node_modules/mkdirp": {
+            "version": "1.0.4",
+            "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz",
+            "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==",
+            "bin": {
+                "mkdirp": "bin/cmd.js"
+            },
+            "engines": {
+                "node": ">=10"
+            }
+        },
         "node_modules/json-buffer": {
             "version": "3.0.1",
             "resolved": "https://registry.npmjs.org/json-buffer/-/json-buffer-3.0.1.tgz",
@@ -5885,6 +5988,14 @@
                 "node": ">=0.10.0"
             }
         },
+        "node_modules/klaw": {
+            "version": "3.0.0",
+            "resolved": "https://registry.npmjs.org/klaw/-/klaw-3.0.0.tgz",
+            "integrity": "sha512-0Fo5oir+O9jnXu5EefYbVK+mHMBeEVEy2cmctR1O1NECcCkPRreJKrS6Qt/j3KC2C148Dfo9i3pCmCMsdqGr0g==",
+            "dependencies": {
+                "graceful-fs": "^4.1.9"
+            }
+        },
         "node_modules/kolorist": {
             "version": "1.8.0",
             "resolved": "https://registry.npmjs.org/kolorist/-/kolorist-1.8.0.tgz",
@@ -5968,6 +6079,14 @@
             "integrity": "sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==",
             "dev": true
         },
+        "node_modules/linkify-it": {
+            "version": "3.0.3",
+            "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-3.0.3.tgz",
+            "integrity": "sha512-ynTsyrFSdE5oZ/O9GEf00kPngmOfVwazR5GKDq6EYfhlpFug3J2zybX56a2PRRpc9P+FuSoGNAwjlbDs9jJBPQ==",
+            "dependencies": {
+                "uc.micro": "^1.0.1"
+            }
+        },
         "node_modules/listr2": {
             "version": "3.14.0",
             "resolved": "https://registry.npmjs.org/listr2/-/listr2-3.14.0.tgz",
@@ -6025,8 +6144,7 @@
         "node_modules/lodash": {
             "version": "4.17.21",
             "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz",
-            "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==",
+            "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg=="
-            "dev": true
         },
         "node_modules/lodash-es": {
             "version": "4.17.21",
@@ -6178,6 +6296,41 @@
                 "node": ">=12"
             }
         },
+        "node_modules/markdown-it": {
+            "version": "12.3.2",
+            "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-12.3.2.tgz",
+            "integrity": "sha512-TchMembfxfNVpHkbtriWltGWc+m3xszaRD0CZup7GFFhzIgQqxIfn3eGj1yZpfuflzPvfkt611B2Q/Bsk1YnGg==",
+            "dependencies": {
+                "argparse": "^2.0.1",
+                "entities": "~2.1.0",
+                "linkify-it": "^3.0.1",
+                "mdurl": "^1.0.1",
+                "uc.micro": "^1.0.5"
+            },
+            "bin": {
+                "markdown-it": "bin/markdown-it.js"
+            }
+        },
+        "node_modules/markdown-it-anchor": {
+            "version": "8.6.7",
+            "resolved": "https://registry.npmjs.org/markdown-it-anchor/-/markdown-it-anchor-8.6.7.tgz",
+            "integrity": "sha512-FlCHFwNnutLgVTflOYHPW2pPcl2AACqVzExlkGQNsi4CJgqOHN7YTgDd4LuhgN1BFO3TS0vLAruV1Td6dwWPJA==",
+            "peerDependencies": {
+                "@types/markdown-it": "*",
+                "markdown-it": "*"
+            }
+        },
+        "node_modules/marked": {
+            "version": "4.3.0",
+            "resolved": "https://registry.npmjs.org/marked/-/marked-4.3.0.tgz",
+            "integrity": "sha512-PRsaiG84bK+AMvxziE/lCFss8juXjNaWzVbN5tXAm4XjeaS9NAHhop+PjQxz2A9h8Q4M/xGmzP8vqNwy6JeK0A==",
+            "bin": {
+                "marked": "bin/marked.js"
+            },
+            "engines": {
+                "node": ">= 12"
+            }
+        },
         "node_modules/md5-hex": {
             "version": "3.0.1",
             "resolved": "https://registry.npmjs.org/md5-hex/-/md5-hex-3.0.1.tgz",
@@ -6190,6 +6343,11 @@
                 "node": ">=8"
             }
         },
+        "node_modules/mdurl": {
+            "version": "1.0.1",
+            "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-1.0.1.tgz",
+            "integrity": "sha512-/sKlQJCBYVY9Ers9hqzKou4H6V5UWc/M59TH2dvkt+84itfnq7uFOMLpOiOS4ujvHP4etln18fmIxA5R5fll0g=="
+        },
         "node_modules/media-typer": {
             "version": "0.3.0",
             "resolved": "https://registry.npmjs.org/media-typer/-/media-typer-0.3.0.tgz",
@@ -7333,6 +7491,14 @@
             "resolved": "https://registry.npmjs.org/requires-port/-/requires-port-1.0.0.tgz",
             "integrity": "sha512-KigOCHcocU3XODJxsu8i/j8T9tzT4adHiecwORRQ0ZZFcp7ahwXuRU1m+yuO90C5ZUyGeGfocHDI14M3L3yDAQ=="
         },
+        "node_modules/requizzle": {
+            "version": "0.2.4",
+            "resolved": "https://registry.npmjs.org/requizzle/-/requizzle-0.2.4.tgz",
+            "integrity": "sha512-JRrFk1D4OQ4SqovXOgdav+K8EAhSB/LJZqCz8tbX0KObcdeM15Ss59ozWMBWmmINMagCwmqn4ZNryUGpBsl6Jw==",
+            "dependencies": {
+                "lodash": "^4.17.21"
+            }
+        },
         "node_modules/resolve-alpn": {
             "version": "1.2.1",
             "resolved": "https://registry.npmjs.org/resolve-alpn/-/resolve-alpn-1.2.1.tgz",
@@ -7957,7 +8123,6 @@
             "version": "3.1.1",
             "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz",
             "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==",
-            "dev": true,
             "engines": {
                 "node": ">=8"
             },
@@ -8334,6 +8499,11 @@
                 "is-typedarray": "^1.0.0"
             }
         },
+        "node_modules/uc.micro": {
+            "version": "1.0.6",
+            "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-1.0.6.tgz",
+            "integrity": "sha512-8Y75pvTYkLJW2hWQHXxoqRgV7qb9B+9vFEtidML+7koHUFapnVJAZ6cKs+Qjz5Aw3aZWHMC6u0wJE3At+nSGwA=="
+        },
         "node_modules/ufo": {
             "version": "1.1.2",
             "resolved": "https://registry.npmjs.org/ufo/-/ufo-1.1.2.tgz",
@@ -8352,6 +8522,11 @@
                 "node": ">=0.8.0"
             }
         },
+        "node_modules/underscore": {
+            "version": "1.13.6",
+            "resolved": "https://registry.npmjs.org/underscore/-/underscore-1.13.6.tgz",
+            "integrity": "sha512-+A5Sja4HP1M08MaXya7p5LvjuM7K6q/2EaC0+iovj/wOcMsTzMvDFbasi/oSapiwOlt252IqsKqPjCl7huKS0A=="
+        },
         "node_modules/unique-string": {
             "version": "3.0.0",
             "resolved": "https://registry.npmjs.org/unique-string/-/unique-string-3.0.0.tgz",
@@ -9149,6 +9324,11 @@
                 "node": ">=12"
             }
         },
+        "node_modules/xmlcreate": {
+            "version": "2.0.4",
+            "resolved": "https://registry.npmjs.org/xmlcreate/-/xmlcreate-2.0.4.tgz",
+            "integrity": "sha512-nquOebG4sngPmGPICTS5EnxqhKbCmz5Ox5hsszI2T6U5qdrJizBc+0ilYSEjTSzU0yZcmvppztXe/5Al5fUwdg=="
+        },
         "node_modules/y18n": {
             "version": "5.0.8",
             "resolved": "https://registry.npmjs.org/y18n/-/y18n-5.0.8.tgz",

package.json

@@ -19,6 +19,7 @@
         "@quasar/extras": "^1.16.4",
         "axios": "^1.4.0",
         "chromium": "^3.0.3",
+        "jsdoc": "^4.0.2",
         "pinia": "^2.1.3",
         "quasar": "^2.12.0",
         "validator": "^13.9.0",
@@ -53,4 +54,4 @@
         "vite": "^4.3.5",
         "vitest": "^0.31.1"
     }
-}
+}