zod-geojson 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Reinert Lemmens
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,107 @@
+# Zod GeoJSON
+
+This repository contains GeoJSON schemas for the [Zod](https://github.com/colinhacks/zod) validation library.
+
+The schemas are based on the GeoJSON specification found in this RFC: https://datatracker.ietf.org/doc/html/rfc7946. The
+schemas do not only validate the basic structure of the GeoJSON objects but also the validity of the geometries and
+bounding boxes.
+
+## Getting Started
+
+To use these schemas, you can install the package from npm:
+
+```bash
+# With NPM
+npm install zod-geojson
+# With Yarn
+yarn add zod-geojson
+# With PNPM
+pnpm add zod-geojson
+```
+
+## Usage Example
+
+Then you can use the schemas in your code:
+
+```typescript
+import { GeoJSONSchema } from "zod-geojson";
+
+const schema = GeoJSONSchema.parse({
+    type: "Feature",
+    geometry: {
+        type: "Point",
+        coordinates: [0, 0],
+    },
+    properties: {
+        name: "Null Island",
+    },
+});
+```
+
+This library also exposes schemas for the individual GeoJSON types:
+
+```typescript
+import {
+    GeoJSONFeatureSchema,
+    GeoJSONFeatureCollectionSchema,
+    GeoJSONGeometrySchema,
+    GeoJSONGeometryCollectionSchema,
+    GeoJSONMultiPolygonSchema,
+    GeoJSONMultiLineStringSchema,
+    GeoJSONMultiPointSchema,
+    GeoJSONPolygonSchema,
+    GeoJSONLineStringSchema,
+    GeoJSONPointSchema,
+} from "zod-geojson";
+```
+
+It also exposes the resulting types from the schemas:
+
+```typescript
+import type {
+    GeoJSONFeature,
+    GeoJSONFeatureCollection,
+    GeoJSONGeometry,
+    GeoJSONGeometryCollection,
+    GeoJSONMultiPolygon,
+    GeoJSONMultiLineString,
+    GeoJSONMultiPoint,
+    GeoJSONPolygon,
+    GeoJSONLineString,
+    GeoJSONPoint,
+} from "zod-geojson";
+```
+
+## Error Cases
+
+This library will throw an error if the GeoJSON object is not valid. For example, where the coordinates type does
+not match the geometry type:
+
+```typescript
+import { GeoJSONSchema } from "zod-geojson";
+
+const schema = GeoJSONSchema.parse({
+    type: "Point",
+    coordinates: [[0, 0]],
+});
+```
+
+It will also throw an error if the bounding box does not match the geometry:
+
+```typescript
+import { GeoJSONSchema } from "zod-geojson";
+
+const schema = GeoJSONSchema.parse({
+    type: "MultiPoint",
+    coordinates: [
+        [-2, 0],
+        [3, 4],
+        [2, -1],
+    ],
+    bbox: [0, 0, 1, 1],
+});
+```
+
+## Contributing
+
+If you find any issues with the schemas or want to add new features, feel free to open an issue or a pull request.

package/lib/base.d.ts

@@ -0,0 +1,9 @@
+import { z } from "zod";
+export declare const GeoJSONBaseSchema: z.ZodObject<{
+    bbox: z.ZodOptional<z.ZodEffects<z.ZodArray<z.ZodNumber, "many">, number[], number[]>>;
+}, "strip", z.ZodTypeAny, {
+    bbox?: number[] | undefined;
+}, {
+    bbox?: number[] | undefined;
+}>;
+//# sourceMappingURL=base.d.ts.map

package/lib/base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../src/base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,eAAO,MAAM,iBAAiB;;;;;;EAE5B,CAAC"}

package/lib/base.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GeoJSONBaseSchema = void 0;
+var zod_1 = require("zod");
+var bbox_1 = require("./bbox");
+exports.GeoJSONBaseSchema = zod_1.z.object({
+    bbox: bbox_1.GeoJSONBBoxSchema.optional(),
+});

package/lib/bbox.d.ts

@@ -0,0 +1,4 @@
+import { z } from "zod";
+export declare const GeoJSONBBoxSchema: z.ZodEffects<z.ZodArray<z.ZodNumber, "many">, number[], number[]>;
+export type GeoJSONBbox = z.infer<typeof GeoJSONBBoxSchema>;
+//# sourceMappingURL=bbox.d.ts.map

package/lib/bbox.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bbox.d.ts","sourceRoot":"","sources":["../src/bbox.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,eAAO,MAAM,iBAAiB,mEAGmE,CAAC;AAClG,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC"}

package/lib/bbox.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GeoJSONBBoxSchema = void 0;
+var zod_1 = require("zod");
+var position_1 = require("./position");
+exports.GeoJSONBBoxSchema = zod_1.z
+    .array(zod_1.z.number())
+    .min(position_1.MIN_POSITION * 2)
+    .refine(function (bbox) { return bbox.length % 2 === 0; }, "Bounding box must have an even number of elements");