desmost 0.7.3 → 0.8.1

package/src/magic/global/desmos.ts

@@ -1,22 +1,25 @@
 import { Incantation, ArgIncantation, type GLOBAL } from "../incantation";
 
 
+type DesmosSettings = Desmos.GraphConfiguration & Desmos.GraphSettings
+
+
 export class DesmosIncantation extends ArgIncantation<GLOBAL>
 {
-  override readonly description
-    = "Set the configuration of the calculator via `Calculator.updateSettings()`."
-  
-  override readonly identifier   = "desmos"
-  override readonly requires_arg = false
-  override readonly arg_type     = Incantation.ArgType.OBJECT
+	override readonly description
+		= "Set the configuration of the calculator via `Calculator.updateSettings()`."
+	
+	override readonly identifier   = "desmos"
+	override readonly requires_arg = false
+	override readonly arg_type     = Incantation.ArgType.OBJECT
 
-  override apply(
-    target: Desmos.Calculator,
-    data?: Desmos.GraphConfiguration & Desmos.GraphSettings,
-  ): void
-  {
-    if (data != undefined) {
-      target.updateSettings(data);
-    }
-  }
+	override apply(
+		target: Desmos.Calculator,
+		data?: DesmosSettings,
+	): void
+	{
+		if (data != undefined) {
+			target.updateSettings(data);
+		}
+	}
 }

package/src/magic/global/index.ts

@@ -1,3 +1,8 @@
+export { DesmosIncantation } from "./desmos";
+export { ViewportIncantation } from "./viewport";
+export { DarkModeIncantation } from "./dark-mode";
+
+
 import { Incantation, type GLOBAL } from "../incantation";
 
 import { DesmosIncantation } from "./desmos";
@@ -7,7 +12,7 @@ import { DarkModeIncantation } from "./dark-mode";
 
 export const GLOBAL_INCANTATIONS: Incantation<GLOBAL>[] =
 [
-  new DesmosIncantation(),
-  new ViewportIncantation(),
-  new DarkModeIncantation(),
+	new DesmosIncantation(),
+	new ViewportIncantation(),
+	new DarkModeIncantation(),
 ];

package/src/magic/global/viewport.ts

@@ -3,32 +3,31 @@ import { Incantation, ArgIncantation, type GLOBAL } from "../incantation";
 
 interface ViewportBounds
 {
-  left?:   number; right?: number;
-  bottom?: number; top?:   number;
+	left?:   number; right?: number;
+	bottom?: number; top?:   number;
 }
 
 
 export class ViewportIncantation extends ArgIncantation<GLOBAL>
 {
-  override readonly description
-    = "Set the bounds of the viewport via `Calculator.setMathBounds()`."
-  
-  override readonly identifier   = "viewport"
-  override readonly requires_arg = true
-  override readonly arg_type     = Incantation.ArgType.OBJECT
+	override readonly description
+		= "Set the bounds of the viewport via `Calculator.setMathBounds()`."
+	
+	override readonly identifier   = "viewport"
+	override readonly requires_arg = true
+	override readonly arg_type     = Incantation.ArgType.OBJECT
 
-  apply(target: Desmos.Calculator, data: ViewportBounds)
-  {
-    let existing = target.graphpaperBounds.mathCoordinates;
-    console.log(`existing =`, existing);
+	apply(target: Desmos.Calculator, data: ViewportBounds)
+	{
+		let existing = target.graphpaperBounds.mathCoordinates;
 
-    let {
-      left   = existing.left,
-      right  = existing.right,
-      bottom = existing.bottom,
-      top    = existing.top,
-    } = data;
+		let {
+			left   = existing.left,
+			right  = existing.right,
+			bottom = existing.bottom,
+			top    = existing.top,
+		} = data;
 
-    target.setMathBounds({ left, right, bottom, top });
-  }
+		target.setMathBounds({ left, right, bottom, top });
+	}
 }

package/src/magic/incantation.ts

@@ -17,38 +17,38 @@ import { UnrecoverableError, type Unrecoverable } from "../errors";
  * Incantations that accept an argument derive from `ArgIncantation`.
  */
 export abstract class Incantation<
