@nice2dev/ui-math 1.2.0 → 1.2.2

package/dist/index.d.ts

@@ -43,7 +43,12 @@ export declare class CalculatorService {
     private variables;
     private config;
     constructor(config?: CalculatorConfig);
-    /** Evaluate expression */
+    /**
+     * Evaluate an expression — parsed by {@link ExpressionParser}, never run as code (until 1.2.0 a
+     * chain of regex replacements fed `new Function`: `asin` came out as `aMath.sin`, `ceil` lost
+     * its `e` to Euler's number, a result in exponent notation summed wrongly, and any text ran).
+     * `log` is base 10 like the key, `ln` natural; trig functions follow `angleUnit`.
+     */
     evaluate(expression: string): number;
     /** Add to history */
     addHistory(expression: string, result: string, mode: CalculatorMode): void;
@@ -119,21 +124,40 @@ export declare interface EquationTemplate {
 }
 
 /**
- * Simple expression parser for math expressions.
- * Supports: +, -, *, /, ^, (), functions, variables
+ * Expression parser for math expressions — no `eval`: the input is parsed into a tree and the
+ * tree is evaluated, so only numbers, the listed functions and the given variables exist.
+ * Supports: + - * / ^ (right-associative, above unary minus: `-2^2` = -4), parentheses, function
+ * calls, variables, numbers with an exponent (`1.5e-7`) and implicit multiplication (`2x`, `2pi`,
+ * `2(x+1)`). `×`, `÷`, `−`, `π` and `√` are read as `*`, `/`, `-`, `pi` and `sqrt`.
  */
 export declare class ExpressionParser {
     private pos;
     private expr;
+    private readonly options;
+    constructor(options?: ExpressionParserOptions);
     parse(expression: string): MathFunction;
     private parseAddSub;
     private parseMulDiv;
-    private parsePower;
     private parseUnary;
+    private parsePower;
     private parsePrimary;
+    /** A name from a table, honouring `ignoreCase`. */
+    private lookup;
     private evaluate;
 }
 
+/** Options of {@link ExpressionParser}; every one is optional and off by default. */
+export declare interface ExpressionParserOptions {
+    /** Functions by name, over the built-ins (e.g. `{ log: Math.log10 }` for a calculator). */
+    functions?: Record<string, (...args: number[]) => number>;
+    /** Constants by name, over `pi`, `e`, `phi`, `tau`. */
+    constants?: Record<string, number>;
+    /** Match function and constant names case-insensitively (`SIN`, `Pi`). */
+    ignoreCase?: boolean;
+    /** Throw on input left over after a whole expression, instead of ignoring it. */
+    strict?: boolean;
+}
+
 export declare const FUNCTION_PRESETS: FunctionPreset[];
 
 export declare interface FunctionPreset {
@@ -564,7 +588,7 @@ export declare interface NiceGraphPlotterProps {
     style?: default_2.CSSProperties;
 }
 
-export declare function NiceI18nProvider({ locale, overrides, children }: NiceI18nProviderProps): default_2.FunctionComponentElement<default_2.ProviderProps<I18nContextValue>>;
+export declare function NiceI18nProvider({ locale, overrides, children }: NiceI18nProviderProps): default_2.FunctionComponentElement<default_2.ProviderProps<I18nContextValue | null>>;
 
 export declare interface NiceI18nProviderProps {
     /** Language code, e.g. `'pl'`, `'cs'`. Falls back to English when unknown. */
@@ -679,6 +703,12 @@ export declare function useGraph(): GraphContextValue;
 
 export declare function useMathEditor(): MathEditorContextValue;
 
+/**
+ * This package's translator: under its `NiceI18nProvider`, that provider's language and overrides;
+ * without one (since 1.2.2), the language of the app's global `NiceI18nProvider` — English when
+ * this dictionary does not have it. Before 1.2.2 the controls stayed English without the
+ * package's own provider, whatever language the app used.
+ */
 export declare function useNiceTranslation(): {
     t: NiceTranslateFn;
     locale: string;