@ts-for-gir/cli 3.0.0-beta.9 → 3.0.0

package/src/types/ts-parameter.ts

@@ -1,20 +0,0 @@
-import { TsType, TsDoc, TypeGirParameter, TsFunction } from './index.js'
-
-/**
- * Holds the data to generate a parameter of a function or return value in/for Typescript
- */
-export interface TsParameter {
-    name: string
-    type: TsType[]
-
-    /** The parent function of this parameter */
-    parent: TsFunction
-
-    /** If `true` the parameter is a rest parameter like `(...names: string[])` */
-    isRest: boolean
-
-    girTypeName: TypeGirParameter
-
-    /** Typescript data to generate documentations in TSDoc style */
-    doc: TsDoc
-}

package/src/types/ts-property.ts

@@ -1,22 +0,0 @@
-import { TsVar, TsDoc, TypeGirProperty, TypeTsProperty } from './index.js'
-
-/**
- * Holds the data to generate a property in/for Typescript
- */
-export interface TsProperty extends TsVar {
-    readonly: boolean
-    isStatic: boolean
-    /** Temporary property, we will try later to resolve the conflicts correctly */
-    hasUnresolvedConflict?: boolean
-
-    /** true if this function was injected using the `Injector`. This information is used in the `ConflictResolver` */
-    isInjected: boolean
-
-    // CUSTOM
-    girTypeName: TypeGirProperty
-    /** Will be exported in Typescript as a `field` of a `class` or as a "constructor-property" */
-    tsTypeName: TypeTsProperty
-
-    /** Typescript data to generate documentations in TSDoc style */
-    doc: TsDoc
-}

package/src/types/ts-signal.ts

@@ -1,21 +0,0 @@
-import { TsMethod, TsCallback, TsCallbackInterface } from './index.js'
-
-/**
- * Holds the data to generate a function in/for Typescript for `GirSignal`
- */
-export interface TsSignal extends TsCallback {
-    /** Signal functions like `connect`, `connect_after`, `disconnect` and `emit` on Gjs or `connect`, `after`, `on`, `once`, `off` and `emit` an node-gtk */
-    tsMethods: TsMethod[]
-
-    /** Signal overloads, used in `ConflictResolver` */
-    overloads: TsSignal[]
-
-    /**
-     * Interface for the callback type
-     */
-    tsCallbackInterface?: TsCallbackInterface
-
-    girTypeName: 'signal'
-    /** Signals are represented in Typescript as multiple event methods */
-    tsTypeName: 'event-methods'
-}

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

@@ -1 +0,0 @@
-export type TsTypeName = 'function' | 'method' | 'static-function' | 'interface' | 'event-methods' | 'constructor'

package/src/types/ts-type-separator.ts

@@ -1 +0,0 @@
-export type TsTypeSeparator = '&' | '|'

package/src/types/ts-type.ts

@@ -1,25 +0,0 @@
-import { GirCallbackElement, TsGenericParameter, TsTypeSeparator } from './index.js'
-
-/**
- * Holds the data to generate a type in/for Typescript
- */
-export interface TsType {
-    // TODO: move option property to `TsParameter` and add the `undefined` type to types
-    optional: boolean
-    nullable: boolean
-    type: string
-    callbacks: GirCallbackElement[]
-    generics: TsGenericParameter[]
-    // TODO: transform array to type with generics?
-    isArray: boolean
-    isFunction: boolean
-    isCallback: boolean
-    /**
-     * Left type separated, used if multiple types found.
-     * If nothing os set, `|` will be used by default.
-     *
-     * @Example
-     * `string | number` or `Gtk.Window & Gtk.Widget`
-     * */
-    leftSeparator?: TsTypeSeparator
-}

package/src/types/ts-var.ts

@@ -1,21 +0,0 @@
-import { TsType, TsDoc } from './index.js'
-
-/**
- * Holds the data to generate a variable in/for Typescript
- */
-export interface TsVar {
-    name: string | null
-    type: TsType[]
-    /** Temporary property, we will try later to resolve the conflicts correctly */
-    hasUnresolvedConflict?: boolean
-
-    /** true if this function was injected using the `Injector`. This information is used in the `ConflictResolver` */
-    isInjected: boolean
-
-    girTypeName: 'constant' | 'field' | 'property'
-    /** Will be exported in Typescript as a `constant` or a `field` of a `class` */
-    tsTypeName: 'constant' | 'static-property' | 'property' | 'constructor-property'
-
-    /** Typescript data to generate documentations in TSDoc style */
-    doc: TsDoc
-}

