@girs/gjs 3.3.0 → 4.0.0-beta.10

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) v3.3.0.
+GJS TypeScript type definitions for Gjs using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.10.
 
 [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,7 +2,3 @@
 declare const Cairo: any;
 
 export default Cairo;
-
-
-
-

package/cairo.js

@@ -1,8 +1,6 @@
-
 import Cairo from 'cairo';
 
 // cairo doesn't have named exports, see https://gitlab.gnome.org/GNOME/gjs/-/blob/c2a714f348d6848037f072063e0a914fd537c4f4/installed-tests/js/testCairoModule.js#L14
 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/gettext.js

@@ -1,8 +1,6 @@
-
 import Gettext, { setlocale, textdomain, bindtextdomain, gettext, dgettext, dcgettext, ngettext, dngettext, pgettext, dpgettext, domain } from 'gettext';
 
 export { setlocale, textdomain, bindtextdomain, gettext, dgettext, dcgettext, ngettext, dngettext, pgettext, dpgettext, 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;
+}