@stonecrop/aform 0.16.2 → 0.16.4

package/dist/aform.d.ts

@@ -1,4 +1,5 @@
 import ACheckbox from './components/form/ACheckbox.vue';
+import ACurrencyInput from './components/form/ACurrencyInput.vue';
 import ADate from './components/form/ADate.vue';
 import ADatePicker from './components/form/ADatePicker.vue';
 import ADateRange from './components/form/ADateRange.vue';
@@ -25,6 +26,8 @@ import type { ValueField } from '@stonecrop/schema';
 
 export { ACheckbox }
 
+export { ACurrencyInput }
+
 export { ADate }
 
 export { ADatePicker }
@@ -139,6 +142,45 @@ export declare type ComponentProps = {
     errors?: string[];
 };
 
+/**
+ * Type-specific configuration for ACurrencyInput, passed via the field's `options` property.
+ * @public
+ */
+export declare interface CurrencyOptions {
+    /** Currency doctype name, used for FK resolution via `aformLinkResolver`. The currency picker is embedded, so it renders no navigate button. */
+    doctype?: string;
+    /** The record's base currency — fixed, not user-editable. A bare id resolves to displayText via `aformLinkResolver`. */
+    baseCurrency?: AFormLinkValue | string;
+    /** Exchange rate lookup for each non-base currency id, relative to `baseCurrency` (which is implicitly `1`) */
+    exchangeRates?: Record<string, number>;
+    /** Decimal places to round the derived `baseAmount` to — the base currency's scale (JPY carries 0, most carry 2, KWD 3). Applies only to `baseAmount`; the entered `amount` is left as typed. Omit to round only enough to shed binary floating-point noise, which never discards a digit the rate actually produced. A non-integer or out-of-range value falls back to that default. */
+    precision?: number;
+    /** Search function backing the `currency` autocomplete dropdown — see AFormLink's `filterFunction` */
+    filterFunction?: string | ((search: string) => AFormLinkValue[] | Promise<AFormLinkValue[]>);
+    /** Whether `filterFunction` results should show a loading state — see AFormLink's `isAsync` */
+    isAsync?: boolean;
+}
+
+/**
+ * The value shape for ACurrencyInput — an amount paired with its currency (an
+ * {@link AFormLinkValue} FK reference), plus the derived base-currency-equivalent amount.
+ * `exchangeRate` is carried on the value so it round-trips with the record even though it is
+ * never directly edited by the user.
+ * @public
+ */
+export declare interface CurrencyValue {
+    /** The entered amount, in `currency` units */
+    amount: number;
+    /** FK reference to the Currency doctype the user entered `amount` in */
+    currency: AFormLinkValue;
+    /** `amount` converted into `baseCurrency` units — `amount * exchangeRate` */
+    baseAmount: number;
+    /** The record's base currency — fixed, not user-editable */
+    baseCurrency: AFormLinkValue;
+    /** Multiplier from `currency` to `baseCurrency` — hidden from the UI, drives `baseAmount` */
+    exchangeRate: number;
+}
+
 /**
  * Deserializes a stringified function expression into a typed callable.
  *