ol-wfst 3.0.5 → 4.0.1

package/README.md

@@ -1,8 +1,20 @@
 # 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.
+<p align="center">
+    <a href="https://www.npmjs.com/package/ol-wfst">
+        <img src="https://img.shields.io/npm/v/ol-wfst.svg" alt="npm version">
+    </a>
+    <a href="https://img.shields.io/npm/dm/ol-wfst">
+        <img alt="npm" src="https://img.shields.io/npm/dm/ol-wfst">
+    </a>
+    <a href="https://github.com/gastonzalba/ol-wfst/blob/master/LICENSE">
+        <img src="https://img.shields.io/npm/l/ol-wfst.svg" alt="license">
+    </a>
+</p>
+
+Tiny WFST-T client to insert (drawing/uploading), modify and delete features on GeoServers using [OpenLayers](https://openlayers.org/). 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, 6 and 7.
 
 <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;">
@@ -12,7 +24,7 @@ Tested with OpenLayers version 5 and 6.
 See [Wfst Options](#options) for more details.
 
 ```javascript
-import Wfst from 'ol-wfst';
+import Wfst, { Geoserver, WmsLayer, WfsLayer } from 'ol-wfst';
 import { Fill, Stroke, Circle, Style } from 'ol/style';
 
 // Style
@@ -23,9 +35,9 @@ import 'ol-wfst/lib/scss/ol-wfst.bootstrap5.css'; // Do not import if you alread
 const password = 123456;
 const username = 'username';
 
-const wfst = new Wfst({
-    geoServerUrl: 'https://mysite.com/geoserver/myworkspace/ows',
-    geoServerAdvanced: {
+const geoserver = {
+    url: 'https://mysite.com/geoserver/myworkspace/ows',
+    advanced: {
         getCapabilitiesVersion: '1.3.0',
         getFeatureVersion: '1.0.0',
         describeFeatureTypeVersion: '1.1.0',
@@ -33,77 +45,161 @@ const wfst = new Wfst({
         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
-                    })
-                })
+    headers: { Authorization: 'Basic ' + btoa(username + ':' + password) }
+};
+
+const wfsLayer = new WfsLayer({
+    name: 'myPointsLayer', // Name of the layer on the GeoServer
+    label: 'Photos', // Optional Label to be displayed in the controller
+    geoserver: geoserver,
+    zIndex: 99,
+
+    // WfsLayers need a custom style
+    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
-        },
-        {
-            name: 'myMultiPointLayer',
-            label: 'Markers',
-            visible: false
+        })
+    }),
+
+    // See [geoserverVendor](#geoservervendor) for more details.
+    geoserverVendor: {
+        cql_filter: 'id > 50',
+        maxFeatures: 500
+    },
+
+    beforeTransactFeature: function (feature, transactionType) {
+        if (transactionType === 'insert') {
+            // Maybe add a custom value o perform an action before insert features
+            feature.set('customProperty', 'customValue', true);
+        } else if (transactionType === 'update') {
+            // ... //
+        } else if (transactionType === 'delete') {
+            // .. //
         }
-    ],
-    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;
+    }
+});
+
+const wmsLayer = new WmsLayer({
+    name: 'myMultiGeometryLayer',
+    label: 'Other elements',
+    geoserver: geoserver,
+    // See [geoserverVendor](#geoservervendor) for more details.
+    geoserverVendor: {
+        cql_filter: 'id > 50',
+        buffer: 50,
+        maxFeatures: 500
+    },
+    beforeTransactFeature: function (feature, transactionType) {
+        if (transactionType === 'insert') {
+            // Maybe add a custom value o perform an action before insert features
+            feature.set('customProperty', 'customValue', true);
+        } else if (transactionType === 'update') {
+            // ... //
+        } else if (transactionType === 'delete') {
+            // .. //
+        }
+
         return feature;
     }
 });
 
-// Adding custom feature without drawing
+const wfst = new Wfst({
+    layers: [wfsLayer, wmsLayer],
+    language: 'en',
+    showUpload: true
+});
+
+map.addControl(wfst);
+```
+
+### Useful methods
+
+See \[#wfsSource]
+
+```js
+
+wmsLayer.setCustomParam('cql_filter',(`id = 28`);
+wmsLayer.setCustomParam('env', `tags=true`);
+```
+
+### Adding features programatically
+
+```js
 const feature = new ol.Feature({
     geometry: new ol.geom.MultiPoint([[`-57.1145}`, `-36.2855`]])
 });
-const inserted = await wfst.insertFeaturesTo('myMultiPointLayer', [feature]);
+const inserted = await myWmsLayer.insertFeatures([feature]);
 
 if (inserted) {
     alert('Feature inserted');
 } else {
     alert('Feature not inserted');
 }
+```
 
-// Events
-wfst.on(['getCapabilities', 'getFeaturesLoaded'], function (evt) {
-    console.log(evt.type, evt.data);
+### Events
+
+### wfst instance events
+
+```js
+wfst.on(
+    ['modifystart', 'modifyend', 'drawstart', 'drawend', 'load', 'visible'],
+    function (evt) {
+        console.log(evt);
+    }
+);
+
+wfst.on(['describeFeatureType'], function (evt) {
+    console.log(evt.layer, evt.data);
+});
+```
+
+### Geoserver events
+
+```js
+geoserver.on(['getCapabilities'], function (evt) {
+    console.log(evt.data);
 });
+```
+
+### Layers events
+
+#### WMS Layer
 
-wfst.on(['describeFeatureType', 'getFeature'], function (evt) {
-    console.log(evt.type, evt.layer, evt.data);
+```js
+wmsLayer.on(['change:describeFeatureType'], function (evt) {
+    console.log(evt);
 });
+```
+
+Source [TileWMS Events](https://openlayers.org/en/latest/apidoc/module-ol_Object.ObjectEvent.html)
+
+```js
+wmsLayer.getSource().on([...])
+```
+
+#### WFS Layer
 
-wfst.on(['modifystart', 'modifyend', 'drawstart', 'drawend'], function (evt) {
-    console.log(evt.type, evt);
+```js
+wfsLayer.on(['change:describeFeatureType'], function (evt) {
+    console.log(evt);
 });
+```
+
+[VectorSource Events](https://openlayers.org/en/latest/apidoc/module-ol_source_Vector.VectorSourceEvent.html)
+
+```js
+wfsLayer.getSource().on([...])
 
-map.addControl(wfst);
 ```
 
 ### Some considerations
@@ -122,17 +218,17 @@ See [CHANGELOG](./CHANGELOG.md) for details of changes in each release.
 
 #### JS
 
-Load `ol-wfst.js` after OpenLayers. Wfst is available as `Wfst`.
+Load `ol-wfst.js` after OpenLayers. The available classes are `Wfst`, `Wfst.Geoserver`, `Wfst.WfsLayer` and `Wfst.WmsLayer`.
 
 ```HTML
-<script src="https://unpkg.com/ol-wfst@3.0.3"></script>
+<script src="https://unpkg.com/ol-wfst@4.0.0"></script>
 ```
 
 #### CSS
 
 ```HTML
-<link rel="stylesheet" href="https://unpkg.com/ol-wfst@3.0.3/dist/css/ol-wfst.min.css" />
-<link rel="stylesheet" href="https://unpkg.com/ol-wfst@3.0.3/dist/css/ol-wfst.bootstrap5.min.css" />
+<link rel="stylesheet" href="https://unpkg.com/ol-wfst@4.0.0/dist/css/ol-wfst.min.css" />
+<link rel="stylesheet" href="https://unpkg.com/ol-wfst@4.0.0/dist/css/ol-wfst.bootstrap5.min.css" />
 ```
 
 ### Parcel, Webpack, etc.
@@ -146,7 +242,7 @@ Install the package via `npm`
 #### JS
 
 ```js
-import Wfst from 'ol-wfst';
+import Wfst, { Geoserver, WmsLayer, WfsLayer } from 'ol-wfst';
 ```
 
 #### CSS
@@ -161,7 +257,7 @@ import 'ol-wfst/dist/css/ol-wfst.css';
 import 'ol-wfst/dist/css/ol-wfst.bootstrap5.css';
 ```
 
-##### TypeScript type definition
+#### 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.
 
@@ -171,52 +267,163 @@ TypeScript types are shipped with the project in the dist directory and should b
 
 #### Table of Contents
 
+-   [BaseGeoserverVendor](#basegeoservervendor)
+    -   [key](#key)
+    -   [cql_filter](#cql_filter)
+    -   [sortBy](#sortby)
+    -   [featureid](#featureid)
+    -   [filter](#filter)
+    -   [format_options](#format_options)
+    -   [maxFeatures](#maxfeatures)
+    -   [startIndex](#startindex)
+    -   [propertyname](#propertyname)
 -   [Wfst](#wfst)
     -   [Parameters](#parameters)
     -   [getLayers](#getlayers)
+    -   [getLayerByName](#getlayerbyname)
         -   [Parameters](#parameters-1)
     -   [activateDrawMode](#activatedrawmode)
         -   [Parameters](#parameters-2)
     -   [activateEditMode](#activateeditmode)
         -   [Parameters](#parameters-3)
-    -   [insertFeaturesTo](#insertfeaturesto)
-        -   [Parameters](#parameters-4)
+-   [Geoserver](#geoserver)
+    -   [Parameters](#parameters-4)
+    -   [getCapabilities](#getcapabilities)
+    -   [setUrl](#seturl)
+        -   [Parameters](#parameters-5)
+    -   [getUrl](#geturl)
+    -   [setHeaders](#setheaders)
+        -   [Parameters](#parameters-6)
+    -   [getHeaders](#getheaders)
+    -   [setCredentials](#setcredentials)
+        -   [Parameters](#parameters-7)
+    -   [getCredentials](#getcredentials)
+    -   [setAdvanced](#setadvanced)
+        -   [Parameters](#parameters-8)
+    -   [getAdvanced](#getadvanced)
+    -   [hasTransaction](#hastransaction)
+    -   [hasLockFeature](#haslockfeature)
+    -   [getUseLockFeature](#getuselockfeature)
+    -   [setUseLockFeature](#setuselockfeature)
+        -   [Parameters](#parameters-9)
+    -   [isLoaded](#isloaded)
+    -   [getState](#getstate)
+    -   [getAndUpdateCapabilities](#getandupdatecapabilities)
+    -   [lockFeature](#lockfeature)
+        -   [Parameters](#parameters-10)
+-   [WfsLayer](#wfslayer)
+    -   [Parameters](#parameters-11)
+    -   [refresh](#refresh)
+    -   [setCustomParam](#setcustomparam)
+        -   [Parameters](#parameters-12)
+-   [WmsLayer](#wmslayer)
+    -   [Parameters](#parameters-13)
+    -   [refresh](#refresh-1)
+    -   [setCustomParam](#setcustomparam-1)
+        -   [Parameters](#parameters-14)
 -   [Options](#options)
-    -   [geoServerUrl](#geoserverurl)
-    -   [geoServerAdvanced](#geoserveradvanced)
-    -   [headers](#headers)
-    -   [credentials](#credentials)
+    -   [processUpload](#processupload)
+        -   [Parameters](#parameters-15)
     -   [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-5)
-    -   [beforeInsertFeature](#beforeinsertfeature)
-        -   [Parameters](#parameters-6)
--   [LayerParams](#layerparams)
+-   [LayerOptions](#layeroptions)
+    -   [beforeTransactFeature](#beforetransactfeature)
+        -   [Parameters](#parameters-16)
     -   [name](#name)
+    -   [geoserver](#geoserver-1)
     -   [label](#label)
-    -   [mode](#mode)
-    -   [wfsStrategy](#wfsstrategy)
-    -   [cqlFilter](#cqlfilter)
-    -   [tilesBuffer](#tilesbuffer)
--   [WfstLayer](#wfstlayer)
--   [IWfstLayersList](#iwfstlayerslist)
+    -   [geoserverVendor](#geoservervendor)
+    -   [strategy](#strategy)
+-   [GeoserverOptions](#geoserveroptions)
+    -   [url](#url)
+    -   [advanced](#advanced)
+    -   [headers](#headers)
+    -   [credentials](#credentials)
+    -   [useLockFeature](#uselockfeature)
+-   [GeoServerAdvanced](#geoserveradvanced)
+-   [WfsGeoserverVendor](#wfsgeoservervendor)
+    -   [strict](#strict)
+-   [WmsGeoserverVendor](#wmsgeoservervendor)
+    -   [buffer](#buffer)
+    -   [env](#env)
+    -   [clip](#clip)
+    -   [styles](#styles)
+    -   [transparent](#transparent)
+    -   [bgcolor](#bgcolor)
+    -   [time](#time)
+    -   [sld](#sld)
+    -   [sld_body](#sld_body)
+-   [IGeoserverDescribeFeatureType](#igeoserverdescribefeaturetype)
+    -   [\_parsed](#_parsed)
 -   [I18n](#i18n-1)
     -   [labels](#labels)
     -   [errors](#errors)
 
+### BaseGeoserverVendor
+
+#### key
+
+Add any other param
+
+#### cql_filter
+
+<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html#cql-filter>
+
+Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
+
+#### sortBy
+
+<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html#sortBy>
+
+Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
+
+#### featureid
+
+<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html#featureid>
+
+Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
+
+#### filter
+
+<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html#filter>
+
+Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
+
+#### format_options
+
+WMS: <https://docs.geoserver.org/latest/en/user/services/wms/vendor.html#format-options>
+WFS: <https://docs.geoserver.org/latest/en/user/services/wfs/vendor.html#format-options>
+
+Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
+
+#### maxFeatures
+
+<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html#maxfeatures-and-startindex>
+
+Type: ([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number))
+
+#### startIndex
+
+<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html#maxfeatures-and-startindex>
+
+Type: ([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number))
+
+#### propertyname
+
+<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html#propertyname>
+
+Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
+
 ### Wfst
 
-**Extends ol/control/Control~Control**
+**Extends ol/control/[Control](https://openlayers.org/en/latest/apidoc/module-ol_control_Control-Control.html)~[Control](https://openlayers.org/en/latest/apidoc/module-ol_control_Control-Control.html)**
 
 Tiny WFST-T client to insert (drawing/uploading), modify and delete
 features on GeoServers using OpenLayers. Layers with these types
@@ -226,18 +433,23 @@ choose the geometry type of each element to draw), "Point", "MultiPoint",
 
 #### Parameters
 
--   `opt_options` **[Options](#options)?** Wfst options, see [Wfst Options](#options) for more details.
+-   `options` **[Options](#options)?** Wfst options, see [Wfst Options](#options) for more details.
 
 #### getLayers
 
-Gat all the layers in the ol-wfst instance
-If a name is provided, only returns that layer
+Get all the layers in the ol-wfst instance
+
+Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<([WfsLayer](#wfslayer) | [WmsLayer](#wmslayer))>**&#x20;
+
+#### getLayerByName
+
+Get a layer
 
 ##### Parameters
 
 -   `layerName` (optional, default `''`)
 
-Returns **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[WfstLayer](#wfstlayer)> | [WfstLayer](#wfstlayer))**
+Returns **([WfsLayer](#wfslayer) | [WmsLayer](#wmslayer))**&#x20;
 
 #### activateDrawMode
 
@@ -245,9 +457,9 @@ 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))**
+-   `layer` **([WfsLayer](#wfslayer) | [WmsLayer](#wmslayer) | `false`)**&#x20;
 
-Returns **void**
+Returns **void**&#x20;
 
 #### activateEditMode
 
@@ -257,20 +469,176 @@ Activate/desactivate the edit mode
 
 -   `bool` (optional, default `true`)
 
-Returns **void**
+Returns **void**&#x20;
+
+### Geoserver
+
+**Extends ol/Object~[BaseObject](https://openlayers.org/en/latest/apidoc/module-ol_Object-BaseObject.html)**
+
+#### Parameters
+
+-   `options` **[GeoserverOptions](#geoserveroptions)**&#x20;
+
+#### getCapabilities
 
-#### insertFeaturesTo
+Returns **XMLDocument**&#x20;
 
-Add features directly to the geoserver, in a custom layer
-without checking geometry or showing modal to confirm.
-Returns `true` if features are inserted correctly
+#### setUrl
 
 ##### 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>>**
+-   `url` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
+-   `opt_silent` (optional, default `false`)
+
+Returns **void**&#x20;
+
+#### getUrl
+
+Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
+
+#### setHeaders
+
+##### Parameters
+
+-   `headers` **HeadersInit** (optional, default `{}`)
+-   `opt_silent` (optional, default `false`)
+
+Returns **void**&#x20;
+
+#### getHeaders
+
+Returns **HeadersInit**&#x20;
+
+#### setCredentials
+
+##### Parameters
+
+-   `credentials` **RequestCredentials** (optional, default `null`)
+-   `opt_silent` (optional, default `false`)
+
+Returns **void**&#x20;
+
+#### getCredentials
+
+Returns **RequestCredentials**&#x20;
+
+#### setAdvanced
+
+##### Parameters
+
+-   `advanced` **[GeoServerAdvanced](#geoserveradvanced)** (optional, default `{}`)
+-   `opt_silent` (optional, default `false`)
+
+Returns **void**&#x20;
+
+#### getAdvanced
+
+Returns **[GeoServerAdvanced](#geoserveradvanced)**&#x20;
+
+#### hasTransaction
+
+Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**&#x20;
+
+#### hasLockFeature
+
+Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**&#x20;
+
+#### getUseLockFeature
+
+Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**&#x20;
+
+#### setUseLockFeature
+
+##### Parameters
+
+-   `useLockFeature` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**&#x20;
+-   `opt_silent` (optional, default `false`)
+
+Returns **void**&#x20;
+
+#### isLoaded
+
+Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**&#x20;
+
+#### getState
+
+#### getAndUpdateCapabilities
+
+Get the capabilities from the GeoServer and check
+all the available operations.
+
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<XMLDocument>**&#x20;
+
+#### lockFeature
+
+Lock a feature in the geoserver. Useful before editing a geometry,
+to avoid changes from multiples suers
+
+##### Parameters
+
+-   `featureId` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number))**&#x20;
+-   `layerName` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
+-   `retry` (optional, default `0`)
+
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>**&#x20;
+
+### WfsLayer
+
+**Extends ol/layer/Vector~[VectorLayer](https://openlayers.org/en/latest/apidoc/module-ol_layer_Vector-VectorLayer.html)**
 
-Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)>**
+Layer to retrieve WFS features from geoservers
+<https://docs.geoserver.org/stable/en/user/services/wfs/reference.html>
+
+#### Parameters
+
+-   `options` **[LayerOptions](#layeroptions)**&#x20;
+
+#### refresh
+
+#### setCustomParam
+
+Use this to update Geoserver Wms Vendors (<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html>)
+and other arguements (<https://docs.geoserver.org/stable/en/user/services/wms/reference.html#getmap>)
+in all the getMap requests.
+
+Example: you can use this to change the style of the WMS, add a custom sld, set a cql_filter, etc.
+
+##### Parameters
+
+-   `paramName` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
+-   `value` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** (optional, default `null`)
+-   `refresh` (optional, default `true`)
+
+Returns **URLSearchParams**&#x20;
+
+### WmsLayer
+
+**Extends ol/layer/Tile~[TileLayer](https://openlayers.org/en/latest/apidoc/module-ol_layer_Tile-TileLayer.html)**
+
+Layer to retrieve WMS information from geoservers
+<https://docs.geoserver.org/stable/en/user/services/wms/reference.html>
+
+#### Parameters
+
+-   `options` **[LayerOptions](#layeroptions)**&#x20;
+
+#### refresh
+
+#### setCustomParam
+
+Use this to update Geoserver Wfs Vendors (<https://docs.geoserver.org/latest/en/user/services/wfs/vendor.html>)
+and other arguements (<https://docs.geoserver.org/stable/en/user/services/wfs/reference.html>)
+in all the getFeature requests.
+
+Example: you can use this to set a cql_filter, limit the numbers of features, etc.
+
+##### Parameters
+
+-   `paramName` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
+-   `value` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** (optional, default `null`)
+-   `refresh` (optional, default `true`)
+
+Returns **URLSearchParams**&#x20;
 
 ### Options
 
@@ -280,62 +648,34 @@ 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: {},
- credentials: 'same-origin',
  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
-<https://developer.mozilla.org/en-US/docs/Web/API/Request/headers>
+#### processUpload
 
-Type: HeadersInit
+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.
 
-#### credentials
+##### Parameters
 
-Credentials for fetch requests
-<https://developer.mozilla.org/en-US/docs/Web/API/Request/credentials>
+-   `file` **File**&#x20;
 
-Type: RequestCredentials
+Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<Feature\<Geometry>>**&#x20;
 
 #### layers
 
 Layers to be loaded from the geoserver
 
-Type: [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[LayerParams](#layerparams)>
+Type: [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<([WfsLayer](#wfslayer) | [WmsLayer](#wmslayer))>
 
 #### active
 
@@ -349,26 +689,12 @@ 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
@@ -400,100 +726,219 @@ Example: ".json,.geojson"
 
 Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
 
-#### processUpload
+### LayerOptions
 
-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.
+**Extends Omit\<[VectorLayerOptions](https://openlayers.org/en/latest/apidoc/module-ol_layer_Vector-VectorLayer.html)\<any>, 'source'>**
 
-##### Parameters
+**_\[interface]_** - Parameters to create the layers and connect to the GeoServer
 
--   `file` **File**
+You can use all the parameters supported by OpenLayers
 
-Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<Feature\<Geometry>>**
+Default values:
 
-#### beforeInsertFeature
+```javascript
+{
+ name: null,
+ geoserver: null,
+ label: null, // `name` if not provided
+ strategy: all,
+ geoserverVendor: null
+}
+```
+
+#### beforeTransactFeature
 
 Triggered before inserting new features to the Geoserver.
 Use this to insert custom properties, modify the feature, etc.
 
 ##### Parameters
 
--   `feature` **Feature\<Geometry>**
+-   `feature` **Feature\<Geometry>**&#x20;
+-   `transaction` **TransactionType**&#x20;
 
-Returns **Feature\<Geometry>**
+Returns **Feature\<Geometry>**&#x20;
 
-### LayerParams
+#### name
 
-**Extends Omit\<[VectorLayerOptions](https://openlayers.org/en/latest/apidoc/module-ol_layer_Vector-VectorLayer.html)\<any>, 'source'>**
+Layer name in the GeoServer
 
-**_\[interface]_** - Parameters to create the layers and connect to the GeoServer
+Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
 
-You can use all the parameters supported by OpenLayers
+#### geoserver
 
-Default values:
+Geoserver Object
+
+Type: [Geoserver](#geoserver)
+
+#### label
+
+Label to be displayed in the widget control
+
+Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
+
+#### geoserverVendor
+
+Available geoserver options
+
+Type: ([WfsGeoserverVendor](#wfsgeoservervendor) | [WmsGeoserverVendor](#wmsgeoservervendor))
+
+#### strategy
+
+Strategy function for loading features.
+Only for WFS
+By default `all` strategy is used
+
+Type: LoadingStrategy
+
+### GeoserverOptions
+
+**_\[interface]_**
+
+#### url
+
+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)
+
+#### advanced
+
+Advanced options for geoserver requests
+
+Type: [GeoServerAdvanced](#geoserveradvanced)
+
+#### headers
+
+Http headers for GeoServer requests
+<https://developer.mozilla.org/en-US/docs/Web/API/Request/headers>
+
+Type: HeadersInit
+
+#### credentials
+
+Credentials for fetch requests
+<https://developer.mozilla.org/en-US/docs/Web/API/Request/credentials>
+
+Default is 'same-origin'
+
+Type: RequestCredentials
+
+#### useLockFeature
+
+Use LockFeatue request on GeoServer when selecting features. Prevents a feature from being edited
+through a persistent feature lock. 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)
+
+### GeoServerAdvanced
+
+**_\[interface]_**
+
+-   Default values:
 
 ```javascript
 {
- name: null,
- label: null, // `name` if not provided
- mode: 'wfs',
- wfsStrategy: 'bbox',
- cqlFilter: null,
- tilesBuffer: 0,
+  getCapabilitiesVersion: '1.3.0',
+  getFeatureVersion: '1.0.0',
+  describeFeatureTypeVersion: '1.1.0',
+  lockFeatureVersion: '1.1.0',
+  wfsTransactionVersion: '1.1.0',
+  projection: 'EPSG:3857',
+  lockFeatureParams: {
+    expiry: 5,
+    lockId: 'Geoserver',
+    releaseAction: 'SOME'
+  }
 }
 ```
 
-#### name
+### WfsGeoserverVendor
 
-Layer name in the GeoServer
+**Extends BaseGeoserverVendor**
+
+**_\[interface]_** - WFS geoserver options
+<https://docs.geoserver.org/latest/en/user/services/wfs/vendor.html>
+
+#### strict
+
+<https://docs.geoserver.org/latest/en/user/services/wfs/vendor.html#xml-request-validation>
+
+Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
+
+### WmsGeoserverVendor
+
+**Extends BaseGeoserverVendor**
+
+**_\[interface]_** - WMS geoserver options
+<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html>
+
+#### buffer
+
+<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html#buffer>
+
+Type: ([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number))
+
+#### env
+
+<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html#env>
 
 Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
 
-#### label
+#### clip
 
-Label to be displayed in the widget control
+<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html#clip>
 
 Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
 
-#### mode
+#### styles
+
+Styles in which layers are to be rendered.
+Value is a comma-separated list of style names, or empty if default styling is required.
+Style names may be empty in the list, to use default layer styling.
 
-Mode to use in the layer
+Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
 
-Type: (`"wfs"` | `"wms"`)
+#### transparent
 
-#### wfsStrategy
+Whether the map background should be transparent. Values are true or false. Default is false
+
+Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
 
-Strategy function for loading features. Only works if mode is "wfs"
+#### bgcolor
+
+Background color for the map image. Value is in the form RRGGBB. Default is FFFFFF (white).
 
 Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
 
-#### cqlFilter
+#### time
 
-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.
+Time value or range for map data.
+See [Time Support in GeoServer WMS](https://docs.geoserver.org/stable/en/user/services/wms/time.html#wms-time) for more information.
 
 Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
 
-#### tilesBuffer
+#### sld
 
-The buffer parameter specifies the number of additional
-border pixels that are used on requesting rasted tiles
-Only works if mode is 'wms'
+A URL referencing a [StyledLayerDescriptor](https://docs.geoserver.org/stable/en/user/styling/index.html#styling)
+XML file which controls or enhances map layers and styling
 
-Type: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)
+Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
 
-### WfstLayer
+#### sld_body
 
-**_\[type]_** - Supported layers
+A URL-encoded StyledLayerDescriptor XML document which controls or enhances map layers and styling
 
-Type: (VectorLayer\<any> | TileLayer\<any>)
+Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
 
-### IWfstLayersList
+### IGeoserverDescribeFeatureType
 
-**_\[interface]_** - Custom Language specified when creating a WFST instance
+**_\[interface]_** - Geoserver original response on DescribeFeature request
+
+#### \_parsed
+
+DescribeFeature request parsed
+
+Type: {namespace: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), properties: any, geomType: GeometryType, geomField: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)}
 
 ### I18n
 
@@ -509,13 +954,15 @@ Type: {select: [string](https://developer.mozilla.org/docs/Web/JavaScript/Refere
 
 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)?, layerNotFound: [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)?}
+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)?, layerNotFound: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, layerNotVisible: [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 `Don't show again` option in the error modal
+-   Allow selection of multiples features and bulk edit
 -   Add customizables styles
 -   Improve scss (add variables)
 -   Add cookies to persist widget controller state
@@ -524,7 +971,4 @@ Type: {capabilities: [string](https://developer.mozilla.org/docs/Web/JavaScript/
 -   Improve comments and documentation
 -   Improve interface
 -   Change svg imports to preserve svg structure
-
-## License
-
-MIT (c) Gastón Zalba.
+-   Improve style on editing and drawing features