@codecademy/codebytes 0.5.2-alpha.b9fc3a.0 → 0.6.2-alpha.0500c8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (56) hide show
  1. package/CHANGELOG.md +18 -1
  2. package/dist/MonacoEditor/colorsDark.d.ts +32 -0
  3. package/{src/MonacoEditor/colorsDark.ts → dist/MonacoEditor/colorsDark.js} +8 -16
  4. package/dist/MonacoEditor/index.d.ts +7 -0
  5. package/dist/MonacoEditor/index.js +42 -0
  6. package/dist/MonacoEditor/theme.d.ts +2 -0
  7. package/dist/MonacoEditor/theme.js +122 -0
  8. package/dist/MonacoEditor/types.d.ts +1 -0
  9. package/dist/MonacoEditor/types.js +0 -0
  10. package/dist/__tests__/codebyte-test.d.ts +1 -0
  11. package/dist/__tests__/codebyte-test.js +195 -0
  12. package/dist/__tests__/editor-test.d.ts +1 -0
  13. package/dist/__tests__/editor-test.js +147 -0
  14. package/dist/__tests__/helpers-test.d.ts +1 -0
  15. package/dist/__tests__/helpers-test.js +117 -0
  16. package/dist/__tests__/language-selection-test.d.ts +1 -0
  17. package/dist/__tests__/language-selection-test.js +15 -0
  18. package/dist/__tests__/mocks.d.ts +0 -0
  19. package/dist/__tests__/mocks.js +13 -0
  20. package/dist/api.d.ts +12 -0
  21. package/dist/api.js +39 -0
  22. package/dist/codeByteEditor.d.ts +13 -0
  23. package/dist/codeByteEditor.js +133 -0
  24. package/dist/consts.d.ts +23 -0
  25. package/dist/consts.js +34 -0
  26. package/dist/drawers.d.ts +6 -0
  27. package/dist/drawers.js +148 -0
  28. package/dist/editor.d.ts +13 -0
  29. package/dist/editor.js +189 -0
  30. package/dist/helpers/index.d.ts +15 -0
  31. package/dist/helpers/index.js +29 -0
  32. package/dist/index.d.ts +2 -0
  33. package/dist/index.js +2 -0
  34. package/dist/languageSelection.d.ts +6 -0
  35. package/dist/languageSelection.js +22 -0
  36. package/dist/libs/eventTracking.d.ts +1 -0
  37. package/dist/libs/eventTracking.js +13 -0
  38. package/{src → dist}/theme.d.ts +0 -0
  39. package/dist/types.d.ts +14 -0
  40. package/dist/types.js +0 -0
  41. package/package.json +17 -5
  42. package/.turbo/turbo-build.log +0 -6
  43. package/babel.config.js +0 -15
  44. package/src/MonacoEditor/index.tsx +0 -56
  45. package/src/MonacoEditor/theme.ts +0 -64
  46. package/src/MonacoEditor/types.ts +0 -1
  47. package/src/api.ts +0 -28
  48. package/src/consts.ts +0 -64
  49. package/src/drawers.tsx +0 -132
  50. package/src/editor.tsx +0 -154
  51. package/src/helpers/index.ts +0 -41
  52. package/src/index.tsx +0 -109
  53. package/src/languageSelection.tsx +0 -26
  54. package/src/libs/eventTracking.ts +0 -18
  55. package/src/types.ts +0 -15
  56. package/tsconfig.json +0 -8
