@geospatial-sdk/geocoding 0.0.5-alpha.0 → 0.0.5-alpha.2

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./providers";
+export * from "./model";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC"}

package/dist/index.js

@@ -1 +1,2 @@
 export * from "./providers";
+export * from "./model";

package/dist/providers/geoadmin.provider.d.ts

@@ -19,5 +19,4 @@ export interface GeoadminOptions {
     features?: string[];
 }
 export declare function queryGeoadmin(input: string, options?: GeoadminOptions): Promise<GeocodingResult[]>;
-export declare function sayHello(): string;
 //# sourceMappingURL=geoadmin.provider.d.ts.map

package/dist/providers/geoadmin.provider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"geoadmin.provider.d.ts","sourceRoot":"","sources":["../../lib/providers/geoadmin.provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,EAAQ,iBAAiB,EAAY,MAAM,SAAS,CAAC;AAK5D,MAAM,MAAM,gBAAgB,GAAG,iBAAiB,CAAC;AAEjD;;;;;;;;GAQG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,CAAC,EAAE,WAAW,GAAG,eAAe,GAAG,QAAQ,CAAC;IAChD,EAAE,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACxC,OAAO,CAAC,EAAE,KAAK,CACX,SAAS,GACT,MAAM,GACN,UAAU,GACV,SAAS,GACT,WAAW,GACX,SAAS,GACT,QAAQ,CACX,CAAC;IACF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;IACxC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB;AAED,wBAAgB,aAAa,CAC3B,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,eAAe,EAAE,CAAC,CAyC5B;AAED,wBAAgB,QAAQ,WAGvB"}
+{"version":3,"file":"geoadmin.provider.d.ts","sourceRoot":"","sources":["../../lib/providers/geoadmin.provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,EAAQ,iBAAiB,EAAY,MAAM,SAAS,CAAC;AAK5D,MAAM,MAAM,gBAAgB,GAAG,iBAAiB,CAAC;AAEjD;;;;;;;;GAQG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,CAAC,EAAE,WAAW,GAAG,eAAe,GAAG,QAAQ,CAAC;IAChD,EAAE,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACxC,OAAO,CAAC,EAAE,KAAK,CACX,SAAS,GACT,MAAM,GACN,UAAU,GACV,SAAS,GACT,WAAW,GACX,SAAS,GACT,QAAQ,CACX,CAAC;IACF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;IACxC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB;AAED,wBAAgB,aAAa,CAC3B,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,eAAe,EAAE,CAAC,CAyC5B"}

package/dist/providers/geoadmin.provider.js

@@ -38,10 +38,6 @@ export function queryGeoadmin(input, options) {
         };
     }));
 }
