@sitecore-cloudsdk/search 0.5.0-rc.0

package/dist/esm/src/lib/request-entities/filters/facet/logical-facet-filter.d.ts

@@ -0,0 +1,19 @@
+import type { FacetFilter } from '../../widgets/interfaces';
+import type { LogicalOperators } from '../interfaces';
+import type { FacetFilterBase, LogicalFacetFilterDTO } from './interfaces';
+/**
+ * Creates LogicalFacetFilter object.
+ */
+export declare class LogicalFacetFilter implements FacetFilterBase {
+    private _operator;
+    private _value;
+    /**
+     * @param operator - The operator to be applied on attribute.
+     * @param value - The value to check against of.
+     */
+    constructor(operator: Exclude<LogicalOperators, 'not'>, value: Array<FacetFilter>);
+    /**
+     * @returns The DTO representation of the filter.
+     */
+    toDTO(): LogicalFacetFilterDTO;
+}

package/dist/esm/src/lib/request-entities/filters/facet/logical-facet-filter.js

@@ -0,0 +1,22 @@
+/**
+ * Creates LogicalFacetFilter object.
+ */
+export class LogicalFacetFilter {
+    /**
+     * @param operator - The operator to be applied on attribute.
+     * @param value - The value to check against of.
+     */
+    constructor(operator, value) {
+        this._operator = operator;
+        this._value = value;
+    }
+    /**
+     * @returns The DTO representation of the filter.
+     */
+    toDTO() {
+        return {
+            filters: this._value.map((filter) => filter.toDTO()),
+            type: this._operator
+        };
+    }
+}

package/dist/esm/src/lib/request-entities/filters/facet/not-facet-filter.d.ts

@@ -0,0 +1,7 @@
+import type { FacetFilter } from '../../widgets/interfaces';
+import type { FacetFilterBase, NotFacetFilterDTO } from './interfaces';
+export declare class NotFacetFilter implements FacetFilterBase {
+    private _value;
+    constructor(value: string | FacetFilter);
+    toDTO(): NotFacetFilterDTO;
+}

package/dist/esm/src/lib/request-entities/filters/facet/not-facet-filter.js

@@ -0,0 +1,18 @@
+export class NotFacetFilter {
+    constructor(value) {
+        this._value = value;
+    }
+    toDTO() {
+        /**
+         * If the value is a string, it probably means that it is a facet filter id.
+         * Otherwise, it is a facet filter object, so we need to convert it to DTO.
+         * @example facetid_eyJ0eXBlIjoiZXEiLCJuYW1lIjoicHJvZHVjdCIsInZhbHVlIjoiQ0RQIn0=
+         * @example \{"type": "not", "filter": \{ "type": "eq", "value": "test" \}\}
+         */
+        const filter = typeof this._value === 'string' ? this._value : this._value.toDTO();
+        return {
+            filter,
+            type: 'not'
+        };
+    }
+}

package/dist/esm/src/lib/request-entities/filters/geo-filter.d.ts

@@ -0,0 +1,19 @@
+import { BaseFilter } from './base-filter';
+import type { GeoFilterData, GeoFilterDTO } from './interfaces';
+export declare const GEO_FILTER_TYPE = "geoDistance";
+/**
+ * Creates a GeoFilter object which denotes the base of each filter.
+ */
+export declare class GeoFilter extends BaseFilter {
+    private _attributeName;
+    /**
+     * @param attributeName - The name of the attribute to filter.
+     * @param geoFilterData - The geo filter data like location and distance.
+     */
+    constructor(attributeName: string, geoFilterData?: GeoFilterData);
+    private _validateLocation;
+    /**
+     * @returns The DTO representation of the filter.
+     */
+    toDTO(): GeoFilterDTO;
+}

package/dist/esm/src/lib/request-entities/filters/geo-filter.js

@@ -0,0 +1,45 @@
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+import { isValidLocation } from '@sitecore-cloudsdk/utils';
+import { ErrorMessages } from '../../consts';
+import { BaseFilter } from './base-filter';
+export const GEO_FILTER_TYPE = 'geoDistance';
+/**
+ * Creates a GeoFilter object which denotes the base of each filter.
+ */
+export class GeoFilter extends BaseFilter {
+    /**
+     * @param attributeName - The name of the attribute to filter.
+     * @param geoFilterData - The geo filter data like location and distance.
+     */
+    constructor(attributeName, geoFilterData) {
+        super(GEO_FILTER_TYPE, geoFilterData);
+        if (geoFilterData?.location)
+            this._validateLocation(geoFilterData.location);
+        this._attributeName = attributeName;
+    }
+    _validateLocation(location) {
+        const result = isValidLocation(location);
+        if (!result.latitude)
+            throw new Error(ErrorMessages.IV_0012);
+        if (!result.longitude)
+            throw new Error(ErrorMessages.IV_0013);
+    }
+    /**
+     * @returns The DTO representation of the filter.
+     */
+    toDTO() {
+        const dto = {
+            name: this._attributeName,
+            type: GEO_FILTER_TYPE
+        };
+        if (this.value && this.value.distance)
+            dto.distance = this.value.distance;
+        if (this.value && this.value.location) {
+            /* eslint-disable @typescript-eslint/no-non-null-assertion */
+            dto.lat = this.value.location.latitude;
+            dto.lon = this.value.location.longitude;
+            /* eslint-enable @typescript-eslint/no-non-null-assertion */
+        }
+        return dto;
+    }
+}

