Merge branch main into feature/packaging

jest.config.ts

@@ -15,7 +15,7 @@ const config: Config.InitialOptions = {
   },
   testEnvironment: 'jsdom',
   transform: {
-    '^[^.]+.vue$': 'vue-jest',
+    '^[^.]+.vue$': '@vue/vue2-jest',
     '^.+\\.tsx?$': 'ts-jest',
     '^.*\\.js$': 'babel-jest',
   },

package.json

@@ -29,6 +29,9 @@
     "snowbox": "concurrently \"nx dev @polar/client-snowbox\" \"npm:nx:watch\"",
     "snowbox:build": "nx build @polar/client-snowbox",
     "snowbox:build:serve": "http-server packages/clients/snowbox -o /dist/index.html",
+    "textLocator:build": "lerna run build --scope @polar/client-text-locator --stream",
+    "textLocator:build:serve": "http-server ./packages/clients/textLocator -o /dist/index.html",
+    "textLocator:dev": "cd packages/clients/textLocator/ && vite --host",
     "pages:build": "rimraf ./pages/docs && npm run generic:build && bash ./scripts/buildPages.sh",
     "pages:build:serve": "http-server pages -o index.html",
     "clean": "nx reset && rimraf --glob packages/**/{.cache,dist,docs} && rimraf --glob {.cache,dist} && node ./scripts/clean",
@@ -37,6 +40,7 @@
     "docs:meldemichel": "node ./scripts/makeDocs ./packages/clients/meldemichel && npm run meldemichel:build && cp -r ./packages/clients/meldemichel/dist ./packages/clients/meldemichel/example ./packages/clients/meldemichel/docs",
     "docs:sbom": "npx @cyclonedx/cyclonedx-npm --output-file sbom.json",
     "docs:snowbox": "node ./scripts/makeDocs ./packages/clients/snowbox",
+    "docs:textLocator": "node ./scripts/makeDocs ./packages/clients/textLocator && npm run textLocator:build && cp -r ./packages/clients/textLocator/dist ./packages/clients/textLocator/docs",
     "nx:watch": "nx watch --all -- nx bundle %NX_PROJECT_NAME%",
     "lint": "npx eslint . --cache --ext .js,.ts,.vue",
     "lint:ci": "npx eslint . --ext .js,.ts,.vue",
@@ -66,6 +70,7 @@
     "@typescript-eslint/eslint-plugin": "^5.9.0",
     "@typescript-eslint/parser": "^5.9.0",
     "@vitejs/plugin-vue2": "^2.2.0",
+    "@vue/vue2-jest": "^28.1.0",
     "@vue/test-utils": "^1.2.2",
     "babel-core": "^7.0.0-bridge.0",
     "cesium": "^1.62.0",
@@ -106,7 +111,6 @@
     "typescript": "^5.3.3",
     "vite": "^5.1.3",
     "vite-plugin-commonjs": "^0.6.2",
-    "vue-jest": "^3.0.7",
     "vue-template-compiler": "^2.7.16"
   }
 }

packages/clients/afm/API.md

@@ -2,6 +2,8 @@
 
 This is a default compilation of POLAR feature packages for online services. This document and its child documents describe the setup.
 
