manish-9245/purchasing-power-parity-advanced

Purpose and Entry Points

This is a compact Node.js package providing purchasing-power-parity (PPP) currency conversions across ISO3 country codes. It supports both a CommonJS programmatic API and a globally installed CLI command (ppp-calculator).

The implementation is centralized in index.js; package exposure, CLI bin mapping, dependencies, and runtime metadata are expected in package.json.

Public API Boundary

index.js exports three consumer-facing operations:

• convertPPP(originCode, amount, targetCodes, options) — asynchronous multi-country PPP conversion.

• listCountries() — asynchronous list of supported ISO3 PPP codes.

• listCountryCodes() — country code/name lookup data.

The module boundary is CommonJS (require('purchasing-power-parity-advanced')), making index.js the single integration point for library users.

Paths: index.js, package.json

CLI Execution Path

The CLI accepts an origin ISO3 code, numeric amount, and comma-separated target ISO3 codes. It invokes the same conversion capability as the module API, but always emits flags and country names in JSON output.

The CLI is likely implemented or dispatched from index.js, with the executable command registration defined through package.json.

Paths: index.js, package.json

Conversion Pipeline

The core flow is:

1. Normalize/validate origin and target ISO3 country codes.

2. Resolve PPP data for origin and each requested target.

3. Calculate target purchasing-power-equivalent amounts relative to the origin amount.

4. Enrich origin and result records with currency metadata, optional country names, and optional flags.

5. Return one origin record plus an ordered array of target result records.

A target may produce amount: null when conversion data is unavailable, while metadata fields are independently nullable.

Paths: index.js

Country and Currency Metadata

Country lookup is a separate logical concern from PPP arithmetic: callers can retrieve ISO3/ISO2/name records without performing a conversion. Conversion responses additionally expose currency code, name, and symbol, and conditionally include visual/country-name presentation fields.

This design supports a data-oriented API response rather than returning only numeric conversions.

Paths: index.js

Runtime and External Dependencies

The package runs on Node.js and is distributed through npm. Dependency resolution is pinned by package-lock.json; runtime dependencies and the CLI executable declaration are defined by package.json.

No separate service, database, frontend, or infrastructure layer is present in the repository tree. Any external PPP data source or country/currency dataset dependency must therefore be consumed directly by the single module implementation or installed npm dependencies.

Paths: package.json, package-lock.json, index.js