@instructure/canvas-rce 5.11.1 → 5.12.2

package/lib/rce/plugins/instructure_links/components/LinkSet.js

@@ -1,195 +0,0 @@
-/*
- * Copyright (C) 2019 - 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 React, { Component, useRef } from 'react';
-import { bool, func, string } from 'prop-types';
-import { linkShape, linksShape, linkType } from './propTypes';
-import formatMessage from '../../../../format-message';
-import { ScreenReaderContent } from '@instructure/ui-a11y-content';
-import { List } from '@instructure/ui-list';
-import { View } from '@instructure/ui-view';
-import uid from '@instructure/uid';
-import { LoadMoreButton, LoadingIndicator, LoadingStatus, useIncrementalLoading } from '../../../../common/incremental-loading';
-import Link from './Link';
-import RCEGlobals from '../../../RCEGlobals';
-import { NoResults } from './NoResults';
-/*
- * This is needed only as long as `LinkSet` is a class component.
- */
-
-function IncrementalLoader(props) {
-  const {
-    children,
-    collection,
-    fetchInitialPage,
-    fetchNextPage,
-    contextType,
-    searchString
-  } = props;
-  const {
-    hasMore,
-    isLoading,
-    links
-  } = collection;
-  const lastItemRef = useRef(null);
-  const loader = useIncrementalLoading({
-    hasMore: hasMore && fetchNextPage != null,
-    isLoading,
-    lastItemRef,
-    contextType,
-    sortBy: {
-      sort: 'alphabetical',
-      order: 'asc'
-    },
-    // not actually used in the query, but a required param
-    searchString,
-
-    onLoadInitial() {
-      if (fetchInitialPage) {
-        fetchInitialPage();
-      }
-    },
-
-    onLoadMore() {
-      fetchNextPage();
-    },
-
-    records: links
-  });
-  return children({
-    loader,
-    lastItemRef
-  });
-}
-
-class LinkSet extends Component {
-  constructor(props) {
-    super(props);
-    this.describedByID = `rce-LinkSet-describedBy-${uid()}`;
-    this.loadMoreButtonRef = null;
-  }
-
-  hasLinks(props) {
-    return props.collection.links.length > 0;
-  }
-
-  isEmpty(props) {
-    return !this.hasLinks(props) && !props.collection.hasMore && !props.collection.isLoading;
-  }
-
-  compareURLs() {
-    let url1 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : '';
-    let url2 = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : '';
-    if (url1 === '' || url2 === '') return false;
-    return url1.split('?')[0] === url2.split('?')[0];
-  }
-
-  renderLinks(lastItemRef) {
-    function refFor(index, array) {
-      if (!lastItemRef || index !== array.length - 1) {
-        return null;
-      } // Return a compatible callback ref for InstUI
-
-
-      return ref => {
-        lastItemRef.current = ref;
-      };
-    }
-
-    return /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(ScreenReaderContent, {
-      id: this.describedByID
-    }, formatMessage('Click to insert a link into the editor.')), /*#__PURE__*/React.createElement(List, {
-      isUnstyled: true,
-      as: "ul",
-      margin: "0"
-    }, this.props.collection.links.map((link, index, array) => {
-      var _this$props$selectedL;
-
-      return /*#__PURE__*/React.createElement(List.Item, {
-        key: link.href,
-        spacing: "none",
-        padding: "0"
-      }, /*#__PURE__*/React.createElement(Link, {
-        link: link,
-        type: this.props.type,
-        onClick: this.props.onLinkClick,
-        describedByID: this.describedByID,
-        elementRef: refFor(index, array),
-        editing: this.props.editing,
-        onEditClick: this.props.onEditClick,
-        isSelected: this.compareURLs((_this$props$selectedL = this.props.selectedLink) === null || _this$props$selectedL === void 0 ? void 0 : _this$props$selectedL.href, link.href)
-      }));
-    })));
-  }
-
-  renderEmptyIndicator() {
-    var _this$props$searchStr;
-
-    return /*#__PURE__*/React.createElement(NoResults, {
-      contextType: this.props.contextType,
-      contextId: this.props.contextId,
-      collectionType: this.props.type,
-      isSearchResult: ((_this$props$searchStr = this.props.searchString) === null || _this$props$searchStr === void 0 ? void 0 : _this$props$searchStr.length) >= 3
-    });
-  }
-
-  renderLoadingError() {
-    if (this.props.collection.lastError) {
-      return /*#__PURE__*/React.createElement("span", {
-        className: "rcs-LinkSet-LoadFailed",
-        role: "alert"
-      }, formatMessage('Loading failed...'));
-    }
-
-    return null;
-  }
-
-  render() {
-    return /*#__PURE__*/React.createElement(IncrementalLoader, this.props, _ref => {
-      let {
-        loader,
-        lastItemRef
-      } = _ref;
-      return /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement("div", {
-        "data-testid": "instructure_links-LinkSet"
-      }, this.hasLinks(this.props) && this.renderLinks(lastItemRef), this.renderLoadingError(), loader.isLoading && /*#__PURE__*/React.createElement(LoadingIndicator, {
-        loader: loader
-      }), !loader.isLoading && loader.hasMore && /*#__PURE__*/React.createElement(LoadMoreButton, {
-        loader: loader
-      }), this.isEmpty(this.props) && !this.props.suppressRenderEmpty && this.renderEmptyIndicator()), /*#__PURE__*/React.createElement(LoadingStatus, {
-        loader: loader
-      }));
-    });
-  }
-
-}
-
-LinkSet.propTypes = {
-  type: linkType.isRequired,
-  collection: linksShape.isRequired,
-  onLinkClick: func.isRequired,
-  contextType: string.isRequired,
-  contextId: string.isRequired,
-  fetchInitialPage: func,
-  fetchNextPage: func,
-  suppressRenderEmpty: bool,
-  searchString: string,
-  editing: bool,
-  onEditClick: func,
-  selectedLink: linkShape
-};
-export default LinkSet;

