@websolutespa/bom-core 3.0.4 → 4.0.0-next.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @websolutespa/bom-core
 
+## 4.0.0-next.0
+
+### Major Changes
+
+- Next: support of the bom-next app package
+
+## 3.0.5
+
+### Patch Changes
+
+- added: IRoute isProtected
+
 ## 3.0.4
 
 ### Patch Changes

package/dist/index.d.ts

@@ -270,92 +270,6 @@ type IMeta = {
     image?: IMedia;
 };
 
-type ICategory = IEntity & {
-    category?: IEquatable | ICategory;
-    id: IEquatable;
-    media?: IMedia;
-    order?: number;
-    slug: ILocalizable;
-    title: ILocalizable;
-    isHidden?: boolean;
-};
-type ICategoryItem = ICategory & {
-    items: ICategory[];
-};
-type ICategorized = IEntity & {
-    title: ILocalizable;
-    abstract?: string;
-    description?: string;
-    media?: IMedia;
-    meta?: IMeta;
-    components?: IComponent[];
-    category: IEquatable | ICategory;
-    slug: ILocalizable;
-    template?: string;
-    isDefault?: boolean;
-    useSplat?: boolean;
-    order?: number;
-    markets?: string[];
-    createdAt?: Date;
-    updatedAt?: Date;
-    _status?: string;
-};
-
-type IClassNameValue = string | boolean | number | null | undefined;
-type IClassNameCollection = Record<string, IClassNameValue>;
-type IClassName = IClassNameCollection | IClassNameValue;
-
-type IEmailConfig = IEntity & {
-    id: string;
-    subject: string;
-    fromAddress: string;
-    to: [{
-        address: string;
-    }];
-    cc: [{
-        address: string;
-    }];
-    bcc: [{
-        address: string;
-    }];
-};
-
-type FetchRequestOptions = {
-    method?: string;
-    headers?: {
-        [key: string]: string;
-    };
-    body?: Blob | BufferSource | FormData | URLSearchParams | string | ReadableStream;
-    mode?: 'cors' | 'no-cors' | 'same-origin';
-    credentials?: 'omit' | 'same-origin' | 'include';
-    cache?: 'default' | 'no-store' | 'reload' | 'no-cache' | 'force-cache' | 'only-if-cached';
-    redirect?: 'follow' | 'error' | 'manual';
-    referrer?: string;
-    referrerPolicy?: 'no-referrer, no-referrer-when-downgrade, same-origin, origin, strict-origin, origin-when-cross-origin, strict-origin-when-cross-origin, or unsafe-url';
-    integrity?: string;
-    keepalive?: boolean;
-    signal?: AbortSignal;
-};
-type FetchService<T = unknown> = (url: string, options?: FetchRequestOptions, serviceOptions?: any) => Promise<T>;
-type FetchError = any;
-
-declare enum ImageStrategy {
-    None = "none",
-    Next = "next",
-    Mixer = "mixer",
-    Oven = "oven",
-    Token = "token",
-    Custom = "custom"
-}
-type IImageResize = {
-    q: number;
-    w: number;
-    h?: number;
-    x?: number;
-    y?: number;
-    src: string;
-};
-
 type ILabel = IEntity & {
     id: IEquatable;
     text?: ILocalizable;
@@ -380,6 +294,113 @@ type IMarket = IEntity & {
     isHidden?: boolean;
 };
 
+declare enum MenuCategoryStrategy {
+    Default = "default",// show hidden categories recursively,
+    ExcludeHidden = "exclude-hidden",
+    ExcludeRoute = "exclude-route",
+    ExcludeHiddenAndRoute = "exclude-hidden-and-route"
+}
+type IMenuBase = {
+    abstract?: ILocalizable;
+    extra?: ILocalizable;
+    customClass?: string;
+    id: IEquatable;
+    items?: IMenuItem[];
+    media?: IMedia;
+    title: ILocalizable;
+};
+type IMenuCategory = IMenuBase & {
+    type: 'category';
+    href: string;
+    category: IEquatable;
+    customTitle?: ILocalizable;
+};
+type IMenuGroup = IMenuBase & {
+    type: 'group';
+};
+type IMenuLink = IMenuBase & {
+    type: 'link';
+    href: string;
+    target: string;
+};
+type IMenuRoute = IMenuBase & {
+    type: 'route';
+    href: string;
+    page: IEquatable;
+    schema: string;
+};
+type IMenuPage = IMenuBase & {
+    type: 'page';
+    href: string;
+    page: IEquatable;
+    schema: string;
+    customTitle?: ILocalizable;
+};
+type IMenuCustom = Record<string, unknown> & {
+    id: IEquatable;
+    type: string;
+};
+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[];
+};
+type ILocalizedMenu = {
+    id: string;
+    items: ILocalized<IMenuItem>[];
+};
+/**
+ * this is the original menu model from cms
+ */
+type IUndecoratedMenuBase = {
+    abstract?: ILocalizable;
+    extra?: ILocalizable;
+    customClass?: string;
+    id?: string;
+    items: IUndecoratedMenuItem[];
+    markets?: string[];
+    media?: IMedia;
+    type: string;
+};
+type IUndecoratedMenuCategory = Omit<IUndecoratedMenuBase, 'type'> & {
+    type: 'category';
+    category: string;
+    maxDepth?: number;
+    strategy?: MenuCategoryStrategy;
+    title?: ILocalizable;
+};
+type IUndecoratedMenuGroup = Omit<IUndecoratedMenuBase, 'type'> & {
+    type: 'group';
+    title: ILocalizable;
+};
+type IUndecoratedMenuLink = Omit<IUndecoratedMenuBase, 'type'> & {
+    type: 'link';
+    title: ILocalizable;
+    href: string;
+    target?: string;
+};
+type IUndecoratedMenuPage = Omit<IUndecoratedMenuBase, 'type'> & {
+    type: 'page';
+    page: IPageRelation;
+    title?: ILocalizable;
+};
+type IUndecoratedMenuCustom = Omit<IUndecoratedMenuBase, 'type'> & {
+    type: 'custom';
+    blockType: string;
+};
+type IUndecoratedMenuItem = IUndecoratedMenuCategory | IUndecoratedMenuGroup | IUndecoratedMenuLink | IUndecoratedMenuPage | IUndecoratedMenuCustom;
+type IUndecoratedMenu = IEntity & {
+    id: string;
+    items: IUndecoratedMenuItem[];
+};
+
 type IRoute = {
     category: IEquatable;
     id: string;
@@ -391,6 +412,7 @@ type IRoute = {
     title: string;
     _status?: 'published' | 'draft';
     isDefault?: boolean;
+    isProtected?: boolean;
     isRoot?: boolean;
     media?: {
         url: string;
@@ -400,6 +422,7 @@ type IRoute = {
     };
     noindex?: boolean;
     order?: number;
+    publicRedirect?: string;
     template?: string;
     updatedAt?: Date | string;
     useSplat?: boolean;
@@ -422,6 +445,19 @@ type IRouteParams = Record<string, any> & {
     market: string;
 };
 
+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>;
+    tree?: IRouteLink;
+};
+
 /**
  * Represents a listing item returned from the findMany method of a page collection.
  * @template T - The type of the categorized item.
@@ -488,124 +524,92 @@ type IPageUnresolvedRelation = {
     value: IEquatable | IEquatable[];
 };
 
-declare enum MenuCategoryStrategy {
-    Default = "default",// show hidden categories recursively,
-    ExcludeHidden = "exclude-hidden",
-    ExcludeRoute = "exclude-route",
-    ExcludeHiddenAndRoute = "exclude-hidden-and-route"
-}
-type IMenuBase = {
-    abstract?: ILocalizable;
-    extra?: ILocalizable;
-    customClass?: string;
+type ICategory = IEntity & {
+    category?: IEquatable | ICategory;
     id: IEquatable;
-    items?: IMenuItem[];
     media?: IMedia;
+    order?: number;
+    slug: ILocalizable;
     title: ILocalizable;
+    isHidden?: boolean;
 };
-type IMenuCategory = IMenuBase & {
-    type: 'category';
-    href: string;
-    category: IEquatable;
-    customTitle?: ILocalizable;
-};
-type IMenuGroup = IMenuBase & {
-    type: 'group';
-};
-type IMenuLink = IMenuBase & {
-    type: 'link';
-    href: string;
-    target: string;
-};
-type IMenuRoute = IMenuBase & {
-    type: 'route';
-    href: string;
-    page: IEquatable;
-    schema: string;
-};
-type IMenuPage = IMenuBase & {
-    type: 'page';
-    href: string;
-    page: IEquatable;
-    schema: string;
-    customTitle?: ILocalizable;
-};
-type IMenuCustom = Record<string, unknown> & {
-    id: IEquatable;
-    type: string;
-};
-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[];
-};
-type ILocalizedMenu = {
-    id: string;
-    items: ILocalized<IMenuItem>[];
+type ICategoryItem = ICategory & {
+    items: ICategory[];
 };
-/**
- * this is the original menu model from cms
- */
-type IUndecoratedMenuBase = {
-    abstract?: ILocalizable;
-    extra?: ILocalizable;
-    customClass?: string;
-    id?: string;
-    items: IUndecoratedMenuItem[];
+type ICategorized = IEntity & {
+    category: IEquatable | ICategory;
+    slug: ILocalizable;
+    title: ILocalizable;
+    _status?: string;
+    abstract?: string;
+    components?: IComponent[];
+    createdAt?: Date;
+    description?: string;
+    isDefault?: boolean;
+    isProtected?: boolean;
     markets?: string[];
     media?: IMedia;
-    type: string;
-};
-type IUndecoratedMenuCategory = Omit<IUndecoratedMenuBase, 'type'> & {
-    type: 'category';
-    category: string;
-    maxDepth?: number;
-    strategy?: MenuCategoryStrategy;
-    title?: ILocalizable;
-};
-type IUndecoratedMenuGroup = Omit<IUndecoratedMenuBase, 'type'> & {
-    type: 'group';
-    title: ILocalizable;
-};
-type IUndecoratedMenuLink = Omit<IUndecoratedMenuBase, 'type'> & {
-    type: 'link';
-    title: ILocalizable;
-    href: string;
-    target?: string;
-};
-type IUndecoratedMenuPage = Omit<IUndecoratedMenuBase, 'type'> & {
-    type: 'page';
-    page: IPageRelation;
-    title?: ILocalizable;
-};
-type IUndecoratedMenuCustom = Omit<IUndecoratedMenuBase, 'type'> & {
-    type: 'custom';
-    blockType: string;
+    meta?: IMeta;
+    order?: number;
+    publicRedirect?: IEquatable | IEntity | IPageUnresolvedRelation;
+    template?: string;
+    updatedAt?: Date;
+    useSplat?: boolean;
 };
-type IUndecoratedMenuItem = IUndecoratedMenuCategory | IUndecoratedMenuGroup | IUndecoratedMenuLink | IUndecoratedMenuPage | IUndecoratedMenuCustom;
-type IUndecoratedMenu = IEntity & {
+
+type IClassNameValue = string | boolean | number | null | undefined;
+type IClassNameCollection = Record<string, IClassNameValue>;
+type IClassName = IClassNameCollection | IClassNameValue;
+
+type IEmailConfig = IEntity & {
     id: string;
-    items: IUndecoratedMenuItem[];
+    subject: string;
+    fromAddress: string;
+    to: [{
+        address: string;
+    }];
+    cc: [{
+        address: string;
+    }];
+    bcc: [{
+        address: string;
+    }];
 };
 
-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>;
-    tree?: IRouteLink;
+type FetchRequestOptions = {
+    method?: string;
+    headers?: {
+        [key: string]: string;
+    };
+    body?: Blob | BufferSource | FormData | URLSearchParams | string | ReadableStream;
+    mode?: 'cors' | 'no-cors' | 'same-origin';
+    credentials?: 'omit' | 'same-origin' | 'include';
+    cache?: 'default' | 'no-store' | 'reload' | 'no-cache' | 'force-cache' | 'only-if-cached';
+    redirect?: 'follow' | 'error' | 'manual';
+    referrer?: string;
+    referrerPolicy?: 'no-referrer, no-referrer-when-downgrade, same-origin, origin, strict-origin, origin-when-cross-origin, strict-origin-when-cross-origin, or unsafe-url';
+    integrity?: string;
+    keepalive?: boolean;
+    signal?: AbortSignal;
+};
+type FetchService<T = unknown> = (url: string, options?: FetchRequestOptions, serviceOptions?: any) => Promise<T>;
+type FetchError = any;
+
+declare enum ImageStrategy {
+    None = "none",
+    Next = "next",
+    Mixer = "mixer",
+    Oven = "oven",
+    Token = "token",
+    Custom = "custom"
+}
+type IImageResize = {
+    q: number;
+    w: number;
+    h?: number;
+    x?: number;
+    y?: number;
+    src: string;
 };
 
 type IUndecoratedNav = IUndecoratedMenuPage;

package/dist/index.js

@@ -1535,8 +1535,16 @@ var RouteStrategy = /* @__PURE__ */ ((RouteStrategy2) => {
   return RouteStrategy2;
 })(RouteStrategy || {});
 var ROUTE_STRATEGY = process.env.ROUTE_STRATEGY || "manual" /* Manual */;
+function getPublicRedirectId(value) {
+  if (value && typeof value === "object" && "relationTo" in value && "value" in value) {
+    const relationValue = value.value;
+    return Array.isArray(relationValue) ? void 0 : asEntityId(relationValue);
+  }
+  return asEntityId(value);
+}
 function collectRoutes(store, categories, markets, locales, medias) {
   const routes = [];
+  const redirects = /* @__PURE__ */ new Map();
   if (locales.length > 0 && markets.length > 0) {
     const rootCategory = getRootCategory(categories);
     const activeLocales = locales.filter((locale) => locale.isActive !== false);
@@ -1588,6 +1596,7 @@ function collectRoutes(store, categories, markets, locales, medias) {
               isDefault,
               media,
               order,
+              isProtected,
               template,
               updatedAt,
               useSplat
@@ -1609,6 +1618,13 @@ function collectRoutes(store, categories, markets, locales, medias) {
             if (isDefault) {
               route.isDefault = true;
             }
+            if (isProtected) {
+              route.isProtected = true;
+              const publicRedirect = getPublicRedirectId(item.publicRedirect);
+              if (publicRedirect != null) {
+                redirects.set(item.id, publicRedirect);
+              }
+            }
             if (isRootCategory) {
               route.isRoot = true;
             }
@@ -1634,6 +1650,19 @@ function collectRoutes(store, categories, markets, locales, medias) {
         });
       }
     });
+    const routeByPageContext = /* @__PURE__ */ new Map();
+    for (const route of routes) {
+      routeByPageContext.set(JSON.stringify([route.page, route.market, route.locale]), route);
+    }
+    for (const route of routes) {
+      const targetPage = redirects.get(route.page);
+      if (targetPage != null) {
+        const target = routeByPageContext.get(JSON.stringify([targetPage, route.market, route.locale]));
+        if (target) {
+          route.publicRedirect = target.id;
+        }
+      }
+    }
   }
   return routes;
 }
@@ -1716,7 +1745,7 @@ function getRouteHref(segments, market, locale, markets, locales) {
   return `${prefix}${href}`;
 }
 function hasMarket(item, market) {
-  return !item.markets || item.markets.length === 0 || item.markets.includes(market.id);
+  return !item.markets || item.markets.length === 0 || item.markets.map((x) => asEquatable(x)).includes(market.id);
 }
 export {
   ImageStrategy,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@websolutespa/bom-core",
-  "version": "3.0.4",
+  "version": "4.0.0-next.0",
   "description": "Core module of the BOM Repository",
   "keywords": [
     "bom",
@@ -31,7 +31,7 @@
     "@types/pluralize": "0.0.33",
     "@types/react": "19.2.10",
     "@websolutespa/eslint-config": "^3.0.0",
-    "@websolutespa/test": "^3.0.1",
+    "@websolutespa/test": "^4.0.0-next.0",
     "@websolutespa/tsconfig": "^3.0.0",
     "eslint": "9.31.0",
     "npm-run-all": "4.1.5",