@vcmap/viewshed 3.0.5 → 4.1.0

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@vcmap/viewshed",
-  "version": "3.0.5",
-  "description": "Tool to simulate a \"viewer\" and their field of vision from a certain standpoint in the map. It allows the user to see which areas and buildings can or can't be seen from a specific standpoint, regarding different viewing distances, viewers' sizes and orientations.Th",
+  "version": "4.1.0",
+  "description": "Tool to simulate a \"viewer\" and their field of vision from a certain standpoint in the map. It allows the user to see which areas and buildings can or can't be seen from a specific standpoint, regarding different viewing distances, viewers' sizes and orientations.",
   "type": "module",
   "main": "src/index.js",
   "scripts": {
     "prepublishOnly": "vcmplugin build",
     "build": "vcmplugin build",
     "bundle": "vcmplugin bundle",
+    "audit": "npm audit --omit=peer --omit=dev --omit=optional",
     "start": "vcmplugin serve",
     "preview": "vcmplugin preview",
     "buildStagingApp": "vcmplugin buildStagingApp",
@@ -16,7 +17,9 @@
     "lint": "npm run lint:js && npm run lint:prettier",
     "format": "prettier --write --list-different . && npm run lint:js -- --fix",
     "test": "vitest",
-    "coverage": "vitest run --coverage"
+    "coverage": "vitest run --coverage",
+    "type-check": "vue-tsc --noEmit",
+    "ensure-types": "vcmplugin ensure-types"
   },
   "author": "Tobias Krauth <tkrauth@vc.systems>",
   "license": "MIT",
@@ -36,36 +39,33 @@
     ".": "./src/index.js",
     "./dist": "./dist/index.js"
   },
-  "eslintIgnore": [
-    "node_modules",
-    "dist",
-    "plugin-assets"
-  ],
-  "eslintConfig": {
-    "root": true,
-    "extends": "@vcsuite/eslint-config/vue"
-  },
   "prettier": "@vcsuite/eslint-config/prettier.js",
   "peerDependencies": {
-    "@vcmap-cesium/engine": "^11.0.2",
-    "@vcmap/core": "^6.0.4",
-    "@vcmap/ui": "^6.0.6",
-    "ol": "^10.2.1",
+    "@vcmap-cesium/engine": "^11.0.5",
+    "@vcmap/core": "^6.3.5",
+    "@vcmap/ui": "^6.3.6",
+    "ol": "^10.4.0",
     "vue": "~3.4.38",
-    "vuetify": "^3.7.3"
+    "vuetify": "~3.7.14"
+  },
+  "overrides": {
+    "esbuild": "^0.25.0"
   },
   "devDependencies": {
-    "@vcmap/plugin-cli": "^4.0.1",
-    "@vcsuite/eslint-config": "^3.0.8",
-    "@vitest/coverage-v8": "^2.1.4",
+    "@vcmap/plugin-cli": "^4.2.0",
+    "@vcsuite/eslint-config": "^4.1.0",
+    "@vitest/coverage-v8": "^2.1.9",
     "jest-canvas-mock": "^2.5.2",
     "jsdom": "^22.1.0",
     "resize-observer-polyfill": "^1.5.1",
-    "vitest": "^2.1.4"
+    "typescript": "^5.9.2",
+    "vitest": "^2.1.9",
+    "vue-tsc": "^2.2.12"
   },
   "dependencies": {
-    "@vcsuite/check": "^2.1.0",
-    "@vcsuite/parsers": "^1.0.3"
+    "@vcsuite/check": "^3.2.2",
+    "@vcsuite/logger": "^1.0.1",
+    "@vcsuite/parsers": "^2.0.1"
   },
-  "mapVersion": "^6.0"
+  "mapVersion": "^6.3"
 }

package/src/ViewshedConfigEditor.vue

@@ -1,6 +1,6 @@
 <template>
