@ts-for-gir/lib 4.0.0-beta.4 → 4.0.0-beta.41

package/src/types/class.ts

@@ -0,0 +1,43 @@
+import type { IntrospectedConstructor } from "../gir/constructor.ts";
+import type {
+	IntrospectedBaseClass,
+	IntrospectedClass,
+	IntrospectedClassCallback,
+	IntrospectedClassFunction,
+	IntrospectedInterface,
+} from "../gir/introspected-classes.ts";
+import type { IntrospectedField, IntrospectedProperty } from "../gir/property.ts";
+import type { IntrospectedRecord } from "../gir/record.ts";
+import type { TypeIdentifier } from "../gir.ts";
+
+export interface ClassDefinition {
+	superType: TypeIdentifier;
+	interfaces: TypeIdentifier[];
+	mainConstructor: IntrospectedConstructor;
+	constructors: IntrospectedConstructor[];
+	members: IntrospectedClassFunction[];
+	props: IntrospectedProperty[];
+	fields: IntrospectedField[];
+	callbacks: IntrospectedClassCallback[];
+}
+
+export interface ResolutionNode {
+	identifier: TypeIdentifier;
+	node: IntrospectedBaseClass;
+}
+
+export interface InterfaceResolution extends ResolutionNode, Iterable<InterfaceResolution | ClassResolution> {
+	extends(): InterfaceResolution | ClassResolution | undefined;
+	node: IntrospectedInterface;
+}
+
+export interface ClassResolution extends ResolutionNode, Iterable<ClassResolution> {
+	extends(): ClassResolution | undefined;
+	implements(): InterfaceResolution[];
+	node: IntrospectedClass;
+}
+
+export interface RecordResolution extends ResolutionNode, Iterable<RecordResolution> {
+	extends(): RecordResolution | undefined;
+	node: IntrospectedRecord;
+}

package/src/types/config-flags.ts

@@ -0,0 +1,5 @@
+import type { UserConfig } from "./user-config.ts";
+
+export interface ConfigFlags extends UserConfig {
+	configName: string;
+}

package/src/types/construct-name.ts

@@ -0,0 +1,13 @@
+export type ConstructName =
+	| "functionName"
+	| "enumMember"
+	| "signalName"
+	| "fieldName"
+	| "constantName"
+	| "constructorPropertyName"
+	| "propertyName"
+	| "parameterName"
+	| "enumName"
+	| "importNamespaceName"
+	| "signalInterfaceName"
+	| "importName";

package/src/types/dependency-map.ts

@@ -0,0 +1,4 @@
+import type { Dependency } from "./dependency.ts";
+export interface DependencyMap {
+	[packageName: string]: Dependency[];
+}

package/src/types/dependency.ts

@@ -0,0 +1,49 @@
+import type { GirXML } from "@gi.ts/parser";
+import type { LibraryVersion } from "../library-version.ts";
+import type { FileInfo } from "./index.ts";
+
+export interface Dependency extends FileInfo {
+	/**
+	 * E.g. 'Gtk'
+	 */
+	namespace: string;
+	/**
+	 * E.g. 'Gtk40'
+	 * Is used in the generated index.d.ts, for example: `import * as Gtk40 from "./Gtk-4.0.ts";`
+	 */
+	importNamespace: string;
+	/**
+	 * E.g. '4.0'
+	 */
+	version: string;
+	/**
+	 * E.g. '4.14.0'
+	 */
+	libraryVersion: LibraryVersion;
+	/**
+	 * E.g. 'Gtk-4.0'
+	 */
+	packageName: string;
+	/**
+	 * The NPM package name
+	 * E.g. 'gtk-4.0'
+	 */
+	importName: string;
+	/**
+	 * Import path for the package
+	 * E.g. './Gtk-4.0.ts' or '@girs/Gtk-4.0'
+	 */
+	importPath: string;
+	/**
+	 * Import definition for the package
+	 * E.g. `import type Gtk from '@girs/Gtk-3.0'`
+	 */
+	importDef: string;
+	/**
+	 * Complete dependency string for package.json
+	 * E.g. `"@girs/gtk-4.0": "workspace:^"`
+	 */
+	packageJsonImport: string;
+
+	girXML: GirXML | null;
+}

package/src/types/file-info.ts

