@khanacademy/perseus 48.0.0 → 48.1.0

package/dist/index.d.ts

@@ -81,6 +81,8 @@ export { addWidget, QUESTION_WIDGETS } from "./util/snowman-utils";
 export { getCircleCoords, getLineCoords, getLinearSystemCoords, getPointCoords, getPolygonCoords, getSegmentCoords, getSinusoidCoords, getQuadraticCoords, getAngleCoords, } from "./widgets/interactive-graphs/reducer/initialize-graph-state";
 export { getClockwiseAngle } from "./widgets/interactive-graphs/math";
 export { makeSafeUrl } from "./widgets/phet-simulation";
+export { parseDataFromJSONP } from "./util/graphie-utils";
+export type { GraphieData, GraphieLabel, GraphieRange, } from "./util/graphie-utils";
 /**
  * Mixins
  */

package/dist/index.js

@@ -3494,6 +3494,163 @@ const Util = {
   deepClone
 };
 
+// For offline exercises in the mobile app, we download the graphie data
+// (svgs and localized data files) and serve them from the local file
+// system (with file://). We replace urls that start with `web+graphie`
+// in the perseus json with this `file+graphie` prefix to indicate that
+// they should have the `file://` protocol instead of `https://`.
+const svgLocalLabelsRegex = /^file\+graphie:/;
+const hashRegex = /\/([^/]+)$/;
+
+/**
+ * A Graphie axis range.
+ */
+
+/**
+ * A Graphie label.
+ */
+
+/**
+ * The Graphie data (labels, etc.)
+ */
+
+function getLocale() {
+  const {
+    JIPT,
+    kaLocale
+  } = getDependencies();
+  return JIPT.useJIPT ? "en-pt" : kaLocale;
+}
+function shouldUseLocalizedData() {
+  return getLocale() !== "en";
+}
+
+// A regex to split at the last / of a URL, separating the base part from the
+// hash. This is used to create the localized label data URLs.
+const splitHashRegex = /\/(?=[^/]+$)/;
+function getLocalizedDataUrl(url) {
+  // For local (cached) graphie images, they are already localized.
+  if (svgLocalLabelsRegex.test(url)) {
+    return Util.getDataUrl(url);
+  }
+  const [base, hash] = Util.getBaseUrl(url).split(splitHashRegex);
+  return `${base}/${getLocale()}/${hash}-data.json`;
+}
+
+// Get the hash from the url, which is just the filename
+function getUrlHash(url) {
+  const match = url.match(hashRegex);
+  if (match == null) {
+    throw new perseusCore.PerseusError("not a valid URL", perseusCore.Errors.InvalidInput);
+  }
+  return match && match[1];
+}
+
+/**
+ * Parse JSONP for a web+graphie://... hash to extract Graphie data, or throw
+ * an error if invalid JSONP.
+ */
+function parseDataFromJSONP(graphieHash, graphieJSONP, errorCallback) {
+  // The JSONP is expected to be in the form of `svgDataHASH(...)` or `svgOtherDataHASH(...)`
+  const match = graphieJSONP.match(new RegExp(`^(?:svgData|svgOtherData)${graphieHash}\\((.+)\\);$`));
+
+  // It is also possible that the JSONP is simply a JSON object,
+  //  in which case we can parse it directly.
+  const jsonToParse = match ? match[1] : graphieJSONP;
+
+  // Try to parse the JSONP, and if it fails, call the error callback
+  try {
+    return JSON.parse(jsonToParse);
+  } catch (error) {
+    errorCallback(error);
+    return null;
+  }
+}
+// The global cache of label data. Its format is:
+// {
+//   hash (e.g. "c21435944d2cf0c8f39d9059cb35836aa701d04a"): {
+//     loaded: a boolean of whether the data has been loaded or not
+//     dataCallbacks: a list of callbacks to call with the data when the data
+//                    is loaded
+//     data: the other data for this hash
+//   },
+//   ...
+// }
+const labelDataCache = {};
+function loadGraphie(url, onDataLoaded) {
+  const hash = getUrlHash(url);
+
+  // We can't make multiple jsonp calls to the same file because their
+  // callbacks will collide with each other. Instead, we cache the data
+  // and only make the jsonp calls once.
+  const entry = labelDataCache[hash];
+  if (entry != null) {
+    if (entry.loaded) {
+      const {
+        data,
+        localized
+      } = entry;
+      onDataLoaded(data, localized);
+    } else {
+      entry.dataCallbacks.push(onDataLoaded);
+    }
+  } else {
+    const cacheData = {
+      loaded: false,
+      dataCallbacks: [onDataLoaded],
+      localized: shouldUseLocalizedData()
+    };
+    labelDataCache[hash] = cacheData;
+    const retrieveData = async (url, errorCallback) => {
+      const response = await fetch(url);
+      if (!response?.ok) {
+        errorCallback();
+        return;
+      }
+      const jsonp = await response.text();
+      const data = parseDataFromJSONP(hash, jsonp, error => {
+        Log.error("Failed to parse JSONP for svg-image", perseusCore.Errors.Service, {
+          cause: error,
+          loggedMetadata: {
+            dataUrl: Util.getDataUrl(url),
+            jsonp
+          }
+        });
+      });
+
+      // If the data is null, then we failed to parse the JSONP
+      if (!data) {
+        return;
+      }
+      const newCacheEntry = labelDataCache[hash] = {
+        ...labelDataCache[hash],
+        loaded: true,
+        data
+      };
+      newCacheEntry.dataCallbacks.forEach(callback => {
+        callback(newCacheEntry.data, cacheData.localized);
+      });
+    };
+    const dataLoadErrorHandler = (x, status, error) => {
+      Log.error("Data load failed for svg-image", perseusCore.Errors.Service, {
+        cause: error,
+        loggedMetadata: {
+          dataUrl: Util.getDataUrl(url),
+          status
+        }
+      });
+    };
+    if (shouldUseLocalizedData()) {
+      cacheData.localized = false;
+      // If there is isn't any localized data, fall back to
+      // the original, unlocalized data
+      retrieveData(getLocalizedDataUrl(url), dataLoadErrorHandler);
+    } else {
+      retrieveData(Util.getDataUrl(url), dataLoadErrorHandler);
+    }
+  }
+}
+
 // Derived from the MIT-licensed:
 
 /*jshint browser:true, node:true */
