@instructure/canvas-rce 5.11.1 → 5.12.2

package/lib/util/string-util.js

@@ -1,48 +0,0 @@
-/*
- * Copyright (C) 2023 - present Instructure, Inc.
- *
- * This file is part of Canvas.
- *
- * Canvas is free software: you can redistribute it and/or modify it under
- * the terms of the GNU Affero General Public License as published by the Free
- * Software Foundation, version 3 of the License.
- *
- * Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
- * A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
- * details.
- *
- * You should have received a copy of the GNU Affero General Public License along
- * with this program. If not, see <http://www.gnu.org/licenses/>.
- */
-
-/**
- * Returns null if the string is null, undefined, or has length === 0
- *
- * @param str
- */
-export function emptyAsNull(str) {
-  if (str == null) return null;
-  if (str.length === 0) return null;
-  return str;
-}
-/**
- * Returns null if the string is null, undefined, is empty, or contains only whitespace.
- *
- * Otherwise returns the string with leading and trailing whitespace removed.
- *
- * Useful for providing a default value for a string input:
- *
- * ```
- * label.innerText = trimmedOrNull(input.value) ?? 'Default value'
- * ```
- *
- * @param str
- */
-
-export function trimmedOrNull(str) {
-  if (str == null) return null;
-  str = str.trim();
-  if (str.length === 0) return null;
-  return str;
-}

package/lib/util/textarea-editing-util.js

@@ -1,87 +0,0 @@
-/*
- * Copyright (C) 2023 - present Instructure, Inc.
- *
- * This file is part of Canvas.
- *
- * Canvas is free software: you can redistribute it and/or modify it under
- * the terms of the GNU Affero General Public License as published by the Free
- * Software Foundation, version 3 of the License.
- *
- * Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
- * A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
- * details.
- *
- * You should have received a copy of the GNU Affero General Public License along
- * with this program. If not, see <http://www.gnu.org/licenses/>.
- */
-import * as textFieldEdit from 'text-field-edit';
-import { assertNever } from './assertNever';
-/**
- * Represents a subset of the editing actions that can be taken on a <textarea> using the text-field-edit library.
- *
- * This is used to allow decoupling logic that requires textarea editing from the actual commands, because it's tricky
- * to test code that uses the 'text-field-edit' library directly, since it relies on document.execCommand().
- *
- * For production code, actions can be executed on a <textarea> using performTextEditActionOnTextarea
- * For testing, actions can be executed on a string using performTextEditActionsOnString
- */
-
-/**
- * Executes the given text edit actions on a <textarea>
- */
-export function performTextEditActionOnTextarea(textarea, editAction) {
-  var _editAction$before, _editAction$after;
-
-  switch (editAction.action) {
-    case 'insert':
-      return textFieldEdit.insert(textarea, editAction.text);
-
-    case 'wrapSelection':
-      return textFieldEdit.wrapSelection(textarea, (_editAction$before = editAction.before) !== null && _editAction$before !== void 0 ? _editAction$before : '', (_editAction$after = editAction.after) !== null && _editAction$after !== void 0 ? _editAction$after : '');
-
-    default:
-      assertNever(editAction);
-  }
-}
-/**
- * Executes the given text edit actions on an object representing the important state of textarea editing,
- * the current text, selection start, and selection end.
- */
-
-export function performTextEditActionsOnString(args) {
-  let {
-    text: currentText,
-    selStart,
-    selEnd
-  } = args;
-  args.actions.forEach(action => {
-    switch (action.action) {
-      case 'insert':
-        currentText = currentText.substring(0, selStart) + action.text + currentText.substring(selEnd);
-        selStart += action.text.length;
-        selEnd = selStart;
-        break;
-
-      case 'wrapSelection':
-        {
-          var _action$before, _action$after;
-
-          const before = (_action$before = action.before) !== null && _action$before !== void 0 ? _action$before : '';
-          const after = (_action$after = action.after) !== null && _action$after !== void 0 ? _action$after : '';
-          currentText = currentText.substring(0, selStart) + before + currentText.substring(selStart, selEnd) + after + currentText.substring(selEnd);
-          selStart += before.length;
-          selEnd += before.length;
-        }
-        break;
-
-      default:
-        assertNever(action);
-    }
-  });
-  return {
-    text: currentText,
-    selStart,
-    selEnd
-  };
-}