@@ -0,0 +1,14 @@
+export interface FileInfo {
+	/**
+	 * The path to the gir file or null if the file does not exist
+	 */
+	path: string | null;
+	/**
+	 * The filename of the gir file
+	 */
+	filename: string;
+	/**
+	 * Whether the file exists or not
+	 */
+	exists: boolean;
+}

package/src/types/format.ts

@@ -0,0 +1 @@
+export type Format = "dts" | "json";

package/src/types/generator-constructor.ts

@@ -0,0 +1,7 @@
+import type { FormatGenerator } from "../generators/generator.ts";
+import type { IntrospectedNamespace } from "../gir/namespace.ts";
+import type { OptionsGeneration } from "./options-generation.ts";
+
+export type GeneratorConstructor<T> = {
+	new (namespace: IntrospectedNamespace, options: OptionsGeneration, ...args: unknown[]): FormatGenerator<T>;
+};

package/src/types/generics-config.ts

@@ -0,0 +1,90 @@
+import type { IntrospectedNamespace } from "../gir/namespace.ts";
+
+/**
+ * Function type for modifying a namespace with generic type information
+ */
+export type NamespaceModifier = (namespace: IntrospectedNamespace, inferGenerics: boolean) => void;
+
+/**
+ * Configuration for namespace-specific generic modifications
+ */
+export interface NamespaceDefinition {
+	/** The namespace name (e.g., "Gtk", "Gio") */
+	namespace: string;
+	/** The namespace version (e.g., "4.0", "2.0") */
+	version: string;
+	/** The modifier function to apply generics to the namespace */
+	modifier: NamespaceModifier;
+}
+
+/**
+ * Configuration for Clutter template-based generic modifications
+ */
+export interface ClutterTemplateConfig {
+	/** The namespace name - always "Clutter" */
+	namespace: string;
+	/** The Clutter version */
+	version: string;
+	/** The modifier function to apply Clutter-specific generics */
+	modifier: NamespaceModifier;
+}
+
+/**
+ * Configuration for Meta template-based generic modifications
+ */
+export interface MetaTemplateConfig {
+	/** The namespace name - always "Meta" */
+	namespace: string;
+	/** The Meta version */
+	version: string;
+	/** The modifier function to apply Meta-specific generics */
+	modifier: NamespaceModifier;
+}
+
+/**
+ * Configuration for St (Shell Toolkit) template-based generic modifications
+ */
+export interface StTemplateConfig {
+	/** The namespace name - always "St" */
+	namespace: string;
+	/** The St version */
+	version: string;
+	/** The modifier function to apply St-specific generics */
+	modifier: NamespaceModifier;
+}
+
+/**
+ * Configuration for GIO-specific generic modifications
+ */
+export interface GioConfig {
+	/** The namespace name - always "Gio" */
+	namespace: string;
+	/** The GIO version - always "2.0" */
+	version: string;
+	/** The modifier function to apply GIO-specific generics */
+	modifier: (namespace: IntrospectedNamespace) => void;
+}
+
+/**
+ * Configuration for GTK-specific generic modifications
+ */
+export interface GtkConfig {
+	/** The namespace name - always "Gtk" */
+	namespace: string;
+	/** The GTK version - always "4.0" */
+	version: string;
+	/** The modifier function to apply GTK-specific generics */
+	modifier: (namespace: IntrospectedNamespace) => void;
+}
+
+/**
+ * Configuration for GLib-specific generic modifications
+ */
+export interface GlibConfig {
+	/** The namespace name - always "GLib" */
+	namespace: string;
+	/** The GLib version - always "2.0" */
+	version: string;
+	/** The modifier function to apply GLib-specific generics */
+	modifier: (namespace: IntrospectedNamespace) => void;
+}

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

@@ -0,0 +1,35 @@
+import type {
+	GirAliasElement,
+	GirBitfieldElement,
+	GirCallbackElement,
+	GirClassElement,
+	GirConstantElement,
+	GirConstructorElement,
+	GirEnumElement,
+	GirFieldElement,
+	GirFunctionElement,
+	GirInterfaceElement,
+	GirMethodElement,
+	GirPropertyElement,
+	GirRecordElement,
+	GirSignalElement,
+	GirUnionElement,
+	GirVirtualMethodElement,
+} from "./index.ts";
+export type GirAnyElement =
+	| GirBitfieldElement
+	| GirCallbackElement
+	| GirClassElement
+	| GirConstantElement
+	| GirEnumElement
+	| GirFunctionElement
+	| GirInterfaceElement
+	| GirRecordElement
+	| GirUnionElement
+	| GirAliasElement
+	| GirMethodElement
+	| GirVirtualMethodElement
+	| GirSignalElement
+	| GirConstructorElement
+	| GirFieldElement
+	| GirPropertyElement;

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

