@girs/papersview-4.0 4.2.0

package/README.md

@@ -0,0 +1,85 @@
+
+# PapersView-4.0
+
+![version](https://img.shields.io/npm/v/@girs/papersview-4.0)
+![downloads/week](https://img.shields.io/npm/dw/@girs/papersview-4.0)
+
+
+GJS TypeScript type definitions for PapersView-4.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.2.0.
+
+## Install
+
+Install the type definitions with npm:
+```bash
+npm install @girs/papersview-4.0
+```
+
+## Usage
+
+Import it like any other module:
+```ts
+import PapersView from '@girs/papersview-4.0';
+```
+
+### Ambient Modules
+
+[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/papersview-4.0` or `@girs/papersview-4.0/ambient` in your `tsconfig` or entry point Typescript file:
+
+`index.ts`:
+```ts
+import '@girs/papersview-4.0'
+```
+
+`tsconfig.json`:
+```json
+{
+  "compilerOptions": {
+    ...
+  },
+  "include": ["@girs/papersview-4.0"],
+  ...
+}
+```
+
+The ambient module now resolves with types:
+
+```ts
+import PapersView from 'gi://PapersView?version=4.0';
+```
+
+### Global import
+
+GJS's global `imports.gi` works too, with types.
+For this you need to include `@girs/papersview-4.0` or `@girs/papersview-4.0/import` in your `tsconfig` or entry point Typescript file:
+
+`index.ts`:
+```ts
+import '@girs/papersview-4.0'
+```
+
+`tsconfig.json`:
+```json
+{
+  "compilerOptions": {
+    ...
+  },
+  "include": ["@girs/papersview-4.0"],
+  ...
+}
+```
+
+That form carries types as well:
+
+```ts
+const PapersView = imports.gi.PapersView;
+```
+
+### Bundle
+
+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
+
+All existing pre-generated packages can be found on [gjsify/types](https://github.com/gjsify/types).
+

package/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Type Definitions for Gjs (https://gjs.guide/)
+ *
+ * These type definitions are automatically generated, do not edit them by hand.
+ * If you found a bug fix it in `ts-for-gir` or create a bug report on https://github.com/gjsify/ts-for-gir
+ * 
+ * This template is used to generate the index.d.ts file of each GIR module like Gtk-4.0, GObject-2.0, ...
+ */
+
+import './papersview-4.0-ambient.d.ts';
+
+import './papersview-4.0-import.d.ts';
+
+import PapersView from './papersview-4.0.js';
+export default PapersView;
+

package/index.js

@@ -0,0 +1,5 @@
+
+// @ts-expect-error
+import PapersView from './papersview-4.0.js';
+export default PapersView;
+

package/package.json

@@ -0,0 +1,77 @@
+{
+    "name": "@girs/papersview-4.0",
+    "version": "4.2.0",
+    "description": "GJS TypeScript type definitions for PapersView-4.0",
+    "type": "module",
+    "module": "papersview-4.0.js",
+    "main": "papersview-4.0.js",
+    "exports": {
+        "./ambient": {
+            "types": "./papersview-4.0-ambient.d.ts",
+            "import": "./papersview-4.0-ambient.js",
+            "default": "./papersview-4.0-ambient.js"
+        },
+        "./import": {
+            "types": "./papersview-4.0-import.d.ts",
+            "import": "./papersview-4.0-import.js",
+            "default": "./papersview-4.0-import.js"
+        },
+        "./surface": {
+            "types": "./papersview-4.0-surface.d.ts",
+            "import": "./papersview-4.0-surface.js",
+            "default": "./papersview-4.0-surface.js"
+        },
+        "./papersview-4.0": {
+            "types": "./papersview-4.0.d.ts",
+            "import": "./papersview-4.0.js",
+            "default": "./papersview-4.0.js"
+        },
+        ".": {
+            "types": "./index.d.ts",
+            "import": "./index.js",
+            "default": "./index.js"
+        }
+    },
+    "scripts": {
+        "test": "tsc --project tsconfig.json"
+    },
+    "dependencies": {
+        "@girs/gjs": "^4.2.0",
+        "@girs/papersdocument-4.0": "^4.2.0",
+        "@girs/pango-1.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/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/gtk-4.0": "^4.2.0",
+        "@girs/gsk-4.0": "^4.2.0",
+        "@girs/graphene-1.0": "^4.2.0",
+        "@girs/gdk-4.0": "^4.2.0",
+        "@girs/pangocairo-1.0": "^4.2.0",
+        "@girs/gdkpixbuf-2.0": "^4.2.0"
+    },
+    "devDependencies": {
+        "typescript": "*"
+    },
+    "keywords": [
+        "Gir",
+        "TypeScript",
+        "types",
+        "GObject-Introspection",
+        "GJS",
+        "PapersView-4.0"
+    ],
+    "author": "ts-for-gir",
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/gjsify/types.git"
+    },
+    "bugs": {
+        "url": "https://github.com/gjsify/ts-for-gir/issues"
+    },
+    "homepage": "https://github.com/gjsify/types/tree/main/papersview-4.0#readme"
+}

package/papersview-4.0-ambient.d.ts

@@ -0,0 +1,12 @@
+
+declare module 'gi://PapersView?version=4.0' {
+    import PapersView40 from '@girs/papersview-4.0';
+    export default PapersView40;
+}
+
+declare module 'gi://PapersView' {
+    import PapersView40 from 'gi://PapersView?version=4.0';
+    export default PapersView40;
+}
+
+

package/papersview-4.0-ambient.js

@@ -0,0 +1,2 @@
+export {}
+

package/papersview-4.0-import.d.ts

@@ -0,0 +1,12 @@
+
+import type PapersView40 from '@girs/papersview-4.0';
+
+declare global {
+    export interface GjsGiImports {
+        PapersView: typeof PapersView40;
+    }
+}
+
+export default GjsGiImports;
+
+

package/papersview-4.0-import.js

@@ -0,0 +1,3 @@
+const gi = globalThis.imports?.gi || {};
+export default gi;
+

package/papersview-4.0-surface.d.ts

@@ -0,0 +1,156 @@
+/**
+ * The GIR-derived widget VOCABULARY for PapersView-4.0.
+ *
+ * GENERATED — do not edit. Provenance: PapersView-4.0 — dropped empty base(s): GObject.InitiallyUnowned GObject.Object
+ *
+ * 2 concrete widgets, 2 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
+ * 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 PapersDocument from '@girs/papersdocument-4.0';
+import type PapersView from './papersview-4.0.js';
+import type { GtkAccessibleConstructOnly, GtkAccessibleProps, GtkBuildableConstructOnly, GtkBuildableProps, GtkConstraintTargetConstructOnly, GtkConstraintTargetProps, GtkScrollableConstructOnly, GtkScrollableProps, GtkWidgetConstructOnly, GtkWidgetProps } from '@girs/gtk-4.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 PpsAnnotationToolNick = 'pencil' | 'highlight' | 'eraser' | 'text' | 'max';
+export type PpsJobPriorityNick = 'priority-urgent' | 'priority-high' | 'priority-low' | 'priority-none' | 'n-priorities';
+export type PpsPageLayoutNick = 'single' | 'dual' | 'automatic';
+export type PpsSizingModeNick = 'fit-page' | 'fit-width' | 'free' | 'automatic';
+
+// ---------------------------------------------------------------------------
+// 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 PpsViewProps extends GtkWidgetProps, GtkAccessibleProps, GtkBuildableProps, GtkConstraintTargetProps, GtkScrollableProps {
+    'annotations-context'?: PapersView.AnnotationsContext;
+    model?: PapersView.DocumentModel;
+    'search-context'?: PapersView.SearchContext;
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type PpsViewConstructOnly = GtkWidgetConstructOnly | GtkAccessibleConstructOnly | GtkBuildableConstructOnly | GtkConstraintTargetConstructOnly | GtkScrollableConstructOnly;
+
+export interface PpsViewPresentationProps extends GtkWidgetProps, GtkAccessibleProps, GtkBuildableProps, GtkConstraintTargetProps {
+    'current-page'?: number;
+    document?: PapersDocument.Document;
+    'inverted-colors'?: boolean;
+    rotation?: number;
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type PpsViewPresentationConstructOnly = GtkWidgetConstructOnly | GtkAccessibleConstructOnly | GtkBuildableConstructOnly | GtkConstraintTargetConstructOnly;
+
+// ---------------------------------------------------------------------------
+// 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 {
+    PpsView: {
+        class: PapersView.View;
+        props: PpsViewProps;
+        signals: PapersView.View.SignalSignatures;
+        constructOnly: PpsViewConstructOnly;
+        slotCandidates: {};
+    };
+    PpsViewPresentation: {
+        class: PapersView.ViewPresentation;
+        props: PpsViewPresentationProps;
+        signals: PapersView.ViewPresentation.SignalSignatures;
+        constructOnly: PpsViewPresentationConstructOnly;
+        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/papersview-4.0-surface.js

@@ -0,0 +1,35 @@
+// The widget vocabulary of PapersView-4.0 as runtime data.
+//
+// GENERATED — do not edit. Provenance: PapersView-4.0 — dropped empty base(s): GObject.InitiallyUnowned GObject.Object
+//
+// 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 = 'PapersView-4.0 — dropped empty base(s): GObject.InitiallyUnowned GObject.Object';
+
+export const OWN_PROPS = {
+    PpsView: ['annotations-context', 'model', 'search-context'],
+    PpsViewPresentation: ['current-page', 'document', 'inverted-colors', 'rotation'],
+};
+
+export const OWN_SIGNALS = {
+    PpsView: ['activate', 'cursor-moved', 'external-link', 'handle-link', 'layers-changed', 'move-cursor', 'popup', 'scroll', 'selection-changed', 'signature-rect'],
+    PpsViewPresentation: ['change-page', 'external-link', 'finished'],
+};
+
+export const DECLS = {
+    PpsView: ['PpsView', 'GtkWidget', 'GtkAccessible', 'GtkBuildable', 'GtkConstraintTarget', 'GtkScrollable'],
+    PpsViewPresentation: ['PpsViewPresentation', 'GtkWidget', 'GtkAccessible', 'GtkBuildable', 'GtkConstraintTarget'],
+};
+
+export const ENUM_NICKS = {
+    PpsAnnotationTool: ['pencil', 'highlight', 'eraser', 'text', 'max'],
+    PpsJobPriority: ['priority-urgent', 'priority-high', 'priority-low', 'priority-none', 'n-priorities'],
+    PpsPageLayout: ['single', 'dual', 'automatic'],
+    PpsSizingMode: ['fit-page', 'fit-width', 'free', 'automatic'],
+};
+
+export const SLOT_CANDIDATES = {};
+
+export const SINCE = {};