[Security Solution] Move remaining DE route schemas to /common/api (#…

…162856)

Closes elastic/security-team#7098

After this PR is merged, all DE APIs listed
[here](https://docs.google.com/spreadsheets/d/1VCoJ74EkyGuj59VwWj_3v2ecB84pNCpzGqkYnS0SUKw/edit?pli=1#gid=0)
will have a corresponding folder and schema file in `/common/api`.

x-pack/plugins/security_solution/common/api/detection_engine/index.ts

@@ -7,10 +7,12 @@
 
 export * from './alert_tags';
 export * from './fleet_integrations';
+export * from './index_management';
 export * from './model';
 export * from './prebuilt_rules';
 export * from './rule_exceptions';
 export * from './rule_management';
 export * from './rule_monitoring';
+export * from './rule_preview';
 export * from './signals';
 export * from './signals_migration';

x-pack/plugins/security_solution/common/api/detection_engine/index_management/create_index/create_index_route.ts

@@ -0,0 +1,10 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+export interface CreateIndexResponse {
+  acknowledged: boolean;
+}

x-pack/plugins/security_solution/common/api/detection_engine/index_management/delete_index/delete_index_route.ts

@@ -0,0 +1,10 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+export interface DeleteIndexResponse {
+  acknowledged: boolean;
+}

x-pack/plugins/security_solution/common/api/detection_engine/index_management/index.ts

@@ -0,0 +1,12 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+export * from './create_index/create_index_route';
+export * from './delete_index/delete_index_route';
+export * from './read_alerts_index_exists/read_alerts_index_exists_route';
+export * from './read_index/read_index_route';
+export * from './read_privileges/read_privileges_route';

x-pack/plugins/security_solution/common/api/detection_engine/index_management/read_alerts_index_exists/read_alerts_index_exists_route.ts

@@ -0,0 +1,10 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+export interface ReadAlertsIndexExistsResponse {
+  indexExists: boolean;
+}

x-pack/plugins/security_solution/common/api/detection_engine/index_management/read_index/read_index_route.ts

@@ -0,0 +1,11 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+export interface ReadIndexResponse {
+  name: string;
+  index_mapping_outdated: boolean | null;
+}

x-pack/plugins/security_solution/common/api/detection_engine/index_management/read_privileges/read_privileges_route.ts

@@ -0,0 +1,11 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+export interface ReadPrivilegesResponse {
+  is_authenticated: boolean;
+  has_encryption_key: boolean;
+}

x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/rule_schemas.ts

@@ -178,8 +178,8 @@ export const BaseCreateProps = baseSchema.create;
 // with some variations for each route. These intersect with type specific schemas below
 // to create the full schema for each route.
 
-type SharedCreateProps = t.TypeOf<typeof SharedCreateProps>;
-const SharedCreateProps = t.intersection([
+export type SharedCreateProps = t.TypeOf<typeof SharedCreateProps>;
+export const SharedCreateProps = t.intersection([
   baseSchema.create,
   t.exact(t.partial({ rule_id: RuleSignatureId })),
 ]);
@@ -542,28 +542,3 @@ export const RulePatchProps = t.intersection([TypeSpecificPatchProps, SharedPatc
 
 export type RuleResponse = t.TypeOf<typeof RuleResponse>;
 export const RuleResponse = t.intersection([SharedResponseProps, TypeSpecificResponse]);
-
-// -------------------------------------------------------------------------------------------------
-// Rule preview schemas
-
-// TODO: Move to the rule_preview subdomain
-
-export type PreviewRulesSchema = t.TypeOf<typeof previewRulesSchema>;
-export const previewRulesSchema = t.intersection([
-  SharedCreateProps,
-  TypeSpecificCreateProps,
-  t.type({ invocationCount: t.number, timeframeEnd: t.string }),
-]);
-
-export interface RulePreviewLogs {
-  errors: string[];
-  warnings: string[];
-  startedAt?: string;
-  duration: number;
-}
-
-export interface PreviewResponse {
-  previewId: string | undefined;
-  logs: RulePreviewLogs[] | undefined;
-  isAborted: boolean | undefined;
-}

x-pack/plugins/security_solution/common/api/detection_engine/rule_exceptions/create_shared_exceptions_list/create_shared_exceptions_list_route.ts

@@ -0,0 +1,17 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+import * as t from 'io-ts';
+
+export const CreateSharedExceptionListRequest = t.exact(
+  t.type({
+    name: t.string,
+    description: t.string,
+  })
+);
+export type CreateSharedExceptionListRequest = t.TypeOf<typeof CreateSharedExceptionListRequest>;
+
+export type CreateSharedExceptionListRequestDecoded = CreateSharedExceptionListRequest;

x-pack/plugins/security_solution/common/api/detection_engine/rule_exceptions/index.ts

@@ -6,5 +6,6 @@
  */
 
 export * from './create_rule_exceptions/create_rule_exceptions_route';
+export * from './create_shared_exceptions_list/create_shared_exceptions_list_route';
 export * from './find_exception_references/find_exception_references_route';
 export * from './urls';

x-pack/plugins/security_solution/common/api/detection_engine/rule_preview/index.ts

@@ -0,0 +1,8 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+export * from './preview_rules_route';

x-pack/plugins/security_solution/common/api/detection_engine/rule_preview/preview_rules_route.ts

@@ -0,0 +1,29 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import * as t from 'io-ts';
+import { SharedCreateProps, TypeSpecificCreateProps } from '../model';
+
+export type PreviewRulesSchema = t.TypeOf<typeof previewRulesSchema>;
+export const previewRulesSchema = t.intersection([
+  SharedCreateProps,
+  TypeSpecificCreateProps,
+  t.type({ invocationCount: t.number, timeframeEnd: t.string }),
+]);
+
+export interface RulePreviewLogs {
+  errors: string[];
+  warnings: string[];
+  startedAt?: string;
+  duration: number;
+}
+
+export interface PreviewResponse {
+  previewId: string | undefined;
+  logs: RulePreviewLogs[] | undefined;
+  isAborted: boolean | undefined;
+}

x-pack/plugins/security_solution/public/detection_engine/rule_management/api/api.ts

@@ -53,10 +53,7 @@ import type {
   BulkActionEditPayload,
 } from '../../../../common/api/detection_engine/rule_management/bulk_actions/bulk_actions_route';
 import { BulkActionType } from '../../../../common/api/detection_engine/rule_management/bulk_actions/bulk_actions_route';
-import type {
-  PreviewResponse,
-  RuleResponse,
-} from '../../../../common/api/detection_engine/model/rule_schema';
+import type { PreviewResponse, RuleResponse } from '../../../../common/api/detection_engine';
 
 import { KibanaServices } from '../../../common/lib/kibana';
 import * as i18n from '../../../detections/pages/detection_engine/rules/translations';

x-pack/plugins/security_solution/public/detections/components/rules/rule_preview/preview_logs.tsx

@@ -7,7 +7,7 @@
 
 import React, { Fragment, useMemo } from 'react';
 import { EuiCallOut, EuiText, EuiSpacer, EuiAccordion } from '@elastic/eui';
-import type { RulePreviewLogs } from '../../../../../common/api/detection_engine/model/rule_schema';
+import type { RulePreviewLogs } from '../../../../../common/api/detection_engine';
 import * as i18n from './translations';
 
 interface PreviewLogsComponentProps {

x-pack/plugins/security_solution/public/detections/components/rules/rule_preview/use_preview_route.tsx

@@ -9,7 +9,7 @@ import { useEffect, useState, useCallback } from 'react';
 import type { List } from '@kbn/securitysolution-io-ts-list-types';
 import { usePreviewRule } from './use_preview_rule';
 import { formatPreviewRule } from '../../../../detection_engine/rule_creation_ui/pages/rule_creation/helpers';
-import type { RulePreviewLogs } from '../../../../../common/api/detection_engine/model/rule_schema';
+import type { RulePreviewLogs } from '../../../../../common/api/detection_engine';
 import type {
   AboutStepRule,
   DefineStepRule,

x-pack/plugins/security_solution/public/detections/components/rules/rule_preview/use_preview_rule.ts

@@ -8,10 +8,7 @@
 import { useEffect, useMemo, useState } from 'react';
 
 import { useAppToasts } from '../../../../common/hooks/use_app_toasts';
-import type {
-  PreviewResponse,
-  RuleCreateProps,
-} from '../../../../../common/api/detection_engine/model/rule_schema';
+import type { PreviewResponse, RuleCreateProps } from '../../../../../common/api/detection_engine';
 
 import { previewRule } from '../../../../detection_engine/rule_management/api/api';
 import { transformOutput } from '../../../containers/detection_engine/rules/transforms';

x-pack/plugins/security_solution/server/lib/detection_engine/routes/index/create_index_route.ts

@@ -7,7 +7,7 @@
 
 import { chunk, get } from 'lodash';
 import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey';
-import type { ElasticsearchClient } from '@kbn/core/server';
+import type { ElasticsearchClient, IKibanaResponse } from '@kbn/core/server';
 import {
   transformError,
   getBootstrapIndexExists,
@@ -20,6 +20,7 @@ import type {
   SecuritySolutionPluginRouter,
 } from '../../../../types';
 import { DETECTION_ENGINE_INDEX_URL } from '../../../../../common/constants';
+import type { CreateIndexResponse } from '../../../../../common/api/detection_engine';
 import { buildSiemResponse } from '../utils';
 import {
   getSignalsTemplate,
@@ -43,7 +44,7 @@ export const createIndexRoute = (router: SecuritySolutionPluginRouter) => {
         tags: ['access:securitySolution'],
       },
     },
-    async (context, _, response) => {
+    async (context, _, response): Promise<IKibanaResponse<CreateIndexResponse>> => {
       const siemResponse = buildSiemResponse(response);
 
       try {

x-pack/plugins/security_solution/server/lib/detection_engine/routes/index/delete_index_route.ts

@@ -12,9 +12,12 @@ import {
   deletePolicy,
   deleteAllIndex,
 } from '@kbn/securitysolution-es-utils';
+
+import type { IKibanaResponse } from '@kbn/core/server';
 import type { SecuritySolutionPluginRouter } from '../../../../types';
 import { DETECTION_ENGINE_INDEX_URL } from '../../../../../common/constants';
 import { buildSiemResponse } from '../utils';
+import type { DeleteIndexResponse } from '../../../../../common/api/detection_engine';
 
 /**
  * Deletes all of the indexes, template, ilm policies, and aliases. You can check
@@ -36,7 +39,7 @@ export const deleteIndexRoute = (router: SecuritySolutionPluginRouter) => {
         tags: ['access:securitySolution'],
       },
     },
-    async (context, _, response) => {
+    async (context, _, response): Promise<IKibanaResponse<DeleteIndexResponse>> => {
       const siemResponse = buildSiemResponse(response);
 
       try {

x-pack/plugins/security_solution/server/lib/detection_engine/routes/index/read_alerts_index_exists_route.ts

@@ -6,10 +6,12 @@
  */
 
 import { transformError, getIndexExists } from '@kbn/securitysolution-es-utils';
+import type { IKibanaResponse } from '@kbn/core/server';
 import type { SecuritySolutionPluginRouter } from '../../../../types';
 import { DETECTION_ENGINE_ALERTS_INDEX_URL } from '../../../../../common/constants';
 
 import { buildSiemResponse } from '../utils';
+import type { ReadAlertsIndexExistsResponse } from '../../../../../common/api/detection_engine';
 
 export const readAlertsIndexExistsRoute = (router: SecuritySolutionPluginRouter) => {
   router.get(
@@ -20,7 +22,7 @@ export const readAlertsIndexExistsRoute = (router: SecuritySolutionPluginRouter)
         tags: ['access:securitySolution'],
       },
     },
-    async (context, _, response) => {
+    async (context, _, response): Promise<IKibanaResponse<ReadAlertsIndexExistsResponse>> => {
       const siemResponse = buildSiemResponse(response);
 
       try {

x-pack/plugins/security_solution/server/lib/detection_engine/routes/index/read_index_route.ts

@@ -7,6 +7,7 @@
 
 import { transformError, getBootstrapIndexExists } from '@kbn/securitysolution-es-utils';
 import type { RuleDataPluginService } from '@kbn/rule-registry-plugin/server';
+import type { IKibanaResponse } from '@kbn/core/server';
 import type { SecuritySolutionPluginRouter } from '../../../../types';
 import { DETECTION_ENGINE_INDEX_URL } from '../../../../../common/constants';
 
@@ -15,6 +16,7 @@ import { fieldAliasesOutdated } from './check_template_version';
 import { getIndexVersion } from './get_index_version';
 import { isOutdated } from '../../migrations/helpers';
 import { SIGNALS_TEMPLATE_VERSION } from './get_signals_template';
+import type { ReadIndexResponse } from '../../../../../common/api/detection_engine';
 
 export const readIndexRoute = (
   router: SecuritySolutionPluginRouter,
@@ -28,7 +30,7 @@ export const readIndexRoute = (
         tags: ['access:securitySolution'],
       },
     },
-    async (context, _, response) => {
+    async (context, _, response): Promise<IKibanaResponse<ReadIndexResponse>> => {
       const siemResponse = buildSiemResponse(response);
 
       try {

x-pack/plugins/security_solution/server/lib/detection_engine/routes/privileges/read_privileges_route.ts

@@ -8,9 +8,11 @@
 import { merge } from 'lodash/fp';
 
 import { readPrivileges, transformError } from '@kbn/securitysolution-es-utils';
+import type { IKibanaResponse } from '@kbn/core/server';
 import type { SecuritySolutionPluginRouter } from '../../../../types';
 import { DETECTION_ENGINE_PRIVILEGES_URL } from '../../../../../common/constants';
 import { buildSiemResponse } from '../utils';
+import type { ReadPrivilegesResponse } from '../../../../../common/api/detection_engine';
 
 export const readPrivilegesRoute = (
   router: SecuritySolutionPluginRouter,
@@ -24,7 +26,7 @@ export const readPrivilegesRoute = (
         tags: ['access:securitySolution'],
       },
     },
-    async (context, request, response) => {
+    async (context, request, response): Promise<IKibanaResponse<ReadPrivilegesResponse>> => {
       const siemResponse = buildSiemResponse(response);
 
       try {

x-pack/plugins/security_solution/server/lib/detection_engine/rule_preview/api/preview_rules/route.ts

@@ -28,8 +28,8 @@ import { RuleExecutionStatus } from '../../../../../../common/api/detection_engi
 import type {
   PreviewResponse,
   RulePreviewLogs,
-} from '../../../../../../common/api/detection_engine/model/rule_schema';
-import { previewRulesSchema } from '../../../../../../common/api/detection_engine/model/rule_schema';
+} from '../../../../../../common/api/detection_engine';
+import { previewRulesSchema } from '../../../../../../common/api/detection_engine';
 
 import type { StartPlugins, SetupPlugins } from '../../../../../plugin';
 import { buildSiemResponse } from '../../../routes/utils';