@budiauktioner/buildi-primitives 0.1.0

package/dist/finance/index.d.cts

@@ -0,0 +1,83 @@
+import { d as Currency } from '../country-BhD51LDL.cjs';
+export { g as getCurrencyForCountry } from '../country-BhD51LDL.cjs';
+export { I as Isin, m as maskIsin } from '../isin-ZlQLBVm8.cjs';
+import { P as PrimitiveTypeInfo } from '../text-candidate-qg2bD9PY.cjs';
+
+/** Provides exchange rates between {@link Currency} pairs. */
+interface IExchangeRates {
+    /**
+     * Returns the exchange rate from `from` to `to`. Returns `1` when both
+     * currencies are the same. Throws when no rate is available.
+     */
+    getRate(from: Currency, to: Currency): number;
+    /**
+     * Attempts to read a rate. Returns `null` when no rate is available.
+     * Returns `1` when both currencies are the same.
+     */
+    tryGetRate(from: Currency, to: Currency): number | null;
+}
+/**
+ * Dictionary-backed collection of exchange rates. Automatically derives the
+ * inverse rate unless an explicit value is added in both directions.
+ */
+declare class ExchangeRates implements IExchangeRates {
+    #private;
+    /**
+     * Adds a rate from `from` to `to`. A rate of `0.095` from SEK to USD means
+     * `1 SEK = 0.095 USD`. Returns `this` for fluent chaining.
+     */
+    addRate(from: Currency, to: Currency, rate: number): this;
+    getRate(from: Currency, to: Currency): number;
+    tryGetRate(from: Currency, to: Currency): number | null;
+}
+
+interface ParseOptions {
+    fallbackCurrency?: Currency | null;
+}
+interface FormatOptions extends ParseOptions {
+    fallbackToTrimmedInputWhenInvalid?: boolean;
+}
+/**
+ * A monetary amount composed of a numeric value and a {@link Currency}.
+ *
+ * Note: JavaScript has no native arbitrary-precision decimal. Amounts are
+ * stored as `number` (IEEE-754 double). Parsing and arithmetic round to the
+ * currency's decimal places to keep results predictable.
+ */
+declare class MoneyAmount {
+    static readonly typeInfo: PrimitiveTypeInfo;
+    readonly amount: number;
+    readonly currency: Currency;
+    private constructor();
+    /** Creates a {@link MoneyAmount} from an explicit amount and currency. */
+    static create(amount: number, currency: Currency): MoneyAmount;
+    static tryParse(input: string | null | undefined, options?: ParseOptions): MoneyAmount | null;
+    static parse(input: string, options?: ParseOptions): MoneyAmount;
+    static isValid(input: string | null | undefined, options?: ParseOptions): boolean;
+    /** Returns the amount formatted using the default culture's numeric conventions, e.g. `1 000,00 SEK`. */
+    static format(input: string | null | undefined, options?: FormatOptions): string | null;
+    /** Returns the amount as a plain decimal string with the ISO code, e.g. `1000.50 SEK`. */
+    static normalize(input: string | null | undefined, options?: FormatOptions): string | null;
+    static isNormalized(input: string | null | undefined): boolean;
+    /** `1000.50 SEK` (invariant culture). */
+    toNormalizedString(): string;
+    /** `1 000,00 SEK` (current culture). */
+    toString(): string;
+    add(other: MoneyAmount): MoneyAmount;
+    subtract(other: MoneyAmount): MoneyAmount;
+    multiply(factor: number): MoneyAmount;
+    divide(divisor: number): MoneyAmount;
+    negate(): MoneyAmount;
+    /**
+     * Converts this amount to `target` using either an explicit rate or an
+     * {@link IExchangeRates} provider. The result is rounded to the target
+     * currency's decimal places using half-up rounding.
+     */
+    convertTo(target: Currency, rateOrRates: number | IExchangeRates): MoneyAmount;
+    equals(other: MoneyAmount | null | undefined): boolean;
+    compareTo(other: MoneyAmount | null | undefined): number;
+}
+/** Mask a money amount preserving the currency, e.g. `1 000,00 SEK` → `*** SEK`. */
+declare function maskMoneyAmount(amount: MoneyAmount): string;
+
+export { Currency, ExchangeRates, type IExchangeRates, MoneyAmount, maskMoneyAmount };

