@borgar/fx 4.13.0 → 5.0.0

package/dist/xlsx/index.d.ts

@@ -0,0 +1,55 @@
+import { T as Token, a as TokenEnhanced } from '../index-BMr6cTgc.js';
+export { an as ArrayExpression, ar as AstExpression, ak as BinaryExpression, al as BinaryOperator, am as CallExpression, ah as ErrorLiteral, ae as Identifier, ao as LambdaExpression, aq as LetDeclarator, ap as LetExpression, ag as Literal, M as MAX_COLS, r as MAX_ROWS, ad as Node, v as OptsFixRanges, i as OptsParse, X as OptsParseA1Ref, Z as OptsParseR1C1Ref, _ as OptsStringifyStructRef, O as OptsTokenize, n as OptsTranslateFormulaToA1, l as OptsTranslateToR1C1, q as OptsTranslateTokensToA1, a0 as RangeA1, a1 as RangeR1C1, a2 as ReferenceA1, a3 as ReferenceA1Xlsx, af as ReferenceIdentifier, a8 as ReferenceName, a9 as ReferenceNameXlsx, a4 as ReferenceR1C1, a5 as ReferenceR1C1Xlsx, a6 as ReferenceStruct, a7 as ReferenceStructXlsx, ac as SourceLocation, ai as UnaryExpression, aj as UnaryOperator, S as addA1RangeBounds, b as fixFormulaRanges, f as fixTokenRanges, V as fromCol, E as isArrayNode, F as isBinaryNode, G as isCallNode, w as isError, H as isErrorNode, I as isExpressionNode, x as isFunction, y as isFxPrefix, J as isIdentifierNode, K as isLambdaNode, L as isLetDeclaratorNode, N as isLetNode, z as isLiteral, P as isLiteralNode, A as isOperator, B as isRange, C as isReference, Q as isReferenceNode, R as isUnaryNode, D as isWhitespace, u as mergeRefTokens, ab as nodeTypes, h as parse, W as parseA1Range, p as parseA1Ref, Y as parseR1C1Range, c as parseR1C1Ref, d as parseStructRef, s as stringifyA1Ref, e as stringifyR1C1Ref, g as stringifyStructRef, $ as stringifyTokens, U as toCol, aa as tokenTypes, t as tokenize, m as translateFormulaToA1, j as translateFormulaToR1C1, o as translateTokensToA1, k as translateTokensToR1C1 } from '../index-BMr6cTgc.js';
+
+/**
+ * Runs through a list of tokens and adds extra attributes such as matching
+ * parens and ranges.
+ *
+ * The `context` parameter defines default reference attributes:
+ * `{ workbookName: 'report.xlsx', sheetName: 'Sheet1' }`.
+ * If supplied, these are used to match `A1` to `Sheet1!A1`.
+ *
+ * All tokens will be tagged with a `.depth` number value to indicating the
+ * level of nesting in parentheses as well as an `.index` number indicating
+ * their zero based position in the list.
+ *
+ * The returned output will be the same array of tokens but the following
+ * properties will added to tokens (as applicable):
+ *
+ * #### Parentheses ( )
+ *
+ * Matching parens will be tagged with `.groupId` string identifier as well as
+ * a `.depth` number value (indicating the level of nesting).
+ *
+ * Closing parens without a counterpart will be tagged with `.error`
+ * (boolean true).
+ *
+ * #### Curly brackets { }
+ *
+ * Matching curly brackets will be tagged with `.groupId` string identifier.
+ * These may not be nested in Excel.
+ *
+ * Closing curly brackets without a counterpart will be tagged with `.error`
+ * (boolean `true`).
+ *
+ * #### Ranges (`REF_RANGE` or `REF_BEAM` type tokens)
+ *
+ * All ranges will be tagged with `.groupId` string identifier regardless of
+ * the number of times they occur.
+ *
+ * #### Tokens of type `UNKNOWN`
+ *
+ * All will be tagged with `.error` (boolean `true`).
+ *
+ * @param tokenlist An array of tokens (from `tokenize()`)
+ * @param [context={}] A contest used to match `A1` to `Sheet1!A1`.
+ * @param [context.sheetName=''] An implied sheet name ('Sheet1')
+ * @param [context.workbookName=''] An implied workbook name ('report.xlsx')
+ * @returns The input array with the enchanced tokens
+ */
+declare function addTokenMeta(tokenlist: Token[], { sheetName, workbookName }?: {
+    sheetName?: string;
+    workbookName?: string;
+}): TokenEnhanced[];
+
+export { Token, TokenEnhanced, addTokenMeta };