domain-quotes 0.0.10 → 0.0.20

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.

package/dist/index.js

@@ -0,0 +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};

package/package.json

@@ -1,29 +1,32 @@
 {
   "name": "domain-quotes",
-  "version": "0.0.10",
-  "description": "Fast multi-currency domain price checker library across registrars.",
+  "version": "0.0.20",
+  "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"

package/todo.txt

@@ -1,5 +0,0 @@
-
-    "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",