Merge pull request #44 from camptocamp/wfs_check_startIndex

[WFS] Add startIndex Support in URL generation and supportsStartIndex Method

src/wfs/endpoint.spec.ts

@@ -504,4 +504,11 @@ describe('WfsEndpoint', () => {
       );
     });
   });
+
+  describe('#supportsStartIndex', () => {
+    it('returns true if the WFS version is 2.0.0 or higher', async () => {
+      await endpoint.isReady();
+      expect(endpoint.supportsStartIndex()).toBeTruthy();
+    });
+  });
 });

src/wfs/endpoint.ts

@@ -235,6 +235,14 @@ export default class WfsEndpoint {
     return !!this._getJsonCompatibleOutputFormat(featureType);
   }
 
+  /**
+   * Returns true if the WFS service supports the startIndex parameter.
+   */
+  supportsStartIndex(): boolean {
+    if (!this._version) return false;
+    return this._version >= '2.0.0';
+  }
+
   /**
    * Returns a URL that can be used to query features from this feature type.
    * @param featureType
@@ -245,6 +253,7 @@ export default class WfsEndpoint {
    * @property [options.outputCrs] if unspecified, this will be the data native projection
    * @property [options.extent] an extent to restrict returned objects
    * @property [options.extentCrs] if unspecified, `extent` should be in the data native projection
+   * @property [options.startIndex] if the service supports it, this will be the index of the first feature to return
    * @returns Returns null if endpoint is not ready
    */
   getFeatureUrl(
@@ -256,13 +265,21 @@ export default class WfsEndpoint {
       outputCrs?: CrsCode;
       extent?: BoundingBox;
       extentCrs?: CrsCode;
+      startIndex?: number;
     }
   ) {
     if (!this._featureTypes) {
       return null;
     }
-    const { maxFeatures, asJson, outputFormat, outputCrs, extent, extentCrs } =
-      options || {};
+    const {
+      maxFeatures,
+      asJson,
+      outputFormat,
+      outputCrs,
+      extent,
+      extentCrs,
+      startIndex,
+    } = options || {};
     const internalFeatureType = this._getFeatureTypeByName(featureType);
     if (!internalFeatureType) {
       throw new Error(
@@ -296,7 +313,8 @@ export default class WfsEndpoint {
       undefined,
       outputCrs,
       extent,
-      extentCrs
+      extentCrs,
+      startIndex
     );
   }
 }

src/wfs/url.spec.ts

@@ -99,6 +99,25 @@ describe('WFS url helpers', () => {
         'http://example.com/wfs?SERVICE=WFS&REQUEST=GetFeature&VERSION=2.0.0&TYPENAMES=my%3Atype&SRSNAME=EPSG%3A2154&BBOX=10%2C20%2C100%2C200%2CEPSG%3A3857'
       );
     });
+    it('generates a correct URL (v2.0.0, startIndex set)', () => {
+      expect(
+        generateGetFeatureUrl(
+          'http://example.com/wfs',
+          '2.0.0',
+          'my:type',
+          undefined,
+          undefined,
+          undefined,
+          undefined,
+          undefined,
+          undefined,
+          undefined,
+          10
+        )
+      ).toBe(
+        'http://example.com/wfs?SERVICE=WFS&REQUEST=GetFeature&VERSION=2.0.0&TYPENAMES=my%3Atype&STARTINDEX=10'
+      );
+    });
   });
 
   describe('generateDescribeFeatureTypeUrl', () => {

src/wfs/url.ts

@@ -15,6 +15,7 @@ import { WfsVersion } from './model.js';
  * @param [outputCrs] if unspecified, this will be the data native projection
  * @param [extent] an extent to restrict returned objects
  * @param [extentCrs] if unspecified, `extent` should be in the data native projection
+ * @param [startIndex] if the service supports it, this will be the index of the first feature to return
  */
 export function generateGetFeatureUrl(
   serviceUrl: string,
@@ -26,7 +27,8 @@ export function generateGetFeatureUrl(
   hitsOnly?: boolean,
   outputCrs?: CrsCode,
   extent?: BoundingBox,
-  extentCrs?: CrsCode
+  extentCrs?: CrsCode,
+  startIndex?: number
 ) {
   const typeParam = version === '2.0.0' ? 'TYPENAMES' : 'TYPENAME';
   const countParam = version === '2.0.0' ? 'COUNT' : 'MAXFEATURES';
@@ -51,6 +53,9 @@ export function generateGetFeatureUrl(
     const extentJoined = extent.join(',');
     newParams.BBOX = extentCrs ? `${extentJoined},${extentCrs}` : extentJoined;
   }
+  if (startIndex) {
+    newParams.STARTINDEX = startIndex.toString(10);
+  }
 
   return setQueryParams(serviceUrl, newParams);
 }