@websolutespa/bom-core 0.6.4 → 0.6.6

package/CHANGELOG.md

@@ -1,95 +1,108 @@
-# @websolutespa/bom-core
-
-## 0.6.4
-
-### Patch Changes
-
-- Added: typeGuards, IPagedResult.
-- Modified: IUndecoratedMenuCustom.
-
-## 0.6.3
-
-### Patch Changes
-
-- Added: isReservedCollectionDescription.
-
-## 0.6.2
-
-### Patch Changes
-
-- Modified: IMedia.
-
-## 0.6.1
-
-### Patch Changes
-
-- Added: defaultMarket, defaultLocale.
-
-## 0.6.0
-
-### Minor Changes
-
-- Added Logger, IPaginationResult.
-
-## 0.5.0
-
-### Minor Changes
-
-- Modified: JsonService, qs.
-- Added: asEquatable, cloneItem, typeGuards.
-
-## 0.4.1
-
-### Patch Changes
-
-- Added: IAnchor, babelCase.
-- Modified: IApplication, IPageRelation.
-
-## 0.4.0
-
-### Minor Changes
-
-- Updating: next 13.
-
-## 0.3.0
-
-### Minor Changes
-
-- Modified: HttpService.
-
-## 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.
+# @websolutespa/bom-core
+
+## 0.6.6
+
+### Patch Changes
+
+- Modified: collectRoutes
+
+## 0.6.5
+
+### Patch Changes
+
+- Added: collectFeatureTypes, collectOptions
+- Modified: Category, collectRoutes, getRouteHref, entity
+
+## 0.6.4
+
+### Patch Changes
+
+- Added: typeGuards, IPagedResult
+- Modified: IUndecoratedMenuCustom
+
+## 0.6.3
+
+### Patch Changes
+
+- Added: isReservedCollectionDescription
+
+## 0.6.2
+
+### Patch Changes
+
+- Modified: IMedia
+
+## 0.6.1
+
+### Patch Changes
+
+- Added: defaultMarket, defaultLocale
+
+## 0.6.0
+
+### Minor Changes
+
+- Added Logger, IPaginationResult
+
+## 0.5.0
+
+### Minor Changes
+
+- Modified: JsonService, qs
+- Added: asEquatable, cloneItem, typeGuards
+
+## 0.4.1
+
+### Patch Changes
+
+- Added: IAnchor, babelCase
+- Modified: IApplication, IPageRelation
+
+## 0.4.0
+
+### Minor Changes
+
+- Updating: next 13
+
+## 0.3.0
+
+### Minor Changes
+
+- Modified: HttpService
+
+## 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

