@girs/gtksource-300 4.1.0 → 4.3.0

package/README.md

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

@@ -0,0 +1,183 @@
+/**
+ * The GIR-derived widget VOCABULARY for GtkSource-300.
+ *
+ * GENERATED — do not edit. Provenance: GtkSource-300 — dropped empty base(s): GObject.InitiallyUnowned GObject.Object Atk.ImplementorIface
+ *
+ * 2 concrete widgets, 2 declarations, 9 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 GtkSource from './gtksource-300.js';
+import type { GtkBinConstructOnly, GtkBinProps, GtkBuildableConstructOnly, GtkBuildableProps, GtkContainerConstructOnly, GtkContainerProps, GtkScrollableConstructOnly, GtkScrollableProps, GtkTextViewConstructOnly, GtkTextViewProps, GtkWidgetConstructOnly, GtkWidgetProps, GtkWindowConstructOnly, GtkWindowProps } 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.
+// ---------------------------------------------------------------------------
+
+export type GtkSourceBracketMatchTypeNick = 'none' | 'out-of-range' | 'not-found' | 'found';
+export type GtkSourceChangeCaseTypeNick = 'lower' | 'upper' | 'toggle' | 'title';
+export type GtkSourceCompressionTypeNick = 'none' | 'gzip';
+export type GtkSourceEncodingDuplicatesNick = 'first' | 'last';
+export type GtkSourceGutterRendererAlignmentModeNick = 'cell' | 'first' | 'last';
+export type GtkSourceNewlineTypeNick = 'lf' | 'cr' | 'cr-lf';
+export type GtkSourceSmartHomeEndTypeNick = 'disabled' | 'before' | 'after' | 'always';
+export type GtkSourceStyleSchemeKindNick = 'light' | 'dark' | 'light-only' | 'dark-only';
+export type GtkSourceViewGutterPositionNick = 'lines' | 'marks';
+
+// ---------------------------------------------------------------------------
+// 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 GtkSourceCompletionInfoProps extends GtkWindowProps, GtkBuildableProps {
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type GtkSourceCompletionInfoConstructOnly = GtkWindowConstructOnly | GtkBuildableConstructOnly;
+
+export interface GtkSourceViewProps extends GtkTextViewProps, GtkBuildableProps, GtkScrollableProps {
+    /** Whether to enable auto indentation. */
+    'auto-indent'?: boolean;
+    /** Whether to highlight the current line. */
+    'highlight-current-line'?: boolean;
+    /** Whether to indent the selected text when the tab key is pressed. */
+    'indent-on-tab'?: boolean;
+    /** Width of an indentation step expressed in number of spaces. */
+    'indent-width'?: number;
+    /** Whether to insert spaces instead of tabs. */
+    'insert-spaces-instead-of-tabs'?: boolean;
+    /** The width in characters where to position the right margin. */
+    'right-margin-position'?: number;
+    /** Whether to display line mark pixbufs beside the text. */
+    'show-line-marks'?: boolean;
+    /** Whether to display line numbers beside the text. */
+    'show-line-numbers'?: boolean;
+    /** Whether to display the right margin. */
+    'show-right-margin'?: boolean;
+    /**
+     * Whether smart Backspace should be used.
+     * @since 3.18
+     */
+    'smart-backspace'?: boolean;
+    /**
+     * Set the behavior of the HOME and END keys.
+     * @since 2.0
+     */
+    'smart-home-end'?: GtkSourceSmartHomeEndTypeNick | GtkSource.SmartHomeEndType;
+    /** The width of a tabulation character expressed in number of spaces. */
+    'tab-width'?: number;
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type GtkSourceViewConstructOnly = GtkTextViewConstructOnly | GtkBuildableConstructOnly | GtkScrollableConstructOnly;
+
+// ---------------------------------------------------------------------------
+// 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 {
+    GtkSourceCompletionInfo: {
+        class: GtkSource.CompletionInfo;
+        props: GtkSourceCompletionInfoProps;
+        signals: GtkSource.CompletionInfo.SignalSignatures;
+        constructOnly: GtkSourceCompletionInfoConstructOnly;
+        slotCandidates: {};
+    };
+    GtkSourceView: {
+        class: GtkSource.View;
+        props: GtkSourceViewProps;
+        signals: GtkSource.View.SignalSignatures;
+        constructOnly: GtkSourceViewConstructOnly;
+        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/gtksource-300-surface.js

@@ -0,0 +1,41 @@
+// The widget vocabulary of GtkSource-300 as runtime data.
+//
+// GENERATED — do not edit. Provenance: GtkSource-300 — 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 = 'GtkSource-300 — dropped empty base(s): GObject.InitiallyUnowned GObject.Object Atk.ImplementorIface';
+
+export const OWN_PROPS = {
+    GtkSourceView: ['auto-indent', 'highlight-current-line', 'indent-on-tab', 'indent-width', 'insert-spaces-instead-of-tabs', 'right-margin-position', 'show-line-marks', 'show-line-numbers', 'show-right-margin', 'smart-backspace', 'smart-home-end', 'tab-width'],
+};
+
+export const OWN_SIGNALS = {
+    GtkSourceView: ['change-case', 'change-number', 'join-lines', 'line-mark-activated', 'move-lines', 'move-to-matching-bracket', 'move-words', 'redo', 'show-completion', 'smart-home-end', 'undo'],
+};
+
+export const DECLS = {
+    GtkSourceCompletionInfo: ['GtkSourceCompletionInfo', 'GtkWindow', 'GtkBin', 'GtkContainer', 'GtkWidget', 'GtkBuildable'],
+    GtkSourceView: ['GtkSourceView', 'GtkTextView', 'GtkContainer', 'GtkWidget', 'GtkBuildable', 'GtkScrollable'],
+};
+
+export const ENUM_NICKS = {
+    GtkSourceBracketMatchType: ['none', 'out-of-range', 'not-found', 'found'],
+    GtkSourceChangeCaseType: ['lower', 'upper', 'toggle', 'title'],
+    GtkSourceCompressionType: ['none', 'gzip'],
+    GtkSourceEncodingDuplicates: ['first', 'last'],
+    GtkSourceGutterRendererAlignmentMode: ['cell', 'first', 'last'],
+    GtkSourceNewlineType: ['lf', 'cr', 'cr-lf'],
+    GtkSourceSmartHomeEndType: ['disabled', 'before', 'after', 'always'],
+    GtkSourceStyleSchemeKind: ['light', 'dark', 'light-only', 'dark-only'],
+    GtkSourceViewGutterPosition: ['lines', 'marks'],
+};
+
+export const SLOT_CANDIDATES = {};
+
+export const SINCE = {
+    'GtkSourceView.smart-backspace': '3.18',
+    'GtkSourceView.smart-home-end': '2.0',
+};

package/gtksource-300.d.ts

@@ -998,6 +998,13 @@ export namespace GtkSource {
         emit<K extends keyof Buffer.SignalSignatures>(signal: K, ...args: GObject.GjsParameters<Buffer.SignalSignatures[K]> extends [any, ...infer Q] ? Q : never): void;
         emit(signal: string, ...args: any[]): void;
 
+        // Static methods
+        /**
+         * Removes one trailing newline of `buffer` if it contains at least one.
+         * @param buffer a {@link Gtk.TextBuffer}.
+         */
+        static remove_trailing_newline(buffer: Gtk.TextBuffer): void;
+
         // Virtual methods
         /**
          * @param iter 
@@ -2020,10 +2027,9 @@ export namespace GtkSource {
 
         // Methods
         /**
-         * Moves the {@link GtkSource.CompletionInfo} to `iter`. If `iter` is `null` `info` is
-         * moved to the cursor position. Moving will respect the {@link Gdk.Gravity} setting
-         * of the info window and will ensure the line at `iter` is not occluded by
-         * the window.
+         * Moves the {@link GtkSource.CompletionInfo} to `iter`. If `iter` is `null` `info` is moved
+         * to the cursor position. Moving will respect the {@link Gdk.Gravity} setting of the
+         * info window and will ensure the line at `iter` is not occluded by the window.
          * @param view a {@link Gtk.TextView} on which the info window should be positioned.
          * @param iter a {@link Gtk.TextIter}.
          */

package/package.json

@@ -1,8 +1,7 @@
 {
     "name": "@girs/gtksource-300",
-    "version": "4.1.0",
-    "libraryVersion": "300.0.0",
-    "description": "GJS TypeScript type definitions for GtkSource-300, generated from library version 300.0.0",
+    "version": "4.3.0",
+    "description": "GJS TypeScript type definitions for GtkSource-300",
     "type": "module",
     "module": "gtksource-300.js",
     "main": "gtksource-300.js",
@@ -17,6 +16,11 @@
         "import": "./gtksource-300-import.js",
         "default": "./gtksource-300-import.js"
       },
+      "./surface": {
+        "types": "./gtksource-300-surface.d.ts",
+        "import": "./gtksource-300-surface.js",
+        "default": "./gtksource-300-surface.js"
+      },
       "./gtksource-300": {
         "types": "./gtksource-300.d.ts",
         "import": "./gtksource-300.js",
@@ -32,20 +36,20 @@
       "test": "tsc --project tsconfig.json"
     },
     "dependencies": {
-      "@girs/gjs": "^4.1.0",
-      "@girs/gtk-3.0": "^4.1.0",
-      "@girs/xlib-2.0": "^4.1.0",
-      "@girs/gdk-3.0": "^4.1.0",
-      "@girs/cairo-1.0": "^4.1.0",
-      "@girs/gobject-2.0": "^4.1.0",
-      "@girs/glib-2.0": "^4.1.0",
-      "@girs/pango-1.0": "^4.1.0",
-      "@girs/harfbuzz-0.0": "^4.1.0",
-      "@girs/freetype2-2.0": "^4.1.0",
-      "@girs/gio-2.0": "^4.1.0",
-      "@girs/gmodule-2.0": "^4.1.0",
-      "@girs/gdkpixbuf-2.0": "^4.1.0",
-      "@girs/atk-1.0": "^4.1.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": ["./gtksource-300.d.ts"]
+  "include": ["./gtksource-300.d.ts","./gtksource-300-surface.d.ts"]
 }