@open-amt-cloud-toolkit/ui-toolkit-react 2.0.2 → 2.0.3

package/README.md

@@ -0,0 +1,71 @@
+# UI Toolkit React
+
+[![Known Vulnerabilities](https://snyk.io/test/github/open-amt-cloud-toolkit/ui-toolkit/badge.svg?targetFile=package.json)](https://snyk.io/test/github/open-amt-cloud-toolkit/ui-toolkit?targetFile=package.json) ![Node.js CI](https://github.com/open-amt-cloud-toolkit/sample-web-ui/workflows/Node.js%20CI/badge.svg) 
+![codecov.io](https://codecov.io/github/open-amt-cloud-toolkit/ui-toolkit-react/coverage.svg?branch=main)
+
+> Disclaimer: Production viable releases are tagged and listed under 'Releases'.  All other check-ins should be considered 'in-development' and should not be used in production
+
+The UI Toolkit provides prebuilt, React-based components for integrating remote management features such as a keyboard, video, mouse (KVM) control into a web-based management console UI. The controls have a reference UI and layout that can be customized further to seamlessly integrate with existing management console solutions.
+
+<br><br>
+
+**For detailed documentation** about [Getting Started with the UI Toolkit](https://open-amt-cloud-toolkit.github.io/docs/2.0/Tutorials/uitoolkit) or other features of the Open AMT Cloud Toolkit, see the [docs](https://open-amt-cloud-toolkit.github.io/docs/).
+
+<br>
+
+## Prerequisites
+
+To succesfully deploy the UI Toolkit using React, the following software must be installed on your development system:
+
+- [Node.js* LTS 12.x.x or newer](https://nodejs.org/en/)
+- [git](https://git-scm.com/downloads)
+- [Visual Studio Code](https://code.visualstudio.com/) or any other IDE of choice
+
+
+## Create a New React App
+
+The React app can be created in any preferred development directory. The MPS can continue to run while creating and running the app.
+
+1. In a Command Prompt or Terminal, go to your preferred development directory. 
+
+2. Run the following commands to create sample React app named `my-app`.
+
+    ``` bash
+    npx create-react-app my-app && cd my-app
+    ```
+
+## Add UI Toolkit
+
+1. Run the following command to add the UI Toolkit and install the required dependencies:
+
+    ``` bash
+    npm install @open-amt-cloud-toolkit/ui-toolkit-react
+    ```
+
+2. Run the following commands to start the web UI locally:
+
+    ``` bash
+    npm start
+    ```
+
+3. By default, React apps run on port `3000`. If port `3000` is already used by the MPS server or any other application, you'll be prompted to use another port. If this happens, enter 'Y'.
+
+    Sample Output:
+
+    ```
+    You can now view my-app in the browser.
+    Local: http://localhost:3000
+    On Your Network: http://172.16.17.4:3000
+    ```
+
+
+Learn how to add the KVM control to your new React app [here](https://open-amt-cloud-toolkit.github.io/docs/2.0/Tutorials/uitoolkit/#add-a-sample-control)
+
+
+For detailed documentation about the UI Toolkit, see the [docs](https://open-amt-cloud-toolkit.github.io/docs/)
+
+
+## License Note
+
+If you are distributing the FortAwesome Icons, please provide attribution to the source per the [CC-by 4.0](https://creativecommons.org/licenses/by/4.0/deed.ast) license obligations.
+

package/dist

@@ -0,0 +1,83 @@
+{
+  "name": "@open-amt-cloud-toolkit/ui-toolkit-react",
+  "version": "2.0.3",
+  "description": "React UI controls for Intel AMT features",
+  "main": "index.js",
+  "scripts": {
+    "prepublishOnly": "cp package.json dist",
+    "start": "webpack serve --config webpack.config.dev.js",
+    "build": "webpack --config webpack.config.prod.js",
+    "build-ext": "npm run build-types && webpack --config webpack.config.externals.js",
+    "lint": "eslint . --ext .ts",
+    "test": "jest --detectOpenHandles --logHeapUsage --ci --no-cache --runInBand --updateSnapshot",
+    "coverage": "jest --coverage  --detectOpenHandles --logHeapUsage --ci --no-cache --runInBand ",
+    "test-kvm": "tsc && node ./dist/test/kvmui.test.ws.js",
+    "build-types": "tsc --emitDeclarationOnly -p tsconfig.build.json"
+  },
+  "author": "",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/open-amt-cloud-toolkit/ui-toolkit-react/issues"
+  },
+  "homepage": "https://github.com/open-amt-cloud-toolkit/ui-toolkit-react#readme",
+  "types": "index.d.ts",
+  "peerDependencies": {
+    "react": "^17.0.2",
+    "react-dom": "^17.0.2"
+  },
+  "dependencies": {
+    "@fortawesome/fontawesome-svg-core": "^1.2.35",
+    "@fortawesome/free-solid-svg-icons": "^5.15.3",
+    "@fortawesome/react-fontawesome": "^0.1.13",
+    "@open-amt-cloud-toolkit/ui-toolkit": "^2.0.5",
+    "i18next": "^21.2.0",
+    "i18next-browser-languagedetector": "^6.1.2",
+    "md5": "^2.2.1",
+    "moment": "^2.24.0",
+    "react-i18next": "^11.11.4",
+    "sass": "^1.36.0",
+    "styled-components": "^5.3.0",
+    "winston": "^3.0.0",
+    "ws": "^8.2.1",
+    "xterm": "^4.13.0"
+  },
+  "devDependencies": {
+    "@types/enzyme": "^3.10.8",
+    "@types/enzyme-adapter-react-16": "^1.0.5",
+    "@types/jest": "^27.0.1",
+    "@types/md5": "^2.1.33",
+    "@types/node": "^14.17.3",
+    "@types/react": "^17.0.16",
+    "@types/react-dom": "^17.0.8",
+    "@types/ws": "^8.2.0",
+    "@typescript-eslint/eslint-plugin": "^4.29.1",
+    "@typescript-eslint/parser": "^4.29.1",
+    "canvas": "^2.8.0",
+    "css-loader": "^6.2.0",
+    "enzyme": "^3.10.0",
+    "enzyme-adapter-react-16": "^1.14.0",
+    "eslint": "^7.29.0",
+    "eslint-config-standard": "^16.0.3",
+    "eslint-config-standard-with-typescript": "^21.0.1",
+    "eslint-plugin-import": "^2.23.4",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-promise": "^6.0.0",
+    "filereader": "^0.10.3",
+    "html-webpack-plugin": "^5.3.1",
+    "identity-obj-proxy": "^3.0.0",
+    "jest": "^27.0.4",
+    "jest-transform-stub": "^2.0.0",
+    "react": "^17.0.2",
+    "react-dom": "^17.0.2",
+    "sass-loader": "^12.1.0",
+    "source-map-loader": "^3.0.0",
+    "style-loader": "^3.0.0",
+    "ts-jest": "^27.0.4",
+    "ts-loader": "^9.2.3",
+    "typescript": "^4.3.4",
+    "webpack": "^5.40.0",
+    "webpack-cli": "^4.7.2",
+    "webpack-dev-server": "^4.1.1",
+    "webpack-node-externals": "^3.0.0"
+  }
+}

package/package.json

@@ -1,77 +1,83 @@
-{
-  "name": "@open-amt-cloud-toolkit/ui-toolkit-react",
-  "version": "2.0.2",
-  "description": "React UI controls for Intel AMT features",
-  "scripts": {
-    "start": "webpack serve --config webpack.config.dev.js",
-    "build": "webpack --config webpack.config.prod.js",
-    "build-ext": "npm run build-types && webpack --config webpack.config.externals.js",
-    "lint": "eslint . --ext .ts",
-    "test": "jest --detectOpenHandles --logHeapUsage --ci --no-cache --runInBand --updateSnapshot",
-    "coverage": "jest --coverage  --detectOpenHandles --logHeapUsage --ci --no-cache --runInBand ",
-    "test-kvm": "tsc && node ./dist/test/kvmui.test.ws.js",
-    "build-types": "tsc --emitDeclarationOnly -p tsconfig.build.json"
-  },
-  "author": "",
-  "license": "Apache-2.0",
-  "types": "index.d.ts",
-  "peerDependencies": {
-    "react": "^17.0.2",
-    "react-dom": "^17.0.2"
-  },
-  "dependencies": {
-    "@fortawesome/fontawesome-svg-core": "^1.2.35",
-    "@fortawesome/free-solid-svg-icons": "^5.15.3",
-    "@fortawesome/react-fontawesome": "^0.1.13",
-    "@open-amt-cloud-toolkit/ui-toolkit": "^2.0.3",
-    "i18next": "^21.2.0",
-    "i18next-browser-languagedetector": "^6.1.2",
-    "md5": "^2.2.1",
-    "moment": "^2.24.0",
-    "react-i18next": "^11.11.4",
-    "sass": "^1.36.0",
-    "styled-components": "^5.3.0",
-    "winston": "^3.0.0",
-    "ws": "^8.2.1",
-    "xterm": "^4.13.0"
-  },
-  "devDependencies": {
-    "@types/enzyme": "^3.10.8",
-    "@types/enzyme-adapter-react-16": "^1.0.5",
-    "@types/jest": "^27.0.1",
-    "@types/md5": "^2.1.33",
-    "@types/node": "^14.17.3",
-    "@types/react": "^17.0.16",
-    "@types/react-dom": "^17.0.8",
-    "@types/ws": "^8.2.0",
-    "@typescript-eslint/eslint-plugin": "^4.29.1",
-    "@typescript-eslint/parser": "^4.29.1",
-    "canvas": "^2.8.0",
-    "css-loader": "^6.2.0",
-    "enzyme": "^3.10.0",
-    "enzyme-adapter-react-16": "^1.14.0",
-    "eslint": "^7.29.0",
-    "eslint-config-standard": "^16.0.3",
-    "eslint-config-standard-with-typescript": "^21.0.1",
-    "eslint-plugin-import": "^2.23.4",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^5.1.0",
-    "filereader": "^0.10.3",
-    "html-webpack-plugin": "^5.3.1",
-    "identity-obj-proxy": "^3.0.0",
-    "jest": "^27.0.4",
-    "jest-transform-stub": "^2.0.0",
-    "react": "^17.0.2",
-    "react-dom": "^17.0.2",
-    "sass-loader": "^12.1.0",
-    "source-map-loader": "^3.0.0",
-    "style-loader": "^3.0.0",
-    "ts-jest": "^27.0.4",
-    "ts-loader": "^9.2.3",
-    "typescript": "^4.3.4",
-    "webpack": "^5.40.0",
-    "webpack-cli": "^4.7.2",
-    "webpack-dev-server": "^4.1.1",
-    "webpack-node-externals": "^3.0.0"
-  }
-}
+{
+  "name": "@open-amt-cloud-toolkit/ui-toolkit-react",
+  "version": "2.0.3",
+  "description": "React UI controls for Intel AMT features",
+  "main": "index.js",
+  "scripts": {
+    "prepublishOnly": "cp package.json dist",
+    "start": "webpack serve --config webpack.config.dev.js",
+    "build": "webpack --config webpack.config.prod.js",
+    "build-ext": "npm run build-types && webpack --config webpack.config.externals.js",
+    "lint": "eslint . --ext .ts",
+    "test": "jest --detectOpenHandles --logHeapUsage --ci --no-cache --runInBand --updateSnapshot",
+    "coverage": "jest --coverage  --detectOpenHandles --logHeapUsage --ci --no-cache --runInBand ",
+    "test-kvm": "tsc && node ./dist/test/kvmui.test.ws.js",
+    "build-types": "tsc --emitDeclarationOnly -p tsconfig.build.json"
+  },
+  "author": "",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/open-amt-cloud-toolkit/ui-toolkit-react/issues"
+  },
+  "homepage": "https://github.com/open-amt-cloud-toolkit/ui-toolkit-react#readme",
+  "types": "index.d.ts",
+  "peerDependencies": {
+    "react": "^17.0.2",
+    "react-dom": "^17.0.2"
+  },
+  "dependencies": {
+    "@fortawesome/fontawesome-svg-core": "^1.2.35",
+    "@fortawesome/free-solid-svg-icons": "^5.15.3",
+    "@fortawesome/react-fontawesome": "^0.1.13",
+    "@open-amt-cloud-toolkit/ui-toolkit": "^2.0.5",
+    "i18next": "^21.2.0",
+    "i18next-browser-languagedetector": "^6.1.2",
+    "md5": "^2.2.1",
+    "moment": "^2.24.0",
+    "react-i18next": "^11.11.4",
+    "sass": "^1.36.0",
+    "styled-components": "^5.3.0",
+    "winston": "^3.0.0",
+    "ws": "^8.2.1",
+    "xterm": "^4.13.0"
+  },
+  "devDependencies": {
+    "@types/enzyme": "^3.10.8",
+    "@types/enzyme-adapter-react-16": "^1.0.5",
+    "@types/jest": "^27.0.1",
+    "@types/md5": "^2.1.33",
+    "@types/node": "^14.17.3",
+    "@types/react": "^17.0.16",
+    "@types/react-dom": "^17.0.8",
+    "@types/ws": "^8.2.0",
+    "@typescript-eslint/eslint-plugin": "^4.29.1",
+    "@typescript-eslint/parser": "^4.29.1",
+    "canvas": "^2.8.0",
+    "css-loader": "^6.2.0",
+    "enzyme": "^3.10.0",
+    "enzyme-adapter-react-16": "^1.14.0",
+    "eslint": "^7.29.0",
+    "eslint-config-standard": "^16.0.3",
+    "eslint-config-standard-with-typescript": "^21.0.1",
+    "eslint-plugin-import": "^2.23.4",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-promise": "^6.0.0",
+    "filereader": "^0.10.3",
+    "html-webpack-plugin": "^5.3.1",
+    "identity-obj-proxy": "^3.0.0",
+    "jest": "^27.0.4",
+    "jest-transform-stub": "^2.0.0",
+    "react": "^17.0.2",
+    "react-dom": "^17.0.2",
+    "sass-loader": "^12.1.0",
+    "source-map-loader": "^3.0.0",
+    "style-loader": "^3.0.0",
+    "ts-jest": "^27.0.4",
+    "ts-loader": "^9.2.3",
+    "typescript": "^4.3.4",
+    "webpack": "^5.40.0",
+    "webpack-cli": "^4.7.2",
+    "webpack-dev-server": "^4.1.1",
+    "webpack-node-externals": "^3.0.0"
+  }
+}

package/i18n.d.ts

@@ -1,6 +0,0 @@
-/*********************************************************************
-* Copyright (c) Intel Corporation 2019
-* SPDX-License-Identifier: Apache-2.0
-**********************************************************************/
-import i18n from 'i18next';
-export default i18n;

package/jest.setup.d.ts

@@ -1,5 +0,0 @@
-/*********************************************************************
-* Copyright (c) Intel Corporation 2020
-* SPDX-License-Identifier: Apache-2.0
-**********************************************************************/
-export {};