@ts-for-gir/templates 4.0.0-beta.44 → 4.0.0-rc.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ts-for-gir/templates",
-  "version": "4.0.0-beta.44",
+  "version": "4.0.0-rc.10",
   "description": "Templates for ts-for-gir",
   "type": "module",
   "main": "package.json",

package/templates/gio-2.0.d.ts

@@ -31,7 +31,7 @@
  * ```
  *
  */
-export function _promisify(proto: any, asyncFunc: string, finishFunc?: string): void
+export function _promisify(proto: any, asyncFunc: string, finishFunc?: string): void;
 
 /** Temporary Gio.File.prototype fix */
-export const _LocalFilePrototype: typeof File.prototype
+export const _LocalFilePrototype: typeof File.prototype;

package/templates/gjs/cairo.d.ts

@@ -64,9 +64,9 @@ import Cairo from '<%- Cairo.importPath %>';
         /** Recommended vertical distance between baselines for consecutive lines */
         height: number;
         /** Maximum X advance for any glyph */
-        max_x_advance: number;
+        maxXAdvance: number;
         /** Maximum Y advance for any glyph (typically 0 for horizontal text) */
-        max_y_advance: number;
+        maxYAdvance: number;
     }
 
     /**
@@ -533,6 +533,13 @@ import Cairo from '<%- Cairo.importPath %>';
          */
         showText(utf8: string): void;
 
+        /**
+         * Adds the text outline to the current path (cairo_text_path).
+         * After this call the context will have a current point.
+         * @param utf8 A string of text encoded in UTF-8
+         */
+        textPath(utf8: string): void;
+
         /**
          * Strokes the current path using the current line width, line join,
          * line cap, and dash settings, then clears the path
@@ -561,7 +568,7 @@ import Cairo from '<%- Cairo.importPath %>';
          * Gets the font extents for the currently selected font
          * @returns Font extents in user-space coordinates
          */
-        getFontExtents(): FontExtents;
+        fontExtents(): FontExtents;
 
         /**
          * Renders an array of glyphs at the current point (low-level text API)

package/templates/gobject-2.0.d.ts

@@ -40,7 +40,7 @@ export interface MetaInfo<Props, Interfaces, Sigs> {
 
 export type Property<K extends ParamSpec> = K extends ParamSpec<infer T> ? T : any
 
-<% if (!noAdvancedVariants) { %>
+<%_ if (!noAdvancedVariants) { _%>
 // Advanced type inference for GObject class registration
 // String conversion utilities for property names
 type SnakeToUnderscoreCase<S extends string> = S extends `${infer T}-${infer U}`
@@ -111,7 +111,7 @@ export type SignalDefinitionType = {
     param_types?: readonly GTypeInput[]
     [key: string]: any
 }
-<% } %>
+<%_ } _%>
 
 // Correctly types interface checks.
 export function type_is_a<T extends Object>(obj: Object, is_a_type: { $gtype: GType<T> }): obj is T
@@ -336,7 +336,7 @@ export function registerClass<
     },
 >(options: MetaInfo<Props, Interfaces, Sigs>, cls: T): T
 
-<% if (!noAdvancedVariants) { %>
+<%_ if (!noAdvancedVariants) { _%>
 // Enhanced registerClass overloads with advanced type inference
 
 export function registerClass<P extends {}, T extends new (...args: any[]) => P>(
@@ -367,4 +367,4 @@ export function registerClass<
     },
     klass: T,
 ): RegisteredClass<T, Props, Interfaces>
-<% } %>
+<%_ } _%>

package/templates/gstbase-0.10.d.ts

@@ -2,5 +2,5 @@
 // Workaround
 /** @ignore */
 export module BaseSink {
-    export type ConstructorProps = Gst.BaseSink.ConstructorProps
+    export type ConstructorProps = Gst.BaseSink.ConstructorProps;
 }

package/templates/gtk-4.0.d.ts

@@ -0,0 +1,44 @@
+// @ts-nocheck
+
+/**
+ * GJS replaces `Gtk.Builder` with a JS subclass (`GtkJSBuilder`) whose constructor
+ * accepts five additional, JS-only properties on top of the GIR-derived ones:
+ * `data`, `filename`, `resource`, `callbacks`, and `objects`. They are consumed at
+ * construction time (used to call `add_from_string` / `add_from_file` /
+ * `add_from_resource`, set up a callback scope, and register named objects), so
+ * they appear only in the constructor signature, not as instance accessors.
+ *
+ * @see https://gitlab.gnome.org/GNOME/gjs/-/blob/master/modules/core/overrides/Gtk.js
+ * @example
+ * ```ts
+ * const builder = new Gtk.Builder({
+ *     filename: "window.ui",
+ *     callbacks: { on_clicked: () => print("clicked") },
+ *     objects: { existing: someExistingWidget },
+ * });
+ * ```
+ */
+export namespace Builder {
+    interface ConstructorProps {
+        /** Inline XML interface description. Calls `add_from_string` on construction. */
+        data?: string | Uint8Array;
+        /** Path to a UI file. Calls `add_from_file` on construction. */
+        filename?: string;
+        /** Resource path to a UI file. Calls `add_from_resource` on construction. */
+        resource?: string;
+        /** Named signal callbacks resolved against `<signal>` `handler` attributes. */
+        callbacks?: Record<string, (...args: any[]) => any>;
+        /** Pre-existing objects exposed to the UI via {@link Builder.exposeObjects}. */
+        objects?: Record<string, GObject.Object>;
+    }
+}
+
+/**
+ * GJS-only convenience method on {@link Builder}: registers every entry of
+ * `objects` so the UI XML can reference them by name.
+ *
+ * @see https://gitlab.gnome.org/GNOME/gjs/-/blob/master/modules/core/overrides/Gtk.js
+ */
+export interface Builder {
+    exposeObjects(objects: Record<string, GObject.Object>): void;
+}

package/templates/module.append.d.ts

@@ -1,17 +1,17 @@
-<%_ if(!noNamespace){ -%>
-    }
+<%_ if (!noNamespace) { _%>
+}
 
-    export default <%- girModule.namespace %>;
-<%_ } -%>
+export default <%- girModule.namespace %>;
+<%_ } _%>
 
-<%_ if(!package){ -%>
-    }
+<%_ if (!package) { _%>
+}
 
-    <%_ if(!onlyVersionPrefix){ -%>
-        declare module 'gi://<%- girModule.namespace %>' {
-            import <%- girModule.importNamespace %> from 'gi://<%- girModule.namespace %>?version=<%- girModule.version %>';
-            export default <%- girModule.importNamespace %>;
-        }
-    <% } -%>
-<%_ } -%>
-// END
+<%_ if (!onlyVersionPrefix) { _%>
+declare module 'gi://<%- girModule.namespace %>' {
+    import <%- girModule.importNamespace %> from 'gi://<%- girModule.namespace %>?version=<%- girModule.version %>';
+    export default <%- girModule.importNamespace %>;
+}
+<%_ } _%>
+<%_ } _%>
+// END

package/templates/module.d.ts

@@ -1,53 +1,53 @@
-<%_ if(!package){ -%>
-    <%_ girModule.transitiveDependencies.forEach(dependency => { -%>
-        <%_ if (girModule.packageName !== dependency.packageName) { -%>
-            <%_ if (dependency.exists) { -%>
-                /// <reference path="./<%- dependency.importName %>.d.ts" />
-                <%_ if (dependency.packageName === 'cairo-1.0') { -%>
-                    /// <reference path="./cairo.d.ts" />
-                <%_ } -%>
-            <%_ } -%>
-        <%_ } -%>
-    <%_ }) -%>
-<% } -%>
+<%_ if (!package && !externalDeps) { _%>
+<%_ girModule.transitiveDependencies.forEach(dependency => { _%>
+<%_ if (girModule.packageName !== dependency.packageName) { _%>
+<%_ if (dependency.exists) { _%>
+/// <reference path="./<%- dependency.importName %>.d.ts" />
+<%_ if (dependency.packageName === 'cairo-1.0') { _%>
+/// <reference path="./cairo.d.ts" />
+<%_ } _%>
+<%_ } _%>
+<%_ } _%>
+<%_ }) _%>
+<%_ } _%>
 
 /**
  * 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 `<%- APP_NAME %>` or create a bug report on <%- APP_SOURCE %>
- * 
+ *
  * The based EJS template file is used for the generated .d.ts file of each GIR module like Gtk-4.0, GObject-2.0, ...
  */
 
-<%_ if(!package){ -%>
-    declare module 'gi://<%- girModule.namespace %>?version=<%- girModule.version %>' {
-<% } -%>
+<%_ if (!package) { _%>
+declare module 'gi://<%- girModule.namespace %>?version=<%- girModule.version %>' {
 
-<%_ if(package){ -%>
-    <%_ const Gjs = await dep.getGjs() -%>
-    import '<%- Gjs.importPath %>';
-<% } -%>
+<%_ } _%>
+<%_ if (package) { _%>
+<%_ const Gjs = await dep.getGjs() _%>
+import '<%- Gjs.importPath %>';
 
+<%_ } _%>
 // Module dependencies
-<%_ girModule.transitiveDependencies.forEach(dependency => { -%>
-    <%_ if (girModule.packageName !== dependency.packageName) { -%>
-        <%_ if (dependency.exists) { -%>
-            <%_ if (girModule.hasSymbol(dependency.namespace)) { -%>
-                <%_ if (noNamespace) { -%>
-                    import * as <%- dependency.namespace %>__ from '<%- dependency.importPath %>';
-                <%_ } else { %>
-                    import <%- dependency.namespace %>__ from '<%- dependency.importPath %>';
-                <%_ } -%>
-            <%_ } else { -%>
-                <%- dependency.importDef %>
-            <%_ } -%>
-        <%_ } else { -%>
-            // WARN: Dependency not found: '<%- dependency.packageName %>'
-        <%_ } -%>
-    <%_ } -%>
-<%_ }) -%>
+<%_ girModule.transitiveDependencies.forEach(dependency => { _%>
+<%_ if (girModule.packageName !== dependency.packageName) { _%>
+<%_ if (dependency.exists || externalDeps) { _%>
+<%_ if (dependency.exists && girModule.hasSymbol(dependency.namespace)) { _%>
+<%_ if (noNamespace) { _%>
+import * as <%- dependency.namespace %>__ from '<%- dependency.importPath %>';
+<%_ } else { _%>
+import <%- dependency.namespace %>__ from '<%- dependency.importPath %>';
+<%_ } _%>
+<%_ } else { _%>
+<%- dependency.importDef %>
+<%_ } _%>
+<%_ } else { _%>
+// WARN: Dependency not found: '<%- dependency.packageName %>'
+<%_ } _%>
+<%_ } _%>
+<%_ }) _%>
+<%_ if (!noNamespace) { _%>
 
-<%_ if(!noNamespace){ -%>
-    export namespace <%- girModule.namespace %> {
-<% } -%>
+export namespace <%- girModule.namespace %> {
+<%_ } _%>

package/templates/package.json

@@ -4,7 +4,6 @@ let entryPointName = importName
 if (packageName === 'Gjs') {
   entryPointName = 'gjs'
 }
-let depVersion = workspace ? 'workspace:^' : APP_VERSION
 _%>
 {
     "name": "<%- npmScope %>/<%- importName %>",
@@ -77,7 +76,7 @@ _%>
     },
     "dependencies": {
       <%_ if (packageName !== 'Gjs') { _%>
-      "<%- npmScope %>/gjs": "<%- depVersion %>"<%_ if(deps.length > 0 ) { _%>,
+      <%- dep.createPackageJsonImport(npmScope + '/gjs') %><%_ if(deps.length > 0 ) { _%>,
       <%_ } _%>
       <%_ } _%>
       <%_ for (let i = 0; i < deps.length;  i++ ) { _%>