@websolutespa/bom-core 1.7.10 → 1.7.12

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @websolutespa/bom-core
 
+## 1.7.12
+
+### Patch Changes
+
+- Modified: RouteService, MenuService to handle isHidden Category segments
+
+## 1.7.11
+
+### Patch Changes
+
+- Modified: JsonService where clauses, limit, sort
+- Added: JsonService tests
+
 ## 1.7.10
 
 ### Patch Changes

package/dist/index.d.ts

@@ -64,7 +64,7 @@ type IOverride<T, FromType, ToType> = {
  */
 type ILetter = 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | 'h' | 'i' | 'j' | 'k' | 'l' | 'm' | 'n' | 'o' | 'p' | 'q' | 'r' | 's' | 't' | 'u' | 'v' | 'w' | 'x' | 'y' | 'z';
 type ILocaleId = `${ILetter}${ILetter}`;
-type ILocalizedString = Record<ILocaleId, string>;
+type ILocalizedString = Partial<Record<ILocaleId, string>>;
 type ILocalizable = string | ILocalizedString;
 type ILocalized<T> = IOverride<T, ILocalizable, string>;
 
@@ -226,6 +226,7 @@ type ICategory = IEntity & {
     order?: number;
     slug: ILocalizable;
     title: ILocalizable;
+    isHidden?: boolean;
 };
 type ICategoryItem = ICategory & {
     items: ICategory[];
@@ -311,7 +312,8 @@ type IMarket = IEntity & {
 };
 
 type IRoute = {
-    category: IEquatable | ICategory;
+    category: IEquatable;
+    resolvedCategory: IEquatable;
     id: string;
     isDefault?: boolean;
     locale: string;
@@ -497,7 +499,22 @@ type IPaginationResult<T> = {
     docs: T[];
 } & Pagination;
 
-type Operator = 'equals' | 'contains' | 'not_equals' | 'in' | 'not_in' | 'exists' | 'greater_than' | 'greater_than_equal' | 'less_than' | 'less_than_equal' | 'like' | 'near';
+/**
+  equals	The value must be exactly equal.
+  not_equals	The query will return all documents where the value is not equal.
+  exists	Only return documents where the value either exists (true) or does not exist (false).
+  greater_than	For numeric or date-based fields.
+  greater_than_equal	For numeric or date-based fields.
+  less_than	For numeric or date-based fields.
+  less_than_equal	For numeric or date-based fields.
+  like	Case-insensitive string must be present. If string of words, all words must be present, in any order.
+  contains	Must contain the value entered, case-insensitive.
+  in	The value must be found within the provided comma-delimited list of values.
+  not_in	The value must NOT be within the provided comma-delimited list of values.
+  all	The value must contain all values provided in the comma-delimited list.
+  near	For distance related to a point field comma separated as <longitude>, <latitude>, <maxDistance in meters (nullable)>, <minDistance in meters (nullable)>.
+  */
+type Operator = 'equals' | 'not_equals' | 'exists' | 'greater_than' | 'greater_than_equal' | 'less_than' | 'less_than_equal' | 'like' | 'contains' | 'in' | 'not_in' | 'all' | 'near';
 type WhereField = {
     [key in Operator]?: unknown;
 };
@@ -596,31 +613,167 @@ type ITemplate = {
     collections: string[];
 };
 
-declare function isCategory(value?: ICategory | IEquatable): value is ICategory;
-declare function asCategoryId(value: ICategory | IEquatable): string;
+/**
+ * Retrieves the root category from the given list of categories.
+ * @param categories - The list of categories.
+ * @returns The root category, if found; otherwise undefined.
+ */
 declare function getRootCategory(categories: ICategory[]): ICategory | undefined;
-declare function getParentCategoriesById(id: string, categories: ICategory[]): ICategory[];
-declare function getCategorySegments(item: ICategorized, categories: ICategory[]): ICategory[];
-declare function getCategorySegmentsByCategory(item: ICategory, categories: ICategory[]): ICategory[];
+/**
+ * Retrieves the parent category of an item.
+ * @param categories - The array of categories.
+ * @param item - The item to find the parent category for.
+ * @returns The parent category of the item, or undefined if not found.
+ */
+declare function getParentCategory(categories: ICategory[], item: ICategorized): ICategory | undefined;
+/**
+ * Retrieves the parent categories of a category with the given ID.
+ * @param categories - The list of categories.
+ * @param id - The ID of the category.
+ * @returns An array of parent categories.
+ */
+declare function getParentCategoriesById(categories: ICategory[], id?: string): ICategory[];
+/**
+ * Retrieves the category segments for an ICategorized item.
+ * @param item - The item to retrieve the category segments for.
+ * @param categories - The list of categories.
+ * @returns An array of category segments.
+ */
+declare function getCategorySegments(categories: ICategory[], item: ICategorized): ICategory[];
+/**
+ * Retrieves the category segments for a category.
+ * @param item - The category to retrieve the category segments for.
+ * @param categories - The list of categories.
+ * @returns An array of category segments.
+ */
+declare function getCategorySegmentsByCategory(categories: ICategory[], item: ICategory): ICategory[];
+/**
+ * Retrieves the ID of a category or an object that implements IEquatable.
+ * @param value - The category or object to retrieve the ID from.
+ * @returns The ID of the category or object as a string.
+ */
+declare function asCategoryId(value: undefined): undefined;
+declare function asCategoryId(value: string): string;
+declare function asCategoryId(value: IEntity | IEquatable): string;
+declare function asCategoryId(value: IEntity | IEquatable | undefined): string | undefined;
+/**
+ * Finds a category in the given array of categories based on the provided item.
+ * @param categories - The array of categories to search in.
+ * @param item - The item to find in the categories array.
+ * @returns The found category, if any, or undefined.
+ */
+declare function findCategoryInCategories(categories: ICategory[], item: ICategory | IEquatable | undefined): ICategory | undefined;
+/**
+ * Finds child categories based on the given item.
+ * @param categories - The array of categories to search in.
+ * @param item - The item to find child categories for.
+ * @returns An array of child categories.
+ */
+declare function findChildCategories(categories: ICategory[], item: ICategory | IEquatable | undefined): ICategory[];
 
+/**
+ * Combines multiple IClassName objects into a single string of class names.
+ * @param props - The IClassName objects to combine.
+ * @returns A string of class names.
+ */
 declare function getClassNames(...props: Array<IClassName>): string;
 
+/**
+ * Retrieves the collection description based on the given text.
+ * @param text - The input text.
+ * @returns The collection description object.
+ */
 declare function getCollectionDescription(text: string): ICollectionDescription;
+/**
+ * Converts a camel case string to snake case.
+ * @param text - The input text.
+ * @returns The converted snake case string.
+ */
 declare function camelToSnakeCase(text: string): string;
+/**
+ * Checks if the given collection description is valid.
+ * @param description - The collection description object.
+ * @returns True if the collection description is valid, false otherwise.
+ */
 declare function isValidCollectionDescription(description: ICollectionDescription): boolean;
+/**
+ * Checks if the given collection description is reserved.
+ * @param description - The collection description object.
+ * @returns True if the collection description is reserved, false otherwise.
+ */
 declare function isReservedCollectionDescription(description: ICollectionDescription): boolean;
+/**
+ * Converts a string to a display name by removing spaces.
+ * @param text - The input text.
+ * @returns The converted display name.
+ */
 declare function toDisplayName(text: string): string;
+/**
+ * Converts a string to its plural form.
+ * @param text - The input text.
+ * @returns The plural form of the input text.
+ */
 declare function toPluralName(text: string): string;
+/**
+ * Converts a string to title case.
+ * @param text - The input text.
+ * @returns The converted title case string.
+ */
 declare function toTitleCase(text: string): string;
+/**
+ * Converts a string to a valid collection name by removing special characters and converting to snake case.
+ * @param text - The input text.
+ * @returns The converted valid collection name.
+ */
 declare function toValidCollectionName(text: string): string;
 
 declare function consoleWarn(message: string, component?: string): void;
 
+/**
+ * Performs an HTTP fetch request.
+ * @param url - The URL to fetch.
+ * @param options - The fetch request options.
+ * @param serviceOptions - Additional service options.
+ * @returns A promise that resolves to the response data.
+ */
 declare function httpFetch(url: string, options?: FetchRequestOptions, serviceOptions?: any): Promise<any>;
+/**
+ * Performs an HTTP GET request.
+ * @param url - The URL to fetch.
+ * @param options - The fetch request options.
+ * @returns A promise that resolves to the response data.
+ */
 declare function httpGet(url: string, options?: FetchRequestOptions): Promise<any>;
+/**
+ * Performs an HTTP POST request.
+ * @param url - The URL to fetch.
+ * @param payload - The payload to send in the request body.
+ * @param options - The fetch request options.
+ * @returns A promise that resolves to the response data.
+ */
 declare function httpPost(url: string, payload: any, options?: FetchRequestOptions): Promise<any>;
+/**
+ * Performs an HTTP PUT request.
+ * @param url - The URL to fetch.
+ * @param payload - The payload to send in the request body.
+ * @param options - The fetch request options.
+ * @returns A promise that resolves to the response data.
+ */
 declare function httpPut(url: string, payload: any, options?: FetchRequestOptions): Promise<any>;
+/**
+ * Performs an HTTP PATCH request.
+ * @param url - The URL to fetch.
+ * @param payload - The payload to send in the request body.
+ * @param options - The fetch request options.
+ * @returns A promise that resolves to the response data.
+ */
 declare function httpPatch(url: string, payload: any, options?: FetchRequestOptions): Promise<any>;
+/**
+ * Performs an HTTP DELETE request.
+ * @param url - The URL to fetch.
+ * @param options - The fetch request options.
+ * @returns A promise that resolves to the response data.
+ */
 declare function httpDelete(url: string, options?: FetchRequestOptions): Promise<any>;
 
 declare class JsonService<T extends IEntity = IEntity> implements IQuerable<T> {
@@ -636,31 +789,38 @@ declare class JsonService<T extends IEntity = IEntity> implements IQuerable<T> {
     protected decorateOne_<B extends T = T>(item: B, params?: QueryParams): Promise<B>;
     protected decorateMany_<B extends T = T>(items: B[], params?: QueryParams): Promise<B[]>;
     protected newUUID_(): number;
-    protected evaluateValue_(value: unknown): unknown;
-    /**
-    equals	            The value must be exactly equal.
-    not_equals	        The query will return all documents where the value is not equal.
-    greater_than	      For numeric or date-based fields.
-    greater_than_equal	For numeric or date-based fields.
-    less_than	          For numeric or date-based fields.
-    less_than_equal	    For numeric or date-based fields.
-    like	              Case-insensitive string must be present. If string of words, all words must be present, in any order.
-    contains	          Must contain the value entered, case-insensitive.
-    in	                The value must be found within the provided comma-delimited list of values.
-    not_in	            The value must NOT be within the provided comma-delimited list of values.
-    all	                The value must contain all values provided in the comma-delimited list.
-    exists	            Only return documents where the value either exists (true) or does not exist (false).
-    near	              For distance related to a point field comma separated as <longitude>, <latitude>, <maxDistance in meters (nullable)>, <minDistance in meters (nullable)>.
-    */
-    protected existsClause_(value: unknown, exists?: boolean): boolean;
     protected equalsClause_(value: unknown, equals?: unknown): boolean;
-    protected inClause_(value: unknown, values?: unknown[]): boolean;
-    protected notInClause_(value: unknown, values?: unknown[]): boolean;
+    protected notEqualsClause_(value: unknown, not_equals?: unknown): boolean;
+    protected existsClause_(value: unknown, exists?: boolean): boolean;
+    protected greaterThanClause_(value: unknown, greater_than?: unknown): boolean;
+    protected greaterThanEqualClause_(value: unknown, greater_than_equal?: unknown): boolean;
+    protected lessThanClause_(value: unknown, less_than?: unknown): boolean;
+    protected lessThanEqualClause_(value: unknown, less_than_equal?: unknown): boolean;
     protected likeClause_(value: unknown, query?: string): boolean;
     protected containsClause_(value: unknown, contains?: IEquatable): boolean;
+    protected inClause_(value: unknown, values?: unknown[]): boolean;
+    protected notInClause_(value: unknown, values?: unknown[]): boolean;
+    protected allClause_(value: unknown, values?: unknown[]): boolean;
+    protected nearClause_(value: unknown, near?: unknown[]): boolean;
     protected whereItem_<B extends T = T>(item: B, where?: Where): boolean;
-    protected whereItems_<B extends T = T>(items: B[], where?: Where): B[];
+    /**
+    equals	The value must be exactly equal.
+    not_equals	The query will return all documents where the value is not equal.
+    exists	Only return documents where the value either exists (true) or does not exist (false).
+    greater_than	For numeric or date-based fields.
+    greater_than_equal	For numeric or date-based fields.
+    less_than	For numeric or date-based fields.
+    less_than_equal	For numeric or date-based fields.
+    like	Case-insensitive string must be present. If string of words, all words must be present, in any order.
+    contains	Must contain the value entered, case-insensitive.
+    in	The value must be found within the provided comma-delimited list of values.
+    not_in	The value must NOT be within the provided comma-delimited list of values.
+    all	The value must contain all values provided in the comma-delimited list.
+    near	For distance related to a point field comma separated as <longitude>, <latitude>, <maxDistance in meters (nullable)>, <minDistance in meters (nullable)>.
+    */
+    protected whereItems_<B extends T = T>(items: B[], where?: Where, limit?: number): B[];
     protected sortCollection_<B extends T = T>(items: B[], sort?: string): B[];
+    protected limitCollection_<B extends T = T>(items: B[], limit?: number): B[];
     protected paginatedItems_<B extends T = T>(items: B[], page?: number, limit?: number): ({
         docs: B[];
     } & Pagination);
@@ -668,10 +828,43 @@ declare class JsonService<T extends IEntity = IEntity> implements IQuerable<T> {
 
 declare const defaultLocale: string;
 
+/**
+ * Checks if a value is a localized string.
+ * @param value - The value to check.
+ * @returns A boolean indicating whether the value is a localized string.
+ */
 declare function isLocalizedString(value: any): value is ILocalizedString;
+/**
+ * Converts a localized string object to a string based on the specified locale.
+ * @param json - The localized string object.
+ * @param locale - The locale to use.
+ * @param defaultLocale - The default locale to use if the specified locale is not found.
+ * @returns The localized string.
+ */
 declare function localizedToString(json: ILocalizedString, locale: string, defaultLocale?: string): string;
+/**
+ * Localizes a value based on the specified locale.
+ * @param value - The value to localize.
+ * @param locale - The locale to use.
+ * @param defaultLocale - The default locale to use if the specified locale is not found.
+ * @returns The localized value as a string.
+ */
 declare function localize(value: ILocalizable, locale: string, defaultLocale?: string): string;
+/**
+ * Localizes a value or an array/object of values based on the specified locale.
+ * @param value - The value or array/object of values to localize.
+ * @param locale - The locale to use.
+ * @param defaultLocale - The default locale to use if the specified locale is not found.
+ * @returns The localized value or array/object of localized values.
+ */
 declare function localizeValue(value: any, locale: string, defaultLocale?: string): any;
+/**
+ * Localizes an array/object of values based on the specified locale.
+ * @param item - The array/object of values to localize.
+ * @param locale - The locale to use.
+ * @param defaultLocale - The default locale to use if the specified locale is not found.
+ * @returns The localized array/object of values.
+ */
 declare function localizeItem<T = any>(item: T, locale: string, defaultLocale?: string): T;
 
 declare enum LoggerLevel {
@@ -694,33 +887,166 @@ declare class Logger {
 
 declare const defaultMarket: string;
 
+/**
+ * Serializes query parameters into a query string.
+ * @param queryParams - The query parameters to serialize.
+ * @returns The serialized query string.
+ */
 declare function qsSerialize(queryParams?: QueryParams): string;
+/**
+ * Serializes query parameters into a raw query string.
+ * @param queryParams - The query parameters to serialize.
+ * @returns The serialized raw query string.
+ */
 declare function qsSerializeRaw(queryParams?: {}): string;
+/**
+ * Deserializes a query string into query parameters.
+ * @param query - The query string to deserialize.
+ * @param deserializedParams - The deserialized query parameters.
+ * @returns The deserialized query parameters.
+ */
 declare function qsDeserialize(query?: string, deserializedParams?: {}): QueryParams;
+/**
+ * Deserializes a raw query string into parameters.
+ * @param query - The raw query string to deserialize.
+ * @param deserializedParams - The deserialized parameters.
+ * @returns The deserialized parameters.
+ */
 declare function qsDeserializeRaw(query?: string, deserializedParams?: {}): {};
 
+/**
+ * Checks if the given headers object is an instance of the Headers class.
+ * @param headers - The headers object to check.
+ * @returns True if the headers object is an instance of Headers, false otherwise.
+ */
 declare function isHeaders(headers?: IncomingHttpHeaders | Headers): headers is Headers;
+/**
+ * Checks if the given headers object is an instance of IncomingHttpHeaders.
+ * @param headers - The headers object to check.
+ * @returns True if the headers object is an instance of IncomingHttpHeaders, false otherwise.
+ */
 declare function isIncomingHttpHeaders(headers?: IncomingHttpHeaders | Headers): headers is IncomingHttpHeaders;
+/**
+ * Retrieves the host from the headers object.
+ * @param headers - The headers object.
+ * @returns The host value from the headers object, or null if not found.
+ */
 declare function getHost(headers?: IncomingHttpHeaders | Headers): string | null;
+/**
+ * Retrieves the protocol from the headers object.
+ * @param headers - The headers object.
+ * @returns The protocol value from the headers object, or 'https' if not found.
+ */
 declare function getProto(headers?: IncomingHttpHeaders | Headers): string;
+/**
+ * Retrieves the origin from the headers object.
+ * @param headers - The headers object.
+ * @returns The origin value based on the host and protocol from the headers object, or an empty string if not found.
+ */
 declare function getOrigin(headers?: IncomingHttpHeaders | Headers): string;
 
-declare function collectRoutes(store: IMemoryStore<ICategorized>, categories: ICategory[], markets: IMarket[], locales: ILocale[]): IRoute[];
-declare function eachMarketLocale(markets: IMarket[], locales: ILocale[], callback: (market: IMarket, locale: ILocale, markets: IMarket[], locales: ILocale[]) => void): void;
-declare function eachCategorized(store: IMemoryStore<ICategorized>, callback: (item: ICategorized, key: string) => void): void;
+/**
+ * Represents the route strategy options.
+ */
 declare enum RouteStrategy {
     Auto = "auto",
     Default = "default",
     Manual = "manual"
 }
+/**
+ * Collects routes based on the provided data.
+ *
+ * @param store - The memory store containing categorized items.
+ * @param categories - The list of categories.
+ * @param markets - The list of markets.
+ * @param locales - The list of locales.
+ * @returns An array of collected routes.
+ */
+declare function collectRoutes(store: IMemoryStore<ICategorized>, categories: ICategory[], markets: IMarket[], locales: ILocale[]): IRoute[];
+/**
+ * Iterates over each market and locale combination and invokes the callback function.
+ *
+ * @param markets - The list of markets.
+ * @param locales - The list of locales.
+ * @param callback - The callback function to be invoked for each market and locale combination.
+ */
+declare function eachMarketLocale(markets: IMarket[], locales: ILocale[], callback: (market: IMarket, locale: ILocale, markets: IMarket[], locales: ILocale[]) => void): void;
+/**
+ * Iterates over each categorized item in the store and invokes the callback function.
+ *
+ * @param store - The memory store containing categorized items.
+ * @param callback - The callback function to be invoked for each categorized item.
+ */
+declare function eachCategorized(store: IMemoryStore<ICategorized>, callback: (item: ICategorized, key: string) => void): void;
+/**
+ * Finds the default route of a category by categoryId, market, and locale.
+ * @param routes - The array of routes to search.
+ * @param categoryId - The category ID to match.
+ * @param market - The market to match (optional).
+ * @param locale - The locale to match (optional).
+ * @returns The matching route, if found. Otherwise, undefined.
+ */
+declare function findRouteOfCategory(routes: IRoute[], categoryId: IEquatable, market?: string, locale?: string): IRoute | undefined;
+/**
+ * Finds the routes of a category by categoryId.
+ * @param routes - The array of routes to search.
+ * @param categoryId - The category ID to filter routes by.
+ * @param isDefault - Optional. Specifies whether to filter routes by default status. Default is true.
+ * @returns An array of routes that match the specified category and default status.
+ */
+declare function findRoutesOfCategory(routes: IRoute[], categoryId: IEquatable, isDefault?: boolean): IRoute[];
+/**
+ * Generates the route href based on the provided segments, market, locale, markets, and locales.
+ *
+ * @param segments - The segments of the route.
+ * @param market - The market object.
+ * @param locale - The locale object.
+ * @param markets - The list of markets.
+ * @param locales - The list of locales.
+ * @returns The generated route href.
+ */
 declare function getRouteHref(segments: {
     slug: ILocalizable;
 }[], market: IMarket, locale: ILocale, markets: IMarket[], locales: ILocale[]): string;
 
-declare function textToSlug(title: string): string;
-
+/**
+ * Converts a value to an `IEquatable` or `undefined`.
+ * If the value is an `IEntity`, it extracts the `id` property.
+ * If the `id` is a string that represents a valid number, it returns the number.
+ * Otherwise, it returns the `id` as is.
+ *
+ * @param value The value to convert.
+ * @returns The converted value as an `IEquatable` or `undefined`.
+ */
 declare function asEquatable(value: string): IEquatable;
+declare function asEquatable(value: number): number;
+/**
+ * Converts a value to a string or `undefined`.
+ * If the value is an `IEntity`, it extracts the `id` property.
+ * If the `id` is defined, it returns it as a string.
+ * Otherwise, it returns `undefined`.
+ *
+ * @param value The value to convert.
+ * @returns The converted value as a string or `undefined`.
+ */
+declare function asEquatableString(value: string): string;
+/**
+ * Converts a value to a number or `undefined`.
+ * If the value is an `IEntity`, it extracts the `id` property.
+ * If the `id` is a string that represents a valid number, it returns the number.
+ * Otherwise, it returns `undefined`.
+ *
+ * @param value The value to convert.
+ * @returns The converted value as a number or `undefined`.
+ */
+declare function asEquatableNumber(value: number): number;
 
+/**
+ * Reorder an array of INamedEntities into an options list sorted by name.
+ *
+ * @param items - The array of INamedEntities to reorder.
+ * @returns An array of sorted IOption.
+ */
 declare function asSortedOptions<T extends INamedEntity = INamedEntity>(items: T[]): IOption[];
 
 /**
@@ -745,6 +1071,12 @@ declare function cloneItem<T = unknown>(item: T): T;
 
 declare function collectFeatureTypes<T extends IEntity = IEntity>(items: T[], ...keys: string[]): Promise<IFeatureType[]>;
 
+/**
+ * Collects options from an array of items based on specified keys.
+ * @param items The array of items to collect options from.
+ * @param keys The keys to collect options for.
+ * @returns A promise that resolves to an object containing the collected options.
+ */
 declare function collectOptions<T extends IEntity = IEntity>(items: T[], ...keys: string[]): Promise<Partial<Record<keyof T, IOption[]>>>;
 
 /**
@@ -779,22 +1111,104 @@ type ListItem<T> = {
 */
 declare function enumToList<T extends Record<string, number | string>>(enumeration: T, separatorRegex?: RegExp): ListItem<T>[];
 
+/**
+ * Checks if the given item is a number.
+ * @param item The item to check.
+ * @returns True if the item is a number, false otherwise.
+ */
 declare function isNumber(item: unknown): item is number;
+/**
+ * Checks if the given item is a string.
+ * @param item The item to check.
+ * @returns True if the item is a string, false otherwise.
+ */
 declare function isString(item: unknown): item is string;
+/**
+ * Checks if the given item is a valid non-empty string.
+ * @param item The item to check.
+ * @returns True if the item is a valid non-empty string, false otherwise.
+ */
 declare function isValidString(item: unknown): item is string;
+/**
+ * Checks if the given item is an array.
+ * @param item The item to check.
+ * @returns True if the item is an array, false otherwise.
+ */
 declare function isArray<T = unknown>(item: unknown): item is Array<T>;
+/**
+ * Checks if the given item is an object.
+ * @param item The item to check.
+ * @returns True if the item is an object, false otherwise.
+ */
 declare function isObject<T = Record<string, unknown>>(item: unknown): item is T;
+/**
+ * Checks if the given item is a promise.
+ * @param result The item to check.
+ * @returns True if the item is a promise, false otherwise.
+ */
 declare function isPromise(result: unknown): result is Promise<unknown>;
+/**
+ * Checks if the given item is a non-null string.
+ * @param item The item to check.
+ * @returns True if the item is a non-null string, false otherwise.
+ */
 declare function isNotNullString(item: unknown): item is string;
+/**
+ * Checks if the given item is equatable.
+ * @param item The item to check.
+ * @returns True if the item is equatable, false otherwise.
+ */
 declare function isEquatable(item: unknown): item is IEquatable;
-declare function isEntity(item: unknown): item is IEntity;
+/**
+ * Checks if the given item is an entity.
+ * @param item The item to check.
+ * @returns True if the item is an entity, false otherwise.
+ */
+declare function isEntity<T = IEntity>(item: unknown): item is T;
+/**
+ * Checks if the given item is an unresolved relation.
+ * @param item The item to check.
+ * @returns True if the item is an unresolved relation, false otherwise.
+ */
 declare function isUnresolvedRelation(item: unknown): item is IPageUnresolvedRelation;
+/**
+ * Checks if the given item is a relation.
+ * @param item The item to check.
+ * @returns True if the item is a relation, false otherwise.
+ */
 declare function isRelation(item: unknown): item is IPageRelation;
+/**
+ * Checks if the given item is an undecorated menu item.
+ * @param item The item to check.
+ * @returns True if the item is an undecorated menu item, false otherwise.
+ */
 declare function isUndecoratedMenuItem(item: unknown): item is IUndecoratedMenuItem;
+/**
+ * Checks if the given item is an undecorated navigation.
+ * @param item The item to check.
+ * @returns True if the item is an undecorated navigation, false otherwise.
+ */
 declare function isUndecoratedNav<T>(item: unknown): item is IUndecoratedNav<T>;
+/**
+ * Checks if the given item is an undecorated menu category.
+ * @param item The item to check.
+ * @returns True if the item is an undecorated menu category, false otherwise.
+ */
 declare function isUndecoratedMenuCategory(item: unknown): item is IUndecoratedMenuCategory;
+/**
+ * Checks if the given item is an undecorated menu page.
+ * @param item The item to check.
+ * @returns True if the item is an undecorated menu page, false otherwise.
+ */
 declare function isUndecoratedMenuPage(item: unknown): item is IUndecoratedMenuPage;
 
+/**
+ * Generates a random UUID (Universally Unique Identifier) in version 4 format.
+ *
+ * @returns {string} The generated UUID.
+ */
+declare function uuidv4(): string;
+
 declare function getIsDevelopment(): boolean;
 declare function getIsProduction(): boolean;
 declare const isDevelopment: boolean;
@@ -807,4 +1221,4 @@ declare function asServerProps(props: any): any;
 declare function awaitAll(array: any, callback: (item: any, index: number) => Promise<any>): Promise<any[]>;
 declare function merge(target: any, source: any): any;
 
-export { DeepPartial, Dynamic, FetchError, FetchRequestOptions, FetchService, FindParams, FindWhereParams, IAction, IActionEmailData, IAnchor, ICategorized, ICategory, ICategoryItem, IClassName, IClassNameCollection, IClassNameValue, ICollectionDescription, IComponent, IConfig, IConsentPreference, IContextBaseParams, IContextParams, IDecoratedNav, IEmailConfig, IEndUser, IEntity, IEquatable, IFeature, IFeatureType, ILabel, ILayout, ILegalNotice, ILetter, ILocale, ILocaleId, ILocalizable, ILocalized, ILocalizedString, IMarket, IMedia, IMediaImage, IMediaInfo, IMediaJson, IMediaPdf, IMediaType, IMediaVideo, IMemoryStore, IMenu, IMenuBase, IMenuCategory, IMenuCustom, IMenuGroup, IMenuHref, IMenuItem, IMenuLink, IMenuPage, IMenuRoute, INamedEntity, IOption, IOverride, IOverrideReturnValue, IOverrideValue, IPackages, IPage, IPageRelation, IPageRelationResult, IPageUnresolvedRelation, IPagedResult, IPaginationResult, IPartial, IPreference, IPrettify, IQuerable, IRedirect, IRoute, IRouteCanonical, IRouteLink, IRouteParams, ISchema, ISerializedCollection, ISerializedStore, IServerSideContext, IServerSideSplatContext, IStaticContext, IStore, ITemplate, ITitledEntity, IUndecoratedMenu, IUndecoratedMenuBase, IUndecoratedMenuCategory, IUndecoratedMenuCustom, IUndecoratedMenuGroup, IUndecoratedMenuItem, IUndecoratedMenuLink, IUndecoratedMenuPage, IUndecoratedNav, Json, JsonService, LiteralUnion, Logger, LoggerLevel, NextApiRequestCookies, Operator, PageProps, Pagination, PreviewData, Primitive, QueryParams, RedirectReason, RouteStrategy, SchemaType, ServerSidePropsContext, StaticPropsContext, User, UserRole, UserWithRoles, ValueOf, Where, WhereAndOr, WhereBase, WhereField, asCategoryId, asEquatable, asServerProps, asSortedOptions, awaitAll, camelToSnakeCase, cloneItem, collectFeatureTypes, collectOptions, collectRoutes, consoleWarn, deepMerge, defaultLocale, defaultMarket, eachCategorized, eachMarketLocale, enumToList, getCategorySegments, getCategorySegmentsByCategory, getClassNames, getCollectionDescription, getEnv, getHost, getIsDevelopment, getIsProduction, getOrigin, getParentCategoriesById, getProto, getRootCategory, getRouteHref, httpDelete, httpFetch, httpGet, httpPatch, httpPost, httpPut, isArray, isBrowser, isCategory, isDevelopment, isEntity, isEquatable, isHeaders, isIncomingHttpHeaders, isLocalizedString, isMediaImage, isMediaJson, isMediaPdf, isMediaVideo, isMenuHref, isNotNullString, isNumber, isObject, isProduction, isPromise, isRelation, isReservedCollectionDescription, isStage, isString, isUndecoratedMenuCategory, isUndecoratedMenuItem, isUndecoratedMenuPage, isUndecoratedNav, isUnresolvedRelation, isValidCollectionDescription, isValidString, localize, localizeItem, localizeValue, localizedToString, merge, pascalCaseToCamelCase, pascalCaseToCharCase, pascalCaseToKebabCase, pascalCaseToSnakeCase, qsDeserialize, qsDeserializeRaw, qsSerialize, qsSerializeRaw, resolveMediaType, textToSlug, toCamelCase, toCharCase, toDisplayName, toFindParams, toKebabCase, toPascalCase, toPluralName, toSnakeCase, toTitleCase, toValidCollectionName, unknownCaseToPascalCase, withSchema };
+export { DeepPartial, Dynamic, FetchError, FetchRequestOptions, FetchService, FindParams, FindWhereParams, IAction, IActionEmailData, IAnchor, ICategorized, ICategory, ICategoryItem, IClassName, IClassNameCollection, IClassNameValue, ICollectionDescription, IComponent, IConfig, IConsentPreference, IContextBaseParams, IContextParams, IDecoratedNav, IEmailConfig, IEndUser, IEntity, IEquatable, IFeature, IFeatureType, ILabel, ILayout, ILegalNotice, ILetter, ILocale, ILocaleId, ILocalizable, ILocalized, ILocalizedString, IMarket, IMedia, IMediaImage, IMediaInfo, IMediaJson, IMediaPdf, IMediaType, IMediaVideo, IMemoryStore, IMenu, IMenuBase, IMenuCategory, IMenuCustom, IMenuGroup, IMenuHref, IMenuItem, IMenuLink, IMenuPage, IMenuRoute, INamedEntity, IOption, IOverride, IOverrideReturnValue, IOverrideValue, IPackages, IPage, IPageRelation, IPageRelationResult, IPageUnresolvedRelation, IPagedResult, IPaginationResult, IPartial, IPreference, IPrettify, IQuerable, IRedirect, IRoute, IRouteCanonical, IRouteLink, IRouteParams, ISchema, ISerializedCollection, ISerializedStore, IServerSideContext, IServerSideSplatContext, IStaticContext, IStore, ITemplate, ITitledEntity, IUndecoratedMenu, IUndecoratedMenuBase, IUndecoratedMenuCategory, IUndecoratedMenuCustom, IUndecoratedMenuGroup, IUndecoratedMenuItem, IUndecoratedMenuLink, IUndecoratedMenuPage, IUndecoratedNav, Json, JsonService, LiteralUnion, Logger, LoggerLevel, NextApiRequestCookies, Operator, PageProps, Pagination, PreviewData, Primitive, QueryParams, RedirectReason, RouteStrategy, SchemaType, ServerSidePropsContext, StaticPropsContext, User, UserRole, UserWithRoles, ValueOf, Where, WhereAndOr, WhereBase, WhereField, asCategoryId, asEquatable, asEquatableNumber, asEquatableString, asServerProps, asSortedOptions, awaitAll, camelToSnakeCase, cloneItem, collectFeatureTypes, collectOptions, collectRoutes, consoleWarn, deepMerge, defaultLocale, defaultMarket, eachCategorized, eachMarketLocale, enumToList, findCategoryInCategories, findChildCategories, findRouteOfCategory, findRoutesOfCategory, getCategorySegments, getCategorySegmentsByCategory, getClassNames, getCollectionDescription, getEnv, getHost, getIsDevelopment, getIsProduction, getOrigin, getParentCategoriesById, getParentCategory, getProto, getRootCategory, getRouteHref, httpDelete, httpFetch, httpGet, httpPatch, httpPost, httpPut, isArray, isBrowser, isDevelopment, isEntity, isEquatable, isHeaders, isIncomingHttpHeaders, isLocalizedString, isMediaImage, isMediaJson, isMediaPdf, isMediaVideo, isMenuHref, isNotNullString, isNumber, isObject, isProduction, isPromise, isRelation, isReservedCollectionDescription, isStage, isString, isUndecoratedMenuCategory, isUndecoratedMenuItem, isUndecoratedMenuPage, isUndecoratedNav, isUnresolvedRelation, isValidCollectionDescription, isValidString, localize, localizeItem, localizeValue, localizedToString, merge, pascalCaseToCamelCase, pascalCaseToCharCase, pascalCaseToKebabCase, pascalCaseToSnakeCase, qsDeserialize, qsDeserializeRaw, qsSerialize, qsSerializeRaw, resolveMediaType, toCamelCase, toCharCase, toDisplayName, toFindParams, toKebabCase, toPascalCase, toPluralName, toSnakeCase, toTitleCase, toValidCollectionName, unknownCaseToPascalCase, uuidv4, withSchema };