-export function sayHello() {
-    console.log("hello");
-    return "hello";
-}
 function bboxToGeometry(extent) {
     const [minX, minY, maxX, maxY] = extent;
     return {

package/dist/providers/geonames.provider.d.ts

@@ -0,0 +1,24 @@
+import { GeocodingResult } from "../model";
+/**
+ * Reference documentation: http://www.geonames.org/export/geonames-search.html
+ * @property lang Default is English. Either "local" or iso2 country code should be used
+ * @property maxRows The maximal number of rows in the document returned by the service. Default is 100
+ * @property country Default is all countries. The country parameter may occur more than once, example: country=FR&country=GP
+ * @property style verbosity of returned xml document, default = MEDIUM
+ * @property type The format type of the returned document, default = xml
+ * @property username The parameter 'username' needs to be passed with each request. (https://www.geonames.org/login)
+ * @property east, west, north, south Restrict the search to the given bounding box
+ */
+export interface GeonamesOptions {
+    lang?: string;
+    maxRows?: number;
+    country?: string | string[];
+    style?: "SHORT" | "MEDIUM" | "LONG" | "FULL";
+    username: string;
+    east?: number;
+    west?: number;
+    north?: number;
+    south?: number;
+}
+export declare function queryGeonames(input: string, options?: GeonamesOptions): Promise<GeocodingResult[]>;
+//# sourceMappingURL=geonames.provider.d.ts.map

package/dist/providers/geonames.provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"geonames.provider.d.ts","sourceRoot":"","sources":["../../lib/providers/geonames.provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAK3C;;;;;;;;;GASG;AAEH,MAAM,WAAW,eAAe;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC5B,KAAK,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,MAAM,CAAC;IAC7C,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAQD,wBAAgB,aAAa,CACzB,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,eAAe,GAC1B,OAAO,CAAC,eAAe,EAAE,CAAC,CAuD5B"}

package/dist/providers/geonames.provider.js

@@ -0,0 +1,53 @@
+const baseUrl = "https://secure.geonames.org/searchJSON";
+export function queryGeonames(input, options) {
+    if (!input.trim()) {
+        throw new Error("Input query is required and cannot be empty.");
+    }
+    const baseOptions = {
+        lang: "en",
+        maxRows: 10,
+        style: "FULL",
+        username: "gn_ui",
+    };
+    const finalOptions = Object.assign(Object.assign({}, baseOptions), options);
+    const url = new URL(baseUrl);
+    url.searchParams.set("q", input.trim());
+    url.searchParams.set("username", finalOptions.username);
+    finalOptions.maxRows && url.searchParams.set("maxRows", finalOptions.maxRows.toString());
+    if (typeof finalOptions.country === "string") {
+        url.searchParams.set("country", finalOptions.country);
+    }
+    else if (Array.isArray(finalOptions.country)) {
+        finalOptions.country.forEach(c => url.searchParams.append("country", c));
+    }
+    finalOptions.lang && url.searchParams.set("lang", finalOptions.lang);
+    finalOptions.style && url.searchParams.set("style", finalOptions.style);
+    url.searchParams.set("type", "json");
+    if (finalOptions.east !== undefined && finalOptions.west !== undefined &&
+        finalOptions.north !== undefined && finalOptions.south !== undefined &&
+        finalOptions.east > finalOptions.west && finalOptions.north > finalOptions.south) {
+        url.searchParams.set("east", finalOptions.east.toString());
+        url.searchParams.set("west", finalOptions.west.toString());
+        url.searchParams.set("north", finalOptions.north.toString());
+        url.searchParams.set("south", finalOptions.south.toString());
+    }
+    return fetch(url.toString())
+        .then(response => {
+        if (!response.ok) {
+            throw new Error(`Geonames API returned ${response.status}: ${response.statusText}`);
+        }
+        return response.json();
+    })
+        .then((data) => {
+        if (!data.geonames) {
+            throw new Error('Invalid response from Geonames API: no geonames property');
+        }
+        return data.geonames.map(geoname => ({
+            label: geoname.name,
+            geom: {
+                type: "Point",
+                coordinates: [parseFloat(geoname.lng), parseFloat(geoname.lat)],
+            },
+        }));
+    });
+}

package/dist/providers/geonames.provider.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=geonames.provider.test.d.ts.map

package/dist/providers/geonames.provider.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"geonames.provider.test.d.ts","sourceRoot":"","sources":["../../lib/providers/geonames.provider.test.ts"],"names":[],"mappings":""}

package/dist/providers/geonames.provider.test.js

@@ -0,0 +1,120 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { queryGeonames } from "./geonames.provider";
+import { describe } from "vitest";
+const MOCK_DATA = {
+    totalResultsCount: 35,
+    geonames: [
+        {
+            adminCode1: "ZH",
+            lng: "8.55",
+            geonameId: 2657896,
+            toponymName: "Zürich",
+            countryId: "2658434",
+            fcl: "P",
+            population: 341730,
+            countryCode: "CH",
+            name: "Zurich",
+            fclName: "city, village...",
+            adminCodes1: { ISO3166_2: "ZH" },
+            countryName: "Switzerland",
+            fcodeName: "seat of a first-order administrative division",
+            adminName1: "Zurich",
+            lat: "47.36667",
+            fcode: "PPLA"
+        },
+        {
+            adminCode1: "ZH",
+            lng: "8.66667",
+            geonameId: 2657895,
+            toponymName: "Kanton Zürich",
+            countryId: "2658434",
+            fcl: "A",
+            population: 1553423,
+            countryCode: "CH",
+            name: "Zurich",
+            fclName: "country, state, region...",
+            adminCodes1: { ISO3166_2: "ZH" },
+            countryName: "Switzerland",
+            fcodeName: "first-order administrative division",
+            adminName1: "Zurich",
+            lat: "47.41667",
+            fcode: "ADM1"
+        }
+    ]
+};
+vi.stubGlobal('fetch', vi.fn(() => Promise.resolve({
+    ok: true, // Ensure the mock reflects a successful response
+    json: () => Promise.resolve(MOCK_DATA),
+})));
+describe("queryGeonames", () => {
+    let results;
+    beforeEach(() => {
+        vi.clearAllMocks();
+    });
+    describe("results parsing", () => {
+        beforeEach(() => __awaiter(void 0, void 0, void 0, function* () {
+            results = yield queryGeonames("Zurich");
+        }));
+        it("correctly processes Geonames API response", () => {
+            expect(results).toEqual([
+                {
+                    label: "Zurich",
+                    geom: {
+                        type: "Point",
+                        coordinates: [8.55, 47.36667],
+                    },
+                },
+                {
+                    label: "Zurich",
+                    geom: {
+                        type: "Point",
+                        coordinates: [8.66667, 47.41667],
+                    },
+                },
+            ]);
+        });
+    });
+    describe("default options", () => {
+        beforeEach(() => __awaiter(void 0, void 0, void 0, function* () {
+            results = yield queryGeonames("Zurich");
+        }));
+        it("uses default options", () => {
+            expect(global.fetch).toHaveBeenCalledWith(expect.stringContaining("https://secure.geonames.org/searchJSON?q=Zurich&username=gn_ui&maxRows=10"));
+        });
+    });
+    describe("custom options", () => {
+        beforeEach(() => __awaiter(void 0, void 0, void 0, function* () {
+            results = yield queryGeonames("Zurich", {
+                lang: "de",
+                maxRows: 5,
+                country: "CH",
+                username: "customUser",
+            });
+        }));
+        it("uses given options for custom search", () => {
+            expect(global.fetch).toHaveBeenCalledWith(expect.stringContaining("https://secure.geonames.org/searchJSON?q=Zurich&username=customUser&maxRows=5&country=CH&lang=de&style=FULL&type=json"));
+        });
+    });
+    describe("bounding box search", () => {
+        beforeEach(() => __awaiter(void 0, void 0, void 0, function* () {
+            results = yield queryGeonames("Zurich", {
+                east: 10,
+                west: 5,
+                north: 50,
+                south: 45,
+                username: "customUser",
+            });
+        }));
+        it("uses given options for bounding box search", () => {
+            expect(global.fetch).toHaveBeenCalledWith(expect.stringContaining("https://secure.geonames.org/searchJSON?q=Zurich&username=customUser&maxRows=10&lang=en&style=FULL&type=json&east=10&west=5&north=50&south=45"));
+        });
+    });
+});

package/dist/providers/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./geoadmin.provider";
 export * from "./data-gouv-fr.provider";
+export * from "./geonames.provider";
 //# sourceMappingURL=index.d.ts.map

package/dist/providers/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/providers/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/providers/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC"}

package/dist/providers/index.js

@@ -1,2 +1,3 @@
 export * from "./geoadmin.provider";
 export * from "./data-gouv-fr.provider";
+export * from "./geonames.provider";

package/lib/index.ts

@@ -1 +1,2 @@
 export * from "./providers";
+export * from "./model";

package/lib/providers/geoadmin.provider.ts

@@ -78,12 +78,6 @@ export function queryGeoadmin(
     );
 }
 
