dts-buddy/src/types.d.ts

A tool for creating .d.ts bundles

import { SourceMapMappings } from '@jridgewell/sourcemap-codec';
import { Location } from 'locate-character';
import { SourceFile } from 'typescript';

interface Reference {
	module: string;
	name: string;
}

interface Declaration {
	module: string;
	name: string;
	alias: string;
	exported: boolean;
	external: boolean;
	included: boolean;
	dependencies: Reference[];
	/**
	 * The name we'd like to use to refer to this binding.
	 * Only applies to default imports from external modules
	 */
	preferred_alias: string;
}

interface Binding {
	id: string;
	external: boolean;
	name: string;
}

interface ModuleReference {
	id: string;
	external: boolean;
}

interface Module {
	file: string;
	dts: string;
	ast: SourceFile;
	locator: (pos: number) => Location | undefined;
	source: null | {
		code: string;
		map: any; // TODO
		mappings: SourceMapMappings;
	};
	dependencies: string[];
	globals: string[];
	references: Set<string>;
	declarations: Map<string, Declaration>;
	imports: Map<string, Binding>;
	import_all: Map<string, Binding>;
	export_from: Map<string, Binding>;
	export_all: ModuleReference[];
	ambient_imports: ModuleReference[];

	/** A map of <exported, local> exports */
	exports: Map<string, string>;
}

interface Namespace {
	declarations: Map<string, Declaration>;
	references: Set<string>;
	exports: Map<string, string>;
}

interface Mapping {
	source: string;
	line: number;
	column: number;
}

export { Binding, Declaration, Mapping, Module, ModuleReference, Namespace };