@girs/amtk-5 4.2.0 → 4.3.0

package/README.md

@@ -5,25 +5,25 @@
 ![downloads/week](https://img.shields.io/npm/dw/@girs/amtk-5)
 
 
-GJS TypeScript type definitions for Amtk-5 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.2.0.
+GJS TypeScript type definitions for Amtk-5 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/amtk-5
 ```
 
 ## Usage
 
-You can import this package into your project like this:
+Import it like any other module:
 ```ts
 import Amtk from '@girs/amtk-5';
 ```
 
 ### 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/amtk-5` or `@girs/amtk-5/ambient` in your `tsconfig` or entry point Typescript file:
 
 `index.ts`:
@@ -42,7 +42,7 @@ import '@girs/amtk-5'
 }
 ```
 
-Now you can import the ambient module with TypeScript support: 
+The ambient module now resolves with types:
 
 ```ts
 import Amtk from 'gi://Amtk?version=5';
@@ -50,7 +50,7 @@ import Amtk from 'gi://Amtk?version=5';
 
 ### 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/amtk-5` or `@girs/amtk-5/import` in your `tsconfig` or entry point Typescript file:
 
 `index.ts`:
@@ -69,7 +69,7 @@ import '@girs/amtk-5'
 }
 ```
 
-Now you have also type support for this, too:
+That form carries types as well:
 
 ```ts
 const Amtk = imports.gi.Amtk;
@@ -77,7 +77,7 @@ const Amtk = imports.gi.Amtk;
 
 ### 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/amtk-5-surface.d.ts

