@konfirm/geojson 1.0.0 → 1.0.1

package/README.md

@@ -33,7 +33,7 @@ The `isStrict*` variants of the type guards also validate the following:
  - `Latitude` is a number in the range (inclusive) `-90..90`
  - `Altitude` is a number in the range (inclusive) `-6371008.7714..20180000` (Earth center(-ish) up to the GPS satelite distance)
  - `Polygon` "LinearRing" are closed (first and last `Position` are identical)
- - `Polygon` "LinearRing" have the correct winding (counterclockwise for exterior rings (outline), clockwise for interior rings (holes))
+ - ~~`Polygon` "LinearRing" have the correct winding (counterclockwise for exterior rings (outline), clockwise for interior rings (holes))~~ _(not yet enforced — planned for v2)_
 
 
 | type               | guard                  | strict guard                 | description                                                                                                        |
@@ -107,7 +107,7 @@ import { distance, Feature } from '@konfirm/geojson';
     const a: Feature = {
         type: 'Feature',
         properties: {
-            name: 'Schiphol Airpoirt, Amsterdam',
+            name: 'Schiphol Airport, Amsterdam',
         },
         geometry: {
             type: 'Point',
@@ -125,15 +125,15 @@ import { distance, Feature } from '@konfirm/geojson';
         },
     };
 
