@sitecore-cloudsdk/search 0.5.0-rc.0

package/dist/cjs/src/lib/request-entities/context/context.d.ts

@@ -0,0 +1,141 @@
+import type { BrowserData, CampaignData, ContextData, ContextDTO, GeoData, LocaleData, PageData, StoreData, UserData } from './interfaces';
+/**
+ * Create context object.
+ * @param context - The context object.
+ * @returns the validated and mapped context object
+ */
+export declare class Context {
+    private _campaign?;
+    private _locale?;
+    private _page?;
+    private _store?;
+    private _geo?;
+    private _user?;
+    private _browser?;
+    /**
+     * @param context - The context object.
+     * @returns the validated and mapped context object
+     */
+    constructor(context: ContextData);
+    /**
+     * Sets the campaign data.
+     * @param campaign - The new value to set.
+     *
+     */
+    set campaign(campaign: CampaignData);
+    /**
+     * @returns The campaign data.
+     */
+    get campaign(): CampaignData | undefined;
+    /**
+     * Sets the campaign data to undefined
+     */
+    removeCampaign(): void;
+    /**
+     * Sets the locale data.
+     * @param locale - The new value to set.
+     *
+     */
+    set locale(locale: LocaleData);
+    /**
+     * @returns The locale data.
+     */
+    get locale(): LocaleData | undefined;
+    /**
+     * Sets the campaign data to undefined
+     */
+    removeLocale(): void;
+    /**
+     * Sets the page data.
+     * @param page - The new value to set.
+     *
+     */
+    set page(page: PageData);
+    /**
+     * @returns The page data.
+     */
+    get page(): PageData | undefined;
+    /**
+     * Sets the page data to undefined
+     */
+    removePage(): void;
+    /**
+     * Validate context locale object.
+     */
+    private _validateContextLocale;
+    /**
+     * Sets the store data.
+     * @param store - The new value to set.
+     *
+     */
+    set store(store: StoreData);
+    /**
+     * @returns The store data.
+     */
+    get store(): StoreData | undefined;
+    /**
+     * Sets the store data to undefined
+     */
+    removeStore(): void;
+    /**
+     * Sets the geo data.
+     * @param geo - The new value to set.
+     *
+     */
+    set geo(geo: GeoData);
+    /**
+     * @returns The geo data.
+     */
+    get geo(): GeoData | undefined;
+    /**
+     * Sets the geo data to undefined
+     */
+    removeGeo(): void;
+    /**
+     * Validate location object.
+     */
+    private _validateLocation;
+    /**
+     * Sets the user data.
+     * @param user - The new value to set.
+     */
+    set user(user: UserData | undefined);
+    /**
+     * @returns The user data.
+     */
+    get user(): UserData | undefined;
+    /** Simply removes the user data from the context */
+    removeUser(): void;
+    /**
+     * Validate user object, which is part of the context object.
+     * We need to ensure that the user object has `userId` or `uuid`, but not neither.
+     * @param user - The user object to validate.
+     */
+    private _validateUser;
+    /**
+     * Sets the browser data
+     */
+    set browser(browser: BrowserData);
+    /**
+     * @returns The browser data.
+     */
+    get browser(): BrowserData | undefined;
+    /**
+     * Sets the browser dta to undefined.
+     */
+    removeBrowser(): void;
+    /**
+     * Validate context object.
+     */
+    private _validateContext;
+    /**
+     * Validate the `page` object which required a `uri` property.
+     * @param page - The page object to validate.
+     */
+    private _validatePage;
+    /**
+     * Map context object to DTO.
+     * @returns The DTO representation of the filter.
+     */
+    toDTO(): ContextDTO;
+}

package/dist/cjs/src/lib/request-entities/context/context.js

