@girs/trackerminer-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/trackerminer-2.0)
6
6
 
7
7
 
8
- GJS TypeScript type definitions for TrackerMiner-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 TrackerMiner-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
 
11
11
  ## Install
@@ -81,6 +81,19 @@ Now you have also type support for this, too:
81
81
  const TrackerMiner = imports.gi.TrackerMiner;
82
82
  ```
83
83
 
84
+
85
+ ### ESM vs. CommonJS
86
+
87
+ GJS supports two different import syntaxes. The new modern ESM syntax and the old global imports syntax.
88
+
89
+ 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.
90
+
91
+ 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.
92
+
93
+ 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.
94
+
95
+ 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.
96
+
84
97
  ### Bundle
85
98
 
86
99
  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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/trackerminer-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 TrackerMiner-2.0, generated from library version 2.0.0",
5
5
  "type": "module",
6
6
  "module": "trackerminer-2.0.js",
@@ -25,10 +25,10 @@
25
25
  "test:cjs": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit trackerminer-2.0.d.cts"
26
26
  },
27
27
  "dependencies": {
28
- "@girs/gio-2.0": "^2.78.0-3.2.4",
29
- "@girs/gjs": "^3.2.4",
30
- "@girs/glib-2.0": "^2.78.0-3.2.4",
31
- "@girs/gobject-2.0": "^2.78.0-3.2.4"
28
+ "@girs/gio-2.0": "^2.78.0-3.2.6",
29
+ "@girs/gjs": "^3.2.6",
30
+ "@girs/glib-2.0": "^2.78.0-3.2.6",
31
+ "@girs/gobject-2.0": "^2.78.0-3.2.6"
32
32
  },
33
33
  "devDependencies": {
34
34
  "typescript": "*"
@@ -1,9 +1,12 @@
1
1
 
2
-
3
2
  declare module 'gi://TrackerMiner?version=2.0' {
4
3
  import TrackerMiner20 from '@girs/trackerminer-2.0';
5
4
  export default TrackerMiner20;
6
5
  }
7
6
 
7
+ declare module 'gi://TrackerMiner' {
8
+ import TrackerMiner20 from '@girs/trackerminer-2.0';
9
+ export default TrackerMiner20;
10
+ }
8
11
 
9
12
 
@@ -1,5 +1,4 @@
1
1
 
2
-
3
2
  import TrackerMiner20 from '@girs/trackerminer-2.0';
4
3
 
5
4
  declare global {
@@ -456,6 +456,10 @@ export module Decorator {
456
456
  commit_batch_size?: number | null
457
457
  data_source?: string | null
458
458
  priority_rdf_types?: string[] | null
459
+ classNames?: string[] | null
460
+ commitBatchSize?: number | null
461
+ dataSource?: string | null
462
+ priorityRdfTypes?: string[] | null
459
463
  }
460
464
 
461
465
  }
@@ -465,9 +469,13 @@ export interface Decorator extends Gio.Initable {
465
469
  // Own properties of TrackerMiner-2.0.TrackerMiner.Decorator
466
470
 
467
471
  class_names: string[]
472
+ classNames: string[]
468
473
  commit_batch_size: number
474
+ commitBatchSize: number
469
475
  readonly data_source: string | null
476
+ readonly dataSource: string | null
470
477
  priority_rdf_types: string[]
478
+ priorityRdfTypes: string[]
471
479
 
472
480
  // Own fields of TrackerMiner-2.0.TrackerMiner.Decorator
473
481
 
@@ -719,6 +727,7 @@ export module IndexingTree {
719
727
 
720
728
  filter_hidden?: boolean | null
721
729
  root?: Gio.File | null
730
+ filterHidden?: boolean | null
722
731
  }
723
732
 
724
733
  }
@@ -728,6 +737,7 @@ export interface IndexingTree {
728
737
  // Own properties of TrackerMiner-2.0.TrackerMiner.IndexingTree
729
738
 
730
739
  filter_hidden: boolean
740
+ filterHidden: boolean
731
741
  readonly root: Gio.File
732
742
 
733
743
  // Own fields of TrackerMiner-2.0.TrackerMiner.IndexingTree
@@ -1013,6 +1023,7 @@ export module Miner {
1013
1023
  progress?: number | null
1014
1024
  remaining_time?: number | null
1015
1025
  status?: string | null
1026
+ remainingTime?: number | null
1016
1027
  }
1017
1028
 
1018
1029
  }
@@ -1023,6 +1034,7 @@ export interface Miner extends Gio.Initable {
1023
1034
 
1024
1035
  progress: number
1025
1036
  remaining_time: number
1037
+ remainingTime: number
1026
1038
  status: string | null
1027
1039
 
1028
1040
  // Own fields of TrackerMiner-2.0.TrackerMiner.Miner
@@ -1197,6 +1209,9 @@ export module MinerFS {
1197
1209
  processing_pool_wait_limit?: number | null
1198
1210
  root?: Gio.File | null
1199
1211
  throttle?: number | null
1212
+ dataProvider?: DataProvider | null
1213
+ processingPoolReadyLimit?: number | null
1214
+ processingPoolWaitLimit?: number | null
1200
1215
  }
1201
1216
 
1202
1217
  }
@@ -1206,8 +1221,11 @@ export interface MinerFS extends Gio.Initable {
1206
1221
  // Own properties of TrackerMiner-2.0.TrackerMiner.MinerFS
1207
1222
 
1208
1223
  readonly data_provider: DataProvider
1224
+ readonly dataProvider: DataProvider
1209
1225
  processing_pool_ready_limit: number
1226
+ processingPoolReadyLimit: number
1210
1227
  processing_pool_wait_limit: number
1228
+ processingPoolWaitLimit: number
1211
1229
  readonly root: Gio.File
1212
1230
  throttle: number
1213
1231
 
@@ -1479,6 +1497,8 @@ export module MinerProxy {
1479
1497
  dbus_connection?: Gio.DBusConnection | null
1480
1498
  dbus_path?: string | null
1481
1499
  miner?: Miner | null
1500
+ dbusConnection?: Gio.DBusConnection | null
1501
+ dbusPath?: string | null
1482
1502
  }
1483
1503
 
1484
1504
  }
@@ -1488,7 +1508,9 @@ export interface MinerProxy extends Gio.Initable {
1488
1508
  // Own properties of TrackerMiner-2.0.TrackerMiner.MinerProxy
1489
1509
 
1490
1510
  readonly dbus_connection: Gio.DBusConnection
1511
+ readonly dbusConnection: Gio.DBusConnection
1491
1512
  readonly dbus_path: string | null
1513
+ readonly dbusPath: string | null
1492
1514
  readonly miner: Miner
1493
1515
 
1494
1516
  // Own fields of TrackerMiner-2.0.TrackerMiner.MinerProxy
@@ -458,6 +458,10 @@ module Decorator {
458
458
  commit_batch_size?: number | null
459
459
  data_source?: string | null
460
460
  priority_rdf_types?: string[] | null
461
+ classNames?: string[] | null
462
+ commitBatchSize?: number | null
463
+ dataSource?: string | null
464
+ priorityRdfTypes?: string[] | null
461
465
  }
462
466
 
463
467
  }
@@ -467,9 +471,13 @@ interface Decorator extends Gio.Initable {
467
471
  // Own properties of TrackerMiner-2.0.TrackerMiner.Decorator
468
472
 
469
473
  class_names: string[]
474
+ classNames: string[]
470
475
  commit_batch_size: number
476
+ commitBatchSize: number
471
477
  readonly data_source: string | null
478
+ readonly dataSource: string | null
472
479
  priority_rdf_types: string[]
480
+ priorityRdfTypes: string[]
473
481
 
474
482
  // Own fields of TrackerMiner-2.0.TrackerMiner.Decorator
475
483
 
@@ -721,6 +729,7 @@ module IndexingTree {
721
729
 
722
730
  filter_hidden?: boolean | null
723
731
  root?: Gio.File | null
732
+ filterHidden?: boolean | null
724
733
  }
725
734
 
726
735
  }
@@ -730,6 +739,7 @@ interface IndexingTree {
730
739
  // Own properties of TrackerMiner-2.0.TrackerMiner.IndexingTree
731
740
 
732
741
  filter_hidden: boolean
742
+ filterHidden: boolean
733
743
  readonly root: Gio.File
734
744
 
735
745
  // Own fields of TrackerMiner-2.0.TrackerMiner.IndexingTree
@@ -1015,6 +1025,7 @@ module Miner {
1015
1025
  progress?: number | null
1016
1026
  remaining_time?: number | null
1017
1027
  status?: string | null
1028
+ remainingTime?: number | null
1018
1029
  }
1019
1030
 
1020
1031
  }
@@ -1025,6 +1036,7 @@ interface Miner extends Gio.Initable {
1025
1036
 
1026
1037
  progress: number
1027
1038
  remaining_time: number
1039
+ remainingTime: number
1028
1040
  status: string | null
1029
1041
 
1030
1042
  // Own fields of TrackerMiner-2.0.TrackerMiner.Miner
@@ -1199,6 +1211,9 @@ module MinerFS {
1199
1211
  processing_pool_wait_limit?: number | null
1200
1212
  root?: Gio.File | null
1201
1213
  throttle?: number | null
1214
+ dataProvider?: DataProvider | null
1215
+ processingPoolReadyLimit?: number | null
1216
+ processingPoolWaitLimit?: number | null
1202
1217
  }
1203
1218
 
1204
1219
  }
@@ -1208,8 +1223,11 @@ interface MinerFS extends Gio.Initable {
1208
1223
  // Own properties of TrackerMiner-2.0.TrackerMiner.MinerFS
1209
1224
 
1210
1225
  readonly data_provider: DataProvider
1226
+ readonly dataProvider: DataProvider
1211
1227
  processing_pool_ready_limit: number
1228
+ processingPoolReadyLimit: number
1212
1229
  processing_pool_wait_limit: number
1230
+ processingPoolWaitLimit: number
1213
1231
  readonly root: Gio.File
1214
1232
  throttle: number
1215
1233
 
@@ -1481,6 +1499,8 @@ module MinerProxy {
1481
1499
  dbus_connection?: Gio.DBusConnection | null
1482
1500
  dbus_path?: string | null
1483
1501
  miner?: Miner | null
1502
+ dbusConnection?: Gio.DBusConnection | null
1503
+ dbusPath?: string | null
1484
1504
  }
1485
1505
 
1486
1506
  }
@@ -1490,7 +1510,9 @@ interface MinerProxy extends Gio.Initable {
1490
1510
  // Own properties of TrackerMiner-2.0.TrackerMiner.MinerProxy
1491
1511
 
1492
1512
  readonly dbus_connection: Gio.DBusConnection
1513
+ readonly dbusConnection: Gio.DBusConnection
1493
1514
  readonly dbus_path: string | null
1515
+ readonly dbusPath: string | null
1494
1516
  readonly miner: Miner
1495
1517
 
1496
1518
  // Own fields of TrackerMiner-2.0.TrackerMiner.MinerProxy