-    console.log(distance(a, b));             // 8829424.604594177
-    console.log(distance(a, b, 'direct');    // 8829424.604594177 ('direct' is the default)
-    console.log(distance(a, b, 'haversine'); // 5847546.425707642
-    console.log(distance(a, b, 'vincenty');  // 5863355.371234315
+    console.log(distance(a, b));              // 8829424.604594177 ('cartesian' is the default)
+    console.log(distance(a, b, 'cartesian')); // 8829424.604594177
+    console.log(distance(a, b, 'haversine')); // 5847546.425707642
+    console.log(distance(a, b, 'vincenty'));  // 5863355.371234315
 ```
 
 ### SimpleGeometryIterator
 
-The SimpleGeometryIterator class is a convenience helper utility which yeilds all simple Geometric shapes (`Point`, `LineString`, `Polygon`) from any GeoJSON object. Using a SimpleGeometryIterator allows you to focus on just implementing logic for the simple Geometric shapes whilst supporting any compbination of GeoJSON objects as input.
+The SimpleGeometryIterator class is a convenience helper utility which yields all simple Geometric shapes (`Point`, `LineString`, `Polygon`) from any GeoJSON object. Using a SimpleGeometryIterator allows you to focus on just implementing logic for the simple Geometric shapes whilst supporting any combination of GeoJSON objects as input.
 
 | input type           | yields type(s)                     | description                                                                              |
 | -------------------- | ---------------------------------- | ---------------------------------------------------------------------------------------- |

package/dist/{geojson.d.ts → main.d.mts}

@@ -1,12 +1,15 @@
 import * as _konfirm_guard from '@konfirm/guard';
+import { Guard } from '@konfirm/guard';
 
-type Guard<T> = (value: any) => value is T;
-
-type Longitude = number;
+type Altitude = number;
 
 type Latitude = number;
 
-type Altitude = number;
+type Longitude = number;
+
+type Position = [Longitude, Latitude, Altitude?];
+declare const isPosition: _konfirm_guard.Guard<Position>;
+declare const isStrictPosition: _konfirm_guard.Guard<Position>;
 
 type BoundingBox = [Longitude, Latitude, Altitude, Longitude, Latitude, Altitude] | [Longitude, Latitude, Longitude, Latitude];
 
@@ -17,10 +20,6 @@ type GeoJSONBase = {
 };
 type GeoJSONObject<T extends GeoJSONBase = GeoJSONBase> = GeoJSONBase & T;
 
-type Position = [Longitude, Latitude, Altitude?];
-declare const isPosition: _konfirm_guard.Guard<Position>;
-declare const isStrictPosition: _konfirm_guard.Guard<Position>;
-
 type GeometryBase = GeoJSONObject & {
     coordinates: Array<unknown>;
 };
@@ -38,8 +37,8 @@ declare const isPoint: Guard<Point>;
 declare const isStrictPoint: Guard<Point>;
 
 type MultiPoint = MultiGeometryObject<Point>;
-declare const isMultiPoint: _konfirm_guard.Guard<MultiPoint>;
-declare const isStrictMultiPoint: _konfirm_guard.Guard<MultiPoint>;
+declare const isMultiPoint: Guard<MultiPoint>;
+declare const isStrictMultiPoint: Guard<MultiPoint>;
 
 type LineString = GeometryObject<{
     type: 'LineString';
@@ -77,8 +76,8 @@ type GeometryCollection = GeoJSONObject<{
     type: 'GeometryCollection';
     geometries: Array<Geometry | GeometryCollection>;
 }>;
-declare function isGeometryCollection(value: any): value is GeometryCollection;
-declare function isStrictGeometryCollection(value: any): value is GeometryCollection;
+declare function isGeometryCollection(value: unknown): value is GeometryCollection;
+declare function isStrictGeometryCollection(value: unknown): value is GeometryCollection;
 
 type Feature = GeoJSONObject<{
     type: 'Feature';
@@ -101,12 +100,6 @@ type GeoJSON = Geometry | GeometryCollection | Feature | FeatureCollection;
 declare const isGeoJSON: _konfirm_guard.Guard<GeoJSON>;
 declare const isStrictGeoJSON: _konfirm_guard.Guard<GeoJSON>;
 
-declare function intersect(a: GeoJSON, b: GeoJSON): boolean;
-
-type PointToPointCalculation = 'cartesian' | 'haversine' | 'vincenty' | ((a: Point['coordinates'], b: Point['coordinates']) => number);
-
-declare function distance(a: GeoJSON, b: GeoJSON, calculation?: PointToPointCalculation): number;
-
 type SimpleGeometry = Point | LineString | Polygon;
 /**
  * Iterator class to turn any GeoJSON structure into one or more SimpleGeometry (Point | LineString | Polygon) objects
@@ -116,12 +109,6 @@ type SimpleGeometry = Point | LineString | Polygon;
  */
 declare class SimpleGeometryIterator {
     private readonly inputs;
-    /**
-     *  Creates an instance of SimpleGeometryIterator
-     *
-     * @param {...[GeoJSON, ...Array<GeoJSON>]} inputs
-     * @memberof SimpleGeometryIterator
-     */
     constructor(...inputs: [GeoJSON, ...Array<GeoJSON>]);
     /**
      * Generator yielding all SimpleGeometry objects from the provided GeoJSON structure(s)
@@ -139,60 +126,12 @@ declare class SimpleGeometryIterator {
      * @memberof SimpleGeometryIterator
      */
     private unwrap;
-    /**
-     * Generate the geometries in a GeometryCollection
-     *
-     * @private
-     * @param {GeometryCollection} { geometries }
-     * @return {*}  {Iterable<SimpleGeometry>}
-     * @memberof SimpleGeometryIterator
-     */
-    private GeometryCollection;
-    /**
-     * Generate the geometries of the Feature object(s) in a FeatureCollection
-     *
-     * @private
-     * @param {FeatureCollection} { features }
-     * @return {*}  {Iterable<SimpleGeometry>}
-     * @memberof SimpleGeometryIterator
-     */
-    private FeatureCollection;
-    /**
-     * Generate the geometry of a Feature object
-     *
-     * @private
-     * @param {Feature} { geometry }
-     * @return {*}  {Iterable<SimpleGeometry>}
-     * @memberof SimpleGeometryIterator
-     */
-    private Feature;
-    /**
-     * Generate Point objects from a MultiPoint object
-     *
-     * @private
-     * @param {MultiPoint} multi
-     * @return {*}  {Iterable<Point>}
-     * @memberof SimpleGeometryIterator
-     */
-    private MultiPoint;
-    /**
-     * Generate LineString objects from a MultiLineString object
-     *
-     * @private
-     * @param {MultiLineString} multi
-     * @return {*}  {Iterable<LineString>}
-     * @memberof SimpleGeometryIterator
-     */
-    private MultiLineString;
-    /**
-     * Generate Polygon objects from a MultiPolygon object
-     *
-     * @private
-     * @param {MultiPolygon} multi
-     * @return {*}  {Iterable<Polygon>}
-     * @memberof SimpleGeometryIterator
-     */
-    private MultiPolygon;
 }
 
-export { Feature, FeatureCollection, GeoJSON, Geometry, GeometryCollection, LineString, MultiLineString, MultiPoint, MultiPolygon, Point, Polygon, Position, SimpleGeometryIterator, distance, intersect, isFeature, isFeatureCollection, isGeoJSON, isGeometry, isGeometryCollection, isLineString, isMultiLineString, isMultiPoint, isMultiPolygon, isPoint, isPolygon, isPosition, isStrictFeature, isStrictFeatureCollection, isStrictGeoJSON, isStrictGeometry, isStrictGeometryCollection, isStrictLineString, isStrictMultiLineString, isStrictMultiPoint, isStrictMultiPolygon, isStrictPoint, isStrictPolygon, isStrictPosition };
+type PointToPointCalculation = 'cartesian' | 'haversine' | 'vincenty' | ((a: Point['coordinates'], b: Point['coordinates']) => number);
+
+declare function distance(a: GeoJSON, b: GeoJSON, calculation?: PointToPointCalculation): number;
+
+declare function intersect(a: GeoJSON, b: GeoJSON): boolean;
+
+export { type Feature, type FeatureCollection, type GeoJSON, type Geometry, type GeometryCollection, type LineString, type MultiLineString, type MultiPoint, type MultiPolygon, type Point, type Polygon, type Position, SimpleGeometryIterator, distance, intersect, isFeature, isFeatureCollection, isGeoJSON, isGeometry, isGeometryCollection, isLineString, isMultiLineString, isMultiPoint, isMultiPolygon, isPoint, isPolygon, isPosition, isStrictFeature, isStrictFeatureCollection, isStrictGeoJSON, isStrictGeometry, isStrictGeometryCollection, isStrictLineString, isStrictMultiLineString, isStrictMultiPoint, isStrictMultiPolygon, isStrictPoint, isStrictPolygon, isStrictPosition };

package/dist/main.d.ts

@@ -1,15 +1,137 @@
-export { intersect } from './Domain/Utility/Intersect';
-export { distance } from './Domain/Utility/Distance';
-export { SimpleGeometryIterator } from './Domain/Iterator/SimpleGeometry';
-export { Position, isPosition, isStrictPosition } from './Domain/GeoJSON/Concept/Position';
-export { Point, isPoint, isStrictPoint } from './Domain/GeoJSON/Geometry/Point';
-export { MultiPoint, isMultiPoint, isStrictMultiPoint } from './Domain/GeoJSON/Geometry/MultiPoint';
-export { LineString, isLineString, isStrictLineString } from './Domain/GeoJSON/Geometry/LineString';
-export { MultiLineString, isMultiLineString, isStrictMultiLineString } from './Domain/GeoJSON/Geometry/MultiLineString';
-export { Polygon, isPolygon, isStrictPolygon } from './Domain/GeoJSON/Geometry/Polygon';
-export { MultiPolygon, isMultiPolygon, isStrictMultiPolygon } from './Domain/GeoJSON/Geometry/MultiPolygon';
-export { GeometryCollection, isGeometryCollection, isStrictGeometryCollection } from './Domain/GeoJSON/GeometryCollection';
-export { Geometry, isGeometry, isStrictGeometry } from './Domain/GeoJSON/Geometry';
-export { Feature, isFeature, isStrictFeature } from './Domain/GeoJSON/Feature';
-export { FeatureCollection, isFeatureCollection, isStrictFeatureCollection } from './Domain/GeoJSON/FeatureCollection';
-export { GeoJSON, isGeoJSON, isStrictGeoJSON } from './Domain/GeoJSON/GeoJSON';
+import * as _konfirm_guard from '@konfirm/guard';
+import { Guard } from '@konfirm/guard';
+
+type Altitude = number;
+
+type Latitude = number;
+
+type Longitude = number;
+
+type Position = [Longitude, Latitude, Altitude?];
+declare const isPosition: _konfirm_guard.Guard<Position>;
+declare const isStrictPosition: _konfirm_guard.Guard<Position>;
+
+type BoundingBox = [Longitude, Latitude, Altitude, Longitude, Latitude, Altitude] | [Longitude, Latitude, Longitude, Latitude];
+
+type GeoJSONBase = {
+    type: string;
+    bbox?: BoundingBox;
+    [key: string]: unknown;
+};
+type GeoJSONObject<T extends GeoJSONBase = GeoJSONBase> = GeoJSONBase & T;
+
+type GeometryBase = GeoJSONObject & {
+    coordinates: Array<unknown>;
+};
+type GeometryObject<T extends GeometryBase> = Omit<GeometryBase, 'coordinates'> & T;
+type MultiGeometryObject<T extends GeometryBase> = GeometryObject<{
+    type: `Multi${T['type']}`;
+    coordinates: Array<T['coordinates']>;
+}>;
+
+type Point = GeometryObject<{
+    type: 'Point';
+    coordinates: Position;
+}>;
+declare const isPoint: Guard<Point>;
+declare const isStrictPoint: Guard<Point>;
+
+type MultiPoint = MultiGeometryObject<Point>;
+declare const isMultiPoint: Guard<MultiPoint>;
+declare const isStrictMultiPoint: Guard<MultiPoint>;
+
+type LineString = GeometryObject<{
+    type: 'LineString';
+    coordinates: MultiPoint['coordinates'];
+}>;
+declare const isLineString: Guard<LineString>;
+declare const isStrictLineString: Guard<LineString>;
+
+type MultiLineString = MultiGeometryObject<LineString>;
+declare const isMultiLineString: _konfirm_guard.Guard<MultiLineString>;
+declare const isStrictMultiLineString: _konfirm_guard.Guard<MultiLineString>;
+
+type LinearRing = Array<Position>;
+
+type ExteriorRing = LinearRing;
+
+type InteriorRing = LinearRing;
+
+type Polygon = GeometryObject<{
+    type: 'Polygon';
+    coordinates: [ExteriorRing, ...Array<InteriorRing>];
+}>;
+declare const isPolygon: _konfirm_guard.Guard<Polygon>;
+declare const isStrictPolygon: _konfirm_guard.Guard<Polygon>;
+
+type MultiPolygon = MultiGeometryObject<Polygon>;
+declare const isMultiPolygon: _konfirm_guard.Guard<MultiPolygon>;
+declare const isStrictMultiPolygon: _konfirm_guard.Guard<MultiPolygon>;
+
+type Geometry = Point | MultiPoint | LineString | MultiLineString | Polygon | MultiPolygon;
+declare const isGeometry: _konfirm_guard.Guard<Geometry>;
+declare const isStrictGeometry: _konfirm_guard.Guard<Geometry>;
+
+type GeometryCollection = GeoJSONObject<{
+    type: 'GeometryCollection';
+    geometries: Array<Geometry | GeometryCollection>;
+}>;
+declare function isGeometryCollection(value: unknown): value is GeometryCollection;
+declare function isStrictGeometryCollection(value: unknown): value is GeometryCollection;
+
+type Feature = GeoJSONObject<{
+    type: 'Feature';
+    geometry: Geometry | GeometryCollection;
+    properties: {
+        [key: string]: unknown;
+    } | null;
+}>;
+declare const isFeature: _konfirm_guard.Guard<Feature>;
+declare const isStrictFeature: _konfirm_guard.Guard<Feature>;
+
+type FeatureCollection = GeoJSONObject<{
+    type: 'FeatureCollection';
+    features: Array<Feature>;
+}>;
+declare const isFeatureCollection: _konfirm_guard.Guard<FeatureCollection>;
+declare const isStrictFeatureCollection: _konfirm_guard.Guard<FeatureCollection>;
+
+type GeoJSON = Geometry | GeometryCollection | Feature | FeatureCollection;
+declare const isGeoJSON: _konfirm_guard.Guard<GeoJSON>;
+declare const isStrictGeoJSON: _konfirm_guard.Guard<GeoJSON>;
+
+type SimpleGeometry = Point | LineString | Polygon;
+/**
+ * Iterator class to turn any GeoJSON structure into one or more SimpleGeometry (Point | LineString | Polygon) objects
+ *
+ * @export
+ * @class SimpleGeometryIterator
+ */
+declare class SimpleGeometryIterator {
+    private readonly inputs;
+    constructor(...inputs: [GeoJSON, ...Array<GeoJSON>]);
+    /**
+     * Generator yielding all SimpleGeometry objects from the provided GeoJSON structure(s)
+     *
+     * @return {*}  {Iterator<SimpleGeometry>}
+     * @memberof SimpleGeometryIterator
+     */
+    [Symbol.iterator](): Iterator<SimpleGeometry>;
+    /**
+     * unwrap any GeoJSON object into one or more SimpleGeometry object
+     *
+     * @private
+     * @param {GeoJSON} geo
+     * @return {*}  {Iterable<SimpleGeometry>}
+     * @memberof SimpleGeometryIterator
+     */
+    private unwrap;
+}
+
+type PointToPointCalculation = 'cartesian' | 'haversine' | 'vincenty' | ((a: Point['coordinates'], b: Point['coordinates']) => number);
+
+declare function distance(a: GeoJSON, b: GeoJSON, calculation?: PointToPointCalculation): number;
+
+declare function intersect(a: GeoJSON, b: GeoJSON): boolean;
+
+export { type Feature, type FeatureCollection, type GeoJSON, type Geometry, type GeometryCollection, type LineString, type MultiLineString, type MultiPoint, type MultiPolygon, type Point, type Polygon, type Position, SimpleGeometryIterator, distance, intersect, isFeature, isFeatureCollection, isGeoJSON, isGeometry, isGeometryCollection, isLineString, isMultiLineString, isMultiPoint, isMultiPolygon, isPoint, isPolygon, isPosition, isStrictFeature, isStrictFeatureCollection, isStrictGeoJSON, isStrictGeometry, isStrictGeometryCollection, isStrictLineString, isStrictMultiLineString, isStrictMultiPoint, isStrictMultiPolygon, isStrictPoint, isStrictPolygon, isStrictPosition };