@oods/component-contracts 0.4.0 → 0.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/index.cjs +342 -23
- package/dist/index.d.cts +182 -6
- package/dist/index.d.ts +182 -6
- package/dist/index.js +340 -24
- package/package.json +1 -1
- package/registry/component-capability-additions.v1.json +144 -0
- package/registry/component-capability-ledger.v1.json +143 -1
- package/registry/component-intake.v1.json +64 -1
- package/registry/component-obligation-scope.v1.json +2 -2
- package/registry/component-reconciliation.proposed.v2.json +40 -2
package/dist/index.d.cts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
declare const COMPONENT_CLASSIFICATIONS: readonly ["native", "recipe", "alias", "authoring-only", "merged", "retired"];
|
|
2
2
|
type ComponentClassification = (typeof COMPONENT_CLASSIFICATIONS)[number];
|
|
3
|
-
declare const NUCLEUS_COMPONENT_IDS: readonly ["AddressCollectionPanel", "AddressEditor", "AddressSummaryBadge", "AddressValidationTimeline", "ArchiveEvent", "ArchivePill", "ArchiveSummary", "ArchivedRowOverlay", "AuditEvent", "AuditSummaryCard", "AuditTimeline", "Badge", "Banner", "BillingAmountInput", "BillingCardMeta", "BillingIntervalSelector", "BillingSummaryBadge", "Button", "CancellationBadge", "CancellationEvent", "CancellationForm", "CancellationSummary", "Card", "CardHeader", "Checkbox", "ClassificationBadge", "ClassificationEditor", "ClassificationPanel", "ColorStatePicker", "ColorSwatch", "ColorizedBadge", "CommunicationDetailPanel", "CycleProgressCard", "DatePicker", "DetailHeader", "Dialog", "FilterPanel", "FormLabelGroup", "GeoFieldMappingForm", "GeoResolutionBadge", "GeocodablePreview", "Grid", "InlineLabel", "Input", "LabelCell", "MembershipAuditTimeline", "MembershipPanel", "MessageEventTimeline", "MessageStatusBadge", "OwnerBadge", "OwnershipMeta", "OwnershipSummary", "PaginationBar", "PaymentEventTimeline", "PaymentTimeline", "PreferenceEditor", "PreferencePanel", "PreferenceSummaryBadge", "PreferenceTimeline", "PriceBadge", "PriceCardMeta", "PriceSummary", "RelativeTimestamp", "RoleAssignmentForm", "RoleBadgeList", "SearchInput", "Select", "SortIndicator", "Stack", "StateTransitionEvent", "StatusBadge", "StatusColorLegend", "StatusSelector", "StatusTimeline", "Switch", "Table", "Tabs", "TagInput", "TagManager", "TagPills", "TagSummary", "TemplatePicker", "Text", "Textarea", "TimelineEntryLabel", "VizAreaControls", "VizAreaPreview", "VizAxisControls", "VizAxisSummary", "VizColorControls", "VizColorLegendConfig", "VizEncodingBadge", "VizGraphPreview", "VizHeatmapControls", "VizHeatmapPreview", "VizLineControls", "VizLinePreview", "VizMarkControls", "VizMarkPreview", "VizOpacityControls", "VizOpacitySummary", "VizPointControls", "VizPointPreview", "VizRoleBadge", "VizScaleControls", "VizScaleSummary", "VizScatterControls", "VizScatterPreview", "VizShapeControls", "VizShapeLegend", "VizSizeControls", "VizSizeSummary"];
|
|
3
|
+
declare const NUCLEUS_COMPONENT_IDS: readonly ["AddressCollectionPanel", "AddressEditor", "AddressSummaryBadge", "AddressValidationTimeline", "ArchiveEvent", "ArchivePill", "ArchiveSummary", "ArchivedRowOverlay", "AuditEvent", "AuditSummaryCard", "AuditTimeline", "Badge", "Banner", "BillingAmountInput", "BillingCardMeta", "BillingIntervalSelector", "BillingSummaryBadge", "Button", "CancellationBadge", "CancellationEvent", "CancellationForm", "CancellationSummary", "Card", "CardHeader", "Checkbox", "ClassificationBadge", "ClassificationEditor", "ClassificationPanel", "ColorStatePicker", "ColorSwatch", "ColorizedBadge", "Combobox", "CommunicationDetailPanel", "CycleProgressCard", "DatePicker", "DetailHeader", "Dialog", "FilterPanel", "FormLabelGroup", "GeoFieldMappingForm", "GeoResolutionBadge", "GeocodablePreview", "Grid", "InlineLabel", "Input", "LabelCell", "MembershipAuditTimeline", "MembershipPanel", "MessageEventTimeline", "MessageStatusBadge", "OwnerBadge", "OwnershipMeta", "OwnershipSummary", "PaginationBar", "PaymentEventTimeline", "PaymentTimeline", "PreferenceEditor", "PreferencePanel", "PreferenceSummaryBadge", "PreferenceTimeline", "PriceBadge", "PriceCardMeta", "PriceSummary", "RelativeTimestamp", "RoleAssignmentForm", "RoleBadgeList", "SearchInput", "SegmentedControl", "Select", "SortIndicator", "Stack", "StateTransitionEvent", "StatusBadge", "StatusColorLegend", "StatusSelector", "StatusTimeline", "Switch", "Table", "Tabs", "TagInput", "TagManager", "TagPills", "TagSummary", "TemplatePicker", "Text", "Textarea", "TimelineEntryLabel", "VizAreaControls", "VizAreaPreview", "VizAxisControls", "VizAxisSummary", "VizColorControls", "VizColorLegendConfig", "VizEncodingBadge", "VizGraphPreview", "VizHeatmapControls", "VizHeatmapPreview", "VizLineControls", "VizLinePreview", "VizMarkControls", "VizMarkPreview", "VizOpacityControls", "VizOpacitySummary", "VizPointControls", "VizPointPreview", "VizRoleBadge", "VizScaleControls", "VizScaleSummary", "VizScatterControls", "VizScatterPreview", "VizShapeControls", "VizShapeLegend", "VizSizeControls", "VizSizeSummary"];
|
|
4
4
|
type NucleusComponentId = (typeof NUCLEUS_COMPONENT_IDS)[number];
|
|
5
5
|
declare const HISTORICAL_PORTED_COMPONENT_IDS: readonly ["AuditTimeline", "CancellationSummary", "PaginationBar", "PriceBadge", "RelativeTimestamp", "SearchInput", "StatusBadge", "StatusTimeline"];
|
|
6
6
|
/** @deprecated Historical compatibility cohort; all members belong to NucleusComponentId. */
|
|
@@ -67,10 +67,19 @@ type ScenarioTrigger = {
|
|
|
67
67
|
trigger: 'keyboard' | 'pointer';
|
|
68
68
|
target: string;
|
|
69
69
|
key?: string;
|
|
70
|
+
/**
|
|
71
|
+
* s223-m02 (#2527 ruling 11): keys pressed first on the target, in the same fresh scenario, before key, whose effect is
|
|
72
|
+
* asserted. A combobox's Enter, Home and End act on an open list, which a key such as ArrowDown opens.
|
|
73
|
+
*/
|
|
74
|
+
keys?: readonly string[];
|
|
70
75
|
action?: 'click' | 'select';
|
|
71
76
|
value?: string;
|
|
77
|
+
/**
|
|
78
|
+
* active-option (s223-m02): the target's popup is open (aria-expanded true), its aria-activedescendant names the option
|
|
79
|
+
* whose text is value, and nothing was picked (no event).
|
|
80
|
+
*/
|
|
72
81
|
effect: {
|
|
73
|
-
kind: 'focus' | 'event' | 'value' | 'selected-tab';
|
|
82
|
+
kind: 'focus' | 'event' | 'value' | 'selected-tab' | 'active-option';
|
|
74
83
|
value?: unknown;
|
|
75
84
|
target?: string;
|
|
76
85
|
};
|
|
@@ -86,7 +95,7 @@ type ComponentBehavior = {
|
|
|
86
95
|
|
|
87
96
|
declare const COMPONENT_CONTRACT_VERSION: "1.1.0";
|
|
88
97
|
declare const COMPONENT_CONTRACT_VERSION_1_1: "1.1.0";
|
|
89
|
-
declare const componentContracts: Readonly<Record<"AddressCollectionPanel" | "AddressEditor" | "AddressSummaryBadge" | "AddressValidationTimeline" | "ArchiveEvent" | "ArchivePill" | "ArchiveSummary" | "ArchivedRowOverlay" | "AuditEvent" | "AuditSummaryCard" | "AuditTimeline" | "Badge" | "Banner" | "BillingAmountInput" | "BillingCardMeta" | "BillingIntervalSelector" | "BillingSummaryBadge" | "Button" | "CancellationBadge" | "CancellationEvent" | "CancellationForm" | "CancellationSummary" | "Card" | "CardHeader" | "Checkbox" | "ClassificationBadge" | "ClassificationEditor" | "ClassificationPanel" | "ColorStatePicker" | "ColorSwatch" | "ColorizedBadge" | "CommunicationDetailPanel" | "CycleProgressCard" | "DatePicker" | "DetailHeader" | "Dialog" | "FilterPanel" | "FormLabelGroup" | "GeoFieldMappingForm" | "GeoResolutionBadge" | "GeocodablePreview" | "Grid" | "InlineLabel" | "Input" | "LabelCell" | "MembershipAuditTimeline" | "MembershipPanel" | "MessageEventTimeline" | "MessageStatusBadge" | "OwnerBadge" | "OwnershipMeta" | "OwnershipSummary" | "PaginationBar" | "PaymentEventTimeline" | "PaymentTimeline" | "PreferenceEditor" | "PreferencePanel" | "PreferenceSummaryBadge" | "PreferenceTimeline" | "PriceBadge" | "PriceCardMeta" | "PriceSummary" | "RelativeTimestamp" | "RoleAssignmentForm" | "RoleBadgeList" | "SearchInput" | "Select" | "SortIndicator" | "Stack" | "StateTransitionEvent" | "StatusBadge" | "StatusColorLegend" | "StatusSelector" | "StatusTimeline" | "Switch" | "Table" | "Tabs" | "TagInput" | "TagManager" | "TagPills" | "TagSummary" | "TemplatePicker" | "Text" | "Textarea" | "TimelineEntryLabel" | "VizAreaControls" | "VizAreaPreview" | "VizAxisControls" | "VizAxisSummary" | "VizColorControls" | "VizColorLegendConfig" | "VizEncodingBadge" | "VizGraphPreview" | "VizHeatmapControls" | "VizHeatmapPreview" | "VizLineControls" | "VizLinePreview" | "VizMarkControls" | "VizMarkPreview" | "VizOpacityControls" | "VizOpacitySummary" | "VizPointControls" | "VizPointPreview" | "VizRoleBadge" | "VizScaleControls" | "VizScaleSummary" | "VizScatterControls" | "VizScatterPreview" | "VizShapeControls" | "VizShapeLegend" | "VizSizeControls" | "VizSizeSummary", ComponentContract>>;
|
|
98
|
+
declare const componentContracts: Readonly<Record<"AddressCollectionPanel" | "AddressEditor" | "AddressSummaryBadge" | "AddressValidationTimeline" | "ArchiveEvent" | "ArchivePill" | "ArchiveSummary" | "ArchivedRowOverlay" | "AuditEvent" | "AuditSummaryCard" | "AuditTimeline" | "Badge" | "Banner" | "BillingAmountInput" | "BillingCardMeta" | "BillingIntervalSelector" | "BillingSummaryBadge" | "Button" | "CancellationBadge" | "CancellationEvent" | "CancellationForm" | "CancellationSummary" | "Card" | "CardHeader" | "Checkbox" | "ClassificationBadge" | "ClassificationEditor" | "ClassificationPanel" | "ColorStatePicker" | "ColorSwatch" | "ColorizedBadge" | "Combobox" | "CommunicationDetailPanel" | "CycleProgressCard" | "DatePicker" | "DetailHeader" | "Dialog" | "FilterPanel" | "FormLabelGroup" | "GeoFieldMappingForm" | "GeoResolutionBadge" | "GeocodablePreview" | "Grid" | "InlineLabel" | "Input" | "LabelCell" | "MembershipAuditTimeline" | "MembershipPanel" | "MessageEventTimeline" | "MessageStatusBadge" | "OwnerBadge" | "OwnershipMeta" | "OwnershipSummary" | "PaginationBar" | "PaymentEventTimeline" | "PaymentTimeline" | "PreferenceEditor" | "PreferencePanel" | "PreferenceSummaryBadge" | "PreferenceTimeline" | "PriceBadge" | "PriceCardMeta" | "PriceSummary" | "RelativeTimestamp" | "RoleAssignmentForm" | "RoleBadgeList" | "SearchInput" | "SegmentedControl" | "Select" | "SortIndicator" | "Stack" | "StateTransitionEvent" | "StatusBadge" | "StatusColorLegend" | "StatusSelector" | "StatusTimeline" | "Switch" | "Table" | "Tabs" | "TagInput" | "TagManager" | "TagPills" | "TagSummary" | "TemplatePicker" | "Text" | "Textarea" | "TimelineEntryLabel" | "VizAreaControls" | "VizAreaPreview" | "VizAxisControls" | "VizAxisSummary" | "VizColorControls" | "VizColorLegendConfig" | "VizEncodingBadge" | "VizGraphPreview" | "VizHeatmapControls" | "VizHeatmapPreview" | "VizLineControls" | "VizLinePreview" | "VizMarkControls" | "VizMarkPreview" | "VizOpacityControls" | "VizOpacitySummary" | "VizPointControls" | "VizPointPreview" | "VizRoleBadge" | "VizScaleControls" | "VizScaleSummary" | "VizScatterControls" | "VizScatterPreview" | "VizShapeControls" | "VizShapeLegend" | "VizSizeControls" | "VizSizeSummary", ComponentContract>>;
|
|
90
99
|
|
|
91
100
|
/** Billable's declared defaults; object parameter overrides travel as runtime props. */
|
|
92
101
|
declare const BILLING_INTERVALS: readonly ["monthly", "quarterly", "annual"];
|
|
@@ -174,7 +183,7 @@ declare const SEVERITY_TONES: readonly ["positive", "success", "warning", "criti
|
|
|
174
183
|
* mark keeps the tone's graded text contrast and reads at a badge's 12px and a banner's 16px. React, Vue and HTML all
|
|
175
184
|
* draw from this table.
|
|
176
185
|
*/
|
|
177
|
-
type StatusIconName = 'check' | 'x' | 'alert' | 'info' | 'clock' | 'dots' | 'refresh' | 'pause' | 'ban' | 'pencil' | 'star' | 'undo' | 'lock' | 'unlock' | 'dot';
|
|
186
|
+
type StatusIconName = 'check' | 'x' | 'alert' | 'info' | 'clock' | 'dots' | 'refresh' | 'pause' | 'ban' | 'pencil' | 'star' | 'undo' | 'lock' | 'unlock' | 'dot' | 'chevron-down';
|
|
178
187
|
type StatusIconShape = {
|
|
179
188
|
readonly tag: 'path' | 'circle' | 'rect';
|
|
180
189
|
readonly attrs: Readonly<Record<string, string>>;
|
|
@@ -305,8 +314,15 @@ interface CollectionEvent {
|
|
|
305
314
|
}
|
|
306
315
|
/** Invalid dates cannot participate in a chronological view; ties retain source order. */
|
|
307
316
|
declare function chronologicalEvents(events: readonly CollectionEvent[]): CollectionEvent[];
|
|
317
|
+
/** A number's declared display format (a field's ui_hints.format). */
|
|
318
|
+
type NumberDisplayFormat = 'percent' | 'quantity';
|
|
319
|
+
/**
|
|
320
|
+
* s223-m01 (#2527 ruling 4): a declared number reads as a person writes it. percent holds percent units (12.5 reads
|
|
321
|
+
* 12.5%, -41 reads -41%); quantity is grouped (86420 reads 86,420). Undefined for a value that is not a finite number.
|
|
322
|
+
*/
|
|
323
|
+
declare function formatDeclaredNumber(value: unknown, format: NumberDisplayFormat): string | undefined;
|
|
308
324
|
/** Format declared scalar display fields without changing the underlying record. */
|
|
309
|
-
declare function formatReadOnlyValue(value: unknown, type: string, code?: boolean): string;
|
|
325
|
+
declare function formatReadOnlyValue(value: unknown, type: string, code?: boolean, format?: NumberDisplayFormat): string;
|
|
310
326
|
/** Workflow apps and standalone previews project the same actual record events. */
|
|
311
327
|
declare function recordCollectionEvents(record: Record<string, unknown>, options?: {
|
|
312
328
|
historyField?: string;
|
|
@@ -316,8 +332,20 @@ declare function recordCollectionEvents(record: Record<string, unknown>, options
|
|
|
316
332
|
}>;
|
|
317
333
|
minorUnits?: number;
|
|
318
334
|
}): CollectionEvent[];
|
|
335
|
+
/**
|
|
336
|
+
* s223-m02 (#2527 ruling 13i, #2521): the summary an AddressCollectionPanel shows of a record's addresses, one line per
|
|
337
|
+
* entry (its role, street lines, city, region and postal code) with the entries separated by semicolons, for example
|
|
338
|
+
* "home, 8 Lake Road, Madison, WI, 53703". A generated workflow's store prints the same line (collectionSummary); a single
|
|
339
|
+
* screen and the HTML renderer print it from here. A record with no addresses reads as an empty string.
|
|
340
|
+
*/
|
|
341
|
+
declare function addressCollectionSummary(entries: unknown): string;
|
|
319
342
|
/** A label is authoritative only alongside its actual reference; never infer a related entity. */
|
|
320
343
|
declare function formatReferenceLabel(identifier: unknown, label?: unknown, subject?: string): string;
|
|
344
|
+
/**
|
|
345
|
+
* s223-m01 (#2527 ruling 6): ownership on a card as one phrase, "Owned by Pricing and packaging · team", or by its type
|
|
346
|
+
* alone when the owner has no name to show ("Team-owned"). Undefined when there is nothing to say.
|
|
347
|
+
*/
|
|
348
|
+
declare function ownershipPhrase(ownerLabel?: unknown, ownerType?: unknown, role?: unknown): string | undefined;
|
|
321
349
|
/** Keep authored record keys and the Transaction fallback; UUIDs belong in technical inspection. */
|
|
322
350
|
declare function formatRecordLabel(value: unknown): string;
|
|
323
351
|
|
|
@@ -1712,6 +1740,91 @@ declare const componentBehaviors: {
|
|
|
1712
1740
|
readonly interactionReason: "ColorizedBadge presents content and owns no focusable control or action; authored child actions remain the consumer's responsibility.";
|
|
1713
1741
|
readonly event: readonly [];
|
|
1714
1742
|
};
|
|
1743
|
+
readonly Combobox: {
|
|
1744
|
+
readonly role: "combobox";
|
|
1745
|
+
readonly name: {
|
|
1746
|
+
readonly strategy: "label";
|
|
1747
|
+
readonly target: "input[role=\"combobox\"]";
|
|
1748
|
+
};
|
|
1749
|
+
readonly keyboard: {
|
|
1750
|
+
readonly Tab: "Move focus to the named native control; an open list closes without picking";
|
|
1751
|
+
readonly x: "Type to filter the options by label";
|
|
1752
|
+
readonly ArrowDown: "Open the list and move to the next option";
|
|
1753
|
+
readonly ArrowUp: "Move to the previous option; with the list closed, open it at the last option";
|
|
1754
|
+
readonly Home: "Move to the first option of an open list";
|
|
1755
|
+
readonly End: "Move to the last option of an open list";
|
|
1756
|
+
readonly Enter: "Pick the active option and close the list";
|
|
1757
|
+
readonly Escape: "Close the list; with the list closed, clear the field";
|
|
1758
|
+
};
|
|
1759
|
+
readonly interaction: "interactive";
|
|
1760
|
+
readonly event: readonly [{
|
|
1761
|
+
readonly trigger: "keyboard";
|
|
1762
|
+
readonly target: "input[role=\"combobox\"]";
|
|
1763
|
+
readonly key: "Tab";
|
|
1764
|
+
readonly effect: {
|
|
1765
|
+
readonly kind: "focus";
|
|
1766
|
+
};
|
|
1767
|
+
}, {
|
|
1768
|
+
readonly trigger: "keyboard";
|
|
1769
|
+
readonly target: "input[role=\"combobox\"]";
|
|
1770
|
+
readonly key: "x";
|
|
1771
|
+
readonly effect: {
|
|
1772
|
+
readonly kind: "value";
|
|
1773
|
+
readonly value: "Canadax";
|
|
1774
|
+
};
|
|
1775
|
+
}, {
|
|
1776
|
+
readonly trigger: "keyboard";
|
|
1777
|
+
readonly target: "input[role=\"combobox\"]";
|
|
1778
|
+
readonly key: "ArrowDown";
|
|
1779
|
+
readonly effect: {
|
|
1780
|
+
readonly kind: "active-option";
|
|
1781
|
+
readonly value: "Australia";
|
|
1782
|
+
};
|
|
1783
|
+
}, {
|
|
1784
|
+
readonly trigger: "keyboard";
|
|
1785
|
+
readonly target: "input[role=\"combobox\"]";
|
|
1786
|
+
readonly key: "ArrowUp";
|
|
1787
|
+
readonly effect: {
|
|
1788
|
+
readonly kind: "active-option";
|
|
1789
|
+
readonly value: "United States";
|
|
1790
|
+
};
|
|
1791
|
+
}, {
|
|
1792
|
+
readonly trigger: "keyboard";
|
|
1793
|
+
readonly target: "input[role=\"combobox\"]";
|
|
1794
|
+
readonly keys: readonly ["ArrowUp"];
|
|
1795
|
+
readonly key: "Home";
|
|
1796
|
+
readonly effect: {
|
|
1797
|
+
readonly kind: "active-option";
|
|
1798
|
+
readonly value: "Australia";
|
|
1799
|
+
};
|
|
1800
|
+
}, {
|
|
1801
|
+
readonly trigger: "keyboard";
|
|
1802
|
+
readonly target: "input[role=\"combobox\"]";
|
|
1803
|
+
readonly keys: readonly ["ArrowDown"];
|
|
1804
|
+
readonly key: "End";
|
|
1805
|
+
readonly effect: {
|
|
1806
|
+
readonly kind: "active-option";
|
|
1807
|
+
readonly value: "United States";
|
|
1808
|
+
};
|
|
1809
|
+
}, {
|
|
1810
|
+
readonly trigger: "keyboard";
|
|
1811
|
+
readonly target: "input[role=\"combobox\"]";
|
|
1812
|
+
readonly keys: readonly ["ArrowDown", "ArrowDown", "ArrowDown"];
|
|
1813
|
+
readonly key: "Enter";
|
|
1814
|
+
readonly effect: {
|
|
1815
|
+
readonly kind: "event";
|
|
1816
|
+
readonly value: "fr";
|
|
1817
|
+
};
|
|
1818
|
+
}, {
|
|
1819
|
+
readonly trigger: "keyboard";
|
|
1820
|
+
readonly target: "input[role=\"combobox\"]";
|
|
1821
|
+
readonly key: "Escape";
|
|
1822
|
+
readonly effect: {
|
|
1823
|
+
readonly kind: "event";
|
|
1824
|
+
readonly value: "";
|
|
1825
|
+
};
|
|
1826
|
+
}];
|
|
1827
|
+
};
|
|
1715
1828
|
readonly CycleProgressCard: {
|
|
1716
1829
|
readonly role: "none";
|
|
1717
1830
|
readonly name: {
|
|
@@ -2201,6 +2314,69 @@ declare const componentBehaviors: {
|
|
|
2201
2314
|
};
|
|
2202
2315
|
}];
|
|
2203
2316
|
};
|
|
2317
|
+
readonly SegmentedControl: {
|
|
2318
|
+
readonly role: "radio";
|
|
2319
|
+
readonly name: {
|
|
2320
|
+
readonly strategy: "label";
|
|
2321
|
+
readonly target: "input[type=\"radio\"]:checked";
|
|
2322
|
+
};
|
|
2323
|
+
readonly keyboard: {
|
|
2324
|
+
readonly Tab: "Move focus to the checked option";
|
|
2325
|
+
readonly ArrowRight: "Check and focus the next option";
|
|
2326
|
+
readonly ArrowDown: "Check and focus the next option";
|
|
2327
|
+
readonly ArrowLeft: "Check and focus the previous option";
|
|
2328
|
+
readonly ArrowUp: "Check and focus the previous option";
|
|
2329
|
+
};
|
|
2330
|
+
readonly interaction: "interactive";
|
|
2331
|
+
readonly event: readonly [{
|
|
2332
|
+
readonly trigger: "keyboard";
|
|
2333
|
+
readonly target: "input[type=\"radio\"]:checked";
|
|
2334
|
+
readonly key: "Tab";
|
|
2335
|
+
readonly effect: {
|
|
2336
|
+
readonly kind: "focus";
|
|
2337
|
+
};
|
|
2338
|
+
}, {
|
|
2339
|
+
readonly trigger: "keyboard";
|
|
2340
|
+
readonly target: "input[type=\"radio\"]:checked";
|
|
2341
|
+
readonly key: "ArrowRight";
|
|
2342
|
+
readonly effect: {
|
|
2343
|
+
readonly kind: "event";
|
|
2344
|
+
readonly value: "yearly";
|
|
2345
|
+
};
|
|
2346
|
+
}, {
|
|
2347
|
+
readonly trigger: "keyboard";
|
|
2348
|
+
readonly target: "input[type=\"radio\"]:checked";
|
|
2349
|
+
readonly key: "ArrowDown";
|
|
2350
|
+
readonly effect: {
|
|
2351
|
+
readonly kind: "event";
|
|
2352
|
+
readonly value: "yearly";
|
|
2353
|
+
};
|
|
2354
|
+
}, {
|
|
2355
|
+
readonly trigger: "keyboard";
|
|
2356
|
+
readonly target: "input[type=\"radio\"]:checked";
|
|
2357
|
+
readonly key: "ArrowLeft";
|
|
2358
|
+
readonly effect: {
|
|
2359
|
+
readonly kind: "event";
|
|
2360
|
+
readonly value: "monthly";
|
|
2361
|
+
};
|
|
2362
|
+
}, {
|
|
2363
|
+
readonly trigger: "keyboard";
|
|
2364
|
+
readonly target: "input[type=\"radio\"]:checked";
|
|
2365
|
+
readonly key: "ArrowUp";
|
|
2366
|
+
readonly effect: {
|
|
2367
|
+
readonly kind: "event";
|
|
2368
|
+
readonly value: "monthly";
|
|
2369
|
+
};
|
|
2370
|
+
}, {
|
|
2371
|
+
readonly trigger: "pointer";
|
|
2372
|
+
readonly target: "input[value=\"yearly\"]";
|
|
2373
|
+
readonly effect: {
|
|
2374
|
+
readonly kind: "event";
|
|
2375
|
+
readonly value: "yearly";
|
|
2376
|
+
};
|
|
2377
|
+
readonly action: "click";
|
|
2378
|
+
}];
|
|
2379
|
+
};
|
|
2204
2380
|
readonly Select: {
|
|
2205
2381
|
readonly role: "combobox";
|
|
2206
2382
|
readonly name: {
|
|
@@ -3220,4 +3396,4 @@ declare function getBaselineCapability(componentId: string): {
|
|
|
3220
3396
|
};
|
|
3221
3397
|
} | undefined;
|
|
3222
3398
|
|
|
3223
|
-
export { type AuditSummaryValues, BILLING_AMOUNT_ERROR, BILLING_INTERVALS, BILLING_INTERVAL_ERROR, BILLING_MINOR_UNITS, type BillingAmountResult, type BillingCycleValues, type BillingPaymentValues, COMPONENT_CLASSIFICATIONS, COMPONENT_CONTRACT_VERSION, COMPONENT_CONTRACT_VERSION_1_1, type CollectionEvent, type ComponentBehavior, type ComponentClassification, type ComponentContract, DEFAULT_COLOR_STATES, EMISSION_ELIGIBILITY_EVIDENCE_CLASSES, type EmissionEligibilityEvidence, type EmissionEligibilityEvidenceClass, type EvidenceResult, type EvidenceStatus, FOUNDATION_V1_EVIDENCE_CLASSES, type FoundationV1Evidence, type FoundationV1EvidenceClass, GOVERNED_DEFINITION, GOVERNED_SURFACES, type GeoFieldMappingValue, type GovernedComponentId, type GovernedLedgerRow, NO_LAST_PAYMENT, NO_NEXT_PAYMENT, NUCLEUS_COMPONENT_IDS, type NucleusComponentId, type ObligationStatus, PORTED_COMPONENT_IDS, type PortedComponentId, RESULT_STATES, RESULT_STATE_TONE, type ResultState, SEVERITY_TONES, STATUS_DOMAINS, STATUS_ICON_SHAPES, STATUS_ICON_SVG_ATTRS, type ScenarioTrigger, type SharedScenario, type SortIndicatorValues, type SortState, type StatusDomain, type StatusIconName, type StatusIconShape, type StatusPresentation, type StatusTokenSet, type StatusTone, type SubstitutionContractReport, type SubstitutionObligation, type TraitEventKind, type TraitEventValues, UI_WORKFLOW_STATES, type UiWorkflowState, VIZ_CONTROL_IDS, VIZ_CONTROL_TITLES, VIZ_PREVIEW_TYPES, VIZ_SUMMARY_IDS, VIZ_SVG_PROPS, VIZ_THEME_SVG_PROPS, type VizChannel, type VizChartType, type VizColorBinding, type VizControlField, type VizControlId, type VizFieldBinding, type VizIntentFragment, type VizPreviewLayer, type VizPreviewTheme, type VizRenderAttribute, type VizScale, type VizSummaryId, type VizThemeSvgProp, ariaSort, assertStaticSvg, auditSummary, billingAmountMessage, billingAmountText, billingCycle, billingDate, billingIntervalMessage, billingPaymentRows, billingPaymentSummary, billingPeriodEnd, billingSummary, chronologicalEvents, componentBehaviors, componentCapabilityBaseline, componentContracts, componentIntake, componentReconciliationProposal, currencyMinorUnits, dateTimeInputValue, defaultVizIntent, deriveStartingComponentCount, editVizIntent, evaluateEmissionEligibility, evaluateFoundationV1, formatBillingAmount, formatDateTime, formatPriceAmount, formatPriceCode, formatReadOnlyValue, formatRecordLabel, formatReferenceLabel, geoFieldMapping, getBannerToneTokenSet, getBaselineCapability, getStatusPresentation, getToneTokenSet, initialSort, isGovernedComponent, isVizIntentFragment, listStatuses, nextSort, parseBillingAmount, portedComponentContracts, portedScenarios, recipeItemLabels, recordCollectionEvents, relativeTimestampEmptyScenario, resolveStatusIcon, restartedBillingPeriod, sharedScenarios, statusIconMarkup, substitutionContractReport, summarizeSubstitutionReport, summaryValue, svgCarriesTitle, traitEventRows, validMinorUnits, validateComponentIntakeDocument, vizControlFields, vizFieldValue, vizPreviewLayers, vizSummaryRows };
|
|
3399
|
+
export { type AuditSummaryValues, BILLING_AMOUNT_ERROR, BILLING_INTERVALS, BILLING_INTERVAL_ERROR, BILLING_MINOR_UNITS, type BillingAmountResult, type BillingCycleValues, type BillingPaymentValues, COMPONENT_CLASSIFICATIONS, COMPONENT_CONTRACT_VERSION, COMPONENT_CONTRACT_VERSION_1_1, type CollectionEvent, type ComponentBehavior, type ComponentClassification, type ComponentContract, DEFAULT_COLOR_STATES, EMISSION_ELIGIBILITY_EVIDENCE_CLASSES, type EmissionEligibilityEvidence, type EmissionEligibilityEvidenceClass, type EvidenceResult, type EvidenceStatus, FOUNDATION_V1_EVIDENCE_CLASSES, type FoundationV1Evidence, type FoundationV1EvidenceClass, GOVERNED_DEFINITION, GOVERNED_SURFACES, type GeoFieldMappingValue, type GovernedComponentId, type GovernedLedgerRow, NO_LAST_PAYMENT, NO_NEXT_PAYMENT, NUCLEUS_COMPONENT_IDS, type NucleusComponentId, type NumberDisplayFormat, type ObligationStatus, PORTED_COMPONENT_IDS, type PortedComponentId, RESULT_STATES, RESULT_STATE_TONE, type ResultState, SEVERITY_TONES, STATUS_DOMAINS, STATUS_ICON_SHAPES, STATUS_ICON_SVG_ATTRS, type ScenarioTrigger, type SharedScenario, type SortIndicatorValues, type SortState, type StatusDomain, type StatusIconName, type StatusIconShape, type StatusPresentation, type StatusTokenSet, type StatusTone, type SubstitutionContractReport, type SubstitutionObligation, type TraitEventKind, type TraitEventValues, UI_WORKFLOW_STATES, type UiWorkflowState, VIZ_CONTROL_IDS, VIZ_CONTROL_TITLES, VIZ_PREVIEW_TYPES, VIZ_SUMMARY_IDS, VIZ_SVG_PROPS, VIZ_THEME_SVG_PROPS, type VizChannel, type VizChartType, type VizColorBinding, type VizControlField, type VizControlId, type VizFieldBinding, type VizIntentFragment, type VizPreviewLayer, type VizPreviewTheme, type VizRenderAttribute, type VizScale, type VizSummaryId, type VizThemeSvgProp, addressCollectionSummary, ariaSort, assertStaticSvg, auditSummary, billingAmountMessage, billingAmountText, billingCycle, billingDate, billingIntervalMessage, billingPaymentRows, billingPaymentSummary, billingPeriodEnd, billingSummary, chronologicalEvents, componentBehaviors, componentCapabilityBaseline, componentContracts, componentIntake, componentReconciliationProposal, currencyMinorUnits, dateTimeInputValue, defaultVizIntent, deriveStartingComponentCount, editVizIntent, evaluateEmissionEligibility, evaluateFoundationV1, formatBillingAmount, formatDateTime, formatDeclaredNumber, formatPriceAmount, formatPriceCode, formatReadOnlyValue, formatRecordLabel, formatReferenceLabel, geoFieldMapping, getBannerToneTokenSet, getBaselineCapability, getStatusPresentation, getToneTokenSet, initialSort, isGovernedComponent, isVizIntentFragment, listStatuses, nextSort, ownershipPhrase, parseBillingAmount, portedComponentContracts, portedScenarios, recipeItemLabels, recordCollectionEvents, relativeTimestampEmptyScenario, resolveStatusIcon, restartedBillingPeriod, sharedScenarios, statusIconMarkup, substitutionContractReport, summarizeSubstitutionReport, summaryValue, svgCarriesTitle, traitEventRows, validMinorUnits, validateComponentIntakeDocument, vizControlFields, vizFieldValue, vizPreviewLayers, vizSummaryRows };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
declare const COMPONENT_CLASSIFICATIONS: readonly ["native", "recipe", "alias", "authoring-only", "merged", "retired"];
|
|
2
2
|
type ComponentClassification = (typeof COMPONENT_CLASSIFICATIONS)[number];
|
|
3
|
-
declare const NUCLEUS_COMPONENT_IDS: readonly ["AddressCollectionPanel", "AddressEditor", "AddressSummaryBadge", "AddressValidationTimeline", "ArchiveEvent", "ArchivePill", "ArchiveSummary", "ArchivedRowOverlay", "AuditEvent", "AuditSummaryCard", "AuditTimeline", "Badge", "Banner", "BillingAmountInput", "BillingCardMeta", "BillingIntervalSelector", "BillingSummaryBadge", "Button", "CancellationBadge", "CancellationEvent", "CancellationForm", "CancellationSummary", "Card", "CardHeader", "Checkbox", "ClassificationBadge", "ClassificationEditor", "ClassificationPanel", "ColorStatePicker", "ColorSwatch", "ColorizedBadge", "CommunicationDetailPanel", "CycleProgressCard", "DatePicker", "DetailHeader", "Dialog", "FilterPanel", "FormLabelGroup", "GeoFieldMappingForm", "GeoResolutionBadge", "GeocodablePreview", "Grid", "InlineLabel", "Input", "LabelCell", "MembershipAuditTimeline", "MembershipPanel", "MessageEventTimeline", "MessageStatusBadge", "OwnerBadge", "OwnershipMeta", "OwnershipSummary", "PaginationBar", "PaymentEventTimeline", "PaymentTimeline", "PreferenceEditor", "PreferencePanel", "PreferenceSummaryBadge", "PreferenceTimeline", "PriceBadge", "PriceCardMeta", "PriceSummary", "RelativeTimestamp", "RoleAssignmentForm", "RoleBadgeList", "SearchInput", "Select", "SortIndicator", "Stack", "StateTransitionEvent", "StatusBadge", "StatusColorLegend", "StatusSelector", "StatusTimeline", "Switch", "Table", "Tabs", "TagInput", "TagManager", "TagPills", "TagSummary", "TemplatePicker", "Text", "Textarea", "TimelineEntryLabel", "VizAreaControls", "VizAreaPreview", "VizAxisControls", "VizAxisSummary", "VizColorControls", "VizColorLegendConfig", "VizEncodingBadge", "VizGraphPreview", "VizHeatmapControls", "VizHeatmapPreview", "VizLineControls", "VizLinePreview", "VizMarkControls", "VizMarkPreview", "VizOpacityControls", "VizOpacitySummary", "VizPointControls", "VizPointPreview", "VizRoleBadge", "VizScaleControls", "VizScaleSummary", "VizScatterControls", "VizScatterPreview", "VizShapeControls", "VizShapeLegend", "VizSizeControls", "VizSizeSummary"];
|
|
3
|
+
declare const NUCLEUS_COMPONENT_IDS: readonly ["AddressCollectionPanel", "AddressEditor", "AddressSummaryBadge", "AddressValidationTimeline", "ArchiveEvent", "ArchivePill", "ArchiveSummary", "ArchivedRowOverlay", "AuditEvent", "AuditSummaryCard", "AuditTimeline", "Badge", "Banner", "BillingAmountInput", "BillingCardMeta", "BillingIntervalSelector", "BillingSummaryBadge", "Button", "CancellationBadge", "CancellationEvent", "CancellationForm", "CancellationSummary", "Card", "CardHeader", "Checkbox", "ClassificationBadge", "ClassificationEditor", "ClassificationPanel", "ColorStatePicker", "ColorSwatch", "ColorizedBadge", "Combobox", "CommunicationDetailPanel", "CycleProgressCard", "DatePicker", "DetailHeader", "Dialog", "FilterPanel", "FormLabelGroup", "GeoFieldMappingForm", "GeoResolutionBadge", "GeocodablePreview", "Grid", "InlineLabel", "Input", "LabelCell", "MembershipAuditTimeline", "MembershipPanel", "MessageEventTimeline", "MessageStatusBadge", "OwnerBadge", "OwnershipMeta", "OwnershipSummary", "PaginationBar", "PaymentEventTimeline", "PaymentTimeline", "PreferenceEditor", "PreferencePanel", "PreferenceSummaryBadge", "PreferenceTimeline", "PriceBadge", "PriceCardMeta", "PriceSummary", "RelativeTimestamp", "RoleAssignmentForm", "RoleBadgeList", "SearchInput", "SegmentedControl", "Select", "SortIndicator", "Stack", "StateTransitionEvent", "StatusBadge", "StatusColorLegend", "StatusSelector", "StatusTimeline", "Switch", "Table", "Tabs", "TagInput", "TagManager", "TagPills", "TagSummary", "TemplatePicker", "Text", "Textarea", "TimelineEntryLabel", "VizAreaControls", "VizAreaPreview", "VizAxisControls", "VizAxisSummary", "VizColorControls", "VizColorLegendConfig", "VizEncodingBadge", "VizGraphPreview", "VizHeatmapControls", "VizHeatmapPreview", "VizLineControls", "VizLinePreview", "VizMarkControls", "VizMarkPreview", "VizOpacityControls", "VizOpacitySummary", "VizPointControls", "VizPointPreview", "VizRoleBadge", "VizScaleControls", "VizScaleSummary", "VizScatterControls", "VizScatterPreview", "VizShapeControls", "VizShapeLegend", "VizSizeControls", "VizSizeSummary"];
|
|
4
4
|
type NucleusComponentId = (typeof NUCLEUS_COMPONENT_IDS)[number];
|
|
5
5
|
declare const HISTORICAL_PORTED_COMPONENT_IDS: readonly ["AuditTimeline", "CancellationSummary", "PaginationBar", "PriceBadge", "RelativeTimestamp", "SearchInput", "StatusBadge", "StatusTimeline"];
|
|
6
6
|
/** @deprecated Historical compatibility cohort; all members belong to NucleusComponentId. */
|
|
@@ -67,10 +67,19 @@ type ScenarioTrigger = {
|
|
|
67
67
|
trigger: 'keyboard' | 'pointer';
|
|
68
68
|
target: string;
|
|
69
69
|
key?: string;
|
|
70
|
+
/**
|
|
71
|
+
* s223-m02 (#2527 ruling 11): keys pressed first on the target, in the same fresh scenario, before key, whose effect is
|
|
72
|
+
* asserted. A combobox's Enter, Home and End act on an open list, which a key such as ArrowDown opens.
|
|
73
|
+
*/
|
|
74
|
+
keys?: readonly string[];
|
|
70
75
|
action?: 'click' | 'select';
|
|
71
76
|
value?: string;
|
|
77
|
+
/**
|
|
78
|
+
* active-option (s223-m02): the target's popup is open (aria-expanded true), its aria-activedescendant names the option
|
|
79
|
+
* whose text is value, and nothing was picked (no event).
|
|
80
|
+
*/
|
|
72
81
|
effect: {
|
|
73
|
-
kind: 'focus' | 'event' | 'value' | 'selected-tab';
|
|
82
|
+
kind: 'focus' | 'event' | 'value' | 'selected-tab' | 'active-option';
|
|
74
83
|
value?: unknown;
|
|
75
84
|
target?: string;
|
|
76
85
|
};
|
|
@@ -86,7 +95,7 @@ type ComponentBehavior = {
|
|
|
86
95
|
|
|
87
96
|
declare const COMPONENT_CONTRACT_VERSION: "1.1.0";
|
|
88
97
|
declare const COMPONENT_CONTRACT_VERSION_1_1: "1.1.0";
|
|
89
|
-
declare const componentContracts: Readonly<Record<"AddressCollectionPanel" | "AddressEditor" | "AddressSummaryBadge" | "AddressValidationTimeline" | "ArchiveEvent" | "ArchivePill" | "ArchiveSummary" | "ArchivedRowOverlay" | "AuditEvent" | "AuditSummaryCard" | "AuditTimeline" | "Badge" | "Banner" | "BillingAmountInput" | "BillingCardMeta" | "BillingIntervalSelector" | "BillingSummaryBadge" | "Button" | "CancellationBadge" | "CancellationEvent" | "CancellationForm" | "CancellationSummary" | "Card" | "CardHeader" | "Checkbox" | "ClassificationBadge" | "ClassificationEditor" | "ClassificationPanel" | "ColorStatePicker" | "ColorSwatch" | "ColorizedBadge" | "CommunicationDetailPanel" | "CycleProgressCard" | "DatePicker" | "DetailHeader" | "Dialog" | "FilterPanel" | "FormLabelGroup" | "GeoFieldMappingForm" | "GeoResolutionBadge" | "GeocodablePreview" | "Grid" | "InlineLabel" | "Input" | "LabelCell" | "MembershipAuditTimeline" | "MembershipPanel" | "MessageEventTimeline" | "MessageStatusBadge" | "OwnerBadge" | "OwnershipMeta" | "OwnershipSummary" | "PaginationBar" | "PaymentEventTimeline" | "PaymentTimeline" | "PreferenceEditor" | "PreferencePanel" | "PreferenceSummaryBadge" | "PreferenceTimeline" | "PriceBadge" | "PriceCardMeta" | "PriceSummary" | "RelativeTimestamp" | "RoleAssignmentForm" | "RoleBadgeList" | "SearchInput" | "Select" | "SortIndicator" | "Stack" | "StateTransitionEvent" | "StatusBadge" | "StatusColorLegend" | "StatusSelector" | "StatusTimeline" | "Switch" | "Table" | "Tabs" | "TagInput" | "TagManager" | "TagPills" | "TagSummary" | "TemplatePicker" | "Text" | "Textarea" | "TimelineEntryLabel" | "VizAreaControls" | "VizAreaPreview" | "VizAxisControls" | "VizAxisSummary" | "VizColorControls" | "VizColorLegendConfig" | "VizEncodingBadge" | "VizGraphPreview" | "VizHeatmapControls" | "VizHeatmapPreview" | "VizLineControls" | "VizLinePreview" | "VizMarkControls" | "VizMarkPreview" | "VizOpacityControls" | "VizOpacitySummary" | "VizPointControls" | "VizPointPreview" | "VizRoleBadge" | "VizScaleControls" | "VizScaleSummary" | "VizScatterControls" | "VizScatterPreview" | "VizShapeControls" | "VizShapeLegend" | "VizSizeControls" | "VizSizeSummary", ComponentContract>>;
|
|
98
|
+
declare const componentContracts: Readonly<Record<"AddressCollectionPanel" | "AddressEditor" | "AddressSummaryBadge" | "AddressValidationTimeline" | "ArchiveEvent" | "ArchivePill" | "ArchiveSummary" | "ArchivedRowOverlay" | "AuditEvent" | "AuditSummaryCard" | "AuditTimeline" | "Badge" | "Banner" | "BillingAmountInput" | "BillingCardMeta" | "BillingIntervalSelector" | "BillingSummaryBadge" | "Button" | "CancellationBadge" | "CancellationEvent" | "CancellationForm" | "CancellationSummary" | "Card" | "CardHeader" | "Checkbox" | "ClassificationBadge" | "ClassificationEditor" | "ClassificationPanel" | "ColorStatePicker" | "ColorSwatch" | "ColorizedBadge" | "Combobox" | "CommunicationDetailPanel" | "CycleProgressCard" | "DatePicker" | "DetailHeader" | "Dialog" | "FilterPanel" | "FormLabelGroup" | "GeoFieldMappingForm" | "GeoResolutionBadge" | "GeocodablePreview" | "Grid" | "InlineLabel" | "Input" | "LabelCell" | "MembershipAuditTimeline" | "MembershipPanel" | "MessageEventTimeline" | "MessageStatusBadge" | "OwnerBadge" | "OwnershipMeta" | "OwnershipSummary" | "PaginationBar" | "PaymentEventTimeline" | "PaymentTimeline" | "PreferenceEditor" | "PreferencePanel" | "PreferenceSummaryBadge" | "PreferenceTimeline" | "PriceBadge" | "PriceCardMeta" | "PriceSummary" | "RelativeTimestamp" | "RoleAssignmentForm" | "RoleBadgeList" | "SearchInput" | "SegmentedControl" | "Select" | "SortIndicator" | "Stack" | "StateTransitionEvent" | "StatusBadge" | "StatusColorLegend" | "StatusSelector" | "StatusTimeline" | "Switch" | "Table" | "Tabs" | "TagInput" | "TagManager" | "TagPills" | "TagSummary" | "TemplatePicker" | "Text" | "Textarea" | "TimelineEntryLabel" | "VizAreaControls" | "VizAreaPreview" | "VizAxisControls" | "VizAxisSummary" | "VizColorControls" | "VizColorLegendConfig" | "VizEncodingBadge" | "VizGraphPreview" | "VizHeatmapControls" | "VizHeatmapPreview" | "VizLineControls" | "VizLinePreview" | "VizMarkControls" | "VizMarkPreview" | "VizOpacityControls" | "VizOpacitySummary" | "VizPointControls" | "VizPointPreview" | "VizRoleBadge" | "VizScaleControls" | "VizScaleSummary" | "VizScatterControls" | "VizScatterPreview" | "VizShapeControls" | "VizShapeLegend" | "VizSizeControls" | "VizSizeSummary", ComponentContract>>;
|
|
90
99
|
|
|
91
100
|
/** Billable's declared defaults; object parameter overrides travel as runtime props. */
|
|
92
101
|
declare const BILLING_INTERVALS: readonly ["monthly", "quarterly", "annual"];
|
|
@@ -174,7 +183,7 @@ declare const SEVERITY_TONES: readonly ["positive", "success", "warning", "criti
|
|
|
174
183
|
* mark keeps the tone's graded text contrast and reads at a badge's 12px and a banner's 16px. React, Vue and HTML all
|
|
175
184
|
* draw from this table.
|
|
176
185
|
*/
|
|
177
|
-
type StatusIconName = 'check' | 'x' | 'alert' | 'info' | 'clock' | 'dots' | 'refresh' | 'pause' | 'ban' | 'pencil' | 'star' | 'undo' | 'lock' | 'unlock' | 'dot';
|
|
186
|
+
type StatusIconName = 'check' | 'x' | 'alert' | 'info' | 'clock' | 'dots' | 'refresh' | 'pause' | 'ban' | 'pencil' | 'star' | 'undo' | 'lock' | 'unlock' | 'dot' | 'chevron-down';
|
|
178
187
|
type StatusIconShape = {
|
|
179
188
|
readonly tag: 'path' | 'circle' | 'rect';
|
|
180
189
|
readonly attrs: Readonly<Record<string, string>>;
|
|
@@ -305,8 +314,15 @@ interface CollectionEvent {
|
|
|
305
314
|
}
|
|
306
315
|
/** Invalid dates cannot participate in a chronological view; ties retain source order. */
|
|
307
316
|
declare function chronologicalEvents(events: readonly CollectionEvent[]): CollectionEvent[];
|
|
317
|
+
/** A number's declared display format (a field's ui_hints.format). */
|
|
318
|
+
type NumberDisplayFormat = 'percent' | 'quantity';
|
|
319
|
+
/**
|
|
320
|
+
* s223-m01 (#2527 ruling 4): a declared number reads as a person writes it. percent holds percent units (12.5 reads
|
|
321
|
+
* 12.5%, -41 reads -41%); quantity is grouped (86420 reads 86,420). Undefined for a value that is not a finite number.
|
|
322
|
+
*/
|
|
323
|
+
declare function formatDeclaredNumber(value: unknown, format: NumberDisplayFormat): string | undefined;
|
|
308
324
|
/** Format declared scalar display fields without changing the underlying record. */
|
|
309
|
-
declare function formatReadOnlyValue(value: unknown, type: string, code?: boolean): string;
|
|
325
|
+
declare function formatReadOnlyValue(value: unknown, type: string, code?: boolean, format?: NumberDisplayFormat): string;
|
|
310
326
|
/** Workflow apps and standalone previews project the same actual record events. */
|
|
311
327
|
declare function recordCollectionEvents(record: Record<string, unknown>, options?: {
|
|
312
328
|
historyField?: string;
|
|
@@ -316,8 +332,20 @@ declare function recordCollectionEvents(record: Record<string, unknown>, options
|
|
|
316
332
|
}>;
|
|
317
333
|
minorUnits?: number;
|
|
318
334
|
}): CollectionEvent[];
|
|
335
|
+
/**
|
|
336
|
+
* s223-m02 (#2527 ruling 13i, #2521): the summary an AddressCollectionPanel shows of a record's addresses, one line per
|
|
337
|
+
* entry (its role, street lines, city, region and postal code) with the entries separated by semicolons, for example
|
|
338
|
+
* "home, 8 Lake Road, Madison, WI, 53703". A generated workflow's store prints the same line (collectionSummary); a single
|
|
339
|
+
* screen and the HTML renderer print it from here. A record with no addresses reads as an empty string.
|
|
340
|
+
*/
|
|
341
|
+
declare function addressCollectionSummary(entries: unknown): string;
|
|
319
342
|
/** A label is authoritative only alongside its actual reference; never infer a related entity. */
|
|
320
343
|
declare function formatReferenceLabel(identifier: unknown, label?: unknown, subject?: string): string;
|
|
344
|
+
/**
|
|
345
|
+
* s223-m01 (#2527 ruling 6): ownership on a card as one phrase, "Owned by Pricing and packaging · team", or by its type
|
|
346
|
+
* alone when the owner has no name to show ("Team-owned"). Undefined when there is nothing to say.
|
|
347
|
+
*/
|
|
348
|
+
declare function ownershipPhrase(ownerLabel?: unknown, ownerType?: unknown, role?: unknown): string | undefined;
|
|
321
349
|
/** Keep authored record keys and the Transaction fallback; UUIDs belong in technical inspection. */
|
|
322
350
|
declare function formatRecordLabel(value: unknown): string;
|
|
323
351
|
|
|
@@ -1712,6 +1740,91 @@ declare const componentBehaviors: {
|
|
|
1712
1740
|
readonly interactionReason: "ColorizedBadge presents content and owns no focusable control or action; authored child actions remain the consumer's responsibility.";
|
|
1713
1741
|
readonly event: readonly [];
|
|
1714
1742
|
};
|
|
1743
|
+
readonly Combobox: {
|
|
1744
|
+
readonly role: "combobox";
|
|
1745
|
+
readonly name: {
|
|
1746
|
+
readonly strategy: "label";
|
|
1747
|
+
readonly target: "input[role=\"combobox\"]";
|
|
1748
|
+
};
|
|
1749
|
+
readonly keyboard: {
|
|
1750
|
+
readonly Tab: "Move focus to the named native control; an open list closes without picking";
|
|
1751
|
+
readonly x: "Type to filter the options by label";
|
|
1752
|
+
readonly ArrowDown: "Open the list and move to the next option";
|
|
1753
|
+
readonly ArrowUp: "Move to the previous option; with the list closed, open it at the last option";
|
|
1754
|
+
readonly Home: "Move to the first option of an open list";
|
|
1755
|
+
readonly End: "Move to the last option of an open list";
|
|
1756
|
+
readonly Enter: "Pick the active option and close the list";
|
|
1757
|
+
readonly Escape: "Close the list; with the list closed, clear the field";
|
|
1758
|
+
};
|
|
1759
|
+
readonly interaction: "interactive";
|
|
1760
|
+
readonly event: readonly [{
|
|
1761
|
+
readonly trigger: "keyboard";
|
|
1762
|
+
readonly target: "input[role=\"combobox\"]";
|
|
1763
|
+
readonly key: "Tab";
|
|
1764
|
+
readonly effect: {
|
|
1765
|
+
readonly kind: "focus";
|
|
1766
|
+
};
|
|
1767
|
+
}, {
|
|
1768
|
+
readonly trigger: "keyboard";
|
|
1769
|
+
readonly target: "input[role=\"combobox\"]";
|
|
1770
|
+
readonly key: "x";
|
|
1771
|
+
readonly effect: {
|
|
1772
|
+
readonly kind: "value";
|
|
1773
|
+
readonly value: "Canadax";
|
|
1774
|
+
};
|
|
1775
|
+
}, {
|
|
1776
|
+
readonly trigger: "keyboard";
|
|
1777
|
+
readonly target: "input[role=\"combobox\"]";
|
|
1778
|
+
readonly key: "ArrowDown";
|
|
1779
|
+
readonly effect: {
|
|
1780
|
+
readonly kind: "active-option";
|
|
1781
|
+
readonly value: "Australia";
|
|
1782
|
+
};
|
|
1783
|
+
}, {
|
|
1784
|
+
readonly trigger: "keyboard";
|
|
1785
|
+
readonly target: "input[role=\"combobox\"]";
|
|
1786
|
+
readonly key: "ArrowUp";
|
|
1787
|
+
readonly effect: {
|
|
1788
|
+
readonly kind: "active-option";
|
|
1789
|
+
readonly value: "United States";
|
|
1790
|
+
};
|
|
1791
|
+
}, {
|
|
1792
|
+
readonly trigger: "keyboard";
|
|
1793
|
+
readonly target: "input[role=\"combobox\"]";
|
|
1794
|
+
readonly keys: readonly ["ArrowUp"];
|
|
1795
|
+
readonly key: "Home";
|
|
1796
|
+
readonly effect: {
|
|
1797
|
+
readonly kind: "active-option";
|
|
1798
|
+
readonly value: "Australia";
|
|
1799
|
+
};
|
|
1800
|
+
}, {
|
|
1801
|
+
readonly trigger: "keyboard";
|
|
1802
|
+
readonly target: "input[role=\"combobox\"]";
|
|
1803
|
+
readonly keys: readonly ["ArrowDown"];
|
|
1804
|
+
readonly key: "End";
|
|
1805
|
+
readonly effect: {
|
|
1806
|
+
readonly kind: "active-option";
|
|
1807
|
+
readonly value: "United States";
|
|
1808
|
+
};
|
|
1809
|
+
}, {
|
|
1810
|
+
readonly trigger: "keyboard";
|
|
1811
|
+
readonly target: "input[role=\"combobox\"]";
|
|
1812
|
+
readonly keys: readonly ["ArrowDown", "ArrowDown", "ArrowDown"];
|
|
1813
|
+
readonly key: "Enter";
|
|
1814
|
+
readonly effect: {
|
|
1815
|
+
readonly kind: "event";
|
|
1816
|
+
readonly value: "fr";
|
|
1817
|
+
};
|
|
1818
|
+
}, {
|
|
1819
|
+
readonly trigger: "keyboard";
|
|
1820
|
+
readonly target: "input[role=\"combobox\"]";
|
|
1821
|
+
readonly key: "Escape";
|
|
1822
|
+
readonly effect: {
|
|
1823
|
+
readonly kind: "event";
|
|
1824
|
+
readonly value: "";
|
|
1825
|
+
};
|
|
1826
|
+
}];
|
|
1827
|
+
};
|
|
1715
1828
|
readonly CycleProgressCard: {
|
|
1716
1829
|
readonly role: "none";
|
|
1717
1830
|
readonly name: {
|
|
@@ -2201,6 +2314,69 @@ declare const componentBehaviors: {
|
|
|
2201
2314
|
};
|
|
2202
2315
|
}];
|
|
2203
2316
|
};
|
|
2317
|
+
readonly SegmentedControl: {
|
|
2318
|
+
readonly role: "radio";
|
|
2319
|
+
readonly name: {
|
|
2320
|
+
readonly strategy: "label";
|
|
2321
|
+
readonly target: "input[type=\"radio\"]:checked";
|
|
2322
|
+
};
|
|
2323
|
+
readonly keyboard: {
|
|
2324
|
+
readonly Tab: "Move focus to the checked option";
|
|
2325
|
+
readonly ArrowRight: "Check and focus the next option";
|
|
2326
|
+
readonly ArrowDown: "Check and focus the next option";
|
|
2327
|
+
readonly ArrowLeft: "Check and focus the previous option";
|
|
2328
|
+
readonly ArrowUp: "Check and focus the previous option";
|
|
2329
|
+
};
|
|
2330
|
+
readonly interaction: "interactive";
|
|
2331
|
+
readonly event: readonly [{
|
|
2332
|
+
readonly trigger: "keyboard";
|
|
2333
|
+
readonly target: "input[type=\"radio\"]:checked";
|
|
2334
|
+
readonly key: "Tab";
|
|
2335
|
+
readonly effect: {
|
|
2336
|
+
readonly kind: "focus";
|
|
2337
|
+
};
|
|
2338
|
+
}, {
|
|
2339
|
+
readonly trigger: "keyboard";
|
|
2340
|
+
readonly target: "input[type=\"radio\"]:checked";
|
|
2341
|
+
readonly key: "ArrowRight";
|
|
2342
|
+
readonly effect: {
|
|
2343
|
+
readonly kind: "event";
|
|
2344
|
+
readonly value: "yearly";
|
|
2345
|
+
};
|
|
2346
|
+
}, {
|
|
2347
|
+
readonly trigger: "keyboard";
|
|
2348
|
+
readonly target: "input[type=\"radio\"]:checked";
|
|
2349
|
+
readonly key: "ArrowDown";
|
|
2350
|
+
readonly effect: {
|
|
2351
|
+
readonly kind: "event";
|
|
2352
|
+
readonly value: "yearly";
|
|
2353
|
+
};
|
|
2354
|
+
}, {
|
|
2355
|
+
readonly trigger: "keyboard";
|
|
2356
|
+
readonly target: "input[type=\"radio\"]:checked";
|
|
2357
|
+
readonly key: "ArrowLeft";
|
|
2358
|
+
readonly effect: {
|
|
2359
|
+
readonly kind: "event";
|
|
2360
|
+
readonly value: "monthly";
|
|
2361
|
+
};
|
|
2362
|
+
}, {
|
|
2363
|
+
readonly trigger: "keyboard";
|
|
2364
|
+
readonly target: "input[type=\"radio\"]:checked";
|
|
2365
|
+
readonly key: "ArrowUp";
|
|
2366
|
+
readonly effect: {
|
|
2367
|
+
readonly kind: "event";
|
|
2368
|
+
readonly value: "monthly";
|
|
2369
|
+
};
|
|
2370
|
+
}, {
|
|
2371
|
+
readonly trigger: "pointer";
|
|
2372
|
+
readonly target: "input[value=\"yearly\"]";
|
|
2373
|
+
readonly effect: {
|
|
2374
|
+
readonly kind: "event";
|
|
2375
|
+
readonly value: "yearly";
|
|
2376
|
+
};
|
|
2377
|
+
readonly action: "click";
|
|
2378
|
+
}];
|
|
2379
|
+
};
|
|
2204
2380
|
readonly Select: {
|
|
2205
2381
|
readonly role: "combobox";
|
|
2206
2382
|
readonly name: {
|
|
@@ -3220,4 +3396,4 @@ declare function getBaselineCapability(componentId: string): {
|
|
|
3220
3396
|
};
|
|
3221
3397
|
} | undefined;
|
|
3222
3398
|
|
|
3223
|
-
export { type AuditSummaryValues, BILLING_AMOUNT_ERROR, BILLING_INTERVALS, BILLING_INTERVAL_ERROR, BILLING_MINOR_UNITS, type BillingAmountResult, type BillingCycleValues, type BillingPaymentValues, COMPONENT_CLASSIFICATIONS, COMPONENT_CONTRACT_VERSION, COMPONENT_CONTRACT_VERSION_1_1, type CollectionEvent, type ComponentBehavior, type ComponentClassification, type ComponentContract, DEFAULT_COLOR_STATES, EMISSION_ELIGIBILITY_EVIDENCE_CLASSES, type EmissionEligibilityEvidence, type EmissionEligibilityEvidenceClass, type EvidenceResult, type EvidenceStatus, FOUNDATION_V1_EVIDENCE_CLASSES, type FoundationV1Evidence, type FoundationV1EvidenceClass, GOVERNED_DEFINITION, GOVERNED_SURFACES, type GeoFieldMappingValue, type GovernedComponentId, type GovernedLedgerRow, NO_LAST_PAYMENT, NO_NEXT_PAYMENT, NUCLEUS_COMPONENT_IDS, type NucleusComponentId, type ObligationStatus, PORTED_COMPONENT_IDS, type PortedComponentId, RESULT_STATES, RESULT_STATE_TONE, type ResultState, SEVERITY_TONES, STATUS_DOMAINS, STATUS_ICON_SHAPES, STATUS_ICON_SVG_ATTRS, type ScenarioTrigger, type SharedScenario, type SortIndicatorValues, type SortState, type StatusDomain, type StatusIconName, type StatusIconShape, type StatusPresentation, type StatusTokenSet, type StatusTone, type SubstitutionContractReport, type SubstitutionObligation, type TraitEventKind, type TraitEventValues, UI_WORKFLOW_STATES, type UiWorkflowState, VIZ_CONTROL_IDS, VIZ_CONTROL_TITLES, VIZ_PREVIEW_TYPES, VIZ_SUMMARY_IDS, VIZ_SVG_PROPS, VIZ_THEME_SVG_PROPS, type VizChannel, type VizChartType, type VizColorBinding, type VizControlField, type VizControlId, type VizFieldBinding, type VizIntentFragment, type VizPreviewLayer, type VizPreviewTheme, type VizRenderAttribute, type VizScale, type VizSummaryId, type VizThemeSvgProp, ariaSort, assertStaticSvg, auditSummary, billingAmountMessage, billingAmountText, billingCycle, billingDate, billingIntervalMessage, billingPaymentRows, billingPaymentSummary, billingPeriodEnd, billingSummary, chronologicalEvents, componentBehaviors, componentCapabilityBaseline, componentContracts, componentIntake, componentReconciliationProposal, currencyMinorUnits, dateTimeInputValue, defaultVizIntent, deriveStartingComponentCount, editVizIntent, evaluateEmissionEligibility, evaluateFoundationV1, formatBillingAmount, formatDateTime, formatPriceAmount, formatPriceCode, formatReadOnlyValue, formatRecordLabel, formatReferenceLabel, geoFieldMapping, getBannerToneTokenSet, getBaselineCapability, getStatusPresentation, getToneTokenSet, initialSort, isGovernedComponent, isVizIntentFragment, listStatuses, nextSort, parseBillingAmount, portedComponentContracts, portedScenarios, recipeItemLabels, recordCollectionEvents, relativeTimestampEmptyScenario, resolveStatusIcon, restartedBillingPeriod, sharedScenarios, statusIconMarkup, substitutionContractReport, summarizeSubstitutionReport, summaryValue, svgCarriesTitle, traitEventRows, validMinorUnits, validateComponentIntakeDocument, vizControlFields, vizFieldValue, vizPreviewLayers, vizSummaryRows };
|
|
3399
|
+
export { type AuditSummaryValues, BILLING_AMOUNT_ERROR, BILLING_INTERVALS, BILLING_INTERVAL_ERROR, BILLING_MINOR_UNITS, type BillingAmountResult, type BillingCycleValues, type BillingPaymentValues, COMPONENT_CLASSIFICATIONS, COMPONENT_CONTRACT_VERSION, COMPONENT_CONTRACT_VERSION_1_1, type CollectionEvent, type ComponentBehavior, type ComponentClassification, type ComponentContract, DEFAULT_COLOR_STATES, EMISSION_ELIGIBILITY_EVIDENCE_CLASSES, type EmissionEligibilityEvidence, type EmissionEligibilityEvidenceClass, type EvidenceResult, type EvidenceStatus, FOUNDATION_V1_EVIDENCE_CLASSES, type FoundationV1Evidence, type FoundationV1EvidenceClass, GOVERNED_DEFINITION, GOVERNED_SURFACES, type GeoFieldMappingValue, type GovernedComponentId, type GovernedLedgerRow, NO_LAST_PAYMENT, NO_NEXT_PAYMENT, NUCLEUS_COMPONENT_IDS, type NucleusComponentId, type NumberDisplayFormat, type ObligationStatus, PORTED_COMPONENT_IDS, type PortedComponentId, RESULT_STATES, RESULT_STATE_TONE, type ResultState, SEVERITY_TONES, STATUS_DOMAINS, STATUS_ICON_SHAPES, STATUS_ICON_SVG_ATTRS, type ScenarioTrigger, type SharedScenario, type SortIndicatorValues, type SortState, type StatusDomain, type StatusIconName, type StatusIconShape, type StatusPresentation, type StatusTokenSet, type StatusTone, type SubstitutionContractReport, type SubstitutionObligation, type TraitEventKind, type TraitEventValues, UI_WORKFLOW_STATES, type UiWorkflowState, VIZ_CONTROL_IDS, VIZ_CONTROL_TITLES, VIZ_PREVIEW_TYPES, VIZ_SUMMARY_IDS, VIZ_SVG_PROPS, VIZ_THEME_SVG_PROPS, type VizChannel, type VizChartType, type VizColorBinding, type VizControlField, type VizControlId, type VizFieldBinding, type VizIntentFragment, type VizPreviewLayer, type VizPreviewTheme, type VizRenderAttribute, type VizScale, type VizSummaryId, type VizThemeSvgProp, addressCollectionSummary, ariaSort, assertStaticSvg, auditSummary, billingAmountMessage, billingAmountText, billingCycle, billingDate, billingIntervalMessage, billingPaymentRows, billingPaymentSummary, billingPeriodEnd, billingSummary, chronologicalEvents, componentBehaviors, componentCapabilityBaseline, componentContracts, componentIntake, componentReconciliationProposal, currencyMinorUnits, dateTimeInputValue, defaultVizIntent, deriveStartingComponentCount, editVizIntent, evaluateEmissionEligibility, evaluateFoundationV1, formatBillingAmount, formatDateTime, formatDeclaredNumber, formatPriceAmount, formatPriceCode, formatReadOnlyValue, formatRecordLabel, formatReferenceLabel, geoFieldMapping, getBannerToneTokenSet, getBaselineCapability, getStatusPresentation, getToneTokenSet, initialSort, isGovernedComponent, isVizIntentFragment, listStatuses, nextSort, ownershipPhrase, parseBillingAmount, portedComponentContracts, portedScenarios, recipeItemLabels, recordCollectionEvents, relativeTimestampEmptyScenario, resolveStatusIcon, restartedBillingPeriod, sharedScenarios, statusIconMarkup, substitutionContractReport, summarizeSubstitutionReport, summaryValue, svgCarriesTitle, traitEventRows, validMinorUnits, validateComponentIntakeDocument, vizControlFields, vizFieldValue, vizPreviewLayers, vizSummaryRows };
|