package/lib/rce/plugins/instructure_links/components/LinksPanel.js

@@ -1,100 +0,0 @@
-/*
- * Copyright (C) 2019 - 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 React from 'react';
-import { bool, func, string } from 'prop-types';
-import formatMessage from '../../../../format-message';
-import { collectionsShape, linkShape } from './propTypes';
-import NavigationPanel from './NavigationPanel';
-import CollectionPanel from './CollectionPanel';
-import { View } from '@instructure/ui-view';
-import { pickProps } from '@instructure/ui-react-utils';
-
-function LinksPanel(props) {
-  const isCourse = props.contextType === 'course';
-  const isGroup = props.contextType === 'group';
-  const collectionProps = pickProps(props, CollectionPanel.propTypes);
-  return /*#__PURE__*/React.createElement(View, {
-    as: "div",
-    "data-testid": "instructure_links-LinksPanel"
-  }, (isCourse || isGroup) && /*#__PURE__*/React.createElement(CollectionPanel, Object.assign({}, collectionProps, {
-    editing: props.editing,
-    onEditClick: props.onEditClick,
-    selectedLink: props.selectedLink,
-    collection: "wikiPages",
-    label: formatMessage('Pages')
-  })), isCourse && /*#__PURE__*/React.createElement(CollectionPanel, Object.assign({}, collectionProps, {
-    editing: props.editing,
-    onEditClick: props.onEditClick,
-    selectedLink: props.selectedLink,
-    collection: "assignments",
-    label: formatMessage('Assignments')
-  })), isCourse && /*#__PURE__*/React.createElement(CollectionPanel, Object.assign({}, collectionProps, {
-    editing: props.editing,
-    onEditClick: props.onEditClick,
-    selectedLink: props.selectedLink,
-    collection: "quizzes",
-    label: formatMessage('Quizzes')
-  })), (isCourse || isGroup) && /*#__PURE__*/React.createElement(CollectionPanel, Object.assign({}, collectionProps, {
-    editing: props.editing,
-    onEditClick: props.onEditClick,
-    selectedLink: props.selectedLink,
-    collection: "announcements",
-    label: formatMessage('Announcements')
-  })), (isCourse || isGroup) && /*#__PURE__*/React.createElement(CollectionPanel, Object.assign({}, collectionProps, {
-    editing: props.editing,
-    onEditClick: props.onEditClick,
-    selectedLink: props.selectedLink,
-    collection: "discussions",
-    label: formatMessage('Discussions')
-  })), isCourse && /*#__PURE__*/React.createElement(CollectionPanel, Object.assign({}, collectionProps, {
-    editing: props.editing,
-    onEditClick: props.onEditClick,
-    selectedLink: props.selectedLink,
-    collection: "modules",
-    label: formatMessage('Modules')
-  })), /*#__PURE__*/React.createElement(NavigationPanel, {
-    contextType: props.contextType,
-    contextId: props.contextId,
-    onLinkClick: props.onLinkClick,
-    onChangeAccordion: props.onChangeAccordion,
-    selectedAccordionIndex: props.selectedAccordionIndex,
-    editing: props.editing,
-    onEditClick: props.onEditClick
-  }));
-}
-
-LinksPanel.propTypes = {
-  selectedAccordionIndex: string,
-  onChangeAccordion: func,
-  contextType: string.isRequired,
-  contextId: string.isRequired,
-  searchString: string,
-  collections: collectionsShape.isRequired,
-  fetchInitialPage: func,
-  fetchNextPage: func,
-  onLinkClick: func,
-  canCreatePages: bool,
-  editing: bool,
-  onEditClick: func,
-  selectedLink: linkShape
-};
-LinksPanel.defaultProps = {
-  selectedAccordionIndex: '',
-  editing: false
-};
-export default LinksPanel;

