@open-pioneer/ogc-features 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @open-pioneer/ogc-features
+
+## 0.1.0
+
+### Minor Changes
+
+-   bc54925: Initial release.

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/OffsetStrategy.d.ts

@@ -0,0 +1,10 @@
+import { FeatureLike } from "ol/Feature";
+import { LoadFeatureOptions } from "./OgcFeatureSourceFactory";
+/** @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>;
+/** @internal */
+export declare function loadAllFeaturesWithOffset(options: LoadFeatureOptions): Promise<FeatureLike[]>;

package/OffsetStrategy.js

@@ -0,0 +1,67 @@
+import { loadPages } from './OgcFeatureSourceFactory.js';
+import { createOffsetURL, getNextURL } from './requestUtils.js';
+
+async function getCollectionInfos(collectionsItemsUrl) {
+  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(), {
+    headers: {
+      Accept: "application/geo+json"
+    }
+  });
+  if (response.status !== 200) {
+    throw new Error(`Failed to probe collection information (status code ${response.status})`);
+  }
+  const jsonResp = await response.json();
+  const nextUrl = getNextURL(jsonResp.links);
+  if (!nextUrl) {
+    return infos;
+  }
+  const parsedURL = new URL(nextUrl);
+  const hasOffset = parsedURL.searchParams.has("offset");
+  infos.supportsOffsetStrategy = hasOffset;
+  return infos;
+}
+async function loadAllFeaturesWithOffset(options) {
+  const { fullURL, featureFormat, signal, addFeatures, queryFeatures } = options;
+  const pageSize = options.limit;
+  const maxConcurrency = options.maxConcurrentRequests;
+  let startOffset = 0;
+  let currentUrl = fullURL;
+  const allFeatures = [];
+  let totalFeatures;
+  while (currentUrl) {
+    let pagesInIteration;
+    if (totalFeatures == void 0) {
+      pagesInIteration = maxConcurrency;
+    } else {
+      pagesInIteration = Math.ceil((totalFeatures - startOffset) / pageSize);
+    }
+    pagesInIteration = Math.max(1, Math.min(pagesInIteration, maxConcurrency));
+    const urls = [];
+    for (let page = 0; page < pagesInIteration; ++page) {
+      urls.push(createOffsetURL(fullURL, startOffset, pageSize));
+      startOffset += pageSize;
+    }
+    const allFeatureResp = await loadPages(
+      urls,
+      featureFormat,
+      signal,
+      addFeatures,
+      queryFeatures
+    );
+    allFeatures.push(...allFeatureResp.features);
+    currentUrl = allFeatureResp.nextURL;
+    if (allFeatureResp.numberMatched != null) {
+      totalFeatures = allFeatureResp.numberMatched;
+    }
+  }
+  return allFeatures;
+}
+
+export { getCollectionInfos, loadAllFeaturesWithOffset };
+//# sourceMappingURL=OffsetStrategy.js.map

package/OffsetStrategy.js.map

@@ -0,0 +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;;;;"}

package/OgcFeatureSourceFactory.d.ts

@@ -0,0 +1,77 @@
+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

