postal-code-scraper 1.0.2 → 1.0.4

package/src/types.ts

@@ -1,37 +0,0 @@
-export type Region = {
-	path: string;
-	name: string;
-	prettyName: string;
-};
-
-export type ScraperConfig = {
-	usePrettyName?: boolean;
-	directory?: string;
-	concurrency?: number;
-	maxRetries?: number;
-	headless?: boolean;
-	logger?: any;
-};
-
-export type ProcessingQueueItem = {
-	region: Region;
-	currData: RegionData;
-};
-
-export interface LookupData {
-	postalCodeMap: {
-		[postalCode: string]: string;
-	};
-	regions: {
-		[code: string]: string[];
-	};
-}
-
-export interface PostalCodeData {
-	rawData: RegionData;
-	postalCodeLookup: LookupData;
-}
-
-export interface RegionData {
-	[key: string]: RegionData | string[];
-}

package/src/utils/env-config.ts

@@ -1,3 +0,0 @@
-export const getBaseUrl = () => {
-	return "https://worldpostalcode.com";
-};

package/src/utils/id-generator.ts

@@ -1,35 +0,0 @@
-export interface RegionIdGenerator {
-	(regions: string[]): string;
-}
-
-export const createRegionIdGenerator = (): RegionIdGenerator => {
-	const regionRegistry = new Map<string, string>();
-	const counterMap = new Map<string, number>();
-
-	return (regions: string[]): string => {
-		const normalized = regions.map((region) =>
-			region
-				.trim()
-				.toLowerCase()
-				.normalize("NFD")
-				.replace(/[\u0300-\u036f]/g, "")
-				.replace(/\s+/g, "_")
-		);
-
-		const compositeKey = normalized.join("|");
-
-		if (regionRegistry.has(compositeKey)) {
-			return regionRegistry.get(compositeKey)!;
-		}
-
-		const baseName = normalized[normalized.length - 1];
-		const count = (counterMap.get(baseName) || 0) + 1;
-		counterMap.set(baseName, count);
-
-		const newId = `${baseName}_${count}`;
-
-		regionRegistry.set(compositeKey, newId);
-
-		return newId;
-	};
-};

package/src/utils/logger.ts

@@ -1,105 +0,0 @@
-export type LogMethod = "error" | "warn" | "info" | "debug";
-export type LogLevel = LogMethod | "silent";
-
-export interface LoggerInterface {
-	debug(message: string, ...args: any[]): void;
-	info(message: string, ...args: any[]): void;
-	warn(message: string, ...args: any[]): void;
-	error(message: string, ...args: any[]): void;
-}
-
-export class Logger implements LoggerInterface {
-	private static logLevel: LogLevel = "info";
-	private static useColors: boolean = true;
-	private static prefix: string = "[POSTAL-CODE-SCRAPER]";
-	private static instance: LoggerInterface;
-
-	static configure(config: { level?: LogLevel; colors?: boolean; prefix?: string; logger?: LoggerInterface }): void {
-		if (config.level) this.logLevel = config.level;
-		if (config.colors !== undefined) this.useColors = config.colors;
-		if (config.prefix) this.prefix = config.prefix;
-		if (config.logger) this.instance = config.logger;
-	}
-
-	static getInstance(): LoggerInterface {
-		return this.instance || new Logger();
-	}
-
-	static debug(message: string, ...args: any[]): void {
-		this.log("debug", message, args);
-	}
-
-	static info(message: string, ...args: any[]): void {
-		this.log("info", message, args);
-	}
-
-	static warn(message: string, ...args: any[]): void {
-		this.log("warn", message, args);
-	}
-
-	static error(message: string, ...args: any[]): void {
-		this.log("error", message, args);
-	}
-
-	private static shouldLog(level: LogLevel): boolean {
-		if (this.logLevel === "silent") return false;
-
-		const levels: LogMethod[] = ["error", "warn", "info", "debug"];
-		return levels.indexOf(level as LogMethod) <= levels.indexOf(this.logLevel as LogMethod);
-	}
-
-	private static log(level: LogMethod, message: string, args: any[]): void {
-		if (!this.shouldLog(level)) return;
-
-		const logger = this.getInstance();
-		const formatted = this.formatMessage(level, message);
-
-		logger[level](formatted, ...args);
-	}
-
-	private static formatMessage(level: LogMethod, message: string): string {
-		const timestamp = new Date().toISOString();
-		const levelColor = this.getLevelColor(level);
-		const messageColor = this.useColors ? "\x1b[37m" : "";
-
-		return [
-			this.useColors ? "\x1b[90m" : "",
-			`${this.prefix} `,
-			`${timestamp} `,
-			levelColor,
-			`[${level.toUpperCase()}]`,
-			this.useColors ? "\x1b[0m" : "",
-			messageColor,
-			` ${message}`,
-			this.useColors ? "\x1b[0m" : "",
-		].join("");
-	}
-
-	private static getLevelColor(level: LogMethod): string {
-		if (!this.useColors) return "";
-
-		return {
-			error: "\x1b[31m", // Red
-			warn: "\x1b[33m", // Yellow
-			info: "\x1b[36m", // Cyan
-			debug: "\x1b[35m", // Magenta
-		}[level];
-	}
-
-	// Instance methods to implement LoggerInterface
-	debug(message: string, ...args: any[]): void {
-		console.debug(message, ...args);
-	}
-
-	info(message: string, ...args: any[]): void {
-		console.log(message, ...args);
-	}
-
-	warn(message: string, ...args: any[]): void {
-		console.warn(message, ...args);
-	}
-
-	error(message: string, ...args: any[]): void {
-		console.error(message, ...args);
-	}
-}