-  Effect extends Incantation.Effect = Incantation.Effect
+	Effect extends Incantation.Effect = Incantation.Effect
 >
 {
-  /** Short user-facing description of what the incantation does. */
-  public abstract readonly description: string
-
-  /** The raw text sequence that matches this incantation, such as `viewport` or `hidden`. */
-  public abstract readonly identifier: string
-
-  /** An alternative `.identifier`, strictly for localisation purposes only. */
-  public readonly alias?: string
-
-
-  /** Apply this incantation's effect to `target`, using the provided `data` if required. */
-  public abstract apply(
-    target: Effect extends GLOBAL ? Desmos.Calculator : Desmos.ExpressionState,
-    data?: unknown,
-  ): void
-
-  /** Error if the `actual` type of the given expression is not `required`. */
-  protected require_expr_type<T extends Desmos.ExpressionState["type"]>(
-    actual: unknown,
-    required: T,
-  ): asserts actual is T
-  {
-    if ((actual ?? "expression") !== required)
-    {
-      throw new UnrecoverableError.IllegalIncantation(
-        `/${this.identifier} can only applied to ${required === "expression" ? "latex" : required} expressions, but target block has type: ${actual}`
-      );
-    }
-  }
+	/** Short user-facing description of what the incantation does. */
+	public abstract readonly description: string
+
+	/** The raw text sequence that matches this incantation, such as `viewport` or `hidden`. */
+	public abstract readonly identifier: string
+
+	/** An alternative `.identifier`, strictly for localisation purposes only. */
+	public readonly alias?: string
+
+
+	/** Apply this incantation's effect to `target`, using the provided `data` if required. */
+	public abstract apply(
+		target: Effect extends GLOBAL ? Desmos.Calculator : Desmos.ExpressionState,
+		data?: unknown,
+	): void
+
+	/** Error if the `actual` type of the given expression is not `required`. */
+	protected require_expr_type<T extends Desmos.ExpressionState["type"]>(
+		actual: unknown,
+		required: T,
+	): asserts actual is T
+	{
+		if ((actual ?? "expression") !== required)
+		{
+			throw new UnrecoverableError.IllegalIncantation(
+				`/${this.identifier} can only applied to ${required === "expression" ? "latex" : required} expressions, but target block has type: ${actual}`
+			);
+		}
+	}
 }
 
 
@@ -56,77 +56,77 @@ export abstract class Incantation<
  * An incantation that accepts an argument.
  */
 export abstract class ArgIncantation<
-  Effect extends Incantation.Effect = Incantation.Effect
+	Effect extends Incantation.Effect = Incantation.Effect
 >