package/lib/util/tinymce-plugin-util.js

@@ -1,52 +0,0 @@
-/*
- * Copyright (C) 2022 - present Instructure, Inc.
- *
- * This file is part of Canvas.
- *
- * Canvas is free software: you can redistribute it and/or modify it under
- * the terms of the GNU Affero General Public License as published by the Free
- * Software Foundation, version 3 of the License.
- *
- * Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
- * A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
- * details.
- *
- * You should have received a copy of the GNU Affero General Public License along
- * with this program. If not, see <http://www.gnu.org/licenses/>.
- */
-
-/**
- * Returns a helper for updating the icon of a toolbar button in a TinyMCE editor, necessary since there isn't a
- * built-in API for doing this, and RCE UX calls for toolbar buttons to be updated to match the user's selection
- * in the editor.
- *
- *
- * NOTE:
- * This function returns a helper that can later be used to actually update the icon. This is done so that
- * `toolbarIconHelperFor` can be called in the `onSetup` method of a button, such that any errors in finding the
- * icon in the toolbar will occur at RCE setup time, and not later, when user action occurs, thus increasing the
- * likelihood that those errors will be caught in tests, rather than being thrown at runtime as a result of user action
- */
-export function toolbarIconHelperFor(editor, ariaLabel) {
-  // There are a few different potential button selectors
-  const containerSelector = ['.tox-tbtn', '.tox-split-button'].map(buttonSel => `${buttonSel}[aria-label="${CSS.escape(ariaLabel)}"] .tox-icon`).join(',');
-  const $svgContainer = editor.$(containerSelector, document);
-
-  if ($svgContainer.length === 0) {
-    console.error(`Failed to find TinyMCE toolbar button for ariaLabel "${ariaLabel}" using selector: ${containerSelector}`);
-  }
-
-  return {
-    updateIcon(iconName) {
-      const svg = editor.ui.registry.getAll().icons[iconName];
-
-      if (!svg) {
-        console.error(`Invalid icon name given for button labeled "${ariaLabel}": ${iconName}`);
-      }
-
-      $svgContainer.html(svg);
-    }
-
-  };
-}

package/lib/util/url-util.js

