@sentry/junior-plugin-api 0.66.2 → 0.67.0

package/dist/index.d.ts

@@ -137,6 +137,9 @@ export interface AgentPluginState {
     setIfNotExists(key: string, value: unknown, ttlMs?: number): Promise<boolean>;
     withLock<T>(key: string, ttlMs: number, callback: () => Promise<T>): Promise<T>;
 }
+export interface AgentPluginReadState {
+    get<T = unknown>(key: string): Promise<T | undefined>;
+}
 export interface HeartbeatHookContext extends AgentPluginContext {
     agent: {
         dispatch(options: DispatchOptions): Promise<DispatchResult>;
@@ -148,6 +151,40 @@ export interface HeartbeatHookContext extends AgentPluginContext {
 export interface HeartbeatResult {
     dispatchCount?: number;
 }
+export type PluginOperationalTone = "danger" | "good" | "neutral" | "warning";
+export interface PluginOperationalMetric {
+    label: string;
+    tone?: PluginOperationalTone;
+    value: string;
+}
+export interface PluginOperationalField {
+    key: string;
+    label: string;
+}
+export interface PluginOperationalRecord {
+    id: string;
+    tone?: PluginOperationalTone;
+    values: Record<string, string>;
+}
+export interface PluginOperationalRecordSet {
+    fields?: PluginOperationalField[];
+    emptyText?: string;
+    records?: PluginOperationalRecord[];
+    title: string;
+}
+export interface PluginOperationalReportContent {
+    generatedAt?: string;
+    metrics?: PluginOperationalMetric[];
+    recordSets?: PluginOperationalRecordSet[];
+    title?: string;
+}
+export interface PluginOperationalReport extends PluginOperationalReportContent {
+    pluginName: string;
+}
+export interface OperationalReportHookContext extends AgentPluginContext {
+    nowMs: number;
+    state: AgentPluginReadState;
+}
 export type AgentPluginRouteMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "OPTIONS" | "ALL";
 export type AgentPluginRouteHandler = {
     bivarianceHack(request: Request): Promise<Response> | Response;
@@ -171,6 +208,7 @@ export interface AgentPluginHooks {
     routes?(ctx: RouteRegistrationHookContext): AgentPluginRoute[];
     tools?(ctx: ToolRegistrationHookContext): Record<string, AgentPluginToolDefinition>;
     heartbeat?(ctx: HeartbeatHookContext): Promise<HeartbeatResult | void> | HeartbeatResult | void;
+    operationalReport?(ctx: OperationalReportHookContext): Promise<PluginOperationalReportContent | undefined> | PluginOperationalReportContent | undefined;
     slackConversationLink?(ctx: SlackConversationLinkHookContext): SlackConversationLink | undefined;
 }
 export interface JuniorPluginOAuthConfig {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry/junior-plugin-api",
-  "version": "0.66.2",
+  "version": "0.67.0",
   "private": false,
   "publishConfig": {
     "access": "public"

package/src/index.ts

@@ -167,6 +167,10 @@ export interface AgentPluginState {
   ): Promise<T>;
 }
 
+export interface AgentPluginReadState {
+  get<T = unknown>(key: string): Promise<T | undefined>;
+}
+
 export interface HeartbeatHookContext extends AgentPluginContext {
   agent: {
     dispatch(options: DispatchOptions): Promise<DispatchResult>;
@@ -180,6 +184,48 @@ export interface HeartbeatResult {
   dispatchCount?: number;
 }
 
+export type PluginOperationalTone = "danger" | "good" | "neutral" | "warning";
+
+export interface PluginOperationalMetric {
+  label: string;
+  tone?: PluginOperationalTone;
+  value: string;
+}
+
+export interface PluginOperationalField {
+  key: string;
+  label: string;
+}
+
+export interface PluginOperationalRecord {
+  id: string;
+  tone?: PluginOperationalTone;
+  values: Record<string, string>;
+}
+
+export interface PluginOperationalRecordSet {
+  fields?: PluginOperationalField[];
+  emptyText?: string;
+  records?: PluginOperationalRecord[];
+  title: string;
+}
+
+export interface PluginOperationalReportContent {
+  generatedAt?: string;
+  metrics?: PluginOperationalMetric[];
+  recordSets?: PluginOperationalRecordSet[];
+  title?: string;
+}
+
+export interface PluginOperationalReport extends PluginOperationalReportContent {
+  pluginName: string;
+}
+
+export interface OperationalReportHookContext extends AgentPluginContext {
+  nowMs: number;
+  state: AgentPluginReadState;
+}
+
 export type AgentPluginRouteMethod =
   | "GET"
   | "POST"
@@ -220,6 +266,12 @@ export interface AgentPluginHooks {
   heartbeat?(
     ctx: HeartbeatHookContext,
   ): Promise<HeartbeatResult | void> | HeartbeatResult | void;
+  operationalReport?(
+    ctx: OperationalReportHookContext,
+  ):
+    | Promise<PluginOperationalReportContent | undefined>
+    | PluginOperationalReportContent
+    | undefined;
   slackConversationLink?(
     ctx: SlackConversationLinkHookContext,
   ): SlackConversationLink | undefined;