@borgar/fx 4.7.0 → 4.7.1

package/dist/fx.d.ts

@@ -111,15 +111,6 @@ export declare function fixRanges(formula: (string | Array<Token>), options?: {
     xlsx?: boolean;
 }): (string | Array<Token>);
 
-/**
- * Parse a simple string reference to an A1 range into a range object.
- * Will accept `A1`, `A2`, `A:A`, or `1:1`.
- *
- * @param rangeString A range string
- * @returns An object representing a valid range or null if it is invalid.
- */
-declare function fromA1(rangeString: string): (RangeA1 | null);
-
 /**
  * Convert a column string representation to a 0 based
  * offset number (`"C"` = `2`).
@@ -132,14 +123,6 @@ declare function fromA1(rangeString: string): (RangeA1 | null);
  */
 export declare function fromCol(columnString: string): number;
 
-/**
- * Parse a simple string reference to an R1C1 range into a range object.
- *
- * @param rangeString A range string
- * @returns An object representing a valid reference or null if it is invalid.
- */
-declare function fromR1C1(rangeString: string): (RangeR1C1 | null);
-
 /**
  * Determines whether the specified token is an error.
  * Returns `true` if the input is a token of type ERROR (`#VALUE!`). In all
@@ -447,14 +430,6 @@ export declare function stringifyStructRef(refObject: ReferenceStruct, options?:
     xlsx?: boolean;
 }): string;
 
-/**
- * Stringify a range object into A1 syntax.
- *
- * @param range A range object
- * @returns An A1-style string represenation of a range
- */
-declare function toA1(range: RangeA1): string;
-
 /**
  * Convert a 0 based offset number to a column string
  * representation (`2` = `"C"`).
@@ -466,14 +441,6 @@ declare function toA1(range: RangeA1): string;
  */
 export declare function toCol(columnIndex: number): string;
 
