@elice/material-exercise 1.260305.0 → 1.260430.0

package/es/components/material-exercise/exercise-runner/arduino/ArduinoErrorDialog.d.ts

@@ -0,0 +1,3 @@
+import type React from 'react';
+declare const ArduinoErrorDialog: React.VFC;
+export default ArduinoErrorDialog;

package/es/components/material-exercise/exercise-runner/arduino/ArduinoErrorDialog.js

@@ -0,0 +1,112 @@
+import { asyncToGenerator as _asyncToGenerator, regenerator as _regenerator } from '../../../../_virtual/_rollupPluginBabelHelpers.js';
+import { jsxs, jsx } from 'react/jsx-runtime';
+import { useRawEliceIntl } from '@elice/intl';
+import { useConnection, useMCUBridgeError, usePermissionState, PermissionAlert, MCUBridgeErrorText } from '@elice/mcu-bridge';
+import Button from '@mui/material/Button';
+import Dialog from '@mui/material/Dialog';
+import DialogActions from '@mui/material/DialogActions';
+import DialogContent from '@mui/material/DialogContent';
+import DialogTitle from '@mui/material/DialogTitle';
+import Stack from '@mui/material/Stack';
+
+//
+//
+//
+var ArduinoErrorDialog = function ArduinoErrorDialog() {
+  var intl = useRawEliceIntl();
+  var _useConnection = useConnection(),
+    connect = _useConnection.connect;
+  var _useMCUBridgeError = useMCUBridgeError(),
+    errorCode = _useMCUBridgeError.errorCode,
+    clearError = _useMCUBridgeError.clearError;
+  var _usePermissionState = usePermissionState(),
+    permissionPhase = _usePermissionState.phase,
+    resetPermission = _usePermissionState.reset;
+  var isErrorDialogOpen = permissionPhase === 'denied' || Boolean(errorCode);
+  /**
+   *
+   */
+  var handleClose = function handleClose() {
+    resetPermission();
+    clearError();
+  };
+  // `PermissionAlert` resets `permissionStore` itself; `errorStore` is
+  // separate and must be cleared here or `errorCode` keeps the dialog open.
+  var handleRetry = /*#__PURE__*/function () {
+    var _ref = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee() {
+      return _regenerator().w(function (_context) {
+        while (1) switch (_context.p = _context.n) {
+          case 0:
+            clearError();
+            _context.p = 1;
+            _context.n = 2;
+            return connect();
+          case 2:
+            _context.n = 4;
+            break;
+          case 3:
+            _context.p = 3;
+            _context.v;
+          case 4:
+            return _context.a(2);
+        }
+      }, _callee, null, [[1, 3]]);
+    }));
+    return function handleRetry() {
+      return _ref.apply(this, arguments);
+    };
+  }();
+  /**
+   *
+   */
+  var renderErrorDialogTitle = function renderErrorDialogTitle() {
+    return jsx(DialogTitle, {
+      children: intl.formatMessage({
+        id: 'exerciseRunner.arduino.error.title'
+      })
+    });
+  };
+  /**
+   *
+   */
+  var renderErrorDialogContent = function renderErrorDialogContent() {
+    return jsx(DialogContent, {
+      children: jsxs(Stack, {
+        spacing: 1.5,
+        children: [permissionPhase === 'denied' ? jsx(PermissionAlert, {
+          onRetry: handleRetry
+        }) : null, errorCode ? jsx(MCUBridgeErrorText, {
+          code: errorCode,
+          variant: "body2",
+          color: "error"
+        }) : null]
+      })
+    });
+  };
+  /**
+   *
+   */
+  var renderErrorDialogActions = function renderErrorDialogActions() {
+    return jsx(DialogActions, {
+      children: jsx(Button, {
+        color: "inherit",
+        onClick: handleClose,
+        children: intl.formatMessage({
+          id: 'exerciseRunner.arduino.error.close'
+        })
+      })
+    });
+  };
+  //
+  //
+  //
+  return jsxs(Dialog, {
+    fullWidth: true,
+    open: isErrorDialogOpen,
+    maxWidth: "sm",
+    onClose: handleClose,
+    children: [renderErrorDialogTitle(), renderErrorDialogContent(), renderErrorDialogActions()]
+  });
+};
+
+export { ArduinoErrorDialog as default };

