react-semaphor 0.1.315 → 0.1.317

package/dist/types/types.d.ts

@@ -31,198 +31,6 @@ export declare type AIScopeTable = {
     datamodelName: string;
 };
 
-export declare interface Alert {
-    id: string;
-    kind?: 'ALERT';
-    name: string;
-    description?: string | null;
-    status: AlertStatus;
-    scheduleExpr: string;
-    timezone: string;
-    nextRunAt?: string | null;
-    lastRunAt?: string | null;
-    lastRunStatus?: string | null;
-    sourceHealth?: 'OK' | 'SOURCE_MISSING' | 'SOURCE_ERROR' | 'STALE';
-    alertState?: AlertState | null;
-    jobConfig: AlertJobConfig;
-    deliveryConfig: DeliveryConfig;
-    createdAt: string;
-    updatedAt: string;
-}
-
-export declare interface AlertBacktestResult {
-    ruleId?: string;
-    evaluationCount: number;
-    transitionsWithoutDampening: number;
-    transitionsWithDampening: number;
-    recommendation?: string | null;
-    firingEpisodes?: Array<{
-        triggeredAt: string;
-        recoveredAt: string | null;
-        durationMinutes: number;
-        peakValue: number;
-    }>;
-}
-
-export declare type AlertConditionOperator = 'gt' | 'gte' | 'lt' | 'lte' | 'eq' | 'neq' | 'pct_change_gt' | 'pct_change_lt';
-
-export declare interface AlertContextInterpretResponse {
-    workflowDef: Record<string, unknown>;
-    contextSources: ContextSource[];
-    explanation?: string;
-}
-
-export declare type AlertContextSourceKind = 'trend_window' | 'peer_comparison' | 'related_metric' | 'breakdown' | 'custom_query';
-
-export declare interface AlertDeliverablePreview {
-    mode: 'standard_fallback' | 'custom';
-    html: string;
-    warnings?: string[];
-}
-
-export declare type AlertDeliveryChannel = 'EMAIL' | 'WEBHOOK' | 'SLACK' | 'IN_APP' | 'TELEGRAM';
-
-export declare type AlertExecutionControlContext = {
-    values: Record<string, unknown>;
-};
-
-export declare type AlertExecutionFilterContext = {
-    active_filters: TFilterValue[];
-};
-
-export declare type AlertExecutionQueryConfig = {
-    cardType: TChartType;
-    cardMode: CardMode;
-    cardConfig: CardConfig;
-    cardDataSource: DataSource;
-    connectionId?: string;
-};
-
-export declare interface AlertHistoryResponse {
-    ruleId: string;
-    windowDays: number;
-    totalFirings: number;
-    averageFiringDurationMinutes: number;
-    longestFiring: {
-        triggeredAt: string;
-        recoveredAt: string | null;
-        durationMinutes: number;
-        triggerValue: number | null;
-        recoveryValue: number | null;
-    } | null;
-    shortestFiring: {
-        triggeredAt: string;
-        recoveredAt: string | null;
-        durationMinutes: number;
-        triggerValue: number | null;
-        recoveryValue: number | null;
-    } | null;
-    totalFiringMinutes: number;
-    firingPercentage: number;
-    episodes: Array<{
-        triggeredAt: string;
-        recoveredAt: string | null;
-        durationMinutes: number;
-        triggerValue: number | null;
-        recoveryValue: number | null;
-    }>;
-}
-
-export declare type AlertJobConfig = {
-    kind: 'ALERT';
-    source: AlertSource;
-    operator: AlertConditionOperator;
-    threshold: number;
-    severity: AlertSeverity;
-    consecutiveCount?: number;
-    notifyPolicy: 'on_state_change';
-    contextSources?: ContextSource[];
-    presentationPrompt?: string;
-    sensitivityPreset?: SensitivityPreset | null;
-};
-
-export declare interface AlertQuotaPolicy {
-    maxActiveAlerts: number;
-    minCadenceMinutes: number;
-    maxContextSources: number;
-}
-
-export declare interface AlertQuotaRecord {
-    tenantId: string | null;
-    policy: AlertQuotaPolicy;
-    activeAlerts: number;
-}
-
-export declare type AlertRecipient = {
-    type: 'email';
-    address: string;
-    name?: string;
-} | {
-    type: 'user';
-    userId: string;
-} | {
-    type: 'tenant_user';
-    tenantUserId: string;
-} | {
-    type: 'group';
-    groupId: string;
-};
-
-export declare interface AlertRun {
-    id: string;
-    ruleId: string;
-    status: 'QUEUED' | 'RUNNING' | 'SUCCESS' | 'FAILED';
-    scheduledFor: string;
-    startedAt?: string | null;
-    completedAt?: string | null;
-    error?: string | null;
-    result?: Record<string, unknown> | null;
-}
-
-export declare type AlertSeverity = 'LOW' | 'MEDIUM' | 'HIGH' | 'CRITICAL';
-
-export declare type AlertSource = {
-    type: 'saved_metric';
-    visualId: string;
-    title?: string;
-    format?: CanonicalFormatSpec;
-} | {
-    type: 'dashboard_metric';
-    dashboardId: string;
-    visualId: string;
-    cardId: string;
-    title?: string;
-    format?: CanonicalFormatSpec;
-    executionSnapshot: {
-        queryConfig: AlertExecutionQueryConfig;
-        filterContext: AlertExecutionFilterContext;
-        controlContext?: AlertExecutionControlContext;
-        controlDefinitions?: ControlDefinition[];
-        cardControlDefinitions?: ControlDefinition[];
-        controlBindings?: ControlBinding[];
-        connectionId: string;
-        calendarContext?: {
-            tz: string;
-            weekStart: number;
-        };
-    };
-};
-
-export declare interface AlertState {
-    currentState: AlertStateValue;
-    lastEvaluatedAt?: string | null;
-    lastValue?: string | null;
-    lastTriggeredAt?: string | null;
-    lastRecoveredAt?: string | null;
-    consecutiveTrue: number;
-    consecutiveFalse: number;
-    firingDurationMinutes?: number | null;
-}
-
-export declare type AlertStateValue = 'OK' | 'FIRING';
-
-export declare type AlertStatus = 'ACTIVE' | 'PAUSED' | 'DISABLED';
-
 declare const APPEARANCE_SPEC_VERSION: 1;
 
 declare type AppearanceColorToken = 'background' | 'foreground' | 'muted' | 'mutedForeground' | 'border' | 'input' | 'primary' | 'primaryForeground' | 'accent' | 'accentForeground' | 'card' | 'cardForeground' | 'positive' | 'negative' | 'warning' | 'info' | 'destructive' | 'destructiveForeground';
