@ts-for-gir/cli 3.0.0-beta.2

package/templates/Gjs/index.d.ts

@@ -0,0 +1,279 @@
+/*
+ * 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 <%= APP_NAME %> itself or create a bug report on <%= APP_SOURCE %>
+ */
+
+import type * as Gjs from './Gjs.js'
+<%_ for (const girModule of girModules) { _%>
+  <%_ if(useNamespace){ _%>
+import type <%= girModule.importName %> from "./<%= girModule.packageName %>.js";
+  <%_ } else { _%>
+import type * as <%= girModule.importName %> from "./<%= girModule.packageName %>.js";
+  <%_ } _%>
+<%_ } _%>
+
+// See also https://github.com/microsoft/TypeScript/blob/main/lib/lib.dom.d.ts
+declare global {
+    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
+
+    interface Console {
+        /**
+         * Logs a critical message if the condition is not truthy.
+         * {@link console.error()} for additional information.
+         *
+         * @param condition a boolean condition which, if false, causes
+         *   the log to print
+         * @param data formatting substitutions, if applicable
+         * @returns
+         */
+        assert(condition: boolean, ...data: any[]): void
+
+        /**
+         * Resets grouping and clears the terminal on systems supporting ANSI
+         * terminal control sequences.
+         *
+         * In file-based stdout or systems which do not support clearing,
+         * console.clear() has no visual effect.
+         *
+         */
+        clear(): void
+
+        /**
+         * Logs a message with severity equal to {@link GLib20.LogLevelFlags.DEBUG}.
+         *
+         * @param  {...any} data formatting substitutions, if applicable
+         */
+        debug(...data: any[]): void
+
+        /**
+         * Logs a message with severity equal to {@link GLib20.LogLevelFlags.CRITICAL}.
+         * Does not use {@link GLib20.LogLevelFlags.ERROR} to avoid asserting and
+         * forcibly shutting down the application.
+         *
+         * @param data formatting substitutions, if applicable
+         */
+        error(...data: any[]): void
+
+        /**
+         * Logs a message with severity equal to {@link GLib20.LogLevelFlags.INFO}.
+         *
+         * @param data formatting substitutions, if applicable
+         */
+        info(...data: any[]): void
+
+        /**
+         * Logs a message with severity equal to {@link GLib20.LogLevelFlags.MESSAGE}.
+         *
+         * @param data formatting substitutions, if applicable
+         */
+        log(...data: any[]): void
+
+        // 1.1.7 table(tabularData, properties)
+        table(tabularData: any, _properties: never): void
+
+        /**
+         * @param data formatting substitutions, if applicable
+         */
+        trace(...data: any[]): void
+
+        /**
+         * @param data formatting substitutions, if applicable
+         */
+        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
+
+        /**
+         * @param data formatting substitutions, if applicable
+         */
+        dirxml(...data: any[]): void
+
+        // 1.2 Counting functions
+        // https://console.spec.whatwg.org/#counting
+
+        /**
+         * Logs how many times console.count(label) has been called with a given
+         * label.
+         * {@link console.countReset()} for resetting a count.
+         *
+         * @param label unique identifier for this action
+         */
+        count(label: string): void
+
+        /**
+         * @param label the unique label to reset the count for
+         */
+        countReset(label: string): void
+
+        // 1.3 Grouping functions
+        // https://console.spec.whatwg.org/#grouping
+
+        /**
+         * @param data formatting substitutions, if applicable
+         */
+        group(...data: any[]): void
+
+        /**
+         * Alias for console.group()
+         *
+         * @param  {...any} data formatting substitutions, if applicable
+         */
+        groupCollapsed(...data: any[]): void
+
+        /**
+         */
+        groupEnd(): void
+
+        // 1.4 Timing functions
+        // https://console.spec.whatwg.org/#timing
+
+        /**
+         * @param label unique identifier for this action, pass to
+         *   console.timeEnd() to complete
+         */
+        time(label: string): void
+
+        /**
+         * Logs the time since the last call to console.time(label) where label is
+         * the same.
+         *
+         * @param label unique identifier for this action, pass to
+         *   console.timeEnd() to complete
+         * @param data string substitutions, if applicable
+         */
+        timeLog(label: string, ...data: any[]): void
+
+        /**
+         * Logs the time since the last call to console.time(label) and completes
+         * the action.
+         * Call console.time(label) again to re-measure.
+         *
+         * @param label unique identifier for this action
+         */
+        timeEnd(label: string): void
+
+        // Non-standard functions which are de-facto standards.
+        // Similar to Node, we define these as no-ops for now.
+
+        /**
+         * @deprecated Not implemented in GJS
+         *
+         * @param _label unique identifier for this action, pass to
+         *   console.profileEnd to complete
+         */
+        profile(_label: string): void
+
+        /**
+         * @deprecated Not implemented in GJS
+         *
+         * @param _label unique identifier for this action
+         */
+        profileEnd(_label: string): void
+
+        /**
+         * @deprecated Not implemented in GJS
+         *
+         * @param _label unique identifier for this action
+         */
+        timeStamp(_label: string): void
+
+        // GJS-specific extensions for integrating with GLib structured logging
+
+        /**
+         * @param logDomain the GLib log domain this Console should print
+         *   with. Defaults to 'Gjs-Console'.
+         */
+        setLogDomain(logDomain: string): void
+
+        logDomain: string
+    }
+
+    const console: Console;
+
+    interface BooleanConstructor {
+        $gtype: GObject20.GType<boolean>
+    }
+
+    interface NumberConstructor {
+        $gtype: GObject20.GType<number>
+    }
+
+    interface StringConstructor {
+        $gtype: GObject20.GType<string>
+    }
+
+    const ARGV: string[]
+
+    // Timers
+    // See https://gitlab.gnome.org/GNOME/gjs/-/blob/master/modules/esm/_timers.js
+
+    /**
+     * @version Gjs 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
+     */
+    function setTimeout(callback: (...args: any[]) => any, delay?: number, ...args: any[]): GLib20.Source
+
+    /**
+     * @version Gjs 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
+     */
+    function setInterval(callback: (...args: any[]) => any, delay?: number, ...args: any[]): GLib20.Source
+
+    /**
+     * @version Gjs 1.71.1
+     * @param timeout the timeout to clear
+     */
+    function clearTimeout(timeout: GLib20.Source): void
+
+    /**
+     * @version Gjs 1.71.1
+     * @param timeout the timeout to clear
+     */
+    function clearInterval(timeout: GLib20.Source): void
+
+    const imports: typeof Gjs & {
+        gi: {
+          <%_ for (const girModuleGroup of girModulesGrouped) { _%>
+            <%= girModuleGroup.namespace %>: <%_ for (const [i, girModule] of girModuleGroup.modules.entries()) { _%>
+              typeof <%= girModule.module.importName %>
+              <%_ if (i !== girModuleGroup.modules.length - 1) { _%>
+                |
+              <%_ } _%>
+            <%_ } _%>
+          <%_ } _%>
+          versions: {
+            <%_ for (const girModuleGroup of girModulesGrouped) { _%>
+              <%= girModuleGroup.namespace %>: <%_ for (const [i, girModule] of girModuleGroup.modules.entries()) { _%>
+                '<%= girModule.module.version %>'
+                <%_ if (i !== girModuleGroup.modules.length - 1) { _%>
+                  |
+                <%_ } _%>
+              <%_ } _%>
+            <%_ } _%>
+          }
+        }
+        lang: typeof Gjs.Lang
+        system: typeof Gjs.System
+        package: typeof Gjs.Package
+        mainloop: typeof Gjs.Mainloop
+        searchPath: string[]
+    }
+}
+
+declare const _imports: typeof imports
+export default _imports

