@ts-for-gir/lib 3.0.0-beta.11

package/templates/Gjs/misc/extensionUtils.d.ts

@@ -0,0 +1,99 @@
+// https://gitlab.gnome.org/GNOME/gnome-shell/blob/main/js/misc/extensionUtils.js
+
+// TODO: untested
+export interface Extension {
+    type: ExtensionType;
+    state: ExtensionState;
+    path: string;
+    error: string | null;
+    hasPrefs: boolean;
+    hasUpdate: boolean;
+    canChange: boolean;
+}
+
+export enum ExtensionType {
+    SYSTEM = 1,
+    PER_USER = 2,
+}
+
+export enum ExtensionState {
+    ENABLED = 1,
+    DISABLED = 2,
+    ERROR = 3,
+    OUT_OF_DATE = 4,
+    DOWNLOADING = 5,
+    INITIALIZED = 6,
+    DISABLING = 7,
+    ENABLING = 8,
+    UNINSTALLED = 99,
+}
+
+declare const SERIALIZED_PROPERTIES: string[];
+
+/**
+ * Get current extension
+ * @param extension the extension object to use in utilities like `initTranslations()`
+ */
+export function setCurrentExtension(extension: Extension): void;
+
+/**
+ * @returns The current extension, or null if not called from an extension.
+ */
+export function getCurrentExtension(): Extension | null;
+
+/**
+ * Init translation
+ * @param domain the gettext domain to use
+ * 
+ * Initialize Gettext to load translations from extensionsdir/locale.
+ * If @domain is not provided, it will be taken from metadata['gettext-domain']
+ */
+export function initTranslations(domain: string): void;
+
+/**
+ * gettext:
+ * @param str the string to translate
+ * 
+ * Translate @str using the extension's gettext domain
+ *
+ * @returns the translated string
+ */
+export function gettext(str: string): string;
+
+/**
+ * ngettext:
+ * @param str the string to translate
+ * @param strPlural the plural form of the string
+ * @param n the quantity for which translation is needed
+ * 
+ * Translate @str and choose plural form using the extension's gettext domain
+ * 
+ * @returns the translated string
+ */
+export function ngettext(str: string, strPlural: string, n: number): string;
+
+/**
+ * pgettext:
+ * @param context context to disambiguate @str
+ * @param str the string to translate
+ * 
+ * Translate @str in the context of @context using the extension's gettext domain
+ * 
+ * @returns the translated string
+ */
+export function pgettext(context: string, str: string): string;
+
+/**
+ * openPrefs:
+ * 
+ * Open the preference dialog of the current extension
+ */
+export function openPrefs(): void;
+
+export function isOutOfDate(extension: Extension): boolean;
+
+export function installImporter(extension: Extension): void;
+
+export function serializeExtension(extension: Extension): object;
+
+export function deserializeExtension(data: object): Extension;

package/templates/Gjs/misc/extensionUtils.js

@@ -0,0 +1,6 @@
+<% if(moduleType === 'esm') { %>
+    export imports.misc.extensionUtils;
+<% } else { %>  
+    module.exports = imports.misc.extensionUtils;
+<% } %>
+  

package/templates/Gjs/misc/fileUtils.d.ts

@@ -0,0 +1,51 @@
+// https://gitlab.gnome.org/GNOME/gnome-shell/-/blob/main/js/misc/fileUtils.js
+
+<% const Gio = dep.find('Gio') %>
+
+<%_ if(noNamespace){ _%>
+    import type * as Gio from '../<%= Gio.packageName %>.js';
+<%_ } else { _%>
+    import type Gio from '../<%= Gio.packageName %>.js';
+<%_ } _%>
+
+export interface SubdirInfo {
+    dir: Gio.File
+    info: Gio.FileInfo
+}
+
+/**
+ * Collects all subdirectories named `subdir` within the system data directories and (optionally) the user's data directory
+ *
+ * @param {string} subdir - the subdirectory to search within the data directories
+ * @param {boolean} includeUserDir - whether the user's data directory should also be searched in addition to the system data directories
+ * @returns {IterableIterator<SubdirInfo>} - a generator which yields file info for subdirectories named `subdir` within data directories
+ */
+export function collectFromDatadirs(subdir: string, includeUserDir: boolean): IterableIterator<SubdirInfo>
+
+/**
+ * Recursively delete a directory and its contents
+ *
+ * @param {Gio.File} dir - the file object for the directory to delete
+ * @param {boolean} deleteParent - whether to delete the parent directory
+ */
+export function recursivelyDeleteDir(dir: Gio.File, deleteParent: boolean): void
+
+/**
+ * Recursively move a directory and its contents
+ *
+ * @param {Gio.File} srcDir - the file object for the directory to move
+ * @param {Gio.File} destDir - the file object for the destination directory
+ */
+export function recursivelyMoveDir(srcDir: Gio.File, destDir: Gio.File): void
+
+/**
+ * Load an interface xml file
+ * @param {string} name - the name of the interface file to load
+*/
+export var loadInterfaceXML: (name: string) => any
+
+/**
+ * Load an subinterface xml file
+ * @param {string} name - the name of the subinterface file to load
+*/
+export function loadSubInterfaceXML(name: string): any