package/es/components/material-exercise/exercise-runner/arduino/ArduinoHelpDialog.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+declare const ArduinoHelpDialog: React.VFC;
+export default ArduinoHelpDialog;

package/es/components/material-exercise/exercise-runner/arduino/ArduinoHelpDialog.js

@@ -0,0 +1,161 @@
+import { slicedToArray as _slicedToArray } from '../../../../_virtual/_rollupPluginBabelHelpers.js';
+import { jsxs, jsx } from 'react/jsx-runtime';
+import React from 'react';
+import { useRawEliceIntl } from '@elice/intl';
+import { EliceIcon } from '@elice/mui-elements';
+import { faBookAlt, faArrowRight } from '@fortawesome/pro-regular-svg-icons';
+import { Card, CardActionArea } from '@mui/material';
+import Box from '@mui/material/Box';
+import Button from '@mui/material/Button';
+import Checkbox from '@mui/material/Checkbox';
+import Dialog from '@mui/material/Dialog';
+import DialogActions from '@mui/material/DialogActions';
+import DialogContent from '@mui/material/DialogContent';
+import DialogTitle from '@mui/material/DialogTitle';
+import FormControlLabel from '@mui/material/FormControlLabel';
+import Stack from '@mui/material/Stack';
+import Typography from '@mui/material/Typography';
+import { useArduinoBridge } from './_context.js';
+import ArduinoHelpDialogChecklist from './ArduinoHelpDialogChecklist.js';
+
+//
+//
+//
+var STORAGE_KEY = 'elice-material-exercise-arduino-help-modal-closed';
+var STORAGE_VALUE = 'true';
+var ARDUINO_FAQ_URL = 'https://eli.so/arduino-faq';
+//
+//
+//
+var ArduinoHelpDialog = function ArduinoHelpDialog() {
+  var intl = useRawEliceIntl();
+  var _useArduinoBridge = useArduinoBridge(),
+    isHelpDialogOpen = _useArduinoBridge.isHelpDialogOpen,
+    openHelpDialog = _useArduinoBridge.openHelpDialog,
+    closeHelpDialog = _useArduinoBridge.closeHelpDialog;
+  var _React$useState = React.useState(false),
+    _React$useState2 = _slicedToArray(_React$useState, 2),
+    wasAutoOpened = _React$useState2[0],
+    setWasAutoOpened = _React$useState2[1];
+  var _React$useState3 = React.useState(false),
+    _React$useState4 = _slicedToArray(_React$useState3, 2),
+    dontShowAgain = _React$useState4[0],
+    setDontShowAgain = _React$useState4[1];
+  //
+  // Auto-popup once on first visit (localStorage flag survives reloads).
+  //
+  React.useEffect(function () {
+    var isClosed = localStorage.getItem(STORAGE_KEY) === STORAGE_VALUE;
+    if (!isClosed) {
+      openHelpDialog();
+      setWasAutoOpened(true);
+    }
+  },
+  // eslint-disable-next-line react-hooks/exhaustive-deps
+  []);
+  /**
+   *
+   */
+  var handleClose = function handleClose() {
+    if (dontShowAgain) {
+      localStorage.setItem(STORAGE_KEY, STORAGE_VALUE);
+    }
+    closeHelpDialog();
+    setWasAutoOpened(false);
+    setDontShowAgain(false);
+  };
+  /**
+   *
+   */
+  var renderDialogManual = function renderDialogManual() {
+    return jsx(Card, {
+      variant: "outlined",
+      children: jsx(CardActionArea, {
+        component: "a",
+        href: ARDUINO_FAQ_URL,
+        target: "_blank",
+        rel: "noopener noreferrer",
+        sx: {
+          p: 1.5
+        },
+        children: jsxs(Stack, {
+          direction: "row",
+          spacing: 1.5,
+          alignItems: "center",
+          children: [jsx(EliceIcon, {
+            icon: faBookAlt
+          }), jsxs(Box, {
+            sx: {
+              flex: 1,
+              minWidth: 0
+            },
+            children: [jsx(Typography, {
+              variant: "body2",
+              fontWeight: 700,
+              children: intl.formatMessage({
+                id: 'exerciseRunner.arduino.help.manual.title'
+              })
+            }), jsx(Typography, {
+              variant: "caption",
+              color: "text.secondary",
+              children: intl.formatMessage({
+                id: 'exerciseRunner.arduino.help.manual.detail'
+              })
+            })]
+          }), jsx(EliceIcon, {
+            icon: faArrowRight
+          })]
+        })
+      })
+    });
+  };
+  //
+  //
+  //
+  return jsxs(Dialog, {
+    fullWidth: true,
+    open: isHelpDialogOpen,
+    maxWidth: "sm",
+    onClose: handleClose,
+    children: [jsx(DialogTitle, {
+      children: intl.formatMessage({
+        id: 'exerciseRunner.arduino.help.title'
+      })
+    }), jsx(DialogContent, {
+      children: jsxs(Stack, {
+        spacing: 2.5,
+        children: [jsx(Typography, {
+          variant: "body2",
+          color: "text.secondary",
+          children: intl.formatMessage({
+            id: 'exerciseRunner.arduino.help.greeting'
+          })
+        }), jsx(ArduinoHelpDialogChecklist, {}), renderDialogManual()]
+      })
+    }), jsxs(DialogActions, {
+      sx: {
+        justifyContent: 'space-between'
+      },
+      children: [wasAutoOpened ? jsx(FormControlLabel, {
+        control: jsx(Checkbox, {
+          size: "small",
+          checked: dontShowAgain,
+          onChange: function onChange(e) {
+            return setDontShowAgain(e.target.checked);
+          }
+        }),
+        label: intl.formatMessage({
+          id: 'exerciseRunner.arduino.help.dontShowAgain'
+        })
+      }) : jsx(Box, {}), jsx(Button, {
+        color: "inherit",
+        onClick: handleClose,
+        children: intl.formatMessage({
+          id: 'exerciseRunner.arduino.help.close'
+        })
+      })]
+    })]
+  });
+};
+
+export { ArduinoHelpDialog as default };