@@ -0,0 +1,273 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Context = void 0;
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+const utils_1 = require("@sitecore-cloudsdk/utils");
+const consts_1 = require("../../consts");
+/**
+ * Create context object.
+ * @param context - The context object.
+ * @returns the validated and mapped context object
+ */
+class Context {
+    /**
+     * @param context - The context object.
+     * @returns the validated and mapped context object
+     */
+    constructor(context) {
+        this._validateContext(context);
+        this._campaign = context.campaign;
+        this._locale = context.locale;
+        this._page = context.page;
+        this._store = context.store;
+        this._geo = context.geo;
+        this._browser = context.browser;
+        this._user = context.user;
+    }
+    /**
+     * Sets the campaign data.
+     * @param campaign - The new value to set.
+     *
+     */
+    set campaign(campaign) {
+        this._campaign = campaign;
+    }
+    /**
+     * @returns The campaign data.
+     */
+    get campaign() {
+        return this._campaign;
+    }
+    /**
+     * Sets the campaign data to undefined
+     */
+    removeCampaign() {
+        this._campaign = undefined;
+    }
+    /**
+     * Sets the locale data.
+     * @param locale - The new value to set.
+     *
+     */
+    set locale(locale) {
+        this._validateContextLocale(locale);
+        this._locale = locale;
+    }
+    /**
+     * @returns The locale data.
+     */
+    get locale() {
+        return this._locale;
+    }
+    /**
+     * Sets the campaign data to undefined
+     */
+    removeLocale() {
+        this._locale = undefined;
+    }
+    /**
+     * Sets the page data.
+     * @param page - The new value to set.
+     *
+     */
+    set page(page) {
+        this._validatePage(page);
+        this._page = page;
+    }
+    /**
+     * @returns The page data.
+     */
+    get page() {
+        return this._page;
+    }
+    /**
+     * Sets the page data to undefined
+     */
+    removePage() {
+        this._page = undefined;
+    }
+    /**
+     * Validate context locale object.
+     */
+    _validateContextLocale(locale) {
+        if (!locale)
+            return;
+        if (locale.country.length !== 2)
+            throw new Error(consts_1.ErrorMessages.IV_0010);
+        if (locale.language.length !== 2)
+            throw new Error(consts_1.ErrorMessages.IV_0011);
+    }
+    /**
+     * Sets the store data.
+     * @param store - The new value to set.
+     *
+     */
+    set store(store) {
+        this._store = store;
+    }
+    /**
+     * @returns The store data.
+     */
+    get store() {
+        return this._store;
+    }
+    /**
+     * Sets the store data to undefined
+     */
+    removeStore() {
+        this._store = undefined;
+    }
+    /**
+     * Sets the geo data.
+     * @param geo - The new value to set.
+     *
+     */
+    set geo(geo) {
+        if (geo.location)
+            this._validateLocation(geo.location);
+        this._geo = geo;
+    }
+    /**
+     * @returns The geo data.
+     */
+    get geo() {
+        return this._geo;
+    }
+    /**
+     * Sets the geo data to undefined
+     */
+    removeGeo() {
+        this._geo = undefined;
+    }
+    /**
+     * Validate location object.
+     */
+    _validateLocation(location) {
+        const result = (0, utils_1.isValidLocation)(location);
+        if (!result.latitude)
+            throw new Error(consts_1.ErrorMessages.IV_0012);
+        if (!result.longitude)
+            throw new Error(consts_1.ErrorMessages.IV_0013);
+    }
+    /**
+     * Sets the user data.
+     * @param user - The new value to set.
+     */
+    set user(user) {
+        this._validateUser(user);
+        this._user = user;
+    }
+    /**
+     * @returns The user data.
+     */
+    get user() {
+        return this._user;
+    }
+    /** Simply removes the user data from the context */
+    removeUser() {
+        this._user = undefined;
+    }
+    /**
+     * Validate user object, which is part of the context object.
+     * We need to ensure that the user object has `userId` or `uuid`, but not neither.
+     * @param user - The user object to validate.
+     */
+    _validateUser(user) {
+        if (typeof user !== 'undefined' && !user.userId && !user.uuid)
+            throw new Error(consts_1.ErrorMessages.MV_0013);
+    }
+    /**
+     * Sets the browser data
+     */
+    set browser(browser) {
+        this._browser = browser;
+    }
+    /**
+     * @returns The browser data.
+     */
+    get browser() {
+        return this._browser;
+    }
+    /**
+     * Sets the browser dta to undefined.
+     */
+    removeBrowser() {
+        this._browser = undefined;
+    }
+    /**
+     * Validate context object.
+     */
+    _validateContext(context) {
+        this._validateContextLocale(context.locale);
+        this._validateUser(context.user);
+        this._validatePage(context.page);
+        if (context.store && ((context.store.groupId && !context.store.id) || (!context.store.groupId && context.store.id)))
+            throw new Error(consts_1.ErrorMessages.MV_0009);
+        if (context.geo && context.geo.location)
+            this._validateLocation(context.geo.location);
+    }
+    /**
+     * Validate the `page` object which required a `uri` property.
+     * @param page - The page object to validate.
+     */
+    _validatePage(page) {
+        if (!page)
+            return;
+        if (!page.uri || typeof page.uri !== 'string' || !page.uri.trim())
+            throw new Error(consts_1.ErrorMessages.IV_0025);
+    }
+    /**
+     * Map context object to DTO.
+     * @returns The DTO representation of the filter.
+     */
+    toDTO() {
+        /* eslint-disable @typescript-eslint/naming-convention */
+        const dto = {
+            context: {
+                page: this._page
+            }
+        };
+        if (this._browser)
+            dto.context.browser = {
+                app_type: this._browser.appType,
+                device: this._browser.device,
+                user_agent: this._browser.userAgent
+            };
+        if (this._locale)
+            dto.context.locale = {
+                country: this._locale.country.toLowerCase(),
+                language: this._locale.language.toLowerCase()
+            };
+        if (this._store)
+            dto.context.store = {
+                group_id: this._store && this._store.groupId,
+                id: this._store && this._store.id
+            };
+        if (this._geo?.ip)
+            dto.context.geo = {
+                ip: this._geo.ip
+            };
+        if (this._user?.userId || this._user?.uuid)
+            dto.context.user = {
+                custom: this._user.custom,
+                groups: this._user.groups,
+                user_id: this._user.userId,
+                uuid: this._user.uuid
+            };
+        if (this._geo?.location)
+            dto.context.geo = {
+                ...dto.context.geo,
+                location: { lat: this._geo.location.latitude, lon: this._geo.location.longitude }
+            };
+        if (this._campaign)
+            dto.context.campaign = {
+                utm_campaign: this._campaign.campaign,
+                utm_content: this._campaign.content,
+                utm_medium: this._campaign.medium,
+                utm_source: this._campaign.source,
+                utm_term: this._campaign.term
+            };
+        return dto;
+    }
+}
+exports.Context = Context;

