Type connector adapter params

elastic · Mar 30, 2024 · c5c06e9 · c5c06e9
1 parent e59c542
commit c5c06e9
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 20 deletions.
diff --git a/x-pack/plugins/alerting/server/connector_adapters/connector_adapter_registry.ts b/x-pack/plugins/alerting/server/connector_adapters/connector_adapter_registry.ts
@@ -8,7 +8,7 @@
 import Boom from '@hapi/boom';
 import { i18n } from '@kbn/i18n';
 
-import { ConnectorAdapter } from './types';
+import { ConnectorAdapter, ConnectorAdapterParams } from './types';
 
 export class ConnectorAdapterRegistry {
   private readonly connectorAdapters: Map<string, ConnectorAdapter> = new Map();
@@ -17,14 +17,20 @@ export class ConnectorAdapterRegistry {
     return this.connectorAdapters.has(connectorTypeId);
   }
 
-  public register(connectorAdapter: ConnectorAdapter) {
+  public register<
+    RuleActionParams extends ConnectorAdapterParams = ConnectorAdapterParams,
+    ConnectorParams extends ConnectorAdapterParams = ConnectorAdapterParams
+  >(connectorAdapter: ConnectorAdapter<RuleActionParams, ConnectorParams>) {
     if (this.has(connectorAdapter.connectorTypeId)) {
       throw new Error(
         `${connectorAdapter.connectorTypeId} is already registered to the ConnectorAdapterRegistry`
       );
     }
 
-    this.connectorAdapters.set(connectorAdapter.connectorTypeId, connectorAdapter);
+    this.connectorAdapters.set(
+      connectorAdapter.connectorTypeId,
+      connectorAdapter as unknown as ConnectorAdapter
+    );
   }
 
   public get(connectorTypeId: string): ConnectorAdapter {

diff --git a/x-pack/plugins/alerting/server/connector_adapters/types.ts b/x-pack/plugins/alerting/server/connector_adapters/types.ts
@@ -6,28 +6,27 @@
  */
 
 import { ObjectType } from '@kbn/config-schema';
-import type {
-  RuleActionParams as GenericRuleActionParams,
-  RuleTypeParams,
-  SanitizedRule,
-} from '../../common';
+import type { RuleTypeParams, SanitizedRule } from '../../common';
 import { CombinedSummarizedAlerts } from '../types';
 
-type ActionTypeParams = Record<string, unknown>;
-
 type Rule = Pick<SanitizedRule<RuleTypeParams>, 'id' | 'name' | 'tags'>;
 
-interface BuildActionParamsArgs<
-  RuleActionParams extends GenericRuleActionParams = GenericRuleActionParams
-> {
+export interface ConnectorAdapterParams {
+  [x: string]: unknown;
+}
+
+interface BuildActionParamsArgs<RuleActionParams> {
   alerts: CombinedSummarizedAlerts;
   rule: Rule;
   params: RuleActionParams;
   spaceId: string;
   ruleUrl?: string;
 }
 
-export interface ConnectorAdapter {
+export interface ConnectorAdapter<
+  RuleActionParams extends ConnectorAdapterParams = ConnectorAdapterParams,
+  ConnectorParams extends ConnectorAdapterParams = ConnectorAdapterParams
+> {
   connectorTypeId: string;
   /**
    * The schema of the action persisted
@@ -38,7 +37,5 @@ export interface ConnectorAdapter {
    * changes.
    */
   ruleActionParamsSchema: ObjectType;
-  buildActionParams: <RuleActionParams extends GenericRuleActionParams>(
-    args: BuildActionParamsArgs<RuleActionParams>
-  ) => ActionTypeParams;
+  buildActionParams: (args: BuildActionParamsArgs<RuleActionParams>) => ConnectorParams;
 }
diff --git a/x-pack/plugins/alerting/server/plugin.ts b/x-pack/plugins/alerting/server/plugin.ts
@@ -100,7 +100,7 @@ import {
 import { getRulesSettingsFeature } from './rules_settings_feature';
 import { maintenanceWindowFeature } from './maintenance_window_feature';
 import { ConnectorAdapterRegistry } from './connector_adapters/connector_adapter_registry';
-import { ConnectorAdapter } from './connector_adapters/types';
+import { ConnectorAdapter, ConnectorAdapterParams } from './connector_adapters/types';
 import { DataStreamAdapter, getDataStreamAdapter } from './alerts_service/lib/data_stream_adapter';
 import { createGetAlertIndicesAliasFn, GetAlertIndicesAlias } from './lib';
 
@@ -120,7 +120,12 @@ export const LEGACY_EVENT_LOG_ACTIONS = {
 };
 
 export interface PluginSetupContract {
-  registerConnectorAdapter(adapter: ConnectorAdapter): void;
+  registerConnectorAdapter<
+    RuleActionParams extends ConnectorAdapterParams = ConnectorAdapterParams,
+    ConnectorParams extends ConnectorAdapterParams = ConnectorAdapterParams
+  >(
+    adapter: ConnectorAdapter<RuleActionParams, ConnectorParams>
+  ): void;
   registerType<
     Params extends RuleTypeParams = RuleTypeParams,
     ExtractedParams extends RuleTypeParams = RuleTypeParams,
@@ -382,7 +387,12 @@ export class AlertingPlugin {
     });
 
     return {
-      registerConnectorAdapter: (adapter: ConnectorAdapter) => {
+      registerConnectorAdapter: <
+        RuleActionParams extends ConnectorAdapterParams = ConnectorAdapterParams,
+        ConnectorParams extends ConnectorAdapterParams = ConnectorAdapterParams
+      >(
+        adapter: ConnectorAdapter<RuleActionParams, ConnectorParams>
+      ) => {
         this.connectorAdapterRegistry.register(adapter);
       },
       registerType: <