@ts-for-gir/lib 3.0.0-beta.11

package/lib/utils.js

@@ -0,0 +1,366 @@
+/* eslint-disable @typescript-eslint/unbound-method */
+import lodash from 'lodash';
+import { join, dirname } from 'path';
+import { existsSync } from 'fs';
+import { fileURLToPath } from 'url';
+import { inspect } from 'util';
+import { Logger } from './logger.js';
+import { COMMENT_REG_EXP, PARAM_REG_EXP, OPT_PARAM_REG_EXP } from './constants.js';
+export { inspect };
+/**
+ * Performs a deep comparison between two values to determine if they are
+ * equivalent.
+ *
+ * **Note:** This method supports comparing arrays, array buffers, booleans,
+ * date objects, error objects, maps, numbers, `Object` objects, regexes,
+ * sets, strings, symbols, and typed arrays. `Object` objects are compared
+ * by their own, not inherited, enumerable properties. Functions and DOM
+ * nodes are **not** supported.
+ *
+ * @category Lang
+ * @param value The value to compare.
+ * @param other The other value to compare.
+ * @returns Returns `true` if the values are equivalent, else `false`.
+ * @example
+ *
+ * var object = { 'user': 'fred' };
+ * var other = { 'user': 'fred' };
+ *
+ * _.isEqual(object, other);
+ * // => true
+ *
+ * object === other;
+ * // => false
+ */
+export const isEqual = lodash.isEqual;
+/**
+ * Creates an array of values by running each element in collection through iteratee. The iteratee is
+ * invoked with three arguments: (value, index|key, collection).
+ *
+ * Many lodash methods are guarded to work as iteratees for methods like _.every, _.filter, _.map, _.mapValues,
+ * _.reject, and _.some.
+ *
+ * The guarded methods are:
+ * ary, callback, chunk, clone, create, curry, curryRight, drop, dropRight, every, fill, flatten, invert, max,
+ * min, parseInt, slice, sortBy, take, takeRight, template, trim, trimLeft, trimRight, trunc, random, range,
+ * sample, some, sum, uniq, and words
+ *
+ * @param collection The collection to iterate over.
+ * @param iteratee The function invoked per iteration.
+ * @return Returns the new mapped array.
+ */
+export const map = lodash.map;
+/**
+ * Iterates over elements of collection, returning the first element predicate returns truthy for.
+ * The predicate is invoked with three arguments: (value, index|key, collection).
+ *
+ * @param collection The collection to search.
+ * @param predicate The function invoked per iteration.
+ * @param fromIndex The index to search from.
+ * @return Returns the matched element, else undefined.
+ */
+export const find = lodash.find;
+/**
+ * Recursively merges own and inherited enumerable properties of source
+ * objects into the destination object, skipping source properties that resolve
+ * to `undefined`. Array and plain object properties are merged recursively.
+ * Other objects and value types are overridden by assignment. Source objects
+ * are applied from left to right. Subsequent sources overwrite property
+ * assignments of previous sources.
+ *
+ * **Note:** This method mutates `object`.
+ *
+ * @category Object
+ * @param object The destination object.
+ * @param [sources] The source objects.
+ * @returns Returns `object`.
+ * @example
+ *
+ * var users = {
+ *   'data': [{ 'user': 'barney' }, { 'user': 'fred' }]
+ * };
+ *
+ * var ages = {
+ *   'data': [{ 'age': 36 }, { 'age': 40 }]
+ * };
+ *
+ * _.merge(users, ages);
+ * // => { 'data': [{ 'user': 'barney', 'age': 36 }, { 'user': 'fred', 'age': 40 }] }
+ */
+export const merge = lodash.merge;
+/**
+ * Creates a shallow clone of value.
+ *
+ * Note: This method is loosely based on the structured clone algorithm and supports cloning arrays,
+ * array buffers, booleans, date objects, maps, numbers, Object objects, regex's, sets, strings, symbols,
+ * and typed arrays. The own enumerable properties of arguments objects are cloned as plain objects. An empty
+ * object is returned for not cloneable values such as error objects, functions, DOM nodes, and WeakMaps.
+ *
+ * @param value The value to clone.
+ * @return Returns the cloned value.
+ */
+export const clone = lodash.clone;
+/**
+ * This method is like clone except that it recursively clones value.
+ *
+ * @param value The value to recursively clone.
+ * @return Returns the deep cloned value.
+ */
+export const cloneDeep = lodash.cloneDeep;
+/**
+ * Split a package name into namespace and version
+ */
+export const splitModuleName = (packageName) => {
+    // There are modules that use multiple hyphens like 'GUPnP-DLNA-1.0'
+    const splits = packageName.split('-');
+    const version = splits.splice(-1, 1)[0];
+    const namespace = splits.join('');
+    return {
+        packageName,
+        namespace,
+        version,
+    };
+};
+/** Remove namespace prefix */
+export const removeNamespace = (type, namespace) => {
+    if (type.startsWith(namespace + '.')) {
+        type = type.substring(namespace.length + 1);
+    }
+    return type;
+};
+/** Remove class module name prefix */
+export const removeClassModule = removeNamespace;
+/**
+ * Add namespace prefix
+ */
+export const addNamespace = (type, namespace) => {
+    if (!type.startsWith(namespace + '.')) {
+        type = namespace + '.' + type;
+    }
+    return type;
+};
+/**
+ * Checking whether some variable is iterable
+ * @see https://stackoverflow.com/a/32538867
+ * @param obj Variable to check for iterable
+ * @returns Whether the variable is iterable or not
+ */
+export const isIterable = (obj) => {
+    return obj != null && typeof obj[Symbol.iterator] === 'function';
+};
+/**
+ * Checking whether a string is numeric
+ * @param str The string to check
+ * @returns Whether the string is numeric or not
+ */
+export const isNumeric = (str) => {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    return !isNaN(str - parseFloat(str));
+};
+/**
+ * Get the first character of a string
+ * @param str The string to get the first character from
+ * @returns The first character
+ */
+export const getFirstChar = (str) => {
+    return str.charAt(0);
+};
+/**
+ * Get the last character of a string
+ * @param str The string to get the last character from
+ * @returns The last character
+ */
+export const getLastChar = (str) => {
+    return str.charAt(str.length - 1);
+};
+/**
+ * Check if the first character of a string is numeric
+ * @param str The string to check
+ * @returns Whether the first character is numeric or not
+ */
+export const isFirstCharNumeric = (str) => {
+    return isNumeric(getFirstChar(str));
+};
+/**
+ * Convert a string to camelCase
+ * @param str The string to convert
+ * @returns The converted string
+ */
+export const camelCase = (str) => {
+    return str
+        .replace(/\s(.)|(\s|-|_|\.)(.)/g, (a) => {
+        return a.toUpperCase();
+    })
+        .replace(/(\s|-|_|\.)/g, '');
+};
+/**
+ * Convert a string to lowerCamelCase
+ * @param str The string to convert
+ * @returns The converted string
+ */
+export const lowerCamelCase = (str) => {
+    str = camelCase(str);
+    str = getFirstChar(str).toLowerCase() + str.slice(1);
+    return str;
+};
+/**
+ * Convert a string to UpperCamelCase
+ * @param str The string to convert
+ * @returns The converted string
+ */
+export const upperCamelCase = (str) => {
+    str = camelCase(str);
+    str = getFirstChar(str).toUpperCase() + str.slice(1);
+    return str;
+};
+/**
+ * Find a file in a list of directories
+ * @param dirs The directories to search in
+ * @param filename The filename to search for
+ * @returns The file info
+ */
+export const findFileInDirs = (dirs, filename) => {
+    const FileInfo = {
+        path: null,
+        filename,
+        exists: false,
+    };
+    for (const dir of dirs) {
+        const filePath = join(dir, filename);
+        FileInfo.exists = existsSync(filePath);
+        if (FileInfo.exists) {
+            FileInfo.path = filePath;
+            return FileInfo;
+        }
+    }
+    return FileInfo;
+};
+/**
+ * Union (a ∪ b): create a set that contains the elements of both set a and set b.
+ * See https://2ality.com/2015/01/es6-set-operations.html#union
+ * @param target
+ * @param source
+ */
+export const union = (target, source) => {
+    return (target = new Set([...target, ...source]));
+};
+export const stripParamNames = (func, ignoreTail = false) => {
+    const g = func;
+    func = func.replace(COMMENT_REG_EXP, '');
+    const lb = func.split('(', 2);
+    if (lb.length < 2)
+        Logger.error(`Bad function definition ${g}`);
+    const rb = lb[1].split(')');
+    const tail = ignoreTail ? '' : rb[rb.length - 1];
+    let params = rb.slice(0, rb.length - 1).join(')');
+    params = params.replace(PARAM_REG_EXP, ':');
+    params = params.replace(OPT_PARAM_REG_EXP, '?:');
+    return `${lb[0]}(${params})${tail}`;
+};
+/**
+ * Check if a line is a comment line
+ * @param line The line to check
+ * @returns Whether the line is a comment line or not
+ */
+export const isCommentLine = (line) => {
+    const lineTrim = line.trim();
+    return lineTrim.startsWith('//') || (lineTrim.startsWith('/*') && lineTrim.endsWith('*/'));
+};
+/**
+ * Add indents to a string
+ * @param indents The number of indents
+ * @param spaceForIndent The number of spaces for each indent
+ * @returns The indented string
+ */
+export const generateIndent = (indents = 1, spaceForIndent = 4) => {
+    return ' '.repeat(indents * spaceForIndent);
+};
+// Get __filename on ESM
+export const __filename = fileURLToPath(import.meta.url);
+// Get __dirname on ESM
+export const __dirname = dirname(__filename);
+/**
+ * Get the output or input directory of the environment
+ * @param environment The environment to get the directory for
+ * @param baseDir The base directory
+ * @returns The path to the directory
+ */
+export const getEnvironmentDir = (environment, baseDir) => {
+    if (!baseDir.endsWith(environment))
+        if (environment === 'gjs' && !baseDir.endsWith('/Gjs')) {
+            return join(baseDir, 'Gjs');
+        }
+    if (environment === 'node' && !baseDir.endsWith('/node-gtk')) {
+        return join(baseDir, 'node-gtk');
+    }
+    return baseDir;
+};
+/**
+ * Get the destination path for the environment
+ * @param environment The environment to get the destination path for
+ * @param outputDir The output directory
+ * @param parts The path parts
+ * @returns The destination path
+ */
+export const getDestPath = (environment, outputDir, ...parts) => {
+    const outputEnvDir = getEnvironmentDir(environment, outputDir);
+    const destPath = join(outputEnvDir, ...parts);
+    return destPath;
+};
+/**
+ * Convert a GirBoolean to a boolean
+ * @param boolStr The GirBoolean string
+ * @param defaultVal The default value
+ * @returns The boolean value
+ */
+export const girBool = (boolStr, defaultVal = false) => {
+    if (boolStr) {
+        if (parseInt(boolStr) === 0)
+            return false;
+        return true;
+    }
+    return defaultVal;
+};
+/**
+ * Returns `true` if the definitions in `d1` and `d2` have equivalent signatures
+ * @param d1
+ * @param d2
+ */
+export const signaturesMatch = (d1, d2) => {
+    if (isCommentLine(d1) || isCommentLine(d2))
+        return false;
+    return stripParamNames(d1) == stripParamNames(d2);
+};
+/**
+ * GirElements contains an attribute `introspectable`, which is a GirBoolean.
+ * If this is attribute is falsy the element is not introspectable,
+ * this means doesn't exist in the bindings, due in general to missing information in the annotations in the original C code
+ */
+export const girElementIsIntrospectable = (girElement, name) => {
+    if (!girElement) {
+        return false;
+    }
+    name = name || girElement?.$?.name;
+    if (!name) {
+        return false;
+    }
+    // Handle introspectable only if the attribute is also present...
+    if (girElement.$.hasOwnProperty('introspectable') && girElement.$.introspectable !== undefined) {
+        return girBool(girElement.$.introspectable, true);
+    }
+    // ...otherwise we assume that it is introspectable
+    return true;
+};
+/**
+ * Check if a type is optional
+ * @param types The types to check
+ * @returns Whether the type is optional or not
+ */
+export const typeIsOptional = (types) => {
+    for (const type of types) {
+        if (type.optional)
+            return true;
+    }
+    return false;
+};
+//# sourceMappingURL=utils.js.map

