@ts-for-gir/cli 3.0.0-beta.10

package/src/types/index.ts

@@ -0,0 +1,120 @@
+export * from './answer-version.js'
+export * from './build-type.js'
+export * from './class-parent.js'
+export * from './config-flags.js'
+export * from './conflict-child-element.js'
+export * from './conflict-grouped-element.js'
+export * from './conflict-grouped-elements.js'
+export * from './construct-name.js'
+export * from './dependency-map.js'
+export * from './dependency.js'
+export * from './environment.js'
+export * from './file-info.js'
+export * from './generate-config.js'
+export * from './generator-type.js'
+export * from './gir-alias-element.js'
+export * from './gir-annotation.js'
+export * from './gir-any-element.js'
+export * from './gir-any-type.js'
+export * from './gir-array-type.js'
+export * from './gir-bitfield-element.js'
+export * from './gir-boolean.js'
+export * from './gir-boxed-element.js'
+export * from './gir-c-include.js'
+export * from './gir-callable-attrs.js'
+export * from './gir-callable-param-element.js'
+export * from './gir-callable-param.js'
+export * from './gir-callable-return.js'
+export * from './gir-callback-element.js'
+export * from './gir-class-element.js'
+export * from './gir-constant-element.js'
+export * from './gir-constructor-element.js'
+export * from './gir-direction.js'
+export * from './gir-doc-element.js'
+export * from './gir-enum-element.js'
+export * from './gir-field-element.js'
+export * from './gir-function-element.js'
+export * from './gir-implements.js'
+export * from './gir-include.js'
+export * from './gir-info-attrs.js'
+export * from './gir-info-elements.js'
+export * from './gir-instance-parameter.js'
+export * from './gir-interface-element.js'
+export * from './gir-member-element.js'
+export * from './gir-method-element.js'
+export * from './gir-module-resolved-by.js'
+export * from './gir-modules-grouped-map.js'
+export * from './gir-modules-grouped.js'
+export * from './gir-namespace.js'
+export * from './gir-package.js'
+export * from './gir-prerequisite.js'
+export * from './gir-property-element.js'
+export * from './gir-record-element.js'
+export * from './gir-repository.js'
+export * from './gir-signal.js'
+export * from './gir-transfer-ownership-type.js'
+export * from './gir-transfer-ownership.js'
+export * from './gir-type.js'
+export * from './gir-union-element.js'
+export * from './gir-unparsed-number.js'
+export * from './gir-var-args.js'
+export * from './gir-virtual-method.js'
+export * from './inheritance-table.js'
+export * from './injection-callback.js'
+export * from './injection-class.js'
+export * from './injection-function.js'
+export * from './injection-generic-parameter.js'
+export * from './injection-parameter.js'
+export * from './injection-property.js'
+export * from './injection-instance-parameter.js'
+export * from './injection-type.js'
+export * from './injection.js'
+export * from './local-name-check.js'
+export * from './local-name-type.js'
+export * from './local-name.js'
+export * from './local-names.js'
+export * from './module-type.js'
+export * from './parsed-gir.js'
+export * from './part-of-class.js'
+export * from './part-of-module.js'
+export * from './promisify-func.js'
+export * from './resolve-type.js'
+export * from './sym-table-items.js'
+export * from './transformation-case.js'
+export * from './transformations.js'
+export * from './ts-alias.js'
+export * from './ts-callback.js'
+export * from './ts-class.js'
+export * from './ts-doc-tag.js'
+export * from './ts-doc.js'
+export * from './ts-callback-interface.js'
+export * from './ts-enum.js'
+export * from './ts-function.js'
+export * from './ts-generic-parameter.js'
+export * from './ts-instance-parameter.js'
+export * from './ts-member.js'
+export * from './ts-method.js'
+export * from './ts-parameter.js'
+export * from './ts-property.js'
+export * from './ts-signal.js'
+export * from './ts-type-name.js'
+export * from './ts-type-separator.js'
+export * from './ts-type.js'
+export * from './ts-var.js'
+export * from './type-gir-alias.js'
+export * from './type-gir-class.js'
+export * from './type-gir-element.js'
+export * from './type-gir-enumeration.js'
+export * from './type-gir-enumeration-member.js'
+export * from './type-gir-function.js'
+export * from './type-gir-interface.js'
+export * from './type-gir-method.js'
+export * from './type-gir-parameter.js'
+export * from './type-gir-property.js'
+export * from './type-gir-variable.js'
+export * from './type-ts-element.js'
+export * from './type-ts-enumeration-member.js'
+export * from './type-ts-function.js'
+export * from './type-ts-property.js'
+export * from './user-config-load-result.js'
+export * from './user-config.js'

