@nascentdigital/funnel-core 6.1.0 → 6.1.2

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/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/dist/ui/fields/Field.d.ts

@@ -8,6 +8,7 @@ export declare class Field<TSchema extends Schema.Field.Type = Schema.Field.Type
     readonly id: string;
     readonly name: string;
     readonly required: boolean;
+    readonly tags: ReadonlySet<string>;
     private readonly publishedValue;
     private _initialValue;
     private _value;
@@ -75,6 +76,7 @@ export declare namespace Field {
         initialValue?: Value<TSchema>;
         required: boolean;
         customValidator?: FieldValidator;
+        tags?: string[] | string;
     };
     type Value<TSchema extends Schema.Field.Type = Schema.Field.Type> = Schema.Field.Data<TSchema>;
     interface Event extends EventBus.Event<'Field', Event.Type> {
@@ -85,4 +87,7 @@ export declare namespace Field {
         function filter(event: EventBus.Event): event is Event;
         function create(event: EventBus.Args<Event>): Event;
     }
+    const Tag: {
+        readonly config: "config";
+    };
 }

package/dist/ui/fields/Field.js

@@ -51,6 +51,7 @@ class Field {
         this.name = args.name;
         this.required = args.required;
         this.publishedValue = args.publishedValue;
+        this.tags = new Set(utils_1.ArrayUtils.coerce(args.tags));
         this._initialValue = (_a = args.initialValue) !== null && _a !== void 0 ? _a : this.defaultValue;
         this._value = this._initialValue;
         this._editing = false;
@@ -343,4 +344,8 @@ exports.Field = Field;
         }
         Event.create = create;
     })(Event = Field.Event || (Field.Event = {}));
+    // tags
+    Field.Tag = {
+        config: 'config'
+    };
 })(Field || (exports.Field = Field = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nascentdigital/funnel-core",
-  "version": "6.1.0",
+  "version": "6.1.2",
   "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": "7b491cfadfcb458bf5882ec8da6c9c5401d61312"
+  "gitHead": "d72a93d505884f030d595ecf66c64351ebfc8ed1"
 }