@websolutespa/bom-core 0.2.0 → 0.2.1

package/CHANGELOG.md

@@ -1,32 +1,38 @@
-# @websolutespa/bom-core
-
-## 0.2.0
-
-### Minor Changes
-
-- Modified routes, added redirects.
-
-## 0.1.2
-
-### Patch Changes
-
-- Modified: MockMenuService.
-
-## 0.1.1
-
-### Patch Changes
-
-- Modified: ILocalizable.
-
-## 0.1.0
-
-### Minor Changes
-
-- Added: splat routes.
-- Added: variants.
-
-## 0.0.1
-
-### Patch Changes
-
-- Added: first release.
+# @websolutespa/bom-core
+
+## 0.2.1
+
+### Patch Changes
+
+- Added: env ROOT_CATEGORY.
+
+## 0.2.0
+
+### Minor Changes
+
+- Modified routes, added redirects.
+
+## 0.1.2
+
+### Patch Changes
+
+- Modified: MockMenuService.
+
+## 0.1.1
+
+### Patch Changes
+
+- Modified: ILocalizable.
+
+## 0.1.0
+
+### Minor Changes
+
+- Added: splat routes.
+- Added: variants.
+
+## 0.0.1
+
+### Patch Changes
+
+- Added: first release.

package/dist/index.d.ts

