@nascentdigital/funnel-core 4.4.10 → 4.4.14

package/dist/schema/ChangeSet.d.ts

@@ -105,4 +105,10 @@ export declare namespace ChangeSet {
         };
     }
     type ConstructorArgs = Omit<Data, 'errors'>;
+    type AddChangeArgs<TChange extends Change> = {
+        changes: TChange[];
+        change: Omit<TChange, 'attribution'>;
+        userId: string;
+    };
+    function addChange<TChange extends Change>({ changes, change, userId }: AddChangeArgs<TChange>): void;
 }

package/dist/schema/ChangeSet.js

@@ -81,7 +81,7 @@ class ChangeSet {
     }
     addPageChange(userId, change) {
         // apply change
-        addChange({
+        ChangeSet.addChange({
             changes: this._changes,
             change,
             userId
@@ -98,7 +98,7 @@ class ChangeSet {
     }
     addCollectionChange(userId, change) {
         // apply change
-        addChange({
+        ChangeSet.addChange({
             changes: this._changes,
             change,
             userId
@@ -115,7 +115,7 @@ class ChangeSet {
     }
     addAssetChange(userId, change) {
         // apply change
-        addChange({
+        ChangeSet.addChange({
             changes: this._changes,
             change,
             userId
@@ -162,26 +162,27 @@ exports.ChangeSet = ChangeSet;
             New.filter = filter;
         })(New = Data.New || (Data.New = {}));
     })(Data = ChangeSet.Data || (ChangeSet.Data = {}));
-})(ChangeSet || (exports.ChangeSet = ChangeSet = {}));
-function addChange({ changes, change, userId }) {
-    // update existing page
-    const updatedOn = Date.now();
-    const changeIndex = changes.findIndex(({ id }) => change.id === id);
-    if (changeIndex >= 0) {
-        // update attribution (skip if it's the same change by the same user)
-        const _a = changes[changeIndex], { type, attribution } = _a, existingChange = __rest(_a, ["type", "attribution"]);
-        const lastAttribution = attribution.length > 0
-            ? attribution[attribution.length - 1]
-            : undefined;
-        if ((lastAttribution === null || lastAttribution === void 0 ? void 0 : lastAttribution.userId) !== userId || change.type !== type) {
-            attribution.push({ userId, updatedOn });
+    function addChange({ changes, change, userId }) {
+        // update existing page
+        const updatedOn = Date.now();
+        const changeIndex = changes.findIndex(({ id }) => change.id === id);
+        if (changeIndex >= 0) {
+            // update attribution (skip if it's the same change by the same user)
+            const _a = changes[changeIndex], { type, attribution } = _a, existingChange = __rest(_a, ["type", "attribution"]);
+            const lastAttribution = attribution.length > 0
+                ? attribution[attribution.length - 1]
+                : undefined;
+            if ((lastAttribution === null || lastAttribution === void 0 ? void 0 : lastAttribution.userId) !== userId || change.type !== type) {
+                attribution.push({ userId, updatedOn });
+            }
+            // update change
+            changes[changeIndex] = Object.assign(Object.assign(Object.assign({}, existingChange), change), { type,
+                attribution });
+        }
+        // or add a new one
+        else {
+            changes.push(Object.assign(Object.assign({}, change), { attribution: [{ userId, updatedOn }] }));
         }
-        // update change
-        changes[changeIndex] = Object.assign(Object.assign(Object.assign({}, existingChange), change), { type,
-            attribution });
-    }
-    // or add a new one
-    else {
-        changes.push(Object.assign(Object.assign({}, change), { attribution: [{ userId, updatedOn }] }));
     }
-}
+    ChangeSet.addChange = addChange;
+})(ChangeSet || (exports.ChangeSet = ChangeSet = {}));

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

@@ -1,9 +1,24 @@
 export type BlockLayout = {
     name: string;
     root: BlockLayout.Root;
-    fullbleed: boolean;
+    tight?: BlockLayout.Tight;
+    tightMobile?: BlockLayout.Tight;
+    tightDesktop?: BlockLayout.Tight;
 };
 export declare namespace BlockLayout {
+    type Tight = 'above' | 'below' | 'both' | 'none';
+    namespace Tight {
+        const values: ReadonlyArray<Tight>;
+        function parse(value: string, fallback?: Tight): Tight;
+    }
+    type Ratio = '1/1' | '1/2' | '1/3' | '2/1' | '3/1' | '2/3' | '3/2';
+    namespace Ratio {
+        const values: ReadonlyArray<Ratio>;
+        function parse(value: string, fallback?: Ratio): Ratio;
+    }
+    namespace FullBleed {
+        function parse(value: string, fallback?: boolean): boolean;
+    }
     type Root = Row | Column | Stack;
     type Container = Row | Row.Nested | Column | Column.Nested | Stack | Stack.Nested;
     type Row = {
@@ -11,10 +26,14 @@ export declare namespace BlockLayout {
         items: ReadonlyArray<Column.Nested | Stack.Nested | Panel>;
         alignX?: Alignment;
         alignY?: Alignment;
+        ratio?: Ratio;
+        ratioMobile?: Ratio;
+        ratioDesktop?: Ratio;
     };
     namespace Row {
         type Nested = Omit<Row, 'items'> & {
             items: ReadonlyArray<Panel>;
+            mobileOrder?: MobileOrder;
         };
     }
     type Column = {
@@ -26,6 +45,7 @@ export declare namespace BlockLayout {
     namespace Column {
         type Nested = Omit<Column, 'items'> & {
             items: ReadonlyArray<Panel>;
+            mobileOrder?: MobileOrder;
         };
     }
     type Stack = {
@@ -37,6 +57,7 @@ export declare namespace BlockLayout {
     namespace Stack {
         type Nested = Omit<Stack, 'items'> & {
             items: ReadonlyArray<Panel>;
+            mobileOrder?: MobileOrder;
         };
     }
     type NestedItem = Row.Nested | Column.Nested | Stack.Nested | Panel;
@@ -46,18 +67,25 @@ export declare namespace BlockLayout {
         type Base = {
             key: Key;
             mobileOrder?: MobileOrder;
-            alignX: Alignment;
-            alignY: Alignment;
-            size: Size;
+            alignX?: Alignment;
+            alignY?: Alignment;
+            size?: Size;
+            fullBleed?: boolean;
+            fullBleedMobile?: boolean;
+            fullBleedDesktop?: boolean;
         };
     }
     type Message = Panel.Base & {
         type: 'message';
-        textAlign: TextAlignment;
+        textAlign?: TextAlignment;
+        textAlignMobile?: TextAlignment;
+        textAlignDesktop?: TextAlignment;
     };
     type Visual = Panel.Base & {
         type: 'visual';
         aspectRatio: AspectRatio;
+        aspectRatioMobile?: AspectRatio;
+        aspectRatioDesktop?: AspectRatio;
     };
     type List = Panel.Base & {
         type: 'list';

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

@@ -17,6 +17,71 @@ const errors_1 = require("../../errors");
 // extension
 var BlockLayout;
 (function (BlockLayout) {
+    let Tight;
+    (function (Tight) {
+        // values
+        Tight.values = ['above', 'below', 'both', 'none'];
+        // helper
+        function parse(value, fallback) {
+            // return if it's a match
+            if (Tight.values.includes(value)) {
+                return value;
+            }
+            // or fallback if we have one
+            else if (fallback) {
+                return fallback;
+            }
+            // or throw
+            else {
+                throw new errors_1.ArgumentError(`Invalid BlockLayout.Tight "${value}"`, 'value');
+            }
+        }
+        Tight.parse = parse;
+    })(Tight = BlockLayout.Tight || (BlockLayout.Tight = {}));
+    let Ratio;
+    (function (Ratio) {
+        // values
+        Ratio.values = ['1/1', '1/2', '1/3', '2/1', '3/1', '2/3', '3/2'];
+        // helper
+        function parse(value, fallback) {
+            // return if it's a match
+            if (Ratio.values.includes(value)) {
+                return value;
+            }
+            // or fallback if we have one
+            else if (fallback) {
+                return fallback;
+            }
+            // or throw
+            else {
+                throw new errors_1.ArgumentError(`Invalid BlockLayout.Ratio "${value}"`, 'value');
+            }
+        }
+        Ratio.parse = parse;
+    })(Ratio = BlockLayout.Ratio || (BlockLayout.Ratio = {}));
+    let FullBleed;
+    (function (FullBleed) {
+        // helper
+        function parse(value, fallback) {
+            // return true if the string is 'true'
+            if (value === 'true') {
+                return true;
+            }
+            // return false if the string is 'false'
+            else if (value === 'false') {
+                return false;
+            }
+            // or fallback if we have one
+            else if (fallback !== undefined) {
+                return fallback;
+            }
+            // or throw
+            else {
+                throw new errors_1.ArgumentError(`Invalid BlockLayout.FullBleed "${value}"`, 'value');
+            }
+        }
+        FullBleed.parse = parse;
+    })(FullBleed = BlockLayout.FullBleed || (BlockLayout.FullBleed = {}));
     let List;
     (function (List) {
         let ItemType;
@@ -153,28 +218,32 @@ var BlockLayout;
         // parse xml (not sure if this throws on error)
         const blockJson = xmlParser.parse(xml);
         // walk json to create block data
-        return parseeBlock(blockJson[0]);
+        return parseBlock(blockJson[0]);
     }
     BlockLayout.parse = parse;
 })(BlockLayout || (exports.BlockLayout = BlockLayout = {}));
 // helpers
-function parseeBlock(json) {
+function parseBlock(json) {
     // parse block
     const block = ParsedElement.parse({ data: json, expectedTags: ['block'], expectedChildren: 1 });
+    const tight = BlockLayout.Tight.parse(block.attributes['tight'], 'none');
     // return block
     return {
         name: block.attributes['name'],
+        tight,
+        tightMobile: BlockLayout.Tight.parse(block.attributes['tightMobile'], tight),
+        tightDesktop: BlockLayout.Tight.parse(block.attributes['tightDesktop'], tight),
         root: parseRoot(ParsedElement.parse({ data: block.children[0], expectedTags: ['row', 'col', 'stack'] })),
-        fullbleed: block.attributes['fullbleed'] === 'true'
     };
 }
 function parseRoot({ tag, attributes, children }) {
+    const ratio = BlockLayout.Ratio.parse(attributes['ratio'], '1/1');
     // parse attributes
-    const itemAttributes = parseItemAttributes(attributes);
+    const _a = parseItemAttributes(attributes), { size } = _a, itemAttributes = __rest(_a, ["size"]);
     // create root
     switch (tag) {
         case 'row':
-            return Object.assign(Object.assign({ type: 'row' }, itemAttributes), { items: children.map(data => parseNestedItem(ParsedElement.parse({
+            return Object.assign(Object.assign({ type: 'row' }, itemAttributes), { ratio, ratioMobile: BlockLayout.Ratio.parse(attributes['ratioMobile'], ratio), ratioDesktop: BlockLayout.Ratio.parse(attributes['ratioDesktop'], ratio), items: children.map(data => parseNestedItem(ParsedElement.parse({
                     data,
                     expectedTags: ParsedElement.tags.filter(t => t !== tag)
                 }))) });
@@ -195,9 +264,14 @@ function parseRoot({ tag, attributes, children }) {
 function parseNestedItem({ tag, attributes, children }) {
     // parse attributes
     const _a = parseItemAttributes(attributes), { size } = _a, itemAttributes = __rest(_a, ["size"]);
+    const ratio = BlockLayout.Ratio.parse(attributes['ratio'], '1/1');
     // create container
     switch (tag) {
         case 'row':
+            return Object.assign(Object.assign({ type: 'row' }, itemAttributes), { ratio, ratioMobile: BlockLayout.Ratio.parse(attributes['ratioMobile'], ratio), ratioDesktop: BlockLayout.Ratio.parse(attributes['ratioDesktop'], ratio), items: children.map(data => parsePanel(Object.assign({}, ParsedElement.parse({
+                    data,
+                    expectedTags: ParsedElement.tags.filter(t => t !== 'row' && t !== 'col')
+                })))) });
         case 'col':
         case 'stack':
             return Object.assign(Object.assign({ type: tag === 'col' ? 'column' : tag }, itemAttributes), { items: children.map(data => parsePanel(Object.assign({}, ParsedElement.parse({
@@ -212,13 +286,24 @@ function parsePanel({ tag, attributes }) {
     var _a;
     const key = (_a = attributes['key']) !== null && _a !== void 0 ? _a : tag;
     const itemAttributes = parseItemAttributes(attributes);
+    const textAlign = BlockLayout.TextAlignment.parse(attributes['textAlign'], 'left');
+    const aspectRatio = BlockLayout.AspectRatio.parse(attributes['aspect'], 'auto');
+    const fullBleed = BlockLayout.FullBleed.parse(attributes['fullBleed'], false);
+    const fullBleedMobile = BlockLayout.FullBleed.parse(attributes['fullBleedMobile'], fullBleed);
+    const fullBleedDesktop = BlockLayout.FullBleed.parse(attributes['fullBleedDesktop'], fullBleed);
     switch (tag) {
         case 'message':
-            return Object.assign(Object.assign({ type: 'message', key }, itemAttributes), { textAlign: BlockLayout.TextAlignment.parse(attributes['textAlign'], 'left') });
+            return Object.assign(Object.assign({ type: 'message', key }, itemAttributes), { textAlign, textAlignMobile: BlockLayout.TextAlignment.parse(attributes['textAlignMobile'], textAlign), textAlignDesktop: BlockLayout.TextAlignment.parse(attributes['textAlignDesktop'], textAlign), fullBleed,
+                fullBleedMobile,
+                fullBleedDesktop });
         case 'visual':
-            return Object.assign(Object.assign({ type: 'visual', key }, itemAttributes), { aspectRatio: BlockLayout.AspectRatio.parse(attributes['aspect'], 'auto') });
+            return Object.assign(Object.assign({ type: 'visual', key }, itemAttributes), { aspectRatio, aspectRatioMobile: BlockLayout.AspectRatio.parse(attributes['aspectMobile'], aspectRatio), aspectRatioDesktop: BlockLayout.AspectRatio.parse(attributes['aspectDesktop'], aspectRatio), fullBleed,
+                fullBleedMobile,
+                fullBleedDesktop });
         case 'list':
-            return Object.assign(Object.assign({ type: 'list', key }, itemAttributes), { itemType: BlockLayout.List.ItemType.parse(attributes['itemType'], 'message+visual') });
+            return Object.assign(Object.assign({ type: 'list', key }, itemAttributes), { fullBleed,
+                fullBleedMobile,
+                fullBleedDesktop, itemType: BlockLayout.List.ItemType.parse(attributes['itemType'], 'message+visual') });
         default:
             throw new errors_1.ArgumentError(`Invalid XML BlockLayout - encountered "${tag}" where instead of BlockLayout.Panel`);
     }
@@ -226,9 +311,9 @@ function parsePanel({ tag, attributes }) {
 function parseItemAttributes(attributes) {
     return {
         mobileOrder: BlockLayout.MobileOrder.parse(attributes['mobileOrder']),
-        size: BlockLayout.Size.parse(attributes['size'], 'full'),
         alignX: BlockLayout.Alignment.parse(attributes['alignX'], 'start'),
-        alignY: BlockLayout.Alignment.parse(attributes['alignY'], 'start')
+        alignY: BlockLayout.Alignment.parse(attributes['alignY'], 'start'),
+        size: BlockLayout.Size.parse(attributes['size'], 'full'),
     };
 }
 var ParsedElement;

package/dist/ui/fields/Field.d.ts

@@ -11,6 +11,8 @@ export declare class Field<TSchema extends Schema.Field.Type = Schema.Field.Type
     private readonly publishedValue;
     private _initialValue;
     private _value;
+    private _modifiedOn?;
+    private _savingOn?;
     private _editing;
     private _sandboxed;
     private _sandboxedValue;
@@ -48,6 +50,8 @@ export declare class Field<TSchema extends Schema.Field.Type = Schema.Field.Type
     didFocus(): void;
     validate(silent?: boolean): ReadonlyArray<FieldValidator.Error>;
     migrate(previous: Field<TSchema>): void;
+    onSaveStart(): void;
+    onSaveComplete(): void;
     reset(initialValue?: Schema.Field.Data<TSchema> | null): void;
     clone({ schema, eventBus, name, required }?: Field.CloneArgs<TSchema>): Field<TSchema>;
     private raiseEvent;

package/dist/ui/fields/Field.js

@@ -122,6 +122,7 @@ class Field {
         }
         // update value
         this._value = value;
+        this._modifiedOn = Date.now();
         // raise change event
         this.raiseEvent('changed');
         // raise error (if any)
@@ -134,6 +135,7 @@ class Field {
         }
         // update value
         this._value = value;
+        this._modifiedOn = Date.now();
         // raise error (if any)
         this.validate(true);
     }
@@ -189,6 +191,7 @@ class Field {
         }
         // rollback sandbox
         this._value = this._sandboxedValue;
+        this._modifiedOn = Date.now();
         this._sandboxed = false;
         // raise event
         this.raiseEvent('changed');
@@ -244,10 +247,25 @@ class Field {
     }
     migrate(previous) {
         this._value = previous.value;
+        this._modifiedOn = previous._modifiedOn;
         this._editing = true;
         this._sandboxed = previous._sandboxed;
         this._sandboxedValue = previous._sandboxedValue;
     }
+    onSaveStart() {
+        this._savingOn = Date.now();
+    }
+    onSaveComplete() {
+        // reset to initial value if not modified or if save is newer
+        const { _modifiedOn, _savingOn } = this;
+        if (_savingOn && (!_modifiedOn || _savingOn >= _modifiedOn)) {
+            this._initialValue = this._value;
+            delete this._optIn;
+            delete this._optOut;
+        }
+        // clear saving flag
+        delete this._savingOn;
+    }
     reset(initialValue) {
         // reset initial value if it's set
         if (initialValue !== undefined) {

package/dist/ui/fields/FieldList.d.ts

@@ -8,11 +8,13 @@ export declare class FieldList {
     readonly schema: FieldList.ListSchema;
     readonly composition: FieldList.ListComposition;
     private _items;
+    private _modifiedOn?;
+    private _savingOn?;
     readonly id: string;
     readonly name: string;
     readonly required: boolean;
     private readonly eventBus;
-    readonly initialValue: FieldList.ListValue | undefined;
+    private _initialValue;
     readonly publishedValue: FieldList.ListValue | undefined;
     private readonly _validator;
     private _errors;
@@ -20,6 +22,7 @@ export declare class FieldList {
     private _optOut?;
     constructor(args: FieldList.ConstructorArgs);
     get events$(): Observable<FieldList.Event>;
+    get initialValue(): Schema.Field.Data.ForCompositeType<FieldList.ListSchema> | undefined;
     get items(): ReadonlyArray<FieldList.Item>;
     get isNew(): boolean;
     get exists(): boolean;
@@ -45,6 +48,8 @@ export declare class FieldList {
     removeItem(itemId: string): void;
     removeField(field: Field | ObjectField): void;
     moveItem(fromIndex: number, toIndex: number): void;
+    onSaveStart(): void;
+    onSaveComplete(): void;
     reset(initialValue?: FieldList.ListValue | null): void;
     clone(): FieldList;
     private raiseEvent;

package/dist/ui/fields/FieldList.js

@@ -70,7 +70,7 @@ class FieldList {
         this.id = args.id;
         this.name = args.name;
         this.required = args.required;
-        this.initialValue = args.initialValue;
+        this._initialValue = args.initialValue;
         this.publishedValue = args.publishedValue;
         this._validator = new FieldListValidator_1.FieldListValidator(this.schema);
         // validate
@@ -79,6 +79,9 @@ class FieldList {
     get events$() {
         return this.eventBus.events$.pipe((0, rxjs_1.filter)(FieldList.Event.filter), (0, rxjs_1.filter)(e => e.field === this));
     }
+    get initialValue() {
+        return this._initialValue;
+    }
     get items() {
         return this._items;
     }
@@ -127,6 +130,7 @@ class FieldList {
             value,
             publishedValue
         });
+        this._modifiedOn = Date.now();
         // revalidate
         this.validate();
         // raise event
@@ -221,6 +225,7 @@ class FieldList {
         };
         // add to list
         this._items = [...this._items, item];
+        this._modifiedOn = Date.now();
         // revalidate
         this.validate();
         // raise event
@@ -234,6 +239,8 @@ class FieldList {
         this._items = this._items.filter(({ id }) => !itemIds.includes(id));
         // raise event (if there are changes)
         if (this._items.length !== itemCount) {
+            // update modified
+            this._modifiedOn = Date.now();
             // revalidate
             this.validate();
             // raise change
@@ -268,11 +275,26 @@ class FieldList {
         items.splice(toIndex, 0, item);
         // update items
         this._items = items;
+        this._modifiedOn = Date.now();
         // revalidate
         this.validate();
         // raise change
         this.raiseEvent('changed');
     }
+    onSaveStart() {
+        this._savingOn = Date.now();
+    }
+    onSaveComplete() {
+        // reset to initial value if not modified or if save is newer
+        const { _modifiedOn, _savingOn } = this;
+        if (_savingOn && (!_modifiedOn || _savingOn >= _modifiedOn)) {
+            this._initialValue = this.value;
+            delete this._optIn;
+            delete this._optOut;
+        }
+        // clear saving flag
+        delete this._savingOn;
+    }
     reset(initialValue) {
         // re-bind new initial values
         if (initialValue || initialValue === null) {
@@ -287,6 +309,8 @@ class FieldList {
         else {
             this._items.forEach(({ field }) => field.reset());
         }
+        // mark modified
+        this._modifiedOn = Date.now();
         // revalidate
         this.validate();
         // raise final change

package/dist/ui/fields/ObjectField.d.ts

@@ -15,6 +15,8 @@ export declare class ObjectField {
     private readonly _content;
     private readonly _fields;
     private _initialValue;
+    private _modifiedOn?;
+    private _savingOn?;
     private _optIn?;
     private _optOut?;
     constructor(args: ObjectField.ConstructorArgs);
@@ -40,6 +42,8 @@ export declare class ObjectField {
     get shouldFocus(): boolean;
     didFocus(): boolean;
     getString(key: string | undefined): string | undefined;
+    onSaveStart(): void;
+    onSaveComplete(): void;
     reset(initialValue?: ObjectField.Value | null): void;
     clone(): ObjectField;
     private raiseEvent;

package/dist/ui/fields/ObjectField.js

@@ -93,6 +93,8 @@ class ObjectField {
                 field.value = values[key];
             }
         });
+        // mark modified
+        this._modifiedOn = Date.now();
     }
     get modified() {
         // modified if opted in/our
@@ -179,9 +181,25 @@ class ObjectField {
                 return undefined;
         }
     }
+    onSaveStart() {
+        this._savingOn = Date.now();
+    }
+    onSaveComplete() {
+        // reset to initial value if not modified or if save is newer
+        const { _modifiedOn, _savingOn } = this;
+        if (_savingOn && (!_modifiedOn || _savingOn >= _modifiedOn)) {
+            this._initialValue = this.value;
+            delete this._optIn;
+            delete this._optOut;
+        }
+        // clear saving flag
+        delete this._savingOn;
+    }
     reset(initialValue) {
         var _a;
+        // reset fields using specified value
         if (initialValue !== undefined) {
+            // update initial value
             this._initialValue = initialValue !== null && initialValue !== void 0 ? initialValue : undefined;
             // re-bind new initial values
             const values = (_a = initialValue === null || initialValue === void 0 ? void 0 : initialValue.value) !== null && _a !== void 0 ? _a : {};
@@ -198,10 +216,12 @@ class ObjectField {
                 }
             });
         }
-        //  reset each field if there's no initial value
+        // or reset each field if there's no initial value
         else {
             this._fields.forEach(field => field.reset());
         }
+        // track modified
+        this._modifiedOn = Date.now();
         // raise final change
         this.raiseEvent('changed');
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nascentdigital/funnel-core",
-  "version": "4.4.10",
+  "version": "4.4.14",
   "repository": {
     "url": "git+https://github.com/nascentdigital/funnel.git",
     "directory": "libs/core"
@@ -63,5 +63,5 @@
     "jest-tsd": "^0.2.2",
     "ts-jest": "^29.3.2"
   },
-  "gitHead": "3aa36fa46c32ad625f569ea4b9e43aab80937ff4"
+  "gitHead": "242a9e0979c03d4037eb2462c5b01b2a095e8e8f"
 }