@@ -8925,6 +9082,9 @@ class Graphie$1 {
     $__default["default"](el).css("position", "relative");
     this.raphael = Raphael$1(el);
 
+    // Hide the Raphael canvas from screen readers
+    $__default["default"](el).attr("aria-hidden", "true");
+
     // For a sometimes-reproducible IE8 bug; doesn't affect SVG browsers at all
     $__default["default"](el).children("div").css("position", "absolute");
   }
@@ -17002,106 +17162,11 @@ class ImageLoader extends React__namespace.Component {
 /* eslint-disable @khanacademy/ts-no-error-suppressions */
 // Minimum image width to make an image appear as zoomable.
 const ZOOMABLE_THRESHOLD = 700;
-
-// The global cache of label data. Its format is:
-// {
-//   hash (e.g. "c21435944d2cf0c8f39d9059cb35836aa701d04a"): {
-//     loaded: a boolean of whether the data has been loaded or not
-//     dataCallbacks: a list of callbacks to call with the data when the data
-//                    is loaded
-//     data: the other data for this hash
-//   },
-//   ...
-// }
-const labelDataCache = {};
-
-// Write our own JSONP handler because all the other ones don't do things we
-// need.
-const doJSONP = function (url, options) {
-  options = {
-    callbackName: "callback",
-    success: $__default["default"].noop,
-    error: $__default["default"].noop,
-    ...options
-  };
-
-  // Create the script
-  const script = document.createElement("script");
-  script.setAttribute("async", "");
-  script.setAttribute("src", url);
-
-  // A cleanup function to run when we're done.
-  function cleanup() {
-    document.head?.removeChild(script);
-    delete window[options.callbackName];
-  }
-
-  // Add the global callback.
-  // @ts-expect-error - TS2740 - Type '() => void' is missing the following properties from type 'Window': clientInformation, closed, customElements, devicePixelRatio, and 206 more.
-  window[options.callbackName] = function () {
-    cleanup();
-    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
-      args[_key] = arguments[_key];
-    }
-    options.success.apply(null, args);
-  };
-
-  // Add the error handler.
-  script.addEventListener("error", function () {
-    cleanup();
-    for (var _len2 = arguments.length, args = new Array(_len2), _key2 = 0; _key2 < _len2; _key2++) {
-      args[_key2] = arguments[_key2];
-    }
-    options.error.apply(null, args);
-  });
-
-  // Insert the script to start the download.
-  document.head?.appendChild(script);
-};
-
-// For offline exercises in the mobile app, we download the graphie data
-// (svgs and localized data files) and serve them from the local file
-// system (with file://). We replace urls that start with `web+graphie`
-// in the perseus json with this `file+graphie` prefix to indicate that
-// they should have the `file://` protocol instead of `https://`.
-const svgLocalLabelsRegex = /^file\+graphie:/;
-const hashRegex = /\/([^/]+)$/;
 function isImageProbablyPhotograph(imageUrl) {
   // TODO(david): Do an inventory to refine this heuristic. For example, what
   //     % of .png images are illustrations?
   return /\.(jpg|jpeg)$/i.test(imageUrl);
 }
