Merge 45e8b0e into 75a2d99

docs/search-core.conjunctionstaticfilter.combinator.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [ConjunctionStaticFilter](./search-core.conjunctionstaticfilter.md) &gt; [combinator](./search-core.conjunctionstaticfilter.combinator.md)
+
+## ConjunctionStaticFilter.combinator property
+
+Indicates that filters should be combined with a logical AND.
+
+<b>Signature:</b>
+
+```typescript
+combinator: FilterCombinator.AND;
+```

docs/search-core.conjunctionstaticfilter.filters.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [ConjunctionStaticFilter](./search-core.conjunctionstaticfilter.md) &gt; [filters](./search-core.conjunctionstaticfilter.filters.md)
+
+## ConjunctionStaticFilter.filters property
+
+The filters to combine together.
+
+<b>Signature:</b>
+
+```typescript
+filters: StaticFilter[];
+```

docs/search-core.conjunctionstaticfilter.kind.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [ConjunctionStaticFilter](./search-core.conjunctionstaticfilter.md) &gt; [kind](./search-core.conjunctionstaticfilter.kind.md)
+
+## ConjunctionStaticFilter.kind property
+
+The kind of static filter.
+
+<b>Signature:</b>
+
+```typescript
+kind: 'conjunction';
+```

docs/search-core.conjunctionstaticfilter.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [ConjunctionStaticFilter](./search-core.conjunctionstaticfilter.md)
+
+## ConjunctionStaticFilter interface
+
+A static filter composed by combining other static filters with the logical AND operator.
+
+<b>Signature:</b>
+
+```typescript
+export interface ConjunctionStaticFilter 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [combinator](./search-core.conjunctionstaticfilter.combinator.md) | [FilterCombinator.AND](./search-core.filtercombinator.md) | Indicates that filters should be combined with a logical AND. |
+|  [filters](./search-core.conjunctionstaticfilter.filters.md) | [StaticFilter](./search-core.staticfilter.md)<!-- -->\[\] | The filters to combine together. |
+|  [kind](./search-core.conjunctionstaticfilter.kind.md) | 'conjunction' | The kind of static filter. |
+

docs/search-core.disjunctionstaticfilter.combinator.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [DisjunctionStaticFilter](./search-core.disjunctionstaticfilter.md) &gt; [combinator](./search-core.disjunctionstaticfilter.combinator.md)
+
+## DisjunctionStaticFilter.combinator property
+
+Indicates that filters should be combined with a logical OR.
+
+<b>Signature:</b>
+
+```typescript
+combinator: FilterCombinator.OR;
+```

docs/search-core.disjunctionstaticfilter.filters.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [DisjunctionStaticFilter](./search-core.disjunctionstaticfilter.md) &gt; [filters](./search-core.disjunctionstaticfilter.filters.md)
+
+## DisjunctionStaticFilter.filters property
+
+The filters to combine together.
+
+<b>Signature:</b>
+
+```typescript
+filters: (DisjunctionStaticFilter | FieldValueStaticFilter)[];
+```

docs/search-core.disjunctionstaticfilter.kind.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [DisjunctionStaticFilter](./search-core.disjunctionstaticfilter.md) &gt; [kind](./search-core.disjunctionstaticfilter.kind.md)
+
+## DisjunctionStaticFilter.kind property
+
+The kind of static filter.
+
+<b>Signature:</b>
+
+```typescript
+kind: 'disjunction';
+```

docs/search-core.disjunctionstaticfilter.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [DisjunctionStaticFilter](./search-core.disjunctionstaticfilter.md)
+
+## DisjunctionStaticFilter interface
+
+A static filter composed by combining filters with the logical OR operator. The combined filters can either be field value filters or other disjunction filters.
+
+<b>Signature:</b>
+
+```typescript
+export interface DisjunctionStaticFilter 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [combinator](./search-core.disjunctionstaticfilter.combinator.md) | [FilterCombinator.OR](./search-core.filtercombinator.md) | Indicates that filters should be combined with a logical OR. |
+|  [filters](./search-core.disjunctionstaticfilter.filters.md) | ([DisjunctionStaticFilter](./search-core.disjunctionstaticfilter.md) \| [FieldValueStaticFilter](./search-core.fieldvaluestaticfilter.md)<!-- -->)\[\] | The filters to combine together. |
+|  [kind](./search-core.disjunctionstaticfilter.kind.md) | 'disjunction' | The kind of static filter. |
+

