@genesislcap/foundation-forms 15.50.2 → 15.50.3-holiday-picker.2

package/dist/foundation-forms.d.ts

@@ -1,5 +1,7 @@
 import { Controller } from '@microsoft/fast-element';
 import { DatasourceOptions } from '@genesislcap/foundation-comms';
+import type { DateConventionsChangedDetail } from '@genesislcap/foundation-ui';
+import type { DayRollConvention } from '@genesislcap/foundation-ui';
 import { DOMContainer } from '@genesislcap/foundation-utils';
 import { ElementStyles } from '@microsoft/fast-element';
 import { ErrorObject } from 'ajv';
@@ -23,6 +25,7 @@ import { OwnPropsOfControl } from '@jsonforms/core';
 import { RankedTester } from '@jsonforms/core';
 import { RuleEffect } from '@jsonforms/core';
 import { SchemaBasedCondition } from '@jsonforms/core';
+import type { SpotLag } from '@genesislcap/foundation-ui';
 import { StatePropsOfControl } from '@jsonforms/core';
 import { UISchemaElement } from '@jsonforms/core';
 import { ViewTemplate } from '@microsoft/fast-element';
@@ -593,6 +596,160 @@ export declare type CsvTemplateErrorEventDetail = {
     error: string;
 };
 
+/**
+ * Renderer entry for a date-picker control. Opt in per form via `additionalRenderers`:
+ * ```ts
+ * import { DatePickerControlRendererEntry } from '@genesislcap/foundation-forms';
+ * form.additionalRenderers = [DatePickerControlRendererEntry];
+ * ```
+ * It then matches every `format: "date"` string field, plus fields with `options.datePicker`.
+ * @public
+ */
+export declare const DatePickerControlRendererEntry: RendererEntry;
+
+/**
+ * Renders a `<prefix-date-picker>` for a date control, storing an ISO `YYYY-MM-DD` string by
+ * default or UTC-midnight epoch milliseconds with `options.valueFormat: 'epoch'`.
+ *
+ * `allow-empty` keeps an unset field empty rather than defaulting to today, and
+ * `strict-free-text` reverts typed dates the calendar couldn't pick. The picker has no
+ * `disabled` state, so a disabled control blocks pointer events on its wrapper.
+ * @public
+ */
+export declare const DatePickerControlRendererTemplate: (prefix?: string) => ViewTemplate<DispatchRenderer, any>;
+
+/**
+ * Configuration options for the date-picker control renderer (`DatePickerControlRendererEntry`).
+ * @public
+ */
+export declare type DatePickerRendererOptions = StandardRendererOptions & {
+    /**
+     * Opts a plain `type: "string"` field (no `format: "date"`), or a `number` epoch field, into
+     * the date-picker renderer.
+     * @public
+     */
+    datePicker?: true;
+    /**
+     * How the selected date is stored in the form data; either format is read.
+     * @defaultValue `'iso'`
+     * @public
+     */
+    valueFormat?: DateValueFormat;
+    /**
+     * BCP-47 locale for this control, e.g. `'en-GB'`: sets the default `displayFormat` and the
+     * calendar's month/weekday names.
+     * @defaultValue the runtime's `Intl` locale
+     * @public
+     */
+    locale?: string;
+    /**
+     * dayjs format used to display and read typed dates, e.g. `'DD MMM YYYY'`. Does not affect the
+     * stored value.
+     * @defaultValue the numeric date pattern of `locale` (en-GB → `DD/MM/YYYY`, en-US → `MM/DD/YYYY`)
+     * @public
+     */
+    displayFormat?: string;
+    /**
+     * Hides Saturday/Sunday columns in the calendar.
+     * @public
+     */
+    hideWeekends?: boolean;
+    /**
+     * Fetches holiday/closure days from the server and disables them: those of the business
+     * centres, exchanges and currencies named below, merged (a day any of them closes is
+     * disabled), or every calendar's when none is named.
+     * @defaultValue `false`
+     * @public
+     */
+    holidayCalendars?: boolean;
+    /**
+     * FpML business centre codes (`businessCenterScheme`, e.g. `GBLO`, `USNY`, `EUTA`) whose
+     * holidays `holidayCalendars` disables, combined with `businessCentersField`.
+     * @public
+     */
+    businessCenters?: string[];
+    /**
+     * Name of a top-level sibling field holding business centre codes: an array, or a string
+     * separated by `;` (e.g. a `PAY_CALENDAR` of `GBLO;USNY`), commas or spaces.
+     * @public
+     */
+    businessCentersField?: string;
+    /**
+     * Exchange MICs (e.g. `XNYS`) whose closures `holidayCalendars` disables, combined with
+     * `exchangeCodesField`.
+     * @public
+     */
+    exchangeCodes?: string[];
+    /**
+     * Name of a top-level sibling field holding exchange MICs, as `businessCentersField`.
+     * @public
+     */
+    exchangeCodesField?: string;
+    /**
+     * ISO 4217 currencies whose holidays `holidayCalendars` disables, combined with `currencyField`.
+     * @public
+     */
+    currencyCodes?: string[];
+    /**
+     * Name of a top-level sibling field holding an ISO 4217 currency code (or several, as
+     * `businessCentersField`) whose holidays `holidayCalendars` disables.
+     * @public
+     */
+    currencyField?: string;
+    /**
+     * Earliest selectable date, ISO `YYYY-MM-DD` (inclusive); with `minDateField` the later applies.
+     * @public
+     */
+    minDate?: string;
+    /**
+     * Latest selectable date, ISO `YYYY-MM-DD` (inclusive); with `maxDateField` the earlier applies.
+     * @public
+     */
+    maxDate?: string;
+    /**
+     * Name of a top-level sibling field whose date is the earliest selectable one, e.g.
+     * `'START_DATE'` on an end date. Ignored while empty.
+     * @public
+     */
+    minDateField?: string;
+    /**
+     * Name of a top-level sibling field whose date is the latest selectable one, e.g. `'END_DATE'`
+     * on a start date. Ignored while empty.
+     * @public
+     */
+    maxDateField?: string;
+    /**
+     * Picks a date range: this control holds the start and the named sibling field the end. Leave
+     * the end field out of the uiSchema, since this control edits it.
+     * @public
+     */
+    rangeEndField?: string;
+    /**
+     * Lets the user type the date in `displayFormat` as well as pick it. A typed date the calendar
+     * wouldn't allow reverts on blur/Enter.
+     * @public
+     */
+    allowFreeText?: boolean;
+};
+
+/**
+ * Storage format for a date written by the date-picker and value-date control renderers:
+ * - `'iso'` — an ISO 8601 calendar date string, `YYYY-MM-DD` (e.g. `2026-09-25`). Matches JSON
+ *   Schema `format: "date"` and the FpML/CDM convention, sorts correctly as a string, and parses
+ *   natively everywhere.
+ * - `'epoch'` — UTC-midnight epoch milliseconds, the genesis `DATE` wire format.
+ * @public
+ */
+export declare type DateValueFormat = 'iso' | 'epoch';
+
+/**
+ * Default settlement convention per overnight benchmark index, applied when the control's
+ * `options.indexField` sibling carries one of these codes: a short name (`SOFR`) or its FpML
+ * `floatingRateIndexScheme` code (`USD-SOFR`, checked against scheme 3-14).
+ * @public
+ */
+export declare const DEFAULT_INDEX_CONVENTIONS: Record<string, IndexConvention>;
+
 declare class DispatchRenderer extends FASTElement {
     jsonforms: any;
     jsonformsChanged(): void;
@@ -2156,6 +2313,10 @@ export declare function getVerticalCategorizationHeight(layout: CategorizationLa
  */
 export declare type GroupRendererOptions = CategorizationRendererOptions;
 
+declare interface IndexConvention extends DateConventionsChangedDetail {
+    currency: string;
+}
+
 /**
  * Converts a JsonForms/Ajv instance path to a JSON Forms scope string.
  * @example `/items/0/CCY` → `#/properties/items/items/0/properties/CCY`
@@ -2339,6 +2500,40 @@ export declare type MulticolumnDropdownRendererOptions = Pick<ConnectedRenderers
     dropdownWidth?: number;
 };
 
+/**
+ * Ensures the date in the current field (the one the validator is on) is on or after the date in
+ * the target field, e.g. an end date that can't be before its start date. Either field may hold
+ * an ISO `YYYY-MM-DD` string or epoch milliseconds; no error while either is empty.
+ * @param target - the other date field, e.g. `'START_DATE'`
+ * @param message - the error shown on the current field; defaults to `Must not be before <target>`
+ * @returns a validator function that will be run by the smart form during the client-side validation stage
+ * @public
+ */
+export declare const mustBeOnOrAfter: (target: string, message?: string) => (data: any, path: any) => {
+    instancePath: string;
+    message: string;
+    schemaPath: string;
+    keyword: string;
+    params: {};
+}[];
+
+/**
+ * Ensures the date in the current field (the one the validator is on) is on or before the date
+ * in the target field, e.g. a start date that can't be after its end date. Either field may hold
+ * an ISO `YYYY-MM-DD` string or epoch milliseconds; no error while either is empty.
+ * @param target - the other date field, e.g. `'END_DATE'`
+ * @param message - the error shown on the current field; defaults to `Must not be after <target>`
+ * @returns a validator function that will be run by the smart form during the client-side validation stage
+ * @public
+ */
+export declare const mustBeOnOrBefore: (target: string, message?: string) => (data: any, path: any) => {
+    instancePath: string;
+    message: string;
+    schemaPath: string;
+    keyword: string;
+    params: {};
+}[];
+
 /**
  * Ensures the value of the current field (the one the validator is on) matches the one of the target field.
  * @param target - any other field
@@ -2925,7 +3120,7 @@ export declare type UiSchemaElementOptions = StandardRendererOptions & {
      * @public
      */
     data?: any[];
-} & Partial<Omit<ConnectedRenderersOptions, 'data'>> & Partial<NumberRendererOptions> & Partial<ArrayRendererOptions> & Partial<CategorizationRendererOptions> & Partial<CategorizationLayoutOptions> & Partial<GroupRendererOptions> & Partial<StepperRendererOptions> & Partial<StringRendererOptions> & Partial<Omit<RadioGroupRendererOptions, 'data'>> & Partial<Omit<SegmentedRendererOptions, 'data'>>;
+} & Partial<Omit<ConnectedRenderersOptions, 'data'>> & Partial<NumberRendererOptions> & Partial<ArrayRendererOptions> & Partial<CategorizationRendererOptions> & Partial<CategorizationLayoutOptions> & Partial<GroupRendererOptions> & Partial<StepperRendererOptions> & Partial<StringRendererOptions> & Partial<Omit<RadioGroupRendererOptions, 'data'>> & Partial<Omit<SegmentedRendererOptions, 'data'>> & Partial<ValueDateRendererOptions> & Partial<DatePickerRendererOptions>;
 
 /**
  * The layouts and control types, which allow you to customize the arrangement of forms.
@@ -2939,4 +3134,115 @@ export declare type UiSchemaElementType = 'Control' | 'VerticalLayout' | 'Layout
  */
 export declare type UiSchemaOptions = StepperOrientationOptions | LabelPlacementOptions | CategorizationLayoutOptions;
 