@@ -0,0 +1,125 @@
+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';
+
+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, queryFeaturesParam, addFeaturesParam, getCollectionInfosParam) {
+  const collectionItemsURL = `${options.baseUrl}/collections/${options.collectionId}/items?`;
+  const vectorSrc = new VectorSource({
+    format: new GeoJSON(),
+    strategy: bbox,
+    attributions: options.attributions,
+    ...options.additionalOptions
+  });
+  const queryFeaturesFunc = queryFeaturesParam ?? queryFeatures;
+  const getCollectionInfosFunc = getCollectionInfosParam ?? getCollectionInfos;
+  const addFeaturesFunc = 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);
+    let collectionInfos;
+    try {
+      collectionInfos = await collectionInfosPromise;
+    } catch (e) {
+      LOG.error("Failed to retrieve collection information", e);
+      failure?.();
+      collectionInfosPromise = void 0;
+      return;
+    }
+    abortController?.abort("Extent changed");
+    abortController = new AbortController();
+    const fullURL = createCollectionRequestUrl(collectionItemsURL, extent, options.crs);
+    const strategy = collectionInfos?.supportsOffsetStrategy ? "offset" : "next";
+    try {
+      const features = await loadAllFeatures(strategy, {
+        fullURL: fullURL.toString(),
+        featureFormat: vectorSrc.getFormat(),
+        // TODO
+        queryFeatures: queryFeaturesFunc,
+        addFeatures: addFeaturesFunc,
+        limit: options.limit ?? DEFAULT_LIMIT,
+        maxConcurrentRequests: options.maxConcurrentRequests ?? DEFAULT_CONCURRENTY,
+        signal: abortController.signal,
+        collectionInfos
+      });
+      success?.(features);
+      LOG.debug("Finished loading features for extent:", extent);
+    } catch (e) {
+      if (!isAbortError(e)) {
+        LOG.error("Failed to load features", e);
+      } else {
+        LOG.debug("Query-Feature-Request aborted", e);
+        vectorSrc.removeLoadedExtent(extent);
+        failure?.();
+      }
+    }
+  };
+  vectorSrc.setLoader(loaderFunction);
+  return vectorSrc;
+}
+function loadAllFeatures(strategy, options) {
+  switch (strategy) {
+    case "next":
+      return loadAllFeaturesNextStrategy(options);
+    case "offset":
+      return loadAllFeaturesWithOffset(options);
+  }
+}
+async function loadAllFeaturesNextStrategy(options) {
+  const limit = options.limit;
+  let url = new URL(options.fullURL);
+  url.searchParams.set("limit", limit.toString());
+  let allFeatures = [];
+  do {
+    const featureResp = await loadPages(
+      [url.toString()],
+      options.featureFormat,
+      options.signal,
+      options.addFeatures,
+      options.queryFeatures
+    );
+    allFeatures = allFeatures.concat(featureResp.features);
+    if (!featureResp.nextURL) {
+      break;
+    }
+    url = new URL(featureResp.nextURL);
+  } while (1);
+  return allFeatures;
+}
+async function loadPages(allUrls, featureFormat, signal, addFeaturesFunc, queryFeaturesFunc = queryFeatures) {
+  const allFeatureResponse = {
+    nextURL: void 0,
+    numberMatched: void 0,
+    features: []
+  };
+  const allRequestPromises = allUrls.map(async (singleUrl, index) => {
+    const isLast = index === allUrls.length - 1;
+    const featureResponse = await queryFeaturesFunc(singleUrl, featureFormat, signal);
+    addFeaturesFunc(featureResponse.features);
+    LOG.debug(
+      `NextURL for index = ${index} (isLast = ${isLast}): ${featureResponse.nextURL || "No Next URL"}`
+    );
+    allFeatureResponse.features.push(...featureResponse.features);
+    if (isLast) {
+      allFeatureResponse.numberMatched = featureResponse.numberMatched;
+      allFeatureResponse.nextURL = featureResponse.nextURL;
+    }
+  });
+  await Promise.all(allRequestPromises);
+  return allFeatureResponse;
+}
+
+export { _createVectorSource, createVectorSource, loadAllFeaturesNextStrategy, loadPages };
+//# sourceMappingURL=OgcFeatureSourceFactory.js.map

package/OgcFeatureSourceFactory.js.map

@@ -0,0 +1 @@
+{"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;;;;"}

package/README.md

