@girs/gjs 4.0.0-beta.6 → 4.0.0-beta.8

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.6.
+GJS TypeScript type definitions for Gjs using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.8.
 
 [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/cairo.d.ts

@@ -2,5 +2,3 @@
 declare const Cairo: any;
 
 export default Cairo;
-
-

package/dom.d.ts

@@ -2,16 +2,16 @@
  * Gjs has implemented some functionality from the DOM API,
  * this leads to a conflict when all DOM (`lib.dom.d.ts`) should be used.
  * This should normally not be the case, since the other - not yet reimplemented - API's cannot be used in GJS anyway.
- * In particular, Gjsify tries to rebuild the DOM API and therefore does not need these types.
- * For this reason they are stored in this separate file to make them optional.
- * 
+ *
+ * If for some reason the entire DOM types should still be used,
+ * this file can be ignored and `lib.dom.d.ts` used instead, otherwise this file should be imported in your project.
+ *
  * See also https://github.com/microsoft/TypeScript/blob/main/lib/lib.dom.d.ts
  */
 
 import type GLib from '@girs/glib-2.0';
 
 declare global {
-
     interface ImportMeta {
         /**
          * The absolute file: or resource: URL of the module.
@@ -30,7 +30,7 @@ declare global {
      * @param delay the duration in milliseconds to wait before running callback
      * @param args arguments to pass to callback
      */
-    function setTimeout(callback: (...args: any[]) => any, delay?: number, ...args: any[]): GLib.Source
+    function setTimeout(callback: (...args: any[]) => any, delay?: number, ...args: any[]): GLib.Source;
 
     /**
      * @version Gjs 1.71.1
@@ -38,19 +38,19 @@ declare global {
      * @param delay the duration in milliseconds to wait between calling callback
      * @param args arguments to pass to callback
      */
-    function setInterval(callback: (...args: any[]) => any, delay?: number, ...args: any[]): GLib.Source
+    function setInterval(callback: (...args: any[]) => any, delay?: number, ...args: any[]): GLib.Source;
 
     /**
      * @version Gjs 1.71.1
      * @param timeout the timeout to clear
      */
-    function clearTimeout(timeout: GLib.Source): void
+    function clearTimeout(timeout: GLib.Source): void;
 
     /**
      * @version Gjs 1.71.1
      * @param timeout the timeout to clear
      */
-    function clearInterval(timeout: GLib.Source): void
+    function clearInterval(timeout: GLib.Source): void;
 
     interface Console {
         /**
@@ -62,7 +62,7 @@ declare global {
          * @param data formatting substitutions, if applicable
          * @returns
          */
-        assert(condition: boolean, ...data: any[]): void
+        assert(condition: boolean, ...data: any[]): void;
 
         /**
          * Resets grouping and clears the terminal on systems supporting ANSI
@@ -72,14 +72,14 @@ declare global {
          * console.clear() has no visual effect.
          *
          */
-        clear(): void
+        clear(): void;
 
         /**
          * Logs a message with severity equal to {@link GLib.LogLevelFlags.DEBUG}.
          *
          * @param  {...any} data formatting substitutions, if applicable
          */
-        debug(...data: any[]): void
+        debug(...data: any[]): void;
 
         /**
          * Logs a message with severity equal to {@link GLib.LogLevelFlags.CRITICAL}.
@@ -88,46 +88,46 @@ declare global {
          *
          * @param data formatting substitutions, if applicable
          */
-        error(...data: any[]): void
+        error(...data: any[]): void;
 
         /**
          * Logs a message with severity equal to {@link GLib.LogLevelFlags.INFO}.
          *
          * @param data formatting substitutions, if applicable
          */
-        info(...data: any[]): void
+        info(...data: any[]): void;
 
         /**
          * Logs a message with severity equal to {@link GLib.LogLevelFlags.MESSAGE}.
          *
          * @param data formatting substitutions, if applicable
          */
-        log(...data: any[]): void
+        log(...data: any[]): void;
 
         // 1.1.7 table(tabularData, properties)
-        table(tabularData: any, _properties: never): void
+        table(tabularData: any, _properties: never): void;
 
         /**
          * @param data formatting substitutions, if applicable
          */
-        trace(...data: any[]): void
+        trace(...data: any[]): void;
 
         /**
          * @param data formatting substitutions, if applicable
          */
-        warn(...data: any[]): void
+        warn(...data: any[]): void;
 
         /**
          * @param item an item to format generically
          * @param [options] any additional options for the formatter. Unused
          *   in our implementation.
          */
-        dir(item: object, options: never): void
+        dir(item: object, options: never): void;
 
         /**
          * @param data formatting substitutions, if applicable
          */
-        dirxml(...data: any[]): void
+        dirxml(...data: any[]): void;
 
         // 1.2 Counting functions
         // https://console.spec.whatwg.org/#counting
@@ -139,12 +139,12 @@ declare global {
          *
          * @param label unique identifier for this action
          */
-        count(label: string): void
+        count(label: string): void;
 
         /**
          * @param label the unique label to reset the count for
          */
-        countReset(label: string): void
+        countReset(label: string): void;
 
         // 1.3 Grouping functions
         // https://console.spec.whatwg.org/#grouping
@@ -152,18 +152,18 @@ declare global {
         /**
          * @param data formatting substitutions, if applicable
          */
-        group(...data: any[]): void
+        group(...data: any[]): void;
 
         /**
          * Alias for console.group()
          *
          * @param  {...any} data formatting substitutions, if applicable
          */
-        groupCollapsed(...data: any[]): void
+        groupCollapsed(...data: any[]): void;
 
         /**
          */
-        groupEnd(): void
+        groupEnd(): void;
 
         // 1.4 Timing functions
         // https://console.spec.whatwg.org/#timing
@@ -172,7 +172,7 @@ declare global {
          * @param label unique identifier for this action, pass to
          *   console.timeEnd() to complete
          */
-        time(label: string): void
+        time(label: string): void;
 
         /**
          * Logs the time since the last call to console.time(label) where label is
@@ -182,7 +182,7 @@ declare global {
          *   console.timeEnd() to complete
          * @param data string substitutions, if applicable
          */
-        timeLog(label: string, ...data: any[]): void
+        timeLog(label: string, ...data: any[]): void;
 
         /**
          * Logs the time since the last call to console.time(label) and completes
@@ -191,7 +191,7 @@ declare global {
          *
          * @param label unique identifier for this action
          */
-        timeEnd(label: string): void
+        timeEnd(label: string): void;
 
         // Non-standard functions which are de-facto standards.
         // Similar to Node, we define these as no-ops for now.
@@ -202,21 +202,21 @@ declare global {
          * @param _label unique identifier for this action, pass to
          *   console.profileEnd to complete
          */
-        profile(_label: string): void
+        profile(_label: string): void;
 
         /**
          * @deprecated Not implemented in GJS
          *
          * @param _label unique identifier for this action
          */
-        profileEnd(_label: string): void
+        profileEnd(_label: string): void;
 
         /**
          * @deprecated Not implemented in GJS
          *
          * @param _label unique identifier for this action
          */
-        timeStamp(_label: string): void
+        timeStamp(_label: string): void;
 
         // GJS-specific extensions for integrating with GLib structured logging
 
@@ -224,11 +224,11 @@ declare global {
          * @param logDomain the GLib log domain this Console should print
          *   with. Defaults to 'Gjs-Console'.
          */
-        setLogDomain(logDomain: string): void
+        setLogDomain(logDomain: string): void;
 
-        logDomain: string
+        logDomain: string;
 
-        interact(): void
+        interact(): void;
     }
 
     interface TextDecodeOptions {
@@ -238,9 +238,9 @@ declare global {
 
     interface TextDecoderOptions {
         /** Indicates whether the error mode is fatal. */
-        fatal?: boolean
+        fatal?: boolean;
         /** Indicates whether whether the byte order mark is ignored. */
-        ignoreBOM?: boolean
+        ignoreBOM?: boolean;
     }
 
     /**
@@ -251,11 +251,11 @@ declare global {
      */
     interface TextDecoder {
         /** A string containing the name of the decoder, that is a string describing the method the TextDecoder will use. */
-        readonly encoding: TextDecoderEncoding
+        readonly encoding: TextDecoderEncoding;
         /** A Boolean indicating whether the error mode is fatal. */
-        readonly fatal: boolean
+        readonly fatal: boolean;
         /** A Boolean indicating whether the byte order mark is ignored. */
-        readonly ignoreBOM: boolean
+        readonly ignoreBOM: boolean;
 
         /**
          * Returns a string containing the text decoded with the method of the specific TextDecoder object.
@@ -265,12 +265,12 @@ declare global {
          * @param input Buffer containing the text to decode
          * @param options Object defining the decode options
          */
-        decode(input?: ArrayBufferView | ArrayBuffer, options?: TextDecodeOptions): string
+        decode(input?: ArrayBufferView | ArrayBuffer, options?: TextDecodeOptions): string;
     }
 
     interface TextEncoderEncodeIntoResult {
-        read?: number
-        written?: number
+        read?: number;
+        written?: number;
     }
 
     /**
@@ -279,14 +279,14 @@ declare global {
      * @version Gjs 1.69.2
      */
     interface TextEncoder {
-        readonly encoding: 'utf-8'
+        readonly encoding: 'utf-8';
 
         /**
          * Takes a string as input, and returns a buffer containing the text given in parameters encoded with the UTF-8 method.
          *
          * @param input Text to encode.
          */
-        encode(input?: string): Uint8Array
+        encode(input?: string): Uint8Array;
         /**
          * Takes a string to encode and a destination Uint8Array to put resulting UTF-8 encoded text into,
          * and returns a dictionary object indicating the progress of the encoding.
@@ -296,21 +296,20 @@ declare global {
          * @param source Text to encode.
          * @param destination Buffer where to place the resulting UTF-8 encoded text into.
          */
-        encodeInto(source: string, destination: Uint8Array): TextEncoderEncodeIntoResult
+        encodeInto(source: string, destination: Uint8Array): TextEncoderEncodeIntoResult;
     }
 
-    const console: Console
+    const console: Console;
 
     const TextDecoder: {
-        prototype: TextDecoder
-        new (label?: TextDecoderEncoding, options?: TextDecoderOptions): TextDecoder
-    }
+        prototype: TextDecoder;
+        new (label?: TextDecoderEncoding, options?: TextDecoderOptions): TextDecoder;
+    };
 
     const TextEncoder: {
-        prototype: TextEncoder
-        new (): TextEncoder
-    }
+        prototype: TextEncoder;
+        new (): TextEncoder;
+    };
 }
 
-export {}
-
+export {};

package/gettext.d.ts

@@ -7,36 +7,35 @@ export enum LocaleCategory {
     NUMERIC,
     TIME,
 }
-export function setlocale(category: number, locale: string | null): string
-export function textdomain(domainname: string | null): string
-export function bindtextdomain(domainname: string, dirname: string | null): string
-export function gettext(msgid: string): string
-export function dgettext(domainname: string | null, msgid: string): string
-export function dcgettext(domainname: string | null, msgid: string, category: number): string
-export function ngettext(msgid: string, msgid_plural: string, n: number): string
-export function dngettext(domainname: string, msgid: string, msgid_plural: string, n: number): string
-export function pgettext(context: string, msgid: string): string
-export function dpgettext(dom: string | null, context: string, msgid: string): string
+export function setlocale(category: number, locale: string | null): string;
+export function textdomain(domainname: string | null): string;
+export function bindtextdomain(domainname: string, dirname: string | null): string;
+export function gettext(msgid: string): string;
+export function dgettext(domainname: string | null, msgid: string): string;
+export function dcgettext(domainname: string | null, msgid: string, category: number): string;
+export function ngettext(msgid: string, msgid_plural: string, n: number): string;
+export function dngettext(domainname: string, msgid: string, msgid_plural: string, n: number): string;
+export function pgettext(context: string, msgid: string): string;
+export function dpgettext(dom: string | null, context: string, msgid: string): string;
 export function domain(domainName: string): {
-    gettext: (msgid: string) => string
-    ngettext: (msgid: string, msgid_plural: string, n: number) => string
-    pgettext: (context: string, msgid: string) => string
-}
+    gettext: (msgid: string) => string;
+    ngettext: (msgid: string, msgid_plural: string, n: number) => string;
+    pgettext: (context: string, msgid: string) => string;
+};
 
 declare const Gettext: {
-    LocaleCategory: typeof LocaleCategory,
-    setlocale: typeof setlocale,
-    textdomain: typeof textdomain,
-    bindtextdomain: typeof bindtextdomain,
-    gettext: typeof gettext,
-    dgettext: typeof dgettext,
-    dcgettext: typeof dcgettext,
-    ngettext: typeof ngettext,
-    dngettext: typeof dngettext,
-    pgettext: typeof pgettext,
-    dpgettext: typeof dpgettext,
-    domain: typeof domain,
-}
-
-export default Gettext
+    LocaleCategory: typeof LocaleCategory;
+    setlocale: typeof setlocale;
+    textdomain: typeof textdomain;
+    bindtextdomain: typeof bindtextdomain;
+    gettext: typeof gettext;
+    dgettext: typeof dgettext;
+    dcgettext: typeof dcgettext;
+    ngettext: typeof ngettext;
+    dngettext: typeof dngettext;
+    pgettext: typeof pgettext;
+    dpgettext: typeof dpgettext;
+    domain: typeof domain;
+};
 
+export default Gettext;

package/gjs-ambient.d.ts

@@ -0,0 +1,19 @@
+// https://www.typescriptlang.org/docs/handbook/modules.html#ambient-modules
+// https://stackoverflow.com/questions/45099605/ambient-declaration-with-an-imported-type-in-typescript
+
+declare module 'gettext' {
+    export * from '@girs/gjs/gettext';
+    import Gettext from '@girs/gjs/gettext';
+    export default Gettext;
+}
+
+declare module 'system' {
+    export * from '@girs/gjs/system';
+    import System from '@girs/gjs/system';
+    export default System;
+}
+
+declare module 'cairo' {
+    import Cairo from '@girs/gjs/cairo';
+    export default Cairo;
+}

package/gjs.d.ts

@@ -1,13 +1,13 @@
-/*
+/**
  * Type Definitions for Gjs (https://gjs.guide/)
  *
  * These type definitions are automatically generated, do not edit them by hand.
  * If you found a bug fix it in ts-for-gir itself or create a bug report on https://github.com/gjsify/ts-for-gir
  */
-import './ambient.d.ts';
 
 import type GObject from '@girs/gobject-2.0';
 import type GLib from '@girs/glib-2.0';
+
 import gettext from './gettext.js';
 import system from './system.js';
 import cairo from './cairo.js';
@@ -20,73 +20,208 @@ declare namespace package {
      * and all the other have their values derived from them.
      */
     interface PackageInitParams {
-        name: string
-        version: string
-        prefix: string
-        libdir: string
+        /** The base name of the entry point (eg. org.foo.Bar.App) */
+        name: string;
+        /** The version of the package */
+        version: string;
+        /** The prefix of the package */
+        prefix: string;
+        /**
+         * The final datadir and libdir when installed;
+         * usually, these would be prefix + '/share' and
+         * and prefix + '/lib' (or '/lib64')
+         */
+        libdir: string;
+        /**
+         * The final datadir and libdir when installed;
+         * usually, these would be prefix + '/share' and
+         * and prefix + '/lib' (or '/lib64')
+         */
+        datadir?: string;
     }
 
-    export const name: string | undefined
-    export const version: string | undefined
-    export const prefix: string | undefined
-    export const datadir: string | undefined
-    export const libdir: string | undefined
-    export const pkgdatadir: string | undefined
-    export const pkglibdir: string | undefined
-    export const moduledir: string | undefined
-    export const localedir: string | undefined
+    /** The base name of the entry point (eg. org.foo.Bar.App) */
+    export const name: string | undefined;
+    /** The version of the package */
+    export const version: string | undefined;
+    /** The prefix of the package */
+    export const prefix: string | undefined;
+    /** The final datadir when installed; usually, these would be prefix + '/share' */
+    export const datadir: string | undefined;
+    /** The final libdir when installed; usually, these would be prefix + '/lib' (or '/lib64') */
+    export const libdir: string | undefined;
+    /** The final pkgdatadir when installed; usually, this would be prefix + '/share' */
+    export const pkgdatadir: string | undefined;
+    /** The final pkglibdir when installed; usually, this would be prefix + '/lib' (or '/lib64') */
+    export const pkglibdir: string | undefined;
+    /** The final moduledir when installed; usually, this would be prefix + '/lib' (or '/lib64') */
+    export const moduledir: string | undefined;
+    /** The directory containing gettext translation files; this will be datadir + '/locale' when installed and './po' in the source tree */
+    export const localedir: string | undefined;
 
-    export function init(params: PackageInitParams): void
-    export function run(module: { main: (argv: string[]) => void }): void
-    /** shortcut to init+run */
-    export function start(params: PackageInitParams): void
-    export function require(libs: Record<string, string>): void
-    export function requireSymbol(lib: string, ver: string, symbol: string): void
-    export function checkSymbol(lib: string, ver: string, symbol: string): void
-    export function initGettext(): void
-    /** @deprecated Use JS string interpolation */
-    export function initFormat(): void
-    export function initSubmodule(module: string): void
+    /**
+     * Initialize directories and global variables. Must be called
+     * before any of other API in Package is used.
+     * `params` must be an object with at least the following keys:
+     *  - name: the package name ($(PACKAGE_NAME) in autotools,
+     *          eg. org.foo.Bar)
+     *  - version: the package version
+     *  - prefix: the installation prefix
+     *
+     * init() will take care to check if the program is running from
+     * the source directory or not, by looking for a 'src' directory.
+     *
+     * At the end, the global variable 'pkg' will contain the
+     * Package module (imports.package). Additionally, the following
+     * module variables will be available:
+     *  - name: the base name of the entry point (eg. org.foo.Bar.App)
+     *  - version: same as in @params
+     *  - prefix: the installation prefix (as passed in @params)
+     *  - datadir, libdir: the final datadir and libdir when installed;
+     *                     usually, these would be prefix + '/share' and
+     *                     and prefix + '/lib' (or '/lib64')
+     *  - pkgdatadir: the directory to look for private data files, such as
+     *                images, stylesheets and UI definitions;
+     *                this will be datadir + name when installed and
+     *                './data' when running from the source tree
+     *  - pkglibdir: the directory to look for private typelibs and C
+     *               libraries;
+     *               this will be libdir + name when installed and
+     *               './lib' when running from the source tree
+     *  - moduledir: the directory to look for JS modules;
+     *               this will be pkglibdir when installed and
+     *               './src' when running from the source tree
+     *  - localedir: the directory containing gettext translation files;
+     *               this will be datadir + '/locale' when installed
+     *               and './po' in the source tree
+     *
+     * All paths are absolute and will not end with '/'.
+     *
+     * As a side effect, init() calls GLib.set_prgname().
+     *
+     * @param {object} params package parameters
+     */
+    export function init(params: PackageInitParams): void;
+    /**
+     * This is the function to use if you want to have multiple
+     * entry points in one package.
+     * You must define a main(ARGV) function inside the passed
+     * in module, and then the launcher would be
+     *
+     * imports.package.init(...);
+     * imports.package.run(imports.entrypoint);
+     *
+     * @param module the module to run
+     * @returns the exit code of the module's main() function
+     */
+    export function run(module: { main: (argv: string[]) => void }): number | undefined;
+    /**
+     * This is a convenience function if your package has a
+     * single entry point.
+     * You must define a main(ARGV) function inside a main.js
+     * module in moduledir.
+     *
+     * @param params see init()
+     */
+    export function start(params: PackageInitParams): void;
+    /**
+     * Mark a dependency on a specific version of one or more
+     * external GI typelibs.
+     * `libs` must be an object whose keys are a typelib name,
+     * and values are the respective version. The empty string
+     * indicates any version.
+     * @param deps The external dependencies to import
+     */
+    export function require(deps: Record<string, string>): void;
+    /**
+     * As checkSymbol(), but exit with an error if the
+     * dependency cannot be satisfied.
+     *
+     * @param lib an external dependency to import
+     * @param ver version of the dependency
+     * @param symbol symbol to check for
+     */
+    export function requireSymbol(lib: string, ver?: string, symbol?: string): void;
+    /**
+     * Check whether an external GI typelib can be imported
+     * and provides @symbol.
+     *
+     * Symbols may refer to
+     *  - global functions         ('main_quit')
+     *  - classes                  ('Window')
+     *  - class / instance methods ('IconTheme.get_default' / 'IconTheme.has_icon')
+     *  - GObject properties       ('Window.default_height')
+     *
+     * @param lib an external dependency to import
+     * @param ver version of the dependency
+     * @param symbol symbol to check for
+     * @returns true if `lib` can be imported and provides `symbol`, false
+     * otherwise
+     */
+    export function checkSymbol(lib: string, ver: string, symbol: string): boolean;
+    /**
+     * Initialize `gettext`.
+     * After calling this method `globalThis._`, `globalThis.C_` and `globalThis.N_` will be available.
+     */
+    export function initGettext(): void;
+    /**
+     * @deprecated Use JS string interpolation
+     */
+    export function initFormat(): void;
+    /**
+     * As checkSymbol(), but exit with an error if the
+     * dependency cannot be satisfied.
+     *
+     * @param lib an external dependency to import
+     * @param ver version of the dependency
+     * @param symbol symbol to check for
+     */
+    export function initSubmodule(lib: string, ver?: string, symbol?: string): void;
+    /**
+     * Load and register a GResource named @name. @name is optional and defaults to ${package-name}
+     * @param name The name of the GResource to load
+     */
+    export function loadResource(name?: string): void;
 }
 
 declare namespace byteArray {
     export class ByteArray {
-        static get(target: any, property: string, receiver: any): any
-        static set(target: any, property: string, value: any, receiver: any): boolean
+        static get(target: any, property: string, receiver: any): any;
+        static set(target: any, property: string, value: any, receiver: any): boolean;
 
-        length: number
-        protected _array: Uint8Array
+        length: number;
+        protected _array: Uint8Array;
 
-        constructor(x: Uint8Array | number)
-        toString(encoding?: TextDecoderEncoding): string
-        fromString(input: string, encoding?: TextDecoderEncoding): ByteArray
-        toGBytes(): GLib.Bytes
+        constructor(x: Uint8Array | number);
+        toString(encoding?: TextDecoderEncoding): string;
+        fromString(input: string, encoding?: TextDecoderEncoding): ByteArray;
+        toGBytes(): GLib.Bytes;
     }
 
     /** @deprecated Use {@link TextEncoder.encode} instead */
-    export function fromString(input: string, encoding?: TextDecoderEncoding): Uint8Array
+    export function fromString(input: string, encoding?: TextDecoderEncoding): Uint8Array;
 
     /** @deprecated Use {@link GLib.Bytes.toArray} instead */
-    export function fromGBytes(input: GLib.Bytes): Uint8Array
+    export function fromGBytes(input: GLib.Bytes): Uint8Array;
 
     /** @deprecated Use {@link TextDecoder.decode} instead */
-    export function toString(x: Uint8Array, encoding?: TextDecoderEncoding): string
+    export function toString(x: Uint8Array, encoding?: TextDecoderEncoding): string;
 
     /** @deprecated Use {@link GLib.Bytes new GLib.Bytes() } instead */
-    export function toGBytes(x: Uint8Array): GLib.Bytes
+    export function toGBytes(x: Uint8Array): GLib.Bytes;
 
     /** @deprecated Use {@link ByteArray new ByteArray()} instead */
-    export function fromArray(array: Iterable<number>): ByteArray
+    export function fromArray(array: Iterable<number>): ByteArray;
 }
 
 declare namespace lang {
     // TODO: There is a lot more in Lang
-    export function Class(props: any): void
+    export function Class(props: any): void;
 }
 
 declare namespace format {
-    export function vprintf(str: string, args: string[]): string
-    export function printf(fmt: string, ...args: any[]): void
+    export function vprintf(str: string, args: string[]): string;
+    export function printf(fmt: string, ...args: any[]): void;
     // Following docs from gjs/modules/format.js
     /**
      * This function is intended to extend the String object and provide
@@ -99,19 +234,19 @@ declare namespace format {
      * field width, e.g. "%5s".format("foo"). Unless the width is prefixed
      * with '0', the formatted string will be padded with spaces.
      */
-    export function format(fmt: string, ...args: any[]): string
+    export function format(fmt: string, ...args: any[]): string;
 }
 
 declare namespace mainloop {
-    export function quit(name: string): void
-    export function idle_source(handler: any, priority?: number): any
-    export function idle_add(handler: any, priority?: number): any
-    export function timeout_source(timeout: any, handler: any, priority?: number): any
-    export function timeout_seconds_source(timeout: any, handler: any, priority?: number): any
-    export function timeout_add(timeout: any, handler: any, priority?: number): any
-    export function timeout_add_seconds(timeout: any, handler: any, priority?: number): any
-    export function source_remove(id: any): any
-    export function run(name: string): void
+    export function quit(name: string): void;
+    export function idle_source(handler: any, priority?: number): any;
+    export function idle_add(handler: any, priority?: number): any;
+    export function timeout_source(timeout: any, handler: any, priority?: number): any;
+    export function timeout_seconds_source(timeout: any, handler: any, priority?: number): any;
+    export function timeout_add(timeout: any, handler: any, priority?: number): any;
+    export function timeout_add_seconds(timeout: any, handler: any, priority?: number): any;
+    export function source_remove(id: any): any;
+    export function run(name: string): void;
 }
 
 /**
@@ -121,15 +256,15 @@ declare namespace mainloop {
  * @example
  * ```ts
  * const Signals = imports.signals;
- * 
+ *
  * // Define an interface with the same name of your class to make the methods known
  * interface Events extends Signals.Methods {}
- * 
+ *
  * class Events {}
  * Signals.addSignalMethods(Events.prototype);
- * 
+ *
  * const events = new Events();
- * 
+ *
  * // Typescript will not complain here
  * events.emit("test-signal", "test argument");
  * ```
@@ -138,13 +273,13 @@ export interface SignalMethods {
     /**
      * Connects a callback to a signal for an object. Pass the returned ID to
      * `disconnect()` to remove the handler.
-     * 
+     *
      * If `callback` returns `true`, emission will stop and no other handlers will be
      * invoked.
-     * 
+     *
      * > Warning: Unlike GObject signals, `this` within a signal callback will always
      * > refer to the global object (ie. `globalThis`).
-     * 
+     *
      * @param sigName A signal name
      * @param callback A callback function
      * @returns A handler ID
@@ -152,7 +287,7 @@ export interface SignalMethods {
     connect(sigName: string, callback: (self: any, ...args: any[]) => void): number;
     /**
      * Emits a signal for an object. Emission stops if a signal handler returns `true`.
-     * 
+     *
      * Unlike GObject signals, it is not necessary to declare signals or define their
      * signature. Simply call `emit()` with whatever signal name you wish, with
      * whatever arguments you wish.
@@ -168,7 +303,7 @@ export interface SignalMethods {
     /**
      * Disconnects all signal handlers for an object.
      */
-    disconnectAll(): void
+    disconnectAll(): void;
     /**
      * Checks if a handler ID is connected.
      * @param id The ID of the handler to be disconnected
@@ -182,7 +317,6 @@ declare namespace signals {
 }
 
 declare global {
-
     // https://gitlab.gnome.org/GNOME/gjs/-/blob/1.73.2/modules/esm/_encoding/encodingMap.js#L7-232
     type TextDecoderEncoding =
         | 'unicode-1-1-utf-8'
@@ -404,56 +538,72 @@ declare global {
         | 'unicode'
         | 'unicodefeff'
         | 'utf-16'
-        | 'utf-16le'
+        | 'utf-16le';
 
     interface GjsGiImports {
         // Will be extended by the import of more gir types
         versions: {
-            [namespace: string]: string
-        }
+            [namespace: string]: string;
+        };
     }
-    
+
     interface GjsImports {
-        gi: GjsGiImports
-        lang: typeof lang
-        system: typeof system
-        signals: typeof signals
-        package: typeof package
-        mainloop: typeof mainloop
-        searchPath: string[]
-        gettext: typeof gettext
-        byteArray: typeof byteArray
-        format: typeof format
-        cairo: typeof cairo
+        gi: GjsGiImports;
+        lang: typeof lang;
+        system: typeof system;
+        signals: typeof signals;
+        package: typeof package;
+        mainloop: typeof mainloop;
+        searchPath: string[];
+        gettext: typeof gettext;
+        byteArray: typeof byteArray;
+        format: typeof format;
+        cairo: typeof cairo;
     }
 
-    function print(...args: any[]): void
-    function printerr(...args: any[]): void
-    function log(message: any): void
-    function logError(exception: object, message?: any): void
-    function logError(message?: any): void
+    // Overwrites, see https://gitlab.gnome.org/GNOME/gjs/-/blob/master/modules/script/package.js
+    /**
+     * Run `pkg.initGettext()` before using this.
+     * See {@link gettext.gettext}
+     */
+    const _: undefined | typeof gettext.gettext;
+    /**
+     * Run `pkg.initGettext()` before using this.
+     * See {@link gettext.pgettext}
+     */
+    const C_: undefined | typeof gettext.pgettext;
+    /**
+     * Run `pkg.initGettext()` before using this.
+     * Currently not implemented.
+     */
+    const N_: undefined | ((x: string) => string);
+
+    function print(...args: any[]): void;
+    function printerr(...args: any[]): void;
+    function log(obj: object, others?: object[]): void;
+    function log(msg: string, substitutions?: any[]): void;
+    function logError(exception: object, message?: any): void;
+    function logError(message?: any): void;
 
-    const pkg: typeof package
+    const pkg: typeof package;
 
     interface BooleanConstructor {
-        $gtype: GObject.GType<boolean>
+        $gtype: GObject.GType<boolean>;
     }
 
     interface NumberConstructor {
-        $gtype: GObject.GType<number>
+        $gtype: GObject.GType<number>;
     }
 
     interface StringConstructor {
-        $gtype: GObject.GType<string>
+        $gtype: GObject.GType<string>;
     }
 
-    const imports: GjsImports
+    const imports: GjsImports;
 
-    const ARGV: string[]
+    const ARGV: string[];
 }
 
-declare const _imports: GjsImports
-export default _imports
-export { _imports as imports }
-
-
+declare const _imports: GjsImports;
+export default _imports;
+export { _imports as imports };

package/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Type Definitions for Gjs (https://gjs.guide/)
+ *
+ * These type definitions are automatically generated, do not edit them by hand.
+ * If you found a bug fix it in `ts-for-gir` or create a bug report on https://github.com/gjsify/ts-for-gir
+ *
+ * This template is used to generate the index.d.ts file of each GIR module like Gtk-4.0, GObject-2.0, ...
+ */
+
+import './gjs-ambient.d.ts';
+
+import gjs from './gjs.js';
+export default gjs;

package/index.js

@@ -0,0 +1,5 @@
+
+// @ts-expect-error
+import gjs from './gjs.js';
+export default gjs;
+

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@girs/gjs",
-  "version": "4.0.0-beta.6",
+  "version": "4.0.0-beta.8",
   "description": "GJS TypeScript type definitions for Gjs",
   "type": "module",
   "module": "gjs.js",
   "main": "gjs.js",
   "exports": {
     "./ambient": {
-      "types": "./ambient.d.ts",
-      "import": "./ambient.js",
-      "default": "./ambient.js"
+      "types": "./gjs-ambient.d.ts",
+      "import": "./gjs-ambient.js",
+      "default": "./gjs-ambient.js"
     },
     "./dom": {
       "types": "./dom.d.ts",
@@ -31,19 +31,24 @@
       "import": "./cairo.js",
       "default": "./cairo.js"
     },
-    ".": {
+    "./gjs": {
       "types": "./gjs.d.ts",
       "import": "./gjs.js",
       "default": "./gjs.js"
+    },
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js",
+      "default": "./index.js"
     }
   },
   "scripts": {
     "test": "tsc --project tsconfig.json"
   },
   "dependencies": {
-    "@girs/gio-2.0": "^2.80.3-4.0.0-beta.6",
-    "@girs/glib-2.0": "^2.80.3-4.0.0-beta.6",
-    "@girs/gobject-2.0": "^2.80.3-4.0.0-beta.6"
+    "@girs/gio-2.0": "^2.80.2-4.0.0-beta.8",
+    "@girs/glib-2.0": "^2.80.2-4.0.0-beta.8",
+    "@girs/gobject-2.0": "^2.80.2-4.0.0-beta.8"
   },
   "devDependencies": {
     "typescript": "*"

package/system.d.ts

@@ -7,18 +7,18 @@ import type GObject from '@girs/gobject-2.0';
  * subsequent command-line arguments. In other words, `ARGV[0]` in GJS is the same as `argv[1]` in C.
  * @version Gjs 1.68
  */
-export const programInvocationName: string
+export const programInvocationName: string;
 
 /**
  * This property contains version information about GJS.
  */
-export const version: number
+export const version: number;
 
 /**
  * The full path of the executed program.
  * @version Gjs 1.68
  */
-export const programPath: string | null
+export const programPath: string | null;
 
 /**
  * A list of arguments passed to the current process.
@@ -26,7 +26,7 @@ export const programPath: string | null
  * it is not equivalent to the platform'`s` argv.
  * @version Gjs 1.68
  */
-export const programArgs: string[]
+export const programArgs: string[];
 
 /**
  * Return the memory address of any object as a string.
@@ -39,7 +39,7 @@ export const programArgs: string[]
  * @param o Any Object
  * @returns A hexadecimal string (e.g. `0xb4f170f0`)
  */
-export function addressOf(o: any): string
+export function addressOf(o: any): string;
 
 /**
  * Return the memory address of any GObject as a string.
@@ -48,7 +48,7 @@ export function addressOf(o: any): string
  * @returns A hexadecimal string (e.g. `0xb4f170f0`)
  * @version Gjs 1.58
  */
-export function addressOfGObject(o: GObject.Object): string
+export function addressOfGObject(o: GObject.Object): string;
 
 /**
  * Inserts a breakpoint instruction into the code.
@@ -81,30 +81,30 @@ export function addressOfGObject(o: GObject.Object): string
  * breakpoint, so make sure to remove any calls to `System.breakpoint()` when
  * you're done debugging.
  */
-export function breakpoint(): void
+export function breakpoint(): void;
 
 /**
  * Clears the timezone cache.
  * This is a workaround for SpiderMonkey Bug [#1004706](https://bugzilla.mozilla.org/show_bug.cgi?id=1004706).
  */
-export function clearDateCaches(): void
+export function clearDateCaches(): void;
 
 /** Runs the garbage collector */
-export function gc(): void
+export function gc(): void;
 
 /**
  * Return the reference count of any GObject-derived type. When an object's
  * reference count is zero, it is cleaned up and erased from memory.
  * @param o A {@link GObject.Object}
  */
-export function refcount(o: GObject.Object): number
+export function refcount(o: GObject.Object): number;
 /**
  * See also: The [heapgraph](https://gitlab.gnome.org/GNOME/gjs/blob/HEAD/tools/heapgraph.md) utility in the GJS repository.
  * Dump a representation of internal heap memory. If `path` is not given, GJS will
  * write the contents to `stdout`.
  * @param path  Optional file path
  */
-export function dumpHeap(path?: string): void
+export function dumpHeap(path?: string): void;
 
 /**
  * Dump internal garbage collector statistics. If `path` is not given, GJS will
@@ -132,44 +132,43 @@ export function dumpHeap(path?: string): void
  *   }
  * }
  * ```
- * 
+ *
  */
-export function dumpMemoryInfo(path?: string): void
+export function dumpMemoryInfo(path?: string): void;
 
 /**
  * This works the same as C's exit() function; exits the program, passing a
  * certain error code to the shell. The shell expects the error code to be zero if
  * there was no error, or non-zero (any value you please) to indicate an error.
- * 
+ *
  * This value is used by other tools such as `make`; if `make` calls a program that
  * returns a non-zero error code, then `make` aborts the build.
  * @param code An exit code
  */
-export function exit(code: number): void
+export function exit(code: number): void;
 
 /**
  * The System module provides common low-level facilities such as access to
  * process arguments and exit(), as well as a number of useful functions and
  * properties for debugging.
- * 
+ *
  * Note that the majority of the functions and properties in this module should not
  * be used in normal operation of a GJS application.
  */
 declare const System: {
-    programInvocationName: typeof programInvocationName,
-    version: typeof version,
-    programPath: typeof programPath,
-    programArgs: typeof programArgs,
-    addressOf: typeof addressOf,
-    addressOfGObject: typeof addressOfGObject,
-    breakpoint: typeof breakpoint,
-    clearDateCaches: typeof clearDateCaches,
-    gc: typeof gc,
-    refcount: typeof refcount,
-    dumpHeap: typeof dumpHeap,
-    dumpMemoryInfo: typeof dumpMemoryInfo,
-    exit: typeof exit,
-}
-
-export default System
+    programInvocationName: typeof programInvocationName;
+    version: typeof version;
+    programPath: typeof programPath;
+    programArgs: typeof programArgs;
+    addressOf: typeof addressOf;
+    addressOfGObject: typeof addressOfGObject;
+    breakpoint: typeof breakpoint;
+    clearDateCaches: typeof clearDateCaches;
+    gc: typeof gc;
+    refcount: typeof refcount;
+    dumpHeap: typeof dumpHeap;
+    dumpMemoryInfo: typeof dumpMemoryInfo;
+    exit: typeof exit;
+};
 
+export default System;

package/tsconfig.json

@@ -2,11 +2,11 @@
   "compilerOptions": {
     // General settings for code interpretation
     "target": "ESNext",
-    "module": "ESNext",
+    "module": "NodeNext",
     "lib": ["ESNext"],
     "types": [],
     "experimentalDecorators": true,
-    "moduleResolution": "node",
+    "moduleResolution": "NodeNext",
     "noEmit": true,
     "noEmitOnError": false,
     "baseUrl": "./",

package/ambient.d.ts

@@ -1,20 +0,0 @@
-// https://www.typescriptlang.org/docs/handbook/modules.html#ambient-modules
-// https://stackoverflow.com/questions/45099605/ambient-declaration-with-an-imported-type-in-typescript
-
-declare module 'gettext' {
-  export * from '@girs/gjs/gettext';
-  import Gettext from '@girs/gjs/gettext';
-  export default Gettext;
-}
-
-declare module 'system' {
-  export * from '@girs/gjs/system';
-  import System from '@girs/gjs/system';
-  export default System;
-}
-
-declare module 'cairo' {
-  import Cairo from '@girs/gjs/cairo';
-  export default Cairo;
-}
-