+/**
+ * Renderer entry for a value-date control. Opt in per form via `additionalRenderers`:
+ * ```ts
+ * import { ValueDateControlRendererEntry } from '@genesislcap/foundation-forms';
+ * form.additionalRenderers = [ValueDateControlRendererEntry];
+ * ```
+ * and mark the field with `options: { valueDate: true, baseCurrencyField: 'BASE_CCY', ... }`.
+ * @public
+ */
+export declare const ValueDateControlRendererEntry: RendererEntry;
+
+/**
+ * Renders a `<foundation-value-date>` bound to sibling fields (currency pair, index, trade date)
+ * via `options`, and writes the resolved delivery date back as this control's value - plus,
+ * optionally, the unadjusted date (`unadjustedDateScope`) and the spot lag in days
+ * (`spotLagDaysScope`). A read-only control shows the date with its conventions locked.
+ *
+ * Every binding re-pushes on each form-wide re-render, so values the user can change in the
+ * widget are cached per renderer and echoed back instead of being reset.
+ * @public
+ */
+export declare const ValueDateControlRendererTemplate: (prefix?: string) => ViewTemplate<DispatchRenderer, any>;
+
+/**
+ * Configuration options for the value-date control renderer.
+ * Activated by `valueDate: true`; reads its currencies, index and trade date from sibling fields.
+ * @public
+ */
+export declare type ValueDateRendererOptions = StandardRendererOptions & {
+    /**
+     * Enables the value-date control renderer for this element.
+     * @public
+     */
+    valueDate: true;
+    /**
+     * Name of the sibling top-level field holding the base currency code (e.g. `EUR`).
+     * @defaultValue `'BASE_CURRENCY'`
+     * @public
+     */
+    baseCurrencyField?: string;
+    /**
+     * Name of the sibling top-level field holding the quote currency code (e.g. `USD`).
+     * @defaultValue `'QUOTE_CURRENCY'`
+     * @public
+     */
+    quoteCurrencyField?: string;
+    /**
+     * Fixed base currency code, used when the `baseCurrencyField` sibling is empty - e.g. the
+     * settlement currency of an instrument whose form has no currency field.
+     * @public
+     */
+    baseCurrency?: string;
+    /**
+     * Fixed quote currency code, used when the `quoteCurrencyField` sibling is empty.
+     * @public
+     */
+    quoteCurrency?: string;
+    /**
+     * Name of the sibling top-level field holding a benchmark index code (e.g. `SOFR`, `SONIA`).
+     * A recognised index's spot lag and day-roll convention are applied automatically.
+     * @public
+     */
+    indexField?: string;
+    /**
+     * Name of a sibling top-level field holding the trade date (ISO or epoch) that spot and tenor
+     * targets count from instead of today.
+     * @public
+     */
+    tradeDateField?: string;
+    /**
+     * Fixed spot lag for this control, e.g. `'T+0'` for a trade date. A recognised `indexField`
+     * takes precedence; when either fixed convention is set, the conventions popover is hidden.
+     * @public
+     */
+    spotLag?: SpotLag;
+    /**
+     * Fixed day-roll convention for this control, e.g. `'following'`. A recognised `indexField`
+     * convention takes precedence.
+     * @public
+     */
+    dayRollConvention?: DayRollConvention;
+    /**
+     * How the resolved delivery date is stored in the form data.
+     * @defaultValue `'iso'`
+     * @public
+     */
+    valueFormat?: DateValueFormat;
+    /**
+     * Scope (e.g. `#/properties/UNADJUSTED_SETTLEMENT_DATE`) to also store the unadjusted target
+     * date in - the date before the day-roll convention moved it off a holiday or weekend - so a
+     * record keeps both the adjusted and unadjusted dates. Stored in `valueFormat`.
+     * @public
+     */
+    unadjustedDateScope?: string;
+    /**
+     * Scope of an integer field holding the spot lag in business days (`T+N` is `N`), e.g. an
+     * instrument's settlement offset. Its value seeds the spot lag (offsets above 2 show as `T+2`,
+     * the widest lag the widget offers), and the user's spot-lag choice is written back to it; an
+     * empty field is filled with the lag in use. A recognised `indexField` or fixed `spotLag` takes
+     * precedence.
+     * @public
+     */
+    spotLagDaysScope?: string;
+    /**
+     * Whether the widget fetches its holiday calendars from the server (`holiday-calendars`).
+     * @defaultValue `false`
+     * @public
+     */
+    holidayCalendars?: boolean;
+};
+
 export { }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-forms",
   "description": "Genesis Foundation Forms",
