@girs/cmenu-3.0 4.3.0 → 4.5.0

package/README.md

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

@@ -27,15 +27,18 @@ export namespace CMenu {
      * @gir-type Enum
      */
     enum TreeItemType {
-        INVALID,
-        DIRECTORY,
-        ENTRY,
-        SEPARATOR,
-        HEADER,
-        ALIAS,
+        INVALID = 0,
+        DIRECTORY = 1,
+        ENTRY = 2,
+        SEPARATOR = 3,
+        HEADER = 4,
+        ALIAS = 5,
     }
 
 
+    /**
+     * @default :flatpak
+     */
     const DESKTOPAPPINFO_FLATPAK_SUFFIX: string;
 
     /**
@@ -49,13 +52,13 @@ export namespace CMenu {
      * @gir-type Flags
      */
     enum TreeFlags {
-        NONE,
-        INCLUDE_EXCLUDED,
-        SHOW_EMPTY,
-        INCLUDE_NODISPLAY,
-        SHOW_ALL_SEPARATORS,
-        SORT_DISPLAY_NAME,
-        INCLUDE_UNALLOCATED,
+        NONE = 0,
+        INCLUDE_EXCLUDED = 1,
+        SHOW_EMPTY = 256,
+        INCLUDE_NODISPLAY = 2,
+        SHOW_ALL_SEPARATORS = 512,
+        SORT_DISPLAY_NAME = 65536,
+        INCLUDE_UNALLOCATED = 4,
     }
 
 
@@ -115,6 +118,7 @@ export namespace CMenu {
          * action.
          * @param action_name the name of the action as from   `gmenu_desktopappinfo_list_actions()`
          * @returns the locale-specific action name
+         * @since 2.38
          */
         get_action_name(action_name: string): string;
 
@@ -138,6 +142,7 @@ export namespace CMenu {
          * situations such as the {@link CMenu.DesktopAppInfo} returned from
          * `gmenu_desktopappinfo_new_from_keyfile()`, this function will return `null`.
          * @returns The full path to the file for `info`,     or `null` if not known.
+         * @since 2.24
          */
         get_filename(): string;
 
@@ -271,6 +276,7 @@ export namespace CMenu {
          * application is capable of opening files with the given content type.
          * @param content_type a string.
          * @returns `TRUE` on success, `FALSE` on error.
+         * @throws GLib.Error
          */
         add_supports_type(content_type: string): boolean;
 
@@ -278,6 +284,7 @@ export namespace CMenu {
          * Obtains the information whether the {@link Gio.AppInfo} can be deleted.
          * See {@link Gio.AppInfo.delete}.
          * @returns `TRUE` if `appinfo` can be deleted
+         * @since 2.20
          */
         can_delete(): boolean;
 
@@ -294,6 +301,7 @@ export namespace CMenu {
          * {@link Gio.AppInfo}s which can be deleted, and system-wide ones which cannot.
          * See {@link Gio.AppInfo.can_delete}.
          * @returns `TRUE` if `appinfo` has been deleted
+         * @since 2.20
          */
         ["delete"](): boolean;
 
@@ -318,6 +326,7 @@ export namespace CMenu {
          * Gets the commandline with which the application will be
          * started.
          * @returns a string containing the `appinfo`’s   commandline, or `NULL` if this information is not available
+         * @since 2.20
          */
         get_commandline(): string | null;
 
@@ -331,6 +340,7 @@ export namespace CMenu {
          * Gets the display name of the application. The display name is often more
          * descriptive to the user than the name itself.
          * @returns the display name of the application for `appinfo`, or the name if no display name is available.
+         * @since 2.24
          */
         get_display_name(): string;
 
@@ -376,6 +386,7 @@ export namespace CMenu {
          * {@link Gio.AppInfo.add_supports_type}, but only those exported directly by
          * the application.
          * @returns a list of content types.
+         * @since 2.34
          */
         get_supported_types(): string[] | null;
 
@@ -410,6 +421,7 @@ export namespace CMenu {
          * @param files a list of {@link Gio.File} objects
          * @param context the launch context
          * @returns `TRUE` on successful launch, `FALSE` otherwise.
+         * @throws GLib.Error
          */
         launch(files: Gio.File[] | null, context: Gio.AppLaunchContext | null): boolean;
 
@@ -429,6 +441,7 @@ export namespace CMenu {
          * @param uris a list of URIs to launch.
          * @param context the launch context
          * @returns `TRUE` on successful launch, `FALSE` otherwise.
+         * @throws GLib.Error
          */
         launch_uris(uris: string[] | null, context: Gio.AppLaunchContext | null): boolean;
 
@@ -442,6 +455,7 @@ export namespace CMenu {
          * @param uris a list of URIs to launch.
          * @param context the launch context
          * @param cancellable a {@link Gio.Cancellable}
+         * @since 2.60
          */
         launch_uris_async(uris: string[] | null, context: Gio.AppLaunchContext | null, cancellable: Gio.Cancellable | null): globalThis.Promise<boolean>;
 
@@ -456,6 +470,7 @@ export namespace CMenu {
          * @param context the launch context
          * @param cancellable a {@link Gio.Cancellable}
          * @param callback a {@link Gio.AsyncReadyCallback} to call   when the request is done
+         * @since 2.60
          */
         launch_uris_async(uris: string[] | null, context: Gio.AppLaunchContext | null, cancellable: Gio.Cancellable | null, callback: Gio.AsyncReadyCallback<this> | null): void;
 
@@ -470,6 +485,7 @@ export namespace CMenu {
          * @param context the launch context
          * @param cancellable a {@link Gio.Cancellable}
          * @param callback a {@link Gio.AsyncReadyCallback} to call   when the request is done
+         * @since 2.60
          */
         launch_uris_async(uris: string[] | null, context: Gio.AppLaunchContext | null, cancellable: Gio.Cancellable | null, callback?: Gio.AsyncReadyCallback<this> | null): globalThis.Promise<boolean> | void;
 
@@ -477,6 +493,8 @@ export namespace CMenu {
          * Finishes a {@link Gio.AppInfo.launch_uris_async} operation.
          * @param result the async result
          * @returns `TRUE` on successful launch, `FALSE` otherwise.
+         * @since 2.60
+         * @throws GLib.Error
          */
         launch_uris_finish(result: Gio.AsyncResult): boolean;
 
@@ -484,6 +502,7 @@ export namespace CMenu {
          * Removes a supported type from an application, if possible.
          * @param content_type a string.
          * @returns `TRUE` on success, `FALSE` on error.
+         * @throws GLib.Error
          */
         remove_supports_type(content_type: string): boolean;
 
@@ -491,6 +510,7 @@ export namespace CMenu {
          * Sets the application as the default handler for the given file extension.
          * @param extension a string containing the file extension (without   the dot).
          * @returns `TRUE` on success, `FALSE` on error.
+         * @throws GLib.Error
          */
         set_as_default_for_extension(extension: string): boolean;
 
@@ -498,6 +518,7 @@ export namespace CMenu {
          * Sets the application as the default handler for a given type.
          * @param content_type the content type.
          * @returns `TRUE` on success, `FALSE` on error.
+         * @throws GLib.Error
          */
         set_as_default_for_type(content_type: string): boolean;
 
@@ -508,6 +529,7 @@ export namespace CMenu {
          * application for that content type.
          * @param content_type the content type.
          * @returns `TRUE` on success, `FALSE` on error.
+         * @throws GLib.Error
          */
         set_as_last_used_for_type(content_type: string): boolean;
 
@@ -541,6 +563,7 @@ export namespace CMenu {
         /**
          * Obtains the information whether the {@link Gio.AppInfo} can be deleted.
          * See {@link Gio.AppInfo.delete}.
+         * @since 2.20
          * @virtual
          */
         vfunc_can_delete(): boolean;
@@ -557,6 +580,7 @@ export namespace CMenu {
          * On some platforms, there may be a difference between user-defined
          * {@link Gio.AppInfo}s which can be deleted, and system-wide ones which cannot.
          * See {@link Gio.AppInfo.can_delete}.
+         * @since 2.20
          * @virtual
          */
         vfunc_do_delete(): boolean;
@@ -581,6 +605,7 @@ export namespace CMenu {
         /**
          * Gets the commandline with which the application will be
          * started.
+         * @since 2.20
          * @virtual
          */
         vfunc_get_commandline(): string | null;
@@ -594,6 +619,7 @@ export namespace CMenu {
         /**
          * Gets the display name of the application. The display name is often more
          * descriptive to the user than the name itself.
+         * @since 2.24
          * @virtual
          */
         vfunc_get_display_name(): string;
@@ -639,6 +665,7 @@ export namespace CMenu {
          * This function does not take in consideration associations added with
          * {@link Gio.AppInfo.add_supports_type}, but only those exported directly by
          * the application.
+         * @since 2.34
          * @virtual
          */
         vfunc_get_supported_types(): string[] | null;
@@ -707,6 +734,7 @@ export namespace CMenu {
          * @param context the launch context
          * @param cancellable a {@link Gio.Cancellable}
          * @param callback a {@link Gio.AsyncReadyCallback} to call   when the request is done
+         * @since 2.60
          * @virtual
          */
         vfunc_launch_uris_async(uris: string[] | null, context: Gio.AppLaunchContext | null, cancellable: Gio.Cancellable | null, callback: Gio.AsyncReadyCallback<this> | null): void;
@@ -714,6 +742,7 @@ export namespace CMenu {
         /**
          * Finishes a {@link Gio.AppInfo.launch_uris_async} operation.
          * @param result the async result
+         * @since 2.60
          * @virtual
          */
         vfunc_launch_uris_finish(result: Gio.AsyncResult): boolean;
@@ -915,6 +944,7 @@ export namespace CMenu {
          * performs a significant amount of blocking I/O if the
          * tree has not been loaded yet.
          * @returns `true` on success, `false` on error
+         * @throws GLib.Error
          */
         load_sync(): boolean;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@girs/cmenu-3.0",
-    "version": "4.3.0",
+    "version": "4.5.0",
     "description": "GJS TypeScript type definitions for CMenu-3.0",
     "type": "module",
     "module": "cmenu-3.0.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": "*"
     },