@geospatial-sdk/geocoding 0.0.5-dev.43 → 0.0.5-dev.45

package/README.md

@@ -1,11 +1,27 @@
-# `geocoding`
+# `@geospatial-sdk/geocoding`
 
-> TODO: description
+<!-- #region body -->
 
-## Usage
+This package provides a unified interface for working with various geocoding services.
+
+## Installation
 
+```sh
+npm install @geospatial-sdk/geocoding
 ```
-const geocoding = require('geocoding');
 
-// TODO: DEMONSTRATE API
+## Usage
+
+```typescript
+import { queryDataGouvFr } from "@geospatial-sdk/geocoding";
+
+const results = await queryDataGouvFr("Paris, France");
+console.log(results[0].label); // "Paris 75000"
+console.log(results[0].geom); // GeoJSON Geometry object
 ```
+
+<!-- #endregion body -->
+
+## Documentation
+
+For more detailed API documentation, see the [documentation website](https://camptocamp.github.io/geospatial-sdk/docs/).

package/dist/index.d.ts

@@ -1,3 +1,8 @@
+/**
+ * {@include ../README.md#body}
+ *
+ * @module 📦 geocoding
+ */
 export * from "./providers/index.js";
 export * from "./model/index.js";
 //# 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,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC"}

package/dist/index.js

@@ -1,2 +1,7 @@
+/**
+ * {@include ../README.md#body}
+ *
+ * @module 📦 geocoding
+ */
 export * from "./providers/index.js";
 export * from "./model/index.js";

package/dist/model/index.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @group Types
+ * @packageDocumentation
+ */
 import { type Geometry } from "geojson";
 export interface GeocodingResult {
     label: string;

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/model/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,SAAS,CAAC;AAExC,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,QAAQ,GAAG,IAAI,CAAC;CACvB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/model/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,SAAS,CAAC;AAExC,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,QAAQ,GAAG,IAAI,CAAC;CACvB"}

package/dist/model/index.js

@@ -1 +1,5 @@
+/**
+ * @group Types
+ * @packageDocumentation
+ */
 export {};

package/dist/providers/index.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @group Providers
+ * @packageDocumentation
+ */
 export * from "./geoadmin.provider.js";
 export * from "./data-gouv-fr.provider.js";
 export * from "./geonames.provider.js";

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,wBAAwB,CAAC;AACvC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,wBAAwB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/providers/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,wBAAwB,CAAC;AACvC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,wBAAwB,CAAC"}

package/dist/providers/index.js

@@ -1,3 +1,7 @@
+/**
+ * @group Providers
+ * @packageDocumentation
+ */
 export * from "./geoadmin.provider.js";
 export * from "./data-gouv-fr.provider.js";
 export * from "./geonames.provider.js";

package/lib/index.ts

@@ -1,2 +1,8 @@
+/**
+ * {@include ../README.md#body}
+ *
+ * @module 📦 geocoding
+ */
+
 export * from "./providers/index.js";
 export * from "./model/index.js";

package/lib/model/index.ts

@@ -1,3 +1,8 @@
+/**
+ * @group Types
+ * @packageDocumentation
+ */
+
 import { type Geometry } from "geojson";
 
 export interface GeocodingResult {

package/lib/providers/data-gouv-fr.provider.test.ts

@@ -1,5 +1,8 @@
-import { GeocodingResult } from "../model";
-import { DataGouvFrResponse, queryDataGouvFr } from "./data-gouv-fr.provider";
+import { GeocodingResult } from "../model/index.js";
+import {
+  DataGouvFrResponse,
+  queryDataGouvFr,
+} from "./data-gouv-fr.provider.js";
 
 const RESULTS_FIXTURE: DataGouvFrResponse = {
   type: "FeatureCollection",

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

@@ -1,5 +1,5 @@
-import { GeoadminResponse, queryGeoadmin } from "./geoadmin.provider";
-import { GeocodingResult } from "../model";
+import { GeoadminResponse, queryGeoadmin } from "./geoadmin.provider.js";
+import { GeocodingResult } from "../model/index.js";
 
 const RESULTS_FIXTURE: GeoadminResponse = {
   type: "FeatureCollection",

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

@@ -1,5 +1,5 @@
-import { queryGeonames } from "./geonames.provider";
-import { GeocodingResult } from "../model";
+import { queryGeonames } from "./geonames.provider.js";
+import { GeocodingResult } from "../model/index.js";
 import { describe } from "vitest";
 
 const MOCK_DATA = {

package/lib/providers/index.ts

@@ -1,3 +1,8 @@
+/**
+ * @group Providers
+ * @packageDocumentation
+ */
+
 export * from "./geoadmin.provider.js";
 export * from "./data-gouv-fr.provider.js";
 export * from "./geonames.provider.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@geospatial-sdk/geocoding",
-  "version": "0.0.5-dev.43+a7f100d",
+  "version": "0.0.5-dev.45+a90fe28",
   "description": "Geocoding-related components",
   "keywords": [
     "geocoding"
@@ -32,5 +32,5 @@
   "bugs": {
     "url": "https://github.com/jahow/geospatial-sdk/issues"
   },
-  "gitHead": "a7f100dfebe66dff0f44abb4c630917db89453fd"
+  "gitHead": "a90fe28ac749e1d35a976bdcfd02cb47357e8955"
 }