package/templates/Gjs/misc/fileUtils.js

@@ -0,0 +1,6 @@
+<% if(moduleType === 'esm') { %>
+    export imports.misc.fileUtils;
+<% } else { %>  
+    module.exports = imports.misc.fileUtils;
+<% } %>
+  

package/templates/Gjs/misc/gnomeSession.d.ts

@@ -0,0 +1,74 @@
+// https://gitlab.gnome.org/GNOME/gnome-shell/-/blob/main/js/misc/gnomeSession.js
+
+<% const Gio = dep.find('Gio') %>
+
+<%_ if(noNamespace){ _%>
+    import type * as Gio from '../<%= Gio.packageName %>.js';
+<%_ } else { _%>
+    import type Gio from '../<%= Gio.packageName %>.js';
+<%_ } _%>
+
+/**
+ * Enumeration of the possible presence statuses
+ */
+export enum PresenceStatus {
+    AVAILABLE = 0,
+    INVISIBLE = 1,
+    BUSY = 2,
+    IDLE = 3,
+}
+
+export enum InhibitFlags {
+    LOGOUT = 1 << 0,
+    SWITCH = 1 << 1,
+    SUSPEND = 1 << 2,
+    IDLE = 1 << 3,
+    AUTOMOUNT = 1 << 4,
+}
+
+/**
+ * The interface of `org.gnome.SessionManager.Presence`
+ * TODO: Untested
+ */
+interface PresenceIface {
+    // TODO: `org.gnome.SessionManager.Presence`
+}
+
+/**
+ * Create a new DBus proxy for the presence interface
+ * @param {Function | null} initCallback - a callback to call when the proxy is ready
+ * @param {Gio.Cancellable | null} cancellable - a cancellable
+ * @returns {Gio.DBusProxy & PresenceIface} - a new DBus proxy for the presence interface
+ */
+export function Presence(initCallback: Function | null, cancellable: Gio.Cancellable | null): Gio.DBusProxy & PresenceIface;
+
+/**
+ * THe interface of `org.gnome.SessionManager.Inhibitor`
+ * Representation of the DBus interface for the inhibitor, which is used to prevent the session from being closed
+ * TODO: Untested
+ */
+interface InhibitorIface {
+    // TODO: `org.gnome.SessionManager.Inhibitor`
+}
+
+/**
+ * Create a new DBus proxy for the inhibitor interface
+ * 
+ * Note inhibitors are immutable objects, so they don't
+ * change at runtime (changes always come in the form
+ * of new inhibitors)
+ * @param objectPath 
+ * @param initCallback 
+ * @param cancellable 
+ */
+export function Inhibitor(objectPath: string, initCallback: Function | null, cancellable: Gio.Cancellable | null): Gio.DBusProxy & InhibitorIface;
+
+
+/**
+ * The interface of `org.gnome.SessionManager`
+ */
+interface SessionManagerIface {
+    // TODO: `org.gnome.SessionManager`
+}
+
+export function SessionManager(initCallback: Function | null, cancellable: Gio.Cancellable | null): Gio.DBusProxy & SessionManagerIface;

package/templates/Gjs/misc/gnomeSession.js

@@ -0,0 +1,6 @@
+<% if(moduleType === 'esm') { %>
+    export imports.misc.gnomeSession;
+<% } else { %>  
+    module.exports = imports.misc.gnomeSession;
+<% } %>
+  