-/**
- * Stringify a range object into R1C1 syntax.
- *
- * @param range A range object
- * @returns An R1C1-style string represenation of a range
- */
-declare function toR1C1(range: RangeR1C1): string;
-
 /**
  * Breaks a string formula into a list of tokens.
  * The returned output will be an array of objects representing the tokens:

package/docs/API.md

@@ -5,9 +5,7 @@
 - [addA1RangeBounds( range )](#addA1RangeBounds)
 - [addTokenMeta( tokenlist, _\[context\]_ )](#addTokenMeta)
 - [fixRanges( formula, _\[options\]_ )](#fixRanges)
-- [fromA1( rangeString )](#fromA1)
 - [fromCol( columnString )](#fromCol)
-- [fromR1C1( rangeString )](#fromR1C1)
 - [isError( token )](#isError)
 - [isFunction( token )](#isFunction)
 - [isFxPrefix( token )](#isFxPrefix)
@@ -24,9 +22,7 @@
 - [stringifyA1Ref( refObject, _\[options\]_ )](#stringifyA1Ref)
 - [stringifyR1C1Ref( refObject, _\[options\]_ )](#stringifyR1C1Ref)
 - [stringifyStructRef( refObject, _\[options\]_ )](#stringifyStructRef)
-- [toA1( range )](#toA1)
 - [toCol( columnIndex )](#toCol)
-- [toR1C1( range )](#toR1C1)
 - [tokenize( formula, _\[options\]_ )](#tokenize)
 - [translateToA1( formula, anchorCell, _\[options\]_ )](#translateToA1)
 - [translateToR1C1( formula, anchorCell, _\[options\]_ )](#translateToR1C1)
@@ -177,24 +173,6 @@ Returns the same formula with the ranges updated. If an array of tokens was supp
 
 ---
 
-### <a id="fromA1" href="#fromA1">#</a> fromA1( rangeString ) ⇒ [`RangeA1`](#RangeA1) | `null`
-
-Parse a simple string reference to an A1 range into a range object. Will accept `A1`, `A2`, `A:A`, or `1:1`.
-
-**See also:** [parseA1Ref](#parseA1Ref).
-
-##### Parameters
-
-| Name        | Type     | Description    |
-| ----------- | -------- | -------------- |
-| rangeString | `string` | A range string |
-
-##### Returns
-
-[`RangeA1`](#RangeA1) | `null` – An object representing a valid range or null if it is invalid.
-
----
-
 ### <a id="fromCol" href="#fromCol">#</a> fromCol( columnString ) ⇒ `number`
 
 Convert a column string representation to a 0 based offset number (`"C"` = `2`).
@@ -213,24 +191,6 @@ The method expects a valid column identifier made up of _only_ A-Z letters, whic
 
 ---
 
-### <a id="fromR1C1" href="#fromR1C1">#</a> fromR1C1( rangeString ) ⇒ [`RangeR1C1`](#RangeR1C1) | `null`
-
-Parse a simple string reference to an R1C1 range into a range object.
-
-**See also:** [parseA1Ref](#parseA1Ref).
-
-##### Parameters
-
-| Name        | Type     | Description    |
-| ----------- | -------- | -------------- |
-| rangeString | `string` | A range string |
-
-##### Returns
-
-[`RangeR1C1`](#RangeR1C1) | `null` – An object representing a valid reference or null if it is invalid.
-
----
-
 ### <a id="isError" href="#isError">#</a> isError( token ) ⇒ `boolean`
 
 Determines whether the specified token is an error.
@@ -399,7 +359,7 @@ The parser requires `mergeRefs` to have been `true` in tokenlist options, becaus
 
 The AST Abstract Syntax Tree's format is documented in [AST_format.md](./AST_format.md)
 
-**See also:** [nodeTypes](#nodeTypes).
+**See also:**  [nodeTypes](#nodeTypes).
 
 ##### Parameters
 
@@ -626,24 +586,6 @@ stringifyStructRef({
 
 ---
 
-### <a id="toA1" href="#toA1">#</a> toA1( range ) ⇒ `string`
-
-Stringify a range object into A1 syntax.
-
-**See also:** [parseA1Ref](#parseA1Ref).
-
-##### Parameters
-
-| Name  | Type                  | Description    |
-| ----- | --------------------- | -------------- |
-| range | [`RangeA1`](#RangeA1) | A range object |
-
-##### Returns
-
-`string` – An A1-style string represenation of a range
-
----
-
 ### <a id="toCol" href="#toCol">#</a> toCol( columnIndex ) ⇒ `string`
 
 Convert a 0 based offset number to a column string representation (`2` = `"C"`).
@@ -662,24 +604,6 @@ The method expects a number between 0 and 16383. Other input will return garbage
 
 ---
 
-### <a id="toR1C1" href="#toR1C1">#</a> toR1C1( range ) ⇒ `string`
-
-Stringify a range object into R1C1 syntax.
-
-**See also:** [parseR1C1Ref](#parseR1C1Ref).
-
-##### Parameters
-
-| Name  | Type                      | Description    |
-| ----- | ------------------------- | -------------- |
-| range | [`RangeR1C1`](#RangeR1C1) | A range object |
-
-##### Returns
-
-`string` – An R1C1-style string represenation of a range
-
----
-
 ### <a id="tokenize" href="#tokenize">#</a> tokenize( formula, _[options = `{}`]_ ) ⇒ `Array<Token>`
 
 Breaks a string formula into a list of tokens.
@@ -707,7 +631,7 @@ To support syntax highlighting as you type, `STRING` tokens are allowed to be "u
 ]
 ```
 
-**See also:** [tokenTypes](#tokenTypes).
+**See also:**  [tokenTypes](#tokenTypes).
 
 ##### Parameters
 
@@ -802,7 +726,7 @@ translateToR1C1("=SUM(E10,$E$2,Sheet!$E$3)", "D10");
 
 A dictionary of the types used to identify AST node variants.
 
-**See also:** [parse](#parse).
+**See also:**  [parse](#parse).
 
 ##### Properties
 
@@ -823,7 +747,7 @@ A dictionary of the types used to identify AST node variants.
 
 A dictionary of the types used to identify token variants.
 
-**See also:** [tokenize](#tokenize).
+**See also:**  [tokenize](#tokenize).
 
 ##### Properties
 

package/docs/Prefixes.md

@@ -63,7 +63,7 @@ When Excel saves a workbook to one of its XML formats (most commonly as .xlsx) i
 * `[a]!`
 * `[a]b!`
 
-Since the XML files only ever emitted with positive integer indexes instead of workbook names, whether the syntax allows anything else is open. _Fx_ chooses to be permissive in handling this variant and allows `[Workbook.xlsx]!A1` forms as well as `[1]!A1`.
+Since the XML files only ever emitted with positive integer indexes instead of workbook names, whether the syntax allows anything else is speculative. _Fx_ chooses to be permissive in handling this variant and allows `[Workbook.xlsx]!A1` forms as well as `[1]!A1`.
 
 Why the formula language does not use this unambiguous and somewhat more intuitive variant rather than the above form is a question for Excel historians, likely this later form was introduced with the XML format to eliminate the ambiguity?
 

package/lib/a1.js

@@ -84,6 +84,7 @@ export function toAbsolute (range) {
  * Stringify a range object into A1 syntax.
  *
  * @private
+ * @ignore
  * @see parseA1Ref
  * @param {RangeA1} range  A range object
  * @returns {string}  An A1-style string represenation of a range
@@ -161,6 +162,7 @@ function splitA1 (str) {
  * Will accept `A1`, `A2`, `A:A`, or `1:1`.
  *
  * @private
+ * @ignore
  * @see parseA1Ref
  * @param {string} rangeString  A range string
  * @returns {(RangeA1|null)} An object representing a valid range or null if it is invalid.

package/lib/index.spec.js

@@ -0,0 +1,67 @@
+import { test } from 'tape';
+
+import {
+  addA1RangeBounds,
+  addTokenMeta,
+  fixRanges,
+  fromCol,
+  isError,
+  isFunction,
+  isFxPrefix,
+  isLiteral,
+  isOperator,
+  isRange,
+  isReference,
+  isWhitespace,
+  mergeRefTokens,
+  nodeTypes,
+  parse,
+  parseA1Ref,
+  parseR1C1Ref,
+  parseStructRef,
+  stringifyA1Ref,
+  stringifyR1C1Ref,
+  stringifyStructRef,
+  toCol,
+  tokenize,
+  tokenTypes,
+  translateToA1,
+  translateToR1C1
+} from './index.js';
+
+// What happens when B2:A1 -> should work!
+test('fx main interface', t => {
+  t.ok(typeof addA1RangeBounds === 'function', 'addA1RangeBounds exists');
+  t.ok(typeof addTokenMeta === 'function', 'addTokenMeta exists');
+  t.ok(typeof fixRanges === 'function', 'fixRanges exists');
+
+  t.ok(typeof fromCol === 'function', 'fromCol exists');
+
+  t.ok(typeof isError === 'function', 'isError exists');
+  t.ok(typeof isFunction === 'function', 'isFunction exists');
+  t.ok(typeof isFxPrefix === 'function', 'isFxPrefix exists');
+  t.ok(typeof isLiteral === 'function', 'isLiteral exists');
+  t.ok(typeof isOperator === 'function', 'isOperator exists');
+  t.ok(typeof isRange === 'function', 'isRange exists');
+  t.ok(typeof isReference === 'function', 'isReference exists');
+  t.ok(typeof isWhitespace === 'function', 'isWhitespace exists');
+
+  t.ok(typeof mergeRefTokens === 'function', 'mergeRefTokens exists');
+  t.ok(typeof parse === 'function', 'parse exists');
+  t.ok(typeof parseA1Ref === 'function', 'parseA1Ref exists');
+  t.ok(typeof parseR1C1Ref === 'function', 'parseR1C1Ref exists');
+  t.ok(typeof parseStructRef === 'function', 'parseStructRef exists');
+  t.ok(typeof stringifyA1Ref === 'function', 'stringifyA1Ref exists');
+  t.ok(typeof stringifyR1C1Ref === 'function', 'stringifyR1C1Ref exists');
+  t.ok(typeof stringifyStructRef === 'function', 'stringifyStructRef exists');
+  t.ok(typeof toCol === 'function', 'toCol exists');
+  t.ok(typeof tokenize === 'function', 'tokenize exists');
+  t.ok(typeof translateToA1 === 'function', 'translateToA1 exists');
+  t.ok(typeof translateToR1C1 === 'function', 'translateToR1C1 exists');
+
+  t.ok(typeof nodeTypes === 'object', 'nodeTypes exists');
+  t.ok(typeof tokenTypes === 'object', 'tokenTypes exists');
+
+  t.end();
+});
+

package/lib/rc.js

@@ -22,6 +22,7 @@ function toCoord (value, isAbs) {
 /**
  * Stringify a range object into R1C1 syntax.
  *
+ * @ignore
  * @private
  * @see parseR1C1Ref
  * @param {RangeR1C1} range  A range object
@@ -132,6 +133,7 @@ function parseR1C1Part (ref) {
  * Parse a simple string reference to an R1C1 range into a range object.
  *
  * @private
+ * @ignore
  * @see parseA1Ref
  * @param {string} rangeString  A range string
  * @returns {(RangeR1C1|null)} An object representing a valid reference or null if it is invalid.

package/package.json

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