domain-quotes 0.0.11 → 0.1.0

package/README.md

@@ -1,12 +1,12 @@
-# DomainPrices
+# Domain Quotes
 
-[![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)
+[![Build](https://github.com/namewiz/domain-quotes/actions/workflows/build.yml/badge.svg)](https://github.com/namewiz/domain-quotes/actions/workflows/build.yml)
+[![Test](https://github.com/namewiz/domain-quotes/actions/workflows/test.yml/badge.svg)](https://github.com/namewiz/domain-quotes/actions/workflows/test.yml)
+[![NPM](http://img.shields.io/npm/v/domain-quotes.svg)](https://www.npmjs.com/package/domain-quotes)
+[![License](https://img.shields.io/npm/l/domain-quotes.svg)](https://github.com/namewiz/domain-quotes/blob/main/LICENSE)
 
 
-DomainPrices is a lightweight TypeScript/JavaScript library to compute domain registration prices across currencies with discounts and VAT, using curated datasets.
+Domain Quote is a lightweight TypeScript/JavaScript library to compute domain registration quotes across currencies with discounts and VAT, using curated datasets.
 
 Includes:
 - Extension support based on unified registrar price list (OpenProvider/NIRA)
@@ -19,25 +19,25 @@ Includes:
 Install
 
 ```bash
-npm i domainprices
+npm i domain-quotes
 ```
 
 Usage
 
 ```ts
-import { getDefaultPrice, DomainPrices, DEFAULTS_Sept2025 } from 'domainprices';
+import { getDefaultQuote, DomainPrices, DEFAULT_RATES } from 'domain-quotes';
 
-// Quick price (uses bundled defaults)
-const quote = await getDefaultPrice('com', 'USD', { discountCodes: ['SAVE10'] });
+// Quick quote (uses bundled defaults)
+const quote = await getDefaultQuote('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 dp = new DomainPrices(DEFAULT_RATES); // 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,
+  ...DEFAULT_RATES,
   markup: { type: 'percentage', value: 0.15 },
 });
 const quoteWithMarkup = await withMarkup.getPrice('example.com', 'USD', { discountCodes: ['SAVE10'] });
@@ -45,16 +45,17 @@ const quoteWithMarkup = await withMarkup.getPrice('example.com', 'USD', { discou
 
 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.
+- `getDefaultQuote(extension: string, currency: string, options?: GetPriceOptions): Promise<PriceQuote>`
+  - Computes a quote for a TLD/SLD extension (e.g. `com`, `com.ng`, `.org`) using the bundled defaults.
+  - Alias: `getDefaultPrice(...)` for backward-compatibility.
   - `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`.
+  - `getPrice(extension: string, currency: string, options?: GetPriceOptions): Promise<PriceQuote>` – same behavior as above, but uses the provided config. Alias: `getQuote(...)`.
+  - `DEFAULT_RATES: DomainPricesConfig` – exported snapshot config used by `getDefaultQuote`.
 
 - `listSupportedExtensions(): string[]`
   - All extensions with a non-zero price in the dataset.
@@ -120,7 +121,7 @@ interface DomainPricesConfig {
   restorePrices?: Record<string, number>;
   transferPrices?: Record<string, number>;
   exchangeRates: ExchangeRateData[];           // currency conversion data
-  vatRates: Record<string, number>;            // ISO country code → VAT rate
+  vatRate: number;                             // single VAT rate applied to subtotal
   discounts: Record<string, DiscountConfig>;   // discount code → config
   markup?: PriceMarkup;                        // optional markup applied before conversion
 }
@@ -134,7 +135,7 @@ Errors
 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)`.
+- A single VAT rate is applied to the subtotal by default (7.5% in the default config). Override `vatRate` in the config to change it.
 - 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`

package/dist/index.js

@@ -1 +1 @@
-var k={SAVE1:{rate:.01,extensions:["com","net"],startAt:"2023-01-01T00:00:00Z",endAt:"2025-12-31T23:59:59Z"},NEWUSER15:{rate:.15,extensions:["com","net","org"],startAt:"2023-01-01T00:00:00Z",endAt:"2024-12-31T23:59:59Z"},FALL20:{rate:.2,extensions:["org","info"],startAt:"2024-09-01T00:00:00Z",endAt:"2024-12-01T00:00:00Z"}};var v={US:0,GB:.2,DE:.19,NG:.075};var b={USD:"US",GBP:"GB",EUR:"DE",NGN:"NG"};function se(){return Object.keys(b)}function oe(t){return t!=null&&b.hasOwnProperty(t.toUpperCase())}function ie(){let t=E();return Object.keys(t).sort()}function ce(t){let e=E(),r=O(e,t),n=e[r];return typeof n=="number"&&n>0}function O(t,e){if(!e)return e;let n=e.trim().toLowerCase().replace(/^\.+/,"");if(!n)return"";if(t.hasOwnProperty(n))return n;if(n.includes(".")){let s=n.split(".");for(let i=0;i<s.length;i++){let c=s.slice(i).join(".");if(t.hasOwnProperty(c))return c}return s[s.length-1]}return n}function j(t){return t instanceof Date?t.getTime():typeof t=="number"?t:Date.now()}var F="https://raw.githubusercontent.com/namewiz/registrar-pricelist/refs/heads/main/data/unified-create-prices.csv",L="https://raw.githubusercontent.com/namewiz/registrar-pricelist/refs/heads/main/data/exchange-rates.json";async function Z(t){let e=await fetch(t);if(!e.ok)throw new Error(`Failed to fetch ${t}: ${e.status} ${e.statusText}`);return e.text()}async function B(t){let e=await fetch(t);if(!e.ok)throw new Error(`Failed to fetch ${t}: ${e.status} ${e.statusText}`);return e.json()}function J(t){let e=t.split(/\r?\n/).map(s=>s.trim()).filter(Boolean);if(e.length===0)return{};let r=e.shift(),n={};for(let s of e){let i=s.split(",");if(i.length<3)continue;let c=i[0]?.trim().toLowerCase(),o=i[2]?.trim(),a=Number(o);!c||!Number.isFinite(a)||a<=0||(!(c in n)||a<n[c])&&(n[c]=a)}return n}var[z,Q]=await Promise.all([Z(F).then(J),B(L)]);function E(){return z}function X(){return Q}function H(){return v}function q(){return k}var x=class extends Error{constructor(e,r){super(r),this.name="DomainPricesError",this.code=e}},y=class extends x{constructor(e){super("ERR_UNSUPPORTED_EXTENSION",`Unsupported extension: ${e}`),this.name="UnsupportedExtensionError"}},l=class extends x{constructor(e){super("ERR_UNSUPPORTED_CURRENCY",`Unsupported currency: ${e}`),this.name="UnsupportedCurrencyError"}};function W(){return{countryCode:"US",currencyName:"United States Dollar",currencySymbol:"$",currencyCode:"USD",exchangeRate:1,inverseRate:1}}function p(t){return Math.round(t*100)/100}function Y(t,e){if(!e)return t;let r=typeof e.value=="number"?e.value:0;if(!Number.isFinite(r)||r<=0)return t;switch(e.type){case"percentage":return t+t*r;case"fixedUsd":return t+r;default:return t}}var P=class{constructor(e){this.config=e}findRateInfo(e){if(e==="USD")return W();let r=this.config.exchangeRates.find(n=>n.currencyCode===e);if(!r)throw new l(e);return r}async getPrice(e,r,n={}){let s=this.config.createPrices,i=this.config.vatRates,c=this.config.discounts,o=O(s,e),a=n.transaction||"create",u;switch(a){case"renew":u=this.config.renewPrices?.[o]??s[o];break;case"restore":u=this.config.restorePrices?.[o]??s[o];break;case"transfer":u=this.config.transferPrices?.[o]??s[o];break;case"create":default:u=s[o];break}if(u===void 0||u===0)throw new y(o);let R=(r||"").toUpperCase(),w=b[R];if(!w)throw new l(r);let D=i[w];if(typeof D!="number")throw new l(r);let C=this.findRateInfo(R),_=C.currencySymbol,G=Y(u,this.config.markup),d=p(G*C.exchangeRate),I=Array.from(new Set((n.discountCodes||[]).map(m=>m.toUpperCase()))),T=j(n.now),h=[];for(let m of I){let f=c[m];if(!f)continue;let U=Date.parse(f.startAt),A=Date.parse(f.endAt);Number.isNaN(U)||Number.isNaN(A)||T<U||T>A||f.extensions.includes(o)&&h.push(p(d*f.rate))}let g=0;h.length>0&&(n.discountPolicy==="stack"?g=p(h.reduce((m,f)=>m+f,0)):g=Math.max(...h)),g>d&&(g=d);let S=p(d-g),N=p(S*D),M=p(S+N);return{extension:o,currency:R,basePrice:d,discount:g,tax:N,totalPrice:M,symbol:_,transaction:a}}},K={createPrices:E(),exchangeRates:X(),vatRates:H(),discounts:q()};async function ae(t,e,r={}){return new P(K).getPrice(t,e,r)}export{K as DEFAULTS_Sept2025,P as DomainPrices,l as UnsupportedCurrencyError,y as UnsupportedExtensionError,ae as getDefaultPrice,oe as isSupportedCurrency,ce as isSupportedExtension,se as listSupportedCurrencies,ie as listSupportedExtensions};
+var S={SAVE1:{rate:.01,extensions:["com","net"],startAt:"2023-01-01T00:00:00Z",endAt:"2025-12-31T23:59:59Z"},NEWUSER15:{rate:.15,extensions:["com","net","org"],startAt:"2023-01-01T00:00:00Z",endAt:"2024-12-31T23:59:59Z"},FALL20:{rate:.2,extensions:["org","info"],startAt:"2024-09-01T00:00:00Z",endAt:"2024-12-01T00:00:00Z"}};var U=.075;function I(){return(_.supportedCurrencies??["USD","NGN"]).slice()}function et(e){if(!e)return!1;let t=e.toUpperCase();return I().includes(t)}function nt(){let e=y();return Object.keys(e).sort()}function rt(e){let t=y(),n=A(e),r=t[n];return typeof r=="number"&&r>0}function A(e){return e&&e.trim().toLowerCase().replace(/^\.+/,"")}function $(e){return e instanceof Date?e.getTime():typeof e=="number"?e:Date.now()}var L="https://raw.githubusercontent.com/namewiz/registrar-pricelist/refs/heads/main/data/unified-create-prices.csv",M="https://raw.githubusercontent.com/namewiz/registrar-pricelist/refs/heads/main/data/exchange-rates.json";async function Z(e){let t=await fetch(e);if(!t.ok)throw new Error(`Failed to fetch ${e}: ${t.status} ${t.statusText}`);return t.text()}async function j(e){let t=await fetch(e);if(!t.ok)throw new Error(`Failed to fetch ${e}: ${t.status} ${t.statusText}`);return t.json()}function V(e){let t=e.split(/\r?\n/).map(i=>i.trim()).filter(Boolean);if(t.length===0)return{};let n=t.shift(),r={};for(let i of t){let g=i.split(",");if(g.length<3)continue;let u=g[0]?.trim().toLowerCase(),s=g[2]?.trim(),o=Number(s);!u||!Number.isFinite(o)||o<=0||(!(u in r)||o<r[u])&&(r[u]=o)}return r}var[z,J]=await Promise.all([Z(L).then(V),j(M)]);function y(){return z}function X(){return J}function H(){return S}var h=class extends Error{constructor(t,n){super(n),this.name="DomainPricesError",this.code=t}},R=class extends h{constructor(t){super("ERR_UNSUPPORTED_EXTENSION",`Unsupported extension: ${t}`),this.name="UnsupportedExtensionError"}},P=class extends h{constructor(t){super("ERR_UNSUPPORTED_CURRENCY",`Unsupported currency: ${t}`),this.name="UnsupportedCurrencyError"}};function q(){return{countryCode:"US",currencyName:"United States Dollar",currencySymbol:"$",currencyCode:"USD",exchangeRate:1,inverseRate:1}}function p(e){return Number(e.toFixed(2))}function B(e,t){if(!t)return e;let n=typeof t.value=="number"?t.value:0;if(!Number.isFinite(n)||n<=0)return e;switch(t.type){case"percentage":return e+e*n;case"fixedUsd":return e+n;default:return e}}var E=class{constructor(t){this.config=t}findRateInfo(t){if(t==="USD")return q();let n=this.config.exchangeRates.find(r=>r.currencyCode===t);if(!n)throw new P(t);return n}async getPrice(t,n,r={}){let i=this.config.createPrices,g=typeof this.config.vatRate=="number"?this.config.vatRate:U,u=this.config.discounts,s=A(t),o=r.transaction||"create",c;switch(o){case"renew":c=this.config.renewPrices?.[s]??i[s];break;case"restore":c=this.config.restorePrices?.[s]??i[s];break;case"transfer":c=this.config.transferPrices?.[s]??i[s];break;case"create":default:c=i[s];break}if(c===void 0||c===0)throw new R(s);let x=(n||"").toUpperCase();if(!(this.config.supportedCurrencies??["USD","NGN"]).includes(x))throw new P(n);let D=this.findRateInfo(x),k=D.currencySymbol,v=B(c,this.config.markup),d=p(v*D.exchangeRate),G=g,O=Array.from(new Set((r.discountCodes||[]).map(m=>m.toUpperCase()))),C=$(r.now),l=[];for(let m of O){let a=u[m];if(!a)continue;let w=Date.parse(a.startAt),N=Date.parse(a.endAt);Number.isNaN(w)||Number.isNaN(N)||C<w||C>N||a.extensions.includes(s)&&l.push(p(d*a.rate))}let f=0;l.length>0&&(r.discountPolicy==="stack"?f=p(l.reduce((m,a)=>m+a,0)):f=Math.max(...l)),f>d&&(f=d);let b=p(d-f),T=p(b*G),Q=p(b+T);return{extension:s,currency:x,basePrice:d,discount:f,tax:T,totalPrice:Q,symbol:k,transaction:o}}async getQuote(t,n,r={}){return this.getPrice(t,n,r)}},_={createPrices:y(),exchangeRates:X(),vatRate:U,discounts:H(),supportedCurrencies:["USD","NGN"]};async function W(e,t,n={}){return new E(_).getPrice(e,t,n)}async function st(e,t,n={}){return W(e,t,n)}export{_ as DEFAULT_CONFIG,U as DEFAULT_VAT_RATE,E as DomainPrices,E as DomainQuote,P as UnsupportedCurrencyError,R as UnsupportedExtensionError,W as getDefaultPrice,st as getDefaultQuote,et as isSupportedCurrency,rt as isSupportedExtension,I as listSupportedCurrencies,nt as listSupportedExtensions};

package/package.json

@@ -1,29 +1,32 @@
 {
   "name": "domain-quotes",
-  "version": "0.0.11",
-  "description": "Fast multi-currency domain price checker library across registrars.",
+  "version": "0.1.0",
+  "description": "Fast multi-currency domain quote 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",
+    "postbuild": "cp dist/index.js docs/domain-quotes.js",
     "test": "npm run build && node --test",
-    "start": "npm run build && cp dist/index.js docs/domainprices.js && npx serve docs"
+    "start": "npm run build && cp dist/index.js docs/domain-quotes.js && npx serve docs"
   },
-  "homepage": "https://namewiz.github.io/domainprices",
+  "homepage": "https://namewiz.github.io/domain-quotes",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/namewiz/domainprices.git"
+    "url": "git+https://github.com/namewiz/domain-quotes.git"
   },
   "bugs": {
-    "url": "https://github.com/namewiz/domainprices/issues"
+    "url": "https://github.com/namewiz/domain-quotes/issues"
   },
   "author": "Justice Ogbonna <dev@justiceo.com>",
   "keywords": [
     "domain-name",
+    "domain-quotes",
     "domain-price",
     "domain-availability",
-    "price-check"
+    "price-check",
+    "quote",
+    "quote-check"
   ],
   "exports": {
     ".": "./dist/index.js"