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

package/lib/types/ts-property.d.ts

@@ -0,0 +1,17 @@
+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;
+    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/lib/types/ts-property.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ts-property.js.map

package/lib/types/ts-property.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ts-property.js","sourceRoot":"","sources":["../../src/types/ts-property.ts"],"names":[],"mappings":""}

package/lib/types/ts-signal.d.ts

@@ -0,0 +1,17 @@
+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/lib/types/ts-signal.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ts-signal.js.map

package/lib/types/ts-signal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ts-signal.js","sourceRoot":"","sources":["../../src/types/ts-signal.ts"],"names":[],"mappings":""}

package/lib/types/ts-type-name.d.ts

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

package/lib/types/ts-type-name.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ts-type-name.js.map

package/lib/types/ts-type-name.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ts-type-name.js","sourceRoot":"","sources":["../../src/types/ts-type-name.ts"],"names":[],"mappings":""}

package/lib/types/ts-type-separator.d.ts

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

package/lib/types/ts-type-separator.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ts-type-separator.js.map

package/lib/types/ts-type-separator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ts-type-separator.js","sourceRoot":"","sources":["../../src/types/ts-type-separator.ts"],"names":[],"mappings":""}

package/lib/types/ts-type.d.ts

@@ -0,0 +1,22 @@
+import { GirCallbackElement, TsGenericParameter, TsTypeSeparator } from './index.js';
+/**
+ * Holds the data to generate a type in/for Typescript
+ */
+export interface TsType {
+    optional: boolean;
+    nullable: boolean;
+    type: string;
+    callbacks: GirCallbackElement[];
+    generics: TsGenericParameter[];
+    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/lib/types/ts-type.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ts-type.js.map

package/lib/types/ts-type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ts-type.js","sourceRoot":"","sources":["../../src/types/ts-type.ts"],"names":[],"mappings":""}

package/lib/types/ts-var.d.ts

@@ -0,0 +1,17 @@
+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/lib/types/ts-var.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ts-var.js.map

package/lib/types/ts-var.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ts-var.js","sourceRoot":"","sources":["../../src/types/ts-var.ts"],"names":[],"mappings":""}

package/lib/types/type-gir-alias.d.ts

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

package/lib/types/type-gir-alias.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=type-gir-alias.js.map

package/lib/types/type-gir-alias.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-gir-alias.js","sourceRoot":"","sources":["../../src/types/type-gir-alias.ts"],"names":[],"mappings":""}

package/lib/types/type-gir-class.d.ts

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

package/lib/types/type-gir-class.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=type-gir-class.js.map

package/lib/types/type-gir-class.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-gir-class.js","sourceRoot":"","sources":["../../src/types/type-gir-class.ts"],"names":[],"mappings":""}

package/lib/types/type-gir-element.d.ts

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

package/lib/types/type-gir-element.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=type-gir-element.js.map

package/lib/types/type-gir-element.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-gir-element.js","sourceRoot":"","sources":["../../src/types/type-gir-element.ts"],"names":[],"mappings":""}

package/lib/types/type-gir-enumeration-member.d.ts

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

package/lib/types/type-gir-enumeration-member.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=type-gir-enumeration-member.js.map

package/lib/types/type-gir-enumeration-member.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-gir-enumeration-member.js","sourceRoot":"","sources":["../../src/types/type-gir-enumeration-member.ts"],"names":[],"mappings":""}

package/lib/types/type-gir-enumeration.d.ts

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

package/lib/types/type-gir-enumeration.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=type-gir-enumeration.js.map

package/lib/types/type-gir-enumeration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-gir-enumeration.js","sourceRoot":"","sources":["../../src/types/type-gir-enumeration.ts"],"names":[],"mappings":""}

package/lib/types/type-gir-function.d.ts

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

package/lib/types/type-gir-function.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=type-gir-function.js.map

package/lib/types/type-gir-function.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-gir-function.js","sourceRoot":"","sources":["../../src/types/type-gir-function.ts"],"names":[],"mappings":""}

package/lib/types/type-gir-interface.d.ts

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

package/lib/types/type-gir-interface.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=type-gir-interface.js.map

package/lib/types/type-gir-interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-gir-interface.js","sourceRoot":"","sources":["../../src/types/type-gir-interface.ts"],"names":[],"mappings":""}

package/lib/types/type-gir-method.d.ts

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

package/lib/types/type-gir-method.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=type-gir-method.js.map

package/lib/types/type-gir-method.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-gir-method.js","sourceRoot":"","sources":["../../src/types/type-gir-method.ts"],"names":[],"mappings":""}

package/lib/types/type-gir-parameter.d.ts

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

package/lib/types/type-gir-parameter.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=type-gir-parameter.js.map

package/lib/types/type-gir-parameter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-gir-parameter.js","sourceRoot":"","sources":["../../src/types/type-gir-parameter.ts"],"names":[],"mappings":""}

package/lib/types/type-gir-property.d.ts

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

package/lib/types/type-gir-property.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=type-gir-property.js.map

package/lib/types/type-gir-property.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-gir-property.js","sourceRoot":"","sources":["../../src/types/type-gir-property.ts"],"names":[],"mappings":""}

package/lib/types/type-gir-variable.d.ts

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

package/lib/types/type-gir-variable.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=type-gir-variable.js.map

package/lib/types/type-gir-variable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-gir-variable.js","sourceRoot":"","sources":["../../src/types/type-gir-variable.ts"],"names":[],"mappings":""}

package/lib/types/type-ts-element.d.ts

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

package/lib/types/type-ts-element.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=type-ts-element.js.map

package/lib/types/type-ts-element.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-ts-element.js","sourceRoot":"","sources":["../../src/types/type-ts-element.ts"],"names":[],"mappings":""}

package/lib/types/type-ts-enumeration-member.d.ts

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

package/lib/types/type-ts-enumeration-member.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=type-ts-enumeration-member.js.map

package/lib/types/type-ts-enumeration-member.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-ts-enumeration-member.js","sourceRoot":"","sources":["../../src/types/type-ts-enumeration-member.ts"],"names":[],"mappings":""}

package/lib/types/type-ts-function.d.ts

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

package/lib/types/type-ts-function.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=type-ts-function.js.map

package/lib/types/type-ts-function.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-ts-function.js","sourceRoot":"","sources":["../../src/types/type-ts-function.ts"],"names":[],"mappings":""}

package/lib/types/type-ts-property.d.ts

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

package/lib/types/type-ts-property.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=type-ts-property.js.map

package/lib/types/type-ts-property.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-ts-property.js","sourceRoot":"","sources":["../../src/types/type-ts-property.ts"],"names":[],"mappings":""}

package/lib/types/user-config-load-result.d.ts

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

package/lib/types/user-config-load-result.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=user-config-load-result.js.map

package/lib/types/user-config-load-result.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-config-load-result.js","sourceRoot":"","sources":["../../src/types/user-config-load-result.ts"],"names":[],"mappings":""}

package/lib/types/user-config.d.ts

@@ -0,0 +1,38 @@
+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;
+    /** prettifies the generated .d.ts files */
+    pretty: boolean;
+    /** GIR modules to load, e.g. 'Gio-2.0'. Accepts multiple modules */
+    modules: string[];
+    /** modules that should be ignored */
+    ignore?: string[];
+    /** Export all symbols for each module as a namespace */
+    useNamespace: boolean;
+    /** Do not generate documentation comments */
+    noComments: boolean;
+    /** Do not generate debugging inline comments */
+    noDebugComments: boolean;
+    /** Disable typescript semantic checks using @ts-nocheck */
+    noCheck: boolean;
+    /** Fix Inheritance and implementation type conflicts */
+    fixConflicts: boolean;
+}

