@gjsify/adwaita-core 0.36.0 → 0.38.0

package/lib/types/conformance/preferences.d.ts

@@ -13,28 +13,24 @@ export interface PreferencesGroupHeaderVector {
      * markup-rendering gap is what retires the flag.
      */
     dependsOnMarkup?: boolean;
-    /** Why this row exists — the rule or the regression it pins down. */
     rule: string;
 }
 /**
  * `update_title_visibility` / `update_description_visibility` /
- * `update_listbox_visibility` / `is_single_line` / `update_header_visibility`
- * (adw-preferences-group.c:91-156).
+ * `update_listbox_visibility` / `is_single_line` / `update_header_visibility`.
  */
 export declare const PREFERENCES_GROUP_HEADER_VECTORS: ReadonlyArray<PreferencesGroupHeaderVector>;
 /** One `defaultCaseFolder` expectation. */
 export interface CaseFoldVector {
-    /** The string being folded. */
     text: string;
     /** `g_utf8_casefold(text)` — Unicode FULL case folding. */
     folded: string;
     /** What a bare `toLowerCase()` returns, kept in the table as the trap. */
     naiveLowerCase: string;
-    /** Why this row exists. */
     rule: string;
 }
 /**
- * `g_utf8_casefold` (adw-preferences-dialog.c:101, :133).
+ * `g_utf8_casefold`.
  *
  * Every row where `folded !== naiveLowerCase` is a query a `toLowerCase()` port
  * silently fails to match — in German, Greek and any text with a typographic
@@ -50,12 +46,10 @@ export interface StripMarkupVector {
     markup: string;
     /** The plain text, or `null` when `pango_parse_markup` fails. */
     plain: string | null;
-    /** Why this row exists. */
     rule: string;
 }
 /**
- * `pango_parse_markup (…, accel_marker 0, …)` as `make_comparable` calls it
- * (adw-preferences-dialog.c:104-114).
+ * `pango_parse_markup (…, accel_marker 0, …)` as `make_comparable` calls it.
  *
  * `null` is not an error case to be smoothed over: it is the branch where C
  * logs a `g_critical` and KEEPS the unparsed string, so every `null` row below
@@ -70,11 +64,10 @@ export interface StripMnemonicVector {
     text: string;
     /** What `adw_strip_mnemonic` returns. */
     stripped: string;
-    /** Why this row exists. */
     rule: string;
 }
 /**
- * `adw_strip_mnemonic` (adw-widget-utils.c:685-703) — `g_markup_escape_text`
+ * `adw_strip_mnemonic` — `g_markup_escape_text`
  * followed by `pango_parse_markup` with `accel_marker = '_'`.
  *
  * CORE-ONLY: an internal step of a pipeline whose COMPOSED result is renderer-driven — driving it separately would assert the same thing twice (PREFERENCES_SEARCH_VECTORS)
@@ -88,14 +81,13 @@ export interface MakeComparableVector {
     options: MakeComparableOptions;
     /** What the search compares against. */
     comparable: string;
-    /** Why this row exists. */
     rule: string;
 }
 /**
- * `make_comparable` (adw-preferences-dialog.c:96-123).
+ * `make_comparable`.
  *
  * The defaults matter as much as the rows: `use-markup` defaults to TRUE
- * (adw-preferences-row.c:185-188) and `use-underline` to FALSE (:155-158), so
+ * and `use-underline` to FALSE, so
  * an ordinary row's title IS markup-parsed and is NOT mnemonic-stripped.
  *
  * CORE-ONLY: an internal step of a pipeline whose COMPOSED result is renderer-driven — driving it separately would assert the same thing twice (PREFERENCES_SEARCH_VECTORS)
@@ -103,33 +95,30 @@ export interface MakeComparableVector {
 export declare const MAKE_COMPARABLE_VECTORS: ReadonlyArray<MakeComparableVector>;
 /** One `rowMatchesQuery` expectation. */
 export interface RowMatchVector {
-    /** The row being tested. */
     row: PreferencesSearchRow;
-    /** What the user typed into the search entry. */
     query: string;
     /** Whether `filter_search_results` keeps the row. */
     matches: boolean;
-    /** Why this row exists. */
     rule: string;
 }
