@girs/ecal-2.0 2.0.0-3.2.4 → 2.0.0-3.2.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -5,7 +5,7 @@
5
5
  ![downloads/week](https://img.shields.io/npm/dw/@girs/ecal-2.0)
6
6
 
7
7
 
8
- GJS TypeScript type definitions for ECal-2.0, generated from library version 2.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.4.
8
+ GJS TypeScript type definitions for ECal-2.0, generated from library version 2.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.6.
9
9
 
10
10
  This package is a client library for evolution calendars.
11
11
 
@@ -82,6 +82,19 @@ Now you have also type support for this, too:
82
82
  const ECal = imports.gi.ECal;
83
83
  ```
84
84
 
85
+
86
+ ### ESM vs. CommonJS
87
+
88
+ GJS supports two different import syntaxes. The new modern ESM syntax and the old global imports syntax.
89
+
90
+ 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.
91
+
92
+ 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.
93
+
94
+ 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.
95
+
96
+ 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.
97
+
85
98
  ### Bundle
86
99
 
87
100
  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).
@@ -1,5 +1,4 @@
1
1
 
2
-
3
2
  declare module 'gi://ECal?version=2.0' {
4
3
  import ECal20 from '@girs/ecal-2.0';
5
4
  export default ECal20;
@@ -1,5 +1,4 @@
1
1
 
2
-
3
2
  import ECal20 from '@girs/ecal-2.0';
4
3
 
5
4
  declare global {
package/ecal-2.0.d.cts CHANGED
@@ -1477,6 +1477,8 @@ export module Client {
1477
1477
 
1478
1478
  default_timezone?: ICalGLib.Timezone | null
1479
1479
  source_type?: ClientSourceType | null
1480
+ defaultTimezone?: ICalGLib.Timezone | null
1481
+ sourceType?: ClientSourceType | null
1480
1482
  }
1481
1483
 
1482
1484
  }
@@ -1486,7 +1488,9 @@ export interface Client extends TimezoneCache, Gio.AsyncInitable, Gio.Initable {
1486
1488
  // Own properties of ECal-2.0.ECal.Client
1487
1489
 
1488
1490
  default_timezone: ICalGLib.Timezone
1491
+ defaultTimezone: ICalGLib.Timezone
1489
1492
  readonly source_type: ClientSourceType
1493
+ readonly sourceType: ClientSourceType
1490
1494
 
1491
1495
  // Owm methods of ECal-2.0.ECal.Client
1492
1496
 
@@ -2504,6 +2508,10 @@ export module ClientView {
2504
2508
  * The object path used to create the D-Bus proxy
2505
2509
  */
2506
2510
  object_path?: string | null
2511
+ /**
2512
+ * The object path used to create the D-Bus proxy
2513
+ */
2514
+ objectPath?: string | null
2507
2515
  }
2508
2516
 
2509
2517
  }
@@ -2524,6 +2532,10 @@ export interface ClientView extends Gio.Initable {
2524
2532
  * The object path used to create the D-Bus proxy
2525
2533
  */
2526
2534
  readonly object_path: string | null
2535
+ /**
2536
+ * The object path used to create the D-Bus proxy
2537
+ */
2538
+ readonly objectPath: string | null
2527
2539
 
2528
2540
  // Owm methods of ECal-2.0.ECal.ClientView
2529
2541
 
@@ -3408,6 +3420,18 @@ export module ReminderWatcher {
3408
3420
  * Default: %TRUE
3409
3421
  */
3410
3422
  timers_enabled?: boolean | null
3423
+ /**
3424
+ * An #ICalTimezone to be used as the default time zone.
3425
+ */
3426
+ defaultZone?: ICalGLib.Timezone | null
3427
+ /**
3428
+ * Whether timers are enabled for the #EReminderWatcher. See
3429
+ * e_reminder_watcher_set_timers_enabled() for more information
3430
+ * what it means.
3431
+ *
3432
+ * Default: %TRUE
3433
+ */
3434
+ timersEnabled?: boolean | null
3411
3435
  }
3412
3436
 
3413
3437
  }
@@ -3420,6 +3444,10 @@ export interface ReminderWatcher {
3420
3444
  * An #ICalTimezone to be used as the default time zone.
3421
3445
  */
3422
3446
  default_zone: ICalGLib.Timezone
3447
+ /**
3448
+ * An #ICalTimezone to be used as the default time zone.
3449
+ */
3450
+ defaultZone: ICalGLib.Timezone
3423
3451
  /**
3424
3452
  * The #ESourceRegistry which manages #ESource instances.
3425
3453
  */
@@ -3432,6 +3460,14 @@ export interface ReminderWatcher {
3432
3460
  * Default: %TRUE
3433
3461
  */
3434
3462
  timers_enabled: boolean
3463
+ /**
3464
+ * Whether timers are enabled for the #EReminderWatcher. See
3465
+ * e_reminder_watcher_set_timers_enabled() for more information
3466
+ * what it means.
3467
+ *
3468
+ * Default: %TRUE
3469
+ */
3470
+ timersEnabled: boolean
3435
3471
 
3436
3472
  // Owm methods of ECal-2.0.ECal.ReminderWatcher
3437
3473
 
package/ecal-2.0.d.ts CHANGED
@@ -1479,6 +1479,8 @@ module Client {
1479
1479
 
1480
1480
  default_timezone?: ICalGLib.Timezone | null
1481
1481
  source_type?: ClientSourceType | null
1482
+ defaultTimezone?: ICalGLib.Timezone | null
1483
+ sourceType?: ClientSourceType | null
1482
1484
  }
1483
1485
 
1484
1486
  }
@@ -1488,7 +1490,9 @@ interface Client extends TimezoneCache, Gio.AsyncInitable, Gio.Initable {
1488
1490
  // Own properties of ECal-2.0.ECal.Client
1489
1491
 
1490
1492
  default_timezone: ICalGLib.Timezone
1493
+ defaultTimezone: ICalGLib.Timezone
1491
1494
  readonly source_type: ClientSourceType
1495
+ readonly sourceType: ClientSourceType
1492
1496
 
1493
1497
  // Owm methods of ECal-2.0.ECal.Client
1494
1498
 
@@ -2506,6 +2510,10 @@ module ClientView {
2506
2510
  * The object path used to create the D-Bus proxy
2507
2511
  */
2508
2512
  object_path?: string | null
2513
+ /**
2514
+ * The object path used to create the D-Bus proxy
2515
+ */
2516
+ objectPath?: string | null
2509
2517
  }
2510
2518
 
2511
2519
  }
@@ -2526,6 +2534,10 @@ interface ClientView extends Gio.Initable {
2526
2534
  * The object path used to create the D-Bus proxy
2527
2535
  */
2528
2536
  readonly object_path: string | null
2537
+ /**
2538
+ * The object path used to create the D-Bus proxy
2539
+ */
2540
+ readonly objectPath: string | null
2529
2541
 
2530
2542
  // Owm methods of ECal-2.0.ECal.ClientView
2531
2543
 
@@ -3410,6 +3422,18 @@ module ReminderWatcher {
3410
3422
  * Default: %TRUE
3411
3423
  */
3412
3424
  timers_enabled?: boolean | null
3425
+ /**
3426
+ * An #ICalTimezone to be used as the default time zone.
3427
+ */
3428
+ defaultZone?: ICalGLib.Timezone | null
3429
+ /**
3430
+ * Whether timers are enabled for the #EReminderWatcher. See
3431
+ * e_reminder_watcher_set_timers_enabled() for more information
3432
+ * what it means.
3433
+ *
3434
+ * Default: %TRUE
3435
+ */
3436
+ timersEnabled?: boolean | null
3413
3437
  }
3414
3438
 
3415
3439
  }
@@ -3422,6 +3446,10 @@ interface ReminderWatcher {
3422
3446
  * An #ICalTimezone to be used as the default time zone.
3423
3447
  */
3424
3448
  default_zone: ICalGLib.Timezone
3449
+ /**
3450
+ * An #ICalTimezone to be used as the default time zone.
3451
+ */
3452
+ defaultZone: ICalGLib.Timezone
3425
3453
  /**
3426
3454
  * The #ESourceRegistry which manages #ESource instances.
3427
3455
  */
@@ -3434,6 +3462,14 @@ interface ReminderWatcher {
3434
3462
  * Default: %TRUE
3435
3463
  */
3436
3464
  timers_enabled: boolean
3465
+ /**
3466
+ * Whether timers are enabled for the #EReminderWatcher. See
3467
+ * e_reminder_watcher_set_timers_enabled() for more information
3468
+ * what it means.
3469
+ *
3470
+ * Default: %TRUE
3471
+ */
3472
+ timersEnabled: boolean
3437
3473
 
3438
3474
  // Owm methods of ECal-2.0.ECal.ReminderWatcher
3439
3475
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/ecal-2.0",
3
- "version": "2.0.0-3.2.4",
3
+ "version": "2.0.0-3.2.6",
4
4
  "description": "GJS TypeScript type definitions for ECal-2.0, generated from library version 2.0.0",
5
5
  "type": "module",
6
6
  "module": "ecal-2.0.js",
@@ -25,16 +25,16 @@
25
25
  "test:cjs": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit ecal-2.0.d.cts"
26
26
  },
27
27
  "dependencies": {
28
- "@girs/camel-1.2": "^1.2.0-3.2.4",
29
- "@girs/edataserver-1.2": "^1.2.0-3.2.4",
30
- "@girs/gio-2.0": "^2.78.0-3.2.4",
31
- "@girs/gjs": "^3.2.4",
32
- "@girs/glib-2.0": "^2.78.0-3.2.4",
33
- "@girs/gobject-2.0": "^2.78.0-3.2.4",
34
- "@girs/icalglib-3.0": "^3.0.0-3.2.4",
35
- "@girs/json-1.0": "^1.7.1-3.2.4",
36
- "@girs/libxml2-2.0": "^2.0.0-3.2.4",
37
- "@girs/soup-3.0": "^3.4.4-3.2.4"
28
+ "@girs/camel-1.2": "^1.2.0-3.2.6",
29
+ "@girs/edataserver-1.2": "^1.2.0-3.2.6",
30
+ "@girs/gio-2.0": "^2.78.0-3.2.6",
31
+ "@girs/gjs": "^3.2.6",
32
+ "@girs/glib-2.0": "^2.78.0-3.2.6",
33
+ "@girs/gobject-2.0": "^2.78.0-3.2.6",
34
+ "@girs/icalglib-3.0": "^3.0.0-3.2.6",
35
+ "@girs/json-1.0": "^1.7.1-3.2.6",
36
+ "@girs/libxml2-2.0": "^2.0.0-3.2.6",
37
+ "@girs/soup-3.0": "^3.4.4-3.2.6"
38
38
  },
39
39
  "devDependencies": {
40
40
  "typescript": "*"