@girs/gssdp-1.0 1.0.0-3.2.4 → 1.0.0-3.2.6

package/README.md

@@ -5,7 +5,7 @@
 ![downloads/week](https://img.shields.io/npm/dw/@girs/gssdp-1.0)
 
 
-GJS TypeScript type definitions for GSSDP-1.0, generated from library version 1.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.4.
+GJS TypeScript type definitions for GSSDP-1.0, generated from library version 1.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.6.
 
 GObject-based API for handling resource discovery and announcement over SSDP.
 
@@ -82,6 +82,19 @@ Now you have also type support for this, too:
 const GSSDP = imports.gi.GSSDP;
 ```
 
+
+### 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/gssdp-1.0-ambient.d.ts

@@ -1,9 +1,12 @@
 
-
 declare module 'gi://GSSDP?version=1.0' {
     import GSSDP10 from '@girs/gssdp-1.0';
     export default GSSDP10;
 }
 
+declare module 'gi://GSSDP' {
+    import GSSDP10 from '@girs/gssdp-1.0';
+    export default GSSDP10;
+}
 
 

package/gssdp-1.0-import.d.ts

@@ -1,5 +1,4 @@
 
-
 import GSSDP10 from '@girs/gssdp-1.0';
 
 declare global {

package/gssdp-1.0.d.cts

@@ -85,6 +85,26 @@ export module Client {
          * This property can only be set during object construction.
          */
         socket_ttl?: number | null
+        /**
+         * The IP address of the assoicated network interface.
+         */
+        hostIp?: string | null
+        /**
+         * UDP port to use for sending multicast M-SEARCH requests on the
+         * network. If not set (or set to 0) a random port will be used.
+         * This property can be only set during object construction.
+         */
+        msearchPort?: number | null
+        /**
+         * The SSDP server's identifier.
+         */
+        serverId?: string | null
+        /**
+         * Time-to-live value to use for all sockets created by this client.
+         * If not set (or set to 0) the value recommended by UPnP will be used.
+         * This property can only be set during object construction.
+         */
+        socketTtl?: number | null
     }
 
 }
@@ -103,6 +123,10 @@ export interface Client extends Gio.Initable {
      * The IP address of the assoicated network interface.
      */
     host_ip: string | null
+    /**
+     * The IP address of the assoicated network interface.
+     */
+    hostIp: string | null
     /**
      * The name of the network interface this client is associated with.
      * Set to NULL to autodetect.
@@ -114,6 +138,12 @@ export interface Client extends Gio.Initable {
      * This property can be only set during object construction.
      */
     readonly msearch_port: number
+    /**
+     * UDP port to use for sending multicast M-SEARCH requests on the
+     * network. If not set (or set to 0) a random port will be used.
+     * This property can be only set during object construction.
+     */
+    readonly msearchPort: number
     /**
      * The network this client is currently connected to. You could set this
      * to anything you want to identify the network this client is
@@ -127,12 +157,22 @@ export interface Client extends Gio.Initable {
      * The SSDP server's identifier.
      */
     server_id: string | null
+    /**
+     * The SSDP server's identifier.
+     */
+    serverId: string | null
     /**
      * Time-to-live value to use for all sockets created by this client.
      * If not set (or set to 0) the value recommended by UPnP will be used.
      * This property can only be set during object construction.
      */
     readonly socket_ttl: number
+    /**
+     * Time-to-live value to use for all sockets created by this client.
+     * If not set (or set to 0) the value recommended by UPnP will be used.
+     * This property can only be set during object construction.
+     */
+    readonly socketTtl: number
 
     // Own fields of GSSDP-1.0.GSSDP.Client
 
@@ -453,6 +493,15 @@ export module ResourceGroup {
          * The default is 120 based on DLNA specification.
          */
         message_delay?: number | null
+        /**
+         * The number of seconds our advertisements are valid.
+         */
+        maxAge?: number | null
+        /**
+         * The minimum number of milliseconds between SSDP messages.
+         * The default is 120 based on DLNA specification.
+         */
+        messageDelay?: number | null
     }
 
 }
@@ -473,11 +522,20 @@ export interface ResourceGroup {
      * The number of seconds our advertisements are valid.
      */
     max_age: number
+    /**
+     * The number of seconds our advertisements are valid.
+     */
+    maxAge: number
     /**
      * The minimum number of milliseconds between SSDP messages.
      * The default is 120 based on DLNA specification.
      */
     message_delay: number
+    /**
+     * The minimum number of milliseconds between SSDP messages.
+     * The default is 120 based on DLNA specification.
+     */
+    messageDelay: number
 
     // Own fields of GSSDP-1.0.GSSDP.ResourceGroup
 

package/gssdp-1.0.d.ts

@@ -87,6 +87,26 @@ module Client {
          * This property can only be set during object construction.
          */
         socket_ttl?: number | null
+        /**
+         * The IP address of the assoicated network interface.
+         */
+        hostIp?: string | null
+        /**
+         * UDP port to use for sending multicast M-SEARCH requests on the
+         * network. If not set (or set to 0) a random port will be used.
+         * This property can be only set during object construction.
+         */
+        msearchPort?: number | null
+        /**
+         * The SSDP server's identifier.
+         */
+        serverId?: string | null
+        /**
+         * Time-to-live value to use for all sockets created by this client.
+         * If not set (or set to 0) the value recommended by UPnP will be used.
+         * This property can only be set during object construction.
+         */
+        socketTtl?: number | null
     }
 
 }
@@ -105,6 +125,10 @@ interface Client extends Gio.Initable {
      * The IP address of the assoicated network interface.
      */
     host_ip: string | null
+    /**
+     * The IP address of the assoicated network interface.
+     */
+    hostIp: string | null
     /**
      * The name of the network interface this client is associated with.
      * Set to NULL to autodetect.
@@ -116,6 +140,12 @@ interface Client extends Gio.Initable {
      * This property can be only set during object construction.
      */
     readonly msearch_port: number
+    /**
+     * UDP port to use for sending multicast M-SEARCH requests on the
+     * network. If not set (or set to 0) a random port will be used.
+     * This property can be only set during object construction.
+     */
+    readonly msearchPort: number
     /**
      * The network this client is currently connected to. You could set this
      * to anything you want to identify the network this client is
@@ -129,12 +159,22 @@ interface Client extends Gio.Initable {
      * The SSDP server's identifier.
      */
     server_id: string | null
+    /**
+     * The SSDP server's identifier.
+     */
+    serverId: string | null
     /**
      * Time-to-live value to use for all sockets created by this client.
      * If not set (or set to 0) the value recommended by UPnP will be used.
      * This property can only be set during object construction.
      */
     readonly socket_ttl: number
+    /**
+     * Time-to-live value to use for all sockets created by this client.
+     * If not set (or set to 0) the value recommended by UPnP will be used.
+     * This property can only be set during object construction.
+     */
+    readonly socketTtl: number
 
     // Own fields of GSSDP-1.0.GSSDP.Client
 
@@ -455,6 +495,15 @@ module ResourceGroup {
          * The default is 120 based on DLNA specification.
          */
         message_delay?: number | null
+        /**
+         * The number of seconds our advertisements are valid.
+         */
+        maxAge?: number | null
+        /**
+         * The minimum number of milliseconds between SSDP messages.
+         * The default is 120 based on DLNA specification.
+         */
+        messageDelay?: number | null
     }
 
 }
@@ -475,11 +524,20 @@ interface ResourceGroup {
      * The number of seconds our advertisements are valid.
      */
     max_age: number
+    /**
+     * The number of seconds our advertisements are valid.
+     */
+    maxAge: number
     /**
      * The minimum number of milliseconds between SSDP messages.
      * The default is 120 based on DLNA specification.
      */
     message_delay: number
+    /**
+     * The minimum number of milliseconds between SSDP messages.
+     * The default is 120 based on DLNA specification.
+     */
+    messageDelay: number
 
     // Own fields of GSSDP-1.0.GSSDP.ResourceGroup
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@girs/gssdp-1.0",
-  "version": "1.0.0-3.2.4",
+  "version": "1.0.0-3.2.6",
   "description": "GJS TypeScript type definitions for GSSDP-1.0, generated from library version 1.0.0",
   "type": "module",
   "module": "gssdp-1.0.js",
@@ -25,11 +25,11 @@
     "test:cjs": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit gssdp-1.0.d.cts"
   },
   "dependencies": {
-    "@girs/gio-2.0": "^2.78.0-3.2.4",
-    "@girs/gjs": "^3.2.4",
-    "@girs/glib-2.0": "^2.78.0-3.2.4",
-    "@girs/gobject-2.0": "^2.78.0-3.2.4",
-    "@girs/soup-2.4": "^2.74.3-3.2.4"
+    "@girs/gio-2.0": "^2.78.0-3.2.6",
+    "@girs/gjs": "^3.2.6",
+    "@girs/glib-2.0": "^2.78.0-3.2.6",
+    "@girs/gobject-2.0": "^2.78.0-3.2.6",
+    "@girs/soup-2.4": "^2.74.3-3.2.6"
   },
   "devDependencies": {
     "typescript": "*"