-  extends Incantation<Effect>
+	extends Incantation<Effect>
 {
-  /** Does this incantation always require an argument to be passed? */
-  public readonly requires_arg: boolean = true
-
-  /** What type of argument does this incantation accept? */
-  public abstract readonly arg_type: Incantation.ArgType
-
-
-  /**
-   * Evaluate the argument provided to this incantation, throwing if an error is encountered.
-   * 
-   * For instance, for `/viewport{ left: -1, right: 1 }`, this returns the POJO `{ left: -1, right: 1 }`.
-   * 
-   * ## Notes
-   * 
-   * Child incantation classes should override this method, though the defaults should cover most cases (except `ArgType.ENUM`).
-   */
-  public evaluate_arg(raw: string): Unrecoverable<unknown>
-  {
-    switch (this.arg_type) {
-      case Incantation.ArgType.STRING: return raw;
-      case Incantation.ArgType.LATEX:  return raw;
-      case Incantation.ArgType.ENUM:   return raw;
-      
-      case Incantation.ArgType.OBJECT: {
-        try {
-          return Json5.parse(`{${raw}}`);
-        }
-        catch (e) {
-          // @ts-expect-error: fine
-          throw new UnrecoverableError.InvalidArgument(e.message);
-        }
-      }
-    }
-  }
+	/** Does this incantation always require an argument to be passed? */
+	public readonly requires_arg: boolean = true
+
+	/** What type of argument does this incantation accept? */
+	public abstract readonly arg_type: Incantation.ArgType
+
+
+	/**
+	 * Evaluate the argument provided to this incantation, throwing if an error is encountered.
+	 * 
+	 * For instance, for `/viewport{ left: -1, right: 1 }`, this returns the POJO `{ left: -1, right: 1 }`.
+	 * 
+	 * ## Notes
+	 * 
+	 * Child incantation classes should override this method, though the defaults should cover most cases (except `ArgType.ENUM`).
+	 */
+	public evaluate_arg(raw: string): Unrecoverable<unknown>
+	{
+		switch (this.arg_type) {
+			case Incantation.ArgType.STRING: return raw;
+			case Incantation.ArgType.LATEX:  return raw;
+			case Incantation.ArgType.ENUM:   return raw;
+			
+			case Incantation.ArgType.OBJECT: {
+				try {
+					return Json5.parse(`{${raw}}`);
+				}
+				catch (e) {
+					// @ts-expect-error: fine
+					throw new UnrecoverableError.InvalidArgument(e.message);
+				}
+			}
+		}
+	}
 }
 
 
 export namespace Incantation
 {
-  /** The kind of effect an incantation produces - it either modifies only one block, or modifies the calculator as a whole. */
-  export enum Effect
-  {
-    /** An incantation that affects the entire Desmos calculator state, like `/desmos` or `/viewport`. */
-    GLOBAL,
-
-    /** An incantation that affects only the expression immediately following it, like `/hide` or `/slider`. */
-    LOCAL,
-    
-    /** An incantation that produces an expression, like `/latex` or `/text`. */
-    EXPR,
-  }
-
-  /** The type of argument an incantation accepts, which affects how it is parsed. */
-  export enum ArgType
-  {
-    /** Any arbitrary user text content, where characters like `"` and `'` don't have semantic meaning and can be ignored. */
-    STRING = "String",
-
-    /** LaTeX, which should have balanced `{}` braces. */
-    LATEX = "LaTeX",
-
-    /** Specific value from an allowed set of values, which will map to an enum value in the Desmos API. */
-    ENUM = "Enum",
-
-    /** JavaScript object fields, where characters like `{}` and `"` all have semantic meaning, and must be balanced. */
-    OBJECT = "Object",
-  }
+	/** The kind of effect an incantation produces - it either modifies only one block, or modifies the calculator as a whole. */
+	export enum Effect
+	{
+		/** An incantation that affects the entire Desmos calculator state, like `/desmos` or `/viewport`. */
+		GLOBAL,
+
+		/** An incantation that affects only the expression immediately following it, like `/hide` or `/slider`. */
+		LOCAL,
+		
+		/** An incantation that produces an expression, like `/latex` or `/text`. */
+		EXPR,
+	}
+
+	/** The type of argument an incantation accepts, which affects how it is parsed. */
+	export enum ArgType
+	{
+		/** Any arbitrary user text content, where characters like `"` and `'` don't have semantic meaning and can be ignored. */
+		STRING = "String",
+
+		/** LaTeX, which should have balanced `{}` braces. */
+		LATEX = "LaTeX",
+
+		/** Specific value from an allowed set of values, which will map to an enum value in the Desmos API. */
+		ENUM = "Enum",
+
+		/** JavaScript object fields, where characters like `{}` and `"` all have semantic meaning, and must be balanced. */
+		OBJECT = "Object",
+	}
 }
 
 

package/src/magic/local/anim.ts

@@ -3,15 +3,15 @@ import { Incantation, type LOCAL } from "../incantation";
 
 export class AnimIncantation extends Incantation<LOCAL>
 {
-  override readonly description
-    = "Animate the slider of a block."
-  
-  override readonly identifier = "anim"
+	override readonly description
+		= "Animate the slider of a block."
+	
+	override readonly identifier = "anim"
 
-  override apply(target: Desmos.ExpressionState)
-  {
-    super.require_expr_type(target.type, "expression");
-    // @ts-expect-error: outdated types
-    target.playing = true;
-  }
+	override apply(target: Desmos.ExpressionState)
+	{
+		super.require_expr_type(target.type, "expression");
+		// @ts-expect-error: outdated types
+		target.playing = true;
+	}
 }

package/src/magic/local/colour.ts

