[Cases] Create internal API to filter cases by custom fields

x-pack/plugins/cases/common/types/api/case/v1.test.ts

@@ -40,6 +40,7 @@ import {
   CasesFindRequestSortFieldsRt,
   CasesFindResponseRt,
   CasesPatchRequestRt,
+  CasesSearchRequestRt,
 } from './v1';
 import { CustomFieldTypes } from '../../domain/custom_field/v1';
 
@@ -461,6 +462,50 @@ describe('CasesFindRequestRt', () => {
   });
 });
 
+describe('CasesSearchRequestRt', () => {
+  const defaultRequest = {
+    tags: ['new', 'case'],
+    status: CaseStatuses.open,
+    severity: CaseSeverity.LOW,
+    assignees: ['damaged_racoon'],
+    reporters: ['damaged_racoon'],
+    defaultSearchOperator: 'AND',
+    from: 'now',
+    page: '1',
+    perPage: '10',
+    search: 'search text',
+    searchFields: ['title', 'description'],
+    to: '1w',
+    sortOrder: 'desc',
+    sortField: 'createdAt',
+    owner: 'cases',
+    customFields: {
+      toggle_custom_field_key: [true],
+      another_custom_field: [null, false],
+      text_custom_field: ['hello'],
+      number_custom_field: [1234],
+    },
+  };
+
+  it('has expected attributes in request', () => {
+    const query = CasesSearchRequestRt.decode(defaultRequest);
+
+    expect(query).toStrictEqual({
+      _tag: 'Right',
+      right: { ...defaultRequest, page: 1, perPage: 10 },
+    });
+  });
+
+  it('removes foo:bar attributes from request', () => {
+    const query = CasesSearchRequestRt.decode({ ...defaultRequest, foo: 'bar' });
+
+    expect(query).toStrictEqual({
+      _tag: 'Right',
+      right: { ...defaultRequest, page: 1, perPage: 10 },
+    });
+  });
+});
+
 describe('Status', () => {
   describe('CasesStatusRequestRt', () => {
     const defaultRequest = {

x-pack/plugins/cases/common/types/api/case/v1.ts

@@ -283,6 +283,21 @@ export const CasesFindRequestRt = rt.intersection([
   paginationSchema({ maxPerPage: MAX_CASES_PER_PAGE }),
 ]);
 
+export const CasesSearchRequestRt = rt.intersection([
+  rt.exact(
+    rt.partial({
+      /**
+       * custom fields of the case
+       */
+      customFields: rt.record(
+        rt.string,
+        rt.array(rt.union([rt.string, rt.boolean, rt.number, rt.null]))
+      ),
+    })
+  ),
+  CasesFindRequestRt,
+]);
+
 export const CasesFindResponseRt = rt.intersection([
   rt.strict({
     cases: rt.array(CaseRt),
@@ -487,6 +502,7 @@ export type CaseResolveResponse = rt.TypeOf<typeof CaseResolveResponseRt>;
 export type CasesDeleteRequest = rt.TypeOf<typeof CasesDeleteRequestRt>;
 export type CasesByAlertIDRequest = rt.TypeOf<typeof CasesByAlertIDRequestRt>;
 export type CasesFindRequest = rt.TypeOf<typeof CasesFindRequestRt>;
+export type CasesSearchRequest = rt.TypeOf<typeof CasesSearchRequestRt>;
 export type CasesFindRequestSortFields = rt.TypeOf<typeof CasesFindRequestSortFieldsRt>;
 export type CasesFindResponse = rt.TypeOf<typeof CasesFindResponseRt>;
 export type CasePatchRequest = rt.TypeOf<typeof CasePatchRequestRt>;

x-pack/plugins/cases/server/client/cases/client.ts

@@ -8,7 +8,6 @@
 import type { Case, Cases, User } from '../../../common/types/domain';
 import type {
   CasePostRequest,
-  CasesFindRequest,
   CasesFindResponse,
   CaseResolveResponse,
   CasesBulkGetRequest,
@@ -20,14 +19,15 @@ import type {
   CasesBulkGetResponse,
   BulkCreateCasesRequest,
   BulkCreateCasesResponse,
+  CasesSearchRequest,
 } from '../../../common/types/api';
 import type { CasesClient } from '../client';
 import type { CasesClientInternal } from '../client_internal';
 import type { CasesClientArgs } from '../types';
 import { bulkGet } from './bulk_get';
 import { create } from './create';
 import { deleteCases } from './delete';
-import { find } from './find';
+import { search } from './search';
 import type { CasesByAlertIDParams, GetParams } from './get';
 import { get, resolve, getCasesByAlertID, getReporters, getTags, getCategories } from './get';
 import type { PushParams } from './push';
@@ -52,7 +52,7 @@ export interface CasesSubClient {
    *
    * If the `owner` field is left empty then all the cases that the user has access to will be returned.
    */
-  find(params: CasesFindRequest): Promise<CasesFindResponse>;
+  search(params: CasesSearchRequest): Promise<CasesFindResponse>;
   /**
    * Retrieves a single case with the specified ID.
    */
@@ -111,7 +111,7 @@ export const createCasesSubClient = (
   const casesSubClient: CasesSubClient = {
     create: (data: CasePostRequest) => create(data, clientArgs, casesClient),
     bulkCreate: (data: BulkCreateCasesRequest) => bulkCreate(data, clientArgs, casesClient),
-    find: (params: CasesFindRequest) => find(params, clientArgs),
+    search: (params: CasesSearchRequest) => search(params, clientArgs, casesClient),
     get: (params: GetParams) => get(params, clientArgs),
     resolve: (params: GetParams) => resolve(params, clientArgs),
     bulkGet: (params) => bulkGet(params, clientArgs),