@girs/geocodeglib-1.0 1.0.0-3.2.4 → 1.0.0-3.2.6

package/README.md

@@ -5,7 +5,7 @@
 ![downloads/week](https://img.shields.io/npm/dw/@girs/geocodeglib-1.0)
 
 
-GJS TypeScript type definitions for GeocodeGlib-1.0, generated from library version 1.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.4.
+GJS TypeScript type definitions for GeocodeGlib-1.0, generated from library version 1.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.6.
 
 Geocode Helper library
 
@@ -82,6 +82,19 @@ Now you have also type support for this, too:
 const GeocodeGlib = imports.gi.GeocodeGlib;
 ```
 
+
+### ESM vs. CommonJS
+
+GJS supports two different import syntaxes. The new modern ESM syntax and the old global imports syntax.
+
+In TypeScript projects for GJS and GNOME Shell extensions, you have the flexibility to use `ESM` syntax and then decide the import syntax for your bundled file. If your bundler is configured to use `CommonJS`, it will convert to the GJS-specific global imports syntax, like `const moduleName = imports.gi[moduleName]`. This is different from the traditional `require` syntax seen in Node.js. The global imports syntax is chosen because it aligns with the CommonJS format supported by NPM, which is used for the generated type definitions and this package.
+
+On the other hand, if you configure your bundler to use ESM, it will retain the ESM import syntax. It's crucial to ensure that your bundler is set up to correctly translate and bundle these imports into either CommonJS or ESM format, depending on your project's requirements.
+
+This approach is particularly important due to the `@girs` types, which include both `*.cjs `files, using the GJS global imports syntax, and `*.js` files, which utilize the ESM syntax. By appropriately setting up your bundler, you can control which syntax—CommonJS or ESM—is used in your project. The choice of CommonJS in this context is also due to the similarity between the GJS-specific global imports and CommonJS syntax, allowing for easier management and bundling in these specific types of projects.
+
+Since GNOME Shell 45, you should only use ESM, even for GNOME Shell extensions. Before that, extensions had to use the global import syntax, unlike normal GJS applications, where ESM has been available for some time.
+
 ### Bundle
 
 Depending on your project configuration, it is recommended to use a bundler like [esbuild](https://esbuild.github.io/). You can find examples using different bundlers [here](https://github.com/gjsify/ts-for-gir/tree/main/examples).

package/geocodeglib-1.0-ambient.d.ts

@@ -1,9 +1,12 @@
 
-
 declare module 'gi://GeocodeGlib?version=1.0' {
     import GeocodeGlib10 from '@girs/geocodeglib-1.0';
     export default GeocodeGlib10;
 }
 
+declare module 'gi://GeocodeGlib' {
+    import GeocodeGlib10 from '@girs/geocodeglib-1.0';
+    export default GeocodeGlib10;
+}
 
 

package/geocodeglib-1.0-import.d.ts

@@ -1,5 +1,4 @@
 
-
 import GeocodeGlib10 from '@girs/geocodeglib-1.0';
 
 declare global {

package/geocodeglib-1.0.d.cts

@@ -685,6 +685,16 @@ export module Forward {
          * this area is returned.
          */
         search_area?: BoundingBox | null
+        /**
+         * The number of requested results to a search query.
+         */
+        answerCount?: number | null
+        /**
+         * The bounding box that limits the search area.
+         * If #GeocodeForward:bounded property is set to #TRUE only results from
+         * this area is returned.
+         */
+        searchArea?: BoundingBox | null
     }
 
 }
@@ -697,6 +707,10 @@ export interface Forward {
      * The number of requested results to a search query.
      */
     answer_count: number
+    /**
+     * The number of requested results to a search query.
+     */
+    answerCount: number
     /**
      * If set to #TRUE then only results in the #GeocodeForward:search-area
      * bounding box are returned.
@@ -710,6 +724,12 @@ export interface Forward {
      * this area is returned.
      */
     search_area: BoundingBox
+    /**
+     * The bounding box that limits the search area.
+     * If #GeocodeForward:bounded property is set to #TRUE only results from
+     * this area is returned.
+     */
+    searchArea: BoundingBox
 
     // Owm methods of GeocodeGlib-1.0.GeocodeGlib.Forward
 
@@ -1239,6 +1259,31 @@ export module Nominatim {
          * string.
          */
         user_agent?: string | null
+        /**
+         * The base URL of the Nominatim service, for example
+         * `https://nominatim.example.org`.
+         */
+        baseUrl?: string | null
+        /**
+         * E-mail address of the maintainer of the software making the
+         * geocoding requests to the  Nominatim server. This is used to contact
+         * them in the event of a problem with their usage. See
+         * [the Nominatim API](http://wiki.openstreetmap.org/wiki/Nominatim).
+         */
+        maintainerEmailAddress?: string | null
+        /**
+         * User-Agent string to send with HTTP(S) requests, or %NULL to use the
+         * default user agent, which is derived from the geocode-glib version
+         * and #GApplication:id, for example: `geocode-glib/3.20 (MyAppId)`.
+         * 
+         * As per the
+         * [Nominatim usage policy](http://wiki.openstreetmap.org/wiki/Nominatim_usage_policy),
+         * it should be set to a string which identifies the application which
+         * is using geocode-glib, and must be a valid
+         * [user agent](https://tools.ietf.org/html/rfc7231#section-5.5.3)
+         * string.
+         */
+        userAgent?: string | null
     }
 
 }
