@girs/lightdm-1 4.3.0 → 4.5.0

package/README.md

@@ -4,82 +4,77 @@
 ![version](https://img.shields.io/npm/v/@girs/lightdm-1)
 ![downloads/week](https://img.shields.io/npm/dw/@girs/lightdm-1)
 
+GJS TypeScript type definitions for LightDM-1 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.5.0.
 
-GJS TypeScript type definitions for LightDM-1 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.3.0.
+This package contains type declarations only. It ships no runtime code, so it adds
+nothing to your program and works with any bundler or none at all.
 
 ## Install
 
-Install the type definitions with npm:
 ```bash
 npm install @girs/lightdm-1
 ```
 
-## Usage
+Any package manager works. The package has no dependencies beyond other `@girs/*`
+type packages.
+
+## What it exports
+
+| Import | What you get |
+|---|---|
+| `@girs/lightdm-1` | the namespace as a default export, plus the ambient and global declarations |
+| `@girs/lightdm-1/ambient` | only the `gi://` module declarations |
+| `@girs/lightdm-1/import` | only the `imports.gi` declarations |
+| `@girs/lightdm-1/lightdm-1` | the namespace, without the side-effecting declarations |
+
+## Three ways to import
+
+Which one you use depends on how you write imports elsewhere, not on your toolchain.
+
+### As a module
 
-Import it like any other module:
 ```ts
 import LightDM from '@girs/lightdm-1';
 ```
 
-### Ambient Modules
+### As `gi://`
 
-[Ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules) let you write the same import you would in plain JavaScript.
-For this you need to include `@girs/lightdm-1` or `@girs/lightdm-1/ambient` in your `tsconfig` or entry point Typescript file:
+GJS resolves `gi://` at runtime. To give it types, reference the package once, either
+from your entry point or from `tsconfig.json`:
 
-`index.ts`:
 ```ts
-import '@girs/lightdm-1'
+import '@girs/lightdm-1';
 ```
 
-`tsconfig.json`:
 ```json
-{
-  "compilerOptions": {
-    ...
-  },
-  "include": ["@girs/lightdm-1"],
-  ...
-}
+{ "include": ["@girs/lightdm-1"] }
 ```
 
-The ambient module now resolves with types:
+Then the runtime spelling type-checks:
 
 ```ts
 import LightDM from 'gi://LightDM?version=1';
 ```
 
-### Global import
-
-GJS's global `imports.gi` works too, with types.
-For this you need to include `@girs/lightdm-1` or `@girs/lightdm-1/import` in your `tsconfig` or entry point Typescript file:
+Referencing `@girs/lightdm-1/ambient` instead pulls in these declarations
+alone. See [ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules).
 
-`index.ts`:
-```ts
-import '@girs/lightdm-1'
-```
-
-`tsconfig.json`:
-```json
-{
-  "compilerOptions": {
-    ...
-  },
-  "include": ["@girs/lightdm-1"],
-  ...
-}
-```
+### As `imports.gi`
 
-That form carries types as well:
+GJS's global object works the same way, via `@girs/lightdm-1/import`:
 
 ```ts
 const LightDM = imports.gi.LightDM;
 ```
 
-### Bundle
+## Building
 
-Most projects want a bundler. [esbuild](https://esbuild.github.io/) is the smallest thing that works; the [examples directory](https://github.com/gjsify/ts-for-gir/tree/main/examples) has setups for several others.
+The declarations need no build step. If you bundle, every bundler works, since there is
+no runtime code to resolve. The [examples](https://github.com/gjsify/ts-for-gir/tree/main/examples)
+show working setups for several.
 
 ## Other packages
 
-All existing pre-generated packages can be found on [gjsify/types](https://github.com/gjsify/types).
+Every pre-generated package is at [gjsify/types](https://github.com/gjsify/types).
+
 

package/lightdm-1.d.ts

@@ -78,11 +78,11 @@ export namespace LightDM {
         /**
          * Informational message.
          */
-        INFO,
+        INFO = 0,
         /**
          * Error message.
          */
-        ERROR,
+        ERROR = 1,
     }
 
 
@@ -101,32 +101,62 @@ export namespace LightDM {
         /**
          * prompt is a question.  The information can be shown as it is entered.
          */
-        QUESTION,
+        QUESTION = 0,
         /**
          * prompt is for secret information.  The entered information should be obscured so it can't be publicly visible.
          */
-        SECRET,
+        SECRET = 1,
     }
 
 
+    /**
+     * @default authentication-complete
+     */
     const GREETER_SIGNAL_AUTHENTICATION_COMPLETE: string;
 
+    /**
+     * @default autologin-timer-expired
+     */
     const GREETER_SIGNAL_AUTOLOGIN_TIMER_EXPIRED: string;
 
+    /**
+     * @default idle
+     */
     const GREETER_SIGNAL_IDLE: string;
 
+    /**
+     * @default reset
+     */
     const GREETER_SIGNAL_RESET: string;
 
+    /**
+     * @default show-message
+     */
     const GREETER_SIGNAL_SHOW_MESSAGE: string;
 
+    /**
+     * @default show-prompt
+     */
     const GREETER_SIGNAL_SHOW_PROMPT: string;
 
+    /**
+     * @default changed
+     */
     const SIGNAL_USER_CHANGED: string;
 
+    /**
+     * @default user-added
+     */
     const USER_LIST_SIGNAL_USER_ADDED: string;
 
+    /**
+     * @default user-changed
+     */
     const USER_LIST_SIGNAL_USER_CHANGED: string;
 
+    /**
+     * @default user-removed
+     */
     const USER_LIST_SIGNAL_USER_REMOVED: string;
 
     /**
@@ -241,12 +271,14 @@ export namespace LightDM {
     /**
      * Triggers a system hibernate.
      * @returns `TRUE` if hibernate initiated.
+     * @throws GLib.Error
      */
     function hibernate(): boolean;
 
     /**
      * Triggers a system restart.
      * @returns `TRUE` if restart initiated.
+     * @throws GLib.Error
      */
     function restart(): boolean;
 
@@ -259,12 +291,14 @@ export namespace LightDM {
     /**
      * Triggers a system shutdown.
      * @returns `TRUE` if shutdown initiated.
+     * @throws GLib.Error
      */
     function shutdown(): boolean;
 
     /**
      * Triggers a system suspend.
      * @returns `TRUE` if suspend initiated.
+     * @throws GLib.Error
      */
     function suspend(): boolean;
 
@@ -314,7 +348,7 @@ export namespace LightDM {
              * @signal
              * @run-last
              */
-            "show-message": (arg0: string, arg1: MessageType) => void;
+            "show-message": (text: string, type: MessageType) => void;
             /**
              * The ::show-prompt signal gets emitted when the greeter should show a
              * prompt to the user.  The given text should be displayed and an input
@@ -325,7 +359,7 @@ export namespace LightDM {
              * @signal
              * @run-last
              */
-            "show-prompt": (arg0: string, arg1: PromptType) => void;
+            "show-prompt": (text: string, type: PromptType) => void;
             "notify::authentication-user": (pspec: GObject.ParamSpec) => void;
             "notify::autologin-guest-hint": (pspec: GObject.ParamSpec) => void;
             "notify::autologin-session-hint": (pspec: GObject.ParamSpec) => void;
@@ -636,18 +670,21 @@ export namespace LightDM {
          * Starts the authentication procedure for a user.
          * @param username A username or `NULL` to prompt for a username.
          * @returns `TRUE` if authentication request sent.
+         * @throws GLib.Error
          */
         authenticate(username: string | null): boolean;
 
         /**
          * Starts the authentication procedure for the guest user.
          * @returns `TRUE` if authentication request sent.
+         * @throws GLib.Error
          */
         authenticate_as_guest(): boolean;
 
         /**
          * Starts the authentication procedure for the automatic login user.
          * @returns `TRUE` if authentication request sent.
+         * @throws GLib.Error
          */
         authenticate_autologin(): boolean;
 
@@ -656,12 +693,14 @@ export namespace LightDM {
          * @param session The name of a remote session
          * @param username A username of `NULL` to prompt for a username.
          * @returns `TRUE` if authentication request sent.
+         * @throws GLib.Error
          */
         authenticate_remote(session: string, username: string | null): boolean;
 
         /**
          * Cancel the current user authentication.
          * @returns `TRUE` if cancel request sent.
+         * @throws GLib.Error
          */
         cancel_authentication(): boolean;
 
@@ -673,6 +712,8 @@ export namespace LightDM {
         /**
          * Connects the greeter to the display manager.  Will block until connected.
          * @returns `TRUE` if successfully connected
+         * @deprecated since 1.11.1: Use `lightdm_greeter_connect_to_daemon_sync()` instead
+         * @throws GLib.Error
          */
         connect_sync(): boolean;
 
@@ -712,12 +753,14 @@ export namespace LightDM {
          * Finishes an operation started with `lightdm_greeter_connect_to_daemon()`.
          * @param result A {@link Gio.AsyncResult}.
          * @returns `TRUE` if successfully connected
+         * @throws GLib.Error
          */
         connect_to_daemon_finish(result: Gio.AsyncResult): boolean;
 
         /**
          * Connects the greeter to the display manager.  Will block until connected.
          * @returns `TRUE` if successfully connected
+         * @throws GLib.Error
          */
         connect_to_daemon_sync(): boolean;
 
@@ -775,6 +818,7 @@ export namespace LightDM {
          * Function to call from lightdm_greeter_ensure_shared_data_dir callback.
          * @param result A {@link Gio.AsyncResult}.
          * @returns The path to the shared directory, free with g_free.
+         * @throws GLib.Error
          */
         ensure_shared_data_dir_finish(result: Gio.AsyncResult): string;
 
@@ -791,6 +835,7 @@ export namespace LightDM {
          * the directory themselves.
          * @param username A username
          * @returns The path to the shared directory, free with g_free.
+         * @throws GLib.Error
          */
         ensure_shared_data_dir_sync(username: string): string;
 
@@ -905,6 +950,7 @@ export namespace LightDM {
          * Provide response to a prompt.  May be one in a series.
          * @param response Response to a prompt
          * @returns `TRUE` if response sent.
+         * @throws GLib.Error
          */
         respond(response: string): boolean;
 
@@ -912,6 +958,7 @@ export namespace LightDM {
          * Set the language for the currently authenticated user.
          * @param language The language to use for this user in the form of a locale specification (e.g. "de_DE.UTF-8").
          * @returns `TRUE` if set language request sent.
+         * @throws GLib.Error
          */
         set_language(language: string): boolean;
 
@@ -961,6 +1008,7 @@ export namespace LightDM {
          * Start a session for the authenticated user.
          * @param result A {@link Gio.AsyncResult}.
          * @returns TRUE if the session was started.
+         * @throws GLib.Error
          */
         start_session_finish(result: Gio.AsyncResult): boolean;
 
@@ -968,6 +1016,7 @@ export namespace LightDM {
          * Start a session for the authenticated user.
          * @param session The session to log into or `NULL` to use the default.
          * @returns TRUE if the session was started.
+         * @throws GLib.Error
          */
         start_session_sync(session: string | null): boolean;
     }
@@ -1572,19 +1621,19 @@ export namespace LightDM {
              * @signal
              * @run-last
              */
-            "user-added": (arg0: User) => void;
+            "user-added": (user: User) => void;
             /**
              * The ::user-changed signal gets emitted when a user account is modified.
              * @signal
              * @run-last
              */
-            "user-changed": (arg0: User) => void;
+            "user-changed": (user: User) => void;
             /**
              * The ::user-removed signal gets emitted when a user account is removed.
              * @signal
              * @run-last
              */
-            "user-removed": (arg0: User) => void;
+            "user-removed": (user: User) => void;
             "notify::length": (pspec: GObject.ParamSpec) => void;
             "notify::num-users": (pspec: GObject.ParamSpec) => void;
         }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@girs/lightdm-1",
-    "version": "4.3.0",
+    "version": "4.5.0",
     "description": "GJS TypeScript type definitions for LightDM-1",
     "type": "module",
     "module": "lightdm-1.js",
@@ -31,11 +31,11 @@
       "test": "tsc --project tsconfig.json"
     },
     "dependencies": {
-      "@girs/gjs": "^4.3.0",
-      "@girs/gio-2.0": "^4.3.0",
-      "@girs/gobject-2.0": "^4.3.0",
-      "@girs/glib-2.0": "^4.3.0",
-      "@girs/gmodule-2.0": "^4.3.0"    },
+      "@girs/gjs": "^4.5.0",
+      "@girs/gio-2.0": "^4.5.0",
+      "@girs/gobject-2.0": "^4.5.0",
+      "@girs/glib-2.0": "^4.5.0",
+      "@girs/gmodule-2.0": "^4.5.0"    },
     "devDependencies": {
       "typescript": "*"
     },