-  <AbstractConfigEditor @submit="apply" v-bind="{ ...$attrs, ...$props }">
-    <VcsFormSection heading="viewshed.editor.general" v-if="localConfig">
+  <AbstractConfigEditor v-bind="{ ...$attrs, ...$props }" @submit="apply">
+    <VcsFormSection v-if="localConfig" heading="viewshed.editor.general">
       <v-container class="px-1 py-0">
         <v-row no-gutters>
           <v-col>
@@ -11,8 +11,8 @@
           <v-col>
             <VcsSelect
               id="viewshed-tools"
-              :items="toolItems"
               v-model="localConfig.tools"
+              :items="toolItems"
               :multiple="true"
             />
           </v-col>
@@ -42,37 +42,31 @@
   </AbstractConfigEditor>
 </template>
 
-<script>
-  import { ref } from 'vue';
+<script lang="ts">
+  import type { PropType } from 'vue';
+  import { defineComponent, inject, ref, toRaw } from 'vue';
   import { VCol, VColorPicker, VContainer, VRow } from 'vuetify/components';
+  import type { VcsUiApp } from '@vcmap/ui';
   import {
     AbstractConfigEditor,
     VcsFormSection,
     VcsLabel,
     VcsSelect,
   } from '@vcmap/ui';
-  import Viewshed, { ViewshedTypes } from './viewshed.js';
-
-  /**
-   * @typedef {Object} ViewshedConfig
-   * @property {string} visibleColor The color of the viewsheds visible parts.
-   * @property {string} shadowColor The color of the viewsheds hidden parts.
-   * @property {Array<ViewshedTypes>} tools The tools that are available in the toolbox.
-   */
+  import { name } from '../package.json';
+  import { ViewshedTypes } from './viewshed.js';
+  import type { ViewshedPlugin } from './index.js';
 
-  /**
-   * Returns the default viewshed options.
-   * @returns {ViewshedConfig}
-   */
-  export function getDefaultOptions() {
-    return {
-      visibleColor: Viewshed.getDefaultOptions().visibleColor,
-      shadowColor: Viewshed.getDefaultOptions().shadowColor,
-      tools: [...Object.values(ViewshedTypes)],
-    };
-  }
+  export type ViewshedConfig = {
+    /** The color of the viewsheds visible parts. */
+    visibleColor: string;
+    /** The color of the viewsheds hidden parts. */
+    shadowColor: string;
+    /** The tools that are available in the toolbox. */
+    tools: ViewshedTypes[];
+  };
 
-  export default {
+  export default defineComponent({
     name: 'ViewshedConfigEditor',
     components: {
       AbstractConfigEditor,
@@ -86,22 +80,26 @@
     },
     props: {
       getConfig: {
-        type: Function,
+        type: Function as PropType<() => ViewshedConfig>,
         required: true,
       },
       setConfig: {
-        type: Function,
+        type: Function as PropType<(config: ViewshedConfig) => void>,
         required: true,
       },
     },
     setup(props) {
-      /** @type {import("vue").Ref<import("./index.js").ViewshedPluginOptions>} */
-      const config = props.getConfig();
-      /** @type {import("vue").Ref<import("./index.js").ViewshedPluginOptions>} */
-      const localConfig = ref({ ...getDefaultOptions(), ...config });
+      const app = inject<VcsUiApp>('vcsUiApp')!;
+      const { getDefaultOptions } = app.plugins.getByKey(
+        name,
+      ) as ViewshedPlugin;
+      const localConfig = ref<ViewshedConfig>({
+        ...getDefaultOptions?.(),
+        ...props.getConfig(),
+      });
 
-      function apply() {
-        props.setConfig(localConfig.value);
+      function apply(): void {
+        props.setConfig(structuredClone(toRaw(localConfig.value)));
       }
 
       return {
@@ -114,5 +112,5 @@
         })),
       };
     },
-  };
+  });
 </script>