@girs/gci-1 1.0.0-4.0.0

package/README.md

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

@@ -0,0 +1,12 @@
+
+declare module 'gi://GCi?version=1' {
+    import GCi from '@girs/gci-1';
+    export default GCi;
+}
+
+declare module 'gi://GCi' {
+    import GCi1 from 'gi://GCi?version=1';
+    export default GCi1;
+}
+
+

package/gci-1-ambient.js

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

package/gci-1-import.d.ts

@@ -0,0 +1,12 @@
+
+import GCi1 from '@girs/gci-1';
+
+declare global {
+    export interface GjsGiImports {
+        GCi: typeof GCi1;
+    }
+}
+
+export default GjsGiImports;
+
+

package/gci-1-import.js

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

package/gci-1.d.ts

@@ -0,0 +1,84 @@
+/*
+ * 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 './gci-1-ambient.d.ts';
+
+/**
+ * GCi-1
+ */
+
+import type Gtk from '@girs/gtk-4.0';
+import type Gsk from '@girs/gsk-4.0';
+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 Gdk from '@girs/gdk-4.0';
+import type cairo from '@girs/cairo-1.0';
+import type PangoCairo from '@girs/pangocairo-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 Gio from '@girs/gio-2.0';
+import type GdkPixbuf from '@girs/gdkpixbuf-2.0';
+import type GModule from '@girs/gmodule-2.0';
+
+export namespace GCi {
+    module EntryController {
+        // Constructor properties interface
+
+        interface ConstructorProps extends GObject.Object.ConstructorProps {
+            entry: Gtk.Entry;
+        }
+    }
+
+    class EntryController extends GObject.Object {
+        static $gtype: GObject.GType<EntryController>;
+
+        // Own properties of GCi.EntryController
+
+        get entry(): Gtk.Entry;
+        set entry(val: Gtk.Entry);
+
+        // Constructors of GCi.EntryController
+
+        constructor(properties?: Partial<EntryController.ConstructorProps>, ...args: any[]);
+
+        _init(...args: any[]): void;
+
+        static for_entry(entry: Gtk.Entry): EntryController;
+
+        static ['new'](): EntryController;
+
+        // Own methods of GCi.EntryController
+
+        get_entry(): Gtk.Entry;
+        set_entry(value: Gtk.Entry): void;
+    }
+
+    type EntryControllerClass = typeof EntryController;
+    abstract class EntryControllerPrivate {
+        static $gtype: GObject.GType<EntryControllerPrivate>;
+
+        // Constructors of GCi.EntryControllerPrivate
+
+        _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 GCi;
+// END

package/gci-1.js

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

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@girs/gci-1",
+  "version": "1.0.0-4.0.0",
+  "description": "GJS TypeScript type definitions for GCi-1, generated from library version 1.0.0",
+  "type": "module",
+  "module": "gci-1.js",
+  "main": "gci-1.js",
+  "exports": {
+    "./ambient": {
+      "types": "./gci-1-ambient.d.ts",
+      "import": "./gci-1-ambient.js",
+      "default": "./gci-1-ambient.js"
+    },
+    "./import": {
+      "types": "./gci-1-import.d.ts",
+      "import": "./gci-1-import.js",
+      "default": "./gci-1-import.js"
+    },
+    ".": {
+      "types": "./gci-1.d.ts",
+      "import": "./gci-1.js",
+      "default": "./gci-1.js"
+    }
+  },
+  "scripts": {
+    "test": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit gci-1.d.ts"
+  },
+  "dependencies": {
+    "@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-4.0": "^4.0.0-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/graphene-1.0": "^1.0.0-4.0.0-beta.1",
+    "@girs/gsk-4.0": "^4.0.0-4.0.0-beta.1",
+    "@girs/gtk-4.0": "^4.12.0-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/pangocairo-1.0": "^1.0.0-4.0.0-beta.1"
+  },
+  "devDependencies": {
+    "typescript": "*"
+  },
+  "keywords": [
+    "Gir",
+    "TypeScript",
+    "types",
+    "GObject-Introspection",
+    "GJS",
+    "GCi-1"
+  ],
+  "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/gci-1#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": ["./gci-1.d.ts"]
+}
+
+

package/typedoc.json

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