docs/search-core.fieldvaluestaticfilter.kind.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [FieldValueStaticFilter](./search-core.fieldvaluestaticfilter.md) &gt; [kind](./search-core.fieldvaluestaticfilter.kind.md)
+
+## FieldValueStaticFilter.kind property
+
+The kind of static filter.
+
+<b>Signature:</b>
+
+```typescript
+kind: 'fieldValue';
+```

docs/search-core.fieldvaluestaticfilter.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [FieldValueStaticFilter](./search-core.fieldvaluestaticfilter.md)
+
+## FieldValueStaticFilter interface
+
+A [FieldValueFilter](./search-core.fieldvaluefilter.md) with the kind of filter specified to discriminate between static filter types.
+
+<b>Signature:</b>
+
+```typescript
+export interface FieldValueStaticFilter extends FieldValueFilter 
+```
+<b>Extends:</b> [FieldValueFilter](./search-core.fieldvaluefilter.md)
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [kind](./search-core.fieldvaluestaticfilter.kind.md) | 'fieldValue' | The kind of static filter. |
+

docs/search-core.md

@@ -53,7 +53,9 @@
 |  [BaseAnswersConfig](./search-core.baseanswersconfig.md) |  |
 |  [BaseSearchConfig](./search-core.basesearchconfig.md) | The base configuration options for [SearchCore](./search-core.searchcore.md)<!-- -->. |
 |  [ClientSDKHeaderValues](./search-core.clientsdkheadervalues.md) | Additional agents and their versions used to create the Search experience. The information for these agents is added to the Client-SDK HTTP header along with that of the ANSWERS\_CORE agent. |
+|  [ConjunctionStaticFilter](./search-core.conjunctionstaticfilter.md) | A static filter composed by combining other static filters with the logical AND operator. |
 |  [DirectAnswer](./search-core.directanswer.md) | A direct answer to a search. |
+|  [DisjunctionStaticFilter](./search-core.disjunctionstaticfilter.md) | A static filter composed by combining filters with the logical OR operator. The combined filters can either be field value filters or other disjunction filters. |
 |  [DisplayableFacet](./search-core.displayablefacet.md) | A [Facet](./search-core.facet.md) which contains extra fields meant to be displayed to the end user. |
 |  [DisplayableFacetOption](./search-core.displayablefacetoption.md) | A [FacetOption](./search-core.facetoption.md) with extra data meant to be displayed to the end user. |
 |  [Endpoints](./search-core.endpoints.md) | Overrides for the URLs which are used when making requests to the Search API. |
@@ -63,6 +65,7 @@
 |  [FeaturedSnippetDirectAnswer](./search-core.featuredsnippetdirectanswer.md) | A direct answer which was found within a document. |
 |  [FieldValueDirectAnswer](./search-core.fieldvaluedirectanswer.md) | A direct answer where the answer came from a field from the knowledge graph. |
 |  [FieldValueFilter](./search-core.fieldvaluefilter.md) | Represents a filter which compares values to a single field. |
+|  [FieldValueStaticFilter](./search-core.fieldvaluestaticfilter.md) | A [FieldValueFilter](./search-core.fieldvaluefilter.md) with the kind of filter specified to discriminate between static filter types. |
 |  [FilterSearchRequest](./search-core.filtersearchrequest.md) | Options for a filtersearch request. |
 |  [FilterSearchResponse](./search-core.filtersearchresponse.md) | The response of a filtersearch request. |
 |  [HighlightedValue](./search-core.highlightedvalue.md) | A field value and its substring matches as emphasized by the Search API. |

docs/search-core.staticfilter.md

