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

package/dist/foundation-forms.api.json

@@ -1241,6 +1241,192 @@
             "endIndex": 2
           }
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@genesislcap/foundation-forms!DatePickerControlRendererEntry:var",
+          "docComment": "/**\n * Renderer entry for a date-picker control. Opt in per form via `additionalRenderers`:\n * ```ts\n * import { DatePickerControlRendererEntry } from '@genesislcap/foundation-forms';\n * form.additionalRenderers = [DatePickerControlRendererEntry];\n * ```\n *\n * It then matches every `format: \"date\"` string field, plus fields with `options.datePicker`.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "DatePickerControlRendererEntry: "
+            },
+            {
+              "kind": "Reference",
+              "text": "RendererEntry",
+              "canonicalReference": "@genesislcap/foundation-forms!RendererEntry:type"
+            }
+          ],
+          "fileUrlPath": "src/jsonforms/renderers/DatePickerControlRenderer.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "DatePickerControlRendererEntry",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
+        {
+          "kind": "Function",
+          "canonicalReference": "@genesislcap/foundation-forms!DatePickerControlRendererTemplate:function(1)",
+          "docComment": "/**\n * 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'`.\n *\n * `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.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "DatePickerControlRendererTemplate: (prefix?: "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": ") => "
+            },
+            {
+              "kind": "Content",
+              "text": "import(\"@microsoft/fast-element\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "ViewTemplate",
+              "canonicalReference": "@microsoft/fast-element!ViewTemplate:class"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "DispatchRenderer",
+              "canonicalReference": "@genesislcap/foundation-forms!~DispatchRenderer:class"
+            },
+            {
+              "kind": "Content",
+              "text": ", any>"
+            }
+          ],
+          "fileUrlPath": "src/jsonforms/renderers/DatePickerControlRenderer.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 8
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "prefix",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": true
+            }
+          ],
+          "name": "DatePickerControlRendererTemplate"
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-forms!DatePickerRendererOptions:type",
+          "docComment": "/**\n * Configuration options for the date-picker control renderer (`DatePickerControlRendererEntry`).\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type DatePickerRendererOptions = "
+            },
+            {
+              "kind": "Reference",
+              "text": "StandardRendererOptions",
+              "canonicalReference": "@genesislcap/foundation-forms!StandardRendererOptions:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " & {\n    datePicker?: true;\n    valueFormat?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "DateValueFormat",
+              "canonicalReference": "@genesislcap/foundation-forms!DateValueFormat:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n    locale?: string;\n    displayFormat?: string;\n    hideWeekends?: boolean;\n    holidayCalendars?: boolean;\n    businessCenters?: string[];\n    businessCentersField?: string;\n    exchangeCodes?: string[];\n    exchangeCodesField?: string;\n    currencyCodes?: string[];\n    currencyField?: string;\n    minDate?: string;\n    maxDate?: string;\n    minDateField?: string;\n    maxDateField?: string;\n    rangeEndField?: string;\n    allowFreeText?: boolean;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/types.ts",
+          "releaseTag": "Public",
+          "name": "DatePickerRendererOptions",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 5
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-forms!DateValueFormat:type",
+          "docComment": "/**\n * 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.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type DateValueFormat = "
+            },
+            {
+              "kind": "Content",
+              "text": "'iso' | 'epoch'"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/types.ts",
+          "releaseTag": "Public",
+          "name": "DateValueFormat",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@genesislcap/foundation-forms!DEFAULT_INDEX_CONVENTIONS:var",
+          "docComment": "/**\n * 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).\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "DEFAULT_INDEX_CONVENTIONS: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Record",
+              "canonicalReference": "!Record:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<string, "
+            },
+            {
+              "kind": "Reference",
+              "text": "IndexConvention",
+              "canonicalReference": "@genesislcap/foundation-forms!~IndexConvention:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            }
+          ],
+          "fileUrlPath": "src/jsonforms/renderers/ValueDateControlRenderer.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "DEFAULT_INDEX_CONVENTIONS",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 5
+          }
+        },
         {
           "kind": "Function",
           "canonicalReference": "@genesislcap/foundation-forms!downloadCsvTemplate:function(1)",
@@ -4045,6 +4231,120 @@
             "endIndex": 9
           }
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@genesislcap/foundation-forms!mustBeOnOrAfter:function(1)",
+          "docComment": "/**\n * 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.\n *\n * @param target - the other date field, e.g. `'START_DATE'`\n *\n * @param message - the error shown on the current field; defaults to `Must not be before <target>`\n *\n * @returns a validator function that will be run by the smart form during the client-side validation stage\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "mustBeOnOrAfter: (target: "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": ", message?: "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": ") => "
+            },
+            {
+              "kind": "Content",
+              "text": "(data: any, path: any) => {\n    instancePath: string;\n    message: string;\n    schemaPath: string;\n    keyword: string;\n    params: {};\n}[]"
+            }
+          ],
+          "fileUrlPath": "src/utils/validation.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 5,
+            "endIndex": 6
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "target",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "message",
+              "parameterTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "isOptional": true
+            }
+          ],
+          "name": "mustBeOnOrAfter"
+        },
+        {
+          "kind": "Function",
+          "canonicalReference": "@genesislcap/foundation-forms!mustBeOnOrBefore:function(1)",
+          "docComment": "/**\n * 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.\n *\n * @param target - the other date field, e.g. `'END_DATE'`\n *\n * @param message - the error shown on the current field; defaults to `Must not be after <target>`\n *\n * @returns a validator function that will be run by the smart form during the client-side validation stage\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "mustBeOnOrBefore: (target: "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": ", message?: "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": ") => "
+            },
+            {
+              "kind": "Content",
+              "text": "(data: any, path: any) => {\n    instancePath: string;\n    message: string;\n    schemaPath: string;\n    keyword: string;\n    params: {};\n}[]"
+            }
+          ],
+          "fileUrlPath": "src/utils/validation.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 5,
+            "endIndex": 6
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "target",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "message",
+              "parameterTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "isOptional": true
+            }
+          ],
+          "name": "mustBeOnOrBefore"
+        },
         {
           "kind": "Function",
           "canonicalReference": "@genesislcap/foundation-forms!mustMatch:function(1)",
@@ -5756,7 +6056,43 @@
             },
             {
               "kind": "Content",
-              "text": ", 'data'>>"
+              "text": ", 'data'>> & "
+            },
+            {
+              "kind": "Reference",
+              "text": "Partial",
+              "canonicalReference": "!Partial:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "ValueDateRendererOptions",
+              "canonicalReference": "@genesislcap/foundation-forms!ValueDateRendererOptions:type"
+            },
+            {
+              "kind": "Content",
+              "text": "> & "
+            },
+            {
+              "kind": "Reference",
+              "text": "Partial",
+              "canonicalReference": "!Partial:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "DatePickerRendererOptions",
+              "canonicalReference": "@genesislcap/foundation-forms!DatePickerRendererOptions:type"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
             },
             {
               "kind": "Content",
@@ -5768,7 +6104,7 @@
           "name": "UiSchemaElementOptions",
           "typeTokenRange": {
             "startIndex": 1,
-            "endIndex": 49
+            "endIndex": 57
           }
         },
         {
@@ -5841,6 +6177,147 @@
             "startIndex": 1,
             "endIndex": 6
           }
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@genesislcap/foundation-forms!ValueDateControlRendererEntry:var",
+          "docComment": "/**\n * Renderer entry for a value-date control. Opt in per form via `additionalRenderers`:\n * ```ts\n * import { ValueDateControlRendererEntry } from '@genesislcap/foundation-forms';\n * form.additionalRenderers = [ValueDateControlRendererEntry];\n * ```\n *\n * and mark the field with `options: { valueDate: true, baseCurrencyField: 'BASE_CCY', ... }`.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "ValueDateControlRendererEntry: "
+            },
+            {
+              "kind": "Reference",
+              "text": "RendererEntry",
+              "canonicalReference": "@genesislcap/foundation-forms!RendererEntry:type"
+            }
+          ],
+          "fileUrlPath": "src/jsonforms/renderers/ValueDateControlRenderer.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "ValueDateControlRendererEntry",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
+        {
+          "kind": "Function",
+          "canonicalReference": "@genesislcap/foundation-forms!ValueDateControlRendererTemplate:function(1)",
+          "docComment": "/**\n * 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.\n *\n * 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.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "ValueDateControlRendererTemplate: (prefix?: "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": ") => "
+            },
+            {
+              "kind": "Content",
+              "text": "import(\"@microsoft/fast-element\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "ViewTemplate",
+              "canonicalReference": "@microsoft/fast-element!ViewTemplate:class"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "DispatchRenderer",
+              "canonicalReference": "@genesislcap/foundation-forms!~DispatchRenderer:class"
+            },
+            {
+              "kind": "Content",
+              "text": ", any>"
+            }
+          ],
+          "fileUrlPath": "src/jsonforms/renderers/ValueDateControlRenderer.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 8
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "prefix",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": true
+            }
+          ],
+          "name": "ValueDateControlRendererTemplate"
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-forms!ValueDateRendererOptions:type",
+          "docComment": "/**\n * Configuration options for the value-date control renderer. Activated by `valueDate: true`; reads its currencies, index and trade date from sibling fields.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type ValueDateRendererOptions = "
+            },
+            {
+              "kind": "Reference",
+              "text": "StandardRendererOptions",
+              "canonicalReference": "@genesislcap/foundation-forms!StandardRendererOptions:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " & {\n    valueDate: true;\n    baseCurrencyField?: string;\n    quoteCurrencyField?: string;\n    baseCurrency?: string;\n    quoteCurrency?: string;\n    indexField?: string;\n    tradeDateField?: string;\n    spotLag?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "SpotLag",
+              "canonicalReference": "@genesislcap/foundation-ui!SpotLag:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n    dayRollConvention?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "DayRollConvention",
+              "canonicalReference": "@genesislcap/foundation-ui!DayRollConvention:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n    valueFormat?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "DateValueFormat",
+              "canonicalReference": "@genesislcap/foundation-forms!DateValueFormat:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n    unadjustedDateScope?: string;\n    spotLagDaysScope?: string;\n    holidayCalendars?: boolean;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/types.ts",
+          "releaseTag": "Public",
+          "name": "ValueDateRendererOptions",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 9
+          }
         }
       ]
     }