@nascentdigital/funnel-core 6.0.1 → 6.1.1

package/dist/schema/Block.d.ts

@@ -1,6 +1,6 @@
 import { StringKeyOf } from 'type-fest';
 import { Transform } from '../types';
-import { BlockLayout } from '../ui/block-layout';
+import type { BlockLayout, PanelLayout, PanelSlot } from '../ui/block-layout';
 import { Field } from './field';
 import { Fields } from './Fields';
 import { Optional } from './Optional';
@@ -16,14 +16,32 @@ export declare class Block<TId extends string = string, TFields extends Fields =
     readonly config: Block.Config.UnwrapOptional<TConfig>;
     readonly getConfig?: Block.GetConfig<TConfig, TFields>;
     readonly getLayout?: Block.GetLayout<TConfig, TFields>;
+    readonly defaultContent?: Block.DefaultContent<TFields>;
+    readonly defaultPanelLayouts?: Block.DefaultPanelLayouts;
+    readonly defaultLayoutConfigs?: Block.DefaultLayoutConfigs<TConfig>;
     private constructor();
     optional(): Optional<Block<TId, TFields, TConfig>>;
     unwrap(): this;
     modify(args: Block.ModifyArgs<TId, TFields, TConfig>): Block<TId, TFields, TConfig>;
+    /**
+     * Rename a block's name which is used in the editor.
+     */
     rename(name: string): Block<TId, TFields, TConfig>;
     hide(...keys: ReadonlyArray<Fields.OptionalKeys<TFields>>): Block<TId, TFields, TConfig>;
     override(override: Fields.Override<TFields>): Block<TId, TFields, TConfig>;
     extend<TAdditionalFields extends Fields>(fields: TAdditionalFields): Block<TId, TFields & TAdditionalFields, TConfig>;
