@borgar/fx 4.7.1 → 4.9.0

package/lib/sr.js

@@ -241,9 +241,11 @@ function toSentenceCase (str) {
  * @param {ReferenceStruct} refObject A structured reference object
  * @param {object} [options={}]  Options
  * @param {boolean} [options.xlsx=false]  Switches to the `[1]Sheet1!A1` or `[1]!name` prefix syntax form for external workbooks. See: [Prefixes.md](./Prefixes.md)
+ * @param {boolean} [options.thisRow=false]  Enforces using the `[#This Row]` instead of the `@` shorthand when serializing structured ranges.
  * @returns {string} The structured reference in string format
  */
-export function stringifyStructRef (refObject, { xlsx = false } = {}) {
+export function stringifyStructRef (refObject, options = {}) {
+  const { xlsx, thisRow } = options;
   let s = xlsx
     ? stringifyPrefixAlt(refObject)
     : stringifyPrefix(refObject);
@@ -263,8 +265,8 @@ export function stringifyStructRef (refObject, { xlsx = false } = {}) {
   }
   else {
     s += '[';
-    // single [#this row] sections get normalized to an @
-    const singleAt = numSections === 1 && refObject.sections[0].toLowerCase() === 'this row';
+    // single [#this row] sections get normalized to an @ by default
+    const singleAt = !thisRow && numSections === 1 && refObject.sections[0].toLowerCase() === 'this row';
     if (singleAt) {
       s += '@';
     }

package/lib/sr.spec.js

@@ -278,3 +278,53 @@ test('structured references parse and serialize in xlsx mode', t => {
   t.end();
 });
 
+test.only('longform serialize (in xlsx mode)', t => {
+  // thisRow should have no effect when parsing
+  t.isSREqual('Table2[[#This Row],[col1]]', {
+    table: 'Table2',
+    columns: [ 'col1' ],
+    sections: [ 'this row' ]
+  }, { xlsx: true, thisRow: true });
+
+  t.isSREqual('Table2[[#This Row],[col1]]', {
+    table: 'Table2',
+    columns: [ 'col1' ],
+    sections: [ 'this row' ]
+  }, { xlsx: true, thisRow: false });
+
+  t.isSREqual('Table2[[#This Row],[col1]]', {
+    table: 'Table2',
+    columns: [ 'col1' ],
+    sections: [ 'this row' ]
+  }, { xlsx: false, thisRow: true });
+
+  t.isSREqual('Table2[[#This Row],[col1]]', {
+    table: 'Table2',
+    columns: [ 'col1' ],
+    sections: [ 'this row' ]
+  }, { xlsx: false, thisRow: false });
+
+  // thisRow should mean we don't see @'s in output
+  t.is(
+    stringifyStructRef({
+      table: 'Table2',
+      columns: [ 'col1' ],
+      sections: [ 'this row' ]
+    }, { xlsx: true, thisRow: true }),
+    'Table2[[#This row],[col1]]',
+    'Table2[[#This row],[col1]] (xlsx mode)'
+  );
+
+  t.is(
+    stringifyStructRef({
+      table: 'Table2',
+      columns: [ 'col1' ],
+      sections: [ 'this row' ]
+    }, { xlsx: false, thisRow: true }),
+    'Table2[[#This row],[col1]]',
+    'Table2[[#This row],[col1]] (non xlsx mode)'
+  );
+
+  t.end();
+});
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@borgar/fx",
-  "version": "4.7.1",
+  "version": "4.9.0",
   "description": "Utilities for working with Excel formulas",
   "main": "dist/fx.js",
   "types": "dist/fx.d.ts",