@girs/amtk-4 4.3.0 → 4.5.0

package/README.md

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

@@ -198,38 +198,38 @@ export namespace Amtk {
         /**
          * No flags.
          */
-        FLAGS_NONE,
+        FLAGS_NONE = 0,
         /**
          * Do not call `gtk_actionable_set_action_name()`.
          */
-        IGNORE_GACTION,
+        IGNORE_GACTION = 1,
         /**
          * Do not set an icon.
          */
-        IGNORE_ICON,
+        IGNORE_ICON = 2,
         /**
          * Do not set a label/short description.
          */
-        IGNORE_LABEL,
+        IGNORE_LABEL = 4,
         /**
          * Do not set a tooltip/long description.
          */
-        IGNORE_TOOLTIP,
+        IGNORE_TOOLTIP = 8,
         /**
          * Ignore completely the accelerators.
          */
-        IGNORE_ACCELS,
+        IGNORE_ACCELS = 16,
         /**
          * Ignore the accelerators for
          *   documentation purposes only. For example do not add/configure a
          *   {@link Gtk.AccelLabel}.
          */
-        IGNORE_ACCELS_FOR_DOC,
+        IGNORE_ACCELS_FOR_DOC = 32,
         /**
          * Do not call
          *   `gtk_application_set_accels_for_action()`.
          */
-        IGNORE_ACCELS_FOR_APP,
+        IGNORE_ACCELS_FOR_APP = 64,
     }
 
 
@@ -275,12 +275,16 @@ export namespace Amtk {
         emit(signal: string, ...args: any[]): void;
 
         // Static methods
+        /**
+         * @since 3.0
+         */
         static get_singleton(): ActionInfoCentralStore;
 
         // Methods
         /**
          * @param action_name an action name.
          * @returns the found {@link Amtk.ActionInfo}, or `null`.
+         * @since 2.0
          */
         lookup(action_name: string): ActionInfo;
     }
