@websolutespa/bom-core 1.8.7 → 1.8.9

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @websolutespa/bom-core
 
+## 1.8.9
+
+### Patch Changes
+
+- Added: isMenu assertions
+
+## 1.8.8
+
+### Patch Changes
+
+- f343ad7: Modified: RouteService collectRoutes
+
 ## 1.8.7
 
 ### Patch Changes

package/dist/index.d.ts

@@ -94,13 +94,15 @@ type User = Record<string, unknown> & {
     id: string;
     email: string;
 };
-type UserRole = 'admin' | 'editor' | 'user' | string;
+type UserRole = ('admin' | 'editor' | 'guest' | 'user') & string;
 type UserWithRoles = User & {
     roles: UserRole[];
 };
 type IEndUser = UserWithRoles & {
     email: string;
     consentPreferences: IConsentPreference[];
+    createdAt: string;
+    updatedAt: string;
 };
 
 type IAction = Record<string, unknown> & {
@@ -110,7 +112,6 @@ type IAction = Record<string, unknown> & {
     consentsRevoked?: boolean;
     consentsRevokedDate?: string | Date;
     endUser: IEndUser;
-    loggedEndUser?: IEndUser;
     email?: string;
     password?: string;
     createdAt?: string;
@@ -477,6 +478,11 @@ type IMenuCustom = Record<string, unknown> & {
 type IMenuItem = IMenuCategory | IMenuGroup | IMenuLink | IMenuPage | IMenuRoute;
 type IMenuHref = IMenuCategory | IMenuLink | IMenuPage | IMenuRoute;
 declare function isMenuHref(item: IMenuItem): item is IMenuHref;
+declare function isMenuCategory(item: IMenuItem): item is IMenuCategory;
+declare function isMenuGroup(item: IMenuItem): item is IMenuGroup;
+declare function isMenuLink(item: IMenuItem): item is IMenuLink;
+declare function isMenuPage(item: IMenuItem): item is IMenuPage;
+declare function isMenuRoute(item: IMenuItem): item is IMenuRoute;
 type IMenu = {
     id: string;
     items: IMenuItem[];
@@ -542,12 +548,8 @@ type ILayout = {
     tree?: IRouteLink;
 };
 
-type IUndecoratedNav<T> = T & {
-    nav?: IUndecoratedMenuPage;
-};
-type IDecoratedNav<T> = T & {
-    nav?: IMenuPage;
-};
+type IUndecoratedNav = IUndecoratedMenuPage;
+type IDecoratedNav = IMenuPage;
 
 type Pagination = {
     hasNextPage: boolean;
@@ -1265,12 +1267,6 @@ declare function isRelation(item: unknown): item is IPageRelation;
  * @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.
@@ -1283,6 +1279,12 @@ declare function isUndecoratedMenuCategory(item: unknown): item is IUndecoratedM
  * @returns True if the item is an undecorated menu page, false otherwise.
  */
 declare function isUndecoratedMenuPage(item: unknown): item is IUndecoratedMenuPage;
+/**
+ * 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(item: unknown): item is IUndecoratedNav;
 
 /**
  * Generates a random UUID (Universally Unique Identifier) in version 4 format.
@@ -1303,4 +1305,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, IImageResize, 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, IPageItem, 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, ImageStrategy, Json, JsonService, LiteralUnion, Logger, LoggerLevel, MenuCategoryStrategy, NextApiRequestCookies, Operator, PageProps, Pagination, PreviewData, Primitive, QueryParams, RedirectReason, RequireAtLeastOne, RouteStrategy, SchemaType, ServerSidePropsContext, StaticPropsContext, User, UserRole, UserWithRoles, ValueOf, Where, WhereAndOr, WhereBase, WhereField, arrayShuffle, asCategoryId, asEntityId, asEquatable, asEquatableNumber, asEquatableString, asServerProps, asSortedOptions, awaitAll, base64ToString, camelToSnakeCase, cloneItem, collectFeatureTypes, collectFeatureTypes__, collectOptions, collectRoutes, consoleWarn, decryptImageResize, deepMerge, defaultLocale, defaultMarket, eachCategorized, eachMarketLocale, encryptImageToken, 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, stringToBase64, toCamelCase, toCharCase, toDisplayName, toFindParams, toKebabCase, toPascalCase, toPluralName, toSnakeCase, toTitleCase, toValidCollectionName, unknownCaseToPascalCase, uuidv4, 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, IImageResize, 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, IPageItem, 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, ImageStrategy, Json, JsonService, LiteralUnion, Logger, LoggerLevel, MenuCategoryStrategy, NextApiRequestCookies, Operator, PageProps, Pagination, PreviewData, Primitive, QueryParams, RedirectReason, RequireAtLeastOne, RouteStrategy, SchemaType, ServerSidePropsContext, StaticPropsContext, User, UserRole, UserWithRoles, ValueOf, Where, WhereAndOr, WhereBase, WhereField, arrayShuffle, asCategoryId, asEntityId, asEquatable, asEquatableNumber, asEquatableString, asServerProps, asSortedOptions, awaitAll, base64ToString, camelToSnakeCase, cloneItem, collectFeatureTypes, collectFeatureTypes__, collectOptions, collectRoutes, consoleWarn, decryptImageResize, deepMerge, defaultLocale, defaultMarket, eachCategorized, eachMarketLocale, encryptImageToken, 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, isMenuCategory, isMenuGroup, isMenuHref, isMenuLink, isMenuPage, isMenuRoute, 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, stringToBase64, toCamelCase, toCharCase, toDisplayName, toFindParams, toKebabCase, toPascalCase, toPluralName, toSnakeCase, toTitleCase, toValidCollectionName, unknownCaseToPascalCase, uuidv4, withSchema };

package/dist/index.js

@@ -98,7 +98,12 @@ __export(src_exports, {
   isMediaJson: () => isMediaJson,
   isMediaPdf: () => isMediaPdf,
   isMediaVideo: () => isMediaVideo,
+  isMenuCategory: () => isMenuCategory,
+  isMenuGroup: () => isMenuGroup,
   isMenuHref: () => isMenuHref,
+  isMenuLink: () => isMenuLink,
+  isMenuPage: () => isMenuPage,
+  isMenuRoute: () => isMenuRoute,
   isNotNullString: () => isNotNullString,
   isNumber: () => isNumber,
   isObject: () => isObject,
@@ -188,15 +193,15 @@ function isRelation(item) {
 function isUndecoratedMenuItem(item) {
   return isObject(item) && (item.type === "category" && isEquatable(item.category) || item.type === "page" && isEquatable(item.page.value));
 }
-function isUndecoratedNav(item) {
-  return isObject(item) && isUndecoratedMenuPage(item.nav);
-}
 function isUndecoratedMenuCategory(item) {
   return isObject(item) && item.type === "category" && isNotNullString(item.category) && item.id === void 0 && item.href === void 0;
 }
 function isUndecoratedMenuPage(item) {
   return isObject(item) && item.type === "page" && isObject(item.page) && isNotNullString(item.page.relationTo) && isEquatable(item.page.value);
 }
+function isUndecoratedNav(item) {
+  return isUndecoratedMenuPage(item);
+}
 
 // src/utils/asEquatable.ts
 function asEquatable(value) {
@@ -725,7 +730,7 @@ async function httpDelete(url, options = {}) {
 
 // src/image/image.ts
 function getSecret() {
-  return process.env.IMAGE_SECRET || "The sun sets over the calm ocean";
+  return process.env.IMAGE_SECRET || "IMAGE_SECRET";
 }
 function textToArrayBuffer_(text) {
   const encoder = new TextEncoder();
@@ -1399,43 +1404,20 @@ function collectRoutes(store, categories, markets, locales, medias) {
         if (Boolean(item.isDefault) === false) {
           slugs.push({ slug: item.slug });
         }
-        if (rootCategory && item.category === rootCategory.id) {
-          const defaultLocale2 = locales.find((x) => x.isDefault) || locales[0];
-          const defaultMarket2 = markets.find((x) => x.isDefault) || markets[0];
-          const defaultMarketLocale = defaultMarket2 && defaultMarket2.defaultLanguage ? asEntityId(defaultMarket2.defaultLanguage) : defaultLocale2.id;
-          const title = localize(item.title, defaultMarketLocale);
-          const pickedProps = getPickedProps(item);
-          const route = {
-            ...pickedProps,
-            resolvedCategory: rootCategory.id,
-            id: "/",
-            market: defaultMarket2.id,
-            locale: defaultMarketLocale,
-            page: item.id,
-            schema: key,
-            title
-          };
-          const mediaId = typeof item.media === "string" ? item.media : void 0;
-          if (Array.isArray(medias) && mediaId) {
-            const media = item.media && medias.find((x) => x.id === mediaId);
-            if (media) {
-              route.media = media;
-            }
-          }
-          routes.push(route);
-        }
+        const defaultLocale2 = locales.find((x) => x.isDefault) || locales[0];
+        const defaultMarket2 = markets.find((x) => x.isDefault) || markets[0];
+        const defaultMarketLocale = defaultMarket2 && defaultMarket2.defaultLanguage ? asEntityId(defaultMarket2.defaultLanguage) : defaultLocale2.id;
+        const isRootCategory = rootCategory && item.category === rootCategory.id && item.isDefault;
         eachMarketLocale(markets, locales, (market, locale, markets2, locales2) => {
           if (!item.markets || item.markets.includes(market.id)) {
             const title = localize(item.title, locale.id);
             const id = getRouteHref(slugs, market, locale, markets2, locales2);
-            if (!id) {
-              return;
-            }
+            const isDefaultRootCategory = isRootCategory && market.id === defaultMarket2.id && locale.id === defaultMarketLocale;
             const pickedProps = getPickedProps(item);
             const route = {
               ...pickedProps,
               resolvedCategory: visibleCategory.id,
-              id,
+              id: isDefaultRootCategory ? "/" : id,
               locale: locale.id,
               market: market.id,
               page: item.id,
@@ -1583,6 +1565,21 @@ function isMediaPdf(media) {
 function isMenuHref(item) {
   return ["category", "link", "page", "route"].includes(item.type);
 }
+function isMenuCategory(item) {
+  return item.type === "category";
+}
+function isMenuGroup(item) {
+  return item.type === "group";
+}
+function isMenuLink(item) {
+  return item.type === "link";
+}
+function isMenuPage(item) {
+  return item.type === "page";
+}
+function isMenuRoute(item) {
+  return item.type === "route";
+}
 var MenuCategoryStrategy = /* @__PURE__ */ ((MenuCategoryStrategy2) => {
   MenuCategoryStrategy2["Default"] = "default";
   MenuCategoryStrategy2["ExcludeHidden"] = "exclude-hidden";
@@ -1677,7 +1674,12 @@ var RedirectReason = /* @__PURE__ */ ((RedirectReason2) => {
   isMediaJson,
   isMediaPdf,
   isMediaVideo,
+  isMenuCategory,
+  isMenuGroup,
   isMenuHref,
+  isMenuLink,
+  isMenuPage,
+  isMenuRoute,
   isNotNullString,
   isNumber,
   isObject,

package/dist/index.mjs

@@ -40,15 +40,15 @@ function isRelation(item) {
 function isUndecoratedMenuItem(item) {
   return isObject(item) && (item.type === "category" && isEquatable(item.category) || item.type === "page" && isEquatable(item.page.value));
 }
-function isUndecoratedNav(item) {
-  return isObject(item) && isUndecoratedMenuPage(item.nav);
-}
 function isUndecoratedMenuCategory(item) {
   return isObject(item) && item.type === "category" && isNotNullString(item.category) && item.id === void 0 && item.href === void 0;
 }
 function isUndecoratedMenuPage(item) {
   return isObject(item) && item.type === "page" && isObject(item.page) && isNotNullString(item.page.relationTo) && isEquatable(item.page.value);
 }
+function isUndecoratedNav(item) {
+  return isUndecoratedMenuPage(item);
+}
 
 // src/utils/asEquatable.ts
 function asEquatable(value) {
@@ -577,7 +577,7 @@ async function httpDelete(url, options = {}) {
 
 // src/image/image.ts
 function getSecret() {
-  return process.env.IMAGE_SECRET || "The sun sets over the calm ocean";
+  return process.env.IMAGE_SECRET || "IMAGE_SECRET";
 }
 function textToArrayBuffer_(text) {
   const encoder = new TextEncoder();
@@ -1251,43 +1251,20 @@ function collectRoutes(store, categories, markets, locales, medias) {
         if (Boolean(item.isDefault) === false) {
           slugs.push({ slug: item.slug });
         }
-        if (rootCategory && item.category === rootCategory.id) {
-          const defaultLocale2 = locales.find((x) => x.isDefault) || locales[0];
-          const defaultMarket2 = markets.find((x) => x.isDefault) || markets[0];
-          const defaultMarketLocale = defaultMarket2 && defaultMarket2.defaultLanguage ? asEntityId(defaultMarket2.defaultLanguage) : defaultLocale2.id;
-          const title = localize(item.title, defaultMarketLocale);
-          const pickedProps = getPickedProps(item);
-          const route = {
-            ...pickedProps,
-            resolvedCategory: rootCategory.id,
-            id: "/",
-            market: defaultMarket2.id,
-            locale: defaultMarketLocale,
-            page: item.id,
-            schema: key,
-            title
-          };
-          const mediaId = typeof item.media === "string" ? item.media : void 0;
-          if (Array.isArray(medias) && mediaId) {
-            const media = item.media && medias.find((x) => x.id === mediaId);
-            if (media) {
-              route.media = media;
-            }
-          }
-          routes.push(route);
-        }
+        const defaultLocale2 = locales.find((x) => x.isDefault) || locales[0];
+        const defaultMarket2 = markets.find((x) => x.isDefault) || markets[0];
+        const defaultMarketLocale = defaultMarket2 && defaultMarket2.defaultLanguage ? asEntityId(defaultMarket2.defaultLanguage) : defaultLocale2.id;
+        const isRootCategory = rootCategory && item.category === rootCategory.id && item.isDefault;
         eachMarketLocale(markets, locales, (market, locale, markets2, locales2) => {
           if (!item.markets || item.markets.includes(market.id)) {
             const title = localize(item.title, locale.id);
             const id = getRouteHref(slugs, market, locale, markets2, locales2);
-            if (!id) {
-              return;
-            }
+            const isDefaultRootCategory = isRootCategory && market.id === defaultMarket2.id && locale.id === defaultMarketLocale;
             const pickedProps = getPickedProps(item);
             const route = {
               ...pickedProps,
               resolvedCategory: visibleCategory.id,
-              id,
+              id: isDefaultRootCategory ? "/" : id,
               locale: locale.id,
               market: market.id,
               page: item.id,
@@ -1435,6 +1412,21 @@ function isMediaPdf(media) {
 function isMenuHref(item) {
   return ["category", "link", "page", "route"].includes(item.type);
 }
+function isMenuCategory(item) {
+  return item.type === "category";
+}
+function isMenuGroup(item) {
+  return item.type === "group";
+}
+function isMenuLink(item) {
+  return item.type === "link";
+}
+function isMenuPage(item) {
+  return item.type === "page";
+}
+function isMenuRoute(item) {
+  return item.type === "route";
+}
 var MenuCategoryStrategy = /* @__PURE__ */ ((MenuCategoryStrategy2) => {
   MenuCategoryStrategy2["Default"] = "default";
   MenuCategoryStrategy2["ExcludeHidden"] = "exclude-hidden";
@@ -1528,7 +1520,12 @@ export {
   isMediaJson,
   isMediaPdf,
   isMediaVideo,
+  isMenuCategory,
+  isMenuGroup,
   isMenuHref,
+  isMenuLink,
+  isMenuPage,
+  isMenuRoute,
   isNotNullString,
   isNumber,
   isObject,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@websolutespa/bom-core",
-  "version": "1.8.7",
+  "version": "1.8.9",
   "description": "Core module of the BOM Repository",
   "keywords": [
     "bom",