@@ -0,0 +1,22 @@
+import type { Dependency } from "./dependency.ts";
+
+/**
+ * Interface representing the essential GirModule operations needed by type definitions
+ * This follows the Interface Segregation Principle - clients should not depend on interfaces they don't use
+ */
+export interface IGirModule {
+	/** Package name like 'Gtk-4.0' */
+	readonly packageName: string;
+
+	/** Direct dependencies of this module */
+	readonly dependencies: Dependency[];
+
+	/** All transitive dependencies of this module */
+	readonly transitiveDependencies: Dependency[];
+
+	/** Initialize transitive dependencies */
+	initTransitiveDependencies(dependencies: Dependency[]): Promise<void>;
+
+	/** Parse the module contents */
+	parse(): void;
+}

package/src/types/gir-module-resolved.ts

@@ -0,0 +1,32 @@
+import type { IGirModule } from "./gir-module-interface.ts";
+import type { ResolveType } from "./resolve-type.ts";
+
+/**
+ * Represents a resolved GIR module with its resolution context
+ * This is an operational type used by the CLI and module loader
+ */
+export interface GirModuleResolvedBy {
+	namespace: string;
+	version: string;
+	modifier?: string;
+	packageName: string;
+	module: IGirModule;
+	resolvedBy: ResolveType;
+	path: string | null;
+}
+
+/**
+ * Grouped GIR modules by namespace with conflict detection
+ */
+export interface GirModulesGrouped {
+	namespace: string;
+	modules: GirModuleResolvedBy[];
+	hasConflict: boolean;
+}
+
+/**
+ * Map of grouped GIR modules indexed by namespace
+ */
+export interface GirModulesGroupedMap {
+	[namespace: string]: GirModulesGrouped;
+}

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

@@ -0,0 +1,20 @@
+import type {
+	TypeGirAlias,
+	TypeGirClass,
+	TypeGirElement,
+	TypeGirEnumerationMember,
+	TypeGirFunction,
+	TypeGirProperty,
+	TypeGirVariable,
+} from "./index.ts";
+
+export type GirTypeName =
+	| TypeGirFunction
+	| TypeGirElement
+	| TypeGirEnumerationMember
+	| TypeGirProperty
+	| TypeGirClass
+	| TypeGirAlias
+	| TypeGirVariable
+	| "callable-param"
+	| "callable-return";

package/src/types/index.ts

@@ -0,0 +1,92 @@
+// Re-export GIR types from parser (consolidated types)
+export type {
+	GirAliasElement,
+	GirAnnotation,
+	GirBitfieldElement,
+	GirCallableParamElement,
+	GirCallableParams,
+	GirCallableReturn,
+	GirCallbackElement,
+	GirClassElement,
+	GirConstantElement,
+	GirConstructorElement,
+	GirEnumElement,
+	GirFieldElement,
+	GirFunctionElement,
+	// Re-export base XML types that are still needed
+
+	GirInstanceParameter,
+	GirInterfaceElement,
+	GirMemberElement,
+	GirMethodElement,
+	GirNamespace,
+	GirPropertyElement,
+	GirRecordElement,
+	GirRepository,
+	GirSignalElement,
+	GirUnionElement,
+	GirVirtualMethodElement,
+	PartOfClass,
+	PartOfModule,
+} from "@gi.ts/parser";
+// Export the actual GirModule class
+export { GirModule } from "../gir-module.ts";
+export * from "./answer-version.ts";
+export * from "./any-introspected-type.ts";
+export * from "./class.ts";
+export * from "./class-member.ts";
+export * from "./class-parent.ts";
+export * from "./config-flags.ts";
+export * from "./construct-name.ts";
+export * from "./dependency.ts";
+export * from "./dependency-map.ts";
+export * from "./file-info.ts";
+export * from "./format.ts";
+export * from "./generator-constructor.ts";
+export * from "./generics-config.ts";
+export * from "./gir-any-element.ts";
+export * from "./gir-module-interface.ts";
+export * from "./gir-module-resolved.ts";
+export * from "./inheritance-table.ts";
+export * from "./introspected.ts";
+export * from "./local-name.ts";
+export * from "./local-name-check.ts";
+export * from "./local-name-type.ts";
+export * from "./local-names.ts";
+export * from "./metadata.ts";
+export * from "./ns-loader.ts";
+export * from "./options-base.ts";
+export * from "./options-generation.ts";
+export * from "./options-load.ts";
+export * from "./options-transform.ts";
+export * from "./output-format.ts";
+export * from "./package-data.ts";
+export * from "./package-data-parsed.ts";
+export * from "./package-section-parsed.ts";
+export * from "./parsed-gir.ts";
+export * from "./parsed-package-data.ts";
+export * from "./property-case.ts";
+export * from "./resolve-type.ts";
+export * from "./template-data.ts";
+export * from "./template-options.ts";
+export * from "./transformation-case.ts";
+export * from "./transformations.ts";
+export * from "./ts-doc.ts";
+export * from "./ts-doc-tag.ts";
+export * from "./type-gir-alias.ts";
+export * from "./type-gir-class.ts";
+export * from "./type-gir-element.ts";
+export * from "./type-gir-enumeration.ts";
+export * from "./type-gir-enumeration-member.ts";
+export * from "./type-gir-function.ts";
+export * from "./type-gir-interface.ts";
+export * from "./type-gir-method.ts";
+export * from "./type-gir-parameter.ts";
+export * from "./type-gir-property.ts";
+export * from "./type-gir-variable.ts";
+export * from "./type-ts-element.ts";
+export * from "./type-ts-enumeration-member.ts";
+export * from "./type-ts-function.ts";
+export * from "./type-ts-property.ts";
+export * from "./user-config.ts";
+export * from "./user-config-load-result.ts";