@@ -9,14 +9,7 @@ Represents a static filter that will be used to refine results.
 <b>Signature:</b>
 
 ```typescript
-export declare type StaticFilter = {
-    kind: 'fieldValue';
-    value: FieldValueFilter;
-} | {
-    kind: 'combination';
-    combinator: FilterCombinator;
-    children: StaticFilter[];
-};
+export declare type StaticFilter = FieldValueStaticFilter | DisjunctionStaticFilter | ConjunctionStaticFilter;
 ```
-<b>References:</b> [FieldValueFilter](./search-core.fieldvaluefilter.md)<!-- -->, [FilterCombinator](./search-core.filtercombinator.md)<!-- -->, [StaticFilter](./search-core.staticfilter.md)
+<b>References:</b> [FieldValueStaticFilter](./search-core.fieldvaluestaticfilter.md)<!-- -->, [DisjunctionStaticFilter](./search-core.disjunctionstaticfilter.md)<!-- -->, [ConjunctionStaticFilter](./search-core.conjunctionstaticfilter.md)
 

etc/search-core.api.md

@@ -105,6 +105,13 @@ export interface ClientSDKHeaderValues {
     ANSWERS_CORE?: never;
 }
 
+// @public
+export interface ConjunctionStaticFilter {
+    combinator: FilterCombinator.AND;
+    filters: StaticFilter[];
+    kind: 'conjunction';
+}
+
 // @public
 export type Context = any;
 
@@ -129,6 +136,13 @@ export enum Direction {
     Descending = "DESC"
 }
 
