@girs/coglpango-14 14.0.0-3.3.0

package/README.md

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

@@ -0,0 +1,8 @@
+
+declare module 'gi://CoglPango?version=14' {
+    import CoglPango14 from '@girs/coglpango-14';
+    export default CoglPango14;
+}
+
+
+

package/coglpango-14-ambient.js

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

package/coglpango-14-import.d.ts

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

package/coglpango-14-import.js

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

package/coglpango-14.cjs

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

package/coglpango-14.d.cts

@@ -0,0 +1,149 @@
+
+/*
+ * 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 './coglpango-14-ambient.d.ts';
+import './coglpango-14-import.d.ts';
+/**
+ * CoglPango-14
+ */
+
+import type PangoCairo from '@girs/pangocairo-1.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 Mtk from '@girs/mtk-14';
+import type Graphene from '@girs/graphene-1.0';
+import type Cogl from '@girs/cogl-14';
+import type xlib from '@girs/xlib-2.0';
+import type GL from '@girs/gl-1.0';
+
+/**
+ * This updates any internal glyph cache textures as necessary to be
+ * able to render the given `layout`.
+ * 
+ * This api should be used to avoid mid-scene modifications of
+ * glyph-cache textures which can lead to undefined rendering results.
+ * @param layout A #PangoLayout
+ */
+export function ensure_glyph_cache_for_layout(layout: Pango.Layout): void
+/**
+ * Clears the glyph cache for `font_map`.
+ * @param font_map a #CoglPangoFontMap
+ */
+export function font_map_clear_glyph_cache(font_map: FontMap): void
+/**
+ * Create a [class`Pango`.Context] for the given `font_map`.
+ * @param font_map a #CoglPangoFontMap
+ * @returns the newly created context: free with [method@GObject.Object.unref].
+ */
+export function font_map_create_context(font_map: FontMap): Pango.Context
+/**
+ * Retrieves the [class`CoglPango`.Renderer] for the passed `font_map`.
+ * @param font_map a #CoglPangoFontMap
+ * @returns a #PangoRenderer
+ */
+export function font_map_get_renderer(font_map: FontMap): Pango.Renderer
+/**
+ * Retrieves whether the [class`CoglPango`.Renderer] used by `font_map` will use
+ * mipmapping when rendering the glyphs.
+ * @param font_map a #CoglPangoFontMap
+ * @returns %TRUE if mipmapping is used, %FALSE otherwise.
+ */
+export function font_map_get_use_mipmapping(font_map: FontMap): boolean
+/**
+ * Creates a new font map.
+ * @returns the newly created #PangoFontMap
+ */
+export function font_map_new(): Pango.FontMap
+/**
+ * Sets the resolution for the `font_map`.
+ * 
+ * This is a scale factor between points specified in a
+ * [struct`Pango`.FontDescription] and Cogl units.
+ * The default value is %96, meaning that a 10 point font will be 13
+ * units high. (10 * 96. / 72. = 13.3).
+ * @param font_map a #CoglPangoFontMap
+ * @param dpi The resolution in "dots per inch". (Physical inches aren't       actually involved; the terminology is conventional.)
+ */
+export function font_map_set_resolution(font_map: FontMap, dpi: number): void
+/**
+ * Sets whether the renderer for the passed font map should use
+ * mipmapping when rendering a [class`Pango`.Layout].
+ * @param font_map a #CoglPangoFontMap
+ * @param value %TRUE to enable the use of mipmapping
+ */
+export function font_map_set_use_mipmapping(font_map: FontMap, value: boolean): void
+export module Renderer {
+
+    // Constructor properties interface
+
+    export interface ConstructorProperties extends Pango.Renderer.ConstructorProperties {
+
+        // Own constructor properties of CoglPango-14.CoglPango.Renderer
+
+        context?: Cogl.Context | null
+    }
+
+}
+
+export interface Renderer {
+
+    // Own properties of CoglPango-14.CoglPango.Renderer
+
+    readonly context: Cogl.Context
+
+    // Class property signals of CoglPango-14.CoglPango.Renderer
+
+    connect(sigName: "notify::context", callback: (($obj: Renderer, pspec: GObject.ParamSpec) => void)): number
+    connect_after(sigName: "notify::context", callback: (($obj: Renderer, pspec: GObject.ParamSpec) => void)): number
+    emit(sigName: "notify::context", ...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 Renderer extends Pango.Renderer {
+
+    // Own properties of CoglPango-14.CoglPango.Renderer
+
+    static name: string
+    static $gtype: GObject.GType<Renderer>
+
+    // Constructors of CoglPango-14.CoglPango.Renderer
+
+    constructor(config?: Renderer.ConstructorProperties) 
+    _init(config?: Renderer.ConstructorProperties): void
+}
+
+export interface RendererClass {
+}
+
+export abstract class RendererClass {
+
+    // Own properties of CoglPango-14.CoglPango.RendererClass
+
+    static name: string
+}
+
+    export type FontMap = PangoCairo.FontMap
+/**
+ * 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/coglpango-14.d.ts

@@ -0,0 +1,154 @@
+
+/*
+ * 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 './coglpango-14-ambient.d.ts';
+import './coglpango-14-import.d.ts';
+/**
+ * CoglPango-14
+ */
+
+import type PangoCairo from '@girs/pangocairo-1.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 Mtk from '@girs/mtk-14';
+import type Graphene from '@girs/graphene-1.0';
+import type Cogl from '@girs/cogl-14';
+import type xlib from '@girs/xlib-2.0';
+import type GL from '@girs/gl-1.0';
+
+export namespace CoglPango {
+
+/**
+ * This updates any internal glyph cache textures as necessary to be
+ * able to render the given `layout`.
+ * 
+ * This api should be used to avoid mid-scene modifications of
+ * glyph-cache textures which can lead to undefined rendering results.
+ * @param layout A #PangoLayout
+ */
+function ensure_glyph_cache_for_layout(layout: Pango.Layout): void
+/**
+ * Clears the glyph cache for `font_map`.
+ * @param font_map a #CoglPangoFontMap
+ */
+function font_map_clear_glyph_cache(font_map: FontMap): void
+/**
+ * Create a [class`Pango`.Context] for the given `font_map`.
+ * @param font_map a #CoglPangoFontMap
+ * @returns the newly created context: free with [method@GObject.Object.unref].
+ */
+function font_map_create_context(font_map: FontMap): Pango.Context
+/**
+ * Retrieves the [class`CoglPango`.Renderer] for the passed `font_map`.
+ * @param font_map a #CoglPangoFontMap
+ * @returns a #PangoRenderer
+ */
+function font_map_get_renderer(font_map: FontMap): Pango.Renderer
+/**
+ * Retrieves whether the [class`CoglPango`.Renderer] used by `font_map` will use
+ * mipmapping when rendering the glyphs.
+ * @param font_map a #CoglPangoFontMap
+ * @returns %TRUE if mipmapping is used, %FALSE otherwise.
+ */
+function font_map_get_use_mipmapping(font_map: FontMap): boolean
+/**
+ * Creates a new font map.
+ * @returns the newly created #PangoFontMap
+ */
+function font_map_new(): Pango.FontMap
+/**
+ * Sets the resolution for the `font_map`.
+ * 
+ * This is a scale factor between points specified in a
+ * [struct`Pango`.FontDescription] and Cogl units.
+ * The default value is %96, meaning that a 10 point font will be 13
+ * units high. (10 * 96. / 72. = 13.3).
+ * @param font_map a #CoglPangoFontMap
+ * @param dpi The resolution in "dots per inch". (Physical inches aren't       actually involved; the terminology is conventional.)
+ */
+function font_map_set_resolution(font_map: FontMap, dpi: number): void
+/**
+ * Sets whether the renderer for the passed font map should use
+ * mipmapping when rendering a [class`Pango`.Layout].
+ * @param font_map a #CoglPangoFontMap
+ * @param value %TRUE to enable the use of mipmapping
+ */
+function font_map_set_use_mipmapping(font_map: FontMap, value: boolean): void
+module Renderer {
+
+    // Constructor properties interface
+
+    interface ConstructorProperties extends Pango.Renderer.ConstructorProperties {
+
+        // Own constructor properties of CoglPango-14.CoglPango.Renderer
+
+        context?: Cogl.Context | null
+    }
+
+}
+
+interface Renderer {
+
+    // Own properties of CoglPango-14.CoglPango.Renderer
+
+    readonly context: Cogl.Context
+
+    // Class property signals of CoglPango-14.CoglPango.Renderer
+
+    connect(sigName: "notify::context", callback: (($obj: Renderer, pspec: GObject.ParamSpec) => void)): number
+    connect_after(sigName: "notify::context", callback: (($obj: Renderer, pspec: GObject.ParamSpec) => void)): number
+    emit(sigName: "notify::context", ...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 Renderer extends Pango.Renderer {
+
+    // Own properties of CoglPango-14.CoglPango.Renderer
+
+    static name: string
+    static $gtype: GObject.GType<Renderer>
+
+    // Constructors of CoglPango-14.CoglPango.Renderer
+
+    constructor(config?: Renderer.ConstructorProperties) 
+    _init(config?: Renderer.ConstructorProperties): void
+}
+
+interface RendererClass {
+}
+
+abstract class RendererClass {
+
+    // Own properties of CoglPango-14.CoglPango.RendererClass
+
+    static name: string
+}
+
+    type FontMap = PangoCairo.FontMap
+/**
+ * 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 CoglPango;
+// END

package/coglpango-14.js

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

package/package.json

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

package/typedoc.json

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