@girs/xreaderview-1.5 5.0.0 → 5.2.0

package/README.md

@@ -4,7 +4,7 @@
 ![version](https://img.shields.io/npm/v/@girs/xreaderview-1.5)
 ![downloads/week](https://img.shields.io/npm/dw/@girs/xreaderview-1.5)
 
-GJS TypeScript type definitions for XreaderView-1.5 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v5.0.0.
+GJS TypeScript type definitions for XreaderView-1.5 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v5.2.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.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@girs/xreaderview-1.5",
-    "version": "5.0.0",
+    "version": "5.2.0",
     "description": "GJS TypeScript type definitions for XreaderView-1.5",
     "type": "module",
     "module": "xreaderview-1.5.js",
@@ -36,21 +36,21 @@
       "test": "tsc --project tsconfig.json"
     },
     "dependencies": {
-      "@girs/gjs": "^5.0.0",
-      "@girs/xreaderdocument-1.5": "^5.0.0",
-      "@girs/gtk-3.0": "^5.0.0",
-      "@girs/xlib-2.0": "^5.0.0",
-      "@girs/gdk-3.0": "^5.0.0",
-      "@girs/cairo-1.0": "^5.0.0",
-      "@girs/gobject-2.0": "^5.0.0",
-      "@girs/glib-2.0": "^5.0.0",
-      "@girs/pango-1.0": "^5.0.0",
-      "@girs/harfbuzz-0.0": "^5.0.0",
-      "@girs/freetype2-2.0": "^5.0.0",
-      "@girs/gio-2.0": "^5.0.0",
-      "@girs/gmodule-2.0": "^5.0.0",
-      "@girs/gdkpixbuf-2.0": "^5.0.0",
-      "@girs/atk-1.0": "^5.0.0"    },
+      "@girs/gjs": "^5.2.0",
+      "@girs/xreaderdocument-1.5": "^5.2.0",
+      "@girs/gtk-3.0": "^5.2.0",
+      "@girs/xlib-2.0": "^5.2.0",
+      "@girs/gdk-3.0": "^5.2.0",
+      "@girs/cairo-1.0": "^5.2.0",
+      "@girs/gobject-2.0": "^5.2.0",
+      "@girs/glib-2.0": "^5.2.0",
+      "@girs/pango-1.0": "^5.2.0",
+      "@girs/harfbuzz-0.0": "^5.2.0",
+      "@girs/freetype2-2.0": "^5.2.0",
+      "@girs/gio-2.0": "^5.2.0",
+      "@girs/gmodule-2.0": "^5.2.0",
+      "@girs/gdkpixbuf-2.0": "^5.2.0",
+      "@girs/atk-1.0": "^5.2.0"    },
     "devDependencies": {
       "typescript": "*"
     },

package/xreaderview-1.5-vocabulary.d.ts

