ol-wfst 1.0.8 → 3.0.1

package/CHANGELOG.md

@@ -34,4 +34,27 @@
 ## v1.0.8
 * Fixed some css
 * Fixed bug on Open Layers 5 preventing select the features: getFeatureInfoUrl vs getGetFeatureInfoUrl
-* Fixed bug on Open Layers 5 when creating two Select on the same map
+* Fixed bug on Open Layers 5 when creating two Select on the same map
+
+## v1.0.9
+* Fixed error notification on requesting to offlines geoservers
+* Fixed PeerDependencies
+
+## v2.0.0
+* Improved css bootstrap
+* Added option "modal" to customize modals
+* Added option "i18n" to allow custom translations
+
+## v3.0.0
+* Refactored code: class extends class ol.control.Control (breaking changes)
+* Added geoserverAdvanced to allow customizethe geoserver requests
+* Changed default projection to 'EPSG:3857'
+* Fixed types for recent versions of ol
+* Updated dependencies
+* Moved modal-vanilla to dependencies
+* Added events
+* Added Delete button on Edit Mode
+* css to scss
+
+## v3.0.1
+* Fixed loading msg

package/README.md

@@ -15,16 +15,24 @@ See [Wfst Options](#options) for more details.
 import 'Wfst' from 'ol-wfst';
 import { Fill, Stroke, Circle, Style } from 'ol/style';
 
-// Css
-import 'ol-wfst/lib/css/ol-wfst.css';
-import 'ol-wfst/lib/css/bootstrap-modal.min.css'; // Do not import if you already have boostrap css
+// 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(map, {
+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: [
         {
@@ -64,6 +72,22 @@ const wfst = new Wfst(map, {
         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
@@ -78,8 +102,6 @@ See [CHANGELOG](./CHANGELOG.md) for details of changes in each release.
 
 ## Install
 
-The module uses [modal-vanilla](https://github.com/KaneCohen/modal-vanilla) as a peerDependency to show alerts, forms and messages. The Browser version has been bundled with this.
-
 ### Browser
 
 #### JS
@@ -87,29 +109,41 @@ The module uses [modal-vanilla](https://github.com/KaneCohen/modal-vanilla) as a
 Load `ol-wfst.js` after OpenLayers. Wfst is available as `Wfst`.
 
 ```HTML
-<script src="https://unpkg.com/ol-wfst@1.0.7"></script>
+<script src="https://unpkg.com/ol-wfst@3.0.0"></script>
 ```
 
 #### CSS
 
 ```HTML
-<link rel="stylesheet" href="https://unpkg.com/ol-wfst@1.0.7/dist/css/ol-wfst.min.css" />
-<link rel="stylesheet" href="https://unpkg.com/ol-wfst@1.0.7/dist/css/bootstrap-modal.min.css" />
+<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).
 
-#### JS
-
 Install the package via `npm`
 
-    npm install ol-wfst --save-dev
+    npm install ol-wfst
+
+#### JS
+
+```js
+import Wfst from 'ol-wfst';
+```
 
 #### CSS
 
-The CSS files can be found in `./node_modules/ol-wfst/lib`
+```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
 
@@ -123,16 +157,15 @@ TypeScript types are shipped with the project in the dist directory and should b
 
 -   [Wfst](#wfst)
     -   [Parameters](#parameters)
-    -   [\_changeStateSelect](#_changestateselect)
-        -   [Parameters](#parameters-1)
     -   [activateDrawMode](#activatedrawmode)
-        -   [Parameters](#parameters-2)
+        -   [Parameters](#parameters-1)
     -   [activateEditMode](#activateeditmode)
-        -   [Parameters](#parameters-3)
+        -   [Parameters](#parameters-2)
     -   [insertFeaturesTo](#insertfeaturesto)
-        -   [Parameters](#parameters-4)
+        -   [Parameters](#parameters-3)
 -   [Options](#options)
     -   [geoServerUrl](#geoserverurl)
+    -   [geoServerAdvanced](#geoserveradvanced)
     -   [headers](#headers)
     -   [layers](#layers)
     -   [active](#active)
@@ -140,13 +173,15 @@ TypeScript types are shipped with the project in the dist directory and should b
     -   [useLockFeature](#uselockfeature)
     -   [showControl](#showcontrol)
     -   [minZoom](#minzoom)
+    -   [modal](#modal)
     -   [language](#language)
+    -   [i18n](#i18n)
     -   [showUpload](#showupload)
     -   [uploadFormats](#uploadformats)
     -   [processUpload](#processupload)
-        -   [Parameters](#parameters-5)
+        -   [Parameters](#parameters-4)
     -   [beforeInsertFeature](#beforeinsertfeature)
-        -   [Parameters](#parameters-6)
+        -   [Parameters](#parameters-5)
 -   [LayerParams](#layerparams)
     -   [name](#name)
     -   [label](#label)
@@ -154,9 +189,14 @@ TypeScript types are shipped with the project in the dist directory and should b
     -   [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
@@ -165,27 +205,15 @@ choose the geometry type of each element to draw), "Point", "MultiPoint",
 
 #### Parameters
 
--   `map` **[PluggableMap](https://openlayers.org/en/latest/apidoc/module-ol_PluggableMap-PluggableMap.html)** Instance of the created map
 -   `opt_options` **[Options](#options)?** Wfst options, see [Wfst Options](#options) for more details.
 
-#### \_changeStateSelect
-
-Update geom Types availibles to select for this layer
-
-##### Parameters
-
--   `layerName` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
--   `geomDrawTypeSelected` **GeometryType** (optional, default `null`)
-
-Returns **GeometryType**
-
 #### 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))**
+-   `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**
 
@@ -207,19 +235,27 @@ 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)&lt;Feature>**
+-   `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
+**_\[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',
@@ -227,7 +263,8 @@ Default values:
  showControl: true,
  useLockFeature: true,
  minZoom: 9,
- language: 'es',
+ language: 'en',
+ i18n: {...}, // according to language selection
  uploadFormats: '.geojson,.json,.kml',
  processUpload: null,
  beforeInsertFeature: null,
@@ -240,6 +277,12 @@ 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
@@ -250,7 +293,7 @@ Type: HeadersInit
 
 Layers to be loaded from the geoserver
 
-Type: [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[LayerParams](#layerparams)>
+Type: [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[LayerParams](#layerparams)>
 
 #### active
 
@@ -262,7 +305,7 @@ Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Glob
 
 The click event to allow selection of Features to be edited
 
-Type: (`"singleclick"` \| `"dblclick"`)
+Type: (`"singleclick"` | `"dblclick"`)
 
 #### useLockFeature
 
@@ -284,11 +327,23 @@ 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"`)
+Type: (`"es"` | `"en"`)
+
+#### i18n
+
+Custom translations
+
+Type: [I18n](#i18n)
 
 #### showUpload
 
@@ -313,7 +368,7 @@ will be used to extract them.
 
 -   `file` **File**
 
-Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;Feature>**
+Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<Feature\<Geometry>>**
 
 #### beforeInsertFeature
 
@@ -322,15 +377,15 @@ Use this to insert custom properties, modify the feature, etc.
 
 ##### Parameters
 
--   `feature` **Feature**
+-   `feature` **Feature\<Geometry>**
 
-Returns **Feature**
+Returns **Feature\<Geometry>**
 
 ### LayerParams
 
-**Extends Omit&lt;[VectorLayerOptions](https://openlayers.org/en/latest/apidoc/module-ol_layer_Vector-VectorLayer.html), 'source'>**
+**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
+**_\[interface]_** - Parameters to create the layers and connect to the GeoServer
 
 You can use all the parameters supported by OpenLayers
 
@@ -339,7 +394,7 @@ Default values:
 ```javascript
 {
  name: null,
- label: (same as name),
+ label: null, // `name` if not provided
  mode: 'wfs',
  wfsStrategy: 'bbox',
  cqlFilter: null,
@@ -363,7 +418,7 @@ Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
 
 Mode to use in the layer
 
-Type: (`"wfs"` \| `"wms"`)
+Type: (`"wfs"` | `"wms"`)
 
 #### wfsStrategy
 
@@ -388,13 +443,35 @@ 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 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
 

package/dist/@enums.d.ts

@@ -0,0 +1,12 @@
+export declare enum GeometryType {
+    Point = "Point",
+    LineString = "LineString",
+    LinearRing = "LinearRing",
+    Polygon = "Polygon",
+    MultiPoint = "MultiPoint",
+    MultiLineString = "MultiLineString",
+    MultiPolygon = "MultiPolygon",
+    GeometryCollection = "GeometryCollection",
+    Circle = "Circle"
+}
+//# sourceMappingURL=@enums.d.ts.map

package/dist/@enums.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"@enums.d.ts","sourceRoot":"","sources":["../src/@enums.ts"],"names":[],"mappings":"AAAA,oBAAY,YAAY;IACpB,KAAK,UAAU;IACf,UAAU,eAAe;IACzB,UAAU,eAAe;IACzB,OAAO,YAAY;IACnB,UAAU,eAAe;IACzB,eAAe,oBAAoB;IACnC,YAAY,iBAAiB;IAC7B,kBAAkB,uBAAuB;IACzC,MAAM,WAAW;CACpB"}

package/dist/assets/i18n/en.d.ts

@@ -0,0 +1,3 @@
+import { I18n } from '../../ol-wfst';
+export declare const en: I18n;
+//# sourceMappingURL=en.d.ts.map

package/dist/assets/i18n/en.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"en.d.ts","sourceRoot":"","sources":["../../../src/assets/i18n/en.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAErC,eAAO,MAAM,EAAE,EAAE,IAsChB,CAAC"}

package/dist/assets/i18n/es.d.ts

@@ -0,0 +1,3 @@
+import { I18n } from '../../ol-wfst';
+export declare const es: I18n;
+//# sourceMappingURL=es.d.ts.map

package/dist/assets/i18n/es.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"es.d.ts","sourceRoot":"","sources":["../../../src/assets/i18n/es.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAErC,eAAO,MAAM,EAAE,EAAE,IAuChB,CAAC"}

package/dist/assets/i18n/index.d.ts

@@ -0,0 +1,3 @@
+export * from './es';
+export * from './en';
+//# sourceMappingURL=index.d.ts.map

package/dist/assets/i18n/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/assets/i18n/index.ts"],"names":[],"mappings":"AAAA,cAAc,MAAM,CAAC;AACrB,cAAc,MAAM,CAAC"}