geoserver-node-client 1.2.2 → 1.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -18,8 +18,9 @@ Detailed [API-Docs](https://meggsimum.github.io/geoserver-node-client/) are auto
18
18
 
19
19
  Compatible with [GeoServer](https://geoserver.org)
20
20
 
21
+ - v2.22.x
21
22
  - v2.21.x
22
- - v2.20.x
23
+ - v2.20.x (no more maintained and officially deprecated)
23
24
  - v2.19.x (no more maintained and officially deprecated)
24
25
  - v2.18.x (no more maintained and officially deprecated)
25
26
  - v2.17.x (no more maintained and officially deprecated)
@@ -106,12 +107,10 @@ A request either succeeds or throws the custom `GeoServerResponseError`. It has
106
107
 
107
108
  ### Unit Tests
108
109
 
109
- First start a GeoServer, e.g. by using this Docker container:
110
+ First start a test setup using this Docker compose file:
110
111
 
111
112
  ```shell
112
- docker run \
113
- -p 8080:8080 \
114
- meggsimum/geoserver:2.20.4
113
+ docker-compose -f test/docker-compose.yml up
115
114
  ```
116
115
 
117
116
  Then, in an other terminal, run:
package/dist/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "geoserver-node-client",
3
- "version": "1.2.2",
3
+ "version": "1.2.3",
4
4
  "description": "Node.js client for GeoServer REST API",
5
5
  "type": "commonjs",
6
6
  "main": "geoserver-rest-client.js",
@@ -49,8 +49,8 @@
49
49
  "eslint-plugin-node": "^11.1.0",
50
50
  "eslint-plugin-promise": "^4.3.1",
51
51
  "eslint-plugin-standard": "^4.1.0",
52
- "jsdoc": "^3.6.10",
52
+ "jsdoc": "^4.0.0",
53
53
  "mocha": "^9.1.3",
54
- "release-it": "^14.14.3"
54
+ "release-it": "^15.4.2"
55
55
  }
56
56
  }
@@ -170,7 +170,6 @@ var DatastoreClient = /*#__PURE__*/function () {
170
170
  return getWmtsStores;
171
171
  }()
172
172
  /**
173
- * @private
174
173
  * Get information about various store types in a workspace.
175
174
  *
176
175
  * @param {String} workspace The workspace name
@@ -179,6 +178,7 @@ var DatastoreClient = /*#__PURE__*/function () {
179
178
  * @throws Error if request fails
180
179
  *
181
180
  * @returns {Object} An object containing store details or undefined if it cannot be found
181
+ * @private
182
182
  */
183
183
 
184
184
  }, {
@@ -365,7 +365,6 @@ var DatastoreClient = /*#__PURE__*/function () {
365
365
  return getWmtsStore;
366
366
  }()
367
367
  /**
368
- * @private
369
368
  * Get GeoServer store by type
370
369
  *
371
370
  * @param {String} workspace The name of the workspace
@@ -375,6 +374,7 @@ var DatastoreClient = /*#__PURE__*/function () {
375
374
  * @throws Error if request fails
376
375
  *
377
376
  * @returns {Object} An object containing store details or undefined if it cannot be found
377
+ * @private
378
378
  */
379
379
 
380
380
  }, {
@@ -523,12 +523,12 @@ var DatastoreClient = /*#__PURE__*/function () {
523
523
  * @param {String} namespaceUri The namespace URI of the workspace
524
524
  * @param {String} dataStore The data store name to be created
525
525
  * @param {String} pgHost The PostGIS DB host
526
- * @param {String} pgPort The PostGIS DB port
526
+ * @param {Number} pgPort The PostGIS DB port
527
527
  * @param {String} pgUser The PostGIS DB user
528
528
  * @param {String} pgPassword The PostGIS DB password
529
529
  * @param {String} pgSchema The PostGIS DB schema
530
530
  * @param {String} pgDb The PostGIS DB name
531
- * @param {String} [exposePk] expose primary key, defaults to false
531
+ * @param {Boolean} [exposePk] expose primary key, defaults to false
532
532
  *
533
533
  * @throws Error if request fails
534
534
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "geoserver-node-client",
3
- "version": "1.2.2",
3
+ "version": "1.2.3",
4
4
  "description": "Node.js client for GeoServer REST API",
5
5
  "type": "module",
6
6
  "main": "geoserver-rest-client.js",
@@ -49,8 +49,8 @@
49
49
  "eslint-plugin-node": "^11.1.0",
50
50
  "eslint-plugin-promise": "^4.3.1",
51
51
  "eslint-plugin-standard": "^4.1.0",
52
- "jsdoc": "^3.6.10",
52
+ "jsdoc": "^4.0.0",
53
53
  "mocha": "^9.1.3",
54
- "release-it": "^14.14.3"
54
+ "release-it": "^15.4.2"
55
55
  }
56
56
  }
package/src/datastore.js CHANGED
@@ -65,7 +65,6 @@ export default class DatastoreClient {
65
65
  }
66
66
 
67
67
  /**
68
- * @private
69
68
  * Get information about various store types in a workspace.
70
69
  *
71
70
  * @param {String} workspace The workspace name
@@ -74,6 +73,7 @@ export default class DatastoreClient {
74
73
  * @throws Error if request fails
75
74
  *
76
75
  * @returns {Object} An object containing store details or undefined if it cannot be found
76
+ * @private
77
77
  */
78
78
  async getStores (workspace, storeType) {
79
79
  const response = await fetch(this.url + 'workspaces/' + workspace + '/' + storeType + '.json', {
@@ -140,7 +140,6 @@ export default class DatastoreClient {
140
140
  }
141
141
 
142
142
  /**
143
- * @private
144
143
  * Get GeoServer store by type
145
144
  *
146
145
  * @param {String} workspace The name of the workspace
@@ -150,6 +149,7 @@ export default class DatastoreClient {
150
149
  * @throws Error if request fails
151
150
  *
152
151
  * @returns {Object} An object containing store details or undefined if it cannot be found
152
+ * @private
153
153
  */
154
154
  async getStore (workspace, storeName, storeType) {
155
155
  const url = this.url + 'workspaces/' + workspace + '/' + storeType + '/' + storeName + '.json';
@@ -225,12 +225,12 @@ export default class DatastoreClient {
225
225
  * @param {String} namespaceUri The namespace URI of the workspace
226
226
  * @param {String} dataStore The data store name to be created
227
227
  * @param {String} pgHost The PostGIS DB host
228
- * @param {String} pgPort The PostGIS DB port
228
+ * @param {Number} pgPort The PostGIS DB port
229
229
  * @param {String} pgUser The PostGIS DB user
230
230
  * @param {String} pgPassword The PostGIS DB password
231
231
  * @param {String} pgSchema The PostGIS DB schema
232
232
  * @param {String} pgDb The PostGIS DB name
233
- * @param {String} [exposePk] expose primary key, defaults to false
233
+ * @param {Boolean} [exposePk] expose primary key, defaults to false
234
234
  *
235
235
  * @throws Error if request fails
236
236
  */