@girs/nice-0.1 0.1.0-4.0.0-beta.21 → 0.1.0-4.0.0-beta.24

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.21.
+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.24.
 
 
 ## Install

package/nice-0.1.d.ts

@@ -7,6 +7,8 @@
  * The based EJS template file is used for the generated .d.ts file of each GIR module like Gtk-4.0, GObject-2.0, ...
  */
 
+import '@girs/gjs';
+
 // Module dependencies
 import type Gio from '@girs/gio-2.0';
 import type GObject from '@girs/gobject-2.0';
@@ -48,11 +50,11 @@ export namespace Nice {
         TCP_SO,
     }
     /**
-     * An enum representing the type of a candidate
+     * An enum represneting the type of a candidate
      */
 
     /**
-     * An enum representing the type of a candidate
+     * An enum represneting the type of a candidate
      */
     export namespace CandidateType {
         export const $gtype: GObject.GType<CandidateType>;
@@ -64,7 +66,7 @@ export namespace Nice {
          */
         HOST,
         /**
-         * A server reflexive candidate (or a NAT-assisted candidate)
+         * A server reflexive candidate
          */
         SERVER_REFLEXIVE,
         /**
@@ -476,8 +478,9 @@ export namespace Nice {
         TLS,
     }
     /**
-     * Was a limit on the number of remote candidates one can set, but is
-     * no longer used by libnice itself.
+     * A hard limit for the number of remote candidates. This
+     * limit is enforced to protect against malevolent remote
+     * clients.
      */
     const AGENT_MAX_REMOTE_CANDIDATES: number;
     /**
@@ -537,13 +540,6 @@ 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.
@@ -586,10 +582,6 @@ export namespace Nice {
     }
 
     enum AgentOption {
-        /**
-         * No enabled options (Since: 0.1.19)
-         */
-        NONE,
         /**
          * Enables regular nomination, default
          *  is aggrssive mode (see #NiceNominationMode).
@@ -616,56 +608,49 @@ 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,
     }
     namespace Agent {
-        // Signal callback interfaces
-
-        interface CandidateGatheringDone {
-            (stream_id: number): void;
-        }
-
-        interface ComponentStateChanged {
-            (stream_id: number, component_id: number, state: number): void;
-        }
-
-        interface InitialBindingRequestReceived {
-            (stream_id: number): void;
-        }
-
-        interface NewCandidate {
-            (stream_id: number, component_id: number, foundation: string): void;
-        }
-
-        interface NewCandidateFull {
-            (candidate: Candidate): void;
-        }
-
-        interface NewRemoteCandidate {
-            (stream_id: number, component_id: number, foundation: string): void;
-        }
-
-        interface NewRemoteCandidateFull {
-            (candidate: Candidate): void;
-        }
-
-        interface NewSelectedPair {
-            (stream_id: number, component_id: number, lfoundation: string, rfoundation: string): void;
-        }
-
-        interface NewSelectedPairFull {
-            (stream_id: number, component_id: number, lcandidate: Candidate, rcandidate: Candidate): void;
-        }
-
-        interface ReliableTransportWritable {
-            (stream_id: number, component_id: number): void;
-        }
-
-        interface StreamsRemoved {
-            (stream_ids: number[]): void;
+        // Signal signatures
+        interface SignalSignatures extends GObject.Object.SignalSignatures {
+            'candidate-gathering-done': (arg0: number) => void;
+            'component-state-changed': (arg0: number, arg1: number, arg2: number) => void;
+            'initial-binding-request-received': (arg0: number) => void;
+            'new-candidate': (arg0: number, arg1: number, arg2: string) => void;
+            'new-candidate-full': (arg0: Candidate) => void;
+            'new-remote-candidate': (arg0: number, arg1: number, arg2: string) => void;
+            'new-remote-candidate-full': (arg0: Candidate) => void;
+            'new-selected-pair': (arg0: number, arg1: number, arg2: string, arg3: string) => void;
+            'new-selected-pair-full': (arg0: number, arg1: number, arg2: Candidate, arg3: Candidate) => void;
+            'reliable-transport-writable': (arg0: number, arg1: number) => void;
+            'streams-removed': (arg0: number[]) => void;
+            'notify::bytestream-tcp': (pspec: GObject.ParamSpec) => void;
+            'notify::compatibility': (pspec: GObject.ParamSpec) => void;
+            'notify::consent-freshness': (pspec: GObject.ParamSpec) => void;
+            'notify::controlling-mode': (pspec: GObject.ParamSpec) => void;
+            'notify::force-relay': (pspec: GObject.ParamSpec) => void;
+            'notify::full-mode': (pspec: GObject.ParamSpec) => void;
+            'notify::ice-tcp': (pspec: GObject.ParamSpec) => void;
+            'notify::ice-trickle': (pspec: GObject.ParamSpec) => void;
+            'notify::ice-udp': (pspec: GObject.ParamSpec) => void;
+            'notify::idle-timeout': (pspec: GObject.ParamSpec) => void;
+            'notify::keepalive-conncheck': (pspec: GObject.ParamSpec) => void;
+            'notify::main-context': (pspec: GObject.ParamSpec) => void;
+            'notify::max-connectivity-checks': (pspec: GObject.ParamSpec) => void;
+            'notify::proxy-ip': (pspec: GObject.ParamSpec) => void;
+            'notify::proxy-password': (pspec: GObject.ParamSpec) => void;
+            'notify::proxy-port': (pspec: GObject.ParamSpec) => void;
+            'notify::proxy-type': (pspec: GObject.ParamSpec) => void;
+            'notify::proxy-username': (pspec: GObject.ParamSpec) => void;
+            'notify::reliable': (pspec: GObject.ParamSpec) => void;
+            'notify::stun-initial-timeout': (pspec: GObject.ParamSpec) => void;
+            'notify::stun-max-retransmissions': (pspec: GObject.ParamSpec) => void;
+            'notify::stun-pacing-timer': (pspec: GObject.ParamSpec) => void;
+            'notify::stun-reliable-timeout': (pspec: GObject.ParamSpec) => void;
+            'notify::stun-server': (pspec: GObject.ParamSpec) => void;
+            'notify::stun-server-port': (pspec: GObject.ParamSpec) => void;
+            'notify::support-renomination': (pspec: GObject.ParamSpec) => void;
+            'notify::upnp': (pspec: GObject.ParamSpec) => void;
+            'notify::upnp-timeout': (pspec: GObject.ParamSpec) => void;
         }
 
         // Constructor properties interface
@@ -696,8 +681,6 @@ 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;
@@ -739,7 +722,7 @@ export namespace Nice {
         // Properties
 
         /**
-         * This property defines whether receive/send operations over a TCP socket, in
+         * This property defines whether receive/send over a TCP or pseudo-TCP, 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.
@@ -749,16 +732,19 @@ 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 considered packetized and each receive will return one packet
+         * the stream is considred 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 operations over a TCP socket, in
+         * This property defines whether receive/send over a TCP or pseudo-TCP, 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.
@@ -768,14 +754,17 @@ 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 considered packetized and each receive will return one packet
+         * the stream is considred 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.
@@ -1036,20 +1025,6 @@ 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
          */
@@ -1216,6 +1191,15 @@ export namespace Nice {
         get upnpTimeout(): number;
         set upnpTimeout(val: number);
 
+        /**
+         * Compile-time signal type information.
+         *
+         * This instance property is generated only for TypeScript type checking.
+         * It is not defined at runtime and should not be accessed in JS code.
+         * @internal
+         */
+        $signals: Agent.SignalSignatures;
+
         // Constructors
 
         constructor(properties?: Partial<Agent.ConstructorProps>, ...args: any[]);
@@ -1230,123 +1214,21 @@ export namespace Nice {
 
         // Signals
 
-        connect(id: string, callback: (...args: any[]) => any): number;
-        connect_after(id: string, callback: (...args: any[]) => any): number;
-        emit(id: string, ...args: any[]): void;
-        connect(signal: 'candidate-gathering-done', callback: (_source: this, stream_id: number) => void): number;
-        connect_after(signal: 'candidate-gathering-done', callback: (_source: this, stream_id: number) => void): number;
-        emit(signal: 'candidate-gathering-done', stream_id: number): void;
-        connect(
-            signal: 'component-state-changed',
-            callback: (_source: this, stream_id: number, component_id: number, state: number) => void,
-        ): number;
-        connect_after(
-            signal: 'component-state-changed',
-            callback: (_source: this, stream_id: number, component_id: number, state: number) => void,
+        connect<K extends keyof Agent.SignalSignatures>(
+            signal: K,
+            callback: GObject.SignalCallback<this, Agent.SignalSignatures[K]>,
         ): number;
-        emit(signal: 'component-state-changed', stream_id: number, component_id: number, state: number): void;
-        connect(
-            signal: 'initial-binding-request-received',
-            callback: (_source: this, stream_id: number) => void,
+        connect(signal: string, callback: (...args: any[]) => any): number;
+        connect_after<K extends keyof Agent.SignalSignatures>(
+            signal: K,
+            callback: GObject.SignalCallback<this, Agent.SignalSignatures[K]>,
         ): number;
-        connect_after(
-            signal: 'initial-binding-request-received',
-            callback: (_source: this, stream_id: number) => void,
-        ): number;
-        emit(signal: 'initial-binding-request-received', stream_id: number): void;
-        connect(
-            signal: 'new-candidate',
-            callback: (_source: this, stream_id: number, component_id: number, foundation: string) => void,
-        ): number;
-        connect_after(
-            signal: 'new-candidate',
-            callback: (_source: this, stream_id: number, component_id: number, foundation: string) => void,
-        ): number;
-        emit(signal: 'new-candidate', stream_id: number, component_id: number, foundation: string): void;
-        connect(signal: 'new-candidate-full', callback: (_source: this, candidate: Candidate) => void): number;
-        connect_after(signal: 'new-candidate-full', callback: (_source: this, candidate: Candidate) => void): number;
-        emit(signal: 'new-candidate-full', candidate: Candidate): void;
-        connect(
-            signal: 'new-remote-candidate',
-            callback: (_source: this, stream_id: number, component_id: number, foundation: string) => void,
-        ): number;
-        connect_after(
-            signal: 'new-remote-candidate',
-            callback: (_source: this, stream_id: number, component_id: number, foundation: string) => void,
-        ): number;
-        emit(signal: 'new-remote-candidate', stream_id: number, component_id: number, foundation: string): void;
-        connect(signal: 'new-remote-candidate-full', callback: (_source: this, candidate: Candidate) => void): number;
-        connect_after(
-            signal: 'new-remote-candidate-full',
-            callback: (_source: this, candidate: Candidate) => void,
-        ): number;
-        emit(signal: 'new-remote-candidate-full', candidate: Candidate): void;
-        connect(
-            signal: 'new-selected-pair',
-            callback: (
-                _source: this,
-                stream_id: number,
-                component_id: number,
-                lfoundation: string,
-                rfoundation: string,
-            ) => void,
-        ): number;
-        connect_after(
-            signal: 'new-selected-pair',
-            callback: (
-                _source: this,
-                stream_id: number,
-                component_id: number,
-                lfoundation: string,
-                rfoundation: string,
-            ) => void,
-        ): number;
-        emit(
-            signal: 'new-selected-pair',
-            stream_id: number,
-            component_id: number,
-            lfoundation: string,
-            rfoundation: string,
+        connect_after(signal: string, callback: (...args: any[]) => any): number;
+        emit<K extends keyof Agent.SignalSignatures>(
+            signal: K,
+            ...args: GObject.GjsParameters<Agent.SignalSignatures[K]> extends [any, ...infer Q] ? Q : never
         ): void;
-        connect(
-            signal: 'new-selected-pair-full',
-            callback: (
-                _source: this,
-                stream_id: number,
-                component_id: number,
-                lcandidate: Candidate,
-                rcandidate: Candidate,
-            ) => void,
-        ): number;
-        connect_after(
-            signal: 'new-selected-pair-full',
-            callback: (
-                _source: this,
-                stream_id: number,
-                component_id: number,
-                lcandidate: Candidate,
-                rcandidate: Candidate,
-            ) => void,
-        ): number;
-        emit(
-            signal: 'new-selected-pair-full',
-            stream_id: number,
-            component_id: number,
-            lcandidate: Candidate,
-            rcandidate: Candidate,
-        ): void;
-        connect(
-            signal: 'reliable-transport-writable',
-            callback: (_source: this, stream_id: number, component_id: number) => void,
-        ): number;
-        connect_after(
-            signal: 'reliable-transport-writable',
-            callback: (_source: this, stream_id: number, component_id: number) => void,
-        ): number;
-        emit(signal: 'reliable-transport-writable', stream_id: number, component_id: number): void;
-        connect(signal: 'streams-removed', callback: (_source: this, stream_ids: number[]) => void): number;
-        connect_after(signal: 'streams-removed', callback: (_source: this, stream_ids: number[]) => void): number;
-        emit(signal: 'streams-removed', stream_ids: number[]): void;
+        emit(signal: string, ...args: any[]): void;
 
         // Methods
 
@@ -1917,7 +1799,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 address of the TURN server
+         * @param server_ip The IP 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
@@ -2053,6 +1935,18 @@ export namespace Nice {
     }
 
     namespace PseudoTcpSocket {
+        // Signal signatures
+        interface SignalSignatures extends GObject.Object.SignalSignatures {
+            'notify::ack-delay': (pspec: GObject.ParamSpec) => void;
+            'notify::callbacks': (pspec: GObject.ParamSpec) => void;
+            'notify::conversation': (pspec: GObject.ParamSpec) => void;
+            'notify::no-delay': (pspec: GObject.ParamSpec) => void;
+            'notify::rcv-buf': (pspec: GObject.ParamSpec) => void;
+            'notify::snd-buf': (pspec: GObject.ParamSpec) => void;
+            'notify::state': (pspec: GObject.ParamSpec) => void;
+            'notify::support-fin-ack': (pspec: GObject.ParamSpec) => void;
+        }
+
         // Constructor properties interface
 
         interface ConstructorProps extends GObject.Object.ConstructorProps {
@@ -2123,6 +2017,15 @@ export namespace Nice {
          */
         get supportFinAck(): boolean;
 
+        /**
+         * Compile-time signal type information.
+         *
+         * This instance property is generated only for TypeScript type checking.
+         * It is not defined at runtime and should not be accessed in JS code.
+         * @internal
+         */
+        $signals: PseudoTcpSocket.SignalSignatures;
+
         // Constructors
 
         constructor(properties?: Partial<PseudoTcpSocket.ConstructorProps>, ...args: any[]);
@@ -2131,6 +2034,24 @@ export namespace Nice {
 
         static ['new'](conversation: number, callbacks: PseudoTcpCallbacks): PseudoTcpSocket;
 
+        // Signals
+
+        connect<K extends keyof PseudoTcpSocket.SignalSignatures>(
+            signal: K,
+            callback: GObject.SignalCallback<this, PseudoTcpSocket.SignalSignatures[K]>,
+        ): number;
+        connect(signal: string, callback: (...args: any[]) => any): number;
+        connect_after<K extends keyof PseudoTcpSocket.SignalSignatures>(
+            signal: K,
+            callback: GObject.SignalCallback<this, PseudoTcpSocket.SignalSignatures[K]>,
+        ): number;
+        connect_after(signal: string, callback: (...args: any[]) => any): number;
+        emit<K extends keyof PseudoTcpSocket.SignalSignatures>(
+            signal: K,
+            ...args: GObject.GjsParameters<PseudoTcpSocket.SignalSignatures[K]> extends [any, ...infer Q] ? Q : never
+        ): void;
+        emit(signal: string, ...args: any[]): void;
+
         // Methods
 
         /**
@@ -2318,11 +2239,8 @@ export namespace Nice {
 
         // Constructors
 
-        constructor(properties?: Partial<{}>);
         _init(...args: any[]): void;
 
-        static ['new'](): Address;
-
         // Methods
 
         /**
@@ -2330,16 +2248,6 @@ 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.
@@ -2372,11 +2280,6 @@ 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
@@ -2427,6 +2330,11 @@ 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;
@@ -2495,19 +2403,6 @@ 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.21",
+  "version": "0.1.0-4.0.0-beta.24",
   "description": "GJS TypeScript type definitions for Nice-0.1, generated from library version 0.1.0",
   "type": "module",
   "module": "nice-0.1.js",
@@ -31,11 +31,11 @@
     "test": "tsc --project tsconfig.json"
   },
   "dependencies": {
-    "@girs/gio-2.0": "^2.83.3-4.0.0-beta.21",
-    "@girs/gjs": "^4.0.0-beta.21",
-    "@girs/glib-2.0": "^2.83.3-4.0.0-beta.21",
-    "@girs/gmodule-2.0": "^2.0.0-4.0.0-beta.21",
-    "@girs/gobject-2.0": "^2.83.3-4.0.0-beta.21"
+    "@girs/gio-2.0": "^2.84.2-4.0.0-beta.24",
+    "@girs/gjs": "^4.0.0-beta.24",
+    "@girs/glib-2.0": "^2.84.2-4.0.0-beta.24",
+    "@girs/gmodule-2.0": "^2.0.0-4.0.0-beta.24",
+    "@girs/gobject-2.0": "^2.84.2-4.0.0-beta.24"
   },
   "devDependencies": {
     "typescript": "*"