@tutorialkit-rb/runtime 1.5.2-rb.0.1.0

package/dist/store/tutorial-runner.d.ts

@@ -0,0 +1,147 @@
+import type { CommandsSchema, Files } from '@tutorialkit-rb/types';
+import type { WebContainer } from '@webcontainer/api';
+import { type TaskCancelled } from '../tasks.js';
+import { StepsController } from '../webcontainer/steps.js';
+import type { EditorStore } from './editor.js';
+import type { TerminalStore } from './terminal.js';
+interface LoadFilesOptions {
+    /**
+     * The list of files to load.
+     */
+    files: Files | Promise<Files>;
+    /**
+     * The template to load.
+     */
+    template?: Files | Promise<Files>;
+    /**
+     * If true, all files will be removed (except for `node_modules`).
+     *
+     * @default false
+     */
+    removeAllFiles?: boolean;
+    /**
+     * Paths to remove before loading new files.
+     */
+    removePaths?: string[];
+    /**
+     * Abort the previous load files operation.
+     *
+     * @default true
+     */
+    abortPreviousLoad?: boolean;
+    /**
+     * A signal to abort this operation.
+     */
+    signal?: AbortSignal;
+}
+interface RunCommandsOptions {
+    /**
+     * Abort the previous run commands operation.
+     *
+     * @default true
+     */
+    abortPreviousRun?: boolean;
+}
+/**
+ * The idea behind this class is that it manages the state of WebContainer and exposes
+ * an interface that makes sense to every component of TutorialKit.
+ *
+ * There should be only a single instance of this class.
+ */
+export declare class TutorialRunner {
+    private _webcontainer;
+    private _terminalStore;
+    private _editorStore;
+    private _stepController;
+    private _currentLoadTask;
+    private _currentProcessTask;
+    private _currentCommandProcess;
+    private _currentTemplate;
+    private _currentFiles;
+    private _currentRunCommands;
+    private _ignoreFileEvents;
+    private _watcher;
+    private _watchContentFromWebContainer;
+    private _readyToWatch;
+    private _packageJsonDirty;
+    private _commandsChanged;
+    private _packageJsonContent;
+    private _packageJsonPath;
+    constructor(_webcontainer: Promise<WebContainer>, _terminalStore: TerminalStore, _editorStore: EditorStore, _stepController: StepsController);
+    setWatchFromWebContainer(value: boolean | string[]): void;
+    /**
+     * Set the commands to run. This updates the reported `steps` if any have changed.
+     *
+     * This function is safe to call server side.
+     *
+     * To actually run them in WebContainer see `runCommands`.
+     *
+     * @param commands The commands schema.
+     */
+    setCommands(commands: CommandsSchema): void;
+    onTerminalResize(cols: number, rows: number): void;
+    createFolder(folderPath: string): void;
+    /**
+     * Update the content of a single file in WebContainer.
+     *
+     * @param filePath path of the file
+     * @param content new content of the file
+     */
+    updateFile(filePath: string, content: string): void;
+    /**
+     * Update the provided files in WebContainer.
+     *
+     * @param files Files to update.
+     */
+    updateFiles(files: Files): void;
+    fileExists(filepath: string): Promise<boolean>;
+    folderExists(folderPath: string): Promise<boolean>;
+    private _fsExists;
+    /**
+     * Load the provided files into WebContainer and remove any other files that had been loaded previously.
+     *
+     * This function always waits for any previous `prepareFiles` or `updateFile(s)` call to have completed
+     * before sending the next one.
+     *
+     * Previous load operations will be cancelled if `options.abortPreviousLoad` was set to true (which is the default).
+     *
+     * @see {LoadFilesOptions}
+     */
+    prepareFiles({ files, template, signal, abortPreviousLoad, removePaths, }: LoadFilesOptions): Promise<void | TaskCancelled>;
+    /**
+     * Runs the list of commands set with `setCommands`.
+     *
+     * This function always wait for any previous `runCommands` call to have completed before sending the next one.
+     * It will cancel the previous operation if `options.abortPreviousRun` was set to true.
+     *
+     * Commands are split into two:
+     *
+     *  - `prepareCommands`: For example commands like `npm install`, `mkdir -p src/foobar`, etc.
+     *  - `mainCommand`: Used to for example run a dev server or equivalent.
+     *
+     * @see {LoadFilesOptions}
+     */
+    runCommands({ abortPreviousRun }?: RunCommandsOptions): void;
+    /**
+     * Restart the last run commands that were submitted.
+     */
+    restartLastRunCommands(): void;
+    /**
+     * Get snapshot of runner's current files.
+     * Also prepares `package.json`'s `stackblitz.startCommand` with runner's commands.
+     *
+     * Note that file paths do not contain the leading `/`.
+     */
+    takeSnapshot(): {
+        files: Record<string, string>;
+    };
+    private _runCommands;
+    private _newProcess;
+    private _updateDirtyState;
+    private _updateCurrentFiles;
+    private _stopWatcher;
+    private _setupWatcher;
+    private _clearDirtyState;
+    private _changeDetection;
+}
+export {};