domain-quotes 0.0.20 → 0.2.0

package/README.md

@@ -25,37 +25,37 @@ npm i domain-quotes
 Usage
 
 ```ts
-import { getDefaultQuote, DomainPrices, DEFAULT_RATES } from 'domain-quotes';
+import { getDefaultQuote, DomainQuotes, DEFAULT_CONFIG } from 'domain-quotes';
 
 // 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(DEFAULT_RATES); // or provide your own DomainPricesConfig
-const eur = await dp.getPrice('example.com', 'EUR', { discountPolicy: 'stack' });
+const dq = new DomainQuotes(DEFAULT_CONFIG); // or provide your own DomainQuoteConfig
+const eur = await dq.getQuote('example.com', 'EUR', { discountPolicy: 'stack' });
 
 // Add a 15% markup before discounts/taxes
-const withMarkup = new DomainPrices({
-  ...DEFAULT_RATES,
+const withMarkup = new DomainQuotes({
+  ...DEFAULT_CONFIG,
   markup: { type: 'percentage', value: 0.15 },
 });
-const quoteWithMarkup = await withMarkup.getPrice('example.com', 'USD', { discountCodes: ['SAVE10'] });
+const quoteWithMarkup = await withMarkup.getQuote('example.com', 'USD', { discountCodes: ['SAVE10'] });
+
 ```
 
 API
 
-- `getDefaultQuote(extension: string, currency: string, options?: GetPriceOptions): Promise<PriceQuote>`
+- `getDefaultQuote(extension: string, currency: string, options?: GetQuoteOptions): Promise<Quote>`
   - 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. Alias: `getQuote(...)`.
-  - `DEFAULT_RATES: DomainPricesConfig` – exported snapshot config used by `getDefaultQuote`.
+- `class DomainQuotes(config: DomainQuoteConfig)`
+  - `getQuote(extension: string, currency: string, options?: GetQuoteOptions): Promise<Quote>` – same behavior as above, but uses the provided config.
+  - `DEFAULT_CONFIG: DomainQuoteConfig` – exported snapshot config used by `getDefaultQuote`.
 
 - `listSupportedExtensions(): string[]`
   - All extensions with a non-zero price in the dataset.
@@ -73,21 +73,21 @@ Types
 ```ts
 type DiscountPolicy = 'stack' | 'max';
 
-interface GetPriceOptions {
+interface GetQuoteOptions {
   discountCodes?: string[];
   now?: number | Date;
   discountPolicy?: DiscountPolicy;
   transaction?: 'create' | 'renew' | 'restore' | 'transfer'; // default 'create'
 }
 
-type MarkupType = 'percentage' | 'fixed_usd';
+type MarkupType = 'percentage' | 'fixedUsd';
 
-interface PriceMarkup {
-  type: MarkupType;            // percentage -> 0.2 === +20%, fixed_usd -> +$ value before conversion
+interface Markup {
+  type: MarkupType;            // percentage -> 0.2 === +20%, fixedUsd -> +$ value before conversion
   value: number;
 }
 
-interface PriceQuote {
+interface Quote {
   extension: string;
   currency: string;
   basePrice: number;
@@ -114,16 +114,16 @@ interface DiscountConfig {
   endAt: string;   // ISO timestamp
 }
 
-interface DomainPricesConfig {
+interface DomainQuoteConfig {
   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
+  vatRate: number;                             // single VAT rate applied to subtotal
   discounts: Record<string, DiscountConfig>;   // discount code → config
-  markup?: PriceMarkup;                        // optional markup applied before conversion
+  markup?: Markup;                             // optional markup applied before conversion
 }
 ```
 
