@unmap/geocoding 0.0.1

package/dist/index.d.ts

@@ -0,0 +1,54 @@
+interface GeocoderOptions {
+    key: string;
+    gateway?: string;
+    /** Override the fetch implementation (tests, non-global environments). */
+    fetch?: typeof fetch;
+}
+type GeocodeLayer = "address" | "street" | "locality" | "region" | "poi";
+interface GeocodeResult {
+    id: string;
+    name: string;
+    layer: GeocodeLayer;
+    lng: number;
+    lat: number;
+    score?: number;
+    names?: Record<string, string>;
+    address?: {
+        housenumber?: string;
+        street?: string;
+        city?: string;
+        region?: string;
+        postcode?: string;
+        country?: string;
+    };
+}
+interface SearchOptions {
+    limit?: number;
+    lang?: string;
+    /** [minLng, minLat, maxLng, maxLat] bias/filter. */
+    bbox?: [number, number, number, number];
+    signal?: AbortSignal;
+}
+declare class GeocoderError extends Error {
+    readonly status: number;
+    constructor(status: number, message: string);
+}
+/** Typed client for the unmap geocoding API (gateway `/geocode/*`). */
+declare class Geocoder {
+    private readonly key;
+    private readonly base;
+    private readonly fetchImpl;
+    constructor(opts: GeocoderOptions);
+    /** Full-text search. */
+    search(q: string, opts?: SearchOptions): Promise<GeocodeResult[]>;
+    /** Type-ahead suggestions for partial input. */
+    autocomplete(q: string, opts?: SearchOptions): Promise<GeocodeResult[]>;
+    /** Reverse geocode a coordinate. */
+    reverse(lng: number, lat: number, opts?: {
+        lang?: string;
+        signal?: AbortSignal;
+    }): Promise<GeocodeResult[]>;
+    private query;
+}
+
+export { type GeocodeLayer, type GeocodeResult, Geocoder, GeocoderError, type GeocoderOptions, type SearchOptions };

package/dist/index.js

