@websolutespa/bom-core 1.8.22 → 1.8.24

package/CHANGELOG.md

@@ -1,10 +1,22 @@
 # @websolutespa/bom-core
 
+## 1.8.24
+
+### Patch Changes
+
+- Added: IApp global
+
+## 1.8.23
+
+### Patch Changes
+
+- 0c7f05f: Modified: IRoute isRoot noindex, routeService
+
 ## 1.8.22
 
 ### Patch Changes
 
-- Fixing: JsonService whereItem_ unresolved relations
+- Fixing: JsonService whereItem\_ unresolved relations
 
 ## 1.8.21
 

package/dist/index.d.ts

@@ -132,45 +132,6 @@ type IAnchor = {
     title: string;
 };
 
-type IEquatable = number | string;
-type SchemaType = string;
-type ISchema = {
-    id: IEquatable;
-    schema?: string;
-};
-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 = IEntity & {
-    id: string;
-    title: string;
-    mode: string;
-    features: IFeature[];
-};
-
-type Headings = 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6';
-
-type IComponent = {
-    id?: IEquatable;
-    blockType?: string;
-    schema?: string;
-    anchor?: IAnchor;
-    seoWeight?: Headings;
-    [key: string]: unknown;
-};
-
 type IMediaType = 'image' | 'video' | 'json' | 'pdf' | string;
 type IMediaInfo = {
     id: string;
@@ -227,6 +188,68 @@ declare function isMediaPdf(media: {
 }): media is IMediaPdf;
 declare function isMedia(item: unknown): item is IMedia;
 
+type IAppExtended = Record<string, any>;
+type IApp<T extends IAppExtended = IAppExtended> = {
+    id: 'app';
+    brand: {
+        name: string;
+        businessName?: string;
+        appName?: string;
+        logo?: IMedia;
+        email?: string;
+        telephone?: string;
+        address?: string;
+        city?: string;
+        provinceCode?: string;
+        zipCode?: string;
+        countryCode?: string;
+        twitterName?: string;
+        social: {
+            key: string;
+            url: string;
+        }[];
+    };
+} & T;
+
+type IEquatable = number | string;
+type SchemaType = string;
+type ISchema = {
+    id: IEquatable;
+    schema?: string;
+};
+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 = IEntity & {
+    id: string;
+    title: string;
+    mode: string;
+    features: IFeature[];
+};
+
+type Headings = 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6';
+
+type IComponent = {
+    id?: IEquatable;
+    blockType?: string;
+    schema?: string;
+    anchor?: IAnchor;
+    seoWeight?: Headings;
+    [key: string]: unknown;
+};
+
 type IMeta = {
     title?: string;
     description?: string;
@@ -347,14 +370,16 @@ type IMarket = IEntity & {
 
 type IRoute = {
     category: IEquatable;
-    resolvedCategory: IEquatable;
     id: string;
     isDefault?: boolean;
+    isRoot?: boolean;
     locale: string;
     market: string;
     media?: IMedia;
+    noindex?: boolean;
     order?: number;
     page: IEquatable;
+    resolvedCategory: IEquatable;
     schema: string;
     template?: string;
     title: string;
@@ -550,12 +575,13 @@ type IUndecoratedMenu = IEntity & {
     items: IUndecoratedMenuItem[];
 };
 
-type ILayout = {
+type ILayout<T extends IAppExtended = IAppExtended> = {
     labels: ILabel[];
     locale: string;
     locales: ILocale[];
     market: string;
     markets: IMarket[];
+    app: IPrettify<IApp<T>>;
     menu: Record<string, ILocalizedMenu>;
     topLevelHrefs: Record<string, string>;
     topLevelRoutes: Record<string, IRouteLink>;
@@ -619,11 +645,19 @@ type QueryParams = {
     sort?: string;
     where?: Where;
 };
+type GlobalQueryParams = {
+    depth?: number;
+    draft?: boolean;
+    locale?: string;
+    market?: string;
+    richText?: boolean;
+};
 
 type IPagedResult<T extends IEntity = IEntity> = {
     docs: T[];
 } & Pagination;
 type IQuerable<T extends IEntity = IEntity> = {
+    findGlobal<B extends T = T>(params?: GlobalQueryParams, token?: string): Promise<B | undefined>;
     findOne<B extends T = T>(id: IEquatable, params?: QueryParams, token?: string): Promise<B | undefined>;
     findMany<B extends T = T>(params?: QueryParams, token?: string): Promise<B[]>;
     findPaged<B extends T = T>(params?: QueryParams, token?: string): Promise<IPagedResult<B>>;
@@ -879,6 +913,7 @@ declare class JsonService<T extends IEntity = IEntity> implements IQuerable<T> {
     items: T[];
     constructor(items: T[]);
     getItems<B extends T = T>(): Promise<B[]>;
+    findGlobal<B extends T = T>(params?: GlobalQueryParams): Promise<B | undefined>;
     findOne<B extends T = T>(id: IEquatable, params?: QueryParams): Promise<B | undefined>;
     findMany<B extends T = T>(params?: QueryParams): Promise<B[]>;
     findPaged<B extends T = T>(params?: QueryParams): Promise<IPagedResult<B>>;
@@ -1052,6 +1087,9 @@ declare function getOrigin(headers?: IncomingHttpHeaders | Headers): string;
 
 /**
  * Represents the route strategy options.
+ * - **Auto** dynamically add/remove prefixes based on number of markets & languages.
+ * - **Default** add prefixes based on !isDefault market or language flag.
+ * - **Manual** add prefixes based on !isHidden market or language flag.
  */
 declare enum RouteStrategy {
     Auto = "auto",
@@ -1353,4 +1391,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, Headings, 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, ILocalizedMenu, 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, eachMedia, eachValue, encryptImageToken, enumToList, excludeComponent, findCategoryInCategories, findChildCategories, findRouteOfCategory, findRoutesOfCategory, getCategorySegments, getCategorySegmentsByCategory, getClassNames, getCollectionDescription, getEnv, getHost, getIsDevelopment, getIsProduction, getOrigin, getParentCategoriesById, getParentCategory, getProto, getRootCategory, getRouteHref, groupComponents, hasComponents, hasMarket, httpDelete, httpFetch, httpGet, httpPatch, httpPost, httpPut, isArray, isBrowser, isComponent, isComponentOfType, isDevelopment, isEntity, isEquatable, isHeaders, isIncomingHttpHeaders, isLocalizedString, isMedia, isMediaImage, isMediaJson, isMediaPdf, isMediaVideo, isMenuCategory, isMenuGroup, isMenuHref, isMenuLink, isMenuPage, isMenuRoute, isNonEmptyArray, isNotNullString, isNumber, isObject, isProduction, isPromise, isRelation, isReservedCollectionDescription, isStage, isString, isUndecoratedCategory, isUndecoratedMenuCategory, isUndecoratedMenuItem, isUndecoratedMenuPage, isUndecoratedNav, isUnresolvedCategory, isUnresolvedRelation, isValidCollectionDescription, isValidString, localize, localizeItem, localizeValue, localizedToString, merge, pascalCaseToCamelCase, pascalCaseToCharCase, pascalCaseToKebabCase, pascalCaseToSnakeCase, passwordStrategy, pickComponent, pickHero, prependHero, 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, GlobalQueryParams, Headings, IAction, IActionEmailData, IAnchor, IApp, IAppExtended, 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, ILocalizedMenu, 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, eachMedia, eachValue, encryptImageToken, enumToList, excludeComponent, findCategoryInCategories, findChildCategories, findRouteOfCategory, findRoutesOfCategory, getCategorySegments, getCategorySegmentsByCategory, getClassNames, getCollectionDescription, getEnv, getHost, getIsDevelopment, getIsProduction, getOrigin, getParentCategoriesById, getParentCategory, getProto, getRootCategory, getRouteHref, groupComponents, hasComponents, hasMarket, httpDelete, httpFetch, httpGet, httpPatch, httpPost, httpPut, isArray, isBrowser, isComponent, isComponentOfType, isDevelopment, isEntity, isEquatable, isHeaders, isIncomingHttpHeaders, isLocalizedString, isMedia, isMediaImage, isMediaJson, isMediaPdf, isMediaVideo, isMenuCategory, isMenuGroup, isMenuHref, isMenuLink, isMenuPage, isMenuRoute, isNonEmptyArray, isNotNullString, isNumber, isObject, isProduction, isPromise, isRelation, isReservedCollectionDescription, isStage, isString, isUndecoratedCategory, isUndecoratedMenuCategory, isUndecoratedMenuItem, isUndecoratedMenuPage, isUndecoratedNav, isUnresolvedCategory, isUnresolvedRelation, isValidCollectionDescription, isValidString, localize, localizeItem, localizeValue, localizedToString, merge, pascalCaseToCamelCase, pascalCaseToCharCase, pascalCaseToKebabCase, pascalCaseToSnakeCase, passwordStrategy, pickComponent, pickHero, prependHero, qsDeserialize, qsDeserializeRaw, qsSerialize, qsSerializeRaw, resolveMediaType, stringToBase64, toCamelCase, toCharCase, toDisplayName, toFindParams, toKebabCase, toPascalCase, toPluralName, toSnakeCase, toTitleCase, toValidCollectionName, unknownCaseToPascalCase, uuidv4, withSchema };

package/dist/index.js

@@ -998,6 +998,15 @@ var JsonService = class {
   async getItems() {
     return this.items;
   }
+  async findGlobal(params = {}) {
+    const items = await this.getItems();
+    if (items.length > 0) {
+      return await this.decorateOne_(items[0], params);
+    } else {
+      console.log("JsonService.findGlobal.notfound", params);
+      return void 0;
+    }
+  }
   async findOne(id, params = {}) {
     let items = await this.getItems();
     params.where = params.where || {};
@@ -1681,22 +1690,7 @@ var RouteStrategy = /* @__PURE__ */ ((RouteStrategy2) => {
   RouteStrategy2["Manual"] = "manual";
   return RouteStrategy2;
 })(RouteStrategy || {});
-var ROUTE_STRATEGY = process.env.ROUTE_STRATEGY || "auto" /* Auto */;
-function getPickedProps(item) {
-  const pickedProps = Object.fromEntries(Object.entries(item).filter(([k, v]) => [
-    "category",
-    "isDefault",
-    "media",
-    "order",
-    "template",
-    "updatedAt",
-    "useSplat",
-    // 'createdAt',
-    "updatedAt",
-    "_status"
-  ].includes(k)));
-  return pickedProps;
-}
+var ROUTE_STRATEGY = process.env.ROUTE_STRATEGY || "manual" /* Manual */;
 function collectRoutes(store, categories, markets, locales, medias) {
   const routes = [];
   if (locales.length > 0 && markets.length > 0) {
@@ -1710,31 +1704,57 @@ function collectRoutes(store, categories, markets, locales, medias) {
         if (Boolean(item.isDefault) === false) {
           slugs.push({ slug: item.slug });
         }
-        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 (hasMarket(item, market)) {
             const title = localize(item.title, locale.id);
             const id = getRouteHref(slugs, market, locale, markets2, locales2);
-            const isDefaultRootCategory = isRootCategory && market.id === defaultMarket2.id && locale.id === defaultMarketLocale;
-            const pickedProps = getPickedProps(item);
+            const {
+              _status,
+              category,
+              isDefault,
+              media,
+              order,
+              template,
+              updatedAt,
+              useSplat
+            } = item;
             const route = {
-              ...pickedProps,
-              resolvedCategory: visibleCategory.id,
-              id: isDefaultRootCategory ? "/" : id,
+              _status,
+              category,
+              // id: isDefaultRootCategory ? '/' : id,
+              id,
               locale: locale.id,
               market: market.id,
+              media,
               page: item.id,
+              resolvedCategory: visibleCategory.id,
               schema: key,
-              title
+              template,
+              title,
+              updatedAt
             };
+            if (isDefault) {
+              route.isDefault = true;
+            }
+            if (isRootCategory) {
+              route.isRoot = true;
+            }
+            const noindex = (item.meta?.robots || "").includes("noindex");
+            if (noindex) {
+              route.noindex = true;
+            }
+            if (order != null) {
+              route.order = order;
+            }
+            if (useSplat) {
+              route.useSplat = true;
+            }
             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;
+              const media2 = item.media && medias.find((x) => x.id === mediaId);
+              if (media2) {
+                route.media = media2;
               }
             }
             routes.push(route);

package/dist/index.mjs

@@ -829,6 +829,15 @@ var JsonService = class {
   async getItems() {
     return this.items;
   }
+  async findGlobal(params = {}) {
+    const items = await this.getItems();
+    if (items.length > 0) {
+      return await this.decorateOne_(items[0], params);
+    } else {
+      console.log("JsonService.findGlobal.notfound", params);
+      return void 0;
+    }
+  }
   async findOne(id, params = {}) {
     let items = await this.getItems();
     params.where = params.where || {};
@@ -1512,22 +1521,7 @@ var RouteStrategy = /* @__PURE__ */ ((RouteStrategy2) => {
   RouteStrategy2["Manual"] = "manual";
   return RouteStrategy2;
 })(RouteStrategy || {});
-var ROUTE_STRATEGY = process.env.ROUTE_STRATEGY || "auto" /* Auto */;
-function getPickedProps(item) {
-  const pickedProps = Object.fromEntries(Object.entries(item).filter(([k, v]) => [
-    "category",
-    "isDefault",
-    "media",
-    "order",
-    "template",
-    "updatedAt",
-    "useSplat",
-    // 'createdAt',
-    "updatedAt",
-    "_status"
-  ].includes(k)));
-  return pickedProps;
-}
+var ROUTE_STRATEGY = process.env.ROUTE_STRATEGY || "manual" /* Manual */;
 function collectRoutes(store, categories, markets, locales, medias) {
   const routes = [];
   if (locales.length > 0 && markets.length > 0) {
@@ -1541,31 +1535,57 @@ function collectRoutes(store, categories, markets, locales, medias) {
         if (Boolean(item.isDefault) === false) {
           slugs.push({ slug: item.slug });
         }
-        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 (hasMarket(item, market)) {
             const title = localize(item.title, locale.id);
             const id = getRouteHref(slugs, market, locale, markets2, locales2);
-            const isDefaultRootCategory = isRootCategory && market.id === defaultMarket2.id && locale.id === defaultMarketLocale;
-            const pickedProps = getPickedProps(item);
+            const {
+              _status,
+              category,
+              isDefault,
+              media,
+              order,
+              template,
+              updatedAt,
+              useSplat
+            } = item;
             const route = {
-              ...pickedProps,
-              resolvedCategory: visibleCategory.id,
-              id: isDefaultRootCategory ? "/" : id,
+              _status,
+              category,
+              // id: isDefaultRootCategory ? '/' : id,
+              id,
               locale: locale.id,
               market: market.id,
+              media,
               page: item.id,
+              resolvedCategory: visibleCategory.id,
               schema: key,
-              title
+              template,
+              title,
+              updatedAt
             };
+            if (isDefault) {
+              route.isDefault = true;
+            }
+            if (isRootCategory) {
+              route.isRoot = true;
+            }
+            const noindex = (item.meta?.robots || "").includes("noindex");
+            if (noindex) {
+              route.noindex = true;
+            }
+            if (order != null) {
+              route.order = order;
+            }
+            if (useSplat) {
+              route.useSplat = true;
+            }
             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;
+              const media2 = item.media && medias.find((x) => x.id === mediaId);
+              if (media2) {
+                route.media = media2;
               }
             }
             routes.push(route);

package/package.json

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