package/dist/cjs/src/lib/request-entities/context/interfaces.d.ts

@@ -0,0 +1,106 @@
+import type { ArrayOfAtLeastOne } from '../filters/interfaces';
+export interface BrowserData {
+    appType?: string;
+    device?: string;
+    userAgent: string;
+}
+export interface LocaleData {
+    country: string;
+    language: string;
+}
+export interface PageData {
+    uri: string;
+}
+export interface UserData {
+    custom?: {
+        [key: string]: unknown;
+    };
+    groups?: string[];
+    userId?: string;
+    uuid?: string;
+}
+export interface StoreData {
+    groupId: string;
+    id: string;
+}
+export interface IdsDTO {
+    [key: string]: ArrayOfAtLeastOne<string>;
+}
+export interface ContextData {
+    locale?: LocaleData;
+    page?: PageData;
+    user?: UserData;
+    store?: StoreData;
+    campaign?: CampaignData;
+    geo?: GeoData;
+    browser?: BrowserData;
+}
+export interface BrowserDTO {
+    app_type?: string;
+    device?: string;
+    user_agent: string;
+}
+export interface LocaleDTO {
+    country?: string;
+    language?: string;
+}
+export interface PageDTO {
+    custom?: {
+        [key: string]: unknown;
+    };
+    uri?: string;
+}
+export interface StoreDTO {
+    group_id?: string;
+    id?: string;
+}
+export interface UserDTO {
+    custom?: {
+        [key: string]: unknown;
+    };
+    groups?: string[];
+    user_id?: string;
+    uuid?: string;
+}
+export interface ContextDTO {
+    context: {
+        locale?: LocaleDTO;
+        page?: PageDTO;
+        store?: StoreDTO;
+        campaign?: CampaignDTO;
+        geo?: GeoDTO;
+        user?: UserDTO;
+        browser?: BrowserDTO;
+        ids?: IdsDTO;
+    };
+}
+export interface CampaignData {
+    source?: string;
+    medium?: string;
+    campaign?: string;
+    term?: string;
+    content?: string;
+}
+export interface CampaignDTO {
+    utm_source?: string;
+    utm_medium?: string;
+    utm_campaign?: string;
+    utm_term?: string;
+    utm_content?: string;
+}
+export interface LocationData {
+    latitude: number;
+    longitude: number;
+}
+interface GeoDTO {
+    ip?: string;
+    location?: {
+        lat: number;
+        lon: number;
+    };
+}
+export interface GeoData {
+    ip?: string;
+    location?: LocationData;
+}
+export {};