package/src/types/inheritance-table.ts

@@ -0,0 +1,3 @@
+export interface InheritanceTable {
+    [name: string]: string[]
+}

package/src/types/injection-callback.ts

@@ -0,0 +1,20 @@
+import type { InjectionGenericParameter, InjectionParameter } from './index.js'
+
+/** Interface to inject additional methods, properties, etc to a class */
+export interface InjectionCallback {
+    /** The versions on which the injections are to be applied. E.g. `["3.0", "2.0"]` */
+    versions: string[]
+    /** The versions on which the injections are to be applied. E.g. `"Gtk"` */
+    namespace: string
+    name: string
+
+    /** Generic type parameters */
+    generics?: InjectionGenericParameter[]
+
+    inParams?: InjectionParameter[]
+
+    tsCallbackInterface: {
+        /** Generic type parameters */
+        generics?: InjectionGenericParameter[]
+    }
+}

package/src/types/injection-class.ts

@@ -0,0 +1,30 @@
+import type { InjectionFunction, InjectionGenericParameter, InjectionProperty, TsMethod } from './index.js'
+
+/** Interface to inject additional methods, properties, etc to a class */
+export interface InjectionClass {
+    /** The versions on which the injections are to be applied. E.g. `["3.0", "2.0"]` */
+    versions: string[]
+    /** The class namespace and name on which the injections are to be applied. E.g. "Gtk.Window "*/
+    qualifiedName: string
+
+    /** Fields of the base class itself */
+    // TODO: fields: InjectionField[]
+    /** Properties of the base class itself */
+    properties?: InjectionProperty[]
+    /** Constructor properties of the base class itself */
+    // TODO:constructProps: InjectionProperty[]
+    /** Array of signal methods for GObject properties */
+    propertySignalMethods?: TsMethod[]
+    /** Methods of the base class itself */
+    methods?: InjectionFunction[]
+    /** Virtual methods of the base class itself */
+    virtualMethods?: InjectionFunction[]
+    /** Constructor methods of the base class itself */
+    constructors?: InjectionFunction[]
+    /** Static functions of the base class itself */
+    staticFunctions?: InjectionFunction[]
+    /** Signals of the base class itself */
+    // TODO:signals: InjectionSignal[]
+    /** Generic type parameters */
+    generics?: InjectionGenericParameter[]
+}

package/src/types/injection-function.ts

@@ -0,0 +1,31 @@
+import type {
+    TsFunction,
+    InjectionParameter,
+    InjectionInstanceParameter,
+    InjectionType,
+    GirCallableParamElement,
+    GirInstanceParameter,
+} from './index.js'
+
+export interface InjectionFunction
+    extends Pick<TsFunction, 'name' | 'girTypeName'>,
+        Partial<
+            Pick<
+                TsFunction,
+                | 'isArrowType'
+                | 'isStatic'
+                | 'isGlobal'
+                | 'isVirtual'
+                | 'isInjected'
+                | 'isPromise'
+                | 'overloads'
+                | 'generics'
+                | 'doc'
+                | 'parent'
+            >
+        > {
+    returnTypes?: InjectionType[]
+    inParams?: Array<InjectionParameter | GirCallableParamElement>
+    outParams?: Array<InjectionParameter | GirCallableParamElement>
+    instanceParameters?: Array<InjectionInstanceParameter | GirInstanceParameter>
+}

