@girs/cloudproviders-0.3 4.2.0 → 4.3.0

package/README.md

@@ -5,25 +5,25 @@
 ![downloads/week](https://img.shields.io/npm/dw/@girs/cloudproviders-0.3)
 
 
-GJS TypeScript type definitions for CloudProviders-0.3 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.2.0.
+GJS TypeScript type definitions for CloudProviders-0.3 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.3.0.
 
 ## Install
 
-To use this type definitions, install them with NPM:
+Install the type definitions with npm:
 ```bash
 npm install @girs/cloudproviders-0.3
 ```
 
 ## Usage
 
-You can import this package into your project like this:
+Import it like any other module:
 ```ts
 import CloudProviders from '@girs/cloudproviders-0.3';
 ```
 
 ### 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.
+[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/cloudproviders-0.3` or `@girs/cloudproviders-0.3/ambient` in your `tsconfig` or entry point Typescript file:
 
 `index.ts`:
@@ -42,7 +42,7 @@ import '@girs/cloudproviders-0.3'
 }
 ```
 
-Now you can import the ambient module with TypeScript support: 
+The ambient module now resolves with types:
 
 ```ts
 import CloudProviders from 'gi://CloudProviders?version=0.3';
@@ -50,7 +50,7 @@ import CloudProviders from 'gi://CloudProviders?version=0.3';
 
 ### Global import
 
-You can also import the module with Typescript support using the global `imports.gi` object of GJS.
+GJS's global `imports.gi` works too, with types.
 For this you need to include `@girs/cloudproviders-0.3` or `@girs/cloudproviders-0.3/import` in your `tsconfig` or entry point Typescript file:
 
 `index.ts`:
@@ -69,7 +69,7 @@ import '@girs/cloudproviders-0.3'
 }
 ```
 
-Now you have also type support for this, too:
+That form carries types as well:
 
 ```ts
 const CloudProviders = imports.gi.CloudProviders;
@@ -77,7 +77,7 @@ const CloudProviders = imports.gi.CloudProviders;
 
 ### 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).
+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.
 
 ## Other packages
 

package/cloudproviders-0.3.d.ts

@@ -94,10 +94,12 @@ export namespace CloudProviders {
     }
 
     /**
-     * {@link CloudProviders.Account} is the basic object used to construct the integrator UI
+     * Base object for representing a single account for clients.
+     * 
+     * CloudProvidersAccount is the basic object used to construct the integrator UI
      * and actions that a provider will present to the user, from the client side.
      * Integrators of the cloud providers can use this object to poll the
-     * {@link CloudProviders.Provider} menus, status and actions.
+     * {@link Provider} menus, status and actions.
      * @gir-type Class
      */
     class Account extends GObject.Object {
@@ -105,49 +107,58 @@ export namespace CloudProviders {
 
         // Properties
         /**
+         * The action group associated with the account and menu model.
          * @read-only
          */
         get action_group(): Gio.ActionGroup;
 
         /**
+         * The action group associated with the account and menu model.
          * @read-only
          */
         get actionGroup(): Gio.ActionGroup;
 
         /**
+         * The icon representing the account.
          * @read-only
          */
         get icon(): Gio.Icon;
 
         /**
+         * The menu model associated with the account.
          * @read-only
          */
         get menu_model(): Gio.MenuModel;
 
         /**
+         * The menu model associated with the account.
          * @read-only
          */
         get menuModel(): Gio.MenuModel;
 
         /**
+         * The name of the account.
          * @read-only
          * @default null
          */
         get name(): string;
 
         /**
+         * The path of the directory where files are located.
          * @read-only
          * @default null
          */
         get path(): string;
 
         /**
+         * The details of the account status.
          * @read-only
          * @default null
          */
         get status_details(): string;
 
         /**
+         * The details of the account status.
          * @read-only
          * @default null
          */
@@ -185,7 +196,7 @@ export namespace CloudProviders {
         // Methods
         /**
          * Get the action group exported in addition to the {@link Gio.MenuModel} from
-         * `cloud_providers_account_get_menu_model()`
+         * {@link Account.get_menu_model}.
          * @returns The action group exported by the cloud provider account
          */
         get_action_group(): Gio.ActionGroup;
@@ -259,63 +270,86 @@ export namespace CloudProviders {
     }
 
     /**
+     * Base object for representing a cloud providers account
      * @gir-type Class
      */
     class AccountExporter extends GObject.Object {
         static $gtype: GObject.GType<AccountExporter>;
 
         // Properties
+        /**
+         * The action group associated with the account and menu model.
+         */
         get action_group(): Gio.ActionGroup;
         set action_group(val: Gio.ActionGroup);
 
+        /**
+         * The action group associated with the account and menu model.
+         */
         get actionGroup(): Gio.ActionGroup;
         set actionGroup(val: Gio.ActionGroup);
 
         /**
+         * The bus name of the account.
          * @construct-only
          * @default null
          */
         get bus_name(): string;
 
         /**
+         * The bus name of the account.
          * @construct-only
          * @default null
          */
         get busName(): string;
 
+        /**
+         * The icon representing the account.
+         */
         get icon(): Gio.Icon;
         set icon(val: Gio.Icon);
 
+        /**
+         * The menu model associated with the account.
+         */
         get menu_model(): Gio.MenuModel;
         set menu_model(val: Gio.MenuModel);
 
+        /**
+         * The menu model associated with the account.
+         */
         get menuModel(): Gio.MenuModel;
         set menuModel(val: Gio.MenuModel);
 
         /**
+         * The name of the account.
          * @default null
          */
         get name(): string;
         set name(val: string);
 
         /**
+         * The path of the directory where files are located.
          * @default null
          */
         get path(): string;
         set path(val: string);
 
         /**
+         * The provider associated with the account.
          * @construct-only
          */
         get provider(): ProviderExporter;
 
         /**
+         * The details of the account status.
          * @default null
          */
         get status_details(): string;
         set status_details(val: string);
 
         /**
+         * The details of the account status.
          * @default null
          */
         get statusDetails(): string;
@@ -352,10 +386,9 @@ export namespace CloudProviders {
 
         // Methods
         /**
-         * In order for a menu exported with cloud_providers_account_exporter_export_menu to receive events
-         * that will eventually call your callbacks, it needs the corresponding GActionGroup.
-         * Use this function to export it.
-         * @param action_group The GActionGroup to be used by the menu exported by cloud_providers_account_exporter_export_menu
+         * In order for a menu to receive events that will eventually call your callbacks, it needs the
+         * corresponding {@link Gio.ActionGroup}. Use this function to export it.
+         * @param action_group The action group to be used to render the menu
          */
         set_action_group(action_group: Gio.ActionGroup): void;
 
@@ -366,7 +399,7 @@ export namespace CloudProviders {
 
         /**
          * One of the benefits of the integration is to display a menu with available
-         * options for an account. Use this function to export a GMenuModel menu to be
+         * options for an account. Use this function to export a {@link Gio.MenuModel} menu to be
          * displayed by the chosen integration by the desktop environment or application.
          * @param menu_model The menu model to export
          */
@@ -409,10 +442,11 @@ export namespace CloudProviders {
     }
 
     /**
-     * {@link CloudProviders.Collector} is a singleton to track all the changes in all providers.
-     * Using a {@link CloudProviders.Collector} you can implement integration for all of them at once
-     * and represent them in the UI, track new providers added or removed and their
-     * status.
+     * Singleton for tracking all providers.
+     * 
+     * This is a singleton to track all the changes in all providers.
+     * Using this class, you can implement integration for all of them at once and represent them in the
+     * UI, track new providers added or removed and their status.
      * @gir-type Class
      */
     class Collector extends GObject.Object {
@@ -453,7 +487,8 @@ export namespace CloudProviders {
 
         // Methods
         /**
-         * @returns A GList* of {@link CloudProviders.Provider} objects.
+         * Get the list of currently managed providers.
+         * @returns A list of {@link Provider} objects.
          */
         get_providers(): Provider[];
 
@@ -851,9 +886,14 @@ export namespace CloudProviders {
         /**
          * Gets D-Bus introspection information for the D-Bus interface
          * implemented by `interface_`.
+         * 
+         * This can return `null` if no {@link Gio.DBusInterfaceInfo} was provided during
+         * construction of `interface_` and is also not made available otherwise.
+         * For example, {@link Gio.DBusProxy} implements {@link Gio.DBusInterface} but allows for a `null`
+         * {@link Gio.DBusInterfaceInfo}.
          * @returns A {@link Gio.DBusInterfaceInfo}. Do not free.
          */
-        get_info(): Gio.DBusInterfaceInfo;
+        get_info(): Gio.DBusInterfaceInfo | null;
 
         /**
          * Sets the {@link Gio.DBusObject} for `interface_` to `object`.
@@ -872,9 +912,14 @@ export namespace CloudProviders {
         /**
          * Gets D-Bus introspection information for the D-Bus interface
          * implemented by `interface_`.
+         * 
+         * This can return `null` if no {@link Gio.DBusInterfaceInfo} was provided during
+         * construction of `interface_` and is also not made available otherwise.
+         * For example, {@link Gio.DBusProxy} implements {@link Gio.DBusInterface} but allows for a `null`
+         * {@link Gio.DBusInterfaceInfo}.
          * @virtual
          */
-        vfunc_get_info(): Gio.DBusInterfaceInfo;
+        vfunc_get_info(): Gio.DBusInterfaceInfo | null;
 
         /**
          * Sets the {@link Gio.DBusObject} for `interface_` to `object`.
@@ -1095,9 +1140,20 @@ export namespace CloudProviders {
         /**
          * Gets D-Bus introspection information for the D-Bus interface
          * implemented by `interface_`.
+         * 
+         * This can return `null` if no {@link Gio.DBusInterfaceInfo} was provided during
+         * construction of `interface_` and is also not made available otherwise.
+         * For example, {@link Gio.DBusProxy} implements {@link Gio.DBusInterface} but allows for a `null`
+         * {@link Gio.DBusInterfaceInfo}.
          * @returns A {@link Gio.DBusInterfaceInfo}. Do not free.
          */
-        get_info(): Gio.DBusInterfaceInfo;
+        get_info(): Gio.DBusInterfaceInfo | null;
+
+        /**
+         * @param args 
+         */
+        // Conflicted with Gio.DBusInterfaceSkeleton.get_info
+        get_info(...args: never[]): any;
 
         /**
          * Sets the {@link Gio.DBusObject} for `interface_` to `object`.
@@ -1116,9 +1172,21 @@ export namespace CloudProviders {
         /**
          * Gets D-Bus introspection information for the D-Bus interface
          * implemented by `interface_`.
+         * 
+         * This can return `null` if no {@link Gio.DBusInterfaceInfo} was provided during
+         * construction of `interface_` and is also not made available otherwise.
+         * For example, {@link Gio.DBusProxy} implements {@link Gio.DBusInterface} but allows for a `null`
+         * {@link Gio.DBusInterfaceInfo}.
          * @virtual
          */
-        vfunc_get_info(): Gio.DBusInterfaceInfo;
+        vfunc_get_info(): Gio.DBusInterfaceInfo | null;
+
+        /**
+         * @param args 
+         * @virtual
+         */
+        // Conflicted with Gio.DBusInterfaceSkeleton.vfunc_get_info
+        vfunc_get_info(...args: never[]): any;
 
         /**
          * Sets the {@link Gio.DBusObject} for `interface_` to `object`.
@@ -2250,9 +2318,14 @@ export namespace CloudProviders {
         /**
          * Gets D-Bus introspection information for the D-Bus interface
          * implemented by `interface_`.
+         * 
+         * This can return `null` if no {@link Gio.DBusInterfaceInfo} was provided during
+         * construction of `interface_` and is also not made available otherwise.
+         * For example, {@link Gio.DBusProxy} implements {@link Gio.DBusInterface} but allows for a `null`
+         * {@link Gio.DBusInterfaceInfo}.
          * @returns A {@link Gio.DBusInterfaceInfo}. Do not free.
          */
-        get_info(): Gio.DBusInterfaceInfo;
+        get_info(): Gio.DBusInterfaceInfo | null;
 
         /**
          * Sets the {@link Gio.DBusObject} for `interface_` to `object`.
@@ -2271,9 +2344,14 @@ export namespace CloudProviders {
         /**
          * Gets D-Bus introspection information for the D-Bus interface
          * implemented by `interface_`.
+         * 
+         * This can return `null` if no {@link Gio.DBusInterfaceInfo} was provided during
+         * construction of `interface_` and is also not made available otherwise.
+         * For example, {@link Gio.DBusProxy} implements {@link Gio.DBusInterface} but allows for a `null`
+         * {@link Gio.DBusInterfaceInfo}.
          * @virtual
          */
-        vfunc_get_info(): Gio.DBusInterfaceInfo;
+        vfunc_get_info(): Gio.DBusInterfaceInfo | null;
 
         /**
          * Sets the {@link Gio.DBusObject} for `interface_` to `object`.
@@ -2440,9 +2518,20 @@ export namespace CloudProviders {
         /**
          * Gets D-Bus introspection information for the D-Bus interface
          * implemented by `interface_`.
+         * 
+         * This can return `null` if no {@link Gio.DBusInterfaceInfo} was provided during
+         * construction of `interface_` and is also not made available otherwise.
+         * For example, {@link Gio.DBusProxy} implements {@link Gio.DBusInterface} but allows for a `null`
+         * {@link Gio.DBusInterfaceInfo}.
          * @returns A {@link Gio.DBusInterfaceInfo}. Do not free.
          */
-        get_info(): Gio.DBusInterfaceInfo;
+        get_info(): Gio.DBusInterfaceInfo | null;
+
+        /**
+         * @param args 
+         */
+        // Conflicted with Gio.DBusInterfaceSkeleton.get_info
+        get_info(...args: never[]): any;
 
         /**
          * Sets the {@link Gio.DBusObject} for `interface_` to `object`.
@@ -2461,9 +2550,21 @@ export namespace CloudProviders {
         /**
          * Gets D-Bus introspection information for the D-Bus interface
          * implemented by `interface_`.
+         * 
+         * This can return `null` if no {@link Gio.DBusInterfaceInfo} was provided during
+         * construction of `interface_` and is also not made available otherwise.
+         * For example, {@link Gio.DBusProxy} implements {@link Gio.DBusInterface} but allows for a `null`
+         * {@link Gio.DBusInterfaceInfo}.
+         * @virtual
+         */
+        vfunc_get_info(): Gio.DBusInterfaceInfo | null;
+
+        /**
+         * @param args 
          * @virtual
          */
-        vfunc_get_info(): Gio.DBusInterfaceInfo;
+        // Conflicted with Gio.DBusInterfaceSkeleton.vfunc_get_info
+        vfunc_get_info(...args: never[]): any;
 
         /**
          * Sets the {@link Gio.DBusObject} for `interface_` to `object`.
@@ -2499,9 +2600,10 @@ export namespace CloudProviders {
     }
 
     /**
-     * {@link CloudProviders.Provider} is the basic object object for client implementers
-     * that contains the properties of the provider such as name, and the accounts
-     * associated with it.
+     * Base object for representing a single provider for clients.
+     * 
+     * This is the basic object object for client implementers that contains the properties of the
+     * provider such as name, and the accounts associated with it.
      * @gir-type Class
      */
     class Provider extends GObject.Object {
@@ -2509,6 +2611,7 @@ export namespace CloudProviders {
 
         // Properties
         /**
+         * The name of the cloud provider.
          * @read-only
          * @default null
          */
@@ -2545,7 +2648,8 @@ export namespace CloudProviders {
 
         // Methods
         /**
-         * @returns A GList* of {@link CloudProviders.Provider} objects.
+         * Get the list of accounts from this provider.
+         * @returns A list of {@link Account} objects.
          */
         get_accounts(): Account[];
 
@@ -2574,9 +2678,7 @@ export namespace CloudProviders {
     }
 
     /**
-     * {@link CloudProviders.ProviderExporter} is the base object representing a single cloud provider.
-     * Multiple {@link CloudProviders.AccountExporter} objects can be added with `cloud_providers_provider_exporter_add_account()`
-     * After adding the initial set of accounts `cloud_providers_provider_exporter_export_objects()` must be called.
+     * Base object for representing a single single provider.
      * @gir-type Class
      */
     class ProviderExporter extends GObject.Object {
@@ -2584,35 +2686,41 @@ export namespace CloudProviders {
 
         // Properties
         /**
+         * The bus connection object for the provider.
          * @construct-only
          */
         get bus(): Gio.DBusConnection;
 
         /**
+         * The bus name of the provider.
          * @construct-only
          * @default null
          */
         get bus_name(): string;
 
         /**
+         * The bus name of the provider.
          * @construct-only
          * @default null
          */
         get busName(): string;
 
         /**
+         * The bus path of the provider.
          * @construct-only
          * @default null
          */
         get bus_path(): string;
 
         /**
+         * The bus path of the provider.
          * @construct-only
          * @default null
          */
         get busPath(): string;
 
         /**
+         * The name of the cloud provider.
          * @default null
          */
         get name(): string;
@@ -2652,7 +2760,7 @@ export namespace CloudProviders {
 
         /**
          * Each cloud provider can have a variety of account associated with it. Use this
-         * function to remove the accounts that were added when created by `cloud_providers_account_exporter_new()`.
+         * function to remove the accounts that were added when created by {@link AccountExporter.new}.
          * @param account The account object
          */
         remove_account(account: AccountExporter): void;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@girs/cloudproviders-0.3",
-    "version": "4.2.0",
+    "version": "4.3.0",
     "description": "GJS TypeScript type definitions for CloudProviders-0.3",
     "type": "module",
     "module": "cloudproviders-0.3.js",
@@ -31,11 +31,11 @@
       "test": "tsc --project tsconfig.json"
     },
     "dependencies": {
-      "@girs/gjs": "^4.2.0",
-      "@girs/gio-2.0": "^4.2.0",
-      "@girs/gobject-2.0": "^4.2.0",
-      "@girs/glib-2.0": "^4.2.0",
-      "@girs/gmodule-2.0": "^4.2.0"    },
+      "@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"    },
     "devDependencies": {
       "typescript": "*"
     },