@girs/gspell-1 4.4.0 → 4.6.0

package/README.md

@@ -4,82 +4,96 @@
 ![version](https://img.shields.io/npm/v/@girs/gspell-1)
 ![downloads/week](https://img.shields.io/npm/dw/@girs/gspell-1)
 
+GJS TypeScript type definitions for Gspell-1 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.6.0.
 
-GJS TypeScript type definitions for Gspell-1 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/gspell-1
 ```
 
-## Usage
+Any package manager works. The package has no dependencies beyond other `@girs/*`
+type packages.
+
+## What it exports
+
+| Import | What you get |
+|---|---|
+| `@girs/gspell-1` | the namespace as a default export, plus the ambient and global declarations |
+| `@girs/gspell-1/ambient` | only the `gi://` module declarations |
+| `@girs/gspell-1/import` | only the `imports.gi` declarations |
+| `@girs/gspell-1/gspell-1` | the namespace, without the side-effecting declarations |
+| `@girs/gspell-1/vocabulary` | GIR-derived widget data: settable properties, enum nicks, slot candidates |
+
+## 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 Gspell from '@girs/gspell-1';
 ```
 
-### 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/gspell-1` or `@girs/gspell-1/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/gspell-1'
+import '@girs/gspell-1';
 ```
 
-`tsconfig.json`:
 ```json
-{
-  "compilerOptions": {
-    ...
-  },
-  "include": ["@girs/gspell-1"],
-  ...
-}
+{ "include": ["@girs/gspell-1"] }
 ```
 
-The ambient module now resolves with types:
+Then the runtime spelling type-checks:
 
 ```ts
 import Gspell from 'gi://Gspell?version=1';
 ```
 
-### Global import
+Referencing `@girs/gspell-1/ambient` instead pulls in these declarations
+alone. See [ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules).
+
+### As `imports.gi`
 
-GJS's global `imports.gi` works too, with types.
-For this you need to include `@girs/gspell-1` or `@girs/gspell-1/import` in your `tsconfig` or entry point Typescript file:
+GJS's global object works the same way, via `@girs/gspell-1/import`:
 
-`index.ts`:
 ```ts
-import '@girs/gspell-1'
+const Gspell = imports.gi.Gspell;
 ```
 
-`tsconfig.json`:
-```json
-{
-  "compilerOptions": {
-    ...
-  },
-  "include": ["@girs/gspell-1"],
-  ...
-}
-```
+## Widget vocabulary
 
-That form carries types as well:
+`gspell-1` declares widgets, so it also carries what the GIR says about them, as
+types and as values a test can read:
 
 ```ts
-const Gspell = imports.gi.Gspell;
+import type { Widgets, PropsOf } from '@girs/gspell-1/vocabulary';
+import { OWN_PROPS, ENUM_NICKS, PROVENANCE } from '@girs/gspell-1/vocabulary';
 ```
 
-### Bundle
+Properties are keyed the way GObject registered them, writable-only and optional, so they
+match `g_object_set`, GtkBuilder XML and Blueprint. `PROVENANCE.libraryVersion` names the
+library release this was generated from, which lets a check tell "newer than what is
+installed" from "wrong".
 
-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.
+This subpath answers what the GIR says, not what the installed library has. For the
+second question, ask the library.
+
+## Building
+
+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/gspell-1-vocabulary.d.ts

@@ -0,0 +1,212 @@
+/**
+ * The GIR-derived widget VOCABULARY for Gspell-1.
+ *
+ * GENERATED — do not edit. Provenance: Gspell-1 — dropped empty base(s): GObject.InitiallyUnowned GObject.Object Atk.ImplementorIface
+ *
+ * 3 concrete widgets, 4 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 Gspell from './gspell-1.js';
+import type { GtkActionableConstructOnly, GtkActionableProps, GtkActivatableConstructOnly, GtkActivatableProps, GtkBinConstructOnly, GtkBinProps, GtkBuildableConstructOnly, GtkBuildableProps, GtkButtonConstructOnly, GtkButtonProps, GtkContainerConstructOnly, GtkContainerProps, GtkDialogConstructOnly, GtkDialogProps, GtkWidgetConstructOnly, GtkWidgetProps, GtkWindowConstructOnly, GtkWindowProps } from '@girs/gtk-3.0/vocabulary';
+
+// ---------------------------------------------------------------------------
+// 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 GspellCheckerDialogProps extends GtkDialogProps, GtkBuildableProps {
+    /** The #GspellNavigator to use. */
+    'spell-navigator'?: Gspell.Navigator;
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type GspellCheckerDialogConstructOnly = GtkDialogConstructOnly | GtkBuildableConstructOnly | 'spell-navigator';
+
+export interface GspellLanguageChooserProps {
+    /** The selected #GspellLanguage. */
+    language?: Gspell.Language | null;
+    /** The empty string if the default language was set and the selection hasn't changed. */
+    'language-code'?: string;
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type GspellLanguageChooserConstructOnly = never;
+
+export interface GspellLanguageChooserButtonProps extends GtkButtonProps, GspellLanguageChooserProps, GtkActionableProps, GtkActivatableProps, GtkBuildableProps {
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type GspellLanguageChooserButtonConstructOnly = GtkButtonConstructOnly | GspellLanguageChooserConstructOnly | GtkActionableConstructOnly | GtkActivatableConstructOnly | GtkBuildableConstructOnly;
+
+export interface GspellLanguageChooserDialogProps extends GtkDialogProps, GspellLanguageChooserProps, GtkBuildableProps {
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type GspellLanguageChooserDialogConstructOnly = GtkDialogConstructOnly | GspellLanguageChooserConstructOnly | 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 {
+    GspellCheckerDialog: {
+        class: Gspell.CheckerDialog;
+        props: GspellCheckerDialogProps;
+        signals: Gspell.CheckerDialog.SignalSignatures;
+        constructOnly: GspellCheckerDialogConstructOnly;
+        slotCandidates: {};
+    };
+    GspellLanguageChooserButton: {
+        class: Gspell.LanguageChooserButton;
+        props: GspellLanguageChooserButtonProps;
+        signals: Gspell.LanguageChooserButton.SignalSignatures;
+        constructOnly: GspellLanguageChooserButtonConstructOnly;
+        slotCandidates: {};
+    };
+    GspellLanguageChooserDialog: {
+        class: Gspell.LanguageChooserDialog;
+        props: GspellLanguageChooserDialogProps;
+        signals: Gspell.LanguageChooserDialog.SignalSignatures;
+        constructOnly: GspellLanguageChooserDialogConstructOnly;
+        slotCandidates: {};
+    };
+}
+
+/** Every GType this namespace can create. A consumer derives its own tag map. */
+export type WidgetGType = keyof Widgets;
+
+// ---------------------------------------------------------------------------
+// Child holders — the same shape, for objects that CARRY a widget without being one.
+//
+// `GtkListItem`, `GtkListHeader`, `GtkColumnViewCell` and `AdwToggle` descend from
+// `GObject.Object` and hold a widget through `set_child`/`get_child`. A renderer places
+// them exactly like a container, so they belong in the vocabulary; a check asking "is
+// this a widget" must still be able to say no. Hence a sibling table rather than four
+// more rows in `Widgets`: concatenate them when you mean both.
+// ---------------------------------------------------------------------------
+
+export interface ChildHolders {
+
+}
+
+/** Every GType this namespace holds a child in without it being a widget. */
+export type ChildHolderGType = keyof ChildHolders;
+
+/** 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 PROVENANCE: {
+    readonly namespace: string;
+    readonly version: string;
+    /** The version the LIBRARY states, or null where it states none. Never the namespace's. */
+    readonly libraryVersion: string | null;
+    readonly childHolders: number;
+    readonly droppedBases: readonly string[];
+    readonly inlinedBases: readonly string[];
+    readonly unsettableProps: readonly string[];
+};
+
+/** Declaration GType -> its own settable properties, as GObject registered them. */
+export const OWN_PROPS: Readonly<Record<string, readonly string[]>>;
+
+/**
+ * Declaration GType -> the signals it registers itself, never its parents'.
+ *
+ * Keyed like `OWN_PROPS`, so both are read at every link of a `DECLS` chain. An
+ * abstract base has no `Widgets` row and still owns signals — `GtkWidget` owns 13.
+ */
+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[]>>;
+
+/** The GTypes in `DECLS` that hold a widget without being one — see `ChildHolders`. */
+export const CHILD_HOLDERS: 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`, `Type.property` and `Type::signal` -> the release that introduced it.
+ *
+ * What keeps a runtime cross-check honest across a version gap without an
+ * allowlist: a name the installed library lacks is a defect UNLESS the version
+ * here is newer than the one running.
+ *
+ * ALL THREE key shapes, because that test only works for the names it covers. A
+ * property-only map leaves a consumer no way to explain a missing SIGNAL, which is
+ * a correct vocabulary reported as 18 defects; a member-only map leaves it no way to
+ * explain a missing CLASS, and that one fails as a bare
+ * `TypeError: can't access property "$gtype", ctor() is undefined` that does not
+ * even name the GType.
+ *
+ * A key is present only where the GIR states a version — sparse by nature (`version`
+ * sits on 29 of the 301 classes and interfaces in Gtk-4.0), never inferred.
+ */
+export const SINCE: Readonly<Record<string, string>>;

package/gspell-1-vocabulary.js

@@ -0,0 +1,42 @@
+// The widget vocabulary of Gspell-1 as runtime data.
+//
+// GENERATED — do not edit. Provenance: Gspell-1 — 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 PROVENANCE = {
+    namespace: 'Gspell',
+    version: '1',
+    libraryVersion: null,
+    childHolders: 0,
+    droppedBases: ['GObject.InitiallyUnowned', 'GObject.Object', 'Atk.ImplementorIface'],
+    inlinedBases: [],
+    unsettableProps: [],
+};
+
+export const OWN_PROPS = {
+    GspellCheckerDialog: ['spell-navigator'],
+    GspellLanguageChooser: ['language', 'language-code'],
+};
+
+export const OWN_SIGNALS = {};
+
+export const DECLS = {
+    GspellCheckerDialog: ['GspellCheckerDialog', 'GtkDialog', 'GtkWindow', 'GtkBin', 'GtkContainer', 'GtkWidget', 'GtkBuildable'],
+    GspellLanguageChooserButton: ['GspellLanguageChooserButton', 'GtkButton', 'GtkBin', 'GtkContainer', 'GtkWidget', 'GspellLanguageChooser', 'GtkActionable', 'GtkActivatable', 'GtkBuildable'],
+    GspellLanguageChooserDialog: ['GspellLanguageChooserDialog', 'GtkDialog', 'GtkWindow', 'GtkBin', 'GtkContainer', 'GtkWidget', 'GspellLanguageChooser', 'GtkBuildable'],
+};
+
+// The GTypes above that are NOT widgets: they hold one through `set_child`/`get_child`
+// and descend from `GObject.Object`. A renderer places them like a container; a check
+// asking "is this a widget" must not count them. Derived from the accessor pair, never
+// from a list — the count is in the provenance line above.
+export const CHILD_HOLDERS = [];
+
+export const ENUM_NICKS = {};
+
+export const SLOT_CANDIDATES = {};
+
+export const SINCE = {};

package/gspell-1.d.ts

@@ -92,14 +92,14 @@ export namespace Gspell {
              * @signal
              * @run-last
              */
-            "word-added-to-personal": (arg0: string) => void;
+            "word-added-to-personal": (word: string) => void;
             /**
              * Emitted when a word is added to the session dictionary. See
              * `gspell_checker_add_word_to_session()`.
              * @signal
              * @run-last
              */
-            "word-added-to-session": (arg0: string) => void;
+            "word-added-to-session": (word: string) => void;
             "notify::language": (pspec: GObject.ParamSpec) => void;
         }
 
@@ -196,6 +196,7 @@ export namespace Gspell {
          * @param word the word to check.
          * @param word_length the byte length of `word`, or -1 if `word` is nul-terminated.
          * @returns `true` if `word` is correctly spelled, `false` otherwise.
+         * @throws GLib.Error
          */
         check_word(word: string, word_length: bigint | number): boolean;
 
@@ -1440,6 +1441,7 @@ export namespace Gspell {
          * Goes to the next misspelled word. When called the first time, goes to the
          * first misspelled word.
          * @returns `true` if a next misspelled word has been found, `false` if the spell checking is finished or if an error occurred.
+         * @throws GLib.Error
          */
         goto_next(): [boolean, string, Checker | null];
 
@@ -2032,6 +2034,7 @@ export namespace Gspell {
          * Goes to the next misspelled word. When called the first time, goes to the
          * first misspelled word.
          * @returns `true` if a next misspelled word has been found, `false` if the spell checking is finished or if an error occurred.
+         * @throws GLib.Error
          */
         goto_next(): [boolean, string, Checker | null];
     }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@girs/gspell-1",
-    "version": "4.4.0",
+    "version": "4.6.0",
     "description": "GJS TypeScript type definitions for Gspell-1",
     "type": "module",
     "module": "gspell-1.js",
@@ -16,10 +16,10 @@
         "import": "./gspell-1-import.js",
         "default": "./gspell-1-import.js"
       },
-      "./surface": {
-        "types": "./gspell-1-surface.d.ts",
-        "import": "./gspell-1-surface.js",
-        "default": "./gspell-1-surface.js"
+      "./vocabulary": {
+        "types": "./gspell-1-vocabulary.d.ts",
+        "import": "./gspell-1-vocabulary.js",
+        "default": "./gspell-1-vocabulary.js"
       },
       "./gspell-1": {
         "types": "./gspell-1.d.ts",
@@ -36,20 +36,20 @@
       "test": "tsc --project tsconfig.json"
     },
     "dependencies": {
-      "@girs/gjs": "^4.4.0",
-      "@girs/gtk-3.0": "^4.4.0",
-      "@girs/xlib-2.0": "^4.4.0",
-      "@girs/gdk-3.0": "^4.4.0",
-      "@girs/cairo-1.0": "^4.4.0",
-      "@girs/gobject-2.0": "^4.4.0",
-      "@girs/glib-2.0": "^4.4.0",
-      "@girs/pango-1.0": "^4.4.0",
-      "@girs/harfbuzz-0.0": "^4.4.0",
-      "@girs/freetype2-2.0": "^4.4.0",
-      "@girs/gio-2.0": "^4.4.0",
-      "@girs/gmodule-2.0": "^4.4.0",
-      "@girs/gdkpixbuf-2.0": "^4.4.0",
-      "@girs/atk-1.0": "^4.4.0"    },
+      "@girs/gjs": "^4.6.0",
+      "@girs/gtk-3.0": "^4.6.0",
+      "@girs/xlib-2.0": "^4.6.0",
+      "@girs/gdk-3.0": "^4.6.0",
+      "@girs/cairo-1.0": "^4.6.0",
+      "@girs/gobject-2.0": "^4.6.0",
+      "@girs/glib-2.0": "^4.6.0",
+      "@girs/pango-1.0": "^4.6.0",
+      "@girs/harfbuzz-0.0": "^4.6.0",
+      "@girs/freetype2-2.0": "^4.6.0",
+      "@girs/gio-2.0": "^4.6.0",
+      "@girs/gmodule-2.0": "^4.6.0",
+      "@girs/gdkpixbuf-2.0": "^4.6.0",
+      "@girs/atk-1.0": "^4.6.0"    },
     "devDependencies": {
       "typescript": "*"
     },

package/tsconfig.json

@@ -62,7 +62,7 @@
       ]
 }
   },
-  "include": ["./gspell-1.d.ts","./gspell-1-surface.d.ts"]
+  "include": ["./gspell-1.d.ts","./gspell-1-vocabulary.d.ts"]
 }