@girs/cloudproviders-0.3 4.4.0 → 4.5.0

package/README.md

@@ -4,82 +4,77 @@
 ![version](https://img.shields.io/npm/v/@girs/cloudproviders-0.3)
 ![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.5.0.
 
-GJS TypeScript type definitions for CloudProviders-0.3 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.4.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/cloudproviders-0.3
 ```
 
-## Usage
+Any package manager works. The package has no dependencies beyond other `@girs/*`
+type packages.
+
+## What it exports
+
+| Import | What you get |
+|---|---|
+| `@girs/cloudproviders-0.3` | the namespace as a default export, plus the ambient and global declarations |
+| `@girs/cloudproviders-0.3/ambient` | only the `gi://` module declarations |
+| `@girs/cloudproviders-0.3/import` | only the `imports.gi` declarations |
+| `@girs/cloudproviders-0.3/cloudproviders-0.3` | 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 CloudProviders from '@girs/cloudproviders-0.3';
 ```
 
-### 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/cloudproviders-0.3` or `@girs/cloudproviders-0.3/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/cloudproviders-0.3'
+import '@girs/cloudproviders-0.3';
 ```
 
-`tsconfig.json`:
 ```json
-{
-  "compilerOptions": {
-    ...
-  },
-  "include": ["@girs/cloudproviders-0.3"],
-  ...
-}
+{ "include": ["@girs/cloudproviders-0.3"] }
 ```
 
-The ambient module now resolves with types:
+Then the runtime spelling type-checks:
 
 ```ts
 import CloudProviders from 'gi://CloudProviders?version=0.3';
 ```
 
-### Global import
-
-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:
+Referencing `@girs/cloudproviders-0.3/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/cloudproviders-0.3'
-```
-
-`tsconfig.json`:
-```json
-{
-  "compilerOptions": {
-    ...
-  },
-  "include": ["@girs/cloudproviders-0.3"],
-  ...
-}
-```
+### As `imports.gi`
 
-That form carries types as well:
+GJS's global object works the same way, via `@girs/cloudproviders-0.3/import`:
 
 ```ts
 const CloudProviders = imports.gi.CloudProviders;
 ```
 
-### 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/cloudproviders-0.3.d.ts

@@ -27,15 +27,21 @@ export namespace CloudProviders {
      * @gir-type Enum
      */
     enum AccountStatus {
-        INVALID,
-        IDLE,
-        SYNCING,
-        ERROR,
+        INVALID = 0,
+        IDLE = 1,
+        SYNCING = 2,
+        ERROR = 3,
     }
 
 
+    /**
+     * @default org.freedesktop.CloudProviders.Account
+     */
     const ACCOUNT_DBUS_IFACE: string;
 
+    /**
+     * @default org.freedesktop.CloudProviders.Provider
+     */
     const PROVIDER_DBUS_IFACE: string;
 
     /**
@@ -812,6 +818,7 @@ export namespace CloudProviders {
          * @param res a {@link Gio.AsyncResult}.
          * @returns `true` if successful. If an error has occurred, this function will return `false` and set `error` appropriately if present.
          * @since 2.22
+         * @throws GLib.Error
          */
         init_finish(res: Gio.AsyncResult): boolean;
 
@@ -821,6 +828,7 @@ export namespace CloudProviders {
          * @param res the {@link Gio.AsyncResult} from the callback
          * @returns a newly created {@link GObject.Object},      or `null` on error. Free with `g_object_unref()`.
          * @since 2.22
+         * @throws GLib.Error
          */
         new_finish(res: Gio.AsyncResult): DbusAccountProxy;
 
@@ -985,6 +993,7 @@ export namespace CloudProviders {
          * @param cancellable optional {@link Gio.Cancellable} object, `null` to ignore.
          * @returns `true` if successful. If an error has occurred, this function will     return `false` and set `error` appropriately if present.
          * @since 2.22
+         * @throws GLib.Error
          */
         init(cancellable: Gio.Cancellable | null): boolean;
 
@@ -1480,6 +1489,7 @@ export namespace CloudProviders {
          * @param res a {@link Gio.AsyncResult}.
          * @returns `true` if successful. If an error has occurred, this function will return `false` and set `error` appropriately if present.
          * @since 2.22
+         * @throws GLib.Error
          */
         init_finish(res: Gio.AsyncResult): boolean;
 
@@ -1489,6 +1499,7 @@ export namespace CloudProviders {
          * @param res the {@link Gio.AsyncResult} from the callback
          * @returns a newly created {@link GObject.Object},      or `null` on error. Free with `g_object_unref()`.
          * @since 2.22
+         * @throws GLib.Error
          */
         new_finish(res: Gio.AsyncResult): DbusObjectManagerClient;
 
@@ -1688,6 +1699,7 @@ export namespace CloudProviders {
          * @param cancellable optional {@link Gio.Cancellable} object, `null` to ignore.
          * @returns `true` if successful. If an error has occurred, this function will     return `false` and set `error` appropriately if present.
          * @since 2.22
+         * @throws GLib.Error
          */
         init(cancellable: Gio.Cancellable | null): boolean;
 
@@ -2294,6 +2306,7 @@ export namespace CloudProviders {
          * @param res a {@link Gio.AsyncResult}.
          * @returns `true` if successful. If an error has occurred, this function will return `false` and set `error` appropriately if present.
          * @since 2.22
+         * @throws GLib.Error
          */
         init_finish(res: Gio.AsyncResult): boolean;
 
@@ -2303,6 +2316,7 @@ export namespace CloudProviders {
          * @param res the {@link Gio.AsyncResult} from the callback
          * @returns a newly created {@link GObject.Object},      or `null` on error. Free with `g_object_unref()`.
          * @since 2.22
+         * @throws GLib.Error
          */
         new_finish(res: Gio.AsyncResult): DbusProviderProxy;
 
@@ -2467,6 +2481,7 @@ export namespace CloudProviders {
          * @param cancellable optional {@link Gio.Cancellable} object, `null` to ignore.
          * @returns `true` if successful. If an error has occurred, this function will     return `false` and set `error` appropriately if present.
          * @since 2.22
+         * @throws GLib.Error
          */
         init(cancellable: Gio.Cancellable | null): boolean;
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@girs/cloudproviders-0.3",
-    "version": "4.4.0",
+    "version": "4.5.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.4.0",
-      "@girs/gio-2.0": "^4.4.0",
-      "@girs/gobject-2.0": "^4.4.0",
-      "@girs/glib-2.0": "^4.4.0",
-      "@girs/gmodule-2.0": "^4.4.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": "*"
     },