@instructure/canvas-rce 5.11.1 → 5.12.2

package/lib/rce/plugins/instructure_rce_external_tools/lti13-content-items/RceLti13ContentItem.js

@@ -1,111 +0,0 @@
-// @ts-nocheck
-
-/*
- * Copyright (C) 2018 - 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 { isContentItemIframeJson, isContentItemThumbnailJson } from './Lti13ContentItemJson';
-import { addParentFrameContextToUrl } from '../util/addParentFrameContextToUrl';
-/**
- * Represents an LTI 1.3 Deep Linking Content Item for purposes related to the Rich Content Editor.
- *
- * Use rceLti13ContentItemFromJson to create instances of this class.
- */
-
-export class RceLti13ContentItem {
-  constructor(type, json, context) {
-    this.type = type;
-    this.json = json;
-    this.context = context;
-  }
-
-  get untypedJson() {
-    return this.json;
-  }
-
-  linkThumbnail() {
-    if (isContentItemThumbnailJson(this.untypedJson.thumbnail)) {
-      const {
-        url,
-        width,
-        height
-      } = this.untypedJson.thumbnail;
-      return this.imageTag(url, width, height);
-    } else if (typeof this.untypedJson.thumbnail === 'string') {
-      return this.imageTag(this.untypedJson.thumbnail);
-    }
-  }
-
-  iframeTag() {
-    const iframeInfo = this.untypedJson.iframe;
-
-    if (isContentItemIframeJson(iframeInfo)) {
-      var _addParentFrameContex, _this$context$ltiIfra;
-
-      const iframeTag = document.createElement('iframe');
-      iframeTag.setAttribute('src', (_addParentFrameContex = addParentFrameContextToUrl(iframeInfo.src, this.context.containingCanvasLtiToolId)) !== null && _addParentFrameContex !== void 0 ? _addParentFrameContex : '');
-      iframeTag.setAttribute('title', this.buildTitle() || '');
-      iframeTag.setAttribute('allowfullscreen', 'true');
-      iframeTag.setAttribute('allow', (_this$context$ltiIfra = this.context.ltiIframeAllowPolicy) !== null && _this$context$ltiIfra !== void 0 ? _this$context$ltiIfra : '');
-
-      if (iframeInfo.width) {
-        iframeTag.style.width = `${iframeInfo.width}px`;
-      }
-
-      if (iframeInfo.height) {
-        iframeTag.style.height = `${iframeInfo.height}px`;
-      }
-
-      return iframeTag.outerHTML;
-    }
-  }
-
-  imageTag(src, width, height) {
-    const imgTag = document.createElement('img');
-    imgTag.setAttribute('src', src);
-    const text = this.buildText();
-
-    if (text != null) {
-      imgTag.setAttribute('alt', text);
-    }
-
-    if (width) {
-      imgTag.setAttribute('width', width.toString());
-    }
-
-    if (height) {
-      imgTag.setAttribute('height', height.toString());
-    }
-
-    return imgTag.outerHTML;
-  }
-
-  anchorTag(innerHTML) {
-    const anchorTag = document.createElement('a');
-    anchorTag.setAttribute('href', this.safeUrl);
-    anchorTag.setAttribute('title', this.buildTitle() || '');
-    anchorTag.setAttribute('target', '_blank');
-    anchorTag.innerHTML = innerHTML || '';
-    return anchorTag.outerHTML;
-  }
-
-  get safeUrl() {
-    var _this$buildUrl;
-
-    return ((_this$buildUrl = this.buildUrl()) === null || _this$buildUrl === void 0 ? void 0 : _this$buildUrl.replace(/^(data:text\/html|javascript:)/, '#$1')) || '';
-  }
-
-}

package/lib/rce/plugins/instructure_rce_external_tools/lti13-content-items/models/BaseLinkContentItem.js