package/dist/finance/index.d.ts

@@ -0,0 +1,83 @@
+import { d as Currency } from '../country-p0n0EVQ9.js';
+export { g as getCurrencyForCountry } from '../country-p0n0EVQ9.js';
+export { I as Isin, m as maskIsin } from '../isin-EeVPpNWu.js';
+import { P as PrimitiveTypeInfo } from '../text-candidate-qg2bD9PY.js';
+
+/** Provides exchange rates between {@link Currency} pairs. */
+interface IExchangeRates {
+    /**
+     * Returns the exchange rate from `from` to `to`. Returns `1` when both
+     * currencies are the same. Throws when no rate is available.
+     */
+    getRate(from: Currency, to: Currency): number;
+    /**
+     * Attempts to read a rate. Returns `null` when no rate is available.
+     * Returns `1` when both currencies are the same.
+     */
+    tryGetRate(from: Currency, to: Currency): number | null;
+}
+/**
+ * Dictionary-backed collection of exchange rates. Automatically derives the
+ * inverse rate unless an explicit value is added in both directions.
+ */
+declare class ExchangeRates implements IExchangeRates {
+    #private;
+    /**
+     * Adds a rate from `from` to `to`. A rate of `0.095` from SEK to USD means
+     * `1 SEK = 0.095 USD`. Returns `this` for fluent chaining.
+     */
+    addRate(from: Currency, to: Currency, rate: number): this;
+    getRate(from: Currency, to: Currency): number;
+    tryGetRate(from: Currency, to: Currency): number | null;
+}
+
+interface ParseOptions {
+    fallbackCurrency?: Currency | null;
+}
+interface FormatOptions extends ParseOptions {
+    fallbackToTrimmedInputWhenInvalid?: boolean;
+}
+/**
+ * A monetary amount composed of a numeric value and a {@link Currency}.
+ *
+ * Note: JavaScript has no native arbitrary-precision decimal. Amounts are
+ * stored as `number` (IEEE-754 double). Parsing and arithmetic round to the
+ * currency's decimal places to keep results predictable.
+ */
+declare class MoneyAmount {
+    static readonly typeInfo: PrimitiveTypeInfo;
+    readonly amount: number;
+    readonly currency: Currency;
+    private constructor();
+    /** Creates a {@link MoneyAmount} from an explicit amount and currency. */
+    static create(amount: number, currency: Currency): MoneyAmount;
+    static tryParse(input: string | null | undefined, options?: ParseOptions): MoneyAmount | null;
+    static parse(input: string, options?: ParseOptions): MoneyAmount;
+    static isValid(input: string | null | undefined, options?: ParseOptions): boolean;
+    /** Returns the amount formatted using the default culture's numeric conventions, e.g. `1 000,00 SEK`. */
+    static format(input: string | null | undefined, options?: FormatOptions): string | null;
+    /** Returns the amount as a plain decimal string with the ISO code, e.g. `1000.50 SEK`. */
+    static normalize(input: string | null | undefined, options?: FormatOptions): string | null;
+    static isNormalized(input: string | null | undefined): boolean;
+    /** `1000.50 SEK` (invariant culture). */
+    toNormalizedString(): string;
+    /** `1 000,00 SEK` (current culture). */
+    toString(): string;
+    add(other: MoneyAmount): MoneyAmount;
+    subtract(other: MoneyAmount): MoneyAmount;
+    multiply(factor: number): MoneyAmount;
+    divide(divisor: number): MoneyAmount;
+    negate(): MoneyAmount;
+    /**
+     * Converts this amount to `target` using either an explicit rate or an
+     * {@link IExchangeRates} provider. The result is rounded to the target
+     * currency's decimal places using half-up rounding.
+     */
+    convertTo(target: Currency, rateOrRates: number | IExchangeRates): MoneyAmount;
+    equals(other: MoneyAmount | null | undefined): boolean;
+    compareTo(other: MoneyAmount | null | undefined): number;
+}
+/** Mask a money amount preserving the currency, e.g. `1 000,00 SEK` → `*** SEK`. */
+declare function maskMoneyAmount(amount: MoneyAmount): string;
+
+export { Currency, ExchangeRates, type IExchangeRates, MoneyAmount, maskMoneyAmount };