More advanced custom function tutorial

src/ArraySize.ts

@@ -8,7 +8,7 @@ import {SimpleCellAddress} from './Cell'
 import {Config} from './Config'
 import {FunctionRegistry} from './interpreter/FunctionRegistry'
 import {InterpreterState} from './interpreter/InterpreterState'
-import {ArgumentTypes} from './interpreter/plugin/FunctionPlugin'
+import {FunctionArgumentType} from './interpreter/plugin/FunctionPlugin'
 import {Ast, AstNodeType, ProcedureAst} from './parser'
 
 export class ArraySize {
@@ -156,7 +156,7 @@ export class ArraySizePredictor {
     let maxWidth = 1
     let maxHeight = 1
     for (let i = 0; i < subChecks.length; i++) {
-      if (argumentDefinitions[i].argumentType !== ArgumentTypes.RANGE && argumentDefinitions[i].argumentType !== ArgumentTypes.ANY) {
+      if (argumentDefinitions[i].argumentType !== FunctionArgumentType.RANGE && argumentDefinitions[i].argumentType !== FunctionArgumentType.ANY) {
         maxHeight = Math.max(maxHeight, subChecks[i].height)
         maxWidth = Math.max(maxWidth, subChecks[i].width)
       }

src/ArrayValue.ts

@@ -6,7 +6,7 @@
 import {ArraySize} from './ArraySize'
 import {CellError} from './Cell'
 import {EmptyValue, InternalScalarValue, InterpreterValue} from './interpreter/InterpreterValue'
-import {SimpleRangeValue} from './interpreter/SimpleRangeValue'
+import {SimpleRangeValue} from './SimpleRangeValue'
 
 export interface IArray {
   size: ArraySize,

src/Cell.ts

@@ -14,7 +14,7 @@ import {
   isExtendedNumber,
   NumberType,
 } from './interpreter/InterpreterValue'
-import {SimpleRangeValue} from './interpreter/SimpleRangeValue'
+import {SimpleRangeValue} from './SimpleRangeValue'
 import {Maybe} from './Maybe'
 import {CellAddress} from './parser'
 import {AddressWithSheet} from './parser/Address'

src/ContentChanges.ts

@@ -5,7 +5,7 @@
 
 import {addressKey, SimpleCellAddress} from './Cell'
 import {InterpreterValue} from './interpreter/InterpreterValue'
-import {SimpleRangeValue} from './interpreter/SimpleRangeValue'
+import {SimpleRangeValue} from './SimpleRangeValue'
 
 export interface CellValueChange {
   address: SimpleCellAddress,

src/DependencyGraph/DependencyGraph.ts

@@ -20,7 +20,7 @@ import {
   InterpreterValue,
   RawScalarValue
 } from '../interpreter/InterpreterValue'
-import {SimpleRangeValue} from '../interpreter/SimpleRangeValue'
+import {SimpleRangeValue} from '../SimpleRangeValue'
 import {LazilyTransformingAstService} from '../LazilyTransformingAstService'
 import {Maybe} from '../Maybe'
 import {NamedExpressions} from '../NamedExpressions'

src/Evaluator.ts

@@ -13,7 +13,7 @@ import {FormulaVertex} from './DependencyGraph/FormulaCellVertex'
 import {Interpreter} from './interpreter/Interpreter'
 import {InterpreterState} from './interpreter/InterpreterState'
 import {EmptyValue, getRawValue, InterpreterValue} from './interpreter/InterpreterValue'
-import {SimpleRangeValue} from './interpreter/SimpleRangeValue'
+import {SimpleRangeValue} from './SimpleRangeValue'
 import {LazilyTransformingAstService} from './LazilyTransformingAstService'
 import {ColumnSearchStrategy} from './Lookup/SearchStrategy'
 import {Ast, RelativeDependency} from './parser'

src/Exporter.ts

@@ -9,7 +9,7 @@ import {Config} from './Config'
 import {CellValueChange, ChangeExporter} from './ContentChanges'
 import {ErrorMessage} from './error-message'
 import {EmptyValue, getRawValue, InterpreterValue, isExtendedNumber} from './interpreter/InterpreterValue'
-import {SimpleRangeValue} from './interpreter/SimpleRangeValue'
+import {SimpleRangeValue} from './SimpleRangeValue'
 import {LazilyTransformingAstService} from './LazilyTransformingAstService'
 import {NamedExpressions} from './NamedExpressions'
 import {SheetIndexMappingFn, simpleCellAddressToString} from './parser/addressRepresentationConverters'

src/Lookup/AdvancedFind.ts

@@ -10,7 +10,7 @@ import {
   RawInterpreterValue,
   RawNoErrorScalarValue
 } from '../interpreter/InterpreterValue'
-import {SimpleRangeValue} from '../interpreter/SimpleRangeValue'
+import {SimpleRangeValue} from '../SimpleRangeValue'
 import {SearchOptions} from './SearchStrategy'
 import {forceNormalizeString} from '../interpreter/ArithmeticHelper'
 import {findLastOccurrenceInOrderedRange} from '../interpreter/binarySearch'

src/Lookup/ColumnBinarySearch.ts

@@ -7,7 +7,7 @@ import {SimpleCellAddress} from '../Cell'
 import {CellValueChange} from '../ContentChanges'
 import {DependencyGraph} from '../DependencyGraph'
 import {RawNoErrorScalarValue, RawScalarValue} from '../interpreter/InterpreterValue'
-import {SimpleRangeValue} from '../interpreter/SimpleRangeValue'
+import {SimpleRangeValue} from '../SimpleRangeValue'
 import {ColumnsSpan} from '../Span'
 import {AdvancedFind} from './AdvancedFind'
 import {ColumnSearchStrategy, SearchOptions} from './SearchStrategy'

src/Lookup/ColumnIndex.ts

@@ -18,7 +18,7 @@ import {
   RawNoErrorScalarValue,
   RawScalarValue
 } from '../interpreter/InterpreterValue'
-import {SimpleRangeValue} from '../interpreter/SimpleRangeValue'
+import {SimpleRangeValue} from '../SimpleRangeValue'
 import {LazilyTransformingAstService} from '../LazilyTransformingAstService'
 import {ColumnsSpan, RowsSpan} from '../Span'
 import {Statistics, StatType} from '../statistics'

src/Lookup/RowSearchStrategy.ts

@@ -5,7 +5,7 @@
 
 import {DependencyGraph} from '../DependencyGraph'
 import {RawNoErrorScalarValue} from '../interpreter/InterpreterValue'
-import {SimpleRangeValue} from '../interpreter/SimpleRangeValue'
+import {SimpleRangeValue} from '../SimpleRangeValue'
 import {AdvancedFind} from './AdvancedFind'
 import {SearchOptions, SearchStrategy} from './SearchStrategy'
 

src/Lookup/SearchStrategy.ts

@@ -8,7 +8,7 @@ import {Config} from '../Config'
 import {CellValueChange} from '../ContentChanges'
 import {DependencyGraph} from '../DependencyGraph'
 import {RawInterpreterValue, RawNoErrorScalarValue, RawScalarValue} from '../interpreter/InterpreterValue'
-import {SimpleRangeValue} from '../interpreter/SimpleRangeValue'
+import {SimpleRangeValue} from '../SimpleRangeValue'
 import {ColumnsSpan} from '../Span'
 import {Statistics} from '../statistics'
 import {ColumnBinarySearch} from './ColumnBinarySearch'

src/interpreter/SimpleRangeValue.ts → src/SimpleRangeValue.ts

@@ -3,12 +3,13 @@
  * Copyright (c) 2022 Handsoncode. All rights reserved.
  */
 
-import {AbsoluteCellRange} from '../AbsoluteCellRange'
-import {ArraySize} from '../ArraySize'
-import {CellError, ErrorType, simpleCellAddress, SimpleCellAddress} from '../Cell'
-import {DependencyGraph} from '../DependencyGraph'
-import {ErrorMessage} from '../error-message'
-import {InternalScalarValue, isExtendedNumber} from './InterpreterValue'
+import {AbsoluteCellRange} from './AbsoluteCellRange'
+import {ArraySize} from './ArraySize'
+import {CellError, ErrorType, simpleCellAddress, SimpleCellAddress} from './Cell'
+import {DependencyGraph} from './DependencyGraph'
+import {ErrorMessage} from './error-message'
+import {InternalScalarValue, isExtendedNumber} from './interpreter/InterpreterValue'
+
 
 export class SimpleRangeValue {
   public readonly size: ArraySize
@@ -135,6 +136,7 @@ export class SimpleRangeValue {
     if (this._data !== undefined) {
       return
     }
+
     this._hasOnlyNumbers = true
     this._data = this.range!.addressesArrayMap(this.dependencyGraph!, cellFromRange => {
       const value = this.dependencyGraph!.getCellValue(cellFromRange)
@@ -148,6 +150,5 @@ export class SimpleRangeValue {
         return value as InternalScalarValue
       }
     })
-
   }
 }

src/index.ts

@@ -4,6 +4,7 @@
  */
 
 import {SimpleCellRange} from './AbsoluteCellRange'
+import {ArraySize} from './ArraySize'
 import {CellError, CellType, CellValueDetailedType, CellValueType, ErrorType, SimpleCellAddress} from './Cell'
 import {RawCellContent} from './CellContentParser'
 import {CellValue, DetailedCellError, NoErrorCellValue} from './CellValue'
@@ -47,15 +48,17 @@ import {ExportedCellChange, ExportedChange, ExportedNamedExpressionChange} from
 import {HyperFormula} from './HyperFormula'
 import {RawTranslationPackage} from './i18n'
 import enGB from './i18n/languages/enGB'
-import {FunctionArgument, FunctionPlugin, FunctionPluginDefinition} from './interpreter'
+import {FunctionArgument, FunctionPlugin, FunctionPluginDefinition, FunctionArgumentType, ImplementedFunctions, FunctionMetadata} from './interpreter'
 import {FormatInfo} from './interpreter/InterpreterValue'
 import * as plugins from './interpreter/plugin'
-import {SimpleRangeValue} from './interpreter/SimpleRangeValue'
+import {SimpleRangeValue} from './SimpleRangeValue'
 import {NamedExpression, NamedExpressionOptions} from './NamedExpressions'
 import {SerializedNamedExpression} from './Serialization'
 import {Sheet, SheetDimensions, Sheets} from './Sheet'
 
-/** @internal */
+/**
+ * Aggregate class for default export
+ */
 class HyperFormulaNS extends HyperFormula {
   public static HyperFormula = HyperFormula
   public static ErrorType = ErrorType
@@ -70,7 +73,9 @@ class HyperFormulaNS extends HyperFormula {
   public static EvaluationSuspendedError = EvaluationSuspendedError
   public static ExpectedOneOfValuesError = ExpectedOneOfValuesError
   public static ExpectedValueOfTypeError = ExpectedValueOfTypeError
+  public static ArraySize = ArraySize
   public static FunctionPlugin = FunctionPlugin
+  public static FunctionArgumentType = FunctionArgumentType
   public static FunctionPluginValidationError = FunctionPluginValidationError
   public static InvalidAddressError = InvalidAddressError
   public static InvalidArgumentsError = InvalidArgumentsError
@@ -145,7 +150,11 @@ export {
   EvaluationSuspendedError,
   ExpectedOneOfValuesError,
   ExpectedValueOfTypeError,
+  ArraySize,
   FunctionPlugin,
+  ImplementedFunctions,
+  FunctionMetadata,
+  FunctionArgumentType,
   FunctionPluginValidationError,
   InvalidAddressError,
   InvalidArgumentsError,

src/interpreter/ArithmeticHelper.ts

@@ -33,7 +33,7 @@ import {
   RawScalarValue,
   TimeNumber
 } from './InterpreterValue'
-import {SimpleRangeValue} from './SimpleRangeValue'
+import {SimpleRangeValue} from '../SimpleRangeValue'
 import Collator = Intl.Collator
 
 export type complex = [number, number]

src/interpreter/CriterionFunctionCompute.ts

@@ -12,7 +12,7 @@ import {Maybe} from '../Maybe'
 import {CriterionLambda, CriterionPackage} from './Criterion'
 import {Interpreter} from './Interpreter'
 import {getRawValue, InternalScalarValue, RawScalarValue} from './InterpreterValue'
-import {SimpleRangeValue} from './SimpleRangeValue'
+import {SimpleRangeValue} from '../SimpleRangeValue'
 
 const findSmallerRangeForMany = (dependencyGraph: DependencyGraph, conditionRanges: AbsoluteCellRange[], valuesRange: AbsoluteCellRange): { smallerRangeVertex?: RangeVertex, restConditionRanges: AbsoluteCellRange[], restValuesRange: AbsoluteCellRange } => {
   if (valuesRange.end.row > valuesRange.start.row) {

src/interpreter/Interpreter.ts

@@ -39,7 +39,7 @@ import {
   InterpreterValue,
   isExtendedNumber,
 } from './InterpreterValue'
-import {SimpleRangeValue} from './SimpleRangeValue'
+import {SimpleRangeValue} from '../SimpleRangeValue'
 
 export class Interpreter {
   public readonly criterionBuilder: CriterionBuilder

src/interpreter/InterpreterValue.ts

@@ -4,7 +4,7 @@
  */
 
 import {CellError} from '../Cell'
-import {SimpleRangeValue} from './SimpleRangeValue'
+import {SimpleRangeValue} from '../SimpleRangeValue'
 
 export const EmptyValue = Symbol('Empty value')
 export type EmptyValueType = typeof EmptyValue

src/interpreter/index.ts

@@ -9,7 +9,8 @@ import {
   FunctionMetadata,
   FunctionPlugin,
   FunctionPluginDefinition,
-  ImplementedFunctions
+  ImplementedFunctions,
+  FunctionArgumentType,
 } from './plugin/FunctionPlugin'
 
 export {
@@ -18,5 +19,6 @@ export {
   FunctionPlugin,
   ImplementedFunctions,
   FunctionMetadata,
-  FunctionTranslationsPackage
+  FunctionTranslationsPackage,
+  FunctionArgumentType,
 }

src/interpreter/plugin/AbsPlugin.ts

@@ -6,14 +6,14 @@
 import {ProcedureAst} from '../../parser'
 import {InterpreterState} from '../InterpreterState'
 import {InterpreterValue} from '../InterpreterValue'
-import {ArgumentTypes, FunctionPlugin, FunctionPluginTypecheck} from './FunctionPlugin'
+import {FunctionArgumentType, FunctionPlugin, FunctionPluginTypecheck} from './FunctionPlugin'
 
 export class AbsPlugin extends FunctionPlugin implements FunctionPluginTypecheck<AbsPlugin> {
   public static implementedFunctions = {
     'ABS': {
       method: 'abs',
       parameters: [
-        {argumentType: ArgumentTypes.NUMBER}
+        {argumentType: FunctionArgumentType.NUMBER}
       ]
     },
   }

src/interpreter/plugin/ArrayPlugin.ts

@@ -10,8 +10,8 @@ import {AstNodeType, ProcedureAst} from '../../parser'
 import {coerceScalarToBoolean} from '../ArithmeticHelper'
 import {InterpreterState} from '../InterpreterState'
 import {InternalScalarValue, InterpreterValue} from '../InterpreterValue'
-import {SimpleRangeValue} from '../SimpleRangeValue'
-import {ArgumentTypes, FunctionPlugin, FunctionPluginTypecheck} from './FunctionPlugin'
+import {SimpleRangeValue} from '../../SimpleRangeValue'
+import {FunctionArgumentType, FunctionPlugin, FunctionPluginTypecheck} from './FunctionPlugin'
 
 export class ArrayPlugin extends FunctionPlugin implements FunctionPluginTypecheck<ArrayPlugin> {
   public static implementedFunctions = {
@@ -20,16 +20,16 @@ export class ArrayPlugin extends FunctionPlugin implements FunctionPluginTypeche
       arraySizeMethod: 'arrayformulaArraySize',
       arrayFunction: true,
       parameters: [
-        {argumentType: ArgumentTypes.ANY}
+        {argumentType: FunctionArgumentType.ANY}
       ],
     },
     'ARRAY_CONSTRAIN': {
       method: 'arrayconstrain',
       arraySizeMethod: 'arrayconstrainArraySize',
       parameters: [
-        {argumentType: ArgumentTypes.RANGE},
-        {argumentType: ArgumentTypes.INTEGER, minValue: 1},
-        {argumentType: ArgumentTypes.INTEGER, minValue: 1},
+        {argumentType: FunctionArgumentType.RANGE},
+        {argumentType: FunctionArgumentType.INTEGER, minValue: 1},
+        {argumentType: FunctionArgumentType.INTEGER, minValue: 1},
       ],
       vectorizationForbidden: true,
     },
@@ -38,8 +38,8 @@ export class ArrayPlugin extends FunctionPlugin implements FunctionPluginTypeche
       arraySizeMethod: 'filterArraySize',
       arrayFunction: true,
       parameters: [
-        {argumentType: ArgumentTypes.RANGE},
-        {argumentType: ArgumentTypes.RANGE},
+        {argumentType: FunctionArgumentType.RANGE},
+        {argumentType: FunctionArgumentType.RANGE},
       ],
       repeatLastArgs: 1,
     }
@@ -101,9 +101,11 @@ export class ArrayPlugin extends FunctionPlugin implements FunctionPluginTypeche
           return new CellError(ErrorType.NA, ErrorMessage.EqualLength)
         }
       }
+
       if (rangeVals.width() > 1 && rangeVals.height() > 1) {
         return new CellError(ErrorType.NA, ErrorMessage.WrongDimension)
       }
+
       const vals = rangeVals.data
       const ret = []
       for (let i = 0; i < rangeVals.height(); i++) {

src/interpreter/plugin/BitShiftPlugin.ts

@@ -8,7 +8,7 @@ import {ErrorMessage} from '../../error-message'
 import {ProcedureAst} from '../../parser'
 import {InterpreterState} from '../InterpreterState'
 import {InterpreterValue} from '../InterpreterValue'
-import {ArgumentTypes, FunctionPlugin, FunctionPluginTypecheck} from './FunctionPlugin'
+import {FunctionArgumentType, FunctionPlugin, FunctionPluginTypecheck} from './FunctionPlugin'
 
 const MAX_48BIT_INTEGER = 281474976710655
 const SHIFT_MIN_POSITIONS = -53
@@ -19,15 +19,15 @@ export class BitShiftPlugin extends FunctionPlugin implements FunctionPluginType
     'BITLSHIFT': {
       method: 'bitlshift',
       parameters: [
-        {argumentType: ArgumentTypes.INTEGER, minValue: 0},
-        {argumentType: ArgumentTypes.INTEGER, minValue: SHIFT_MIN_POSITIONS, maxValue: SHIFT_MAX_POSITIONS},
+        {argumentType: FunctionArgumentType.INTEGER, minValue: 0},
+        {argumentType: FunctionArgumentType.INTEGER, minValue: SHIFT_MIN_POSITIONS, maxValue: SHIFT_MAX_POSITIONS},
       ]
     },
     'BITRSHIFT': {
       method: 'bitrshift',
       parameters: [
-        {argumentType: ArgumentTypes.INTEGER, minValue: 0},
-        {argumentType: ArgumentTypes.INTEGER, minValue: SHIFT_MIN_POSITIONS, maxValue: SHIFT_MAX_POSITIONS},
+        {argumentType: FunctionArgumentType.INTEGER, minValue: 0},
+        {argumentType: FunctionArgumentType.INTEGER, minValue: SHIFT_MIN_POSITIONS, maxValue: SHIFT_MAX_POSITIONS},
       ]
     },
   }

src/interpreter/plugin/BitwiseLogicOperationsPlugin.ts

@@ -6,29 +6,29 @@
 import {ProcedureAst} from '../../parser'
 import {InterpreterState} from '../InterpreterState'
 import {InterpreterValue} from '../InterpreterValue'
-import {ArgumentTypes, FunctionPlugin, FunctionPluginTypecheck} from './FunctionPlugin'
+import {FunctionArgumentType, FunctionPlugin, FunctionPluginTypecheck} from './FunctionPlugin'
 
 export class BitwiseLogicOperationsPlugin extends FunctionPlugin implements FunctionPluginTypecheck<BitwiseLogicOperationsPlugin> {
   public static implementedFunctions = {
     'BITAND': {
       method: 'bitand',
       parameters: [
-        {argumentType: ArgumentTypes.INTEGER, minValue: 0},
-        {argumentType: ArgumentTypes.INTEGER, minValue: 0},
+        {argumentType: FunctionArgumentType.INTEGER, minValue: 0},
+        {argumentType: FunctionArgumentType.INTEGER, minValue: 0},
       ]
     },
     'BITOR': {
       method: 'bitor',
       parameters: [
-        {argumentType: ArgumentTypes.INTEGER, minValue: 0},
-        {argumentType: ArgumentTypes.INTEGER, minValue: 0},
+        {argumentType: FunctionArgumentType.INTEGER, minValue: 0},
+        {argumentType: FunctionArgumentType.INTEGER, minValue: 0},
       ]
     },
     'BITXOR': {
       method: 'bitxor',
       parameters: [
-        {argumentType: ArgumentTypes.INTEGER, minValue: 0},
-        {argumentType: ArgumentTypes.INTEGER, minValue: 0},
+        {argumentType: FunctionArgumentType.INTEGER, minValue: 0},
+        {argumentType: FunctionArgumentType.INTEGER, minValue: 0},
       ]
     },
   }