@sitecore-cloudsdk/utils 0.1.0-rc.0

package/README.md

@@ -0,0 +1,11 @@
+# utils
+
+This library was generated with [Nx](https://nx.dev).
+
+## Building
+
+Run `nx build utils` to build the library.
+
+## Running unit tests
+
+Run `nx test utils` to execute the unit tests via [Jest](https://jestjs.io).

package/dist/cjs/src/index.d.ts

@@ -0,0 +1,19 @@
+import { createCookieString } from './lib/cookies/create-cookie-string';
+import { ICookieProperties } from './lib/cookies/interfaces';
+import { fetchWithTimeout } from './lib/fetch-with-timeout';
+import { getCookieValueClientSide } from './lib/cookies/get-cookie-value-client-side';
+import { isNextJsMiddlewareRequest } from './lib/typeguards/is-next-js-middleware-request';
+import { isNextJsMiddlewareResponse } from './lib/typeguards/is-next-js-middleware-response';
+import { isHttpRequest } from './lib/typeguards/is-http-request';
+import { isHttpResponse } from './lib/typeguards/is-http-response';
+import { getCookie } from './lib/cookies/get-cookie';
+import { getCookieServerSide } from './lib/cookies/get-cookie-server-side';
+import { cookieExists } from './lib/cookies/cookie-exists';
+import { flattenObject, INestedObject, IFlattenedObject } from './lib/converters/flatten-object';
+import { isShortISODateString } from './lib/validators/is-short-iso-date-string';
+import { isValidEmail } from './lib/validators/is-valid-email';
+import type { TRequest, IMiddlewareNextResponse, IHttpResponse, IMiddlewareRequest, IHttpRequest, BasicTypes } from './lib/interfaces';
+import type { ICookie } from './lib/cookies/interfaces';
+export { createCookieString, fetchWithTimeout, getCookieValueClientSide, isNextJsMiddlewareRequest, isNextJsMiddlewareResponse, isHttpRequest, isHttpResponse, getCookie, getCookieServerSide, cookieExists, flattenObject, isShortISODateString, isValidEmail, };
+export type { INestedObject, TRequest, IMiddlewareNextResponse, BasicTypes, IHttpResponse, IHttpRequest, IMiddlewareRequest, IFlattenedObject, };
+export type { ICookie, ICookieProperties };

package/dist/cjs/src/index.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidEmail = exports.isShortISODateString = exports.flattenObject = exports.cookieExists = exports.getCookieServerSide = exports.getCookie = exports.isHttpResponse = exports.isHttpRequest = exports.isNextJsMiddlewareResponse = exports.isNextJsMiddlewareRequest = exports.getCookieValueClientSide = exports.fetchWithTimeout = exports.createCookieString = void 0;
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+const create_cookie_string_1 = require("./lib/cookies/create-cookie-string");
+Object.defineProperty(exports, "createCookieString", { enumerable: true, get: function () { return create_cookie_string_1.createCookieString; } });
+const fetch_with_timeout_1 = require("./lib/fetch-with-timeout");
+Object.defineProperty(exports, "fetchWithTimeout", { enumerable: true, get: function () { return fetch_with_timeout_1.fetchWithTimeout; } });
+const get_cookie_value_client_side_1 = require("./lib/cookies/get-cookie-value-client-side");
+Object.defineProperty(exports, "getCookieValueClientSide", { enumerable: true, get: function () { return get_cookie_value_client_side_1.getCookieValueClientSide; } });
+const is_next_js_middleware_request_1 = require("./lib/typeguards/is-next-js-middleware-request");
+Object.defineProperty(exports, "isNextJsMiddlewareRequest", { enumerable: true, get: function () { return is_next_js_middleware_request_1.isNextJsMiddlewareRequest; } });
+const is_next_js_middleware_response_1 = require("./lib/typeguards/is-next-js-middleware-response");
+Object.defineProperty(exports, "isNextJsMiddlewareResponse", { enumerable: true, get: function () { return is_next_js_middleware_response_1.isNextJsMiddlewareResponse; } });
+const is_http_request_1 = require("./lib/typeguards/is-http-request");
+Object.defineProperty(exports, "isHttpRequest", { enumerable: true, get: function () { return is_http_request_1.isHttpRequest; } });
+const is_http_response_1 = require("./lib/typeguards/is-http-response");
+Object.defineProperty(exports, "isHttpResponse", { enumerable: true, get: function () { return is_http_response_1.isHttpResponse; } });
+const get_cookie_1 = require("./lib/cookies/get-cookie");
+Object.defineProperty(exports, "getCookie", { enumerable: true, get: function () { return get_cookie_1.getCookie; } });
+const get_cookie_server_side_1 = require("./lib/cookies/get-cookie-server-side");
+Object.defineProperty(exports, "getCookieServerSide", { enumerable: true, get: function () { return get_cookie_server_side_1.getCookieServerSide; } });
+const cookie_exists_1 = require("./lib/cookies/cookie-exists");
+Object.defineProperty(exports, "cookieExists", { enumerable: true, get: function () { return cookie_exists_1.cookieExists; } });
+const flatten_object_1 = require("./lib/converters/flatten-object");
+Object.defineProperty(exports, "flattenObject", { enumerable: true, get: function () { return flatten_object_1.flattenObject; } });
+const is_short_iso_date_string_1 = require("./lib/validators/is-short-iso-date-string");
+Object.defineProperty(exports, "isShortISODateString", { enumerable: true, get: function () { return is_short_iso_date_string_1.isShortISODateString; } });
+const is_valid_email_1 = require("./lib/validators/is-valid-email");
+Object.defineProperty(exports, "isValidEmail", { enumerable: true, get: function () { return is_valid_email_1.isValidEmail; } });

package/dist/cjs/src/lib/converters/base-64-converter.d.ts

@@ -0,0 +1,3 @@
+export declare function convertToBase64(input: string | {
+    [key: string]: unknown;
+}): string;

package/dist/cjs/src/lib/converters/base-64-converter.js

@@ -0,0 +1,19 @@
+"use strict";
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertToBase64 = void 0;
+/*
+ * A function that converts a string or an object to a base64 string
+ * @param input - The string or object to be converted
+ * @returns A base64 string
+ */
+function convertToBase64(input) {
+    const data = typeof input === 'string' ? input : JSON.stringify(input);
+    const stringFormat = 'base64';
+    if (typeof Buffer === 'function')
+        return Buffer.from(data).toString(stringFormat);
+    if (typeof window?.btoa === 'function')
+        return window.btoa(data);
+    return data;
+}
+exports.convertToBase64 = convertToBase64;

package/dist/cjs/src/lib/converters/flatten-object.d.ts

@@ -0,0 +1,35 @@
+import { BasicTypes } from '../interfaces';
+/**
+ * A function that flattens an object, by combining the keys with an "_".
+ * @param data - An object that has the required data to perform the flattening
+ * @returns - A new flattened object
+ * @example
+ *
+ * ```ts
+ * const object = {order:{amount: 1, delivered: false}}
+ * const flattenedObject = flattenObject(object)
+ * // flattenedObject will be {order_amount: 1, order_delivered: false}
+ * ```
+ */
+export declare function flattenObject(data: IFlattenObjectDataParameters): IFlattenedObject;
+/**
+ * Interface for the data object parameter of the flattenObject function
+ */
+interface IFlattenObjectDataParameters {
+    object: INestedObject;
+    currentKey?: string;
+    newObject?: IFlattenedObject;
+}
+/**
+ * Interface for the return object of the flattenObject function
+ */
+export interface IFlattenedObject {
+    [key: string]: BasicTypes;
+}
+/**
+ * Interface of the object to flatten
+ */
+export interface INestedObject {
+    [key: string]: BasicTypes | INestedObject;
+}
+export {};

package/dist/cjs/src/lib/converters/flatten-object.js

@@ -0,0 +1,35 @@
+"use strict";
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.flattenObject = void 0;
+/**
+ * A function that flattens an object, by combining the keys with an "_".
+ * @param data - An object that has the required data to perform the flattening
+ * @returns - A new flattened object
+ * @example
+ *
+ * ```ts
+ * const object = {order:{amount: 1, delivered: false}}
+ * const flattenedObject = flattenObject(object)
+ * // flattenedObject will be {order_amount: 1, order_delivered: false}
+ * ```
+ */
+function flattenObject(data) {
+    const { currentKey, object } = data;
+    const newObject = data.newObject ?? {};
+    for (const key in object) {
+        const value = object[key];
+        if (value === undefined)
+            continue;
+        if (typeof value === 'object' && !Array.isArray(value))
+            flattenObject({
+                currentKey: `${currentKey ? `${currentKey}_${key}` : key}`,
+                newObject,
+                object: value,
+            });
+        else
+            newObject[currentKey ? `${currentKey}_${key}` : key] = value;
+    }
+    return newObject;
+}
+exports.flattenObject = flattenObject;

package/dist/cjs/src/lib/cookies/consts.d.ts

@@ -0,0 +1 @@
+export declare const DAILY_SECONDS = 86400;

package/dist/cjs/src/lib/cookies/consts.js

@@ -0,0 +1,6 @@
+"use strict";
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+/* eslint-disable @typescript-eslint/naming-convention */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DAILY_SECONDS = void 0;
+exports.DAILY_SECONDS = 86400;

package/dist/cjs/src/lib/cookies/cookie-exists-in-server-side.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Evaluates whether a specified cookie name exists in the request header
+ * @param cookiesHeader - The cookie string of the request header
+ * @param cookieName - The cookie name to be found
+ * @returns - A boolean value if cookie exists
+ */
+export declare function cookieExistsInServerSide(cookiesHeader: string, cookieName: string): boolean;

package/dist/cjs/src/lib/cookies/cookie-exists-in-server-side.js

@@ -0,0 +1,15 @@
+"use strict";
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cookieExistsInServerSide = void 0;
+const get_cookie_server_side_1 = require("./get-cookie-server-side");
+/**
+ * Evaluates whether a specified cookie name exists in the request header
+ * @param cookiesHeader - The cookie string of the request header
+ * @param cookieName - The cookie name to be found
+ * @returns - A boolean value if cookie exists
+ */
+function cookieExistsInServerSide(cookiesHeader, cookieName) {
+    return (0, get_cookie_server_side_1.getCookieServerSide)(cookiesHeader, cookieName) !== undefined;
+}
+exports.cookieExistsInServerSide = cookieExistsInServerSide;

package/dist/cjs/src/lib/cookies/cookie-exists.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Checks if the cookie exists in the cookie string
+ * @param cookieStr - The cookie string containing every cookie
+ * @param cookieName - The cookie name to be found
+ * @returns - boolean value, if the cookie is found in the cookie string
+ */
+export declare function cookieExists(cookieStr: string, cookieName: string): boolean;

package/dist/cjs/src/lib/cookies/cookie-exists.js

@@ -0,0 +1,14 @@
+"use strict";
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cookieExists = void 0;
+/**
+ * Checks if the cookie exists in the cookie string
+ * @param cookieStr - The cookie string containing every cookie
+ * @param cookieName - The cookie name to be found
+ * @returns - boolean value, if the cookie is found in the cookie string
+ */
+function cookieExists(cookieStr, cookieName) {
+    return cookieStr.split('; ').some((cookie) => cookie.split('=')[0] === cookieName);
+}
+exports.cookieExists = cookieExists;

package/dist/cjs/src/lib/cookies/create-cookie-string.d.ts

@@ -0,0 +1,9 @@
+import { ICookieProperties } from './interfaces';
+/**
+ * Creates the cookie string with the respectively cookie attributes
+ * @param name - name of the cookie
+ * @param value - value of the cookie
+ * @param attributes - an object of supported cookie attributes
+ * @returns - a string that will be passed to document.cookie
+ */
+export declare function createCookieString(name: string, value: string, attributes: ICookieProperties): string;

package/dist/cjs/src/lib/cookies/create-cookie-string.js

@@ -0,0 +1,21 @@
+"use strict";
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createCookieString = void 0;
+/**
+ * Creates the cookie string with the respectively cookie attributes
+ * @param name - name of the cookie
+ * @param value - value of the cookie
+ * @param attributes - an object of supported cookie attributes
+ * @returns - a string that will be passed to document.cookie
+ */
+function createCookieString(name, value, attributes) {
+    let cookieString = `${name}=${value};`;
+    cookieString += ` Max-Age=${attributes.maxAge}; SameSite=${attributes.sameSite};`;
+    cookieString += attributes.secure ? ' Secure;' : '';
+    cookieString += attributes.path ? ` Path=${attributes.path};` : '';
+    cookieString += attributes.domain ? ` Domain=${attributes.domain};` : '';
+    cookieString = cookieString.substring(0, cookieString.length - 1);
+    return cookieString;
+}
+exports.createCookieString = createCookieString;

package/dist/cjs/src/lib/cookies/delete-cookie.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Deletes a cookie from the document (client-side only)
+ * @param cookieName - The cookie to be deleted
+ */
+export declare function deleteCookie(cookieName: string): void;

package/dist/cjs/src/lib/cookies/delete-cookie.js

@@ -0,0 +1,12 @@
+"use strict";
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deleteCookie = void 0;
+/**
+ * Deletes a cookie from the document (client-side only)
+ * @param cookieName - The cookie to be deleted
+ */
+function deleteCookie(cookieName) {
+    document.cookie = cookieName + '=; Path=/; Expires=Thu, 01 Jan 1970 00:00:01 GMT;';
+}
+exports.deleteCookie = deleteCookie;

package/dist/cjs/src/lib/cookies/get-cookie-server-side.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Retrieves the cookie name and value from the request header
+ * @param cookiesHeader - The cookie string of the request header
+ * @param cookieName - The cookie name to be found
+ * @returns - The name and value of the cookie, or undefined
+ */
+export declare function getCookieServerSide(cookiesHeader: string | undefined, cookieName: string): {
+    name: string;
+    value: string;
+} | undefined;

package/dist/cjs/src/lib/cookies/get-cookie-server-side.js

@@ -0,0 +1,15 @@
+"use strict";
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCookieServerSide = void 0;
+const get_cookie_1 = require("./get-cookie");
+/**
+ * Retrieves the cookie name and value from the request header
+ * @param cookiesHeader - The cookie string of the request header
+ * @param cookieName - The cookie name to be found
+ * @returns - The name and value of the cookie, or undefined
+ */
+function getCookieServerSide(cookiesHeader, cookieName) {
+    return (0, get_cookie_1.getCookie)(cookiesHeader, cookieName);
+}
+exports.getCookieServerSide = getCookieServerSide;

package/dist/cjs/src/lib/cookies/get-cookie-value-client-side.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Gets the value for a given cookie name
+ * @param cookieName - The cookie name to be found
+ * @returns - The value of the cookie if it exists or empty string
+ */
+export declare function getCookieValueClientSide(cookieName: string): string;

package/dist/cjs/src/lib/cookies/get-cookie-value-client-side.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCookieValueClientSide = void 0;
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+const get_cookie_1 = require("./get-cookie");
+/**
+ * Gets the value for a given cookie name
+ * @param cookieName - The cookie name to be found
+ * @returns - The value of the cookie if it exists or empty string
+ */
+function getCookieValueClientSide(cookieName) {
+    const cookie = (0, get_cookie_1.getCookie)(document.cookie, cookieName);
+    return cookie?.value ?? '';
+}
+exports.getCookieValueClientSide = getCookieValueClientSide;

package/dist/cjs/src/lib/cookies/get-cookie.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Retrieves the cookie, if it exists in the cookie string
+ * @param cookieStr - The cookie string containing every cookie
+ * @param cookieName - The cookie name to be found
+ * @returns - an object that contains the cookie name and value or undefined, if not found
+ */
+export declare function getCookie(cookieStr: string | undefined, cookieName: string): {
+    name: string;
+    value: string;
+} | undefined;

package/dist/cjs/src/lib/cookies/get-cookie.js

@@ -0,0 +1,19 @@
+"use strict";
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCookie = void 0;
+/**
+ * Retrieves the cookie, if it exists in the cookie string
+ * @param cookieStr - The cookie string containing every cookie
+ * @param cookieName - The cookie name to be found
+ * @returns - an object that contains the cookie name and value or undefined, if not found
+ */
+function getCookie(cookieStr, cookieName) {
+    if (!cookieStr)
+        return undefined;
+    const found = cookieStr.split('; ').find((cookie) => {
+        return cookie.indexOf('=') > 0 && cookie.split('=')[0] === cookieName;
+    });
+    return found !== undefined ? { name: found.split('=')[0], value: found.split('=')[1] } : undefined;
+}
+exports.getCookie = getCookie;

package/dist/cjs/src/lib/cookies/interfaces.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Cookie properties
+ */
+export interface ICookieProperties {
+    maxAge: number;
+    sameSite: string;
+    secure: boolean;
+    path?: string;
+    httpOnly?: boolean;
+    expires?: Date;
+    domain?: string;
+}
+/**
+ * Interface that represents a cookie (name, value)
+ */
+export interface ICookie {
+    name: string;
+    value: string;
+}

package/dist/cjs/src/lib/cookies/interfaces.js

@@ -0,0 +1,3 @@
+"use strict";
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/src/lib/fetch-with-timeout.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Fetches data from the specified URL within the given timeout period.
+ *
+ * @param url - The URL to fetch data from.
+ * @param timeout - The time in milliseconds to wait before timing out the request.
+ * @param fetchOptions - The options to pass to the fetch API.
+ * @returns - A Promise that resolves to the fetched data, or null if the request was aborted or timed out.
+ * @throws  - If the timeout value is invalid.
+ */
+export declare function fetchWithTimeout(url: string, timeout: number, fetchOptions: {
+    [key: string]: unknown;
+}): Promise<null | unknown>;

package/dist/cjs/src/lib/fetch-with-timeout.js

@@ -0,0 +1,34 @@
+"use strict";
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchWithTimeout = void 0;
+/**
+ * Fetches data from the specified URL within the given timeout period.
+ *
+ * @param url - The URL to fetch data from.
+ * @param timeout - The time in milliseconds to wait before timing out the request.
+ * @param fetchOptions - The options to pass to the fetch API.
+ * @returns - A Promise that resolves to the fetched data, or null if the request was aborted or timed out.
+ * @throws  - If the timeout value is invalid.
+ */
+async function fetchWithTimeout(url, timeout, fetchOptions) {
+    if (!Number.isInteger(timeout) || timeout < 0)
+        throw new Error('[IV-0006] Incorrect value for the timeout parameter. Set the value to an integer greater than or equal to 0.');
+    const abortController = new AbortController();
+    const signal = abortController.signal;
+    const timeoutHandler = setTimeout(() => {
+        abortController.abort();
+    }, timeout);
+    return fetch(url, { ...fetchOptions, signal })
+        .then((response) => {
+        clearTimeout(timeoutHandler);
+        return response.json();
+    })
+        .then((data) => data)
+        .catch((error) => {
+        if (error.name === 'AbortError')
+            throw new Error('[IE-0002] Timeout exceeded. The server did not respond within the allotted time.');
+        return null;
+    });
+}
+exports.fetchWithTimeout = fetchWithTimeout;

package/dist/cjs/src/lib/interfaces.d.ts

@@ -0,0 +1,48 @@
+import { ICookie } from './cookies/interfaces';
+/**
+ * A reusable type that accepts only basic types and arrays of those
+ */
+export type BasicTypes = string | boolean | number | undefined | Array<string | boolean | number | {
+    [key: string]: BasicTypes;
+} | Array<BasicTypes>>;
+/**
+ * Interface for supporting request IncomingMessage http node type
+ */
+export interface IHttpRequest {
+    headers: {
+        'cookie'?: string;
+        'content-language'?: string;
+        'referer'?: string;
+    };
+    url?: string;
+}
+/**
+ * Interface for supporting response OutgoingMessage http node type
+ */
+export interface IHttpResponse {
+    setHeader(name: string, value: number | string | ReadonlyArray<string>): void;
+}
+export type TRequest = IHttpRequest | IMiddlewareRequest;
+/**
+ * Interface for supporting request from Edge Next.js
+ * includes types compatible with both NextJS versions 12 & 13
+ */
+export interface IMiddlewareRequest {
+    cookies: {
+        set: ((key: string, value: string, options: any) => any) | ((...args: [key: string, value: string] | [options: ICookie]) => any);
+        get: (key: string) => ICookie | string | undefined;
+    };
+    headers: {
+        get: (name: string) => string | null;
+    };
+    url?: string;
+}
+/**
+ * Interface for Edge Next.js Response
+ * includes types compatible with both NextJS versions 12 & 13
+ */
+export interface IMiddlewareNextResponse {
+    cookies: {
+        set: ((key: string, value: unknown, options?: any) => any) | ((...args: [key: string, value: string] | [options: ICookie]) => any);
+    };
+}

package/dist/cjs/src/lib/interfaces.js

@@ -0,0 +1,3 @@
+"use strict";
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/src/lib/typeguards/is-http-request.d.ts

@@ -0,0 +1,9 @@
+import { IHttpRequest, TRequest } from '../interfaces';
+/**
+ * Checks if the given 'request' object is a valid HTTP Request
+ * by verifying the presence of necessary properties.
+ *
+ * @param request - The request object to be validated.
+ * @returns Returns true if 'request' is a valid HTTP Request, otherwise false.
+ */
+export declare function isHttpRequest(request: TRequest): request is IHttpRequest;

package/dist/cjs/src/lib/typeguards/is-http-request.js

@@ -0,0 +1,15 @@
+"use strict";
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isHttpRequest = void 0;
+/**
+ * Checks if the given 'request' object is a valid HTTP Request
+ * by verifying the presence of necessary properties.
+ *
+ * @param request - The request object to be validated.
+ * @returns Returns true if 'request' is a valid HTTP Request, otherwise false.
+ */
+function isHttpRequest(request) {
+    return 'headers' in request;
+}
+exports.isHttpRequest = isHttpRequest;

package/dist/cjs/src/lib/typeguards/is-http-response.d.ts

@@ -0,0 +1,9 @@
+import { IHttpResponse, IMiddlewareNextResponse } from '../interfaces';
+/**
+ * Checks if the given 'response' object is a valid HTTP Response
+ * by verifying the presence of necessary properties.
+ *
+ * @param response - IMiddlewareNextResponse | IHttpResponse - The response object to be validated.
+ * @returns Returns true if 'response' is a valid HTTP Response, otherwise false.
+ */
+export declare function isHttpResponse(response: IMiddlewareNextResponse | IHttpResponse): response is IHttpResponse;

package/dist/cjs/src/lib/typeguards/is-http-response.js

@@ -0,0 +1,15 @@
+"use strict";
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isHttpResponse = void 0;
+/**
+ * Checks if the given 'response' object is a valid HTTP Response
+ * by verifying the presence of necessary properties.
+ *
+ * @param response - IMiddlewareNextResponse | IHttpResponse - The response object to be validated.
+ * @returns Returns true if 'response' is a valid HTTP Response, otherwise false.
+ */
+function isHttpResponse(response) {
+    return 'setHeader' in response;
+}
+exports.isHttpResponse = isHttpResponse;

package/dist/cjs/src/lib/typeguards/is-next-js-middleware-request.d.ts

@@ -0,0 +1,9 @@
+import { IMiddlewareRequest, TRequest } from '../interfaces';
+/**
+ * Checks if the given 'request' object is a valid Middleware Request
+ * by verifying the presence of necessary properties.
+ *
+ * @param request - The request object to be validated.
+ * @returns Returns true if 'request' is a valid Middleware Request, otherwise false.
+ */
+export declare function isNextJsMiddlewareRequest(request: TRequest): request is IMiddlewareRequest;

package/dist/cjs/src/lib/typeguards/is-next-js-middleware-request.js

@@ -0,0 +1,15 @@
+"use strict";
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isNextJsMiddlewareRequest = void 0;
+/**
+ * Checks if the given 'request' object is a valid Middleware Request
+ * by verifying the presence of necessary properties.
+ *
+ * @param request - The request object to be validated.
+ * @returns Returns true if 'request' is a valid Middleware Request, otherwise false.
+ */
+function isNextJsMiddlewareRequest(request) {
+    return 'cookies' in request && 'get' in request.cookies && 'set' in request.cookies;
+}
+exports.isNextJsMiddlewareRequest = isNextJsMiddlewareRequest;

package/dist/cjs/src/lib/typeguards/is-next-js-middleware-response.d.ts

@@ -0,0 +1,9 @@
+import { IHttpResponse, IMiddlewareNextResponse } from '../interfaces';
+/**
+ * Checks if the given 'response' object is a valid IMiddlewareNextResponse Response
+ * by verifying the presence of necessary properties.
+ *
+ * @param response - IMiddlewareNextResponse | IHttpResponse - The response object to be validated.
+ * @returns Returns true if 'response' is a valid IMiddlewareNextResponse Response, otherwise false.
+ */
+export declare function isNextJsMiddlewareResponse(response: IMiddlewareNextResponse | IHttpResponse): response is IMiddlewareNextResponse;

package/dist/cjs/src/lib/typeguards/is-next-js-middleware-response.js

@@ -0,0 +1,15 @@
+"use strict";
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isNextJsMiddlewareResponse = void 0;
+/**
+ * Checks if the given 'response' object is a valid IMiddlewareNextResponse Response
+ * by verifying the presence of necessary properties.
+ *
+ * @param response - IMiddlewareNextResponse | IHttpResponse - The response object to be validated.
+ * @returns Returns true if 'response' is a valid IMiddlewareNextResponse Response, otherwise false.
+ */
+function isNextJsMiddlewareResponse(response) {
+    return 'cookies' in response && 'set' in response.cookies;
+}
+exports.isNextJsMiddlewareResponse = isNextJsMiddlewareResponse;

package/dist/cjs/src/lib/validators/is-iso-date-string.d.ts

@@ -0,0 +1 @@
+export declare function isISODateString(date: string): boolean;

package/dist/cjs/src/lib/validators/is-iso-date-string.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isISODateString = void 0;
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+function isISODateString(date) {
+    try {
+        const convertedDate = new Date(date).toISOString();
+        return convertedDate === date;
+    }
+    catch (_) {
+        return false;
+    }
+}
+exports.isISODateString = isISODateString;

package/dist/cjs/src/lib/validators/is-short-iso-date-string.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Checks if the provided string is a shortened version of ISO 8601 date format ‘YYYY-MM-DD’T’hh:mm’
+ * @param date - The date string provided by the developer
+ * @returns - A boolean if the string is valid otherwise false
+ */
+export declare function isShortISODateString(date: string): boolean;