@dodona/papyros 0.1.31-action → 0.1.35

package/README.md

@@ -12,29 +12,22 @@
   </a>
 </p>
 
-Papyros is a programming scratchpad in the browser. It allows running arbitrary
-in various programming languages directly in your browser, no installation required.
+Papyros is a programming scratchpad in the browser. It allows running code
+directly in your browser, no installation required. Right now, the focus in on providing a great experience for Python, while also supporting JavaScript.
 By taking away obstacles between students and coding, the learning experience becomes
-smoother and less error-prone. 
-
-Papyros aims to be:
-
-- **Easy to use** by having minimal installation instructions and an intuitive user interface
-- **Flexible** to support many programming languages
+smoother and less error-prone.
 
 Currently, Papyros provides support for the following programming languages:
 - Python, powered by [Pyodide](https://pyodide.org/en/stable/)
 - JavaScript, powered by your browser
 
-## Installation
+## Using Papyros in your own project
 
 You can install Papyros on your system using npm:
 ```shell
 npm install -g @dodona/papyros
 ```
 
-## Usage
-
 Papyros currently supports two modes of operation: stand-alone and embedded.
 
 In stand-alone mode, Papyros runs as a full application in the browser. 

package/dist/Backend.d.ts

@@ -6,11 +6,12 @@ export declare abstract class Backend {
     /**
      * Initialize the backend, setting up any globals required
      * @param {function(PapyrosEvent):void} onEvent Callback for when events occur
+     * @param {string} hostname Base URL for input
      * @param {Uint8Array} inputTextArray Optional shared buffer for input
      * @param {Int32Array} inputMetaData Optional shared buffer for metadata about input
      * @return {Promise<void>} Promise of launching
      */
-    launch(onEvent: (e: PapyrosEvent) => void, inputTextArray?: Uint8Array, inputMetaData?: Int32Array): Promise<void>;
+    launch(onEvent: (e: PapyrosEvent) => void, hostname: string, inputTextArray?: Uint8Array, inputMetaData?: Int32Array): Promise<void>;
     abstract _runCodeInternal(code: string): Promise<any>;
     /**
      * Validate and run arbitrary code

package/dist/CodeEditor.d.ts

@@ -10,5 +10,6 @@ export declare class CodeEditor {
     setLanguage(language: ProgrammingLanguage, editorPlaceHolder: string): void;
     setIndentLength(indentLength: number): void;
     getCode(): string;
+    setCode(code: string): void;
     focus(): void;
 }

package/dist/Constants.d.ts

@@ -12,6 +12,7 @@ export declare const SEND_INPUT_BTN_ID = "send-input-btn";
 export declare const SWITCH_INPUT_MODE_A_ID = "switch-input-mode";
 export declare const PROGRAMMING_LANGUAGE_SELECT_ID = "programming-language-select";
 export declare const DEFAULT_PROGRAMMING_LANGUAGE = ProgrammingLanguage.Python;
+export declare const EXAMPLE_SELECT_ID = "example-select";
 export declare const LOCALE_SELECT_ID = "locale-select";
 export declare const DEFAULT_LOCALE = "nl";
-export declare const INPUT_RELATIVE_URL = "/__papyros_input";
+export declare const INPUT_RELATIVE_URL = "__papyros_input";

package/dist/OutputManager.d.ts

@@ -0,0 +1,19 @@
+import { PapyrosEvent } from "./PapyrosEvent";
+export interface FriendlyError {
+    name: string;
+    traceback?: string;
+    info?: string;
+    why?: string;
+    what?: string;
+    where?: string;
+}
+export declare class OutputManager {
+    outputArea: HTMLElement;
+    constructor(outputWrapperId: string);
+    renderNextElement(html: string): void;
+    spanify(text: string, ignoreEmpty?: boolean): string;
+    showOutput(output: PapyrosEvent): void;
+    showError(error: FriendlyError | string): void;
+    onRunStart(): void;
+    onRunEnd(): void;
+}

package/dist/Papyros.d.ts

@@ -6,6 +6,7 @@ import { InputManager, InputMode } from "./InputManager";
 import { PapyrosEvent } from "./PapyrosEvent";
 import { ProgrammingLanguage } from "./ProgrammingLanguage";
 import { StatusPanel } from "./StatusPanel";
+import { OutputManager } from "./OutputManager";
 declare enum PapyrosState {
     Loading = "loading",
     Running = "running",
@@ -38,12 +39,15 @@ export declare class Papyros {
     stateManager: PapyrosStateManager;
     codeState: PapyrosCodeState;
     inputManager: InputManager;
+    outputManager: OutputManager;
     constructor(programmingLanguage: ProgrammingLanguage, inputMode: InputMode);
     get state(): PapyrosState;
     launch(): Promise<Papyros>;
     setProgrammingLanguage(programmingLanguage: ProgrammingLanguage): Promise<void>;
+    setCode(code: string): void;
     startBackend(): Promise<void>;
-    static fromElement(parent: HTMLElement, config: PapyrosConfig): Promise<Papyros>;
+    static fromElement(parent: HTMLElement, config: PapyrosConfig): Papyros;
+    static configureInput(allowReload: boolean): Promise<boolean>;
     onError(e: PapyrosEvent): void;
     onInput(e: PapyrosEvent): Promise<void>;
     onMessage(e: PapyrosEvent): void;

package/dist/PapyrosEvent.d.ts

@@ -2,4 +2,5 @@ export interface PapyrosEvent {
     type: "input" | "output" | "script" | "success" | "error";
     data: string;
     runId: number;
+    content?: string;
 }

package/dist/StatusPanel.d.ts

@@ -1,7 +1,4 @@
 export declare class StatusPanel {
-    onRun: () => void;
-    constructor(onRun: () => void);
-    initialize(): void;
     get statusSpinner(): HTMLElement;
     get statusText(): HTMLElement;
     showSpinner(show: boolean): void;

package/dist/examples/Examples.d.ts

@@ -0,0 +1,6 @@
+import { ProgrammingLanguage } from "../ProgrammingLanguage";
+export declare function getExamples(language: ProgrammingLanguage): {
+    [key: string]: string;
+};
+export declare function getExampleNames(language: ProgrammingLanguage): Array<string>;
+export declare function getCodeForExample(language: ProgrammingLanguage, name: string): string;

package/dist/examples/JavaScriptExamples.d.ts

@@ -0,0 +1,5 @@
+export declare const JAVASCRIPT_EXAMPLES: {
+    "Hello world!": string;
+    Input: string;
+    Fibonacci: string;
+};

package/dist/examples/PythonExamples.d.ts

@@ -0,0 +1,11 @@
+export declare const PYTHON_EXAMPLES: {
+    "Hello, World!": string;
+    Input: string;
+    Fibonacci: string;
+    Doctests: string;
+    Async: string;
+    Erroneous: string;
+    Unicode: string;
+    Files: string;
+    Matplotlib: string;
+};