package/templates/Gjs/index.js

@@ -0,0 +1,4 @@
+const _imports = imports || {}
+
+export { _imports }
+export default _imports

package/templates/Gjs/module.d.ts

@@ -0,0 +1,10 @@
+<% if (noCheck) { -%>
+// @ts-nocheck
+<% } -%>
+
+/*
+ * 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 <%= APP_NAME %> itself or create a bug report on <%= APP_SOURCE %>
+ */

package/templates/Gjs/module.js

@@ -0,0 +1,16 @@
+<% if(moduleType === 'esm'){ %>
+// @ts-expect-error
+import <%= name %> from 'gi://<%= name %>?version=<%= version %>';
+export { <%= name %> };
+export default <%= name %>;
+<% } else { %>
+imports.gi.versions.<%= name %> = '<%= version %>'
+const <%= name %> = imports.gi.<%= name %>;
+  <% if(useNamespace){ %>
+module.exports = { <%= name %> };
+exports.default = <%= name %>;
+  <% } else { %>
+module.exports = <%= name %>;
+  <% } %>
+<% } %>
+

package/templates/Granite-1.0.d.ts

@@ -0,0 +1,7 @@
+// Workaround
+/** @ignore */
+export module GraniteServicesSettingsSerializable {
+    export interface ConstructorProperties extends ServicesSettingsSerializable.ConstructorProperties {}
+}
+/** @ignore */
+export interface GraniteServicesSettingsSerializable extends ServicesSettingsSerializable {}