package/es/components/material-exercise/exercise-runner/arduino/ArduinoHelpDialogButton.d.ts

@@ -0,0 +1,3 @@
+import type React from 'react';
+declare const ArduinoHelpDialogButton: React.VFC;
+export default ArduinoHelpDialogButton;

package/es/components/material-exercise/exercise-runner/arduino/ArduinoHelpDialogButton.js

@@ -0,0 +1,25 @@
+import { jsx } from 'react/jsx-runtime';
+import { eilStatusInfo } from '@elice/icons';
+import { useRawEliceIntl } from '@elice/intl';
+import { useArduinoBridge } from './_context.js';
+import ExerciseMenuButton from '../../../shared/exercise-menu-button/ExerciseMenuButton.js';
+
+//
+//
+//
+var ArduinoHelpDialogButton = function ArduinoHelpDialogButton() {
+  var intl = useRawEliceIntl();
+  var _useArduinoBridge = useArduinoBridge(),
+    isHelpDialogOpen = _useArduinoBridge.isHelpDialogOpen,
+    openHelpDialog = _useArduinoBridge.openHelpDialog;
+  return jsx(ExerciseMenuButton, {
+    icon: eilStatusInfo,
+    title: intl.formatMessage({
+      id: 'exerciseRunner.arduino.help.button'
+    }),
+    active: isHelpDialogOpen,
+    onClick: openHelpDialog
+  });
+};
+
+export { ArduinoHelpDialogButton as default };

package/es/components/material-exercise/exercise-runner/arduino/ArduinoHelpDialogChecklist.d.ts

@@ -0,0 +1,3 @@
+import type React from 'react';
+declare const ArduinoHelpDialogChecklist: React.VFC;
+export default ArduinoHelpDialogChecklist;

package/es/components/material-exercise/exercise-runner/arduino/ArduinoHelpDialogChecklist.js

