feat: add getPackageDeclarations

Author: velut

src/get-package-declarations.test.ts

@@ -0,0 +1,72 @@
+import { goTry } from "go-go-try";
+import { dedent } from "ts-dedent";
+import { ModuleKind, ModuleResolutionKind, Project, ScriptTarget } from "ts-morph";
+import { afterEach, expect, test, vi } from "vitest";
+import { extractDeclarations } from "./extract-declarations.ts";
+import { getPackageDeclarations } from "./get-package-declarations.ts";
+
+vi.mock("./extract-declarations", () => ({
+	extractDeclarations: vi.fn(),
+}));
+
+afterEach(() => {
+	vi.clearAllMocks();
+});
+
+test("success", async () => {
+	const project = new Project({
+		useInMemoryFileSystem: true,
+		compilerOptions: {
+			lib: ["lib.esnext.full.d.ts"],
+			target: ScriptTarget.ESNext,
+			module: ModuleKind.ESNext,
+			moduleResolution: ModuleResolutionKind.Bundler,
+		},
+	});
+	const indexFile = project.createSourceFile(
+		"index.ts",
+		dedent`
+    export {};
+    `,
+	);
+	vi.mocked(extractDeclarations).mockResolvedValue([]);
+	const [err, declarations] = await goTry(
+		getPackageDeclarations({
+			pkgName: "foo",
+			project,
+			indexFile,
+			maxDepth: 5,
+		}),
+	);
+	expect(err).toBeUndefined();
+	expect(declarations).toStrictEqual([]);
+});
+
+test("failure", async () => {
+	const project = new Project({
+		useInMemoryFileSystem: true,
+		compilerOptions: {
+			lib: ["lib.esnext.full.d.ts"],
+			target: ScriptTarget.ESNext,
+			module: ModuleKind.ESNext,
+			moduleResolution: ModuleResolutionKind.Bundler,
+		},
+	});
+	const indexFile = project.createSourceFile(
+		"index.ts",
+		dedent`
+    export {};
+    `,
+	);
+	vi.mocked(extractDeclarations).mockRejectedValue(new Error("test"));
+	const [err, declarations] = await goTry(
+		getPackageDeclarations({
+			pkgName: "foo",
+			project,
+			indexFile,
+			maxDepth: 5,
+		}),
+	);
+	expect(err).toBeDefined();
+	expect(declarations).toBeUndefined();
+});

src/get-package-declarations.ts

@@ -0,0 +1,34 @@
+import type { Project, SourceFile } from "ts-morph";
+import { extractDeclarations } from "./extract-declarations.ts";
+import type { ExtractedDeclaration } from "./types.ts";
+
+/** `GetPackageDeclarationsOptions` contains the options for calling {@link getPackageDeclarations}. */
+export interface GetPackageDeclarationsOptions {
+	/** Package name. */
+	pkgName: string;
+
+	/** `Project` created with `ts-morph`. */
+	project: Project;
+
+	/** `SourceFile` created with `ts-morph` representing the index file. */
+	indexFile: SourceFile;
+
+	/** Depth limit for the extraction. */
+	maxDepth: number;
+}
+
+/** `getPackageDeclarations` extracts the declarations exported from the given project representing a package. */
+export async function getPackageDeclarations({
+	pkgName,
+	project,
+	indexFile,
+	maxDepth,
+}: GetPackageDeclarationsOptions): Promise<ExtractedDeclaration[]> {
+	return await extractDeclarations({
+		containerName: "",
+		container: indexFile,
+		maxDepth,
+		project,
+		pkgName,
+	});
+}