@girs/mtk-14 14.0.0-3.3.0

package/README.md

@@ -0,0 +1,104 @@
+
+# Mtk-14
+
+![version](https://img.shields.io/npm/v/@girs/mtk-14)
+![downloads/week](https://img.shields.io/npm/dw/@girs/mtk-14)
+
+
+GJS TypeScript type definitions for Mtk-14, generated from library version 14.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.3.0.
+
+
+## Install
+
+To use this type definitions, install them with NPM:
+```bash
+npm install @girs/mtk-14
+```
+
+## Usage
+
+You can import this package into your project like this:
+```ts
+import Mtk from '@girs/mtk-14';
+```
+
+Or if you prefer CommonJS, you can also use this:
+```ts
+const Mtk = require('@girs/mtk-14');
+```
+
+### 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/mtk-14` or `@girs/mtk-14/ambient` in your `tsconfig` or entry point Typescript file:
+
+`index.ts`:
+```ts
+import '@girs/mtk-14'
+```
+
+`tsconfig.json`:
+```json
+{
+  "compilerOptions": {
+    ...
+  },
+  "include": ["@girs/mtk-14"],
+  ...
+}
+```
+
+Now you can import the ambient module with TypeScript support: 
+
+```ts
+import Mtk from 'gi://Mtk?version=14';
+```
+
+### 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/mtk-14` or `@girs/mtk-14/import` in your `tsconfig` or entry point Typescript file:
+
+`index.ts`:
+```ts
+import '@girs/mtk-14'
+```
+
+`tsconfig.json`:
+```json
+{
+  "compilerOptions": {
+    ...
+  },
+  "include": ["@girs/mtk-14"],
+  ...
+}
+```
+
+Now you have also type support for this, too:
+
+```ts
+const Mtk = imports.gi.Mtk;
+```
+
+
+### 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/mtk-14-ambient.d.ts

@@ -0,0 +1,12 @@
+
+declare module 'gi://Mtk?version=14' {
+    import Mtk14 from '@girs/mtk-14';
+    export default Mtk14;
+}
+
+declare module 'gi://Mtk' {
+    import Mtk14 from '@girs/mtk-14';
+    export default Mtk14;
+}
+
+

package/mtk-14-ambient.js

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

package/mtk-14-import.d.ts

@@ -0,0 +1,12 @@
+
+import Mtk14 from '@girs/mtk-14';
+
+declare global {
+    export interface GjsGiImports {
+        Mtk: typeof Mtk14;
+    }
+}
+
+export default GjsGiImports;
+
+

package/mtk-14-import.js

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

package/mtk-14.cjs

@@ -0,0 +1,11 @@
+
+
+  imports.gi.versions.Mtk = '14'
+  const Mtk = imports.gi.Mtk;
+  
+    module.exports = Mtk;
+  
+
+
+
+

package/mtk-14.d.cts

@@ -0,0 +1,271 @@
+
+/*
+ * 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 './mtk-14-ambient.d.ts';
+import './mtk-14-import.d.ts';
+/**
+ * Mtk-14
+ */
+
+import type Graphene from '@girs/graphene-1.0';
+import type GObject from '@girs/gobject-2.0';
+import type GLib from '@girs/glib-2.0';
+
+export enum RegionOverlap {
+    OUT,
+    IN,
+    PART,
+}
+export enum RoundingStrategy {
+    SHRINK,
+    GROW,
+    ROUND,
+}
+export const RECTANGLE_MAX_STACK_RECTS: number
+export const REGION_BUILDER_MAX_LEVELS: number
+export function rectangle_from_graphene_rect(rect: Graphene.Rect, rounding_strategy: RoundingStrategy): /* dest */ Rectangle
+export function region_create(): Region
+export function region_create_rectangle(rect: Rectangle): Region
+export function region_create_rectangles(rects: Rectangle, n_rects: number): Region
+export function x11_errors_deinit(): void
+export interface Rectangle {
+
+    // Own fields of Mtk-14.Mtk.Rectangle
+
+    /**
+     * X coordinate of the top-left corner
+     * @field 
+     */
+    x: number
+    /**
+     * Y coordinate of the top-left corner
+     * @field 
+     */
+    y: number
+    /**
+     * Width of the rectangle
+     * @field 
+     */
+    width: number
+    /**
+     * Height of the rectangle
+     * @field 
+     */
+    height: number
+
+    // Owm methods of Mtk-14.Mtk.Rectangle
+
+    area(): number
+    contains_rect(inner_rect: Rectangle): boolean
+    copy(): Rectangle
+    could_fit_rect(inner_rect: Rectangle): boolean
+    crop_and_scale(src_rect: Graphene.Rect, dst_width: number, dst_height: number, dest: Rectangle): void
+    /**
+     * Compares the two rectangles
+     * @param src2 The second rectangle
+     * @returns Whether the two rectangles are equal
+     */
+    equal(src2: Rectangle): boolean
+    free(): void
+    /**
+     * Similar to [method`Rectangle`.overlap] but ignores the vertical location.
+     * @param rect2 The second rectangle
+     * @returns Whether the two rectangles overlap horizontally
+     */
+    horiz_overlap(rect2: Rectangle): boolean
+    /**
+     * Find the intersection between the two rectangles
+     * @param src2 another #MtkRectangle
+     * @returns TRUE is some intersection exists and is not degenerate, FALSE   otherwise.
+     */
+    intersect(src2: Rectangle): [ /* returnType */ boolean, /* dest */ Rectangle ]
+    is_adjacent_to(other: Rectangle): boolean
+    /**
+     * Similar to [method`Rectangle`.intersect] but doesn't provide
+     * the location of the intersection.
+     * @param rect2 The second rectangle
+     * @returns Whether the two rectangles overlap
+     */
+    overlap(rect2: Rectangle): boolean
+    scale_double(scale: number, rounding_strategy: RoundingStrategy, dest: Rectangle): void
+    to_graphene_rect(): Graphene.Rect
+    /**
+     * Computes the union of the two rectangles
+     * @param rect2 another #MtkRectangle
+     */
+    union(rect2: Rectangle): /* dest */ Rectangle
+    /**
+     * Similar to [method`Rectangle`.overlap] but ignores the horizontal location.
+     * @param rect2 The second rectangle
+     * @returns Whether the two rectangles overlap vertically
+     */
+    vert_overlap(rect2: Rectangle): boolean
+}
+
+export class Rectangle {
+
+    // Own properties of Mtk-14.Mtk.Rectangle
+
+    static name: string
+
+    // Constructors of Mtk-14.Mtk.Rectangle
+
+    /**
+     * Creates a new rectangle
+     * @constructor 
+     * @param x X coordinate of the top left corner
+     * @param y Y coordinate of the top left corner
+     * @param width Width of the rectangle
+     * @param height Height of the rectangle
+     */
+    constructor(x: number, y: number, width: number, height: number) 
+    /**
+     * Creates a new rectangle
+     * @constructor 
+     * @param x X coordinate of the top left corner
+     * @param y Y coordinate of the top left corner
+     * @param width Width of the rectangle
+     * @param height Height of the rectangle
+     */
+    static new(x: number, y: number, width: number, height: number): Rectangle
+    static from_graphene_rect(rect: Graphene.Rect, rounding_strategy: RoundingStrategy): /* dest */ Rectangle
+}
+
+export interface Region {
+
+    // Owm methods of Mtk-14.Mtk.Region
+
+    apply_matrix_transform_expand(transform: Graphene.Matrix): Region
+    contains_point(x: number, y: number): boolean
+    contains_rectangle(rect: Rectangle): RegionOverlap
+    copy(): Region
+    crop_and_scale(src_rect: Graphene.Rect, dst_width: number, dst_height: number): Region
+    equal(other: Region): boolean
+    get_extents(): Rectangle
+    get_rectangle(nth: number): Rectangle
+    intersect(other: Region): void
+    intersect_rectangle(rect: Rectangle): void
+    is_empty(): boolean
+    num_rectangles(): number
+    /**
+     * Increases the reference count
+     * @returns The region
+     */
+    ref(): Region
+    scale(scale: number): Region
+    subtract(other: Region): void
+    subtract_rectangle(rect: Rectangle): void
+    translate(dx: number, dy: number): void
+    union(other: Region): void
+    union_rectangle(rect: Rectangle): void
+    unref(): void
+}
+
+export class Region {
+
+    // Own properties of Mtk-14.Mtk.Region
+
+    static name: string
+
+    // Constructors of Mtk-14.Mtk.Region
+
+    static create(): Region
+    static create_rectangle(rect: Rectangle): Region
+    static create_rectangles(rects: Rectangle, n_rects: number): Region
+}
+
+export interface RegionBuilder {
+
+    // Own fields of Mtk-14.Mtk.RegionBuilder
+
+    levels: Region[]
+    n_levels: number
+
+    // Owm methods of Mtk-14.Mtk.RegionBuilder
+
+    add_rectangle(x: number, y: number, width: number, height: number): void
+    finish(): Region
+    init(): void
+}
+
+export class RegionBuilder {
+
+    // Own properties of Mtk-14.Mtk.RegionBuilder
+
+    static name: string
+}
+
+export interface RegionIterator {
+
+    // Own fields of Mtk-14.Mtk.RegionIterator
+
+    /**
+     * region being iterated
+     * @field 
+     */
+    region: Region
+    /**
+     * current rectangle
+     * @field 
+     */
+    rectangle: Rectangle
+    /**
+     * whether the current rectangle starts a horizontal band
+     * @field 
+     */
+    line_start: boolean
+    /**
+     * whether the current rectangle ends a horizontal band
+     * @field 
+     */
+    line_end: boolean
+    i: number
+
+    // Owm methods of Mtk-14.Mtk.RegionIterator
+
+    at_end(): boolean
+    init(region: Region): void
+    next(): void
+}
+
+/**
+ * MtkRegion is a yx banded region; sometimes its useful to iterate through
+ * such a region treating the start and end of each horizontal band in a distinct
+ * fashion.
+ * 
+ * Usage:
+ * 
+ * ```c
+ *  MtkRegionIterator iter;
+ *  for (mtk_region_iterator_init (&iter, region);
+ *       !mtk_region_iterator_at_end (&iter);
+ *       mtk_region_iterator_next (&iter))
+ *  {
+ *    [ Use iter.rectangle, iter.line_start, iter.line_end ]
+ *  }
+ * ```
+ * @record 
+ */
+export class RegionIterator {
+
+    // Own properties of Mtk-14.Mtk.RegionIterator
+
+    static name: string
+}
+
+/**
+ * Name of the imported GIR library
+ * @see https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L188
+ */
+export const __name__: string
+/**
+ * Version of the imported GIR library
+ * @see https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L189
+ */
+export const __version__: string
+// END

package/mtk-14.d.ts

@@ -0,0 +1,276 @@
+
+/*
+ * 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 './mtk-14-ambient.d.ts';
+import './mtk-14-import.d.ts';
+/**
+ * Mtk-14
+ */
+
+import type Graphene from '@girs/graphene-1.0';
+import type GObject from '@girs/gobject-2.0';
+import type GLib from '@girs/glib-2.0';
+
+export namespace Mtk {
+
+enum RegionOverlap {
+    OUT,
+    IN,
+    PART,
+}
+enum RoundingStrategy {
+    SHRINK,
+    GROW,
+    ROUND,
+}
+const RECTANGLE_MAX_STACK_RECTS: number
+const REGION_BUILDER_MAX_LEVELS: number
+function rectangle_from_graphene_rect(rect: Graphene.Rect, rounding_strategy: RoundingStrategy): /* dest */ Rectangle
+function region_create(): Region
+function region_create_rectangle(rect: Rectangle): Region
+function region_create_rectangles(rects: Rectangle, n_rects: number): Region
+function x11_errors_deinit(): void
+interface Rectangle {
+
+    // Own fields of Mtk-14.Mtk.Rectangle
+
+    /**
+     * X coordinate of the top-left corner
+     * @field 
+     */
+    x: number
+    /**
+     * Y coordinate of the top-left corner
+     * @field 
+     */
+    y: number
+    /**
+     * Width of the rectangle
+     * @field 
+     */
+    width: number
+    /**
+     * Height of the rectangle
+     * @field 
+     */
+    height: number
+
+    // Owm methods of Mtk-14.Mtk.Rectangle
+
+    area(): number
+    contains_rect(inner_rect: Rectangle): boolean
+    copy(): Rectangle
+    could_fit_rect(inner_rect: Rectangle): boolean
+    crop_and_scale(src_rect: Graphene.Rect, dst_width: number, dst_height: number, dest: Rectangle): void
+    /**
+     * Compares the two rectangles
+     * @param src2 The second rectangle
+     * @returns Whether the two rectangles are equal
+     */
+    equal(src2: Rectangle): boolean
+    free(): void
+    /**
+     * Similar to [method`Rectangle`.overlap] but ignores the vertical location.
+     * @param rect2 The second rectangle
+     * @returns Whether the two rectangles overlap horizontally
+     */
+    horiz_overlap(rect2: Rectangle): boolean
+    /**
+     * Find the intersection between the two rectangles
+     * @param src2 another #MtkRectangle
+     * @returns TRUE is some intersection exists and is not degenerate, FALSE   otherwise.
+     */
+    intersect(src2: Rectangle): [ /* returnType */ boolean, /* dest */ Rectangle ]
+    is_adjacent_to(other: Rectangle): boolean
+    /**
+     * Similar to [method`Rectangle`.intersect] but doesn't provide
+     * the location of the intersection.
+     * @param rect2 The second rectangle
+     * @returns Whether the two rectangles overlap
+     */
+    overlap(rect2: Rectangle): boolean
+    scale_double(scale: number, rounding_strategy: RoundingStrategy, dest: Rectangle): void
+    to_graphene_rect(): Graphene.Rect
+    /**
+     * Computes the union of the two rectangles
+     * @param rect2 another #MtkRectangle
+     */
+    union(rect2: Rectangle): /* dest */ Rectangle
+    /**
+     * Similar to [method`Rectangle`.overlap] but ignores the horizontal location.
+     * @param rect2 The second rectangle
+     * @returns Whether the two rectangles overlap vertically
+     */
+    vert_overlap(rect2: Rectangle): boolean
+}
+
+class Rectangle {
+
+    // Own properties of Mtk-14.Mtk.Rectangle
+
+    static name: string
+
+    // Constructors of Mtk-14.Mtk.Rectangle
+
+    /**
+     * Creates a new rectangle
+     * @constructor 
+     * @param x X coordinate of the top left corner
+     * @param y Y coordinate of the top left corner
+     * @param width Width of the rectangle
+     * @param height Height of the rectangle
+     */
+    constructor(x: number, y: number, width: number, height: number) 
+    /**
+     * Creates a new rectangle
+     * @constructor 
+     * @param x X coordinate of the top left corner
+     * @param y Y coordinate of the top left corner
+     * @param width Width of the rectangle
+     * @param height Height of the rectangle
+     */
+    static new(x: number, y: number, width: number, height: number): Rectangle
+    static from_graphene_rect(rect: Graphene.Rect, rounding_strategy: RoundingStrategy): /* dest */ Rectangle
+}
+
+interface Region {
+
+    // Owm methods of Mtk-14.Mtk.Region
+
+    apply_matrix_transform_expand(transform: Graphene.Matrix): Region
+    contains_point(x: number, y: number): boolean
+    contains_rectangle(rect: Rectangle): RegionOverlap
+    copy(): Region
+    crop_and_scale(src_rect: Graphene.Rect, dst_width: number, dst_height: number): Region
+    equal(other: Region): boolean
+    get_extents(): Rectangle
+    get_rectangle(nth: number): Rectangle
+    intersect(other: Region): void
+    intersect_rectangle(rect: Rectangle): void
+    is_empty(): boolean
+    num_rectangles(): number
+    /**
+     * Increases the reference count
+     * @returns The region
+     */
+    ref(): Region
+    scale(scale: number): Region
+    subtract(other: Region): void
+    subtract_rectangle(rect: Rectangle): void
+    translate(dx: number, dy: number): void
+    union(other: Region): void
+    union_rectangle(rect: Rectangle): void
+    unref(): void
+}
+
+class Region {
+
+    // Own properties of Mtk-14.Mtk.Region
+
+    static name: string
+
+    // Constructors of Mtk-14.Mtk.Region
+
+    static create(): Region
+    static create_rectangle(rect: Rectangle): Region
+    static create_rectangles(rects: Rectangle, n_rects: number): Region
+}
+
+interface RegionBuilder {
+
+    // Own fields of Mtk-14.Mtk.RegionBuilder
+
+    levels: Region[]
+    n_levels: number
+
+    // Owm methods of Mtk-14.Mtk.RegionBuilder
+
+    add_rectangle(x: number, y: number, width: number, height: number): void
+    finish(): Region
+    init(): void
+}
+
+class RegionBuilder {
+
+    // Own properties of Mtk-14.Mtk.RegionBuilder
+
+    static name: string
+}
+
+interface RegionIterator {
+
+    // Own fields of Mtk-14.Mtk.RegionIterator
+
+    /**
+     * region being iterated
+     * @field 
+     */
+    region: Region
+    /**
+     * current rectangle
+     * @field 
+     */
+    rectangle: Rectangle
+    /**
+     * whether the current rectangle starts a horizontal band
+     * @field 
+     */
+    line_start: boolean
+    /**
+     * whether the current rectangle ends a horizontal band
+     * @field 
+     */
+    line_end: boolean
+    i: number
+
+    // Owm methods of Mtk-14.Mtk.RegionIterator
+
+    at_end(): boolean
+    init(region: Region): void
+    next(): void
+}
+
+/**
+ * MtkRegion is a yx banded region; sometimes its useful to iterate through
+ * such a region treating the start and end of each horizontal band in a distinct
+ * fashion.
+ * 
+ * Usage:
+ * 
+ * ```c
+ *  MtkRegionIterator iter;
+ *  for (mtk_region_iterator_init (&iter, region);
+ *       !mtk_region_iterator_at_end (&iter);
+ *       mtk_region_iterator_next (&iter))
+ *  {
+ *    [ Use iter.rectangle, iter.line_start, iter.line_end ]
+ *  }
+ * ```
+ * @record 
+ */
+class RegionIterator {
+
+    // Own properties of Mtk-14.Mtk.RegionIterator
+
+    static name: string
+}
+
+/**
+ * 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 Mtk;
+// END

package/mtk-14.js

@@ -0,0 +1,10 @@
+
+
+  // @ts-expect-error
+  import Mtk from 'gi://Mtk?version=14';
+  export { Mtk };
+  export default Mtk;
+
+
+
+

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@girs/mtk-14",
+  "version": "14.0.0-3.3.0",
+  "description": "GJS TypeScript type definitions for Mtk-14, generated from library version 14.0.0",
+  "type": "module",
+  "module": "mtk-14.js",
+  "main": "mtk-14.js",
+  "exports": {
+    "./ambient": {
+      "types": "./mtk-14-ambient.d.ts",
+      "default": "./mtk-14-ambient.js"
+    },
+    "./import": {
+      "types": "./mtk-14-import.d.ts",
+      "default": "./mtk-14-import.js"
+    },
+    ".": {
+      "import": {
+        "types": "./mtk-14.d.ts",
+        "default": "./mtk-14.js"
+      },
+      "require": {
+        "types": "./mtk-14.d.cts",
+        "default": "./mtk-14.cjs"
+      }
+    }
+  },
+  "scripts": {
+    "test": "yarn test:esm && yarn test:cjs",
+    "test:esm": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit mtk-14.d.ts",
+    "test:cjs": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit mtk-14.d.cts"
+  },
+  "dependencies": {
+    "@girs/gjs": "^3.3.0",
+    "@girs/glib-2.0": "^2.78.0-3.3.0",
+    "@girs/gobject-2.0": "^2.78.0-3.3.0",
+    "@girs/graphene-1.0": "^1.0.0-3.3.0"
+  },
+  "devDependencies": {
+    "typescript": "*"
+  },
+  "keywords": [
+    "Gir",
+    "TypeScript",
+    "types",
+    "GObject-Introspection",
+    "GJS",
+    "Mtk-14"
+  ],
+  "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/mtk-14#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": ["./mtk-14.d.ts"]
+}
+
+

package/typedoc.json

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