@procedures/geo 0.3.0 → 0.5.0

package/src/procedures/geo/geohash.ts

@@ -0,0 +1,16 @@
+/**
+ * geo.geohash procedure
+ *
+ * Give the geohash of a point
+ */
+
+import { decodeGeohash, geohash } from "../../geohash.js";
+import type { GeoGeohashInput, GeoGeohashOutput } from "../../types.js";
+
+/**
+ * This function gives the geohash of a point and the cell of that geohash. It changes nothing.
+ */
+export async function geoGeohash(input: GeoGeohashInput): Promise<GeoGeohashOutput> {
+  const hash = geohash(input.point, input.precision);
+  return { hash, cell: decodeGeohash(hash) };
+}

package/src/procedures/geo/index.ts

@@ -0,0 +1,2 @@
+export { geoDistance } from "./distance.js";
+export { geoGeohash } from "./geohash.js";

package/src/procedures.ts

@@ -1,12 +1,25 @@
 /**
- * The procedures of `@procedures/geo`: `geo.geocode` and `geo.route`.
+ * The procedures of `@procedures/geo`: `geo.geocode`, `geo.route`, `geo.distance` and `geo.geohash`.
  */
 
 import { createProcedure, zodAdapter, type AnyProcedure, type ProcedureContext } from "@procedures/client";
 import { z } from "zod";
 import { drivingRoute, geocode, type GeocodeResult, type RouteResult } from "./geo.js";
+import { geoDistance } from "./procedures/geo/distance.js";
+import { geoGeohash } from "./procedures/geo/geohash.js";
+import {
+  GeoDistanceInputSchema,
+  GeoDistanceOutputSchema,
+  GeoGeohashInputSchema,
+  GeoGeohashOutputSchema,
+  type GeoDistanceInput,
+  type GeoDistanceOutput,
+  type GeoGeohashInput,
+  type GeoGeohashOutput,
+} from "./types.js";
 
 const NETWORK_READ = { reads: ["network"], writes: [] };
+const PURE = { reads: [], writes: [] };
 const point = z.object({ lat: z.number().min(-90).max(90), lon: z.number().min(-180).max(180) });
 const timeoutMs = z.number().int().positive().max(120_000).default(20_000).describe("The time limit, in milliseconds (default: 20000)");
 
@@ -79,4 +92,36 @@ export const geoRouteProcedure: AnyProcedure = createProcedure()
   )
   .build() as AnyProcedure;
 
-export const geoProcedures: AnyProcedure[] = [geoGeocodeProcedure, geoRouteProcedure];
+// =============================================================================
+// geo.distance
+// =============================================================================
+
+export const geoDistanceProcedure: AnyProcedure = createProcedure()
+  .path(["geo", "distance"])
+  .input(zodAdapter<GeoDistanceInput>(GeoDistanceInputSchema))
+  .output(zodAdapter<GeoDistanceOutput>(GeoDistanceOutputSchema))
+  .meta({
+    description: "Give the great-circle distance between two points in kilometres (haversine), without the network",
+    output: "json",
+    effects: PURE,
+  })
+  .handler(async (input: GeoDistanceInput): Promise<GeoDistanceOutput> => geoDistance(input))
+  .build() as AnyProcedure;
+
+// =============================================================================
+// geo.geohash
+// =============================================================================
+
+export const geoGeohashProcedure: AnyProcedure = createProcedure()
+  .path(["geo", "geohash"])
+  .input(zodAdapter<GeoGeohashInput>(GeoGeohashInputSchema))
+  .output(zodAdapter<GeoGeohashOutput>(GeoGeohashOutputSchema))
+  .meta({
+    description: "Give the geohash of a point and the cell of that geohash, without the network",
+    output: "json",
+    effects: PURE,
+  })
+  .handler(async (input: GeoGeohashInput): Promise<GeoGeohashOutput> => geoGeohash(input))
+  .build() as AnyProcedure;
+
+export const geoProcedures: AnyProcedure[] = [geoGeocodeProcedure, geoRouteProcedure, geoDistanceProcedure, geoGeohashProcedure];

package/src/types.ts

@@ -0,0 +1,67 @@
+/**
+ * Type definitions of the procedures of this package
+ */
+
+import { z } from "zod";
+import type { Point } from "./geo.js";
+import type { GeohashCell } from "./geohash.js";
+
+const point = z.object({ lat: z.number().min(-90).max(90), lon: z.number().min(-180).max(180) });
+
+// =============================================================================
+// geo.distance Types - Give the great-circle distance between two points
+// =============================================================================
+
+/** The input of `geo.distance`: two points. */
+export interface GeoDistanceInput {
+  from: Point;
+  to: Point;
+}
+
+/** The output of `geo.distance`: the great-circle distance in kilometres, without rounding. */
+export interface GeoDistanceOutput {
+  km: number;
+}
+
+export const GeoDistanceInputSchema: z.ZodType<GeoDistanceInput> = z.object({
+  from: point.describe("The first point (degrees)"),
+  to: point.describe("The second point (degrees)"),
+});
+
+export const GeoDistanceOutputSchema: z.ZodType<GeoDistanceOutput> = z.object({
+  km: z.number().describe("The great-circle distance in kilometres (haversine, Earth radius 6371 km), without rounding"),
+});
+
+// =============================================================================
+// geo.geohash Types - Give the geohash of a point
+// =============================================================================
+
+/** The input of `geo.geohash`: a point and the number of characters. */
+export interface GeoGeohashInput {
+  point: Point;
+  precision: number;
+}
+
+/** The output of `geo.geohash`: the geohash and its cell. */
+export interface GeoGeohashOutput {
+  hash: string;
+  cell: GeohashCell;
+}
+
+export const GeoGeohashInputSchema: z.ZodType<GeoGeohashInput, { point: Point; precision?: number | undefined }> = z.object({
+  point: point.describe("The point (degrees)"),
+  precision: z.number().int().min(1).max(12).default(7).describe("The number of characters, from 1 to 12 (default: 7)"),
+});
+
+export const GeoGeohashOutputSchema: z.ZodType<GeoGeohashOutput> = z.object({
+  hash: z.string().describe("The geohash"),
+  cell: z
+    .object({
+      south: z.number(),
+      west: z.number(),
+      north: z.number(),
+      east: z.number(),
+      center: z.object({ lat: z.number(), lon: z.number() }),
+    })
+    .describe("The cell of the geohash: its edges and its center (degrees)"),
+});