@agile-team/mach-report 2.16.0 → 2.17.0

package/dist/server.d.ts

@@ -35,6 +35,8 @@ declare interface AssetRenderBudget {
 
 declare interface AssetRenderOptions extends OutputDiagnosticOptions, ImageMediaOptions {
     assetRenderers?: Partial<Record<ImageComponentKind, ComponentImageRenderer>>;
+    /** Explicit id/version registry; unbound components continue using assetRenderers by kind. */
+    assetRegistry?: ComponentAssetRegistry;
     assetBudget?: AssetRenderBudget;
     /** Default throw prevents an incomplete export; placeholder retains the component and emits diagnostics. */
     assetFailure?: "throw" | "placeholder";
@@ -117,6 +119,11 @@ declare type ColumnFormat_2 = {
     pattern?: string;
 };
 
+declare interface ComponentAssetRegistry {
+    rendererFor(component: Readonly<PlanComponent>): ComponentImageRenderer | undefined;
+    hasExtension(id: string, version: string, kind: string): boolean;
+}
+
 /** A literal own field of the current label record; expressions and paths are not evaluated. */
 declare interface ComponentBinding {
     field: string;
@@ -219,6 +226,9 @@ declare interface ComputedField_2 extends ExpressionOptions_2 {
 
 export declare function createManagerTemplateCatalog(manager: ReportTemplateManager, metadata?: (document: ReportTemplateDocument) => Pick<LocalTemplateCatalogItem, "category" | "tags">): ReportTemplateCatalogProvider;
 
+/** Bounded, single-process reference store. Scope is host-authorized identity, never a client permission. */
+export declare function createMemoryReportDocumentStore(options?: ReportDocumentBudget): ReportDocumentStore;
+
 /** Session-local intents; durable hosts should supply their own authorized stable IDs. */
 export declare function createMemoryReportInstanceIds(maximum?: number): {
     forCase(templateId: string, caseId: string): string;
@@ -270,6 +280,13 @@ export declare function createReportInstanceManager(store: ReportInstanceStore,
 /** Durable at-least-once dispatch; export/artifact handlers must be idempotent by scope+taskId. */
 export declare function createReportJobService(options: ReportJobServiceOptions): ReportJobService;
 
+/** OpenAPI 3.1 for the minimal Java/Node wire contract. Host registers routes and authorizes IDs before describe(). */
+export declare function createReportOpenApi(descriptions: readonly ReportDescription[], options?: {
+    title?: string;
+    version?: string;
+    basePath?: string;
+}): Record<string, unknown>;
+
 /** 无 Vue、无 HTTP 框架的可选服务端外观；PDF/Excel 仅在对应 export 调用时加载。 */
 export declare function createReportRuntime(options: ReportRuntimeOptions): ReportRuntime;
 
@@ -709,6 +726,46 @@ declare interface LocalTemplateCatalogItem {
     tags?: string[];
 }
 
+declare interface MatrixAxisOptions {
+    /** Display names in the same outer-to-inner order as the dimension fields. */
+    labels?: readonly string[];
+    /** Per-level sibling order; omitted levels retain first-seen order. */
+    sort?: readonly MatrixDimensionOrder[];
+    /** One-based prefix depths. Leaf depths are not subtotals. */
+    subtotals?: readonly number[];
+}
+
+declare interface MatrixAxisOptions_2 {
+    /** Display names in the same outer-to-inner order as the dimension fields. */
+    labels?: readonly string[];
+    /** Per-level sibling order; omitted levels retain first-seen order. */
+    sort?: readonly MatrixDimensionOrder_2[];
+    /** One-based prefix depths. Leaf depths are not subtotals. */
+    subtotals?: readonly number[];
+}
+
+declare type MatrixDimensionOrder = "source" | "asc" | "desc";
+
+declare type MatrixDimensionOrder_2 = "source" | "asc" | "desc";
+
+declare interface MatrixHierarchyOptions {
+    row?: MatrixAxisOptions;
+    column?: MatrixAxisOptions;
+    /** Only null/missing values use this label; empty strings and zero stay distinct. */
+    emptyLabel?: string;
+    subtotalLabel?: string;
+    totalLabel?: string;
+}
+
+declare interface MatrixHierarchyOptions_2 {
+    row?: MatrixAxisOptions_2;
+    column?: MatrixAxisOptions_2;
+    /** Only null/missing values use this label; empty strings and zero stay distinct. */
+    emptyLabel?: string;
+    subtotalLabel?: string;
+    totalLabel?: string;
+}
+
 declare interface MatrixTableOptions {
     rowFields: readonly string[];
     columnFields: readonly string[];
@@ -723,6 +780,10 @@ declare interface MatrixTableOptions {
     maxColumns?: number;
     maxInputRows?: number;
     maxCells?: number;
+    /** Opt-in hierarchical dimensions, physical merged headers and prefix subtotals. */
+    hierarchy?: MatrixHierarchyOptions;
+    /** Hierarchical aggregate work, checked before measure reads; default 10 million updates. */
+    maxAggregateUpdates?: number;
 }
 
 declare interface MatrixTableOptions_2 {
@@ -739,6 +800,10 @@ declare interface MatrixTableOptions_2 {
     maxColumns?: number;
     maxInputRows?: number;
     maxCells?: number;
+    /** Opt-in hierarchical dimensions, physical merged headers and prefix subtotals. */
+    hierarchy?: MatrixHierarchyOptions_2;
+    /** Hierarchical aggregate work, checked before measure reads; default 10 million updates. */
+    maxAggregateUpdates?: number;
 }
 
 export declare interface MemoryReportInstanceStoreOptions {
@@ -758,6 +823,11 @@ declare interface OutputDiagnostic {
     componentPath?: readonly number[];
     kind: string;
     nid?: string;
+    /** Declarative extension identity only; no property values or business binding data enter diagnostics. */
+    extension?: {
+        id: string;
+        version: string;
+    };
     message: string;
 }
 
@@ -940,6 +1010,21 @@ export declare interface PreparedReport {
 
 declare type PublicationAssets = Omit<AssetRenderOptions, "signal">;
 
+/** Progressive consumption ends at the currently committed boundary; caller may resume with nextPage. */
+export declare function readReportDocumentPages(store: ReportDocumentStore, input: {
+    scope: string;
+    id: string;
+    version: string;
+    fromPage?: number;
+    limit?: number;
+    maxBytes?: number;
+    signal?: AbortSignal;
+}): Promise<{
+    manifest: ReportDocumentManifest;
+    pages: PlanPage[];
+    nextPage: number;
+}>;
+
 declare interface RenderPlan {
     schemaVersion: string;
     /** 编辑需要模板重算上下文；跨 Worker/JSON 保留要求，但不声明本地会话可用。 */
@@ -947,6 +1032,8 @@ declare interface RenderPlan {
     pages: PlanPage[];
 }
 
+export declare const REPORT_HTTP_CONTRACT_VERSION = "1.0";
+
 export declare interface ReportBatchCase {
     id: string;
     params: Record<string, string>;
@@ -1085,6 +1172,46 @@ declare interface ReportDiagnostic {
     target?: ReportDataTarget;
 }
 
+export declare interface ReportDocumentBudget {
+    maxDocuments?: number;
+    maxBytes?: number;
+    maxPages?: number;
+    maxPageBytes?: number;
+    maxManifestBytes?: number;
+}
+
+export declare class ReportDocumentError extends Error {
+    readonly code: "input" | "capacity" | "conflict" | "missing" | "closed";
+    constructor(code: "input" | "capacity" | "conflict" | "missing" | "closed", message: string);
+}
+
+export declare interface ReportDocumentManifest {
+    scope: string;
+    id: string;
+    version: string;
+    /** CAS token increases after each append and completion. */
+    revision: number;
+    state: "building" | "complete" | "failed";
+    failure?: {
+        code: "cancelled" | "generation";
+        message: string;
+    };
+    pageCount: number;
+    bytes: number;
+    plan: Omit<RenderPlan, "pages">;
+    metadata?: Omit<PreparedReport, "plan">;
+}
+
+export declare interface ReportDocumentStore {
+    create(input: Pick<ReportDocumentManifest, "scope" | "id" | "version" | "plan">, signal?: AbortSignal): Promise<ReportDocumentManifest>;
+    append(scope: string, id: string, version: string, expectedRevision: number, page: PlanPage, signal?: AbortSignal): Promise<ReportDocumentManifest>;
+    complete(scope: string, id: string, version: string, expectedRevision: number, metadata?: Omit<PreparedReport, "plan">, signal?: AbortSignal): Promise<ReportDocumentManifest>;
+    fail(scope: string, id: string, version: string, expectedRevision: number, failure: NonNullable<ReportDocumentManifest["failure"]>): Promise<ReportDocumentManifest>;
+    read(scope: string, id: string, signal?: AbortSignal): Promise<ReportDocumentManifest | undefined>;
+    readPage(scope: string, id: string, version: string, index: number, signal?: AbortSignal): Promise<PlanPage | undefined>;
+    remove(scope: string, id: string, version: string, signal?: AbortSignal): Promise<boolean>;
+}
+
 declare type ReportExpression = {
     field: string;
 } | {
@@ -1111,7 +1238,15 @@ declare type ReportExpression_2 = {
     args: readonly ReportExpression_2[];
 };
 
-declare interface ReportFieldContract {
+declare type ReportFieldAggregation = "sum" | "avg" | "min" | "max" | "count" | "none";
+
+declare interface ReportFieldCalculation {
+    /** Business-owned explanation, never executable JavaScript or an inferred business formula. */
+    description: string;
+    dependsOn: readonly string[];
+}
+
+declare interface ReportFieldContract extends ReportFieldSemantics {
     field: string;
     label?: string;
     type: "text" | "number" | "boolean" | "date" | "decimal";
@@ -1126,6 +1261,17 @@ declare interface ReportFieldContract {
     unit?: string;
 }
 
+declare interface ReportFieldSemantics {
+    description?: string;
+    /** Explicit meaning of null/missing; does not convert blanks into zero. */
+    missingMeaning?: string;
+    /** Recommended aggregation; none marks non-additive measures such as ratios. No aggregation runs implicitly. */
+    aggregation?: ReportFieldAggregation;
+    /** Shared presentation only; raw values and calculation precision remain unchanged. */
+    format?: ColumnFormat;
+    calculation?: ReportFieldCalculation;
+}
+
 declare interface ReportFlowBand {
     /** Exact stable component IDs. Static components use nid, lists use id. */
     componentIds: string[];
@@ -1152,6 +1298,22 @@ export declare interface ReportGenerationInput {
     signal?: AbortSignal;
 }
 
+/** Stable transport mapping; unexpected errors never expose exception details or stacks. */
+export declare function reportHttpError(error: unknown, correlationId: string): {
+    status: number;
+    body: ReportHttpErrorBody;
+};
+
+export declare interface ReportHttpErrorBody {
+    error: {
+        code: string;
+        message: string;
+        correlationId: string;
+        path?: string;
+        issues?: Record<string, string>[];
+    };
+}
+
 export declare interface ReportInstanceArtifact {
     key: string;
     format: "pdf" | "xlsx";
@@ -2186,4 +2348,15 @@ declare type ValueFormat = ColumnFormat;
 /** The same declarative formatting used by list columns, before any output backend. */
 declare type ValueFormat_2 = ColumnFormat_2;
 
+/** Accepts paginateTemplatePages/AsyncIterable without retaining all pages; partial documents stay inspectable on failure. */
+export declare function writeReportDocument(store: ReportDocumentStore, input: {
+    scope: string;
+    id: string;
+    version: string;
+    plan: Omit<RenderPlan, "pages">;
+    pages: Iterable<PlanPage> | AsyncIterable<PlanPage>;
+    metadata?: Omit<PreparedReport, "plan">;
+    signal?: AbortSignal;
+}): Promise<ReportDocumentManifest>;
+
 export { }