package/src/types/type-gir-alias.ts

@@ -1,2 +0,0 @@
-/** All gir elements which can be a typescript `type` */
-export type TypeGirAlias = 'alias'

package/src/types/type-gir-class.ts

@@ -1,2 +0,0 @@
-/** All gir elements which can be a typescript class */
-export type TypeGirClass = 'class' | 'record' | 'interface' | 'union'

package/src/types/type-gir-element.ts

@@ -1,25 +0,0 @@
-import {
-    TypeGirClass,
-    TypeGirMethod,
-    TypeGirVariable,
-    TypeGirAlias,
-    TypeGirEnumeration,
-    TypeGirEnumerationMember,
-    TypeGirInterface,
-    TypeGirParameter,
-    TypeGirProperty,
-    TypeGirFunction,
-} from './index.js'
-
-/** Any gir element type */
-export type TypeGirElement =
-    | TypeGirClass
-    | TypeGirMethod
-    | TypeGirVariable
-    | TypeGirAlias
-    | TypeGirEnumeration
-    | TypeGirEnumerationMember
-    | TypeGirInterface
-    | TypeGirParameter
-    | TypeGirProperty
-    | TypeGirFunction

package/src/types/type-gir-enumeration-member.ts

@@ -1,2 +0,0 @@
-/** All gir elements which can be a typescript enumeration */
-export type TypeGirEnumerationMember = 'enum-member' | 'bitfield-member'

package/src/types/type-gir-enumeration.ts

@@ -1,2 +0,0 @@
-/** All gir elements which can be a typescript enumeration */
-export type TypeGirEnumeration = 'enum' | 'bitfield'

package/src/types/type-gir-function.ts

@@ -1,8 +0,0 @@
-export type TypeGirFunction =
-    | 'constructor'
-    | 'function'
-    | 'method'
-    | 'static-function'
-    | 'signal'
-    | 'virtual'
-    | 'callback'

package/src/types/type-gir-interface.ts

@@ -1,2 +0,0 @@
-/** All gir elements which can be a typescript interface */
-export type TypeGirInterface = 'callback'

package/src/types/type-gir-method.ts

@@ -1,2 +0,0 @@
-/** All gir elements which can be a typescript method (or static function) of a class */
-export type TypeGirMethod = 'virtual' | 'signal' | 'method' | 'constructor' | 'function' | 'static'

package/src/types/type-gir-parameter.ts

@@ -1 +0,0 @@
-export type TypeGirParameter = 'callable-param'

package/src/types/type-gir-property.ts

@@ -1,2 +0,0 @@
-/** All gir elements which can be a typescript field / property */
-export type TypeGirProperty = 'property' | 'field' | 'constant'

package/src/types/type-gir-variable.ts

@@ -1 +0,0 @@
-export type TypeGirVariable = 'constant'

package/src/types/type-ts-element.ts

@@ -1,13 +0,0 @@
-import { TypeTsFunction, TypeTsProperty } from './index.js'
-
-/** Any typescript element type */
-export type TypeTsElement =
-    | 'class'
-    | 'interface'
-    | 'enum'
-    | 'enum-member'
-    | 'constant'
-    | 'event-methods'
-    | 'type'
-    | TypeTsFunction
-    | TypeTsProperty

package/src/types/type-ts-enumeration-member.ts

@@ -1,2 +0,0 @@
-/** All gir elements which can be a typescript enumeration */
-export type TypeTsEnumerationMember = 'enum-member'

package/src/types/type-ts-function.ts

@@ -1 +0,0 @@
-export type TypeTsFunction = 'static-function' | 'constructor' | 'function' | 'method' | 'event-methods' | 'interface'

package/src/types/type-ts-property.ts

@@ -1 +0,0 @@
-export type TypeTsProperty = 'static-property' | 'property' | 'constructor-property'

package/src/types/user-config-load-result.ts

@@ -1,6 +0,0 @@
-import { UserConfig } from './user-config'
-export interface UserConfigLoadResult {
-    config: Partial<UserConfig>
-    filepath: string
-    isEmpty?: boolean | undefined
-}

package/src/types/user-config.ts