@@ -6,33 +6,33 @@ import { DesmosColour } from "../../desmos";
 
 export class ColourIncantation extends ArgIncantation<LOCAL>
 {
-  override readonly description
-    = ""
+	override readonly description
+		= ""
 
-  override readonly identifier   = "color"
-  override readonly alias        = "colour"
-  override readonly requires_arg = true
-  override readonly arg_type     = Incantation.ArgType.ENUM
+	override readonly identifier   = "color"
+	override readonly alias        = "colour"
+	override readonly requires_arg = true
+	override readonly arg_type     = Incantation.ArgType.ENUM
 
-  override apply(target: Desmos.ExpressionState, data: DesmosColour)
-  {
-    super.require_expr_type(target.type, "expression");
-    target.color = data;
-  }
+	override apply(target: Desmos.ExpressionState, data: DesmosColour)
+	{
+		super.require_expr_type(target.type, "expression");
+		target.color = data;
+	}
 
-  override evaluate_arg(data: string): DesmosColour
-  {
-    switch (data.trim().toUpperCase()) {
-      case "RED":    return DesmosColour.RED;
-      case "BLUE":   return DesmosColour.BLUE;
-      case "GREEN":  return DesmosColour.GREEN;
-      case "PURPLE": return DesmosColour.PURPLE;
-      case "ORANGE": return DesmosColour.ORANGE;
-      case "BLACK":  return DesmosColour.BLACK;
-      default:
-        throw new UnrecoverableError(
-          `Invalid colour: \`${data}\``
-        );
-    }
-  }
+	override evaluate_arg(data: string): DesmosColour
+	{
+		switch (data.trim().toUpperCase()) {
+			case "RED":    return DesmosColour.RED;
+			case "BLUE":   return DesmosColour.BLUE;
+			case "GREEN":  return DesmosColour.GREEN;
+			case "PURPLE": return DesmosColour.PURPLE;
+			case "ORANGE": return DesmosColour.ORANGE;
+			case "BLACK":  return DesmosColour.BLACK;
+			default:
+				throw new UnrecoverableError(
+					`Invalid colour: \`${data}\``
+				);
+		}
+	}
 }

package/src/magic/local/dashed.ts

@@ -3,14 +3,14 @@ import { Incantation, type LOCAL } from "../incantation";
 
 export class DashedIncantation extends Incantation<LOCAL>
 {
-  override readonly description
-    = "Render a block as a dashed line."
-  
-  override readonly identifier = "dashed"
+	override readonly description
+		= "Render a block as a dashed line."
+	
+	override readonly identifier = "dashed"
 
-  override apply(target: Desmos.ExpressionState)
-  {
-    super.require_expr_type(target.type, "expression");
-    target.lineStyle = Desmos.Styles.DASHED;
-  }
+	override apply(target: Desmos.ExpressionState)
+	{
+		super.require_expr_type(target.type, "expression");
+		target.lineStyle = Desmos.Styles.DASHED;
+	}
 }

package/src/magic/local/fill.ts

@@ -3,22 +3,22 @@ import { Incantation, ArgIncantation, type LOCAL } from "../incantation";
 
 interface FillOptions
 {
-  opacity: number;
+	opacity: number;
 }
 
 
 export class FillIncantation extends ArgIncantation<LOCAL>
 {
-  override readonly description
-    = "Change fill styles for a rendered block."
-  
-  override readonly identifier   = "fill"
-  override readonly requires_arg = true
-  override readonly arg_type     = Incantation.ArgType.OBJECT
+	override readonly description
+		= "Change fill styles for a rendered block."
+	
+	override readonly identifier   = "fill"
+	override readonly requires_arg = true
+	override readonly arg_type     = Incantation.ArgType.OBJECT
 
-  override apply(target: Desmos.ExpressionState, data: FillOptions)
-  {
-    super.require_expr_type(target.type, "expression");
-    target.fillOpacity = data.opacity;
-  }
+	override apply(target: Desmos.ExpressionState, data: FillOptions)
+	{
+		super.require_expr_type(target.type, "expression");
+		target.fillOpacity = data.opacity;
+	}
 }

package/src/magic/local/hide.ts

@@ -3,14 +3,14 @@ import { Incantation, type LOCAL } from "../incantation";
 
 export class HideIncantation extends Incantation<LOCAL>
 {
-  override readonly description
-    = "Hide rendering for a block. This includes graphs, points, polygons, etc."
-  
-  override readonly identifier = "hide"
+	override readonly description
+		= "Hide rendering for a block. This includes graphs, points, polygons, etc."
+	
+	override readonly identifier = "hide"
 
-  apply(target: Desmos.ExpressionState)
-  {
-    super.require_expr_type(target.type, "expression");
-    target.hidden = true;
-  }
+	apply(target: Desmos.ExpressionState)
+	{
+		super.require_expr_type(target.type, "expression");
+		target.hidden = true;
+	}
 }

package/src/magic/local/index.ts