+    /**
+     * Set default content when block gets created.
+     */
+    withContent(defaultContent: Block.DefaultContent<TFields>): Block<TId, TFields, TConfig>;
+    /**
+     * Specify a default layout for a set of active panels.
+     */
+    useLayout(layout: PanelLayout.WithMultiSlots, activePanels: string[] | string): Block<TId, TFields, TConfig>;
+    /**
+     * Specify default configs for a layout.
+     */
+    useConfig(panelLayout: PanelLayout | PanelLayout[], config: Block.Config.Value<TConfig>): Block<TId, TFields, TConfig>;
     static create<TId extends string, TFields extends Fields, TConfig extends Block.Config>(args: Block.FactoryArgs<TId, TFields, TConfig>): Block<TId, TFields, TConfig>;
 }
 export declare namespace Block {
@@ -39,8 +57,8 @@ export declare namespace Block {
     type GetConfig<TConfig extends Config = Config, TFields extends Fields = Fields> = Transform<GetConfig.Args<TConfig, TFields>, GetConfig.Result<TConfig>>;
     namespace GetConfig {
         type Args<TConfig extends Config, TFields extends Fields> = {
+            block: Block<any, TFields, TConfig>;
             config: Partial<Data.ForConfig<Config.UnwrapOptional<TConfig>>>;
-            configSchema: Config.UnwrapOptional<TConfig>;
             fields: Partial<Data.ForFields<TFields>> | Partial<LinkedData.ForFields<TFields>>;
         };
         type Result<TConfig extends Config> = {
@@ -56,11 +74,17 @@ export declare namespace Block {
             fields: Partial<Data.ForFields<TFields>> | Partial<LinkedData.ForFields<TFields>>;
         };
     }
+    type DefaultContent<TFields extends Fields = Fields> = Array<keyof TFields>;
+    type DefaultPanelLayouts = Partial<Record<PanelLayout, Set<PanelSlot>[]>>;
+    type DefaultLayoutConfigs<TConfig extends Config = Config> = Partial<Record<PanelLayout, Config.Value<TConfig>>>;
     type Config = Record<string, Optional.Maybe<Field.Type.Simple.Configuration>>;
     namespace Config {
         type UnwrapOptional<TConfig extends Config> = {
             [key in keyof TConfig]: Optional.InnerType<TConfig[key]>;
         };
+        type Value<TConfig extends Config> = {
+            [key in keyof TConfig]?: Field.Value<Optional.InnerType<TConfig[key]>>;
+        };
     }
     type Data<T extends Block = Block> = {
         type: 'block';
@@ -110,6 +134,9 @@ export declare namespace Block {
         config?: TConfig;
         getConfig?: GetConfig<TConfig, TFields>;
         getLayout?: GetLayout<TConfig, TFields>;
+        defaultContent?: DefaultContent<TFields>;
+        defaultPanelLayouts?: DefaultPanelLayouts;
+        defaultLayoutConfigs?: DefaultLayoutConfigs<TConfig>;
     };
     type ModifyArgs<TId extends string, TFields extends Fields, TConfig extends Config> = Partial<Pick<ConstructorArgs<TId, TFields, TConfig>, 'name' | 'hint' | 'required'>>;
     type FactoryArgs<TId extends string, TFields extends Fields, TConfig extends Config = Config> = Omit<ConstructorArgs<TId, TFields, TConfig>, 'editableFields' | 'required'>;

package/dist/schema/Block.js

@@ -30,6 +30,9 @@ class Block {
             : {};
         this.getConfig = args.getConfig;
         this.getLayout = args.getLayout;
+        this.defaultContent = args.defaultContent;
+        this.defaultPanelLayouts = args.defaultPanelLayouts;
+        this.defaultLayoutConfigs = args.defaultLayoutConfigs;
     }
     optional() {
         return new Optional_1.Optional(this);
@@ -39,8 +42,11 @@ class Block {
     }
     modify(args) {
         // create new block (re-map required fields)
-        return new Block(Object.assign({ id: this.id, name: this.name, hint: this.hint, required: this.required, version: this.version, fields: this.fields, editableFields: this.editableFields, config: this.config, getConfig: this.getConfig, getLayout: this.getLayout }, args));
+        return new Block(Object.assign({ id: this.id, name: this.name, hint: this.hint, required: this.required, version: this.version, fields: this.fields, editableFields: this.editableFields, config: this.config, getConfig: this.getConfig, getLayout: this.getLayout, defaultContent: this.defaultContent, defaultPanelLayouts: this.defaultPanelLayouts, defaultLayoutConfigs: this.defaultLayoutConfigs }, args));
     }
+    /**
+     * Rename a block's name which is used in the editor.
+     */
     rename(name) {
         return this.modify({ name });
     }
@@ -71,7 +77,10 @@ class Block {
             }, Object.assign({}, this.editableFields)),
             config: this.config,
             getConfig: this.getConfig,
-            getLayout: this.getLayout
+            getLayout: this.getLayout,
+            defaultContent: this.defaultContent,
+            defaultPanelLayouts: this.defaultPanelLayouts,
+            defaultLayoutConfigs: this.defaultLayoutConfigs,
         });
     }
     override(override) {
@@ -88,7 +97,10 @@ class Block {
             editableFields: Object.assign(Object.assign({}, this.editableFields), overrides),
             config: this.config,
             getConfig: this.getConfig,
-            getLayout: this.getLayout
+            getLayout: this.getLayout,
+            defaultContent: this.defaultContent,
+            defaultPanelLayouts: this.defaultPanelLayouts,
+            defaultLayoutConfigs: this.defaultLayoutConfigs,
         });
     }
     extend(fields) {
@@ -102,7 +114,82 @@ class Block {
             editableFields: Object.assign(Object.assign({}, this.editableFields), Fields_1.Fields.unwrap(fields)),
             config: this.config,
             getConfig: this.getConfig,
-            getLayout: this.getLayout
+            getLayout: this.getLayout,
+            defaultContent: this.defaultContent,
+            defaultPanelLayouts: this.defaultPanelLayouts,
+            defaultLayoutConfigs: this.defaultLayoutConfigs,
+        });
+    }
+    /**
+     * Set default content when block gets created.
+     */
+    withContent(defaultContent) {
+        return new Block({
+            id: this.id,
+            name: this.name,
+            hint: this.hint,
+            required: this.required,
+            version: this.version,
+            fields: this.fields,
+            editableFields: this.editableFields,
+            config: this.config,
+            getConfig: this.getConfig,
+            getLayout: this.getLayout,
+            defaultContent: defaultContent,
+            defaultPanelLayouts: this.defaultPanelLayouts,
+            defaultLayoutConfigs: this.defaultLayoutConfigs,
+        });
+    }
+    /**
+     * Specify a default layout for a set of active panels.
+     */
+    useLayout(layout, activePanels) {
+        var _a;
+        // update default panel layouts
+        const defaultPanelLayouts = (_a = this.defaultPanelLayouts) !== null && _a !== void 0 ? _a : {};
+        defaultPanelLayouts[layout] = utils_1.ArrayUtils.coerce(activePanels).map(panels => new Set(panels.toUpperCase().split('')));
+        // return new block
+        return new Block({
+            id: this.id,
+            name: this.name,
+            hint: this.hint,
+            required: this.required,
+            version: this.version,
+            fields: this.fields,
+            editableFields: this.editableFields,
+            config: this.config,
+            getConfig: this.getConfig,
+            getLayout: this.getLayout,
+            defaultContent: this.defaultContent,
+            defaultPanelLayouts,
+            defaultLayoutConfigs: this.defaultLayoutConfigs,
+        });
+    }
+    /**
+     * Specify default configs for a layout.
+     */
+    useConfig(panelLayout, config) {
+        var _a;
+        // update default layout configs
+        const defaultLayoutConfigs = (_a = this.defaultLayoutConfigs) !== null && _a !== void 0 ? _a : {};
+        utils_1.ArrayUtils.coerce(panelLayout).forEach(layout => {
+            defaultLayoutConfigs[layout] = config;
+        });
+        // return new block
+        return new Block({
+            id: this.id,
+            name: this.name,
+            hint: this.hint,
+            required: this.required,
+            version: this.version,
+            fields: this.fields,
+            editableFields: this.editableFields,
+            config: this.config,
+            getConfig: this.getConfig,
+            getLayout: this.getLayout,
+            defaultContent: this.defaultContent,
+            defaultPanelLayouts: this.defaultPanelLayouts,
+            defaultLayoutConfigs
         });
     }
     static create(args) {
@@ -116,7 +203,10 @@ class Block {
             editableFields: Fields_1.Fields.unwrap(args.fields),
             config: args.config,
             getConfig: args.getConfig,
-            getLayout: args.getLayout
+            getLayout: args.getLayout,
+            defaultContent: args.defaultContent,
+            defaultPanelLayouts: args.defaultPanelLayouts,
+            defaultLayoutConfigs: args.defaultLayoutConfigs,
         });
     }
 }

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/dist/ui/block-layout/PanelLayout.d.ts

