@nascentdigital/funnel-core 4.4.13 → 4.4.14

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nascentdigital/funnel-core",
-  "version": "4.4.13",
+  "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": "af6ff70daf556e824442ce09959ecff07b43c47c"
+  "gitHead": "242a9e0979c03d4037eb2462c5b01b2a095e8e8f"
 }