@@ -336,6 +340,7 @@ export namespace Amtk {
          * {@link Amtk.ActionInfo} with the same action name. The stores take their own
          * reference on `info`.
          * @param info an {@link Amtk.ActionInfo}.
+         * @since 2.0
          */
         add(info: ActionInfo): void;
 
@@ -348,6 +353,7 @@ export namespace Amtk {
          * An API similar to `g_action_map_add_action_entries()`.
          * @param entries a pointer to the first item in an array of {@link Amtk.ActionInfoEntry} structs.
          * @param translation_domain a gettext domain, or `null`.
+         * @since 2.0
          */
         add_entries(entries: ActionInfoEntry[], translation_domain: string | null): void;
 
@@ -359,12 +365,14 @@ export namespace Amtk {
          * You probably want to call this function on the application store after
          * creating the menu and toolbar. But it can also be useful for a store provided
          * by a library, to easily see which actions are not used by the application.
+         * @since 2.0
          */
         check_all_used(): void;
 
         /**
          * @param action_name an action name.
          * @returns the found {@link Amtk.ActionInfo}, or `null`.
+         * @since 2.0
          */
         lookup(action_name: string): ActionInfo;
     }
@@ -445,6 +453,7 @@ export namespace Amtk {
          * Returns the {@link Amtk.ApplicationWindow} of `gtk_window`. The returned object is
          * guaranteed to be the same for the lifetime of `gtk_window`.
          * @param gtk_window a {@link Gtk.ApplicationWindow}.
+         * @since 2.0
          */
         static get_from_gtk_application_window(gtk_window: Gtk.ApplicationWindow): ApplicationWindow;
 
@@ -458,6 +467,7 @@ export namespace Amtk {
          * So `amtk_menu_item_set_long_description()` must have been called, which is the
          * case if the {@link Gtk.MenuItem} has been created with {@link Amtk.Factory}.
          * @param menu_shell a {@link Gtk.MenuShell}.
+         * @since 2.0
          */
         connect_menu_to_statusbar(menu_shell: Gtk.MenuShell): void;
 
@@ -469,6 +479,7 @@ export namespace Amtk {
          * The full path is retrieved with
          * `amtk_utils_recent_chooser_menu_get_item_uri()`.
          * @param menu a {@link Gtk.RecentChooserMenu}.
+         * @since 2.0
          */
         connect_recent_chooser_menu_to_statusbar(menu: Gtk.RecentChooserMenu): void;
 
@@ -488,6 +499,7 @@ export namespace Amtk {
          * `g_application_open()` is called (with an empty hint), so the {@link Gio.Application}
          * must have the {@link Gio.ApplicationFlags.HANDLES_OPEN} flag set.
          * @returns a new {@link Gtk.RecentChooserMenu}.
+         * @since 3.0
          */
         create_open_recent_menu(): Gtk.Widget;
 
@@ -496,22 +508,26 @@ export namespace Amtk {
          * submenu. The {@link Gtk.RecentChooserMenu} is created with
          * `amtk_application_window_create_open_recent_menu()`.
          * @returns a new {@link Gtk.MenuItem}.
+         * @since 2.0
          */
         create_open_recent_menu_item(): Gtk.Widget;
 
         /**
          * @returns the {@link Gtk.ApplicationWindow} of `amtk_window`.
+         * @since 2.0
          */
         get_application_window(): Gtk.ApplicationWindow;
 
         /**
          * @returns the {@link Amtk.ApplicationWindow.statusbar}.
+         * @since 2.0
          */
         get_statusbar(): Gtk.Statusbar | null;
 
         /**
          * Sets the {@link Amtk.ApplicationWindow.statusbar} property.
          * @param statusbar a {@link Gtk.Statusbar}, or `null`.
+         * @since 2.0
          */
         set_statusbar(statusbar: Gtk.Statusbar | null): void;
     }
@@ -601,6 +617,7 @@ export namespace Amtk {
          * information.
          * @param action_name an action name.
          * @returns a new {@link Gtk.CheckMenuItem} for `action_name`.
+         * @since 3.0
          */
         create_check_menu_item(action_name: string): Gtk.Widget;
 
@@ -616,6 +633,7 @@ export namespace Amtk {
          * @param action_name an action name.
          * @param flags {@link Amtk.FactoryFlags}.
          * @returns a new {@link Gtk.CheckMenuItem} for `action_name`.
+         * @since 3.0
          */
         create_check_menu_item_full(action_name: string, flags: FactoryFlags): Gtk.Widget;
 
@@ -624,6 +642,7 @@ export namespace Amtk {
          * {@link Amtk.Factory.default_flags}.
          * @param action_name an action name.
          * @returns a new {@link Gtk.MenuItem} for `action_name`.
+         * @since 3.0
          */
         create_menu_item(action_name: string): Gtk.Widget;
 
@@ -633,6 +652,7 @@ export namespace Amtk {
          * @param action_name an action name.
          * @param flags {@link Amtk.FactoryFlags}.
          * @returns a new {@link Gtk.MenuItem} for `action_name`.
+         * @since 3.0
          */
         create_menu_item_full(action_name: string, flags: FactoryFlags): Gtk.Widget;
 
@@ -644,6 +664,7 @@ export namespace Amtk {
          * information.
          * @param action_name an action name.
          * @returns a new {@link Gtk.MenuToolButton} for `action_name`.
+         * @since 3.0
          */
         create_menu_tool_button(action_name: string): Gtk.MenuToolButton;
 
@@ -656,6 +677,7 @@ export namespace Amtk {
          * @param action_name an action name.
          * @param flags {@link Amtk.FactoryFlags}.
          * @returns a new {@link Gtk.MenuToolButton} for `action_name`.
+         * @since 3.0
          */
         create_menu_tool_button_full(action_name: string, flags: FactoryFlags): Gtk.MenuToolButton;
 
@@ -664,6 +686,7 @@ export namespace Amtk {
          * {@link Amtk.Factory.default_flags}.
          * @param action_name an action name.
          * @returns a new {@link Gtk.ToolButton} for `action_name`.
+         * @since 3.0
          */
         create_tool_button(action_name: string): Gtk.ToolItem;
 
@@ -673,22 +696,26 @@ export namespace Amtk {
          * @param action_name an action name.
          * @param flags {@link Amtk.FactoryFlags}.
          * @returns a new {@link Gtk.ToolButton} for `action_name`.
+         * @since 3.0
          */
         create_tool_button_full(action_name: string, flags: FactoryFlags): Gtk.ToolItem;
 
         /**
          * @returns the {@link Amtk.Factory.application}.
+         * @since 3.0
          */
         get_application(): Gtk.Application | null;
 
         /**
          * @returns the {@link Amtk.Factory.default_flags}.
+         * @since 3.0
          */
         get_default_flags(): FactoryFlags;
 
         /**
          * Sets the {@link Amtk.Factory.default_flags} property.
          * @param default_flags the new value.
+         * @since 3.0
          */
         set_default_flags(default_flags: FactoryFlags): void;
     }
@@ -705,7 +732,7 @@ export namespace Amtk {
              * @since 2.0
              * @run-first
              */
-            "menu-item-deselected": (arg0: Gtk.MenuItem) => void;
+            "menu-item-deselected": (menu_item: Gtk.MenuItem) => void;
             /**
              * The ::menu-item-selected signal is emitted when the
              * {@link Gtk.MenuItem.SignalSignatures.select | Gtk.MenuItem::select} signal is emitted on a {@link Gtk.MenuItem} belonging
@@ -714,7 +741,7 @@ export namespace Amtk {
              * @since 2.0
              * @run-first
              */
-            "menu-item-selected": (arg0: Gtk.MenuItem) => void;
+            "menu-item-selected": (menu_item: Gtk.MenuItem) => void;
             "notify::menu-shell": (pspec: GObject.ParamSpec) => void;
         }
 
@@ -778,6 +805,7 @@ export namespace Amtk {
          * Returns the {@link Amtk.MenuShell} of `gtk_menu_shell`. The returned object is
          * guaranteed to be the same for the lifetime of `gtk_menu_shell`.
          * @param gtk_menu_shell a {@link Gtk.MenuShell}.
+         * @since 2.0
          */
         static get_from_gtk_menu_shell(gtk_menu_shell: Gtk.MenuShell): MenuShell;
 
@@ -797,6 +825,7 @@ export namespace Amtk {
         // Methods
         /**
          * @returns the {@link Gtk.MenuShell} of `amtk_menu_shell`.
+         * @since 2.0
          */
         get_menu_shell(): Gtk.MenuShell;
     }
@@ -818,6 +847,7 @@ export namespace Amtk {
         // Methods
         /**
          * @returns a copy of `info`. The copy will have a reference count of one.
+         * @since 2.0
          */
         copy(): ActionInfo;
 
@@ -826,27 +856,32 @@ export namespace Amtk {
          * returns a `null`-terminated array, to be suitable for
          * `gtk_application_set_accels_for_action()`.
          * @returns a `null`-terminated array of accelerators in the format understood by `gtk_accelerator_parse()`.
+         * @since 2.0
          */
         get_accels(): string[];
 
         /**
          * @returns the action name, or `null`. Example: `"win.save"`.
+         * @since 2.0
          */
         get_action_name(): string | null;
 
         /**
          * @returns the icon name, or `null`.
+         * @since 2.0
          */
         get_icon_name(): string | null;
 
         /**
          * Gets the label. The label has normally a mnemonic.
          * @returns the label (i.e. a short description), or `null`.
+         * @since 2.0
          */
         get_label(): string | null;
 
         /**
          * @returns the tooltip (i.e. a long description), or `null`.
+         * @since 2.0
          */
         get_tooltip(): string | null;
 
@@ -854,18 +889,21 @@ export namespace Amtk {
          * Returns whether `info` has been used (for example by an {@link Amtk.Factory}
          * function). See also `amtk_action_info_store_check_all_used()`.
          * @returns whether `info` has been used.
+         * @since 3.0
          */
         has_been_used(): boolean;
 
         /**
          * Mark `info` as used. An {@link Amtk.Factory} function that uses an {@link Amtk.ActionInfo}
          * should call this function. See `amtk_action_info_store_check_all_used()`.
+         * @since 3.0
          */
         mark_as_used(): void;
 
         /**
          * Increments the reference count of `info` by one.
          * @returns the passed in `info`.
+         * @since 2.0
          */
         ref(): ActionInfo;
 
@@ -875,34 +913,40 @@ export namespace Amtk {
          * `accels` must not be `null`, it must be a `null`-terminated array, to be
          * consistent with `gtk_application_set_accels_for_action()`.
          * @param accels a `null`-terminated array of accelerators in the format understood by `gtk_accelerator_parse()`.
+         * @since 2.0
          */
         set_accels(accels: string[]): void;
 
         /**
          * Sets the action name, for example `"win.save"`.
          * @param action_name the action name.
+         * @since 2.0
          */
         set_action_name(action_name: string): void;
 
         /**
          * @param icon_name the icon name, or `null`.
+         * @since 2.0
          */
         set_icon_name(icon_name: string | null): void;
 
         /**
          * Sets the label with a mnemonic.
          * @param label the label (i.e. a short description), or `null`.
+         * @since 2.0
          */
         set_label(label: string | null): void;
 
         /**
          * @param tooltip the tooltip (i.e. a long description), or `null`.
+         * @since 2.0
          */
         set_tooltip(tooltip: string | null): void;
 
         /**
          * Decrements the reference count of `info` by one. If the reference count drops
          * to 0, `info` is freed.
+         * @since 2.0
          */
         unref(): void;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@girs/amtk-4",
-    "version": "4.3.0",
+    "version": "4.5.0",
     "description": "GJS TypeScript type definitions for Amtk-4",
     "type": "module",
     "module": "amtk-4.js",
@@ -31,20 +31,20 @@
       "test": "tsc --project tsconfig.json"
     },
     "dependencies": {
-      "@girs/gjs": "^4.3.0",
-      "@girs/gtk-3.0": "^4.3.0",
-      "@girs/xlib-2.0": "^4.3.0",
-      "@girs/gdk-3.0": "^4.3.0",
-      "@girs/cairo-1.0": "^4.3.0",
-      "@girs/gobject-2.0": "^4.3.0",
-      "@girs/glib-2.0": "^4.3.0",
-      "@girs/pango-1.0": "^4.3.0",
-      "@girs/harfbuzz-0.0": "^4.3.0",
-      "@girs/freetype2-2.0": "^4.3.0",
-      "@girs/gio-2.0": "^4.3.0",
-      "@girs/gmodule-2.0": "^4.3.0",
-      "@girs/gdkpixbuf-2.0": "^4.3.0",
-      "@girs/atk-1.0": "^4.3.0"    },
+      "@girs/gjs": "^4.5.0",
+      "@girs/gtk-3.0": "^4.5.0",
+      "@girs/xlib-2.0": "^4.5.0",
+      "@girs/gdk-3.0": "^4.5.0",
+      "@girs/cairo-1.0": "^4.5.0",
+      "@girs/gobject-2.0": "^4.5.0",
+      "@girs/glib-2.0": "^4.5.0",
+      "@girs/pango-1.0": "^4.5.0",
+      "@girs/harfbuzz-0.0": "^4.5.0",
+      "@girs/freetype2-2.0": "^4.5.0",
+      "@girs/gio-2.0": "^4.5.0",
+      "@girs/gmodule-2.0": "^4.5.0",
+      "@girs/gdkpixbuf-2.0": "^4.5.0",
+      "@girs/atk-1.0": "^4.5.0"    },
     "devDependencies": {
       "typescript": "*"
     },