@@ -135,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 ie(){return Object.keys(b)}function oe(t){return t!=null&&b.hasOwnProperty(t.toUpperCase())}function ce(){let t=E();return Object.keys(t).sort()}function ae(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 o=0;o<s.length;o++){let c=s.slice(o).join(".");if(t.hasOwnProperty(c))return c}return s[s.length-1]}return n}function V(t){return t instanceof Date?t.getTime():typeof t=="number"?t:Date.now()}var j="https://raw.githubusercontent.com/namewiz/registrar-pricelist/refs/heads/main/data/unified-create-prices.csv",F="https://raw.githubusercontent.com/namewiz/registrar-pricelist/refs/heads/main/data/exchange-rates.json";async function L(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 Z(t){let e=await fetch(t);if(!e.ok)throw new Error(`Failed to fetch ${t}: ${e.status} ${e.statusText}`);return e.json()}function B(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 o=s.split(",");if(o.length<3)continue;let c=o[0]?.trim().toLowerCase(),i=o[2]?.trim(),a=Number(i);!c||!Number.isFinite(a)||a<=0||(!(c in n)||a<n[c])&&(n[c]=a)}return n}var[J,z]=await Promise.all([L(j).then(B),Z(F)]);function E(){return J}function X(){return z}function H(){return v}function q(){return k}var h=class extends Error{constructor(e,r){super(r),this.name="DomainPricesError",this.code=e}},P=class extends h{constructor(e){super("ERR_UNSUPPORTED_EXTENSION",`Unsupported extension: ${e}`),this.name="UnsupportedExtensionError"}},l=class extends h{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 y=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,o=this.config.vatRates,c=this.config.discounts,i=O(s,e),a=n.transaction||"create",u;switch(a){case"renew":u=this.config.renewPrices?.[i]??s[i];break;case"restore":u=this.config.restorePrices?.[i]??s[i];break;case"transfer":u=this.config.transferPrices?.[i]??s[i];break;case"create":default:u=s[i];break}if(u===void 0||u===0)throw new P(i);let R=(r||"").toUpperCase(),w=b[R];if(!w)throw new l(r);let D=o[w];if(typeof D!="number")throw new l(r);let T=this.findRateInfo(R),G=T.currencySymbol,_=Y(u,this.config.markup),d=p(_*T.exchangeRate),Q=Array.from(new Set((n.discountCodes||[]).map(m=>m.toUpperCase()))),C=V(n.now),x=[];for(let m of Q){let f=c[m];if(!f)continue;let U=Date.parse(f.startAt),A=Date.parse(f.endAt);Number.isNaN(U)||Number.isNaN(A)||C<U||C>A||f.extensions.includes(i)&&x.push(p(d*f.rate))}let g=0;x.length>0&&(n.discountPolicy==="stack"?g=p(x.reduce((m,f)=>m+f,0)):g=Math.max(...x)),g>d&&(g=d);let S=p(d-g),N=p(S*D),I=p(S+N);return{extension:i,currency:R,basePrice:d,discount:g,tax:N,totalPrice:I,symbol:G,transaction:a}}async getQuote(e,r,n={}){return this.getPrice(e,r,n)}},K={createPrices:E(),exchangeRates:X(),vatRates:H(),discounts:q()};async function ee(t,e,r={}){return new y(K).getPrice(t,e,r)}async function ue(t,e,r={}){return ee(t,e,r)}export{K as DEFAULT_RATES,y as DomainPrices,y as DomainQuote,l as UnsupportedCurrencyError,P as UnsupportedExtensionError,ee as getDefaultPrice,ue as getDefaultQuote,oe as isSupportedCurrency,ae as isSupportedExtension,ie as listSupportedCurrencies,ce as listSupportedExtensions};
+var P={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 O(){return(Q.supportedCurrencies??["USD","NGN"]).slice()}function tt(e){if(!e)return!1;let t=e.toUpperCase();return O().includes(t)}function et(){let e=y();return Object.keys(e).sort()}function nt(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(o=>o.trim()).filter(Boolean);if(t.length===0)return{};let n=t.shift(),r={};for(let o of t){let g=o.split(",");if(g.length<3)continue;let u=g[0]?.trim().toLowerCase(),s=g[2]?.trim(),i=Number(s);!u||!Number.isFinite(i)||i<=0||(!(u in r)||i<r[u])&&(r[u]=i)}return r}var[q,z]=await Promise.all([Z(L).then(V),j(M)]);function y(){return q}function J(){return z}function X(){return P}var h=class extends Error{constructor(t,n){super(n),this.name="DomainQuoteError",this.code=t}},E=class extends h{constructor(t){super("ERR_UNSUPPORTED_EXTENSION",`Unsupported extension: ${t}`),this.name="UnsupportedExtensionError"}},x=class extends h{constructor(t){super("ERR_UNSUPPORTED_CURRENCY",`Unsupported currency: ${t}`),this.name="UnsupportedCurrencyError"}};function H(){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 C=class{constructor(t){this.config=t}findRateInfo(t){if(t==="USD")return H();let n=this.config.exchangeRates.find(r=>r.currencyCode===t);if(!n)throw new x(t);return n}async getQuote(t,n,r={}){let o=this.config.createPrices,g=typeof this.config.vatRate=="number"?this.config.vatRate:U,u=this.config.discounts,s=A(t),i=r.transaction||"create",c;switch(i){case"renew":c=this.config.renewPrices?.[s]??o[s];break;case"restore":c=this.config.restorePrices?.[s]??o[s];break;case"transfer":c=this.config.transferPrices?.[s]??o[s];break;case"create":default:c=o[s];break}if(c===void 0||c===0)throw new E(s);let R=(n||"").toUpperCase();if(!(this.config.supportedCurrencies??["USD","NGN"]).includes(R))throw new x(n);let D=this.findRateInfo(R),_=D.currencySymbol,k=B(c,this.config.markup),d=p(k*D.exchangeRate),v=g,F=Array.from(new Set((r.discountCodes||[]).map(m=>m.toUpperCase()))),b=$(r.now),l=[];for(let m of F){let a=u[m];if(!a)continue;let N=Date.parse(a.startAt),S=Date.parse(a.endAt);Number.isNaN(N)||Number.isNaN(S)||b<N||b>S||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 T=p(d-f),w=p(T*v),G=p(T+w);return{extension:s,currency:R,basePrice:d,discount:f,tax:w,totalPrice:G,symbol:_,transaction:i}}},Q={createPrices:y(),exchangeRates:J(),vatRate:U,discounts:X(),supportedCurrencies:["USD","NGN"]};async function rt(e,t,n={}){return new C(Q).getQuote(e,t,n)}export{Q as DEFAULT_CONFIG,U as DEFAULT_VAT_RATE,C as DomainQuotes,x as UnsupportedCurrencyError,E as UnsupportedExtensionError,rt as getDefaultQuote,tt as isSupportedCurrency,nt as isSupportedExtension,O as listSupportedCurrencies,et as listSupportedExtensions};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "domain-quotes",
-  "version": "0.0.20",
+  "version": "0.2.0",
   "description": "Fast multi-currency domain quote checker library across registrars.",
   "type": "module",
   "main": "./dist/index.js",