@instructure/canvas-rce 5.11.1 → 5.12.2

package/es/translations/locales/zh_TW.Big5.js

@@ -0,0 +1,27 @@
+/*
+ * Copyright (C) 2021 - 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 formatMessage from '../../format-message';
+import '../tinymce/zh_CN';
+const locale = {
+  "count_plural_one_item_loaded_other_items_loaded_857023b7": {
+    "message": "{ count, plural,\n  other {}\n}"
+  }
+};
+formatMessage.addLocale({
+  'zh-TW.Big5': locale
+});

package/{lib/translations/locales/th_TH.js → es/translations/locales/zh_TW.js}

@@ -16,12 +16,12 @@
  * with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 import formatMessage from '../../format-message';
-import '../tinymce/th';
+import '../tinymce/zh_CN';
 const locale = {
   "count_plural_one_item_loaded_other_items_loaded_857023b7": {
     "message": "{ count, plural,\n  other {}\n}"
   }
 };
 formatMessage.addLocale({
-  'th-TH': locale
+  'zh-TW': locale
 });

package/jest.config.js

@@ -62,13 +62,6 @@ module.exports = {
         ],
         plugins: [
           ['@babel/plugin-proposal-decorators', {legacy: true}],
-          [
-            '@instructure/babel-plugin-themeable-styles',
-            {
-              postcssrc: require('@instructure/ui-postcss-config')()(),
-              themeablerc: {},
-            },
-          ],
         ],
       },
     ],

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@instructure/canvas-rce",
-  "version": "5.11.1",
+  "version": "5.12.2",
   "description": "A component wrapping Canvas's usage of Tinymce",
   "main": "es/index.js",
+  "owner": "LF",
   "scripts": {
     "i18n:extract": "format-message extract \"src/**/*.[jt]s*\" -g underscored_crc32 -o locales/en.json",
     "integration-test": "nightwatch --env integration",
@@ -45,6 +46,7 @@
     "fmt:fix": "prettier --write '**/*.js*' '**/*.ts*'",
     "clean": "rm -rf lib && yarn clean:es && rm -rf coverage && yarn demo:clean",
     "clean:es": "rm -rf es",
+    "check:ts": "tsc -p tsconfig.json",
     "generate-svgs": "yarn build:es && node --experimental-modules scripts/generateSvgs.js && prettier --write src/rce/plugins/instructure_equation/MathIcon/svgs.js",
     "publishToNpm": "scripts/publish_to_npm.sh"
   },
@@ -116,9 +118,9 @@
     "@instructure/ui-svg-images": "^8",
     "@instructure/ui-table": "^8",
     "@instructure/ui-tabs": "^8",
-    "@instructure/ui-text": "^8",
     "@instructure/ui-text-area": "^8",
     "@instructure/ui-text-input": "^8",
+    "@instructure/ui-text": "^8",
     "@instructure/ui-themes": "^8",
     "@instructure/ui-toggle-details": "^8",
     "@instructure/ui-tooltip": "^8",
@@ -140,13 +142,12 @@
     "format-message-generate-id": "^6",
     "i18n-js": "^3",
     "isomorphic-fetch": "2.2.1",
-    "jquery": "https://github.com/instructure/jquery.git#1.7.2-with-AMD-and-CommonJS",
     "js-beautify": "1",
     "keycode": "^2",
     "lodash": "^4",
     "mathlive": "^0.77.0",
     "minimatch": "~3.0.4",
-    "moment-timezone": "^0.5.13",
+    "moment-timezone": "^0.5.43",
     "prop-types": "^15",
     "react": "^0.14.8 || ^15.0.0 || ^16",
     "react-aria-live": "^2",
@@ -157,8 +158,7 @@
     "react-transition-group": "^1",
     "redux": "^4",
     "redux-batch-middleware": "^0.2.0",
-    "redux-thunk": "^2",
-    "scroll-into-view": "https://github.com/bkirkby/scroll-into-view.git#588b0ced98eeecf84e6fb2074aa076e80b7cffab",
+    "redux-thunk": "^3.1.0",
     "text-field-edit": "^3.2.0",
     "tinymce": "^5",
     "uri-js": "^4.2.2",
@@ -171,24 +171,22 @@
     "@babel/plugin-syntax-nullish-coalescing-operator": "^7.8.3",
     "@babel/preset-typescript": "^7",
     "@babel/register": "7",
-    "@instructure/babel-plugin-themeable-styles": "7.19.0-canvas",
     "@instructure/browserslist-config-canvas-lms": ">=2",
     "@instructure/translations": ">=1",
-    "@instructure/ui-postcss-config": "^7.5.1",
     "@testing-library/dom": "^8",
     "@testing-library/jest-dom": "^5",
     "@testing-library/react": "^12",
     "@testing-library/react-hooks": "^5",
     "@testing-library/user-event": "^12",
     "axe-testcafe": "^3",
-    "babel-loader": "^8.2.5",
+    "babel-loader": "^9.1.3",
     "babel-plugin-dynamic-import-node": "^2.2.0",
     "babel-plugin-inline-json-import": "^0.2.0",
     "babel-plugin-minify-constant-folding": "^0.5.0",
     "babel-plugin-minify-dead-code-elimination": "^0.5.0",
     "babel-plugin-minify-guarded-expressions": "^0.4.3",
     "babel-plugin-transform-inline-environment-variables": "^0.4.3",
-    "babel-plugin-typescript-to-proptypes": "^1.4.2",
+    "babel-plugin-typescript-to-proptypes": "^2.1.0",
     "cross-env": "^5.0.0",
     "escape-html": "^1",
     "eslint-plugin-mocha": "^6",