@@ -1,79 +0,0 @@
-/*
- * Copyright (C) 2018 - 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 { RceLti13ContentItem } from '../RceLti13ContentItem';
-// Base content item type
-export default class BaseLinkContentItem extends RceLti13ContentItem {
-  toHtmlString() {
-    var _this$iframe;
-
-    if (((_this$iframe = this.iframe) === null || _this$iframe === void 0 ? void 0 : _this$iframe.src) != null) {
-      return this.iframeTag();
-    } else {
-      return this.anchorTag(this.linkBody());
-    }
-  }
-
-  linkText() {
-    var _this$buildText$trim, _this$buildText, _this$buildTitle$trim, _this$buildTitle;
-
-    const text = (_this$buildText$trim = (_this$buildText = this.buildText()) === null || _this$buildText === void 0 ? void 0 : _this$buildText.trim()) !== null && _this$buildText$trim !== void 0 ? _this$buildText$trim : '';
-    const title = (_this$buildTitle$trim = (_this$buildTitle = this.buildTitle()) === null || _this$buildTitle === void 0 ? void 0 : _this$buildTitle.trim()) !== null && _this$buildTitle$trim !== void 0 ? _this$buildTitle$trim : '';
-    return text.length > 0 ? text : title.length > 0 ? title : undefined;
-  }
-
-  linkBody() {
-    if (this.thumbnail) {
-      return this.linkThumbnail();
-    }
-
-    return this.linkText();
-  }
-
-  buildText() {
-    return this.context.selection || this.json.text;
-  }
-
-  buildUrl() {
-    return this.json.url;
-  }
-
-  buildTitle() {
-    return this.json.title;
-  }
-
-  get icon() {
-    return this.json.icon;
-  }
-
-  get thumbnail() {
-    return this.json.thumbnail;
-  }
-
-  get iframe() {
-    return this.json.iframe;
-  }
-
-  get custom() {
-    return this.json.custom;
-  }
-
-  get lookup_uuid() {
-    return this.json.lookup_uuid;
-  }
-
-}

package/lib/rce/plugins/instructure_rce_external_tools/lti13-content-items/models/HtmlFragmentContentItem.js

@@ -1,47 +0,0 @@
-/*
- * Copyright (C) 2018 - 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 { RceLti13ContentItem } from '../RceLti13ContentItem';
-export default class HtmlFragmentContentItem extends RceLti13ContentItem {
-  constructor(json, context) {
-    super(HtmlFragmentContentItem.type, json, context);
-  }
-
-  get html() {
-    return this.json.html;
-  }
-
-  buildTitle() {
-    return this.json.title;
-  }
-
-  buildText() {
-    return this.json.text;
-  }
-
-  buildUrl() {
-    return undefined;
-  }
-
-  toHtmlString() {
-    // TinyMCE takes care of sanitizing this HTML string.
-    // If using a target other than TinyMCE be sure to sanitize.
-    return this.html;
-  }
-
-}
-HtmlFragmentContentItem.type = 'html';

package/lib/rce/plugins/instructure_rce_external_tools/lti13-content-items/models/ImageContentItem.js

@@ -1,57 +0,0 @@
-/*
- * Copyright (C) 2018 - 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 { RceLti13ContentItem } from '../RceLti13ContentItem';
-export default class ImageContentItem extends RceLti13ContentItem {
-  constructor(json, context) {
-    super(ImageContentItem.type, json, context);
-  }
-
-  buildUrl() {
-    return this.json.url;
-  }
-
-  buildTitle() {
-    return this.json.title;
-  }
-
-  get thumbnail() {
-    return this.json.thumbnail;
-  }
-
-  buildText() {
-    return this.json.text;
-  }
-
-  get width() {
-    return this.json.width;
-  }
-
-  get height() {
-    return this.json.height;
-  }
-
-  toHtmlString() {
-    if (this.thumbnail) {
-      return this.anchorTag(this.linkThumbnail());
-    }
-
-    return this.imageTag(this.safeUrl, this.width, this.height);
-  }
-
-}
-ImageContentItem.type = 'image';

package/lib/rce/plugins/instructure_rce_external_tools/lti13-content-items/models/LinkContentItem.js

@@ -1,26 +0,0 @@
-/*
- * Copyright (C) 2018 - 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 BaseLinkContentItem from './BaseLinkContentItem';
-// Base content item type
-export default class LinkContentItem extends BaseLinkContentItem {
-  constructor(json, context) {
-    super(LinkContentItem.type, json, context);
-  }
-
-}
-LinkContentItem.type = 'link';

package/lib/rce/plugins/instructure_rce_external_tools/lti13-content-items/models/ResourceLinkContentItem.js

@@ -1,45 +0,0 @@
-/*
- * Copyright (C) 2018 - 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 BaseLinkContentItem from './BaseLinkContentItem';
-import { addQueryParamsToUrl } from '../../../../../util/url-util';
-import { PARENT_FRAME_CONTEXT_PARAM } from '../../ExternalToolsEnv';
-export default class ResourceLinkContentItem extends BaseLinkContentItem {
-  constructor(json, context) {
-    super(ResourceLinkContentItem.type, json, context);
-  }
-
-  toHtmlString() {
-    if (this.iframe != null) {
-      // The iframe src must always be the Canvas launch endpoint
-      this.iframe.src = this.safeUrl;
-      return this.iframeTag();
-    } else {
-      return this.anchorTag(this.linkBody());
-    }
-  }
-
-  buildUrl() {
-    return addQueryParamsToUrl(this.context.ltiEndpoint, {
-      display: 'in_rce',
-      resource_link_lookup_uuid: this.lookup_uuid,
-      [PARENT_FRAME_CONTEXT_PARAM]: this.context.containingCanvasLtiToolId
-    });
-  }
-
-}
-ResourceLinkContentItem.type = 'ltiResourceLink';

package/lib/rce/plugins/instructure_rce_external_tools/lti13-content-items/processEditorContentItems.js

@@ -1,67 +0,0 @@
-// @ts-nocheck
-
-/*
- * Copyright (C) 2018 - 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 { rceLti13ContentItemFromJson } from './rceLti13ContentItemFromJson';
-import { showFlashAlert } from '../../../../common/FlashAlert';
-import formatMessage from '../../../../format-message';
-export default function processEditorContentItems(event, env, dialog) {
-  try {
-    var _event$data, _event$data$content_i, _event$data2, _event$data3;
-
-    const ltiEndpoint = (_event$data = event.data) === null || _event$data === void 0 ? void 0 : _event$data.ltiEndpoint;
-    const selection = env.editorSelection;
-    const eventContentItems = (_event$data$content_i = (_event$data2 = event.data) === null || _event$data2 === void 0 ? void 0 : _event$data2.content_items) !== null && _event$data$content_i !== void 0 ? _event$data$content_i : [];
-    let unsupportedItemWarningShown = false;
-
-    for (const inputItem of eventContentItems) {
-      const parsedItem = rceLti13ContentItemFromJson(inputItem, {
-        ltiEndpoint: ltiEndpoint !== null && ltiEndpoint !== void 0 ? ltiEndpoint : null,
-        selection: selection !== null && selection !== void 0 ? selection : null,
-        containingCanvasLtiToolId: env.containingCanvasLtiToolId,
-        ltiIframeAllowPolicy: env.ltiIframeAllowPolicy
-      });
-
-      if (parsedItem != null) {
-        env.insertCode(parsedItem.toHtmlString());
-      } else if (!unsupportedItemWarningShown) {
-        var _inputItem$type;
-
-        showFlashAlert({
-          message: formatMessage('Could not insert content: "{itemType}" items are not currently supported in Canvas.', {
-            itemType: (_inputItem$type = inputItem.type) !== null && _inputItem$type !== void 0 ? _inputItem$type : 'unknown'
-          }),
-          type: 'warning',
-          err: null
-        });
-        unsupportedItemWarningShown = true;
-      }
-    } // Remove "unsaved changes" warnings and close modal
-
-
-    if ((_event$data3 = event.data) !== null && _event$data3 !== void 0 && _event$data3.content_items) {
-      dialog === null || dialog === void 0 ? void 0 : dialog.close();
-    }
-  } catch (e) {
-    showFlashAlert({
-      message: formatMessage('Failed to retrieve content from external tool'),
-      type: 'error',
-      err: e
-    });
-  }
-}

package/lib/rce/plugins/instructure_rce_external_tools/lti13-content-items/rceLti13ContentItemFromJson.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/>.
- */
-import HtmlFragmentContentItem from './models/HtmlFragmentContentItem';
-import ImageContentItem from './models/ImageContentItem';
-import LinkContentItem from './models/LinkContentItem';
-import ResourceLinkContentItem from './models/ResourceLinkContentItem';
-
-/**
- * Creates an RceLti13ContentItem from the given JSON, or null if the type isn't supported.
- *
- * Note: this function would ideally be a static member of RceLti13ContentItem, but that creates a circular dependency
- *       with the implementations of the base class, so it needs to be in a separate module.
- *
- * @param itemJson
- * @param context
- */
-export function rceLti13ContentItemFromJson(itemJson, context) {
-  if (!itemJson.type) return null;
-  const clazz = typeRegistry[itemJson.type]; // eslint-disable-next-line new-cap
-
-  return clazz ? new clazz(itemJson, context) : null;
-}
-/*
- * Type safe registry of implementation of RceLti13ContentItem. Adding additional types to the Lti13ContentItemJson
- * union will cause a compiler error if the implementations aren't added here as well.
- */
-
-const typeRegistry = {
-  html: HtmlFragmentContentItem,
-  image: ImageContentItem,
-  link: LinkContentItem,
-  ltiResourceLink: ResourceLinkContentItem
-};