package/lib/types/user-config.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=user-config.js.map

package/lib/types/user-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-config.js","sourceRoot":"","sources":["../../src/types/user-config.ts"],"names":[],"mappings":""}

package/lib/utils.d.ts

@@ -0,0 +1,88 @@
+import lodash from 'lodash';
+import { Environment, GirInfoAttrs, TsType } from './types/index.js';
+import { inspect } from 'util';
+export { inspect };
+export declare const isEqual: (value: any, other: any) => boolean;
+export declare const map: {
+    <T, TResult>(collection: T[] | null | undefined, iteratee: lodash.ArrayIterator<T, TResult>): TResult[];
+    <T_1, TResult_1>(collection: lodash.List<T_1> | null | undefined, iteratee: lodash.ListIterator<T_1, TResult_1>): TResult_1[];
+    <T_2>(collection: lodash.Dictionary<T_2> | lodash.NumericDictionary<T_2> | null | undefined): T_2[];
+    <T_3 extends object, TResult_2>(collection: T_3 | null | undefined, iteratee: lodash.ObjectIterator<T_3, TResult_2>): TResult_2[];
+    <T_4, K extends keyof T_4>(collection: lodash.Dictionary<T_4> | lodash.NumericDictionary<T_4> | null | undefined, iteratee: K): T_4[K][];
+    <T_5>(collection: lodash.Dictionary<T_5> | lodash.NumericDictionary<T_5> | null | undefined, iteratee?: string | undefined): any[];
+    <T_6>(collection: lodash.Dictionary<T_6> | lodash.NumericDictionary<T_6> | null | undefined, iteratee?: object | undefined): boolean[];
+};
+export declare const find: {
+    <T, S extends T>(collection: lodash.List<T> | null | undefined, predicate: lodash.ListIteratorTypeGuard<T, S>, fromIndex?: number | undefined): S | undefined;
+    <T_1>(collection: lodash.List<T_1> | null | undefined, predicate?: lodash.ListIterateeCustom<T_1, boolean> | undefined, fromIndex?: number | undefined): T_1 | undefined;
+    <T_2 extends object, S_1 extends T_2[keyof T_2]>(collection: T_2 | null | undefined, predicate: lodash.ObjectIteratorTypeGuard<T_2, S_1>, fromIndex?: number | undefined): S_1 | undefined;
+    <T_3 extends object>(collection: T_3 | null | undefined, predicate?: lodash.ObjectIterateeCustom<T_3, boolean> | undefined, fromIndex?: number | undefined): T_3[keyof T_3] | undefined;
+};
+export declare const merge: {
+    <TObject, TSource>(object: TObject, source: TSource): TObject & TSource;
+    <TObject_1, TSource1, TSource2>(object: TObject_1, source1: TSource1, source2: TSource2): TObject_1 & TSource1 & TSource2;
+    <TObject_2, TSource1_1, TSource2_1, TSource3>(object: TObject_2, source1: TSource1_1, source2: TSource2_1, source3: TSource3): TObject_2 & TSource1_1 & TSource2_1 & TSource3;
+    <TObject_3, TSource1_2, TSource2_2, TSource3_1, TSource4>(object: TObject_3, source1: TSource1_2, source2: TSource2_2, source3: TSource3_1, source4: TSource4): TObject_3 & TSource1_2 & TSource2_2 & TSource3_1 & TSource4;
+    (object: any, ...otherArgs: any[]): any;
+};
+export declare const clone: <T>(value: T) => T;
+export declare const cloneDeep: <T>(value: T) => T;
+export declare const splitModuleName: (packageName: string) => {
+    packageName: string;
+    namespace: string;
+    version: string;
+};
+/** Remove namespace prefix */
+export declare const removeNamespace: (type: string, namespace: string) => string;
+/** Remove class module name prefix */
+export declare const removeClassModule: (type: string, namespace: string) => string;
+export declare const addNamespace: (type: string, namespace: string) => string;
+/**
+ * Checking whether some variable is iterable
+ * see https://stackoverflow.com/a/32538867
+ * @param obj Variable to check for iterable
+ */
+export declare const isIterable: (obj: unknown[]) => boolean;
+export declare const isNumeric: (str: string) => boolean;
+export declare const getFirstChar: (str: string) => string;
+export declare const getLastChar: (str: string) => string;
+export declare const isFirstCharNumeric: (str: string) => boolean;
+export declare const camelCase: (str: string) => string;
+export declare const lowerCamelCase: (str: string) => string;
+export declare const upperCamelCase: (str: string) => string;
+export declare const findFileInDirs: (dirs: string[], filename: string) => {
+    path: string | null;
+    exists: boolean;
+};
+/**
+ * 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 declare const union: <T>(target: Set<T> | T[], source: Set<T> | T[]) => Set<T>;
+export declare const stripParamNames: (func: string, ignoreTail?: boolean) => string;
+export declare const isCommentLine: (line: string) => boolean;
+export declare const generateIndent: (indents?: number, spaceForIndent?: number) => string;
+export declare const __filename: string;
+export declare const __dirname: string;
+export declare const getEnvironmentDir: (environment: Environment, baseDir: string) => string;
+export declare const getDestPath: (environment: Environment, outputDir: string, outputFilename: string) => string;
+export declare const girBool: (boolStr: string | undefined, defaultVal?: boolean) => boolean;
+/**
+ * Returns `true` if the definitions in `d1` and `d2` have equivalent signatures
+ * @param d1
+ * @param d2
+ */
+export declare const signaturesMatch: (d1: string, d2: string) => boolean;
+/**
+ * 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 declare const girElementIsIntrospectable: (girElement?: {
+    $: GirInfoAttrs & {
+        name: string;
+    };
+} | undefined, name?: string) => boolean;
+export declare const typeIsOptional: (types: TsType[]) => boolean;