@girs/gtksessionlock-0.1 0.1.0-4.0.0-beta.41

package/README.md

@@ -0,0 +1,85 @@
+
+# GtkSessionLock-0.1
+
+![version](https://img.shields.io/npm/v/@girs/gtksessionlock-0.1)
+![downloads/week](https://img.shields.io/npm/dw/@girs/gtksessionlock-0.1)
+
+
+GJS TypeScript type definitions for GtkSessionLock-0.1, generated from library version 0.1.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.41.
+
+## Install
+
+To use this type definitions, install them with NPM:
+```bash
+npm install @girs/gtksessionlock-0.1
+```
+
+## Usage
+
+You can import this package into your project like this:
+```ts
+import GtkSessionLock from '@girs/gtksessionlock-0.1';
+```
+
+### Ambient Modules
+
+You can also use [ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules) to import this module like you would do this in JavaScript.
+For this you need to include `@girs/gtksessionlock-0.1` or `@girs/gtksessionlock-0.1/ambient` in your `tsconfig` or entry point Typescript file:
+
+`index.ts`:
+```ts
+import '@girs/gtksessionlock-0.1'
+```
+
+`tsconfig.json`:
+```json
+{
+  "compilerOptions": {
+    ...
+  },
+  "include": ["@girs/gtksessionlock-0.1"],
+  ...
+}
+```
+
+Now you can import the ambient module with TypeScript support: 
+
+```ts
+import GtkSessionLock from 'gi://GtkSessionLock?version=0.1';
+```
+
+### Global import
+
+You can also import the module with Typescript support using the global `imports.gi` object of GJS.
+For this you need to include `@girs/gtksessionlock-0.1` or `@girs/gtksessionlock-0.1/import` in your `tsconfig` or entry point Typescript file:
+
+`index.ts`:
+```ts
+import '@girs/gtksessionlock-0.1'
+```
+
+`tsconfig.json`:
+```json
+{
+  "compilerOptions": {
+    ...
+  },
+  "include": ["@girs/gtksessionlock-0.1"],
+  ...
+}
+```
+
+Now you have also type support for this, too:
+
+```ts
+const GtkSessionLock = imports.gi.GtkSessionLock;
+```
+
+### Bundle
+
+Depending on your project configuration, it is recommended to use a bundler like [esbuild](https://esbuild.github.io/). You can find examples using different bundlers [here](https://github.com/gjsify/ts-for-gir/tree/main/examples).
+
+## Other packages
+
+All existing pre-generated packages can be found on [gjsify/types](https://github.com/gjsify/types).
+

package/gtksessionlock-0.1-ambient.d.ts

@@ -0,0 +1,9 @@
+declare module 'gi://GtkSessionLock?version=0.1' {
+    import GtkSessionLock01 from '@girs/gtksessionlock-0.1';
+    export default GtkSessionLock01;
+}
+
+declare module 'gi://GtkSessionLock' {
+    import GtkSessionLock01 from 'gi://GtkSessionLock?version=0.1';
+    export default GtkSessionLock01;
+}

package/gtksessionlock-0.1-ambient.js

@@ -0,0 +1,2 @@
+export {}
+

package/gtksessionlock-0.1-import.d.ts

@@ -0,0 +1,9 @@
+import type GtkSessionLock01 from '@girs/gtksessionlock-0.1';
+
+declare global {
+    export interface GjsGiImports {
+        GtkSessionLock: typeof GtkSessionLock01;
+    }
+}
+
+export default GjsGiImports;

package/gtksessionlock-0.1-import.js

@@ -0,0 +1,3 @@
+const gi = globalThis.imports?.gi || {};
+export default gi;
+

package/gtksessionlock-0.1.d.ts

@@ -0,0 +1,212 @@
+/**
+ * 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
+ *
+ * The based EJS template file is used for the generated .d.ts file of each GIR module like Gtk-4.0, GObject-2.0, ...
+ */
+
+import '@girs/gjs';
+
+// Module dependencies
+import type Gtk from '@girs/gtk-3.0';
+import type xlib from '@girs/xlib-2.0';
+import type Gdk from '@girs/gdk-3.0';
+import type cairo from 'cairo';
+import type GObject from '@girs/gobject-2.0';
+import type GLib from '@girs/glib-2.0';
+import type Pango from '@girs/pango-1.0';
+import type HarfBuzz from '@girs/harfbuzz-0.0';
+import type freetype2 from '@girs/freetype2-2.0';
+import type Gio from '@girs/gio-2.0';
+import type GModule from '@girs/gmodule-2.0';
+import type GdkPixbuf from '@girs/gdkpixbuf-2.0';
+import type Atk from '@girs/atk-1.0';
+
+export namespace GtkSessionLock {
+    /**
+     * GtkSessionLock-0.1
+     */
+
+    /**
+     * @param window A lock surface.
+     * @returns The underlying lock surface Wayland object
+     */
+    function get_ext_session_lock_surface_v1(window: Gtk.Window): any | null;
+    /**
+     * @returns the major version number of the GTK Session Lock library
+     */
+    function get_major_version(): number;
+    /**
+     * @returns the micro/patch version number of the GTK Session Lock library
+     */
+    function get_micro_version(): number;
+    /**
+     * @returns the minor version number of the GTK Session Lock library
+     */
+    function get_minor_version(): number;
+    /**
+     * May block for a Wayland roundtrip the first time it's called.
+     * @returns version of the ext_session_lock_v1 protocol supported by the compositor or 0 if the protocol is not supported.
+     */
+    function get_protocol_version(): number;
+    /**
+     * @param window A {@link Gtk.Window} that may or may not have a lock surface.
+     * @returns if `window` has been initialized as a lock surface.
+     */
+    function is_lock_window(window: Gtk.Window): boolean;
+    /**
+     * May block for a Wayland roundtrip the first time it's called.
+     * @returns `true` if the platform is Wayland and Wayland compositor supports the ext_session_lock_v1 protocol.
+     */
+    function is_supported(): boolean;
+    /**
+     * Prepare a new `SessionLockLock`. You should connect signals to it before
+     * calling its lock method.
+     * @returns A new `SessionLockLock`.
+     */
+    function prepare_lock(): Lock;
+    /**
+     * If the given window is a lock window, unmap the surface. This must be called
+     * before the window is unmapped (e.g. hidden).
+     * @param window
+     * @since 0.2
+     */
+    function unmap_lock_window(window: Gtk.Window): void;
+    namespace Lock {
+        // Signal signatures
+        interface SignalSignatures extends GObject.Object.SignalSignatures {
+            /**
+             * @signal
+             * @run-first
+             */
+            finished: () => void;
+            /**
+             * @signal
+             * @run-first
+             */
+            locked: () => void;
+            'notify::lock-manager': (pspec: GObject.ParamSpec) => void;
+            'notify::lock-obj': (pspec: GObject.ParamSpec) => void;
+        }
+
+        // Constructor properties interface
+
+        interface ConstructorProps extends GObject.Object.ConstructorProps {
+            lock_manager: any;
+            lockManager: any;
+            lock_obj: any;
+            lockObj: any;
+        }
+    }
+
+    /**
+     * @gir-type Class
+     */
+    class Lock extends GObject.Object {
+        static $gtype: GObject.GType<Lock>;
+
+        // Properties
+
+        /**
+         * @construct-only
+         */
+        get lock_manager(): any;
+        /**
+         * @construct-only
+         */
+        get lockManager(): any;
+        get lock_obj(): any;
+        set lock_obj(val: any);
+        get lockObj(): any;
+        set lockObj(val: any);
+
+        /**
+         * Compile-time signal type information.
+         *
+         * This instance property is generated only for TypeScript type checking.
+         * It is not defined at runtime and should not be accessed in JS code.
+         * @internal
+         */
+        $signals: Lock.SignalSignatures;
+
+        // Constructors
+
+        constructor(properties?: Partial<Lock.ConstructorProps>, ...args: any[]);
+
+        _init(...args: any[]): void;
+
+        // Signals
+
+        /** @signal */
+        connect<K extends keyof Lock.SignalSignatures>(
+            signal: K,
+            callback: GObject.SignalCallback<this, Lock.SignalSignatures[K]>,
+        ): number;
+        connect(signal: string, callback: (...args: any[]) => any): number;
+        /** @signal */
+        connect_after<K extends keyof Lock.SignalSignatures>(
+            signal: K,
+            callback: GObject.SignalCallback<this, Lock.SignalSignatures[K]>,
+        ): number;
+        connect_after(signal: string, callback: (...args: any[]) => any): number;
+        /** @signal */
+        emit<K extends keyof Lock.SignalSignatures>(
+            signal: K,
+            ...args: GObject.GjsParameters<Lock.SignalSignatures[K]> extends [any, ...infer Q] ? Q : never
+        ): void;
+        emit(signal: string, ...args: any[]): void;
+
+        // Methods
+
+        /**
+         * Destory an inactive lock object. You should call this method only after
+         * receiving the finished signal.
+         */
+        destroy(): void;
+        /**
+         * Actually perform the locking operation. This should be run after connecting
+         * to this object's signals.
+         *
+         * The compositor will hide all surfaces except those created via the
+         * `gtk_session_lock_lock_new_surface` method.
+         */
+        lock_lock(): void;
+        /**
+         * This method must be called after gtk_session_lock_lock_lock. If the session
+         * is locked successfully, the specified window will be shown on the given
+         * monitor. You must only ever call this method once for a given lock and
+         * monitor. The window will automatically be stretched to cover the entire
+         * screen.
+         * @param gtk_window
+         * @param monitor
+         */
+        new_surface(gtk_window: Gtk.Window, monitor: Gdk.Monitor): void;
+        /**
+         * Unlock an active session lock and dispose of it. It cannot be reused.
+         * You should generally call this method only after verifying a user's
+         * identity.
+         */
+        unlock_and_destroy(): void;
+    }
+
+    /**
+     * @gir-type Alias
+     */
+    type LockClass = typeof Lock;
+    /**
+     * Name of the imported GIR library
+     * `see` https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L188
+     */
+    const __name__: string;
+    /**
+     * Version of the imported GIR library
+     * `see` https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L189
+     */
+    const __version__: string;
+}
+
+export default GtkSessionLock;
+
+// END

package/gtksessionlock-0.1.js

@@ -0,0 +1,5 @@
+
+// @ts-expect-error
+import GtkSessionLock from 'gi://GtkSessionLock?version=0.1';
+export default GtkSessionLock;
+

package/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 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 './gtksessionlock-0.1-ambient.d.ts';
+
+import './gtksessionlock-0.1-import.d.ts';
+
+import GtkSessionLock from './gtksessionlock-0.1.js';
+export default GtkSessionLock;

package/index.js

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

package/package.json

@@ -0,0 +1,64 @@
+{
+    "name": "@girs/gtksessionlock-0.1",
+    "version": "0.1.0-4.0.0-beta.41",
+    "description": "GJS TypeScript type definitions for GtkSessionLock-0.1, generated from library version 0.1.0",
+    "type": "module",
+    "module": "gtksessionlock-0.1.js",
+    "main": "gtksessionlock-0.1.js",
+    "exports": {
+      "./ambient": {
+        "types": "./gtksessionlock-0.1-ambient.d.ts",
+        "import": "./gtksessionlock-0.1-ambient.js",
+        "default": "./gtksessionlock-0.1-ambient.js"
+      },
+      "./import": {
+        "types": "./gtksessionlock-0.1-import.d.ts",
+        "import": "./gtksessionlock-0.1-import.js",
+        "default": "./gtksessionlock-0.1-import.js"
+      },
+      "./gtksessionlock-0.1": {
+        "types": "./gtksessionlock-0.1.d.ts",
+        "import": "./gtksessionlock-0.1.js",
+        "default": "./gtksessionlock-0.1.js"
+      },
+      ".": {
+        "types": "./index.d.ts",
+        "import": "./index.js",
+        "default": "./index.js"
+      }
+    },
+    "scripts": {
+      "test": "tsc --project tsconfig.json"
+    },
+    "dependencies": {
+      "@girs/gjs": "4.0.0-beta.41",
+      "@girs/gtk-3.0": "3.24.51-4.0.0-beta.41",
+      "@girs/xlib-2.0": "2.0.0-4.0.0-beta.41",
+      "@girs/gdk-3.0": "3.24.51-4.0.0-beta.41",
+      "@girs/cairo-1.0": "1.0.0-4.0.0-beta.41",
+      "@girs/gobject-2.0": "2.88.0-4.0.0-beta.41",
+      "@girs/glib-2.0": "2.88.0-4.0.0-beta.41",
+      "@girs/pango-1.0": "1.57.0-4.0.0-beta.41",
+      "@girs/harfbuzz-0.0": "12.3.2-4.0.0-beta.41",
+      "@girs/freetype2-2.0": "2.0.0-4.0.0-beta.41",
+      "@girs/gio-2.0": "2.88.0-4.0.0-beta.41",
+      "@girs/gmodule-2.0": "2.0.0-4.0.0-beta.41",
+      "@girs/gdkpixbuf-2.0": "2.0.0-4.0.0-beta.41",
+      "@girs/atk-1.0": "2.60.0-4.0.0-beta.41"    },
+    "devDependencies": {
+      "typescript": "*"
+    },
+    "keywords": ["Gir", "TypeScript", "types", "GObject-Introspection", "GJS", "GtkSessionLock-0.1"],
+    "author": "ts-for-gir",
+    "license": "MIT",
+    "repository": {
+      "type": "git",
+      "url": "git+https://github.com/gjsify/types.git"
+    },
+    "bugs": {
+      "url": "https://github.com/gjsify/ts-for-gir/issues"
+    },
+    "homepage": "https://github.com/gjsify/types/tree/main/gtksessionlock-0.1#readme"
+}
+
+

package/tsconfig.json

@@ -0,0 +1,69 @@
+{
+  "compilerOptions": {
+    // General settings for code interpretation
+    "target": "ESNext",
+    "module": "NodeNext",
+    "lib": ["ESNext"],
+    "types": [],
+    "experimentalDecorators": true,
+    "moduleResolution": "NodeNext",
+    "noEmit": true,
+    "noEmitOnError": false,
+    "baseUrl": "./",
+    "rootDir": ".",
+    // General settings for code generation
+    "removeComments": false,
+    "inlineSourceMap": false,
+    "inlineSources": false,
+    "newLine": "LF",
+    // Show diagnostics
+    "diagnostics": true,
+    "paths": {
+      "@girs/gtk-3.0": [
+            "../gtk-3.0/index.d.ts"
+      ],
+      "@girs/xlib-2.0": [
+            "../xlib-2.0/index.d.ts"
+      ],
+      "@girs/gdk-3.0": [
+            "../gdk-3.0/index.d.ts"
+      ],
+      "@girs/cairo-1.0": [
+            "../cairo-1.0/index.d.ts"
+      ],
+      "@girs/gobject-2.0": [
+            "../gobject-2.0/index.d.ts"
+      ],
+      "@girs/glib-2.0": [
+            "../glib-2.0/index.d.ts"
+      ],
+      "@girs/pango-1.0": [
+            "../pango-1.0/index.d.ts"
+      ],
+      "@girs/harfbuzz-0.0": [
+            "../harfbuzz-0.0/index.d.ts"
+      ],
+      "@girs/freetype2-2.0": [
+            "../freetype2-2.0/index.d.ts"
+      ],
+      "@girs/gio-2.0": [
+            "../gio-2.0/index.d.ts"
+      ],
+      "@girs/gmodule-2.0": [
+            "../gmodule-2.0/index.d.ts"
+      ],
+      "@girs/gdkpixbuf-2.0": [
+            "../gdkpixbuf-2.0/index.d.ts"
+      ],
+      "@girs/atk-1.0": [
+            "../atk-1.0/index.d.ts"
+      ],
+      "@girs/gjs": [
+            "../gjs/index.d.ts"
+      ]
+}
+  },
+  "include": ["./gtksessionlock-0.1.d.ts"]
+}
+
+

package/typedoc.json

@@ -0,0 +1,9 @@
+{
+    "entryPoints": ["./gtksessionlock-0.1.d.ts"],
+    "readme": "./README.md",
+    "name": "GtkSessionLock-0.1",
+    "tsconfig": "./tsconfig.json",
+    "skipErrorChecking": true,
+    "highlightLanguages": ["typescript", "javascript", "c", "cpp", "xml", "bash", "json", "css"]
+}
+