-export function sayHello() {
-  console.log("hello")
-  return "hello";
-}
-
-
 function bboxToGeometry(extent: BBox): Geometry {
   const [minX, minY, maxX, maxY] = extent;
   return {

package/lib/providers/geonames.provider.test.ts

@@ -0,0 +1,129 @@
+import {queryGeonames} from "./geonames.provider";
+import { GeocodingResult } from "../model";
+import {describe} from "vitest";
+
+const MOCK_DATA = {
+    totalResultsCount: 35,
+    geonames: [
+        {
+            adminCode1: "ZH",
+            lng: "8.55",
+            geonameId: 2657896,
+            toponymName: "Zürich",
+            countryId: "2658434",
+            fcl: "P",
+            population: 341730,
+            countryCode: "CH",
+            name: "Zurich",
+            fclName: "city, village...",
+            adminCodes1: { ISO3166_2: "ZH" },
+            countryName: "Switzerland",
+            fcodeName: "seat of a first-order administrative division",
+            adminName1: "Zurich",
+            lat: "47.36667",
+            fcode: "PPLA"
+        },
+        {
+            adminCode1: "ZH",
+            lng: "8.66667",
+            geonameId: 2657895,
+            toponymName: "Kanton Zürich",
+            countryId: "2658434",
+            fcl: "A",
+            population: 1553423,
+            countryCode: "CH",
+            name: "Zurich",
+            fclName: "country, state, region...",
+            adminCodes1: { ISO3166_2: "ZH" },
+            countryName: "Switzerland",
+            fcodeName: "first-order administrative division",
+            adminName1: "Zurich",
+            lat: "47.41667",
+            fcode: "ADM1"
+        }
+    ]
+};
+
+vi.stubGlobal('fetch', vi.fn(() =>
+    Promise.resolve({
+        ok: true, // Ensure the mock reflects a successful response
+        json: () => Promise.resolve(MOCK_DATA),
+    }) as unknown as Response
+));
+
+
+describe("queryGeonames", () => {
+    let results: GeocodingResult[];
+
+    beforeEach(() => {
+        vi.clearAllMocks();
+    });
+
+    describe("results parsing", () => {
+        beforeEach(async () => {
+            results = await queryGeonames("Zurich");
+        });
+        it("correctly processes Geonames API response", () => {
+            expect(results).toEqual([
+                {
+                    label: "Zurich",
+                    geom: {
+                        type: "Point",
+                        coordinates: [8.55, 47.36667],
+                    },
+                },
+                {
+                    label: "Zurich",
+                    geom: {
+                        type: "Point",
+                        coordinates: [8.66667, 47.41667],
+                    },
+                },
+            ]);
+        });
+    });
+    describe("default options", () => {
+        beforeEach(async () => {
+            results = await queryGeonames("Zurich");
+        });
+        it("uses default options", () => {
+            expect(global.fetch).toHaveBeenCalledWith(
+                expect.stringContaining("https://secure.geonames.org/searchJSON?q=Zurich&username=gn_ui&maxRows=10")
+            );
+        });
+    });
+
+    describe("custom options", () => {
+        beforeEach(async () => {
+            results = await queryGeonames("Zurich", {
+                lang: "de",
+                maxRows: 5,
+                country: "CH",
+                username: "customUser",
+            });
+        });
+        it("uses given options for custom search", () => {
+            expect(global.fetch).toHaveBeenCalledWith(
+                expect.stringContaining("https://secure.geonames.org/searchJSON?q=Zurich&username=customUser&maxRows=5&country=CH&lang=de&style=FULL&type=json")
+            );
+        });
+    });
+
+    describe("bounding box search", () => {
+        beforeEach(async () => {
+            results = await queryGeonames("Zurich", {
+                east: 10,
+                west: 5,
+                north: 50,
+                south: 45,
+                username: "customUser",
+            });
+        });
+        it("uses given options for bounding box search", () => {
+            expect(global.fetch).toHaveBeenCalledWith(
+                expect.stringContaining("https://secure.geonames.org/searchJSON?q=Zurich&username=customUser&maxRows=10&lang=en&style=FULL&type=json&east=10&west=5&north=50&south=45")
+            );
+        });
+    });
+
+});

package/lib/providers/geonames.provider.ts

@@ -0,0 +1,93 @@
+import { GeocodingResult } from "../model";
+import { Geometry } from "geojson";
+
+const baseUrl = "https://secure.geonames.org/searchJSON";
+
+/**
+ * Reference documentation: http://www.geonames.org/export/geonames-search.html
+ * @property lang Default is English. Either "local" or iso2 country code should be used
+ * @property maxRows The maximal number of rows in the document returned by the service. Default is 100
+ * @property country Default is all countries. The country parameter may occur more than once, example: country=FR&country=GP
+ * @property style verbosity of returned xml document, default = MEDIUM
+ * @property type The format type of the returned document, default = xml
+ * @property username The parameter 'username' needs to be passed with each request. (https://www.geonames.org/login)
+ * @property east, west, north, south Restrict the search to the given bounding box
+ */
+
+export interface GeonamesOptions {
+    lang?: string;
+    maxRows?: number;
+    country?: string | string[]; // Now supports multiple countries
+    style?: "SHORT" | "MEDIUM" | "LONG" | "FULL";
+    username: string;
+    east?: number;
+    west?: number;
+    north?: number;
+    south?: number;
+}
+
+interface GeonameResponse {
+    name: string;
+    lng: string;
+    lat: string;
+}
+
+export function queryGeonames(
+    input: string,
+    options?: GeonamesOptions,
+): Promise<GeocodingResult[]> {
+    if (!input.trim()) {
+        throw new Error("Input query is required and cannot be empty.");
+    }
+
+    const baseOptions: GeonamesOptions = {
+        lang: "en",
+        maxRows: 10,
+        style: "FULL",
+        username: "gn_ui",
+    };
+
+    const finalOptions = { ...baseOptions, ...options };
+
+    const url = new URL(baseUrl);
+    url.searchParams.set("q", input.trim());
+    url.searchParams.set("username", finalOptions.username);
+    finalOptions.maxRows && url.searchParams.set("maxRows", finalOptions.maxRows.toString());
+    if (typeof finalOptions.country === "string") {
+        url.searchParams.set("country", finalOptions.country);
+    } else if (Array.isArray(finalOptions.country)) {
+        finalOptions.country.forEach(c => url.searchParams.append("country", c));
+    }
+    finalOptions.lang && url.searchParams.set("lang", finalOptions.lang);
+    finalOptions.style && url.searchParams.set("style", finalOptions.style);
+    url.searchParams.set("type", "json");
+
+    if (finalOptions.east !== undefined && finalOptions.west !== undefined &&
+        finalOptions.north !== undefined && finalOptions.south !== undefined &&
+        finalOptions.east > finalOptions.west && finalOptions.north > finalOptions.south) {
+        url.searchParams.set("east", finalOptions.east.toString());
+        url.searchParams.set("west", finalOptions.west.toString());
+        url.searchParams.set("north", finalOptions.north.toString());
+        url.searchParams.set("south", finalOptions.south.toString());
+    }
+
+    return fetch(url.toString())
+        .then(response => {
+            if (!response.ok) {
+                throw new Error(`Geonames API returned ${response.status}: ${response.statusText}`);
+            }
+            return response.json();
+        })
+        .then((data: { geonames: GeonameResponse[] }) => {
+            if (!data.geonames) {
+                throw new Error('Invalid response from Geonames API: no geonames property');
+            }
+            return data.geonames.map(geoname => ({
+                label: geoname.name,
+                geom: {
+                    type: "Point",
+                    coordinates: [parseFloat(geoname.lng), parseFloat(geoname.lat)],
+                } as Geometry,
+            }));
+        });
+}

package/lib/providers/index.ts

@@ -1,2 +1,3 @@
 export * from "./geoadmin.provider";
 export * from "./data-gouv-fr.provider";
+export * from "./geonames.provider";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@geospatial-sdk/geocoding",
-  "version": "0.0.5-alpha.0",
+  "version": "0.0.5-alpha.2",
   "description": "Geocoding-related components",
   "keywords": [
     "geocoding"
@@ -32,5 +32,5 @@
   "bugs": {
     "url": "https://github.com/jahow/geospatial-sdk/issues"
   },
-  "gitHead": "99dbb945a303b96e576a02a02bc0590785456bd3"
+  "gitHead": "c61f5acb8eac69b081ef21127092e264306ee99d"
 }