@nivaro/react 0.1.248 → 0.1.250

package/dist/index.d.ts

@@ -1711,6 +1711,47 @@ export declare type GridFlushContextValue = {
     unregister: (key: string) => void;
 };
 
+/**
+ * A one-click rewrite of every row in the grid, driven by an aggregate of a
+ * related collection.
+ *
+ * EFP's "Close Out Lines" is one instance of this shape: for each REQ line,
+ * sum `open_unbilled_amount` across the PO lines pointing at it and, where the
+ * line covers that remainder, subtract it. Expressed as config rather than
+ * EFP code so any collection can do the same:
+ *
+ *   {label:'Close Out Lines', relation:'po_line_items',
+ *    aggregate:{field:'open_unbilled_amount', op:'sum'},
+ *    guard:'{{amount}} >= {{__agg__}}',
+ *    set:{amount:'{{amount}} - {{__agg__}}'}}
+ *
+ * `{{__agg__}}` is the aggregate for that row (same token match-agg-column
+ * uses); every other `{{field}}` reads the row's current value. Rows failing
+ * the guard are left exactly as they are.
+ *
+ * Writes go through the SAME paths a manual cell edit uses, so a staged grid
+ * (new record, addendum, save_mode 'pending') stages the change and an
+ * immediate grid PATCHes it — the action never invents its own persistence.
+ */
+declare interface GridStatConfig {
+    label: string;
+    /** Expression — `{{$parent.requisition_amount}} - {{$sum.total}}`. */
+    value: string;
+    format?: 'currency' | 'number';
+    /** 'danger' paints a negative result red (the "over" state). */
+    negative?: 'danger';
+}
+
+declare interface GridSumCapConfig {
+    /** Column summed over the grid (write-computed columns are derived per row). */
+    field: string;
+    /** Expression for the ceiling — `{{$parent.requisition_amount}}`. */
+    cap: string;
+    format?: 'currency' | 'number';
+    label?: string;
+    message?: string;
+}
+
 export declare interface HeaderWidgetInfo {
     field: string;
     widgetId: number;
@@ -1937,7 +1978,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, 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, sumCap, submissionErrors, prefillParentId, parentFieldKey, readOnly, emptyLabel, editorMode }: {
     relatedCollection: string;
     manyField: string;
     parentId: string;
@@ -2000,6 +2041,16 @@ export declare function InlineTableField({ relatedCollection, manyField, parentI
     } | null;
     /** options.row_lints — "when X, expect Y" checks judged per row on the client. */
     rowLints?: RowLint[] | null;
+    /** options.stats — a figure strip above the grid (both modes). Each value is
+     *  an expression over `{{$parent.<field>}}` (the parent record's draft),
+     *  `{{$sum.<column>}}` (that column summed over the rows on screen, staged
+     *  edits and the row being typed into included) and `{{$count}}`. A
+     *  negative result reads red when `negative` is 'danger'. */
+    stats?: GridStatConfig[] | 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. */
+    sumCap?: GridSumCapConfig | null;
     /** Flag rows a failed ERP push rejected (options.submission_errors) — the
      *  latest failed nivaro_erp_submissions row for the PARENT record is parsed
      *  for "LineNumber N: reason" entries and matching rows tint red with the
@@ -4176,28 +4227,6 @@ export declare const ROW_HIGHLIGHT_TINTS: Record<string, {
     text: string;
 }>;
 
-/**
- * A one-click rewrite of every row in the grid, driven by an aggregate of a
- * related collection.
- *
- * EFP's "Close Out Lines" is one instance of this shape: for each REQ line,
- * sum `open_unbilled_amount` across the PO lines pointing at it and, where the
- * line covers that remainder, subtract it. Expressed as config rather than
- * EFP code so any collection can do the same:
- *
- *   {label:'Close Out Lines', relation:'po_line_items',
- *    aggregate:{field:'open_unbilled_amount', op:'sum'},
- *    guard:'{{amount}} >= {{__agg__}}',
- *    set:{amount:'{{amount}} - {{__agg__}}'}}
- *
- * `{{__agg__}}` is the aggregate for that row (same token match-agg-column
- * uses); every other `{{field}}` reads the row's current value. Rows failing
- * the guard are left exactly as they are.
- *
- * Writes go through the SAME paths a manual cell edit uses, so a staged grid
- * (new record, addendum, save_mode 'pending') stages the change and an
- * immediate grid PATCHes it — the action never invents its own persistence.
- */
 declare interface RowBulkActionConfig {
     label: string;
     /** O2M alias on the ROW's collection pointing at the rows to aggregate. */