package/{lib/types/inheritance-table.d.ts → src/types/inheritance-table.ts}

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

package/src/types/introspected.ts

@@ -0,0 +1,18 @@
+export interface IntrospectedMetadata {
+	deprecated?: boolean;
+	deprecatedVersion?: string;
+	deprecatedDoc?: string;
+	introducedVersion?: string;
+}
+
+export interface IntrospectedBaseOptions {
+	isPrivate?: boolean;
+	isIntrospectable?: boolean;
+	doc?: string | null;
+}
+
+export type IntrospectedOptions<T> = IntrospectedBaseOptions & T;
+
+// Aliases for backward compatibility
+export type BaseOptions = IntrospectedBaseOptions;
+export type Options<T> = IntrospectedOptions<T>;

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

@@ -0,0 +1,5 @@
+import type { LocalName } from "./index.ts";
+
+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 type { GirFieldElement, GirMethodElement, GirPropertyElement, LocalNameType } from "./index.ts";
+
+export interface LocalName {
+	type: LocalNameType;
+	method?: GirMethodElement;
+	property?: GirPropertyElement;
+	field?: GirFieldElement;
+}

package/src/types/local-names.ts

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

package/src/types/metadata.ts

@@ -0,0 +1,6 @@
+export interface Metadata {
+	name: string;
+	package_version: string;
+	api_version: string;
+	imports: { [lib: string]: string };
+}

package/src/types/ns-loader.ts

@@ -0,0 +1,6 @@
+import type { ParsedGir } from "./parsed-gir.ts";
+
+export interface NSLoader {
+	load(namespace: string, version: string): ParsedGir | null;
+	loadAll(namespace: string): ParsedGir[];
+}

package/src/types/options-base.ts

@@ -0,0 +1,8 @@
+export interface OptionsBase {
+	/** Switch on/off the verbose mode */
+	verbose: boolean;
+	/** Enable generation problem reporter */
+	reporter: boolean;
+	/** Output file path for the reporter */
+	reporterOutput: string;
+}

package/src/types/options-generation.ts

