add ts support for i18n strings

Resolves: #94

Author: warm-coolguy

@types/i18next.d.ts

@@ -0,0 +1,84 @@
+import 'i18next'
+
+// // // core/plugins // // //
+
+import { common as resourcesDeCore } from '../packages/core/src/language/locales/de'
+import { resourcesDe as resourcesDeAddressSearch } from '../packages/plugins/AddressSearch/src/language'
+import { resourcesDe as resourcesDeAttributions } from '../packages/plugins/Attributions/src/language'
+import { resourcesDe as resourcesDeDraw } from '../packages/plugins/Draw/src/language'
+import { resourcesDe as resourcesDeExport } from '../packages/plugins/Export/src/language'
+import { resourcesDe as resourcesDeFilter } from '../packages/plugins/Filter/src/language'
+import { resourcesDe as resourcesDeFullscreen } from '../packages/plugins/Fullscreen/src/language'
+import { resourcesDe as resourcesDeGeoLocation } from '../packages/plugins/GeoLocation/src/language'
+import { resourcesDe as resourcesDeGfi } from '../packages/plugins/Gfi/src/language'
+import { resourcesDe as resourcesDeIconMenu } from '../packages/plugins/IconMenu/src/language'
+import { resourcesDe as resourcesDeLayerChooser } from '../packages/plugins/LayerChooser/src/language'
+import { resourcesDe as resourcesDeLegend } from '../packages/plugins/Legend/src/language'
+import { resourcesDe as resourcesDeLoadingIndicator } from '../packages/plugins/LoadingIndicator/src/language'
+import { resourcesDe as resourcesDePins } from '../packages/plugins/Pins/src/language'
+import { resourcesDe as resourcesDeScale } from '../packages/plugins/Scale/src/language'
+import { resourcesDe as resourcesDeToast } from '../packages/plugins/Toast/src/language'
+import { resourcesDe as resourcesDeZoom } from '../packages/plugins/Zoom/src/language'
+
+// // // clients // // //
+
+import { dishDe } from '../packages/clients/dish/src/language'
+import { dishHeaderDe } from '../packages/clients/dish/src/plugins/Header/language'
+import { dishModalDe } from '../packages/clients/dish/src/plugins/Modal/language'
+import { meldemichelDe } from '../packages/clients/meldemichel/src/language'
+import { meldemichelDe as meldemichelAfmButtonDe } from '../packages/clients/meldemichel/src/plugins/AfmButton/language'
+import { snowboxDe } from '../packages/clients/snowbox/src/language'
+import { textLocatorDe } from '../packages/clients/textLocator/src/language'
+import { textLocatorDe as textLocatorHeaderDe } from '../packages/clients/textLocator/src/plugins/Header/language'
+import { geometrySearchDe } from '../packages/clients/textLocator/src/plugins/GeometrySearch/language'
+
+// // // resources // // //
+
+const resources = {
+  common: {
+    ...resourcesDeCore,
+    dish: dishDe,
+    meldemichel: meldemichelDe,
+    snowbox: snowboxDe,
+    textLocator: textLocatorDe,
+    plugins: {
+      addressSearch: resourcesDeAddressSearch.plugins.addressSearch,
+      attributions: resourcesDeAttributions.plugins.attributions,
+      dish: {
+        ...dishHeaderDe,
+        ...dishModalDe
+      },
+      draw: resourcesDeDraw.plugins.draw,
+      export: resourcesDeExport.plugins.export,
+      filter: resourcesDeFilter.plugins.filter,
+      fullscreen: resourcesDeFullscreen.plugins.fullscreen,
+      geoLocation: resourcesDeGeoLocation.plugins.geoLocation,
+      // geometrySearch is from textLocator
+      geometrySearch: {
+        ...geometrySearchDe
+      },
+      gfi: resourcesDeGfi.plugins.gfi,
+      iconMenu: resourcesDeIconMenu.plugins.iconMenu,
+      layerChooser: resourcesDeLayerChooser.plugins.layerChooser,
+      legend: resourcesDeLegend.plugins.legend,
+      loadingIndicator: resourcesDeLoadingIndicator.plugins.loadingIndicator,
+      meldemichel: {
+        ...meldemichelAfmButtonDe
+      },
+      pins: resourcesDePins.plugins.pins,
+      scale: resourcesDeScale.plugins.scale,
+      textLocator: {
+        ...textLocatorHeaderDe
+      },
+      toast: resourcesDeToast.plugins.toast,
+      zoom: resourcesDeZoom.plugins.zoom,
+    }
+  }
+} as const
+
+declare module 'i18next' {
+  interface CustomTypeOptions {
+    defaultNS: "common"
+    resources: typeof resources
+  }
+}

packages/clients/afm/tsconfig.json

@@ -6,6 +6,7 @@
 - Fix: Extend typing for search result function according to type package update.
 - Fix: Import types `AddressSearchState` and `AddressSearchGetters` from correct position.
 - Fix: Import enum `SearchResultSymbols` from correct position.
