@girs/gck-1 4.2.0 → 4.4.0

package/README.md

@@ -5,25 +5,25 @@
 ![downloads/week](https://img.shields.io/npm/dw/@girs/gck-1)
 
 
-GJS TypeScript type definitions for Gck-1, generated from library version 1.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.2.0.
+GJS TypeScript type definitions for Gck-1, generated from library version 1.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.4.0.
 
 ## Install
 
-To use this type definitions, install them with NPM:
+Install the type definitions with npm:
 ```bash
 npm install @girs/gck-1
 ```
 
 ## Usage
 
-You can import this package into your project like this:
+Import it like any other module:
 ```ts
 import Gck from '@girs/gck-1';
 ```
 
 ### Ambient Modules
 
-You can also use [ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules) to import this module like you would do this in JavaScript.
+[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.
 For this you need to include `@girs/gck-1` or `@girs/gck-1/ambient` in your `tsconfig` or entry point Typescript file:
 
 `index.ts`:
@@ -42,7 +42,7 @@ import '@girs/gck-1'
 }
 ```
 
-Now you can import the ambient module with TypeScript support: 
+The ambient module now resolves with types:
 
 ```ts
 import Gck from 'gi://Gck?version=1';
@@ -50,7 +50,7 @@ import Gck from 'gi://Gck?version=1';
 
 ### Global import
 
-You can also import the module with Typescript support using the global `imports.gi` object of GJS.
+GJS's global `imports.gi` works too, with types.
 For this you need to include `@girs/gck-1` or `@girs/gck-1/import` in your `tsconfig` or entry point Typescript file:
 
 `index.ts`:
@@ -69,7 +69,7 @@ import '@girs/gck-1'
 }
 ```
 
-Now you have also type support for this, too:
+That form carries types as well:
 
 ```ts
 const Gck = imports.gi.Gck;
@@ -77,7 +77,7 @@ const Gck = imports.gi.Gck;
 
 ### 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).
+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.
 
 ## Other packages
 

package/gck-1.d.ts

