@open-pioneer/ogc-features 0.1.0 → 0.2.0

package/CHANGELOG.md

@@ -1,7 +1,27 @@
 # @open-pioneer/ogc-features
 
+## 0.2.0
+
+### Minor Changes
+
+- 70349a8: Update to new core packages major versions
+
+### Patch Changes
+
+- Updated dependencies [70349a8]
+  - @open-pioneer/search@0.2.0
+
+## 0.1.1
+
+### Patch Changes
+
+- dfc0896: Add OGC API Features search source
+- Updated dependencies [6209d6c]
+- Updated dependencies [565bd8b]
+  - @open-pioneer/search@0.1.0
+
 ## 0.1.0
 
 ### Minor Changes
 
--   bc54925: Initial release.
+- bc54925: Initial release.

package/OffsetStrategy.d.ts

@@ -1,10 +1,11 @@
 import { FeatureLike } from "ol/Feature";
-import { LoadFeatureOptions } from "./OgcFeatureSourceFactory";
+import { LoadFeatureOptions } from "./createVectorSource";
+import { HttpService } from "@open-pioneer/http";
 /** @internal */
 export interface CollectionInfos {
     /** True if features can be requested in pages using offset & limit parameters. */
     supportsOffsetStrategy: boolean;
 }
-export declare function getCollectionInfos(collectionsItemsUrl: string): Promise<CollectionInfos>;
+export declare function getCollectionInfos(collectionsItemsUrl: string, httpService: HttpService): Promise<CollectionInfos>;
 /** @internal */
 export declare function loadAllFeaturesWithOffset(options: LoadFeatureOptions): Promise<FeatureLike[]>;

package/OffsetStrategy.js

@@ -1,14 +1,14 @@
-import { loadPages } from './OgcFeatureSourceFactory.js';
-import { createOffsetURL, getNextURL } from './requestUtils.js';
+import { loadPages } from './createVectorSource.js';
+import { getNextURL, createOffsetURL } from './requestUtils.js';
 