package/lib/rce/plugins/instructure_rce_external_tools/plugin.js

@@ -1,112 +0,0 @@
-/*
- * Copyright (C) 2018 - 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 tinymce from 'tinymce';
-import React from 'react';
-import ReactDOM from 'react-dom';
-import { RceToolWrapper, buildToolMenuItems } from './RceToolWrapper';
-import formatMessage from '../../../format-message';
-import { ExternalToolSelectionDialog } from './components/ExternalToolSelectionDialog/ExternalToolSelectionDialog';
-import { ensureToolDialogContainerElem } from './dialog-helper';
-import { externalToolsEnvFor } from './ExternalToolsEnv'; // Register plugin
-
-tinymce.PluginManager.add('instructure_rce_external_tools', initExternalToolsLocalPlugin);
-/**
- * This plugin adds the "Apps" toolbar button and the "Apps" menu item. It is a rewrite of 'instructure_external_tools'
- * to live fully in the canvas-rce package. It supports running in an iframe as part of an LTI tool, such as
- * new quizzes.
- *
- * @param editor
- */
-
-export function initExternalToolsLocalPlugin(editor) {
-  if (RceToolWrapper.forEditorEnv(externalToolsEnvFor(editor)).length === 0) {
-    return;
-  }
-
-  registerFavoriteAppsToolbarButtons(editor);
-  registerAppsToolbarButton(editor);
-  registerAppsMenu(editor);
-}
-/**
- * Add the "Apps" toolbar button with "View all" and MRU buttons
- */
-
-function registerAppsMenu(editor) {
-  editor.ui.registry.addNestedMenuItem('lti_tools_menuitem', {
-    text: formatMessage('Apps'),
-    icon: 'lti',
-    getSubmenuItems: () => {
-      const availableTools = RceToolWrapper.forEditorEnv(externalToolsEnvFor(editor));
-      const toolMenuItems = buildToolMenuItems(availableTools, makeViewAllItem(editor));
-      return toolMenuItems;
-    }
-  });
-}
-/**
- * Registers toolbar buttons for favorite apps
- */
-
-
-function registerFavoriteAppsToolbarButtons(editor) {
-  RceToolWrapper.forEditorEnv(externalToolsEnvFor(editor)).filter(it => it.favorite).forEach(toolInfo => editor.ui.registry.addButton(`instructure_external_button_${toolInfo.id}`, toolInfo.asToolbarButton()));
-}
-
-function registerAppsToolbarButton(editor) {
-  const tooltip = formatMessage('Apps');
-  editor.ui.registry.addMenuButton('lti_mru_button', {
-    tooltip,
-    icon: 'lti',
-    fetch: callback => {
-      const availableTools = RceToolWrapper.forEditorEnv(externalToolsEnvFor(editor));
-      const toolMenuItems = buildToolMenuItems(availableTools, makeViewAllItem(editor));
-      callback(toolMenuItems);
-    },
-
-    onSetup(_api) {
-      return () => undefined;
-    }
-
-  });
-}
-
-function openToolSelectionDialog(editor) {
-  const availableTools = RceToolWrapper.forEditorEnv(externalToolsEnvFor(editor));
-  const container = ensureToolDialogContainerElem();
-
-  const handleDismiss = () => {
-    ReactDOM.unmountComponentAtNode(container);
-    editor.focus();
-  };
-
-  ReactDOM.render( /*#__PURE__*/React.createElement(ExternalToolSelectionDialog, {
-    onDismiss: handleDismiss,
-    ltiButtons: availableTools
-  }), ensureToolDialogContainerElem());
-}
-
-function makeViewAllItem(editor) {
-  return {
-    type: 'menuitem',
-    text: formatMessage('View All'),
-
-    onAction() {
-      openToolSelectionDialog(editor);
-    }
-
-  };
-}

package/lib/rce/plugins/instructure_rce_external_tools/util/addParentFrameContextToUrl.js

@@ -1,27 +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 { addQueryParamsToUrl } from '../../../../util/url-util';
-export function addParentFrameContextToUrl(inputUrlStr, containingCanvasLtiToolId) {
-  if (containingCanvasLtiToolId == null || containingCanvasLtiToolId.length === 0) {
-    return inputUrlStr !== null && inputUrlStr !== void 0 ? inputUrlStr : null;
-  }
-
-  return addQueryParamsToUrl(inputUrlStr, {
-    parent_frame_context: containingCanvasLtiToolId
-  });
-}