@@ -0,0 +1,4 @@
+export type PanelLayout = 'none' | 'solo' | 'stack.v' | 'stack.h' | 'brick.v' | 'brick.t' | 'brick.r' | 'brick.b' | 'brick.l' | 'nested' | 'nested.h' | 'nested.v' | 'nested.t' | 'nested.r' | 'nested.b' | 'nested.l';
+export declare namespace PanelLayout {
+    type WithMultiSlots = Exclude<PanelLayout, 'solo'>;
+}

package/dist/ui/block-layout/PanelLayout.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/ui/block-layout/PanelSlot.d.ts

@@ -0,0 +1,6 @@
+export type PanelSlot = 'M' | 'V' | 'L';
+export type PanelSlots = {
+    message: boolean;
+    visual: boolean;
+    list: boolean;
+};

package/dist/ui/block-layout/PanelSlot.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/ui/block-layout/index.d.ts

@@ -1 +1,3 @@
 export * from './BlockLayout';
+export * from './PanelLayout';
+export * from './PanelSlot';

package/dist/ui/block-layout/index.js

@@ -15,3 +15,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./BlockLayout"), exports);
+__exportStar(require("./PanelLayout"), exports);
+__exportStar(require("./PanelSlot"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nascentdigital/funnel-core",
-  "version": "6.0.1",
+  "version": "6.1.1",
   "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": "697c3651dedb43a6e6ff373a495cb29c7e7e1fc6"
 }