@konfirm/geojson 1.0.0

package/dist/Domain/Iterator/IterablePair.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Iterator class which traverses all value pairs of two or more Iterable instances
+ *
+ * @export
+ * @class IterablePairIterator
+ * @template T
+ */
+export declare class IterablePairIterator<T = unknown> {
+    private readonly iterators;
+    /**
+     * Constructs a new instance of IterablePairIterator
+     *
+     * @param iterators
+     */
+    constructor(...iterators: [Iterable<T>, Iterable<T>, ...Array<Iterable<T>>]);
+    /**
+     * Generator yielding all value pairs from the provided iterators
+     *
+     * @return {*}  {Iterator<[T, T]>}
+     * @memberof IterablePairIterator
+     */
+    [Symbol.iterator](): Iterator<[T, T]>;
+    /**
+     * Create unique Iterator<T> combinations to traverse over
+     *
+     * @private
+     * @param {Array<Iterable<T>>} source
+     * @return {*}  {Array<[Iterable<T>, Iterable<T>]>}
+     * @memberof IterablePairIterator
+     */
+    private pairs;
+}

package/dist/Domain/Iterator/SimpleGeometry.d.ts

@@ -0,0 +1,90 @@
+import { LineString, Point, Polygon } from "../../main";
+import { GeoJSON } from "../GeoJSON/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
+ */
+export 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)
+     *
+     * @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;
+    /**
+     * 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 {};

package/dist/Domain/Utility/Calculate.d.ts

@@ -0,0 +1,9 @@
+import { Point } from "../GeoJSON/Geometry/Point";
+export type PointToPointCalculation = 'cartesian' | 'haversine' | 'vincenty' | ((a: Point['coordinates'], b: Point['coordinates']) => number);
+export declare function getClosestPointOnLineByPoint(point: Point['coordinates'], line: [Point['coordinates'], Point['coordinates']]): Point['coordinates'];
+export declare function getDistanceOfPointToPoint(a: Point['coordinates'], b: Point['coordinates'], calculation: PointToPointCalculation): number;
+export declare function getDistanceOfPointToLine(point: Point['coordinates'], line: [Point['coordinates'], Point['coordinates']], calculation: PointToPointCalculation): number;
+export declare function getDistanceOfLineToLine(a: [Point['coordinates'], Point['coordinates']], b: [Point['coordinates'], Point['coordinates']], calculation: PointToPointCalculation): number;
+export declare function isLinesCrossing(a: [Point['coordinates'], Point['coordinates']], b: [Point['coordinates'], Point['coordinates']]): boolean;
+export declare function isPointOnLine(point: Point['coordinates'], line: [Point['coordinates'], Point['coordinates']], threshold?: number): boolean;
+export declare function isPointInRing(p: Point['coordinates'], ring: Array<Point['coordinates']>): boolean;

package/dist/Domain/Utility/Distance.d.ts

@@ -0,0 +1,3 @@
+import { GeoJSON } from '../GeoJSON/GeoJSON';
+import { PointToPointCalculation } from './Calculate';
+export declare function distance(a: GeoJSON, b: GeoJSON, calculation?: PointToPointCalculation): number;

package/dist/Domain/Utility/Intersect.d.ts

@@ -0,0 +1,2 @@
+import { GeoJSON } from '../GeoJSON/GeoJSON';
+export declare function intersect(a: GeoJSON, b: GeoJSON): boolean;

package/dist/Domain/Utility/Segments.d.ts

@@ -0,0 +1,2 @@
+import { Point } from '../GeoJSON/Geometry/Point';
+export declare function segments(line: Array<Point['coordinates']>): Array<[Point['coordinates'], Point['coordinates']]>;

package/dist/Domain/Utility/Winding.d.ts

@@ -0,0 +1,3 @@
+import { Position } from "../GeoJSON/Concept/Position";
+export declare function isClockwiseWinding<T extends Array<Position>>(value: any): value is T;
+export declare function isCounterClockwiseWinding<T extends Array<Position>>(value: any): value is T;