@@ -0,0 +1,84 @@
+import { jsx, jsxs } from 'react/jsx-runtime';
+import { useRawEliceIntl } from '@elice/intl';
+import Box from '@mui/material/Box';
+import Stack from '@mui/material/Stack';
+import Typography from '@mui/material/Typography';
+
+//
+//
+//
+var CHECKLIST_STEPS = [1, 2, 3, 4];
+//
+//
+//
+var ArduinoHelpDialogChecklist = function ArduinoHelpDialogChecklist() {
+  var intl = useRawEliceIntl();
+  /**
+   *
+   */
+  var renderStepBadge = function renderStepBadge(step) {
+    return jsx(Box, {
+      "aria-hidden": "true",
+      sx: {
+        width: 24,
+        height: 24,
+        borderRadius: '50%',
+        display: 'flex',
+        alignItems: 'center',
+        justifyContent: 'center',
+        fontSize: 13,
+        fontWeight: 700,
+        bgcolor: 'primary.main',
+        color: 'primary.contrastText',
+        flexShrink: 0
+      },
+      children: step
+    });
+  };
+  /**
+   *
+   */
+  var renderItem = function renderItem(step) {
+    var title = intl.formatMessage({
+      id: "exerciseRunner.arduino.help.checklist.".concat(step, ".title")
+    });
+    var body = intl.formatMessage({
+      id: "exerciseRunner.arduino.help.checklist.".concat(step, ".body")
+    });
+    return jsxs(Stack, {
+      direction: "row",
+      spacing: 1.5,
+      alignItems: "flex-start",
+      children: [renderStepBadge(step), jsxs(Box, {
+        sx: {
+          flex: 1,
+          pt: 0.25
+        },
+        children: [jsx(Typography, {
+          variant: "body2",
+          fontWeight: 700,
+          children: title
+        }), jsx(Typography, {
+          variant: "caption",
+          color: "text.secondary",
+          sx: {
+            display: 'block',
+            mt: 0.25
+          },
+          children: body
+        })]
+      })]
+    }, step);
+  };
+  //
+  //
+  //
+  return jsx(Stack, {
+    spacing: 1.5,
+    children: CHECKLIST_STEPS.map(function (step) {
+      return renderItem(step);
+    })
+  });
+};
+
+export { ArduinoHelpDialogChecklist as default };

package/es/components/material-exercise/exercise-runner/arduino/ArduinoProvider.d.ts

@@ -0,0 +1,16 @@
+import React from 'react';
+import type { XtermApis } from "../../../shared/xterm/Xterm";
+export interface ArduinoBridgeApi {
+    handleIncomingHex: (dataUrl: string) => void;
+    sendText: (text: string) => void;
+}
+export interface ArduinoBridgeProviderProps {
+    xtermRef: React.RefObject<XtermApis | null>;
+    apiRef: React.MutableRefObject<ArduinoBridgeApi | null>;
+    children: React.ReactNode;
+}
+export interface ArduinoBridgeProviderGateProps extends ArduinoBridgeProviderProps {
+    enabled: boolean;
+}
+declare const _default: ({ enabled, children, ...rest }: ArduinoBridgeProviderGateProps) => import("react/jsx-runtime").JSX.Element;
+export default _default;

package/es/components/material-exercise/exercise-runner/arduino/ArduinoProvider.js

