@girs/nice-0.1 0.1.0-4.0.0-beta.2 → 0.1.0-4.0.0-beta.3

package/README.md

@@ -5,7 +5,7 @@
 ![downloads/week](https://img.shields.io/npm/dw/@girs/nice-0.1)
 
 
-GJS TypeScript type definitions for Nice-0.1, generated from library version 0.1.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.2.
+GJS TypeScript type definitions for Nice-0.1, generated from library version 0.1.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.3.
 
 
 ## Install
@@ -22,11 +22,6 @@ You can import this package into your project like this:
 import Nice from '@girs/nice-0.1';
 ```
 
-Or if you prefer CommonJS, you can also use this:
-```ts
-const Nice = require('@girs/nice-0.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.
@@ -81,19 +76,6 @@ Now you have also type support for this, too:
 const Nice = imports.gi.Nice;
 ```
 
-
-### 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/nice-0.1.d.ts

@@ -14,7 +14,6 @@ import './nice-0.1-ambient.d.ts';
 import type Gio from '@girs/gio-2.0';
 import type GObject from '@girs/gobject-2.0';
 import type GLib from '@girs/glib-2.0';
-import type GModule from '@girs/gmodule-2.0';
 
 export namespace Nice {
     /**
@@ -39,7 +38,7 @@ export namespace Nice {
         TCP_SO,
     }
     /**
-     * An enum represneting the type of a candidate
+     * An enum representing the type of a candidate
      */
     enum CandidateType {
         /**
@@ -47,7 +46,7 @@ export namespace Nice {
          */
         HOST,
         /**
-         * A server reflexive candidate
+         * A server reflexive candidate (or a NAT-assisted candidate)
          */
         SERVER_REFLEXIVE,
         /**
@@ -343,9 +342,8 @@ export namespace Nice {
         TLS,
     }
     /**
-     * A hard limit for the number of remote candidates. This
-     * limit is enforced to protect against malevolent remote
-     * clients.
+     * Was a limit on the number of remote candidates one can set, but is
+     * no longer used by libnice itself.
      */
     const AGENT_MAX_REMOTE_CANDIDATES: number;
     /**
@@ -405,6 +403,13 @@ export namespace Nice {
      * @param with_stun Also enable STUN debugging messages
      */
     function debug_enable(with_stun: boolean): void;
+    /**
+     * Returns the interface index match the local address passed. This can
+     * by used for APIs that need a specific address.
+     * @param addr A #NiceAddress for a local interface
+     * @returns The interface index or 0 on error
+     */
+    function interfaces_get_if_index_by_addr(addr: Address): number;
     /**
      * Retrieves the IP address of an interface by its name. If this fails, %NULL
      * is returned.
@@ -437,6 +442,10 @@ export namespace Nice {
      * the other value.
      */
     enum AgentOption {
+        /**
+         * No enabled options (Since: 0.1.19)
+         */
+        NONE,
         /**
          * Enables regular nomination, default
          *  is aggrssive mode (see #NiceNominationMode).
@@ -463,6 +472,10 @@ export namespace Nice {
          * Enable RFC 7675 consent freshness support. (Since: 0.1.19)
          */
         CONSENT_FRESHNESS,
+        /**
+         * Use bytestream mode for reliable TCP connections. (Since: 0.1.20)
+         */
+        BYTESTREAM_TCP,
     }
     module Agent {
         // Signal callback interfaces
@@ -539,6 +552,8 @@ export namespace Nice {
             mainContext: any;
             max_connectivity_checks: number;
             maxConnectivityChecks: number;
+            proxy_extra_headers: GLib.HashTable<string, string>;
+            proxyExtraHeaders: GLib.HashTable<string, string>;
             proxy_ip: string;
             proxyIp: string;
             proxy_password: string;
@@ -580,7 +595,7 @@ export namespace Nice {
         // Own properties of Nice.Agent
 
         /**
-         * This property defines whether receive/send over a TCP or pseudo-TCP, in
+         * This property defines whether receive/send operations over a TCP socket, in
          * reliable mode, are considered as packetized or as bytestream.
          * In unreliable mode, every send/recv is considered as packetized, and
          * this property is ignored and cannot be set.
@@ -590,19 +605,16 @@ export namespace Nice {
          * </para>
          * If the property is %TRUE, the stream is considered in bytestream mode
          * and data can be read with any receive size. If the property is %FALSE, then
-         * the stream is considred packetized and each receive will return one packet
+         * the stream is considered packetized and each receive will return one packet
          * of the same size as what was sent from the peer. If in packetized mode,
          * then doing a receive with a size smaller than the packet, will cause the
          * remaining bytes in the packet to be dropped, breaking the reliability
          * of the stream.
-         * <para>
-         * This property is currently read-only, and will become read/write once
-         * bytestream mode will be supported.
-         * </para>
          */
         get bytestream_tcp(): boolean;
+        set bytestream_tcp(val: boolean);
         /**
-         * This property defines whether receive/send over a TCP or pseudo-TCP, in
+         * This property defines whether receive/send operations over a TCP socket, in
          * reliable mode, are considered as packetized or as bytestream.
          * In unreliable mode, every send/recv is considered as packetized, and
          * this property is ignored and cannot be set.
@@ -612,17 +624,14 @@ export namespace Nice {
          * </para>
          * If the property is %TRUE, the stream is considered in bytestream mode
          * and data can be read with any receive size. If the property is %FALSE, then
-         * the stream is considred packetized and each receive will return one packet
+         * the stream is considered packetized and each receive will return one packet
          * of the same size as what was sent from the peer. If in packetized mode,
          * then doing a receive with a size smaller than the packet, will cause the
          * remaining bytes in the packet to be dropped, breaking the reliability
          * of the stream.
-         * <para>
-         * This property is currently read-only, and will become read/write once
-         * bytestream mode will be supported.
-         * </para>
          */
         get bytestreamTcp(): boolean;
+        set bytestreamTcp(val: boolean);
         /**
          * The Nice agent can work in various compatibility modes depending on
          * what the application/peer needs.
@@ -883,6 +892,20 @@ export namespace Nice {
         set max_connectivity_checks(val: number);
         get maxConnectivityChecks(): number;
         set maxConnectivityChecks(val: number);
+        /**
+         * Optional extra headers to append to the HTTP proxy CONNECT request.
+         * Provided as key/value-pairs in hash table corresponding to
+         * header-name/header-value.
+         */
+        get proxy_extra_headers(): GLib.HashTable<string, string>;
+        set proxy_extra_headers(val: GLib.HashTable<string, string>);
+        /**
+         * Optional extra headers to append to the HTTP proxy CONNECT request.
+         * Provided as key/value-pairs in hash table corresponding to
+         * header-name/header-value.
+         */
+        get proxyExtraHeaders(): GLib.HashTable<string, string>;
+        set proxyExtraHeaders(val: GLib.HashTable<string, string>);
         /**
          * The proxy server IP used to bypass a proxy firewall
          */
@@ -1750,7 +1773,7 @@ export namespace Nice {
          * discovery process; one TCP and one UDP, for example.
          * @param stream_id The ID of the stream
          * @param component_id The ID of the component
-         * @param server_ip The IP address of the TURN server
+         * @param server_ip The address of the TURN server
          * @param server_port The port of the TURN server
          * @param username The TURN username to use for the allocate
          * @param password The TURN password to use for the allocate
@@ -2151,8 +2174,11 @@ export namespace Nice {
 
         // Constructors of Nice.Address
 
+        constructor(properties?: Partial<{}>);
         _init(...args: any[]): void;
 
+        static ['new'](): Address;
+
         // Own methods of Nice.Address
 
         /**
@@ -2160,6 +2186,16 @@ export namespace Nice {
          * @param sin The sockaddr to fill
          */
         copy_to_sockaddr(sin?: any | null): void;
+        /**
+         * Creates a new #NiceAddress with the same address as `addr`
+         * @returns The new #NiceAddress
+         */
+        dup(): Address;
+        /**
+         * Transforms the address `addr` into a newly allocated human readable string
+         * @returns the address string
+         */
+        dup_string(): string;
         /**
          * Compares two #NiceAddress structures to see if they contain the same address
          * and the same port.
@@ -2192,6 +2228,11 @@ export namespace Nice {
          * @returns 4 for IPv4, 6 for IPv6 and 0 for undefined address
          */
         ip_version(): number;
+        /**
+         * Verifies if the address in `addr` is a link-local address or not
+         * @returns %TRUE if @addr is a link-local address, %FALSE otherwise
+         */
+        is_linklocal(): boolean;
         /**
          * Verifies if the address in `addr` is a private address or not
          * @returns %TRUE if @addr is a private address, %FALSE otherwise
@@ -2242,11 +2283,6 @@ export namespace Nice {
          * @param port The port to set
          */
         set_port(port: number): void;
-        /**
-         * Transforms the address `addr` into a human readable string
-         * @param dst The string to fill
-         */
-        to_string(dst: string): void;
     }
 
     type AgentClass = typeof Agent;
@@ -2315,6 +2351,19 @@ export namespace Nice {
          * Frees a #NiceCandidate
          */
         free(): void;
+        /**
+         * In case the given candidate is relayed through a TURN server, use this utility function to get
+         * its address.
+         * @param addr The #NiceAddress to fill
+         */
+        relay_address(addr: Address): void;
+        /**
+         * In case the given candidate server-reflexive, use this utility function to get its address. The
+         * address will be filled only if the candidate was generated using an STUN server.
+         * @param addr The #NiceAddress to fill
+         * @returns TRUE if it's a STUN created ICE candidate, or FALSE if the reflexed's server was not STUN.
+         */
+        stun_server_address(addr: Address): boolean;
     }
 
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@girs/nice-0.1",
-  "version": "0.1.0-4.0.0-beta.2",
+  "version": "0.1.0-4.0.0-beta.3",
   "description": "GJS TypeScript type definitions for Nice-0.1, generated from library version 0.1.0",
   "type": "module",
   "module": "nice-0.1.js",
@@ -26,11 +26,10 @@
     "test": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit nice-0.1.d.ts"
   },
   "dependencies": {
-    "@girs/gio-2.0": "^2.80.0-4.0.0-beta.2",
-    "@girs/gjs": "^4.0.0-beta.2",
-    "@girs/glib-2.0": "^2.80.0-4.0.0-beta.2",
-    "@girs/gmodule-2.0": "^2.0.0-4.0.0-beta.2",
-    "@girs/gobject-2.0": "^2.80.0-4.0.0-beta.2"
+    "@girs/gio-2.0": "^2.80.0-4.0.0-beta.3",
+    "@girs/gjs": "^4.0.0-beta.3",
+    "@girs/glib-2.0": "^2.80.0-4.0.0-beta.3",
+    "@girs/gobject-2.0": "^2.80.0-4.0.0-beta.3"
   },
   "devDependencies": {
     "typescript": "*"