package/templates/Gjs/misc/parentalControlsManager.d.ts

@@ -0,0 +1,42 @@
+// https://gitlab.gnome.org/GNOME/gnome-shell/-/blob/main/js/misc/parentalControlsManager.js
+
+<% const GObject = dep.find('GObject') %>
+<% const Gio = dep.find('Gio') %>
+<% const Shell = dep.find('Shell') %>
+
+<%_ if(noNamespace){ _%>
+    import type * as GObject from '../<%= GObject.packageName %>.js';
+    import type * as Gio from '../<%= Gio.packageName %>.js';
+    import type * as Shell from '../<%= Shell.packageName %>.js';
+<%_ } else { _%>
+    import type GObject from '../<%= GObject.packageName %>.js';
+    import type Gio from '../<%= Gio.packageName %>.js';
+    import type Shell from '../<%= Shell.packageName %>.js';
+<%_ } _%>
+
+declare class ParentalControlsManager extends GObject.Object {
+
+    protected _initialized: boolean;
+    public readonly initialized: boolean;
+
+    constructor();
+    public _init(): void;
+
+    _initializeManager(): Promise<void>;
+    _onAppFilterChanged(manager: any, uid: ReturnType<typeof Shell.util_get_uid>): void;
+
+    /**
+     * Calculate whether the given app (a Gio.DesktopAppInfo) should be shown
+     * on the desktop, in search results, etc. The app should be shown if:
+     *  - The .desktop file doesn’t say it should be hidden.
+     *  - The executable from the .desktop file’s Exec line isn’t denied in
+     *    the user’s parental controls.
+     *  - None of the flatpak app IDs from the X-Flatpak and the
+     *    X-Flatpak-RenamedFrom lines are denied in the user’s parental
+     *    controls.
+     * @param appInfo The app to check
+     */
+    shouldShowApp(appInfo: Gio.DesktopAppInfo): boolean;
+}
+
+export function getDefault(): ParentalControlsManager;

package/templates/Gjs/misc/parentalControlsManager.js

@@ -0,0 +1,6 @@
+<% if(moduleType === 'esm') { %>
+    export imports.misc.parentalControlsManager;
+<% } else { %>  
+    module.exports = imports.misc.parentalControlsManager;
+<% } %>
+  

package/templates/Gjs/misc/signals.d.ts

@@ -0,0 +1,15 @@
+// https://gitlab.gnome.org/GNOME/gnome-shell/-/blob/main/js/misc/signals.js
+
+import type { Signals } from '../Gjs.js';
+
+export interface EventEmitter extends Signals.Methods {}
+
+export class EventEmitter {
+    connectObject(...args: any[]): number // TODO: return type is return type of imports.misc.signalTracker.connectObject
+
+    disconnectObject(...args: any[]): number // TODO: return type is return type of imports.misc.signalTracker.disconnectObject
+
+    connect_object(...args: any[]): ReturnType<typeof this.connectObject>
+
+    disconnect_object(...args: any[]): ReturnType<typeof this.disconnectObject>
+}

package/templates/Gjs/misc/signals.js

@@ -0,0 +1,6 @@
+<% if(moduleType === 'esm') { %>
+    export imports.misc.signals;
+<% } else { %>  
+    module.exports = imports.misc.signals;
+<% } %>
+  

package/templates/Gjs/module.d.ts

