refactor: rename getHistory/getHistoryEntry to history.list/history.get

Follow namespace pattern consistent with crawl.* and monitor.*

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

Author: FrancescoSaverioZuppichini

CLAUDE.md

@@ -0,0 +1,15 @@
+# Claude Code Instructions
+
+## Before completing any task
+
+Always run these commands before committing or saying a task is done:
+
+```bash
+bun run format
+bun run lint
+bunx tsc --noEmit
+bun run build
+bun test
+```
+
+No exceptions.

src/index.ts

@@ -5,8 +5,7 @@ export {
 	generateSchema,
 	getCredits,
 	checkHealth,
-	getHistory,
-	getHistoryEntry,
+	history,
 	crawl,
 	monitor,
 } from "./scrapegraphai.js";

src/scrapegraphai.ts

@@ -186,35 +186,31 @@ export async function checkHealth(apiKey: string): Promise<ApiResult<ApiHealthRe
 	}
 }
 
-export async function getHistory(
-	apiKey: string,
-	params?: ApiHistoryFilter,
-): Promise<ApiResult<ApiHistoryPage>> {
-	try {
-		const qs = new URLSearchParams();
-		if (params?.page) qs.set("page", String(params.page));
-		if (params?.limit) qs.set("limit", String(params.limit));
-		if (params?.service) qs.set("service", params.service);
-		const query = qs.toString();
-		const path = query ? `/history?${query}` : "/history";
-		const { data, elapsedMs } = await request<ApiHistoryPage>("GET", path, apiKey);
-		return ok(data, elapsedMs);
-	} catch (err) {
-		return fail(err);
-	}
-}
+export const history = {
+	async list(apiKey: string, params?: ApiHistoryFilter): Promise<ApiResult<ApiHistoryPage>> {
+		try {
+			const qs = new URLSearchParams();
+			if (params?.page) qs.set("page", String(params.page));
+			if (params?.limit) qs.set("limit", String(params.limit));
+			if (params?.service) qs.set("service", params.service);
+			const query = qs.toString();
+			const path = query ? `/history?${query}` : "/history";
+			const { data, elapsedMs } = await request<ApiHistoryPage>("GET", path, apiKey);
+			return ok(data, elapsedMs);
+		} catch (err) {
+			return fail(err);
+		}
+	},
 
-export async function getHistoryEntry(
-	apiKey: string,
-	id: string,
-): Promise<ApiResult<ApiHistoryEntry>> {
-	try {
-		const { data, elapsedMs } = await request<ApiHistoryEntry>("GET", `/history/${id}`, apiKey);
-		return ok(data, elapsedMs);
-	} catch (err) {
-		return fail(err);
-	}
-}
+	async get(apiKey: string, id: string): Promise<ApiResult<ApiHistoryEntry>> {
+		try {
+			const { data, elapsedMs } = await request<ApiHistoryEntry>("GET", `/history/${id}`, apiKey);
+			return ok(data, elapsedMs);
+		} catch (err) {
+			return fail(err);
+		}
+	},
+};
 
 export const crawl = {
 	async start(apiKey: string, params: ApiCrawlRequest): Promise<ApiResult<ApiCrawlResponse>> {

tests/integration.test.ts

@@ -1,5 +1,5 @@
 import { describe, expect, test } from "bun:test";
-import { crawl, extract, getCredits, getHistory, scrape, search } from "../src/index.js";
+import { crawl, extract, getCredits, history, scrape, search } from "../src/index.js";
 
 const API_KEY = process.env.SGAI_API_KEY || "sgai-669918e5-55be-4752-a684-f6da788d1384";
 
@@ -73,9 +73,9 @@ describe("integration", () => {
 		expect(res.data?.results.length).toBeGreaterThan(0);
 	});
 
-	test("getHistory", async () => {
-		const res = await getHistory(API_KEY, { limit: 5 });
-		console.log("getHistory:", res.status, res.data?.pagination);
+	test("history.list", async () => {
+		const res = await history.list(API_KEY, { limit: 5 });
+		console.log("history.list:", res.status, res.data?.pagination);
 		expect(res.status).toBe("success");
 	});
 

tests/scrapegraphai.test.ts

@@ -765,40 +765,38 @@ describe("checkHealth", () => {
 	});
 });
 
-describe("getHistory", () => {
-	test("success without params", async () => {
+describe("history", () => {
+	test("list success without params", async () => {
 		const body = {
 			data: [],
 			pagination: { page: 1, limit: 20, total: 0 },
 		};
 		fetchSpy = spyOn(globalThis, "fetch").mockResolvedValueOnce(json(body));
 
-		const res = await sdk.getHistory(API_KEY);
+		const res = await sdk.history.list(API_KEY);
 
 		expect(res.status).toBe("success");
 		expect(res.data).toEqual(body);
 		expectRequest(0, "GET", "/history");
 	});
 
-	test("success with params", async () => {
+	test("list success with params", async () => {
 		const body = {
 			data: [],
 			pagination: { page: 2, limit: 10, total: 50 },
 		};
 		fetchSpy = spyOn(globalThis, "fetch").mockResolvedValueOnce(json(body));
 
-		const res = await sdk.getHistory(API_KEY, { page: 2, limit: 10, service: "scrape" });
+		const res = await sdk.history.list(API_KEY, { page: 2, limit: 10, service: "scrape" });
 
 		expect(res.status).toBe("success");
 		const [url] = fetchSpy.mock.calls[0] as [string, RequestInit];
 		expect(url).toContain("page=2");
 		expect(url).toContain("limit=10");
 		expect(url).toContain("service=scrape");
 	});
-});
 
-describe("getHistoryEntry", () => {
-	test("success", async () => {
+	test("get success", async () => {
 		const body = {
 			id: "abc-123",
 			service: "scrape",
@@ -808,7 +806,7 @@ describe("getHistoryEntry", () => {
 		};
 		fetchSpy = spyOn(globalThis, "fetch").mockResolvedValueOnce(json(body));
 
-		const res = await sdk.getHistoryEntry(API_KEY, "abc-123");
+		const res = await sdk.history.get(API_KEY, "abc-123");
 
 		expect(res.status).toBe("success");
 		expect(res.data).toEqual(body);