-/** `filter_search_results` (adw-preferences-dialog.c:125-153).  *
+/**
+ * `filter_search_results`.
+ *
  * CORE-ONLY: an internal step of a pipeline whose COMPOSED result is renderer-driven — driving it separately would assert the same thing twice (PREFERENCES_SEARCH_VECTORS)
  */
 export declare const ROW_MATCH_VECTORS: ReadonlyArray<RowMatchVector>;
 /** One `collectSearchRows` expectation. */
 export interface SearchCorpusVector {
-    /** The page tree being indexed. */
     pages: readonly PreferencesSearchPage[];
     /** The row titles the corpus contains, in order. */
     titles: readonly string[];
-    /** Why this row exists. */
     rule: string;
 }
 /**
  * The three-filter chain: `adw_preferences_dialog_init`'s visible-page filter
- * (:632-641) over `adw_preferences_page_get_rows`' `is_visible_group`
- * (adw-preferences-page.c:831-834) over `adw_preferences_group_get_rows`'
- * `row_has_title` (adw-preferences-group.c:736-740).
+ * over `adw_preferences_page_get_rows`' `is_visible_group`
+ * over `adw_preferences_group_get_rows`'
+ * `row_has_title`.
  *
  * Dropping any clause is invisible — nothing errors, the search just quietly
  * indexes the wrong set — which is why these rows are separate from the
@@ -144,10 +133,11 @@ export interface SearchRowSubtitleVector {
     input: SearchRowSubtitleInput;
     /** The second line of the result row, `null` for none. */
     subtitle: string | null;
-    /** Why this row exists. */
     rule: string;
 }
-/** `create_search_row_subtitle` (adw-preferences-dialog.c:168-234).  *
+/**
+ * `create_search_row_subtitle`.
+ *
  * CORE-ONLY: an internal step of a pipeline whose COMPOSED result is renderer-driven — driving it separately would assert the same thing twice (PREFERENCES_SEARCH_VECTORS)
  */
 export declare const SEARCH_ROW_SUBTITLE_VECTORS: ReadonlyArray<SearchRowSubtitleVector>;