+For all additional details, check the [full documentation](https://dataport.github.io/polar/docs/afm/client-afm.html).
+
 ## Requirements
 
 To understand this document, programming knowledge (preferably in JavaScript) are required. This is a technical document describing how to integrate the map client with its programmatic API.

packages/clients/dish/src/plugins/Gfi/ActionButton.vue

@@ -17,14 +17,12 @@
 
 <script lang="ts">
 import Vue from 'vue'
+import { mapGetters } from 'vuex'
 
 export default Vue.extend({
   name: 'DishActionButton',
-  props: {
-    exportProperty: {
-      type: String,
-      default: '',
-    },
+  computed: {
+    ...mapGetters('plugin/gfi', ['exportProperty']),
   },
 })
 </script>

packages/clients/dish/src/plugins/Gfi/Content.vue

@@ -1,7 +1,7 @@
 <template>
   <v-card class="dish-gfi-content">
     <v-card-actions v-if="!hasWindowSize || !hasSmallWidth">
-      <ActionButton :export-property="exportProperty"></ActionButton>
+      <ActionButton></ActionButton>
       <v-spacer></v-spacer>
       <v-btn
         icon
@@ -91,8 +91,7 @@
 </template>
 
 <script lang="ts">
-import Vue, { PropType } from 'vue'
-import { GeoJsonProperties } from 'geojson'
+import Vue from 'vue'
 import { mapActions, mapMutations, mapGetters } from 'vuex'
 import ActionButton from './ActionButton.vue'
 
@@ -101,20 +100,6 @@ type GfiIndexStep = -1 | 1
 export default Vue.extend({
   name: 'DishGfiContent',
   components: { ActionButton },
-  props: {
-    currentProperties: {
-      type: Object as PropType<GeoJsonProperties>,
-      required: true,
-    },
-    clientWidth: {
-      type: Number,
-      required: true,
-    },
-    exportProperty: {
-      type: String,
-      default: '',
-    },
-  },
   data: () => ({
     infoFields: [
       'Kreis',
@@ -127,8 +112,9 @@ export default Vue.extend({
     sachgesamtheitOpen: false,
   }),
   computed: {
-    ...mapGetters(['hasSmallWidth', 'hasWindowSize']),
+    ...mapGetters(['clientWidth', 'hasSmallWidth', 'hasWindowSize']),
     ...mapGetters('plugin/gfi', [
+      'currentProperties',
       'imageLoaded',
       'visibleWindowFeatureIndex',
       'windowFeatures',
@@ -173,7 +159,6 @@ export default Vue.extend({
     if (this.hasWindowSize && this.hasSmallWidth) {
       this.setMoveHandleActionButton({
         component: ActionButton,
-        props: { exportProperty: this.exportProperty },
       })
     }
   },

packages/clients/generic/API.md

@@ -6,6 +6,8 @@ For all additional details, check the [full documentation](https://dataport.gith
 
 For the development test deployments and example configurations, [see here](https://dataport.github.io/polar#plugin-gallery).
 
+For a minimum working example, [see here](https://github.com/dopenguin/polar-fossgis-2024).
+
 ## Basic usage
 
 The NPM package `@polar/client-generic` can be installed via NPM or downloaded from the [release page](https://github.com/Dataport/polar/releases). When using `import mapClient from '@polar/client-generic'`, the object `mapClient` contains a method `createMap`. This is the main method required to get the client up and running. Should you use another import method, check the package's `dist` folder for available files.
@@ -15,8 +17,8 @@ The method expects a single object with the following parameters.
 | fieldName | type | description |
 | - | - | - |
 | containerId | string | ID of the container the map is supposed to render itself to. |
-| services | object[] \| string | Either a link to a service registry or an array containing service description objects. For more details, see the startup section on [POLAR documentation](https://dataport.github.io/polar/documentation.html#configuration). |
-| mapConfiguration | object | See full documentation for all possible configuration options. |
+| services | object[] \| string | Either a link to a service registry or an array containing service description objects. For more details, see the startup section on [POLAR documentation](https://dataport.github.io/polar/documentation.html#configuration). This parameter can be seen as an accessible version of `mapConfiguration.layerConf`. |
+| mapConfiguration | object | See [documentation of `@polar/core`](https://dataport.github.io/polar/docs/generic/core.html) for all possible configuration options. |
 | enabledPlugins  | string[]? | This is a client-specific field. Since the `@polar/client-generic` client contains all existing plugins, they are activated by strings. The strings match their package names: `'address-search' \| 'attributions' \| 'draw'* \| 'export' \| 'filter'* \| 'fullscreen'* \| 'geo-location'* \| 'gfi'* \| 'icon-menu' \| 'layer-chooser'* \| 'legend' \| 'loading-indicator' \| 'pins' \| 'reverse-geocoder' \| 'scale' \| 'toast' \| 'zoom'*`. The plugins marked with * are nested in the `'icon-menu'` in this pre-layouting, hence they depend upon it being active, too. |
 | modifyLayerConfiguration | ((layerConf: object[]) => object[])? | Defaults to identity function. This function is applied to the loaded layer configuration before usage. That is, the `services` can be modified by this to e.g. set parameters not supported by the service register, add additional layers, and so on. |
 

packages/clients/meldemichel/CHANGELOG.md

@@ -4,6 +4,17 @@
 
 - Chore: Import newly exposed style paths of `@polar/core` as well as all plugin packages.
 
+## 1.1.2
+
+- Chore: Fix bugs via dependency updates.
+  - resolve filter bugs for features of unknown filter categories; they were sometimes visible
+
+## 1.1.1
+
+- Chore: Fix bugs via dependency updates.
+  - restore Safari 15 compatibility
+  - resolve time filter bugs where selected time frame was applied incorrectly
+
 ## 1.1.0
 
 - Change: The search now no longer focuses on the first result after a successful search.

packages/clients/meldemichel/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@polar/client-meldemichel",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "description": "Client Meldemichel",
   "license": "EUPL-1.2",
   "type": "module",
@@ -29,9 +29,9 @@
     "@polar/lib-invisible-style": "1.1.0-alpha.1",
     "@polar/plugin-address-search": "^1.2.1",
     "@polar/plugin-attributions": "^1.1.0",
-    "@polar/plugin-filter": "^1.0.0",
+    "@polar/plugin-filter": "^1.1.2",
     "@polar/plugin-fullscreen": "^1.1.0",
-    "@polar/plugin-geo-location": "^1.2.0",
+    "@polar/plugin-geo-location": "^1.3.1",
     "@polar/plugin-gfi": "^1.1.0",
     "@polar/plugin-icon-menu": "^1.1.0",
     "@polar/plugin-layer-chooser": "^1.1.0",

packages/clients/meldemichel/src/mapConfigurations.ts

@@ -9,6 +9,7 @@ import {
   PinsConfiguration,
   ReverseGeocoderConfiguration,
 } from '@polar/lib-custom-types'
+import { MpApiParameters } from '@polar/plugin-address-search/src/types'
 import { MODE, SKAT, REPORT_STATUS } from './enums'
 import language from './language'
 import { MeldemichelCreateMapParams } from './types'
@@ -88,12 +89,11 @@ const commonAttributions: Partial<AttributionsConfiguration> = {
 const addressSearch: AddressSearchConfiguration = {
   searchMethods: [
     {
-      // @ts-expect-error | missing field "epsg" filled later in process
       queryParameters: {
         searchAddress: true,
         searchStreets: true,
         searchHouseNumbers: true,
-      },
+      } as MpApiParameters,
       type: 'mpapi',
       url: 'https://geodienste.hamburg.de/HH_WFS_GAGES?service=WFS&request=GetFeature&version=2.0.0',
     },

packages/clients/meldemichel/src/plugins/Gfi/ActionButtons.vue

@@ -29,14 +29,11 @@ export default Vue.extend({
   name: 'MeldemichelGfiFeatureActionButtons',
   computed: {
     ...mapGetters('plugin/gfi', [
+      'showSwitchButtons',
       'visibleWindowFeatureIndex',
       'windowFeatures',
     ]),
     ...mapGetters(['hasSmallWidth', 'hasWindowSize']),
-    /** only show switch buttons if multiple property sets are available */
-    showSwitchButtons(): boolean {
-      return this.windowFeatures.length > 1
-    },
     showSmall(): boolean {
       return !this.hasWindowSize || !this.hasSmallWidth
     },

packages/clients/meldemichel/src/plugins/Gfi/Feature.vue

@@ -49,30 +49,20 @@
 <script lang="ts">
 import Vue from 'vue'
 import { mapActions, mapGetters, mapMutations } from 'vuex'
-import { GeoJsonProperties } from 'geojson'
 import ActionButtons from './ActionButtons.vue'
 
 export default Vue.extend({
   name: 'MeldemichelGfiFeature',
   components: {
     ActionButtons,
   },
-  props: {
-    clientWidth: {
-      type: Number,
-      required: true,
-    },
-    exportProperty: {
-      type: String,
-      default: '',
-    },
-  },
   data: () => ({
     infoFields: ['skat', 'start', 'statu'],
   }),
   computed: {
     ...mapGetters(['hasSmallWidth', 'hasWindowSize']),
     ...mapGetters('plugin/gfi', [
+      'currentProperties',
       'imageLoaded',
       'visibleWindowFeatureIndex',
       'windowFeatures',
@@ -81,9 +71,6 @@ export default Vue.extend({
     displayImage(): boolean {
       return this.currentProperties.pic
     },
-    currentProperties(): GeoJsonProperties {
-      return { ...this.windowFeatures[this.visibleWindowFeatureIndex] }
-    },
   },
   watch: {
     currentProperties(newProps: object) {

packages/clients/snowbox/API.md

@@ -3,3 +3,5 @@
 This is an API file that is used as part of the generated documentation. It will appear as main document in the snowbox's documentation.
 
 If the snowbox implemented any own features that are not derived from either core of plugins, this would be the place to document them. However, since that's not the case, it only features this introduction text and the link list below.
+
+For all additional details, check the [full documentation](https://dataport.github.io/polar/docs/snowbox/client-snowbox.html).

packages/clients/snowbox/src/addPlugins.ts

@@ -105,7 +105,6 @@ export const addPlugins = (core) => {
     ),
     Legend({
       displayComponent: true,
-      maxWidth: 500,
       layoutTag: NineLayoutTag.BOTTOM_RIGHT,
     }),
     Scale(

packages/clients/textLocator/API.md

@@ -0,0 +1,7 @@
+# TextLocator MapClient API 🗺️ `@polar/client-text-locator`
+
+There is no API to this package; it is not configurable, but delivers a hostable website containing the client in question. All reconfiguration must be done in the source code and requires a new build.
+
+When configuring before building, please mind that the `index.html` in the source folder contains configuration parameters that are later bundled.
+
+For all additional details, check the [full documentation](https://dataport.github.io/polar/docs/textLocator/client-textLocator.html).

packages/clients/textLocator/CHANGELOG.md

@@ -0,0 +1,5 @@
+# CHANGELOG
+
+## unpublished
+
+Initial release.