@@ -1,41 +0,0 @@
-import { BuildType, Environment, ModuleType } from './index.js'
-
-/**
- * Types for config file
- */
-export interface UserConfig {
-    /** javascript environment */
-    environments: Environment[]
-    /** directory to output to */
-    outdir: string | null
-    /** Definitions generation type */
-    buildType?: BuildType
-    /** Module type, can be CommonJS or ESM */
-    moduleType?: ModuleType
-    /** GIR directories */
-    girDirectories: string[]
-    /** Switch on/off the verbose mode */
-    verbose: boolean
-    /** Do not ask for package versions if multiple versions are found */
-    ignoreVersionConflicts: boolean
-    /** print the output to console and create no files */
-    print: boolean
-    /** GIR modules to load, e.g. 'Gio-2.0'. Accepts multiple modules */
-    modules: string[]
-    /** modules that should be ignored */
-    ignore?: string[]
-    /** Do not export all symbols for each module as a namespace */
-    noNamespace: boolean
-    /** Do not generate documentation comments */
-    noComments: boolean
-    /** Do not generate debugging inline comments */
-    noDebugComments: boolean
-    /** Fix Inheritance and implementation type conflicts */
-    fixConflicts: boolean
-    /** Disables the generation of types that are in conflict with the DOM types */
-    noDOMLib: boolean
-    /** Generate types for GNOME Shell */
-    gnomeShellTypes: boolean
-    /** Generate a tsconfig alias */
-    generateAlias: boolean
-}

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

@@ -1,238 +0,0 @@
-// 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

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

@@ -1,64 +0,0 @@
-// See https://gitlab.gnome.org/GNOME/gjs/-/blob/master/modules/core/overrides/Gio.js
-export const DBus: {
-    readonly session: DBusConnection;
-    readonly system: DBusConnection;
-    get(bus_type: BusType, cancellable?: Cancellable | null, callback?: AsyncReadyCallback | null): void;
-    get_finish(res: AsyncResult): DBusConnection;
-    get_sync(bus_type: BusType, cancellable?: Cancellable | null): DBusConnection;
-    own_name(
-        bus_type: BusType,
-        name: string,
-        flags: BusNameOwnerFlags,
-        bus_acquired_closure?: GObject.Closure | null,
-        name_acquired_closure?: GObject.Closure | null,
-        name_lost_closure?: GObject.Closure | null
-    ): number;
-    own_name_on_connection(
-        connection: DBusConnection,
-        name: string,
-        flags: BusNameOwnerFlags,
-        name_acquired_closure?: GObject.Closure | null,
-        name_lost_closure?: GObject.Closure | null
-    ): number;
-    unown_name(owner_id: number): void;
-    watch_name(
-        bus_type: BusType,
-        name: string,
-        flags: BusNameWatcherFlags,
-        name_appeared_closure?: GObject.Closure | null,
-        name_vanished_closure?: GObject.Closure | null
-    ): number;
-    unwatch_name(watcher_id: number): void;
-    watch_name_on_connection(
-        connection: DBusConnection,
-        name: string,
-        flags: BusNameWatcherFlags,
-        name_appeared_closure?: GObject.Closure | null,
-        name_vanished_closure?: GObject.Closure | null
-    ): number;
-}
-
-export module DBusExportedObject {
-    export interface ConstructorProperties {
-        [key: string]: any;
-    }
-}
-
-// See https://gitlab.gnome.org/GNOME/gjs/-/blob/master/modules/core/overrides/Gio.js
-export class DBusExportedObject {
-    static $gtype: GObject.GType<DBusExportedObject>;
-
-    constructor(properties?: Partial<DBusExportedObject.ConstructorProperties>, ...args: any[]);
-    _init(properties?: Partial<DBusExportedObject.ConstructorProperties>, ...args: any[]): void;
-
-    static wrapJSObject(info: string, obj: any): DBusExportedObject;
-    get_info(): DBusInterfaceInfo;
-    get_connection(): DBusConnection;
-    get_object_path(): string;
-    unexport_from_connection(connection: DBusConnection): void;
-    ["export"](busConnection: DBusConnection, objectPath: string): void;
-    unexport(): void;
-    flush(): void;
-    emit_signal(name: string, variant: GLib.Variant): void;
-    emit_property_changed(name: string, variant: GLib.Variant): void;
-}