@constructor-io/constructorio-node 4.4.3 → 4.4.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-node",
-  "version": "4.4.3",
+  "version": "4.4.4",
   "description": "Constructor.io Node.js client",
   "main": "src/constructorio.js",
   "types": "src/types/constructorio.d.ts",

package/src/types/browse.d.ts

@@ -11,6 +11,7 @@ import {
   ResultSources,
   SortOption,
   FmtOptions,
+  FilterExpression,
 } from '.';
 
 export default Browse;
@@ -24,6 +25,7 @@ export interface BrowseParameters {
   sortOrder?: string;
   section?: string;
   fmtOptions?: FmtOptions;
+  preFilterExpression?: FilterExpression;
   hiddenFields?: string[];
   hiddenFacets?: string[];
   variationsMap?: Record<string, any>;

package/src/types/index.d.ts

@@ -275,3 +275,31 @@ export interface SynonymGroup extends Record<string, any> {
   synonym_group_id: number;
   synonyms: string[];
 }
+
+export type FilterExpression =
+  | FilterExpressionGroup
+  | FilterExpressionNot
+  | FilterExpressionValue
+  | FilterExpressionRange;
+
+export type FilterExpressionGroup =
+  | FilterExpressionGroupOr
+  | FilterExpressionGroupAnd;
+
+export type FilterExpressionGroupOr = { or: FilterExpression[] };
+export type FilterExpressionGroupAnd = { and: FilterExpression[] };
+export type FilterExpressionCondition = 'or' | 'and';
+
+export type FilterExpressionNot = { not: FilterExpression };
+
+export type FilterExpressionValue = {
+  name: string;
+  value: string;
+};
+
+export type FilterExpressionRange = {
+  name: string;
+  range: FilterExpressionRangeValue;
+};
+
+export type FilterExpressionRangeValue = ['-inf' | number, 'inf' | number];

package/src/types/search.d.ts

@@ -2,6 +2,7 @@ import {
   ConstructorClientOptions,
   Facet,
   Feature,
+  FilterExpression,
   FmtOption,
   Group,
   NetworkParameters,
@@ -22,6 +23,7 @@ export interface SearchParameters {
   sortOrder?: string;
   section?: string;
   fmtOptions?: Record<string, any>;
+  preFilterExpression?: FilterExpression;
   hiddenFields?: string[];
   hiddenFacets?: string[];
   variationsMap?: Record<string, any>;

package/src/types/tests/types.test-d.ts

@@ -0,0 +1,33 @@
+import { expectAssignable } from 'tsd';
+import { FilterExpression } from '../index';
+
+expectAssignable<FilterExpression>({
+  or: [
+    {
+      and: [
+        {
+          name: 'group_id',
+          value: 'electronics-group-id',
+        },
+        {
+          name: 'Price',
+          range: ['-inf', 200],
+        },
+      ],
+    },
+    {
+      and: [
+        {
+          name: 'Type',
+          value: 'Laptop',
+        },
+        {
+          not: {
+            name: 'Price',
+            range: [800, 'inf'],
+          },
+        },
+      ],
+    },
+  ],
+});