@@ -1252,6 +1297,11 @@ export interface Nominatim extends Backend {
      * `https://nominatim.example.org`.
      */
     readonly base_url: string | null
+    /**
+     * The base URL of the Nominatim service, for example
+     * `https://nominatim.example.org`.
+     */
+    readonly baseUrl: string | null
     /**
      * E-mail address of the maintainer of the software making the
      * geocoding requests to the  Nominatim server. This is used to contact
@@ -1259,6 +1309,13 @@ export interface Nominatim extends Backend {
      * [the Nominatim API](http://wiki.openstreetmap.org/wiki/Nominatim).
      */
     readonly maintainer_email_address: string | null
+    /**
+     * E-mail address of the maintainer of the software making the
+     * geocoding requests to the  Nominatim server. This is used to contact
+     * them in the event of a problem with their usage. See
+     * [the Nominatim API](http://wiki.openstreetmap.org/wiki/Nominatim).
+     */
+    readonly maintainerEmailAddress: string | null
     /**
      * User-Agent string to send with HTTP(S) requests, or %NULL to use the
      * default user agent, which is derived from the geocode-glib version
@@ -1272,6 +1329,19 @@ export interface Nominatim extends Backend {
      * string.
      */
     user_agent: string | null
+    /**
+     * User-Agent string to send with HTTP(S) requests, or %NULL to use the
+     * default user agent, which is derived from the geocode-glib version
+     * and #GApplication:id, for example: `geocode-glib/3.20 (MyAppId)`.
+     * 
+     * As per the
+     * [Nominatim usage policy](http://wiki.openstreetmap.org/wiki/Nominatim_usage_policy),
+     * it should be set to a string which identifies the application which
+     * is using geocode-glib, and must be a valid
+     * [user agent](https://tools.ietf.org/html/rfc7231#section-5.5.3)
+     * string.
+     */
+    userAgent: string | null
 
     // Own fields of GeocodeGlib-1.0.GeocodeGlib.Nominatim
 
@@ -1425,6 +1495,38 @@ export module Place {
          * The town.
          */
         town?: string | null
+        /**
+         * The local administrative area.
+         */
+        administrativeArea?: string | null
+        /**
+         * The bounding box for the place.
+         */
+        boundingBox?: BoundingBox | null
+        /**
+         * The country code.
+         */
+        countryCode?: string | null
+        /**
+         * The OpenStreetMap id of the place.
+         */
+        osmId?: string | null
+        /**
+         * The OpenStreetMap type of the place.
+         */
+        osmType?: PlaceOsmType | null
+        /**
+         * The type of the place.
+         */
+        placeType?: PlaceType | null
+        /**
+         * The postal code.
+         */
+        postalCode?: string | null
+        /**
+         * The street address.
+         */
+        streetAddress?: string | null
     }
 
 }
