@girs/libxml2-2.0 2.0.0-3.0.0-beta.14 → 2.0.0-3.0.0-beta.16

package/README.md

@@ -1,13 +1,13 @@
 
 # libxml2-2.0
 
-GJS TypeScript type definitions for libxml2-2.0, generated from library version 2.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.0.0-beta.14.
+GJS TypeScript type definitions for libxml2-2.0, generated from library version 2.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.0.0-beta.16.
 
 Powerful and feature complete XML handling library.
 
 ## Install
 
-To use this type definitions, install them with NPM like this:
+To use this type definitions, install them with NPM:
 ```bash
 npm install @girs/libxml2-2.0
 ```
@@ -24,14 +24,66 @@ Or if you prefer CommonJS, you can also use this:
 const libxml2 = require('@girs/libxml2-2.0');
 ```
 
-If you use [ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules), you can also import this module like you would do this in JavaScript:
+### 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/libxml2-2.0` or `@girs/libxml2-2.0/ambient` in your `tsconfig` or entry point Typescript file:
+
+`index.ts`:
+```ts
+import '@girs/libxml2-2.0'
+```
+
+`tsconfig.json`:
+```json
+{
+  "compilerOptions": {
+    ...
+  },
+  "include": ["@girs/libxml2-2.0"],
+  ...
+}
+```
+
+Now you can import the ambient module with TypeScript support: 
 
 ```ts
 import libxml2 from 'gi://libxml2?version=2.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/libxml2-2.0` or `@girs/libxml2-2.0/import` in your `tsconfig` or entry point Typescript file:
+
+`index.ts`:
+```ts
+import '@girs/libxml2-2.0'
+```
+
+`tsconfig.json`:
+```json
+{
+  "compilerOptions": {
+    ...
+  },
+  "include": ["@girs/libxml2-2.0"],
+  ...
+}
+```
+
+Now you have also type support for this, too:
+
+```ts
+const libxml2 = imports.gi.libxml2;
+```
+
+### 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).
+All existing pre-generated packages can be found on [gjsify/types](https://github.com/gjsify/types).
+

package/libxml2-2.0-ambient.d.ts

@@ -0,0 +1,13 @@
+
+
+declare module 'gi://libxml2?version=2.0' {
+    import Libxml220 from '@girs/libxml2-2.0';
+    export default Libxml220;
+}
+
+declare module 'gi://libxml2' {
+    import Libxml220 from '@girs/libxml2-2.0';
+    export default Libxml220;
+}
+
+

package/libxml2-2.0-import.d.ts

@@ -0,0 +1,13 @@
+
+
+import Libxml220 from '@girs/libxml2-2.0';
+
+declare global {
+    export interface GjsGiImports {
+        libxml2: typeof Libxml220;
+    }
+}
+
+export default GjsGiImports;
+
+

package/libxml2-2.0.cjs

@@ -7,3 +7,5 @@
   
 
 
+
+

package/libxml2-2.0.d.cts

@@ -5,6 +5,9 @@
  * 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 './libxml2-2.0-ambient.d.ts';
+import './libxml2-2.0-import.d.ts';
 /**
  * libxml2-2.0
  */

package/libxml2-2.0.d.ts

@@ -5,6 +5,9 @@
  * 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 './libxml2-2.0-ambient.d.ts';
+import './libxml2-2.0-import.d.ts';
 /**
  * libxml2-2.0
  */

package/libxml2-2.0.js

@@ -6,3 +6,5 @@
   export default libxml2;
 
 
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@girs/libxml2-2.0",
-  "version": "2.0.0-3.0.0-beta.14",
+  "version": "2.0.0-3.0.0-beta.16",
   "description": "GJS TypeScript type definitions for libxml2-2.0, generated from library version 2.0.0",
   "type": "module",
   "module": "libxml2-2.0.js",
@@ -12,6 +12,8 @@
     "tsconfig": "./tsconfig.doc.json"
   },
   "exports": {
+    "./ambient": "./libxml2-2.0-ambient.d.ts",
+    "./import": "./libxml2-2.0-import.d.ts",
     ".": {
       "import": {
         "types": "./libxml2-2.0.d.ts",
@@ -29,7 +31,8 @@
     "test:cjs": "tsc --noEmit libxml2-2.0.d.cts"
   },
   "dependencies": {
-    "@girs/gobject-2.0": "^2.76.1-3.0.0-beta.14"
+    "@girs/gjs": "^3.0.0-beta.16",
+    "@girs/gobject-2.0": "^2.76.1-3.0.0-beta.16"
   },
   "devDependencies": {
     "typescript": "^5.0.4"
@@ -46,7 +49,7 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/gjsify/ts-for-gir.git"
+    "url": "git+https://github.com/gjsify/types.git"
   },
   "bugs": {
     "url": "https://github.com/gjsify/ts-for-gir/issues"

package/tsconfig.doc.json

@@ -17,3 +17,5 @@
   },
   "include": ["./libxml2-2.0.d.ts"]
 }
+
+