package/lib/rce/plugins/instructure_links/components/NavigationPanel.js

@@ -1,141 +0,0 @@
-/*
- * Copyright (C) 2019 - 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 { bool, func, string } from 'prop-types';
-import React from 'react';
-import LinkSet from './LinkSet';
-import formatMessage from '../../../../format-message';
-import AccordionSection from './AccordionSection';
-
-function typeCollection(contextId, contextType) {
-  switch (contextType) {
-    case 'course':
-      return {
-        links: [{
-          href: `/courses/${contextId}`,
-          title: formatMessage('Home')
-        }, {
-          href: `/courses/${contextId}/announcements`,
-          title: formatMessage('Announcements')
-        }, {
-          href: `/courses/${contextId}/assignments`,
-          title: formatMessage('Assignments')
-        }, {
-          href: `/courses/${contextId}/discussion_topics`,
-          title: formatMessage('Discussions')
-        }, {
-          href: `/courses/${contextId}/grades`,
-          title: formatMessage('Grades')
-        }, {
-          href: `/courses/${contextId}/users`,
-          title: formatMessage('People')
-        }, {
-          href: `/courses/${contextId}/pages`,
-          title: formatMessage('Pages')
-        }, {
-          href: `/courses/${contextId}/files`,
-          title: formatMessage('Files')
-        }, {
-          href: `/courses/${contextId}/assignments/syllabus`,
-          title: formatMessage('Syllabus')
-        }, // outcomes
-        {
-          href: `/courses/${contextId}/quizzes`,
-          title: formatMessage('Quizzes')
-        }, {
-          href: `/courses/${contextId}/modules`,
-          title: formatMessage('Modules')
-        }, // conferences
-        {
-          href: `/courses/${contextId}/collaborations`,
-          title: formatMessage('Collaborations')
-        } // settings
-        ]
-      };
-
-    case 'group':
-      return {
-        links: [{
-          href: `/groups/${contextId}/pages`,
-          title: formatMessage('Wiki Home')
-        }, {
-          href: `/groups/${contextId}/discussion_topics`,
-          title: formatMessage('Discussions Index')
-        }, {
-          href: `/groups/${contextId}/announcements`,
-          title: formatMessage('Announcement List')
-        }, {
-          href: `/groups/${contextId}/files`,
-          title: formatMessage('Files Index')
-        }, {
-          href: `/groups/${contextId}/collaborations`,
-          title: formatMessage('Collaborations')
-        }, {
-          href: `/groups/${contextId}/users`,
-          title: formatMessage('People')
-        }]
-      };
-
-    default:
-      // user, TODO
-      return {
-        links: [{
-          href: `/users/${contextId}/files`,
-          title: formatMessage('Files Index')
-        }]
-      };
-  }
-}
-
-export default function NavigationPanel(props) {
-  const collection = typeCollection(props.contextId, props.contextType);
-  let navigationSummary = '';
-
-  if (props.contextType === 'course') {
-    navigationSummary = formatMessage('Course Navigation');
-  } else if (props.contextType === 'group') {
-    navigationSummary = formatMessage('Group Navigation');
-  } else {
-    return null;
-  }
-
-  return /*#__PURE__*/React.createElement("div", {
-    "data-testid": "instructure_links-NavigationPanel"
-  }, /*#__PURE__*/React.createElement(AccordionSection, {
-    collection: "navigation",
-    onToggle: props.onChangeAccordion,
-    expanded: props.selectedAccordionIndex === 'navigation',
-    label: navigationSummary
-  }, /*#__PURE__*/React.createElement(LinkSet, {
-    type: "navigation",
-    collection: collection,
-    onLinkClick: props.onLinkClick,
-    contextType: props.contextType,
-    contextId: props.contextId,
-    editing: props.editing,
-    onEditClick: props.onEditClick
-  })));
-}
-NavigationPanel.propTypes = {
-  contextType: string.isRequired,
-  contextId: string.isRequired,
-  onChangeAccordion: func.isRequired,
-  selectedAccordionIndex: string,
-  onLinkClick: func,
-  editing: bool,
-  onEditClick: func
-};

