@borgar/fx 4.3.0 → 4.4.0

package/lib/addTokenMeta.js

@@ -63,8 +63,8 @@ function isEquivalent (refA, refB) {
   }
   // must have same context
   if (
-    !sameStr(refA.context[0], refB.context[0]) ||
-    !sameStr(refA.context[1], refB.context[1])
+    !sameStr(refA.workbookName, refB.workbookName) ||
+    !sameStr(refA.sheetName, refB.sheetName)
   ) {
     return false;
   }
@@ -72,18 +72,11 @@ function isEquivalent (refA, refB) {
 }
 
 function addContext (ref, sheetName, workbookName) {
-  if (!ref.context.length) {
-    ref.context = [ workbookName, sheetName ];
+  if (!ref.sheetName) {
+    ref.sheetName = sheetName;
   }
-  else if (ref.context.length === 1) {
-    const scope = ref.context[0];
-    if (scope === sheetName || scope === workbookName) {
-      ref.context = [ workbookName, sheetName ];
-    }
-    else {
-      // a single scope on a non-named range is going to be a sheet name
-      ref.context = [ workbookName, scope ];
-    }
+  if (!ref.workbookName) {
+    ref.workbookName = workbookName;
   }
   return ref;
 }
@@ -189,8 +182,8 @@ export function addTokenMeta (tokens, { sheetName = '', workbookName = '' } = {}
       token.type === REF_STRUCT
     ) {
       const ref = (token.type === REF_STRUCT)
-        ? parseStructRef(token.value, { allowTernary: true })
-        : parseA1Ref(token.value, { allowTernary: true });
+        ? parseStructRef(token.value, { allowTernary: true, xlsx: true })
+        : parseA1Ref(token.value, { allowTernary: true, xlsx: true });
       if (ref && (ref.range || ref.columns)) {
         ref.source = token.value;
         addContext(ref, sheetName, workbookName);

package/lib/addTokenMeta.spec.js

@@ -3,8 +3,8 @@ import { FX_PREFIX, OPERATOR, NUMBER, REF_RANGE, REF_BEAM, FUNCTION, WHITESPACE,
 import { addTokenMeta } from './addTokenMeta.js';
 import { tokenize } from './lexer.js';
 
-Test.prototype.isMetaTokens = function isTokens (expr, expect, opts) {
-  const actual = addTokenMeta(tokenize(expr), opts);
+Test.prototype.isMetaTokens = function isTokens (expr, expect, context, opts) {
+  const actual = addTokenMeta(tokenize(expr, opts), context);
   if (actual.length === expect.length) {
     actual.forEach((d, i) => {
       const keys = Object.keys(d).concat(Object.keys(expect[i]));
@@ -115,5 +115,27 @@ test('add extra meta to operators', t => {
     { index: 5, depth: 0, type: REF_STRUCT, value: 'table[[#All]]', groupId: 'fxg1' }
   ], { sheetName: 'Sheet1', workbookName: 'foo' });
 
+  t.isMetaTokens('=[foo]!A1+[foo]Sheet1!A1+Sheet1!A1+A1', [
+    { index: 0, depth: 0, type: FX_PREFIX, value: '=' },
+    { index: 1, depth: 0, type: REF_RANGE, value: '[foo]!A1', groupId: 'fxg1' },
+    { index: 2, depth: 0, type: OPERATOR, value: '+' },
+    { index: 3, depth: 0, type: REF_RANGE, value: '[foo]Sheet1!A1', groupId: 'fxg1' },
+    { index: 4, depth: 0, type: OPERATOR, value: '+' },
+    { index: 5, depth: 0, type: REF_RANGE, value: 'Sheet1!A1', groupId: 'fxg1' },
+    { index: 6, depth: 0, type: OPERATOR, value: '+' },
+    { index: 7, depth: 0, type: REF_RANGE, value: 'A1', groupId: 'fxg1' }
+  ], { sheetName: 'Sheet1', workbookName: 'foo' }, { xlsx: true });
+
+  t.isMetaTokens('=[foo]!table[#data]+[foo]Sheet1!table[#data]+Sheet1!table[#data]+table[#data]', [
+    { index: 0, depth: 0, type: FX_PREFIX, value: '=' },
+    { index: 1, depth: 0, type: REF_STRUCT, value: '[foo]!table[#data]', groupId: 'fxg1' },
+    { index: 2, depth: 0, type: OPERATOR, value: '+' },
+    { index: 3, depth: 0, type: REF_STRUCT, value: '[foo]Sheet1!table[#data]', groupId: 'fxg1' },
+    { index: 4, depth: 0, type: OPERATOR, value: '+' },
+    { index: 5, depth: 0, type: REF_STRUCT, value: 'Sheet1!table[#data]', groupId: 'fxg1' },
+    { index: 6, depth: 0, type: OPERATOR, value: '+' },
+    { index: 7, depth: 0, type: REF_STRUCT, value: 'table[#data]', groupId: 'fxg1' }
+  ], { sheetName: 'Sheet1', workbookName: 'foo' }, { xlsx: true });
+
   t.end();
 });

package/lib/parser.js

@@ -493,7 +493,7 @@ prefix('{', function () {
 export function parse (source, options) {
   if (typeof source === 'string') {
     tokens = tokenize(source, {
-      withLocation: true,
+      withLocation: false,
       ...options,
       mergeRefs: true
     });

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@borgar/fx",
-  "version": "4.3.0",
+  "version": "4.4.0",
   "description": "Utilities for working with Excel formulas",
   "main": "dist/fx.js",
+  "types": "dist/fx.d.ts",
   "module": "lib/index.js",
   "exports": {
     ".": {
@@ -15,7 +16,8 @@
     "version": "npm run build",
     "lint": "eslint lib/*.js",
     "test": "tape lib/*.spec.js | tap-min",
-    "build:docs": "echo '# _Fx_ API\n'>docs/API.md; jsdoc -c .jsdoc/config.json -d console lib>>docs/API.md",
+    "build:types": "jsdoc -c tsd.json lib>dist/fx.d.ts",
+    "build:docs": "echo '# _Fx_ API\n'>docs/API.md; jsdoc -t node_modules/@borgar/jsdoc-tsmd -d console lib>>docs/API.md",
     "build": "NODE_ENV=production rollup -c"
   },
   "repository": {
@@ -39,17 +41,19 @@
   "author": "Borgar Þorsteinsson <borgar@borgar.net> (http://borgar.net/)",
   "license": "MIT",
   "devDependencies": {
-    "@babel/core": "~7.21.0",
-    "@babel/eslint-parser": "~7.19.1",
-    "@babel/preset-env": "~7.20.2",
-    "@borgar/eslint-config": "~3.0.0",
+    "@babel/core": "~7.22.17",
+    "@babel/eslint-parser": "~7.22.15",
+    "@babel/preset-env": "~7.22.15",
+    "@borgar/eslint-config": "~3.1.0",
+    "@borgar/jsdoc-tsmd": "~0.1.0",
     "@rollup/plugin-babel": "~6.0.3",
     "babel-eslint": "~10.1.0",
-    "eslint": "~8.34.0",
+    "eslint": "~8.49.0",
     "jsdoc": "~4.0.2",
-    "rollup": "~3.17.2",
+    "rollup": "~3.29.1",
     "rollup-plugin-minification": "~0.2.0",
-    "tap-min": "~2.0.0",
-    "tape": "~5.6.3"
+    "tap-min": "~3.0.0",
+    "typescript": "~5.2.2",
+    "tape": "~5.6.6"
   }
 }

package/tsd.json

@@ -0,0 +1,12 @@
+{
+  "source": {
+    "includePattern": ".+\\.js(doc|x)?$",
+    "excludePattern": "((^|\\/|\\\\)_|spec\\.js$)"
+  },
+  "opts": {
+    "template": "node_modules/@borgar/jsdoc-tsmd",
+    "destination": "console",
+    "output": "typescript",
+    "validate": true
+  }
+}

package/.jsdoc/config.json

@@ -1,17 +0,0 @@
-{
-  "source": {
-    "includePattern": ".+\\.js(doc|x)?$",
-    "excludePattern": "((^|\\/|\\\\)_|spec\\.js$)"
-  },
-  "opts": {
-    "template": "./.jsdoc",
-    "encoding": "utf8",
-    "destination": "./docs/"
-  },
-  "templates": {
-    "default": {
-      "includeDate": false,
-      "outputSourceFiles": false
-    }
-  }
-}

package/.jsdoc/publish.js

@@ -1,217 +0,0 @@
-/* eslint-disable no-undefined, no-console */
-
-function formatType (d, inTable = false) {
-  return d.names?.map(n => `\`${n}\``).join(inTable ? ' \\| ' : ' | ') || '';
-}
-
-function formatArguments (args, showDefaults = true) {
-  let inOpt = false;
-  let r = args.reduce((a, d, i) => {
-    if (d.name.includes('.')) {
-      return a;
-    }
-    if (inOpt && !d.optional) {
-      a += ']_';
-      inOpt = false;
-    }
-    if (i) {
-      a += ', ';
-    }
-    if (!inOpt && d.optional) {
-      a += '_[';
-      inOpt = true;
-    }
-    a += d.name;
-    if (showDefaults && d.defaultvalue) {
-      a += ' = `' + d.defaultvalue + '`';
-    }
-    return a;
-  }, '');
-  if (inOpt) {
-    r += ']_';
-  }
-  return r;
-}
-
-function repValue (v) {
-  if (v === undefined) {
-    return '';
-  }
-  if (v === "''") {
-    // FIXME: should transform all '' strings to "" style
-    v = '""';
-  }
-  return '`' + v + '`';
-}
-
-function repArgName (name, optional = false) {
-  const names = name.split('.');
-  const nPath = names.length > 1 ? '.' + names.slice(1).join('.') : '';
-  return (optional ? '_[' : '') + names[0] + (optional ? ']_' : '') + nPath;
-}
-
-function listToTable (args) {
-  const useDefaults = args.some(d => !!d.defaultvalue);
-  const table = useDefaults
-    ? [
-      '| Name | Type | Default | Description |',
-      '| ---- | ---- | ------- | ----------- |' ]
-    : [
-      '| Name | Type | Description |',
-      '| ---- | ---- | ----------- |' ];
-  args.forEach(d => {
-    const row = [ repArgName(d.name, d.optional) ];
-    row.push(formatType(d.type, true));
-    useDefaults && row.push(repValue(d.defaultvalue));
-    row.push(transformLinks(d.description));
-    table.push('| ' + row.join(' | ') + ' |');
-  });
-
-  return table.join('\n');
-}
-
-function adjustLineBreaks (md) {
-  return md.trim().replace(
-    /(?:```([^\0]*?)```|(\S)\n(?!\n))/g,
-    (a, b, c) => {
-      return (c ? (c + ' ') : a);
-    }
-  );
-}
-
-function formatSee (see) {
-  if (see) {
-    if (/^[a-z][a-z0-9]*$/i.test(see)) {
-      see = `{@link ${see}}`;
-    }
-    return `\n**See also:** ${transformLinks(see)}.\n`;
-  }
-  return '';
-}
-
-const re_links = /(?:\[([^\]]+)\])?\{@link(?:code|plain)? ([^} ]+)([^}]+)?\}/g;
-function transformLinks (md) {
-  return md.replace(re_links, (a, preLabel, href, postLabel) => {
-    const hash = /^[a-z][a-z0-9]*$/i.test(href) ? '#' : '';
-    return `[${preLabel || postLabel || href}](${hash}${href})`;
-  });
-}
-
-function formatHeading (text, level = 2) {
-  return '#'.repeat(level || 1) + ' ' + text;
-}
-
-function formatIndexLink (name, text) {
-  return `[${text.replace(/([[\]])/g, '\\$1')}](#${name})`;
-}
-
-const formatIndex = {
-  function: d => {
-    return '- ' + formatIndexLink(d.name,
-      `${d.name}( ${formatArguments(d.params, false)} )`
-    );
-  },
-  constant: d => {
-    return '- ' + formatIndexLink(d.name,
-      `${d.name}`
-    );
-  }
-}
-
-const format = {
-  function: d => {
-    return [
-      formatHeading(`<a name="${d.name}" href="#${d.name}">#</a> ${d.name}( ${formatArguments(d.params)} ) ⇒ ${formatType(d.returns[0].type)}`, 3),
-      adjustLineBreaks(transformLinks(d.description)),
-      formatSee(d.see),
-      formatHeading('Parameters', 4),
-      listToTable(d.params),
-      formatHeading('Returns', 4),
-      formatType(d.returns[0].type) + ' – ' + d.returns[0].description
-    ];
-  },
-  constant: d => {
-    return [
-      formatHeading(`<a name="${d.name}" href="#${d.name}">#</a> ${d.name} ⇒ ${formatType(d.type)}`, 3),
-      adjustLineBreaks(transformLinks(d.description)),
-      formatSee(d.see),
-      formatHeading('Properties', 4),
-      listToTable(d.properties)
-    ];
-  }
-};
-
-const categoryHeadings = {
-  package: null,
-  function: 'Functions',
-  constant: 'Constants'
-};
-
-exports.publish = (data, { destination }) => {
-  data({ undocumented: true }).remove();
-  const docs = data().get();
-
-  const test = '';
-  if (test) {
-    const s = docs.find(d => d.name === test);
-    const o = format[s.kind](s);
-    console.log(o.join('\n\n'));
-    return;
-  }
-
-  const categories = {};
-  docs.forEach(d => {
-    if (!categories[d.kind]) {
-      categories[d.kind] = [];
-    }
-    categories[d.kind].push(d);
-  });
-
-  let output = [];
-  const index = [];
-
-  Object.keys(categories)
-    .sort()
-    .forEach(kind => {
-      const heading = categoryHeadings[kind];
-      if (heading == null) { return; }
-      // emit category heading
-      if (index.length) { index.push(''); }
-      index.push('**' + heading + '**', '');
-      output.push(formatHeading(heading, 2));
-      // emit all members belonging to that category
-      docs
-        .filter(d => d.kind === kind)
-        .filter(d => d.access !== 'private')
-        .sort((a, b) => {
-          if (a.name < b.name) { return -1; }
-          if (a.name > b.name) { return 1; }
-          return NaN;
-        })
-        .forEach((d, i) => {
-          if (i) {
-            output.push('---');
-          }
-          if (!format[d.kind]) {
-            console.error('Unsupported member type ' + d.kind);
-            process.exit(1);
-          }
-          index.push(formatIndex[d.kind](d));
-          output.push(...format[d.kind](d));
-        });
-    });
-
-  if (destination === 'console') {
-    const outText = (
-      index.map(d => d.trim()).join('\n') +
-      '\n\n' +
-      output.map(d => d.trim()).filter(Boolean).join('\n\n') +
-      '\n'
-    );
-    console.log(outText);
-  }
-  else {
-    console.error('This template only supports output to the console. Use the option "-d console" when you run JSDoc.');
-    process.exit(1);
-  }
-};