Merge pull request #1153 from mathjax/context

dpvc · web-flow · commit dfe138910b2f · 2024-11-15T12:19:26.000-05:00
Add context.ts to hold hasWindow flag and browser's window and document objects.
diff --git a/components/mjs/a11y/explorer/explorer.js b/components/mjs/a11y/explorer/explorer.js
@@ -1,7 +1,8 @@
 import './lib/explorer.js';
 
 import {ExplorerHandler} from '#js/a11y/explorer.js';
+import {hasWindow} from '#js/util/context.js';
 
-if (MathJax.startup && typeof window !== 'undefined') {
+if (MathJax.startup && hasWindow) {
   MathJax.startup.extendHandler(handler => ExplorerHandler(handler));
 }
diff --git a/components/mjs/a11y/sre/sre.js b/components/mjs/a11y/sre/sre.js
@@ -1,11 +1,11 @@
 import './lib/sre.js';
 import './sre_config.js';
+import {context} from '#js/util/context.js';
 import * as Sre from '#js/a11y/sre.js';
 
 export {Sre};
 
 if (MathJax.startup) {
-  ((typeof window !== 'undefined') ? window : global).
-    SREfeature.custom = (loc) => Sre.preloadLocales(loc);
+  (context.window || global).SREfeature.custom = (loc) => Sre.preloadLocales(loc);
 }
 
diff --git a/components/mjs/a11y/sre/sre_config.js b/components/mjs/a11y/sre/sre_config.js
@@ -1,13 +1,14 @@
 import {combineDefaults} from '#js/components/global.js';
 import {Package} from '#js/components/package.js';
+import {context} from '#js/util/context.js';
 
 // This sets up the correct link to the mathmaps files.
 if (MathJax.startup) {
 
   let path = Package.resolvePath('[sre]', false);
 
-  if (typeof window !== 'undefined') {
-    window.SREfeature = {json: path};
+  if (context.window) {
+    context.window.SREfeature = {json: path};
   } else {
     // In Node get the absolute path to the mathmaps directory.
     try {
diff --git a/components/mjs/input/tex/extension.js b/components/mjs/input/tex/extension.js
@@ -1,8 +1,9 @@
 import {combineDefaults} from '#js/components/global.js';
+import {hasWindow} from '#js/util/context.js';
 
 export function fontExtension(id, name, pkg = `@mathjax/${name}`) {
   if (MathJax.loader) {
-    const FONTPATH = (typeof document === 'undefined' ? pkg : `https://cdn.jsdelivr.net/npm/${name}`);
+    const FONTPATH = hasWindow ? `https://cdn.jsdelivr.net/npm/${name}` : pkg;
     const path = name.replace(/-font-extension$/, '-extension');
     const extension = name.replace(/-font-extension$/, '');
     const jax = (MathJax.config?.startup?.output || 'chtml');
diff --git a/components/mjs/output/util.js b/components/mjs/output/util.js
@@ -1,9 +1,10 @@
 import {combineDefaults, combineWithMathJax} from '#js/components/global.js';
-import {Package} from "#js/components/package.js";
+import {Package} from '#js/components/package.js';
+import {hasWindow} from '#js/util/context.js';
 
-export const FONTPATH = (typeof document === 'undefined' ?
-                         '@mathjax/%%FONT%%-font' :
-                         'https://cdn.jsdelivr.net/npm/%%FONT%%-font');
+export const FONTPATH = hasWindow ?
+                        'https://cdn.jsdelivr.net/npm/%%FONT%%-font':
+                        '@mathjax/%%FONT%%-font';
 
 export const OutputUtil = {
   config(jax, jaxClass, defaultFont, fontClass) {
diff --git a/components/mjs/ui/menu/menu.js b/components/mjs/ui/menu/menu.js
@@ -2,7 +2,8 @@ import './lib/menu.js';
 
 import {combineDefaults} from '#js/components/global.js';
 import {MenuHandler} from '#js/ui/menu/MenuHandler.js';
+import {hasWindow} from '#js/util/context.js';
 
-if (MathJax.startup && typeof window !== 'undefined') {
+if (MathJax.startup && hasWindow) {
   MathJax.startup.extendHandler(handler => MenuHandler(handler), 20);
 }
diff --git a/ts/a11y/explorer.ts b/ts/a11y/explorer.ts
@@ -33,6 +33,7 @@ import {
 import { MathDocumentConstructor } from '../core/MathDocument.js';
 import { OptionList, expandable } from '../util/Options.js';
 import { SerializedMmlVisitor } from '../core/MmlTree/SerializedMmlVisitor.js';
+import { hasWindow } from '../util/context.js';
 
 import { ExplorerPool, RegionPool } from './explorer/ExplorerPool.js';
 
@@ -51,8 +52,6 @@ export type HTMLDOCUMENT = EnrichedMathDocument<HTMLElement, Text, Document>;
 export type HTMLMATHITEM = EnrichedMathItem<HTMLElement, Text, Document>;
 export type MATHML = MathML<HTMLElement, Text, Document>;
 
-const hasWindow = typeof window !== 'undefined';
-
 /*==========================================================================*/
 
 /**
diff --git a/ts/adaptors/chooseAdaptor.ts b/ts/adaptors/chooseAdaptor.ts
@@ -23,18 +23,10 @@
 
 import { liteAdaptor } from './liteAdaptor.js';
 import { browserAdaptor } from './browserAdaptor.js';
-
-let choose;
-
-try {
-  // errors if not in browser
-  document; // eslint-disable-line @typescript-eslint/no-unused-expressions
-  choose = browserAdaptor;
-} catch (_e) {
-  choose = liteAdaptor;
-}
+import { context } from '../util/context.js';
 
 /**
- * Function to select which adaptor to use (depending on whether we are in a browser or node.js)
+ *  Select which adaptor to use (depending on whether we are in a browser or node.js)
  */
-export const chooseAdaptor = choose;
+export const chooseAdaptor = context.document ? browserAdaptor : liteAdaptor;
+
diff --git a/ts/components/loader.ts b/ts/components/loader.ts
@@ -40,11 +40,7 @@ import {
 } from './package.js';
 import { FunctionList } from '../util/FunctionList.js';
 import { mjxRoot } from '#root/root.js';
-
-/*
- * The browser document (if any)
- */
-declare const document: Document;
+import { context } from '../util/context.js';
 
 /**
  * Function used to determine path to a given package.
@@ -272,11 +268,11 @@ export const Loader = {
    * @returns {string}   The root location (directory for node.js, URL for browser)
    */
   getRoot(): string {
-    if (typeof document !== 'undefined') {
+    if (context.document) {
       const script =
-        document.currentScript || document.getElementById('MathJax-script');
-      if (script) {
-        return (script as HTMLScriptElement).src.replace(/\/[^/]*$/, '');
+        context.document.currentScript || context.document.getElementById('MathJax-script');
+      if (script && script instanceof HTMLScriptElement) {
+        return script.src.replace(/\/[^/]*$/, '');
       }
     }
     return mjxRoot();
diff --git a/ts/components/package.ts b/ts/components/package.ts
@@ -23,11 +23,7 @@
  */
 
 import { CONFIG, Loader } from './loader.js';
-
-/*
- * The browser document (for creating scripts to load components)
- */
-declare const document: Document;
+import { context } from '../util/context.js';
 
 /**
  * A map of package names to Package instances
@@ -337,13 +333,13 @@ export class Package {
    * @param {string} url The URL to load from
    */
   protected loadScript(url: string) {
-    const script = document.createElement('script');
+    const script = context.document.createElement('script');
     script.src = url;
     script.charset = 'UTF-8';
     script.onload = (_event) => this.checkLoad();
     script.onerror = (_event) => this.failed('Can\'t load "' + url + '"');
     // FIXME: Should there be a timeout failure as well?
-    document.head.appendChild(script);
+    context.document.head.appendChild(script);
   }
 
   /**
diff --git a/ts/components/startup.ts b/ts/components/startup.ts
@@ -42,6 +42,7 @@ import { CommonOutputJax } from '../output/common.js';
 import { DOMAdaptor } from '../core/DOMAdaptor.js';
 import { PrioritizedList } from '../util/PrioritizedList.js';
 import { OptionList, OPTIONS } from '../util/Options.js';
+import { context} from '../util/context.js';
 
 import { TeX } from '../input/tex.js';
 
@@ -619,7 +620,7 @@ if (typeof MathJax._.startup === 'undefined') {
     output: '',
     handler: null,
     adaptor: null,
-    document: typeof document === 'undefined' ? '' : document,
+    document: context.document || '',
     elements: null,
     typeset: true,
     ready: Startup.defaultReady.bind(Startup),
diff --git a/ts/core/MmlTree/MathMLVisitor.ts b/ts/core/MmlTree/MathMLVisitor.ts
@@ -16,7 +16,7 @@
  */
 
 /**
- * @file  A visitor that produces MathML DOM nodes from the iternal nodes
+ * @file  A visitor that produces MathML DOM nodes from the internal nodes
  *
  * @author dpvc@mathjax.org (Davide Cervone)
  */
diff --git a/ts/input/tex/base/BaseConfiguration.ts b/ts/input/tex/base/BaseConfiguration.ts
@@ -35,6 +35,7 @@ import { getRange } from '../../../core/MmlTree/OperatorDictionary.js';
 import ParseOptions from '../ParseOptions.js';
 import { ParseUtil } from '../ParseUtil.js';
 import { TexConstant } from '../TexConstants.js';
+import { context } from '../../../util/context.js';
 
 const MATHVARIANT = TexConstant.Variant;
 
@@ -210,10 +211,10 @@ export const BaseConfiguration: Configuration = Configuration.create('base', {
     maxMacros: 1000,
     identifierPattern: /^[a-zA-Z]+/, // pattern for multiLetterIdentifiers in \mathrm, etc.
     baseURL:
-      typeof document === 'undefined' ||
-      document.getElementsByTagName('base').length === 0
+      !context.document ||
+      context.document.getElementsByTagName('base').length === 0
         ? ''
-        : String(document.location).replace(/#.*$/, ''),
+        : String(context.document.location).replace(/#.*$/, ''),
   },
   [ConfigurationType.TAGS]: {
     base: BaseTags,
diff --git a/ts/mathjax.ts b/ts/mathjax.ts
@@ -26,6 +26,7 @@ import { HandlerList } from './core/HandlerList.js';
 import { handleRetriesFor, retryAfter } from './util/Retries.js';
 import { OptionList } from './util/Options.js';
 import { MathDocument } from './core/MathDocument.js';
+import { context } from './util/context.js';
 
 /*****************************************************************/
 /**
@@ -37,6 +38,11 @@ export const mathjax = {
    */
   version: VERSION,
 
+  /**
+   * The browser context (window and document values)
+   */
+  context: context,
+
   /**
    *  The list of registers document handlers
    */
diff --git a/ts/ui/menu/MenuUtil.ts b/ts/ui/menu/MenuUtil.ts
@@ -1,15 +1,38 @@
+/*************************************************************
+ *
+ *  Copyright (c) 2024 The MathJax Consortium
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+/**
+ * @file  Implements a function to handle copying to clipboard
+ *
+ * @author dpvc@mathjax.org (Davide Cervone)
+ */
+
+import {context} from '../../util/context.js';
+
 /**
  * True when platform is a Mac (so we can enable CMD menu item for zoom trigger)
  */
-export const isMac =
-  typeof window !== 'undefined' &&
-  window.navigator &&
-  window.navigator.platform.substring(0, 3) === 'Mac';
+export const isMac = context.window?.navigator?.platform?.substring(0, 3) === 'Mac';
 
 /**
- * @param {string} text   The text to be copied ot the clopboard
+ * @param {string} text   The text to be copied to the clipboard
  */
 export function copyToClipboard(text: string) {
+  const document = context.document;
   const input = document.createElement('textarea');
   input.value = text;
   input.setAttribute('readonly', '');
diff --git a/ts/util/context.ts b/ts/util/context.ts
@@ -0,0 +1,35 @@
+/*************************************************************
+ *
+ *  Copyright (c) 2024 The MathJax Consortium
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+/**
+ * @file  Provides the browser window and document values
+ *
+ * @author dpvc@mathjax.org (Davide Cervone)
+ */
+
+/**
+ * True if there is a window object
+ */
+export const hasWindow = typeof window !== 'undefined';
+
+/**
+ * The browsers window and document objects, if any
+ */
+export const context = {
+  window: hasWindow ? window : null,
+  document: hasWindow ? window.document : null,
+};

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,8 @@`
`1`	`1`	`import './lib/explorer.js';`
`2`	`2`
`3`	`3`	`import {ExplorerHandler} from '#js/a11y/explorer.js';`
	`4`	`+import {hasWindow} from '#js/util/context.js';`
`4`	`5`
`5`		`-if (MathJax.startup && typeof window !== 'undefined') {`
	`6`	`+if (MathJax.startup && hasWindow) {`
`6`	`7`	`MathJax.startup.extendHandler(handler => ExplorerHandler(handler));`
`7`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,8 @@ import './lib/menu.js';`
`2`	`2`
`3`	`3`	`import {combineDefaults} from '#js/components/global.js';`
`4`	`4`	`import {MenuHandler} from '#js/ui/menu/MenuHandler.js';`
	`5`	`+import {hasWindow} from '#js/util/context.js';`
`5`	`6`
`6`		`-if (MathJax.startup && typeof window !== 'undefined') {`
	`7`	`+if (MathJax.startup && hasWindow) {`
`7`	`8`	`MathJax.startup.extendHandler(handler => MenuHandler(handler), 20);`
`8`	`9`	`}`