@dodona/papyros 0.1.2-rc → 0.1.3-action

package/lib/Backend.d.ts

@@ -0,0 +1,22 @@
+import { PapyrosEvent } from "./PapyrosEvent";
+export declare abstract class Backend {
+    onEvent: (e: PapyrosEvent) => any;
+    runId: number;
+    constructor();
+    /**
+     * Initialize the backend, setting up any globals required
+     * @param {function(PapyrosEvent):void} onEvent Callback for when events occur
+     * @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>;
+    abstract _runCodeInternal(code: string): Promise<any>;
+    /**
+     * Validate and run arbitrary code
+     * @param {string} code The code to run
+     * @param {string} runId The uuid for this execution
+     * @return {Promise<void>} Promise of execution
+     */
+    runCode(code: string, runId: number): Promise<void>;
+}

package/lib/BackendManager.d.ts

@@ -0,0 +1,5 @@
+import { Remote } from "comlink";
+import { Backend } from "./Backend";
+import { ProgrammingLanguage } from "./ProgrammingLanguage";
+export declare function getBackend(language: ProgrammingLanguage): Remote<Backend>;
+export declare function stopBackend(backend: Remote<Backend>): void;

package/lib/CodeEditor.d.ts

@@ -0,0 +1,14 @@
+import { Compartment } from "@codemirror/state";
+import { ProgrammingLanguage } from "./ProgrammingLanguage";
+import { EditorView } from "@codemirror/view";
+export declare class CodeEditor {
+    editorView: EditorView;
+    languageCompartment: Compartment;
+    indentCompartment: Compartment;
+    placeholderCompartment: Compartment;
+    constructor(element: HTMLElement, language: ProgrammingLanguage, panel: HTMLElement, editorPlaceHolder: string, initialCode?: string, indentLength?: number);
+    setLanguage(language: ProgrammingLanguage, editorPlaceHolder: string): void;
+    setIndentLength(indentLength: number): void;
+    getCode(): string;
+    focus(): void;
+}

package/lib/Constants.d.ts

@@ -0,0 +1,17 @@
+import { ProgrammingLanguage } from "./ProgrammingLanguage";
+export declare const MAIN_APP_ID = "papyros";
+export declare const OUTPUT_TA_ID = "code-output-area";
+export declare const INPUT_AREA_WRAPPER_ID = "code-input-area-wrapper";
+export declare const INPUT_TA_ID = "code-input-area";
+export declare const EDITOR_WRAPPER_ID = "code-area";
+export declare const STATE_SPINNER_ID = "state-spinner";
+export declare const APPLICATION_STATE_TEXT_ID = "application-state-text";
+export declare const RUN_BTN_ID = "run-code-btn";
+export declare const STOP_BTN_ID = "stop-btn";
+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 LOCALE_SELECT_ID = "locale-select";
+export declare const DEFAULT_LOCALE = "nl";
+export declare const INPUT_RELATIVE_URL = "/__papyros_input";

package/lib/InputManager.d.ts

@@ -0,0 +1,31 @@
+import { PapyrosEvent } from "./PapyrosEvent";
+export declare enum InputMode {
+    Interactive = "interactive",
+    Batch = "batch"
+}
+export declare const INPUT_MODES: InputMode[];
+interface InputSession {
+    lineNr: number;
+}
+export declare class InputManager {
+    inputWrapper: HTMLElement;
+    inputMode: InputMode;
+    waiting: boolean;
+    batchInput: string;
+    onSend: () => void;
+    session: InputSession;
+    inputTextArray?: Uint8Array;
+    inputMetaData?: Int32Array;
+    textEncoder: TextEncoder;
+    constructor(onSend: () => void, inputMode: InputMode);
+    get enterButton(): HTMLButtonElement;
+    get inputArea(): HTMLInputElement;
+    buildInputArea(): void;
+    setInputMode(inputMode: InputMode): void;
+    setWaiting(waiting: boolean, prompt?: string): void;
+    sendLine(): Promise<boolean>;
+    onInput(e?: PapyrosEvent): Promise<void>;
+    onRunStart(): void;
+    onRunEnd(): void;
+}
+export {};

package/lib/Papyros.d.ts

@@ -0,0 +1,53 @@
+import "./Papyros.css";
+import { Remote } from "comlink";
+import { Backend } from "./Backend";
+import { CodeEditor } from "./CodeEditor";
+import { InputManager, InputMode } from "./InputManager";
+import { PapyrosEvent } from "./PapyrosEvent";
+import { ProgrammingLanguage } from "./ProgrammingLanguage";
+import { StatusPanel } from "./StatusPanel";
+declare enum PapyrosState {
+    Loading = "loading",
+    Running = "running",
+    AwaitingInput = "awaiting_input",
+    Stopping = "stopping",
+    Ready = "ready"
+}
+declare class PapyrosStateManager {
+    state: PapyrosState;
+    statusPanel: StatusPanel;
+    runButton: HTMLButtonElement;
+    stopButton: HTMLButtonElement;
+    constructor(statusPanel: StatusPanel);
+    setState(state: PapyrosState, message?: string): void;
+}
+interface PapyrosCodeState {
+    programmingLanguage: ProgrammingLanguage;
+    editor: CodeEditor;
+    backend: Remote<Backend>;
+    runId: number;
+    outputArea: HTMLInputElement;
+}
+interface PapyrosConfig {
+    standAlone: boolean;
+    programmingLanguage: ProgrammingLanguage;
+    locale: string;
+    inputMode: InputMode;
+}
+export declare class Papyros {
+    stateManager: PapyrosStateManager;
+    codeState: PapyrosCodeState;
+    inputManager: InputManager;
+    constructor(programmingLanguage: ProgrammingLanguage, inputMode: InputMode);
+    get state(): PapyrosState;
+    launch(): Promise<Papyros>;
+    setProgrammingLanguage(programmingLanguage: ProgrammingLanguage): Promise<void>;
+    startBackend(): Promise<void>;
+    static fromElement(parent: HTMLElement, config: PapyrosConfig): Promise<Papyros>;
+    onError(e: PapyrosEvent): void;
+    onInput(e: PapyrosEvent): Promise<void>;
+    onMessage(e: PapyrosEvent): void;
+    runCode(): Promise<void>;
+    stop(): Promise<void>;
+}
+export {};

package/lib/PapyrosEvent.d.ts

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

package/lib/ProgrammingLanguage.d.ts

@@ -0,0 +1,6 @@
+export declare enum ProgrammingLanguage {
+    Python = "Python",
+    JavaScript = "JavaScript"
+}
+export declare const PROGRAMMING_LANGUAGES: ProgrammingLanguage[];
+export declare function plFromString(language: string): ProgrammingLanguage;

package/lib/StatusPanel.d.ts

@@ -0,0 +1,10 @@
+export declare class StatusPanel {
+    onRun: () => void;
+    constructor(onRun: () => void);
+    initialize(): void;
+    get statusSpinner(): HTMLElement;
+    get statusText(): HTMLElement;
+    showSpinner(show: boolean): void;
+    setStatus(status: string): void;
+    render(parent: HTMLElement): HTMLElement;
+}

package/lib/index.d.ts

@@ -0,0 +1 @@
+export {};