supporting geometry collections

ambrazasp · Aug 25, 2023 · 650af48 · 650af48
1 parent d84b394
commit 650af48
Show file tree

Hide file tree

Showing 3 changed files with 78 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -73,7 +73,9 @@ const result: ValidationResult = validate(featureCollection);
 
 ### parse
 
-Accepts array or object of `type`, `coordinates` and `properties` (optional)
+Accepts array or object of `type`, `coordinates` and `properties` (optional).
+
+Also you can parse `GeometryCollection` (object or array of objects). In that case instead of `coordinates` and `properties` it uses `geometries`.
 
 Returns [feature collection](#feature-collection)
 
@@ -82,21 +84,27 @@ Returns [feature collection](#feature-collection)
 ```js
 import { parse } from 'geojsonjs';
 
-const featureCollection = parse({ type: 'Point', coordinates: [11, 22] });
-const featureCollection2 = parse([
-  { type: 'Point', coordinates: [11, 22], properties: { prop1: 'prop1' } },
-]);
+const point1 = { type: 'Point', coordinates: [11, 22] };
+const point2 = {
+  type: 'Point',
+  coordinates: [11, 22],
+  properties: { prop1: 'prop1' },
+};
+const geometryCollection = {
+  type: 'GeometryCollection',
+  geometries: [{ type: 'Point', coordinates: [11, 22] }],
+};
+
+const featureCollection = parse(point1);
+const featureCollection2 = parse([point1, point2]);
+const featureCollection3 = parse(geometryCollection);
 
 // TypeScript
 import { parse, FeatureCollection } from 'geojsonjs';
 
-const featureCollection: FeatureCollection = parse({
-  type: 'Point',
-  coordinates: [11, 22],
-});
-const featureCollection2: FeatureCollection = parse([
-  { type: 'Point', coordinates: [11, 22], properties: { prop1: 'prop1' } },
-]);
+const featureCollection: FeatureCollection = parse(point1);
+const featureCollection2: FeatureCollection = parse([point1, point2]);
+const featureCollection3: FeatureCollection = parse(geometryCollection);
 ```
 
 ### getGeometries
@@ -336,6 +344,8 @@ const result: ValidationResult = validateGeometryTypes(
   - [Features (array)](#features-array)
   - [Geometry](#geometry)
   - [Geometries (array)](#geometries-array)
+  - [Geometry collection](#geometry-collection)
+  - [Geometry collections (array)](#geometry-collections-array)
 - [Geometry item types](#geometry-types)
   - Point
   - MultiPoint
@@ -451,6 +461,47 @@ const result: ValidationResult = validateGeometryTypes(
 ]
 ```
 
+### Geometry Collection
+
+```json
+{
+  "type": "GeometryCollection",
+  "geometries": [
+    { "type": "Point", "coordinates": [11, 22] },
+    {
+      "type": "LineString",
+      "coordinates": [
+        [11, 22],
+        [22, 33]
+      ]
+    }
+  ]
+}
+```
+
+### Geometry Collections (array)
+
+```json
+[
+  {
+    "type": "GeometryCollection",
+    "geometries": [{ "type": "Point", "coordinates": [11, 22] }]
+  },
+  {
+    "type": "GeometryCollection",
+    "geometries": [
+      {
+        "type": "LineString",
+        "coordinates": [
+          [11, 22],
+          [22, 33]
+        ]
+      }
+    ]
+  }
+]
+```
+
 ### Geometry types
 
 ```js

diff --git a/src/functions.ts b/src/functions.ts
@@ -8,6 +8,7 @@ import {
   GEOMETRY_COLLECTION,
   GenericObject,
   Geometry,
+  GeometryCollection,
   GeometryType,
 } from './types';
 import * as utils from './utils';
@@ -45,6 +46,8 @@ export function getFeatures(geom: AllTypes): Feature[] {
     return geom
       .map((g) => getFeatures(g))
       .reduce((acc: Feature[], item: Feature[]) => [...acc, ...item], []);
+  } else if (geom.type === GEOMETRY_COLLECTION) {
+    return getFeatures((geom as GeometryCollection).geometries);
   } else if (geom.type === FEATURE_COLLECTION_TYPE) {
     return (geom as FeatureCollection).features;
   } else if (geom.type === FEATURE_TYPE) {

diff --git a/src/types.ts b/src/types.ts
@@ -7,6 +7,10 @@ export type CoordinatesMultiLineString = CoordinatesLineString[];
 export type CoordinatesPolygon = CoordinatesLineString[];
 export type CoordinatesMultiPolygon = CoordinatesPolygon[];
 
+export const FEATURE_COLLECTION_TYPE = 'FeatureCollection';
+export const FEATURE_TYPE = 'Feature';
+export const GEOMETRY_COLLECTION = 'GeometryCollection';
+
 export type CoordinatesTypes =
   | CoordinatesPoint
   | CoordinatesLineString
@@ -20,6 +24,11 @@ export type Geometry = {
   coordinates: CoordinatesTypes;
 };
 
+export type GeometryCollection = {
+  type: 'GeometryCollection';
+  geometries: Geometry[];
+};
+
 export type FeatureCollection = {
   type: 'FeatureCollection';
   features: Feature[];
@@ -31,10 +40,6 @@ export type Feature = {
   properties?: GenericObject;
 };
 
-export const FEATURE_COLLECTION_TYPE = 'FeatureCollection';
-export const FEATURE_TYPE = 'Feature';
-export const GEOMETRY_COLLECTION = 'GeometryCollection';
-
 export const ValidationError = {
   EMTPY: 'EMTPY',
   EMPTY_FEATURES: 'EMPTY_FEATURES',
@@ -61,7 +66,9 @@ export type AllTypes =
   | Feature
   | Feature[]
   | FeatureCollection
-  | FeatureCollection[];
+  | FeatureCollection[]
+  | GeometryCollection
+  | GeometryCollection[];
 
 export type ValidationResult = {
   valid: boolean;