@utilix-tech/sdk 0.21.0 → 0.23.0

package/dist/{units-pIRkHnsU.d.ts → units-h4rHQGp5.d.ts}

@@ -21,6 +21,10 @@
  *  - isbn-validator : validateIsbn
  *  - tip-calculator : calculateTipSplit
  *  - simple-interest-calculator : calculateSimpleInterest
+ *  - present-value-calculator : calculateTimeValue
+ *  - percentage-change-calculator : calculatePercentageChange
+ *  - apr-apy-converter : convertAprApy
+ *  - margin-markup-calculator : calculateMarginMarkup, marginToMarkup, markupToMargin
  */
 interface PxConvertResult {
     px: number;
@@ -448,8 +452,69 @@ interface PercentageChangeResult {
 declare function calculatePercentageChange(oldValue: number, newValue: number): PercentageChangeResult | {
     error: string;
 };
+type AprApyDirection = "apr-to-apy" | "apy-to-apr";
+interface AprApyResult {
+    direction: AprApyDirection;
+    compoundsPerYear: number;
+    apr: number;
+    apy: number;
+    aprDecimal: number;
+    apyDecimal: number;
+    difference: number;
+}
+/**
+ * Convert between a nominal annual rate (APR) and the effective annual yield
+ * (APY) for a given compounding frequency. With direction "apr-to-apy" the
+ * input rate is treated as the nominal APR and the effective APY is computed
+ * as (1 + apr/n)^n - 1; with "apy-to-apr" the input is the effective APY and
+ * the nominal APR is recovered as n * ((1 + apy)^(1/n) - 1). Both rates are
+ * percentages, `difference` is apy - apr in percentage points, and n is the
+ * number of compounding periods per year. Pure closed-form formula, no live
+ * rate feed.
+ */
+declare function convertAprApy(rate: number, compoundsPerYear: number, direction: AprApyDirection): AprApyResult | {
+    error: string;
+};
+type MarginMarkupField = "cost" | "price" | "marginPercent" | "markupPercent";
+interface MarginMarkupInput {
+    cost?: number | null;
+    price?: number | null;
+    marginPercent?: number | null;
+    markupPercent?: number | null;
+}
+interface MarginMarkupResult {
+    cost: number;
+    price: number;
+    profit: number;
+    marginPercent: number;
+    markupPercent: number;
+    given: MarginMarkupField[];
+    solvedFor: MarginMarkupField[];
+}
+/**
+ * Solve a pricing triangle: given exactly two of cost, price, gross margin
+ * percent, and markup percent, derive the other two. Margin is profit as a
+ * share of the selling price (profit / price) while markup is profit as a
+ * share of the cost (profit / cost), so a 20% margin is the same deal as a
+ * 25% markup — conflating them is the classic mistake this exists to avoid.
+ * Margin plus markup alone cannot be solved, since neither carries an
+ * absolute amount. Pure closed-form arithmetic, no live price feed.
+ */
+declare function calculateMarginMarkup(input: MarginMarkupInput): MarginMarkupResult | {
+    error: string;
+};
+/** Markup percent that produces a given gross margin percent (margin < 100). */
+declare function marginToMarkup(marginPercent: number): number | {
+    error: string;
+};
+/** Gross margin percent that results from a given markup percent (markup > -100). */
+declare function markupToMargin(markupPercent: number): number | {
+    error: string;
+};
 
 type units_AmortizationRow = AmortizationRow;
+type units_AprApyDirection = AprApyDirection;
+type units_AprApyResult = AprApyResult;
 type units_AspectRatioResult = AspectRatioResult;
 declare const units_BASE_LABELS: typeof BASE_LABELS;
 declare const units_BASE_PREFIXES: typeof BASE_PREFIXES;
@@ -478,6 +543,9 @@ type units_IpConversion = IpConversion;
 type units_IsbnFormat = IsbnFormat;
 type units_IsbnResult = IsbnResult;
 type units_LoanResult = LoanResult;
+type units_MarginMarkupField = MarginMarkupField;
+type units_MarginMarkupInput = MarginMarkupInput;
+type units_MarginMarkupResult = MarginMarkupResult;
 type units_NotationStyle = NotationStyle;
 type units_NumberBase = NumberBase;
 type units_PercentChangeDirection = PercentChangeDirection;
@@ -499,6 +567,7 @@ declare const units_calcAspectRatio: typeof calcAspectRatio;
 declare const units_calcSubnet: typeof calcSubnet;
 declare const units_calculateCompoundInterest: typeof calculateCompoundInterest;
 declare const units_calculateLoan: typeof calculateLoan;
+declare const units_calculateMarginMarkup: typeof calculateMarginMarkup;
 declare const units_calculatePercentageChange: typeof calculatePercentageChange;
 declare const units_calculateSimpleInterest: typeof calculateSimpleInterest;
 declare const units_calculateTax: typeof calculateTax;
@@ -506,6 +575,7 @@ declare const units_calculateTimeValue: typeof calculateTimeValue;
 declare const units_calculateTipSplit: typeof calculateTipSplit;
 declare const units_compareSemver: typeof compareSemver;
 declare const units_convert: typeof convert;
+declare const units_convertAprApy: typeof convertAprApy;
 declare const units_convertBytes: typeof convertBytes;
 declare const units_convertIp: typeof convertIp;
 declare const units_coverBox: typeof coverBox;
@@ -530,6 +600,8 @@ declare const units_isValid: typeof isValid;
 declare const units_isValidCidr: typeof isValidCidr;
 declare const units_isValidIp: typeof isValidIp;
 declare const units_isValidIpv4: typeof isValidIpv4;
+declare const units_marginToMarkup: typeof marginToMarkup;
+declare const units_markupToMargin: typeof markupToMargin;
 declare const units_octalToPermissions: typeof octalToPermissions;
 declare const units_parseFileSize: typeof parseFileSize;
 declare const units_parseInput: typeof parseInput;
@@ -554,7 +626,7 @@ declare const units_validateIban: typeof validateIban;
 declare const units_validateIsbn: typeof validateIsbn;
 declare const units_viewportToPx: typeof viewportToPx;
 declare namespace units {
-  export { type units_AmortizationRow as AmortizationRow, type units_AspectRatioResult as AspectRatioResult, units_BASE_LABELS as BASE_LABELS, units_BASE_PREFIXES as BASE_PREFIXES, units_BYTE_UNITS as BYTE_UNITS, type units_BarcodeFormat as BarcodeFormat, type units_BarcodeValidationResult as BarcodeValidationResult, type units_BaseConvertResult as BaseConvertResult, type units_ByteConvertResult as ByteConvertResult, type units_ByteUnit as ByteUnit, units_COMMON_CURRENCIES as COMMON_CURRENCIES, units_COMMON_LOCALES as COMMON_LOCALES, units_COMMON_PERMISSIONS as COMMON_PERMISSIONS, units_COMMON_RATIOS as COMMON_RATIOS, units_COMMON_SIZES as COMMON_SIZES, units_COMMON_TAX_RATES as COMMON_TAX_RATES, units_COMMON_TIP_PERCENTAGES as COMMON_TIP_PERCENTAGES, units_COMMON_VIEWPORTS as COMMON_VIEWPORTS, type units_CardValidationResult as CardValidationResult, type units_CompoundInterestResult as CompoundInterestResult, type units_CompoundYearRow as CompoundYearRow, type units_Dimensions as Dimensions, type units_FilePermissions as FilePermissions, type units_FormatOptions as FormatOptions, type units_IbanValidationResult as IbanValidationResult, type units_IpConversion as IpConversion, type units_IsbnFormat as IsbnFormat, type units_IsbnResult as IsbnResult, type units_LoanResult as LoanResult, type units_NotationStyle as NotationStyle, type units_NumberBase as NumberBase, type units_PercentChangeDirection as PercentChangeDirection, type units_PercentageChangeResult as PercentageChangeResult, type units_Permission as Permission, type units_PxConvertResult as PxConvertResult, type units_SemverVersion as SemverVersion, type units_SimpleInterestResult as SimpleInterestResult, type units_SubnetInfo as SubnetInfo, type units_TaxDirection as TaxDirection, type units_TaxResult as TaxResult, type units_TimeValueDirection as TimeValueDirection, type units_TimeValueResult as TimeValueResult, type units_TipSplitResult as TipSplitResult, type units_ViewportConvertResult as ViewportConvertResult, units_autoFormat as autoFormat, units_bumpVersion as bumpVersion, units_calcAspectRatio as calcAspectRatio, units_calcSubnet as calcSubnet, units_calculateCompoundInterest as calculateCompoundInterest, units_calculateLoan as calculateLoan, units_calculatePercentageChange as calculatePercentageChange, units_calculateSimpleInterest as calculateSimpleInterest, units_calculateTax as calculateTax, units_calculateTimeValue as calculateTimeValue, units_calculateTipSplit as calculateTipSplit, units_compareSemver as compareSemver, units_convert as convert, units_convertBytes as convertBytes, units_convertIp as convertIp, units_coverBox as coverBox, units_decimalToIp as decimalToIp, units_decimalToIpCidr as decimalToIpCidr, units_describePermissions as describePermissions, units_fitIntoBox as fitIntoBox, units_formatNumber as formatNumber, units_formatValue as formatValue, units_formatVwValue as formatVwValue, units_formatWithSeparator as formatWithSeparator, units_gcd as gcd, units_ipFromBinary as ipFromBinary, units_ipFromDecimal as ipFromDecimal, units_ipFromHex as ipFromHex, units_ipToBinary as ipToBinary, units_ipToDecimal as ipToDecimal, units_ipToDecimalCidr as ipToDecimalCidr, units_ipToHex as ipToHex, units_ipToOctal as ipToOctal, units_isValid as isValid, units_isValidCidr as isValidCidr, units_isValidIp as isValidIp, units_isValidIpv4 as isValidIpv4, units_octalToPermissions as octalToPermissions, units_parseFileSize as parseFileSize, units_parseInput as parseInput, units_parseNumberString as parseNumberString, units_parseSemver as parseSemver, units_permissionsToChmod as permissionsToChmod, units_permissionsToOctal as permissionsToOctal, units_permissionsToSymbolic as permissionsToSymbolic, units_ptToPx as ptToPx, units_pxToAll as pxToAll, units_pxToViewport as pxToViewport, units_remToPx as remToPx, units_satisfiesRange as satisfiesRange, units_scaleByHeight as scaleByHeight, units_scaleByWidth as scaleByWidth, units_sortVersions as sortVersions, units_splitSubnet as splitSubnet, units_symbolicToPermissions as symbolicToPermissions, units_validateBarcode as validateBarcode, units_validateCardNumber as validateCardNumber, units_validateIban as validateIban, units_validateIsbn as validateIsbn, units_viewportToPx as viewportToPx };
+  export { type units_AmortizationRow as AmortizationRow, type units_AprApyDirection as AprApyDirection, type units_AprApyResult as AprApyResult, type units_AspectRatioResult as AspectRatioResult, units_BASE_LABELS as BASE_LABELS, units_BASE_PREFIXES as BASE_PREFIXES, units_BYTE_UNITS as BYTE_UNITS, type units_BarcodeFormat as BarcodeFormat, type units_BarcodeValidationResult as BarcodeValidationResult, type units_BaseConvertResult as BaseConvertResult, type units_ByteConvertResult as ByteConvertResult, type units_ByteUnit as ByteUnit, units_COMMON_CURRENCIES as COMMON_CURRENCIES, units_COMMON_LOCALES as COMMON_LOCALES, units_COMMON_PERMISSIONS as COMMON_PERMISSIONS, units_COMMON_RATIOS as COMMON_RATIOS, units_COMMON_SIZES as COMMON_SIZES, units_COMMON_TAX_RATES as COMMON_TAX_RATES, units_COMMON_TIP_PERCENTAGES as COMMON_TIP_PERCENTAGES, units_COMMON_VIEWPORTS as COMMON_VIEWPORTS, type units_CardValidationResult as CardValidationResult, type units_CompoundInterestResult as CompoundInterestResult, type units_CompoundYearRow as CompoundYearRow, type units_Dimensions as Dimensions, type units_FilePermissions as FilePermissions, type units_FormatOptions as FormatOptions, type units_IbanValidationResult as IbanValidationResult, type units_IpConversion as IpConversion, type units_IsbnFormat as IsbnFormat, type units_IsbnResult as IsbnResult, type units_LoanResult as LoanResult, type units_MarginMarkupField as MarginMarkupField, type units_MarginMarkupInput as MarginMarkupInput, type units_MarginMarkupResult as MarginMarkupResult, type units_NotationStyle as NotationStyle, type units_NumberBase as NumberBase, type units_PercentChangeDirection as PercentChangeDirection, type units_PercentageChangeResult as PercentageChangeResult, type units_Permission as Permission, type units_PxConvertResult as PxConvertResult, type units_SemverVersion as SemverVersion, type units_SimpleInterestResult as SimpleInterestResult, type units_SubnetInfo as SubnetInfo, type units_TaxDirection as TaxDirection, type units_TaxResult as TaxResult, type units_TimeValueDirection as TimeValueDirection, type units_TimeValueResult as TimeValueResult, type units_TipSplitResult as TipSplitResult, type units_ViewportConvertResult as ViewportConvertResult, units_autoFormat as autoFormat, units_bumpVersion as bumpVersion, units_calcAspectRatio as calcAspectRatio, units_calcSubnet as calcSubnet, units_calculateCompoundInterest as calculateCompoundInterest, units_calculateLoan as calculateLoan, units_calculateMarginMarkup as calculateMarginMarkup, units_calculatePercentageChange as calculatePercentageChange, units_calculateSimpleInterest as calculateSimpleInterest, units_calculateTax as calculateTax, units_calculateTimeValue as calculateTimeValue, units_calculateTipSplit as calculateTipSplit, units_compareSemver as compareSemver, units_convert as convert, units_convertAprApy as convertAprApy, units_convertBytes as convertBytes, units_convertIp as convertIp, units_coverBox as coverBox, units_decimalToIp as decimalToIp, units_decimalToIpCidr as decimalToIpCidr, units_describePermissions as describePermissions, units_fitIntoBox as fitIntoBox, units_formatNumber as formatNumber, units_formatValue as formatValue, units_formatVwValue as formatVwValue, units_formatWithSeparator as formatWithSeparator, units_gcd as gcd, units_ipFromBinary as ipFromBinary, units_ipFromDecimal as ipFromDecimal, units_ipFromHex as ipFromHex, units_ipToBinary as ipToBinary, units_ipToDecimal as ipToDecimal, units_ipToDecimalCidr as ipToDecimalCidr, units_ipToHex as ipToHex, units_ipToOctal as ipToOctal, units_isValid as isValid, units_isValidCidr as isValidCidr, units_isValidIp as isValidIp, units_isValidIpv4 as isValidIpv4, units_marginToMarkup as marginToMarkup, units_markupToMargin as markupToMargin, units_octalToPermissions as octalToPermissions, units_parseFileSize as parseFileSize, units_parseInput as parseInput, units_parseNumberString as parseNumberString, units_parseSemver as parseSemver, units_permissionsToChmod as permissionsToChmod, units_permissionsToOctal as permissionsToOctal, units_permissionsToSymbolic as permissionsToSymbolic, units_ptToPx as ptToPx, units_pxToAll as pxToAll, units_pxToViewport as pxToViewport, units_remToPx as remToPx, units_satisfiesRange as satisfiesRange, units_scaleByHeight as scaleByHeight, units_scaleByWidth as scaleByWidth, units_sortVersions as sortVersions, units_splitSubnet as splitSubnet, units_symbolicToPermissions as symbolicToPermissions, units_validateBarcode as validateBarcode, units_validateCardNumber as validateCardNumber, units_validateIban as validateIban, units_validateIsbn as validateIsbn, units_viewportToPx as viewportToPx };
 }
 
-export { calculateTax as $, type AmortizationRow as A, BASE_LABELS as B, COMMON_CURRENCIES as C, type Dimensions as D, type PxConvertResult as E, type FilePermissions as F, type SimpleInterestResult as G, type SubnetInfo as H, type IbanValidationResult as I, type TaxResult as J, type TimeValueDirection as K, type LoanResult as L, type TimeValueResult as M, type NotationStyle as N, type TipSplitResult as O, type PercentChangeDirection as P, autoFormat as Q, bumpVersion as R, type SemverVersion as S, type TaxDirection as T, calcAspectRatio as U, type ViewportConvertResult as V, calcSubnet as W, calculateCompoundInterest as X, calculateLoan as Y, calculatePercentageChange as Z, calculateSimpleInterest as _, type AspectRatioResult as a, calculateTimeValue as a0, calculateTipSplit as a1, compareSemver as a2, convert as a3, convertBytes as a4, convertIp as a5, coverBox as a6, decimalToIp as a7, decimalToIpCidr as a8, describePermissions as a9, ptToPx as aA, pxToAll as aB, pxToViewport as aC, remToPx as aD, satisfiesRange as aE, scaleByHeight as aF, scaleByWidth as aG, sortVersions as aH, splitSubnet as aI, symbolicToPermissions as aJ, validateBarcode as aK, validateCardNumber as aL, validateIban as aM, validateIsbn as aN, viewportToPx as aO, fitIntoBox as aa, formatNumber as ab, formatValue as ac, formatVwValue as ad, formatWithSeparator as ae, gcd as af, ipFromBinary as ag, ipFromDecimal as ah, ipFromHex as ai, ipToBinary as aj, ipToDecimal as ak, ipToDecimalCidr as al, ipToHex as am, ipToOctal as an, isValid as ao, isValidCidr as ap, isValidIp as aq, isValidIpv4 as ar, octalToPermissions as as, parseFileSize as at, parseInput as au, parseNumberString as av, parseSemver as aw, permissionsToChmod as ax, permissionsToOctal as ay, permissionsToSymbolic as az, BASE_PREFIXES as b, BYTE_UNITS as c, type BarcodeFormat as d, type BarcodeValidationResult as e, type BaseConvertResult as f, type ByteConvertResult as g, type ByteUnit as h, COMMON_LOCALES as i, COMMON_PERMISSIONS as j, COMMON_RATIOS as k, COMMON_SIZES as l, COMMON_TAX_RATES as m, COMMON_TIP_PERCENTAGES as n, COMMON_VIEWPORTS as o, type CardValidationResult as p, type CompoundInterestResult as q, type CompoundYearRow as r, type FormatOptions as s, type IpConversion as t, units as u, type IsbnFormat as v, type IsbnResult as w, type NumberBase as x, type PercentageChangeResult as y, type Permission as z };
+export { calcSubnet as $, type AmortizationRow as A, BASE_LABELS as B, COMMON_CURRENCIES as C, type Dimensions as D, type MarginMarkupResult as E, type FilePermissions as F, type NumberBase as G, type PercentageChangeResult as H, type IbanValidationResult as I, type Permission as J, type PxConvertResult as K, type LoanResult as L, type MarginMarkupField as M, type NotationStyle as N, type SimpleInterestResult as O, type PercentChangeDirection as P, type SubnetInfo as Q, type TaxResult as R, type SemverVersion as S, type TaxDirection as T, type TimeValueDirection as U, type TimeValueResult as V, type TipSplitResult as W, type ViewportConvertResult as X, autoFormat as Y, bumpVersion as Z, calcAspectRatio as _, type AprApyDirection as a, calculateCompoundInterest as a0, calculateLoan as a1, calculateMarginMarkup as a2, calculatePercentageChange as a3, calculateSimpleInterest as a4, calculateTax as a5, calculateTimeValue as a6, calculateTipSplit as a7, compareSemver as a8, convert as a9, markupToMargin as aA, octalToPermissions as aB, parseFileSize as aC, parseInput as aD, parseNumberString as aE, parseSemver as aF, permissionsToChmod as aG, permissionsToOctal as aH, permissionsToSymbolic as aI, ptToPx as aJ, pxToAll as aK, pxToViewport as aL, remToPx as aM, satisfiesRange as aN, scaleByHeight as aO, scaleByWidth as aP, sortVersions as aQ, splitSubnet as aR, symbolicToPermissions as aS, validateBarcode as aT, validateCardNumber as aU, validateIban as aV, validateIsbn as aW, viewportToPx as aX, convertAprApy as aa, convertBytes as ab, convertIp as ac, coverBox as ad, decimalToIp as ae, decimalToIpCidr as af, describePermissions as ag, fitIntoBox as ah, formatNumber as ai, formatValue as aj, formatVwValue as ak, formatWithSeparator as al, gcd as am, ipFromBinary as an, ipFromDecimal as ao, ipFromHex as ap, ipToBinary as aq, ipToDecimal as ar, ipToDecimalCidr as as, ipToHex as at, ipToOctal as au, isValid as av, isValidCidr as aw, isValidIp as ax, isValidIpv4 as ay, marginToMarkup as az, type AprApyResult as b, type AspectRatioResult as c, BASE_PREFIXES as d, BYTE_UNITS as e, type BarcodeFormat as f, type BarcodeValidationResult as g, type BaseConvertResult as h, type ByteConvertResult as i, type ByteUnit as j, COMMON_LOCALES as k, COMMON_PERMISSIONS as l, COMMON_RATIOS as m, COMMON_SIZES as n, COMMON_TAX_RATES as o, COMMON_TIP_PERCENTAGES as p, COMMON_VIEWPORTS as q, type CardValidationResult as r, type CompoundInterestResult as s, type CompoundYearRow as t, units as u, type FormatOptions as v, type IpConversion as w, type IsbnFormat as x, type IsbnResult as y, type MarginMarkupInput as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@utilix-tech/sdk",
-  "version": "0.21.0",
+  "version": "0.23.0",
   "description": "154+ developer utility tools for Node.js: JSON, encoding, hashing, color, CSS, network and more. Runs locally, no API key required.",
   "author": "Utilix <hello@utilix.tech>",
   "license": "MIT",