-async function getCollectionInfos(collectionsItemsUrl) {
+async function getCollectionInfos(collectionsItemsUrl, httpService) {
   const infos = {
     supportsOffsetStrategy: false
   };
   const url = new URL(collectionsItemsUrl);
   url.searchParams.set("limit", "1");
   url.searchParams.set("f", "json");
-  const response = await fetch(url.toString(), {
+  const response = await httpService.fetch(url.toString(), {
     headers: {
       Accept: "application/geo+json"
     }
@@ -50,6 +50,7 @@ async function loadAllFeaturesWithOffset(options) {
     const allFeatureResp = await loadPages(
       urls,
       featureFormat,
+      options.httpService,
       signal,
       addFeatures,
       queryFeatures

package/OffsetStrategy.js.map

@@ -1 +1 @@
-{"version":3,"file":"OffsetStrategy.js","sources":["OffsetStrategy.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport { FeatureLike } from \"ol/Feature\";\nimport { LoadFeatureOptions, loadPages } from \"./OgcFeatureSourceFactory\";\nimport { createOffsetURL, getNextURL } from \"./requestUtils\";\n\n/** @internal */\nexport interface CollectionInfos {\n    /** True if features can be requested in pages using offset & limit parameters. */\n    supportsOffsetStrategy: boolean;\n}\n\nexport async function getCollectionInfos(collectionsItemsUrl: string): Promise<CollectionInfos> {\n    const infos: CollectionInfos = {\n        supportsOffsetStrategy: false\n    };\n\n    const url = new URL(collectionsItemsUrl);\n    url.searchParams.set(\"limit\", \"1\");\n    url.searchParams.set(\"f\", \"json\");\n    const response = await fetch(url.toString(), {\n        headers: {\n            Accept: \"application/geo+json\"\n        }\n    });\n    if (response.status !== 200) {\n        throw new Error(`Failed to probe collection information (status code ${response.status})`);\n    }\n\n    const jsonResp = await response.json();\n    const nextUrl = getNextURL(jsonResp.links);\n    if (!nextUrl) {\n        return infos;\n    }\n\n    const parsedURL = new URL(nextUrl);\n    const hasOffset = parsedURL.searchParams.has(\"offset\");\n    infos.supportsOffsetStrategy = hasOffset;\n    return infos;\n}\n\n/** @internal */\nexport async function loadAllFeaturesWithOffset(\n    options: LoadFeatureOptions\n): Promise<FeatureLike[]> {\n    const { fullURL, featureFormat, signal, addFeatures, queryFeatures } = options;\n    const pageSize = options.limit;\n    const maxConcurrency = options.maxConcurrentRequests;\n\n    let startOffset = 0;\n    let currentUrl: string | undefined = fullURL;\n    const allFeatures: FeatureLike[] = [];\n    let totalFeatures: number | undefined;\n    while (currentUrl) {\n        let pagesInIteration: number;\n        if (totalFeatures == undefined) {\n            // We don't know the actual size of the result set yet.\n            pagesInIteration = maxConcurrency;\n        } else {\n            pagesInIteration = Math.ceil((totalFeatures - startOffset) / pageSize);\n        }\n        pagesInIteration = Math.max(1, Math.min(pagesInIteration, maxConcurrency));\n\n        const urls: string[] = [];\n        for (let page = 0; page < pagesInIteration; ++page) {\n            urls.push(createOffsetURL(fullURL, startOffset, pageSize));\n            startOffset += pageSize;\n        }\n\n        const allFeatureResp = await loadPages(\n            urls,\n            featureFormat,\n            signal,\n            addFeatures,\n            queryFeatures\n        );\n\n        allFeatures.push(...allFeatureResp.features);\n        currentUrl = allFeatureResp.nextURL;\n        if (allFeatureResp.numberMatched != null) {\n            totalFeatures = allFeatureResp.numberMatched;\n        }\n    }\n    while (currentUrl !== undefined);\n    return allFeatures;\n}\n"],"names":[],"mappings":";;;AAYA,eAAsB,mBAAmB,mBAAuD,EAAA;AAC5F,EAAA,MAAM,KAAyB,GAAA;AAAA,IAC3B,sBAAwB,EAAA,KAAA;AAAA,GAC5B,CAAA;AAEA,EAAM,MAAA,GAAA,GAAM,IAAI,GAAA,CAAI,mBAAmB,CAAA,CAAA;AACvC,EAAI,GAAA,CAAA,YAAA,CAAa,GAAI,CAAA,OAAA,EAAS,GAAG,CAAA,CAAA;AACjC,EAAI,GAAA,CAAA,YAAA,CAAa,GAAI,CAAA,GAAA,EAAK,MAAM,CAAA,CAAA;AAChC,EAAA,MAAM,QAAW,GAAA,MAAM,KAAM,CAAA,GAAA,CAAI,UAAY,EAAA;AAAA,IACzC,OAAS,EAAA;AAAA,MACL,MAAQ,EAAA,sBAAA;AAAA,KACZ;AAAA,GACH,CAAA,CAAA;AACD,EAAI,IAAA,QAAA,CAAS,WAAW,GAAK,EAAA;AACzB,IAAA,MAAM,IAAI,KAAA,CAAM,CAAuD,oDAAA,EAAA,QAAA,CAAS,MAAM,CAAG,CAAA,CAAA,CAAA,CAAA;AAAA,GAC7F;AAEA,EAAM,MAAA,QAAA,GAAW,MAAM,QAAA,CAAS,IAAK,EAAA,CAAA;AACrC,EAAM,MAAA,OAAA,GAAU,UAAW,CAAA,QAAA,CAAS,KAAK,CAAA,CAAA;AACzC,EAAA,IAAI,CAAC,OAAS,EAAA;AACV,IAAO,OAAA,KAAA,CAAA;AAAA,GACX;AAEA,EAAM,MAAA,SAAA,GAAY,IAAI,GAAA,CAAI,OAAO,CAAA,CAAA;AACjC,EAAA,MAAM,SAAY,GAAA,SAAA,CAAU,YAAa,CAAA,GAAA,CAAI,QAAQ,CAAA,CAAA;AACrD,EAAA,KAAA,CAAM,sBAAyB,GAAA,SAAA,CAAA;AAC/B,EAAO,OAAA,KAAA,CAAA;AACX,CAAA;AAGA,eAAsB,0BAClB,OACsB,EAAA;AACtB,EAAA,MAAM,EAAE,OAAS,EAAA,aAAA,EAAe,MAAQ,EAAA,WAAA,EAAa,eAAkB,GAAA,OAAA,CAAA;AACvE,EAAA,MAAM,WAAW,OAAQ,CAAA,KAAA,CAAA;AACzB,EAAA,MAAM,iBAAiB,OAAQ,CAAA,qBAAA,CAAA;AAE/B,EAAA,IAAI,WAAc,GAAA,CAAA,CAAA;AAClB,EAAA,IAAI,UAAiC,GAAA,OAAA,CAAA;AACrC,EAAA,MAAM,cAA6B,EAAC,CAAA;AACpC,EAAI,IAAA,aAAA,CAAA;AACJ,EAAA,OAAO,UAAY,EAAA;AACf,IAAI,IAAA,gBAAA,CAAA;AACJ,IAAA,IAAI,iBAAiB,KAAW,CAAA,EAAA;AAE5B,MAAmB,gBAAA,GAAA,cAAA,CAAA;AAAA,KAChB,MAAA;AACH,MAAA,gBAAA,GAAmB,IAAK,CAAA,IAAA,CAAA,CAAM,aAAgB,GAAA,WAAA,IAAe,QAAQ,CAAA,CAAA;AAAA,KACzE;AACA,IAAA,gBAAA,GAAmB,KAAK,GAAI,CAAA,CAAA,EAAG,KAAK,GAAI,CAAA,gBAAA,EAAkB,cAAc,CAAC,CAAA,CAAA;AAEzE,IAAA,MAAM,OAAiB,EAAC,CAAA;AACxB,IAAA,KAAA,IAAS,IAAO,GAAA,CAAA,EAAG,IAAO,GAAA,gBAAA,EAAkB,EAAE,IAAM,EAAA;AAChD,MAAA,IAAA,CAAK,IAAK,CAAA,eAAA,CAAgB,OAAS,EAAA,WAAA,EAAa,QAAQ,CAAC,CAAA,CAAA;AACzD,MAAe,WAAA,IAAA,QAAA,CAAA;AAAA,KACnB;AAEA,IAAA,MAAM,iBAAiB,MAAM,SAAA;AAAA,MACzB,IAAA;AAAA,MACA,aAAA;AAAA,MACA,MAAA;AAAA,MACA,WAAA;AAAA,MACA,aAAA;AAAA,KACJ,CAAA;AAEA,IAAY,WAAA,CAAA,IAAA,CAAK,GAAG,cAAA,CAAe,QAAQ,CAAA,CAAA;AAC3C,IAAA,UAAA,GAAa,cAAe,CAAA,OAAA,CAAA;AAC5B,IAAI,IAAA,cAAA,CAAe,iBAAiB,IAAM,EAAA;AACtC,MAAA,aAAA,GAAgB,cAAe,CAAA,aAAA,CAAA;AAAA,KACnC;AAAA,GACJ;AAEA,EAAO,OAAA,WAAA,CAAA;AACX;;;;"}
+{"version":3,"file":"OffsetStrategy.js","sources":["OffsetStrategy.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport { FeatureLike } from \"ol/Feature\";\nimport { LoadFeatureOptions, loadPages } from \"./createVectorSource\";\nimport { createOffsetURL, getNextURL } from \"./requestUtils\";\nimport { HttpService } from \"@open-pioneer/http\";\n\n/** @internal */\nexport interface CollectionInfos {\n    /** True if features can be requested in pages using offset & limit parameters. */\n    supportsOffsetStrategy: boolean;\n}\n\nexport async function getCollectionInfos(\n    collectionsItemsUrl: string,\n    httpService: HttpService\n): Promise<CollectionInfos> {\n    const infos: CollectionInfos = {\n        supportsOffsetStrategy: false\n    };\n\n    const url = new URL(collectionsItemsUrl);\n    url.searchParams.set(\"limit\", \"1\");\n    url.searchParams.set(\"f\", \"json\");\n    const response = await httpService.fetch(url.toString(), {\n        headers: {\n            Accept: \"application/geo+json\"\n        }\n    });\n    if (response.status !== 200) {\n        throw new Error(`Failed to probe collection information (status code ${response.status})`);\n    }\n\n    const jsonResp = await response.json();\n    const nextUrl = getNextURL(jsonResp.links);\n    if (!nextUrl) {\n        return infos;\n    }\n\n    const parsedURL = new URL(nextUrl);\n    const hasOffset = parsedURL.searchParams.has(\"offset\");\n    infos.supportsOffsetStrategy = hasOffset;\n    return infos;\n}\n\n/** @internal */\nexport async function loadAllFeaturesWithOffset(\n    options: LoadFeatureOptions\n): Promise<FeatureLike[]> {\n    const { fullURL, featureFormat, signal, addFeatures, queryFeatures } = options;\n    const pageSize = options.limit;\n    const maxConcurrency = options.maxConcurrentRequests;\n\n    let startOffset = 0;\n    let currentUrl: string | undefined = fullURL;\n    const allFeatures: FeatureLike[] = [];\n    let totalFeatures: number | undefined;\n    while (currentUrl) {\n        let pagesInIteration: number;\n        if (totalFeatures == undefined) {\n            // We don't know the actual size of the result set yet.\n            pagesInIteration = maxConcurrency;\n        } else {\n            pagesInIteration = Math.ceil((totalFeatures - startOffset) / pageSize);\n        }\n        pagesInIteration = Math.max(1, Math.min(pagesInIteration, maxConcurrency));\n\n        const urls: string[] = [];\n        for (let page = 0; page < pagesInIteration; ++page) {\n            urls.push(createOffsetURL(fullURL, startOffset, pageSize));\n            startOffset += pageSize;\n        }\n\n        const allFeatureResp = await loadPages(\n            urls,\n            featureFormat,\n            options.httpService,\n            signal,\n            addFeatures,\n            queryFeatures\n        );\n\n        allFeatures.push(...allFeatureResp.features);\n        currentUrl = allFeatureResp.nextURL;\n        if (allFeatureResp.numberMatched != null) {\n            totalFeatures = allFeatureResp.numberMatched;\n        }\n    }\n    while (currentUrl !== undefined);\n    return allFeatures;\n}\n"],"names":[],"mappings":";;;AAasB,eAAA,kBAAA,CAClB,qBACA,WACwB,EAAA;AACxB,EAAA,MAAM,KAAyB,GAAA;AAAA,IAC3B,sBAAwB,EAAA,KAAA;AAAA,GAC5B,CAAA;AAEA,EAAM,MAAA,GAAA,GAAM,IAAI,GAAA,CAAI,mBAAmB,CAAA,CAAA;AACvC,EAAI,GAAA,CAAA,YAAA,CAAa,GAAI,CAAA,OAAA,EAAS,GAAG,CAAA,CAAA;AACjC,EAAI,GAAA,CAAA,YAAA,CAAa,GAAI,CAAA,GAAA,EAAK,MAAM,CAAA,CAAA;AAChC,EAAA,MAAM,WAAW,MAAM,WAAA,CAAY,KAAM,CAAA,GAAA,CAAI,UAAY,EAAA;AAAA,IACrD,OAAS,EAAA;AAAA,MACL,MAAQ,EAAA,sBAAA;AAAA,KACZ;AAAA,GACH,CAAA,CAAA;AACD,EAAI,IAAA,QAAA,CAAS,WAAW,GAAK,EAAA;AACzB,IAAA,MAAM,IAAI,KAAA,CAAM,CAAuD,oDAAA,EAAA,QAAA,CAAS,MAAM,CAAG,CAAA,CAAA,CAAA,CAAA;AAAA,GAC7F;AAEA,EAAM,MAAA,QAAA,GAAW,MAAM,QAAA,CAAS,IAAK,EAAA,CAAA;AACrC,EAAM,MAAA,OAAA,GAAU,UAAW,CAAA,QAAA,CAAS,KAAK,CAAA,CAAA;AACzC,EAAA,IAAI,CAAC,OAAS,EAAA;AACV,IAAO,OAAA,KAAA,CAAA;AAAA,GACX;AAEA,EAAM,MAAA,SAAA,GAAY,IAAI,GAAA,CAAI,OAAO,CAAA,CAAA;AACjC,EAAA,MAAM,SAAY,GAAA,SAAA,CAAU,YAAa,CAAA,GAAA,CAAI,QAAQ,CAAA,CAAA;AACrD,EAAA,KAAA,CAAM,sBAAyB,GAAA,SAAA,CAAA;AAC/B,EAAO,OAAA,KAAA,CAAA;AACX,CAAA;AAGA,eAAsB,0BAClB,OACsB,EAAA;AACtB,EAAA,MAAM,EAAE,OAAS,EAAA,aAAA,EAAe,MAAQ,EAAA,WAAA,EAAa,eAAkB,GAAA,OAAA,CAAA;AACvE,EAAA,MAAM,WAAW,OAAQ,CAAA,KAAA,CAAA;AACzB,EAAA,MAAM,iBAAiB,OAAQ,CAAA,qBAAA,CAAA;AAE/B,EAAA,IAAI,WAAc,GAAA,CAAA,CAAA;AAClB,EAAA,IAAI,UAAiC,GAAA,OAAA,CAAA;AACrC,EAAA,MAAM,cAA6B,EAAC,CAAA;AACpC,EAAI,IAAA,aAAA,CAAA;AACJ,EAAA,OAAO,UAAY,EAAA;AACf,IAAI,IAAA,gBAAA,CAAA;AACJ,IAAA,IAAI,iBAAiB,KAAW,CAAA,EAAA;AAE5B,MAAmB,gBAAA,GAAA,cAAA,CAAA;AAAA,KAChB,MAAA;AACH,MAAA,gBAAA,GAAmB,IAAK,CAAA,IAAA,CAAA,CAAM,aAAgB,GAAA,WAAA,IAAe,QAAQ,CAAA,CAAA;AAAA,KACzE;AACA,IAAA,gBAAA,GAAmB,KAAK,GAAI,CAAA,CAAA,EAAG,KAAK,GAAI,CAAA,gBAAA,EAAkB,cAAc,CAAC,CAAA,CAAA;AAEzE,IAAA,MAAM,OAAiB,EAAC,CAAA;AACxB,IAAA,KAAA,IAAS,IAAO,GAAA,CAAA,EAAG,IAAO,GAAA,gBAAA,EAAkB,EAAE,IAAM,EAAA;AAChD,MAAA,IAAA,CAAK,IAAK,CAAA,eAAA,CAAgB,OAAS,EAAA,WAAA,EAAa,QAAQ,CAAC,CAAA,CAAA;AACzD,MAAe,WAAA,IAAA,QAAA,CAAA;AAAA,KACnB;AAEA,IAAA,MAAM,iBAAiB,MAAM,SAAA;AAAA,MACzB,IAAA;AAAA,MACA,aAAA;AAAA,MACA,OAAQ,CAAA,WAAA;AAAA,MACR,MAAA;AAAA,MACA,WAAA;AAAA,MACA,aAAA;AAAA,KACJ,CAAA;AAEA,IAAY,WAAA,CAAA,IAAA,CAAK,GAAG,cAAA,CAAe,QAAQ,CAAA,CAAA;AAC3C,IAAA,UAAA,GAAa,cAAe,CAAA,OAAA,CAAA;AAC5B,IAAI,IAAA,cAAA,CAAe,iBAAiB,IAAM,EAAA;AACtC,MAAA,aAAA,GAAgB,cAAe,CAAA,aAAA,CAAA;AAAA,KACnC;AAAA,GACJ;AAEA,EAAO,OAAA,WAAA,CAAA;AACX;;;;"}

package/OgcFeatureSearchSource.d.ts

@@ -0,0 +1,39 @@
+import { SearchSource, SearchResult, SearchOptions } from "@open-pioneer/search";
+import { OgcFeatureSearchSourceOptions } from "./api";
+import { HttpService } from "@open-pioneer/http";
+/** The general shape of features returned by an OGC API Features service. */
+export interface FeatureResponse {
+    /**
+     * The type of the feature (e.g. `Feature`).
+     */
+    type: string;
+    /**
+     * The id of the feature.
+     */
+    id: string | number;
+    /**
+     * The geometry of the feature.
+     */
+    geometry: unknown;
+    /**
+     * The properties of the feature.
+     */
+    properties: Readonly<Record<string, unknown>>;
+}
+/**
+ * An implementation of {@link SearchSource} that searches on an OGC Features API service.
+ */
+export declare class OgcFeatureSearchSource implements SearchSource {
+    #private;
+    readonly label: string;
+    constructor(options: OgcFeatureSearchSourceOptions, httpService: HttpService);
+    search(inputValue: string, { mapProjection, maxResults, signal }: SearchOptions): Promise<SearchResult[]>;
+}
+export interface SearchResponse {
+    features: FeatureResponse[];
+    links?: Record<string, unknown>[];
+    numberMatched?: number;
+    numberReturned?: number;
+    timeStamp?: string;
+    type?: string;
+}

package/OgcFeatureSearchSource.js

@@ -0,0 +1,90 @@
+import { isAbortError } from '@open-pioneer/core';
+import { v4 } from 'uuid';
+import GeoJSON from 'ol/format/GeoJSON';
+
+class OgcFeatureSearchSource {
+  label;
+  #options;
+  #httpService;
+  #baseUrl;
+  #params;
+  constructor(options, httpService) {
+    this.label = options.label;
+    this.#options = options;
+    this.#httpService = httpService;
+    const { baseUrl, params } = getBaseUrl(options.baseUrl);
+    this.#baseUrl = baseUrl;
+    this.#params = params;
+  }
+  async search(inputValue, { mapProjection, maxResults, signal }) {
+    const url = this.#getUrl(inputValue, maxResults);
+    const geojson = new GeoJSON({
+      dataProjection: "EPSG:4326",
+      featureProjection: mapProjection
+    });
+    const responses = await fetchJson(this.#httpService, url, signal);
+    return responses.features.map((feature) => this.#createResult(feature, geojson));
+  }
+  #createResult(feature, geojson) {
+    const customLabel = this.#options.renderLabel?.(feature);
+    const singleLabelProperty = feature.properties[this.#options.labelProperty];
+    const singleSearchProperty = feature.properties[this.#options.searchProperty];
+    const label = (() => {
+      if (customLabel) {
+        return customLabel;
+      } else if (singleLabelProperty !== void 0) {
+        return String(singleLabelProperty);
+      } else if (singleSearchProperty !== void 0) {
+        return String(singleSearchProperty);
+      } else {
+        return "";
+      }
+    })();
+    return {
+      id: feature.id ?? v4(),
+      label,
+      geometry: geojson.readGeometry(feature.geometry),
+      properties: feature.properties
+    };
+  }
+  #getUrl(inputValue, limit) {
+    const url = new URL(`${this.#baseUrl}/collections/${this.#options.collectionId}/items`);
+    for (const [k, v] of this.#params) {
+      url.searchParams.append(k, v);
+    }
+    url.searchParams.set(this.#options.searchProperty, `*${inputValue}*`);
+    url.searchParams.set("limit", String(limit));
+    url.searchParams.set("f", "json");
+    return this.#options.rewriteUrl?.(new URL(url)) ?? url;
+  }
+}
+async function fetchJson(httpService, url, signal) {
+  try {
+    const response = await httpService.fetch(url, {
+      signal,
+      headers: {
+        "Accept": "application/json"
+      }
+    });
+    if (!response.ok) {
+      throw new Error("Request failed with status " + response.status);
+    }
+    const result = await response.json();
+    return result;
+  } catch (error) {
+    if (isAbortError(error)) {
+      throw error;
+    }
+    throw new Error("Failed to search on OGC API Features service", { cause: error });
+  }
+}
+function getBaseUrl(baseUrl) {
+  const url = new URL(baseUrl);
+  const params = new URLSearchParams(url.searchParams);
+  url.search = "";
+  const cleanBaseUrl = url.href.replace(/\/+$/, "");
+  return { baseUrl: cleanBaseUrl, params };
+}
+
+export { OgcFeatureSearchSource };
+//# sourceMappingURL=OgcFeatureSearchSource.js.map

package/OgcFeatureSearchSource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OgcFeatureSearchSource.js","sources":["OgcFeatureSearchSource.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport { isAbortError } from \"@open-pioneer/core\";\nimport { SearchSource, SearchResult, SearchOptions } from \"@open-pioneer/search\";\nimport { v4 as uuid4v } from \"uuid\";\nimport GeoJSON from \"ol/format/GeoJSON\";\nimport { OgcFeatureSearchSourceOptions } from \"./api\";\nimport { HttpService } from \"@open-pioneer/http\";\n\n/** The general shape of features returned by an OGC API Features service. */\nexport interface FeatureResponse {\n    /**\n     * The type of the feature (e.g. `Feature`).\n     */\n    type: string;\n\n    /**\n     * The id of the feature.\n     */\n    id: string | number;\n\n    /**\n     * The geometry of the feature.\n     */\n    geometry: unknown;\n\n    /**\n     * The properties of the feature.\n     */\n    properties: Readonly<Record<string, unknown>>;\n}\n\n/**\n * An implementation of {@link SearchSource} that searches on an OGC Features API service.\n */\nexport class OgcFeatureSearchSource implements SearchSource {\n    readonly label: string;\n    #options: OgcFeatureSearchSourceOptions;\n    #httpService: HttpService;\n    #baseUrl: string;\n    #params: URLSearchParams;\n\n    constructor(options: OgcFeatureSearchSourceOptions, httpService: HttpService) {\n        this.label = options.label;\n        this.#options = options;\n        this.#httpService = httpService;\n\n        const { baseUrl, params } = getBaseUrl(options.baseUrl);\n        this.#baseUrl = baseUrl;\n        this.#params = params;\n    }\n\n    async search(\n        inputValue: string,\n        { mapProjection, maxResults, signal }: SearchOptions\n    ): Promise<SearchResult[]> {\n        const url = this.#getUrl(inputValue, maxResults);\n        const geojson = new GeoJSON({\n            dataProjection: \"EPSG:4326\",\n            featureProjection: mapProjection\n        });\n\n        const responses = await fetchJson(this.#httpService, url, signal);\n        return responses.features.map((feature) => this.#createResult(feature, geojson));\n    }\n\n    #createResult(feature: FeatureResponse, geojson: GeoJSON): SearchResult {\n        const customLabel = this.#options.renderLabel?.(feature);\n\n        const singleLabelProperty =\n            feature.properties[this.#options.labelProperty as keyof typeof feature.properties];\n\n        const singleSearchProperty =\n            feature.properties[this.#options.searchProperty as keyof typeof feature.properties];\n\n        const label = (() => {\n            if (customLabel) {\n                return customLabel;\n            } else if (singleLabelProperty !== undefined) {\n                return String(singleLabelProperty);\n            } else if (singleSearchProperty !== undefined) {\n                return String(singleSearchProperty);\n            } else {\n                return \"\";\n            }\n        })();\n\n        return {\n            id: feature.id ?? uuid4v(),\n            label: label,\n            geometry: geojson.readGeometry(feature.geometry),\n            properties: feature.properties\n        };\n    }\n\n    #getUrl(inputValue: string, limit: number): URL {\n        const url = new URL(`${this.#baseUrl}/collections/${this.#options.collectionId}/items`);\n\n        for (const [k, v] of this.#params) {\n            url.searchParams.append(k, v);\n        }\n        url.searchParams.set(this.#options.searchProperty, `*${inputValue}*`);\n        url.searchParams.set(\"limit\", String(limit));\n        url.searchParams.set(\"f\", \"json\");\n\n        // Passing a copy of the original URL to prevent accidental modifications.\n        // Users should return a new URL instead.\n        return this.#options.rewriteUrl?.(new URL(url)) ?? url;\n    }\n}\n\n// Exported for test\nexport interface SearchResponse {\n    features: FeatureResponse[];\n    links?: Record<string, unknown>[];\n    numberMatched?: number;\n    numberReturned?: number;\n    timeStamp?: string;\n    type?: string;\n}\n\nasync function fetchJson(\n    httpService: HttpService,\n    url: URL,\n    signal?: AbortSignal | undefined\n): Promise<SearchResponse> {\n    try {\n        const response = await httpService.fetch(url, {\n            signal,\n            headers: {\n                \"Accept\": \"application/json\"\n            }\n        });\n        if (!response.ok) {\n            throw new Error(\"Request failed with status \" + response.status);\n        }\n\n        const result = await response.json();\n        return result;\n    } catch (error) {\n        if (isAbortError(error)) {\n            throw error;\n        }\n        throw new Error(\"Failed to search on OGC API Features service\", { cause: error });\n    }\n}\n\n/**\n * Splits the base url into a \"clean\" base URL (no query params) and the original query params.\n */\nfunction getBaseUrl(baseUrl: string) {\n    const url = new URL(baseUrl);\n    const params = new URLSearchParams(url.searchParams);\n    url.search = \"\";\n\n    const cleanBaseUrl = url.href.replace(/\\/+$/, \"\"); // prevent double slash\n    return { baseUrl: cleanBaseUrl, params };\n}\n"],"names":["uuid4v"],"mappings":";;;;AAmCO,MAAM,sBAA+C,CAAA;AAAA,EAC/C,KAAA,CAAA;AAAA,EACT,QAAA,CAAA;AAAA,EACA,YAAA,CAAA;AAAA,EACA,QAAA,CAAA;AAAA,EACA,OAAA,CAAA;AAAA,EAEA,WAAA,CAAY,SAAwC,WAA0B,EAAA;AAC1E,IAAA,IAAA,CAAK,QAAQ,OAAQ,CAAA,KAAA,CAAA;AACrB,IAAA,IAAA,CAAK,QAAW,GAAA,OAAA,CAAA;AAChB,IAAA,IAAA,CAAK,YAAe,GAAA,WAAA,CAAA;AAEpB,IAAA,MAAM,EAAE,OAAS,EAAA,MAAA,EAAW,GAAA,UAAA,CAAW,QAAQ,OAAO,CAAA,CAAA;AACtD,IAAA,IAAA,CAAK,QAAW,GAAA,OAAA,CAAA;AAChB,IAAA,IAAA,CAAK,OAAU,GAAA,MAAA,CAAA;AAAA,GACnB;AAAA,EAEA,MAAM,MACF,CAAA,UAAA,EACA,EAAE,aAAe,EAAA,UAAA,EAAY,QACN,EAAA;AACvB,IAAA,MAAM,GAAM,GAAA,IAAA,CAAK,OAAQ,CAAA,UAAA,EAAY,UAAU,CAAA,CAAA;AAC/C,IAAM,MAAA,OAAA,GAAU,IAAI,OAAQ,CAAA;AAAA,MACxB,cAAgB,EAAA,WAAA;AAAA,MAChB,iBAAmB,EAAA,aAAA;AAAA,KACtB,CAAA,CAAA;AAED,IAAA,MAAM,YAAY,MAAM,SAAA,CAAU,IAAK,CAAA,YAAA,EAAc,KAAK,MAAM,CAAA,CAAA;AAChE,IAAO,OAAA,SAAA,CAAU,SAAS,GAAI,CAAA,CAAC,YAAY,IAAK,CAAA,aAAA,CAAc,OAAS,EAAA,OAAO,CAAC,CAAA,CAAA;AAAA,GACnF;AAAA,EAEA,aAAA,CAAc,SAA0B,OAAgC,EAAA;AACpE,IAAA,MAAM,WAAc,GAAA,IAAA,CAAK,QAAS,CAAA,WAAA,GAAc,OAAO,CAAA,CAAA;AAEvD,IAAA,MAAM,mBACF,GAAA,OAAA,CAAQ,UAAW,CAAA,IAAA,CAAK,SAAS,aAAgD,CAAA,CAAA;AAErF,IAAA,MAAM,oBACF,GAAA,OAAA,CAAQ,UAAW,CAAA,IAAA,CAAK,SAAS,cAAiD,CAAA,CAAA;AAEtF,IAAA,MAAM,SAAS,MAAM;AACjB,MAAA,IAAI,WAAa,EAAA;AACb,QAAO,OAAA,WAAA,CAAA;AAAA,OACX,MAAA,IAAW,wBAAwB,KAAW,CAAA,EAAA;AAC1C,QAAA,OAAO,OAAO,mBAAmB,CAAA,CAAA;AAAA,OACrC,MAAA,IAAW,yBAAyB,KAAW,CAAA,EAAA;AAC3C,QAAA,OAAO,OAAO,oBAAoB,CAAA,CAAA;AAAA,OAC/B,MAAA;AACH,QAAO,OAAA,EAAA,CAAA;AAAA,OACX;AAAA,KACD,GAAA,CAAA;AAEH,IAAO,OAAA;AAAA,MACH,EAAA,EAAI,OAAQ,CAAA,EAAA,IAAMA,EAAO,EAAA;AAAA,MACzB,KAAA;AAAA,MACA,QAAU,EAAA,OAAA,CAAQ,YAAa,CAAA,OAAA,CAAQ,QAAQ,CAAA;AAAA,MAC/C,YAAY,OAAQ,CAAA,UAAA;AAAA,KACxB,CAAA;AAAA,GACJ;AAAA,EAEA,OAAA,CAAQ,YAAoB,KAAoB,EAAA;AAC5C,IAAM,MAAA,GAAA,GAAM,IAAI,GAAA,CAAI,CAAG,EAAA,IAAA,CAAK,QAAQ,CAAgB,aAAA,EAAA,IAAA,CAAK,QAAS,CAAA,YAAY,CAAQ,MAAA,CAAA,CAAA,CAAA;AAEtF,IAAA,KAAA,MAAW,CAAC,CAAA,EAAG,CAAC,CAAA,IAAK,KAAK,OAAS,EAAA;AAC/B,MAAI,GAAA,CAAA,YAAA,CAAa,MAAO,CAAA,CAAA,EAAG,CAAC,CAAA,CAAA;AAAA,KAChC;AACA,IAAA,GAAA,CAAI,aAAa,GAAI,CAAA,IAAA,CAAK,SAAS,cAAgB,EAAA,CAAA,CAAA,EAAI,UAAU,CAAG,CAAA,CAAA,CAAA,CAAA;AACpE,IAAA,GAAA,CAAI,YAAa,CAAA,GAAA,CAAI,OAAS,EAAA,MAAA,CAAO,KAAK,CAAC,CAAA,CAAA;AAC3C,IAAI,GAAA,CAAA,YAAA,CAAa,GAAI,CAAA,GAAA,EAAK,MAAM,CAAA,CAAA;AAIhC,IAAA,OAAO,KAAK,QAAS,CAAA,UAAA,GAAa,IAAI,GAAI,CAAA,GAAG,CAAC,CAAK,IAAA,GAAA,CAAA;AAAA,GACvD;AACJ,CAAA;AAYA,eAAe,SAAA,CACX,WACA,EAAA,GAAA,EACA,MACuB,EAAA;AACvB,EAAI,IAAA;AACA,IAAA,MAAM,QAAW,GAAA,MAAM,WAAY,CAAA,KAAA,CAAM,GAAK,EAAA;AAAA,MAC1C,MAAA;AAAA,MACA,OAAS,EAAA;AAAA,QACL,QAAU,EAAA,kBAAA;AAAA,OACd;AAAA,KACH,CAAA,CAAA;AACD,IAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AACd,MAAA,MAAM,IAAI,KAAA,CAAM,6BAAgC,GAAA,QAAA,CAAS,MAAM,CAAA,CAAA;AAAA,KACnE;AAEA,IAAM,MAAA,MAAA,GAAS,MAAM,QAAA,CAAS,IAAK,EAAA,CAAA;AACnC,IAAO,OAAA,MAAA,CAAA;AAAA,WACF,KAAO,EAAA;AACZ,IAAI,IAAA,YAAA,CAAa,KAAK,CAAG,EAAA;AACrB,MAAM,MAAA,KAAA,CAAA;AAAA,KACV;AACA,IAAA,MAAM,IAAI,KAAM,CAAA,8CAAA,EAAgD,EAAE,KAAA,EAAO,OAAO,CAAA,CAAA;AAAA,GACpF;AACJ,CAAA;AAKA,SAAS,WAAW,OAAiB,EAAA;AACjC,EAAM,MAAA,GAAA,GAAM,IAAI,GAAA,CAAI,OAAO,CAAA,CAAA;AAC3B,EAAA,MAAM,MAAS,GAAA,IAAI,eAAgB,CAAA,GAAA,CAAI,YAAY,CAAA,CAAA;AACnD,EAAA,GAAA,CAAI,MAAS,GAAA,EAAA,CAAA;AAEb,EAAA,MAAM,YAAe,GAAA,GAAA,CAAI,IAAK,CAAA,OAAA,CAAQ,QAAQ,EAAE,CAAA,CAAA;AAChD,EAAO,OAAA,EAAE,OAAS,EAAA,YAAA,EAAc,MAAO,EAAA,CAAA;AAC3C;;;;"}

package/README.md

@@ -1,21 +1,37 @@
 # @open-pioneer/ogc-features
 
-This package provides a function to create an OpenLayers VectorSource to be used with OGC API Features service.
-This VectorSource should be used inside together with a VectorLayer.
+This package provides utilities to work with OGC API Features services.
 
 ## Usage
 
-Just import the function with:
+### Vector source
+
+This vector source should be used together with a vector layer.
+
+Inject the vector source factory by referencing `"ogc-features.VectorSourceFactory"`:
 
 ```js
-import { createVectorSource } from "@open-pioneer/ogc-features";
+// build.config.mjs
+import { defineBuildConfig } from "@open-pioneer/build-support";
+
+export default defineBuildConfig({
+    services: {
+        YourService: {
+            // ...
+            references: {
+                vectorSourceFactory: "ogc-features.VectorSourceFactory"
+            }
+        }
+    }
+});
 ```
 
 and use it inside a VectorLayer:
 
 ```ts
-layer: new VectorLayer({
-    source: createVectorSource({
+const vectorSourceFactory = ...; // injected
+const vectorLayer = new VectorLayer({
+    source: vectorSourceFactory.createVectorSource({
         baseUrl: "https://ogc-api.nrw.de/inspire-us-kindergarten/v1",
         collectionId: "governmentalservice",
         crs: "http://www.opengis.net/def/crs/EPSG/0/25832",
@@ -27,7 +43,7 @@ layer: new VectorLayer({
          * When the `offset` strategy is used for feature fetching, the limit
          * is used for the page size.
          *
-         * Default limit is 5000
+         * Defaults to `5000`.
          */
         limit: 5000,
 
@@ -49,6 +65,79 @@ The number of concurrent requests is never higher than `maxConcurrentRequests`.
 Additional options of the `VectorSource` (see [OpenLayers documentation](https://openlayers.org/en/latest/apidoc/module-ol_source_Vector-VectorSource.html)) can be given by the property
 `additionalOptions`.
 
+### Search source
+
+This search source is used to search in OGC API features.
+
+Inject the search source factory by referencing `"ogc-features.SearchSourceFactory"`:
+
+```js
+// build.config.mjs
+import { defineBuildConfig } from "@open-pioneer/build-support";
+
+export default defineBuildConfig({
+    services: {
+        YourService: {
+            // ...
+            references: {
+                searchSourceFactory: "ogc-features.SearchSourceFactory"
+            }
+        }
+    }
+});
+```
+
+and create a search search instance:
+
+```ts
+const searchSourceFactory = ...; // injected
+const searchSource = searchSourceFactory.createSearchSource({
+    label: this.intl.formatMessage({ id: "searchSources.miningPermissions" }),
+    baseUrl: "https://ogc-api.nrw.de/lika/v1",
+    collectionId: "flurstueck",
+    searchProperty: "flurstid",
+    labelProperty: "objid"
+}),
+```
+
+Use the callback function `renderLabel` to create a custom label for the result.
+
+```ts
+searchSourceFactory.createSearchSource({
+    // ...
+    renderLabel(feature) {
+        const tntxt = feature?.properties?.tntxt;
+        const id = feature?.id;
+        if (typeof tntxt === "string") {
+            return tntxt + " (" + id + ")";
+        } else {
+            return String(id);
+        }
+    }
+    // ...
+});
+```
+
+The label is generated by one of the following methods, weighted by order:
+
+1. `renderLabel` function
+2. `labelProperty`
+3. `searchProperty`
+
+To overwrite the service URL, use the callback function `rewriteUrl`.
+This is useful, for example, to return only a specific attribute in the response, as in the following example:
+
+```ts
+searchSourceFactory.createSearchSource({
+    // ...
+    rewriteUrl(url) {
+        url.searchParams.set("properties", "objid");
+        return url;
+    }
+    // ...
+});
+```
+
 ## License
 
 Apache-2.0 (see `LICENSE` file)

package/api.d.ts

@@ -0,0 +1,124 @@
+import { DeclaredService } from "@open-pioneer/runtime";
+import { SearchSource } from "@open-pioneer/search";
+import Feature from "ol/Feature";
+import { Geometry } from "ol/geom";
+import { AttributionLike } from "ol/source/Source";
+import VectorSource, { Options } from "ol/source/Vector";
+/**
+ * These are properties for OGC API Features vector source.
+ */
+export interface OgcFeatureVectorSourceOptions {
+    /** The base-URL right to the "/collections"-part */
+    baseUrl: string;
+    /** The collection-ID */
+    collectionId: string;
+    /** the URL to the EPSG-Code, e.g. http://www.opengis.net/def/crs/EPSG/0/25832 */
+    crs: string;
+    /**
+     * The maximum number of features to fetch within a single request.
+     * Corresponds to the `limit` parameter in the URL.
+     *
+     * When the `offset` strategy is used for feature fetching, the limit
+     * is used for the page size
+     *
+     * Defaults to `5000` for Next-Strategy.
+     * Defaults to `2500` for Offset-Strategy.
+     */
+    limit?: number;
+    /** The maximum number of concurrent requests. Defaults to `6`. */
+    maxConcurrentRequests?: number;
+    /** Optional attribution for the layer (e.g. copyright hints). */
+    attributions?: AttributionLike | undefined;
+    /** Optional additional options for the VectorSource. */
+    additionalOptions?: Options<Feature<Geometry>>;
+}
+/**
+ * A factory that creates {@link VectorSource | vector sources} for an OGC API Features service.
+ * The resulting vector sources can be used in an OpenLayers `VectorLayer`.
+ *
+ * Use the interface name `"ogc-features.VectorSourceFactory"` to obtain an instance of this factory.
+ */
+export interface OgcFeaturesVectorSourceFactory extends DeclaredService<"ogc-features.VectorSourceFactory"> {
+    /**
+     * Creates a new {@link VectorSource} that loads features from the specified feature service.
+     */
+    createVectorSource(options: OgcFeatureVectorSourceOptions): VectorSource;
+}
+/** Options for {@link OgcFeatureSearchSource}. */
+export interface OgcFeatureSearchSourceOptions {
+    /** The source's label. May be used as a title for results from this source. */
+    label: string;
+    /**
+     * The URL to the service, not including the "/collections"-part.
+     *
+     * Query arguments here are also used for individual requests by default, for example:
+     *
+     * ```js
+     * new OgcFeatureSearchSource({
+     *    // token is also used for all requests made by this class
+     *    baseUrl: `https://example.com/ogc-service?token=...`
+     * })
+     * ```
+     */
+    baseUrl: string;
+    /**
+     * The ID of the collection.
+     */
+    collectionId: string;
+    /**
+     * Property used for filtering on OGC API Features.
+     */
+    searchProperty: string;
+    /**
+     * Property used for labelling.
+     *
+     * Defaults to `searchProperty`.
+     *
+     * This property can be useful if searchProperty is not returned by the service, or
+     * if another field shall be displayed instead.
+     */
+    labelProperty?: string;
+    /**
+     * Function to create custom a label for a given feature.
+     *
+     * If the label is not customized by this function, `labelProperty` (or `searchProperty`) will be used instead.
+     */
+    renderLabel?: (feature: FeatureResponse) => string | undefined;
+    /**
+     * Rewrite function to modify the original URL.
+     *
+     * NOTE: Do not update the `url` argument. Return a new `URL` instance instead.
+     */
+    rewriteUrl?: (url: URL) => URL | undefined;
+}
+/** The general shape of features returned by an OGC API Features service. */
+export interface FeatureResponse {
+    /**
+     * The type of the feature (e.g. `Feature`).
+     */
+    type: string;
+    /**
+     * The id of the feature.
+     */
+    id: string | number;
+    /**
+     * The geometry of the feature.
+     */
+    geometry: unknown;
+    /**
+     * The properties of the feature.
+     */
+    properties: Readonly<Record<string, unknown>>;
+}
+/**
+ * A factory that creates {@link SearchSource | search sources} for an OGC API Features service.
+ * The resulting search sources can be used in combination with the `@open-pioneer/search` package.
+ *
+ * Use the interface name `"ogc-features.SearchSourceFactory"` to obtain an instance of this factory.
+ */
+export interface OgcFeaturesSearchSourceFactory extends DeclaredService<"ogc-features.SearchSourceFactory"> {
+    /**
+     * Returns a new {@link SearchSource} that searches on the specified feature service.
+     */
+    createSearchSource(options: OgcFeatureSearchSourceOptions): SearchSource;
+}

package/createVectorSource.d.ts

@@ -0,0 +1,64 @@
+import { FeatureLike } from "ol/Feature";
+import FeatureFormat from "ol/format/Feature";
+import VectorSource from "ol/source/Vector";
+import { CollectionInfos, getCollectionInfos } from "./OffsetStrategy";
+import { FeatureResponse, queryFeatures } from "./requestUtils";
+import { OgcFeatureVectorSourceOptions } from "./api";
+import { HttpService } from "@open-pioneer/http";
+/**
+ * This function creates an OpenLayers VectorSource for OGC API Features services to be used inside
+ * an OpenLayers VectorLayer.
+ *
+ * @param options Options for the vector source.
+ */
+export declare function createVectorSource(options: OgcFeatureVectorSourceOptions, httpService: HttpService): VectorSource;
+/**
+ * @internal
+ * Exported for tests
+ */
+export interface InternalOptions {
+    httpService: HttpService;
+    queryFeaturesParam?: QueryFeaturesFunc | undefined;
+    addFeaturesParam?: AddFeaturesFunc | undefined;
+    getCollectionInfosParam?: GetCollectionInfosFunc | undefined;
+}
+/**
+ * @internal
+ * Creates the actual vector source.
+ * Exported for testing.
+ * Exposes `queryFeatures`, `addFeatures` and `getCollectionInfos` for easier testing.
+ */
+export declare function _createVectorSource(options: OgcFeatureVectorSourceOptions, internals: InternalOptions): VectorSource;
+/** @internal **/
+type QueryFeaturesFunc = typeof queryFeatures;
+/** @internal **/
+type GetCollectionInfosFunc = typeof getCollectionInfos;
+/** @internal **/
+type AddFeaturesFunc = (features: FeatureLike[]) => void;
+/** @internal **/
+export interface LoadFeatureOptions {
+    fullURL: string;
+    httpService: HttpService;
+    featureFormat: FeatureFormat;
+    queryFeatures: QueryFeaturesFunc;
+    addFeatures: AddFeaturesFunc;
+    limit: number;
+    maxConcurrentRequests: number;
+    signal?: AbortSignal;
+    collectionInfos?: CollectionInfos;
+}
+/**
+ * @internal
+ * Fetches features by following the `next` links in the server's response.
+ */
+export declare function loadAllFeaturesNextStrategy(options: Omit<LoadFeatureOptions, "offsetRequestProps" | "collectionInfos">): Promise<FeatureLike[]>;
+export declare function loadFeatures(requestUrl: string, featureFormat: FeatureFormat, httpService: HttpService, signal: AbortSignal | undefined, addFeaturesFunc: AddFeaturesFunc, queryFeaturesFunc?: QueryFeaturesFunc): Promise<FeatureResponse>;
+/**
+ * Loads features from multiple urls in parallel.
+ * The URLs should represent pages of the same result set.
+ * The `nextURL` of the last page (if any) is returned from this function.
+ *
+ * @internal
+ */
+export declare function loadPages(allUrls: string[], featureFormat: FeatureFormat, httpService: HttpService, signal: AbortSignal | undefined, addFeaturesFunc: AddFeaturesFunc, queryFeaturesFunc?: QueryFeaturesFunc): Promise<FeatureResponse>;
+export {};

package/{OgcFeatureSourceFactory.js → createVectorSource.js}

@@ -2,16 +2,17 @@ import { createLogger, isAbortError } from '@open-pioneer/core';
 import GeoJSON from 'ol/format/GeoJSON';
 import { bbox } from 'ol/loadingstrategy';
 import VectorSource from 'ol/source/Vector';
-import { loadAllFeaturesWithOffset, getCollectionInfos } from './OffsetStrategy.js';
-import { createCollectionRequestUrl, queryFeatures } from './requestUtils.js';
+import { getCollectionInfos, loadAllFeaturesWithOffset } from './OffsetStrategy.js';
+import { queryFeatures, createCollectionRequestUrl } from './requestUtils.js';
 
 const LOG = createLogger("ogc-features:OgcFeatureSourceFactory");
 const DEFAULT_LIMIT = 5e3;
 const DEFAULT_CONCURRENTY = 6;
-function createVectorSource(options) {
-  return _createVectorSource(options, void 0, void 0, void 0);
+function createVectorSource(options, httpService) {
+  return _createVectorSource(options, { httpService });
 }
-function _createVectorSource(options, queryFeaturesParam, addFeaturesParam, getCollectionInfosParam) {
+function _createVectorSource(options, internals) {
+  const httpService = internals.httpService;
   const collectionItemsURL = `${options.baseUrl}/collections/${options.collectionId}/items?`;
   const vectorSrc = new VectorSource({
     format: new GeoJSON(),
@@ -19,16 +20,16 @@ function _createVectorSource(options, queryFeaturesParam, addFeaturesParam, getC
     attributions: options.attributions,
     ...options.additionalOptions
   });
-  const queryFeaturesFunc = queryFeaturesParam ?? queryFeatures;
-  const getCollectionInfosFunc = getCollectionInfosParam ?? getCollectionInfos;
-  const addFeaturesFunc = addFeaturesParam || function(features) {
+  const queryFeaturesFunc = internals.queryFeaturesParam ?? queryFeatures;
+  const getCollectionInfosFunc = internals.getCollectionInfosParam ?? getCollectionInfos;
+  const addFeaturesFunc = internals.addFeaturesParam || function(features) {
     LOG.debug(`Adding ${features.length} features`);
     vectorSrc.addFeatures(features);
   };
   let abortController;
   let collectionInfosPromise;
   const loaderFunction = async (extent, _, __, success, failure) => {
-    collectionInfosPromise ??= getCollectionInfosFunc(collectionItemsURL);
+    collectionInfosPromise ??= getCollectionInfosFunc(collectionItemsURL, httpService);
     let collectionInfos;
     try {
       collectionInfos = await collectionInfosPromise;
@@ -45,8 +46,8 @@ function _createVectorSource(options, queryFeaturesParam, addFeaturesParam, getC
     try {
       const features = await loadAllFeatures(strategy, {
         fullURL: fullURL.toString(),
+        httpService,
         featureFormat: vectorSrc.getFormat(),
-        // TODO
         queryFeatures: queryFeaturesFunc,
         addFeatures: addFeaturesFunc,
         limit: options.limit ?? DEFAULT_LIMIT,
@@ -86,6 +87,7 @@ async function loadAllFeaturesNextStrategy(options) {
     const featureResp = await loadPages(
       [url.toString()],
       options.featureFormat,
+      options.httpService,
       options.signal,
       options.addFeatures,
       options.queryFeatures
@@ -98,7 +100,7 @@ async function loadAllFeaturesNextStrategy(options) {
   } while (1);
   return allFeatures;
 }
-async function loadPages(allUrls, featureFormat, signal, addFeaturesFunc, queryFeaturesFunc = queryFeatures) {
+async function loadPages(allUrls, featureFormat, httpService, signal, addFeaturesFunc, queryFeaturesFunc = queryFeatures) {
   const allFeatureResponse = {
     nextURL: void 0,
     numberMatched: void 0,
@@ -106,7 +108,12 @@ async function loadPages(allUrls, featureFormat, signal, addFeaturesFunc, queryF
   };
   const allRequestPromises = allUrls.map(async (singleUrl, index) => {
     const isLast = index === allUrls.length - 1;
-    const featureResponse = await queryFeaturesFunc(singleUrl, featureFormat, signal);
+    const featureResponse = await queryFeaturesFunc(
+      singleUrl,
+      featureFormat,
+      httpService,
+      signal
+    );
     addFeaturesFunc(featureResponse.features);
     LOG.debug(
       `NextURL for index = ${index} (isLast = ${isLast}): ${featureResponse.nextURL || "No Next URL"}`
@@ -122,4 +129,4 @@ async function loadPages(allUrls, featureFormat, signal, addFeaturesFunc, queryF
 }
 
 export { _createVectorSource, createVectorSource, loadAllFeaturesNextStrategy, loadPages };
-//# sourceMappingURL=OgcFeatureSourceFactory.js.map
+//# sourceMappingURL=createVectorSource.js.map

package/createVectorSource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createVectorSource.js","sources":["createVectorSource.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport { createLogger, isAbortError } from \"@open-pioneer/core\";\nimport { FeatureLike } from \"ol/Feature\";\nimport { FeatureLoader } from \"ol/featureloader\";\nimport FeatureFormat from \"ol/format/Feature\";\nimport GeoJSON from \"ol/format/GeoJSON\";\nimport { bbox } from \"ol/loadingstrategy\";\nimport VectorSource from \"ol/source/Vector\";\nimport { CollectionInfos, getCollectionInfos, loadAllFeaturesWithOffset } from \"./OffsetStrategy\";\nimport { FeatureResponse, createCollectionRequestUrl, queryFeatures } from \"./requestUtils\";\nimport { OgcFeatureVectorSourceOptions } from \"./api\";\nimport { HttpService } from \"@open-pioneer/http\";\n\nconst LOG = createLogger(\"ogc-features:OgcFeatureSourceFactory\");\nconst DEFAULT_LIMIT = 5000;\nconst DEFAULT_CONCURRENTY = 6;\n\n/**\n * This function creates an OpenLayers VectorSource for OGC API Features services to be used inside\n * an OpenLayers VectorLayer.\n *\n * @param options Options for the vector source.\n */\nexport function createVectorSource(\n    options: OgcFeatureVectorSourceOptions,\n    httpService: HttpService\n): VectorSource {\n    return _createVectorSource(options, { httpService });\n}\n\n/**\n * @internal\n * Exported for tests\n */\nexport interface InternalOptions {\n    httpService: HttpService;\n    queryFeaturesParam?: QueryFeaturesFunc | undefined;\n    addFeaturesParam?: AddFeaturesFunc | undefined;\n    getCollectionInfosParam?: GetCollectionInfosFunc | undefined;\n}\n\n/**\n * @internal\n * Creates the actual vector source.\n * Exported for testing.\n * Exposes `queryFeatures`, `addFeatures` and `getCollectionInfos` for easier testing.\n */\nexport function _createVectorSource(\n    options: OgcFeatureVectorSourceOptions,\n    internals: InternalOptions\n): VectorSource {\n    const httpService = internals.httpService;\n    const collectionItemsURL = `${options.baseUrl}/collections/${options.collectionId}/items?`;\n    const vectorSrc = new VectorSource({\n        format: new GeoJSON(),\n        strategy: bbox,\n        attributions: options.attributions,\n        ...options.additionalOptions\n    });\n\n    const queryFeaturesFunc = internals.queryFeaturesParam ?? queryFeatures;\n    const getCollectionInfosFunc = internals.getCollectionInfosParam ?? getCollectionInfos;\n    const addFeaturesFunc =\n        internals.addFeaturesParam ||\n        function (features: FeatureLike[]) {\n            LOG.debug(`Adding ${features.length} features`);\n\n            // Type mismatch FeatureLike <--> Feature<Geometry>\n            // MIGHT be incorrect! We will see.\n            // eslint-disable-next-line @typescript-eslint/no-explicit-any\n            vectorSrc.addFeatures(features as any);\n        };\n\n    // Abort controller for the currently pending request(s).\n    // Used to cancel outdated requests.\n    let abortController: AbortController;\n    let collectionInfosPromise: Promise<CollectionInfos | undefined> | undefined;\n\n    const loaderFunction: FeatureLoader = async (\n        extent,\n        _,\n        __,\n        success,\n        failure\n    ): Promise<void> => {\n        collectionInfosPromise ??= getCollectionInfosFunc(collectionItemsURL, httpService);\n        let collectionInfos;\n        try {\n            collectionInfos = await collectionInfosPromise;\n        } catch (e) {\n            LOG.error(\"Failed to retrieve collection information\", e);\n            failure?.();\n            collectionInfosPromise = undefined;\n            return;\n        }\n\n        // An extent-change should cancel open requests for older extents, because otherwise,\n        // old and expensive requests could block new requests for a new extent\n        // => no features are drawn on the current map for a long time.\n        abortController?.abort(\"Extent changed\");\n        abortController = new AbortController();\n\n        const fullURL = createCollectionRequestUrl(collectionItemsURL, extent, options.crs);\n        const strategy = collectionInfos?.supportsOffsetStrategy ? \"offset\" : \"next\";\n        try {\n            const features = await loadAllFeatures(strategy, {\n                fullURL: fullURL.toString(),\n                httpService: httpService,\n                featureFormat: vectorSrc.getFormat()!,\n                queryFeatures: queryFeaturesFunc,\n                addFeatures: addFeaturesFunc,\n                limit: options.limit ?? DEFAULT_LIMIT,\n                maxConcurrentRequests: options.maxConcurrentRequests ?? DEFAULT_CONCURRENTY,\n                signal: abortController.signal,\n                collectionInfos: collectionInfos\n            });\n            // Type mismatch FeatureLike <--> Feature<Geometry>\n            // MIGHT be incorrect! We will see.\n            // eslint-disable-next-line @typescript-eslint/no-explicit-any\n            success?.(features as any);\n            LOG.debug(\"Finished loading features for extent:\", extent);\n        } catch (e) {\n            if (!isAbortError(e)) {\n                LOG.error(\"Failed to load features\", e);\n            } else {\n                LOG.debug(\"Query-Feature-Request aborted\", e);\n                vectorSrc.removeLoadedExtent(extent);\n                failure?.();\n            }\n        }\n    };\n    vectorSrc.setLoader(loaderFunction);\n    return vectorSrc;\n}\n\n/** @internal **/\ntype QueryFeaturesFunc = typeof queryFeatures;\n/** @internal **/\ntype GetCollectionInfosFunc = typeof getCollectionInfos;\n/** @internal **/\ntype AddFeaturesFunc = (features: FeatureLike[]) => void;\n\n/** @internal **/\nexport interface LoadFeatureOptions {\n    fullURL: string;\n    httpService: HttpService;\n    featureFormat: FeatureFormat;\n    queryFeatures: QueryFeaturesFunc;\n    addFeatures: AddFeaturesFunc;\n    limit: number;\n    maxConcurrentRequests: number;\n    signal?: AbortSignal;\n    collectionInfos?: CollectionInfos;\n}\n\n/**\n * @internal\n * Fetches _all_ features according to the given strategy.\n */\nfunction loadAllFeatures(\n    strategy: \"next\" | \"offset\",\n    options: LoadFeatureOptions\n): Promise<FeatureLike[]> {\n    switch (strategy) {\n        case \"next\":\n            return loadAllFeaturesNextStrategy(options);\n        case \"offset\":\n            return loadAllFeaturesWithOffset(options);\n    }\n}\n\n/**\n * @internal\n * Fetches features by following the `next` links in the server's response.\n */\nexport async function loadAllFeaturesNextStrategy(\n    options: Omit<LoadFeatureOptions, \"offsetRequestProps\" | \"collectionInfos\">\n): Promise<FeatureLike[]> {\n    const limit = options.limit;\n\n    let url = new URL(options.fullURL);\n    url.searchParams.set(\"limit\", limit.toString());\n    let allFeatures: FeatureLike[] = [];\n    do {\n        const featureResp = await loadPages(\n            [url.toString()],\n            options.featureFormat,\n            options.httpService,\n            options.signal,\n            options.addFeatures,\n            options.queryFeatures\n        );\n\n        allFeatures = allFeatures.concat(featureResp.features);\n        if (!featureResp.nextURL) {\n            break;\n        }\n\n        url = new URL(featureResp.nextURL);\n        // eslint-disable-next-line no-constant-condition\n    } while (1);\n    return allFeatures;\n}\n\nexport async function loadFeatures(\n    requestUrl: string,\n    featureFormat: FeatureFormat,\n    httpService: HttpService,\n    signal: AbortSignal | undefined,\n    addFeaturesFunc: AddFeaturesFunc,\n    queryFeaturesFunc: QueryFeaturesFunc = queryFeatures\n): Promise<FeatureResponse> {\n    const featureResponse = await queryFeaturesFunc(requestUrl, featureFormat, httpService, signal);\n    const features = featureResponse.features as FeatureLike[];\n    addFeaturesFunc(features);\n    return featureResponse;\n}\n\n/**\n * Loads features from multiple urls in parallel.\n * The URLs should represent pages of the same result set.\n * The `nextURL` of the last page (if any) is returned from this function.\n *\n * @internal\n */\nexport async function loadPages(\n    allUrls: string[],\n    featureFormat: FeatureFormat,\n    httpService: HttpService,\n    signal: AbortSignal | undefined,\n    addFeaturesFunc: AddFeaturesFunc,\n    queryFeaturesFunc: QueryFeaturesFunc = queryFeatures\n): Promise<FeatureResponse> {\n    const allFeatureResponse: FeatureResponse = {\n        nextURL: undefined,\n        numberMatched: undefined,\n        features: []\n    };\n    const allRequestPromises = allUrls.map(async (singleUrl, index): Promise<void> => {\n        const isLast = index === allUrls.length - 1;\n\n        const featureResponse = await queryFeaturesFunc(\n            singleUrl,\n            featureFormat,\n            httpService,\n            signal\n        );\n        addFeaturesFunc(featureResponse.features as FeatureLike[]);\n\n        LOG.debug(\n            `NextURL for index = ${index} (isLast = ${isLast}): ${\n                featureResponse.nextURL || \"No Next URL\"\n            }`\n        );\n        allFeatureResponse.features.push(...featureResponse.features);\n        if (isLast) {\n            allFeatureResponse.numberMatched = featureResponse.numberMatched;\n            allFeatureResponse.nextURL = featureResponse.nextURL;\n        }\n    });\n    await Promise.all(allRequestPromises);\n    return allFeatureResponse;\n}\n"],"names":[],"mappings":";;;;;;;AAcA,MAAM,GAAA,GAAM,aAAa,sCAAsC,CAAA,CAAA;AAC/D,MAAM,aAAgB,GAAA,GAAA,CAAA;AACtB,MAAM,mBAAsB,GAAA,CAAA,CAAA;AAQZ,SAAA,kBAAA,CACZ,SACA,WACY,EAAA;AACZ,EAAA,OAAO,mBAAoB,CAAA,OAAA,EAAS,EAAE,WAAA,EAAa,CAAA,CAAA;AACvD,CAAA;AAmBgB,SAAA,mBAAA,CACZ,SACA,SACY,EAAA;AACZ,EAAA,MAAM,cAAc,SAAU,CAAA,WAAA,CAAA;AAC9B,EAAA,MAAM,qBAAqB,CAAG,EAAA,OAAA,CAAQ,OAAO,CAAA,aAAA,EAAgB,QAAQ,YAAY,CAAA,OAAA,CAAA,CAAA;AACjF,EAAM,MAAA,SAAA,GAAY,IAAI,YAAa,CAAA;AAAA,IAC/B,MAAA,EAAQ,IAAI,OAAQ,EAAA;AAAA,IACpB,QAAU,EAAA,IAAA;AAAA,IACV,cAAc,OAAQ,CAAA,YAAA;AAAA,IACtB,GAAG,OAAQ,CAAA,iBAAA;AAAA,GACd,CAAA,CAAA;AAED,EAAM,MAAA,iBAAA,GAAoB,UAAU,kBAAsB,IAAA,aAAA,CAAA;AAC1D,EAAM,MAAA,sBAAA,GAAyB,UAAU,uBAA2B,IAAA,kBAAA,CAAA;AACpE,EAAA,MAAM,eACF,GAAA,SAAA,CAAU,gBACV,IAAA,SAAU,QAAyB,EAAA;AAC/B,IAAA,GAAA,CAAI,KAAM,CAAA,CAAA,OAAA,EAAU,QAAS,CAAA,MAAM,CAAW,SAAA,CAAA,CAAA,CAAA;AAK9C,IAAA,SAAA,CAAU,YAAY,QAAe,CAAA,CAAA;AAAA,GACzC,CAAA;AAIJ,EAAI,IAAA,eAAA,CAAA;AACJ,EAAI,IAAA,sBAAA,CAAA;AAEJ,EAAA,MAAM,iBAAgC,OAClC,MAAA,EACA,CACA,EAAA,EAAA,EACA,SACA,OACgB,KAAA;AAChB,IAA2B,sBAAA,KAAA,sBAAA,CAAuB,oBAAoB,WAAW,CAAA,CAAA;AACjF,IAAI,IAAA,eAAA,CAAA;AACJ,IAAI,IAAA;AACA,MAAA,eAAA,GAAkB,MAAM,sBAAA,CAAA;AAAA,aACnB,CAAG,EAAA;AACR,MAAI,GAAA,CAAA,KAAA,CAAM,6CAA6C,CAAC,CAAA,CAAA;AACxD,MAAU,OAAA,IAAA,CAAA;AACV,MAAyB,sBAAA,GAAA,KAAA,CAAA,CAAA;AACzB,MAAA,OAAA;AAAA,KACJ;AAKA,IAAA,eAAA,EAAiB,MAAM,gBAAgB,CAAA,CAAA;AACvC,IAAA,eAAA,GAAkB,IAAI,eAAgB,EAAA,CAAA;AAEtC,IAAA,MAAM,OAAU,GAAA,0BAAA,CAA2B,kBAAoB,EAAA,MAAA,EAAQ,QAAQ,GAAG,CAAA,CAAA;AAClF,IAAM,MAAA,QAAA,GAAW,eAAiB,EAAA,sBAAA,GAAyB,QAAW,GAAA,MAAA,CAAA;AACtE,IAAI,IAAA;AACA,MAAM,MAAA,QAAA,GAAW,MAAM,eAAA,CAAgB,QAAU,EAAA;AAAA,QAC7C,OAAA,EAAS,QAAQ,QAAS,EAAA;AAAA,QAC1B,WAAA;AAAA,QACA,aAAA,EAAe,UAAU,SAAU,EAAA;AAAA,QACnC,aAAe,EAAA,iBAAA;AAAA,QACf,WAAa,EAAA,eAAA;AAAA,QACb,KAAA,EAAO,QAAQ,KAAS,IAAA,aAAA;AAAA,QACxB,qBAAA,EAAuB,QAAQ,qBAAyB,IAAA,mBAAA;AAAA,QACxD,QAAQ,eAAgB,CAAA,MAAA;AAAA,QACxB,eAAA;AAAA,OACH,CAAA,CAAA;AAID,MAAA,OAAA,GAAU,QAAe,CAAA,CAAA;AACzB,MAAI,GAAA,CAAA,KAAA,CAAM,yCAAyC,MAAM,CAAA,CAAA;AAAA,aACpD,CAAG,EAAA;AACR,MAAI,IAAA,CAAC,YAAa,CAAA,CAAC,CAAG,EAAA;AAClB,QAAI,GAAA,CAAA,KAAA,CAAM,2BAA2B,CAAC,CAAA,CAAA;AAAA,OACnC,MAAA;AACH,QAAI,GAAA,CAAA,KAAA,CAAM,iCAAiC,CAAC,CAAA,CAAA;AAC5C,QAAA,SAAA,CAAU,mBAAmB,MAAM,CAAA,CAAA;AACnC,QAAU,OAAA,IAAA,CAAA;AAAA,OACd;AAAA,KACJ;AAAA,GACJ,CAAA;AACA,EAAA,SAAA,CAAU,UAAU,cAAc,CAAA,CAAA;AAClC,EAAO,OAAA,SAAA,CAAA;AACX,CAAA;AA0BA,SAAS,eAAA,CACL,UACA,OACsB,EAAA;AACtB,EAAA,QAAQ,QAAU;AAAA,IACd,KAAK,MAAA;AACD,MAAA,OAAO,4BAA4B,OAAO,CAAA,CAAA;AAAA,IAC9C,KAAK,QAAA;AACD,MAAA,OAAO,0BAA0B,OAAO,CAAA,CAAA;AAAA,GAChD;AACJ,CAAA;AAMA,eAAsB,4BAClB,OACsB,EAAA;AACtB,EAAA,MAAM,QAAQ,OAAQ,CAAA,KAAA,CAAA;AAEtB,EAAA,IAAI,GAAM,GAAA,IAAI,GAAI,CAAA,OAAA,CAAQ,OAAO,CAAA,CAAA;AACjC,EAAA,GAAA,CAAI,YAAa,CAAA,GAAA,CAAI,OAAS,EAAA,KAAA,CAAM,UAAU,CAAA,CAAA;AAC9C,EAAA,IAAI,cAA6B,EAAC,CAAA;AAClC,EAAG,GAAA;AACC,IAAA,MAAM,cAAc,MAAM,SAAA;AAAA,MACtB,CAAC,GAAI,CAAA,QAAA,EAAU,CAAA;AAAA,MACf,OAAQ,CAAA,aAAA;AAAA,MACR,OAAQ,CAAA,WAAA;AAAA,MACR,OAAQ,CAAA,MAAA;AAAA,MACR,OAAQ,CAAA,WAAA;AAAA,MACR,OAAQ,CAAA,aAAA;AAAA,KACZ,CAAA;AAEA,IAAc,WAAA,GAAA,WAAA,CAAY,MAAO,CAAA,WAAA,CAAY,QAAQ,CAAA,CAAA;AACrD,IAAI,IAAA,CAAC,YAAY,OAAS,EAAA;AACtB,MAAA,MAAA;AAAA,KACJ;AAEA,IAAM,GAAA,GAAA,IAAI,GAAI,CAAA,WAAA,CAAY,OAAO,CAAA,CAAA;AAAA,GAE5B,QAAA,CAAA,EAAA;AACT,EAAO,OAAA,WAAA,CAAA;AACX,CAAA;AAuBA,eAAsB,UAClB,OACA,EAAA,aAAA,EACA,aACA,MACA,EAAA,eAAA,EACA,oBAAuC,aACf,EAAA;AACxB,EAAA,MAAM,kBAAsC,GAAA;AAAA,IACxC,OAAS,EAAA,KAAA,CAAA;AAAA,IACT,aAAe,EAAA,KAAA,CAAA;AAAA,IACf,UAAU,EAAC;AAAA,GACf,CAAA;AACA,EAAA,MAAM,kBAAqB,GAAA,OAAA,CAAQ,GAAI,CAAA,OAAO,WAAW,KAAyB,KAAA;AAC9E,IAAM,MAAA,MAAA,GAAS,KAAU,KAAA,OAAA,CAAQ,MAAS,GAAA,CAAA,CAAA;AAE1C,IAAA,MAAM,kBAAkB,MAAM,iBAAA;AAAA,MAC1B,SAAA;AAAA,MACA,aAAA;AAAA,MACA,WAAA;AAAA,MACA,MAAA;AAAA,KACJ,CAAA;AACA,IAAA,eAAA,CAAgB,gBAAgB,QAAyB,CAAA,CAAA;AAEzD,IAAI,GAAA,CAAA,KAAA;AAAA,MACA,uBAAuB,KAAK,CAAA,WAAA,EAAc,MAAM,CAC5C,GAAA,EAAA,eAAA,CAAgB,WAAW,aAC/B,CAAA,CAAA;AAAA,KACJ,CAAA;AACA,IAAA,kBAAA,CAAmB,QAAS,CAAA,IAAA,CAAK,GAAG,eAAA,CAAgB,QAAQ,CAAA,CAAA;AAC5D,IAAA,IAAI,MAAQ,EAAA;AACR,MAAA,kBAAA,CAAmB,gBAAgB,eAAgB,CAAA,aAAA,CAAA;AACnD,MAAA,kBAAA,CAAmB,UAAU,eAAgB,CAAA,OAAA,CAAA;AAAA,KACjD;AAAA,GACH,CAAA,CAAA;AACD,EAAM,MAAA,OAAA,CAAQ,IAAI,kBAAkB,CAAA,CAAA;AACpC,EAAO,OAAA,kBAAA,CAAA;AACX;;;;"}

package/index.d.ts

@@ -1 +1 @@
-export { createVectorSource, type OgcFeatureSourceOptions } from "./OgcFeatureSourceFactory";
+export * from "./api";

package/index.js

@@ -1,2 +1,2 @@
-export { createVectorSource } from './OgcFeatureSourceFactory.js';
+
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,21 +1,65 @@
 {
   "type": "module",
   "name": "@open-pioneer/ogc-features",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "license": "Apache-2.0",
   "peerDependencies": {
-    "@open-pioneer/core": "^1.1.0",
-    "ol": "^8.2.0"
+    "@open-pioneer/core": "^1.2.1",
+    "@open-pioneer/http": "^2.1.1",
+    "ol": "^8.2.0",
+    "uuid": "^9.0.1",
+    "@open-pioneer/search": "^0.2.0"
+  },
+  "peerDependenciesMeta": {
+    "@open-pioneer/search": {
+      "optional": true
+    }
   },
   "exports": {
     "./package.json": "./package.json",
     ".": {
       "import": "./index.js",
       "types": "./index.d.ts"
+    },
+    "./services": {
+      "import": "./services.js",
+      "types": "./services.d.ts"
     }
   },
   "openPioneerFramework": {
-    "services": [],
+    "services": [
+      {
+        "serviceName": "VectorSourceFactory",
+        "provides": [
+          {
+            "interfaceName": "ogc-features.VectorSourceFactory"
+          }
+        ],
+        "references": [
+          {
+            "referenceName": "httpService",
+            "type": "unique",
+            "interfaceName": "http.HttpService"
+          }
+        ]
+      },
+      {
+        "serviceName": "SearchSourceFactory",
+        "provides": [
+          {
+            "interfaceName": "ogc-features.SearchSourceFactory"
+          }
+        ],
+        "references": [
+          {
+            "referenceName": "httpService",
+            "type": "unique",
+            "interfaceName": "http.HttpService"
+          }
+        ]
+      }
+    ],
+    "servicesModule": "./services",
     "i18n": {
       "languages": []
     },

package/requestUtils.d.ts

@@ -1,6 +1,7 @@
 import { Extent } from "ol/extent";
 import FeatureFormat from "ol/format/Feature";
 import { FeatureLike } from "ol/Feature";
+import { HttpService } from "@open-pioneer/http";
 /**
  * Assembles the url to use for fetching features in the given extent.
  */
@@ -19,7 +20,6 @@ export interface FeatureResponse {
     numberMatched: number | undefined;
 }
 /**
- * @internal
  * Performs a single request against the service
  */
-export declare function queryFeatures(fullURL: string, featureFormat: FeatureFormat | undefined, signal: AbortSignal | undefined): Promise<FeatureResponse>;
+export declare function queryFeatures(fullURL: string, featureFormat: FeatureFormat | undefined, httpService: HttpService, signal: AbortSignal | undefined): Promise<FeatureResponse>;

package/requestUtils.js

@@ -25,7 +25,7 @@ function getNextURL(rawLinks) {
     return;
   return nextLinks[0]?.href;
 }
-async function queryFeatures(fullURL, featureFormat, signal) {
+async function queryFeatures(fullURL, featureFormat, httpService, signal) {
   let features = [];
   const requestInit = {
     headers: {
@@ -33,7 +33,7 @@ async function queryFeatures(fullURL, featureFormat, signal) {
     },
     signal
   };
-  const response = await fetch(fullURL, requestInit);
+  const response = await httpService.fetch(fullURL, requestInit);
   if (response.status !== 200) {
     throw new Error(`Failed to query features from service (status code ${response.status})`);
   }

package/requestUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"requestUtils.js","sources":["requestUtils.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport { Extent } from \"ol/extent\";\nimport FeatureFormat from \"ol/format/Feature\";\nimport { FeatureLike } from \"ol/Feature\";\n\nconst NEXT_LINK_PROP = \"next\";\n\n/**\n * Assembles the url to use for fetching features in the given extent.\n */\nexport function createCollectionRequestUrl(\n    collectionItemsURL: string,\n    extent: Extent,\n    crs: string\n): URL {\n    const urlObj = new URL(collectionItemsURL);\n    const searchParams = urlObj.searchParams;\n    searchParams.set(\"bbox\", extent.join(\",\"));\n    searchParams.set(\"bbox-crs\", crs);\n    searchParams.set(\"crs\", crs);\n    searchParams.set(\"f\", \"json\");\n    return urlObj;\n}\n\n/**\n * Adds (or replaces) offset/limit params on the given url.\n */\nexport function createOffsetURL(fullURL: string, offset: number, pageSize: number): string {\n    const url = new URL(fullURL);\n    const searchParams = url.searchParams;\n    searchParams.set(\"offset\", offset.toString());\n    searchParams.set(\"limit\", pageSize.toString());\n    return url.toString();\n}\n\n/**\n * Extracts the `next` link from the service response's `links` property.\n */\nexport function getNextURL(rawLinks: unknown): string | undefined {\n    if (!Array.isArray(rawLinks)) {\n        return undefined;\n    }\n\n    interface ObjWithRelAndHref {\n        href: string;\n        rel: string;\n    }\n\n    // We just assume the correct object shape\n    const links = rawLinks as ObjWithRelAndHref[];\n\n    const nextLinks = links.filter((link) => link.rel === NEXT_LINK_PROP);\n    if (nextLinks.length !== 1) return;\n    return nextLinks[0]?.href;\n}\n\nexport interface FeatureResponse {\n    features: FeatureLike[];\n    nextURL: string | undefined;\n    numberMatched: number | undefined;\n}\n\n/**\n * @internal\n * Performs a single request against the service\n */\nexport async function queryFeatures(\n    fullURL: string,\n    featureFormat: FeatureFormat | undefined,\n    signal: AbortSignal | undefined\n): Promise<FeatureResponse> {\n    let features: FeatureLike[] = [];\n    const requestInit: RequestInit = {\n        headers: {\n            Accept: \"application/geo+json\"\n        },\n        signal\n    };\n    const response = await fetch(fullURL, requestInit);\n    if (response.status !== 200) {\n        throw new Error(`Failed to query features from service (status code ${response.status})`);\n    }\n    const geoJson = await response.json();\n    if (featureFormat) {\n        features = featureFormat.readFeatures(geoJson);\n    }\n    const nextURL = getNextURL(geoJson.links);\n    return {\n        features: features,\n        numberMatched: geoJson.numberMatched,\n        nextURL: nextURL\n    };\n}\n"],"names":[],"mappings":"AAMA,MAAM,cAAiB,GAAA,MAAA,CAAA;AAKP,SAAA,0BAAA,CACZ,kBACA,EAAA,MAAA,EACA,GACG,EAAA;AACH,EAAM,MAAA,MAAA,GAAS,IAAI,GAAA,CAAI,kBAAkB,CAAA,CAAA;AACzC,EAAA,MAAM,eAAe,MAAO,CAAA,YAAA,CAAA;AAC5B,EAAA,YAAA,CAAa,GAAI,CAAA,MAAA,EAAQ,MAAO,CAAA,IAAA,CAAK,GAAG,CAAC,CAAA,CAAA;AACzC,EAAa,YAAA,CAAA,GAAA,CAAI,YAAY,GAAG,CAAA,CAAA;AAChC,EAAa,YAAA,CAAA,GAAA,CAAI,OAAO,GAAG,CAAA,CAAA;AAC3B,EAAa,YAAA,CAAA,GAAA,CAAI,KAAK,MAAM,CAAA,CAAA;AAC5B,EAAO,OAAA,MAAA,CAAA;AACX,CAAA;AAKgB,SAAA,eAAA,CAAgB,OAAiB,EAAA,MAAA,EAAgB,QAA0B,EAAA;AACvF,EAAM,MAAA,GAAA,GAAM,IAAI,GAAA,CAAI,OAAO,CAAA,CAAA;AAC3B,EAAA,MAAM,eAAe,GAAI,CAAA,YAAA,CAAA;AACzB,EAAA,YAAA,CAAa,GAAI,CAAA,QAAA,EAAU,MAAO,CAAA,QAAA,EAAU,CAAA,CAAA;AAC5C,EAAA,YAAA,CAAa,GAAI,CAAA,OAAA,EAAS,QAAS,CAAA,QAAA,EAAU,CAAA,CAAA;AAC7C,EAAA,OAAO,IAAI,QAAS,EAAA,CAAA;AACxB,CAAA;AAKO,SAAS,WAAW,QAAuC,EAAA;AAC9D,EAAA,IAAI,CAAC,KAAA,CAAM,OAAQ,CAAA,QAAQ,CAAG,EAAA;AAC1B,IAAO,OAAA,KAAA,CAAA,CAAA;AAAA,GACX;AAQA,EAAA,MAAM,KAAQ,GAAA,QAAA,CAAA;AAEd,EAAA,MAAM,YAAY,KAAM,CAAA,MAAA,CAAO,CAAC,IAAS,KAAA,IAAA,CAAK,QAAQ,cAAc,CAAA,CAAA;AACpE,EAAA,IAAI,UAAU,MAAW,KAAA,CAAA;AAAG,IAAA,OAAA;AAC5B,EAAO,OAAA,SAAA,CAAU,CAAC,CAAG,EAAA,IAAA,CAAA;AACzB,CAAA;AAYsB,eAAA,aAAA,CAClB,OACA,EAAA,aAAA,EACA,MACwB,EAAA;AACxB,EAAA,IAAI,WAA0B,EAAC,CAAA;AAC/B,EAAA,MAAM,WAA2B,GAAA;AAAA,IAC7B,OAAS,EAAA;AAAA,MACL,MAAQ,EAAA,sBAAA;AAAA,KACZ;AAAA,IACA,MAAA;AAAA,GACJ,CAAA;AACA,EAAA,MAAM,QAAW,GAAA,MAAM,KAAM,CAAA,OAAA,EAAS,WAAW,CAAA,CAAA;AACjD,EAAI,IAAA,QAAA,CAAS,WAAW,GAAK,EAAA;AACzB,IAAA,MAAM,IAAI,KAAA,CAAM,CAAsD,mDAAA,EAAA,QAAA,CAAS,MAAM,CAAG,CAAA,CAAA,CAAA,CAAA;AAAA,GAC5F;AACA,EAAM,MAAA,OAAA,GAAU,MAAM,QAAA,CAAS,IAAK,EAAA,CAAA;AACpC,EAAA,IAAI,aAAe,EAAA;AACf,IAAW,QAAA,GAAA,aAAA,CAAc,aAAa,OAAO,CAAA,CAAA;AAAA,GACjD;AACA,EAAM,MAAA,OAAA,GAAU,UAAW,CAAA,OAAA,CAAQ,KAAK,CAAA,CAAA;AACxC,EAAO,OAAA;AAAA,IACH,QAAA;AAAA,IACA,eAAe,OAAQ,CAAA,aAAA;AAAA,IACvB,OAAA;AAAA,GACJ,CAAA;AACJ;;;;"}
+{"version":3,"file":"requestUtils.js","sources":["requestUtils.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport { Extent } from \"ol/extent\";\nimport FeatureFormat from \"ol/format/Feature\";\nimport { FeatureLike } from \"ol/Feature\";\nimport { HttpService } from \"@open-pioneer/http\";\n\nconst NEXT_LINK_PROP = \"next\";\n\n/**\n * Assembles the url to use for fetching features in the given extent.\n */\nexport function createCollectionRequestUrl(\n    collectionItemsURL: string,\n    extent: Extent,\n    crs: string\n): URL {\n    const urlObj = new URL(collectionItemsURL);\n    const searchParams = urlObj.searchParams;\n    searchParams.set(\"bbox\", extent.join(\",\"));\n    searchParams.set(\"bbox-crs\", crs);\n    searchParams.set(\"crs\", crs);\n    searchParams.set(\"f\", \"json\");\n    return urlObj;\n}\n\n/**\n * Adds (or replaces) offset/limit params on the given url.\n */\nexport function createOffsetURL(fullURL: string, offset: number, pageSize: number): string {\n    const url = new URL(fullURL);\n    const searchParams = url.searchParams;\n    searchParams.set(\"offset\", offset.toString());\n    searchParams.set(\"limit\", pageSize.toString());\n    return url.toString();\n}\n\n/**\n * Extracts the `next` link from the service response's `links` property.\n */\nexport function getNextURL(rawLinks: unknown): string | undefined {\n    if (!Array.isArray(rawLinks)) {\n        return undefined;\n    }\n\n    interface ObjWithRelAndHref {\n        href: string;\n        rel: string;\n    }\n\n    // We just assume the correct object shape\n    const links = rawLinks as ObjWithRelAndHref[];\n\n    const nextLinks = links.filter((link) => link.rel === NEXT_LINK_PROP);\n    if (nextLinks.length !== 1) return;\n    return nextLinks[0]?.href;\n}\n\nexport interface FeatureResponse {\n    features: FeatureLike[];\n    nextURL: string | undefined;\n    numberMatched: number | undefined;\n}\n\n/**\n * Performs a single request against the service\n */\nexport async function queryFeatures(\n    fullURL: string,\n    featureFormat: FeatureFormat | undefined,\n    httpService: HttpService,\n    signal: AbortSignal | undefined\n): Promise<FeatureResponse> {\n    let features: FeatureLike[] = [];\n    const requestInit: RequestInit = {\n        headers: {\n            Accept: \"application/geo+json\"\n        },\n        signal\n    };\n    const response = await httpService.fetch(fullURL, requestInit);\n    if (response.status !== 200) {\n        throw new Error(`Failed to query features from service (status code ${response.status})`);\n    }\n    const geoJson = await response.json();\n    if (featureFormat) {\n        features = featureFormat.readFeatures(geoJson);\n    }\n    const nextURL = getNextURL(geoJson.links);\n    return {\n        features: features,\n        numberMatched: geoJson.numberMatched,\n        nextURL: nextURL\n    };\n}\n"],"names":[],"mappings":"AAOA,MAAM,cAAiB,GAAA,MAAA,CAAA;AAKP,SAAA,0BAAA,CACZ,kBACA,EAAA,MAAA,EACA,GACG,EAAA;AACH,EAAM,MAAA,MAAA,GAAS,IAAI,GAAA,CAAI,kBAAkB,CAAA,CAAA;AACzC,EAAA,MAAM,eAAe,MAAO,CAAA,YAAA,CAAA;AAC5B,EAAA,YAAA,CAAa,GAAI,CAAA,MAAA,EAAQ,MAAO,CAAA,IAAA,CAAK,GAAG,CAAC,CAAA,CAAA;AACzC,EAAa,YAAA,CAAA,GAAA,CAAI,YAAY,GAAG,CAAA,CAAA;AAChC,EAAa,YAAA,CAAA,GAAA,CAAI,OAAO,GAAG,CAAA,CAAA;AAC3B,EAAa,YAAA,CAAA,GAAA,CAAI,KAAK,MAAM,CAAA,CAAA;AAC5B,EAAO,OAAA,MAAA,CAAA;AACX,CAAA;AAKgB,SAAA,eAAA,CAAgB,OAAiB,EAAA,MAAA,EAAgB,QAA0B,EAAA;AACvF,EAAM,MAAA,GAAA,GAAM,IAAI,GAAA,CAAI,OAAO,CAAA,CAAA;AAC3B,EAAA,MAAM,eAAe,GAAI,CAAA,YAAA,CAAA;AACzB,EAAA,YAAA,CAAa,GAAI,CAAA,QAAA,EAAU,MAAO,CAAA,QAAA,EAAU,CAAA,CAAA;AAC5C,EAAA,YAAA,CAAa,GAAI,CAAA,OAAA,EAAS,QAAS,CAAA,QAAA,EAAU,CAAA,CAAA;AAC7C,EAAA,OAAO,IAAI,QAAS,EAAA,CAAA;AACxB,CAAA;AAKO,SAAS,WAAW,QAAuC,EAAA;AAC9D,EAAA,IAAI,CAAC,KAAA,CAAM,OAAQ,CAAA,QAAQ,CAAG,EAAA;AAC1B,IAAO,OAAA,KAAA,CAAA,CAAA;AAAA,GACX;AAQA,EAAA,MAAM,KAAQ,GAAA,QAAA,CAAA;AAEd,EAAA,MAAM,YAAY,KAAM,CAAA,MAAA,CAAO,CAAC,IAAS,KAAA,IAAA,CAAK,QAAQ,cAAc,CAAA,CAAA;AACpE,EAAA,IAAI,UAAU,MAAW,KAAA,CAAA;AAAG,IAAA,OAAA;AAC5B,EAAO,OAAA,SAAA,CAAU,CAAC,CAAG,EAAA,IAAA,CAAA;AACzB,CAAA;AAWA,eAAsB,aAClB,CAAA,OAAA,EACA,aACA,EAAA,WAAA,EACA,MACwB,EAAA;AACxB,EAAA,IAAI,WAA0B,EAAC,CAAA;AAC/B,EAAA,MAAM,WAA2B,GAAA;AAAA,IAC7B,OAAS,EAAA;AAAA,MACL,MAAQ,EAAA,sBAAA;AAAA,KACZ;AAAA,IACA,MAAA;AAAA,GACJ,CAAA;AACA,EAAA,MAAM,QAAW,GAAA,MAAM,WAAY,CAAA,KAAA,CAAM,SAAS,WAAW,CAAA,CAAA;AAC7D,EAAI,IAAA,QAAA,CAAS,WAAW,GAAK,EAAA;AACzB,IAAA,MAAM,IAAI,KAAA,CAAM,CAAsD,mDAAA,EAAA,QAAA,CAAS,MAAM,CAAG,CAAA,CAAA,CAAA,CAAA;AAAA,GAC5F;AACA,EAAM,MAAA,OAAA,GAAU,MAAM,QAAA,CAAS,IAAK,EAAA,CAAA;AACpC,EAAA,IAAI,aAAe,EAAA;AACf,IAAW,QAAA,GAAA,aAAA,CAAc,aAAa,OAAO,CAAA,CAAA;AAAA,GACjD;AACA,EAAM,MAAA,OAAA,GAAU,UAAW,CAAA,OAAA,CAAQ,KAAK,CAAA,CAAA;AACxC,EAAO,OAAA;AAAA,IACH,QAAA;AAAA,IACA,eAAe,OAAQ,CAAA,aAAA;AAAA,IACvB,OAAA;AAAA,GACJ,CAAA;AACJ;;;;"}

package/services.d.ts

@@ -0,0 +1,21 @@
+import { Feature } from "ol";
+import { Geometry } from "ol/geom";
+import VectorSource from "ol/source/Vector";
+import { OgcFeatureSearchSourceOptions, OgcFeatureVectorSourceOptions, OgcFeaturesSearchSourceFactory, OgcFeaturesVectorSourceFactory } from "./api";
+import { SearchSource } from "@open-pioneer/search";
+import { HttpService } from "@open-pioneer/http";
+import { ServiceOptions } from "@open-pioneer/runtime";
+interface References {
+    httpService: HttpService;
+}
+export declare class VectorSourceFactory implements OgcFeaturesVectorSourceFactory {
+    #private;
+    constructor({ references }: ServiceOptions<References>);
+    createVectorSource(options: OgcFeatureVectorSourceOptions): VectorSource<Feature<Geometry>>;
+}
+export declare class SearchSourceFactory implements OgcFeaturesSearchSourceFactory {
+    #private;
+    constructor({ references }: ServiceOptions<References>);
+    createSearchSource(options: OgcFeatureSearchSourceOptions): SearchSource;
+}
+export {};

package/services.js

@@ -0,0 +1,24 @@
+import { createVectorSource } from './createVectorSource.js';
+import { OgcFeatureSearchSource } from './OgcFeatureSearchSource.js';
+
+class VectorSourceFactory {
+  #httpService;
+  constructor({ references }) {
+    this.#httpService = references.httpService;
+  }
+  createVectorSource(options) {
+    return createVectorSource(options, this.#httpService);
+  }
+}
+class SearchSourceFactory {
+  #httpService;
+  constructor({ references }) {
+    this.#httpService = references.httpService;
+  }
+  createSearchSource(options) {
+    return new OgcFeatureSearchSource(options, this.#httpService);
+  }
+}
+
+export { SearchSourceFactory, VectorSourceFactory };
+//# sourceMappingURL=services.js.map

package/services.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"services.js","sources":["services.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport { Feature } from \"ol\";\nimport { Geometry } from \"ol/geom\";\nimport VectorSource from \"ol/source/Vector\";\nimport {\n    OgcFeatureSearchSourceOptions,\n    OgcFeatureVectorSourceOptions,\n    OgcFeaturesSearchSourceFactory,\n    OgcFeaturesVectorSourceFactory\n} from \"./api\";\nimport { SearchSource } from \"@open-pioneer/search\";\nimport { createVectorSource } from \"./createVectorSource\";\nimport { OgcFeatureSearchSource } from \"./OgcFeatureSearchSource\";\nimport { HttpService } from \"@open-pioneer/http\";\nimport { ServiceOptions } from \"@open-pioneer/runtime\";\n\n// Both services share the same dependencies for now\ninterface References {\n    httpService: HttpService;\n}\n\nexport class VectorSourceFactory implements OgcFeaturesVectorSourceFactory {\n    #httpService: HttpService;\n\n    constructor({ references }: ServiceOptions<References>) {\n        this.#httpService = references.httpService;\n    }\n\n    createVectorSource(options: OgcFeatureVectorSourceOptions): VectorSource<Feature<Geometry>> {\n        return createVectorSource(options, this.#httpService);\n    }\n}\n\nexport class SearchSourceFactory implements OgcFeaturesSearchSourceFactory {\n    #httpService: HttpService;\n\n    constructor({ references }: ServiceOptions<References>) {\n        this.#httpService = references.httpService;\n    }\n\n    createSearchSource(options: OgcFeatureSearchSourceOptions): SearchSource {\n        return new OgcFeatureSearchSource(options, this.#httpService);\n    }\n}\n"],"names":[],"mappings":";;;AAsBO,MAAM,mBAA8D,CAAA;AAAA,EACvE,YAAA,CAAA;AAAA,EAEA,WAAA,CAAY,EAAE,UAAA,EAA0C,EAAA;AACpD,IAAA,IAAA,CAAK,eAAe,UAAW,CAAA,WAAA,CAAA;AAAA,GACnC;AAAA,EAEA,mBAAmB,OAAyE,EAAA;AACxF,IAAO,OAAA,kBAAA,CAAmB,OAAS,EAAA,IAAA,CAAK,YAAY,CAAA,CAAA;AAAA,GACxD;AACJ,CAAA;AAEO,MAAM,mBAA8D,CAAA;AAAA,EACvE,YAAA,CAAA;AAAA,EAEA,WAAA,CAAY,EAAE,UAAA,EAA0C,EAAA;AACpD,IAAA,IAAA,CAAK,eAAe,UAAW,CAAA,WAAA,CAAA;AAAA,GACnC;AAAA,EAEA,mBAAmB,OAAsD,EAAA;AACrE,IAAA,OAAO,IAAI,sBAAA,CAAuB,OAAS,EAAA,IAAA,CAAK,YAAY,CAAA,CAAA;AAAA,GAChE;AACJ;;;;"}

package/OgcFeatureSourceFactory.d.ts

@@ -1,77 +0,0 @@
-import Feature, { FeatureLike } from "ol/Feature";
-import FeatureFormat from "ol/format/Feature";
-import { Geometry } from "ol/geom";
-import { AttributionLike } from "ol/source/Source";
-import VectorSource, { Options } from "ol/source/Vector";
-import { CollectionInfos, getCollectionInfos } from "./OffsetStrategy";
-import { FeatureResponse, queryFeatures } from "./requestUtils";
-export interface OgcFeatureSourceOptions {
-    /** The base-URL right to the "/collections"-part */
-    baseUrl: string;
-    /** The collection-ID */
-    collectionId: string;
-    /** the URL to the EPSG-Code, e.g. http://www.opengis.net/def/crs/EPSG/0/25832 */
-    crs: string;
-    /**
-     * The maximum number of features to fetch within a single request.
-     * Corresponds to the `limit` parameter in the URL.
-     *
-     * When the `offset` strategy is used for feature fetching, the limit
-     * is used for the page size
-     *
-     * Default limit is 5000 for Next-Strategy and 2500 for Offset-Strategy
-     */
-    limit?: number;
-    /** The maximum number of concurrent requests. Defaults to `6`. */
-    maxConcurrentRequests?: number;
-    /** Optional attribution for the layer (e.g. copyright hints). */
-    attributions?: AttributionLike | undefined;
-    /** Optional additional options for the VectorSource. */
-    additionalOptions?: Options<Feature<Geometry>>;
-}
-/**
- * This function creates an OpenLayers VectorSource for OGC Features API services to be used inside
- * an OpenLayers VectorLayer.
- *
- * @param options Options for the vector source.
- */
-export declare function createVectorSource(options: OgcFeatureSourceOptions): VectorSource;
-/**
- * @internal
- * Creates the actual vector source.
- * Exported for testing.
- * Exposes `queryFeatures`, `addFeatures` and `getCollectionInfos` for easier testing.
- */
-export declare function _createVectorSource(options: OgcFeatureSourceOptions, queryFeaturesParam: QueryFeaturesFunc | undefined, addFeaturesParam: AddFeaturesFunc | undefined, getCollectionInfosParam: GetCollectionInfosFunc | undefined): VectorSource;
-/** @internal **/
-type QueryFeaturesFunc = typeof queryFeatures;
-/** @internal **/
-type GetCollectionInfosFunc = typeof getCollectionInfos;
-/** @internal **/
-type AddFeaturesFunc = (features: FeatureLike[]) => void;
-/** @internal **/
-export interface LoadFeatureOptions {
-    fullURL: string;
-    featureFormat: FeatureFormat;
-    queryFeatures: QueryFeaturesFunc;
-    addFeatures: AddFeaturesFunc;
-    limit: number;
-    maxConcurrentRequests: number;
-    signal?: AbortSignal;
-    collectionInfos?: CollectionInfos;
-}
-/**
- * @internal
- * Fetches features by following the `next` links in the server's response.
- */
-export declare function loadAllFeaturesNextStrategy(options: Omit<LoadFeatureOptions, "offsetRequestProps" | "collectionInfos">): Promise<FeatureLike[]>;
-export declare function loadFeatures(requestUrl: string, featureFormat: FeatureFormat, signal: AbortSignal | undefined, addFeaturesFunc: AddFeaturesFunc, queryFeaturesFunc?: QueryFeaturesFunc): Promise<FeatureResponse>;
-/**
- * Loads features from multiple urls in parallel.
- * The URLs should represent pages of the same result set.
- * The `nextURL` of the last page (if any) is returned from this function.
- *
- * @internal
- */
-export declare function loadPages(allUrls: Array<string>, featureFormat: FeatureFormat, signal: AbortSignal | undefined, addFeaturesFunc: AddFeaturesFunc, queryFeaturesFunc?: QueryFeaturesFunc): Promise<FeatureResponse>;
-export {};

package/OgcFeatureSourceFactory.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"OgcFeatureSourceFactory.js","sources":["OgcFeatureSourceFactory.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport { createLogger, isAbortError } from \"@open-pioneer/core\";\nimport Feature, { FeatureLike } from \"ol/Feature\";\nimport { FeatureLoader } from \"ol/featureloader\";\nimport FeatureFormat from \"ol/format/Feature\";\nimport GeoJSON from \"ol/format/GeoJSON\";\nimport { Geometry } from \"ol/geom\";\nimport { bbox } from \"ol/loadingstrategy\";\nimport { AttributionLike } from \"ol/source/Source\";\nimport VectorSource, { Options } from \"ol/source/Vector\";\nimport { CollectionInfos, getCollectionInfos, loadAllFeaturesWithOffset } from \"./OffsetStrategy\";\nimport { FeatureResponse, createCollectionRequestUrl, queryFeatures } from \"./requestUtils\";\n\nconst LOG = createLogger(\"ogc-features:OgcFeatureSourceFactory\");\nconst DEFAULT_LIMIT = 5000;\nconst DEFAULT_CONCURRENTY = 6;\n\nexport interface OgcFeatureSourceOptions {\n    /** The base-URL right to the \"/collections\"-part */\n    baseUrl: string;\n\n    /** The collection-ID */\n    collectionId: string;\n\n    /** the URL to the EPSG-Code, e.g. http://www.opengis.net/def/crs/EPSG/0/25832 */\n    crs: string;\n\n    /**\n     * The maximum number of features to fetch within a single request.\n     * Corresponds to the `limit` parameter in the URL.\n     *\n     * When the `offset` strategy is used for feature fetching, the limit\n     * is used for the page size\n     *\n     * Default limit is 5000 for Next-Strategy and 2500 for Offset-Strategy\n     */\n    limit?: number;\n\n    /** The maximum number of concurrent requests. Defaults to `6`. */\n    maxConcurrentRequests?: number;\n\n    /** Optional attribution for the layer (e.g. copyright hints). */\n    attributions?: AttributionLike | undefined;\n\n    /** Optional additional options for the VectorSource. */\n    additionalOptions?: Options<Feature<Geometry>>;\n}\n\n/**\n * This function creates an OpenLayers VectorSource for OGC Features API services to be used inside\n * an OpenLayers VectorLayer.\n *\n * @param options Options for the vector source.\n */\nexport function createVectorSource(options: OgcFeatureSourceOptions): VectorSource {\n    return _createVectorSource(options, undefined, undefined, undefined);\n}\n\n/**\n * @internal\n * Creates the actual vector source.\n * Exported for testing.\n * Exposes `queryFeatures`, `addFeatures` and `getCollectionInfos` for easier testing.\n */\nexport function _createVectorSource(\n    options: OgcFeatureSourceOptions,\n    queryFeaturesParam: QueryFeaturesFunc | undefined,\n    addFeaturesParam: AddFeaturesFunc | undefined,\n    getCollectionInfosParam: GetCollectionInfosFunc | undefined\n): VectorSource {\n    const collectionItemsURL = `${options.baseUrl}/collections/${options.collectionId}/items?`;\n    const vectorSrc = new VectorSource({\n        format: new GeoJSON(),\n        strategy: bbox,\n        attributions: options.attributions,\n        ...options.additionalOptions\n    });\n\n    const queryFeaturesFunc = queryFeaturesParam ?? queryFeatures;\n    const getCollectionInfosFunc = getCollectionInfosParam ?? getCollectionInfos;\n    const addFeaturesFunc =\n        addFeaturesParam ||\n        function (features: FeatureLike[]) {\n            LOG.debug(`Adding ${features.length} features`);\n\n            // Type mismatch FeatureLike <--> Feature<Geometry>\n            // MIGHT be incorrect! We will see.\n            // eslint-disable-next-line @typescript-eslint/no-explicit-any\n            vectorSrc.addFeatures(features as any);\n        };\n\n    // Abort controller for the currently pending request(s).\n    // Used to cancel outdated requests.\n    let abortController: AbortController;\n    let collectionInfosPromise: Promise<CollectionInfos | undefined> | undefined;\n\n    const loaderFunction: FeatureLoader = async (\n        extent,\n        _,\n        __,\n        success,\n        failure\n    ): Promise<void> => {\n        collectionInfosPromise ??= getCollectionInfosFunc(collectionItemsURL);\n        let collectionInfos;\n        try {\n            collectionInfos = await collectionInfosPromise;\n        } catch (e) {\n            LOG.error(\"Failed to retrieve collection information\", e);\n            failure?.();\n            collectionInfosPromise = undefined;\n            return;\n        }\n\n        // An extent-change should cancel open requests for older extents, because otherwise,\n        // old and expensive requests could block new requests for a new extent\n        // => no features are drawn on the current map for a long time.\n        abortController?.abort(\"Extent changed\");\n        abortController = new AbortController();\n\n        const fullURL = createCollectionRequestUrl(collectionItemsURL, extent, options.crs);\n        const strategy = collectionInfos?.supportsOffsetStrategy ? \"offset\" : \"next\";\n        try {\n            const features = await loadAllFeatures(strategy, {\n                fullURL: fullURL.toString(),\n                featureFormat: vectorSrc.getFormat()!, // TODO\n                queryFeatures: queryFeaturesFunc,\n                addFeatures: addFeaturesFunc,\n                limit: options.limit ?? DEFAULT_LIMIT,\n                maxConcurrentRequests: options.maxConcurrentRequests ?? DEFAULT_CONCURRENTY,\n                signal: abortController.signal,\n                collectionInfos: collectionInfos\n            });\n            // Type mismatch FeatureLike <--> Feature<Geometry>\n            // MIGHT be incorrect! We will see.\n            // eslint-disable-next-line @typescript-eslint/no-explicit-any\n            success?.(features as any);\n            LOG.debug(\"Finished loading features for extent:\", extent);\n        } catch (e) {\n            if (!isAbortError(e)) {\n                LOG.error(\"Failed to load features\", e);\n            } else {\n                LOG.debug(\"Query-Feature-Request aborted\", e);\n                vectorSrc.removeLoadedExtent(extent);\n                failure?.();\n            }\n        }\n    };\n    vectorSrc.setLoader(loaderFunction);\n    return vectorSrc;\n}\n\n/** @internal **/\ntype QueryFeaturesFunc = typeof queryFeatures;\n/** @internal **/\ntype GetCollectionInfosFunc = typeof getCollectionInfos;\n/** @internal **/\ntype AddFeaturesFunc = (features: FeatureLike[]) => void;\n\n/** @internal **/\nexport interface LoadFeatureOptions {\n    fullURL: string;\n    featureFormat: FeatureFormat;\n    queryFeatures: QueryFeaturesFunc;\n    addFeatures: AddFeaturesFunc;\n    limit: number;\n    maxConcurrentRequests: number;\n    signal?: AbortSignal;\n    collectionInfos?: CollectionInfos;\n}\n\n/**\n * @internal\n * Fetches _all_ features according to the given strategy.\n */\nfunction loadAllFeatures(\n    strategy: \"next\" | \"offset\",\n    options: LoadFeatureOptions\n): Promise<FeatureLike[]> {\n    switch (strategy) {\n        case \"next\":\n            return loadAllFeaturesNextStrategy(options);\n        case \"offset\":\n            return loadAllFeaturesWithOffset(options);\n    }\n}\n\n/**\n * @internal\n * Fetches features by following the `next` links in the server's response.\n */\nexport async function loadAllFeaturesNextStrategy(\n    options: Omit<LoadFeatureOptions, \"offsetRequestProps\" | \"collectionInfos\">\n): Promise<FeatureLike[]> {\n    const limit = options.limit;\n\n    let url = new URL(options.fullURL);\n    url.searchParams.set(\"limit\", limit.toString());\n    let allFeatures: FeatureLike[] = [];\n    do {\n        const featureResp = await loadPages(\n            [url.toString()],\n            options.featureFormat,\n            options.signal,\n            options.addFeatures,\n            options.queryFeatures\n        );\n\n        allFeatures = allFeatures.concat(featureResp.features);\n        if (!featureResp.nextURL) {\n            break;\n        }\n\n        url = new URL(featureResp.nextURL);\n        // eslint-disable-next-line no-constant-condition\n    } while (1);\n    return allFeatures;\n}\n\nexport async function loadFeatures(\n    requestUrl: string,\n    featureFormat: FeatureFormat,\n    signal: AbortSignal | undefined,\n    addFeaturesFunc: AddFeaturesFunc,\n    queryFeaturesFunc: QueryFeaturesFunc = queryFeatures\n): Promise<FeatureResponse> {\n    const featureResponse = await queryFeaturesFunc(requestUrl, featureFormat, signal);\n    const features = featureResponse.features as FeatureLike[];\n    addFeaturesFunc(features);\n    return featureResponse;\n}\n\n/**\n * Loads features from multiple urls in parallel.\n * The URLs should represent pages of the same result set.\n * The `nextURL` of the last page (if any) is returned from this function.\n *\n * @internal\n */\nexport async function loadPages(\n    allUrls: Array<string>,\n    featureFormat: FeatureFormat,\n    signal: AbortSignal | undefined,\n    addFeaturesFunc: AddFeaturesFunc,\n    queryFeaturesFunc: QueryFeaturesFunc = queryFeatures\n): Promise<FeatureResponse> {\n    const allFeatureResponse: FeatureResponse = {\n        nextURL: undefined,\n        numberMatched: undefined,\n        features: []\n    };\n    const allRequestPromises = allUrls.map(async (singleUrl, index): Promise<void> => {\n        const isLast = index === allUrls.length - 1;\n\n        const featureResponse = await queryFeaturesFunc(singleUrl, featureFormat, signal);\n        addFeaturesFunc(featureResponse.features as FeatureLike[]);\n\n        LOG.debug(\n            `NextURL for index = ${index} (isLast = ${isLast}): ${\n                featureResponse.nextURL || \"No Next URL\"\n            }`\n        );\n        allFeatureResponse.features.push(...featureResponse.features);\n        if (isLast) {\n            allFeatureResponse.numberMatched = featureResponse.numberMatched;\n            allFeatureResponse.nextURL = featureResponse.nextURL;\n        }\n    });\n    await Promise.all(allRequestPromises);\n    return allFeatureResponse;\n}\n"],"names":[],"mappings":";;;;;;;AAcA,MAAM,GAAA,GAAM,aAAa,sCAAsC,CAAA,CAAA;AAC/D,MAAM,aAAgB,GAAA,GAAA,CAAA;AACtB,MAAM,mBAAsB,GAAA,CAAA,CAAA;AAuCrB,SAAS,mBAAmB,OAAgD,EAAA;AAC/E,EAAA,OAAO,mBAAoB,CAAA,OAAA,EAAS,KAAW,CAAA,EAAA,KAAA,CAAA,EAAW,KAAS,CAAA,CAAA,CAAA;AACvE,CAAA;AAQO,SAAS,mBACZ,CAAA,OAAA,EACA,kBACA,EAAA,gBAAA,EACA,uBACY,EAAA;AACZ,EAAA,MAAM,qBAAqB,CAAG,EAAA,OAAA,CAAQ,OAAO,CAAA,aAAA,EAAgB,QAAQ,YAAY,CAAA,OAAA,CAAA,CAAA;AACjF,EAAM,MAAA,SAAA,GAAY,IAAI,YAAa,CAAA;AAAA,IAC/B,MAAA,EAAQ,IAAI,OAAQ,EAAA;AAAA,IACpB,QAAU,EAAA,IAAA;AAAA,IACV,cAAc,OAAQ,CAAA,YAAA;AAAA,IACtB,GAAG,OAAQ,CAAA,iBAAA;AAAA,GACd,CAAA,CAAA;AAED,EAAA,MAAM,oBAAoB,kBAAsB,IAAA,aAAA,CAAA;AAChD,EAAA,MAAM,yBAAyB,uBAA2B,IAAA,kBAAA,CAAA;AAC1D,EAAM,MAAA,eAAA,GACF,gBACA,IAAA,SAAU,QAAyB,EAAA;AAC/B,IAAA,GAAA,CAAI,KAAM,CAAA,CAAA,OAAA,EAAU,QAAS,CAAA,MAAM,CAAW,SAAA,CAAA,CAAA,CAAA;AAK9C,IAAA,SAAA,CAAU,YAAY,QAAe,CAAA,CAAA;AAAA,GACzC,CAAA;AAIJ,EAAI,IAAA,eAAA,CAAA;AACJ,EAAI,IAAA,sBAAA,CAAA;AAEJ,EAAA,MAAM,iBAAgC,OAClC,MAAA,EACA,CACA,EAAA,EAAA,EACA,SACA,OACgB,KAAA;AAChB,IAAA,sBAAA,KAA2B,uBAAuB,kBAAkB,CAAA,CAAA;AACpE,IAAI,IAAA,eAAA,CAAA;AACJ,IAAI,IAAA;AACA,MAAA,eAAA,GAAkB,MAAM,sBAAA,CAAA;AAAA,aACnB,CAAG,EAAA;AACR,MAAI,GAAA,CAAA,KAAA,CAAM,6CAA6C,CAAC,CAAA,CAAA;AACxD,MAAU,OAAA,IAAA,CAAA;AACV,MAAyB,sBAAA,GAAA,KAAA,CAAA,CAAA;AACzB,MAAA,OAAA;AAAA,KACJ;AAKA,IAAA,eAAA,EAAiB,MAAM,gBAAgB,CAAA,CAAA;AACvC,IAAA,eAAA,GAAkB,IAAI,eAAgB,EAAA,CAAA;AAEtC,IAAA,MAAM,OAAU,GAAA,0BAAA,CAA2B,kBAAoB,EAAA,MAAA,EAAQ,QAAQ,GAAG,CAAA,CAAA;AAClF,IAAM,MAAA,QAAA,GAAW,eAAiB,EAAA,sBAAA,GAAyB,QAAW,GAAA,MAAA,CAAA;AACtE,IAAI,IAAA;AACA,MAAM,MAAA,QAAA,GAAW,MAAM,eAAA,CAAgB,QAAU,EAAA;AAAA,QAC7C,OAAA,EAAS,QAAQ,QAAS,EAAA;AAAA,QAC1B,aAAA,EAAe,UAAU,SAAU,EAAA;AAAA;AAAA,QACnC,aAAe,EAAA,iBAAA;AAAA,QACf,WAAa,EAAA,eAAA;AAAA,QACb,KAAA,EAAO,QAAQ,KAAS,IAAA,aAAA;AAAA,QACxB,qBAAA,EAAuB,QAAQ,qBAAyB,IAAA,mBAAA;AAAA,QACxD,QAAQ,eAAgB,CAAA,MAAA;AAAA,QACxB,eAAA;AAAA,OACH,CAAA,CAAA;AAID,MAAA,OAAA,GAAU,QAAe,CAAA,CAAA;AACzB,MAAI,GAAA,CAAA,KAAA,CAAM,yCAAyC,MAAM,CAAA,CAAA;AAAA,aACpD,CAAG,EAAA;AACR,MAAI,IAAA,CAAC,YAAa,CAAA,CAAC,CAAG,EAAA;AAClB,QAAI,GAAA,CAAA,KAAA,CAAM,2BAA2B,CAAC,CAAA,CAAA;AAAA,OACnC,MAAA;AACH,QAAI,GAAA,CAAA,KAAA,CAAM,iCAAiC,CAAC,CAAA,CAAA;AAC5C,QAAA,SAAA,CAAU,mBAAmB,MAAM,CAAA,CAAA;AACnC,QAAU,OAAA,IAAA,CAAA;AAAA,OACd;AAAA,KACJ;AAAA,GACJ,CAAA;AACA,EAAA,SAAA,CAAU,UAAU,cAAc,CAAA,CAAA;AAClC,EAAO,OAAA,SAAA,CAAA;AACX,CAAA;AAyBA,SAAS,eAAA,CACL,UACA,OACsB,EAAA;AACtB,EAAA,QAAQ,QAAU;AAAA,IACd,KAAK,MAAA;AACD,MAAA,OAAO,4BAA4B,OAAO,CAAA,CAAA;AAAA,IAC9C,KAAK,QAAA;AACD,MAAA,OAAO,0BAA0B,OAAO,CAAA,CAAA;AAAA,GAChD;AACJ,CAAA;AAMA,eAAsB,4BAClB,OACsB,EAAA;AACtB,EAAA,MAAM,QAAQ,OAAQ,CAAA,KAAA,CAAA;AAEtB,EAAA,IAAI,GAAM,GAAA,IAAI,GAAI,CAAA,OAAA,CAAQ,OAAO,CAAA,CAAA;AACjC,EAAA,GAAA,CAAI,YAAa,CAAA,GAAA,CAAI,OAAS,EAAA,KAAA,CAAM,UAAU,CAAA,CAAA;AAC9C,EAAA,IAAI,cAA6B,EAAC,CAAA;AAClC,EAAG,GAAA;AACC,IAAA,MAAM,cAAc,MAAM,SAAA;AAAA,MACtB,CAAC,GAAI,CAAA,QAAA,EAAU,CAAA;AAAA,MACf,OAAQ,CAAA,aAAA;AAAA,MACR,OAAQ,CAAA,MAAA;AAAA,MACR,OAAQ,CAAA,WAAA;AAAA,MACR,OAAQ,CAAA,aAAA;AAAA,KACZ,CAAA;AAEA,IAAc,WAAA,GAAA,WAAA,CAAY,MAAO,CAAA,WAAA,CAAY,QAAQ,CAAA,CAAA;AACrD,IAAI,IAAA,CAAC,YAAY,OAAS,EAAA;AACtB,MAAA,MAAA;AAAA,KACJ;AAEA,IAAM,GAAA,GAAA,IAAI,GAAI,CAAA,WAAA,CAAY,OAAO,CAAA,CAAA;AAAA,GAE5B,QAAA,CAAA,EAAA;AACT,EAAO,OAAA,WAAA,CAAA;AACX,CAAA;AAsBA,eAAsB,UAClB,OACA,EAAA,aAAA,EACA,MACA,EAAA,eAAA,EACA,oBAAuC,aACf,EAAA;AACxB,EAAA,MAAM,kBAAsC,GAAA;AAAA,IACxC,OAAS,EAAA,KAAA,CAAA;AAAA,IACT,aAAe,EAAA,KAAA,CAAA;AAAA,IACf,UAAU,EAAC;AAAA,GACf,CAAA;AACA,EAAA,MAAM,kBAAqB,GAAA,OAAA,CAAQ,GAAI,CAAA,OAAO,WAAW,KAAyB,KAAA;AAC9E,IAAM,MAAA,MAAA,GAAS,KAAU,KAAA,OAAA,CAAQ,MAAS,GAAA,CAAA,CAAA;AAE1C,IAAA,MAAM,eAAkB,GAAA,MAAM,iBAAkB,CAAA,SAAA,EAAW,eAAe,MAAM,CAAA,CAAA;AAChF,IAAA,eAAA,CAAgB,gBAAgB,QAAyB,CAAA,CAAA;AAEzD,IAAI,GAAA,CAAA,KAAA;AAAA,MACA,uBAAuB,KAAK,CAAA,WAAA,EAAc,MAAM,CAC5C,GAAA,EAAA,eAAA,CAAgB,WAAW,aAC/B,CAAA,CAAA;AAAA,KACJ,CAAA;AACA,IAAA,kBAAA,CAAmB,QAAS,CAAA,IAAA,CAAK,GAAG,eAAA,CAAgB,QAAQ,CAAA,CAAA;AAC5D,IAAA,IAAI,MAAQ,EAAA;AACR,MAAA,kBAAA,CAAmB,gBAAgB,eAAgB,CAAA,aAAA,CAAA;AACnD,MAAA,kBAAA,CAAmB,UAAU,eAAgB,CAAA,OAAA,CAAA;AAAA,KACjD;AAAA,GACH,CAAA,CAAA;AACD,EAAM,MAAA,OAAA,CAAQ,IAAI,kBAAkB,CAAA,CAAA;AACpC,EAAO,OAAA,kBAAA,CAAA;AACX;;;;"}