@websolutespa/bom-core 1.7.15 → 1.8.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @websolutespa/bom-core
 
+## 1.8.0
+
+### Minor Changes
+
+- f8a1d97: Modified: extracted all website sample components & features
+
+## 1.7.16
+
+### Patch Changes
+
+- Added: MenuCategory strategy
+
 ## 1.7.15
 
 ### Patch Changes

package/dist/index.d.ts

@@ -130,6 +130,7 @@ type IAnchor = {
 
 type IComponent = {
     schema: string;
+    anchor?: IAnchor;
     [key: string]: unknown;
 };
 
@@ -154,12 +155,11 @@ type IFeature = Record<string, any> & {
     id: IEquatable;
     title: string;
 };
-type IFeatureType = {
+type IFeatureType = IEntity & {
     id: string;
-    schema?: string;
     title: string;
     mode: string;
-    features?: IFeature[];
+    features: IFeature[];
 };
 
 type IMediaType = 'image' | 'video' | 'json' | 'pdf' | string;
@@ -348,10 +348,30 @@ type IRouteParams = Record<string, any> & {
     market: string;
 };
 
+/**
+ * Represents a listing item returned from the findMany method of a page collection.
+ * @template T - The type of the categorized item.
+ */
+type IPageItem<T extends ICategorized = ICategorized> = ILocalized<T> & {
+    schema: string;
+    category: ILocalized<ICategory> & {
+        href: string;
+    };
+    href: string;
+    locale: string;
+    market: string;
+};
+/**
+ * Represents a detail item returned from the findOne method of a page collection.
+ * @template T - The type of the categorized item.
+ */
 type IPage<T extends ICategorized = ICategorized> = ILocalized<T> & {
+    schema: string;
     alternates: IRoute[];
     breadcrumb: IRouteLink[];
-    category: ILocalized<ICategory>;
+    category: ILocalized<ICategory> & {
+        href: string;
+    };
     href: string;
     locale: string;
     market: string;
@@ -359,6 +379,10 @@ type IPage<T extends ICategorized = ICategorized> = ILocalized<T> & {
     slug: string;
     title: string;
 };
+/**
+ * Represents the props for a page component.
+ * @template T - The type of the categorized item.
+ */
 type PageProps<T extends ICategorized = ICategorized> = {
     layout: ILayout;
     page: IPage<T>;
@@ -367,13 +391,24 @@ type PageProps<T extends ICategorized = ICategorized> = {
     locale?: string;
     defaultLocale?: string;
 };
+/**
+ * Represents the result of a page relation.
+ * @template T - The type of the categorized item.
+ */
 type IPageRelationResult<T extends ICategorized = ICategorized> = {
     href: string;
 } & T;
+/**
+ * Represents a page relation.
+ * @template T - The type of the categorized item.
+ */
 type IPageRelation<T extends ICategorized = ICategorized> = {
     relationTo: string;
-    value: IPageRelationResult<T>;
+    value: IPageRelationResult<T> | IPageRelationResult<T>[];
 };
+/**
+ * Represents an unresolved page relation.
+ */
 type IPageUnresolvedRelation = {
     relationTo: string;
     value: IEquatable | IEquatable[];
@@ -437,10 +472,15 @@ type IUndecoratedMenuBase = {
     media?: IMedia;
     type: string;
 };
+declare enum MenuCategoryStrategy {
+    Default = "default",// show hidden categories recursively,
+    ExcludeHidden = "exclude-hidden"
+}
 type IUndecoratedMenuCategory = Omit<IUndecoratedMenuBase, 'type'> & {
     type: 'category';
     category: string;
     maxDepth?: number;
+    strategy?: MenuCategoryStrategy;
     title?: ILocalizable;
 };
 type IUndecoratedMenuGroup = Omit<IUndecoratedMenuBase, 'type'> & {
@@ -732,6 +772,17 @@ declare function toValidCollectionName(text: string): string;
 
 declare function consoleWarn(message: string, component?: string): void;
 
+/**
+ * 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 asEntityId(value: undefined): undefined;
+declare function asEntityId(value: string): string;
+declare function asEntityId(value: number): number;
+declare function asEntityId(value: IEntity | IEquatable): string | number;
+declare function asEntityId(value: IEntity | IEquatable | undefined): string | number | undefined;
+
 /**
  * Performs an HTTP fetch request.
  * @param url - The URL to fetch.
@@ -1012,6 +1063,8 @@ declare function getRouteHref(segments: {
     slug: ILocalizable;
 }[], market: IMarket, locale: ILocale, markets: IMarket[], locales: ILocale[]): string;
 
+declare function arrayShuffle<T extends IEntity>(items: T[]): T[];
+
 /**
  * Converts a value to an `IEquatable` or `undefined`.
  * If the value is an `IEntity`, it extracts the `id` property.
@@ -1073,6 +1126,7 @@ 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 collectFeatureTypes__<T extends IEntity = IEntity>(items: T[], ...keys: string[]): Promise<IFeatureType[]>;
 
 /**
  * Collects options from an array of items based on specified keys.
@@ -1224,4 +1278,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, RequireAtLeastOne, 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 };
+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, 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, 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, camelToSnakeCase, cloneItem, collectFeatureTypes, 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 };

package/dist/index.js

@@ -33,9 +33,12 @@ __export(src_exports, {
   JsonService: () => JsonService,
   Logger: () => Logger,
   LoggerLevel: () => LoggerLevel,
+  MenuCategoryStrategy: () => MenuCategoryStrategy,
   RedirectReason: () => RedirectReason,
   RouteStrategy: () => RouteStrategy,
+  arrayShuffle: () => arrayShuffle,
   asCategoryId: () => asCategoryId,
+  asEntityId: () => asEntityId,
   asEquatable: () => asEquatable,
   asEquatableNumber: () => asEquatableNumber,
   asEquatableString: () => asEquatableString,
@@ -45,6 +48,7 @@ __export(src_exports, {
   camelToSnakeCase: () => camelToSnakeCase,
   cloneItem: () => cloneItem,
   collectFeatureTypes: () => collectFeatureTypes,
+  collectFeatureTypes__: () => collectFeatureTypes__,
   collectOptions: () => collectOptions,
   collectRoutes: () => collectRoutes,
   consoleWarn: () => consoleWarn,
@@ -137,6 +141,11 @@ __export(src_exports, {
 });
 module.exports = __toCommonJS(src_exports);
 
+// src/utils/arrayShuffle.ts
+function arrayShuffle(items) {
+  return items.map((item) => ({ item, order: Math.random() })).sort((a, b) => a.order - b.order).map(({ item }) => item);
+}
+
 // src/utils/typeGuards.ts
 function isNumber(item) {
   return typeof item === "number";
@@ -289,6 +298,49 @@ function cloneItem(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] || [];
+        const values = Array.isArray(value) ? value : [value];
+        values.forEach((value2) => {
+          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;
+          const option = isObject(value2) ? {
+            ...value2,
+            title: value2.title || value2.name || value2.label || "Untitled"
+          } : {
+            id: value2,
+            title: String(value2)
+          };
+          if (features && !features.find((x) => x.id === option.id)) {
+            features.push(option);
+          }
+        });
+      });
+    });
+  }
+  featureTypes.forEach((featureType) => {
+    featureType.features.sort((a, b) => {
+      const textA = a.title.toUpperCase();
+      const textB = b.title.toUpperCase();
+      return textA < textB ? -1 : textA > textB ? 1 : 0;
+    });
+  });
+  return featureTypes;
+}
+async function collectFeatureTypes__(items, ...keys) {
   const featureTypes = [];
   if (keys.length > 0) {
     items.forEach((item) => {
@@ -605,6 +657,11 @@ function consoleWarn(message, component) {
   console.warn(log);
 }
 
+// src/entity/entity.ts
+function asEntityId(value) {
+  return isEntity(value) ? value.id : value;
+}
+
 // src/http/http.service.ts
 var defaultOptions = {
   // method: 'POST', // *GET, POST, PUT, DELETE, etc.
@@ -1441,6 +1498,11 @@ function isMediaPdf(media) {
 function isMenuHref(item) {
   return ["category", "link", "page", "route"].includes(item.type);
 }
+var MenuCategoryStrategy = /* @__PURE__ */ ((MenuCategoryStrategy2) => {
+  MenuCategoryStrategy2["Default"] = "default";
+  MenuCategoryStrategy2["ExcludeHidden"] = "exclude-hidden";
+  return MenuCategoryStrategy2;
+})(MenuCategoryStrategy || {});
 
 // src/types/querable.ts
 function toFindParams(idOrParams) {
@@ -1465,9 +1527,12 @@ var RedirectReason = /* @__PURE__ */ ((RedirectReason2) => {
   JsonService,
   Logger,
   LoggerLevel,
+  MenuCategoryStrategy,
   RedirectReason,
   RouteStrategy,
+  arrayShuffle,
   asCategoryId,
+  asEntityId,
   asEquatable,
   asEquatableNumber,
   asEquatableString,
@@ -1477,6 +1542,7 @@ var RedirectReason = /* @__PURE__ */ ((RedirectReason2) => {
   camelToSnakeCase,
   cloneItem,
   collectFeatureTypes,
+  collectFeatureTypes__,
   collectOptions,
   collectRoutes,
   consoleWarn,

package/dist/index.mjs

@@ -1,3 +1,8 @@
+// src/utils/arrayShuffle.ts
+function arrayShuffle(items) {
+  return items.map((item) => ({ item, order: Math.random() })).sort((a, b) => a.order - b.order).map(({ item }) => item);
+}
+
 // src/utils/typeGuards.ts
 function isNumber(item) {
   return typeof item === "number";
@@ -150,6 +155,49 @@ function cloneItem(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] || [];
+        const values = Array.isArray(value) ? value : [value];
+        values.forEach((value2) => {
+          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;
+          const option = isObject(value2) ? {
+            ...value2,
+            title: value2.title || value2.name || value2.label || "Untitled"
+          } : {
+            id: value2,
+            title: String(value2)
+          };
+          if (features && !features.find((x) => x.id === option.id)) {
+            features.push(option);
+          }
+        });
+      });
+    });
+  }
+  featureTypes.forEach((featureType) => {
+    featureType.features.sort((a, b) => {
+      const textA = a.title.toUpperCase();
+      const textB = b.title.toUpperCase();
+      return textA < textB ? -1 : textA > textB ? 1 : 0;
+    });
+  });
+  return featureTypes;
+}
+async function collectFeatureTypes__(items, ...keys) {
   const featureTypes = [];
   if (keys.length > 0) {
     items.forEach((item) => {
@@ -466,6 +514,11 @@ function consoleWarn(message, component) {
   console.warn(log);
 }
 
+// src/entity/entity.ts
+function asEntityId(value) {
+  return isEntity(value) ? value.id : value;
+}
+
 // src/http/http.service.ts
 var defaultOptions = {
   // method: 'POST', // *GET, POST, PUT, DELETE, etc.
@@ -1302,6 +1355,11 @@ function isMediaPdf(media) {
 function isMenuHref(item) {
   return ["category", "link", "page", "route"].includes(item.type);
 }
+var MenuCategoryStrategy = /* @__PURE__ */ ((MenuCategoryStrategy2) => {
+  MenuCategoryStrategy2["Default"] = "default";
+  MenuCategoryStrategy2["ExcludeHidden"] = "exclude-hidden";
+  return MenuCategoryStrategy2;
+})(MenuCategoryStrategy || {});
 
 // src/types/querable.ts
 function toFindParams(idOrParams) {
@@ -1325,9 +1383,12 @@ export {
   JsonService,
   Logger,
   LoggerLevel,
+  MenuCategoryStrategy,
   RedirectReason,
   RouteStrategy,
+  arrayShuffle,
   asCategoryId,
+  asEntityId,
   asEquatable,
   asEquatableNumber,
   asEquatableString,
@@ -1337,6 +1398,7 @@ export {
   camelToSnakeCase,
   cloneItem,
   collectFeatureTypes,
+  collectFeatureTypes__,
   collectOptions,
   collectRoutes,
   consoleWarn,

package/package.json

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