@wiris/mathtype-viewer 8.9.1 → 8.10.0

package/src/services.ts

@@ -1,5 +1,5 @@
-import Parser from '@wiris/mathtype-html-integration-devkit/src/parser';
-import { Properties } from './properties';
+import Parser from "@wiris/mathtype-html-integration-devkit/src/parser";
+import { Properties } from "./properties";
 
 enum MethodType {
   Post = "POST",
@@ -28,12 +28,12 @@ export async function processJsonResponse(response: Promise<Response>): Promise<
   try {
     const { status, result } = await (await response).json();
 
-    if (status !== 'ok') {
-      throw new StatusError('Service responded with a non-ok status');
+    if (status !== "ok") {
+      throw new StatusError("Service responded with a non-ok status");
     }
 
     return result;
-  } catch(e) {
+  } catch (e) {
     // TODO manage network and status non-ok errors
     throw e;
   }
@@ -47,19 +47,26 @@ export async function processJsonResponse(response: Promise<Response>): Promise<
  * @param {string} extension - Extension to add to the end of the serviceName (including the dot if necessary).
  * @returns {Promise<Response>} The request response.
  */
-export async function callService(query: object, serviceName: string, method: MethodType, serverURL: string, extension: string) : Promise<any> {
+export async function callService(
+  query: object,
+  serviceName: string,
+  method: MethodType,
+  serverURL: string,
+  extension: string,
+): Promise<any> {
   try {
     const url = new URL(serviceName + extension, serverURL);
 
-    const properties = Properties.getInstance();
+    // Getting the configuration is asynchronous since we make some requests.
+    const properties = await Properties.getInstance();
     const headers = {
-      'Content-type': 'application/x-www-form-urlencoded; charset=utf-8',
-      ...properties.config.backendConfig.wiriscustomheaders
-    }
+      "Content-type": "application/x-www-form-urlencoded; charset=utf-8",
+      ...properties.config.backendConfig.wiriscustomheaders,
+    };
 
     const init: RequestInit = {
       method,
-      headers
+      headers,
     };
 
     if (method === MethodType.Get) {
@@ -69,11 +76,11 @@ export async function callService(query: object, serviceName: string, method: Me
       }
     } else {
       // Add the query as the body of the request
-      init.body = new URLSearchParams({...query});
+      init.body = new URLSearchParams({ ...query });
     }
 
     return fetch(url.toString(), init);
-  } catch(e) {
+  } catch (e) {
     // TODO manage network and status non-ok errors
     throw e;
   }
@@ -87,18 +94,18 @@ export async function callService(query: object, serviceName: string, method: Me
  * @param {string} extension - Extension to add to the end of the serviceName (including the dot if necessary).
  * @returns {Promise<Response>} The mathml2accessible service response.
  */
-export async function mathml2accessible(mml: string, lang: string, url: string, extension: string) : Promise<any> {
+export async function mathml2accessible(mml: string, lang: string, url: string, extension: string): Promise<any> {
   // Set the needed params to retrieve the alt text.
   const params = {
-    'service': 'mathml2accessible',
-    'mml': mml,
-    'metrics': 'true',
-    'centerbaseline': 'false',
-    'lang': lang,
-    'ignoreStyles': 'true',
-  }
+    service: "mathml2accessible",
+    mml: mml,
+    metrics: "true",
+    centerbaseline: "false",
+    lang: lang,
+    ignoreStyles: "true",
+  };
 
-  const response = callService(params, 'service', MethodType.Post, url, extension);
+  const response = callService(params, "service", MethodType.Post, url, extension);
   return processJsonResponse(response);
 }
 
@@ -112,18 +119,18 @@ export async function mathml2accessible(mml: string, lang: string, url: string,
  */
 export async function showImage(mml: string, lang: string, url: string, extension: string): Promise<any> {
   const params = {
-    'mml': mml,
-    'metrics': 'true',
-    'centerbaseline': 'false',
-    'lang':lang,
-  }
+    mml: mml,
+    metrics: "true",
+    centerbaseline: "false",
+    lang: lang,
+  };
 
   // Try to obtain the image via GET
   const getParams = Parser.createShowImageSrcData(params, params.lang);
-  const getResponse = callService(getParams, 'showimage', MethodType.Get, url, extension);
+  const getResponse = callService(getParams, "showimage", MethodType.Get, url, extension);
   try {
     return await processJsonResponse(getResponse);
-  } catch(e) {
+  } catch (e) {
     if (e instanceof StatusError) {
       // Formula was not in cache; proceed with calling showimage via POST
     } else {
@@ -132,10 +139,9 @@ export async function showImage(mml: string, lang: string, url: string, extensio
   }
 
   // If GET request fails, it means that the formula was not in cache. Proceed with POST:
-  const response = callService(params, 'showimage', MethodType.Post, url, extension);
+  const response = callService(params, "showimage", MethodType.Post, url, extension);
   return processJsonResponse(response);
-
-};
+}
 
 /**
  * Calls the createImage service with the given MathML and returns the received Response object.
@@ -147,16 +153,16 @@ export async function showImage(mml: string, lang: string, url: string, extensio
  */
 export async function createImage(mml: string, lang: string, url: string, extension: string): Promise<any> {
   const params = {
-    'mml': mml,
-    'metrics': 'true',
-    'centerbaseline': 'false',
-    'lang': lang,
-  }
+    mml: mml,
+    metrics: "true",
+    centerbaseline: "false",
+    lang: lang,
+  };
 
-  // POST request to get the corresponding image
-  const response = callService(params, 'showimage', MethodType.Post, url, extension);
+  // POST request to retrieve the corresponding image.
+  const response = callService(params, "showimage", MethodType.Post, url, extension);
   return processJsonResponse(response);
-  };
+}
 
 /**
  * Calls the latex2mathml service with the given LaTeX and returns the received Response object.
@@ -167,11 +173,11 @@ export async function createImage(mml: string, lang: string, url: string, extens
  */
 export async function latexToMathml(latex: string, url: string, extension: string): Promise<any> {
   const params = {
-    'service': 'latex2mathml',
-    'latex': latex,
-  }
+    service: "latex2mathml",
+    latex: latex,
+  };
 
-  const response = callService(params, 'service', MethodType.Post, url, extension);
+  const response = callService(params, "service", MethodType.Post, url, extension);
   return processJsonResponse(response);
 }
 
@@ -181,11 +187,22 @@ export async function latexToMathml(latex: string, url: string, extension: strin
  * @param {string} extension - Extension to add to the end of the serviceName (including the dot if necessary).
  * @returns {Promise<Response>} The configurationjson service response.
  */
-export async function configurationJson(variablekeys: string[], url: string, extension: string) : Promise<any> {
+export async function configurationJson(
+  variablekeys: string[],
+  url: string,
+  extension: string,
+  check: boolean,
+): Promise<any> {
   const params = {
-    'variablekeys': variablekeys.join(','),
-  }
+    variablekeys: variablekeys.join(","),
+  };
 
-  const response = callService(params, 'configurationjson', MethodType.Get, url, extension);
+  const response = await callService(params, "configurationjson", MethodType.Get, url, extension);
+
+  // Provide a warning to alert the users that the console error is an expected outcome,
+  // since this request only aims to be a check and does not expect to retrieve any data.
+  if (check && !response.ok) {
+    console.warn("Fetching the url: " + response.url + ", is expected to fail and handled. Don't panic!");
+  }
   return processJsonResponse(response);
 }

package/tsconfig.json

@@ -1,8 +1,9 @@
 {
   "compilerOptions": {
+    "strict": true,
     /* Basic Options */
-    "target": "ES5",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */
-    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
+    "target": "ES5" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */,
+    "module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */,
     "lib": [
       "dom",
       "es6",
@@ -10,28 +11,28 @@
       "scripthost",
       "es2017",
       "es5",
-      "es2015",
-    ],                             /* Specify library files to be included in the compilation. */
+      "es2015"
+    ] /* Specify library files to be included in the compilation. */,
     // "allowJs": true,                       /* Allow javascript files to be compiled. */
     // "checkJs": true,                       /* Report errors in .js files. */
     // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
-    "declaration": true,                   /* Generates corresponding '.d.ts' file. */
-    "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
-    "sourceMap": true,                     /* Generates corresponding '.map' file. */
+    "declaration": true /* Generates corresponding '.d.ts' file. */,
+    "declarationMap": true /* Generates a sourcemap for each corresponding '.d.ts' file. */,
+    "sourceMap": true /* Generates corresponding '.map' file. */,
     // "outFile": "./",                       /* Concatenate and emit output to single file. */
-    "outDir": "./dist",                        /* Redirect output structure to the directory. */
-    "rootDir": "./src",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    "outDir": "./dist" /* Redirect output structure to the directory. */,
+    "rootDir": "./src" /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */,
     // "composite": true,                     /* Enable project compilation */es
-    "removeComments": true,                /* Do not emit comments to output. */
+    "removeComments": true /* Do not emit comments to output. */,
     // "noEmit": true,                        /* Do not emit outputs. */
     // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
-    "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    "downlevelIteration": true /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */,
     // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
     "noEmitOnError": true,
 
     /* Strict Type-Checking Options */
     // "strict": true,                           /* Enable all strict type-checking options. */
-    "noImplicitAny": false,                 /* Raise error on expressions and declarations with an implied 'any' type. */
+    "noImplicitAny": false /* Raise error on expressions and declarations with an implied 'any' type. */,
     // "strictNullChecks": true,              /* Enable strict null checks. */
     // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
     // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
@@ -40,24 +41,25 @@
     // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
 
     /* Additional Checks */
-    "noUnusedLocals": false,                /* Report errors on unused locals. */
-    "noUnusedParameters": false,            /* Report errors on unused parameters. */
-    "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
+    "noUnusedLocals": false /* Report errors on unused locals. */,
+    "noUnusedParameters": false /* Report errors on unused parameters. */,
+    "noImplicitReturns": true /* Report error when not all code paths in function return a value. */,
     // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
 
     /* Module Resolution Options */
-    "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    "moduleResolution": "node" /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */,
     // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
     // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
     // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
     "typeRoots": [
       "./typings",
       "../node_modules/@types",
+      "../../node_modules/@types",
       "./dist"
-    ],                       /* List of folders to include type definitions from. */
+    ] /* List of folders to include type definitions from. */,
     // "types": [],                           /* Type declaration files to be included in compilation. */
     // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
-    "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
     // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
 
     /* Source Map Options */
@@ -67,12 +69,14 @@
     // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
 
     /* Experimental Options */
-    "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
+    "experimentalDecorators": true /* Enables experimental support for ES7 decorators. */,
     // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
-    "resolveJsonModule": true
+    "resolveJsonModule": true,
+    "types": ["jest"]
   },
   "exclude": [
     "node_modules", // would be the default
-    "./dist"
+    "./dist",
+    "**/*.spec.ts"
   ]
-}
+}