@@ -0,0 +1,59 @@
+// src/index.ts
+import { DEFAULT_GATEWAY } from "@unmap/core";
+var GeocoderError = class extends Error {
+  constructor(status, message) {
+    super(message);
+    this.status = status;
+    this.name = "GeocoderError";
+  }
+  status;
+};
+var Geocoder = class {
+  key;
+  base;
+  fetchImpl;
+  constructor(opts) {
+    this.key = opts.key;
+    this.base = (opts.gateway ?? DEFAULT_GATEWAY).replace(/\/+$/, "");
+    this.fetchImpl = opts.fetch ?? globalThis.fetch.bind(globalThis);
+  }
+  /** Full-text search. */
+  search(q, opts = {}) {
+    return this.query("/geocode/search", { q, ...toParams(opts) }, opts.signal);
+  }
+  /** Type-ahead suggestions for partial input. */
+  autocomplete(q, opts = {}) {
+    return this.query("/geocode/autocomplete", { q, ...toParams(opts) }, opts.signal);
+  }
+  /** Reverse geocode a coordinate. */
+  reverse(lng, lat, opts = {}) {
+    return this.query(
+      "/geocode/reverse",
+      { lon: String(lng), lat: String(lat), lang: opts.lang },
+      opts.signal
+    );
+  }
+  async query(path, params, signal) {
+    const q = new URLSearchParams({ key: this.key });
+    for (const [k, v] of Object.entries(params)) if (v != null && v !== "") q.set(k, v);
+    const res = await this.fetchImpl(`${this.base}${path}?${q}`, {
+      signal,
+      headers: { accept: "application/json" }
+    });
+    if (!res.ok) throw new GeocoderError(res.status, `geocode ${res.status} on ${path}`);
+    const body = await res.json();
+    return Array.isArray(body) ? body : body.results ?? [];
+  }
+};
+function toParams(o) {
+  return {
+    limit: o.limit != null ? String(o.limit) : void 0,
+    lang: o.lang,
+    bbox: o.bbox ? o.bbox.join(",") : void 0
+  };
+}
+export {
+  Geocoder,
+  GeocoderError
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { DEFAULT_GATEWAY } from \"@unmap/core\";\n\nexport interface GeocoderOptions {\n  key: string;\n  gateway?: string;\n  /** Override the fetch implementation (tests, non-global environments). */\n  fetch?: typeof fetch;\n}\n\nexport type GeocodeLayer = \"address\" | \"street\" | \"locality\" | \"region\" | \"poi\";\n\nexport interface GeocodeResult {\n  id: string;\n  name: string;\n  layer: GeocodeLayer;\n  lng: number;\n  lat: number;\n  score?: number;\n  names?: Record<string, string>;\n  address?: {\n    housenumber?: string;\n    street?: string;\n    city?: string;\n    region?: string;\n    postcode?: string;\n    country?: string;\n  };\n}\n\nexport interface SearchOptions {\n  limit?: number;\n  lang?: string;\n  /** [minLng, minLat, maxLng, maxLat] bias/filter. */\n  bbox?: [number, number, number, number];\n  signal?: AbortSignal;\n}\n\nexport class GeocoderError extends Error {\n  constructor(\n    public readonly status: number,\n    message: string,\n  ) {\n    super(message);\n    this.name = \"GeocoderError\";\n  }\n}\n\n/** Typed client for the unmap geocoding API (gateway `/geocode/*`). */\nexport class Geocoder {\n  private readonly key: string;\n  private readonly base: string;\n  private readonly fetchImpl: typeof fetch;\n\n  constructor(opts: GeocoderOptions) {\n    this.key = opts.key;\n    this.base = (opts.gateway ?? DEFAULT_GATEWAY).replace(/\\/+$/, \"\");\n    // Bound to globalThis: stored on an instance and called as `this.fetchImpl(...)`, a bare\n    // `fetch` reference is invoked with the Geocoder as its receiver, and browsers reject that\n    // with \"Illegal invocation\". Node is lenient, so this only ever surfaces in the browser.\n    this.fetchImpl = opts.fetch ?? globalThis.fetch.bind(globalThis);\n  }\n\n  /** Full-text search. */\n  search(q: string, opts: SearchOptions = {}): Promise<GeocodeResult[]> {\n    return this.query(\"/geocode/search\", { q, ...toParams(opts) }, opts.signal);\n  }\n\n  /** Type-ahead suggestions for partial input. */\n  autocomplete(q: string, opts: SearchOptions = {}): Promise<GeocodeResult[]> {\n    return this.query(\"/geocode/autocomplete\", { q, ...toParams(opts) }, opts.signal);\n  }\n\n  /** Reverse geocode a coordinate. */\n  reverse(\n    lng: number,\n    lat: number,\n    opts: { lang?: string; signal?: AbortSignal } = {},\n  ): Promise<GeocodeResult[]> {\n    return this.query(\n      \"/geocode/reverse\",\n      { lon: String(lng), lat: String(lat), lang: opts.lang },\n      opts.signal,\n    );\n  }\n\n  private async query(\n    path: string,\n    params: Record<string, string | undefined>,\n    signal?: AbortSignal,\n  ): Promise<GeocodeResult[]> {\n    const q = new URLSearchParams({ key: this.key });\n    for (const [k, v] of Object.entries(params)) if (v != null && v !== \"\") q.set(k, v);\n    const res = await this.fetchImpl(`${this.base}${path}?${q}`, {\n      signal,\n      headers: { accept: \"application/json\" },\n    });\n    if (!res.ok) throw new GeocoderError(res.status, `geocode ${res.status} on ${path}`);\n    const body = (await res.json()) as { results?: GeocodeResult[] } | GeocodeResult[];\n    return Array.isArray(body) ? body : (body.results ?? []);\n  }\n}\n\nfunction toParams(o: SearchOptions): Record<string, string | undefined> {\n  return {\n    limit: o.limit != null ? String(o.limit) : undefined,\n    lang: o.lang,\n    bbox: o.bbox ? o.bbox.join(\",\") : undefined,\n  };\n}\n"],"mappings":";AAAA,SAAS,uBAAuB;AAqCzB,IAAM,gBAAN,cAA4B,MAAM;AAAA,EACvC,YACkB,QAChB,SACA;AACA,UAAM,OAAO;AAHG;AAIhB,SAAK,OAAO;AAAA,EACd;AAAA,EALkB;AAMpB;AAGO,IAAM,WAAN,MAAe;AAAA,EACH;AAAA,EACA;AAAA,EACA;AAAA,EAEjB,YAAY,MAAuB;AACjC,SAAK,MAAM,KAAK;AAChB,SAAK,QAAQ,KAAK,WAAW,iBAAiB,QAAQ,QAAQ,EAAE;AAIhE,SAAK,YAAY,KAAK,SAAS,WAAW,MAAM,KAAK,UAAU;AAAA,EACjE;AAAA;AAAA,EAGA,OAAO,GAAW,OAAsB,CAAC,GAA6B;AACpE,WAAO,KAAK,MAAM,mBAAmB,EAAE,GAAG,GAAG,SAAS,IAAI,EAAE,GAAG,KAAK,MAAM;AAAA,EAC5E;AAAA;AAAA,EAGA,aAAa,GAAW,OAAsB,CAAC,GAA6B;AAC1E,WAAO,KAAK,MAAM,yBAAyB,EAAE,GAAG,GAAG,SAAS,IAAI,EAAE,GAAG,KAAK,MAAM;AAAA,EAClF;AAAA;AAAA,EAGA,QACE,KACA,KACA,OAAgD,CAAC,GACvB;AAC1B,WAAO,KAAK;AAAA,MACV;AAAA,MACA,EAAE,KAAK,OAAO,GAAG,GAAG,KAAK,OAAO,GAAG,GAAG,MAAM,KAAK,KAAK;AAAA,MACtD,KAAK;AAAA,IACP;AAAA,EACF;AAAA,EAEA,MAAc,MACZ,MACA,QACA,QAC0B;AAC1B,UAAM,IAAI,IAAI,gBAAgB,EAAE,KAAK,KAAK,IAAI,CAAC;AAC/C,eAAW,CAAC,GAAG,CAAC,KAAK,OAAO,QAAQ,MAAM,EAAG,KAAI,KAAK,QAAQ,MAAM,GAAI,GAAE,IAAI,GAAG,CAAC;AAClF,UAAM,MAAM,MAAM,KAAK,UAAU,GAAG,KAAK,IAAI,GAAG,IAAI,IAAI,CAAC,IAAI;AAAA,MAC3D;AAAA,MACA,SAAS,EAAE,QAAQ,mBAAmB;AAAA,IACxC,CAAC;AACD,QAAI,CAAC,IAAI,GAAI,OAAM,IAAI,cAAc,IAAI,QAAQ,WAAW,IAAI,MAAM,OAAO,IAAI,EAAE;AACnF,UAAM,OAAQ,MAAM,IAAI,KAAK;AAC7B,WAAO,MAAM,QAAQ,IAAI,IAAI,OAAQ,KAAK,WAAW,CAAC;AAAA,EACxD;AACF;AAEA,SAAS,SAAS,GAAsD;AACtE,SAAO;AAAA,IACL,OAAO,EAAE,SAAS,OAAO,OAAO,EAAE,KAAK,IAAI;AAAA,IAC3C,MAAM,EAAE;AAAA,IACR,MAAM,EAAE,OAAO,EAAE,KAAK,KAAK,GAAG,IAAI;AAAA,EACpC;AACF;","names":[]}

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@unmap/geocoding",
+  "version": "0.0.1",
+  "description": "Typed client for the unmap geocoding API",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@unmap/core": "0.0.1"
+  },
+  "devDependencies": {
+    "tsup": "^8.3.0",
+    "typescript": "^5.6.0",
+    "vitest": "^2.1.0"
+  },
+  "scripts": {
+    "build": "tsup",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit"
+  }
+}