package/src/types/injection-generic-parameter.ts

@@ -0,0 +1,3 @@
+import type { TsGenericParameter } from './index.js'
+
+export type InjectionGenericParameter = Partial<TsGenericParameter>

package/src/types/injection-instance-parameter.ts

@@ -0,0 +1,3 @@
+import type { TsInstanceParameter } from './index.js'
+
+export type InjectionInstanceParameter = TsInstanceParameter

package/src/types/injection-parameter.ts

@@ -0,0 +1,9 @@
+import type { InjectionType, TsDoc } from './index.js'
+
+export interface InjectionParameter {
+    name: string
+    type: InjectionType[]
+    /** If `true` the parameter is a rest parameter like `(...names: string[])` */
+    isRest?: boolean
+    doc?: Partial<TsDoc>
+}

package/src/types/injection-property.ts

@@ -0,0 +1,7 @@
+import type { TsProperty, InjectionType } from './index.js'
+
+export interface InjectionProperty
+    extends Pick<TsProperty, 'name' | 'girTypeName'>,
+        Partial<Pick<TsProperty, 'readonly' | 'isStatic' | 'isInjected' | 'doc'>> {
+    type?: InjectionType[]
+}

package/src/types/injection-type.ts

@@ -0,0 +1,3 @@
+import type { TsType } from './ts-type.js'
+
+export type InjectionType = Partial<TsType>

package/src/types/injection.ts

@@ -0,0 +1,6 @@
+import type { InjectionClass } from './injection-class.js'
+
+/** Interface to inject additional methods, properties, etc to the generated type definitions (like gjs overrides) */
+export interface Injection {
+    classes: InjectionClass[]
+}

package/src/types/local-name-check.ts

@@ -0,0 +1,5 @@
+import { LocalName } from './index.js'
+
+export interface LocalNameCheck extends LocalName {
+    added: boolean
+}

package/src/types/local-name-type.ts

@@ -0,0 +1 @@
+export type LocalNameType = 'method' | 'property' | 'field'

package/src/types/local-name.ts

@@ -0,0 +1,8 @@
+import { LocalNameType, GirMethodElement, GirPropertyElement, GirFieldElement } from './index.js'
+
+export interface LocalName {
+    type: LocalNameType
+    method?: GirMethodElement
+    property?: GirPropertyElement
+    field?: GirFieldElement
+}

package/src/types/local-names.ts

@@ -0,0 +1,5 @@
+import { LocalName } from './local-name'
+
+export interface LocalNames {
+    [key: string]: LocalName
+}

package/src/types/module-type.ts

@@ -0,0 +1 @@
+export type ModuleType = 'esm' | 'commonjs'

package/src/types/parsed-gir.ts

@@ -0,0 +1,5 @@
+import { GirRepository } from './gir-repository'
+
+export interface ParsedGir {
+    repository: GirRepository
+}

package/src/types/part-of-class.ts

@@ -0,0 +1,9 @@
+import { PartOfModule, GirClassElement, GirUnionElement, GirInterfaceElement, GirRecordElement } from './index.js'
+
+// Custom properties, not part of parsed gir xml
+export interface PartOfClass extends PartOfModule {
+    /**
+     * The class this function is defined in
+     */
+    _class?: GirClassElement | GirUnionElement | GirInterfaceElement | GirRecordElement
+}

package/src/types/part-of-module.ts

@@ -0,0 +1,8 @@
+import { GirModule } from '../gir-module'
+
+// Custom properties, not part of parsed gir xml
+export interface PartOfModule {
+    _module?: GirModule
+    /** E.g. `'GObject.Object'` */
+    _fullSymName?: string
+}