@@ -0,0 +1,97 @@
+import { slicedToArray as _slicedToArray } from '../../../../_virtual/_rollupPluginBabelHelpers.js';
+import { __rest } from 'tslib';
+import { jsx, Fragment, jsxs } from 'react/jsx-runtime';
+import React, { useEffect } from 'react';
+import { useFlash, usePermissionPhase, setupMCUBridge, ArduinoUnoDriver, ArduinoMegaDriver } from '@elice/mcu-bridge';
+import { ArduinoBridgeContext } from './_context.js';
+import ArduinoConnectionGuideDialog from './ArduinoConnectionGuideDialog.js';
+import ArduinoErrorDialog from './ArduinoErrorDialog.js';
+import ArduinoHelpDialog from './ArduinoHelpDialog.js';
+import ArduinoProviderApiBinder from './ArduinoProviderApiBinder.js';
+import ArduinoProviderFlashWriter from './ArduinoProviderFlashWriter.js';
+import ArduinoProviderSessionWriter from './ArduinoProviderSessionWriter.js';
+import { useArduinoRunIntent } from './useArduinoRunIntent.js';
+
+//
+//
+//
+var ArduinoBridgeProvider = function ArduinoBridgeProvider(_ref) {
+  var xtermRef = _ref.xtermRef,
+    apiRef = _ref.apiRef,
+    children = _ref.children;
+  var _useFlash = useFlash(),
+    isFlashing = _useFlash.isFlashing;
+  var _useArduinoRunIntent = useArduinoRunIntent(),
+    pendingIntent = _useArduinoRunIntent.pendingIntent,
+    pendingIntentRef = _useArduinoRunIntent.pendingIntentRef,
+    setRunIntent = _useArduinoRunIntent.setRunIntent,
+    clearRunIntent = _useArduinoRunIntent.clearRunIntent;
+  var permissionPhase = usePermissionPhase();
+  var _React$useState = React.useState(null),
+    _React$useState2 = _slicedToArray(_React$useState, 2),
+    connectionIntent = _React$useState2[0],
+    setConnectionIntent = _React$useState2[1];
+  var _React$useState3 = React.useState(false),
+    _React$useState4 = _slicedToArray(_React$useState3, 2),
+    isHelpDialogOpen = _React$useState4[0],
+    setHelpDialogOpen = _React$useState4[1];
+  var openHelpDialog = React.useCallback(function () {
+    return setHelpDialogOpen(true);
+  }, []);
+  var closeHelpDialog = React.useCallback(function () {
+    return setHelpDialogOpen(false);
+  }, []);
+  useEffect(function () {
+    setupMCUBridge([ArduinoUnoDriver, ArduinoMegaDriver]);
+  }, []);
+  // Clear the variant tag once the picker resolves so it can't bleed into
+  // an unrelated future connect flow.
+  useEffect(function () {
+    if (permissionPhase === 'granted') {
+      setConnectionIntent(null);
+    }
+  }, [permissionPhase]);
+  //
+  //
+  //
+  return jsxs(ArduinoBridgeContext.Provider, {
+    value: {
+      setPendingIntent: setRunIntent,
+      isPending: pendingIntent !== null,
+      isFlashing: isFlashing,
+      connectionIntent: connectionIntent,
+      setConnectionIntent: setConnectionIntent,
+      isHelpDialogOpen: isHelpDialogOpen,
+      openHelpDialog: openHelpDialog,
+      closeHelpDialog: closeHelpDialog
+    },
+    children: [children, jsx(ArduinoProviderSessionWriter, {
+      xtermRef: xtermRef
+    }), jsx(ArduinoProviderFlashWriter, {
+      xtermRef: xtermRef
+    }), jsx(ArduinoProviderApiBinder, {
+      apiRef: apiRef,
+      xtermRef: xtermRef,
+      pendingIntentRef: pendingIntentRef,
+      clearRunIntent: clearRunIntent
+    }), jsx(ArduinoConnectionGuideDialog, {}), jsx(ArduinoHelpDialog, {}), jsx(ArduinoErrorDialog, {})]
+  });
+};
+//
+//
+//
+var ArduinoBridgeProvider$1 = (function (_a) {
+  var enabled = _a.enabled,
+    children = _a.children,
+    rest = __rest(_a, ["enabled", "children"]);
+  if (!enabled) {
+    return jsx(Fragment, {
+      children: children
+    });
+  }
+  return jsx(ArduinoBridgeProvider, Object.assign({}, rest, {
+    children: children
+  }));
+});
+
+export { ArduinoBridgeProvider$1 as default };

package/es/components/material-exercise/exercise-runner/arduino/ArduinoProviderApiBinder.d.ts