@@ -0,0 +1,6 @@
+/*
+ * 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(!noNamespace){ %>
+module.exports = { <%= name %> };
+exports.default = <%= name %>;
+  <% } else { %>
+module.exports = <%= name %>;
+  <% } %>
+<% } %>
+

package/templates/Gjs/tsconfig.alias.json

@@ -0,0 +1,10 @@
+{
+    "compilerOptions": {   
+        "baseUrl": ".",
+        "paths": { <% girModules.forEach(function(module, idx) { %>
+            "gi://<%= module.namespace %>?version=<%= module.version %>": ["<%= typeDir %>/<%= module.namespace %>-<%= module.version %>.d.ts"],
+            "gi://<%= module.namespace %>": ["<%= typeDir %>/<%= module.namespace %>-<%= module.version %>.d.ts"]<% if (idx < girModules.length - 1) { %>,<% } %><% }); %>
+        }
+    },
+    "include": ["<%= typeDir %>/*.ts"]
+}

package/templates/Gjs/ui/accessDialog.d.ts

@@ -0,0 +1,19 @@
+// https://gitlab.gnome.org/GNOME/gnome-shell/-/blob/main/js/ui/accessDialog.js
+
+export namespace AccessDialogDBus {
+    export interface AccessDialogAsyncParams {
+        handle: string;
+        appId: string;
+        parentWindow_: any;
+        title: string;
+        description: string;
+        body: any;
+        options: any;
+    }
+}
+
+export class AccessDialogDBus {
+    constructor();
+
+    AccessDialogAsync(params: AccessDialogDBus.AccessDialogAsyncParams, invocation: any): void;
+}

package/templates/Gjs/ui/accessDialog.js

@@ -0,0 +1,6 @@
+<% if(moduleType === 'esm') { %>
+    export imports.ui.accessDialog;
+<% } else { %>  
+    module.exports = imports.ui.accessDialog;
+<% } %>
+  

package/templates/Gjs/ui/altTab.d.ts

@@ -0,0 +1,124 @@
+// https://gitlab.gnome.org/GNOME/gnome-shell/-/blob/main/js/ui/altTab.js
+
+<% const glib = dep.find('GLib') %>
+<% const Clutter = dep.find('Clutter') %>
+<% const Meta = dep.find('Meta') %>
+
+<%_ if(noNamespace){ _%>
+    import type * as GLib from '../<%= glib.packageName %>.js';
+    import type * as Clutter from '../<%= Clutter.packageName %>.js';
+    import type * as Meta from '../<%= Meta.packageName %>.js';
+<%_ } else { _%>
+    import type GLib from '../<%= glib.packageName %>.js';
+    import type Clutter from '../<%= Clutter.packageName %>.js';
+    import type Meta from '../<%= Meta.packageName %>.js';
+<%_ } _%>
+
+import { SwitcherPopup } from './switcherPopup.js'
+
+export class AppSwitcherPopup extends SwitcherPopup {
+    constructor()
+    _init(): void
+
+    _initialSelection(backward: any, binding: any): void
+
+    _nextWindow(): void
+
+    _previousWindow(): void
+
+    _closeAppWindow(appIndex: number, windowIndex: number): void
+
+    _quitApplication(appIndex: number): void
+
+    _keyPressHandler(keysym: any, action: any): typeof Clutter.EVENT_STOP | typeof Clutter.EVENT_PROPAGATE
+
+    _scrollHandler(direction: Clutter.ScrollDirection): void;
+
+    _itemActivatedHandler(n: any): void
+
+    _windowActivated(thumbnailSwitcher: any, n: any): void
+
+    _windowEntered(thumbnailSwitcher: any, n: any): void
+
+    _windowRemoved(thumbnailSwitcher: any, n: number): void
+
+    _finish(timestamp: number): void
+
+    _onDestroy(): void
+
+    /**
+     * _select:
+     * @param app: index of the app to select
+     * @param window: index of which of @app's windows to select
+     * @param forceAppFocus: optional flag, see below
+     *
+     * Selects the indicated @app, and optional @window, and sets
+     * this._thumbnailsFocused appropriately to indicate whether the
+     * arrow keys should act on the app list or the thumbnail list.
+     *
+     * If @app is specified and @window is unspecified or %null, then
+     * the app is highlighted (ie, given a light background), and the
+     * current thumbnail list, if any, is destroyed. If @app has
+     * multiple windows, and @forceAppFocus is not %true, then a
+     * timeout is started to open a thumbnail list.
+     *
+     * If @app and @window are specified (and @forceAppFocus is not),
+     * then @app will be outlined, a thumbnail list will be created
+     * and focused (if it hasn't been already), and the @window'th
+     * window in it will be highlighted.
+     *
+     * If @app and @window are specified and @forceAppFocus is %true,
+     * then @app will be highlighted, and @window outlined, and the
+     * app list will have the keyboard focus.
+     */
+    _select(app: number, window?: number, forceAppFocus?: undefined): void
+
+    _timeoutPopupThumbnails(): typeof GLib.SOURCE_REMOVE | typeof GLib.SOURCE_CONTINUE
+
+    _destroyThumbnails(): void
+
+    _createThumbnails(): void
+
+}
+
+declare class CyclerPopup extends SwitcherPopup {
+    constructor()
+    _init(): void
+
+    _highlightItem(index: number, _justOutline: boolean): void
+
+    _finish(): void
+
+    onDestroy(): void
+}
+
+export class GroupCyclerPopup extends CyclerPopup {
+    constructor()
+    _init(): void
+
+    _getWindows(): Meta.Window[]
+
+    _keyPressHandler(keysym: any, action: any): typeof Clutter.EVENT_STOP | typeof Clutter.EVENT_PROPAGATE
+}
+
+export class WindowSwitcherPopup extends SwitcherPopup {
+    constructor()
+    _init(): void
+
+    _getWindowList(): Meta.Window[]
+
+    _closeWindow(windowIndex: number): void
+
+    _keyPressHandler(keysym: any, action: any): typeof Clutter.EVENT_STOP | typeof Clutter.EVENT_PROPAGATE
+
+    _finish(): void
+
+}
+
+export class WindowCyclerPopup extends CyclerPopup {
+    init(): void
+
+    _getWindows(): Meta.Window[]
+
+    _keyPressHandler(keysym: any, action: any): typeof Clutter.EVENT_STOP | typeof Clutter.EVENT_PROPAGATE
+}