-  "version": "15.50.2",
+  "version": "15.50.3-holiday-picker.2",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -56,12 +56,12 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "15.50.2",
-    "@genesislcap/genx": "15.50.2",
-    "@genesislcap/ts-builder": "15.50.2",
-    "@genesislcap/uvu-playwright-builder": "15.50.2",
-    "@genesislcap/vite-builder": "15.50.2",
-    "@genesislcap/webpack-builder": "15.50.2",
+    "@genesislcap/foundation-testing": "15.50.3-holiday-picker.2",
+    "@genesislcap/genx": "15.50.3-holiday-picker.2",
+    "@genesislcap/ts-builder": "15.50.3-holiday-picker.2",
+    "@genesislcap/uvu-playwright-builder": "15.50.3-holiday-picker.2",
+    "@genesislcap/vite-builder": "15.50.3-holiday-picker.2",
+    "@genesislcap/webpack-builder": "15.50.3-holiday-picker.2",
     "@types/json-schema": "^7.0.11",
     "@types/papaparse": "^5.3.14"
   },
@@ -78,12 +78,12 @@
     }
   },
   "dependencies": {
-    "@genesislcap/foundation-comms": "15.50.2",
-    "@genesislcap/foundation-criteria": "15.50.2",
-    "@genesislcap/foundation-logger": "15.50.2",
-    "@genesislcap/foundation-notifications": "15.50.2",
-    "@genesislcap/foundation-ui": "15.50.2",
-    "@genesislcap/foundation-utils": "15.50.2",
+    "@genesislcap/foundation-comms": "15.50.3-holiday-picker.2",
+    "@genesislcap/foundation-criteria": "15.50.3-holiday-picker.2",
+    "@genesislcap/foundation-logger": "15.50.3-holiday-picker.2",
+    "@genesislcap/foundation-notifications": "15.50.3-holiday-picker.2",
+    "@genesislcap/foundation-ui": "15.50.3-holiday-picker.2",
+    "@genesislcap/foundation-utils": "15.50.3-holiday-picker.2",
     "@json-schema-tools/dereferencer": "^1.6.1",
     "@jsonforms/core": "^3.2.1",
     "@microsoft/fast-components": "2.30.6",