package/src/types/promisify-func.ts

@@ -0,0 +1,9 @@
+import { TsFunction } from './ts-function'
+
+// Identify promisified funcs
+export interface PromisifyFunc {
+    /** The Gio async function */
+    asyncFn?: TsFunction
+    /** The Gio finish function to get the result of the `asyncFn` */
+    finishFn?: TsFunction
+}

package/src/types/resolve-type.ts

@@ -0,0 +1,4 @@
+export enum ResolveType {
+    DEPENDENCE,
+    BY_HAND,
+}

package/src/types/sym-table-items.ts

@@ -0,0 +1,5 @@
+import { GirAnyElement } from './index'
+
+export interface SymTableItems {
+    [name: string]: GirAnyElement
+}

package/src/types/transformation-case.ts

@@ -0,0 +1,7 @@
+export type TransformationCase =
+    | 'original'
+    | 'lowerCamelCase'
+    | 'upperCamelCase'
+    | 'upperCase'
+    | 'lowerCase'
+    | 'underscores'

package/src/types/transformations.ts

@@ -0,0 +1,12 @@
+import { TransformationCase } from './transformation-case'
+
+export interface Transformations {
+    [type: string]: {
+        node: {
+            transformation: TransformationCase
+        }
+        gjs: {
+            transformation: TransformationCase
+        }
+    }
+}

package/src/types/ts-alias.ts

@@ -0,0 +1,11 @@
+/**
+ * Holds the data to generate an alias in/for Typescript
+ */
+export interface TsAlias {
+    name: string
+    type: string
+    // CUSTOM
+    girTypeName: 'alias'
+    /** Will be exported in Typescript as "type": `export type = ${name} = ${type}` */
+    tsTypeName: 'type'
+}

package/src/types/ts-callback-interface.ts

@@ -0,0 +1,11 @@
+import { TsDoc, TsGenericParameter } from './index.js'
+
+/**
+ * Holds the data to generate an interface for `GirCallbackElements` in/for Typescript
+ */
+export interface TsCallbackInterface {
+    name: string
+    overwriteDoc?: Partial<TsDoc>
+    /** Generic type parameter of this callback interface */
+    generics: TsGenericParameter[]
+}

package/src/types/ts-callback.ts

@@ -0,0 +1,21 @@
+import { TsMethod, TsCallbackInterface, TsDoc } from './index.js'
+
+/**
+ * Holds the data to generate a callback function in/for Typescript
+ */
+export interface TsCallback extends TsMethod {
+    /**
+     * Interface for the callback type
+     */
+    tsCallbackInterface?: TsCallbackInterface
+
+    girTypeName: 'callback' | 'signal'
+    /** Will be exported in Typescript as a `interface` to be able to assign this interface to the callbacks or as a global function */
+    tsTypeName: 'interface' | 'event-methods'
+
+    /** Callback overloads, used in `ConflictResolver` */
+    overloads: TsCallback[]
+
+    /** Typescript data to generate documentations in TSDoc style */
+    doc: TsDoc
+}

package/src/types/ts-class.ts

