feat: update packageDeclarations

Author: velut

src/errors.ts

@@ -16,3 +16,8 @@ export class PackageTypesError extends Data.TaggedError("PackageTypesError") {}
 
 /** `ProjectError` occurs when the `ts-morph` project cannot be created. */
 export class ProjectError extends Data.TaggedError("ProjectError")<{ readonly cause?: unknown }> {}
+
+/** `PackageDeclarationsError` occurs when the declarations extraction fails. */
+export class PackageDeclarationsError extends Data.TaggedError("PackageDeclarationsError")<{
+	cause?: unknown;
+}> {}

src/package-declarations.test.ts

@@ -3,10 +3,11 @@ 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 { packageDeclarations, type PackageDeclarationsOptions } from "./package-declarations.ts";
+import { packageDeclarations } from "./package-declarations.ts";
+import type { PackageDeclarationsOptions } from "./types.ts";
 
-const _packageDeclarations = (options: PackageDeclarationsOptions) =>
-	Effect.runPromise(packageDeclarations(options));
+const _packageDeclarations = (opts: PackageDeclarationsOptions) =>
+	Effect.runPromise(packageDeclarations(opts));
 
 vi.mock("./extract-declarations", () => ({
 	extractDeclarations: vi.fn(),

src/package-declarations.ts

@@ -1,26 +1,16 @@
-import { Data, Effect } from "effect";
-import type { Project, SourceFile } from "ts-morph";
+import { Effect } from "effect";
+import { PackageDeclarationsError } from "./errors.ts";
 import { extractDeclarations } from "./extract-declarations.ts";
+import type { PackageDeclarationsOptions } from "./types.ts";
 
-export type PackageDeclarationsOptions = {
-	pkgName: string;
-	project: Project;
-	indexFile: SourceFile;
-	maxDepth: number;
-};
-
-/** @internal */
-export class PackageDeclarationsError extends Data.TaggedError("PackageDeclarationsError")<{
-	cause?: unknown;
-}> {}
-
-export const packageDeclarations = ({
+/** `packageDeclarations` returns an Effect that extracts declarations from a package. */
+export function packageDeclarations({
 	pkgName,
 	project,
 	indexFile,
 	maxDepth,
-}: PackageDeclarationsOptions) =>
-	Effect.tryPromise({
+}: PackageDeclarationsOptions) {
+	return Effect.tryPromise({
 		try: () =>
 			extractDeclarations({
 				containerName: "",
@@ -29,5 +19,6 @@ export const packageDeclarations = ({
 				project,
 				pkgName,
 			}),
-		catch: (e) => new PackageDeclarationsError({ cause: e }),
+		catch: (err) => new PackageDeclarationsError({ cause: err }),
 	});
+}

src/types.ts

@@ -306,3 +306,18 @@ export interface CreateProjectReturn {
 	/** `SourceFile` created with `ts-morph` representing the index file. */
 	indexFile: SourceFile;
 }
+
+/** `PackageDeclarationsOptions` contains the options for calling {@link packageDeclarations}. */
+export interface PackageDeclarationsOptions {
+	/** Name of the analyzed package. */
+	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;
+}