package/lib/rce/plugins/instructure_links/components/NoResults.js

@@ -1,87 +0,0 @@
-import _pt from "prop-types";
-
-/*
- * 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 React from 'react';
-import { View } from '@instructure/ui-view';
-import { Flex } from '@instructure/ui-flex';
-import { Text } from '@instructure/ui-text';
-import { Link } from '@instructure/ui-link';
-import formatMessage from '../../../../format-message';
-import { getIcon } from '../../shared/linkUtils';
-export function buildUrl(contextType, contextId, collectionType) {
-  var _typeMap$collectionTy;
-
-  const typeMap = {
-    wikiPages: 'pages',
-    discussions: 'discussion_topics'
-  };
-  return `/${contextType}s/${contextId}/${(_typeMap$collectionTy = typeMap[collectionType]) !== null && _typeMap$collectionTy !== void 0 ? _typeMap$collectionTy : collectionType}`;
-}
-export function getMessage(collectionType, isSearchResult) {
-  switch (collectionType) {
-    case 'wikiPages':
-      return isSearchResult ? formatMessage('No pages found.') : formatMessage('No pages created yet.');
-
-    case 'assignments':
-      return isSearchResult ? formatMessage('No assignments found.') : formatMessage('No assignments created yet.');
-
-    case 'quizzes':
-      return isSearchResult ? formatMessage('No quizzes found.') : formatMessage('No quizzes created yet.');
-
-    case 'announcements':
-      return isSearchResult ? formatMessage('No announcements found.') : formatMessage('No announcements created yet.');
-
-    case 'discussions':
-      return isSearchResult ? formatMessage('No discussions found.') : formatMessage('No discussions created yet.');
-
-    case 'modules':
-      return isSearchResult ? formatMessage('No modules found.') : formatMessage('No modules created yet.');
-  }
-}
-export const NoResults = _ref => {
-  let {
-    contextType,
-    contextId,
-    collectionType,
-    isSearchResult
-  } = _ref;
-  const Icon = getIcon(collectionType);
-  return /*#__PURE__*/React.createElement(View, {
-    padding: "xx-large"
-  }, /*#__PURE__*/React.createElement(Flex, {
-    justifyItems: "center",
-    alignItems: "center",
-    direction: "column"
-  }, /*#__PURE__*/React.createElement(Flex.Item, null, /*#__PURE__*/React.createElement(Icon, {
-    size: "large",
-    color: "secondary",
-    padding: "large"
-  })), /*#__PURE__*/React.createElement(Flex.Item, {
-    margin: "small 0 0"
-  }, /*#__PURE__*/React.createElement(Text, null, getMessage(collectionType, isSearchResult))), !isSearchResult && /*#__PURE__*/React.createElement(Flex.Item, null, /*#__PURE__*/React.createElement(Link, {
-    href: buildUrl(contextType, contextId, collectionType),
-    target: "_blank"
-  }, formatMessage('Add one!')))));
-};
-NoResults.propTypes = {
-  contextType: _pt.oneOf(['course', 'group']).isRequired,
-  contextId: _pt.string.isRequired,
-  collectionType: _pt.oneOf(['wikiPages', 'assignments', 'quizzes', 'announcements', 'discussions', 'modules']).isRequired,
-  isSearchResult: _pt.bool.isRequired
-};

package/lib/rce/plugins/instructure_links/components/propTypes.js

@@ -1,41 +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 { arrayOf, bool, object, oneOf, shape, string } from 'prop-types';
-export const linkShape = shape({
-  href: string.isRequired,
-  title: string.isRequired,
-  published: bool,
-  date: string,
-  date_type: string,
-  has_overrides: bool
-});
-export const linksShape = shape({
-  hasMore: bool,
-  isLoading: bool,
-  lastError: object,
-  links: arrayOf(linkShape).isRequired
-});
-export const linkType = oneOf(['assignments', 'discussions', 'modules', 'quizzes', 'announcements', 'wikiPages', 'navigation']);
-export const collectionsShape = shape({
-  announcements: linksShape,
-  assignments: linksShape,
-  discussions: linksShape,
-  modules: linksShape,
-  quizzes: linksShape,
-  wikiPages: linksShape
-});