desmost 0.8.0 → 0.8.2

package/dist/compiler/compile.d.ts

@@ -1,9 +1,33 @@
 import { type DesmostOptions } from "./options.js";
 import { Ast } from "../parser/index.js";
+/** Debug diagnostics returned from `compile()`. */
 export interface DesmostDebug {
     duration: number;
     num_blocks: number;
     ast: Ast[];
 }
-export declare function compile(desmos: Desmos.Calculator, source: string, options?: DesmostOptions): void | DesmostDebug;
+/**
+ * Compile Desmost into Desmos.
+ *
+ * This calls the Desmost compiler: parsing and evaluating `source`, then injecting the results into an existing `desmos` instance. Pass in `options` to customise compilation.
+ *
+ * ## Example
+ *
+ * ```ts
+ * let calc = Desmos.GraphingCalculator();
+ *
+ * compile(calc, `/text{ sup world! }`);
+ *
+ * compile(calc, `/slider{ error! } :: t = 0`, {
+ *   errors: "crash",
+ * });
+ * ```
+ */
+export declare function compile(
+/** The Desmos calculator instance to compile into. */
+desmos: Desmos.Calculator, 
+/** The Desmost source code to compile. */
+source: string, 
+/** Compilation options. */
+options?: DesmostOptions): void | DesmostDebug;
 //# sourceMappingURL=compile.d.ts.map