@@ -0,0 +1,12 @@
+import React from 'react';
+import type { XtermApis } from "../../../shared/xterm/Xterm";
+import type { ArduinoBridgeIntent } from './_context';
+import type { ArduinoBridgeApi } from './ArduinoProvider';
+export interface ArduinoProviderApiBinderProps {
+    apiRef: React.MutableRefObject<ArduinoBridgeApi | null>;
+    xtermRef: React.RefObject<XtermApis | null>;
+    pendingIntentRef: React.MutableRefObject<ArduinoBridgeIntent | null>;
+    clearRunIntent: () => void;
+}
+declare const ArduinoProviderApiBinder: React.FC<ArduinoProviderApiBinderProps>;
+export default ArduinoProviderApiBinder;

package/es/components/material-exercise/exercise-runner/arduino/ArduinoProviderApiBinder.js

@@ -0,0 +1,86 @@
+import React from 'react';
+import { useRawEliceIntl } from '@elice/intl';
+import { useSession, useFlash } from '@elice/mcu-bridge';
+import { useArduinoTerminalWriter } from './useArduinoTerminalWriter.js';
+
+//
+//
+//
+function decodeHexDataUrl(dataUrl) {
+  var base64 = dataUrl.includes(',') ? dataUrl.split(',')[1] : dataUrl;
+  var binary = atob(base64);
+  var bytes = new Uint8Array(binary.length);
+  for (var i = 0; i < binary.length; i += 1) {
+    bytes[i] = binary.charCodeAt(i);
+  }
+  return bytes;
+}
+//
+//
+//
+var ArduinoProviderApiBinder = function ArduinoProviderApiBinder(_ref) {
+  var apiRef = _ref.apiRef,
+    xtermRef = _ref.xtermRef,
+    pendingIntentRef = _ref.pendingIntentRef,
+    clearRunIntent = _ref.clearRunIntent;
+  var intl = useRawEliceIntl();
+  var session = useSession();
+  var _useFlash = useFlash(),
+    flash = _useFlash.flash;
+  var _useArduinoTerminalWr = useArduinoTerminalWriter({
+      xtermRef: xtermRef
+    }),
+    writeSystemMessage = _useArduinoTerminalWr.writeSystemMessage;
+  //
+  // Expose imperative API to the parent runner via ref.
+  //
+  React.useEffect(function () {
+    apiRef.current = {
+      handleIncomingHex: function handleIncomingHex(dataUrl) {
+        var intent = pendingIntentRef.current;
+        clearRunIntent();
+        if (intent !== 'upload') {
+          if (intent === 'compile') {
+            writeSystemMessage(intl.formatMessage({
+              id: 'exerciseRunner.arduino.terminal.compile.done'
+            }));
+          }
+          return;
+        }
+        if (!session) {
+          writeSystemMessage(intl.formatMessage({
+            id: 'exerciseRunner.arduino.terminal.board.notConnected'
+          }));
+          return;
+        }
+        writeSystemMessage(intl.formatMessage({
+          id: 'exerciseRunner.arduino.terminal.compile.done'
+        }));
+        var bytes;
+        try {
+          bytes = decodeHexDataUrl(dataUrl);
+        } catch (_a) {
+          writeSystemMessage(intl.formatMessage({
+            id: 'exerciseRunner.arduino.terminal.firmware.readFail'
+          }));
+          return;
+        }
+        void flash(bytes)["catch"](function () {
+          // Error already surfaced through the progress writer.
+        });
+      },
+      sendText: function sendText(text) {
+        if (!session) {
+          return;
+        }
+        void session.writeText(text);
+      }
+    };
+    return function () {
+      apiRef.current = null;
+    };
+  }, [apiRef, session, flash, pendingIntentRef, clearRunIntent, writeSystemMessage, intl]);
+  return null;
+};
+
+export { ArduinoProviderApiBinder as default };

package/es/components/material-exercise/exercise-runner/arduino/ArduinoProviderFlashWriter.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import type { XtermApis } from "../../../shared/xterm/Xterm";
+export interface ArduinoProviderFlashWriterProps {
+    xtermRef: React.RefObject<XtermApis | null>;
+}
+declare const ArduinoProviderFlashWriter: React.FC<ArduinoProviderFlashWriterProps>;
+export default ArduinoProviderFlashWriter;