@@ -352,6 +160,358 @@ declare type BaseSurfaceAppearance = {
 
 export declare type Breakpoint = 'lg' | 'md' | 'sm' | 'xs' | 'xxs';
 
+declare const BRIEFING_ARTIFACT_FORMATS: readonly ["markdown", "html"];
+
+declare const BRIEFING_KIND: "BRIEFING";
+
+export declare type BriefingArtifactFormat = 'markdown' | 'html';
+
+declare type BriefingArtifactFormat_2 = (typeof BRIEFING_ARTIFACT_FORMATS)[number];
+
+export declare type BriefingArtifactKind = 'markdown' | 'html' | 'evidence' | 'trace';
+
+export declare type BriefingArtifactResponse = {
+    kind: BriefingArtifactKind;
+    content: string;
+    contentType: string;
+    filename?: string;
+};
+
+export declare type BriefingAttachment = (BriefingAttachmentBase & {
+    type: 'dashboard';
+    dashboardId: string;
+    format: 'pdf';
+}) | (BriefingAttachmentBase & {
+    type: 'dashboard_sheet';
+    dashboardId: string;
+    sheetId: string;
+    format: 'pdf';
+}) | (BriefingAttachmentBase & {
+    type: 'document_sheet';
+    dashboardId: string;
+    sheetId: string;
+    format: 'pdf';
+}) | (BriefingAttachmentBase & {
+    type: 'visual';
+    dashboardId: string;
+    visualId: string;
+    format: 'pdf' | 'png';
+}) | (BriefingAttachmentBase & {
+    type: 'card';
+    dashboardId: string;
+    cardId: string;
+    format: 'csv' | 'pdf' | 'png';
+});
+
+declare type BriefingAttachmentBase = {
+    title?: string;
+    settings?: BriefingAttachmentSettings;
+};
+
+export declare type BriefingAttachmentFormat = 'pdf' | 'csv' | 'png';
+
+export declare type BriefingAttachmentSettings = {
+    theme?: string;
+    pageSize?: BriefingPdfPageSize;
+    orientation?: BriefingPdfOrientation;
+    includeFilters?: boolean;
+    includeTimestamp?: boolean;
+    delimiter?: BriefingCsvDelimiter;
+    includeHeaders?: boolean;
+    useFormattedValues?: boolean;
+    sheetSelection?: 'current' | 'all';
+    currentSheetId?: string;
+    currentSheetName?: string;
+    filterValues?: unknown[];
+    inlineFilterValues?: unknown[];
+    sheetFilterValues?: unknown[];
+    filterLine?: string;
+    controlValues?: Record<string, unknown>;
+    controlDefinitions?: unknown[];
+    cardControlDefinitions?: unknown[];
+    controlBindings?: unknown[];
+    tablePreferences?: Record<string, unknown>;
+    dashboardInputExecutionSnapshot?: Record<string, unknown>;
+    selectedSheetId?: string;
+    cardType?: string;
+};
+
+export declare type BriefingBody = {
+    type: 'generated_analysis';
+    instruction: string;
+} | {
+    type: 'custom_message';
+    message: string;
+} | {
+    type: 'none';
+};
+
+declare type BriefingChannelConfig = {
+    subjectOverride?: string;
+    titleOverride?: string;
+    summaryOverride?: string;
+    actionBlockVisible?: boolean;
+    webhookConfig?: BriefingWebhookConfig;
+};
+
+export declare type BriefingChannelFormatConfig = BriefingChannelConfig & {
+    formatProfile?: BriefingFormatProfile;
+};
+
+export declare type BriefingCreatorMetadata = {
+    type: 'organization' | 'tenant' | 'unknown';
+    id: string | null;
+    name: string | null;
+    email: string | null;
+    label: string;
+};
+
+declare type BriefingCsvDelimiter = ',' | ';' | '\t';
+
+export declare type BriefingDeliveryChannel = 'EMAIL' | 'WEBHOOK' | 'SLACK' | 'IN_APP' | 'TELEGRAM';
+
+export declare type BriefingDeliveryConfig = {
+    recipients: BriefingRecipient[];
+    channels: BriefingDeliveryChannel[];
+    channelConfigs?: Partial<Record<BriefingDeliveryChannel, BriefingChannelConfig>>;
+};
+
+export declare interface BriefingDetail extends BriefingListItem {
+    deliveryConfig: BriefingDeliveryConfig | null;
+    latestRun?: BriefingRun | null;
+}
+
+export declare type BriefingDispatchResult = {
+    accepted: boolean;
+    mode?: string;
+    message?: string;
+};
+
+export declare type BriefingFormatProfile = 'concise' | 'balanced' | 'detailed';
+
+export declare type BriefingJobConfig = {
+    kind: BriefingKind;
+    source: BriefingSource;
+    body: BriefingBody;
+    attachments: BriefingAttachment[];
+    presentation: BriefingPresentation;
+    limits?: BriefingLimits;
+};
+
+export declare type BriefingKind = typeof BRIEFING_KIND;
+
+export declare type BriefingLimits = {
+    maxToolCalls?: number;
+    maxRows?: number;
+    timeoutMs?: number;
+};
+
+export declare interface BriefingListItem {
+    id: string;
+    kind: BriefingKind;
+    name: string;
+    description: string | null;
+    status: BriefingStatus | string;
+    scheduleExpr: string | null;
+    timezone: string;
+    nextRunAt: string | null;
+    source: BriefingSource;
+    body: BriefingBody;
+    attachments: BriefingAttachment[];
+    presentation: BriefingPresentation;
+    limits?: BriefingLimits;
+    scope?: BriefingScopeMetadata;
+    creator?: BriefingCreatorMetadata;
+    lastRunAt: string | null;
+    lastRunStatus: BriefingRunStatus | string | null;
+    hasActiveRun: boolean;
+    canManage: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+
+export declare type BriefingListResponse = {
+    briefings: BriefingListItem[];
+    total: number;
+    page: number;
+    pageSize: number;
+};
+
+export declare type BriefingListScope = 'organization' | 'tenants';
+
+declare type BriefingPdfOrientation = 'portrait' | 'landscape';
+
+declare type BriefingPdfPageSize = 'letter' | 'legal' | 'a4' | 'a3' | 'tabloid';
+
+export declare type BriefingPresentation = {
+    artifactFormats: BriefingArtifactFormat_2[];
+    includeEvidence: boolean;
+    includeSql: boolean;
+    audience?: string;
+    tone?: string;
+    format?: string;
+};
+
+export declare type BriefingPreviewPlan = {
+    id: string;
+    status: 'READY';
+    generatedAt: string;
+    expiresAt: string;
+    understood: {
+        investigation: string;
+        threshold: string;
+        audience: string;
+        format: string;
+    };
+    steps: Array<{
+        order: number;
+        title: string;
+        detail: string;
+        tools: string[];
+        optional?: boolean;
+    }>;
+    scope: {
+        source: BriefingSource;
+        sourceLabel: string;
+        datasets: string[];
+        grounding?: {
+            source: 'project' | 'dashboard';
+            confidence: 'high' | 'medium' | 'low';
+            domainId?: string;
+            domainLabel?: string;
+            datasetName?: string;
+            datasetLabel?: string;
+            metric?: string;
+            dateField?: string;
+            dimensions: string[];
+            reason: string;
+        };
+    };
+    estimate: {
+        runtime: string;
+        toolCalls: string;
+    };
+    ambiguities: string[];
+};
+
+export declare type BriefingPreviewRun = {
+    id: string;
+    status: BriefingRunStatus | string;
+    createdAt: string;
+    startedAt?: string | null;
+    completedAt?: string | null;
+    expiresAt: string;
+    error?: string | null;
+    planId?: string | null;
+    requestId?: string | null;
+    progress?: BriefingRunProgress | null;
+    result?: {
+        status: string;
+        title?: string;
+        summary?: string;
+        artifactPreview?: {
+            markdown?: string;
+            html?: string;
+        };
+        warnings: string[];
+        limits?: Record<string, unknown>;
+    } | null;
+};
+
+export declare type BriefingRecipient = {
+    type: 'email';
+    address: string;
+    name?: string;
+} | {
+    type: 'user';
+    userId: string;
+} | {
+    type: 'tenant_user';
+    tenantUserId: string;
+} | {
+    type: 'group';
+    groupId: string;
+};
+
+export declare interface BriefingRun {
+    id: string;
+    ruleId: string;
+    status: BriefingRunStatus | string;
+    scheduledFor: string;
+    startedAt?: string | null;
+    completedAt?: string | null;
+    error?: string | null;
+    requestId?: string | null;
+    attempt: number;
+    progress?: BriefingRunProgress | null;
+    result?: unknown;
+}
+
+export declare type BriefingRunProgress = {
+    stage: BriefingRunProgressStage;
+    label: string;
+    detail?: string;
+    eventCount: number;
+    updatedAt: string;
+    recentEvents?: Array<{
+        stage: BriefingRunProgressStage;
+        label: string;
+        updatedAt: string;
+    }>;
+};
+
+export declare type BriefingRunProgressStage = 'queued' | 'planning' | 'discovering' | 'inspecting' | 'querying' | 'analyzing' | 'rendering' | 'saving' | 'completed' | 'failed';
+
+export declare type BriefingRunsResponse = {
+    runs: BriefingRun[];
+    nextCursor: string | null;
+    total: number;
+};
+
+export declare type BriefingRunStatus = 'QUEUED' | 'RUNNING' | 'SUCCESS' | 'FAILED';
+
+export declare type BriefingScopeMetadata = {
+    type: 'organization';
+    label: string;
+    tenantId: null;
+    tenantName: null;
+} | {
+    type: 'tenant';
+    label: string;
+    tenantId: string;
+    tenantName: string | null;
+};
+
+export declare type BriefingSource = {
+    type: 'project';
+} | {
+    type: 'dashboard';
+    dashboardId: string;
+};
+
+export declare type BriefingStatus = 'ACTIVE' | 'PAUSED' | 'DISABLED';
+
+export declare type BriefingTenantSummariesResponse = {
+    tenants: BriefingTenantSummary[];
+};
+
+export declare type BriefingTenantSummary = {
+    tenantId: string;
+    tenantName: string;
+    briefingCount: number;
+    activeBriefingCount: number;
+    hasActiveRun: boolean;
+    latestRunAt: string | null;
+    latestRunStatus: BriefingRunStatus | string | null;
+};
+
+declare type BriefingWebhookConfig = {
+    url: string;
+    method?: 'POST' | 'PUT';
+    headers?: Record<string, string>;
+    secretEncrypted?: string;
+};
+
 export declare type CacheConfig = {
     ttl: string;
     status: 'on' | 'on-refresh' | 'off';
@@ -452,6 +612,11 @@ export declare type CalendarContext = {
     };
 };
 
+export declare type CancelBriefingRunResponse = {
+    run: BriefingRun;
+    transitionApplied: boolean;
+};
+
 export declare type CanonicalFormatSpec = NumericCanonicalFormat | DateCanonicalFormat | StringCanonicalFormat;
 
 export declare interface CardConfig {
@@ -540,20 +705,6 @@ declare type CardWithFooter = BaseCustomCard & {
     }>;
 };
 
-export declare type ChannelFormatConfig = {
-    formatProfile: FormatProfile;
-    subjectOverride?: string;
-    titleOverride?: string;
-    summaryOverride?: string;
-    actionBlockVisible?: boolean;
-    webhookConfig?: {
-        url: string;
-        method: string;
-        headers: Record<string, string>;
-        secretEncrypted?: string;
-    };
-};
-
 declare type ChartAppearance = {
     palette?: string[];
     background?: string;
@@ -759,12 +910,6 @@ export declare type ConnectionType = 'GoogleSheets' | 'FileUpload' | 'MySQL' | '
 
 export declare type ContainerId = 'groupBy' | 'metrics' | 'pivotBy' | 'sortBy' | 'detailColumns' | 'source';
 
-export declare type ContextSource = {
-    kind: AlertContextSourceKind;
-    config: Record<string, unknown>;
-    outputAs?: string;
-};
-
 export declare const CONTROL_CARD_DEFAULT_VALUE: "__card_default__";
 
 export declare type ControlBinding = {
@@ -842,25 +987,19 @@ export declare type ControlSource = {
 
 export declare type ControlType = 'enum' | 'multi_enum' | 'text' | 'number' | 'boolean' | 'date' | 'field_selector' | 'metric_selector' | 'aggregation_selector' | 'grain_selector';
 
-export declare interface CreateAlertRequest {
-    kind?: 'ALERT';
+export declare type CreateBriefingRequest = {
     name: string;
-    description?: string;
-    scheduleExpr: string;
-    timezone?: string;
-    source?: AlertSource;
-    operator?: AlertConditionOperator;
-    threshold?: number;
-    severity?: AlertSeverity;
-    consecutiveCount?: number;
-    recipients?: AlertRecipient[];
-    channels?: AlertDeliveryChannel[];
-    contextSources?: ContextSource[];
-    presentationPrompt?: string;
-    jobConfig?: AlertJobConfig;
-    deliveryConfig?: DeliveryConfig;
-    workflowDef?: Record<string, unknown>;
-}
+    description: string | null;
+    status: BriefingStatus;
+    scheduleExpr: string | null;
+    timezone: string;
+    source: BriefingSource;
+    body: BriefingBody;
+    attachments: BriefingAttachment[];
+    presentation: BriefingPresentation;
+    limits?: BriefingLimits;
+    deliveryConfig: BriefingDeliveryConfig | null;
+};
 
 export declare type CustomCard = CardWithContent | CardWithFooter;
 
@@ -1063,6 +1202,7 @@ export declare type DashboardProps = {
     currentTheme?: Theme;
     version?: string;
     showAssistant?: boolean;
+    showBriefings?: boolean;
     customCards?: CustomCard[];
     onChartElementClicked?: (card: TCard, fieldValues: any) => void;
     onEvent?: (event: TEvent) => void;
@@ -1176,12 +1316,13 @@ export declare const DEFAULT_SEMANTIC_DOMAIN_ACCESS: SemanticDomainAccess;
 
 declare type DefaultDateFilter = RelativeDateFilter | FixedMonthDefaultDateFilter;
 
-export declare type DeliveryConfig = {
-    recipients: AlertRecipient[];
-    channels: AlertDeliveryChannel[];
-    subject?: string;
-    message?: string;
-    channelConfigs?: Record<string, ChannelFormatConfig>;
+export declare type DeleteBriefingResponse = {
+    success: boolean;
+    deletedBriefingId?: string;
+};
+
+export declare type DeleteBriefingRunResponse = {
+    deletedRunId: string;
 };
 
 /**
@@ -1823,8 +1964,6 @@ declare type FixedMonthDefaultDateFilter = {
 
 export declare type FlatTableTotalsBehavior = 'sum' | 'avg' | 'count' | 'label';
 
-export declare type FormatProfile = 'concise' | 'balanced' | 'detailed';
-
 export declare type FormatSpec = {
     type: 'number' | 'currency' | 'percent' | 'percentage' | 'scientific';
     locale?: string;
@@ -2268,6 +2407,10 @@ export declare type Placeholders = {
 
 export declare type PluginType = 'custom' | 'standard';
 
+export declare type PreviewBriefingPlanResponse = {
+    plan: BriefingPreviewPlan;
+};
+
 export declare interface QueryColumnKeyMap {
     version: 1;
     source: 'explorer';
@@ -2415,6 +2558,29 @@ export declare type ResolvedTokenParams = Omit<TokenParams, 'calendarContext'> &
     calendarContext: CalendarContext;
 };
 
+export declare type RunBriefingNowRequest = {
+    requestId: string;
+};
+
+export declare type RunBriefingNowResponse = {
+    accepted: boolean;
+    run: BriefingRun;
+    transitionApplied: boolean;
+    dispatch: BriefingDispatchResult | null;
+};
+
+export declare type RunBriefingPreviewRequest = {
+    draft: CreateBriefingRequest;
+    planId?: string | null;
+    requestId?: string | null;
+};
+
+export declare type RunBriefingPreviewResponse = {
+    accepted: boolean;
+    previewRun: BriefingPreviewRun;
+    dispatch: BriefingDispatchResult | null;
+};
+
 export declare type SelectedEntities = SelectedEntity[];
 
 export declare type SelectedEntity = DatabaseEntityReference | DataModelEntityReference | DatasetEntityReference | FileEntityReference;
@@ -2449,8 +2615,6 @@ declare type SemanticExecutionPayload = {
     }>;
 };
 
-export declare type SensitivityPreset = 'low_noise' | 'standard' | 'early_warning';
-
 export declare interface SortByField extends Field {
     role: 'sortby';
     direction: 'asc' | 'desc';
@@ -3690,6 +3854,12 @@ export declare type UIConfig = {
      * If unset, runtime falls back to `showAssistant`; if both are unset, assistant is hidden.
      */
     showDashboardAssistant?: boolean;
+    /**
+     * Controls briefing authoring visibility in the dashboard toolbar.
+     * If set, this takes precedence over the embed prop `showBriefings`.
+     * If unset, runtime falls back to `showBriefings`; if both are unset, briefings are visible.
+     */
+    showBriefings?: boolean;
     /**
      * Shows the Direct Source option in the data-source selector.
      * Defaults to true unless explicitly disabled.
@@ -3707,27 +3877,7 @@ export declare type UIConfig = {
     appearance?: AppearanceSpec;
 };
 
-export declare interface UpdateAlertRequest {
-    name?: string;
-    description?: string | null;
-    scheduleExpr?: string;
-    timezone?: string;
-    status?: AlertStatus;
-    source?: AlertSource;
-    operator?: AlertConditionOperator;
-    threshold?: number;
-    severity?: AlertSeverity;
-    consecutiveCount?: number;
-    recipients?: AlertRecipient[];
-    channels?: AlertDeliveryChannel[];
-    contextSources?: ContextSource[];
-    presentationPrompt?: string;
-    sensitivityPreset?: SensitivityPreset | null;
-    channelConfigs?: Record<string, ChannelFormatConfig>;
-    jobConfig?: AlertJobConfig;
-    deliveryConfig?: DeliveryConfig;
-    workflowDef?: Record<string, unknown> | null;
-}
+export declare type UpdateBriefingRequest = Partial<CreateBriefingRequest>;
 
 export declare interface UpdateUserPreferenceRequest {
     defaultDashboardId: string | null;