@ts-for-gir/cli 3.0.0-beta.2 → 3.0.0-beta.4

package/src/module-loader.ts

@@ -2,7 +2,7 @@
  * The ModuleLoader is used for reading gir modules from the file system and to solve conflicts (e.g. Gtk-3.0 and Gtk-4.0 would be a conflict)
  */
 
-import inquirer from 'inquirer'
+import inquirer, { ListQuestion, Answers } from 'inquirer'
 import glob from 'tiny-glob'
 import Path from 'path'
 import fs from 'fs'
@@ -63,7 +63,7 @@ export class ModuleLoader {
     /**
      * Sorts out the module the user has not selected via cli prompt
      * @param girModulesGrouped
-     * @param keepFullName Users selected module packageName
+     * @param selected Users selected module packageName
      */
     private sortVersionsByAnswer(
         girModulesGrouped: GirModulesGrouped,
@@ -99,11 +99,8 @@ export class ModuleLoader {
         }
     }
 
-    private generateContinueQuestion(
-        message = `do you want to continue?`,
-        choices = ['Yes', 'Go back'],
-    ): inquirer.ListQuestion {
-        const question: inquirer.ListQuestion = {
+    private generateContinueQuestion(message = `do you want to continue?`, choices = ['Yes', 'Go back']): ListQuestion {
+        const question: ListQuestion = {
             name: 'continue',
             message,
             type: 'list',
@@ -115,8 +112,8 @@ export class ModuleLoader {
     private generateIgnoreDepsQuestion(
         message = `Do you want to ignore them too?`,
         choices = ['Yes', 'No', 'Go back'],
-    ): inquirer.ListQuestion {
-        const question: inquirer.ListQuestion = {
+    ): ListQuestion {
+        const question: ListQuestion = {
             name: 'continue',
             message,
             type: 'list',
@@ -128,7 +125,7 @@ export class ModuleLoader {
     private async askIgnoreDepsPrompt(
         deps: GirModuleResolvedBy[] | Set<GirModuleResolvedBy>,
     ): Promise<'Yes' | 'No' | 'Go back'> {
-        let question: inquirer.ListQuestion<inquirer.Answers> | null = null
+        let question: ListQuestion<Answers> | null = null
         const size = (deps as GirModuleResolvedBy[]).length || (deps as Set<GirModuleResolvedBy>).size || 0
         if (size > 0) {
             this.log.log(bold('\nThe following modules have the ignored modules as dependencies:'))
@@ -152,13 +149,10 @@ export class ModuleLoader {
      * @param girModuleGrouped
      * @param message
      */
-    private generateModuleVersionQuestion(
-        girModuleGrouped: GirModulesGrouped,
-        message?: string,
-    ): inquirer.ListQuestion {
+    private generateModuleVersionQuestion(girModuleGrouped: GirModulesGrouped, message?: string): ListQuestion {
         message = message || `Multiple versions of '${girModuleGrouped.namespace}' found, which one do you want to use?`
         const choices = ['All', ...girModuleGrouped.modules.map((module) => module.packageName)]
-        const question: inquirer.ListQuestion = {
+        const question: ListQuestion = {
             name: girModuleGrouped.namespace,
             message,
             type: 'list',

package/src/type-definition-generator.ts

@@ -1280,6 +1280,77 @@ export default class TypeDefinitionGenerator implements Generator {
                 for (const girAlias of girModule.ns.alias)
                     if (girModule.packageName !== 'GObject-2.0' || girAlias.$.name !== 'Type')
                         out.push(...this.generateAlias(girAlias, girModule.namespace, 1))
+
+            if (this.config.environment === 'gjs') {
+                // Properties added to every GIRepositoryNamespace
+                // https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L186-190
+                out.push(
+                    ...this.generateConstant(
+                        {
+                            doc: {
+                                text: 'Name of the imported GIR library',
+                                tags: [
+                                    {
+                                        text: 'https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L188',
+                                        tagName: 'see',
+                                        paramName: '',
+                                    },
+                                ],
+                            },
+                            name: '__name__',
+                            type: [
+                                {
+                                    type: 'string',
+                                    optional: false,
+                                    nullable: false,
+                                    callbacks: [],
+                                    generics: [],
+                                    isArray: false,
+                                    isFunction: false,
+                                    isCallback: false,
+                                },
+                            ],
+                            isInjected: false,
+                            tsTypeName: 'constant',
+                            girTypeName: 'constant',
+                        },
+                        girModule.namespace,
+                        0,
+                    ),
+                    ...this.generateConstant(
+                        {
+                            doc: {
+                                text: 'Version of the imported GIR library',
+                                tags: [
+                                    {
+                                        text: 'https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L189',
+                                        tagName: 'see',
+                                        paramName: '',
+                                    },
+                                ],
+                            },
+                            name: '__version__',
+                            type: [
+                                {
+                                    type: 'string',
+                                    optional: false,
+                                    nullable: false,
+                                    callbacks: [],
+                                    generics: [],
+                                    isArray: false,
+                                    isFunction: false,
+                                    isCallback: false,
+                                },
+                            ],
+                            isInjected: false,
+                            tsTypeName: 'constant',
+                            girTypeName: 'constant',
+                        },
+                        girModule.namespace,
+                        0,
+                    ),
+                )
+            }
         }
         // END Namespace
         if (this.config.useNamespace) {

package/src/types/generate-config.ts

@@ -28,4 +28,6 @@ export interface GenerateConfig {
     noCheck: boolean
     /** Fix Inheritance and implementation type conflicts */
     fixConflicts: boolean
+    /** Disables the generation of types that are in conflict with the DOM types */
+    noDOMLib: boolean
 }

package/src/types/user-config.ts

@@ -36,4 +36,6 @@ export interface UserConfig {
     noCheck: boolean
     /** Fix Inheritance and implementation type conflicts */
     fixConflicts: boolean
+    /** Disables the generation of types that are in conflict with the DOM types */
+    noDOMLib: boolean
 }

package/src/utils.ts

@@ -2,6 +2,7 @@
 import lodash from 'lodash'
 import Path from 'path'
 import fs from 'fs'
+import ts from 'typescript'
 import { fileURLToPath } from 'url'
 import { Environment, GirInfoAttrs, TsType } from './types/index.js'
 import { inspect } from 'util'
@@ -27,7 +28,7 @@ export const splitModuleName = (packageName: string): { packageName: string; nam
     // 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('-')
+    const namespace = splits.join('')
     return {
         packageName,
         namespace,
@@ -215,3 +216,40 @@ export const typeIsOptional = (types: TsType[]) => {
     }
     return false
 }
+
+function convertTsJsConfigToObject(path: string) {
+    try {
+        const config: unknown = ts.parseConfigFileTextToJson(
+            Path.basename(path),
+            fs.readFileSync(path, 'utf8').trim(),
+        ).config
+        if (typeof config === 'object' && !Array.isArray(config)) return config as Record<PropertyKey, unknown>
+    } catch {
+        // ignored
+    }
+    return null
+}
+
+/**
+ * Given an directory path search for a tsconfig.json or jsconfig.json file in it or any of its parent directories, then read the file and parse it as json.
+ * @see {@link https://github.com/microsoft/TypeScript/blob/5f9c9a6ccf61fa131849797248438e292e7b496a/src/harness/compilerImpl.ts#L11-L35}
+ * @see {@link https://github.com/microsoft/TypeScript/blob/3fd8a6e44341f14681aa9d303dc380020ccb2147/src/harness/vfsUtil.ts#L286-L316}
+ *
+ * @param path - The directory path to search for a tsconfig.json or jsconfig.json file
+ */
+export function readTsJsConfig(path: string) {
+    let config: null | false | Record<PropertyKey, unknown> = null
+    let lastPath = ''
+    let currentPath = Path.resolve(path)
+    while (!config && currentPath !== lastPath) {
+        const tsConfigPath = Path.join(currentPath, 'tsconfig.json')
+        const jsConfigPath = Path.join(currentPath, 'jsconfig.json')
+        config =
+            (fs.existsSync(tsConfigPath) && convertTsJsConfigToObject(tsConfigPath)) ||
+            (fs.existsSync(jsConfigPath) && convertTsJsConfigToObject(jsConfigPath))
+        lastPath = currentPath
+        currentPath = Path.dirname(currentPath)
+    }
+
+    return config === false ? null : config
+}

package/templates/Gjs/Gjs.d.ts

@@ -120,12 +120,12 @@ export namespace Format {
 
 export namespace Mainloop {
     export function quit(name: string): void
-    export function idle_source(handler: any, priority: number): any
-    export function idle_add(handler: any, priority: number): any
-    export function timeout_source(timeout: any, handler: any, priority: number): any
-    export function timeout_seconds_source(timeout: any, handler: any, priority: number): any
-    export function timeout_add(timeout: any, handler: any, priority: number): any
-    export function timeout_add_seconds(timeout: any, handler: any, priority: number): any
+    export function idle_source(handler: any, priority?: number): any
+    export function idle_add(handler: any, priority?: number): any
+    export function timeout_source(timeout: any, handler: any, priority?: number): any
+    export function timeout_seconds_source(timeout: any, handler: any, priority?: number): any
+    export function timeout_add(timeout: any, handler: any, priority?: number): any
+    export function timeout_add_seconds(timeout: any, handler: any, priority?: number): any
     export function source_remove(id: any): any
     export function run(name: string): void
 }

package/templates/Gjs/index.d.ts

@@ -199,7 +199,314 @@ declare global {
         logDomain: string
     }
 
-    const console: Console;
+    <% if(noDOMLib){ %>
+    const console: Console
+    <% } %>
+
+    // https://gitlab.gnome.org/GNOME/gjs/-/blob/1.73.2/modules/esm/_encoding/encodingMap.js#L7-232
+    type TextDecoderEncoding =
+        | 'unicode-1-1-utf-8'
+        | 'unicode11utf8'
+        | 'unicode20utf8'
+        | 'utf-8'
+        | 'utf8'
+        | 'x-unicode20utf8'
+        | '866'
+        | 'cp866'
+        | 'csibm866'
+        | 'ibm866'
+        | 'csisolatin2'
+        | 'iso-8859-2'
+        | 'iso-ir-101'
+        | 'iso8859-2'
+        | 'iso88592'
+        | 'iso_8859-2'
+        | 'iso_8859-2:1987'
+        | 'l2'
+        | 'latin2'
+        | 'csisolatin3'
+        | 'iso-8859-3'
+        | 'iso-ir-109'
+        | 'iso8859-3'
+        | 'iso88593'
+        | 'iso_8859-3'
+        | 'iso_8859-3:1988'
+        | 'l3'
+        | 'latin3'
+        | 'csisolatin4'
+        | 'iso-8859-4'
+        | 'iso-ir-110'
+        | 'iso8859-4'
+        | 'iso88594'
+        | 'iso_8859-4'
+        | 'iso_8859-4:1988'
+        | 'l4'
+        | 'latin4'
+        | 'csisolatincyrillic'
+        | 'cyrillic'
+        | 'iso-8859-5'
+        | 'iso-ir-144'
+        | 'iso8859-5'
+        | 'iso88595'
+        | 'iso_8859-5'
+        | 'iso_8859-5:1988'
+        | 'arabic'
+        | 'asmo-708'
+        | 'csiso88596e'
+        | 'csiso88596i'
+        | 'csisolatinarabic'
+        | 'ecma-114'
+        | 'iso-8859-6'
+        | 'iso-8859-6-e'
+        | 'iso-8859-6-i'
+        | 'iso-ir-127'
+        | 'iso8859-6'
+        | 'iso88596'
+        | 'iso_8859-6'
+        | 'iso_8859-6:1987'
+        | 'csisolatingreek'
+        | 'ecma-118'
+        | 'elot_928'
+        | 'greek'
+        | 'greek8'
+        | 'iso-8859-7'
+        | 'iso-ir-126'
+        | 'iso8859-7'
+        | 'iso88597'
+        | 'iso_8859-7'
+        | 'iso_8859-7:1987'
+        | 'sun_eu_greek'
+        | 'csiso88598e'
+        | 'csisolatinhebrew'
+        | 'hebrew'
+        | 'iso-8859-8'
+        | 'iso-8859-8-e'
+        | 'iso-ir-138'
+        | 'iso8859-8'
+        | 'iso88598'
+        | 'iso_8859-8'
+        | 'iso_8859-8:1988'
+        | 'visual'
+        | 'csiso88598i'
+        | 'iso-8859-8-i'
+        | 'logical'
+        | 'csisolatin6'
+        | 'iso-8859-10'
+        | 'iso-ir-157'
+        | 'iso8859-10'
+        | 'iso885910'
+        | 'l6'
+        | 'latin6'
+        | 'iso-8859-13'
+        | 'iso8859-13'
+        | 'iso885913'
+        | 'iso-8859-14'
+        | 'iso8859-14'
+        | 'iso885914'
+        | 'csisolatin9'
+        | 'iso-8859-15'
+        | 'iso8859-15'
+        | 'iso885915'
+        | 'iso_8859-15'
+        | 'l9'
+        | 'iso-8859-16'
+        | 'cskoi8r'
+        | 'koi'
+        | 'koi8'
+        | 'koi8-r'
+        | 'koi8_r'
+        | 'koi8-ru'
+        | 'koi8-u'
+        | 'csmacintosh'
+        | 'mac'
+        | 'macintosh'
+        | 'x-mac-roman'
+        | 'dos-874'
+        | 'iso-8859-11'
+        | 'iso8859-11'
+        | 'iso885911'
+        | 'tis-620'
+        | 'windows-874'
+        | 'cp1250'
+        | 'windows-1250'
+        | 'x-cp1250'
+        | 'cp1251'
+        | 'windows-1251'
+        | 'x-cp1251'
+        | 'ansi_x3.4-1968'
+        | 'ascii'
+        | 'cp1252'
+        | 'cp819'
+        | 'csisolatin1'
+        | 'ibm819'
+        | 'iso-8859-1'
+        | 'iso-ir-100'
+        | 'iso8859-1'
+        | 'iso88591'
+        | 'iso_8859-1'
+        | 'iso_8859-1:1987'
+        | 'l1'
+        | 'latin1'
+        | 'us-ascii'
+        | 'windows-1252'
+        | 'x-cp1252'
+        | 'cp1253'
+        | 'windows-1253'
+        | 'x-cp1253'
+        | 'cp1254'
+        | 'csisolatin5'
+        | 'iso-8859-9'
+        | 'iso-ir-148'
+        | 'iso8859-9'
+        | 'iso88599'
+        | 'iso_8859-9'
+        | 'iso_8859-9:1989'
+        | 'l5'
+        | 'latin5'
+        | 'windows-1254'
+        | 'x-cp1254'
+        | 'cp1255'
+        | 'windows-1255'
+        | 'x-cp1255'
+        | 'cp1256'
+        | 'windows-1256'
+        | 'x-cp1256'
+        | 'cp1257'
+        | 'windows-1257'
+        | 'x-cp1257'
+        | 'cp1258'
+        | 'windows-1258'
+        | 'x-cp1258'
+        | 'x-mac-cyrillic'
+        | 'x-mac-ukrainian'
+        | 'chinese'
+        | 'csgb2312'
+        | 'csiso58gb231280'
+        | 'gb2312'
+        | 'gb_2312'
+        | 'gb_2312-80'
+        | 'gbk'
+        | 'iso-ir-58'
+        | 'x-gbk'
+        | 'gb18030'
+        | 'big5'
+        | 'cn-big5'
+        | 'csbig5'
+        | 'x-x-big5'
+        | 'cseucpkdfmtjapanese'
+        | 'euc-jp'
+        | 'x-euc-jp'
+        | 'csiso2022jp'
+        | 'iso-2022-jp'
+        | 'csshiftjis'
+        | 'ms932'
+        | 'ms_kanji'
+        | 'shift-jis'
+        | 'shift_jis'
+        | 'sjis'
+        | 'windows-31j'
+        | 'x-sjis'
+        | 'cseuckr'
+        | 'csksc56011987'
+        | 'euc-kr'
+        | 'iso-ir-149'
+        | 'korean'
+        | 'ks_c_5601-1987'
+        | 'ks_c_5601-1989'
+        | 'ksc5601'
+        | 'ksc_5601'
+        | 'windows-949'
+        | 'unicodefffe'
+        | 'utf-16be'
+        | 'csunicode'
+        | 'iso-10646-ucs-2'
+        | 'ucs-2'
+        | 'unicode'
+        | 'unicodefeff'
+        | 'utf-16'
+        | 'utf-16le'
+
+    interface TextDecodeOptions {
+        // As of Gjs 1.73.2 stream mode is not supported yet.
+        // stream?: boolean
+    }
+
+    interface TextDecoderOptions {
+        /** Indicates whether the error mode is fatal. */
+        fatal?: boolean
+        /** Indicates whether whether the byte order mark is ignored. */
+        ignoreBOM?: boolean
+    }
+
+    /**
+     * The TextDecoder interface represents a decoder for a specific text encoding.
+     * It takes a stream of bytes as input and emits a stream of code points.
+     *
+     * @version Gjs 1.69.2
+     */
+    interface TextDecoder {
+        /** A string containing the name of the decoder, that is a string describing the method the TextDecoder will use. */
+        readonly encoding: TextDecoderEncoding
+        /** A Boolean indicating whether the error mode is fatal. */
+        readonly fatal: boolean
+        /** A Boolean indicating whether the byte order mark is ignored. */
+        readonly ignoreBOM: boolean
+
+        /**
+         * Returns a string containing the text decoded with the method of the specific TextDecoder object.
+         *
+         * If the error mode is "fatal" and the encoder method encounter an error it WILL THROW a TypeError.
+         *
+         * @param input Buffer containing the text to decode
+         * @param options Object defining the decode options
+         */
+        decode(input?: ArrayBufferView | ArrayBuffer, options?: TextDecodeOptions): string
+    }
+
+    <% if(noDOMLib){ %>
+    const TextDecoder: {
+      prototype: TextDecoder
+      new (label?: TextDecoderEncoding, options?: TextDecoderOptions): TextDecoder
+    }
+    <% } %>
+
+    interface TextEncoderEncodeIntoResult {
+        read?: number
+        written?: number
+    }
+
+    /**
+     * TextEncoder takes a stream of code points as input and emits a stream of bytes.
+     *
+     * @version Gjs 1.69.2
+     */
+    interface TextEncoder {
+        readonly encoding: 'utf-8'
+
+        /**
+         * Takes a string as input, and returns a buffer containing the text given in parameters encoded with the UTF-8 method.
+         *
+         * @param input Text to encode.
+         */
+        encode(input?: string): Uint8Array
+        /**
+         * Takes a string to encode and a destination Uint8Array to put resulting UTF-8 encoded text into,
+         * and returns a dictionary object indicating the progress of the encoding.
+         *
+         * This is potentially more performant than the older encode() method.
+         *
+         * @param source Text to enconde.
+         * @param destination Buffer where to place the resulting UTF-8 encoded text into.
+         */
+        encodeInto(source: string, destination: Uint8Array): TextEncoderEncodeIntoResult
+    }
+
+    <% if(noDOMLib){ %>
+    const TextEncoder: {
+        prototype: TextEncoder
+        new (): TextEncoder
+    }
+    <% } %>
 
     interface BooleanConstructor {
         $gtype: GObject20.GType<boolean>