@@ -216,7 +214,7 @@
     "testcafe-browser-provider-selenium": "^1.2.0",
     "testcafe-react-selectors": "^3.3.0",
     "ts-node": "^10.9.1",
-    "typescript": "^5.2.2",
+    "typescript": "^5.3.2",
     "url-loader": "^4.1.1",
     "webpack": "^5",
     "webpack-merge": "^5",

package/scripts/build.js

@@ -21,7 +21,6 @@
 // Generates all the pre-translated code in lib/translated/{locale}.
 
 const shell = require('shelljs')
-const promisify = require('util').promisify
 
 shell.set('-e')
 
@@ -37,10 +36,5 @@ shell.exec('rm -rf lib/*')
 shell.exec('rm -rf es/*')
 shell.exec('scripts/installTranslations.js')
 
-shell.echo('Building CommonJS version')
-shell.exec(
-  "JEST_WORKER_ID=1 npx babel --out-dir lib src --ignore '**/__tests__' --extensions '.ts,.tsx,.js,.jsx'"
-)
-
-shell.echo('Building ES Modules version')
+shell.echo('Building')
 shell.exec("npx babel --out-dir es src --ignore '**/__tests__' --extensions '.ts,.tsx,.js,.jsx'")

package/scripts/publish_to_npm.sh

@@ -16,6 +16,7 @@
 #   SKIP_NPM_LOGIN=1
 #   SKIP_NPM_PUBLISH=1
 #   SKIP_ALERT=1
+#   SKIP_NPM_INSTALL=1
 
 function prompt {
     read -p "$1 (Y/N): " confirm &&
@@ -49,6 +50,31 @@ else
     echo "Would have logged into NPM"
 fi
 
+if [ -z "$SKIP_NPM_INSTALL" ]; then
+    # checks that the package is able to be installed outside
+    # of the canvas-lms directory
+    echo -e "\nVerifying NPM install...\n"
+
+    script_dir=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
+    current_dir=$(pwd)
+    temp=$(mktemp -d)
+    cd "$temp"
+    yarn add file:$script_dir/..
+
+    if [[ ! $? -eq 0 ]]; then
+        echo "npm install failed"
+        cd "$current_dir"
+        rm -rf "$temp"
+        exit 1
+    fi
+
+    echo "npm install successful"
+    cd "$current_dir"
+    rm -rf "$temp"
+else
+    echo "Would have verified NPM install"
+fi
+
 if [ -z "$SKIP_NPM_PUBLISH" ]; then
     echo -e "\nPublishing to NPM...\n"
     npm publish

package/canvas/README.md

@@ -1,84 +0,0 @@
-# Canvas Rich Content Editor
-
-The Canvas LMS Rich Content Editor extracted in it's own npm package for use
-across multiple services. In the canvas ecosystem, this npm module is used
-in pair with a running `canvas-rce-api` microservice.
-
-Some features require a running instance of the `canvas-rce-api`,
-but you do not need that instance in order to
-do development on `canvas-rce`. (see [docs/development.md](docs/development.md))
-
-The first customer of the `canvas-rce` is the `canvas-lms` LMS so documentation
-and references throughout documentation might reflect and assume the use of
-`canvas-lms`.
-
-## Install and setup
-
-As a published npm module, you can add canvas-rce to your node project by doing
-the following:
-
-```bash
-npm install canvas-rce --save
-```
-
-For guidance on how `canvas-rce` is used within canvas, please reference
-the [canvas-lms use of canvas-rce](https://github.com/instructure/canvas-lms/tree/stable/ui/shared/rce)
-to get an idea on how to incorporate it into your project. Pay
-special attention to the `RichContentEditor.js` and `serviceRCELoader.js`.
-
-Outside of canvas, the `CanvasRce` React component is your entry point.
-_Work is ongoing to make the props to `CanvasRce` more rational.
-Please be patient._
-
-## Tests
-
-While canvas consumes the es modules build of the rce,
-Jest tests are run against the commonjs build, so make sure you've built the
-commonjs assets before running tests:
-
-```bash
-yarn build:canvas
-yarn test:jest
-```
-
-There are still legacy mocha tests run with `yarn test:mocha`. `yarn test` runs them all.
-
-### test debugging hints
-
-```
-yarn test:jest:debug path/to/__test__/file.test.js
-```
-
-will break and wait for you to attach a debugger (e.g. `chrome://inspect/#devices`).
-
-Similarly, for mocha tests
-
-```
-yarn test:mocha:debug path/to/test/file.test.js
-```
-
-Both those commands may include a `--watch` argument to keep the process alive
-while you iterate.
-
-## Polyfills
-
-This project makes use of modern JavaScript APIs like Promise, Object.assign,
-Array.prototype.includes, etc. which are present in modern
-browsers but may not be present in old browsers like IE 11. In order to not
-send unnecessarily large and duplicated code bundles to the browser, consumers
-are expected to have already globally polyfilled those APIs.
-Canvas only supports modern browsers and the rce has not been tested
-in older browsers like IE. If you need suggestions for how to include
-polyfills in your
-own app, you can just put this in your html above the script that includes
-canvas-rce:
-
-```
-<script src="https://cdn.polyfill.io/v2/polyfill.min.js?rum=0"></script>
-```
-
-(See: https://polyfill.io/v2/docs/ for more info)
-
-## Development
-
-See [DEVELOPMENT.md](./DEVELOPMENT.md)