@girs/gtkspell-3.0 3.0.0-4.0.0

package/README.md

@@ -0,0 +1,104 @@
+
+# GtkSpell-3.0
+
+![version](https://img.shields.io/npm/v/@girs/gtkspell-3.0)
+![downloads/week](https://img.shields.io/npm/dw/@girs/gtkspell-3.0)
+
+
+GJS TypeScript type definitions for GtkSpell-3.0, generated from library version 3.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0.
+
+
+## Install
+
+To use this type definitions, install them with NPM:
+```bash
+npm install @girs/gtkspell-3.0
+```
+
+## Usage
+
+You can import this package into your project like this:
+```ts
+import GtkSpell from '@girs/gtkspell-3.0';
+```
+
+Or if you prefer CommonJS, you can also use this:
+```ts
+const GtkSpell = require('@girs/gtkspell-3.0');
+```
+
+### 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.
+For this you need to include `@girs/gtkspell-3.0` or `@girs/gtkspell-3.0/ambient` in your `tsconfig` or entry point Typescript file:
+
+`index.ts`:
+```ts
+import '@girs/gtkspell-3.0'
+```
+
+`tsconfig.json`:
+```json
+{
+  "compilerOptions": {
+    ...
+  },
+  "include": ["@girs/gtkspell-3.0"],
+  ...
+}
+```
+
+Now you can import the ambient module with TypeScript support: 
+
+```ts
+import GtkSpell from 'gi://GtkSpell?version=3.0';
+```
+
+### Global import
+
+You can also import the module with Typescript support using the global `imports.gi` object of GJS.
+For this you need to include `@girs/gtkspell-3.0` or `@girs/gtkspell-3.0/import` in your `tsconfig` or entry point Typescript file:
+
+`index.ts`:
+```ts
+import '@girs/gtkspell-3.0'
+```
+
+`tsconfig.json`:
+```json
+{
+  "compilerOptions": {
+    ...
+  },
+  "include": ["@girs/gtkspell-3.0"],
+  ...
+}
+```
+
+Now you have also type support for this, too:
+
+```ts
+const GtkSpell = imports.gi.GtkSpell;
+```
+
+
+### ESM vs. CommonJS
+
+GJS supports two different import syntaxes. The new modern ESM syntax and the old global imports syntax.
+
+In TypeScript projects for GJS and GNOME Shell extensions, you have the flexibility to use `ESM` syntax and then decide the import syntax for your bundled file. If your bundler is configured to use `CommonJS`, it will convert to the GJS-specific global imports syntax, like `const moduleName = imports.gi[moduleName]`. This is different from the traditional `require` syntax seen in Node.js. The global imports syntax is chosen because it aligns with the CommonJS format supported by NPM, which is used for the generated type definitions and this package.
+
+On the other hand, if you configure your bundler to use ESM, it will retain the ESM import syntax. It's crucial to ensure that your bundler is set up to correctly translate and bundle these imports into either CommonJS or ESM format, depending on your project's requirements.
+
+This approach is particularly important due to the `@girs` types, which include both `*.cjs `files, using the GJS global imports syntax, and `*.js` files, which utilize the ESM syntax. By appropriately setting up your bundler, you can control which syntax—CommonJS or ESM—is used in your project. The choice of CommonJS in this context is also due to the similarity between the GJS-specific global imports and CommonJS syntax, allowing for easier management and bundling in these specific types of projects.
+
+Since GNOME Shell 45, you should only use ESM, even for GNOME Shell extensions. Before that, extensions had to use the global import syntax, unlike normal GJS applications, where ESM has been available for some time.
+
+### 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).
+
+## Other packages
+
+All existing pre-generated packages can be found on [gjsify/types](https://github.com/gjsify/types).
+

package/gtkspell-3.0-ambient.d.ts

@@ -0,0 +1,12 @@
+
+declare module 'gi://GtkSpell?version=3.0' {
+    import GtkSpell from '@girs/gtkspell-3.0';
+    export default GtkSpell;
+}
+
+declare module 'gi://GtkSpell' {
+    import GtkSpell30 from 'gi://GtkSpell?version=3.0';
+    export default GtkSpell30;
+}
+
+

package/gtkspell-3.0-ambient.js

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

package/gtkspell-3.0-import.d.ts

@@ -0,0 +1,12 @@
+
+import GtkSpell30 from '@girs/gtkspell-3.0';
+
+declare global {
+    export interface GjsGiImports {
+        GtkSpell: typeof GtkSpell30;
+    }
+}
+
+export default GjsGiImports;
+
+

package/gtkspell-3.0-import.js

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

package/gtkspell-3.0.d.ts

@@ -0,0 +1,213 @@
+/*
+ * 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
+ */
+
+import './gtkspell-3.0-ambient.d.ts';
+
+/**
+ * GtkSpell-3.0
+ */
+
+import type Gtk from '@girs/gtk-3.0';
+import type xlib from '@girs/xlib-2.0';
+import type Gdk from '@girs/gdk-3.0';
+import type cairo from '@girs/cairo-1.0';
+import type GObject from '@girs/gobject-2.0';
+import type GLib from '@girs/glib-2.0';
+import type Pango from '@girs/pango-1.0';
+import type HarfBuzz from '@girs/harfbuzz-0.0';
+import type freetype2 from '@girs/freetype2-2.0';
+import type Gio from '@girs/gio-2.0';
+import type GdkPixbuf from '@girs/gdkpixbuf-2.0';
+import type GModule from '@girs/gmodule-2.0';
+import type Atk from '@girs/atk-1.0';
+
+export namespace GtkSpell {
+    /**
+     * Error codes used for GtkSpell errors.
+     */
+    class Error extends GLib.Error {
+        static $gtype: GObject.GType<Error>;
+
+        // Static fields of GtkSpell.Error
+
+        /**
+         * Error code for backend errors
+         */
+        static BACKEND: number;
+
+        // Constructors of GtkSpell.Error
+
+        constructor(options: { message: string; code: number });
+        _init(...args: any[]): void;
+
+        // Own static methods of GtkSpell.Error
+
+        static quark(): GLib.Quark;
+    }
+
+    function error_quark(): GLib.Quark;
+    module Checker {
+        // Signal callback interfaces
+
+        interface LanguageChanged {
+            (lang: string): void;
+        }
+
+        // Constructor properties interface
+
+        interface ConstructorProps extends GObject.InitiallyUnowned.ConstructorProps {
+            decode_language_codes: boolean;
+            decodeLanguageCodes: boolean;
+        }
+    }
+
+    /**
+     * The #GtkSpellChecker struct contains only private fields.
+     */
+    class Checker extends GObject.InitiallyUnowned {
+        static $gtype: GObject.GType<Checker>;
+
+        // Own properties of GtkSpell.Checker
+
+        get decode_language_codes(): boolean;
+        set decode_language_codes(val: boolean);
+        get decodeLanguageCodes(): boolean;
+        set decodeLanguageCodes(val: boolean);
+
+        // Constructors of GtkSpell.Checker
+
+        constructor(properties?: Partial<Checker.ConstructorProps>, ...args: any[]);
+
+        _init(...args: any[]): void;
+
+        static ['new'](): Checker;
+
+        // Own signals of GtkSpell.Checker
+
+        connect(id: string, callback: (...args: any[]) => any): number;
+        connect_after(id: string, callback: (...args: any[]) => any): number;
+        emit(id: string, ...args: any[]): void;
+        connect(signal: 'language-changed', callback: (_source: this, lang: string) => void): number;
+        connect_after(signal: 'language-changed', callback: (_source: this, lang: string) => void): number;
+        emit(signal: 'language-changed', lang: string): void;
+
+        // Own static methods of GtkSpell.Checker
+
+        /**
+         * Translates the language code to a human readable format
+         * (i.e. "en_US" -> "English (United States)").
+         * Note: If the iso-codes package is not available, the unchanged code is
+         * returned.
+         * @param lang The language locale specifier (i.e. "en_US").
+         */
+        static decode_language_code(lang: string): string;
+        /**
+         * Retrieves the #GtkSpellChecker object attached to a text view.
+         * @param view A #GtkTextView.
+         */
+        static get_from_text_view(view: Gtk.TextView): Checker;
+        /**
+         * Requests the list of available languages from the enchant broker.
+         */
+        static get_language_list(): string[];
+
+        // Own virtual methods of GtkSpell.Checker
+
+        vfunc_language_changed(new_lang: string): void;
+
+        // Own methods of GtkSpell.Checker
+
+        /**
+         * Add the specified word to the user dictionary.
+         * @param word The word to add to the user dictionary.
+         */
+        add_to_dictionary(word: string): void;
+        /**
+         * Attach #GtkSpellChecker object to `view`.
+         *
+         * Note: Please read the tutorial section of the documentation to make sure
+         * you don't leak references!
+         * @param view The #GtkTextView to attach to.
+         * @returns TRUE on success, FALSE on failure.
+         */
+        attach(view: Gtk.TextView): boolean;
+        /**
+         * Check the specified word.
+         * @param word The word to check.
+         * @returns TRUE if the word is correctly spelled, FALSE otherwise.
+         */
+        check_word(word: string): boolean;
+        /**
+         * Detaches this #GtkSpellChecker from its #GtkTextView.  Use
+         * gtk_spell_checker_get_from_text_view () to retrieve a #GtkSpellChecker from
+         * a #GtkTextView. If the #GtkSpellChecker is not attached to any #GtkTextView,
+         * the function silently exits.
+         *
+         * Note: if the #GtkSpellChecker is owned by the #GtkTextView, you must
+         * take a reference to it to prevent it from being automatically destroyed.
+         * Please read the tutorial section of the documentation!
+         */
+        detach(): void;
+        /**
+         * Fetches the current language.
+         * @returns the current language. This string is owned by the spell object and must not be modified or freed.
+         */
+        get_language(): string;
+        /**
+         * Retreives a list of spelling suggestions for the specified word.
+         * @param word The word for which to fetch suggestions
+         * @returns the list of spelling suggestions for the specified word, or NULL if there are no suggestions.
+         */
+        get_suggestions(word: string): string[];
+        /**
+         * Retrieves a submenu of replacement spellings, or NULL if the word at `iter` is
+         * not misspelt.
+         * @param iter Textiter of position in buffer to be corrected if necessary.
+         * @returns the #GtkMenu widget, or %NULL if there is no need for a menu
+         */
+        get_suggestions_menu(iter: Gtk.TextIter): Gtk.Widget;
+        /**
+         * Add the specified word to the user ignore list.
+         * @param word The word to add to the user ignore list.
+         */
+        ignore_word(word: string): void;
+        /**
+         * Recheck the spelling in the entire buffer.
+         */
+        recheck_all(): void;
+        /**
+         * Set the language on `spell` to `lang,` possibily returning an error in
+         * `error`.
+         * @param lang The language to use, as a locale specifier (i.e. "en_US"). If #NULL, attempt to use the default system locale (LANG).
+         * @returns FALSE if there was an error.
+         */
+        set_language(lang?: string | null): boolean;
+    }
+
+    type CheckerClass = typeof Checker;
+    abstract class CheckerPrivate {
+        static $gtype: GObject.GType<CheckerPrivate>;
+
+        // Constructors of GtkSpell.CheckerPrivate
+
+        _init(...args: any[]): void;
+    }
+
+    /**
+     * Name of the imported GIR library
+     * `see` https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L188
+     */
+    const __name__: string;
+    /**
+     * Version of the imported GIR library
+     * `see` https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L189
+     */
+    const __version__: string;
+}
+
+export default GtkSpell;
+// END

package/gtkspell-3.0.js

@@ -0,0 +1,6 @@
+
+  // @ts-expect-error
+  import GtkSpell from 'gi://GtkSpell?version=3.0';
+  export { GtkSpell };
+  export default GtkSpell;
+

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@girs/gtkspell-3.0",
+  "version": "3.0.0-4.0.0",
+  "description": "GJS TypeScript type definitions for GtkSpell-3.0, generated from library version 3.0.0",
+  "type": "module",
+  "module": "gtkspell-3.0.js",
+  "main": "gtkspell-3.0.js",
+  "exports": {
+    "./ambient": {
+      "types": "./gtkspell-3.0-ambient.d.ts",
+      "import": "./gtkspell-3.0-ambient.js",
+      "default": "./gtkspell-3.0-ambient.js"
+    },
+    "./import": {
+      "types": "./gtkspell-3.0-import.d.ts",
+      "import": "./gtkspell-3.0-import.js",
+      "default": "./gtkspell-3.0-import.js"
+    },
+    ".": {
+      "types": "./gtkspell-3.0.d.ts",
+      "import": "./gtkspell-3.0.js",
+      "default": "./gtkspell-3.0.js"
+    }
+  },
+  "scripts": {
+    "test": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit gtkspell-3.0.d.ts"
+  },
+  "dependencies": {
+    "@girs/atk-1.0": "^2.45.1-4.0.0-beta.1",
+    "@girs/cairo-1.0": "^1.0.0-4.0.0-beta.1",
+    "@girs/freetype2-2.0": "^2.0.0-4.0.0-beta.1",
+    "@girs/gdk-3.0": "^3.24.39-4.0.0-beta.1",
+    "@girs/gdkpixbuf-2.0": "^2.0.0-4.0.0-beta.1",
+    "@girs/gio-2.0": "^2.77.0-4.0.0-beta.1",
+    "@girs/gjs": "^4.0.0-beta.1",
+    "@girs/glib-2.0": "^2.77.0-4.0.0-beta.1",
+    "@girs/gmodule-2.0": "^2.0.0-4.0.0-beta.1",
+    "@girs/gobject-2.0": "^2.77.0-4.0.0-beta.1",
+    "@girs/gtk-3.0": "^3.24.39-4.0.0-beta.1",
+    "@girs/harfbuzz-0.0": "^8.1.1-4.0.0-beta.1",
+    "@girs/pango-1.0": "^1.51.0-4.0.0-beta.1",
+    "@girs/xlib-2.0": "^2.0.0-4.0.0-beta.1"
+  },
+  "devDependencies": {
+    "typescript": "*"
+  },
+  "keywords": [
+    "Gir",
+    "TypeScript",
+    "types",
+    "GObject-Introspection",
+    "GJS",
+    "GtkSpell-3.0"
+  ],
+  "author": "ts-for-gir",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/gjsify/ts-for-gir.git"
+  },
+  "bugs": {
+    "url": "https://github.com/gjsify/ts-for-gir/issues"
+  },
+  "homepage": "https://github.com/gjsify/types/tree/main/gtkspell-3.0#readme"
+}

package/tsconfig.json

@@ -0,0 +1,23 @@
+{
+  "compilerOptions": {
+    // General settings for code interpretation
+    "target": "ESNext",
+    "module": "ESNext",
+    "lib": ["ESNext"],
+    "types": [],
+    "experimentalDecorators": true,
+    "moduleResolution": "node",
+    "noEmit": true,
+    "noEmitOnError": false,
+    "baseUrl": "./",
+    "rootDir": ".",
+    // General settings for code generation
+    "removeComments": false,
+    "inlineSourceMap": false,
+    "inlineSources": false,
+    "newLine": "LF"
+  },
+  "include": ["./gtkspell-3.0.d.ts"]
+}
+
+

package/typedoc.json

@@ -0,0 +1,7 @@
+{
+    "entryPoints": ["./gtkspell-3.0.d.ts"],
+    "readme": "./README.md",
+    "name": "GtkSpell-3.0",
+    "tsconfig": "./tsconfig.json"
+}
+