@ts-for-gir/cli 3.0.0-beta.5 → 3.0.0-beta.7

package/src/injection/injector.ts

@@ -45,6 +45,11 @@ export class Injector {
                     ...this.girFactory.newGirFunctions(toClass.staticFunctions, girClass._tsData, { isInjected: true }),
                 )
             }
+            if (toClass.properties) {
+                girClass._tsData.properties.push(
+                    ...this.girFactory.newGirProperties(toClass.properties, { isInjected: true }),
+                )
+            }
             if (toClass.constructors) {
                 girClass._tsData.constructors.push(
                     ...this.girFactory.newGirFunctions(toClass.constructors, girClass._tsData, { isInjected: true }),

package/src/module-loader.ts

@@ -495,8 +495,8 @@ export class ModuleLoader {
 
     /**
      * Find modules with the possibility to use wild cards for module names. E.g. `Gtk*` or `'*'`
-     * @param girDirectories
      * @param modules
+     * @param ignore
      */
     private async findModules(modules: string[], ignore: string[] = []): Promise<Set<string>> {
         const foundModules = new Set<string>()
@@ -506,7 +506,11 @@ export class ModuleLoader {
                 const filename = `${modules[i]}.gir`
                 let files: string[] = []
                 for (const girDirectory of this.config.girDirectories) {
-                    files = files.concat(await glob(filename, { cwd: girDirectory }))
+                    try {
+                        files = files.concat(await glob(filename, { cwd: girDirectory }))
+                    } catch (error) {
+                        this.log.warn(`Error on finding "${filename}" in "${girDirectory}"`, error)
+                    }
                 }
 
                 let globModules = files.map((file) => Path.basename(file, '.gir'))

package/src/template-processor.ts

@@ -69,7 +69,7 @@ export class TemplateProcessor {
         const destPath = getDestPath(this.config.environment, outputDir, outputFilename)
 
         // write template result file
-        mkdirSync(outputDir, { recursive: true })
+        mkdirSync(Path.dirname(destPath), { recursive: true })
         writeFileSync(destPath, content, { encoding: 'utf8', flag: 'w' })
 
         return Promise.resolve(destPath)

package/src/type-definition-generator.ts

@@ -57,8 +57,8 @@ export default class TypeDefinitionGenerator implements Generator {
      */
     private generateModuleDependenciesImport(namespace: string, packageName: string, asExternType = false): string[] {
         const def: string[] = []
+        const sas = this.config.useNamespace && packageName !== 'Gjs' ? '' : '* as '
         if (this.config.buildType === 'lib') {
-            const sas = this.config.useNamespace && packageName !== 'Gjs' ? '' : '* as '
             def.push(`import type ${sas}${namespace} from './${packageName}.js';`)
         } else if (this.config.buildType === 'types') {
             if (asExternType) {
@@ -66,7 +66,7 @@ export default class TypeDefinitionGenerator implements Generator {
                 def.push(`import ${namespace} from "${packageName}.js"`)
             } else {
                 def.push(`/// <reference path="${packageName}.d.ts" />`)
-                def.push(`import type ${namespace} from './${packageName}.js';`)
+                def.push(`import type ${sas}${namespace} from './${packageName}.js';`)
             }
         }
         return def
@@ -1357,7 +1357,7 @@ export default class TypeDefinitionGenerator implements Generator {
             out.push(`}`)
         }
 
-        if (this.config.buildType !== 'types' && this.config.useNamespace) {
+        if (this.config.useNamespace) {
             out.push(`export default ${girModule.namespace};`)
         }
 
@@ -1406,24 +1406,19 @@ export default class TypeDefinitionGenerator implements Generator {
 
         // Types
         await templateProcessor.create('Gjs.d.ts', this.config.outdir, 'Gjs.d.ts')
+        await templateProcessor.create('GnomeShell.d.ts', this.config.outdir, 'GnomeShell.d.ts')
+        await templateProcessor.create('misc/extensionUtils.d.ts', this.config.outdir, 'misc/extensionUtils.d.ts')
         await templateProcessor.create('index.d.ts', this.config.outdir, 'index.d.ts')
 
         // Lib
         if (this.config.buildType === 'lib') {
+            await templateProcessor.create('Gjs.js', this.config.outdir, 'Gjs.js')
+            await templateProcessor.create('GnomeShell.js', this.config.outdir, 'GnomeShell.js')
+            await templateProcessor.create('misc/extensionUtils.js', this.config.outdir, 'misc/extensionUtils.js')
             await templateProcessor.create('index.js', this.config.outdir, 'index.js')
-            const template = 'Gjs.js'
-            await templateProcessor.create(template, this.config.outdir, 'Gjs.js')
         }
     }
 
-    private async exportGjsCastLib(inheritanceTable: InheritanceTable) {
-        if (!this.config.outdir) return
-
-        const inheritanceTableKeys = Object.keys(inheritanceTable)
-        const templateProcessor = new TemplateProcessor({ inheritanceTableKeys, inheritanceTable }, 'gjs', this.config)
-        await templateProcessor.create('cast.ts', this.config.outdir, 'cast.ts')
-    }
-
     private async exportNodeGtk(girModules: GirModule[], girModulesGrouped: GirModulesGrouped[]) {
         if (!this.config.outdir) return
 
@@ -1452,7 +1447,6 @@ export default class TypeDefinitionGenerator implements Generator {
         if (this.config.environment === 'gjs' && girModulesGrouped && inheritanceTable) {
             // GJS internal stuff
             await this.exportGjs(girModules, girModulesGrouped)
-            await this.exportGjsCastLib(inheritanceTable)
         }
     }
 }

package/src/types/injection-class.ts

@@ -1,4 +1,4 @@
-import type { InjectionFunction, InjectionGenericParameter, TsMethod } from './index.js'
+import type { InjectionFunction, InjectionGenericParameter, InjectionProperty, TsMethod } from './index.js'
 
 /** Interface to inject additional methods, properties, etc to a class */
 export interface InjectionClass {
@@ -10,7 +10,7 @@ export interface InjectionClass {
     /** Fields of the base class itself */
     // TODO: fields: InjectionField[]
     /** Properties of the base class itself */
-    // TODO: properties: InjectionProperty[]
+    properties?: InjectionProperty[]
     /** Constructor properties of the base class itself */
     // TODO:constructProps: InjectionProperty[]
     /** Array of signal methods for GObject properties */

package/src/utils.ts

@@ -2,7 +2,7 @@
 import lodash from 'lodash'
 import Path from 'path'
 import fs from 'fs'
-import ts from 'typescript'
+import { getTsconfig, TsConfigJsonResolved } from 'get-tsconfig'
 import { fileURLToPath } from 'url'
 import { Environment, GirInfoAttrs, TsType } from './types/index.js'
 import { inspect } from 'util'
@@ -219,11 +219,8 @@ export const typeIsOptional = (types: TsType[]) => {
 
 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>
+        const config = getTsconfig(path)?.config
+        if (config) return config
     } catch {
         // ignored
     }
@@ -232,13 +229,11 @@ function convertTsJsConfigToObject(path: string) {
 
 /**
  * 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 config: null | false | TsConfigJsonResolved = null
     let lastPath = ''
     let currentPath = Path.resolve(path)
     while (!config && currentPath !== lastPath) {
@@ -251,5 +246,5 @@ export function readTsJsConfig(path: string) {
         currentPath = Path.dirname(currentPath)
     }
 
-    return config === false ? null : config
+    return config || null
 }

package/templates/Gjs/Gjs.d.ts

@@ -93,10 +93,12 @@ export namespace gettext {
     export function dcgettext(domainname: string | null, msgid: string, category: number): string
     export function ngettext(msgid: string, msgid_plural: string, n: number): string
     export function dngettext(domainname: string, msgid: string, msgid_plural: string, n: number): string
+    export function pgettext(context: string, msgid: string): string
+    export function dpgettext(dom: string | null, context: string, msgid: string): string
     export function domain(domainName: string): {
         gettext: (msgid: string) => string
         ngettext: (msgid: string, msgid_plural: string, n: number) => string
-        pgettext: (context: any, msgid: string) => any
+        pgettext: (context: string, msgid: string) => string
     }
 }
 

package/templates/Gjs/GnomeShell.d.ts

@@ -0,0 +1,118 @@
+
+import type * as ExtensionUtils from './misc/extensionUtils.js';
+
+// TODO: https://gitlab.gnome.org/GNOME/gnome-shell/-/tree/main/js/misc
+export namespace misc {
+    export const dbusUtils: any;
+    export const extensionUtils: typeof ExtensionUtils;
+    export const fileUtils: any;
+    export const gnomeSession: any;
+    export const history: any;
+    export const ibusManager: any;
+    export const inputMethod: any;
+    export const introspect: any;
+    export const jsParse: any;
+    export const keyboardManager: any;
+    export const loginManager: any;
+    export const modemManager: any;
+    export const objectManager: any;
+    export const params: any;
+    export const parentalControlsManager: any;
+    export const permissionStore: any;
+    export const signalTracker: any;
+    export const signals: any;
+    export const smartcardManager: any;
+    export const systemActions: any;
+    export const util: any;
+    export const weather: any;
+}
+
+// TODO: https://gitlab.gnome.org/GNOME/gnome-shell/-/tree/main/js/ui
+export namespace ui {
+    export const components: any;
+    export const status: any;
+    export const accessDialog: any;
+    export const altTab: any;
+    export const animation: any;
+    export const appDisplay: any;
+    export const appFavorites: any;
+    export const appMenu: any;
+    export const audioDeviceSelection: any;
+    export const background: any;
+    export const backgroundMenu: any;
+    export const barLevel: any;
+    export const boxpointer: any;
+    export const calendar: any;
+    export const checkBox: any;
+    export const closeDialog: any;
+    export const ctrlAltTab: any;
+    export const dash: any;
+    export const dateMenu: any;
+    export const dialog: any;
+    export const dnd: any;
+    export const edgeDragAction: any;
+    export const endSessionDialog: any;
+    export const environment: any;
+    export const extensionDownloader: any;
+    export const extensionSystem: any;
+    export const focusCaretTracker: any;
+    export const grabHelper: any;
+    export const ibusCandidatePopup: any;
+    export const iconGrid: any;
+    export const inhibitShortcutsDialog: any;
+    export const init: any;
+    export const kbdA11yDialog: any;
+    export const keyboard: any;
+    export const layout: any;
+    export const lightbox: any;
+    export const locatePointer: any;
+    export const lookingGlass: any;
+    export const magnifier: any;
+    export const main: any;
+    export const messageList: any;
+    export const messageTray: any;
+    export const modalDialog: any;
+    export const mpris: any;
+    export const notificationDaemon: any;
+    export const osdMonitorLabeler: any;
+    export const osdWindow: any;
+    export const overview: any;
+    export const overviewControls: any;
+    export const padOsd: any;
+    export const pageIndicators: any;
+    export const panel: any;
+    export const panelMenu: any;
+    export const pointerA11yTimeout: any;
+    export const pointerWatcher: any;
+    export const popupMenu: any;
+    export const quickSettings: any;
+    export const remoteSearch: any;
+    export const ripples: any;
+    export const runDialog: any;
+    export const screenShield: any;
+    export const screenshot: any;
+    export const scripting: any;
+    export const search: any;
+    export const searchController: any;
+    export const sessionMode: any;
+    export const shellDBus: any;
+    export const shellEntry: any;
+    export const shellMountOperation: any;
+    export const slider: any;
+    export const swipeTracker: any;
+    export const switchMonitor: any;
+    export const switcherPopup: any;
+    export const unlockDialog: any;
+    export const userWidget: any;
+    export const welcomeDialog: any;
+    export const windowAttentionHandler: any;
+    export const windowManager: any;
+    export const windowMenu: any;
+    export const windowPreview: any;
+    export const workspace: any;
+    export const workspaceAnimation: any;
+    export const workspaceSwitcherPopup: any;
+    export const workspaceThumbnail: any;
+    export const workspacesView: any;
+    export const xdndHandler: any;
+}

package/templates/Gjs/GnomeShell.js

@@ -0,0 +1,10 @@
+<% if(moduleType === 'esm') { %>
+    export const misc = imports.misc;
+    export const ui = imports.ui;
+  <% } else { %>  
+    module.exports = {
+      misc: imports.misc,
+      ui: imports.ui
+    }
+  <% } %>
+  

package/templates/Gjs/index.d.ts

@@ -6,6 +6,7 @@
  */
 
 import type * as Gjs from './Gjs.js'
+import type * as GnomeShell from './GnomeShell.js'
 <%_ for (const girModule of girModules) { _%>
   <%_ if(useNamespace){ _%>
 import type <%= girModule.importName %> from "./<%= girModule.packageName %>.js";
@@ -465,8 +466,8 @@ declare global {
 
     <% if(!noDOMLib){ %>
     const TextDecoder: {
-      prototype: TextDecoder
-      new (label?: TextDecoderEncoding, options?: TextDecoderOptions): TextDecoder
+        prototype: TextDecoder
+        new (label?: TextDecoderEncoding, options?: TextDecoderOptions): TextDecoder
     }
     <% } %>
 
@@ -555,29 +556,32 @@ declare global {
 
     const imports: typeof Gjs & {
         gi: {
-          <%_ for (const girModuleGroup of girModulesGrouped) { _%>
-            <%= girModuleGroup.namespace %>: <%_ for (const [i, girModule] of girModuleGroup.modules.entries()) { _%>
-              typeof <%= girModule.module.importName %>
-              <%_ if (i !== girModuleGroup.modules.length - 1) { _%>
-                |
-              <%_ } _%>
-            <%_ } _%>
-          <%_ } _%>
-          versions: {
             <%_ for (const girModuleGroup of girModulesGrouped) { _%>
               <%= girModuleGroup.namespace %>: <%_ for (const [i, girModule] of girModuleGroup.modules.entries()) { _%>
-                '<%= girModule.module.version %>'
+                typeof <%= girModule.module.importName %>
                 <%_ if (i !== girModuleGroup.modules.length - 1) { _%>
                   |
                 <%_ } _%>
               <%_ } _%>
             <%_ } _%>
-          }
+            versions: {
+                <%_ for (const girModuleGroup of girModulesGrouped) { _%>
+                  <%= girModuleGroup.namespace %>: <%_ for (const [i, girModule] of girModuleGroup.modules.entries()) { _%>
+                    '<%= girModule.module.version %>'
+                    <%_ if (i !== girModuleGroup.modules.length - 1) { _%>
+                      |
+                    <%_ } _%>
+                  <%_ } _%>
+                <%_ } _%>
+            }
         }
         lang: typeof Gjs.Lang
         system: typeof Gjs.System
+        signals: typeof Gjs.Signals
         package: typeof Gjs.Package
         mainloop: typeof Gjs.Mainloop
+        misc: typeof GnomeShell.misc
+        ui: typeof GnomeShell.ui
         searchPath: string[]
     }
 }

package/templates/Gjs/index.js

@@ -1,4 +1,4 @@
-const _imports = imports || {}
+const _imports = globalThis.imports || {}
 
 export { _imports }
 export default _imports

package/templates/Gjs/misc/extensionUtils.d.ts

@@ -0,0 +1,99 @@
+// https://gitlab.gnome.org/GNOME/gnome-shell/blob/main/js/misc/extensionUtils.js
+
+// TODO: untested
+export interface Extension {
+    type: ExtensionType;
+    state: ExtensionState;
+    path: string;
+    error: string | null;
+    hasPrefs: boolean;
+    hasUpdate: boolean;
+    canChange: boolean;
+}
+
+export enum ExtensionType {
+    SYSTEM = 1,
+    PER_USER = 2,
+}
+
+export enum ExtensionState {
+    ENABLED = 1,
+    DISABLED = 2,
+    ERROR = 3,
+    OUT_OF_DATE = 4,
+    DOWNLOADING = 5,
+    INITIALIZED = 6,
+    DISABLING = 7,
+    ENABLING = 8,
+    UNINSTALLED = 99,
+}
+
+declare const SERIALIZED_PROPERTIES: string[];
+
+/**
+ * Get current extension
+ * @param extension the extension object to use in utilities like `initTranslations()`
+ */
+export function setCurrentExtension(extension: Extension): void;
+
+/**
+ * @returns The current extension, or null if not called from an extension.
+ */
+export function getCurrentExtension(): Extension | null;
+
+/**
+ * Init translation
+ * @param domain the gettext domain to use
+ * 
+ * Initialize Gettext to load translations from extensionsdir/locale.
+ * If @domain is not provided, it will be taken from metadata['gettext-domain']
+ */
+export function initTranslations(domain: string): void;
+
+/**
+ * gettext:
+ * @param str the string to translate
+ * 
+ * Translate @str using the extension's gettext domain
+ *
+ * @returns the translated string
+ */
+export function gettext(str: string): string;
+
+/**
+ * ngettext:
+ * @param str the string to translate
+ * @param strPlural the plural form of the string
+ * @param n the quantity for which translation is needed
+ * 
+ * Translate @str and choose plural form using the extension's gettext domain
+ * 
+ * @returns the translated string
+ */
+export function ngettext(str: string, strPlural: string, n: number): string;
+
+/**
+ * pgettext:
+ * @param context context to disambiguate @str
+ * @param str the string to translate
+ * 
+ * Translate @str in the context of @context using the extension's gettext domain
+ * 
+ * @returns the translated string
+ */
+export function pgettext(context: string, str: string): string;
+
+/**
+ * openPrefs:
+ * 
+ * Open the preference dialog of the current extension
+ */
+export function openPrefs(): void;
+
+export function isOutOfDate(extension: Extension): boolean;
+
+export function installImporter(extension: Extension): void;
+
+export function serializeExtension(extension: Extension): object;
+
+export function deserializeExtension(data: object): Extension;

package/templates/Gjs/misc/extensionUtils.js

@@ -0,0 +1,6 @@
+<% if(moduleType === 'esm') { %>
+    export imports.misc.extensionUtils;
+<% } else { %>  
+    module.exports = imports.misc.extensionUtils;
+<% } %>
+  

package/templates/Gjs/cast.ts

@@ -1,52 +0,0 @@
-
-<% if(useNamespace){ %>
-    import GObject from './GObject-2.0.js';
-  <% } else { %>  
-    import * as GObject from './GObject-2.0.js';
-<% } %>
-
-const inheritanceTable: { [key: string]: string[] } = {
-<%_ for (const key of inheritanceTableKeys) { _%>
-    '<%= key %>': [
-    <%_ for (const value of inheritanceTable[key]) { _%>
-    '<%= value %>',
-    <%_ } _%>
-],
-<%_ } _%>
-}
-
-
-interface StaticNamedClass<T> {
-    new (...args: any[]): T
-    name: string
-}
-
-/**
- * Casts between derived classes, performing a run-time type-check
- * and raising an exception if the cast fails. Allows casting to implemented
- * interfaces, too.
- */
-export function giCast<T>(from_: GObject.Object, to_: StaticNamedClass<T>): T {
-    const desc: string = from_.toString()
-    let clsName: string|null = null
-    for (const k of desc.split(" ")) {
-        if (k.substring(0, 7) == "GIName:") {
-            clsName = k.substring(7)
-            break
-        }
-    }
-    const toName = to_.name.replace("_", ".")
-
-    if (toName === clsName)
-        return ((from_ as any) as T)
-
-    if (clsName) {
-        const parents = inheritanceTable[clsName]
-        if (parents) {
-            if (parents.indexOf(toName) >= 0)
-                return ((from_ as any) as T)
-        }
-    }
-
-    throw Error("Invalid cast of " + desc + "(" + clsName + ") to " + toName)
-}