package/dist/compiler/compile.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"compile.d.ts","sourceRoot":"","sources":["../../src/compiler/compile.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAiB,MAAM,WAAW,CAAC;AAG/D,OAAO,EAAiB,GAAG,EAAE,MAAM,WAAW,CAAC;AAI/C,MAAM,WAAW,YAAY;IAE5B,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,GAAG,EAAE,GAAG,EAAE,CAAC;CACX;AAoBD,wBAAgB,OAAO,CAEtB,MAAM,EAAE,MAAM,CAAC,UAAU,EAGzB,MAAM,EAAE,MAAM,EAGd,OAAO,CAAC,EAAE,cAAc,GACtB,IAAI,GAAG,YAAY,CAkHrB"}
+{"version":3,"file":"compile.d.ts","sourceRoot":"","sources":["../../src/compiler/compile.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAiB,MAAM,WAAW,CAAC;AAG/D,OAAO,EAAiB,GAAG,EAAE,MAAM,WAAW,CAAC;AAG/C,mDAAmD;AACnD,MAAM,WAAW,YAAY;IAE5B,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,GAAG,EAAE,GAAG,EAAE,CAAC;CACX;AAGD;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,OAAO;AACtB,sDAAsD;AACtD,MAAM,EAAE,MAAM,CAAC,UAAU;AAEzB,0CAA0C;AAC1C,MAAM,EAAE,MAAM;AAEd,2BAA2B;AAC3B,OAAO,CAAC,EAAE,cAAc,GACtB,IAAI,GAAG,YAAY,CAkHrB"}

package/dist/compiler/compile.js

@@ -1,7 +1,30 @@
 import { fill_defaults } from "./options.js";
 import { evaluate_global_incantation, evaluate_expr, evaluate_error } from "./evaluate.js";
 import { DesmostParser, Ast } from "../parser/index.js";
-export function compile(desmos, source, options) {
+/**
+ * Compile Desmost into Desmos.
+ *
+ * This calls the Desmost compiler: parsing and evaluating `source`, then injecting the results into an existing `desmos` instance. Pass in `options` to customise compilation.
+ *
+ * ## Example
+ *
+ * ```ts
+ * let calc = Desmos.GraphingCalculator();
+ *
+ * compile(calc, `/text{ sup world! }`);
+ *
+ * compile(calc, `/slider{ error! } :: t = 0`, {
+ *   errors: "crash",
+ * });
+ * ```
+ */
+export function compile(
+/** The Desmos calculator instance to compile into. */
+desmos, 
+/** The Desmost source code to compile. */
+source, 
+/** Compilation options. */
+options) {
     if (desmos == undefined) {
         console.error(`Desmost: No \`Desmos.Calculator\` instance provided, aborting compilation!`);
         return;
@@ -18,11 +41,16 @@ export function compile(desmos, source, options) {
     }
     let parser = new DesmostParser(source, opts);
     let errors = [];
+    /* To aggregate errors at the start, we need a target to retroactively inject errors into */
     if (opts.place_errors === "start") {
-        desmos.setExpression({ id: "deferred-start", latex: " " });
+        desmos.setExpression({ id: "deferred-start", latex: " " }); // FIXME check if ` ` needed
     }
+    /* Keep track of whether we're still evaluating leading blank expressions, which might be ignored. */
     let seen_non_blank = false;
+    /** The number of pending blank expressions to add. */
     let pending_blanks = 0;
+    /* The compiler is lazy, parsing and evaluating one block at a time (as opposed to first parsing the entire AST). We don't need the whole AST, so this saves memory. */
+    /* NOTE: It also doesn't sacrifice performance, since `.setExpressions()` internally just calls `.setExpression()` in a loop anyway. Benchmarks in the frontend produce similar times for both, so there's no performance improvement. */
     try {
         while (true) {
             let r = parser.parse_next();
@@ -32,12 +60,14 @@ export function compile(desmos, source, options) {
                 num_blocks++;
                 ast.push(r);
             }
+            /** An error message to leave for aggregation later. */
             let defer = undefined;
             switch (r.kind) {
                 case Ast.Kind.INCANTATION_INVOCATION:
                     defer = evaluate_global_incantation(r, desmos, opts);
                     break;
                 case Ast.Kind.EXPRESSION:
+                    // @ts-expect-error: outdated types
                     if (r.data.latex === " ") {
                         if (opts.ignore_all_blanks)
                             break;

package/dist/compiler/compile.js.map

@@ -1 +1 @@
-{"version":3,"file":"compile.js","sourceRoot":"","sources":["../../src/compiler/compile.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,aAAa,EAAE,MAAM,WAAW,CAAC;AAC/D,OAAO,EAAE,2BAA2B,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAExF,OAAO,EAAE,aAAa,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AA6B/C,MAAM,UAAU,OAAO,CAEtB,MAAyB,EAGzB,MAAc,EAGd,OAAwB;IAGxB,IAAI,MAAM,IAAI,SAAS,EAAE,CAAC;QACzB,OAAO,CAAC,KAAK,CAAC,4EAA4E,CAAC,CAAC;QAC5F,OAAO;IACR,CAAC;IAED,IAAI,MAAM,IAAI,SAAS,EAAE,CAAC;QACzB,OAAO,CAAC,KAAK,CAAC,yDAAyD,CAAC,CAAC;QACzE,OAAO;IACR,CAAC;IAED,IAAI,IAAI,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;IAElC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QAChB,IAAI,MAAM,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QAC/B,IAAI,UAAU,GAAG,CAAC,CAAC;QACnB,IAAI,GAAG,GAAU,EAAE,CAAC;IACrB,CAAC;IAED,IAAI,MAAM,GAAG,IAAI,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAE7C,IAAI,MAAM,GAAa,EAAE,CAAC;IAG1B,IAAI,IAAI,CAAC,YAAY,KAAK,OAAO,EAAE,CAAC;QACnC,MAAM,CAAC,aAAa,CAAC,EAAE,EAAE,EAAE,gBAAgB,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;IAC5D,CAAC;IAGD,IAAI,cAAc,GAAG,KAAK,CAAC;IAG3B,IAAI,cAAc,GAAW,CAAC,CAAC;IAI/B,IAAI,CAAC;QACJ,OAAO,IAAI,EAAE,CAAC;YACb,IAAI,CAAC,GAAG,MAAM,CAAC,UAAU,EAAE,CAAC;YAC5B,IAAI,CAAC,KAAK,IAAI;gBAAE,MAAM;YAEtB,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBAChB,UAAW,EAAE,CAAC;gBACd,GAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACd,CAAC;YAGD,IAAI,KAAK,GAAkB,SAAS,CAAC;YAErC,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC;gBAChB,KAAK,GAAG,CAAC,IAAI,CAAC,sBAAsB;oBACnC,KAAK,GAAG,2BAA2B,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;oBACrD,MAAM;gBAEP,KAAK,GAAG,CAAC,IAAI,CAAC,UAAU;oBAEvB,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,KAAK,GAAG,EAAE,CAAC;wBAC1B,IAAI,IAAI,CAAC,iBAAiB;4BAAE,MAAM;wBAClC,IAAI,CAAC,cAAc,IAAI,CAAC,IAAI,CAAC,mBAAmB;4BAAE,MAAM;wBACxD,cAAc,EAAE,CAAC;wBACjB,MAAM;oBACP,CAAC;yBACI,CAAC;wBACL,oBAAoB,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;wBAC7C,cAAc,GAAG,CAAC,CAAC;wBAEnB,cAAc,GAAG,IAAI,CAAC;wBACtB,KAAK,GAAG,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;wBACvC,MAAM;oBACP,CAAC;gBAEF,KAAK,GAAG,CAAC,IAAI,CAAC,mBAAmB;oBAChC,KAAK,GAAG,cAAc,CAAC,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;oBAC9C,MAAM;YACR,CAAC;YAED,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACzB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACpB,CAAC;QACF,CAAC;IACF,CAAC;IACD,OAAO,CAAC,EAAE,CAAC;QACV,MAAM,CAAC,IAAI,CAAE,CAAW,CAAC,OAAO,CAAC,CAAC;IACnC,CAAC;IAED,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC/B,oBAAoB,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAC9C,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,IAAI,IAAI,GAA2B;YAClC,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;SACzB,CAAC;QAEF,QAAQ,IAAI,CAAC,YAAY,EAAE,CAAC;YAC3B,KAAK,OAAO;gBACX,MAAM,CAAC,aAAa,CAAC,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC;gBACxD,MAAM;YACP,KAAK,KAAK,CAAC;YACX,KAAK,QAAQ;gBACZ,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;gBAC3B,MAAM;QACR,CAAC;IACF,CAAC;IAED,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QAChB,OAAO;YACN,QAAQ,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,MAAO;YACrC,UAAU,EAAE,UAAW;YACvB,GAAG,EAAE,GAAI;SACT,CAAC;IACH,CAAC;AACF,CAAC;AAGD,SAAS,oBAAoB,CAAC,MAAyB,EAAE,KAAa;IAErE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;QAChC,MAAM,CAAC,aAAa,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;IACtC,CAAC;AACF,CAAC"}
+{"version":3,"file":"compile.js","sourceRoot":"","sources":["../../src/compiler/compile.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,aAAa,EAAE,MAAM,WAAW,CAAC;AAC/D,OAAO,EAAE,2BAA2B,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAExF,OAAO,EAAE,aAAa,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAY/C;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,OAAO;AACtB,sDAAsD;AACtD,MAAyB;AAEzB,0CAA0C;AAC1C,MAAc;AAEd,2BAA2B;AAC3B,OAAwB;IAGxB,IAAI,MAAM,IAAI,SAAS,EAAE,CAAC;QACzB,OAAO,CAAC,KAAK,CAAC,4EAA4E,CAAC,CAAC;QAC5F,OAAO;IACR,CAAC;IAED,IAAI,MAAM,IAAI,SAAS,EAAE,CAAC;QACzB,OAAO,CAAC,KAAK,CAAC,yDAAyD,CAAC,CAAC;QACzE,OAAO;IACR,CAAC;IAED,IAAI,IAAI,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;IAElC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QAChB,IAAI,MAAM,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QAC/B,IAAI,UAAU,GAAG,CAAC,CAAC;QACnB,IAAI,GAAG,GAAU,EAAE,CAAC;IACrB,CAAC;IAED,IAAI,MAAM,GAAG,IAAI,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAE7C,IAAI,MAAM,GAAa,EAAE,CAAC;IAE1B,4FAA4F;IAC5F,IAAI,IAAI,CAAC,YAAY,KAAK,OAAO,EAAE,CAAC;QACnC,MAAM,CAAC,aAAa,CAAC,EAAE,EAAE,EAAE,gBAAgB,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAE,4BAA4B;IAC1F,CAAC;IAED,qGAAqG;IACrG,IAAI,cAAc,GAAG,KAAK,CAAC;IAE3B,sDAAsD;IACtD,IAAI,cAAc,GAAW,CAAC,CAAC;IAE/B,uKAAuK;IACvK,yOAAyO;IACzO,IAAI,CAAC;QACJ,OAAO,IAAI,EAAE,CAAC;YACb,IAAI,CAAC,GAAG,MAAM,CAAC,UAAU,EAAE,CAAC;YAC5B,IAAI,CAAC,KAAK,IAAI;gBAAE,MAAM;YAEtB,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBAChB,UAAW,EAAE,CAAC;gBACd,GAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACd,CAAC;YAED,uDAAuD;YACvD,IAAI,KAAK,GAAkB,SAAS,CAAC;YAErC,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC;gBAChB,KAAK,GAAG,CAAC,IAAI,CAAC,sBAAsB;oBACnC,KAAK,GAAG,2BAA2B,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;oBACrD,MAAM;gBAEP,KAAK,GAAG,CAAC,IAAI,CAAC,UAAU;oBACvB,mCAAmC;oBACnC,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,KAAK,GAAG,EAAE,CAAC;wBAC1B,IAAI,IAAI,CAAC,iBAAiB;4BAAE,MAAM;wBAClC,IAAI,CAAC,cAAc,IAAI,CAAC,IAAI,CAAC,mBAAmB;4BAAE,MAAM;wBACxD,cAAc,EAAE,CAAC;wBACjB,MAAM;oBACP,CAAC;yBACI,CAAC;wBACL,oBAAoB,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;wBAC7C,cAAc,GAAG,CAAC,CAAC;wBAEnB,cAAc,GAAG,IAAI,CAAC;wBACtB,KAAK,GAAG,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;wBACvC,MAAM;oBACP,CAAC;gBAEF,KAAK,GAAG,CAAC,IAAI,CAAC,mBAAmB;oBAChC,KAAK,GAAG,cAAc,CAAC,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;oBAC9C,MAAM;YACR,CAAC;YAED,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACzB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACpB,CAAC;QACF,CAAC;IACF,CAAC;IACD,OAAO,CAAC,EAAE,CAAC;QACV,MAAM,CAAC,IAAI,CAAE,CAAW,CAAC,OAAO,CAAC,CAAC;IACnC,CAAC;IAED,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC/B,oBAAoB,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAC9C,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,IAAI,IAAI,GAA2B;YAClC,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;SACzB,CAAC;QAEF,QAAQ,IAAI,CAAC,YAAY,EAAE,CAAC;YAC3B,KAAK,OAAO;gBACX,MAAM,CAAC,aAAa,CAAC,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC;gBACxD,MAAM;YACP,KAAK,KAAK,CAAC;YACX,KAAK,QAAQ;gBACZ,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;gBAC3B,MAAM;QACR,CAAC;IACF,CAAC;IAED,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QAChB,OAAO;YACN,QAAQ,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,MAAO;YACrC,UAAU,EAAE,UAAW;YACvB,GAAG,EAAE,GAAI;SACT,CAAC;IACH,CAAC;AACF,CAAC;AAGD,SAAS,oBAAoB,CAAC,MAAyB,EAAE,KAAa;IAErE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;QAChC,MAAM,CAAC,aAAa,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;IACtC,CAAC;AACF,CAAC"}

package/dist/compiler/evaluate.d.ts

@@ -1,7 +1,18 @@
 import type { DesmostOptions } from "./options.js";
 import { Ast } from "../parser/index.js";
 import { UnrecoverableError, type Unrecoverable } from "../errors.js";
+/**
+ * Evaluate arguments (if any) to a global incantation `invocation`, then apply the incantation to `desmos`.
+ */
 export declare function evaluate_global_incantation(invocation: Ast.IncantationInvocation, desmos: Desmos.Calculator, options: Required<DesmostOptions>): Unrecoverable<void | string>;
+/**
+ * Evaluate arguments (if any) to local incantation invocations on `expr`, then add `expr` to `desmos`.
+ */
 export declare function evaluate_expr(expr: Ast.Expression, desmos: Desmos.Calculator, options: Required<DesmostOptions>): Unrecoverable<void | string>;
+/**
+ * Handle an `InvalidInvocation`, respecting the user's preferences in `options`.
+ *
+ * If the user set `place_errors: start` or `place_errors: end`, this returns the formatted error message for deferred aggregation.
+ */
 export declare function evaluate_error(error: UnrecoverableError, desmos: Desmos.Calculator, options: Required<DesmostOptions>): Unrecoverable<void | string>;
 //# sourceMappingURL=evaluate.d.ts.map

package/dist/compiler/evaluate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"evaluate.d.ts","sourceRoot":"","sources":["../../src/compiler/evaluate.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAEhD,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAChC,OAAO,EAAE,kBAAkB,EAAE,KAAK,aAAa,EAAE,MAAM,WAAW,CAAC;AAMnE,wBAAgB,2BAA2B,CAC1C,UAAU,EAAE,GAAG,CAAC,qBAAqB,EACrC,MAAM,EAAE,MAAM,CAAC,UAAU,EACzB,OAAO,EAAE,QAAQ,CAAC,cAAc,CAAC,GAC/B,aAAa,CAAC,IAAI,GAAG,MAAM,CAAC,CAe9B;AAMD,wBAAgB,aAAa,CAC5B,IAAI,EAAE,GAAG,CAAC,UAAU,EACpB,MAAM,EAAE,MAAM,CAAC,UAAU,EACzB,OAAO,EAAE,QAAQ,CAAC,cAAc,CAAC,GAC/B,aAAa,CAAC,IAAI,GAAG,MAAM,CAAC,CA4C9B;AAQD,wBAAgB,cAAc,CAC7B,KAAK,EAAE,kBAAkB,EACzB,MAAM,EAAE,MAAM,CAAC,UAAU,EACzB,OAAO,EAAE,QAAQ,CAAC,cAAc,CAAC,GAC/B,aAAa,CAAC,IAAI,GAAG,MAAM,CAAC,CAuB9B"}
+{"version":3,"file":"evaluate.d.ts","sourceRoot":"","sources":["../../src/compiler/evaluate.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAEhD,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAChC,OAAO,EAAE,kBAAkB,EAAE,KAAK,aAAa,EAAE,MAAM,WAAW,CAAC;AAGnE;;GAEG;AACH,wBAAgB,2BAA2B,CAC1C,UAAU,EAAE,GAAG,CAAC,qBAAqB,EACrC,MAAM,EAAE,MAAM,CAAC,UAAU,EACzB,OAAO,EAAE,QAAQ,CAAC,cAAc,CAAC,GAC/B,aAAa,CAAC,IAAI,GAAG,MAAM,CAAC,CAe9B;AAGD;;GAEG;AACH,wBAAgB,aAAa,CAC5B,IAAI,EAAE,GAAG,CAAC,UAAU,EACpB,MAAM,EAAE,MAAM,CAAC,UAAU,EACzB,OAAO,EAAE,QAAQ,CAAC,cAAc,CAAC,GAC/B,aAAa,CAAC,IAAI,GAAG,MAAM,CAAC,CA4C9B;AAGD;;;;GAIG;AACH,wBAAgB,cAAc,CAC7B,KAAK,EAAE,kBAAkB,EACzB,MAAM,EAAE,MAAM,CAAC,UAAU,EACzB,OAAO,EAAE,QAAQ,CAAC,cAAc,CAAC,GAC/B,aAAa,CAAC,IAAI,GAAG,MAAM,CAAC,CAuB9B"}

package/dist/compiler/evaluate.js

@@ -1,6 +1,9 @@
 import { format_error, normalise_latex, prettify_latex } from "./format.js";
 import { Ast } from "../parser/index.js";
 import { UnrecoverableError } from "../errors.js";
+/**
+ * Evaluate arguments (if any) to a global incantation `invocation`, then apply the incantation to `desmos`.
+ */
 export function evaluate_global_incantation(invocation, desmos, options) {
     let data = undefined;
     if ("arg_raw" in invocation && invocation.arg_raw != undefined) {
@@ -14,6 +17,9 @@ export function evaluate_global_incantation(invocation, desmos, options) {
     }
     invocation.incantation.apply(desmos, data);
 }
+/**
+ * Evaluate arguments (if any) to local incantation invocations on `expr`, then add `expr` to `desmos`.
+ */
 export function evaluate_expr(expr, desmos, options) {
     let errors = [];
     for (let invocation of expr.incantations) {
@@ -40,14 +46,22 @@ export function evaluate_expr(expr, desmos, options) {
     if (errors.length > 0) {
         desmos.setExpression({ type: "text", text: errors.join("\n\n") });
     }
+    // @ts-expect-error: outdated types
     if (expr.data.latex != undefined) {
+        // @ts-expect-error: outdated types
         expr.data.latex = normalise_latex(expr.data.latex);
         if (options.prettify) {
+            // @ts-expect-error: outdated types
             expr.data.latex = prettify_latex(expr.data.latex);
         }
     }
     desmos.setExpression(expr.data);
 }
+/**
+ * Handle an `InvalidInvocation`, respecting the user's preferences in `options`.
+ *
+ * If the user set `place_errors: start` or `place_errors: end`, this returns the formatted error message for deferred aggregation.
+ */
 export function evaluate_error(error, desmos, options) {
     switch (options.errors) {
         case "crash":

package/dist/compiler/evaluate.js.map

@@ -1 +1 @@
-{"version":3,"file":"evaluate.js","sourceRoot":"","sources":["../../src/compiler/evaluate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAGzE,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAChC,OAAO,EAAE,kBAAkB,EAAsB,MAAM,WAAW,CAAC;AAMnE,MAAM,UAAU,2BAA2B,CAC1C,UAAqC,EACrC,MAAyB,EACzB,OAAiC;IAGjC,IAAI,IAAI,GAAG,SAAS,CAAC;IAErB,IAAI,SAAS,IAAI,UAAU,IAAI,UAAU,CAAC,OAAO,IAAI,SAAS,EAAE,CAAC;QAChE,IAAI,CAAC;YACJ,IAAI,GAAG,UAAU,CAAC,WAAW,CAAC,YAAY,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAChE,CAAC;QACD,OAAO,CAAC,EAAE,CAAC;YACV,IAAI,GAAG,GAAG,cAAc,CAAC,CAAU,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;YACtD,OAAO,GAAG,CAAC;QACZ,CAAC;IACF,CAAC;IAED,UAAU,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AAC5C,CAAC;AAMD,MAAM,UAAU,aAAa,CAC5B,IAAoB,EACpB,MAAyB,EACzB,OAAiC;IAGjC,IAAI,MAAM,GAAa,EAAE,CAAC;IAE1B,KAAK,IAAI,UAAU,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;QAC1C,IAAI,UAAU,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC;YACtD,IAAI,GAAG,GAAG,cAAc,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,GAAG,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,CAAC,CAAC;YAC1F,IAAI,GAAG,IAAI,SAAS,EAAE,CAAC;gBACtB,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAClB,CAAC;YACD,SAAS;QACV,CAAC;QAED,IAAI,IAAI,GAAG,SAAS,CAAC;QAErB,IAAI,SAAS,IAAI,UAAU,IAAI,UAAU,CAAC,OAAO,IAAI,SAAS,EAAE,CAAC;YAChE,IAAI,CAAC;gBACJ,IAAI,GAAG,UAAU,CAAC,WAAW,CAAC,YAAY,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;YAChE,CAAC;YACD,OAAO,CAAC,EAAE,CAAC;gBACV,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAU,EAAE,OAAO,CAAC,CAAC,CAAC;gBAC/C,IAAI,UAAU,CAAC,WAAW,CAAC,YAAY;oBAAE,SAAS;YACnD,CAAC;QACF,CAAC;QAED,UAAU,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC/C,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,MAAM,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACnE,CAAC;IAGD,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,SAAS,EAAE,CAAC;QAElC,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAEnD,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;YAEtB,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACnD,CAAC;IACF,CAAC;IAED,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACjC,CAAC;AAQD,MAAM,UAAU,cAAc,CAC7B,KAAyB,EACzB,MAAyB,EACzB,OAAiC;IAGjC,QAAQ,OAAO,CAAC,MAAM,EAAE,CAAC;QACxB,KAAK,OAAO;YACX,MAAM,KAAK,CAAC;QAEb,KAAK,UAAU;YACd,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACrB,MAAM;QAEP,OAAO,CAAC,CAAC,QAAQ,OAAO,CAAC,YAAY,EAAE,CAAC;YACvC,KAAK,KAAK,CAAC;YACX,KAAK,OAAO;gBACX,OAAO,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;YAErC;gBACC,MAAM,CAAC,aAAa,CAAC;oBACpB,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC;iBAClC,CAAC,CAAC;gBACH,MAAM;QACR,CAAC;IACF,CAAC;AACF,CAAC"}
+{"version":3,"file":"evaluate.js","sourceRoot":"","sources":["../../src/compiler/evaluate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAGzE,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAChC,OAAO,EAAE,kBAAkB,EAAsB,MAAM,WAAW,CAAC;AAGnE;;GAEG;AACH,MAAM,UAAU,2BAA2B,CAC1C,UAAqC,EACrC,MAAyB,EACzB,OAAiC;IAGjC,IAAI,IAAI,GAAG,SAAS,CAAC;IAErB,IAAI,SAAS,IAAI,UAAU,IAAI,UAAU,CAAC,OAAO,IAAI,SAAS,EAAE,CAAC;QAChE,IAAI,CAAC;YACJ,IAAI,GAAG,UAAU,CAAC,WAAW,CAAC,YAAY,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAChE,CAAC;QACD,OAAO,CAAC,EAAE,CAAC;YACV,IAAI,GAAG,GAAG,cAAc,CAAC,CAAU,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;YACtD,OAAO,GAAG,CAAC;QACZ,CAAC;IACF,CAAC;IAED,UAAU,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AAC5C,CAAC;AAGD;;GAEG;AACH,MAAM,UAAU,aAAa,CAC5B,IAAoB,EACpB,MAAyB,EACzB,OAAiC;IAGjC,IAAI,MAAM,GAAa,EAAE,CAAC;IAE1B,KAAK,IAAI,UAAU,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;QAC1C,IAAI,UAAU,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC;YACtD,IAAI,GAAG,GAAG,cAAc,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,GAAG,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,CAAC,CAAC;YAC1F,IAAI,GAAG,IAAI,SAAS,EAAE,CAAC;gBACtB,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAClB,CAAC;YACD,SAAS;QACV,CAAC;QAED,IAAI,IAAI,GAAG,SAAS,CAAC;QAErB,IAAI,SAAS,IAAI,UAAU,IAAI,UAAU,CAAC,OAAO,IAAI,SAAS,EAAE,CAAC;YAChE,IAAI,CAAC;gBACJ,IAAI,GAAG,UAAU,CAAC,WAAW,CAAC,YAAY,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;YAChE,CAAC;YACD,OAAO,CAAC,EAAE,CAAC;gBACV,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAU,EAAE,OAAO,CAAC,CAAC,CAAC;gBAC/C,IAAI,UAAU,CAAC,WAAW,CAAC,YAAY;oBAAE,SAAS;YACnD,CAAC;QACF,CAAC;QAED,UAAU,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC/C,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,MAAM,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACnE,CAAC;IAED,mCAAmC;IACnC,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,SAAS,EAAE,CAAC;QAClC,mCAAmC;QACnC,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAEnD,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;YACtB,mCAAmC;YACnC,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACnD,CAAC;IACF,CAAC;IAED,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACjC,CAAC;AAGD;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAC7B,KAAyB,EACzB,MAAyB,EACzB,OAAiC;IAGjC,QAAQ,OAAO,CAAC,MAAM,EAAE,CAAC;QACxB,KAAK,OAAO;YACX,MAAM,KAAK,CAAC;QAEb,KAAK,UAAU;YACd,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACrB,MAAM;QAEP,OAAO,CAAC,CAAC,QAAQ,OAAO,CAAC,YAAY,EAAE,CAAC;YACvC,KAAK,KAAK,CAAC;YACX,KAAK,OAAO;gBACX,OAAO,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;YAErC;gBACC,MAAM,CAAC,aAAa,CAAC;oBACpB,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC;iBAClC,CAAC,CAAC;gBACH,MAAM;QACR,CAAC;IACF,CAAC;AACF,CAAC"}

package/dist/compiler/format.d.ts

@@ -1,6 +1,17 @@
 import type { DesmostOptions } from "./options.js";
 import { UnrecoverableError } from "../errors.js";
 export declare function format_error(e: UnrecoverableError, options: Required<DesmostOptions>): string;
+/**
+ * Remove line breaks from `latex` so Desmos can properly consume it.
+ */
 export declare function normalise_latex(latex: string): string;
+/**
+ * Prettify `latex` to render nicely in Desmos, reflecting how you would type directly into Desmos.
+ *
+ * This includes:
+ *
+ * - Replace `()`, `[]`, etc. with `\left(\right)`
+ * - Replace `min()`, `max()`, etc. with `\operatorname{min}()`
+ */
 export declare function prettify_latex(latex: string): string;
 //# sourceMappingURL=format.d.ts.map

package/dist/compiler/format.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"format.d.ts","sourceRoot":"","sources":["../../src/compiler/format.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAEhD,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAG/C,wBAAgB,YAAY,CAC3B,CAAC,EAAE,kBAAkB,EACrB,OAAO,EAAE,QAAQ,CAAC,cAAc,CAAC,GAC/B,MAAM,CAOR;AAMD,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAIrD;AAWD,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAYpD"}
+{"version":3,"file":"format.d.ts","sourceRoot":"","sources":["../../src/compiler/format.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAEhD,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAG/C,wBAAgB,YAAY,CAC3B,CAAC,EAAE,kBAAkB,EACrB,OAAO,EAAE,QAAQ,CAAC,cAAc,CAAC,GAC/B,MAAM,CAOR;AAGD;;GAEG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAIrD;AAGD;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAiBpD"}

package/dist/compiler/format.js

@@ -3,16 +3,29 @@ export function format_error(e, options) {
     let prefix = options.error_prefix;
     let sep = (prefix === "" || prefix.endsWith("\n")) ? "" : " ";
     return `${prefix}${sep}${e.name}: ${e.message}`;
+    // TODO maybe include stack? (configurable?)
 }
+/**
+ * Remove line breaks from `latex` so Desmos can properly consume it.
+ */
 export function normalise_latex(latex) {
     latex = latex.replaceAll(/\s+/g, " ");
     return latex;
 }
+/**
+ * Prettify `latex` to render nicely in Desmos, reflecting how you would type directly into Desmos.
+ *
+ * This includes:
+ *
+ * - Replace `()`, `[]`, etc. with `\left(\right)`
+ * - Replace `min()`, `max()`, etc. with `\operatorname{min}()`
+ */
 export function prettify_latex(latex) {
     latex = latex.replaceAll(/(?<!\\left)(\(|\[|\\\{)/g, "\\left$1");
     latex = latex.replaceAll(/(?<!\\right)(\)|\]|\\\})/g, "\\right$1");
     latex = latex.replaceAll(/(:|,)(?!\\ ) */g, "$1\\ ");
-    latex = latex.replaceAll(/(?<=[^\w]|^)\\?(mean|median|count|total|repeat|join|sort|shuffle|unique|mod|ceil|floor|round|sign) ?(?=\(|\\left\()/g, "\\operatorname{$1}");
+    latex = latex.replaceAll(/(?<=[^\w]|^)\\?(length|mean|median|count|total|repeat|join|sort|shuffle|unique|mod|ceil|floor|round|sign) ?(?=\(|\\left\()/g, "\\operatorname{$1}");
+    latex = latex.replaceAll(/\s(and|or)\s/g, "\\operatorname{$1}");
     return latex;
 }
 //# sourceMappingURL=format.js.map

package/dist/compiler/format.js.map

@@ -1 +1 @@
-{"version":3,"file":"format.js","sourceRoot":"","sources":["../../src/compiler/format.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAG/C,MAAM,UAAU,YAAY,CAC3B,CAAqB,EACrB,OAAiC;IAGjC,IAAI,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAClC,IAAI,GAAG,GAAG,CAAC,MAAM,KAAK,EAAE,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;IAE9D,OAAO,GAAG,MAAM,GAAG,GAAG,GAAG,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC;AAEjD,CAAC;AAMD,MAAM,UAAU,eAAe,CAAC,KAAa;IAE5C,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACtC,OAAO,KAAK,CAAC;AACd,CAAC;AAWD,MAAM,UAAU,cAAc,CAAC,KAAa;IAE3C,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,0BAA0B,EAAE,UAAU,CAAC,CAAC;IACjE,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,2BAA2B,EAAE,WAAW,CAAC,CAAC;IACnE,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC;IAErD,KAAK,GAAG,KAAK,CAAC,UAAU,CACvB,sHAAsH,EACtH,oBAAoB,CACpB,CAAC;IAEF,OAAO,KAAK,CAAC;AACd,CAAC"}
+{"version":3,"file":"format.js","sourceRoot":"","sources":["../../src/compiler/format.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAG/C,MAAM,UAAU,YAAY,CAC3B,CAAqB,EACrB,OAAiC;IAGjC,IAAI,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAClC,IAAI,GAAG,GAAG,CAAC,MAAM,KAAK,EAAE,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;IAE9D,OAAO,GAAG,MAAM,GAAG,GAAG,GAAG,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC;IAChD,4CAA4C;AAC7C,CAAC;AAGD;;GAEG;AACH,MAAM,UAAU,eAAe,CAAC,KAAa;IAE5C,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACtC,OAAO,KAAK,CAAC;AACd,CAAC;AAGD;;;;;;;GAOG;AACH,MAAM,UAAU,cAAc,CAAC,KAAa;IAE3C,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,0BAA0B,EAAE,UAAU,CAAC,CAAC;IACjE,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,2BAA2B,EAAE,WAAW,CAAC,CAAC;IACnE,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC;IAErD,KAAK,GAAG,KAAK,CAAC,UAAU,CACvB,6HAA6H,EAC7H,oBAAoB,CACpB,CAAC;IAEF,KAAK,GAAG,KAAK,CAAC,UAAU,CACvB,eAAe,EACf,oBAAoB,CACpB,CAAC;IAEF,OAAO,KAAK,CAAC;AACd,CAAC"}

package/dist/compiler/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/compiler/index.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAGpC,YAAY,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/compiler/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,YAAY,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC"}

package/dist/compiler/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/compiler/index.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/compiler/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC"}

package/dist/compiler/options.d.ts

@@ -1,13 +1,92 @@
+/**
+ * Options to customise Desmost compilation.
+ *
+ * To customise compilation, pass in a `DesmostOptions` object as the last argument to `compile()`:
+ *
+ * ```ts
+ * compile(calc, source, { errors: "crash" });
+ * ```
+ */
 export interface DesmostOptions {
+    /**
+     * How should errors be *surfaced* to the end user?
+     *
+     * - `surface` (default): Blocks that result in errors will become Desmos text expressions containing the error message, leaving other expressions unaffected.
+     *
+     * - `crash`: The entire compilation to Desmos will terminate with a single error message. This means you don't get any output at all, but errors are also immediately obvious.
+     *    - Note that this will *clear all expressions* in the calculator instance.
+     *
+     * - `suppress`: Silently fail on the frontend (if you wish to give the illusion that everything is fine).
+     */
     errors?: "surface" | "crash" | "suppress";
+    /**
+     * Where should errors be placed?
+     *
+     * - `inline` (default): Alongside or in place of the expression that produced it.
+     * - `end`: All aggregated at the end of the Desmos expressions list.
+     * - `start`: All aggregated at the start of the Desmos expressions list.
+     */
     place_errors?: "inline" | "end" | "start";
+    /**
+     * The prefix to prepend to error blocks.
+     *
+     * Defaults to `[DESMOST ERROR]\n`.
+     *
+     * Provide a `""` blank string if you wish for no prefix to be added.
+     */
     error_prefix?: string;
+    /**
+     * Prettify LaTeX output so it renders nicely in the Desmos editor?
+     *
+     * Defaults to `true`, meaning LaTeX is prettified.
+     */
     prettify?: boolean;
+    /**
+     * Should `%` LaTeX comments be ignored, instead of turned into text expressions (notes)?
+     *
+     * Defaults to `false`, meaning comments are kept.
+     */
     ignore_comments?: boolean;
+    /**
+     * Should all line breaks be ignored, instead of kept as blank expressions?
+     *
+     * Defaults to `false`, meaning all blank lines are kept.
+     */
     ignore_all_blanks?: boolean;
+    /**
+     * Should trailing blank lines at the start of the source be kept as blank expressions?
+     *
+     * Defaults to `false`, meaning leading blank lines are ignored.
+     */
     keep_leading_blanks?: boolean;
+    /**
+     * Should trailing blank lines at the end of the source be kept as blank expressions?
+     *
+     * Defaults to `false`, meaning trailing blank lines are ignored.
+     */
     keep_trailing_blanks?: boolean;
+    /**
+     * Return debug diagnostics?
+     *
+     * This includes the unevaluated AST and performance diagnostics.
+     *
+     * Defaults to `false`, meaning `compile()` returns `void`.
+     */
     debug?: boolean;
 }
+export declare const DEFAULT_OPTIONS: {
+    errors: string;
+    place_errors: string;
+    error_prefix: string;
+    prettify: boolean;
+    ignore_comments: boolean;
+    ignore_all_blanks: boolean;
+    keep_leading_blanks: boolean;
+    keep_trailing_blanks: boolean;
+    debug: boolean;
+};
+/**
+ * Fill in `options` with Desmost's defaults to produce a complete `DesmostOptions` config.
+ */
 export declare function fill_defaults(options: Partial<DesmostOptions> | undefined): Required<DesmostOptions>;
 //# sourceMappingURL=options.d.ts.map

package/dist/compiler/options.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../src/compiler/options.ts"],"names":[],"mappings":"AASA,MAAM,WAAW,cAAc;IAY9B,MAAM,CAAC,EAAE,SAAS,GAAG,OAAO,GAAG,UAAU,CAAA;IASzC,YAAY,CAAC,EAAE,QAAQ,GAAG,KAAK,GAAG,OAAO,CAAA;IASzC,YAAY,CAAC,EAAE,MAAM,CAAA;IAOrB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAOlB,eAAe,CAAC,EAAE,OAAO,CAAA;IAOzB,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAO3B,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAO7B,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAS9B,KAAK,CAAC,EAAE,OAAO,CAAA;CACf;AAMD,wBAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,SAAS,GAAG,QAAQ,CAAC,cAAc,CAAC,CAiBpG"}
+{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../src/compiler/options.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,MAAM,WAAW,cAAc;IAE9B;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,SAAS,GAAG,OAAO,GAAG,UAAU,CAAA;IAEzC;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,QAAQ,GAAG,KAAK,GAAG,OAAO,CAAA;IAEzC;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;;;OAIG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IAEzB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAE3B;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAE7B;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAE9B;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;CACf;AAGD,eAAO,MAAM,eAAe;;;;;;;;;;CAW3B,CAAC;AAGF;;GAEG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,SAAS,GAAG,QAAQ,CAAC,cAAc,CAAC,CAMpG"}

package/dist/compiler/options.js

@@ -1,14 +1,21 @@
+export const DEFAULT_OPTIONS = {
+    errors: "surface",
+    place_errors: "inline",
+    error_prefix: "[DESMOST ERROR]\n",
+    prettify: true,
+    ignore_comments: false,
+    ignore_all_blanks: false,
+    keep_leading_blanks: false,
+    keep_trailing_blanks: false,
+    debug: false,
+};
+/**
+ * Fill in `options` with Desmost's defaults to produce a complete `DesmostOptions` config.
+ */
 export function fill_defaults(options) {
-    let out = Object.assign({}, options);
-    out.errors ??= "surface";
-    out.place_errors ??= "inline";
-    out.error_prefix ??= "[DESMOST ERROR]\n";
-    out.prettify ??= true;
-    out.ignore_comments ??= false;
-    out.ignore_all_blanks ??= false;
-    out.keep_leading_blanks ??= false;
-    out.keep_trailing_blanks ??= false;
-    out.debug ??= false;
-    return out;
+    return {
+        ...DEFAULT_OPTIONS,
+        ...options,
+    };
 }
 //# sourceMappingURL=options.js.map

package/dist/compiler/options.js.map

@@ -1 +1 @@
-{"version":3,"file":"options.js","sourceRoot":"","sources":["../../src/compiler/options.ts"],"names":[],"mappings":"AA0FA,MAAM,UAAU,aAAa,CAAC,OAA4C;IAEzE,IAAI,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IAErC,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC;IACzB,GAAG,CAAC,YAAY,KAAK,QAAQ,CAAC;IAC9B,GAAG,CAAC,YAAY,KAAK,mBAAmB,CAAC;IAEzC,GAAG,CAAC,QAAQ,KAAK,IAAI,CAAC;IAEtB,GAAG,CAAC,eAAe,KAAK,KAAK,CAAC;IAC9B,GAAG,CAAC,iBAAiB,KAAK,KAAK,CAAC;IAChC,GAAG,CAAC,mBAAmB,KAAK,KAAK,CAAC;IAClC,GAAG,CAAC,oBAAoB,KAAK,KAAK,CAAC;IACnC,GAAG,CAAC,KAAK,KAAK,KAAK,CAAC;IAEpB,OAAO,GAA+B,CAAC;AACxC,CAAC"}
+{"version":3,"file":"options.js","sourceRoot":"","sources":["../../src/compiler/options.ts"],"names":[],"mappings":"AAuFA,MAAM,CAAC,MAAM,eAAe,GAC5B;IACG,MAAM,EAAE,SAAS;IACjB,YAAY,EAAE,QAAQ;IACtB,YAAY,EAAE,mBAAmB;IACjC,QAAQ,EAAE,IAAI;IACd,eAAe,EAAE,KAAK;IACtB,iBAAiB,EAAE,KAAK;IACxB,mBAAmB,EAAE,KAAK;IAC1B,oBAAoB,EAAE,KAAK;IAC3B,KAAK,EAAE,KAAK;CACd,CAAC;AAGF;;GAEG;AACH,MAAM,UAAU,aAAa,CAAC,OAA4C;IAEvE,OAAO;QACJ,GAAG,eAAe;QAClB,GAAG,OAAO;KACgB,CAAC;AACjC,CAAC"}

package/dist/decompiler/decompile.d.ts

@@ -3,7 +3,18 @@ export interface SemiStructuredAst {
     globals: Ast.IncantationInvocation[];
     locals: Ast.Expression[];
 }
+/**
+ * Decompile Desmos into raw Desmost source code.
+ *
+ * The caller must also supply a `blank` calculator instance. This is used as a reference for default field values, so that emitted incantations like `/desmos{}` don't get filled with a huge amount of noise.
+ */
 export declare function decompile(desmos: Desmos.Calculator, blank: Desmos.Calculator): string;
+/**
+ * Decompile `desmos` into a semi-structured AST.
+ */
 export declare function desmos_to_ast(desmos: Desmos.Calculator, blank: Desmos.Calculator): SemiStructuredAst;
+/**
+ * Emit the Desmost source code representation of `ast`.
+ */
 export declare function ast_to_source(ast: SemiStructuredAst): string;
 //# sourceMappingURL=decompile.d.ts.map

package/dist/decompiler/decompile.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"decompile.d.ts","sourceRoot":"","sources":["../../src/decompiler/decompile.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAGhC,MAAM,WAAW,iBAAiB;IAE/B,OAAO,EAAE,GAAG,CAAC,qBAAqB,EAAE,CAAC;IACvC,MAAM,EAAE,GAAG,CAAC,UAAU,EAAE,CAAC;CACzB;AAQD,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,UAAU,EAAE,KAAK,EAAE,MAAM,CAAC,UAAU,GAAG,MAAM,CAGrF;AAKD,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,CAAC,UAAU,EAAE,KAAK,EAAE,MAAM,CAAC,UAAU,GAAG,iBAAiB,CASpG;AAKD,wBAAgB,aAAa,CAAC,GAAG,EAAE,iBAAiB,GAAG,MAAM,CAO5D"}
+{"version":3,"file":"decompile.d.ts","sourceRoot":"","sources":["../../src/decompiler/decompile.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAGhC,MAAM,WAAW,iBAAiB;IAE/B,OAAO,EAAE,GAAG,CAAC,qBAAqB,EAAE,CAAC;IACvC,MAAM,EAAE,GAAG,CAAC,UAAU,EAAE,CAAC;CACzB;AAGD;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,UAAU,EAAE,KAAK,EAAE,MAAM,CAAC,UAAU,GAAG,MAAM,CAGrF;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,CAAC,UAAU,EAAE,KAAK,EAAE,MAAM,CAAC,UAAU,GAAG,iBAAiB,CASpG;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,iBAAiB,GAAG,MAAM,CAO5D"}

package/dist/decompiler/decompile.js

@@ -1,9 +1,17 @@
 import { emit_global_incantation, emit_expression } from "./emit.js";
 import { extract_settings, extract_viewport, extract_expression } from "./extract.js";
 import { Ast } from "../parser/index.js";
+/**
+ * Decompile Desmos into raw Desmost source code.
+ *
+ * The caller must also supply a `blank` calculator instance. This is used as a reference for default field values, so that emitted incantations like `/desmos{}` don't get filled with a huge amount of noise.
+ */
 export function decompile(desmos, blank) {
     return ast_to_source(desmos_to_ast(desmos, blank));
 }
+/**
+ * Decompile `desmos` into a semi-structured AST.
+ */
 export function desmos_to_ast(desmos, blank) {
     return {
         globals: [
@@ -13,6 +21,9 @@ export function desmos_to_ast(desmos, blank) {
         locals: desmos.getExpressions().map(extract_expression),
     };
 }
+/**
+ * Emit the Desmost source code representation of `ast`.
+ */
 export function ast_to_source(ast) {
     return (ast.globals.map(emit_global_incantation).join("\n")
         + "\n\n"

package/dist/decompiler/decompile.js.map

@@ -1 +1 @@
-{"version":3,"file":"decompile.js","sourceRoot":"","sources":["../../src/decompiler/decompile.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAC;AAClE,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAEnF,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAehC,MAAM,UAAU,SAAS,CAAC,MAAyB,EAAE,KAAwB;IAE5E,OAAO,aAAa,CAAC,aAAa,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;AACpD,CAAC;AAKD,MAAM,UAAU,aAAa,CAAC,MAAyB,EAAE,KAAwB;IAEhF,OAAO;QACN,OAAO,EAAE;YACR,gBAAgB,CAAC,MAAM,EAAE,KAAK,CAAC;YAC/B,gBAAgB,CAAC,MAAM,EAAE,KAAK,CAAC;SAC/B,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,IAAI,CAAC;QACxB,MAAM,EAAE,MAAM,CAAC,cAAc,EAAE,CAAC,GAAG,CAAC,kBAAkB,CAAC;KACvD,CAAC;AACH,CAAC;AAKD,MAAM,UAAU,aAAa,CAAC,GAAsB;IAEnD,OAAO,CACF,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;UACjD,MAAM;UACN,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAChD,CAAC;AACH,CAAC"}
+{"version":3,"file":"decompile.js","sourceRoot":"","sources":["../../src/decompiler/decompile.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAC;AAClE,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAEnF,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAUhC;;;;GAIG;AACH,MAAM,UAAU,SAAS,CAAC,MAAyB,EAAE,KAAwB;IAE5E,OAAO,aAAa,CAAC,aAAa,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;AACpD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,aAAa,CAAC,MAAyB,EAAE,KAAwB;IAEhF,OAAO;QACN,OAAO,EAAE;YACR,gBAAgB,CAAC,MAAM,EAAE,KAAK,CAAC;YAC/B,gBAAgB,CAAC,MAAM,EAAE,KAAK,CAAC;SAC/B,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,IAAI,CAAC;QACxB,MAAM,EAAE,MAAM,CAAC,cAAc,EAAE,CAAC,GAAG,CAAC,kBAAkB,CAAC;KACvD,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,aAAa,CAAC,GAAsB;IAEnD,OAAO,CACF,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;UACjD,MAAM;UACN,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAChD,CAAC;AACH,CAAC"}

package/dist/decompiler/emit.d.ts

@@ -1,4 +1,10 @@
 import type { Ast } from "../parser/index.js";
+/**
+ * Emit the source code for a global incantation `invocation`.
+ */
 export declare function emit_global_incantation(invocation?: Ast.IncantationInvocation): string;
+/**
+ * Emit the source code for an `expr`.
+ */
 export declare function emit_expression(expr?: Ast.Expression): string;
 //# sourceMappingURL=emit.d.ts.map

package/dist/decompiler/emit.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"emit.d.ts","sourceRoot":"","sources":["../../src/decompiler/emit.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAMrC,wBAAgB,uBAAuB,CAAC,UAAU,CAAC,EAAE,GAAG,CAAC,qBAAqB,GAAG,MAAM,CAQtF;AAMD,wBAAgB,eAAe,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,UAAU,GAAG,MAAM,CA0B7D"}
+{"version":3,"file":"emit.d.ts","sourceRoot":"","sources":["../../src/decompiler/emit.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAGrC;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,UAAU,CAAC,EAAE,GAAG,CAAC,qBAAqB,GAAG,MAAM,CAQtF;AAGD;;GAEG;AACH,wBAAgB,eAAe,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,UAAU,GAAG,MAAM,CA0B7D"}

package/dist/decompiler/emit.js

@@ -1,3 +1,6 @@
+/**
+ * Emit the source code for a global incantation `invocation`.
+ */
 export function emit_global_incantation(invocation) {
     if (invocation == undefined)
         return "";
@@ -5,9 +8,13 @@ export function emit_global_incantation(invocation) {
     let arg_raw = invocation.arg_raw;
     return `/${ident}{\n  ${arg_raw}\n}`;
 }
+/**
+ * Emit the source code for an `expr`.
+ */
 export function emit_expression(expr) {
     if (expr == undefined)
         return "";
+    // TODO
     let locals = [];
     let sep = expr.incantations.length > 0 ? " :: " : "";
     let content;
@@ -16,10 +23,12 @@ export function emit_expression(expr) {
             content = `/text{ ${expr.data.text} }`;
             break;
         default:
+            // @ts-expect-error: outdated types
             if (expr.data.latex?.trim() === "") {
                 content = "";
             }
             else {
+                // @ts-expect-error: outdated types
                 content = expr.data.latex ?? "?";
             }
     }

package/dist/decompiler/emit.js.map

@@ -1 +1 @@
-{"version":3,"file":"emit.js","sourceRoot":"","sources":["../../src/decompiler/emit.ts"],"names":[],"mappings":"AAMA,MAAM,UAAU,uBAAuB,CAAC,UAAsC;IAE7E,IAAI,UAAU,IAAI,SAAS;QAAE,OAAO,EAAE,CAAC;IAErC,IAAI,KAAK,GAAG,UAAU,CAAC,WAAW,CAAC,UAAU,CAAC;IAC9C,IAAI,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC;IAEjC,OAAO,IAAI,KAAK,QAAQ,OAAO,KAAK,CAAC;AACxC,CAAC;AAMD,MAAM,UAAU,eAAe,CAAC,IAAqB;IAEpD,IAAI,IAAI,IAAI,SAAS;QAAE,OAAO,EAAE,CAAC;IAG/B,IAAI,MAAM,GAAa,EAAE,CAAC;IAE1B,IAAI,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;IAErD,IAAI,OAAO,CAAC;IAEZ,QAAQ,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QACtB,KAAK,MAAM;YACR,OAAO,GAAG,UAAU,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC;YACvC,MAAM;QACT;YAEG,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;gBAClC,OAAO,GAAG,EAAE,CAAC;YAChB,CAAC;iBAAM,CAAC;gBAEL,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,GAAG,CAAC;YACpC,CAAC;IACP,CAAC;IAED,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,OAAO,EAAE,CAAC;AAChD,CAAC"}
+{"version":3,"file":"emit.js","sourceRoot":"","sources":["../../src/decompiler/emit.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,MAAM,UAAU,uBAAuB,CAAC,UAAsC;IAE7E,IAAI,UAAU,IAAI,SAAS;QAAE,OAAO,EAAE,CAAC;IAErC,IAAI,KAAK,GAAG,UAAU,CAAC,WAAW,CAAC,UAAU,CAAC;IAC9C,IAAI,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC;IAEjC,OAAO,IAAI,KAAK,QAAQ,OAAO,KAAK,CAAC;AACxC,CAAC;AAGD;;GAEG;AACH,MAAM,UAAU,eAAe,CAAC,IAAqB;IAEpD,IAAI,IAAI,IAAI,SAAS;QAAE,OAAO,EAAE,CAAC;IAEjC,OAAO;IACL,IAAI,MAAM,GAAa,EAAE,CAAC;IAE1B,IAAI,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;IAErD,IAAI,OAAO,CAAC;IAEZ,QAAQ,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QACtB,KAAK,MAAM;YACR,OAAO,GAAG,UAAU,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC;YACvC,MAAM;QACT;YACG,mCAAmC;YACnC,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;gBAClC,OAAO,GAAG,EAAE,CAAC;YAChB,CAAC;iBAAM,CAAC;gBACL,mCAAmC;gBACnC,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,GAAG,CAAC;YACpC,CAAC;IACP,CAAC;IAED,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,OAAO,EAAE,CAAC;AAChD,CAAC"}

package/dist/decompiler/extract.d.ts

@@ -1,5 +1,14 @@
 import { Ast } from "../parser/index.js";
+/**
+ * Extract a `/desmos` incantation from the settings of `desmos`.
+ */
 export declare function extract_settings(desmos: Desmos.Calculator, blank: Desmos.Calculator): Ast.IncantationInvocation | null;
+/**
+ * Extract a `/viewport` incantation from the viewport bounds of `desmos`.
+ */
 export declare function extract_viewport(desmos: Desmos.Calculator, blank: Desmos.Calculator): Ast.IncantationInvocation | null;
+/**
+ * Extract an expression and the local incantations that reproduce its state.
+ */
 export declare function extract_expression(expression: Desmos.ExpressionState): Ast.Expression;
 //# sourceMappingURL=extract.d.ts.map

package/dist/decompiler/extract.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"extract.d.ts","sourceRoot":"","sources":["../../src/decompiler/extract.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAQhC,wBAAgB,gBAAgB,CAC7B,MAAM,EAAE,MAAM,CAAC,UAAU,EACzB,KAAK,EAAE,MAAM,CAAC,UAAU,GACxB,GAAG,CAAC,qBAAqB,GAAG,IAAI,CAuBlC;AAKD,wBAAgB,gBAAgB,CAC7B,MAAM,EAAE,MAAM,CAAC,UAAU,EACzB,KAAK,EAAE,MAAM,CAAC,UAAU,GACxB,GAAG,CAAC,qBAAqB,GAAG,IAAI,CAkBlC;AAKD,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,MAAM,CAAC,eAAe,GAAG,GAAG,CAAC,UAAU,CAuBrF"}
+{"version":3,"file":"extract.d.ts","sourceRoot":"","sources":["../../src/decompiler/extract.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAKhC;;GAEG;AACH,wBAAgB,gBAAgB,CAC7B,MAAM,EAAE,MAAM,CAAC,UAAU,EACzB,KAAK,EAAE,MAAM,CAAC,UAAU,GACxB,GAAG,CAAC,qBAAqB,GAAG,IAAI,CAuBlC;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAC7B,MAAM,EAAE,MAAM,CAAC,UAAU,EACzB,KAAK,EAAE,MAAM,CAAC,UAAU,GACxB,GAAG,CAAC,qBAAqB,GAAG,IAAI,CAkBlC;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,MAAM,CAAC,eAAe,GAAG,GAAG,CAAC,UAAU,CAuBrF"}

package/dist/decompiler/extract.js

@@ -1,6 +1,9 @@
 import { stringify_json5, prettify_source } from "./format.js";
 import { Ast } from "../parser/index.js";
 import { DesmosIncantation, ViewportIncantation } from "../magic/global/index.js";
+/**
+ * Extract a `/desmos` incantation from the settings of `desmos`.
+ */
 export function extract_settings(desmos, blank) {
     let defaults = blank.settings;
     let arg_raw = stringify_json5(desmos.settings, (k, v) => (v === defaults[k]
@@ -16,6 +19,9 @@ export function extract_settings(desmos, blank) {
         arg_raw,
     };
 }
+/**
+ * Extract a `/viewport` incantation from the viewport bounds of `desmos`.
+ */
 export function extract_viewport(desmos, blank) {
     let defaults = blank.graphpaperBounds.mathCoordinates;
     let { left, right, bottom, top } = desmos.graphpaperBounds.mathCoordinates;
@@ -28,8 +34,12 @@ export function extract_viewport(desmos, blank) {
         arg_raw,
     };
 }
+/**
+ * Extract an expression and the local incantations that reproduce its state.
+ */
 export function extract_expression(expression) {
     let data;
+    // @ts-expect-error: outdated types
     if (expression.latex?.trim() === "") {
         data = { latex: ` ` };
     }
@@ -43,7 +53,7 @@ export function extract_expression(expression) {
     return {
         kind: Ast.Kind.EXPRESSION,
         data,
-        incantations: [],
+        incantations: [], // TODO
     };
 }
 function is_insignificant(key, value) {

package/dist/decompiler/extract.js.map

@@ -1 +1 @@
-{"version":3,"file":"extract.js","sourceRoot":"","sources":["../../src/decompiler/extract.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAE5D,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAEhC,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAMzE,MAAM,UAAU,gBAAgB,CAC7B,MAAyB,EACzB,KAAwB;IAGxB,IAAI,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;IAE9B,IAAI,OAAO,GAAG,eAAe,CAC1B,MAAM,CAAC,QAAQ,EACf,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CACJ,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC;WACjB,CAAC,KAAK,aAAa;WACnB,CAAC,KAAK,MAAM;WACZ,CAAC,KAAK,YAAY;WAClB,CAAC,KAAK,QAAQ,CACnB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EACjB,IAAI,CACN,CAAC;IAEF,IAAI,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE;QAAE,OAAO,IAAI,CAAC;IAEzC,OAAO;QACN,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,sBAAsB;QACrC,WAAW,EAAE,IAAI,iBAAiB,EAAE;QACpC,OAAO;KACP,CAAC;AACH,CAAC;AAKD,MAAM,UAAU,gBAAgB,CAC7B,MAAyB,EACzB,KAAwB;IAGxB,IAAI,QAAQ,GAAG,KAAK,CAAC,gBAAgB,CAAC,eAAe,CAAC;IACxD,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC,gBAAgB,CAAC,eAAe,CAAC;IAEzE,IAAI,OAAO,GAAG,eAAe,CAC1B,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,EAC5B,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAC3C,IAAI,CACN,CAAC;IAEF,IAAI,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE;QAAE,OAAO,IAAI,CAAC;IAEzC,OAAO;QACN,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,sBAAsB;QACrC,WAAW,EAAE,IAAI,mBAAmB,EAAE;QACtC,OAAO;KACP,CAAC;AACH,CAAC;AAKD,MAAM,UAAU,kBAAkB,CAAC,UAAkC;IAElE,IAAI,IAAI,CAAC;IAGT,IAAI,UAAU,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QACnC,IAAI,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC;IACzB,CAAC;SAAM,CAAC;QACL,IAAI,GAAG,MAAM,CAAC,WAAW,CACtB,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC;aACzB,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,gBAAgB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAC1D,CAAC;IACL,CAAC;IAED,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;QACnB,IAAI,CAAC,KAAK,GAAG,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC5C,CAAC;IAEH,OAAO;QACN,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,UAAU;QACzB,IAAI;QACJ,YAAY,EAAE,EAAE;KAChB,CAAC;AACH,CAAC;AAGD,SAAS,gBAAgB,CAAC,GAAW,EAAE,KAAU;IAE9C,OAAO,CACD,KAAK,KAAK,EAAE;WACZ,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAC3E,CAAC;AACL,CAAC"}
+{"version":3,"file":"extract.js","sourceRoot":"","sources":["../../src/decompiler/extract.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAE5D,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAEhC,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAGzE;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAC7B,MAAyB,EACzB,KAAwB;IAGxB,IAAI,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;IAE9B,IAAI,OAAO,GAAG,eAAe,CAC1B,MAAM,CAAC,QAAQ,EACf,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CACJ,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC;WACjB,CAAC,KAAK,aAAa;WACnB,CAAC,KAAK,MAAM;WACZ,CAAC,KAAK,YAAY;WAClB,CAAC,KAAK,QAAQ,CACnB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EACjB,IAAI,CACN,CAAC;IAEF,IAAI,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE;QAAE,OAAO,IAAI,CAAC;IAEzC,OAAO;QACN,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,sBAAsB;QACrC,WAAW,EAAE,IAAI,iBAAiB,EAAE;QACpC,OAAO;KACP,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAC7B,MAAyB,EACzB,KAAwB;IAGxB,IAAI,QAAQ,GAAG,KAAK,CAAC,gBAAgB,CAAC,eAAe,CAAC;IACxD,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC,gBAAgB,CAAC,eAAe,CAAC;IAEzE,IAAI,OAAO,GAAG,eAAe,CAC1B,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,EAC5B,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAC3C,IAAI,CACN,CAAC;IAEF,IAAI,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE;QAAE,OAAO,IAAI,CAAC;IAEzC,OAAO;QACN,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,sBAAsB;QACrC,WAAW,EAAE,IAAI,mBAAmB,EAAE;QACtC,OAAO;KACP,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAC,UAAkC;IAElE,IAAI,IAAI,CAAC;IAET,mCAAmC;IACnC,IAAI,UAAU,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QACnC,IAAI,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC;IACzB,CAAC;SAAM,CAAC;QACL,IAAI,GAAG,MAAM,CAAC,WAAW,CACtB,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC;aACzB,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,gBAAgB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAC1D,CAAC;IACL,CAAC;IAED,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;QACnB,IAAI,CAAC,KAAK,GAAG,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC5C,CAAC;IAEH,OAAO;QACN,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,UAAU;QACzB,IAAI;QACJ,YAAY,EAAE,EAAE,EAAG,OAAO;KAC1B,CAAC;AACH,CAAC;AAGD,SAAS,gBAAgB,CAAC,GAAW,EAAE,KAAU;IAE9C,OAAO,CACD,KAAK,KAAK,EAAE;WACZ,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAC3E,CAAC;AACL,CAAC"}