@@ -0,0 +1,109 @@
+import {
+    LocalNames,
+    GirPropertyElement,
+    GirFieldElement,
+    GirMethodElement,
+    GirConstructorElement,
+    GirFunctionElement,
+    GirVirtualMethodElement,
+    GirSignalElement,
+    TsGenericParameter,
+    TsMethod,
+    TsProperty,
+    TsDoc,
+    ClassParent,
+    TypeGirClass,
+} from './index.js'
+
+export interface TsClass {
+    /** E.g. "Window" */
+    name: string
+    /** E.g. "Gtk.Window "*/
+    qualifiedName: string
+    /** E.g. "Gtk" */
+    namespace: string
+    /** E.g. "3.0" */
+    version: string
+    isDerivedFromGObject?: boolean
+
+    constructPropInterfaceName: string
+    inheritConstructPropInterfaceNames: string[]
+    /**
+     * `true` if this is a abstract class.
+     * E.g GObject.ObjectClass is a abstract class and required by UPowerGlib-1.0, UDisks-2.0 and others
+     */
+    isAbstract: boolean
+    /** Object with all property / method names (Used to prevent duplicate class properties / method names) */
+    localNames: LocalNames
+    /** Object of all constructor properties (used to generate the constructor property interface) */
+    constructPropNames: LocalNames
+
+    /** Fields of the base class itself */
+    fields: GirFieldElement[]
+    /** Properties of the base class itself */
+    properties: GirPropertyElement[]
+    /** Injected properties to resolve conflicts between properties */
+    conflictProperties: TsProperty[]
+    /** Constructor properties of the base class itself */
+    constructProps: GirPropertyElement[]
+    /** Array of signal methods for GObject properties */
+    propertySignalMethods: TsMethod[]
+    /** Methods of the base class itself */
+    methods: GirMethodElement[]
+    /** Injected methods to resolve conflicts between properties */
+    conflictMethods: TsMethod[]
+    /** Virtual methods of the base class itself */
+    virtualMethods: GirVirtualMethodElement[]
+    /** Constructor methods of the base class itself */
+    constructors: GirConstructorElement[]
+    /** Static functions of the base class itself */
+    staticFunctions: Array<GirFunctionElement | GirConstructorElement | GirMethodElement>
+    /** Signals of the base class itself */
+    signals: GirSignalElement[]
+    /** Generic type parameter of this class */
+    generics: TsGenericParameter[]
+
+    /**
+     * All direct inheritances and implementations.
+     * Whether it is an inheritance or an implementation can be recognized by the `type` property
+     */
+    parents: ClassParent[]
+
+    /** All extended classes, also the indirect extended classes */
+    inherit: {
+        /** module packageName + package version + full system name of extended class */
+        [key: string]: {
+            /**
+             * The depth of the inheritance, starts at 1.
+             * 1 means it is a direct inheritance,
+             * greater means it is an indirect inheritance
+             */
+            depth: number
+            /** The extended class itself */
+            class: TsClass
+        }
+    }
+
+    /** All implemented interfaces, also the indirect implemented interfaces */
+    implements: {
+        /** module packageName + package version + full system name of implemented class / interface */
+        [key: string]: {
+            /**
+             * The depth of the implementation, starts at 1.
+             * 1 means it is a direct implementation,
+             * greater means it is an indirect implementation
+             */
+            depth: number
+            /** The implemented class / interface itself */
+            interface: TsClass
+        }
+    }
+
+    // CUSTOM
+    girTypeName: TypeGirClass
+    /** Will be exported in Typescript as a `class` */
+    tsTypeName: 'class'
+
+    /** Typescript data to generate documentations in TSDoc style */
+    doc: TsDoc
+}

package/src/types/ts-doc-tag.ts

@@ -0,0 +1,23 @@
+/**
+ * A model that represents a single tsDoc comment tag.
+ *
+ * Tags are stored in the {@link TsDoc.tags} interface.
+ *
+ * Inspirited from https://github.com/TypeStrong/typedoc/blob/master/src/lib/models/comments/tag.ts
+ */
+export interface TsDocTag {
+    /**
+     * The name of this tag.
+     */
+    tagName: string
+
+    /**
+     * The name of the related parameter when this is a ```@param``` tag.
+     */
+    paramName: string
+
+    /**
+     * The actual body text of this tag.
+     */
+    text: string
+}

package/src/types/ts-doc.ts

@@ -0,0 +1,18 @@
+import type { TsDocTag } from './ts-doc-tag.js'
+
+/**
+ * A model that represents a comment.
+ *
+ * Inspirited from https://github.com/TypeStrong/typedoc/blob/master/src/lib/models/comments/comment.ts
+ */
+export interface TsDoc {
+    /**
+     * The full body text of the comment..
+     */
+    text: string
+
+    /**
+     * All associated tags.
+     */
+    tags: TsDocTag[]
+}