package/dist/esm/src/lib/request-entities/filters/geo-within-filter.d.ts

@@ -0,0 +1,19 @@
+import { BaseFilter } from './base-filter';
+import type { GeoWithinFilterData, GeoWithinFilterDTO } from './interfaces';
+export declare const GEO_FILTER_TYPE = "geoWithin";
+/**
+ * Creates a GeoWithinFilter object which denotes the base of each filter.
+ */
+export declare class GeoWithinFilter extends BaseFilter {
+    private _attributeName;
+    /**
+     * @param attributeName - The name of the attribute to filter.
+     * @param geoWithinFilterData - The geo within filter data. Array of location objects.
+     */
+    constructor(attributeName: string, geoWithinFilterData: GeoWithinFilterData);
+    private _validateLocation;
+    /**
+     * @returns The DTO representation of the filter.
+     */
+    toDTO(): GeoWithinFilterDTO;
+}

package/dist/esm/src/lib/request-entities/filters/geo-within-filter.js

@@ -0,0 +1,40 @@
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+import { isValidLocation } from '@sitecore-cloudsdk/utils';
+import { ErrorMessages } from '../../consts';
+import { BaseFilter } from './base-filter';
+export const GEO_FILTER_TYPE = 'geoWithin';
+/**
+ * Creates a GeoWithinFilter object which denotes the base of each filter.
+ */
+export class GeoWithinFilter extends BaseFilter {
+    /**
+     * @param attributeName - The name of the attribute to filter.
+     * @param geoWithinFilterData - The geo within filter data. Array of location objects.
+     */
+    constructor(attributeName, geoWithinFilterData) {
+        super(GEO_FILTER_TYPE, geoWithinFilterData);
+        geoWithinFilterData.forEach((location) => this._validateLocation(location));
+        this._attributeName = attributeName;
+    }
+    _validateLocation(location) {
+        const result = isValidLocation(location);
+        if (!result.latitude)
+            throw new Error(ErrorMessages.IV_0012);
+        if (!result.longitude)
+            throw new Error(ErrorMessages.IV_0013);
+    }
+    /**
+     * @returns The DTO representation of the filter.
+     */
+    toDTO() {
+        const dto = {
+            coordinates: this.value.map((location) => ({
+                lat: location.latitude,
+                lon: location.longitude
+            })),
+            name: this._attributeName,
+            type: GEO_FILTER_TYPE
+        };
+        return dto;
+    }
+}

package/dist/esm/src/lib/request-entities/filters/interfaces.d.ts

@@ -0,0 +1,66 @@
+import type { LocationData } from '../context/interfaces';
+import type { BaseFilter } from './base-filter';
+import type { ComparisonFilter } from './comparison-filter';
+import type { GeoFilter } from './geo-filter';
+import type { GeoWithinFilter } from './geo-within-filter';
+import type { ListFilter } from './list-filter';
+import type { LogicalFilter } from './logical-filter';
+export type Filter = LogicalFilter<keyof LogicalFilterValues> | GeoFilter | ComparisonFilter | ListFilter | GeoWithinFilter;
+export type FilterDTO = LogicalFilterDTO | NotFilterDTO | GeoFilterDTO | ComparisonFilterDTO | ListFilterDTO | GeoWithinFilterDTO;
+export interface ComparisonFilterDTO {
+    name: string;
+    type: string;
+    value: unknown;
+}
+export interface ListFilterDTO {
+    name: string;
+    type: string;
+    values: unknown[];
+}
+export interface LogicalFilterDTO {
+    filters: ArrayOfAtLeastTwo<ComparisonFilterDTO | LogicalFilterDTO | NotFilterDTO>;
+    type: string;
+}
+export interface GeoFilterData {
+    distance?: DistanceString;
+    location?: LocationData;
+}
+export type GeoWithinFilterData = ArrayOfAtLeastThree<LocationData>;
+export interface GeoFilterDTO {
+    distance?: DistanceString;
+    name: string;
+    type: GeoOperator;
+    lat?: number;
+    lon?: number;
+}
+export interface LocationDTO {
+    lat: number;
+    lon: number;
+}
+export interface GeoWithinFilterDTO {
+    name: string;
+    type: GeoWithinOperator;
+    coordinates: ArrayOfAtLeastThree<LocationDTO>;
+}
+export type DistanceString = `${number}${DistanceUnits}`;
+type DistanceUnits = 'in' | 'ft' | 'yd' | 'nmi' | 'km' | 'm' | 'cm' | 'mm';
+export interface NotFilterDTO {
+    type: string;
+    filter: ComparisonFilterDTO | LogicalFilterDTO;
+}
+export type ComparisonOperators = 'eq' | 'gt' | 'gte' | 'lt' | 'lte';
+export type LogicalOperators = 'and' | 'or' | 'not';
+export type ListOperators = 'allOf' | 'anyOf';
+export type GeoOperator = 'geoDistance';
+export type GeoWithinOperator = 'geoWithin';
+export type Operators = ComparisonOperators | LogicalOperators | GeoOperator | GeoWithinOperator | ListOperators;
+export interface LogicalFilterValues {
+    not: BaseFilter;
+    or: ArrayOfAtLeastTwo<BaseFilter>;
+    and: ArrayOfAtLeastTwo<BaseFilter>;
+}
+export type ArrayOfAtLeastOne<T> = [T, ...T[]];
+export type ArrayOfAtLeastTwo<T> = [T, T, ...T[]];
+export type ArrayOfAtLeastThree<T> = [T, T, T, ...T[]];
+export type PickLogicalDTO<T extends keyof LogicalFilterValues> = T extends 'not' ? NotFilterDTO : LogicalFilterDTO;
+export {};