package/src/utils/string-utils.ts

@@ -1,9 +0,0 @@
-export const normalizeString = (str: string): string => {
-	return str
-		.trim()
-		.toLowerCase()
-		.normalize("NFD")
-		.replace(/[\u0300-\u036f]/g, "")
-		.replace(/\s+/g, "-")
-		.replace(/[^a-z0-9.-]/g, "");
-};

package/tests/postal-code-scraper.test.ts

@@ -1,100 +0,0 @@
-import { expect } from "chai";
-import sinon from "sinon";
-import { PostalCodeScraper, ScraperConfig } from "../src";
-import path from "path";
-import fs from "fs";
-
-const TEST_DATA_DIR = "./tests/test-data";
-
-describe("PostalCodeScraper", () => {
-	let scraper: PostalCodeScraper;
-	let config: ScraperConfig;
-
-	before(async function () {
-		this.timeout(20000);
-		config = {
-			headless: true,
-			concurrency: 10,
-			logger: console,
-			directory: TEST_DATA_DIR,
-		};
-
-		scraper = new PostalCodeScraper(config);
-		await scraper.scrapeCountry("romania");
-	});
-
-	afterEach(async () => {
-		sinon.restore();
-	});
-
-	after(() => {
-		fs.rmSync(TEST_DATA_DIR, { recursive: true, force: true });
-	});
-
-	describe("Country Scraping", function () {
-		it("should handle country found", async () => {
-			const postalCodesFile = path.join(TEST_DATA_DIR, "romania-postal-codes.json");
-			const lookupFile = path.join(TEST_DATA_DIR, "romania-lookup.json");
-
-			expect(fs.existsSync(postalCodesFile), "Postal codes file should exist").to.be.true;
-			expect(fs.existsSync(lookupFile), "Lookup file should exist").to.be.true;
-		});
-
-		it("should handle country not found", async () => {
-			const loggerSpy = sinon.spy(console, "warn");
-			await scraper.scrapeCountry("NonExistentCountry");
-			expect(loggerSpy.calledOnce).to.be.true;
-		});
-	});
-
-	describe("Data Processing", () => {
-		it("should generate valid postal code data", async () => {
-			const postalCodesFile = path.join(TEST_DATA_DIR, "romania-postal-codes.json");
-			const postalCodesContent = JSON.parse(fs.readFileSync(postalCodesFile, "utf8"));
-
-			const expectedPostalCodes = {
-				alba: {
-					abrud: ["515100"],
-				},
-			};
-
-			expect(postalCodesContent).to.have.property("alba");
-			expect(postalCodesContent.alba).to.have.property("abrud");
-			expect(postalCodesContent.alba.abrud).to.deep.equal(expectedPostalCodes.alba.abrud);
-		});
-
-		it("should generate valid postal code lookup", () => {
-			const lookupFile = path.join(TEST_DATA_DIR, "romania-lookup.json");
-			const lookupContent = JSON.parse(fs.readFileSync(lookupFile, "utf8"));
-
-			const expectedLookup = {
-				postalCodeMap: {
-					"450145": "zalau_1",
-				},
-				regions: {
-					zalau_1: ["salaj", "zalau"],
-				},
-			};
-
-			expect(lookupContent).to.have.property("postalCodeMap");
-			expect(lookupContent.postalCodeMap).to.have.property("450145");
-			expect(lookupContent.regions.zalau_1).to.deep.equal(expectedLookup.regions.zalau_1);
-			expect(lookupContent).to.have.property("regions");
-			expect(lookupContent.regions).to.have.property("zalau_1");
-			expect(lookupContent.regions.zalau_1).to.deep.equal(expectedLookup.regions.zalau_1);
-		});
-	});
-
-	describe("Error Handling", () => {
-		it("should retry failed fetches", async () => {
-			const fetcherStub = sinon.stub((scraper as any).fetcher, "fetchWithRetry").rejects(new Error("Network error"));
-
-			try {
-				await (scraper as any).getCountriesDetails();
-			} catch (err) {
-				expect(err).to.be.an("error");
-				expect(fetcherStub.callCount).to.equal(config.maxRetries);
-			}
-		});
-	});
-});

package/tests/tsconfig.json

@@ -1,13 +0,0 @@
-{
-	"extends": "../tsconfig.json",
-
-	"compilerOptions": {
-		"outDir": "../build/test",
-		"rootDir": "../",
-		"rootDirs": ["../src", "./"],
-		"noEmitOnError": true,
-		"declaration": false,
-		"sourceMap": true
-	},
-	"include": ["./**/*", "../src/**/*"]
-}

package/tsconfig.json

@@ -1,15 +0,0 @@
-{
-	"compilerOptions": {
-		"rootDir": "./src",
-		"outDir": "./dist",
-		"forceConsistentCasingInFileNames": true,
-		"strict": true,
-		"skipLibCheck": true,
-		"declaration": true,
-		"target": "ES6",
-		"module": "CommonJS",
-		"esModuleInterop": true,
-		"moduleResolution": "node"
-	},
-	"include": ["src/**/*"]
-}