@utilix-tech/sdk 0.22.0 → 0.24.0

package/dist/{units-KrjRyu0w.d.ts → units-DAoSM2g8.d.ts}

@@ -24,6 +24,8 @@
  *  - present-value-calculator : calculateTimeValue
  *  - percentage-change-calculator : calculatePercentageChange
  *  - apr-apy-converter : convertAprApy
+ *  - margin-markup-calculator : calculateMarginMarkup, marginToMarkup, markupToMargin
+ *  - discount-calculator : calculateDiscount, applySuccessiveDiscounts
  */
 interface PxConvertResult {
     px: number;
@@ -474,6 +476,90 @@ interface AprApyResult {
 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 DiscountField = "discountPercent" | "discountAmount" | "finalPrice";
+interface DiscountInput {
+    originalPrice?: number | null;
+    discountPercent?: number | null;
+    discountAmount?: number | null;
+    finalPrice?: number | null;
+}
+interface DiscountResult {
+    originalPrice: number;
+    finalPrice: number;
+    discountAmount: number;
+    discountPercent: number;
+    given: DiscountField;
+    solvedFor: DiscountField[];
+}
+interface SuccessiveDiscountStep {
+    discountPercent: number;
+    priceBefore: number;
+    priceAfter: number;
+    saved: number;
+}
+interface SuccessiveDiscountResult {
+    originalPrice: number;
+    finalPrice: number;
+    totalSaved: number;
+    effectiveDiscountPercent: number;
+    sumOfDiscountPercents: number;
+    steps: SuccessiveDiscountStep[];
+}
+/**
+ * Supply the original price plus exactly one of discountPercent,
+ * discountAmount, or finalPrice; the other two are derived. A discount cannot
+ * exceed the original price, so a final price above the original or a percent
+ * above 100 is rejected rather than silently returning a negative amount.
+ * Pure arithmetic over user-supplied numbers, no live price feed.
+ */
+declare function calculateDiscount(input: DiscountInput): DiscountResult | {
+    error: string;
+};
+/**
+ * Apply discounts one after another, each off the running price. Stacked
+ * discounts never simply add up: 20% then 10% leaves 72% of the original, an
+ * effective 28% discount, not 30%. Returns each step plus the effective single
+ * discount that would produce the same final price.
+ */
+declare function applySuccessiveDiscounts(originalPrice: number, discountPercents: number[]): SuccessiveDiscountResult | {
+    error: string;
+};
 
 type units_AmortizationRow = AmortizationRow;
 type units_AprApyDirection = AprApyDirection;
@@ -499,6 +585,9 @@ type units_CardValidationResult = CardValidationResult;
 type units_CompoundInterestResult = CompoundInterestResult;
 type units_CompoundYearRow = CompoundYearRow;
 type units_Dimensions = Dimensions;
+type units_DiscountField = DiscountField;
+type units_DiscountInput = DiscountInput;
+type units_DiscountResult = DiscountResult;
 type units_FilePermissions = FilePermissions;
 type units_FormatOptions = FormatOptions;
 type units_IbanValidationResult = IbanValidationResult;
@@ -506,6 +595,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;
@@ -515,18 +607,23 @@ type units_PxConvertResult = PxConvertResult;
 type units_SemverVersion = SemverVersion;
 type units_SimpleInterestResult = SimpleInterestResult;
 type units_SubnetInfo = SubnetInfo;
+type units_SuccessiveDiscountResult = SuccessiveDiscountResult;
+type units_SuccessiveDiscountStep = SuccessiveDiscountStep;
 type units_TaxDirection = TaxDirection;
 type units_TaxResult = TaxResult;
 type units_TimeValueDirection = TimeValueDirection;
 type units_TimeValueResult = TimeValueResult;
 type units_TipSplitResult = TipSplitResult;
 type units_ViewportConvertResult = ViewportConvertResult;
+declare const units_applySuccessiveDiscounts: typeof applySuccessiveDiscounts;
 declare const units_autoFormat: typeof autoFormat;
 declare const units_bumpVersion: typeof bumpVersion;
 declare const units_calcAspectRatio: typeof calcAspectRatio;
 declare const units_calcSubnet: typeof calcSubnet;
 declare const units_calculateCompoundInterest: typeof calculateCompoundInterest;
+declare const units_calculateDiscount: typeof calculateDiscount;
 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;
@@ -559,6 +656,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;
@@ -583,7 +682,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_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_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_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_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_DiscountField as DiscountField, type units_DiscountInput as DiscountInput, type units_DiscountResult as DiscountResult, 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_SuccessiveDiscountResult as SuccessiveDiscountResult, type units_SuccessiveDiscountStep as SuccessiveDiscountStep, 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_applySuccessiveDiscounts as applySuccessiveDiscounts, units_autoFormat as autoFormat, units_bumpVersion as bumpVersion, units_calcAspectRatio as calcAspectRatio, units_calcSubnet as calcSubnet, units_calculateCompoundInterest as calculateCompoundInterest, units_calculateDiscount as calculateDiscount, 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 { calculatePercentageChange as $, type AmortizationRow as A, BASE_LABELS as B, COMMON_CURRENCIES as C, type Dimensions as D, type PercentageChangeResult as E, type FilePermissions as F, type Permission as G, type PxConvertResult as H, type IbanValidationResult as I, type SimpleInterestResult as J, type SubnetInfo as K, type LoanResult as L, type TaxResult as M, type NotationStyle as N, type TimeValueDirection as O, type PercentChangeDirection as P, type TimeValueResult as Q, type TipSplitResult as R, type SemverVersion as S, type TaxDirection as T, autoFormat as U, type ViewportConvertResult as V, bumpVersion as W, calcAspectRatio as X, calcSubnet as Y, calculateCompoundInterest as Z, calculateLoan as _, type AprApyDirection as a, calculateSimpleInterest as a0, calculateTax as a1, calculateTimeValue as a2, calculateTipSplit as a3, compareSemver as a4, convert as a5, convertAprApy as a6, convertBytes as a7, convertIp as a8, coverBox as a9, permissionsToChmod as aA, permissionsToOctal as aB, permissionsToSymbolic as aC, ptToPx as aD, pxToAll as aE, pxToViewport as aF, remToPx as aG, satisfiesRange as aH, scaleByHeight as aI, scaleByWidth as aJ, sortVersions as aK, splitSubnet as aL, symbolicToPermissions as aM, validateBarcode as aN, validateCardNumber as aO, validateIban as aP, validateIsbn as aQ, viewportToPx as aR, decimalToIp as aa, decimalToIpCidr as ab, describePermissions as ac, fitIntoBox as ad, formatNumber as ae, formatValue as af, formatVwValue as ag, formatWithSeparator as ah, gcd as ai, ipFromBinary as aj, ipFromDecimal as ak, ipFromHex as al, ipToBinary as am, ipToDecimal as an, ipToDecimalCidr as ao, ipToHex as ap, ipToOctal as aq, isValid as ar, isValidCidr as as, isValidIp as at, isValidIpv4 as au, octalToPermissions as av, parseFileSize as aw, parseInput as ax, parseNumberString as ay, parseSemver 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 NumberBase as z };
+export { type TipSplitResult as $, type AmortizationRow as A, BASE_LABELS as B, COMMON_CURRENCIES as C, type Dimensions as D, type IsbnFormat as E, type FilePermissions as F, type IsbnResult as G, type MarginMarkupInput as H, type IbanValidationResult as I, type MarginMarkupResult as J, type NumberBase as K, type LoanResult as L, type MarginMarkupField as M, type NotationStyle as N, type PercentageChangeResult as O, type PercentChangeDirection as P, type Permission as Q, type PxConvertResult as R, type SemverVersion as S, type SimpleInterestResult as T, type SubnetInfo as U, type SuccessiveDiscountResult as V, type SuccessiveDiscountStep as W, type TaxDirection as X, type TaxResult as Y, type TimeValueDirection as Z, type TimeValueResult as _, type AprApyDirection as a, validateCardNumber as a$, type ViewportConvertResult as a0, applySuccessiveDiscounts as a1, autoFormat as a2, bumpVersion as a3, calcAspectRatio as a4, calcSubnet as a5, calculateCompoundInterest as a6, calculateDiscount as a7, calculateLoan as a8, calculateMarginMarkup as a9, ipToHex as aA, ipToOctal as aB, isValid as aC, isValidCidr as aD, isValidIp as aE, isValidIpv4 as aF, marginToMarkup as aG, markupToMargin as aH, octalToPermissions as aI, parseFileSize as aJ, parseInput as aK, parseNumberString as aL, parseSemver as aM, permissionsToChmod as aN, permissionsToOctal as aO, permissionsToSymbolic as aP, ptToPx as aQ, pxToAll as aR, pxToViewport as aS, remToPx as aT, satisfiesRange as aU, scaleByHeight as aV, scaleByWidth as aW, sortVersions as aX, splitSubnet as aY, symbolicToPermissions as aZ, validateBarcode as a_, calculatePercentageChange as aa, calculateSimpleInterest as ab, calculateTax as ac, calculateTimeValue as ad, calculateTipSplit as ae, compareSemver as af, convert as ag, convertAprApy as ah, convertBytes as ai, convertIp as aj, coverBox as ak, decimalToIp as al, decimalToIpCidr as am, describePermissions as an, fitIntoBox as ao, formatNumber as ap, formatValue as aq, formatVwValue as ar, formatWithSeparator as as, gcd as at, ipFromBinary as au, ipFromDecimal as av, ipFromHex as aw, ipToBinary as ax, ipToDecimal as ay, ipToDecimalCidr as az, type AprApyResult as b, validateIban as b0, validateIsbn as b1, viewportToPx as b2, 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 DiscountField as v, type DiscountInput as w, type DiscountResult as x, type FormatOptions as y, type IpConversion as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@utilix-tech/sdk",
-  "version": "0.22.0",
+  "version": "0.24.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",