package/lib/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,OAAO,MAAM,MAAM,QAAQ,CAAA;AAC3B,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AACpC,OAAO,EAAE,UAAU,EAAE,MAAM,IAAI,CAAA;AAE/B,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAA;AAEnC,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAC9B,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAEpC,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAA;AAElF,OAAO,EAAE,OAAO,EAAE,CAAA;AAElB;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAA;AAErC;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAA;AAE7B;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAA;AAE/B;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAA;AAEjC;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAA;AAEjC;;;;;GAKG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,CAAA;AAEzC;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,WAAmB,EAA+D,EAAE;IAChH,oEAAoE;IACpE,MAAM,MAAM,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IACrC,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IACvC,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IACjC,OAAO;QACH,WAAW;QACX,SAAS;QACT,OAAO;KACV,CAAA;AACL,CAAC,CAAA;AAED,8BAA8B;AAC9B,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,IAAY,EAAE,SAAiB,EAAE,EAAE;IAC/D,IAAI,IAAI,CAAC,UAAU,CAAC,SAAS,GAAG,GAAG,CAAC,EAAE;QAClC,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;KAC9C;IACD,OAAO,IAAI,CAAA;AACf,CAAC,CAAA;AAED,sCAAsC;AACtC,MAAM,CAAC,MAAM,iBAAiB,GAAG,eAAe,CAAA;AAEhD;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,IAAY,EAAE,SAAiB,EAAE,EAAE;IAC5D,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,GAAG,GAAG,CAAC,EAAE;QACnC,IAAI,GAAG,SAAS,GAAG,GAAG,GAAG,IAAI,CAAA;KAChC;IACD,OAAO,IAAI,CAAA;AACf,CAAC,CAAA;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,GAAc,EAAW,EAAE;IAClD,OAAO,GAAG,IAAI,IAAI,IAAI,OAAO,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,UAAU,CAAA;AACpE,CAAC,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,GAAW,EAAW,EAAE;IAC9C,8DAA8D;IAC9D,OAAO,CAAC,KAAK,CAAE,GAAW,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,CAAA;AACjD,CAAC,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,GAAW,EAAU,EAAE;IAChD,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;AACxB,CAAC,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,GAAW,EAAU,EAAE;IAC/C,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;AACrC,CAAC,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,GAAW,EAAW,EAAE;IACvD,OAAO,SAAS,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAA;AACvC,CAAC,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,GAAW,EAAU,EAAE;IAC7C,OAAO,GAAG;SACL,OAAO,CAAC,uBAAuB,EAAE,CAAC,CAAC,EAAE,EAAE;QACpC,OAAO,CAAC,CAAC,WAAW,EAAE,CAAA;IAC1B,CAAC,CAAC;SACD,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC,CAAA;AACpC,CAAC,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,GAAW,EAAU,EAAE;IAClD,GAAG,GAAG,SAAS,CAAC,GAAG,CAAC,CAAA;IACpB,GAAG,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IACpD,OAAO,GAAG,CAAA;AACd,CAAC,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,GAAW,EAAU,EAAE;IAClD,GAAG,GAAG,SAAS,CAAC,GAAG,CAAC,CAAA;IACpB,GAAG,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IACpD,OAAO,GAAG,CAAA;AACd,CAAC,CAAA;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,IAAc,EAAE,QAAgB,EAAY,EAAE;IACzE,MAAM,QAAQ,GAAa;QACvB,IAAI,EAAE,IAAI;QACV,QAAQ;QACR,MAAM,EAAE,KAAK;KAChB,CAAA;IACD,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;QACpB,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAA;QACpC,QAAQ,CAAC,MAAM,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAA;QACtC,IAAI,QAAQ,CAAC,MAAM,EAAE;YACjB,QAAQ,CAAC,IAAI,GAAG,QAAQ,CAAA;YACxB,OAAO,QAAQ,CAAA;SAClB;KACJ;IAED,OAAO,QAAQ,CAAA;AACnB,CAAC,CAAA;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,CAAI,MAAoB,EAAE,MAAoB,EAAU,EAAE;IAC3E,OAAO,CAAC,MAAM,GAAG,IAAI,GAAG,CAAI,CAAC,GAAG,MAAM,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;AACxD,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,IAAY,EAAE,UAAU,GAAG,KAAK,EAAU,EAAE;IACxE,MAAM,CAAC,GAAG,IAAI,CAAA;IACd,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC,CAAA;IACxC,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA;IAC7B,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC;QAAE,MAAM,CAAC,KAAK,CAAC,2BAA2B,CAAC,EAAE,CAAC,CAAA;IAC/D,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAC3B,MAAM,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;IAChD,IAAI,MAAM,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IACjD,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,aAAa,EAAE,GAAG,CAAC,CAAA;IAC3C,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAA;IAChD,OAAO,GAAG,EAAE,CAAC,CAAC,CAAC,IAAI,MAAM,IAAI,IAAI,EAAE,CAAA;AACvC,CAAC,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,IAAY,EAAE,EAAE;IAC1C,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,EAAE,CAAA;IAC5B,OAAO,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAA;AAC9F,CAAC,CAAA;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,OAAO,GAAG,CAAC,EAAE,cAAc,GAAG,CAAC,EAAU,EAAE;IACtE,OAAO,GAAG,CAAC,MAAM,CAAC,OAAO,GAAG,cAAc,CAAC,CAAA;AAC/C,CAAC,CAAA;AAED,wBAAwB;AACxB,MAAM,CAAC,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AACxD,uBAAuB;AACvB,MAAM,CAAC,MAAM,SAAS,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;AAE5C;;;;;GAKG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,WAAwB,EAAE,OAAe,EAAU,EAAE;IACnF,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC;QAC9B,IAAI,WAAW,KAAK,KAAK,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;YACpD,OAAO,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;SAC9B;IACL,IAAI,WAAW,KAAK,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE;QAC1D,OAAO,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAA;KACnC;IACD,OAAO,OAAO,CAAA;AAClB,CAAC,CAAA;AAED;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,WAAwB,EAAE,SAAiB,EAAE,GAAG,KAAe,EAAE,EAAE;IAC3F,MAAM,YAAY,GAAG,iBAAiB,CAAC,WAAW,EAAE,SAAS,CAAC,CAAA;IAC9D,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,EAAE,GAAG,KAAK,CAAC,CAAA;IAC7C,OAAO,QAAQ,CAAA;AACnB,CAAC,CAAA;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,OAA2B,EAAE,UAAU,GAAG,KAAK,EAAW,EAAE;IAChF,IAAI,OAAO,EAAE;QACT,IAAI,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC;YAAE,OAAO,KAAK,CAAA;QACzC,OAAO,IAAI,CAAA;KACd;IACD,OAAO,UAAU,CAAA;AACrB,CAAC,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,EAAU,EAAE,EAAU,EAAE,EAAE;IACtD,IAAI,aAAa,CAAC,EAAE,CAAC,IAAI,aAAa,CAAC,EAAE,CAAC;QAAE,OAAO,KAAK,CAAA;IACxD,OAAO,eAAe,CAAC,EAAE,CAAC,IAAI,eAAe,CAAC,EAAE,CAAC,CAAA;AACrD,CAAC,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,UAAmD,EAAE,IAAa,EAAE,EAAE;IAC7G,IAAI,CAAC,UAAU,EAAE;QACb,OAAO,KAAK,CAAA;KACf;IACD,IAAI,GAAG,IAAI,IAAI,UAAU,EAAE,CAAC,EAAE,IAAI,CAAA;IAClC,IAAI,CAAC,IAAI,EAAE;QACP,OAAO,KAAK,CAAA;KACf;IACD,iEAAiE;IACjE,IAAI,UAAU,CAAC,CAAC,CAAC,cAAc,CAAC,gBAAgB,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,cAAc,KAAK,SAAS,EAAE;QAC5F,OAAO,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,cAAc,EAAE,IAAI,CAAC,CAAA;KACpD;IACD,mDAAmD;IACnD,OAAO,IAAI,CAAA;AACf,CAAC,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,KAAe,EAAE,EAAE;IAC9C,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;QACtB,IAAI,IAAI,CAAC,QAAQ;YAAE,OAAO,IAAI,CAAA;KACjC;IACD,OAAO,KAAK,CAAA;AAChB,CAAC,CAAA"}

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@ts-for-gir/lib",
+  "version": "3.0.0-beta.11",
+  "description": "Typescript .d.ts generator from GIR for gjs and node-gtk",
+  "module": "lib/index.js",
+  "main": "lib/index.js",
+  "type": "module",
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "build": "yarn lint && yarn build:ts",
+    "build:ts": "tsc",
+    "clear": "yarn clear:build",
+    "clear:build": "rimraf ./lib",
+    "watch": "yarn build:ts -- --watch",
+    "lint": "eslint . --ext .ts,.tsx --fix"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/gjsify/ts-for-gjs.git"
+  },
+  "author": "Pascal Garber <pascal@artandcode.studio>",
+  "files": [
+    "lib",
+    "templates"
+  ],
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/gjsify/ts-for-gjs/issues"
+  },
+  "homepage": "https://github.com/gjsify/ts-for-gjs#readme",
+  "keywords": [
+    "gjs",
+    "typescript",
+    "generate",
+    "node-gtk",
+    "gir",
+    "gobject-introspection",
+    "gnome",
+    "gtk",
+    "glib",
+    "gobject",
+    "dts",
+    "type definitions"
+  ],
+  "devDependencies": {
+    "@types/ejs": "^3.1.2",
+    "@types/eslint": "8.21.1",
+    "@types/lodash": "^4.14.191",
+    "@types/node": "^18.14.0",
+    "@types/xml2js": "^0.4.11",
+    "@typescript-eslint/eslint-plugin": "^5.53.0",
+    "@typescript-eslint/parser": "^5.53.0",
+    "eslint": "^8.34.0",
+    "eslint-config-prettier": "^8.6.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "prettier": "^2.8.4",
+    "rimraf": "^4.1.2",
+    "typescript": "^4.9.5"
+  },
+  "dependencies": {
+    "colorette": "^2.0.19",
+    "ejs": "^3.1.8",
+    "lodash": "^4.17.21",
+    "xml2js": "^0.4.23"
+  }
+}

