https://github.com/koopjs/koop-provider-hub-search-ogc
A Koop provider for querying against the ArcGIS Hub Search OGC API.
https://github.com/koopjs/koop-provider-hub-search-ogc
Last synced: 12 days ago
JSON representation
A Koop provider for querying against the ArcGIS Hub Search OGC API.
- Host: GitHub
- URL: https://github.com/koopjs/koop-provider-hub-search-ogc
- Owner: koopjs
- License: other
- Created: 2023-05-24T17:07:17.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-06T17:36:19.000Z (about 2 months ago)
- Last Synced: 2025-03-24T09:38:17.765Z (29 days ago)
- Language: TypeScript
- Size: 853 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Koop Provider Hub Search OGC
This is a Koop provider that extracts datasets from the ArcGIS Hub Search OGC API.
## Use - Streaming All Datasets
This provider plugin currently only supports [streaming](https://nodejs.org/api/stream.html#stream_readable_streams) ALL datasets matching a given search query.
### Define Search Parameters
To perform a search from an output plugin, attach onto the response.
```js
req.res.locals.siteIdentifier = 'https://my-site.hub.arcgis.com'
```
### Pull the Readable Stream
Then pass the request object to `this.model.pullStream`.
```js
const docStream = await this.model.pullStream(req);
```
### Full Example
What you have now is a Node.js `Readable` stream. You can pipe the datasets from the readable through a transform stream in order to format them into some other type of output before sending them back to the browser by piping them to the Express.js response. The following simple example also uses the [`through2`](https://www.npmjs.com/package/through2) library to conveniently define a transform stream.
```js
async handleRequest (req, res) {
req.res.locals.siteIdentifier = 'my-site.hub.arcgis.com'
const docStream = await this.model.pullStream(req);
docStream
.pipe(through2.obj(function (dataset, enc, callback) {
const transformed = someTranformFunc(dataset);
// the Express.js "res" Writable only accepts strings or Buffers
this.push(JSON.stringify(transformed));
callback();
}))
.pipe(res);
}
```
## Develop
```sh
# clone and install dependencies
git clone https://github.com/koopjs/koop-provider-hub-search-ogc
cd koop-provider-hub-search-ogc
npm i
# starts the example Koop app found in ./example-app.
npm run dev
```
## Test
Run the `npm t` commmand to spin up the automated tests.