package/dist/cjs/src/lib/request-entities/context/interfaces.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/src/lib/request-entities/filters/base-filter.d.ts

@@ -0,0 +1,17 @@
+import type { Operators } from './interfaces';
+/**
+ * Creates BaseFilter object which ComparisonFilter inherits.
+ */
+export declare abstract class BaseFilter {
+    protected operator: Operators;
+    protected value: unknown;
+    /**
+     * @param operator - The operator to be applied on attribute.
+     * @param value - The value to check against of.
+     */
+    constructor(operator: Operators, value: unknown);
+    /**
+     * @returns The DTO representation of the filter.
+     */
+    abstract toDTO(): unknown;
+}

package/dist/cjs/src/lib/request-entities/filters/base-filter.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseFilter = void 0;
+/**
+ * Creates BaseFilter object which ComparisonFilter inherits.
+ */
+class BaseFilter {
+    /**
+     * @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;
+    }
+}
+exports.BaseFilter = BaseFilter;

package/dist/cjs/src/lib/request-entities/filters/comparison-filter.d.ts

@@ -0,0 +1,18 @@
+import { BaseFilter } from './base-filter';
+import type { ComparisonFilterDTO, ComparisonOperators } from './interfaces';
+/**
+ * Creates ComparisonFilter object which denotes the base of each filter.
+ */
+export declare class ComparisonFilter 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: ComparisonOperators, value: unknown);
+    /**
+     * @returns The DTO representation of the filter.
+     */
+    toDTO(): ComparisonFilterDTO;
+}

package/dist/cjs/src/lib/request-entities/filters/comparison-filter.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ComparisonFilter = void 0;
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+const base_filter_1 = require("./base-filter");
+/**
+ * Creates ComparisonFilter object which denotes the base of each filter.
+ */
+class ComparisonFilter extends base_filter_1.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,
+            value: this.value
+        };
+    }
+}
+exports.ComparisonFilter = ComparisonFilter;

package/dist/cjs/src/lib/request-entities/filters/facet/comparison-facet-filter.d.ts

@@ -0,0 +1,18 @@
+import type { ComparisonOperators } from '../interfaces';
+import type { ComparisonFacetFilterDTO, FacetFilterBase } from './interfaces';
+/**
+ * Creates ComparisonFacetFilter object.
+ */
+export declare class ComparisonFacetFilter 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: ComparisonOperators, value: string);
+    /**
+     * @returns The DTO representation of the filter.
+     */
+    toDTO(): ComparisonFacetFilterDTO;
+}

package/dist/cjs/src/lib/request-entities/filters/facet/comparison-facet-filter.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ComparisonFacetFilter = void 0;
+/**
+ * Creates ComparisonFacetFilter object.
+ */
+class ComparisonFacetFilter {
+    /**
+     * @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 {
+            type: this._operator,
+            value: this._value
+        };
+    }
+}
+exports.ComparisonFacetFilter = ComparisonFacetFilter;

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

@@ -0,0 +1,21 @@
+import type { FacetFilterDTO } from '../../widgets/interfaces';
+import type { ArrayOfAtLeastOne, ListOperators, LogicalOperators } from '../interfaces';
+export interface FacetFilterBase {
+    toDTO: () => unknown;
+}
+export interface ComparisonFacetFilterDTO {
+    type: string;
+    value: string;
+}
+export interface ListFacetFilterDTO {
+    type: ListOperators;
+    values: ArrayOfAtLeastOne<string>;
+}
+export interface NotFacetFilterDTO {
+    type: 'not';
+    filter: string | FacetFilterDTO;
+}
+export interface LogicalFacetFilterDTO {
+    type: Exclude<LogicalOperators, 'not'>;
+    filters: ArrayOfAtLeastOne<FacetFilterDTO>;
+}

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,18 @@
+import type { ArrayOfAtLeastOne, ListOperators } from '../interfaces';
+import type { FacetFilterBase, ListFacetFilterDTO } from './interfaces';
+/**
+ * Creates ListFacetFilter object.
+ */
+export declare class ListFacetFilter implements FacetFilterBase {
+    private _operator;
+    private _values;
+    /**
+     * @param operator - The operator to be applied on attribute.
+     * @param values - The values to check against of.
+     */
+    constructor(operator: ListOperators, values: ArrayOfAtLeastOne<string>);
+    /**
+     * @returns The DTO representation of the filter.
+     */
+    toDTO(): ListFacetFilterDTO;
+}