package/dist/esm/src/lib/request-entities/filters/interfaces.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/src/lib/request-entities/filters/list-filter.d.ts

@@ -0,0 +1,18 @@
+import { BaseFilter } from './base-filter';
+import type { ListFilterDTO, ListOperators } from './interfaces';
+/**
+ * Creates ListFilter object which denotes the base of each filter.
+ */
+export declare class ListFilter extends BaseFilter {
+    private _attributeName;
+    /**
+     * @param attributeName - The name of the attribute to filter.
+     * @param operator - The operator to be applied on attribute.
+     * @param value - The value to check against of.
+     */
+    constructor(attributeName: string, operator: ListOperators, value: unknown[]);
+    /**
+     * @returns The DTO representation of the filter.
+     */
+    toDTO(): ListFilterDTO;
+}

package/dist/esm/src/lib/request-entities/filters/list-filter.js

@@ -0,0 +1,26 @@
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+import { BaseFilter } from './base-filter';
+/**
+ * Creates ListFilter object which denotes the base of each filter.
+ */
+export class ListFilter extends BaseFilter {
+    /**
+     * @param attributeName - The name of the attribute to filter.
+     * @param operator - The operator to be applied on attribute.
+     * @param value - The value to check against of.
+     */
+    constructor(attributeName, operator, value) {
+        super(operator, value);
+        this._attributeName = attributeName;
+    }
+    /**
+     * @returns The DTO representation of the filter.
+     */
+    toDTO() {
+        return {
+            name: this._attributeName,
+            type: this.operator,
+            values: this.value
+        };
+    }
+}

package/dist/esm/src/lib/request-entities/filters/logical-filter.d.ts

@@ -0,0 +1,16 @@
+import { BaseFilter } from './base-filter';
+import type { LogicalFilterValues, PickLogicalDTO } from './interfaces';
+/**
+ * Creates a LogicalFilter object which denotes the base of each filter.
+ */
+export declare class LogicalFilter<T extends keyof LogicalFilterValues> extends BaseFilter {
+    /**
+     * @param operator - The operator to be applied on attribute.
+     * @param value - The value to check against. Using "and" or the "or" filter, you must include minimum 2 filters.
+     */
+    constructor(operator: T, value: LogicalFilterValues[T]);
+    /**
+     * @returns The DTO representation of the filter.
+     */
+    toDTO(): PickLogicalDTO<T>;
+}

package/dist/esm/src/lib/request-entities/filters/logical-filter.js

@@ -0,0 +1,28 @@
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+import { BaseFilter } from './base-filter';
+/**
+ * Creates a LogicalFilter object which denotes the base of each filter.
+ */
+export class LogicalFilter extends BaseFilter {
+    /**
+     * @param operator - The operator to be applied on attribute.
+     * @param value - The value to check against. Using "and" or the "or" filter, you must include minimum 2 filters.
+     */
+    constructor(operator, value) {
+        super(operator, value);
+    }
+    /**
+     * @returns The DTO representation of the filter.
+     */
+    toDTO() {
+        if (this.operator === 'not')
+            return {
+                filter: this.value.toDTO(),
+                type: this.operator
+            };
+        return {
+            filters: this.value.map((filter) => filter.toDTO()),
+            type: this.operator
+        };
+    }
+}