@@ -0,0 +1,65 @@
+import type { OptionsBase } from "./index.ts";
+
+/**
+ * Type for currently used config e.g. in GirModule
+ */
+export interface OptionsGeneration extends OptionsBase {
+	/** root / working directory of your project */
+	root: string;
+	/** directory to output to */
+	outdir: string | null;
+	/** GIR directories */
+	girDirectories: string[];
+	/** Do not export all symbols for each module as a namespace */
+	noNamespace: boolean;
+	/** Do not generate documentation comments */
+	noComments: boolean;
+	/** Generate promisified functions for async/finish calls */
+	promisify: boolean;
+	/**
+	 * Scope of the generated NPM packages
+	 * @see https://docs.npmjs.com/cli/v7/using-npm/scope
+	 */
+	npmScope: string;
+	/** Uses the workspace protocol for the generated packages which can be used with package managers like Yarn and PNPM */
+	workspace: boolean;
+	/** Disable GLib.Variant class with string parsing */
+	noAdvancedVariants: boolean;
+	/**
+	 * Only use the version prefix for the ambient module exports.
+	 * This is useful if, for whatever reason, you want to use different library versions of the same library in your project.
+	 *
+	 * @example
+	 * ```ts
+	 * declare module 'gi://Gtk?version=4.0' {...}
+	 * declare module 'gi://Gtk?version=3.0' {...}
+	 * ```
+	 */
+	onlyVersionPrefix: boolean;
+	/** Disable pretty printing the output */
+	noPrettyPrint: boolean;
+	/**
+	 * Generate the typescript types with package.json support
+	 */
+	package: boolean;
+	/**
+	 * Enable generation problem reporter and create a detailed report file
+	 */
+	reporter: boolean;
+	/**
+	 * Output file path for the reporter
+	 */
+	reporterOutput: string;
+	/** Generate a single unified documentation for all modules instead of separate per-module docs */
+	combined?: boolean;
+	/** URL template for source links in generated documentation. Supports {path}, {line}, {gitRevision} placeholders */
+	sourceLinkTemplate?: string;
+	/** Theme for HTML documentation generation (default: "gi-docgen") */
+	theme?: string;
+	/** Path to a README file to use as the documentation index page (default: "none") */
+	readme?: string;
+	/** Use TypeDoc merge mode to generate HTML from pre-generated JSON files */
+	merge?: boolean;
+	/** Directory containing pre-generated TypeDoc JSON files for merge mode (from 'ts-for-gir json') */
+	jsonDir?: string;
+}

package/src/types/options-load.ts

@@ -0,0 +1,6 @@
+import type { OptionsBase, PropertyCase } from "./index.ts";
+
+export interface OptionsLoad extends OptionsBase {
+	loadDocs: boolean;
+	propertyCase: PropertyCase;
+}

package/src/types/options-transform.ts

@@ -0,0 +1,5 @@
+import type { OptionsBase } from "./index.ts";
+
+export interface OptionsTransform extends OptionsBase {
+	inferGenerics: boolean;
+}

package/src/types/output-format.ts

@@ -0,0 +1 @@
+export type OutputFormat = "file" | "folder";

package/src/types/package-data-parsed.ts

@@ -0,0 +1,28 @@
+export interface PackageDataParsed {
+	/** Description of this package */
+	_: string;
+	$: {
+		/** Vala package name */
+		name: string;
+		/** Vala build flags */
+		flags?: string;
+		/** URL to the homepage of this package */
+		home?: string;
+		/** URL to a gallery of widgets of this package */
+		gallery?: string;
+		/** URL to the source code of this package */
+		"c-docs"?: string;
+		/** True if this package should be ignored*/
+		ignore?: "true" | "false";
+		/** True if this package is deprecated */
+		deprecated?: "true" | "false";
+		/** Gir package name with version string */
+		gir?: string;
+		/** URL to the VAPI image sources of this package */
+		"vapi-image-source"?: string;
+		/** Name of the Maintainer of this package */
+		maintainers?: string;
+		/** Name of the Maintainer of this package */
+		maintainer?: string;
+	};
+}

package/src/types/package-data.ts

@@ -0,0 +1,24 @@
+import type { PackageSectionParsed } from "./index.ts";
+
+export interface PackageData {
+	/** Namespace of this package, e.g. Gtk */
+	namespace: string;
+	/** Version of this package, e.g. 4.0 */
+	version: string;
+	/** Description of this package */
+	description: string;
+	/** Gir package name with version string */
+	gir?: string;
+	/** URL to the homepage of this package */
+	home?: string;
+	/** URL to a gallery of widgets of this package */
+	gallery?: string;
+	/** URL to the source code of this package */
+	cDocs?: string;
+	/** True if this package is deprecated */
+	deprecated?: boolean;
+	/** Name of the Maintainer of this package */
+	maintainers?: string;
+	/** The section of this package */
+	section?: PackageSectionParsed;
+}

package/src/types/package-section-parsed.ts

@@ -0,0 +1,9 @@
+import type { PackageDataParsed } from "./index.ts";
+
+export interface PackageSectionParsed {
+	$: {
+		name: string;
+	};
+	package?: PackageDataParsed[];
+	section?: PackageSectionParsed[];
+}