@nascentdigital/funnel-core 6.0.0 → 6.1.0

package/dist/schema/Page.d.ts

@@ -14,7 +14,7 @@ import { Section } from './Section';
 import type { Seo } from './Seo';
 import { Tag } from './Tag';
 import { TagGroup } from './TagGroup';
-export declare class Page<TContent extends Page.Content = Page.Content, TPreview extends Page.PreviewTarget<TContent> = Page.PreviewTarget<TContent>> {
+export declare class Page<TContent extends Page.Content = any, TPreview extends Page.PreviewTarget<TContent> = any> {
     private _type?;
     readonly variant: Page.Variant;
     readonly route: Localized.Maybe<PageRoute>;
@@ -25,13 +25,14 @@ export declare class Page<TContent extends Page.Content = Page.Content, TPreview
     readonly optional: boolean;
     readonly preview?: TPreview;
     readonly content: TContent;
+    readonly navigation: ReadonlyArray<Page.Content.BlockKeys<TContent>>;
     readonly parent?: string;
     private constructor();
     get type(): Page.Type;
     parseTags(tags: Tag.Data[]): Tag[];
     bind(type: Page.Type): void;
-    static static<TContent extends Page.Content, TPreview extends Page.PreviewTarget<TContent>>({ route, ...args }: Page.FactoryArgs.Static<TContent, TPreview>): Page<TContent, TPreview>;
-    static dynamic<TContent extends Page.Content, TPreview extends Page.PreviewTarget<TContent>>(args: Page.FactoryArgs.Dynamic<TContent, TPreview>): Page<TContent, TPreview>;
+    static static<TContent extends Page.Content, TPreview extends Page.PreviewTarget<TContent>>({ route, navigation, ...args }: Page.FactoryArgs.Static<TContent, TPreview>): Page<TContent, TPreview>;
+    static dynamic<TContent extends Page.Content, TPreview extends Page.PreviewTarget<TContent>>({ navigation, ...args }: Page.FactoryArgs.Dynamic<TContent, TPreview>): Page<TContent, TPreview>;
 }
 export declare namespace Page {
     type Content = Record<string, Content.Item>;
@@ -40,12 +41,13 @@ export declare namespace Page {
         type Blocks<TContent extends Content = Content> = {
             [TKey in StringKeyOf<TContent>]: TContent[TKey] extends Block ? TContent[TKey] : never;
         };
+        type BlockKeys<TContent extends Content = Content> = StringKeyOf<Blocks<TContent>>;
     }
     type PreviewTarget<TContent extends Content = Content> = StringKeyOf<Content.Blocks<TContent>>;
-    type DisplayName<TContent extends Content = Content> = DisplayName.For<TContent>;
+    type DisplayName<TContent extends Content = any> = DisplayName.For<TContent>;
     namespace DisplayName {
         type For<TContent extends Content> = {
-            [TKey in StringKeyOf<Content.Blocks<TContent>>]: TContent[TKey] extends Block<infer TId, infer TFields> ? `${TKey}.${keyof Fields.TextLikeFields<TFields>}` : never;
+            [TKey in StringKeyOf<Content.Blocks<TContent>>]: TContent[TKey] extends Block<infer TId, infer TFields> ? StringKeyOf<Fields.TextLikeFields<TFields>> extends string ? `${TKey}.${StringKeyOf<Fields.TextLikeFields<TFields>>}` : never : never;
         }[StringKeyOf<Content.Blocks<TContent>>];
     }
     type Update = Update.Page | Update.BlockCreate | Update.BlockDelete | Update.SectionInsert | Update.SectionDelete | Update.SectionReorder | Update.SectionBlockName | Update.ObjectInsert | Update.ArrayInsert | Update.ArrayDelete | Update.ArrayReorder | Update.Value;
@@ -229,7 +231,7 @@ export declare namespace Page {
             type Prop = Props.Id | Extract<Props.Content, 'preview'> | Props.Links | Props.Audit;
             const props: ReadonlyArray<Prop>;
             function from(data: LegacyData): AsPreview;
-            function filter(data: LegacyData | AsPreview): data is Preview;
+            function filter(data: LegacyData | AsPreview): data is AsPreview;
         }
         type AsContent<TPage extends Page = Page, TRegion extends string = string> = Pick<LegacyData<TPage, TRegion>, AsContent.Prop>;
         namespace AsContent {
@@ -325,6 +327,7 @@ export declare namespace Page {
             optional?: boolean;
             preview?: TPreview;
             content: TContent;
+            navigation: ReadonlyArray<Content.BlockKeys<TContent>>;
         };
         type Static<TContent extends Content = Content, TPreview extends PreviewTarget<TContent> = PreviewTarget<TContent>> = Base<TContent, TPreview> & {
             variant: Extract<Variant, 'static'>;
@@ -341,8 +344,9 @@ export declare namespace Page {
         }
     }
     namespace FactoryArgs {
-        type Base<TContent extends Content, TPreview extends PreviewTarget<TContent>> = Omit<ConstructorArgs.Base<TContent, TPreview>, 'route'> & {
+        type Base<TContent extends Content, TPreview extends PreviewTarget<TContent>> = Omit<ConstructorArgs.Base<TContent, TPreview>, 'route' | 'navigation'> & {
             route: Localized.Maybe<string>;
+            navigation?: Content.BlockKeys<TContent> | ReadonlyArray<Content.BlockKeys<TContent>>;
         };
         export type Static<TContent extends Content, TPreview extends PreviewTarget<TContent>> = Base<TContent, TPreview>;
         export type Dynamic<TContent extends Content, TPreview extends PreviewTarget<TContent>> = Base<TContent, TPreview> & Pick<ConstructorArgs.Dynamic<TContent, TPreview>, 'parent'>;

package/dist/schema/Page.js

@@ -30,6 +30,7 @@ class Page {
         this.optional = (_b = args.optional) !== null && _b !== void 0 ? _b : false;
         this.preview = args.preview;
         this.content = args.content;
+        this.navigation = args.navigation;
         // or dynamic args (basic)
         if (Page.ConstructorArgs.Dynamic.filter(args)) {
             this.parent = args.parent;
@@ -65,10 +66,11 @@ class Page {
         this._type = type;
     }
     static static(_a) {
-        var { route } = _a, args = __rest(_a, ["route"]);
-        return new Page(Object.assign({ variant: 'static', route: route }, args));
+        var { route, navigation = [] } = _a, args = __rest(_a, ["route", "navigation"]);
+        return new Page(Object.assign({ variant: 'static', route: route, navigation: typeof navigation === 'string' ? [navigation] : navigation }, args));
     }
-    static dynamic(args) {
+    static dynamic(_a) {
+        var { navigation = [] } = _a, args = __rest(_a, ["navigation"]);
         return new Page({
             variant: 'dynamic',
             route: args.route,
@@ -76,8 +78,9 @@ class Page {
             name: args.name,
             preview: args.preview,
             content: args.content,
+            navigation: typeof navigation === 'string' ? [navigation] : navigation,
             displayName: args.displayName,
-            parent: args.parent,
+            parent: args.parent
         });
     }
 }

package/dist/schema/Site.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Site = void 0;
+const app_1 = require("../app");
 const errors_1 = require("../errors");
 const utils_1 = require("../utils");
 const field_1 = require("./field");
@@ -11,6 +12,14 @@ class Site {
         // initialize instance variables
         this.regions = args.regions;
         this.collections = args.collections;
+        // blow up if we're mossing a region
+        const { regionalization } = app_1.AppConfig.brandConfig();
+        const expectedRegionIds = new Set(app_1.RegionsConfig.getRegions(regionalization).map(({ id }) => id));
+        const providedRegionIds = new Set(Object.keys(this.regions));
+        const missingRegionIds = expectedRegionIds.difference(providedRegionIds);
+        if (missingRegionIds.size > 0) {
+            throw new errors_1.ArgumentError('Site configuration is missing the following region(s): ' + missingRegionIds.values().toArray().join(', '));
+        }
         // bind pages within each region
         Object.values(this.regions).forEach(region => Object.entries(region).forEach(([pageType, page]) => page.bind(pageType)));
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nascentdigital/funnel-core",
-  "version": "6.0.0",
+  "version": "6.1.0",
   "repository": {
     "url": "git+https://github.com/nascentdigital/funnel.git",
     "directory": "libs/core"
@@ -65,5 +65,5 @@
     "jest-tsd": "^0.2.2",
     "ts-jest": "^29.3.2"
   },
-  "gitHead": "83e335312f91fb90aae73dfc31b3df1ec1895f76"
+  "gitHead": "7b491cfadfcb458bf5882ec8da6c9c5401d61312"
 }