@ts-for-gir/lib/src/types/dependency.ts

Typescript .d.ts generator from GIR for gjs

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;
}