-function getLocale() {
-  const {
-    JIPT,
-    kaLocale
-  } = getDependencies();
-  return JIPT.useJIPT ? "en-pt" : kaLocale;
-}
-function shouldUseLocalizedData() {
-  return getLocale() !== "en";
-}
-
-// A regex to split at the last / of a URL, separating the base part from the
-// hash. This is used to create the localized label data URLs.
-const splitHashRegex = /\/(?=[^/]+$)/;
-function getLocalizedDataUrl(url) {
-  // For local (cached) graphie images, they are already localized.
-  if (svgLocalLabelsRegex.test(url)) {
-    return Util.getDataUrl(url);
-  }
-  const [base, hash] = Util.getBaseUrl(url).split(splitHashRegex);
-  return `${base}/${getLocale()}/${hash}-data.json`;
-}
-
-// Get the hash from the url, which is just the filename
-function getUrlHash(url) {
-  const match = url.match(hashRegex);
-  if (match == null) {
-    throw new perseusCore.PerseusError("not a valid URL", perseusCore.Errors.InvalidInput);
-  }
-  return match && match[1];
-}
 function defaultPreloader(dimensions) {
   return /*#__PURE__*/React__namespace.createElement("span", {
     style: {
@@ -17188,90 +17253,22 @@ class SvgImage extends React__namespace.Component {
     return Util.isLabeledSVG(this.props.src) ? state.imageLoaded && state.dataLoaded : state.imageLoaded;
   }
   loadResources() {
-    const hash = getUrlHash(this.props.src);
-
-    // We can't make multiple jsonp calls to the same file because their
-    // callbacks will collide with each other. Instead, we cache the data
-    // and only make the jsonp calls once.
-    if (labelDataCache[hash]) {
-      if (labelDataCache[hash].loaded) {
-        const {
-          data,
-          localized
-        } = labelDataCache[hash];
-        this.onDataLoaded(data, localized);
-      } else {
-        labelDataCache[hash].dataCallbacks.push(this.onDataLoaded);
-      }
-    } else {
-      const cacheData = {
-        loaded: false,
-        dataCallbacks: [this.onDataLoaded],
-        data: null,
-        localized: shouldUseLocalizedData()
-      };
-      labelDataCache[hash] = cacheData;
-      const retrieveData = (url, errorCallback) => {
-        doJSONP(url, {
-          callbackName: "svgData" + hash,
-          success: data => {
-            // @ts-expect-error - TS2540 - Cannot assign to 'data' because it is a read-only property.
-            cacheData.data = data;
-            // @ts-expect-error - TS2540 - Cannot assign to 'loaded' because it is a read-only property.
-            cacheData.loaded = true;
-            ___default["default"].each(cacheData.dataCallbacks, callback => {
-              // @ts-expect-error - TS2345 - Argument of type 'null' is not assignable to parameter of type '{ labels: readonly any[]; range: readonly any[]; }'.
-              callback(cacheData.data, cacheData.localized);
-            });
-          },
-          error: errorCallback
-        });
-      };
-      if (shouldUseLocalizedData()) {
-        retrieveData(getLocalizedDataUrl(this.props.src), (x, status, error) => {
-          // @ts-expect-error - TS2540 - Cannot assign to 'localized' because it is a read-only property.
-          cacheData.localized = false;
-
-          // If there is isn't any localized data, fall back to
-          // the original, unlocalized data
-          retrieveData(Util.getDataUrl(this.props.src), (x, status, error) => {
-            Log.error("Data load failed for svg-image", perseusCore.Errors.Service, {
-              cause: error,
-              loggedMetadata: {
-                dataUrl: Util.getDataUrl(this.props.src),
-                status
-              }
-            });
-          });
+    loadGraphie(this.props.src, (data, localized) => {
+      if (this._isMounted && data.labels && data.range) {
+        const labelsRendered = {};
+        data.labels.forEach(label => {
+          labelsRendered[label.content] = false;
         });
-      } else {
-        retrieveData(Util.getDataUrl(this.props.src), (x, status, error) => {
-          Log.error("Data load failed for svg-image", perseusCore.Errors.Service, {
-            cause: error,
-            loggedMetadata: {
-              dataUrl: Util.getDataUrl(this.props.src),
-              status
-            }
-          });
+        this.setState({
+          dataLoaded: true,
+          labelDataIsLocalized: localized,
+          labelsRendered,
+          labels: data.labels,
+          range: data.range
         });
       }
-    }
+    });
   }
-  onDataLoaded = (data, localized) => {
-    if (this._isMounted && data.labels && data.range) {
-      const labelsRendered = data.labels.reduce((dict, label) => ({
-        ...dict,
-        [label.content]: false
-      }), {});
-      this.setState({
-        dataLoaded: true,
-        labelDataIsLocalized: localized,
-        labelsRendered,
-        labels: data.labels,
-        range: data.range
-      });
-    }
-  };
   sizeProvided() {
     return this.props.width != null && this.props.height != null;
   }
@@ -45530,7 +45527,7 @@ const init = function () {
 
 // This file is processed by a Rollup plugin (replace) to inject the production
 const libName = "@khanacademy/perseus";
-const libVersion = "48.0.0";
+const libVersion = "48.1.0";
 perseusCore.addLibraryVersionToPerseusDebug(libName, libVersion);
 
 const apiVersion = {
@@ -49196,6 +49193,7 @@ exports.lockedFigureFillStyles = lockedFigureFillStyles;
 exports.makeSafeUrl = makeSafeUrl;
 exports.mathOnlyParser = mathOnlyParser;
 exports.mediaQueries = mediaQueries;
+exports.parseDataFromJSONP = parseDataFromJSONP;
 exports.parsePerseusItem = parsePerseusItem;
 exports.plotterPlotTypes = plotterPlotTypes;
 exports.preprocessTex = preprocessTex;