package/templates/Granite-7.0.d.ts

@@ -0,0 +1,7 @@
+// Workaround
+/** @ignore */
+export module GraniteServicesSettingsSerializable {
+    export interface ConstructorProperties extends ServicesSettingsSerializable.ConstructorProperties {}
+}
+/** @ignore */
+export interface GraniteServicesSettingsSerializable extends ServicesSettingsSerializable {}

package/templates/GstBase-0.10.d.ts

@@ -0,0 +1,5 @@
+// Workaround
+/** @ignore */
+export module BaseSink {
+    export type ConstructorProperties = Gst.BaseSink.ConstructorProperties;
+}

package/templates/RygelServer-2.6.d.ts

@@ -0,0 +1,3 @@
+// Workaround
+/** @ignore */
+interface IconInfo extends RygelCore.IconInfo {}

package/templates/node-gtk/GObject-2.0.d.ts

@@ -0,0 +1,57 @@
+// See https://github.com/romgrk/node-gtk/blob/master/lib/overrides/GObject.js
+
+export type GType<T = unknown> = {
+    __type__(arg: never): T
+    name: string
+};
+
+// TODO: What about the generated class Closure 
+export type TClosure<R = any, P = any> = (...args: P[]) => R;
+
+export let TYPE_INVALID   : 0n
+export let TYPE_NONE      : GType<undefined>;
+export let TYPE_INTERFACE : GType<unknown>;
+export let TYPE_CHAR      : GType<string>;
+export let TYPE_UCHAR     : GType<string>;
+export let TYPE_BOOLEAN   : GType<boolean>;
+export let TYPE_INT       : GType<number>;
+export let TYPE_UINT      : GType<number>;
+export let TYPE_LONG      : GType<number>;
+export let TYPE_ULONG     : GType<number>;
+export let TYPE_INT64     : GType<number>;
+export let TYPE_UINT64    : GType<number>;
+export let TYPE_ENUM      : GType<number>;
+export let TYPE_FLAGS     : GType<number>;
+export let TYPE_FLOAT     : GType<number>;
+export let TYPE_DOUBLE    : GType<number>;
+export let TYPE_STRING    : GType<string>;
+export let TYPE_POINTER   : GType<undefined>;
+export let TYPE_BOXED     : GType<unknown>;
+export let TYPE_PARAM     : GType<unknown>;
+export let TYPE_OBJECT    : GType<object>;
+export let TYPE_GTYPE     : GType<unknown>;
+export let TYPE_VARIANT   : GType<unknown>;
+export let TYPE_UNICHAR   : GType<number>;
+
+export function typeFromName(name: 'void'): typeof TYPE_INVALID
+export function typeFromName(name: 'GInterface'): typeof TYPE_INTERFACE
+export function typeFromName(name: 'gchar'): typeof TYPE_CHAR
+export function typeFromName(name: 'guchar'): typeof TYPE_UCHAR
+export function typeFromName(name: 'gboolean'): typeof TYPE_BOOLEAN
+export function typeFromName(name: 'gint'): typeof TYPE_INT
+export function typeFromName(name: 'guint'): typeof TYPE_UINT
+export function typeFromName(name: 'glong'): typeof TYPE_LONG
+export function typeFromName(name: 'gulong'): typeof TYPE_ULONG
+export function typeFromName(name: 'gint64'): typeof TYPE_INT64
+export function typeFromName(name: 'guint64'): typeof TYPE_UINT64
+export function typeFromName(name: 'GEnum'): typeof TYPE_ENUM
+export function typeFromName(name: 'GFlags'): typeof TYPE_FLAGS
+export function typeFromName(name: 'gfloat'): typeof TYPE_FLOAT
+export function typeFromName(name: 'gdouble'): typeof TYPE_DOUBLE
+export function typeFromName(name: 'gchararray'): typeof TYPE_STRING
+export function typeFromName(name: 'gpointer'): typeof TYPE_POINTER
+export function typeFromName(name: 'GBoxed'): typeof TYPE_BOXED
+export function typeFromName(name: 'GParam'): typeof TYPE_PARAM
+export function typeFromName(name: 'GObject'): typeof TYPE_OBJECT
+export function typeFromName(name: 'GType'): typeof TYPE_GTYPE
+export function typeFromName(name: 'GVariant'): typeof TYPE_VARIANT

