update API.md files and fix a type

packages/clients/afm/API.md

@@ -1,6 +1,6 @@
 # POLAR AfM map client
 
-This is a default compilation of POLAR feature packages that can be used for online services. This document and its child documents describe the setup.
+This is a default compilation of POLAR feature packages for online services. This document and its child documents describe the setup.
 
 ## Requirements
 

packages/clients/generic/API.md

@@ -1,3 +1,50 @@
-# POLAR Generic client
+# Generic MapClient API 🗺️ `@polar/client-generic`
 
-TODO
+This client is based on [POLAR](https://github.com/Dataport/polar) and subsequently the [masterportalAPI](https://bitbucket.org/geowerkstatt-hamburg/masterportalapi/src/master/). The following documentation only contains how this specific client can be used, and the minimal information required to get it running.
+
+For all additional details, check the [full documentation](https://dataport.github.io/polar/docs/generic/client-generic.html).
+
+For the development test deployments and example configurations, [see here](https://dataport.github.io/polar#plugin-gallery).
+
+## 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.
+
+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. |
+| 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. |
+
+`createMap` a Promise of a map instance. This returned instance is required to retrieve information from the map.
+
+The package also includes a `style.css` and an `index.html` file. The `style.css`'s relative path must, if it isn't the default value `'./style.css'`, be included in the `mapConfiguration` as follows:
+
+```js
+{
+  // ...
+  stylePath: '../the/relative/path/style.css'
+}
+```
+
+The value to `stylePath` is the same as as a `link` tag would have in its `href`.
+
+### Destroy instance
+
+The `mapInstance` returned by the `createMap` call can be destroyed by calling `mapInstance.$destroy`. This will not remove the rendered HTML, but unlink all internal creations and effects. This should be called before re-navigating, usual lifecycle hooks are `beforeDestroy` or `beforeUnmount`, depending on the framework in use.
+
+After this, `createMap` can be used again when the DOM is restored. That is, the original `div` with its `id` must be recreated, since POLAR changes the DOM in the `div`. Normally, an SPA will take care of this by itself since it will render the outlying component anew.
+
+Should this not be the case in your framework, the following snippet restores the DOM:
+
+```js
+// assuming the render div's id was `"polarstern"`
+const polarstern = document.getElementById('polarstern-wrapper')
+const newStar = document.createElement('div')
+newStar.id = 'polarstern'
+newStar.classList.add('polarstern')
+polarstern?.parentElement?.replaceChild(newStar, polarstern)
+```

packages/clients/generic/src/polar-client.ts

@@ -141,7 +141,7 @@ export default {
     enabledPlugins = [],
   }: {
     containerId: string
-    services: object
+    services: object[]
     mapConfiguration: MapConfig
     enabledPlugins: Array<PluginName>
   }) =>