@centia-io/sdk 0.2.11 → 0.2.13

package/dist/centia-io-sdk.js

@@ -3040,6 +3040,157 @@ var Mapcache = class {
 	}
 };
 
+//#endregion
+//#region src/ogc/Ogc.ts
+/** Default CRS of the OGC API: WGS 84 in longitude/latitude order. */
+const OGC_CRS84 = "http://www.opengis.net/def/crs/OGC/1.3/CRS84";
+/**
+* CRS URI for an EPSG code, e.g. `ogcEpsgCrs(25832)`. Note that
+* `ogcEpsgCrs(4326)` is latitude/longitude order; use `OGC_CRS84` for lon/lat.
+*/
+function ogcEpsgCrs(epsg) {
+	return `http://www.opengis.net/def/crs/EPSG/0/${epsg}`;
+}
+function bboxToString(bbox) {
+	return typeof bbox === "string" ? bbox : bbox.join(",");
+}
+function spatialQuery(options) {
+	const query = {};
+	if ((options === null || options === void 0 ? void 0 : options.bbox) !== void 0) query.bbox = bboxToString(options.bbox);
+	if ((options === null || options === void 0 ? void 0 : options.bboxCrs) !== void 0) query["bbox-crs"] = options.bboxCrs;
+	if ((options === null || options === void 0 ? void 0 : options.crs) !== void 0) query.crs = options.crs;
+	if ((options === null || options === void 0 ? void 0 : options.datetime) !== void 0) query.datetime = options.datetime;
+	return query;
+}
+function nonEmpty(query) {
+	return Object.keys(query).length > 0 ? query : void 0;
+}
+/**
+* OGC API Features (Part 1 Core, Part 2 CRS) and OGC API Maps (Part 1 Core)
+* wrapper for `/api/v4/ogc/database/{database}`.
+*
+* The endpoints accept Bearer token, HTTP Basic and anonymous requests. A
+* Bearer token must match the `database` in the path. Anonymous callers read
+* layers below `Read/write`; a `Read/write` collection answers 401 (Basic
+* challenge) for anonymous callers and 403 for identities without privilege.
+* Geofence rules, versioning and workflow are applied server-side.
+*
+* Map images cannot be fetched through this client; use `mapUrl` /
+* `datasetMapUrl` to build image URLs for `<img>` tags or map libraries.
+*
+* ```ts
+* const ogc = new Ogc(createCentiaClient({ baseUrl, auth }));
+* const page = await ogc.getItems('my_database', 'my_schema.roads', { bbox: [9, 55, 10, 56], limit: 100 });
+* ```
+*/
+var Ogc = class {
+	constructor(client) {
+		this.client = client;
+	}
+	basePath(database) {
+		return `api/v4/ogc/database/${encodeURIComponent(database)}`;
+	}
+	collectionPath(database, collectionId) {
+		return `${this.basePath(database)}/collections/${encodeURIComponent(collectionId)}`;
+	}
+	/** The landing page with links to conformance, collections and the OpenAPI document. */
+	async getLandingPage(database) {
+		var _this = this;
+		return _this.client.request({
+			path: _this.basePath(database),
+			method: "GET"
+		});
+	}
+	/** Conformance classes implemented by the server. */
+	async getConformance(database) {
+		var _this2 = this;
+		return _this2.client.request({
+			path: `${_this2.basePath(database)}/conformance`,
+			method: "GET"
+		});
+	}
+	/** The collections (OWS-enabled layers) the caller may read, paged. */
+	async getCollections(database, options) {
+		var _this3 = this;
+		const query = {};
+		if ((options === null || options === void 0 ? void 0 : options.limit) !== void 0) query.limit = String(options.limit);
+		if ((options === null || options === void 0 ? void 0 : options.offset) !== void 0) query.offset = String(options.offset);
+		return _this3.client.request({
+			path: `${_this3.basePath(database)}/collections`,
+			method: "GET",
+			query: nonEmpty(query)
+		});
+	}
+	/**
+	* One collection. Throws a `CentiaApiError` with status 404 (unknown),
+	* 401 (anonymous caller, credentials required) or 403 (no privilege).
+	*/
+	async getCollection(database, collectionId) {
+		var _this4 = this;
+		return _this4.client.request({
+			path: _this4.collectionPath(database, collectionId),
+			method: "GET"
+		});
+	}
+	/**
+	* Features of a collection as a GeoJSON FeatureCollection page. The default
+	* page size is 10; follow `links` with `rel: 'next'` or pass `offset`.
+	*/
+	async getItems(database, collectionId, options) {
+		var _this5 = this;
+		const query = {};
+		if ((options === null || options === void 0 ? void 0 : options.limit) !== void 0) query.limit = String(options.limit);
+		if ((options === null || options === void 0 ? void 0 : options.offset) !== void 0) query.offset = String(options.offset);
+		Object.assign(query, spatialQuery(options));
+		return _this5.client.request({
+			path: `${_this5.collectionPath(database, collectionId)}/items`,
+			method: "GET",
+			query: nonEmpty(query),
+			accept: "application/geo+json"
+		});
+	}
+	/** One feature by primary key. Throws a 404 `CentiaApiError` when it does not exist. */
+	async getItem(database, collectionId, featureId, options) {
+		var _this6 = this;
+		const query = {};
+		if ((options === null || options === void 0 ? void 0 : options.crs) !== void 0) query.crs = options.crs;
+		if ((options === null || options === void 0 ? void 0 : options.datetime) !== void 0) query.datetime = options.datetime;
+		return _this6.client.request({
+			path: `${_this6.collectionPath(database, collectionId)}/items/${encodeURIComponent(String(featureId))}`,
+			method: "GET",
+			query: nonEmpty(query),
+			accept: "application/geo+json"
+		});
+	}
+	/**
+	* URL of a rendered map of one collection (PNG/JPEG), without fetching it.
+	* Authorization travels in the `Authorization` header, so for protected
+	* collections fetch the image with the header set (or use Basic auth).
+	*/
+	mapUrl(database, collectionId, options) {
+		return this.buildUrl(`${this.collectionPath(database, collectionId)}/map`, this.mapQuery(options));
+	}
+	/** URL of a rendered map of several collections of the same schema. */
+	datasetMapUrl(database, collections, options) {
+		const query = _objectSpread2({ collections: collections.join(",") }, this.mapQuery(options));
+		return this.buildUrl(`${this.basePath(database)}/map`, query);
+	}
+	mapQuery(options) {
+		const query = spatialQuery(options);
+		if ((options === null || options === void 0 ? void 0 : options.width) !== void 0) query.width = String(options.width);
+		if ((options === null || options === void 0 ? void 0 : options.height) !== void 0) query.height = String(options.height);
+		if ((options === null || options === void 0 ? void 0 : options.format) !== void 0) query.f = options.format;
+		if ((options === null || options === void 0 ? void 0 : options.transparent) !== void 0) query.transparent = String(options.transparent);
+		if ((options === null || options === void 0 ? void 0 : options.bgcolor) !== void 0) query.bgcolor = options.bgcolor;
+		return query;
+	}
+	buildUrl(path, query) {
+		let url = `${this.client.baseUrl}/${path}`;
+		if (Object.keys(query).length > 0) url += `?${new URLSearchParams(query).toString()}`;
+		return url;
+	}
+};
+
 //#endregion
 //#region src/keyvalue/Keyvalue.ts
 /**
@@ -3163,7 +3314,11 @@ var Features = class {
 			expectedStatus: 303
 		})).getHeader("Location")) !== null && _res$getHeader2 !== void 0 ? _res$getHeader2 : "" };
 	}
-	/** Delete a single feature by primary key. */
+	/**
+	* Delete one or more features by primary key. Keys that match are deleted
+	* in one WFS-T transaction; a 404 `CentiaApiError` is thrown only when
+	* none of the keys match.
+	*/
 	async deleteFeature(schema, table, feature) {
 		await this.client.request({
 			path: featurePath(schema, table, feature),
@@ -3295,5 +3450,5 @@ function isExpired(jwt, skewSeconds) {
 */
 
 //#endregion
-export { CentiaApiError, Claims, CodeFlow, Features, Gql, Keyvalue, Mapcache, Meta, NotLoggedInError, Ows, PasswordFlow, Rpc, SessionExpiredError, SignUp, Sql, SqlNoToken, Stats, Status, Tables, Users, Wfs, Ws, createApi, createCentiaAdminClient, createCentiaClient, createSqlBuilder, createTokenProvider, isCentiaApiError };
+export { CentiaApiError, Claims, CodeFlow, Features, Gql, Keyvalue, Mapcache, Meta, NotLoggedInError, OGC_CRS84, Ogc, Ows, PasswordFlow, Rpc, SessionExpiredError, SignUp, Sql, SqlNoToken, Stats, Status, Tables, Users, Wfs, Ws, createApi, createCentiaAdminClient, createCentiaClient, createSqlBuilder, createTokenProvider, isCentiaApiError, ogcEpsgCrs };
 //# sourceMappingURL=centia-io-sdk.js.map