@@ -1437,6 +1539,10 @@ export interface Place {
      * The local administrative area.
      */
     administrative_area: string | null
+    /**
+     * The local administrative area.
+     */
+    administrativeArea: string | null
     /**
      * A named area such as a campus or neighborhood.
      */
@@ -1445,6 +1551,10 @@ export interface Place {
      * The bounding box for the place.
      */
     bounding_box: BoundingBox
+    /**
+     * The bounding box for the place.
+     */
+    boundingBox: BoundingBox
     /**
      * A specific building on a street or in an area.
      */
@@ -1461,6 +1571,10 @@ export interface Place {
      * The country code.
      */
     country_code: string | null
+    /**
+     * The country code.
+     */
+    countryCode: string | null
     /**
      * The county.
      */
@@ -1481,18 +1595,34 @@ export interface Place {
      * The OpenStreetMap id of the place.
      */
     osm_id: string | null
+    /**
+     * The OpenStreetMap id of the place.
+     */
+    osmId: string | null
     /**
      * The OpenStreetMap type of the place.
      */
     osm_type: PlaceOsmType
+    /**
+     * The OpenStreetMap type of the place.
+     */
+    osmType: PlaceOsmType
     /**
      * The type of the place.
      */
     readonly place_type: PlaceType
+    /**
+     * The type of the place.
+     */
+    readonly placeType: PlaceType
     /**
      * The postal code.
      */
     postal_code: string | null
+    /**
+     * The postal code.
+     */
+    postalCode: string | null
     /**
      * The state.
      */
@@ -1505,6 +1635,10 @@ export interface Place {
      * The street address.
      */
     street_address: string | null
+    /**
+     * The street address.
+     */
+    streetAddress: string | null
     /**
      * The town.
      */

package/geocodeglib-1.0.d.ts

@@ -687,6 +687,16 @@ module Forward {
          * this area is returned.
          */
         search_area?: BoundingBox | null
+        /**
+         * The number of requested results to a search query.
+         */
+        answerCount?: number | null
+        /**
+         * The bounding box that limits the search area.
+         * If #GeocodeForward:bounded property is set to #TRUE only results from
+         * this area is returned.
+         */
+        searchArea?: BoundingBox | null
     }
 
 }
@@ -699,6 +709,10 @@ interface Forward {
      * The number of requested results to a search query.
      */
     answer_count: number
+    /**
+     * The number of requested results to a search query.
+     */
+    answerCount: number
     /**
      * If set to #TRUE then only results in the #GeocodeForward:search-area
      * bounding box are returned.
@@ -712,6 +726,12 @@ interface Forward {
      * this area is returned.
      */
     search_area: BoundingBox
+    /**
+     * The bounding box that limits the search area.
+     * If #GeocodeForward:bounded property is set to #TRUE only results from
+     * this area is returned.
+     */
+    searchArea: BoundingBox
 
     // Owm methods of GeocodeGlib-1.0.GeocodeGlib.Forward
 
@@ -1241,6 +1261,31 @@ module Nominatim {
          * string.
          */
         user_agent?: string | null
+        /**
+         * The base URL of the Nominatim service, for example
+         * `https://nominatim.example.org`.
+         */
+        baseUrl?: string | null
+        /**
+         * E-mail address of the maintainer of the software making the
+         * geocoding requests to the  Nominatim server. This is used to contact
+         * them in the event of a problem with their usage. See
+         * [the Nominatim API](http://wiki.openstreetmap.org/wiki/Nominatim).
+         */
+        maintainerEmailAddress?: string | null
+        /**
+         * User-Agent string to send with HTTP(S) requests, or %NULL to use the
+         * default user agent, which is derived from the geocode-glib version
+         * and #GApplication:id, for example: `geocode-glib/3.20 (MyAppId)`.
+         * 
+         * As per the
+         * [Nominatim usage policy](http://wiki.openstreetmap.org/wiki/Nominatim_usage_policy),
+         * it should be set to a string which identifies the application which
+         * is using geocode-glib, and must be a valid
+         * [user agent](https://tools.ietf.org/html/rfc7231#section-5.5.3)
+         * string.
+         */
+        userAgent?: string | null
     }
 
 }
@@ -1254,6 +1299,11 @@ interface Nominatim extends Backend {
      * `https://nominatim.example.org`.
      */
     readonly base_url: string | null
+    /**
+     * The base URL of the Nominatim service, for example
+     * `https://nominatim.example.org`.
+     */
+    readonly baseUrl: string | null
     /**
      * E-mail address of the maintainer of the software making the
      * geocoding requests to the  Nominatim server. This is used to contact
@@ -1261,6 +1311,13 @@ interface Nominatim extends Backend {
      * [the Nominatim API](http://wiki.openstreetmap.org/wiki/Nominatim).
      */
     readonly maintainer_email_address: string | null
+    /**
+     * E-mail address of the maintainer of the software making the
+     * geocoding requests to the  Nominatim server. This is used to contact
+     * them in the event of a problem with their usage. See
+     * [the Nominatim API](http://wiki.openstreetmap.org/wiki/Nominatim).
+     */
+    readonly maintainerEmailAddress: string | null
     /**
      * User-Agent string to send with HTTP(S) requests, or %NULL to use the
      * default user agent, which is derived from the geocode-glib version
@@ -1274,6 +1331,19 @@ interface Nominatim extends Backend {
      * string.
      */
     user_agent: string | null
+    /**
+     * User-Agent string to send with HTTP(S) requests, or %NULL to use the
+     * default user agent, which is derived from the geocode-glib version
+     * and #GApplication:id, for example: `geocode-glib/3.20 (MyAppId)`.
+     * 
+     * As per the
+     * [Nominatim usage policy](http://wiki.openstreetmap.org/wiki/Nominatim_usage_policy),
+     * it should be set to a string which identifies the application which
+     * is using geocode-glib, and must be a valid
+     * [user agent](https://tools.ietf.org/html/rfc7231#section-5.5.3)
+     * string.
+     */
+    userAgent: string | null
 
     // Own fields of GeocodeGlib-1.0.GeocodeGlib.Nominatim
 
@@ -1427,6 +1497,38 @@ module Place {
          * The town.
          */
         town?: string | null
+        /**
+         * The local administrative area.
+         */
+        administrativeArea?: string | null
+        /**
+         * The bounding box for the place.
+         */
+        boundingBox?: BoundingBox | null
+        /**
+         * The country code.
+         */
+        countryCode?: string | null
+        /**
+         * The OpenStreetMap id of the place.
+         */
+        osmId?: string | null
+        /**
+         * The OpenStreetMap type of the place.
+         */
+        osmType?: PlaceOsmType | null
+        /**
+         * The type of the place.
+         */
+        placeType?: PlaceType | null
+        /**
+         * The postal code.
+         */
+        postalCode?: string | null
+        /**
+         * The street address.
+         */
+        streetAddress?: string | null
     }
 
 }
@@ -1439,6 +1541,10 @@ interface Place {
      * The local administrative area.
      */
     administrative_area: string | null
+    /**
+     * The local administrative area.
+     */
+    administrativeArea: string | null
     /**
      * A named area such as a campus or neighborhood.
      */
@@ -1447,6 +1553,10 @@ interface Place {
      * The bounding box for the place.
      */
     bounding_box: BoundingBox
+    /**
+     * The bounding box for the place.
+     */
+    boundingBox: BoundingBox
     /**
      * A specific building on a street or in an area.
      */
@@ -1463,6 +1573,10 @@ interface Place {
      * The country code.
      */
     country_code: string | null
+    /**
+     * The country code.
+     */
+    countryCode: string | null
     /**
      * The county.
      */
@@ -1483,18 +1597,34 @@ interface Place {
      * The OpenStreetMap id of the place.
      */
     osm_id: string | null
+    /**
+     * The OpenStreetMap id of the place.
+     */
+    osmId: string | null
     /**
      * The OpenStreetMap type of the place.
      */
     osm_type: PlaceOsmType
+    /**
+     * The OpenStreetMap type of the place.
+     */
+    osmType: PlaceOsmType
     /**
      * The type of the place.
      */
     readonly place_type: PlaceType
+    /**
+     * The type of the place.
+     */
+    readonly placeType: PlaceType
     /**
      * The postal code.
      */
     postal_code: string | null
+    /**
+     * The postal code.
+     */
+    postalCode: string | null
     /**
      * The state.
      */
@@ -1507,6 +1637,10 @@ interface Place {
      * The street address.
      */
     street_address: string | null
+    /**
+     * The street address.
+     */
+    streetAddress: string | null
     /**
      * The town.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@girs/geocodeglib-1.0",
-  "version": "1.0.0-3.2.4",
+  "version": "1.0.0-3.2.6",
   "description": "GJS TypeScript type definitions for GeocodeGlib-1.0, generated from library version 1.0.0",
   "type": "module",
   "module": "geocodeglib-1.0.js",
@@ -25,12 +25,12 @@
     "test:cjs": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit geocodeglib-1.0.d.cts"
   },
   "dependencies": {
-    "@girs/gio-2.0": "^2.78.0-3.2.4",
-    "@girs/gjs": "^3.2.4",
-    "@girs/glib-2.0": "^2.78.0-3.2.4",
-    "@girs/gobject-2.0": "^2.78.0-3.2.4",
-    "@girs/json-1.0": "^1.7.1-3.2.4",
-    "@girs/soup-2.4": "^2.74.3-3.2.4"
+    "@girs/gio-2.0": "^2.78.0-3.2.6",
+    "@girs/gjs": "^3.2.6",
+    "@girs/glib-2.0": "^2.78.0-3.2.6",
+    "@girs/gobject-2.0": "^2.78.0-3.2.6",
+    "@girs/json-1.0": "^1.7.1-3.2.6",
+    "@girs/soup-2.4": "^2.74.3-3.2.6"
   },
   "devDependencies": {
     "typescript": "*"