@@ -1,9 +1,9 @@
 /**
  * The GIR-derived widget VOCABULARY for XreaderView-1.5.
  *
- * GENERATED — do not edit. Provenance: XreaderView-1.5 — dropped empty base(s): GObject.InitiallyUnowned GObject.Object Atk.ImplementorIface
+ * GENERATED — do not edit. Provenance: XreaderView-1.5 — dropped empty base(s): GObject.Object GObject.InitiallyUnowned Atk.ImplementorIface
  *
- * 2 concrete widgets, 2 declarations, 4 enum nick unions, 0 slot candidates.
+ * 16 instantiable GTypes (of which 2 concrete widgets), 17 declarations, 4 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
@@ -53,6 +53,102 @@ export type EvViewSelectionModeNick = 'text' | 'rectangle';
 // GIR keeps them once, on the interface.
 // ---------------------------------------------------------------------------
 
+export interface EvDocumentModelProps {
+    /** @default TRUE */
+    continuous?: boolean;
+    document?: XreaderDocument.Document;
+    /** @default FALSE */
+    'dual-odd-left'?: boolean;
+    /** @default FALSE */
+    'dual-page'?: boolean;
+    /** @default FALSE */
+    fullscreen?: boolean;
+    /** @default FALSE */
+    'inverted-colors'?: boolean;
+    /** @default -1 */
+    page?: number;
+    /** @default 0 */
+    rotation?: number;
+    /** @default FALSE */
+    rtl?: boolean;
+    /** @default 1.000000 */
+    scale?: number;
+    /** @default EV_SIZING_FIT_WIDTH */
+    'sizing-mode'?: EvSizingModeNick | XreaderView.SizingMode;
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type EvDocumentModelConstructOnly = never;
+
+export interface EvJobProps {
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type EvJobConstructOnly = never;
+
+export interface EvJobAnnotsProps extends EvJobProps {
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type EvJobAnnotsConstructOnly = EvJobConstructOnly;
+
+export interface EvJobAttachmentsProps extends EvJobProps {
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type EvJobAttachmentsConstructOnly = EvJobConstructOnly;
+
+export interface EvJobExportProps extends EvJobProps {
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type EvJobExportConstructOnly = EvJobConstructOnly;
+
+export interface EvJobFindProps extends EvJobProps {
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type EvJobFindConstructOnly = EvJobConstructOnly;
+
+export interface EvJobFontsProps extends EvJobProps {
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type EvJobFontsConstructOnly = EvJobConstructOnly;
+
+export interface EvJobLayersProps extends EvJobProps {
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type EvJobLayersConstructOnly = EvJobConstructOnly;
+
+export interface EvJobLinksProps extends EvJobProps {
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type EvJobLinksConstructOnly = EvJobConstructOnly;
+
+export interface EvJobLoadProps extends EvJobProps {
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type EvJobLoadConstructOnly = EvJobConstructOnly;
+
+export interface EvJobPageDataProps extends EvJobProps {
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type EvJobPageDataConstructOnly = EvJobConstructOnly;
+
+export interface EvJobPrintProps extends EvJobProps {
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type EvJobPrintConstructOnly = EvJobConstructOnly;
+
+export interface EvJobRenderProps extends EvJobProps {
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type EvJobRenderConstructOnly = EvJobConstructOnly;
+
+export interface EvJobSaveProps extends EvJobProps {
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type EvJobSaveConstructOnly = EvJobConstructOnly;
+
+export interface EvJobThumbnailProps extends EvJobProps {
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type EvJobThumbnailConstructOnly = EvJobConstructOnly;
+
 export interface EvViewProps extends GtkContainerProps, GtkBuildableProps, GtkScrollableProps {
 }
 /** Settable only at construction — a renderer must REBUILD, not patch. */
@@ -102,7 +198,11 @@ export interface Widgets {
     };
 }
 
-/** Every GType this namespace can create. A consumer derives its own tag map. */
+/**
+ * Every GType this namespace can create AND put on screen. A consumer derives its own
+ * tag map. For everything a UI file can instantiate — layout managers, event
+ * controllers, cell renderers, `GtkSizeGroup` — read `DECLS` below.
+ */
 export type WidgetGType = keyof Widgets;
 
 // ---------------------------------------------------------------------------
@@ -154,7 +254,14 @@ export const PROVENANCE: {
     readonly childHolders: number;
     readonly droppedBases: readonly string[];
     readonly inlinedBases: readonly string[];
+    /** `<decl>.<prop>` for every property printed `never` because TypeScript has no value for it. */
     readonly unsettableProps: readonly string[];
+    /**
+     * `<decl>.<prop>: <Ns>.<Name>` for every property printed `never` because the model
+     * could not resolve its type across a namespace boundary — two independently released
+     * GIRs disagreeing, which is what the main emitter answers `never` for as well.
+     */
+    readonly unresolvedProps: readonly string[];
 };
 
 /** Declaration GType -> its own settable properties, as GObject registered them. */
@@ -168,7 +275,17 @@ export const OWN_PROPS: Readonly<Record<string, readonly string[]>>;
  */
 export const OWN_SIGNALS: Readonly<Record<string, readonly string[]>>;
 
-/** Widget GType -> every declaration its members come from, self first. */
+/**
+ * Instantiable GType -> every declaration its members come from, self first.
+ *
+ * The key set is what a UI description file can NAME: every registered, non-abstract
+ * class this namespace declares. GtkBuilder resolves a `<object class="…">` through
+ * `g_type_from_name`, which knows nothing about widgets, so this is wider than
+ * `Widgets` by design — `GtkSizeGroup`, `GtkTextTag`, every `GtkEventController`
+ * and every `GtkCellRenderer` are here and are not widgets.
+ *
+ * `Widgets` and `CHILD_HOLDERS` are the narrower questions and answer them unchanged.
+ */
 export const DECLS: Readonly<Record<string, readonly string[]>>;
 
 /** The GTypes in `DECLS` that hold a widget without being one — see `ChildHolders`. */
@@ -180,8 +297,8 @@ export const ENUM_NICKS: Readonly<Record<string, readonly string[]>>;
 /**
  * `<enum GType>.<nick>` -> the integer GObject registers for it, from GIR's `value`.
  *
- * Position in `ENUM_NICKS` is NOT this number. Counting is wrong on 6 of the 129 enums a
- * GTK 4 vocabulary carries -- 104 in Gtk-4.0 and 25 in Adw-1: `GtkResponseType` runs -1 to -11, `GtkTextWindowType` starts
+ * Position in `ENUM_NICKS` is NOT this number. Counting is wrong on 6 of the 137 enums a
+ * GTK 4 vocabulary carries -- 112 in Gtk-4.0 and 25 in Adw-1: `GtkResponseType` runs -1 to -11, `GtkTextWindowType` starts
  * at 1, `GtkOrdering` and `GtkConstraintRelation` are -1/0/1, `GtkAlign` has two names
  * on one value, and `GtkConstraintStrength.required` is 1001001000 where counting says 0.
  *
@@ -219,10 +336,11 @@ export const ENUM_VALUES_UNREADABLE: Readonly<Record<string, string>>;
  *
  * `ENUM_NICKS` carries no bitfield, because GObject cannot resolve a nick SET; that says
  * nothing about a single member's number, and the number is what a host without GI needs.
- * 21 writable widget properties in Gtk-4.0 and Adw-1 are bitfield-typed and are declared
- * bare `number` -- `GtkEntry:input-hints`, `GtkPopoverMenu:flags`, `AdwTabView:shortcuts`
- * among them. Counting is worst here: 95 of 121 Gtk-4.0 bitfield members disagree with their
- * position, against 29 of 685 enumeration members.
+ * 23 settable properties in Gtk-4.0 and Adw-1 are bitfield-typed and are declared bare
+ * `number` -- `GtkEntry:input-hints`, `GtkPopoverMenu:flags`, `AdwTabView:shortcuts`,
+ * `GtkDropTarget:actions` among them. Counting is worst here: 119 of the 156 Gtk-4.0
+ * bitfield members this vocabulary carries disagree with their declaration position,
+ * against 29 of 672 enumeration members.
  *
  * Combine with `|` as GObject does. There is no nick table to pair this with, so a name
  * here is resolvable and a SET still is not.
@@ -246,13 +364,52 @@ export const FLAG_VALUES_UNREADABLE: Readonly<Record<string, string>>;
  *
  * The GType named here is not always one THIS module gives numbers for. A nick vocabulary is
  * emitted once, by the namespace that owns the enum, so `AdwComboRow.search-match-mode` names
- * `GtkStringFilterMatchMode` and its rows are in `@girs/gtk-4.0/vocabulary` — 57 of the 438
+ * `GtkStringFilterMatchMode` and its rows are in `@girs/gtk-4.0/vocabulary` — 83 of the 909
  * entries in a full run resolve only with the owner's vocabulary loaded beside this one. An
  * owner with no vocabulary of its own (Gdk, Pango) is inlined here instead, so every entry
  * resolves against SOME module.
  */
 export const PROP_ENUMS: Readonly<Record<string, string>>;
 
+/**
+ * The kinds of value a GTK accessible property, relation or state takes.
+ *
+ * `enum` is the one that needs a second lookup: `ARIA_VALUE_ENUMS` names the enum GType,
+ * and `ENUM_NICKS` and `ENUM_VALUES` answer from there.
+ */
+export type AriaValueType = 'string' | 'integer' | 'double' | 'boolean' | 'reference' | 'enum';
+
+/**
+ * `<enum GType>.<nick>` -> the kind of value that ARIA slot takes.
+ *
+ * The one table in this file that is not a fact about a ParamSpec. A GtkBuilder or
+ * Blueprint `accessibility { … }` block is typed by GTK's ARIA table, not by the widget,
+ * and the two disagree where it costs most: `orientation` is settable on a `GtkLabel`
+ * that implements no `GtkOrientable`, and `checked` is a `GtkAccessibleTristate`, so
+ * `checked: true` is the number 1 rather than a boolean. Typing those slots from the
+ * widget's properties gets both wrong and raises nothing.
+ *
+ * Keyed like `ENUM_VALUES` because the ARIA names ARE enum members — of
+ * `GtkAccessibleProperty`, `GtkAccessibleRelation` and `GtkAccessibleState` — so
+ * `ENUM_NICKS` already lists them and one key parser reads both.
+ *
+ * Read from each member's own GIR documentation. `gtk_accessible_property_init_value()`
+ * is the C half of this table and is not introspectable; the doc sentence is, and states
+ * the type for 52 of the 53 members in gtk4 4.23.3. Complete or absent, never partial: a
+ * member the generator cannot answer for fails the build and names itself.
+ */
+export const ARIA_VALUE_TYPES: Readonly<Record<string, AriaValueType>>;
+
+/**
+ * The same keys, for the `'enum'` rows only -> the GType of that enum.
+ *
+ * A table of its own for the reason `PROP_ENUMS` is one: folded in, the values of
+ * `ARIA_VALUE_TYPES` would be six reserved words mixed with arbitrary GTypes and telling
+ * them apart would be the consumer's problem. Apart, `ARIA_VALUE_TYPES[k] === 'enum'` is
+ * the whole test and `ENUM_NICKS[ARIA_VALUE_ENUMS[k]]` is the nick list.
+ */
+export const ARIA_VALUE_ENUMS: Readonly<Record<string, string>>;
+
 /** Widget GType -> slot name -> the method that may adopt a child there. */
 export const SLOT_CANDIDATES: Readonly<Record<string, Readonly<Record<string, string>>>>;
 

package/xreaderview-1.5-vocabulary.js

@@ -1,6 +1,6 @@
 // The widget vocabulary of XreaderView-1.5 as runtime data.
 //
-// GENERATED — do not edit. Provenance: XreaderView-1.5 — dropped empty base(s): GObject.InitiallyUnowned GObject.Object Atk.ImplementorIface
+// GENERATED — do not edit. Provenance: XreaderView-1.5 — dropped empty base(s): GObject.Object GObject.InitiallyUnowned 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
@@ -11,29 +11,57 @@ export const PROVENANCE = {
     version: '1.5',
     libraryVersion: null,
     childHolders: 0,
-    droppedBases: ['GObject.InitiallyUnowned', 'GObject.Object', 'Atk.ImplementorIface'],
+    droppedBases: ['GObject.Object', 'GObject.InitiallyUnowned', 'Atk.ImplementorIface'],
     inlinedBases: [],
     unsettableProps: [],
+    unresolvedProps: [],
 };
 
 export const OWN_PROPS = {
+    EvDocumentModel: ['continuous', 'document', 'dual-odd-left', 'dual-page', 'fullscreen', 'inverted-colors', 'page', 'rotation', 'rtl', 'scale', 'sizing-mode'],
     EvViewPresentation: ['current-page', 'document', 'inverted-colors', 'rotation'],
 };
 
 export const OWN_SIGNALS = {
+    EvDocumentModel: ['page-changed'],
+    EvJob: ['cancelled', 'finished'],
+    EvJobFind: ['updated'],
+    EvJobFonts: ['updated'],
     EvView: ['activate', 'annot-added', 'annot-removed', 'binding-activated', 'external-link', 'handle-link', 'layers-changed', 'popup', 'selection-changed', 'sync-source'],
     EvViewPresentation: ['change-page', 'external-link', 'finished'],
 };
 
+// Every GType this namespace can INSTANTIATE -> the declarations its members come from.
+//
+// The key set is what a UI description file can name: a registered, non-abstract class.
+// Not "every widget" — GtkBuilder resolves a name through `g_type_from_name`, which knows
+// nothing about widgets, and a `.ui` file is full of `GtkSizeGroup`, `GtkTextTag`,
+// `GtkEventController*` and `GtkCellRenderer*`. Use `Widgets` and `CHILD_HOLDERS`
+// below for the narrower questions; they did not move.
 export const DECLS = {
+    EvDocumentModel: ['EvDocumentModel'],
+    EvJobAnnots: ['EvJobAnnots', 'EvJob'],
+    EvJobAttachments: ['EvJobAttachments', 'EvJob'],
+    EvJobExport: ['EvJobExport', 'EvJob'],
+    EvJobFind: ['EvJobFind', 'EvJob'],
+    EvJobFonts: ['EvJobFonts', 'EvJob'],
+    EvJobLayers: ['EvJobLayers', 'EvJob'],
+    EvJobLinks: ['EvJobLinks', 'EvJob'],
+    EvJobLoad: ['EvJobLoad', 'EvJob'],
+    EvJobPageData: ['EvJobPageData', 'EvJob'],
+    EvJobPrint: ['EvJobPrint', 'EvJob'],
+    EvJobRender: ['EvJobRender', 'EvJob'],
+    EvJobSave: ['EvJobSave', 'EvJob'],
+    EvJobThumbnail: ['EvJobThumbnail', 'EvJob'],
     EvView: ['EvView', 'GtkContainer', 'GtkWidget', 'GtkBuildable', 'GtkScrollable'],
     EvViewPresentation: ['EvViewPresentation', 'GtkWidget', '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.
+// The GTypes above that ARE widgets are the `Widgets` map in the sibling `.d.ts`; these
+// are the ones that merely HOLD one, through `set_child`/`get_child`, descending 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 = {
@@ -48,7 +76,7 @@ export const ENUM_NICKS = {
 // It ships because position in `ENUM_NICKS` is not the value and a consumer with no
 // typelib has no other way to learn it: a surface without GI still has to hand GObject an
 // integer. The alternative a consumer reaches for first is counting, and counting is wrong
-// on 6 of the 129 enums a GTK 4 vocabulary carries (104 in Gtk-4.0, 25 in Adw-1) --
+// on 6 of the 137 enums a GTK 4 vocabulary carries (112 in Gtk-4.0, 25 in Adw-1) --
 // `GtkResponseType` runs -1 down to
 // -11, `GtkTextWindowType` starts at 1, and `GtkConstraintStrength.required` is
 // 1001001000 where counting answers 0.
@@ -98,11 +126,12 @@ export const ENUM_VALUES_UNREADABLE = {};
 // The number behind each member of a registered BITFIELD, keyed the same way.
 //
 // `ENUM_NICKS` refuses a bitfield because GObject cannot resolve a nick SET, and that
-// reason says nothing about one member's number. 21 writable widget properties in Gtk-4.0
-// and Adw-1 are bitfield-typed -- `GtkEntry:input-hints`, `GtkPopoverMenu:flags`,
-// `AdwTabView:shortcuts`, ... -- and they are typed bare `number`, so a host without GI
-// has nothing to compute one from. Counting is worst exactly here: 95 of 121 Gtk-4.0
-// bitfield members disagree with their position, against 29 of 685 enumeration members.
+// reason says nothing about one member's number. 23 settable properties in Gtk-4.0 and
+// Adw-1 are bitfield-typed -- `GtkEntry:input-hints`, `GtkPopoverMenu:flags`,
+// `AdwTabView:shortcuts`, `GtkDropTarget:actions`, ... -- and they are typed bare
+// `number`, so a host without GI has nothing to compute one from. Counting is worst
+// exactly here: 119 of the 156 Gtk-4.0 bitfield members this vocabulary carries disagree
+// with their declaration position, against 29 of 672 enumeration members.
 //
 // A table of its own rather than more rows in `ENUM_VALUES`, so that "every nick in
 // `ENUM_NICKS` has a number or a declared reason" stays a claim about one set.
@@ -135,9 +164,36 @@ export const FLAG_VALUES_UNREADABLE = {};
 // one are both entries a consumer would resolve wrongly, so neither is written.
 //
 // A GType named here has numbers in SOME vocabulary, not necessarily this one: the namespace
-// that OWNS an enum publishes it, so 57 of the 438 entries a full run emits want the owner's
+// that OWNS an enum publishes it, so 83 of the 909 entries a full run emits want the owner's
 // vocabulary loaded too. Owners that emit none (Gdk, Pango) are inlined into the tables above.
-export const PROP_ENUMS = {};
+export const PROP_ENUMS = {
+    'EvDocumentModel.sizing-mode': 'EvSizingMode',
+};
+
+// `<enum GType>.<nick>` -> the kind of value that ARIA slot takes.
+//
+// The one table here that is not about a ParamSpec. A GtkBuilder or Blueprint
+// `accessibility { … }` block is typed by GTK's ARIA table instead, and the two disagree
+// where it matters: `orientation` is settable on a `GtkLabel` that implements no
+// `GtkOrientable` and has no such property, and `checked` is a `GtkAccessibleTristate`, so
+// `checked: true` means the number 1 and not the boolean. A consumer typing those slots
+// from the widget gets both wrong, silently.
+//
+// Read from each member's own documentation, which is where GTK keeps the table --
+// `gtk_accessible_property_init_value()` is the C half and is not introspectable, the
+// sentence is. Complete or absent, never partial: a member whose documentation states no
+// value type fails generation and names itself, because a missing row is indistinguishable
+// from "GTK has no such name" and the plausible fallback emits `true` where GTK means 1.
+export const ARIA_VALUE_TYPES = {};
+
+// The same keys, for the `'enum'` rows only -> the GType of the enum.
+//
+// The join on from a kind to a number, and a table of its own for the reason `PROP_ENUMS`
+// is one: folding the GType into `ARIA_VALUE_TYPES` would make its values a mix of six
+// reserved words and arbitrary GTypes, and telling them apart would be the consumer's
+// problem. With this, `ARIA_VALUE_TYPES[k] === 'enum'` is the whole test, and
+// `ENUM_NICKS[ARIA_VALUE_ENUMS[k]]` is the nick list.
+export const ARIA_VALUE_ENUMS = {};
 
 export const SLOT_CANDIDATES = {};