package/templates/node-gtk/index.d.ts

@@ -0,0 +1,40 @@
+/* eslint-disable @typescript-eslint/triple-slash-reference */
+
+/*
+ * Type Definitions for node-gtk (https://github.com/romgrk/node-gtk)
+ *
+ * These type definitions are automatically generated, do not edit them by hand.
+ * If you found a bug fix it in <%= APP_NAME %> itself or create a bug report on <%= APP_SOURCE %>
+ */
+
+<%_ for (const girModule of girModules) { _%>
+    <%_ if (buildType === 'lib') { _%>
+        <% if(useNamespace){ %>
+import type <%= girModule.importName %> from "./<%= girModule.packageName %>.js";
+        <% } else { %>  
+import type * as <%= girModule.importName %> from './<%= girModule.packageName %>.js';
+        <% } %>
+    <%_ } else if (buildType === 'types') { _%>
+import type <%= girModule.importName %> from "./<%= girModule.packageName %>.js";
+    <%_ } _%>
+<%_ } _%>
+
+<%_ if (buildType === 'types') { _%>
+declare module 'node-gtk' {
+<%_ } _%>
+    export function require(ns: string, ver?: string): any;
+    <%_ for (const girModule of girModules) { _%>
+    export function require(ns: '<%= girModule.namespace %>', ver: '<%= girModule.version %>'): typeof <%= girModule.importName %>;
+    <%_ } _%>
+    export function startLoop(): void;
+    export function registerClass(object: any): void
+
+    declare const gi: {
+        require: typeof require,
+        startLoop: typeof startLoop,
+        registerClass: typeof registerClass,
+    }
+    export default gi
+<%_ if (buildType === 'types') { _%>
+}
+<%_ } _%>

package/templates/node-gtk/index.js

@@ -0,0 +1,9 @@
+<% if(moduleType === 'esm'){ %>
+    import * as gi from 'node-gtk';
+    export { gi };
+    export default gi;
+<% } else { %>  
+    const gi = require('node-gtk');
+    module.exports = gi;
+    exports.default = gi;
+<% } %>

package/templates/node-gtk/module.d.ts

@@ -0,0 +1,10 @@
+<% if (noCheck) { -%>
+// @ts-nocheck
+<% } -%>
+
+/*
+ * Type Definitions for node-gtk (https://github.com/romgrk/node-gtk)
+ *
+ * These type definitions are automatically generated, do not edit them by hand.
+ * If you found a bug fix it in <%= APP_NAME %> itself or create a bug report on <%= APP_SOURCE %>
+ */

package/templates/node-gtk/module.js

@@ -0,0 +1,17 @@
+<% if(moduleType === 'esm'){ %>
+    import { require as giRequire } from 'node-gtk';
+    const <%= name %> = giRequire('<%= name %>', '<%= version %>');
+    export { <%= name %> };
+    export default <%= name %>;
+<% } else { %>  
+    const { require: giRequire } = require('node-gtk');
+    const <%= name %> = giRequire('<%= name %>', '<%= version %>');
+    <% if(useNamespace){ %>
+        module.exports = { <%= name %> };
+        exports.default = <%= name %>;
+    <% } else { %>  
+        module.exports = <%= name %>;
+    <% } %>
+<% } %>
+
+