package/src/drawers.tsx DELETED
@@ -1,132 +0,0 @@
1
- import { FlexBox, IconButton } from '@codecademy/gamut';
2
- import {
3
- ArrowChevronLeftIcon,
4
- ArrowChevronRightIcon,
5
- } from '@codecademy/gamut-icons';
6
- import styled from '@emotion/styled';
7
- import React, { useState } from 'react';
8
-
9
- const DrawerLabel = styled.span`
10
- padding: 0.875rem 0.5rem;
11
- `;
12
-
13
- const LeftDrawerIcon = styled(ArrowChevronLeftIcon)<{ open?: boolean }>`
14
- transition: transform 0.2s ease-in-out;
15
- `;
16
- const RightDrawerIcon = LeftDrawerIcon.withComponent(ArrowChevronRightIcon);
17
-
18
- const Drawer = styled(FlexBox)<{ open?: boolean; hideOnClose?: boolean }>`
19
- position: relative;
20
- ${({ open, hideOnClose }) => `
21
- flex-basis: ${open ? '100%' : '0%'};
22
- visibility: ${!open && hideOnClose ? 'hidden' : 'visible'};
23
- transition: flex-basis 0.2s ${
24
- open ? 'ease-out' : 'ease-in, visibility 0s 0.2s'
25
- };
26
-
27
- ${LeftDrawerIcon}, ${RightDrawerIcon} {
28
- transform: rotateZ(${open ? '0' : '180'}deg)};
29
- }
30
- `}
31
- `;
32
-
33
- export type DrawersProps = {
34
- leftChild: React.ReactNode;
35
- rightChild: React.ReactNode;
36
- };
37
-
38
- export const Drawers: React.FC<DrawersProps> = ({ leftChild, rightChild }) => {
39
- const [open, setOpen] = useState<'left' | 'right' | 'both'>('both');
40
-
41
- let ariaLabelCodeButton = 'hide code';
42
- let ariaLabelOutputButton = 'hide output';
43
- let isLeftOpen = false;
44
- let isRightOpen = false;
45
-
46
- if (open === 'left') {
47
- ariaLabelCodeButton = ariaLabelOutputButton = 'show output';
48
- isLeftOpen = true;
49
- } else if (open === 'right') {
50
- ariaLabelCodeButton = ariaLabelOutputButton = 'show code';
51
- isRightOpen = true;
52
- }
53
-
54
- return (
55
- <>
56
- <FlexBox>
57
- <Drawer
58
- open={!isRightOpen}
59
- alignItems="center"
60
- flexWrap="nowrap"
61
- textAlign="left"
62
- borderRight={1}
63
- borderColor="gray-900"
64
- px={8}
65
- >
66
- <IconButton
67
- icon={LeftDrawerIcon}
68
- variant="secondary"
69
- size="small"
70
- onClick={() =>
71
- setOpen((state) => (state === 'both' ? 'right' : 'both'))
72
- }
73
- aria-label={ariaLabelCodeButton}
74
- aria-controls="code-drawer"
75
- aria-expanded={!isRightOpen}
76
- />
77
- <DrawerLabel id="code-drawer-label">Code</DrawerLabel>
78
- </Drawer>
79
- <Drawer
80
- open={!isLeftOpen}
81
- alignItems="center"
82
- flexWrap="nowrap"
83
- justifyContent="flex-end"
84
- px={8}
85
- >
86
- <DrawerLabel id="output-drawer-label">Output</DrawerLabel>
87
- <IconButton
88
- icon={RightDrawerIcon}
89
- variant="secondary"
90
- size="small"
91
- onClick={() =>
92
- setOpen((state) => (state === 'both' ? 'left' : 'both'))
93
- }
94
- aria-label={ariaLabelOutputButton}
95
- aria-controls="output-drawer"
96
- aria-expanded={!isLeftOpen}
97
- />
98
- </Drawer>
99
- </FlexBox>
100
- <FlexBox
101
- flexGrow={1}
102
- borderY={1}
103
- borderColor="gray-900"
104
- alignItems="stretch"
105
- overflow="hidden"
106
- >
107
- <Drawer
108
- hideOnClose
109
- id="code-drawer"
110
- aria-labelledby="code-drawer-label"
111
- open={!isRightOpen}
112
- flexGrow={0}
113
- overflow="hidden"
114
- borderColor="gray-900"
115
- borderStyleRight="solid"
116
- borderWidthRight="thin"
117
- >
118
- {leftChild}
119
- </Drawer>
120
- <Drawer
121
- hideOnClose
122
- id="output-drawer"
123
- aria-labelledby="output-drawer-label"
124
- open={!isLeftOpen}
125
- overflow="hidden"
126
- >
127
- {rightChild}
128
- </Drawer>
129
- </FlexBox>
130
- </>
131
- );
132
- };
package/src/editor.tsx DELETED
@@ -1,154 +0,0 @@
1
- import {
2
- FillButton,
3
- FlexBox,
4
- Spinner,
5
- TextButton,
6
- ToolTip,
7
- } from '@codecademy/gamut';
8
- import { CopyIcon } from '@codecademy/gamut-icons';
9
- import styled from '@emotion/styled';
10
- import React, { useState } from 'react';
11
-
12
- import { postSnippet } from './api';
13
- import type { LanguageOption } from './consts';
14
- import { Drawers } from './drawers';
15
- import { trackClick } from './helpers';
16
- import { SimpleMonacoEditor } from './MonacoEditor';
17
-
18
- const Output = styled.pre<{ hasError: boolean }>`
19
- width: 100%;
20
- height: 100%;
21
- margin: 0;
22
- padding: 0 1rem;
23
- font-family: Monaco;
24
- font-size: 0.875rem;
25
- overflow: auto;
26
- ${({ hasError, theme }) => `
27
- color: ${hasError ? theme.colors.orange : theme.colors.white};
28
- background-color: ${theme.colors['navy-900']};
29
- `}
30
- `;
31
-
32
- const CopyIconStyled = styled(CopyIcon)`
33
- margin-right: 0.5rem;
34
- `;
35
-
36
- const DOCKER_SIGTERM = 143;
37
-
38
- type EditorProps = {
39
- hideCopyButton: boolean;
40
- language: LanguageOption;
41
- text: string;
42
- onChange: (text: string) => void;
43
- onCopy?: (text: string, language: string) => void;
44
- snippetsBaseUrl?: string;
45
- };
46
-
47
- export const Editor: React.FC<EditorProps> = ({
48
- language,
49
- text,
50
- hideCopyButton,
51
- onChange,
52
- onCopy,
53
- snippetsBaseUrl,
54
- }) => {
55
- const [output, setOutput] = useState('');
56
- const [status, setStatus] = useState<'ready' | 'waiting' | 'error'>('ready');
57
- const [isCodeByteCopied, setIsCodeByteCopied] = useState(false);
58
- const onCopyClick = () => {
59
- if (!isCodeByteCopied) {
60
- navigator.clipboard
61
- .writeText(text)
62
- // eslint-disable-next-line no-console
63
- .catch(() => console.error('Failed to copy'));
64
- onCopy?.(text, language);
65
- setIsCodeByteCopied(true);
66
- trackClick('copy');
67
- }
68
- };
69
-
70
- const setErrorStatusAndOutput = (message: string) => {
71
- setOutput(message);
72
- setStatus('error');
73
- };
74
-
75
- const handleSubmit = async () => {
76
- if (text.trim().length === 0) {
77
- return;
78
- }
79
- const data = {
80
- language,
81
- code: text,
82
- };
83
- setStatus('waiting');
84
- setOutput('');
85
- trackClick('run');
86
-
87
- try {
88
- const response = await postSnippet(data, snippetsBaseUrl);
89
- if (response.stderr.length > 0) {
90
- setErrorStatusAndOutput(response.stderr);
91
- } else if (response.exit_code === DOCKER_SIGTERM) {
92
- setErrorStatusAndOutput(
93
- 'Your code took too long to return a result. Double check your code for any issues and try again!'
94
- );
95
- } else if (response.exit_code !== 0) {
96
- setErrorStatusAndOutput('An unknown error occured.');
97
- } else {
98
- setOutput(response.stdout);
99
- setStatus('ready');
100
- }
101
- } catch (error) {
102
- setErrorStatusAndOutput('Error: ' + error);
103
- }
104
- };
105
-
106
- return (
107
- <>
108
- <Drawers
109
- leftChild={
110
- <SimpleMonacoEditor
111
- value={text}
112
- language={language}
113
- onChange={onChange}
114
- />
115
- }
116
- rightChild={
117
- <Output hasError={status === 'error'} aria-live="polite">
118
- {output}
119
- </Output>
120
- }
121
- />
122
- <FlexBox
123
- justifyContent={hideCopyButton ? 'flex-end' : 'space-between'}
124
- pl={8}
125
- >
126
- {!hideCopyButton ? (
127
- <ToolTip
128
- id="codebyte-copied"
129
- alignment="top-right"
130
- mode="dark"
131
- target={
132
- <TextButton
133
- variant="secondary"
134
- onClick={onCopyClick}
135
- onBlur={() => setIsCodeByteCopied(false)}
136
- >
137
- <CopyIconStyled aria-hidden="true" /> Copy Codebyte
138
- </TextButton>
139
- }
140
- >
141
- {isCodeByteCopied ? (
142
- <span role="alert">Copied!</span>
143
- ) : (
144
- <span>Copy to your clipboard</span>
145
- )}
146
- </ToolTip>
147
- ) : null}
148
- <FillButton onClick={handleSubmit}>
149
- {status === 'waiting' ? <Spinner /> : 'Run'}
150
- </FillButton>
151
- </FlexBox>
152
- </>
153
- );
154
- };
@@ -1,41 +0,0 @@
1
- import { trackUserClick } from '../libs/eventTracking';
2
-
3
- export type CodebyteOptions = {
4
- clientName: string;
5
- parentPage: string;
6
- renderMode: string;
7
- };
8
-
9
- export enum CodebytesParams {
10
- Language = 'lang',
11
- Text = 'text',
12
- CopyMode = 'copy-mode',
13
- ClientName = 'client-name',
14
- Page = 'page',
15
- Mode = 'mode',
16
- }
17
-
18
- export const getOptions = (): CodebyteOptions => {
19
- const currentUri = new URL(window.location.href);
20
-
21
- return {
22
- clientName:
23
- currentUri.searchParams.get(CodebytesParams.ClientName) || 'Unknown',
24
- parentPage:
25
- currentUri.searchParams.get(CodebytesParams.Page) || document.referrer,
26
- renderMode: currentUri.searchParams.get(CodebytesParams.Mode) || '',
27
- };
28
- };
29
-
30
- export const trackClick = (target: string) => {
31
- const options = getOptions();
32
- const page_name = options.renderMode
33
- ? `${options.clientName}_${options.renderMode}`
34
- : options.clientName;
35
-
36
- trackUserClick({
37
- page_name,
38
- context: options.parentPage,
39
- target,
40
- });
41
- };
package/src/index.tsx DELETED
@@ -1,109 +0,0 @@
1
- import { Box, IconButton } from '@codecademy/gamut';
2
- import { FaviconIcon } from '@codecademy/gamut-icons';
3
- import { Background, states, system } from '@codecademy/gamut-styles';
4
- import { StyleProps } from '@codecademy/variance';
5
- import styled from '@emotion/styled';
6
- import React, { useEffect, useState } from 'react';
7
-
8
- import { helloWorld, LanguageOption } from './consts';
9
- import { Editor } from './editor';
10
- import { getOptions, trackClick } from './helpers';
11
- import { LanguageSelection } from './languageSelection';
12
- import { trackUserImpression } from './libs/eventTracking';
13
- import { CodeByteEditorProps } from './types';
14
-
15
- const editorStates = states({
16
- isForums: { height: '100vh' },
17
- });
18
-
19
- const editorBaseStyles = system.css({
20
- border: 1,
21
- borderColor: 'gray-900',
22
- display: 'flex',
23
- flexDirection: 'column',
24
- height: '25rem',
25
- width: '43rem',
26
- overflow: 'hidden',
27
- });
28
- export interface EditorStyleProps
29
- extends StyleProps<typeof editorBaseStyles>,
30
- StyleProps<typeof editorStates> {}
31
-
32
- const EditorContainer = styled(Background)<EditorStyleProps>(
33
- editorBaseStyles,
34
- editorStates
35
- );
36
-
37
- export const CodeByteEditor: React.FC<CodeByteEditorProps> = ({
38
- text: initialText,
39
- language: initialLanguage,
40
- hideCopyButton,
41
- isForums = false,
42
- snippetsBaseUrl,
43
- onEdit,
44
- onLanguageChange,
45
- }) => {
46
- const [text, setText] = useState<string>(initialText);
47
- const [language, setLanguage] = useState<LanguageOption>(initialLanguage);
48
- const [hasBeenEdited, setHasBeenEdited] = useState(false);
49
-
50
- useEffect(() => {
51
- const options = getOptions();
52
- const page_name = options.renderMode
53
- ? `${options.clientName}_${options.renderMode}`
54
- : options.clientName;
55
-
56
- trackUserImpression({
57
- page_name,
58
- context: options.parentPage,
59
- target: 'codebyte',
60
- });
61
- }, []);
62
-
63
- return (
64
- <EditorContainer bg="black" as="main" isForums={isForums}>
65
- <Box borderBottom={1} borderColor="gray-900" py={4} pl={8}>
66
- <IconButton
67
- icon={FaviconIcon}
68
- variant="secondary"
69
- href="https://www.codecademy.com/"
70
- target="_blank"
71
- rel="noreferrer"
72
- aria-label="visit codecademy.com"
73
- onClick={() => trackClick('logo')}
74
- />
75
- </Box>
76
- {language ? (
77
- <Editor
78
- language={language}
79
- text={text}
80
- hideCopyButton={hideCopyButton}
81
- onChange={(newText: string) => {
82
- setText(newText);
83
- onEdit?.(newText, language);
84
-
85
- const { renderMode } = getOptions();
86
- if (!renderMode && hasBeenEdited === false) {
87
- setHasBeenEdited(true);
88
- trackClick('edit');
89
- }
90
- }}
91
- snippetsBaseUrl={snippetsBaseUrl}
92
- />
93
- ) : (
94
- <LanguageSelection
95
- onChange={(newLanguage) => {
96
- const newText: string =
97
- text || (newLanguage ? helloWorld[newLanguage] : '');
98
- setLanguage(newLanguage);
99
- setText(newText);
100
- trackClick('lang_select');
101
- onLanguageChange?.(newText, newLanguage);
102
- }}
103
- />
104
- )}
105
- </EditorContainer>
106
- );
107
- };
108
-
109
- export default CodeByteEditor;
@@ -1,26 +0,0 @@
1
- import { Select, Text } from '@codecademy/gamut';
2
- import { ColorMode } from '@codecademy/gamut-styles';
3
- import React from 'react';
4
-
5
- import type { LanguageOption } from './consts';
6
- import { LanguageOptions } from './consts';
7
-
8
- export type LanguageSelectionProps = {
9
- onChange: (newLanguage: LanguageOption) => void;
10
- };
11
-
12
- export const LanguageSelection: React.FC<LanguageSelectionProps> = ({
13
- onChange,
14
- }) => {
15
- return (
16
- <ColorMode mode="dark" flex={1} px={16} pt={48}>
17
- <Text mb={16}>Which language do you want to code in?</Text>
18
- <Select
19
- id="language-select"
20
- aria-label="Select a language"
21
- options={LanguageOptions}
22
- onChange={(e) => onChange(e.target.value as LanguageOption)}
23
- />
24
- </ColorMode>
25
- );
26
- };
@@ -1,18 +0,0 @@
1
- import { createTracker } from '@codecademy/tracking';
2
-
3
- const IS_DEV = process.env.NODE_ENV === 'development';
4
-
5
- // TODO: confirm tracking details and implementation DISC-447
6
- const tracker = createTracker({
7
- apiBaseUrl:
8
- typeof window === undefined
9
- ? 'https://www.codecademy.com'
10
- : window.location.origin,
11
- verbose: IS_DEV,
12
- });
13
-
14
- export const {
15
- click: trackUserClick,
16
- visit: trackUserVisit,
17
- impression: trackUserImpression,
18
- } = tracker;
package/src/types.ts DELETED
@@ -1,15 +0,0 @@
1
- import { LanguageOption } from './consts';
2
-
3
- interface CodebytesChangeHandler {
4
- (text: string, language: LanguageOption): void;
5
- }
6
- export interface CodeByteEditorProps {
7
- text: string;
8
- language: LanguageOption;
9
- hideCopyButton: boolean;
10
- onCopy?: CodebytesChangeHandler;
11
- isForums?: boolean;
12
- snippetsBaseUrl?: string;
13
- onEdit?: CodebytesChangeHandler;
14
- onLanguageChange?: CodebytesChangeHandler;
15
- }
package/tsconfig.json DELETED
@@ -1,8 +0,0 @@
1
- {
2
- "extends": "../../tsconfig.json",
3
- "include": ["../../typings/*.d.ts", "./src/**/*.ts", "./src/**/*.tsx"],
4
- "compilerOptions": {
5
- "allowJs": true,
6
- "outDir": "./dist"
7
- }
8
- }