ol-wfst 3.0.1 → 3.0.2

package/README.md

@@ -1,478 +1,478 @@
-# OpenLayers WFST
-
-Tiny WFST-T client to insert (drawing/uploading), modify and delete features on GeoServers using OpenLayers. Layers with these types of geometries are supported: _GeometryCollection_ (in this case, you can choose the geometry type of each element to draw), _Point_, _MultiPoint_, _LineString_, _MultiLineString_, _Polygon_ and _MultiPolygon_.
-
-Tested with OpenLayers version 5 and 6.
-
-<img src="screenshots/example-1.jpg" alt="Drawing" style="width:50%; float:left;">
-<img src="screenshots/example-2.jpg" alt="Editing fields" style="width:50%; float:left;">
-
-## Usage
-
-See [Wfst Options](#options) for more details.
-
-```javascript
-import 'Wfst' from 'ol-wfst';
-import { Fill, Stroke, Circle, Style } from 'ol/style';
-
-// Style
-import 'ol-wfst/lib/scss/ol-wfst.css';
-import 'ol-wfst/lib/scss/ol-wfst.bootstrap5.css'; // Do not import if you already have boostrap css
-
-// Optional credentials
-const password = 123456;
-const username = 'username';
-
-const wfst = new Wfst({
-    geoServerUrl: 'https://mysite.com/geoserver/myworkspace/ows',
-    geoServerAdvanced: {
-        getCapabilitiesVersion: '1.3.0',
-        getFeatureVersion: '1.0.0',
-        describeFeatureTypeVersion: '1.1.0',
-        lockFeatureVersion: '1.1.0',
-        projection: 'EPSG:3857'
-    },
-    // Maybe you wanna add this on a proxy, at the backend
-    headers: { Authorization: 'Basic ' + btoa(username + ':' + password) },
-    layers: [
-        {
-            name: 'myPointsLayer', // Name of the layer on the GeoServer
-            label: 'Photos', // Optional Label to be displayed in the controller
-            mode: 'wfs',
-            zIndex: 99,
-            style: new Style({
-                image: new Circle({
-                    radius: 7,
-                    fill: new Fill({
-                        color: '#000000'
-                    }),
-                    stroke: new Stroke({
-                        color: [255, 0, 0],
-                        width: 2
-                    })
-                })
-            })
-        },
-        {
-            name: 'myMultiGeometryLayer',
-            label: 'Other elements'
-        },
-        {
-            name: 'myLineStringLayer',
-            label: 'Routes',
-            visible: false
-        }
-    ],
-    language: 'en',
-    minZoom: 12,
-    showUpload: true,
-    beforeInsertFeature: function (feature) {
-        // Add a custom value o perform an action before insert features
-        feature.set('customProperty', 'customValue', true);
-        return feature;
-    }
-});
-
-// Events
-wfst.on(['getCapabilities', 'getFeaturesLoaded'], function (evt) {
-    console.log(evt.type, evt.data);
-});
-
-wfst.on(['describeFeatureType', 'getFeature'], function (evt) {
-    console.log(evt.type, evt.layer, evt.data);
-});
-
-wfst.on(['modifystart', 'modifyend', 'drawstart', 'drawend'], function (evt) {
-    console.log(evt.type, evt);
-});
-
-map.addControl(wfst);
-
-```
-
-### Some considerations
-
--   If the features/vertex appear to be slightly offset after adding them, check the _Number of Decimals_ in your Workplace, you may have to increment that to have a more accurete preview.
--   You can configure a _Basic Authentication_ or an _HTTP Header Proxy Authentication_ with this client, but in some cases is recommended setting that on an reverse proxy on the backend.
--   If you don't use a reverse proxy, remeber configure [cors](https://docs.geoserver.org/latest/en/user/production/container.html#enable-cors)
-
-## Changelog
-
-See [CHANGELOG](./CHANGELOG.md) for details of changes in each release.
-
-## Install
-
-### Browser
-
-#### JS
-
-Load `ol-wfst.js` after OpenLayers. Wfst is available as `Wfst`.
-
-```HTML
-<script src="https://unpkg.com/ol-wfst@3.0.0"></script>
-```
-
-#### CSS
-
-```HTML
-<link rel="stylesheet" href="https://unpkg.com/ol-wfst@3.0.0/dist/css/ol-wfst.min.css" />
-<link rel="stylesheet" href="https://unpkg.com/ol-wfst@3.0.0/dist/css/ol-wfst.bootstrap5.min.css" />
-```
-
-### Parcel, Webpack, etc.
-
-NPM package: [ol-wfst](https://www.npmjs.com/package/ol-wfst).
-
-Install the package via `npm`
-
-    npm install ol-wfst
-
-#### JS
-
-```js
-import Wfst from 'ol-wfst';
-```
-
-#### CSS
-
-```js
-// scss
-import 'ol-wfst/dist/scss/ol-wfst.scss';
-import 'ol-wfst/dist/scss/-ol-wfst.bootstrap5.scss';
-
-// or css
-import 'ol-wfst/dist/css/ol-wfst.css';
-import 'ol-wfst/dist/css/ol-wfst.bootstrap5.css';
-```
-
-##### TypeScript type definition
-
-TypeScript types are shipped with the project in the dist directory and should be automatically used in a TypeScript project. Interfaces are provided for Wfst Options.
-
-## API
-
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
-
-#### Table of Contents
-
--   [Wfst](#wfst)
-    -   [Parameters](#parameters)
-    -   [activateDrawMode](#activatedrawmode)
-        -   [Parameters](#parameters-1)
-    -   [activateEditMode](#activateeditmode)
-        -   [Parameters](#parameters-2)
-    -   [insertFeaturesTo](#insertfeaturesto)
-        -   [Parameters](#parameters-3)
--   [Options](#options)
-    -   [geoServerUrl](#geoserverurl)
-    -   [geoServerAdvanced](#geoserveradvanced)
-    -   [headers](#headers)
-    -   [layers](#layers)
-    -   [active](#active)
-    -   [evtType](#evttype)
-    -   [useLockFeature](#uselockfeature)
-    -   [showControl](#showcontrol)
-    -   [minZoom](#minzoom)
-    -   [modal](#modal)
-    -   [language](#language)
-    -   [i18n](#i18n)
-    -   [showUpload](#showupload)
-    -   [uploadFormats](#uploadformats)
-    -   [processUpload](#processupload)
-        -   [Parameters](#parameters-4)
-    -   [beforeInsertFeature](#beforeinsertfeature)
-        -   [Parameters](#parameters-5)
--   [LayerParams](#layerparams)
-    -   [name](#name)
-    -   [label](#label)
-    -   [mode](#mode)
-    -   [wfsStrategy](#wfsstrategy)
-    -   [cqlFilter](#cqlfilter)
-    -   [tilesBuffer](#tilesbuffer)
--   [I18n](#i18n-1)
-    -   [labels](#labels)
-    -   [errors](#errors)
-
-### Wfst
-
-**Extends ol/control/Control~Control**
-
-Tiny WFST-T client to insert (drawing/uploading), modify and delete
-features on GeoServers using OpenLayers. Layers with these types
-of geometries are supported: "GeometryCollection" (in this case, you can
-choose the geometry type of each element to draw), "Point", "MultiPoint",
-"LineString", "MultiLineString", "Polygon" and "MultiPolygon".
-
-#### Parameters
-
--   `opt_options` **[Options](#options)?** Wfst options, see [Wfst Options](#options) for more details.
-
-#### activateDrawMode
-
-Activate/deactivate the draw mode
-
-##### Parameters
-
--   `layerName` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean))**
-
-Returns **void**
-
-#### activateEditMode
-
-Activate/desactivate the edit mode
-
-##### Parameters
-
--   `bool` (optional, default `true`)
-
-Returns **void**
-
-#### insertFeaturesTo
-
-Add features directly to the geoserver, in a custom layer
-without checking geometry or showing modal to confirm.
-
-##### Parameters
-
--   `layerName` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
--   `features` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<Feature\<Geometry>>**
-
-Returns **void**
-
-### Options
-
-**_\[interface]_** - Wfst Options specified when creating a Wfst instance
-
-Default values:
-
-```javascript
-{
- geoServerUrl: null,
- geoServerAdvanced: {
-     getCapabilitiesVersion: '1.3.0',
-     getFeatureVersion: '1.0.0',
-     describeFeatureTypeVersion: '1.1.0',
-     lockFeatureVersion: '1.1.0',
-     wfsTransactionVersion: '1.1.0',
-     projection: 'EPSG:3857'
- },
- headers: {},
- layers: null,
- evtType: 'singleclick',
- active: true,
- showControl: true,
- useLockFeature: true,
- minZoom: 9,
- language: 'en',
- i18n: {...}, // according to language selection
- uploadFormats: '.geojson,.json,.kml',
- processUpload: null,
- beforeInsertFeature: null,
-}
-```
-
-#### geoServerUrl
-
-Url for OWS services. This endpoint will recive the WFS, WFST and WMS requests
-
-Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
-
-#### geoServerAdvanced
-
-Advanced options for geoserver requests
-
-Type: {getCapabilitiesVersion: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, getFeatureVersion: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, lockFeatureVersion: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, describeFeatureTypeVersion: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, wfsTransactionVersion: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, projection: ProjectionLike?}
-
-#### headers
-
-Url headers for GeoServer requests. You can use it to add Authorization credentials
-
-Type: HeadersInit
-
-#### layers
-
-Layers to be loaded from the geoserver
-
-Type: [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[LayerParams](#layerparams)>
-
-#### active
-
-Init active
-
-Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
-
-#### evtType
-
-The click event to allow selection of Features to be edited
-
-Type: (`"singleclick"` | `"dblclick"`)
-
-#### useLockFeature
-
-Use LockFeatue request on GeoServer when selecting features.
-This is not always supportedd by the GeoServer.
-See <https://docs.geoserver.org/stable/en/user/services/wfs/reference.html>
-
-Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
-
-#### showControl
-
-Show/hide the control map
-
-Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
-
-#### minZoom
-
-Zoom level to hide features to prevent too much features being loaded
-
-Type: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)
-
-#### modal
-
-Modal configuration
-
-Type: {animateClass: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, animateInClass: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, transition: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)?, backdropTransition: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)?, templates: {dialog: ([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [HTMLElement](https://developer.mozilla.org/docs/Web/HTML/Element))?, headerClose: ([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [HTMLElement](https://developer.mozilla.org/docs/Web/HTML/Element))?}?}
-
-#### language
-
-Language to be used
-
-Type: (`"es"` | `"en"`)
-
-#### i18n
-
-Custom translations
-
-Type: [I18n](#i18n)
-
-#### showUpload
-
-Show/hide the upload button
-
-Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
-
-#### uploadFormats
-
-Accepted extension formats on upload
-Example: ".json,.geojson"
-
-Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
-
-#### processUpload
-
-Triggered to allow implement custom functions or to parse other formats than default
-by filtering the extension. If this doesn't return features, the default function
-will be used to extract them.
-
-##### Parameters
-
--   `file` **File**
-
-Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<Feature\<Geometry>>**
-
-#### beforeInsertFeature
-
-Triggered before inserting new features to the Geoserver.
-Use this to insert custom properties, modify the feature, etc.
-
-##### Parameters
-
--   `feature` **Feature\<Geometry>**
-
-Returns **Feature\<Geometry>**
-
-### LayerParams
-
-**Extends Omit\<[VectorLayerOptions](https://openlayers.org/en/latest/apidoc/module-ol_layer_Vector-VectorLayer.html)\<any>, 'source'>**
-
-**_\[interface]_** - Parameters to create the layers and connect to the GeoServer
-
-You can use all the parameters supported by OpenLayers
-
-Default values:
-
-```javascript
-{
- name: null,
- label: null, // `name` if not provided
- mode: 'wfs',
- wfsStrategy: 'bbox',
- cqlFilter: null,
- tilesBuffer: 0,
-}
-```
-
-#### name
-
-Layer name in the GeoServer
-
-Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
-
-#### label
-
-Label to be displayed in the widget control
-
-Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
-
-#### mode
-
-Mode to use in the layer
-
-Type: (`"wfs"` | `"wms"`)
-
-#### wfsStrategy
-
-Strategy function for loading features. Only works if mode is "wfs"
-
-Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
-
-#### cqlFilter
-
-The cql_filter GeoServer parameter is similar to the standard filter parameter,
-but the filter is expressed using ECQL (Extended Common Query Language).
-ECQL provides a more compact and readable syntax compared to OGC XML filters.
-For full details see the [ECQL Reference](https://docs.geoserver.org/stable/en/user/filter/ecql_reference.html#filter-ecql-reference) and CQL and ECQL tutorial.
-
-Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
-
-#### tilesBuffer
-
-The buffer parameter specifies the number of additional
-border pixels that are used on requesting rasted tiles
-Only works if mode is 'wms'
-
-Type: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)
-
-### I18n
-
-**_\[interface]_** - Custom Language specified when creating a WFST instance
-
-#### labels
-
-Labels section
-
-Type: {select: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, addElement: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, editElement: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, save: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, delete: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, cancel: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, apply: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, upload: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, editMode: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, confirmDelete: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, geomTypeNotSupported: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, editFields: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, editGeom: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, selectDrawType: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, uploadToLayer: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, uploadFeatures: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, validFeatures: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, invalidFeatures: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, loading: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, toggleVisibility: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, close: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?}
-
-#### errors
-
-Errors section
-
-Type: {capabilities: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, wfst: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, layer: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, noValidGeometry: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, geoserver: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, badFormat: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, badFile: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, lockFeature: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, transaction: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, getFeatures: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?}
-
-## TODO
-
--   \~~Add support to diferent layer styles~~
--   \~~Improve widget controller: visibility toggle~~
--   \~~Add events~~
--   Add customizables styles
--   Improve scss (add variables)
--   Add cookies to persist widget controller state
--   Geometry type _LinearRing_ support
--   Tests!
--   Improve comments and documentation
--   Improve interface
--   Change svg imports to preserve svg structure
-
-## License
-
-MIT (c) Gastón Zalba.
+# OpenLayers WFST
+
+Tiny WFST-T client to insert (drawing/uploading), modify and delete features on GeoServers using OpenLayers. Layers with these types of geometries are supported: _GeometryCollection_ (in this case, you can choose the geometry type of each element to draw), _Point_, _MultiPoint_, _LineString_, _MultiLineString_, _Polygon_ and _MultiPolygon_.
+
+Tested with OpenLayers version 5 and 6.
+
+<img src="screenshots/example-1.jpg" alt="Drawing" style="width:50%; float:left;">
+<img src="screenshots/example-2.jpg" alt="Editing fields" style="width:50%; float:left;">
+
+## Usage
+
+See [Wfst Options](#options) for more details.
+
+```javascript
+import Wfst from 'ol-wfst';
+import { Fill, Stroke, Circle, Style } from 'ol/style';
+
+// Style
+import 'ol-wfst/lib/scss/ol-wfst.css';
+import 'ol-wfst/lib/scss/ol-wfst.bootstrap5.css'; // Do not import if you already have boostrap css
+
+// Optional credentials
+const password = 123456;
+const username = 'username';
+
+const wfst = new Wfst({
+    geoServerUrl: 'https://mysite.com/geoserver/myworkspace/ows',
+    geoServerAdvanced: {
+        getCapabilitiesVersion: '1.3.0',
+        getFeatureVersion: '1.0.0',
+        describeFeatureTypeVersion: '1.1.0',
+        lockFeatureVersion: '1.1.0',
+        projection: 'EPSG:3857'
+    },
+    // Maybe you wanna add this on a proxy, at the backend
+    headers: { Authorization: 'Basic ' + btoa(username + ':' + password) },
+    layers: [
+        {
+            name: 'myPointsLayer', // Name of the layer on the GeoServer
+            label: 'Photos', // Optional Label to be displayed in the controller
+            mode: 'wfs',
+            zIndex: 99,
+            style: new Style({
+                image: new Circle({
+                    radius: 7,
+                    fill: new Fill({
+                        color: '#000000'
+                    }),
+                    stroke: new Stroke({
+                        color: [255, 0, 0],
+                        width: 2
+                    })
+                })
+            })
+        },
+        {
+            name: 'myMultiGeometryLayer',
+            label: 'Other elements'
+        },
+        {
+            name: 'myLineStringLayer',
+            label: 'Routes',
+            visible: false
+        }
+    ],
+    language: 'en',
+    minZoom: 12,
+    showUpload: true,
+    beforeInsertFeature: function (feature) {
+        // Add a custom value o perform an action before insert features
+        feature.set('customProperty', 'customValue', true);
+        return feature;
+    }
+});
+
+// Events
+wfst.on(['getCapabilities', 'getFeaturesLoaded'], function (evt) {
+    console.log(evt.type, evt.data);
+});
+
+wfst.on(['describeFeatureType', 'getFeature'], function (evt) {
+    console.log(evt.type, evt.layer, evt.data);
+});
+
+wfst.on(['modifystart', 'modifyend', 'drawstart', 'drawend'], function (evt) {
+    console.log(evt.type, evt);
+});
+
+map.addControl(wfst);
+
+```
+
+### Some considerations
+
+-   If the features/vertex appear to be slightly offset after adding them, check the _Number of Decimals_ in your Workplace, you may have to increment that to have a more accurete preview.
+-   You can configure a _Basic Authentication_ or an _HTTP Header Proxy Authentication_ with this client, but in some cases is recommended setting that on an reverse proxy on the backend.
+-   If you don't use a reverse proxy, remeber configure [cors](https://docs.geoserver.org/latest/en/user/production/container.html#enable-cors)
+
+## Changelog
+
+See [CHANGELOG](./CHANGELOG.md) for details of changes in each release.
+
+## Install
+
+### Browser
+
+#### JS
+
+Load `ol-wfst.js` after OpenLayers. Wfst is available as `Wfst`.
+
+```HTML
+<script src="https://unpkg.com/ol-wfst@3.0.0"></script>
+```
+
+#### CSS
+
+```HTML
+<link rel="stylesheet" href="https://unpkg.com/ol-wfst@3.0.0/dist/css/ol-wfst.min.css" />
+<link rel="stylesheet" href="https://unpkg.com/ol-wfst@3.0.0/dist/css/ol-wfst.bootstrap5.min.css" />
+```
+
+### Parcel, Webpack, etc.
+
+NPM package: [ol-wfst](https://www.npmjs.com/package/ol-wfst).
+
+Install the package via `npm`
+
+    npm install ol-wfst
+
+#### JS
+
+```js
+import Wfst from 'ol-wfst';
+```
+
+#### CSS
+
+```js
+// scss
+import 'ol-wfst/dist/scss/ol-wfst.scss';
+import 'ol-wfst/dist/scss/-ol-wfst.bootstrap5.scss';
+
+// or css
+import 'ol-wfst/dist/css/ol-wfst.css';
+import 'ol-wfst/dist/css/ol-wfst.bootstrap5.css';
+```
+
+##### TypeScript type definition
+
+TypeScript types are shipped with the project in the dist directory and should be automatically used in a TypeScript project. Interfaces are provided for Wfst Options.
+
+## API
+
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+#### Table of Contents
+
+-   [Wfst](#wfst)
+    -   [Parameters](#parameters)
+    -   [activateDrawMode](#activatedrawmode)
+        -   [Parameters](#parameters-1)
+    -   [activateEditMode](#activateeditmode)
+        -   [Parameters](#parameters-2)
+    -   [insertFeaturesTo](#insertfeaturesto)
+        -   [Parameters](#parameters-3)
+-   [Options](#options)
+    -   [geoServerUrl](#geoserverurl)
+    -   [geoServerAdvanced](#geoserveradvanced)
+    -   [headers](#headers)
+    -   [layers](#layers)
+    -   [active](#active)
+    -   [evtType](#evttype)
+    -   [useLockFeature](#uselockfeature)
+    -   [showControl](#showcontrol)
+    -   [minZoom](#minzoom)
+    -   [modal](#modal)
+    -   [language](#language)
+    -   [i18n](#i18n)
+    -   [showUpload](#showupload)
+    -   [uploadFormats](#uploadformats)
+    -   [processUpload](#processupload)
+        -   [Parameters](#parameters-4)
+    -   [beforeInsertFeature](#beforeinsertfeature)
+        -   [Parameters](#parameters-5)
+-   [LayerParams](#layerparams)
+    -   [name](#name)
+    -   [label](#label)
+    -   [mode](#mode)
+    -   [wfsStrategy](#wfsstrategy)
+    -   [cqlFilter](#cqlfilter)
+    -   [tilesBuffer](#tilesbuffer)
+-   [I18n](#i18n-1)
+    -   [labels](#labels)
+    -   [errors](#errors)
+
+### Wfst
+
+**Extends ol/control/Control~Control**
+
+Tiny WFST-T client to insert (drawing/uploading), modify and delete
+features on GeoServers using OpenLayers. Layers with these types
+of geometries are supported: "GeometryCollection" (in this case, you can
+choose the geometry type of each element to draw), "Point", "MultiPoint",
+"LineString", "MultiLineString", "Polygon" and "MultiPolygon".
+
+#### Parameters
+
+-   `opt_options` **[Options](#options)?** Wfst options, see [Wfst Options](#options) for more details.
+
+#### activateDrawMode
+
+Activate/deactivate the draw mode
+
+##### Parameters
+
+-   `layerName` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean))**
+
+Returns **void**
+
+#### activateEditMode
+
+Activate/desactivate the edit mode
+
+##### Parameters
+
+-   `bool` (optional, default `true`)
+
+Returns **void**
+
+#### insertFeaturesTo
+
+Add features directly to the geoserver, in a custom layer
+without checking geometry or showing modal to confirm.
+
+##### Parameters
+
+-   `layerName` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
+-   `features` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<Feature\<Geometry>>**
+
+Returns **void**
+
+### Options
+
+**_\[interface]_** - Wfst Options specified when creating a Wfst instance
+
+Default values:
+
+```javascript
+{
+ geoServerUrl: null,
+ geoServerAdvanced: {
+     getCapabilitiesVersion: '1.3.0',
+     getFeatureVersion: '1.0.0',
+     describeFeatureTypeVersion: '1.1.0',
+     lockFeatureVersion: '1.1.0',
+     wfsTransactionVersion: '1.1.0',
+     projection: 'EPSG:3857'
+ },
+ headers: {},
+ layers: null,
+ evtType: 'singleclick',
+ active: true,
+ showControl: true,
+ useLockFeature: true,
+ minZoom: 9,
+ language: 'en',
+ i18n: {...}, // according to language selection
+ uploadFormats: '.geojson,.json,.kml',
+ processUpload: null,
+ beforeInsertFeature: null,
+}
+```
+
+#### geoServerUrl
+
+Url for OWS services. This endpoint will recive the WFS, WFST and WMS requests
+
+Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
+
+#### geoServerAdvanced
+
+Advanced options for geoserver requests
+
+Type: {getCapabilitiesVersion: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, getFeatureVersion: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, lockFeatureVersion: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, describeFeatureTypeVersion: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, wfsTransactionVersion: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, projection: ProjectionLike?}
+
+#### headers
+
+Url headers for GeoServer requests. You can use it to add Authorization credentials
+
+Type: HeadersInit
+
+#### layers
+
+Layers to be loaded from the geoserver
+
+Type: [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[LayerParams](#layerparams)>
+
+#### active
+
+Init active
+
+Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
+
+#### evtType
+
+The click event to allow selection of Features to be edited
+
+Type: (`"singleclick"` | `"dblclick"`)
+
+#### useLockFeature
+
+Use LockFeatue request on GeoServer when selecting features.
+This is not always supportedd by the GeoServer.
+See <https://docs.geoserver.org/stable/en/user/services/wfs/reference.html>
+
+Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
+
+#### showControl
+
+Show/hide the control map
+
+Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
+
+#### minZoom
+
+Zoom level to hide features to prevent too much features being loaded
+
+Type: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)
+
+#### modal
+
+Modal configuration
+
+Type: {animateClass: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, animateInClass: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, transition: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)?, backdropTransition: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)?, templates: {dialog: ([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [HTMLElement](https://developer.mozilla.org/docs/Web/HTML/Element))?, headerClose: ([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [HTMLElement](https://developer.mozilla.org/docs/Web/HTML/Element))?}?}
+
+#### language
+
+Language to be used
+
+Type: (`"es"` | `"en"` | `"zh"`)
+
+#### i18n
+
+Custom translations
+
+Type: [I18n](#i18n)
+
+#### showUpload
+
+Show/hide the upload button
+
+Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
+
+#### uploadFormats
+
+Accepted extension formats on upload
+Example: ".json,.geojson"
+
+Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
+
+#### processUpload
+
+Triggered to allow implement custom functions or to parse other formats than default
+by filtering the extension. If this doesn't return features, the default function
+will be used to extract them.
+
+##### Parameters
+
+-   `file` **File**
+
+Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<Feature\<Geometry>>**
+
+#### beforeInsertFeature
+
+Triggered before inserting new features to the Geoserver.
+Use this to insert custom properties, modify the feature, etc.
+
+##### Parameters
+
+-   `feature` **Feature\<Geometry>**
+
+Returns **Feature\<Geometry>**
+
+### LayerParams
+
+**Extends Omit\<[VectorLayerOptions](https://openlayers.org/en/latest/apidoc/module-ol_layer_Vector-VectorLayer.html)\<any>, 'source'>**
+
+**_\[interface]_** - Parameters to create the layers and connect to the GeoServer
+
+You can use all the parameters supported by OpenLayers
+
+Default values:
+
+```javascript
+{
+ name: null,
+ label: null, // `name` if not provided
+ mode: 'wfs',
+ wfsStrategy: 'bbox',
+ cqlFilter: null,
+ tilesBuffer: 0,
+}
+```
+
+#### name
+
+Layer name in the GeoServer
+
+Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
+
+#### label
+
+Label to be displayed in the widget control
+
+Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
+
+#### mode
+
+Mode to use in the layer
+
+Type: (`"wfs"` | `"wms"`)
+
+#### wfsStrategy
+
+Strategy function for loading features. Only works if mode is "wfs"
+
+Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
+
+#### cqlFilter
+
+The cql_filter GeoServer parameter is similar to the standard filter parameter,
+but the filter is expressed using ECQL (Extended Common Query Language).
+ECQL provides a more compact and readable syntax compared to OGC XML filters.
+For full details see the [ECQL Reference](https://docs.geoserver.org/stable/en/user/filter/ecql_reference.html#filter-ecql-reference) and CQL and ECQL tutorial.
+
+Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
+
+#### tilesBuffer
+
+The buffer parameter specifies the number of additional
+border pixels that are used on requesting rasted tiles
+Only works if mode is 'wms'
+
+Type: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)
+
+### I18n
+
+**_\[interface]_** - Custom Language specified when creating a WFST instance
+
+#### labels
+
+Labels section
+
+Type: {select: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, addElement: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, editElement: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, save: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, delete: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, cancel: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, apply: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, upload: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, editMode: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, confirmDelete: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, geomTypeNotSupported: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, editFields: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, editGeom: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, selectDrawType: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, uploadToLayer: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, uploadFeatures: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, validFeatures: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, invalidFeatures: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, loading: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, toggleVisibility: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, close: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?}
+
+#### errors
+
+Errors section
+
+Type: {capabilities: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, wfst: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, layer: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, noValidGeometry: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, geoserver: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, badFormat: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, badFile: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, lockFeature: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, transaction: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, getFeatures: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?}
+
+## TODO
+
+-   \~~Add support to diferent layer styles~~
+-   \~~Improve widget controller: visibility toggle~~
+-   \~~Add events~~
+-   Add customizables styles
+-   Improve scss (add variables)
+-   Add cookies to persist widget controller state
+-   Geometry type _LinearRing_ support
+-   Tests!
+-   Improve comments and documentation
+-   Improve interface
+-   Change svg imports to preserve svg structure
+
+## License
+
+MIT (c) Gastón Zalba.