@girs/ebook-1.2 1.2.0-3.2.4 → 1.2.0-3.2.6

package/README.md

@@ -5,7 +5,7 @@
 ![downloads/week](https://img.shields.io/npm/dw/@girs/ebook-1.2)
 
 
-GJS TypeScript type definitions for EBook-1.2, generated from library version 1.2.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.4.
+GJS TypeScript type definitions for EBook-1.2, generated from library version 1.2.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.6.
 
 This package is a client library for evolution addressbooks.
 
@@ -82,6 +82,19 @@ Now you have also type support for this, too:
 const EBook = imports.gi.EBook;
 ```
 
+
+### 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/ebook-1.2-ambient.d.ts

@@ -1,5 +1,4 @@
 
-
 declare module 'gi://EBook?version=1.2' {
     import EBook12 from '@girs/ebook-1.2';
     export default EBook12;

package/ebook-1.2-import.d.ts

@@ -1,5 +1,4 @@
 
-
 import EBook12 from '@girs/ebook-1.2';
 
 declare global {

package/ebook-1.2.d.cts

@@ -713,6 +713,22 @@ export module BookClientCursor {
          * </para></note>
          */
         sort_fields?: string[] | null
+        /**
+         * The D-Bus object path to find the server side cursor object.
+         * 
+         * <note><para>This is an internal parameter for constructing the
+         * cursor, to construct the cursor use e_book_client_get_cursor().
+         * </para></note>
+         */
+        objectPath?: string | null
+        /**
+         * The #EContactField names to sort this cursor with
+         * 
+         * <note><para>This is an internal parameter for constructing the
+         * cursor, to construct the cursor use e_book_client_get_cursor().
+         * </para></note>
+         */
+        sortFields?: string[] | null
     }
 
 }
@@ -767,6 +783,14 @@ export interface BookClientCursor extends Gio.Initable {
      * </para></note>
      */
     readonly object_path: string | null
+    /**
+     * The D-Bus object path to find the server side cursor object.
+     * 
+     * <note><para>This is an internal parameter for constructing the
+     * cursor, to construct the cursor use e_book_client_get_cursor().
+     * </para></note>
+     */
+    readonly objectPath: string | null
     /**
      * The current cursor position in the cursor's result list.
      * 
@@ -795,6 +819,14 @@ export interface BookClientCursor extends Gio.Initable {
      * </para></note>
      */
     readonly sort_fields: string[]
+    /**
+     * The #EContactField names to sort this cursor with
+     * 
+     * <note><para>This is an internal parameter for constructing the
+     * cursor, to construct the cursor use e_book_client_get_cursor().
+     * </para></note>
+     */
+    readonly sortFields: string[]
     /**
      * The total number of contacts which satisfy the cursor's query.
      * 
@@ -1137,6 +1169,7 @@ export module BookClientView {
         client?: BookClient | null
         connection?: Gio.DBusConnection | null
         object_path?: string | null
+        objectPath?: string | null
     }
 
 }
@@ -1162,7 +1195,14 @@ export interface BookClientView extends Gio.Initable {
      * Note: This property can be used only with `E_BOOK_CLIENT_VIEW_FLAGS_MANUAL_QUERY`.
      */
     readonly n_total: number
+    /**
+     * How many contacts are available in the view.
+     * 
+     * Note: This property can be used only with `E_BOOK_CLIENT_VIEW_FLAGS_MANUAL_QUERY`.
+     */
+    readonly nTotal: number
     readonly object_path: string | null
+    readonly objectPath: string | null
 
     // Owm methods of EBook-1.2.EBook.BookClientView
 

package/ebook-1.2.d.ts

@@ -715,6 +715,22 @@ module BookClientCursor {
          * </para></note>
          */
         sort_fields?: string[] | null
+        /**
+         * The D-Bus object path to find the server side cursor object.
+         * 
+         * <note><para>This is an internal parameter for constructing the
+         * cursor, to construct the cursor use e_book_client_get_cursor().
+         * </para></note>
+         */
+        objectPath?: string | null
+        /**
+         * The #EContactField names to sort this cursor with
+         * 
+         * <note><para>This is an internal parameter for constructing the
+         * cursor, to construct the cursor use e_book_client_get_cursor().
+         * </para></note>
+         */
+        sortFields?: string[] | null
     }
 
 }
@@ -769,6 +785,14 @@ interface BookClientCursor extends Gio.Initable {
      * </para></note>
      */
     readonly object_path: string | null
+    /**
+     * The D-Bus object path to find the server side cursor object.
+     * 
+     * <note><para>This is an internal parameter for constructing the
+     * cursor, to construct the cursor use e_book_client_get_cursor().
+     * </para></note>
+     */
+    readonly objectPath: string | null
     /**
      * The current cursor position in the cursor's result list.
      * 
@@ -797,6 +821,14 @@ interface BookClientCursor extends Gio.Initable {
      * </para></note>
      */
     readonly sort_fields: string[]
+    /**
+     * The #EContactField names to sort this cursor with
+     * 
+     * <note><para>This is an internal parameter for constructing the
+     * cursor, to construct the cursor use e_book_client_get_cursor().
+     * </para></note>
+     */
+    readonly sortFields: string[]
     /**
      * The total number of contacts which satisfy the cursor's query.
      * 
@@ -1139,6 +1171,7 @@ module BookClientView {
         client?: BookClient | null
         connection?: Gio.DBusConnection | null
         object_path?: string | null
+        objectPath?: string | null
     }
 
 }
@@ -1164,7 +1197,14 @@ interface BookClientView extends Gio.Initable {
      * Note: This property can be used only with `E_BOOK_CLIENT_VIEW_FLAGS_MANUAL_QUERY`.
      */
     readonly n_total: number
+    /**
+     * How many contacts are available in the view.
+     * 
+     * Note: This property can be used only with `E_BOOK_CLIENT_VIEW_FLAGS_MANUAL_QUERY`.
+     */
+    readonly nTotal: number
     readonly object_path: string | null
+    readonly objectPath: string | null
 
     // Owm methods of EBook-1.2.EBook.BookClientView
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@girs/ebook-1.2",
-  "version": "1.2.0-3.2.4",
+  "version": "1.2.0-3.2.6",
   "description": "GJS TypeScript type definitions for EBook-1.2, generated from library version 1.2.0",
   "type": "module",
   "module": "ebook-1.2.js",
@@ -25,16 +25,16 @@
     "test:cjs": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit ebook-1.2.d.cts"
   },
   "dependencies": {
-    "@girs/camel-1.2": "^1.2.0-3.2.4",
-    "@girs/ebookcontacts-1.2": "^1.2.0-3.2.4",
-    "@girs/edataserver-1.2": "^1.2.0-3.2.4",
-    "@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/libxml2-2.0": "^2.0.0-3.2.4",
-    "@girs/soup-3.0": "^3.4.4-3.2.4"
+    "@girs/camel-1.2": "^1.2.0-3.2.6",
+    "@girs/ebookcontacts-1.2": "^1.2.0-3.2.6",
+    "@girs/edataserver-1.2": "^1.2.0-3.2.6",
+    "@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/libxml2-2.0": "^2.0.0-3.2.6",
+    "@girs/soup-3.0": "^3.4.4-3.2.6"
   },
   "devDependencies": {
     "typescript": "*"