@@ -0,0 +1,138 @@
+/**
+ * The GIR-derived widget VOCABULARY for Amtk-5.
+ *
+ * GENERATED — do not edit. Provenance: Amtk-5 — dropped empty base(s): GObject.InitiallyUnowned GObject.Object Atk.ImplementorIface
+ *
+ * 1 concrete widgets, 1 declarations, 0 enum nick unions, 0 slot candidates.
+ *
+ * Module-scoped exports only. There is no `JSX` namespace here, no tag spelling and
+ * no `on<Signal>` prop name: those are DIALECT, and every framework answers them
+ * differently. The shape to avoid is the GLOBAL AUGMENT — a `declare global` on
+ * `React.JSX` collides with every other library on a shared tag — while a
+ * module-scoped `JSX` behind a `jsxImportSource` does not. This package is used by
+ * projects that want nothing to do with JSX, so it emits neither; a consumer declaring
+ * a module-scoped namespace over these names is doing it right.
+ *
+ * Three things this is and `ConstructorProps` is not: WRITABLE-only (measured on
+ * Gtk-4.0, `ConstructorProps` offers 150 read-only properties across 68 classes as
+ * settable, and GTK's failure mode for writing one is exit 0), OPTIONAL, and keyed
+ * by the name GObject actually REGISTERED — the dashed spelling `g_object_set`,
+ * GtkBuilder XML and Blueprint all use.
+ *
+ * Signal handler types are not re-derived: `X.SignalSignatures`, which this package
+ * already emits for every class with the parent chain, every implemented interface
+ * and the `notify::` keys folded in, is what `Widgets[G]['signals']` points at.
+ */
+
+import type Amtk from './amtk-5.js';
+import type { GtkBinConstructOnly, GtkBinProps, GtkBuildableConstructOnly, GtkBuildableProps, GtkContainerConstructOnly, GtkContainerProps, GtkScrolledWindowConstructOnly, GtkScrolledWindowProps, GtkWidgetConstructOnly, GtkWidgetProps } from '@girs/gtk-3.0/surface';
+
+// ---------------------------------------------------------------------------
+// Enum nicks — the string vocabulary GObject registered, from GIR's `glib:nick`.
+//
+// Not derived from the member name. Substituting underscores for dashes is not a law:
+// some nicks keep an underscore the substitution would have replaced, and only the
+// attribute knows which. Gtk-4.0 and Adw-1 contradict no derivation at all, which is
+// how a derived nick passes review and breaks elsewhere.
+// Re-measure with `scripts/check-nick-derivation.mjs` in ts-for-gir.
+// ---------------------------------------------------------------------------
+
+
+
+// ---------------------------------------------------------------------------
+// Property surfaces — one interface per GIR DECLARATION, mirroring GIR's own
+// inheritance rather than flattening per widget.
+//
+// The interfaces are load-bearing, not tidiness: `GtkBox` declares four properties
+// of its own and `orientation` is not among them — it lives on `Gtk.Orientable`,
+// because GObject installs interface properties on the implementor at runtime while
+// GIR keeps them once, on the interface.
+// ---------------------------------------------------------------------------
+
+export interface AmtkTreeViewScrolledWindowSizingProps extends GtkScrolledWindowProps, GtkBuildableProps {
+    /**
+     * Whether to take the #GdkMonitor size into account as a maximum width and height to apply.
+     * @since 5.10
+     */
+    'monitor-limit-enabled'?: boolean;
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type AmtkTreeViewScrolledWindowSizingConstructOnly = GtkScrolledWindowConstructOnly | GtkBuildableConstructOnly;
+
+// ---------------------------------------------------------------------------
+// The GType-keyed widget map.
+//
+// Keyed by GType because that is also the GtkBuilder XML key and the typelib key. A
+// consumer maps GTypes to tags in ITS convention — kebab for JSX intrinsics, Pascal
+// for a Vue `GlobalComponents`, the class itself for a renderer whose element type
+// is the class. None of those is baked in here.
+//
+// `slotCandidates` is a candidate list and never an answer: derived from methods
+// taking exactly one widget argument. The GIR cannot tell adoption from reference —
+// `set_title_widget` parents its argument and `set_activatable_widget` does not, and
+// both are `void f(GtkWidget*)` at `transfer-ownership="none"`. Curation decides;
+// this is what notices when a release adds a candidate.
+// ---------------------------------------------------------------------------
+
+export interface Widgets {
+    AmtkTreeViewScrolledWindowSizing: {
+        class: Amtk.TreeViewScrolledWindowSizing;
+        props: AmtkTreeViewScrolledWindowSizingProps;
+        signals: Amtk.TreeViewScrolledWindowSizing.SignalSignatures;
+        constructOnly: AmtkTreeViewScrolledWindowSizingConstructOnly;
+        slotCandidates: {};
+    };
+}
+
+/** Every GType this namespace can create. A consumer derives its own tag map. */
+export type WidgetGType = keyof Widgets;
+
+/** The writable, optional, GObject-keyed property surface of one GType. */
+export type PropsOf<G extends WidgetGType> = Widgets[G]['props'];
+
+/** The signal table this package already emits, reached by GType. */
+export type SignalsOf<G extends WidgetGType> = Widgets[G]['signals'];
+
+/** The instance type — what a `ref`-shaped prop should infer. */
+export type InstanceOf<G extends WidgetGType> = Widgets[G]['class'];
+
+/** Property names that can only be set at construction. */
+export type ConstructOnlyOf<G extends WidgetGType> = Widgets[G]['constructOnly'];
+
+/** Candidate child slots — see the note above; curation decides. */
+export type SlotCandidatesOf<G extends WidgetGType> = keyof Widgets[G]['slotCandidates'];
+
+/**
+ * The same facts as runtime data, for a consumer that CHECKS them.
+ *
+ * Types are erased, so a spec that asks the installed GTK whether every property
+ * here is a writable ParamSpec, every signal resolvable by `GObject.signal_lookup`
+ * and every nick resolvable through an enum lookup cannot read the interfaces
+ * above. Emitted headlessly with no GTK present, which is exactly why the checking
+ * belongs to the consumer and the DATA belongs here.
+ */
+export const SURFACE_PROVENANCE: string;
+
+/** Declaration GType -> its own settable properties, as GObject registered them. */
+export const OWN_PROPS: Readonly<Record<string, readonly string[]>>;
+
+/** Widget GType -> its own signals. */
+export const OWN_SIGNALS: Readonly<Record<string, readonly string[]>>;
+
+/** Widget GType -> every declaration its members come from, self first. */
+export const DECLS: Readonly<Record<string, readonly string[]>>;
+
+/** Enum GType -> the nicks this surface offers. */
+export const ENUM_NICKS: Readonly<Record<string, readonly string[]>>;
+
+/** Widget GType -> slot name -> the method that may adopt a child there. */
+export const SLOT_CANDIDATES: Readonly<Record<string, Readonly<Record<string, string>>>>;
+
+/**
+ * `Type.property` -> the release that introduced it.
+ *
+ * What keeps a runtime cross-check honest across a version gap without an
+ * allowlist: a member the installed library lacks is a defect UNLESS the version
+ * here is newer than the one running.
+ */
+export const SINCE: Readonly<Record<string, string>>;

package/amtk-5-surface.js

@@ -0,0 +1,27 @@
+// The widget vocabulary of Amtk-5 as runtime data.
+//
+// GENERATED — do not edit. Provenance: Amtk-5 — dropped empty base(s): GObject.InitiallyUnowned GObject.Object Atk.ImplementorIface
+//
+// The type half of this subpath is the sibling `.d.ts`. This file exists because
+// types are erased: a consumer that wants to ask the installed library whether every
+// name here is real needs values, not declarations.
+
+export const SURFACE_PROVENANCE = 'Amtk-5 — dropped empty base(s): GObject.InitiallyUnowned GObject.Object Atk.ImplementorIface';
+
+export const OWN_PROPS = {
+    AmtkTreeViewScrolledWindowSizing: ['monitor-limit-enabled'],
+};
+
+export const OWN_SIGNALS = {};
+
+export const DECLS = {
+    AmtkTreeViewScrolledWindowSizing: ['AmtkTreeViewScrolledWindowSizing', 'GtkScrolledWindow', 'GtkBin', 'GtkContainer', 'GtkWidget', 'GtkBuildable'],
+};
+
+export const ENUM_NICKS = {};
+
+export const SLOT_CANDIDATES = {};
+
+export const SINCE = {
+    'AmtkTreeViewScrolledWindowSizing.monitor-limit-enabled': '5.10',
+};

package/amtk-5.d.ts

@@ -991,6 +991,149 @@ export namespace Amtk {
     }
 
 
+    namespace TreeViewScrolledWindowSizing {
+        // Signal signatures
+        interface SignalSignatures extends Gtk.ScrolledWindow.SignalSignatures {
+            "notify::monitor-limit-enabled": (pspec: GObject.ParamSpec) => void;
+            "notify::hadjustment": (pspec: GObject.ParamSpec) => void;
+            "notify::hscrollbar-policy": (pspec: GObject.ParamSpec) => void;
+            "notify::kinetic-scrolling": (pspec: GObject.ParamSpec) => void;
+            "notify::max-content-height": (pspec: GObject.ParamSpec) => void;
+            "notify::max-content-width": (pspec: GObject.ParamSpec) => void;
+            "notify::min-content-height": (pspec: GObject.ParamSpec) => void;
+            "notify::min-content-width": (pspec: GObject.ParamSpec) => void;
+            "notify::overlay-scrolling": (pspec: GObject.ParamSpec) => void;
+            "notify::propagate-natural-height": (pspec: GObject.ParamSpec) => void;
+            "notify::propagate-natural-width": (pspec: GObject.ParamSpec) => void;
+            "notify::shadow-type": (pspec: GObject.ParamSpec) => void;
+            "notify::vadjustment": (pspec: GObject.ParamSpec) => void;
+            "notify::vscrollbar-policy": (pspec: GObject.ParamSpec) => void;
+            "notify::window-placement": (pspec: GObject.ParamSpec) => void;
+            "notify::window-placement-set": (pspec: GObject.ParamSpec) => void;
+            "notify::border-width": (pspec: GObject.ParamSpec) => void;
+            "notify::child": (pspec: GObject.ParamSpec) => void;
+            "notify::resize-mode": (pspec: GObject.ParamSpec) => void;
+            "notify::app-paintable": (pspec: GObject.ParamSpec) => void;
+            "notify::can-default": (pspec: GObject.ParamSpec) => void;
+            "notify::can-focus": (pspec: GObject.ParamSpec) => void;
+            "notify::composite-child": (pspec: GObject.ParamSpec) => void;
+            "notify::double-buffered": (pspec: GObject.ParamSpec) => void;
+            "notify::events": (pspec: GObject.ParamSpec) => void;
+            "notify::expand": (pspec: GObject.ParamSpec) => void;
+            "notify::focus-on-click": (pspec: GObject.ParamSpec) => void;
+            "notify::halign": (pspec: GObject.ParamSpec) => void;
+            "notify::has-default": (pspec: GObject.ParamSpec) => void;
+            "notify::has-focus": (pspec: GObject.ParamSpec) => void;
+            "notify::has-tooltip": (pspec: GObject.ParamSpec) => void;
+            "notify::height-request": (pspec: GObject.ParamSpec) => void;
+            "notify::hexpand": (pspec: GObject.ParamSpec) => void;
+            "notify::hexpand-set": (pspec: GObject.ParamSpec) => void;
+            "notify::is-focus": (pspec: GObject.ParamSpec) => void;
+            "notify::margin": (pspec: GObject.ParamSpec) => void;
+            "notify::margin-bottom": (pspec: GObject.ParamSpec) => void;
+            "notify::margin-end": (pspec: GObject.ParamSpec) => void;
+            "notify::margin-left": (pspec: GObject.ParamSpec) => void;
+            "notify::margin-right": (pspec: GObject.ParamSpec) => void;
+            "notify::margin-start": (pspec: GObject.ParamSpec) => void;
+            "notify::margin-top": (pspec: GObject.ParamSpec) => void;
+            "notify::name": (pspec: GObject.ParamSpec) => void;
+            "notify::no-show-all": (pspec: GObject.ParamSpec) => void;
+            "notify::opacity": (pspec: GObject.ParamSpec) => void;
+            "notify::parent": (pspec: GObject.ParamSpec) => void;
+            "notify::receives-default": (pspec: GObject.ParamSpec) => void;
+            "notify::scale-factor": (pspec: GObject.ParamSpec) => void;
+            "notify::sensitive": (pspec: GObject.ParamSpec) => void;
+            "notify::style": (pspec: GObject.ParamSpec) => void;
+            "notify::tooltip-markup": (pspec: GObject.ParamSpec) => void;
+            "notify::tooltip-text": (pspec: GObject.ParamSpec) => void;
+            "notify::valign": (pspec: GObject.ParamSpec) => void;
+            "notify::vexpand": (pspec: GObject.ParamSpec) => void;
+            "notify::vexpand-set": (pspec: GObject.ParamSpec) => void;
+            "notify::visible": (pspec: GObject.ParamSpec) => void;
+            "notify::width-request": (pspec: GObject.ParamSpec) => void;
+            "notify::window": (pspec: GObject.ParamSpec) => void;
+        }
+
+        // Constructor properties interface
+        interface ConstructorProps extends Gtk.ScrolledWindow.ConstructorProps, Atk.ImplementorIface.ConstructorProps, Gtk.Buildable.ConstructorProps {
+            monitor_limit_enabled: boolean;
+            monitorLimitEnabled: boolean;
+        }
+    }
+
+    /**
+     * @gir-type Class
+     */
+    class TreeViewScrolledWindowSizing extends Gtk.ScrolledWindow implements Atk.ImplementorIface, Gtk.Buildable {
+        static $gtype: GObject.GType<TreeViewScrolledWindowSizing>;
+
+        // Properties
+        /**
+         * Whether to take the {@link Gdk.Monitor} size into account as a maximum width
+         * and height to apply.
+         * @since 5.10
+         * @default true
+         */
+        get monitor_limit_enabled(): boolean;
+        set monitor_limit_enabled(val: boolean);
+
+        /**
+         * Whether to take the {@link Gdk.Monitor} size into account as a maximum width
+         * and height to apply.
+         * @since 5.10
+         * @default true
+         */
+        get monitorLimitEnabled(): boolean;
+        set monitorLimitEnabled(val: boolean);
+
+        /**
+         * Compile-time signal type information.
+         *
+         * This instance property is generated only for TypeScript type checking.
+         * It is not defined at runtime and should not be accessed in JS code.
+         * @internal
+         */
+        $signals: TreeViewScrolledWindowSizing.SignalSignatures;
+
+        // Constructors
+        constructor(properties?: Partial<TreeViewScrolledWindowSizing.ConstructorProps>, ...args: any[]);
+
+        _init(...args: any[]): void;
+
+        static ["new"](): TreeViewScrolledWindowSizing;
+
+        // Signals
+        /** @signal */
+        connect<K extends keyof TreeViewScrolledWindowSizing.SignalSignatures>(signal: K, callback: GObject.SignalCallback<this, TreeViewScrolledWindowSizing.SignalSignatures[K]>): number;
+        connect(signal: string, callback: (...args: any[]) => any): number;
+
+        /** @signal */
+        connect_after<K extends keyof TreeViewScrolledWindowSizing.SignalSignatures>(signal: K, callback: GObject.SignalCallback<this, TreeViewScrolledWindowSizing.SignalSignatures[K]>): number;
+        connect_after(signal: string, callback: (...args: any[]) => any): number;
+
+        /** @signal */
+        emit<K extends keyof TreeViewScrolledWindowSizing.SignalSignatures>(signal: K, ...args: GObject.GjsParameters<TreeViewScrolledWindowSizing.SignalSignatures[K]> extends [any, ...infer Q] ? Q : never): void;
+        emit(signal: string, ...args: any[]): void;
+
+        // Methods
+        /**
+         * @returns the current value of the   {@link Amtk.TreeViewScrolledWindowSizing.monitor_limit_enabled} property.
+         */
+        get_monitor_limit(): boolean;
+
+        /**
+         * @returns the {@link Gtk.TreeView}, if the child widget is   a {@link Gtk.TreeView}. Otherwise `null` is returned.
+         */
+        get_tree_view(): Gtk.TreeView | null;
+
+        /**
+         * Sets the {@link Amtk.TreeViewScrolledWindowSizing.monitor_limit_enabled} property.
+         * @param monitor_limit the new value.
+         */
+        set_monitor_limit(monitor_limit: boolean): void;
+    }
+
+
     /**
      * @gir-type Struct
      */
@@ -1201,6 +1344,19 @@ export namespace Amtk {
     }
 
 
+    /**
+     * @gir-type Alias
+     */
+    type TreeViewScrolledWindowSizingClass = typeof TreeViewScrolledWindowSizing;
+
+    /**
+     * @gir-type Struct
+     */
+    abstract class TreeViewScrolledWindowSizingPrivate {
+        static $gtype: GObject.GType<TreeViewScrolledWindowSizingPrivate>;
+    }
+
+
     /**
      * Name of the imported GIR library
      * `see` https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L188

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@girs/amtk-5",
-    "version": "4.2.0",
+    "version": "4.3.0",
     "description": "GJS TypeScript type definitions for Amtk-5",
     "type": "module",
     "module": "amtk-5.js",
@@ -16,6 +16,11 @@
         "import": "./amtk-5-import.js",
         "default": "./amtk-5-import.js"
       },
+      "./surface": {
+        "types": "./amtk-5-surface.d.ts",
+        "import": "./amtk-5-surface.js",
+        "default": "./amtk-5-surface.js"
+      },
       "./amtk-5": {
         "types": "./amtk-5.d.ts",
         "import": "./amtk-5.js",
@@ -31,20 +36,20 @@
       "test": "tsc --project tsconfig.json"
     },
     "dependencies": {
-      "@girs/gjs": "^4.2.0",
-      "@girs/gtk-3.0": "^4.2.0",
-      "@girs/xlib-2.0": "^4.2.0",
-      "@girs/gdk-3.0": "^4.2.0",
-      "@girs/cairo-1.0": "^4.2.0",
-      "@girs/gobject-2.0": "^4.2.0",
-      "@girs/glib-2.0": "^4.2.0",
-      "@girs/pango-1.0": "^4.2.0",
-      "@girs/harfbuzz-0.0": "^4.2.0",
-      "@girs/freetype2-2.0": "^4.2.0",
-      "@girs/gio-2.0": "^4.2.0",
-      "@girs/gmodule-2.0": "^4.2.0",
-      "@girs/gdkpixbuf-2.0": "^4.2.0",
-      "@girs/atk-1.0": "^4.2.0"    },
+      "@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"    },
     "devDependencies": {
       "typescript": "*"
     },

package/tsconfig.json

@@ -62,7 +62,7 @@
       ]
 }
   },
-  "include": ["./amtk-5.d.ts"]
+  "include": ["./amtk-5.d.ts","./amtk-5-surface.d.ts"]
 }