@@ -66,21 +66,32 @@ type IAnchor = {
 
 type IEquatable = number | string;
 type SchemaType = string;
-type IOption = Record<string, any> & {
-    id: IEquatable;
-    name: string;
-};
 type ISchema = {
     id: IEquatable;
     schema?: string;
 };
-type IEntity = Record<string, unknown> & ISchema;
+type IEntity = ISchema & Record<string, unknown>;
 type INamedEntity = IEntity & {
     name: ILocalizable;
 };
 type ITitledEntity = IEntity & {
     title: ILocalizable;
 };
+type IOption = Record<string, any> & {
+    id: IEquatable;
+    name: string;
+};
+type IFeature = Record<string, any> & {
+    id: IEquatable;
+    title: string;
+};
+type IFeatureType = {
+    id: string;
+    schema?: string;
+    title: string;
+    mode: string;
+    features?: IFeature[];
+};
 
 type IMediaType = 'image' | 'video' | string;
 type IMedia = {
@@ -329,7 +340,7 @@ type IUndecoratedMenuCustom = Omit<IUndecoratedMenuBase, 'type'> & {
     blockType: string;
 };
 type IUndecoratedMenuItem = IUndecoratedMenuCategory | IUndecoratedMenuGroup | IUndecoratedMenuLink | IUndecoratedMenuPage | IUndecoratedMenuCustom;
-type IUndecoratedMenu = {
+type IUndecoratedMenu = IEntity & {
     id: string;
     items: IUndecoratedMenuItem[];
 };
@@ -468,9 +479,9 @@ type ITemplate = {
 };
 
 declare function isCategory(value?: ICategory | IEquatable): value is ICategory;
-declare function asCategoryId(value?: ICategory | IEquatable): string | undefined;
+declare function asCategoryId(value: ICategory | IEquatable): string;
 declare function getRootCategory(categories: ICategory[]): ICategory | undefined;
-declare function getParentCategoriesById(id: string | undefined, categories: ICategory[]): ICategory[];
+declare function getParentCategoriesById(id: string, categories: ICategory[]): ICategory[];
 declare function getCategorySegments(item: ICategorized, categories: ICategory[]): ICategory[];
 declare function getCategorySegmentsByCategory(item: ICategory, categories: ICategory[]): ICategory[];
 
@@ -562,7 +573,9 @@ declare enum RouteStrategy {
     Default = "default",
     Manual = "manual"
 }
-declare function getRouteHref(segments: ICategory[], market: IMarket, locale: ILocale, markets: IMarket[], locales: ILocale[]): string;
+declare function getRouteHref(segments: {
+    slug: ILocalizable;
+}[], market: IMarket, locale: ILocale, markets: IMarket[], locales: ILocale[]): string;
 
 declare function textToSlug(title: string): string;
 
@@ -588,6 +601,10 @@ declare function toSnakeCase(unknownCase: string): string;
 
 declare function cloneItem<T = unknown>(item: T): T;
 
+declare function collectFeatureTypes<T extends IEntity = IEntity>(items: T[], ...keys: string[]): Promise<IFeatureType[]>;
+
+declare function collectOptions<T extends IEntity = IEntity>(items: T[], ...keys: string[]): Promise<Partial<Record<keyof T, IOption[]>>>;
+
 type ListItem<T> = {
     [K in keyof T]: {
         readonly key: string;
@@ -625,4 +642,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 { FetchError, FetchRequestOptions, FetchService, FindParams, FindWhereParams, IAnchor, ICategorized, ICategory, ICategoryItem, IClassName, IClassNameCollection, IClassNameValue, ICollectionDescription, IConfig, IContextBaseParams, IContextParams, IDecoratedNav, 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, IPageRelationResult, IPageResult, IPageUnresolvedRelation, IPagedResult, IPaginationResult, 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, IUndecoratedNav, Json, JsonService, LiteralUnion, Logger, LoggerLevel, NextApiRequestCookies, Operator, PageProps, Pagination, PreviewData, QueryParams, RedirectReason, RouteStrategy, SchemaType, ServerSidePropsContext, StateValue, StaticPropsContext, ValueOf, Where, WhereAndOr, WhereBase, WhereField, asCategoryId, asEquatable, asServerProps, awaitAll, camelToSnakeCase, cloneItem, collectRoutes, consoleWarn, defaultLocale, defaultMarket, eachCategorized, eachMarketLocale, enumToList, getCategorySegments, getCategorySegmentsByCategory, getClassNames, getCollectionDescription, getEnv, getIsDevelopment, getIsProduction, getParentCategoriesById, getRootCategory, getRouteHref, httpDelete, httpFetch, httpGet, httpPatch, httpPost, httpPut, isArray, isBrowser, isCategory, isDevelopment, isEntity, isEquatable, isLocalizedString, isNotNullString, isObject, isProduction, isRelation, isReservedCollectionDescription, isStage, isUndecoratedMenuCategory, isUndecoratedMenuItem, isUndecoratedMenuPage, isUndecoratedNav, isUnresolvedRelation, isValidCollectionDescription, 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 { FetchError, FetchRequestOptions, FetchService, FindParams, FindWhereParams, IAnchor, ICategorized, ICategory, ICategoryItem, IClassName, IClassNameCollection, IClassNameValue, ICollectionDescription, IConfig, IContextBaseParams, IContextParams, IDecoratedNav, IEntity, IEquatable, IFeature, IFeatureType, 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, IPageRelationResult, IPageResult, IPageUnresolvedRelation, IPagedResult, IPaginationResult, 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, IUndecoratedNav, Json, JsonService, LiteralUnion, Logger, LoggerLevel, NextApiRequestCookies, Operator, PageProps, Pagination, PreviewData, QueryParams, RedirectReason, RouteStrategy, SchemaType, ServerSidePropsContext, StateValue, StaticPropsContext, ValueOf, Where, WhereAndOr, WhereBase, WhereField, asCategoryId, asEquatable, asServerProps, awaitAll, camelToSnakeCase, cloneItem, collectFeatureTypes, collectOptions, collectRoutes, consoleWarn, defaultLocale, defaultMarket, eachCategorized, eachMarketLocale, enumToList, getCategorySegments, getCategorySegmentsByCategory, getClassNames, getCollectionDescription, getEnv, getIsDevelopment, getIsProduction, getParentCategoriesById, getRootCategory, getRouteHref, httpDelete, httpFetch, httpGet, httpPatch, httpPost, httpPut, isArray, isBrowser, isCategory, isDevelopment, isEntity, isEquatable, isLocalizedString, isNotNullString, isObject, isProduction, isRelation, isReservedCollectionDescription, isStage, isUndecoratedMenuCategory, isUndecoratedMenuItem, isUndecoratedMenuPage, isUndecoratedNav, isUnresolvedRelation, isValidCollectionDescription, 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 };

package/dist/index.js

@@ -41,6 +41,8 @@ __export(src_exports, {
   awaitAll: () => awaitAll,
   camelToSnakeCase: () => camelToSnakeCase,
   cloneItem: () => cloneItem,
+  collectFeatureTypes: () => collectFeatureTypes,
+  collectOptions: () => collectOptions,
   collectRoutes: () => collectRoutes,
   consoleWarn: () => consoleWarn,
   defaultLocale: () => defaultLocale,
@@ -141,7 +143,7 @@ function getParentCategoriesById(id, categories) {
         const segment = { ...parentCategory };
         segments.unshift(segment);
       }
-      parentId = asCategoryId(parentCategory.category) || null;
+      parentId = parentCategory.category ? asCategoryId(parentCategory.category) : null;
       if (parentId) {
         if (routeCategories.includes(parentId)) {
           console.log("ICategory.getParentCategoriesById", "circular reference found", parentId);
@@ -159,24 +161,11 @@ function getParentCategoriesById(id, categories) {
 function getCategorySegments(item, categories) {
   const categoryId = asCategoryId(item.category);
   const segments = getParentCategoriesById(categoryId, categories);
-  if (item.isDefault !== true) {
-    const category = categories.find((x) => x.id === item.category);
-    if (category) {
-      const segment = {
-        id: item.id,
-        title: item.title,
-        slug: item.slug,
-        media: item.media || category.media,
-        category
-      };
-      segments.push(segment);
-    }
-  }
   return segments;
 }
 function getCategorySegmentsByCategory(item, categories) {
-  const categoryId = asCategoryId(item.category);
-  const segments = getParentCategoriesById(categoryId, categories);
+  const categoryId = item.category ? asCategoryId(item.category) : null;
+  const segments = categoryId ? getParentCategoriesById(categoryId, categories) : [];
   segments.push(item);
   return segments;
 }
@@ -398,6 +387,65 @@ function cloneItem(item) {
   return item;
 }
 
+// src/utils/collectFeatureTypes.ts
+async function collectFeatureTypes(items, ...keys) {
+  const featureTypes = [];
+  if (keys.length > 0) {
+    items.forEach((item) => {
+      keys.forEach((key) => {
+        const value = item[key];
+        if (value) {
+          let featureType = featureTypes.find((x) => x.id === key);
+          if (!featureType) {
+            featureType = {
+              id: key,
+              schema: "featureType",
+              title: key,
+              mode: "or",
+              features: []
+            };
+            featureTypes.push(featureType);
+          }
+          const features = featureType.features;
+          if (features && !features.find((x) => x.id === value)) {
+            features.push({
+              id: value,
+              title: String(value)
+            });
+          }
+        }
+      });
+    });
+  }
+  return featureTypes;
+}
+
+// src/utils/collectOptions.ts
+async function collectOptions(items, ...keys) {
+  const optionsGroup = {};
+  if (keys.length > 0) {
+    items.forEach((item) => {
+      keys.forEach((key) => {
+        const value = item[key];
+        if (value) {
+          let options = optionsGroup[key];
+          if (!options) {
+            options = [];
+            optionsGroup[key] = options;
+          }
+          if (!options.find((x) => x.id === value)) {
+            options.push({
+              id: value,
+              name: String(value)
+            });
+          }
+        }
+      });
+    });
+  }
+  return optionsGroup;
+}
+
 // src/utils/enumToList.ts
 function enumToList(enumeration, separatorRegex = /_/g) {
   const array = Object.keys(enumeration);
@@ -957,10 +1005,14 @@ function collectRoutes(store, categories, markets, locales) {
     const rootCategory = getRootCategory(categories);
     eachCategorized(store, (item, key) => {
       const segments = getCategorySegments(item, categories);
+      const slugs = segments.map((x) => ({ slug: x.slug }));
+      if (!item.isDefault) {
+        slugs.push({ slug: item.slug });
+      }
       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(segments, market, locale, markets2, locales2);
+          const id = getRouteHref(slugs, market, locale, markets2, locales2);
           const route = {
             category: item.category,
             id,
@@ -1108,6 +1160,8 @@ var RedirectReason = /* @__PURE__ */ ((RedirectReason2) => {
   awaitAll,
   camelToSnakeCase,
   cloneItem,
+  collectFeatureTypes,
+  collectOptions,
   collectRoutes,
   consoleWarn,
   defaultLocale,

package/dist/index.mjs

@@ -26,7 +26,7 @@ function getParentCategoriesById(id, categories) {
         const segment = { ...parentCategory };
         segments.unshift(segment);
       }
-      parentId = asCategoryId(parentCategory.category) || null;
+      parentId = parentCategory.category ? asCategoryId(parentCategory.category) : null;
       if (parentId) {
         if (routeCategories.includes(parentId)) {
           console.log("ICategory.getParentCategoriesById", "circular reference found", parentId);
@@ -44,24 +44,11 @@ function getParentCategoriesById(id, categories) {
 function getCategorySegments(item, categories) {
   const categoryId = asCategoryId(item.category);
   const segments = getParentCategoriesById(categoryId, categories);
-  if (item.isDefault !== true) {
-    const category = categories.find((x) => x.id === item.category);
-    if (category) {
-      const segment = {
-        id: item.id,
-        title: item.title,
-        slug: item.slug,
-        media: item.media || category.media,
-        category
-      };
-      segments.push(segment);
-    }
-  }
   return segments;
 }
 function getCategorySegmentsByCategory(item, categories) {
-  const categoryId = asCategoryId(item.category);
-  const segments = getParentCategoriesById(categoryId, categories);
+  const categoryId = item.category ? asCategoryId(item.category) : null;
+  const segments = categoryId ? getParentCategoriesById(categoryId, categories) : [];
   segments.push(item);
   return segments;
 }
@@ -283,6 +270,65 @@ function cloneItem(item) {
   return item;
 }
 
+// src/utils/collectFeatureTypes.ts
+async function collectFeatureTypes(items, ...keys) {
+  const featureTypes = [];
+  if (keys.length > 0) {
+    items.forEach((item) => {
+      keys.forEach((key) => {
+        const value = item[key];
+        if (value) {
+          let featureType = featureTypes.find((x) => x.id === key);
+          if (!featureType) {
+            featureType = {
+              id: key,
+              schema: "featureType",
+              title: key,
+              mode: "or",
+              features: []
+            };
+            featureTypes.push(featureType);
+          }
+          const features = featureType.features;
+          if (features && !features.find((x) => x.id === value)) {
+            features.push({
+              id: value,
+              title: String(value)
+            });
+          }
+        }
+      });
+    });
+  }
+  return featureTypes;
+}
+
+// src/utils/collectOptions.ts
+async function collectOptions(items, ...keys) {
+  const optionsGroup = {};
+  if (keys.length > 0) {
+    items.forEach((item) => {
+      keys.forEach((key) => {
+        const value = item[key];
+        if (value) {
+          let options = optionsGroup[key];
+          if (!options) {
+            options = [];
+            optionsGroup[key] = options;
+          }
+          if (!options.find((x) => x.id === value)) {
+            options.push({
+              id: value,
+              name: String(value)
+            });
+          }
+        }
+      });
+    });
+  }
+  return optionsGroup;
+}
+
 // src/utils/enumToList.ts
 function enumToList(enumeration, separatorRegex = /_/g) {
   const array = Object.keys(enumeration);
@@ -842,10 +888,14 @@ function collectRoutes(store, categories, markets, locales) {
     const rootCategory = getRootCategory(categories);
     eachCategorized(store, (item, key) => {
       const segments = getCategorySegments(item, categories);
+      const slugs = segments.map((x) => ({ slug: x.slug }));
+      if (!item.isDefault) {
+        slugs.push({ slug: item.slug });
+      }
       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(segments, market, locale, markets2, locales2);
+          const id = getRouteHref(slugs, market, locale, markets2, locales2);
           const route = {
             category: item.category,
             id,
@@ -992,6 +1042,8 @@ export {
   awaitAll,
   camelToSnakeCase,
   cloneItem,
+  collectFeatureTypes,
+  collectOptions,
   collectRoutes,
   consoleWarn,
   defaultLocale,

package/package.json

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