@konfirm/geojson 1.0.0

package/dist/geojson.d.ts

@@ -0,0 +1,198 @@
+import * as _konfirm_guard from '@konfirm/guard';
+
+type Guard<T> = (value: any) => value is T;
+
+type Longitude = number;
+
+type Latitude = number;
+
+type Altitude = number;
+
+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 Position = [Longitude, Latitude, Altitude?];
+declare const isPosition: _konfirm_guard.Guard<Position>;
+declare const isStrictPosition: _konfirm_guard.Guard<Position>;
+
+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: _konfirm_guard.Guard<MultiPoint>;
+declare const isStrictMultiPoint: _konfirm_guard.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: any): value is GeometryCollection;
+declare function isStrictGeometryCollection(value: any): 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>;
+
+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
+ *
+ * @export
+ * @class SimpleGeometryIterator
+ */
+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 { 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 };