@nivaro/react 0.1.259 → 0.1.260

package/dist/index.d.ts

@@ -894,6 +894,36 @@ export declare function CommentPanel({ collection, item, title, defaultExpanded,
     onQueueComment?: (text: string) => void;
 }): React_2.JSX.Element;
 
+/**
+ * Comparison series for an inline grid (`options.compare_series`).
+ *
+ * A second, read-only line of figures under the grid's own cells — "what
+ * actually happened" beside "what was planned" — fetched from an endpoint the
+ * layout names. The grid stays domain-blind: the endpoint says which row key
+ * and columns it speaks about, which columns are closed (final), the verdict
+ * it wants shown, and what each figure is made of. Any month × key planning
+ * grid whose "what really happened" lives elsewhere fits the contract — the
+ * nouns (what a detail row IS, what the grid's own figures are called) come
+ * from the endpoint too, so this file never names a domain.
+ *
+ * Contract (endpoint response, under `data`):
+ *   label            'Actual' — the series name
+ *   plan_label       'Plan' — what the grid's own figures are called (default 'Plan')
+ *   unit             { one, many } — the noun for a detail row (default entry/entries)
+ *   key_field        the grid column that identifies a row (e.g. 'year')
+ *   columns          the grid columns the series speaks about
+ *   rows[]           { key, values: {column: number}, details?: {column: DetailRow[]} }
+ *   closed_through   'YYYY-MM' | null — month columns at or before it are final
+ *   closed_rule      one sentence explaining how a month closes
+ *   status           { key, label, tone, reason } | null — the verdict + why
+ *   figures[]        { label, value, format } — strip chips beside the grid's own
+ */
+declare interface CompareSeriesConfig {
+    /** `/my-extension/actuals/{{$parent.id}}` — `{{$parent.<field>}}` tokens read the parent draft. */
+    endpoint: string;
+    label?: string;
+}
+
 export declare type ComponentOverrides = {
     text?: default_2.ComponentType<FieldComponentProps>;
     textarea?: default_2.ComponentType<FieldComponentProps>;
@@ -2000,7 +2030,7 @@ export declare function InboundCallersView({ hours: initialHours }: {
     hours?: number;
 }): JSX.Element;
 
-export declare function InlineTableField({ relatedCollection, manyField, parentId, parentCollection, layoutId, showRowRevisions, rowComments, allowRevisionRestore, saveMode, showLineNumbers, enableReorder, parentCascades, rowRules, columnPresets, defaultPreset, drawerRelations, parentContextFields, uniqueBy, sortField, sortDir, sectionGroupBy, freezeFirstColumn, rowFilter, rowDefaults, allocateDrawer, autoAllocate, rowBulkActions, uploadTemplate, rowMatchPanel, lineSla, rowLints, stats, sumCap, spreadRemaining, submissionErrors, prefillParentId, parentFieldKey, readOnly, emptyLabel, editorMode }: {
+export declare function InlineTableField({ relatedCollection, manyField, parentId, parentCollection, layoutId, showRowRevisions, rowComments, allowRevisionRestore, saveMode, showLineNumbers, enableReorder, parentCascades, rowRules, columnPresets, defaultPreset, drawerRelations, parentContextFields, uniqueBy, sortField, sortDir, sectionGroupBy, freezeFirstColumn, rowFilter, rowDefaults, allocateDrawer, autoAllocate, rowBulkActions, uploadTemplate, rowMatchPanel, lineSla, rowLints, stats, compareSeries, sumCap, spreadRemaining, submissionErrors, prefillParentId, parentFieldKey, readOnly, emptyLabel, editorMode }: {
     relatedCollection: string;
     manyField: string;
     parentId: string;
@@ -2069,6 +2099,11 @@ export declare function InlineTableField({ relatedCollection, manyField, parentI
      *  edits and the row being typed into included) and `{{$count}}`. A
      *  negative result reads red when `negative` is 'danger'. */
     stats?: GridStatConfig[] | null;
+    /** options.compare_series — a second, read-only line of figures under the
+     *  cells ("what actually happened" beside the plan) fetched from an endpoint
+     *  the layout names; closed columns shade, a verdict chip leads the strip,
+     *  each figure opens the rows behind it. See CompareSeries.tsx. */
+    compareSeries?: CompareSeriesConfig | null;
     /** options.sum_cap — refuse to save/stage a row when `field` summed over the
      *  grid (this row's draft included) would exceed `cap` (same tokens as
      *  stats). The client twin of the server's sum_cap validation rule. */