@@ -1,138 +0,0 @@
-/*
- * Copyright (C) 2023 - present Instructure, Inc.
- *
- * This file is part of Canvas.
- *
- * Canvas is free software: you can redistribute it and/or modify it under
- * the terms of the GNU Affero General Public License as published by the Free
- * Software Foundation, version 3 of the License.
- *
- * Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
- * A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
- * details.
- *
- * You should have received a copy of the GNU Affero General Public License along
- * with this program. If not, see <http://www.gnu.org/licenses/>.
- */
-import * as URI from 'uri-js';
-/**
- * Attempts to build a URL from the given string, and returns null if it is not a valid URL, rather than
- * throwing an exception, as the URL constructor does.
- */
-
-export function parseUrlOrNull(url, base) {
-  if (!url) return null;
-
-  try {
-    return new URL(url, base);
-  } catch (e) {
-    return null;
-  }
-}
-export function relativizeUrl(url) {
-  const parsed = URI.parse(url);
-  delete parsed.scheme;
-  delete parsed.userinfo;
-  delete parsed.host;
-  delete parsed.port;
-  return URI.serialize(parsed);
-}
-/**
- * Converts the given URL into a relative URL if it meets the following criteria:
- * - is parsable by the browser URL class
- * - has the HTTP or HTTPS protocol
- * - has the same hostname as the given origin
- *
- * Note: This will relativize URLs where the ports don't match. This is intentional, as ports really shouldn't
- * matter for RCE HTTP content, and it can solve issues where an extraneous port is added (e.g. :80 on an http url)
- * or when running locally and the port is different. There isn't a security issue because the user could just manually
- * put in the transformed content anyways.
- *
- * @param inputUrlStr URL to relativize
- * @param origin Origin to check for
- */
-
-export function relativeHttpUrlForHostname(inputUrlStr, origin) {
-  if (inputUrlStr == null || inputUrlStr === '') {
-    return inputUrlStr;
-  }
-
-  if (!(inputUrlStr !== null && inputUrlStr !== void 0 && inputUrlStr.match(/^https?:/i)) || !(origin !== null && origin !== void 0 && origin.match(/^https?:/i))) {
-    // Already relative or not a http/https protocol url
-    return inputUrlStr;
-  }
-
-  const url = parseUrlOrNull(inputUrlStr);
-
-  if (url == null) {
-    return inputUrlStr;
-  } // Handle the simple case of origins matching. Note that the parsed URL will always have a lowercase origin
-  // new URL("hTTps://CaNvAs.CoM").origin === 'https://canvas.com'
-
-
-  if (url.origin === origin.toLowerCase()) {
-    return relativizeUrl(inputUrlStr);
-  } // Handle the more complex case of hostname/port matching
-
-
-  const originUrl = parseUrlOrNull(origin);
-  const originHostname = originUrl === null || originUrl === void 0 ? void 0 : originUrl.hostname; // Port checks are only needed if the port is not the default port for http or https.
-  // If the port isn't an http port, then we don't want equivalence, especially for local origins,
-  // since you might be running canvas on "localhost:3000" and some LTI tool on "localhost:4000"
-  // But elsewhere, "http://canvas.com:80" and "http://canvas.com" are equivalent
-
-  const urlUsesHttpPort = url.port === '80' || url.port === '443' || url.port === '';
-  const originUsesHttpPort = originUrl == null || (originUrl === null || originUrl === void 0 ? void 0 : originUrl.port) === '80' || (originUrl === null || originUrl === void 0 ? void 0 : originUrl.port) === '443' || (originUrl === null || originUrl === void 0 ? void 0 : originUrl.port) === '';
-  const portCheckNeeded = !(urlUsesHttpPort && originUsesHttpPort);
-
-  if (portCheckNeeded && (originUrl === null || originUrl === void 0 ? void 0 : originUrl.port) !== (url === null || url === void 0 ? void 0 : url.port)) {
-    return inputUrlStr;
-  }
-
-  if (url.hostname === (originHostname === null || originHostname === void 0 ? void 0 : originHostname.toLowerCase())) {
-    return relativizeUrl(inputUrlStr);
-  } else {
-    return inputUrlStr;
-  }
-}
-/**
- * Adds a record of query parameters to a URL. null or undefined values in the record are ignored.
- *
- * - Relative URLs are supported.
- * - Non-parsable URLs will return null.
- *
- * @param inputUrlStr The URL string to parse
- * @param queryParams A record containing the query parameters to add
- */
-
-export function addQueryParamsToUrl(inputUrlStr, queryParams) {
-  var _parsedUrl$query;
-
-  if (inputUrlStr == null) {
-    return null;
-  }
-
-  const paramEntries = Object.entries(queryParams);
-
-  if (paramEntries.length === 0) {
-    return inputUrlStr;
-  }
-
-  const parsedUrl = URI.parse(inputUrlStr);
-
-  if (parsedUrl == null) {
-    return null;
-  }
-
-  const searchParams = new URLSearchParams((_parsedUrl$query = parsedUrl.query) !== null && _parsedUrl$query !== void 0 ? _parsedUrl$query : '');
-
-  for (const [paramName, paramValue] of paramEntries) {
-    if (paramValue != null) {
-      searchParams.set(paramName, paramValue);
-    }
-  }
-
-  parsedUrl.query = searchParams.toString();
-  return URI.serialize(parsedUrl);
-}