@girs/gcr-3 4.4.0 → 4.5.0

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.
Files changed (3) hide show
  1. package/README.md +36 -41
  2. package/gcr-3.d.ts +134 -53
  3. package/package.json +7 -7
package/README.md CHANGED
@@ -4,82 +4,77 @@
4
4
  ![version](https://img.shields.io/npm/v/@girs/gcr-3)
5
5
  ![downloads/week](https://img.shields.io/npm/dw/@girs/gcr-3)
6
6
 
7
+ GJS TypeScript type definitions for Gcr-3, generated from library version 3.41.2 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.5.0.
7
8
 
8
- GJS TypeScript type definitions for Gcr-3, generated from library version 3.41.2 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.4.0.
9
+ This package contains type declarations only. It ships no runtime code, so it adds
10
+ nothing to your program and works with any bundler or none at all.
9
11
 
10
12
  ## Install
11
13
 
12
- Install the type definitions with npm:
13
14
  ```bash
14
15
  npm install @girs/gcr-3
15
16
  ```
16
17
 
17
- ## Usage
18
+ Any package manager works. The package has no dependencies beyond other `@girs/*`
19
+ type packages.
20
+
21
+ ## What it exports
22
+
23
+ | Import | What you get |
24
+ |---|---|
25
+ | `@girs/gcr-3` | the namespace as a default export, plus the ambient and global declarations |
26
+ | `@girs/gcr-3/ambient` | only the `gi://` module declarations |
27
+ | `@girs/gcr-3/import` | only the `imports.gi` declarations |
28
+ | `@girs/gcr-3/gcr-3` | the namespace, without the side-effecting declarations |
29
+
30
+ ## Three ways to import
31
+
32
+ Which one you use depends on how you write imports elsewhere, not on your toolchain.
33
+
34
+ ### As a module
18
35
 
19
- Import it like any other module:
20
36
  ```ts
21
37
  import Gcr from '@girs/gcr-3';
22
38
  ```
23
39
 
24
- ### Ambient Modules
40
+ ### As `gi://`
25
41
 
26
- [Ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules) let you write the same import you would in plain JavaScript.
27
- For this you need to include `@girs/gcr-3` or `@girs/gcr-3/ambient` in your `tsconfig` or entry point Typescript file:
42
+ GJS resolves `gi://` at runtime. To give it types, reference the package once, either
43
+ from your entry point or from `tsconfig.json`:
28
44
 
29
- `index.ts`:
30
45
  ```ts
31
- import '@girs/gcr-3'
46
+ import '@girs/gcr-3';
32
47
  ```
33
48
 
34
- `tsconfig.json`:
35
49
  ```json
36
- {
37
- "compilerOptions": {
38
- ...
39
- },
40
- "include": ["@girs/gcr-3"],
41
- ...
42
- }
50
+ { "include": ["@girs/gcr-3"] }
43
51
  ```
44
52
 
45
- The ambient module now resolves with types:
53
+ Then the runtime spelling type-checks:
46
54
 
47
55
  ```ts
48
56
  import Gcr from 'gi://Gcr?version=3';
49
57
  ```
50
58
 
51
- ### Global import
52
-
53
- GJS's global `imports.gi` works too, with types.
54
- For this you need to include `@girs/gcr-3` or `@girs/gcr-3/import` in your `tsconfig` or entry point Typescript file:
59
+ Referencing `@girs/gcr-3/ambient` instead pulls in these declarations
60
+ alone. See [ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules).
55
61
 
56
- `index.ts`:
57
- ```ts
58
- import '@girs/gcr-3'
59
- ```
60
-
61
- `tsconfig.json`:
62
- ```json
63
- {
64
- "compilerOptions": {
65
- ...
66
- },
67
- "include": ["@girs/gcr-3"],
68
- ...
69
- }
70
- ```
62
+ ### As `imports.gi`
71
63
 
72
- That form carries types as well:
64
+ GJS's global object works the same way, via `@girs/gcr-3/import`:
73
65
 
74
66
  ```ts
75
67
  const Gcr = imports.gi.Gcr;
76
68
  ```
77
69
 
78
- ### Bundle
70
+ ## Building
79
71
 
80
- Most projects want a bundler. [esbuild](https://esbuild.github.io/) is the smallest thing that works; the [examples directory](https://github.com/gjsify/ts-for-gir/tree/main/examples) has setups for several others.
72
+ The declarations need no build step. If you bundle, every bundler works, since there is
73
+ no runtime code to resolve. The [examples](https://github.com/gjsify/ts-for-gir/tree/main/examples)
74
+ show working setups for several.
81
75
 
82
76
  ## Other packages
83
77
 
84
- All existing pre-generated packages can be found on [gjsify/types](https://github.com/gjsify/types).
78
+ Every pre-generated package is at [gjsify/types](https://github.com/gjsify/types).
79
+
85
80
 
package/gcr-3.d.ts CHANGED
@@ -36,35 +36,35 @@ export namespace Gcr {
36
36
  * When a chain is not yet built it has this status. If a chain is modified after
37
37
  * being built, it has this status.
38
38
  */
39
- UNKNOWN,
39
+ UNKNOWN = 0,
40
40
  /**
41
41
  * A full chain could not be loaded. The
42
42
  * chain does not end with a self-signed certificate, a trusted anchor, or a
43
43
  * pinned certificate.
44
44
  */
45
- INCOMPLETE,
45
+ INCOMPLETE = 1,
46
46
  /**
47
47
  * The certificate chain contains a revoked
48
48
  * or otherwise explicitly distrusted certificate. The entire chain should
49
49
  * be distrusted.
50
50
  */
51
- DISTRUSTED,
51
+ DISTRUSTED = 2,
52
52
  /**
53
53
  * The chain ends with a self-signed
54
54
  * certificate. No trust anchor was found.
55
55
  */
56
- SELFSIGNED,
56
+ SELFSIGNED = 3,
57
57
  /**
58
58
  * The chain represents a pinned certificate. A
59
59
  * pinned certificate is an exception which trusts a given certificate
60
60
  * explicitly for a purpose and communication with a certain peer.
61
61
  */
62
- PINNED,
62
+ PINNED = 4,
63
63
  /**
64
64
  * The chain ends with an anchored
65
65
  * certificate. The anchored certificate is not necessarily self-signed.
66
66
  */
67
- ANCHORED,
67
+ ANCHORED = 5,
68
68
  }
69
69
 
70
70
 
@@ -76,7 +76,7 @@ export namespace Gcr {
76
76
  /**
77
77
  * certificate request is in PKCS#10 format
78
78
  */
79
- CERTIFICATE_REQUEST_PKCS10,
79
+ CERTIFICATE_REQUEST_PKCS10 = 1,
80
80
  }
81
81
 
82
82
 
@@ -88,19 +88,19 @@ export namespace Gcr {
88
88
  /**
89
89
  * Failed to parse or serialize the data
90
90
  */
91
- FAILURE,
91
+ FAILURE = -1,
92
92
  /**
93
93
  * The data was unrecognized or unsupported
94
94
  */
95
- UNRECOGNIZED,
95
+ UNRECOGNIZED = 1,
96
96
  /**
97
97
  * The operation was cancelled
98
98
  */
99
- CANCELLED,
99
+ CANCELLED = 2,
100
100
  /**
101
101
  * The data was encrypted or locked and could not be unlocked.
102
102
  */
103
- LOCKED,
103
+ LOCKED = 3,
104
104
  }
105
105
 
106
106
 
@@ -112,127 +112,127 @@ export namespace Gcr {
112
112
  /**
113
113
  * Represents all the formats, when enabling or disabling
114
114
  */
115
- ALL,
115
+ ALL = -1,
116
116
  /**
117
117
  * Not a valid format
118
118
  */
119
- INVALID,
119
+ INVALID = 0,
120
120
  /**
121
121
  * DER encoded private key
122
122
  */
123
- DER_PRIVATE_KEY,
123
+ DER_PRIVATE_KEY = 100,
124
124
  /**
125
125
  * DER encoded RSA private key
126
126
  */
127
- DER_PRIVATE_KEY_RSA,
127
+ DER_PRIVATE_KEY_RSA = 101,
128
128
  /**
129
129
  * DER encoded DSA private key
130
130
  */
131
- DER_PRIVATE_KEY_DSA,
131
+ DER_PRIVATE_KEY_DSA = 102,
132
132
  /**
133
133
  * DER encoded EC private key
134
134
  */
135
- DER_PRIVATE_KEY_EC,
135
+ DER_PRIVATE_KEY_EC = 103,
136
136
  /**
137
137
  * DER encoded SubjectPublicKeyInfo
138
138
  */
139
- DER_SUBJECT_PUBLIC_KEY,
139
+ DER_SUBJECT_PUBLIC_KEY = 150,
140
140
  /**
141
141
  * DER encoded X.509 certificate
142
142
  */
143
- DER_CERTIFICATE_X509,
143
+ DER_CERTIFICATE_X509 = 200,
144
144
  /**
145
145
  * DER encoded PKCS#7 container file which can contain certificates
146
146
  */
147
- DER_PKCS7,
147
+ DER_PKCS7 = 300,
148
148
  /**
149
149
  * DER encoded PKCS#8 file which can contain a key
150
150
  */
151
- DER_PKCS8,
151
+ DER_PKCS8 = 400,
152
152
  /**
153
153
  * Unencrypted DER encoded PKCS#8 file which can contain a key
154
154
  */
155
- DER_PKCS8_PLAIN,
155
+ DER_PKCS8_PLAIN = 401,
156
156
  /**
157
157
  * Encrypted DER encoded PKCS#8 file which can contain a key
158
158
  */
159
- DER_PKCS8_ENCRYPTED,
159
+ DER_PKCS8_ENCRYPTED = 402,
160
160
  /**
161
161
  * DER encoded PKCS#10 certificate request file
162
162
  */
163
- DER_PKCS10,
163
+ DER_PKCS10 = 450,
164
164
  /**
165
165
  * DER encoded SPKAC as generated by HTML5 keygen element
166
166
  */
167
- DER_SPKAC,
167
+ DER_SPKAC = 455,
168
168
  /**
169
169
  * OpenSSL style SPKAC data
170
170
  */
171
- BASE64_SPKAC,
171
+ BASE64_SPKAC = 456,
172
172
  /**
173
173
  * DER encoded PKCS#12 file which can contain certificates and/or keys
174
174
  */
175
- DER_PKCS12,
175
+ DER_PKCS12 = 500,
176
176
  /**
177
177
  * OpenSSH v1 or v2 public key
178
178
  */
179
- OPENSSH_PUBLIC,
179
+ OPENSSH_PUBLIC = 600,
180
180
  /**
181
181
  * OpenPGP key packet(s)
182
182
  */
183
- OPENPGP_PACKET,
183
+ OPENPGP_PACKET = 700,
184
184
  /**
185
185
  * OpenPGP public or private key armor encoded data
186
186
  */
187
- OPENPGP_ARMOR,
187
+ OPENPGP_ARMOR = 701,
188
188
  /**
189
189
  * An OpenSSL style PEM file with unspecified contents
190
190
  */
191
- PEM,
191
+ PEM = 1000,
192
192
  /**
193
193
  * An OpenSSL style PEM file with a private RSA key
194
194
  */
195
- PEM_PRIVATE_KEY_RSA,
195
+ PEM_PRIVATE_KEY_RSA = 1001,
196
196
  /**
197
197
  * An OpenSSL style PEM file with a private DSA key
198
198
  */
199
- PEM_PRIVATE_KEY_DSA,
199
+ PEM_PRIVATE_KEY_DSA = 1002,
200
200
  /**
201
201
  * An OpenSSL style PEM file with an X.509 certificate
202
202
  */
203
- PEM_CERTIFICATE_X509,
203
+ PEM_CERTIFICATE_X509 = 1003,
204
204
  /**
205
205
  * An OpenSSL style PEM file containing PKCS#7
206
206
  */
207
- PEM_PKCS7,
207
+ PEM_PKCS7 = 1004,
208
208
  /**
209
209
  * Unencrypted OpenSSL style PEM file containing PKCS#8
210
210
  */
211
- PEM_PKCS8_PLAIN,
211
+ PEM_PKCS8_PLAIN = 1005,
212
212
  /**
213
213
  * Encrypted OpenSSL style PEM file containing PKCS#8
214
214
  */
215
- PEM_PKCS8_ENCRYPTED,
215
+ PEM_PKCS8_ENCRYPTED = 1006,
216
216
  /**
217
217
  * An OpenSSL style PEM file containing PKCS#12
218
218
  */
219
- PEM_PKCS12,
219
+ PEM_PKCS12 = 1007,
220
220
  /**
221
221
  * An OpenSSL style PEM file with a private key
222
222
  */
223
- PEM_PRIVATE_KEY,
223
+ PEM_PRIVATE_KEY = 1008,
224
224
  /**
225
225
  * An OpenSSL style PEM file containing PKCS#10
226
226
  */
227
- PEM_PKCS10,
227
+ PEM_PKCS10 = 1009,
228
228
  /**
229
229
  * An OpenSSL style PEM file with a private EC key
230
230
  */
231
- PEM_PRIVATE_KEY_EC,
231
+ PEM_PRIVATE_KEY_EC = 1010,
232
232
  /**
233
233
  * An OpenSSL style PEM file containing a SubjectPublicKeyInfo
234
234
  */
235
- PEM_PUBLIC_KEY,
235
+ PEM_PUBLIC_KEY = 1011,
236
236
  }
237
237
 
238
238
 
@@ -244,11 +244,11 @@ export namespace Gcr {
244
244
  /**
245
245
  * the prompt was cancelled
246
246
  */
247
- CANCEL,
247
+ CANCEL = 0,
248
248
  /**
249
249
  * the user replied with 'ok'
250
250
  */
251
- CONTINUE,
251
+ CONTINUE = 1,
252
252
  }
253
253
 
254
254
 
@@ -265,7 +265,7 @@ export namespace Gcr {
265
265
  /**
266
266
  * another prompt is already in progress
267
267
  */
268
- SYSTEM_PROMPT_IN_PROGRESS,
268
+ SYSTEM_PROMPT_IN_PROGRESS = 1,
269
269
  }
270
270
 
271
271
 
@@ -278,62 +278,90 @@ export namespace Gcr {
278
278
  /**
279
279
  * only one prompt shown at a time
280
280
  */
281
- SINGLE,
281
+ SINGLE = 0,
282
282
  /**
283
283
  * more than one prompt shown at a time
284
284
  */
285
- MULTIPLE,
285
+ MULTIPLE = 1,
286
286
  }
287
287
 
288
288
 
289
+ /**
290
+ * @default application-certificate
291
+ */
289
292
  const ICON_CERTIFICATE: string;
290
293
 
294
+ /**
295
+ * @default gcr-gnupg
296
+ */
291
297
  const ICON_GNUPG: string;
292
298
 
299
+ /**
300
+ * @default user-home
301
+ */
293
302
  const ICON_HOME_DIRECTORY: string;
294
303
 
304
+ /**
305
+ * @default gcr-key
306
+ */
295
307
  const ICON_KEY: string;
296
308
 
309
+ /**
310
+ * @default gcr-key-pair
311
+ */
297
312
  const ICON_KEY_PAIR: string;
298
313
 
314
+ /**
315
+ * @default gcr-password
316
+ */
299
317
  const ICON_PASSWORD: string;
300
318
 
319
+ /**
320
+ * @default gcr-smart-card
321
+ */
301
322
  const ICON_SMART_CARD: string;
302
323
 
303
324
  /**
304
325
  * The major version number of the Gcr library.
326
+ * @default 3
305
327
  */
306
328
  const MAJOR_VERSION: number;
307
329
 
308
330
  /**
309
331
  * The micro version number of the Gcr library.
332
+ * @default 2
310
333
  */
311
334
  const MICRO_VERSION: number;
312
335
 
313
336
  /**
314
337
  * The minor version number of the Gcr library.
338
+ * @default 41
315
339
  */
316
340
  const MINOR_VERSION: number;
317
341
 
318
342
  /**
319
343
  * The purpose used to verify the client certificate in a TLS connection.
344
+ * @default 1.3.6.1.5.5.7.3.2
320
345
  */
321
346
  const PURPOSE_CLIENT_AUTH: string;
322
347
 
323
348
  /**
324
349
  * The purpose used to verify certificate used for the signature on signed code.
350
+ * @default 1.3.6.1.5.5.7.3.3
325
351
  */
326
352
  const PURPOSE_CODE_SIGNING: string;
327
353
 
328
354
  /**
329
355
  * The purpose used to verify certificates that are used in email communication
330
356
  * such as S/MIME.
357
+ * @default 1.3.6.1.5.5.7.3.4
331
358
  */
332
359
  const PURPOSE_EMAIL: string;
333
360
 
334
361
  /**
335
362
  * The purpose used to verify the server certificate in a TLS connection. This
336
363
  * is the most common purpose in use.
364
+ * @default 1.3.6.1.5.5.7.3.1
337
365
  */
338
366
  const PURPOSE_SERVER_AUTH: string;
339
367
 
@@ -341,15 +369,28 @@ export namespace Gcr {
341
369
  * The current secret exchange protocol. Key agreement is done using DH with the
342
370
  * 1536 bit IKE parameter group. Keys are derived using SHA256 with HKDF. The
343
371
  * transport encryption is done with 128 bit AES.
372
+ * @default sx-aes-1
344
373
  */
345
374
  const SECRET_EXCHANGE_PROTOCOL_1: string;
346
375
 
376
+ /**
377
+ * @default always
378
+ */
347
379
  const UNLOCK_OPTION_ALWAYS: string;
348
380
 
381
+ /**
382
+ * @default idle
383
+ */
349
384
  const UNLOCK_OPTION_IDLE: string;
350
385
 
386
+ /**
387
+ * @default session
388
+ */
351
389
  const UNLOCK_OPTION_SESSION: string;
352
390
 
391
+ /**
392
+ * @default timeout
393
+ */
353
394
  const UNLOCK_OPTION_TIMEOUT: string;
354
395
 
355
396
  /**
@@ -533,6 +574,7 @@ export namespace Gcr {
533
574
  * @param module_path the full file path of the PKCS#11 module
534
575
  * @param unused unused
535
576
  * @returns whether the module was sucessfully added.
577
+ * @throws GLib.Error
536
578
  */
537
579
  function pkcs11_add_module_from_file(module_path: string, unused: null): boolean;
538
580
 
@@ -588,6 +630,7 @@ export namespace Gcr {
588
630
  * Asynchronously initialize the registered PKCS#11 modules.
589
631
  * @param cancellable optional cancellable used to cancel the operation
590
632
  * @returns whether the operation was successful or not.
633
+ * @throws GLib.Error
591
634
  */
592
635
  function pkcs11_initialize(cancellable: Gio.Cancellable | null): boolean;
593
636
 
@@ -614,6 +657,7 @@ export namespace Gcr {
614
657
  * modules.
615
658
  * @param result the asynchronous result
616
659
  * @returns whether the operation was successful or not.
660
+ * @throws GLib.Error
617
661
  */
618
662
  function pkcs11_initialize_finish(result: Gio.AsyncResult): boolean;
619
663
 
@@ -663,6 +707,7 @@ export namespace Gcr {
663
707
  * @param peer the peer for this pinned certificate
664
708
  * @param cancellable a {@link Gio.Cancellable}
665
709
  * @returns `true` if the pinned certificate is recorded successfully
710
+ * @throws GLib.Error
666
711
  */
667
712
  function trust_add_pinned_certificate(certificate: Certificate, purpose: string, peer: string, cancellable: Gio.Cancellable | null): boolean;
668
713
 
@@ -725,6 +770,7 @@ export namespace Gcr {
725
770
  * `gcr_trust_add_pinned_certificate_async()`.
726
771
  * @param result the {@link Gio.AsyncResult} passed to the callback
727
772
  * @returns `true` if the pinned certificate is recorded successfully
773
+ * @throws GLib.Error
728
774
  */
729
775
  function trust_add_pinned_certificate_finish(result: Gio.AsyncResult): boolean;
730
776
 
@@ -742,6 +788,7 @@ export namespace Gcr {
742
788
  * @param purpose the purpose string
743
789
  * @param cancellable a {@link Gio.Cancellable}
744
790
  * @returns `true` if the certificate is a trust anchor
791
+ * @throws GLib.Error
745
792
  */
746
793
  function trust_is_certificate_anchored(certificate: Certificate, purpose: string, cancellable: Gio.Cancellable | null): boolean;
747
794
 
@@ -792,6 +839,7 @@ export namespace Gcr {
792
839
  * if an error occurred.
793
840
  * @param result the {@link Gio.AsyncResult} passed to the callback
794
841
  * @returns `true` if the certificate is a trust anchor
842
+ * @throws GLib.Error
795
843
  */
796
844
  function trust_is_certificate_anchored_finish(result: Gio.AsyncResult): boolean;
797
845
 
@@ -809,6 +857,7 @@ export namespace Gcr {
809
857
  * @param peer the peer for this pinned
810
858
  * @param cancellable a {@link Gio.Cancellable}
811
859
  * @returns `true` if the certificate is pinned for the host and purpose
860
+ * @throws GLib.Error
812
861
  */
813
862
  function trust_is_certificate_pinned(certificate: Certificate, purpose: string, peer: string, cancellable: Gio.Cancellable | null): boolean;
814
863
 
@@ -862,6 +911,7 @@ export namespace Gcr {
862
911
  * if an error occurred.
863
912
  * @param result the {@link Gio.AsyncResult} passed to the callback
864
913
  * @returns `true` if the certificate is pinned.
914
+ * @throws GLib.Error
865
915
  */
866
916
  function trust_is_certificate_pinned_finish(result: Gio.AsyncResult): boolean;
867
917
 
@@ -878,6 +928,7 @@ export namespace Gcr {
878
928
  * @param peer the peer for this pinned certificate
879
929
  * @param cancellable a {@link Gio.Cancellable}
880
930
  * @returns `true` if the pinned certificate no longer exists
931
+ * @throws GLib.Error
881
932
  */
882
933
  function trust_remove_pinned_certificate(certificate: Certificate, purpose: string, peer: string, cancellable: Gio.Cancellable | null): boolean;
883
934
 
@@ -934,6 +985,7 @@ export namespace Gcr {
934
985
  * `gcr_trust_remove_pinned_certificate_async()`.
935
986
  * @param result the {@link Gio.AsyncResult} passed to the callback
936
987
  * @returns `true` if the pinned certificate no longer exists
988
+ * @throws GLib.Error
937
989
  */
938
990
  function trust_remove_pinned_certificate_finish(result: Gio.AsyncResult): boolean;
939
991
 
@@ -952,14 +1004,14 @@ export namespace Gcr {
952
1004
  /**
953
1005
  * no flags
954
1006
  */
955
- NONE,
1007
+ NONE = 0,
956
1008
  /**
957
1009
  * If this flag is specified then no
958
1010
  * lookups for anchors or pinned certificates are done, and the resulting chain
959
1011
  * will be neither anchored or pinned. Additionally no missing certificate
960
1012
  * authorities are looked up in PKCS#11.
961
1013
  */
962
- NO_LOOKUPS,
1014
+ NO_LOOKUPS = 1,
963
1015
  }
964
1016
 
965
1017
 
@@ -967,9 +1019,9 @@ export namespace Gcr {
967
1019
  * @gir-type Flags
968
1020
  */
969
1021
  enum ColumnFlags {
970
- NONE,
971
- HIDDEN,
972
- SORTABLE,
1022
+ NONE = 0,
1023
+ HIDDEN = 2,
1024
+ SORTABLE = 4,
973
1025
  }
974
1026
 
975
1027
 
@@ -1106,6 +1158,7 @@ export namespace Gcr {
1106
1158
  * @param flags chain completion flags
1107
1159
  * @param cancellable a {@link Gio.Cancellable} or `null`
1108
1160
  * @returns whether the operation completed successfully
1161
+ * @throws GLib.Error
1109
1162
  */
1110
1163
  build(purpose: string, peer: string | null, flags: CertificateChainFlags, cancellable: Gio.Cancellable | null): boolean;
1111
1164
 
@@ -1227,6 +1280,7 @@ export namespace Gcr {
1227
1280
  * `gcr_certificate_chain_build_async()`.
1228
1281
  * @param result the {@link Gio.AsyncResult} passed to the callback
1229
1282
  * @returns whether the operation succeeded
1283
+ * @throws GLib.Error
1230
1284
  */
1231
1285
  build_finish(result: Gio.AsyncResult): boolean;
1232
1286
 
@@ -1383,6 +1437,7 @@ export namespace Gcr {
1383
1437
  * This call may block as it signs the request using the private key.
1384
1438
  * @param cancellable a cancellation object
1385
1439
  * @returns whether certificate request was successfully completed or not
1440
+ * @throws GLib.Error
1386
1441
  */
1387
1442
  complete(cancellable: Gio.Cancellable | null): boolean;
1388
1443
 
@@ -1420,6 +1475,7 @@ export namespace Gcr {
1420
1475
  * request.
1421
1476
  * @param result result of the asynchronous operation
1422
1477
  * @returns whether certificate request was successfully completed or not
1478
+ * @throws GLib.Error
1423
1479
  */
1424
1480
  complete_finish(result: Gio.AsyncResult): boolean;
1425
1481
 
@@ -1628,7 +1684,7 @@ export namespace Gcr {
1628
1684
  * @signal
1629
1685
  * @run-last
1630
1686
  */
1631
- authenticate: (arg0: number) => boolean | void;
1687
+ authenticate: (count: number) => boolean | void;
1632
1688
  /**
1633
1689
  * This signal is emitted when an item is sucessfully parsed. To access
1634
1690
  * the information about the item use the `gcr_parser_get_parsed_label()`,
@@ -1848,6 +1904,7 @@ export namespace Gcr {
1848
1904
  * may fire during the parsing.
1849
1905
  * @param data the data to parse
1850
1906
  * @returns Whether the data was parsed successfully or not.
1907
+ * @throws GLib.Error
1851
1908
  */
1852
1909
  parse_bytes(data: GLib.Bytes | Uint8Array): boolean;
1853
1910
 
@@ -1858,6 +1915,7 @@ export namespace Gcr {
1858
1915
  * A copy of the data will be made. Use `gcr_parser_parse_bytes()` to avoid this.
1859
1916
  * @param data the data to parse
1860
1917
  * @returns Whether the data was parsed successfully or not.
1918
+ * @throws GLib.Error
1861
1919
  */
1862
1920
  parse_data(data: Uint8Array | string): boolean;
1863
1921
 
@@ -1871,6 +1929,7 @@ export namespace Gcr {
1871
1929
  * @param input The input stream
1872
1930
  * @param cancellable An optional cancellation object
1873
1931
  * @returns Whether the parsing completed successfully or not.
1932
+ * @throws GLib.Error
1874
1933
  */
1875
1934
  parse_stream(input: Gio.InputStream, cancellable: Gio.Cancellable | null): boolean;
1876
1935
 
@@ -1913,6 +1972,7 @@ export namespace Gcr {
1913
1972
  * Complete an operation to parse a stream.
1914
1973
  * @param result The operation result
1915
1974
  * @returns Whether the parsing completed successfully or not.
1975
+ * @throws GLib.Error
1916
1976
  */
1917
1977
  parse_stream_finish(result: Gio.AsyncResult): boolean;
1918
1978
 
@@ -3228,6 +3288,7 @@ export namespace Gcr {
3228
3288
  * still closed and may not be further used.
3229
3289
  * @param cancellable an optional cancellation object
3230
3290
  * @returns whether close was cleanly completed
3291
+ * @throws GLib.Error
3231
3292
  */
3232
3293
  close(cancellable: Gio.Cancellable | null): boolean;
3233
3294
 
@@ -3276,6 +3337,7 @@ export namespace Gcr {
3276
3337
  * still closed and may not be further used.
3277
3338
  * @param result asynchronous operation result
3278
3339
  * @returns whether close was cleanly completed
3340
+ * @throws GLib.Error
3279
3341
  */
3280
3342
  close_finish(result: Gio.AsyncResult): boolean;
3281
3343
 
@@ -3504,6 +3566,7 @@ export namespace Gcr {
3504
3566
  * an error occurs. Check the `error` argument to tell the difference.
3505
3567
  * @param cancellable optional cancellation object
3506
3568
  * @returns the reply from the prompt
3569
+ * @throws GLib.Error
3507
3570
  */
3508
3571
  confirm(cancellable: Gio.Cancellable | null): PromptReply;
3509
3572
 
@@ -3547,6 +3610,7 @@ export namespace Gcr {
3547
3610
  * an error occurs. Check the `error` argument to tell the difference.
3548
3611
  * @param result asynchronous result passed to callback
3549
3612
  * @returns the reply from the prompt
3613
+ * @throws GLib.Error
3550
3614
  */
3551
3615
  confirm_finish(result: Gio.AsyncResult): PromptReply;
3552
3616
 
@@ -3564,6 +3628,7 @@ export namespace Gcr {
3564
3628
  * an error occurs. Check the `error` argument to tell the difference.
3565
3629
  * @param cancellable optional cancellation object
3566
3630
  * @returns the reply from the prompt
3631
+ * @throws GLib.Error
3567
3632
  */
3568
3633
  confirm_run(cancellable: Gio.Cancellable | null): PromptReply;
3569
3634
 
@@ -3684,6 +3749,7 @@ export namespace Gcr {
3684
3749
  * `error` argument to tell the difference.
3685
3750
  * @param cancellable optional cancellation object
3686
3751
  * @returns the password owned by the prompt, or `null`
3752
+ * @throws GLib.Error
3687
3753
  */
3688
3754
  password(cancellable: Gio.Cancellable | null): string;
3689
3755
 
@@ -3727,6 +3793,7 @@ export namespace Gcr {
3727
3793
  * `error` argument to tell the difference.
3728
3794
  * @param result asynchronous result passed to callback
3729
3795
  * @returns the password owned by the prompt, or `null`
3796
+ * @throws GLib.Error
3730
3797
  */
3731
3798
  password_finish(result: Gio.AsyncResult): string;
3732
3799
 
@@ -3746,6 +3813,7 @@ export namespace Gcr {
3746
3813
  * `error` argument to tell the difference.
3747
3814
  * @param cancellable optional cancellation object
3748
3815
  * @returns the password owned by the prompt, or `null`
3816
+ * @throws GLib.Error
3749
3817
  */
3750
3818
  password_run(cancellable: Gio.Cancellable | null): string;
3751
3819
 
@@ -4043,6 +4111,7 @@ export namespace Gcr {
4043
4111
  * @param res a {@link Gio.AsyncResult}.
4044
4112
  * @returns `true` if successful. If an error has occurred, this function will return `false` and set `error` appropriately if present.
4045
4113
  * @since 2.22
4114
+ * @throws GLib.Error
4046
4115
  */
4047
4116
  init_finish(res: Gio.AsyncResult): boolean;
4048
4117
 
@@ -4052,6 +4121,7 @@ export namespace Gcr {
4052
4121
  * @param res the {@link Gio.AsyncResult} from the callback
4053
4122
  * @returns a newly created {@link GObject.Object}, or `null` on error. Free with `g_object_unref()`.
4054
4123
  * @since 2.22
4124
+ * @throws GLib.Error
4055
4125
  */
4056
4126
  new_finish(res: Gio.AsyncResult): SystemPrompt;
4057
4127
 
@@ -4151,6 +4221,7 @@ export namespace Gcr {
4151
4221
  * @param cancellable optional {@link Gio.Cancellable} object, `null` to ignore.
4152
4222
  * @returns `true` if successful. If an error has occurred, this function will return `false` and set `error` appropriately if present.
4153
4223
  * @since 2.22
4224
+ * @throws GLib.Error
4154
4225
  */
4155
4226
  init(cancellable: Gio.Cancellable | null): boolean;
4156
4227
 
@@ -5304,6 +5375,7 @@ export namespace Gcr {
5304
5375
  * @param builder supplemented attributes
5305
5376
  * @param cancellable optional cancellable object
5306
5377
  * @returns {@link Gio.TlsInteractionResult.HANDLED} if successful or {@link Gio.TlsInteractionResult.FAILED}
5378
+ * @throws GLib.Error
5307
5379
  */
5308
5380
  supplement(builder: Gck.Builder, cancellable: Gio.Cancellable | null): Gio.TlsInteractionResult;
5309
5381
 
@@ -5349,6 +5421,7 @@ export namespace Gcr {
5349
5421
  * with {@link Gio.IOErrorEnum.CANCELLED}.
5350
5422
  * @param result the asynchronous result
5351
5423
  * @returns {@link Gio.TlsInteractionResult.HANDLED} if successful or {@link Gio.TlsInteractionResult.FAILED}
5424
+ * @throws GLib.Error
5352
5425
  */
5353
5426
  supplement_finish(result: Gio.AsyncResult): Gio.TlsInteractionResult;
5354
5427
 
@@ -5516,6 +5589,7 @@ export namespace Gcr {
5516
5589
  * until the operation completes.
5517
5590
  * @param cancellable a {@link Gio.Cancellable}, or `null`
5518
5591
  * @returns whether the items were imported successfully or not
5592
+ * @throws GLib.Error
5519
5593
  */
5520
5594
  ["import"](cancellable: Gio.Cancellable | null): boolean;
5521
5595
 
@@ -5546,6 +5620,7 @@ export namespace Gcr {
5546
5620
  * Complete an asynchronous operation to import queued items.
5547
5621
  * @param result an asynchronous result
5548
5622
  * @returns whether the import succeeded or failed
5623
+ * @throws GLib.Error
5549
5624
  */
5550
5625
  import_finish(result: Gio.AsyncResult): boolean;
5551
5626
 
@@ -5900,6 +5975,7 @@ export namespace Gcr {
5900
5975
  * an error occurs. Check the `error` argument to tell the difference.
5901
5976
  * @param cancellable optional cancellation object
5902
5977
  * @returns the reply from the prompt
5978
+ * @throws GLib.Error
5903
5979
  */
5904
5980
  confirm(cancellable: Gio.Cancellable | null): PromptReply;
5905
5981
 
@@ -5943,6 +6019,7 @@ export namespace Gcr {
5943
6019
  * an error occurs. Check the `error` argument to tell the difference.
5944
6020
  * @param result asynchronous result passed to callback
5945
6021
  * @returns the reply from the prompt
6022
+ * @throws GLib.Error
5946
6023
  */
5947
6024
  confirm_finish(result: Gio.AsyncResult): PromptReply;
5948
6025
 
@@ -5960,6 +6037,7 @@ export namespace Gcr {
5960
6037
  * an error occurs. Check the `error` argument to tell the difference.
5961
6038
  * @param cancellable optional cancellation object
5962
6039
  * @returns the reply from the prompt
6040
+ * @throws GLib.Error
5963
6041
  */
5964
6042
  confirm_run(cancellable: Gio.Cancellable | null): PromptReply;
5965
6043
 
@@ -6080,6 +6158,7 @@ export namespace Gcr {
6080
6158
  * `error` argument to tell the difference.
6081
6159
  * @param cancellable optional cancellation object
6082
6160
  * @returns the password owned by the prompt, or `null`
6161
+ * @throws GLib.Error
6083
6162
  */
6084
6163
  password(cancellable: Gio.Cancellable | null): string;
6085
6164
 
@@ -6123,6 +6202,7 @@ export namespace Gcr {
6123
6202
  * `error` argument to tell the difference.
6124
6203
  * @param result asynchronous result passed to callback
6125
6204
  * @returns the password owned by the prompt, or `null`
6205
+ * @throws GLib.Error
6126
6206
  */
6127
6207
  password_finish(result: Gio.AsyncResult): string;
6128
6208
 
@@ -6142,6 +6222,7 @@ export namespace Gcr {
6142
6222
  * `error` argument to tell the difference.
6143
6223
  * @param cancellable optional cancellation object
6144
6224
  * @returns the password owned by the prompt, or `null`
6225
+ * @throws GLib.Error
6145
6226
  */
6146
6227
  password_run(cancellable: Gio.Cancellable | null): string;
6147
6228
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/gcr-3",
3
- "version": "4.4.0",
3
+ "version": "4.5.0",
4
4
  "libraryVersion": "3.41.2",
5
5
  "description": "GJS TypeScript type definitions for Gcr-3, generated from library version 3.41.2",
6
6
  "type": "module",
@@ -32,12 +32,12 @@
32
32
  "test": "tsc --project tsconfig.json"
33
33
  },
34
34
  "dependencies": {
35
- "@girs/gjs": "^4.4.0",
36
- "@girs/gio-2.0": "^4.4.0",
37
- "@girs/gobject-2.0": "^4.4.0",
38
- "@girs/glib-2.0": "^4.4.0",
39
- "@girs/gmodule-2.0": "^4.4.0",
40
- "@girs/gck-1": "^4.4.0" },
35
+ "@girs/gjs": "^4.5.0",
36
+ "@girs/gio-2.0": "^4.5.0",
37
+ "@girs/gobject-2.0": "^4.5.0",
38
+ "@girs/glib-2.0": "^4.5.0",
39
+ "@girs/gmodule-2.0": "^4.5.0",
40
+ "@girs/gck-1": "^4.5.0" },
41
41
  "devDependencies": {
42
42
  "typescript": "*"
43
43
  },