@@ -165,16 +155,13 @@ export declare const PREFERENCES_SEARCH_PAGES: ReadonlyArray<PreferencesSearchPa
 export interface PreferencesSearchExpectation {
     /** The result row's title — copied verbatim from the matched row. */
     title: string;
-    /** The result row's subtitle. */
     subtitle: string | null;
 }
 /** One end-to-end `searchPreferences` expectation over {@link PREFERENCES_SEARCH_PAGES}. */
 export interface PreferencesSearchVector {
-    /** What the user typed. */
     query: string;
     /** The results, in corpus order. */
     results: readonly PreferencesSearchExpectation[];
-    /** Why this row exists. */
     rule: string;
 }
 /**

package/lib/types/conformance/rows.d.ts

@@ -19,9 +19,7 @@ export type ComboSelectionStep = {
 };
 /** One combo-selection scenario. */
 export interface ComboSelectionVector {
-    /** Short scenario name. */
     name: string;
-    /** The mutations, applied in order to a fresh state. */
     steps: readonly ComboSelectionStep[];
     /** `selectedIndex` afterwards. */
     selected: number;
@@ -35,12 +33,11 @@ export interface ComboSelectionVector {
      * gated on `interactive`.
      */
     emitted: ReadonlyArray<ComboStateChange>;
-    /** Why this row exists — the rule or edge case it pins down. */
     rule: string;
 }
 /**
- * `adw_combo_row_set_selected` (adw-combo-row.c:772-789) and the notify chain it
- * drives (:136-155, :157-185), plus the two port answers the C leaves open (see
+ * `adw_combo_row_set_selected` and the notify chain it
+ * drives, plus the two port answers the C leaves open (see
  * the module header).
  *
  * Note that EVERY scenario starts with a `setOptions`, which is itself an
@@ -51,22 +48,18 @@ export interface ComboSelectionVector {
 export declare const COMBO_SELECTION_VECTORS: ReadonlyArray<ComboSelectionVector>;
 /** One `presentsChooser` expectation. */
 export interface ComboChooserVector {
-    /** How many options the model holds. */
     count: number;
     /** Whether the arrow is drawn and the row is activatable. */
     presentsChooser: boolean;
-    /** The rule this row pins down. */
     rule: string;
 }
 /**
- * `model_changed` (adw-combo-row.c:187-195) — one predicate, `n_items > 1`,
+ * `model_changed` — one predicate, `n_items > 1`,
  * driving BOTH `gtk_widget_set_visible (arrow_box, …)` and
  * `gtk_list_box_row_set_activatable (row, …)`.
  *
- * A row with one option or none has nothing to choose, so it stops presenting
- * itself as a chooser. Neither port did this: a NativeScript `AdwComboRow` with
- * a single option still showed its chevron and opened an `action()` sheet with
- * one entry, and the browser element behaved the same way.
+ * A row with one option or none has nothing to choose, so it stops presenting itself as a
+ * chooser: no chevron, and no sheet with a single entry in it.
  *
  * `Gtk.DropDown` is deliberately NOT covered — it keeps its arrow at any count,
  * which is why this lives on the combo ROW rather than in the shared chooser.

package/lib/types/conformance/shortcut-label.d.ts

@@ -0,0 +1,34 @@
+import type { ShortcutLabelNode } from '../shortcut-label.js';
+/**
+ * The compact form of a parse, so the CORE suite compares the same strings the
+ * renderer suites serialise their DOM into.
+ *
+ * It lives here rather than in a spec file for exactly that reason: two
+ * serialisers would be two definitions of "the same rendering", and the
+ * divergence would show up as a passing test on both sides.
+ */
+export declare function formatShortcutLabelNodes(nodes: readonly ShortcutLabelNode[]): string;
+/** One accelerator → rendering expectation. */
+export interface ShortcutLabelVector {
+    /** The `accelerator` property value. */
+    accelerator: string;
+    /** Compact rendering — see the header. */
+    expected: string;
+    /** `platform`, when the vector is about the Apple glyph set (:153-182). */
+    platform?: 'default' | 'apple';
+    /** `direction`, when the vector is about the sequence arrow (:439, :447). */
+    direction?: 'ltr' | 'rtl';
+    /** `disabled-text`, for the empty-accelerator vector (:513-520). */
+    disabledText?: string;
+    /** The accessible string — structure pinned, per-accelerator text is ours. */
+    accessibleLabel?: string;
+    /** The fragment that must fail to parse, if any (:531-534). */
+    error?: string;
+    /** Why this row exists. */
+    rule: string;
+}
+/**
+ * `AdwShortcutLabel`'s parse, across the four grammar levels and the label
+ * lookup (adw-shortcut-label.c:115-544).
+ */
+export declare const SHORTCUT_LABEL_VECTORS: ReadonlyArray<ShortcutLabelVector>;

package/lib/types/conformance/sidebar.d.ts

@@ -7,19 +7,17 @@ export interface SidebarClampVector {
     count: number;
     /** What `selected` reads back as: the index itself, or `-1` for no selection. */
     selected: number;
-    /** Why this row exists. */
     rule: string;
 }
 /**
- * `adw_sidebar_set_selected` (adw-sidebar.c:3028-3029):
+ * `adw_sidebar_set_selected`:
  * `if (selected >= self->n_items) selected = GTK_INVALID_LIST_POSITION;`
  *
- * The negative rows are not a TS invention — `selected` is a `guint`, so `-7`
- * arrives as `4294967289`, which is `>= n_items`. The fractional/`NaN` rows are
- * the generalisation to values C cannot express: not a valid position is no
- * position. They are the inputs that used to be wrong — the web port truncated
- * `"1.5"` to row 1 and the NativeScript port stored `1.5` verbatim, highlighting
- * no row while reporting a selection.
+ * The negative rows are not a TS invention — `selected` is a `guint`, so `-7` arrives as
+ * `4294967289`, which is `>= n_items`. The fractional/`NaN` rows generalise to values C
+ * cannot express: not a valid position is no position. Both are the inputs a port gets
+ * wrong by truncating `"1.5"` to row 1, or by storing `1.5` verbatim and then reporting a
+ * selection while highlighting no row.
  */
 export declare const SIDEBAR_CLAMP_VECTORS: ReadonlyArray<SidebarClampVector>;
 /** One `adjustSidebarSelection` expectation — an `items-changed` splice. */
@@ -38,11 +36,10 @@ export interface SidebarItemsChangedVector {
     added: number;
     /** `selected` after `items_changed_cb` has run. */
     expected: number;
-    /** Why this row exists. */
     rule: string;
 }
 /**
- * `items_changed_cb` (adw-sidebar.c:2246-2284) — the derivation NEITHER port had.
+ * `items_changed_cb`.
  *
  * The last row documents libadwaita's unsigned wraparound: with no selection,
  * `selected` is `G_MAXUINT`, so the "splice covers the selection" test can never
@@ -53,9 +50,7 @@ export interface SidebarItemsChangedVector {
 export declare const SIDEBAR_ITEMS_CHANGED_VECTORS: ReadonlyArray<SidebarItemsChangedVector>;
 /** One flattened-model expectation for a whole section list. */
 export interface SidebarModelVector {
-    /** Human-readable name, used as the test title. */
     name: string;
-    /** The declared sections. */
     sections: ReadonlyArray<AdwSidebarSectionSpec>;
     /** `n_items` — the size of the selection index space. */
     count: number;
@@ -70,31 +65,28 @@ export interface SidebarModelVector {
     }>;
     /** The headers that get drawn, in render order. */
     headers: ReadonlyArray<SidebarHeaderSpec>;
-    /** Why this row exists. */
     rule: string;
 }
 /**
- * The flat index space (`items_changed_cb`'s section walk, adw-sidebar.c:2261-2267
- * + `adw_sidebar_item_get_index`, adw-sidebar-item.c:1040) and the header
- * derivation (`set_header_cb`/`create_header`, adw-sidebar.c:1532-1563, :1483-1530).
+ * The flat index space (`items_changed_cb`'s section walk plus
+ * `adw_sidebar_item_get_index`) and the header derivation
+ * (`set_header_cb`/`create_header`).
  *
- * The empty-leading-section rows are the ones the web port got wrong: it keyed
- * `.first` and the hidden-separator case off the DECLARATION index, so an empty
- * or fully-filtered first section drew a stray separator and cost section 1 the
- * flush-to-top padding `.header.first > .heading` prescribes.
+ * The empty-leading-section rows pin the trap: keying `.first` and the hidden-separator
+ * case off the DECLARATION index makes an empty or fully-filtered first section draw a
+ * stray separator and costs section 1 the flush-to-top padding
+ * `.header.first > .heading` prescribes.
  */
 export declare const SIDEBAR_MODEL_VECTORS: ReadonlyArray<SidebarModelVector>;
 /** One item-label-visibility expectation. */
 export interface SidebarItemFlagsVector {
-    /** The declared item. */
     item: AdwSidebarItemSpec;
-    /** `string_is_not_empty(title)` (adw-sidebar.c:1411-1412). */
+    /** `string_is_not_empty(title)`. */
     titleVisible: boolean;
-    /** `string_is_not_empty(subtitle)` (adw-sidebar.c:1420-1421). */
+    /** `string_is_not_empty(subtitle)`. */
     subtitleVisible: boolean;
-    /** `notify_icon_cb`'s `icon_name && *icon_name` (adw-sidebar.c:1303). */
+    /** `notify_icon_cb`'s `icon_name && *icon_name`. */
     iconVisible: boolean;
-    /** Why this row exists. */
     rule: string;
 }
 /**
@@ -105,13 +97,10 @@ export interface SidebarItemFlagsVector {
 export declare const SIDEBAR_ITEM_FLAG_VECTORS: ReadonlyArray<SidebarItemFlagsVector>;
 /** One activation (row click) expectation. */
 export interface SidebarActivationVector {
-    /** Human-readable name, used as the test title. */
     name: string;
-    /** The declared sections. */
     sections: ReadonlyArray<AdwSidebarSectionSpec>;
     /** The selection to establish before clicking, applied through `setSelected`. */
     initialSelected: number;
-    /** The flat index that is clicked. */
     activate: number;
     /** Whether a row was actually activated — the `activated` signal. */
     activated: boolean;
@@ -119,25 +108,21 @@ export interface SidebarActivationVector {
     selectionChanged: boolean;
     /** `selected` afterwards. */
     selected: number;
-    /** Why this row exists. */
     rule: string;
 }
 /**
  * The selection/activation split: `row-selected` fires only on a real change,
- * `row-activated` fires on EVERY click (adw-sidebar.c:1585-1612), and page mode
- * does the same thing in one callback (`boxed_row_activated_cb`, :1662-1674).
+ * `row-activated` fires on EVERY click, and page mode
+ * does the same thing in one callback (`boxed_row_activated_cb`).
  *
- * The re-click row is the one that matters: it is the documented way to reveal
- * the content pane of a split view (adw-sidebar.c:73-75), and the NativeScript
- * port could not express it at all — its setter early-returned on an unchanged
- * index and it emitted no activation signal.
+ * The re-click row is the one that matters: it is the documented way to reveal the content
+ * pane of a split view, and a setter that early-returns on an unchanged index cannot
+ * express it.
  */
 export declare const SIDEBAR_ACTIVATION_VECTORS: ReadonlyArray<SidebarActivationVector>;
 /** One filter / empty-state expectation. */
 export interface SidebarFilterVector {
-    /** Human-readable name, used as the test title. */
     name: string;
-    /** The declared sections. */
     sections: ReadonlyArray<AdwSidebarSectionSpec>;
     /** Item titles the filter keeps; the suites build `(item) => keepTitles.includes(item.title)`. */
     keepTitles: ReadonlyArray<string>;
@@ -149,34 +134,28 @@ export interface SidebarFilterVector {
     headers: ReadonlyArray<SidebarHeaderSpec>;
     /** The `.empty` / placeholder state — computed from the FILTERED count. */
     isEmpty: boolean;
-    /** Why this row exists. */
     rule: string;
 }
 /**
- * `adw_sidebar_set_filter` (adw-sidebar.c:3127-3139) feeds a `GtkFilterListModel`
- * that only the row list and the placeholder see; the selection index space stays
- * on the unfiltered `items_model` (adw-sidebar.c:2866 vs :2177-2180), and
- * `update_placeholder` counts the filtered one (adw-sidebar.c:1828, :1839-1842).
- *
- * Neither port had a filter or a placeholder at all.
+ * `adw_sidebar_set_filter` feeds a `GtkFilterListModel` that only the row list and the
+ * placeholder see: the selection index space stays on the UNFILTERED `items_model` while
+ * `update_placeholder` counts the filtered one.
  */
 export declare const SIDEBAR_FILTER_VECTORS: ReadonlyArray<SidebarFilterVector>;
 /** One mode expectation. */
 export interface SidebarModeVector {
-    /** The mode being set. */
     mode: 'sidebar' | 'page';
     /** Whether the selection is PAINTED in that mode. */
     selectionVisible: boolean;
-    /** Why this row exists. */
     rule: string;
 }
 /**
- * `adw_sidebar_set_mode` (adw-sidebar.c:2960-2981) never touches `selected`:
+ * `adw_sidebar_set_mode` never touches `selected`:
  * "In this mode, the selection is invisible and only tracked to determine the
- * initially selected item once switched back to sidebar mode" (adw-sidebar.c:2948-2951).
+ * initially selected item once switched back to sidebar mode".
  *
  * The web port painted its `.selected` highlight in BOTH modes; page mode builds
- * plain `AdwActionRow`s in a boxed list (`create_boxed_row`, adw-sidebar.c:1676)
+ * plain `AdwActionRow`s in a boxed list (`create_boxed_row`)
  * and shows no selected row at all.
  */
 export declare const SIDEBAR_MODE_VECTORS: ReadonlyArray<SidebarModeVector>;

package/lib/types/conformance/spinner.d.ts

@@ -4,16 +4,12 @@ export declare const SPINNER_ARC_TOLERANCE = 1e-9;
  * The arc lengths actually DRAWN, in radians — measured over one cycle at 200k
  * samples, not read off the constants.
  *
- * The distinction matters and is easy to get wrong: `MAX_ARC_LENGTH` is
- * `pi * 0.9` (162 degrees), and both `get_arc_start` and `get_arc_end` lerp
- * TOWARDS it — but each then subtracts the drift term
- * `angle * MAX_ARC_LENGTH / cycle_length`, which is what makes the figure
- * advance around the circle. The two ends drift together, so the visible arc
- * peaks at **102.8 degrees**, not 162. Reading the constant as the drawn length
- * is the obvious mistake; issue #1066 made it in its own summary table.
- *
- * The MINIMUM is exactly `MIN_ARC_LENGTH`, because the drift is zero at the
- * cycle boundary where the arc is shortest.
+ * `MAX_ARC_LENGTH` is `pi * 0.9` (162 degrees) and both `get_arc_start` and
+ * `get_arc_end` lerp TOWARDS it, but each then subtracts the drift term
+ * `angle * MAX_ARC_LENGTH / cycle_length` that advances the figure around the circle.
+ * The two ends drift together, so the visible arc peaks at 102.8 degrees, not 162 —
+ * reading the constant as the drawn length is the obvious mistake. The minimum is
+ * exactly `MIN_ARC_LENGTH`, the drift being zero at the cycle boundary.
  */
 export declare const SPINNER_ARC_ENVELOPE: {
     /** Exactly `MIN_ARC_LENGTH` — 2.7 degrees, at the cycle boundary. */
@@ -24,24 +20,23 @@ export declare const SPINNER_ARC_ENVELOPE: {
     readonly tolerance: 0.0001;
 };
 /**
- * `get_arc_start` / `get_arc_end` (adw-spinner-paintable.c:109-145) at the four
- * corners of one cycle, plus the resting pose.
+ * One named moment of `get_arc_start` / `get_arc_end` within a cycle.
  *
- * The lengths are DERIVED from the C's own constants rather than typed in: the
- * point of the rows is which MOMENT each is, and a hand-copied radian would be a
- * second reading of the same arithmetic the implementation does. What they pin
- * is the shape — that the arc is shortest at the cycle boundary, longest around
- * the extend/contract handover, and never leaves `[MIN_ARC_LENGTH,
- * MAX_ARC_LENGTH]`.
+ * The rows name the MOMENT, not the length: lengths are derived from the C's own
+ * constants rather than typed in, so what they pin is the shape — arc shortest at the
+ * cycle boundary, longest around the extend/contract handover, never outside
+ * `[MIN_ARC_LENGTH, MAX_ARC_LENGTH]`.
  */
 export interface SpinnerArcShapeVector {
     /** Fraction of one arc cycle, 0..1. */
     phase: number;
-    /** What happens here. */
     rule: string;
 }
-/** The moments worth naming in one arc cycle.  *
- * CORE-ONLY: the arc is drawn per frame from `spinnerArc`, and a renderer can only show the RESULT — the browser suite asserts the drawn envelope and the round caps, which is the observable half
+/**
+ * The moments worth naming in one arc cycle.
+ *
+ * CORE-ONLY: the arc is drawn per frame from `spinnerArc` and a renderer can only show
+ * the RESULT — the browser suite asserts the drawn envelope and the round caps.
  */
 export declare const SPINNER_ARC_PHASE_VECTORS: ReadonlyArray<SpinnerArcShapeVector>;
 /** One "is this constant what the C says" expectation. */
@@ -54,13 +49,12 @@ export interface SpinnerConstantVector {
     rule: string;
 }
 /**
- * The `#define`s at adw-spinner-paintable.c:18-33 and adw-spinner.c:14-15.
+ * The animation `#define`s plus `adw-spinner.c`'s own size constants.
  *
- * A constant table looks redundant next to the implementation until you read the
- * `rule` column: five of these seven were WRONG or absent in a shipping port,
- * and a table is what makes "the port picked its own number" fail a test rather
- * than look like a design choice.
+ * Four of these seven were wrong or absent in a shipping port; as a table, "the port
+ * picked its own number" fails a test instead of reading as a design choice.
  *
- * CORE-ONLY: a table OF constants: what a renderer can show is the geometry they produce, which the browser suite asserts through SPINNER_GEOMETRY/SIZE_VECTORS
+ * CORE-ONLY: a table OF constants — what a renderer can show is the geometry they
+ * produce, asserted by the browser suite through SPINNER_GEOMETRY/SIZE_VECTORS.
  */
 export declare const SPINNER_CONSTANT_VECTORS: ReadonlyArray<SpinnerConstantVector>;