@girs/metatest-14 14.0.0-3.3.0

package/README.md

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

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

package/metatest-14-ambient.js

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

package/metatest-14-import.d.ts

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

package/metatest-14-import.js

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

package/metatest-14.cjs

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

package/metatest-14.d.cts

@@ -0,0 +1,204 @@
+
+/*
+ * 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 './metatest-14-ambient.d.ts';
+import './metatest-14-import.d.ts';
+/**
+ * MetaTest-14
+ */
+
+import type xlib from '@girs/xlib-2.0';
+import type xfixes from '@girs/xfixes-4.0';
+import type Mtk from '@girs/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';
+import type Meta from '@girs/meta-14';
+import type Gio from '@girs/gio-2.0';
+import type GDesktopEnums from '@girs/gdesktopenums-3.0';
+import type CoglPango from '@girs/coglpango-14';
+import type PangoCairo from '@girs/pangocairo-1.0';
+import type cairo from '@girs/cairo-1.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 Cogl from '@girs/cogl-14';
+import type GL from '@girs/gl-1.0';
+import type Clutter from '@girs/clutter-14';
+import type Atk from '@girs/atk-1.0';
+
+export enum ContextTestType {
+    HEADLESS,
+    VKMS,
+    NESTED,
+}
+export enum ContextTestFlag {
+    NONE,
+    TEST_CLIENT,
+    NO_X11,
+}
+export enum TestRunFlags {
+    NONE,
+    CAN_SKIP,
+}
+export module ContextTest {
+
+    // Signal callback interfaces
+
+    /**
+     * Signal callback interface for `after-tests`
+     */
+    export interface AfterTestsSignalCallback {
+        ($obj: ContextTest): void
+    }
+
+    /**
+     * Signal callback interface for `before-tests`
+     */
+    export interface BeforeTestsSignalCallback {
+        ($obj: ContextTest): void
+    }
+
+    /**
+     * Signal callback interface for `run-tests`
+     */
+    export interface RunTestsSignalCallback {
+        ($obj: ContextTest): number
+    }
+
+
+    // Constructor properties interface
+
+    export interface ConstructorProperties extends Meta.Context.ConstructorProperties {
+    }
+
+}
+
+export interface ContextTest {
+
+    // Own fields of MetaTest-14.MetaTest.ContextTest
+
+    parent_instance: Meta.Context & GObject.Object
+
+    // Owm methods of MetaTest-14.MetaTest.ContextTest
+
+    run_tests(flags: TestRunFlags): number
+    wait_for_x11_display(): void
+
+    // Own signals of MetaTest-14.MetaTest.ContextTest
+
+    connect(sigName: "after-tests", callback: ContextTest.AfterTestsSignalCallback): number
+    connect_after(sigName: "after-tests", callback: ContextTest.AfterTestsSignalCallback): number
+    emit(sigName: "after-tests", ...args: any[]): void
+    connect(sigName: "before-tests", callback: ContextTest.BeforeTestsSignalCallback): number
+    connect_after(sigName: "before-tests", callback: ContextTest.BeforeTestsSignalCallback): number
+    emit(sigName: "before-tests", ...args: any[]): void
+    connect(sigName: "run-tests", callback: ContextTest.RunTestsSignalCallback): number
+    connect_after(sigName: "run-tests", callback: ContextTest.RunTestsSignalCallback): number
+    emit(sigName: "run-tests", ...args: any[]): void
+
+    // Class property signals of MetaTest-14.MetaTest.ContextTest
+
+    connect(sigName: "notify::name", callback: (($obj: ContextTest, pspec: GObject.ParamSpec) => void)): number
+    connect_after(sigName: "notify::name", callback: (($obj: ContextTest, pspec: GObject.ParamSpec) => void)): number
+    emit(sigName: "notify::name", ...args: any[]): void
+    connect(sigName: "notify::unsafe-mode", callback: (($obj: ContextTest, pspec: GObject.ParamSpec) => void)): number
+    connect_after(sigName: "notify::unsafe-mode", callback: (($obj: ContextTest, pspec: GObject.ParamSpec) => void)): number
+    emit(sigName: "notify::unsafe-mode", ...args: any[]): void
+    connect(sigName: string, callback: (...args: any[]) => void): number
+    connect_after(sigName: string, callback: (...args: any[]) => void): number
+    emit(sigName: string, ...args: any[]): void
+    disconnect(id: number): void
+}
+
+export class ContextTest extends Meta.Context {
+
+    // Own properties of MetaTest-14.MetaTest.ContextTest
+
+    static name: string
+    static $gtype: GObject.GType<ContextTest>
+
+    // Constructors of MetaTest-14.MetaTest.ContextTest
+
+    constructor(config?: ContextTest.ConstructorProperties) 
+    _init(config?: ContextTest.ConstructorProperties): void
+}
+
+export module TestMonitor {
+
+    // Constructor properties interface
+
+    export interface ConstructorProperties extends GObject.Object.ConstructorProperties {
+    }
+
+}
+
+export interface TestMonitor {
+
+    // Owm methods of MetaTest-14.MetaTest.TestMonitor
+
+    destroy(): void
+
+    // Class property signals of MetaTest-14.MetaTest.TestMonitor
+
+    connect(sigName: string, callback: (...args: any[]) => void): number
+    connect_after(sigName: string, callback: (...args: any[]) => void): number
+    emit(sigName: string, ...args: any[]): void
+    disconnect(id: number): void
+}
+
+export class TestMonitor extends GObject.Object {
+
+    // Own properties of MetaTest-14.MetaTest.TestMonitor
+
+    static name: string
+    static $gtype: GObject.GType<TestMonitor>
+
+    // Constructors of MetaTest-14.MetaTest.TestMonitor
+
+    constructor(config?: TestMonitor.ConstructorProperties) 
+    constructor(context: Meta.Context, width: number, height: number, refresh_rate: number) 
+    static new(context: Meta.Context, width: number, height: number, refresh_rate: number): TestMonitor
+    _init(config?: TestMonitor.ConstructorProperties): void
+}
+
+export interface ContextTestClass {
+}
+
+export abstract class ContextTestClass {
+
+    // Own properties of MetaTest-14.MetaTest.ContextTestClass
+
+    static name: string
+}
+
+export interface TestMonitorClass {
+
+    // Own fields of MetaTest-14.MetaTest.TestMonitorClass
+
+    parent_class: GObject.ObjectClass
+}
+
+export abstract class TestMonitorClass {
+
+    // Own properties of MetaTest-14.MetaTest.TestMonitorClass
+
+    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/metatest-14.d.ts

@@ -0,0 +1,209 @@
+
+/*
+ * 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 './metatest-14-ambient.d.ts';
+import './metatest-14-import.d.ts';
+/**
+ * MetaTest-14
+ */
+
+import type xlib from '@girs/xlib-2.0';
+import type xfixes from '@girs/xfixes-4.0';
+import type Mtk from '@girs/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';
+import type Meta from '@girs/meta-14';
+import type Gio from '@girs/gio-2.0';
+import type GDesktopEnums from '@girs/gdesktopenums-3.0';
+import type CoglPango from '@girs/coglpango-14';
+import type PangoCairo from '@girs/pangocairo-1.0';
+import type cairo from '@girs/cairo-1.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 Cogl from '@girs/cogl-14';
+import type GL from '@girs/gl-1.0';
+import type Clutter from '@girs/clutter-14';
+import type Atk from '@girs/atk-1.0';
+
+export namespace MetaTest {
+
+enum ContextTestType {
+    HEADLESS,
+    VKMS,
+    NESTED,
+}
+enum ContextTestFlag {
+    NONE,
+    TEST_CLIENT,
+    NO_X11,
+}
+enum TestRunFlags {
+    NONE,
+    CAN_SKIP,
+}
+module ContextTest {
+
+    // Signal callback interfaces
+
+    /**
+     * Signal callback interface for `after-tests`
+     */
+    interface AfterTestsSignalCallback {
+        ($obj: ContextTest): void
+    }
+
+    /**
+     * Signal callback interface for `before-tests`
+     */
+    interface BeforeTestsSignalCallback {
+        ($obj: ContextTest): void
+    }
+
+    /**
+     * Signal callback interface for `run-tests`
+     */
+    interface RunTestsSignalCallback {
+        ($obj: ContextTest): number
+    }
+
+
+    // Constructor properties interface
+
+    interface ConstructorProperties extends Meta.Context.ConstructorProperties {
+    }
+
+}
+
+interface ContextTest {
+
+    // Own fields of MetaTest-14.MetaTest.ContextTest
+
+    parent_instance: Meta.Context & GObject.Object
+
+    // Owm methods of MetaTest-14.MetaTest.ContextTest
+
+    run_tests(flags: TestRunFlags): number
+    wait_for_x11_display(): void
+
+    // Own signals of MetaTest-14.MetaTest.ContextTest
+
+    connect(sigName: "after-tests", callback: ContextTest.AfterTestsSignalCallback): number
+    connect_after(sigName: "after-tests", callback: ContextTest.AfterTestsSignalCallback): number
+    emit(sigName: "after-tests", ...args: any[]): void
+    connect(sigName: "before-tests", callback: ContextTest.BeforeTestsSignalCallback): number
+    connect_after(sigName: "before-tests", callback: ContextTest.BeforeTestsSignalCallback): number
+    emit(sigName: "before-tests", ...args: any[]): void
+    connect(sigName: "run-tests", callback: ContextTest.RunTestsSignalCallback): number
+    connect_after(sigName: "run-tests", callback: ContextTest.RunTestsSignalCallback): number
+    emit(sigName: "run-tests", ...args: any[]): void
+
+    // Class property signals of MetaTest-14.MetaTest.ContextTest
+
+    connect(sigName: "notify::name", callback: (($obj: ContextTest, pspec: GObject.ParamSpec) => void)): number
+    connect_after(sigName: "notify::name", callback: (($obj: ContextTest, pspec: GObject.ParamSpec) => void)): number
+    emit(sigName: "notify::name", ...args: any[]): void
+    connect(sigName: "notify::unsafe-mode", callback: (($obj: ContextTest, pspec: GObject.ParamSpec) => void)): number
+    connect_after(sigName: "notify::unsafe-mode", callback: (($obj: ContextTest, pspec: GObject.ParamSpec) => void)): number
+    emit(sigName: "notify::unsafe-mode", ...args: any[]): void
+    connect(sigName: string, callback: (...args: any[]) => void): number
+    connect_after(sigName: string, callback: (...args: any[]) => void): number
+    emit(sigName: string, ...args: any[]): void
+    disconnect(id: number): void
+}
+
+class ContextTest extends Meta.Context {
+
+    // Own properties of MetaTest-14.MetaTest.ContextTest
+
+    static name: string
+    static $gtype: GObject.GType<ContextTest>
+
+    // Constructors of MetaTest-14.MetaTest.ContextTest
+
+    constructor(config?: ContextTest.ConstructorProperties) 
+    _init(config?: ContextTest.ConstructorProperties): void
+}
+
+module TestMonitor {
+
+    // Constructor properties interface
+
+    interface ConstructorProperties extends GObject.Object.ConstructorProperties {
+    }
+
+}
+
+interface TestMonitor {
+
+    // Owm methods of MetaTest-14.MetaTest.TestMonitor
+
+    destroy(): void
+
+    // Class property signals of MetaTest-14.MetaTest.TestMonitor
+
+    connect(sigName: string, callback: (...args: any[]) => void): number
+    connect_after(sigName: string, callback: (...args: any[]) => void): number
+    emit(sigName: string, ...args: any[]): void
+    disconnect(id: number): void
+}
+
+class TestMonitor extends GObject.Object {
+
+    // Own properties of MetaTest-14.MetaTest.TestMonitor
+
+    static name: string
+    static $gtype: GObject.GType<TestMonitor>
+
+    // Constructors of MetaTest-14.MetaTest.TestMonitor
+
+    constructor(config?: TestMonitor.ConstructorProperties) 
+    constructor(context: Meta.Context, width: number, height: number, refresh_rate: number) 
+    static new(context: Meta.Context, width: number, height: number, refresh_rate: number): TestMonitor
+    _init(config?: TestMonitor.ConstructorProperties): void
+}
+
+interface ContextTestClass {
+}
+
+abstract class ContextTestClass {
+
+    // Own properties of MetaTest-14.MetaTest.ContextTestClass
+
+    static name: string
+}
+
+interface TestMonitorClass {
+
+    // Own fields of MetaTest-14.MetaTest.TestMonitorClass
+
+    parent_class: GObject.ObjectClass
+}
+
+abstract class TestMonitorClass {
+
+    // Own properties of MetaTest-14.MetaTest.TestMonitorClass
+
+    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 MetaTest;
+// END

package/metatest-14.js

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

package/package.json

@@ -0,0 +1,76 @@
+{
+  "name": "@girs/metatest-14",
+  "version": "14.0.0-3.3.0",
+  "description": "GJS TypeScript type definitions for MetaTest-14, generated from library version 14.0.0",
+  "type": "module",
+  "module": "metatest-14.js",
+  "main": "metatest-14.js",
+  "exports": {
+    "./ambient": {
+      "types": "./metatest-14-ambient.d.ts",
+      "default": "./metatest-14-ambient.js"
+    },
+    "./import": {
+      "types": "./metatest-14-import.d.ts",
+      "default": "./metatest-14-import.js"
+    },
+    ".": {
+      "import": {
+        "types": "./metatest-14.d.ts",
+        "default": "./metatest-14.js"
+      },
+      "require": {
+        "types": "./metatest-14.d.cts",
+        "default": "./metatest-14.cjs"
+      }
+    }
+  },
+  "scripts": {
+    "test": "yarn test:esm && yarn test:cjs",
+    "test:esm": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit metatest-14.d.ts",
+    "test:cjs": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit metatest-14.d.cts"
+  },
+  "dependencies": {
+    "@girs/atk-1.0": "^2.50.1-3.3.0",
+    "@girs/cairo-1.0": "^1.0.0-3.3.0",
+    "@girs/clutter-14": "^14.0.0-3.3.0",
+    "@girs/cogl-14": "^14.0.0-3.3.0",
+    "@girs/coglpango-14": "^14.0.0-3.3.0",
+    "@girs/freetype2-2.0": "^2.0.0-3.3.0",
+    "@girs/gdesktopenums-3.0": "^3.0.0-3.3.0",
+    "@girs/gio-2.0": "^2.78.0-3.3.0",
+    "@girs/gjs": "^3.3.0",
+    "@girs/gl-1.0": "^1.0.0-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",
+    "@girs/harfbuzz-0.0": "^8.2.1-3.3.0",
+    "@girs/meta-14": "^14.0.0-3.3.0",
+    "@girs/mtk-14": "^14.0.0-3.3.0",
+    "@girs/pango-1.0": "^1.51.0-3.3.0",
+    "@girs/pangocairo-1.0": "^1.0.0-3.3.0",
+    "@girs/xfixes-4.0": "^4.0.0-3.3.0",
+    "@girs/xlib-2.0": "^2.0.0-3.3.0"
+  },
+  "devDependencies": {
+    "typescript": "*"
+  },
+  "keywords": [
+    "Gir",
+    "TypeScript",
+    "types",
+    "GObject-Introspection",
+    "GJS",
+    "MetaTest-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/metatest-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": ["./metatest-14.d.ts"]
+}
+
+

package/typedoc.json

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