@@ -0,0 +1,54 @@
+# @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.
+
+## Usage
+
+Just import the function with:
+
+```js
+import { createVectorSource } from "@open-pioneer/ogc-features";
+```
+
+and use it inside a VectorLayer:
+
+```ts
+layer: new VectorLayer({
+    source: createVectorSource({
+        baseUrl: "https://ogc-api.nrw.de/inspire-us-kindergarten/v1",
+        collectionId: "governmentalservice",
+        crs: "http://www.opengis.net/def/crs/EPSG/0/25832",
+
+        /**
+         * 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
+         */
+        limit: 5000,
+
+        /** The maximum number of concurrent requests. Defaults to `6`. */
+        maxConcurrentRequests: 6,
+
+        attributions:
+            "<a href='https://www.govdata.de/dl-de/by-2-0'>Datenlizenz Deutschland - Namensnennung - Version 2.0</a>",
+
+        additionalOptions: {} // (Optional)
+    })
+});
+```
+
+The optional `limit` configures the concurrent execution of requests by using the `offset` URL property for pagination.
+If the service returns a `numberMatched` property together with its results, it is used alongside the configured pageSize to calculate the optimal number of concurrent requests.
+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`.
+
+## License
+
+Apache-2.0 (see `LICENSE` file)

package/index.d.ts

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

package/index.js

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

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,28 @@
+{
+  "type": "module",
+  "name": "@open-pioneer/ogc-features",
+  "version": "0.1.0",
+  "license": "Apache-2.0",
+  "peerDependencies": {
+    "@open-pioneer/core": "^1.1.0",
+    "ol": "^8.2.0"
+  },
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "import": "./index.js",
+      "types": "./index.d.ts"
+    }
+  },
+  "openPioneerFramework": {
+    "services": [],
+    "i18n": {
+      "languages": []
+    },
+    "ui": {
+      "references": []
+    },
+    "properties": [],
+    "packageFormatVersion": "1.0.0"
+  }
+}

package/requestUtils.d.ts

@@ -0,0 +1,25 @@
+import { Extent } from "ol/extent";
+import FeatureFormat from "ol/format/Feature";
+import { FeatureLike } from "ol/Feature";
+/**
+ * Assembles the url to use for fetching features in the given extent.
+ */
+export declare function createCollectionRequestUrl(collectionItemsURL: string, extent: Extent, crs: string): URL;
+/**
+ * Adds (or replaces) offset/limit params on the given url.
+ */
+export declare function createOffsetURL(fullURL: string, offset: number, pageSize: number): string;
+/**
+ * Extracts the `next` link from the service response's `links` property.
+ */
+export declare function getNextURL(rawLinks: unknown): string | undefined;
+export interface FeatureResponse {
+    features: FeatureLike[];
+    nextURL: string | undefined;
+    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>;

package/requestUtils.js

@@ -0,0 +1,53 @@
+const NEXT_LINK_PROP = "next";
+function createCollectionRequestUrl(collectionItemsURL, extent, crs) {
+  const urlObj = new URL(collectionItemsURL);
+  const searchParams = urlObj.searchParams;
+  searchParams.set("bbox", extent.join(","));
+  searchParams.set("bbox-crs", crs);
+  searchParams.set("crs", crs);
+  searchParams.set("f", "json");
+  return urlObj;
+}
+function createOffsetURL(fullURL, offset, pageSize) {
+  const url = new URL(fullURL);
+  const searchParams = url.searchParams;
+  searchParams.set("offset", offset.toString());
+  searchParams.set("limit", pageSize.toString());
+  return url.toString();
+}
+function getNextURL(rawLinks) {
+  if (!Array.isArray(rawLinks)) {
+    return void 0;
+  }
+  const links = rawLinks;
+  const nextLinks = links.filter((link) => link.rel === NEXT_LINK_PROP);
+  if (nextLinks.length !== 1)
+    return;
+  return nextLinks[0]?.href;
+}
+async function queryFeatures(fullURL, featureFormat, signal) {
+  let features = [];
+  const requestInit = {
+    headers: {
+      Accept: "application/geo+json"
+    },
+    signal
+  };
+  const response = await fetch(fullURL, requestInit);
+  if (response.status !== 200) {
+    throw new Error(`Failed to query features from service (status code ${response.status})`);
+  }
+  const geoJson = await response.json();
+  if (featureFormat) {
+    features = featureFormat.readFeatures(geoJson);
+  }
+  const nextURL = getNextURL(geoJson.links);
+  return {
+    features,
+    numberMatched: geoJson.numberMatched,
+    nextURL
+  };
+}
+
+export { createCollectionRequestUrl, createOffsetURL, getNextURL, queryFeatures };
+//# sourceMappingURL=requestUtils.js.map

package/requestUtils.js.map

@@ -0,0 +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;;;;"}