+- Fix: The alt text to the "Landesdachmarke" for screen readers was missing.
 - Chore: Change value of `pins.movable` configuration to `'drag'` as using a boolean has been deprecated in a future release.
 - Chore: Upgrade `@masterportal/masterportalapi` from `2.8.0` to `2.40.0` and subsequently `ol` from `^7.1.0` to `^9.2.4`.
 - Chore: Update `@polar`-dependencies to the latest versions.

packages/clients/dish/CHANGELOG.md

@@ -0,0 +1,52 @@
+export const dishDe = {
+  backendSizeError:
+    'Die Suche ist zu allgemein. Bitte wählen Sie weitere Suchbegriffe oder schränken Sie die Suche über einen Filter ein.',
+  unknownError: 'Ein unbekannter Fehler ist aufgetreten.',
+  idNotFound:
+    'Die verlinkte ID konnte leider nicht aufgelöst werden. Bitte verwenden Sie Suche und Karte, um zum Denkmal zu navigieren.',
+  addressSearchHint: 'Eingabe von z.B. Bezeichnung, Lage, Adresse, ...',
+} as const
+
+export const resourcesDe = {
+  dish: dishDe,
+  plugins: {
+    gfi: {
+      property: {
+        export: 'Export Detailinformationen',
+      },
+      toggle: 'Informationen zu Sachgesamtheit öffnen/schließen',
+    },
+  },
+} as const
+
+export const resourcesEn = {
+  dish: {
+    backendSizeError:
+      'Too broad search. Please choose additional search terms or use a filter.',
+    unknownError: 'An unknown error occurred.',
+    idNotFound:
+      'The linked ID could not be found. Please use the search function or map to navigate to your point of interest.',
+    addressSearchHint: 'Entry of e.g. monument names, location, address, ...',
+  },
+  plugins: {
+    gfi: {
+      property: {
+        export: 'Detail information export',
+      },
+      toggle: 'Open/close additional information',
+    },
+  },
+} as const
+
+const locales = [
+  {
+    type: 'de',
+    resources: resourcesDe,
+  },
+  {
+    type: 'en',
+    resources: resourcesEn,
+  },
+]
+
+export default locales

packages/clients/dish/src/language.ts

@@ -7,7 +7,7 @@ import {
   dishBaseUrl,
   // servicePrefix, s.u.
 } from './services'
-import locales from './locales'
+import locales from './language'
 
 const shBlue = '#003064'
 const shWhite = '#FFFFFF'
@@ -171,7 +171,7 @@ export const mapConfiguration = {
     groupProperties: {
       groupDenkmalsuche: {
         label: 'Denkmalsuche',
-        hint: 'common:dish.addressSearchHint',
+        hint: 'dish.addressSearchHint',
         resultDisplayMode: 'categorized',
         limitResults: 3,
       },

packages/clients/dish/src/locales.ts

@@ -5,13 +5,13 @@
     text
     :href="exportProperty"
     target="_blank"
-    :alt="$t('common:plugins.gfi.property.imageAlt')"
-    :title="$t('common:plugins.gfi.property.linkTitle')"
-    :aria-label="$t('common:plugins.gfi.property.export')"
+    :alt="$t('plugins.gfi.property.imageAlt')"
+    :title="$t('plugins.gfi.property.linkTitle')"
+    :aria-label="$t('plugins.gfi.property.export')"
     onmousedown="return false"
   >
     <v-icon small>fa-download</v-icon>
-    {{ $t('common:plugins.gfi.property.export') }}
+    {{ $t('plugins.gfi.property.export') }}
   </v-btn>
 </template>
 

packages/clients/dish/src/mapConfig.ts

@@ -6,7 +6,7 @@
       <v-btn
         icon
         small
-        :aria-label="$t('common:plugins.gfi.header.close')"
+        :aria-label="$t('plugins.gfi.header.close')"
         @click="close(true)"
       >
         <v-icon small>fa-xmark</v-icon>
@@ -49,7 +49,7 @@
               <v-btn
                 icon
                 x-small
-                :aria-label="$t('common:plugins.gfi.toggle')"
+                :aria-label="$t('plugins.gfi.toggle')"
                 @click="toggleSachgesamtheit"
               >
                 <v-icon small>

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

@@ -1,6 +1,6 @@
 <template>
   <h1 class="polar-plugin-header">
-    {{ $t('common:plugins.dish.header.text') }}
+    {{ $t('plugins.dish.header.text') }}
   </h1>
 </template>
 

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

@@ -1,14 +1,18 @@
 import { LanguageOption } from '@polar/lib-custom-types'
 
+export const dishHeaderDe = {
+  header: {
+    text: 'Denkmalkarte Schleswig-Holstein',
+  },
+} as const
+
 const lang: LanguageOption[] = [
   {
     type: 'de',
     resources: {
       plugins: {
         dish: {
-          header: {
-            text: 'Denkmalkarte Schleswig-Holstein',
-          },
+          ...dishHeaderDe,
         },
       },
     },