@girs/gjs 4.0.0-beta.40 → 4.0.0-beta.42

package/README.md

@@ -4,7 +4,7 @@
 ![version](https://img.shields.io/npm/v/@girs/gjs)
 ![downloads/week](https://img.shields.io/npm/dw/@girs/gjs)
 
-GJS TypeScript type definitions for Gjs using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.40.
+GJS TypeScript type definitions for Gjs using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.42.
 
 [GJS](https://gitlab.gnome.org/GNOME/gjs) is a JavaScript runtime for the GNOME ecosystem. Using GJS and the type definitions in this NPM package, you can build GTK applications in JavaScript or TypeScript with type checking, better autocompletion and inline documentations.
 

package/dom.d.ts

@@ -26,7 +26,7 @@ declare global {
     // See https://gitlab.gnome.org/GNOME/gjs/-/blob/master/modules/esm/_timers.js
 
     /**
-     * @version Gjs 1.71.1
+     * @since 1.71.1
      * @param callback a callback function
      * @param delay the duration in milliseconds to wait before running callback
      * @param args arguments to pass to callback
@@ -34,7 +34,7 @@ declare global {
     function setTimeout(callback: (...args: any[]) => any, delay?: number, ...args: any[]): GLib.Source;
 
     /**
-     * @version Gjs 1.71.1
+     * @since 1.71.1
      * @param callback a callback function
      * @param delay the duration in milliseconds to wait between calling callback
      * @param args arguments to pass to callback
@@ -42,13 +42,13 @@ declare global {
     function setInterval(callback: (...args: any[]) => any, delay?: number, ...args: any[]): GLib.Source;
 
     /**
-     * @version Gjs 1.71.1
+     * @since 1.71.1
      * @param timeout the timeout to clear
      */
     function clearTimeout(timeout: GLib.Source): void;
 
     /**
-     * @version Gjs 1.71.1
+     * @since 1.71.1
      * @param timeout the timeout to clear
      */
     function clearInterval(timeout: GLib.Source): void;
@@ -236,7 +236,7 @@ declare global {
      * The TextDecoder interface represents a decoder for a specific text encoding.
      * It takes a stream of bytes as input and emits a stream of code points.
      *
-     * @version Gjs 1.69.2
+     * @since 1.69.2
      */
     interface TextDecoder {
         /** A string containing the name of the decoder, that is a string describing the method the TextDecoder will use. */
@@ -265,7 +265,7 @@ declare global {
     /**
      * TextEncoder takes a stream of code points as input and emits a stream of bytes.
      *
-     * @version Gjs 1.69.2
+     * @since 1.69.2
      */
     interface TextEncoder {
         readonly encoding: 'utf-8';

package/gi.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Requires a GObject Introspection namespace, optionally at a specific version.
+ * If a version is specified and a different version of the same namespace is
+ * already loaded, an error will be thrown.
+ *
+ * @param namespace The GI namespace to import (e.g. 'Gtk', 'GLib')
+ * @param version The version of the namespace (e.g. '4.0', '2.0')
+ * @returns The imported namespace module
+ */
+export function require(namespace: string, version?: string): any;
+
+/**
+ * The `gi` module provides a single entry point for importing GObject
+ * Introspection namespaces in GJS ESM modules.
+ *
+ * @example
+ * ```ts
+ * import Gi from 'gi';
+ * Gi.require('Gtk', '4.0');
+ * ```
+ *
+ * @see https://gjs-docs.gnome.org/gjs/overrides.md#gi-require
+ */
+declare const Gi: {
+    readonly require: typeof require;
+};
+
+export default Gi;

package/gi.js

@@ -0,0 +1,6 @@
+import Gi, { require } from 'gi';
+
+export { require };
+export default Gi;
+
+

package/gjs-ambient.d.ts

@@ -23,3 +23,9 @@ declare module 'console' {
     export { setConsoleLogDomain, getConsoleLogDomain, DEFAULT_LOG_DOMAIN };
     export default Console;
 }
+
+declare module 'gi' {
+    import Gi, { require } from '@girs/gjs/gi';
+    export { require };
+    export default Gi;
+}

package/gjs.d.ts

@@ -725,6 +725,22 @@ declare global {
          */
         format(...args: (string | number | boolean | null | undefined)[]): string;
     }
+
+    interface Error {
+        /**
+         * Checks if this error matches a GLib error domain and code.
+         *
+         * Added to the global `Error` prototype by the GLib override so that
+         * `e.matches(Ns.FooError, Ns.FooError.SOME_CODE)` works without an
+         * `instanceof` check. Always returns `false` for standard JavaScript
+         * errors; only `GLib.Error` instances provide a meaningful implementation.
+         *
+         * @param domain A GLib error domain (error class constructor or quark)
+         * @param code The error code to match against
+         * @returns `false` for native JS errors, `true` if a GLib.Error matches
+         */
+        matches(domain: unknown, code: number): boolean;
+    }
 }
 
 declare const _imports: GjsImports;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@girs/gjs",
-    "version": "4.0.0-beta.40",
+    "version": "4.0.0-beta.42",
     "description": "GJS TypeScript type definitions for Gjs",
     "type": "module",
     "module": "gjs.js",
@@ -36,6 +36,11 @@
         "import": "./console.js",
         "default": "./console.js"
       },
+      "./gi": {
+        "types": "./gi.d.ts",
+        "import": "./gi.js",
+        "default": "./gi.js"
+      },
       "./gjs": {
         "types": "./gjs.d.ts",
         "import": "./gjs.js",
@@ -51,10 +56,10 @@
       "test": "tsc --project tsconfig.json"
     },
     "dependencies": {
-      "@girs/gobject-2.0": "2.86.4-4.0.0-beta.40",
-      "@girs/glib-2.0": "2.86.4-4.0.0-beta.40",
-      "@girs/gio-2.0": "2.86.4-4.0.0-beta.40",
-      "@girs/cairo-1.0": "1.0.0-4.0.0-beta.40"    },
+      "@girs/gobject-2.0": "2.88.0-4.0.0-beta.42",
+      "@girs/glib-2.0": "2.88.0-4.0.0-beta.42",
+      "@girs/gio-2.0": "2.88.0-4.0.0-beta.42",
+      "@girs/cairo-1.0": "1.0.0-4.0.0-beta.42"    },
     "devDependencies": {
       "typescript": "*"
     },

package/system.d.ts

@@ -5,7 +5,7 @@ import type GObject from '@girs/gobject-2.0';
  * line. In C and other languages, this information is contained in the first element of
  * the platform's equivalent of argv, but GJS's ARGV only contains the
  * subsequent command-line arguments. In other words, `ARGV[0]` in GJS is the same as `argv[1]` in C.
- * @version Gjs 1.68
+ * @since 1.68
  */
 export const programInvocationName: string;
 
@@ -16,7 +16,7 @@ export const version: number;
 
 /**
  * The full path of the executed program.
- * @version Gjs 1.68
+ * @since 1.68
  */
 export const programPath: string | null;
 
@@ -24,7 +24,7 @@ export const programPath: string | null;
  * A list of arguments passed to the current process.
  * This is effectively an alias for the global `ARGV`, which is misleading in that
  * it is not equivalent to the platform'`s` argv.
- * @version Gjs 1.68
+ * @since 1.68
  */
 export const programArgs: string[];
 
@@ -46,7 +46,7 @@ export function addressOf(o: object): string;
  * See also {@link addressOf}
  * @param o Any {@link GObject.Object}-derived instance
  * @returns A hexadecimal string (e.g. `0xb4f170f0`)
- * @version Gjs 1.58
+ * @since 1.58
  */
 export function addressOfGObject(o: GObject.Object): string;
 
@@ -110,7 +110,7 @@ export function dumpHeap(path?: string): void;
  * Dump internal garbage collector statistics. If `path` is not given, GJS will
  * write the contents to `stdout`.
  * @param path Optional file path
- * @version Gjs 1.70
+ * @since 1.70
  * @example Output:
  * ```json
  * {

package/tsconfig.json

@@ -17,9 +17,8 @@
     "inlineSources": false,
     "newLine": "LF",
     // Show diagnostics
-    "diagnostics": true
-  },
-  "include": ["./dom.d.ts","./gjs.d.ts"]
+    "diagnostics": true  },
+  "include": ["./dom.d.ts","./cairo.d.ts","./gettext.d.ts","./system.d.ts","./console.d.ts","./gjs-ambient.d.ts","./gjs.d.ts"]
 }
 
 

package/typedoc.json

@@ -1,7 +1,9 @@
 {
-    "entryPoints": ["./gjs.d.ts"],
+    "entryPoints": ["./gjs.d.ts","./cairo.d.ts","./gettext.d.ts","./system.d.ts","./dom.d.ts","./console.d.ts"],
     "readme": "./README.md",
     "name": "Gjs",
-    "tsconfig": "./tsconfig.json"
+    "tsconfig": "./tsconfig.json",
+    "skipErrorChecking": true,
+    "highlightLanguages": ["typescript", "javascript", "c", "cpp", "xml", "bash", "json", "css"]
 }