react-semaphor 0.1.372 → 0.1.373

package/dist/types/data-app-sdk.d.ts

@@ -54,6 +54,26 @@ declare type MatrixAxisPayload = {
     nodes: MatrixNode[];
 };
 
+declare type MatrixAxisResultPayload = {
+    id: 'rows' | 'columns';
+    levels: MatrixAxisLevelDescriptor[];
+    nodeIds: string[];
+};
+
+declare type MatrixCalculationDescriptor = {
+    id: string;
+    measureId: string;
+    aggregate?: SemaphorAggregateFunction;
+    label?: string;
+    source: 'measureDefault' | 'rowSubtotal' | 'columnSubtotal' | 'subtotalIntersection' | 'rowGrandTotal' | 'columnGrandTotal' | 'matrixGrandTotal' | 'custom';
+    scope?: {
+        rowLevelId?: string;
+        columnLevelId?: string;
+        rowNodeId?: string;
+        columnNodeId?: string;
+    };
+};
+
 declare type MatrixCapability = 'rowHierarchy' | 'columnHierarchy' | 'rowSubtotals' | 'columnSubtotals' | 'grandTotals' | 'lazyRows' | 'lazyColumns' | 'conditionalFormatting' | 'visualExport' | (string & {});
 
 declare type MatrixCell = {
@@ -61,8 +81,6 @@ declare type MatrixCell = {
     rowNodeId: string;
     columnNodeId?: string;
     measureInstanceId: string;
-    rowPath: MatrixMemberPathSegment[];
-    columnPath: MatrixMemberPathSegment[];
     rawValue: unknown;
     presence: MatrixCellPresence;
     formattedValue?: string;
@@ -83,8 +101,6 @@ declare type MatrixCellFormattingScope = {
     columnNodeId?: string;
     measureInstanceId: string;
     role: MatrixCellRole;
-    rowPath: MatrixMemberPathSegment[];
-    columnPath: MatrixMemberPathSegment[];
 };
 
 declare type MatrixCellPresence = 'present' | 'presentNull' | 'missing' | 'densified';
@@ -147,8 +163,6 @@ declare type MatrixGridCell = {
     presence: MatrixCellPresence;
     role: MatrixCellRole;
     measureInstanceId: string;
-    rowPath: MatrixMemberPathSegment[];
-    columnPath: MatrixMemberPathSegment[];
 };
 
 declare type MatrixGridColumn = {
@@ -202,15 +216,26 @@ declare type MatrixGridRowHeaderLevel = {
     fieldInstanceId: string;
 };
 
+declare type MatrixLayoutProjection = {
+    rowHeaderLevels: MatrixGridRowHeaderLevel[];
+    columnHeaderRows: MatrixGridHeaderRow[];
+    columns: MatrixGridColumn[];
+};
+
 declare type MatrixMeasureDescriptor = {
     instanceId: string;
     fieldKey: string;
     label: string;
     field: SemaphorFieldRef;
     aggregate?: SemaphorAggregateFunction;
+    format?: SemaphorValueFormat;
     totalBehavior?: SemaphorMatrixTotalCalculation;
 };
 
+declare type MatrixMeasureResultDescriptor = MatrixMeasureDescriptor & {
+    semantics: MatrixMeasureSemantics;
+};
+
 declare type MatrixMeasureSemantics = {
     kind: 'additive';
     aggregate?: SemaphorAggregateFunction;
@@ -304,6 +329,17 @@ declare type MatrixResolvedSort = {
     by: SemaphorMatrixSortRule['by'];
 };
 
+declare type MatrixResultCell = {
+    rowId: string;
+    columnId?: string;
+    measureId: string;
+    value: unknown;
+    formattedValue?: string;
+    presence: MatrixCellPresence;
+    role: MatrixCellRole;
+    calculationId?: string;
+};
+
 declare type MatrixShape = 'hierarchical' | 'pivot';
 
 declare type MatrixTotals = {
@@ -684,7 +720,7 @@ export declare type SemaphorDerivedFieldDefinition = {
     defaultAggregate?: SemaphorAggregateFunction;
     aggregationBehavior?: SemaphorDerivedFieldAggregationBehavior;
     aggregationStrategy?: SemaphorDerivedFieldAggregationStrategy;
-    format?: unknown;
+    format?: SemaphorValueFormat;
     tags?: string[];
 };
 
@@ -912,7 +948,11 @@ declare type SemaphorMatrixMemberPathSegment = {
 };
 
 export declare type SemaphorMatrixPayload = {
-    payload?: MatrixPayload;
+    matrixResult?: SemaphorMatrixResult;
+    /**
+     * Client-side derived projection for matrix renderers. The canonical server
+     * response is matrixResult.
+     */
     grid?: MatrixGridProjection;
     expansion?: MatrixExpansionResponseHints;
     executionResult?: SemaphorAnalyticsExecutionResult;
@@ -942,9 +982,25 @@ export declare type SemaphorMatrixQuerySpec = Omit<SemaphorMatrixIntent, 'kind'
 
 declare type SemaphorMatrixResult = SemaphorAnalyticsResultBase & {
     kind: 'matrix';
-    intent: SemaphorMatrixIntent;
-    payload: MatrixPayload;
-    grid: MatrixGridProjection;
+    schemaVersion: 1;
+    intent?: SemaphorMatrixIntent;
+    shape: MatrixShape;
+    capabilities: MatrixCapability[];
+    executionMetadata: MatrixExecutionMetadata;
+    fieldsById: Record<string, MatrixFieldDescriptor>;
+    measuresById: Record<string, MatrixMeasureResultDescriptor>;
+    calculationsById?: Record<string, MatrixCalculationDescriptor>;
+    axes: {
+        rows: MatrixAxisResultPayload;
+        columns: MatrixAxisResultPayload;
+    };
+    nodesById: Record<string, MatrixNode>;
+    layout: MatrixLayoutProjection;
+    cells: MatrixResultCell[];
+    totals: MatrixTotals;
+    sort: MatrixResolvedSort[];
+    formattingContext: MatrixFormattingContext;
+    pageInfo?: MatrixPageInfo;
     expansion?: MatrixExpansionResponseHints;
 };
 
@@ -1011,6 +1067,7 @@ export declare type SemaphorMatrixValueField = {
     field: SemaphorFieldRef;
     aggregate?: SemaphorAggregateFunction;
     label?: string;
+    format?: SemaphorValueFormat;
     totalBehavior?: SemaphorMatrixTotalCalculation;
 };
 
@@ -1402,6 +1459,44 @@ declare type SemaphorTimeGrain = 'hour' | 'day' | 'week' | 'month' | 'quarter' |
 
 export declare type SemaphorTimeWindow = SemaphorRelativeTimeWindow | SemaphorAbsoluteTimeWindow;
 
+declare type SemaphorValueFormat = {
+    type: 'number' | 'currency' | 'percent' | 'percentage' | 'scientific';
+    locale?: string;
+    minimumFractionDigits?: number;
+    maximumFractionDigits?: number;
+    useGrouping?: boolean;
+    prefix?: string;
+    suffix?: string;
+    negativeStyle?: 'minus' | 'parentheses';
+    compact?: boolean;
+    scale?: number;
+    currency?: string;
+    percentValueMode?: 'fraction' | 'whole';
+} | {
+    type: 'date' | 'datetime';
+    locale?: string;
+    pattern?: string;
+    relative?: boolean;
+    timezone?: string;
+    sourceTimezone?: string;
+    prefix?: string;
+    suffix?: string;
+} | {
+    type: 'duration';
+    inputUnit?: 'millisecond' | 'second' | 'minute' | 'hour' | 'day';
+    outputStyle?: 'compact' | 'digital' | 'long';
+    largestUnit?: 'millisecond' | 'second' | 'minute' | 'hour' | 'day';
+    smallestUnit?: 'millisecond' | 'second' | 'minute' | 'hour' | 'day';
+    maxUnits?: number;
+    prefix?: string;
+    suffix?: string;
+    negativeStyle?: 'minus' | 'parentheses';
+} | {
+    type: 'string';
+    prefix?: string;
+    suffix?: string;
+};
+
 export declare function toSemaphorActiveInputSnapshots(inputs: SemaphorInputReference[] | undefined): SemaphorActiveInput[];
 
 export declare function toSemaphorAnalysisIntent(spec: SemaphorAnalysisQuerySpec): SemaphorMetricIntent;