refactor: update extract-declarations module

Author: velut

src/ambient-modules-declarations.ts

@@ -1,7 +1,7 @@
 import { Node, type Project } from "ts-morph";
+import type { FoundDeclaration } from "./extract-declarations.ts";
 import { isHidden } from "./is-hidden.ts";
 import { sourceFilePath } from "./source-file-path.ts";
-import type { FoundDeclaration } from "./types.ts";
 
 export function ambientModulesDeclarations(
 	containerName: string,

src/export-equals-declarations.ts

@@ -1,9 +1,9 @@
 import { ModuleDeclaration, SourceFile, SyntaxKind } from "ts-morph";
 import { isNamespace } from "./declaration-type-guards.ts";
+import type { FoundDeclaration } from "./extract-declarations.ts";
 import { isExportedDeclarations } from "./is-exported-declarations.ts";
 import { isHidden } from "./is-hidden.ts";
 import { isShorthandAmbientModule } from "./is-shorthand-ambient-module.ts";
-import type { FoundDeclaration } from "./types.ts";
 
 export function exportEqualsDeclarations(
 	containerName: string,

src/exported-declarations.ts

@@ -1,7 +1,7 @@
 import type { ModuleDeclaration, SourceFile } from "ts-morph";
+import type { FoundDeclaration } from "./extract-declarations.ts";
 import { isExportedDeclarations } from "./is-exported-declarations.ts";
 import { isHidden } from "./is-hidden.ts";
-import type { FoundDeclaration } from "./types.ts";
 
 export function exportedDeclarations(
 	containerName: string,

src/extract-declarations.ts

@@ -1,5 +1,11 @@
 import { orderBy } from "natural-orderby";
-import { Node, type ExportedDeclarations } from "ts-morph";
+import {
+	type ExportedDeclarations,
+	type ModuleDeclaration,
+	Node,
+	type Project,
+	type SourceFile,
+} from "ts-morph";
 import { ambientModulesDeclarations } from "./ambient-modules-declarations.ts";
 import {
 	isClass,
@@ -29,7 +35,39 @@ import { extractVariableAssignmentExpression } from "./extract-variable-assignme
 import { extractVariable } from "./extract-variable.ts";
 import { globalAmbientDeclarations } from "./global-ambient-declarations.ts";
 import { id } from "./id.ts";
-import type { ExtractDeclarationsOptions, ExtractedDeclaration } from "./types.ts";
+import type { ExtractedDeclaration } from "./types.ts";
+
+/** `ExtractDeclarationsOptions` contains the options for calling {@link extractDeclarations}. */
+export interface ExtractDeclarationsOptions {
+	/** Container that exports the top-level declarations. */
+	container: SourceFile | ModuleDeclaration;
+
+	/**
+  Container name (e.g., the name of a namespace), used to generate declaration IDs.
+  */
+	containerName: string;
+
+	/** Maximum extraction depth for nested namespaces. */
+	maxDepth: number;
+
+	/** Instance of a `ts-morph` `Project`, used to find ambient modules. */
+	project?: Project;
+
+	/** Name of the package being analyzed, used to filter ambient modules. */
+	pkgName?: string;
+}
+
+/** `FoundDeclaration` represents a declaration found during the initial extraction process. */
+export interface FoundDeclaration {
+	/** Declaration container name. */
+	containerName: string;
+
+	/** Export name (may differ from the original name). */
+	exportName: string;
+
+	/** Declaration. */
+	declaration: ExportedDeclarations;
+}
 
 /**
 `extractDeclarations` extracts the top-level declarations
@@ -68,14 +106,14 @@ export async function extractDeclarations({
 	return orderBy(extractedDeclarations, "id");
 }
 
-type ExtractDeclarationOptions = {
+interface ExtractDeclarationOptions {
 	containerName: string;
 	exportName: string;
 	declaration: ExportedDeclarations;
 	maxDepth: number;
 	seenFunctions: Set<string>;
 	seenNamespaces: Set<string>;
-};
+}
 
 async function extractDeclaration({
 	containerName,

src/global-ambient-declarations.ts

@@ -1,7 +1,7 @@
 import { SourceFile } from "ts-morph";
+import type { FoundDeclaration } from "./extract-declarations.ts";
 import { isGlobal } from "./is-global.ts";
 import { isHidden } from "./is-hidden.ts";
-import type { FoundDeclaration } from "./types.ts";
 
 export function globalAmbientDeclarations(
 	containerName: string,