package/templates/Gjs/ui/altTab.js

@@ -0,0 +1,6 @@
+<% if(moduleType === 'esm') { %>
+    export imports.ui.altTab;
+<% } else { %>  
+    module.exports = imports.ui.altTab;
+<% } %>
+  

package/templates/Gjs/ui/animation.d.ts

@@ -0,0 +1,58 @@
+// https://gitlab.gnome.org/GNOME/gnome-shell/-/blob/main/js/ui/animation.js
+
+<% const glib = dep.find('GLib') %>
+<% const Gio = dep.find('Gio') %>
+<% const St = dep.find('St') %>
+
+<%_ if(noNamespace){ _%>
+    import type * as GLib from '../<%= glib.packageName %>.js';
+    import type * as Gio from '../<%= Gio.packageName %>.js';
+    import type * as St from '../<%= St.packageName %>.js';
+<%_ } else { _%>
+    import type GLib from '../<%= glib.packageName %>.js';
+    import type Gio from '../<%= Gio.packageName %>.js';
+    import type St from '../<%= St.packageName %>.js';
+<%_ } _%>
+
+export class Animation extends St.Bin {
+    constructor(file: Gio.File, width: number, height: number, speed: number);
+    
+    /** @hidden */
+    public _init(props?: St.Bin.ConstructorProperties): void;
+    public _init(file: Gio.File, width: number, height: number, speed: number): void;
+
+    public play(): void;
+    public stop(): void;
+
+    protected _loadFile(file: Gio.File, width: number, height: number): void;
+    protected _showFrame(frame: number): void;
+    protected _update(): typeof GLib.SOURCE_CONTINUE;
+    protected _syncAnimationSize(): void;
+    protected _animationsLoaded(): void;
+    protected _onDestroy(): void;
+}
+
+export class AnimatedIcon extends Animation {
+    constructor(file: Gio.File, size: number);
+    /** @hidden */
+    public _init(props?: St.Bin.ConstructorProperties): void;
+    /** @hidden */
+    public _init(file: Gio.File, width: number, height: number, speed: number): void;
+    public _init(file: Gio.File, size: number): void;
+}
+
+export class Spinner extends AnimatedIcon {
+    constructor(size: number, params: {animate: boolean; hideOnStop: boolean});
+    /** @hidden */
+    public _init(props?: St.Bin.ConstructorProperties): void;
+    /** @hidden */
+    public _init(file: Gio.File, width: number, height: number, speed: number): void;
+    /** @hidden */
+    public _init(file: Gio.File, size: number): void;
+    public _init(size: number, params: {animate: boolean; hideOnStop: boolean}): void;
+
+    public play(): void;
+    public stop(): void;
+
+    protected _onDestroy(): void;
+}

package/templates/Gjs/ui/animation.js

@@ -0,0 +1,6 @@
+<% if(moduleType === 'esm') { %>
+    export imports.ui.animation;
+<% } else { %>  
+    module.exports = imports.ui.animation;
+<% } %>
+