@@ -15,15 +15,15 @@ import { SliderIncantation } from "./slider";
 
 export const LOCAL_INCANTATIONS: Incantation<LOCAL>[] =
 [
-  new AnimIncantation(),
-  new ColourIncantation(),
-  new DashedIncantation(),
-  new FillIncantation(),
-  new HideIncantation(),
-  new LabelIncantation(),
-  new LineIncantation(),
-  new NoLineIncantation(),
-  new PointIncantation(),
-  new SecretIncantation(),
-  new SliderIncantation(),
+	new AnimIncantation(),
+	new ColourIncantation(),
+	new DashedIncantation(),
+	new FillIncantation(),
+	new HideIncantation(),
+	new LabelIncantation(),
+	new LineIncantation(),
+	new NoLineIncantation(),
+	new PointIncantation(),
+	new SecretIncantation(),
+	new SliderIncantation(),
 ];

package/src/magic/local/label.ts

@@ -4,60 +4,60 @@ import { Incantation, ArgIncantation, type LOCAL } from "../incantation";
 
 interface LabelOptions
 {
-  text: string;
-  show?: boolean;
-  size?: number | keyof typeof Desmos.LabelSizes;
-  pos?: keyof typeof Desmos.LabelOrientations;
+	text: string;
+	show?: boolean;
+	size?: number | keyof typeof Desmos.LabelSizes;
+	pos?: keyof typeof Desmos.LabelOrientations;
 }
 
 
 export class LabelIncantation extends ArgIncantation<LOCAL>
 {
-  override readonly description
-    = "Label a block that evaluates to a point(s)."
-
-  override readonly identifier   = "label"
-  override readonly requires_arg = true
-  override readonly arg_type     = Incantation.ArgType.OBJECT
-
-  override apply(target: Desmos.ExpressionState, data: LabelOptions)
-  {
-    super.require_expr_type(target.type, "expression");
-    target.label = data.text;
-    target.showLabel = data.show ?? true;
-    // @ts-expect-error: outdated types TODO check
-    if (data.size != undefined) target.labelSize = data.size;
-    if (data.pos  != undefined) target.labelOrientation = data.pos;
-  }
-
-  override evaluate_arg(raw: string): LabelOptions
-  {
-    let out = super.evaluate_arg(raw) as LabelOptions;
-
-    if (!("text" in out)) {
-      throw new UnrecoverableError.InvalidArgument(
-        `/label requires a \`text\` argument, such as: \`/label{ text: "sup world!" }\``
-      );
-    }
-
-    if (typeof out.pos != "undefined") {
-      let pos = out.pos.trim().toUpperCase();
-
-      switch (pos) {
-        case "ABOVE":
-        case "BELOW":
-        case "LEFT":
-        case "RIGHT":
-          out.pos = pos;
-          break;
-        
-        default:
-          throw new UnrecoverableError.InvalidArgument(
-            `/label: Invalid label position: ${pos}`
-          );
-      }
-    }
-
-    return out;
-  }
+	override readonly description
+		= "Label a block that evaluates to a point(s)."
+
+	override readonly identifier   = "label"
+	override readonly requires_arg = true
+	override readonly arg_type     = Incantation.ArgType.OBJECT
+
+	override apply(target: Desmos.ExpressionState, data: LabelOptions)
+	{
+		super.require_expr_type(target.type, "expression");
+		target.label = data.text;
+		target.showLabel = data.show ?? true;
+		// @ts-expect-error: outdated types TODO check
+		if (data.size != undefined) target.labelSize = data.size;
+		if (data.pos  != undefined) target.labelOrientation = data.pos;
+	}
+
+	override evaluate_arg(raw: string): LabelOptions
+	{
+		let out = super.evaluate_arg(raw) as LabelOptions;
+
+		if (!("text" in out)) {
+			throw new UnrecoverableError.InvalidArgument(
+				`/label requires a \`text\` argument, such as: \`/label{ text: "sup world!" }\``
+			);
+		}
+
+		if (typeof out.pos != "undefined") {
+			let pos = out.pos.trim().toUpperCase();
+
+			switch (pos) {
+				case "ABOVE":
+				case "BELOW":
+				case "LEFT":
+				case "RIGHT":
+					out.pos = pos;
+					break;
+				
+				default:
+					throw new UnrecoverableError.InvalidArgument(
+						`/label: Invalid label position: ${pos}`
+					);
+			}
+		}
+
+		return out;
+	}
 }