package/typings/module-name.d.ts

@@ -1,2 +1,2 @@
 declare module "Parser";
-declare module '@wiris/mathtype-html-integration-devkit/src/parser';
+declare module "@wiris/mathtype-html-integration-devkit/src/parser";

package/webpack.config.js

@@ -1,35 +1,35 @@
-const path = require('path');
+const path = require("path");
 
 module.exports = (config, context) => {
   return {
-    entry: './src/app.ts',
-    mode: 'none',
+    entry: "./src/app.ts",
+    mode: "none",
     module: {
       rules: [
         {
           test: /\.tsx?$/,
-          use: 'ts-loader',
+          use: "ts-loader",
           exclude: /node_modules/,
         },
         {
           test: /\.js$/,
           exclude: /node_modules/,
-          use: ['babel-loader']
+          use: ["babel-loader"],
         },
       ],
     },
     resolve: {
-      extensions: ['.tsx', '.ts', '.js'],
+      extensions: [".tsx", ".ts", ".js"],
     },
     output: {
-      filename: 'WIRISplugins.js',
-      path: path.resolve(__dirname, 'dist'),
+      filename: "WIRISplugins.js",
+      path: path.resolve(__dirname, "dist"),
     },
     devServer: {
       devMiddleware: {
         writeToDisk: true,
       },
-      static:  './',
+      static: "./",
       hot: true,
       port: 8001,
       open: true,
@@ -37,5 +37,5 @@ module.exports = (config, context) => {
     optimization: {
       minimize: true, // enabling this reduces file size and readability
     },
-  }
+  };
 };

package/dist/utils.d.ts

@@ -1,3 +0,0 @@
-export declare function htmlEntitiesToXmlEntities(text: string): string;
-export declare const corruptMathML: string[];
-//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAoBA,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAoB9D;AAID,eAAO,MAAM,aAAa,UAAqG,CAAC"}

package/src/utils.ts

@@ -1,45 +0,0 @@
-/**
- * Takes a string possibly containing encoded entities (e.g.    ) and
- * returns the same string with these replaced by the UTF-8 characters they represent
- * @param {string} text - the string with encoded entities
- * @returns the same string with the entities decoded
- */
-function decodeEntities(text: string): string {
-  const element = document.createElement('textarea');
-  element.innerHTML = text;
-  return element.value;
-}
-
-/**
- * Takes a string possibly containing encoded named HTML entities (e.g.  ) and
- * returns the same string with these replaced by the encoding that uses numbers (e.g.  ).
- * By its implementation, this method also possibly encodes special characters that were
- * previously unencoded.
- * @param {string} text - the string with encoded entities
- * @returns the same string with the entities decoded
- */
-export function htmlEntitiesToXmlEntities(text: string): string {
-  text = decodeEntities(text);
-
-  // Replaces the '<', '&', '>', and '"' characters to its HTMLEntity to avoid render issues.
-  text = text.split('&').join('&amp;')
-    .split('"<"').join('"&lt;"')
-    .split('">"').join('"&gt;"')
-    .split('><<').join('>&lt;<');
-
-
-  let result = '';
-  for (let i = 0; i < text.length; i++) {
-    const character = text.charAt(i);
-    if (text.charCodeAt(i) > 128) {
-      result += '&#' + text.charCodeAt(i) + ';';
-    } else {
-      result += character;
-    }
-  }
-  return result;
-}
-
-// Set of mathml and characters which don't have an accessible text associated
-// and can not be translated or transformed to LaTeX.
-export const corruptMathML = ['⟦', '&#10214;', '⟧', '&#10215;', 'mscarries', 'mscarry', 'msgroup', 'mstack', 'msline', 'msrow'];