@@ -644,6 +644,7 @@ export namespace Gck {
          * This may be set to NULL if this object was created from an already
          * initialized module via the `gck_module_new()` function.
          * @construct-only
+         * @default null
          */
         get path(): string;
 
@@ -790,6 +791,7 @@ export namespace Gck {
         /**
          * The raw PKCS11 handle for this object.
          * @construct-only
+         * @default 0
          */
         get handle(): number;
 
@@ -1445,6 +1447,7 @@ export namespace Gck {
         /**
          * The raw CK_SESSION_HANDLE handle of this session.
          * @construct-only
+         * @default 0
          */
         get handle(): number;
 
@@ -1465,18 +1468,21 @@ export namespace Gck {
         /**
          * Raw PKCS#11 flags used to open the PKCS#11 session.
          * @construct-only
+         * @default 0
          */
         set opening_flags(val: bigint | number);
 
         /**
          * Raw PKCS#11 flags used to open the PKCS#11 session.
          * @construct-only
+         * @default 0
          */
         set openingFlags(val: bigint | number);
 
         /**
          * The options this session was opened with.
          * @construct-only
+         * @default Gck.SessionOptions.READ_ONLY
          */
         get options(): SessionOptions;
 
@@ -2571,6 +2577,7 @@ export namespace Gck {
          * any interface methods.
          * @param io_priority the [I/O priority](iface.AsyncResult.html#io-priority) of the operation
          * @param cancellable optional {@link Gio.Cancellable} object, `null` to ignore.
+         * @since 2.22
          */
         init_async(io_priority: number, cancellable: Gio.Cancellable | null): globalThis.Promise<boolean>;
 
@@ -2614,6 +2621,7 @@ export namespace Gck {
          * @param io_priority the [I/O priority](iface.AsyncResult.html#io-priority) of the operation
          * @param cancellable optional {@link Gio.Cancellable} object, `null` to ignore.
          * @param callback a {@link Gio.AsyncReadyCallback} to call when the request is satisfied
+         * @since 2.22
          */
         init_async(io_priority: number, cancellable: Gio.Cancellable | null, callback: Gio.AsyncReadyCallback<this> | null): void;
 
@@ -2657,6 +2665,7 @@ export namespace Gck {
          * @param io_priority the [I/O priority](iface.AsyncResult.html#io-priority) of the operation
          * @param cancellable optional {@link Gio.Cancellable} object, `null` to ignore.
          * @param callback a {@link Gio.AsyncReadyCallback} to call when the request is satisfied
+         * @since 2.22
          */
         init_async(io_priority: number, cancellable: Gio.Cancellable | null, callback?: Gio.AsyncReadyCallback<this> | null): globalThis.Promise<boolean> | void;
 
@@ -2665,6 +2674,7 @@ export namespace Gck {
          * See `g_async_initable_init_async()`.
          * @param res a {@link Gio.AsyncResult}.
          * @returns `true` if successful. If an error has occurred, this function will return `false` and set `error` appropriately if present.
+         * @since 2.22
          */
         init_finish(res: Gio.AsyncResult): boolean;
 
@@ -2673,6 +2683,7 @@ export namespace Gck {
          * calls, returning the created object or `null` on error.
          * @param res the {@link Gio.AsyncResult} from the callback
          * @returns a newly created {@link GObject.Object},      or `null` on error. Free with `g_object_unref()`.
+         * @since 2.22
          */
         new_finish(res: Gio.AsyncResult): Session;
 
@@ -2716,6 +2727,7 @@ export namespace Gck {
          * @param io_priority the [I/O priority](iface.AsyncResult.html#io-priority) of the operation
          * @param cancellable optional {@link Gio.Cancellable} object, `null` to ignore.
          * @param callback a {@link Gio.AsyncReadyCallback} to call when the request is satisfied
+         * @since 2.22
          * @virtual
          */
         vfunc_init_async(io_priority: number, cancellable: Gio.Cancellable | null, callback: Gio.AsyncReadyCallback<this> | null): void;
@@ -2724,6 +2736,7 @@ export namespace Gck {
          * Finishes asynchronous initialization and returns the result.
          * See `g_async_initable_init_async()`.
          * @param res a {@link Gio.AsyncResult}.
+         * @since 2.22
          * @virtual
          */
         vfunc_init_finish(res: Gio.AsyncResult): boolean;
@@ -2769,6 +2782,7 @@ export namespace Gck {
          * instance.
          * @param cancellable optional {@link Gio.Cancellable} object, `null` to ignore.
          * @returns `true` if successful. If an error has occurred, this function will     return `false` and set `error` appropriately if present.
+         * @since 2.22
          */
         init(cancellable: Gio.Cancellable | null): boolean;
 
@@ -2812,6 +2826,7 @@ export namespace Gck {
          * on the result of `g_object_new()`, regardless of whether it is in fact a new
          * instance.
          * @param cancellable optional {@link Gio.Cancellable} object, `null` to ignore.
+         * @since 2.22
          * @virtual
          */
         vfunc_init(cancellable: Gio.Cancellable | null): boolean;
@@ -2847,6 +2862,7 @@ export namespace Gck {
         /**
          * The raw CK_SLOT_ID handle of this slot.
          * @construct-only
+         * @default 0
          */
         get handle(): number;
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@girs/gck-1",
-    "version": "4.2.0",
+    "version": "4.4.0",
     "libraryVersion": "1.0.0",
     "description": "GJS TypeScript type definitions for Gck-1, generated from library version 1.0.0",
     "type": "module",
@@ -32,11 +32,11 @@
       "test": "tsc --project tsconfig.json"
     },
     "dependencies": {
-      "@girs/gjs": "^4.2.0",
-      "@girs/gio-2.0": "^4.2.0",
-      "@girs/gobject-2.0": "^4.2.0",
-      "@girs/glib-2.0": "^4.2.0",
-      "@girs/gmodule-2.0": "^4.2.0"    },
+      "@girs/gjs": "^4.4.0",
+      "@girs/gio-2.0": "^4.4.0",
+      "@girs/gobject-2.0": "^4.4.0",
+      "@girs/glib-2.0": "^4.4.0",
+      "@girs/gmodule-2.0": "^4.4.0"    },
     "devDependencies": {
       "typescript": "*"
     },