@@ -444,6 +444,7 @@ type ITemplate = {
 
 declare function isCategory(value?: ICategory | IEquatable): value is ICategory;
 declare function asCategoryId(value?: ICategory | IEquatable): string | undefined;
+declare function getRootCategory(categories: ICategory[]): ICategory | undefined;
 declare function getParentCategoriesById(id: string | undefined, categories: ICategory[]): ICategory[];
 declare function getCategorySegments(item: ICategorized, categories: ICategory[]): ICategory[];
 declare function getCategorySegmentsByCategory(item: ICategory, categories: ICategory[]): ICategory[];
@@ -519,6 +520,19 @@ declare function getRouteHref(segments: ICategory[], market: IMarket, locale: IL
 
 declare function textToSlug(title: string): string;
 
+type ListItem<T> = {
+    [K in keyof T]: {
+        readonly key: string;
+        readonly value: T[K];
+    };
+}[keyof T];
+/**
+* Helper to produce an array of enum descriptors.
+* @param enumeration Enumeration object.
+* @param separatorRegex Regex that would catch the separator in your enum key.
+*/
+declare function enumToList<T extends Record<string, number | string>>(enumeration: T, separatorRegex?: RegExp): ListItem<T>[];
+
 declare function getIsDevelopment(): boolean;
 declare function getIsProduction(): boolean;
 declare const isDevelopment: boolean;
@@ -531,4 +545,4 @@ declare function awaitAll(array: any, callback: (item: any, index: number) => Pr
 declare function merge(target: any, source: any): any;
 declare function deepCopy<T>(source: T): T;
 
-export { FetchRequestOptions, FetchService, FindParams, FindWhereParams, ICategorized, ICategory, ICategoryItem, IClassName, IClassNameCollection, IClassNameValue, ICollectionDescription, IConfig, IContextBaseParams, IContextParams, IEntity, IEquatable, ILabel, ILayout, ILocale, ILocalizable, ILocalized, ILocalizedString, IMarket, IMedia, IMediaType, IMemoryStore, IMenu, IMenuBase, IMenuCategory, IMenuCustom, IMenuGroup, IMenuItem, IMenuLink, IMenuPage, IMenuRoute, INamedEntity, IOption, IOverride, IPackages, IPage, IPageRelation, IPageResult, IPartial, IPrettify, IQuerable, IRedirect, IRoute, IRouteCanonical, IRouteLink, IRouteParams, ISchema, ISerializedCollection, ISerializedStore, IServerSideContext, IServerSideSplatContext, IStaticContext, IStore, ITemplate, ITitledEntity, IUndecoratedMenu, IUndecoratedMenuBase, IUndecoratedMenuCategory, IUndecoratedMenuCustom, IUndecoratedMenuGroup, IUndecoratedMenuItem, IUndecoratedMenuLink, IUndecoratedMenuPage, Json, JsonService, LiteralUnion, NextApiRequestCookies, Operator, PageProps, Pagination, PreviewData, QueryParams, RedirectReason, RouteStrategy, SchemaType, ServerSidePropsContext, StateValue, StaticPropsContext, ValueOf, Where, WhereAndOr, WhereBase, WhereField, asCategoryId, asEquatable, asServerProps, awaitAll, camelToSnakeCase, collectRoutes, consoleWarn, deepCopy, deserializeKey, deserializeValue, eachCategorized, eachMarketLocale, getCategorySegments, getCategorySegmentsByCategory, getClassNames, getCollectionDescription, getIsDevelopment, getIsProduction, getParentCategoriesById, getRouteHref, httpDelete, httpFetch, httpGet, httpPatch, httpPost, httpPut, isBrowser, isCategory, isDevelopment, isLocalizedString, isProduction, isStage, isValidCollectionDescription, localize, localizeItem, localizeValue, localizedToString, merge, qsDeserialize, qsSerialize, textToSlug, toDisplayName, toFindParams, toPluralName, toTitleCase, toValidCollectionName, withSchema };
+export { FetchRequestOptions, FetchService, FindParams, FindWhereParams, ICategorized, ICategory, ICategoryItem, IClassName, IClassNameCollection, IClassNameValue, ICollectionDescription, IConfig, IContextBaseParams, IContextParams, IEntity, IEquatable, ILabel, ILayout, ILocale, ILocalizable, ILocalized, ILocalizedString, IMarket, IMedia, IMediaType, IMemoryStore, IMenu, IMenuBase, IMenuCategory, IMenuCustom, IMenuGroup, IMenuItem, IMenuLink, IMenuPage, IMenuRoute, INamedEntity, IOption, IOverride, IPackages, IPage, IPageRelation, IPageResult, IPartial, IPrettify, IQuerable, IRedirect, IRoute, IRouteCanonical, IRouteLink, IRouteParams, ISchema, ISerializedCollection, ISerializedStore, IServerSideContext, IServerSideSplatContext, IStaticContext, IStore, ITemplate, ITitledEntity, IUndecoratedMenu, IUndecoratedMenuBase, IUndecoratedMenuCategory, IUndecoratedMenuCustom, IUndecoratedMenuGroup, IUndecoratedMenuItem, IUndecoratedMenuLink, IUndecoratedMenuPage, Json, JsonService, LiteralUnion, NextApiRequestCookies, Operator, PageProps, Pagination, PreviewData, QueryParams, RedirectReason, RouteStrategy, SchemaType, ServerSidePropsContext, StateValue, StaticPropsContext, ValueOf, Where, WhereAndOr, WhereBase, WhereField, asCategoryId, asEquatable, asServerProps, awaitAll, camelToSnakeCase, collectRoutes, consoleWarn, deepCopy, deserializeKey, deserializeValue, eachCategorized, eachMarketLocale, enumToList, getCategorySegments, getCategorySegmentsByCategory, getClassNames, getCollectionDescription, getIsDevelopment, getIsProduction, getParentCategoriesById, getRootCategory, getRouteHref, httpDelete, httpFetch, httpGet, httpPatch, httpPost, httpPut, isBrowser, isCategory, isDevelopment, isLocalizedString, isProduction, isStage, isValidCollectionDescription, localize, localizeItem, localizeValue, localizedToString, merge, qsDeserialize, qsSerialize, textToSlug, toDisplayName, toFindParams, toPluralName, toTitleCase, toValidCollectionName, withSchema };

package/dist/index.js

@@ -45,6 +45,7 @@ __export(src_exports, {
   deserializeValue: () => deserializeValue,
   eachCategorized: () => eachCategorized,
   eachMarketLocale: () => eachMarketLocale,
+  enumToList: () => enumToList,
   getCategorySegments: () => getCategorySegments,
   getCategorySegmentsByCategory: () => getCategorySegmentsByCategory,
   getClassNames: () => getClassNames,
@@ -52,6 +53,7 @@ __export(src_exports, {
   getIsDevelopment: () => getIsDevelopment,
   getIsProduction: () => getIsProduction,
   getParentCategoriesById: () => getParentCategoriesById,
+  getRootCategory: () => getRootCategory,
   getRouteHref: () => getRouteHref,
   httpDelete: () => httpDelete,
   httpFetch: () => httpFetch,
@@ -90,6 +92,15 @@ function isCategory(value) {
 function asCategoryId(value) {
   return isCategory(value) ? value.id : value;
 }
+var ROOT_CATEGORY = process.env.ROOT_CATEGORY || "";
+function getRootCategory(categories) {
+  const rootCategory = ROOT_CATEGORY && categories.find((x) => x.id == ROOT_CATEGORY);
+  if (rootCategory) {
+    return rootCategory;
+  } else {
+    return categories.find((x) => x.category == null);
+  }
+}
 function getParentCategoriesById(id, categories) {
   const routeCategories = [];
   const segments = [];
@@ -239,6 +250,15 @@ function consoleWarn(message, component) {
   console.warn(log);
 }
 
+// src/utils/enumToList.ts
+function enumToList(enumeration, separatorRegex = /_/g) {
+  const array = Object.keys(enumeration);
+  return array.filter((key) => isNaN(Number(key))).filter((key) => typeof enumeration[key] === "number" || typeof enumeration[key] === "string").map((key) => ({
+    key: String(key).replace(separatorRegex, " "),
+    value: enumeration[key]
+  }));
+}
+
 // src/utils/index.ts
 function getIsDevelopment() {
   return process && (!process.env.NODE_ENV || process.env.NODE_ENV === "development");
@@ -708,7 +728,7 @@ function qsDeserialize(query = "", deserializedParams = {}) {
 function collectRoutes(store, categories, markets, locales) {
   const routes = [];
   if (locales.length > 0 && markets.length > 0) {
-    const firstTopCategory = categories.find((x) => x.category === void 0);
+    const rootCategory = getRootCategory(categories);
     eachCategorized(store, (item, key) => {
       const segments = getCategorySegments(item, categories);
       eachMarketLocale(markets, locales, (market, locale, markets2, locales2) => {
@@ -732,7 +752,7 @@ function collectRoutes(store, categories, markets, locales) {
           routes.push(route);
         }
       });
-      if (firstTopCategory && item.category === firstTopCategory.id) {
+      if (rootCategory && item.category === rootCategory.id) {
         const defaultLocale = locales.find((x) => x.isDefault) || locales[0];
         const defaultMarket = markets.find((x) => x.isDefault) || markets[0];
         const defaultMarketLocale = defaultMarket && defaultMarket.defaultLanguage ? defaultMarket.defaultLanguage : defaultLocale.id;
@@ -860,6 +880,7 @@ var RedirectReason = /* @__PURE__ */ ((RedirectReason2) => {
   deserializeValue,
   eachCategorized,
   eachMarketLocale,
+  enumToList,
   getCategorySegments,
   getCategorySegmentsByCategory,
   getClassNames,
@@ -867,6 +888,7 @@ var RedirectReason = /* @__PURE__ */ ((RedirectReason2) => {
   getIsDevelopment,
   getIsProduction,
   getParentCategoriesById,
+  getRootCategory,
   getRouteHref,
   httpDelete,
   httpFetch,

package/dist/index.mjs

@@ -5,6 +5,15 @@ function isCategory(value) {
 function asCategoryId(value) {
   return isCategory(value) ? value.id : value;
 }
+var ROOT_CATEGORY = process.env.ROOT_CATEGORY || "";
+function getRootCategory(categories) {
+  const rootCategory = ROOT_CATEGORY && categories.find((x) => x.id == ROOT_CATEGORY);
+  if (rootCategory) {
+    return rootCategory;
+  } else {
+    return categories.find((x) => x.category == null);
+  }
+}
 function getParentCategoriesById(id, categories) {
   const routeCategories = [];
   const segments = [];
@@ -154,6 +163,15 @@ function consoleWarn(message, component) {
   console.warn(log);
 }
 
+// src/utils/enumToList.ts
+function enumToList(enumeration, separatorRegex = /_/g) {
+  const array = Object.keys(enumeration);
+  return array.filter((key) => isNaN(Number(key))).filter((key) => typeof enumeration[key] === "number" || typeof enumeration[key] === "string").map((key) => ({
+    key: String(key).replace(separatorRegex, " "),
+    value: enumeration[key]
+  }));
+}
+
 // src/utils/index.ts
 function getIsDevelopment() {
   return process && (!process.env.NODE_ENV || process.env.NODE_ENV === "development");
@@ -623,7 +641,7 @@ function qsDeserialize(query = "", deserializedParams = {}) {
 function collectRoutes(store, categories, markets, locales) {
   const routes = [];
   if (locales.length > 0 && markets.length > 0) {
-    const firstTopCategory = categories.find((x) => x.category === void 0);
+    const rootCategory = getRootCategory(categories);
     eachCategorized(store, (item, key) => {
       const segments = getCategorySegments(item, categories);
       eachMarketLocale(markets, locales, (market, locale, markets2, locales2) => {
@@ -647,7 +665,7 @@ function collectRoutes(store, categories, markets, locales) {
           routes.push(route);
         }
       });
-      if (firstTopCategory && item.category === firstTopCategory.id) {
+      if (rootCategory && item.category === rootCategory.id) {
         const defaultLocale = locales.find((x) => x.isDefault) || locales[0];
         const defaultMarket = markets.find((x) => x.isDefault) || markets[0];
         const defaultMarketLocale = defaultMarket && defaultMarket.defaultLanguage ? defaultMarket.defaultLanguage : defaultLocale.id;
@@ -774,6 +792,7 @@ export {
   deserializeValue,
   eachCategorized,
   eachMarketLocale,
+  enumToList,
   getCategorySegments,
   getCategorySegmentsByCategory,
   getClassNames,
@@ -781,6 +800,7 @@ export {
   getIsDevelopment,
   getIsProduction,
   getParentCategoriesById,
+  getRootCategory,
   getRouteHref,
   httpDelete,
   httpFetch,

package/package.json

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