package/templates/Gjs/GObject-2.0.d.ts

@@ -0,0 +1,238 @@
+// A few things here are inspired by gi.ts 
+// See https://gitlab.gnome.org/ewlsh/gi.ts/-/blob/master/packages/lib/src/generators/dts/gobject.ts
+// Copyright Evan Welsh
+
+export type GType<T = unknown> = {
+    __type__(arg: never): T
+    name: string
+};
+
+// Extra interfaces used to help define GObject classes in js; these
+// aren't part of gi.
+export interface SignalDefinition {
+    flags?: SignalFlags
+    accumulator: number
+    return_type?: GType
+    param_types?: GType[]
+}
+
+export interface MetaInfo<Props, Interfaces, Sigs> {
+    GTypeName?: string
+    GTypeFlags?: TypeFlags
+    Properties?: Props
+    Signals?: Sigs
+    Implements?: Interfaces
+    CssName?: string
+    Template?: Uint8Array | GLib.Bytes
+    Children?: string[]
+    InternalChildren?: string[]
+}
+
+/** Interface of GObject Interface should be implemented by all GObject interfaces */
+export class Interface<T = unknown> {
+    static _classInit: (cls: any) => any;
+    __name__: string;
+    _construct: (params: any, ...otherArgs: any[]) => any;
+    _init: (params: any) => void;
+    $gtype?: GType<T>;
+}
+
+/**
+ * Use this to signify a function that must be overridden in an
+ * implementation of the interface.
+ */
+export class NotImplementedError extends Error {
+    get name(): 'NotImplementedError'
+}
+
+// Expose GObject static properties for ES6 classes
+
+export const GTypeName: unique symbol;
+export const requires: unique symbol;
+export const interfaces: unique symbol;
+export const properties: unique symbol;
+export const signals: unique symbol;
+
+export let gtypeNameBasedOnJSPath: boolean;
+
+export let TYPE_BOOLEAN: GType<boolean>;
+export let Boolean: BooleanConstructor;
+
+export let TYPE_ENUM: GType<number>;
+export let TYPE_FLAGS: GType<number>;
+
+export let TYPE_DOUBLE: GType<number>;
+export let Double: NumberConstructor;
+
+export let TYPE_STRING: GType<string>;
+export let String: StringConstructor;
+
+export let TYPE_NONE: GType<undefined>;
+export let TYPE_POINTER: GType<undefined>;
+export let TYPE_BOXED: GType<unknown>;
+export let TYPE_PARAM: GType<unknown>;
+export let TYPE_INTERFACE: GType<unknown>;
+export let TYPE_OBJECT: GType<object>;
+export let TYPE_VARIANT: GType<GLib.Variant>;
+export let TYPE_INT: GType<number>;
+export let TYPE_UINT: GType<number>;
+export let TYPE_INT64: GType<number>;
+export let TYPE_UINT64: GType<number>;
+
+// fake enum for signal accumulators, keep in sync with gi/object.c
+export enum AccumulatorType {
+    NONE=0,
+    FIRST_WINS=1,
+    TRUE_HANDLED=2,
+}
+
+// A simple workaround if you have a class with .connect, .disconnect or .emit
+// methods (such as Gio.Socket.connect or NMClient.Device.disconnect)
+// The original g_signal_* functions are not introspectable anyway, because
+// we need our own handling of signal argument marshalling
+export function signal_connect(object: Object, name: string, handler: (...args: any[]) => any): number
+export function signal_connect_after(object: Object, name: string, handler: (...args: any[]) => any): number
+export function signal_emit_by_name(object: Object, ...nameAndArgs: any[]): void
+
+/**
+ * Finds the first signal handler that matches certain selection criteria.
+ * The criteria are passed as properties of a match object.
+ * The match object has to be non-empty for successful matches.
+ * If no handler was found, a falsy value is returned.
+ *
+ * @param instance the instance owning the signal handler to be found.
+ * @param match a properties object indicating whether to match by signal ID, detail, or callback function.
+ * @param match.signalId signal the handler has to be connected to.
+ * @param match.detail signal detail the handler has to be connected to.
+ * @param match.func the callback function the handler will invoke.
+ * @returns A valid non-0 signal handler ID for a successful match.
+ */
+export function signal_handler_find(instance: Object, match: {signalId: string, detail: string, func: (...args: any[]) => any}): number | bigint | object | null
+
+/**
+ * Blocks all handlers on an instance that match certain selection criteria.
+ * The criteria are passed as properties of a match object.
+ * The match object has to have at least `func` for successful matches.
+ * If no handlers were found, 0 is returned, the number of blocked handlers
+ * otherwise.
+ *
+ * @param instance the instance owning the signal handler to be found.
+ * @param match a properties object indicating whether to match by signal ID, detail, or callback function.
+ * @param match.signalId signal the handler has to be connected to.
+ * @param match.detail signal detail the handler has to be connected to.
+ * @param match.func the callback function the handler will invoke.
+ * @returns The number of handlers that matched.
+ */
+export function signal_handlers_block_matched(instance: Object, match: {signalId: string, detail: string, func: (...args: any[]) => any}): number
+
+/**
+ * Disconnects all handlers on an instance that match certain selection
+ * criteria.
+ * The criteria are passed as properties of a match object.
+ * The match object has to have at least `func` for successful matches.
+ * If no handlers were found, 0 is returned, the number of disconnected
+ * handlers otherwise.
+ *
+ * @param instance the instance owning the signal handler
+ *   to be found.
+ * @param match a properties object indicating whether to match by signal ID, detail, or callback function.
+ * @param match.signalId signal the handler has to be connected to.
+ * @param match.detail signal detail the handler has to be connected to.
+ * @param match.func the callback function the handler will invoke.
+ * @returns The number of handlers that matched.
+ */
+export function signal_handlers_unblock_matched(instance: Object, match: {signalId: string, detail: string, func: (...args: any[]) => any}): number
+
+/**
+ * Disconnects all handlers on an instance that match certain selection
+ * criteria.
+ * The criteria are passed as properties of a match object.
+ * The match object has to have at least `func` for successful matches.
+ * If no handlers were found, 0 is returned, the number of disconnected
+ * handlers otherwise.
+ *
+ * @param instance the instance owning the signal handler
+ *   to be found.
+ * @param match a properties object indicating whether to match by signal ID, detail, or callback function.
+ * @param match.signalId signal the handler has to be connected to.
+ * @param match.detail signal detail the handler has to be connected to.
+ * @param match.func the callback function the handler will invoke.
+ * @returns The number of handlers that matched.
+ */
+export function signal_handlers_disconnect_matched(instance: Object, match: {signalId: string, detail: string, func: (...args: any[]) => any}): number
+
+// Also match the macros used in C APIs, even though they're not introspected
+
+/**
+ * Blocks all handlers on an instance that match `func`.
+ *
+ * @param instance the instance to block handlers from.
+ * @param func the callback function the handler will invoke.
+ * @returns The number of handlers that matched.
+ */
+export function signal_handlers_block_by_func(instance: Object, func: (...args: any[]) => any): number;
+
+/**
+ * Unblocks all handlers on an instance that match `func`.
+ *
+ * @function
+ * @param instance the instance to unblock handlers from.
+ * @param func the callback function the handler will invoke.
+ * @returns The number of handlers that matched.
+ */
+export function signal_handlers_unblock_by_func(instance: Object, func: (...args: any[]) => any): number;
+
+/**
+ * Disconnects all handlers on an instance that match `func`.
+ *
+ * @param instance the instance to remove handlers from.
+ * @param func the callback function the handler will invoke.
+ * @returns The number of handlers that matched.
+ */
+export function signal_handlers_disconnect_by_func(instance: Object, func: (...args: any[]) => any): number;
+export function signal_handlers_disconnect_by_data(): void;
+
+export type Property<K extends ParamSpec> = K extends ParamSpecBoolean
+    ? boolean
+    : K extends ParamSpecDouble | ParamSpecInt | ParamSpecUInt | ParamSpecFloat | ParamSpecLong
+    ? number
+    : K extends ParamSpecInt64 | ParamSpecUInt64 | ParamSpecULong
+    ? number
+    : K extends ParamSpecFlags
+    ? number
+    : K extends ParamSpecString | ParamSpecUnichar
+    ? string
+    : K extends ParamSpecValueArray
+    ? any[]
+    : K extends ParamSpecObject // TODO?: <infer T>
+    ? ParamSpecObject // T
+    : K extends ParamSpecEnum // TODO?: <infer T><infer E>
+    ? ParamSpecEnum // E
+    : K extends ParamSpecBoxed // TODO?: <infer T><infer B>
+    ? ParamSpecBoxed //B
+    : K extends ParamSpecVariant
+    ? GLib.Variant
+    : any;
+
+// TODO: What about the generated class Closure 
+export type TClosure<R = any, P = any> = (...args: P[]) => R;
+
+// This should be replaces by a class of GObject.Object as soon as once we have implemented inheritance
+export class AnyClass {}
+
+export function registerClass<
+    T extends AnyClass,
+    Props extends { [key: string]: ParamSpec },
+    Interfaces extends { $gtype: GType }[],
+    Sigs extends {
+        [key: string]: {
+            param_types?: readonly GType[];
+            [key: string]: any;
+        };
+    }
+>(
+    options: MetaInfo<Props, Interfaces, Sigs>,
+    cls: T
+): T;
+
+export function registerClass<T extends AnyClass>(cls: T): T