@happyvertical/smrt-reports 0.36.5

package/dist/refresh.d.ts

@@ -0,0 +1,106 @@
+import { AggregateFunction } from '@happyvertical/sql';
+import { AggregateTimeBucketUnit } from '@happyvertical/sql';
+import { DatabaseInterface } from '@happyvertical/sql';
+import { SmrtObject } from '@happyvertical/smrt-core';
+import { SqlAdapterType } from '@happyvertical/sql';
+import { WhereClause } from '@happyvertical/sql';
+
+export declare function refreshReport(reportCtor: ReportCtor, options?: ReportRefreshOptions): Promise<ReportRefreshResult>;
+
+declare interface ReportAggregateFieldMetadata {
+    kind: 'aggregate';
+    fn: ReportAggregateFn;
+    column?: string;
+    distinct?: boolean;
+}
+
+declare type ReportAggregateFn = AggregateFunction;
+
+declare interface ReportBucketFieldMetadata {
+    kind: 'bucket';
+    unit: ReportTimeBucketUnit;
+    sourceColumn: string;
+}
+
+declare type ReportCtor = new (...args: any[]) => SmrtObject;
+
+declare interface ReportDefinition {
+    reportClassName: string;
+    sourceClassName: string;
+    sourceTable: string;
+    fields: ReportFieldDefinition[];
+    where?: WhereClause;
+    having?: WhereClause;
+    refresh?: ReportRefreshConfig;
+}
+
+declare interface ReportFieldDefinition {
+    fieldName: string;
+    columnName?: string;
+    type?: string;
+    report?: ReportFieldMetadata;
+}
+
+declare type ReportFieldMetadata = ReportGroupFieldMetadata | ReportBucketFieldMetadata | ReportAggregateFieldMetadata;
+
+declare interface ReportGroupFieldMetadata {
+    kind: 'group';
+    sourceColumn?: string;
+}
+
+declare interface ReportRefreshConfig {
+    mode?: ReportRefreshMode;
+    schedule?: string;
+    onChange?: ReportSource[];
+    /**
+     * Milliseconds before collection reads trigger a synchronous refresh.
+     *
+     * TTL refresh checks add a read-time MAX(refreshedAt) query, and stale reads
+     * perform the refresh before returning list/get results.
+     */
+    ttl?: number;
+    manual?: boolean;
+    watermarkColumn?: string;
+    softDeleteColumn?: string;
+    fullRebuildSchedule?: string;
+    tenantFanout?: boolean;
+}
+
+declare type ReportRefreshMode = 'rebuild' | 'incremental';
+
+declare interface ReportRefreshOptions {
+    db?: DatabaseInterface;
+    mode?: ReportRefreshMode;
+    adapterType?: SqlAdapterType;
+    trigger?: ReportRefreshTrigger;
+    tenantId?: string | null;
+    tenantIds?: string[];
+    lock?: boolean;
+    lockTtlMs?: number;
+    trackRuns?: boolean;
+    scheduleId?: string;
+    changedRows?: Record<string, unknown>[];
+}
+
+declare interface ReportRefreshResult {
+    rowCount: number;
+    refreshedAt: Date;
+    mode: ReportRefreshMode;
+    tenantId?: string | null;
+    runId?: string;
+    changedGroupCount?: number;
+    skipped?: boolean;
+    tenantResults?: ReportRefreshResult[];
+}
+
+declare type ReportRefreshTrigger = 'manual' | 'schedule' | 'change' | 'ttl' | 'job';
+
+export declare function reportRowIdentity(row: Record<string, any>, definition: ReportDefinition): string;
+
+declare type ReportSource = string | (new (...args: any[]) => SmrtObject) | (abstract new (...args: any[]) => SmrtObject);
+
+export declare function reportSourceClassName(source: ReportSource): string;
+
+declare type ReportTimeBucketUnit = AggregateTimeBucketUnit;
+
+export { }