+// @public
+export interface DisjunctionStaticFilter {
+    combinator: FilterCombinator.OR;
+    filters: (DisjunctionStaticFilter | FieldValueStaticFilter)[];
+    kind: 'disjunction';
+}
+
 // @public
 export interface DisplayableFacet extends Facet {
     displayName: string;
@@ -219,6 +233,11 @@ export interface FieldValueFilter {
     value: string | number | boolean | NearFilterValue | NumberRangeValue;
 }
 
+// @public
+export interface FieldValueStaticFilter extends FieldValueFilter {
+    kind: 'fieldValue';
+}
+
 // @public
 export enum FilterCombinator {
     AND = "$and",
@@ -504,14 +523,7 @@ export enum SpellCheckType {
 }
 
 // @public
-export type StaticFilter = {
-    kind: 'fieldValue';
-    value: FieldValueFilter;
-} | {
-    kind: 'combination';
-    combinator: FilterCombinator;
-    children: StaticFilter[];
-};
+export type StaticFilter = FieldValueStaticFilter | DisjunctionStaticFilter | ConjunctionStaticFilter;
 
 // @public
 export interface UniversalAutocompleteRequest extends SearchRequest {

src/models/index.ts

@@ -33,7 +33,13 @@ export { QuestionSubmissionRequest } from './questionsubmission/QuestionSubmissi
 export { QuestionSubmissionResponse } from './questionsubmission/QuestionSubmissionResponse';
 
 // Search service request models
-export { StaticFilter, FilterCombinator } from './searchservice/request/StaticFilter';
+export {
+  StaticFilter,
+  FieldValueStaticFilter,
+  ConjunctionStaticFilter,
+  DisjunctionStaticFilter,
+  FilterCombinator
+} from './searchservice/request/StaticFilter';
 export { Context } from './searchservice/request/Context';
 export { UniversalLimit } from './searchservice/request/UniversalLimit';
 export { LatLong } from './searchservice/request/LatLong';

src/models/searchservice/request/StaticFilter.ts

@@ -5,9 +5,49 @@ import { FieldValueFilter } from './FieldValueFilter';
  *
  * @public
  */
-export type StaticFilter =
-  { kind: 'fieldValue', value: FieldValueFilter } |
-  { kind: 'combination', combinator: FilterCombinator, children: StaticFilter[] };
+export type StaticFilter = FieldValueStaticFilter | DisjunctionStaticFilter | ConjunctionStaticFilter;
+
+/**
+ * A {@link FieldValueFilter} with the kind of filter specified
+ * to discriminate between static filter types.
+ *
+ * @public
+ */
+export interface FieldValueStaticFilter extends FieldValueFilter {
+  /** The kind of static filter. */
+  kind: 'fieldValue'
+}
+
+/**
+ * A static filter composed by combining filters with the logical OR
+ * operator. The combined filters can either be field value filters or
+ * other disjunction filters.
+ *
+ * @public
+ */
+export interface DisjunctionStaticFilter {
+  /** {@inheritDoc FieldValueStaticFilter.kind} */
+  kind: 'disjunction',
+  /** {@inheritDoc FilterCombinator.OR} */
+  combinator: FilterCombinator.OR,
+  /** The filters to combine together. */
+  filters: (DisjunctionStaticFilter | FieldValueStaticFilter)[]
+}
+
+/**
+ * A static filter composed by combining other static filters with the
+ * logical AND operator.
+ *
+ * @public
+ */
+export interface ConjunctionStaticFilter {
+  /** {@inheritDoc FieldValueStaticFilter.kind} */
+  kind: 'conjunction',
+  /** {@inheritDoc FilterCombinator.AND} */
+  combinator: FilterCombinator.AND,
+  /** {@inheritDoc DisjunctionStaticFilter.filters} */
+  filters: StaticFilter[]
+}
 
 /**
  * Indicates how child filters in a {@link StaticFilter} should be combined.

src/serializers/serializeStaticFilters.ts

@@ -4,34 +4,33 @@ import { FieldValueFilter } from '../models/searchservice/request/FieldValueFilt
 import { ApiStaticFilters, ApiFilter } from '../models/searchservice/request/ApiStaticFilters';
 
 export function serializeStaticFilters(filter: StaticFilter): string | undefined {
-  if (filter.kind === 'combination') {
-    const shapedFilter = shapeCombinedFilterForApi(filter.combinator, filter.children);
+  if (filter.kind !== 'fieldValue') {
+    const shapedFilter = shapeCombinedFilterForApi(filter.combinator, filter.filters);
     return shapedFilter && JSON.stringify(shapedFilter);
   }
 
-  return JSON.stringify(shapeFieldValueFilterForApi(filter.value));
+  return JSON.stringify(shapeFieldValueFilterForApi(filter));
 }
 
 function shapeCombinedFilterForApi(
   combinator: FilterCombinator,
   filters: StaticFilter[]
 ): ApiStaticFilters | undefined {
-  if (filters.length === 0) {
-    return undefined;
-  }
-
   const shapedFilters: ApiStaticFilters[] = [];
   for (const filter of filters) {
-    if (filter.kind === 'combination') {
-      const shapedFilter = shapeCombinedFilterForApi(filter.combinator, filter.children);
+    if (filter.kind !== 'fieldValue') {
+      const shapedFilter = shapeCombinedFilterForApi(filter.combinator, filter.filters);
       shapedFilter && shapedFilters.push(shapedFilter);
     } else {
-      shapedFilters.push(shapeFieldValueFilterForApi(filter.value));
+      shapedFilters.push(shapeFieldValueFilterForApi(filter));
     }
   }
-  return shapedFilters.length === 1
-    ? shapedFilters[0]
-    : { [combinator]: shapedFilters };
+
+  return shapedFilters.length === 0
+    ? undefined
+    : shapedFilters.length === 1
+      ? shapedFilters[0]
+      : { [combinator]: shapedFilters };
 }
 
 export function shapeFieldValueFilterForApi(filter: FieldValueFilter): ApiStaticFilters {

tests/infra/SearchServiceImpl.ts

@@ -276,11 +276,9 @@ describe('SearchService', () => {
         }],
         staticFilter: {
           kind: 'fieldValue',
-          value: {
-            fieldId: 'city',
-            matcher: Matcher.NotEquals,
-            value: 'Arlington'
-          }
+          fieldId: 'city',
+          matcher: Matcher.NotEquals,
+          value: 'Arlington'
         },
         verticalKey: 'verticalKey'
       };