domain-quotes 0.0.10

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Justice Ogbonna
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,149 @@
+# DomainPrices
+
+[![Build](https://github.com/namewiz/domainprices/actions/workflows/build.yml/badge.svg)](https://github.com/namewiz/domainprices/actions/workflows/build.yml)
+[![Test](https://github.com/namewiz/domainprices/actions/workflows/test.yml/badge.svg)](https://github.com/namewiz/domainprices/actions/workflows/test.yml)
+[![NPM](http://img.shields.io/npm/v/domainprices.svg)](https://www.npmjs.com/package/domainprices)
+[![License](https://img.shields.io/npm/l/domainprices.svg)](https://github.com/namewiz/domainprices/blob/main/LICENSE)
+
+
+DomainPrices is a lightweight TypeScript/JavaScript library to compute domain registration prices across currencies with discounts and VAT, using curated datasets.
+
+Includes:
+- Extension support based on unified registrar price list (OpenProvider/NIRA)
+- Currency conversion via remote exchange rates
+- VAT calculation per currency (US, GB, DE, NG mapping)
+- Optional discount codes with max-or-stack policy
+- Configurable markup to increase base prices before taxes/discounts
+- Clean ESM API with TypeScript types
+
+Install
+
+```bash
+npm i domainprices
+```
+
+Usage
+
+```ts
+import { getDefaultPrice, DomainPrices, DEFAULTS_Sept2025 } from 'domainprices';
+
+// Quick price (uses bundled defaults)
+const quote = await getDefaultPrice('com', 'USD', { discountCodes: ['SAVE10'] });
+// → { extension, currency, basePrice, discount, tax, totalPrice, symbol }
+
+// Advanced: custom or explicit config via the class
+const dp = new DomainPrices(DEFAULTS_Sept2025); // or provide your own DomainPricesConfig
+const eur = await dp.getPrice('example.com', 'EUR', { discountPolicy: 'stack' });
+
+// Add a 15% markup before discounts/taxes
+const withMarkup = new DomainPrices({
+  ...DEFAULTS_Sept2025,
+  markup: { type: 'percentage', value: 0.15 },
+});
+const quoteWithMarkup = await withMarkup.getPrice('example.com', 'USD', { discountCodes: ['SAVE10'] });
+```
+
+API
+
+- `getDefaultPrice(extension: string, currency: string, options?: GetPriceOptions): Promise<PriceQuote>`
+  - Computes price for a TLD/SLD extension (e.g. `com`, `com.ng`, `.org`) using the bundled defaults.
+  - `options`
+    - `discountCodes?: string[]` – one or more codes; case-insensitive.
+    - `now?: number | Date` – inject time for deterministic tests.
+    - `discountPolicy?: 'stack' | 'max'` – default `'max'` (highest single discount only).
+
+- `class DomainPrices(config: DomainPricesConfig)`
+  - `getPrice(extension: string, currency: string, options?: GetPriceOptions): Promise<PriceQuote>` – same behavior as above, but uses the provided config.
+  - `DEFAULTS_Sept2025: DomainPricesConfig` – exported snapshot config used by `getDefaultPrice`.
+
+- `listSupportedExtensions(): string[]`
+  - All extensions with a non-zero price in the dataset.
+
+- `isSupportedExtension(extOrDomain: string): boolean`
+  - Accepts an extension or a full domain (resolved by longest-known suffix match against bundled price data).
+
+- `listSupportedCurrencies(): string[]`
+  - Currently returns `['USD','GBP','EUR','NGN']`. These map to VAT via country ISO codes.
+
+- `isSupportedCurrency(code: string): boolean`
+
+Types
+
+```ts
+type DiscountPolicy = 'stack' | 'max';
+
+interface GetPriceOptions {
+  discountCodes?: string[];
+  now?: number | Date;
+  discountPolicy?: DiscountPolicy;
+  transaction?: 'create' | 'renew' | 'restore' | 'transfer'; // default 'create'
+}
+
+type MarkupType = 'percentage' | 'fixed_usd';
+
+interface PriceMarkup {
+  type: MarkupType;            // percentage -> 0.2 === +20%, fixed_usd -> +$ value before conversion
+  value: number;
+}
+
+interface PriceQuote {
+  extension: string;
+  currency: string;
+  basePrice: number;
+  discount: number;
+  tax: number;
+  totalPrice: number;
+  symbol: string;
+  transaction: 'create' | 'renew' | 'restore' | 'transfer';
+}
+
+interface ExchangeRateData {
+  countryCode: string;
+  currencyName: string;
+  currencySymbol: string;
+  currencyCode: string;
+  exchangeRate: number;
+  inverseRate: number;
+}
+
+interface DiscountConfig {
+  rate: number; // e.g. 0.1 for 10%
+  extensions: string[]; // eligible extensions
+  startAt: string; // ISO timestamp
+  endAt: string;   // ISO timestamp
+}
+
+interface DomainPricesConfig {
+  createPrices: Record<string, number>;        // base USD prices for create
+  // Optional price tables per transaction type (all USD). Falls back to `createPrices` when absent.
+  renewPrices?: Record<string, number>;
+  restorePrices?: Record<string, number>;
+  transferPrices?: Record<string, number>;
+  exchangeRates: ExchangeRateData[];           // currency conversion data
+  vatRates: Record<string, number>;            // ISO country code → VAT rate
+  discounts: Record<string, DiscountConfig>;   // discount code → config
+  markup?: PriceMarkup;                        // optional markup applied before conversion
+}
+```
+
+Errors
+
+- `UnsupportedExtensionError` with `code = 'ERR_UNSUPPORTED_EXTENSION'`
+- `UnsupportedCurrencyError` with `code = 'ERR_UNSUPPORTED_CURRENCY'`
+
+Notes
+
+- Rounding is to 2 decimal places at each step to keep totals predictable (`base`, `discount`, `tax`, `total`).
+- VAT mapping is intentionally narrow and explicit by currency → country: `USD → US (0)`, `GBP → GB (0.2)`, `EUR → DE (0.19)`, `NGN → NG (0.075)`.
+- Price and exchange-rate data are fetched from maintained remote sources at import time:
+  - Prices: `https://raw.githubusercontent.com/namewiz/registrar-pricelist/refs/heads/main/data/unified-create-prices.csv`
+  - Exchange rates: `https://raw.githubusercontent.com/namewiz/registrar-pricelist/refs/heads/main/data/exchange-rates.json`
+  These are cached in-memory for the life of the process.
+
+## Testing
+
+```bash
+npm test
+```
+
+The test suite uses Node’s built-in `node:test` runner and builds the library first.

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "domain-quotes",
+  "version": "0.0.10",
+  "description": "Fast multi-currency domain price checker library across registrars.",
+  "type": "module",
+  "main": "./dist/index.js",
+  "scripts": {
+    "build": "npx -y esbuild src/index.ts --bundle --minify --format=esm --target=esnext --outdir=dist/ --platform=neutral",
+    "postbuild": "cp dist/index.js docs/domainprices.js",
+    "test": "npm run build && node --test",
+    "start": "npm run build && cp dist/index.js docs/domainprices.js && npx serve docs"
+  },
+  "homepage": "https://namewiz.github.io/domainprices",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/namewiz/domainprices.git"
+  },
+  "bugs": {
+    "url": "https://github.com/namewiz/domainprices/issues"
+  },
+  "author": "Justice Ogbonna <dev@justiceo.com>",
+  "keywords": [
+    "domain-name",
+    "domain-price",
+    "domain-availability",
+    "price-check"
+  ],
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "license": "MIT",
+  "engines": {
+    "node": "^22.12.0",
+    "npm": "^10.9.0"
+  }
+}

package/todo.txt

@@ -0,0 +1,5 @@
+
+    "comment": "organizational email constraint, origin website, max # of years, whether it can be combined with other coupons, user country code, new customer only",
+    "comment2": "doesn't support fixed amount intentionally, avoid -ve charges, ",
+    "comment3": "each code can be used an unlimited number of times between start and end",
+    "comment4": "Alt: enable use:once or use:once_per_user",