package/src/types/ts-enum.ts

@@ -0,0 +1,15 @@
+import { TsDoc } from './index.js'
+
+/**
+ * Holds the data to generate an `enum` or method in/for Typescript
+ */
+export interface TsEnum {
+    name: string
+
+    girTypeName: 'bitfield' | 'enum'
+    /** Will be exported in Typescript as "enumeration": `export enum ${name} { ${memberName}: ${memberType}, ... }` */
+    tsTypeName: 'enum'
+
+    /** Typescript data to generate documentations in TSDoc style */
+    doc: TsDoc
+}

package/src/types/ts-function.ts

@@ -0,0 +1,70 @@
+import {
+    GirCallableParamElement,
+    GirInstanceParameter,
+    TsGenericParameter,
+    TsType,
+    TsDoc,
+    TypeTsFunction,
+    TypeGirFunction,
+    TsClass,
+} from './index.js'
+
+/**
+ * Holds the data to generate a function in/for Typescript
+ */
+export interface TsFunction {
+    name: string
+    /**
+     * Actually there are no multiple return types in gir.
+     * We still use an array to resolve conflicts with multiple inheritance
+     */
+    returnTypes: TsType[]
+    /** `true` if this function is a arrow function: `() => {}` */
+    isArrowType: boolean
+    /** c `static foobar() {}` */
+    isStatic: boolean
+    /** true if this function is a global function and not part of a class: `function foobar() {}` */
+    isGlobal: boolean
+    /** true if this function is a virtual method with the `vfunc:` prefix: vfunc_foobar() {} */
+    isVirtual: boolean
+    /** true if this function was injected using the `Injector`. This information is used in the `ConflictResolver` */
+    isInjected: boolean
+    /** Define this to override the return type defined in `returnTypes` */
+    overrideReturnType?: string
+    /** True if the return type is void */
+    retTypeIsVoid: boolean
+    /**
+     * True if the return types are a promise
+     * TODO: we should transform this to a generic `returnTypes`
+     **/
+    isPromise?: boolean
+    inParams: GirCallableParamElement[]
+    instanceParameters: GirInstanceParameter[]
+    /**
+     * Additional return types
+     * TODO: we should transform this to `returnTypes`
+     **/
+    outParams: GirCallableParamElement[]
+    generics: TsGenericParameter[]
+
+    /** Function overloads, used in `ConflictResolver` */
+    overloads: TsFunction[]
+
+    /** Temporary property, we will try later to resolve the conflicts correctly */
+    hasUnresolvedConflict?: boolean
+
+    girTypeName: TypeGirFunction
+    /**
+     * - Functions are usually exported as global functions in typescript, but can also be static functions of a class
+     * - Signals are represented in Typescript as multiple event methods
+     * - Virtual methods are represented in Typescript as normal methods with the prefix "vfunc_"
+     * - Callbacks are generated as interfaces
+     */
+    tsTypeName: TypeTsFunction
+
+    /** Typescript data to generate documentations in TSDoc style */
+    doc: TsDoc
+
+    /** The parent class / interface which contains this function, if this is a global function parent is null */
+    parent: TsClass | null
+}

package/src/types/ts-generic-parameter.ts

@@ -0,0 +1,8 @@
+export interface TsGenericParameter {
+    /** E.g. `T` */
+    name?: string
+    /** The default type if the generic. E.g. `T = GObject.Object`, `T = any` or `T = unknown` */
+    value?: string
+    /** E.g. `GObject.Object` */
+    extends?: string
+}

package/src/types/ts-instance-parameter.ts

@@ -0,0 +1,4 @@
+export interface TsInstanceParameter {
+    name: string
+    structFor: string
+}