namespace pxt.editor {

export enum SimState {

Stopped,

Starting,

Running

}

export interface IEditor {

undo(): void;

redo(): void;

hasUndo(): boolean;

hasRedo(): boolean;

zoomIn(): void;

zoomOut(): void;

resize(): void;

setScale(scale: number): void;

}

export interface IFile {

name: string;

virtual?: boolean; // gimmick to switch views

}

export interface FileHistoryEntry {

id: string;

name: string;

pos: any;

}

export interface EditorSettings {

editorFontSize: number;

fileHistory: FileHistoryEntry[];

}

export interface IAppProps { }

export interface IAppState {

active?: boolean; // is this tab visible at all

header?: pxt.workspace.Header;

editorState?: EditorState;

currFile?: IFile;

fileState?: string;

showFiles?: boolean;

sideDocsLoadUrl?: string; // set once to load the side docs frame

sideDocsCollapsed?: boolean;

projectName?: string;

suppressPackageWarning?: boolean;

tutorialOptions?: TutorialOptions;

lightbox?: boolean;

simState?: SimState;

autoRun?: boolean;

resumeOnVisibility?: boolean;

compiling?: boolean;

isSaving?: boolean;

publishing?: boolean;

hideEditorFloats?: boolean;

collapseEditorTools?: boolean;

showBlocks?: boolean;

showParts?: boolean;

fullscreen?: boolean;

mute?: boolean;

embedSimView?: boolean;

tracing?: boolean;

debugging?: boolean;

bannerVisible?: boolean;

highContrast?: boolean;

print?: boolean;

greenScreen?: boolean;

home?: boolean;

hasError?: boolean;

screenshoting?: boolean;

}

export interface EditorState {

filters?: pxt.editor.ProjectFilters;

searchBar?: boolean; // show the search bar in editor

hasCategories?: boolean; // show categories in toolbox

}

export interface ProjectCreationOptions {

prj?: pxt.ProjectTemplate;

name?: string;

documentation?: string;

filesOverride?: pxt.Map<string>;

filters?: ProjectFilters;

temporary?: boolean;

inTutorial?: boolean;

dependencies?: pxt.Map<string>;

tsOnly?: boolean;

}

export interface ExampleImportOptions {

name: string;

path: string;

loadBlocks?: boolean;

prj?: ProjectTemplate;

}

export interface ProjectFilters {

namespaces?: { [index: string]: FilterState; }; // Disabled = 2, Hidden = 0, Visible = 1

blocks?: { [index: string]: FilterState; }; // Disabled = 2, Hidden = 0, Visible = 1

fns?: { [index: string]: FilterState; }; // Disabled = 2, Hidden = 0, Visible = 1

defaultState?: FilterState; // hide, show or disable all by default

}

export enum FilterState {

Hidden = 0,

Visible = 1,

Disabled = 2

}

export interface TutorialOptions {

tutorial?: string; // tutorial

tutorialName?: string; // tutorial title

tutorialReportId?: string; // if this tutorial was user generated, the report abuse id

tutorialStepInfo?: pxt.tutorial.TutorialStepInfo[];

tutorialStep?: number; // current tutorial page

tutorialReady?: boolean; // current tutorial page

}

export interface ModalDialogButton {

label: string;

url?: string;

}

export interface ModalDialogOptions {

header: string;

body: string;

buttons?: ModalDialogButton[];

}

export interface ScreenshotData {

data?: ImageData;

delay?: number;

event?: "start" | "stop";

}

export interface IProjectView {

state: IAppState;

setState(st: IAppState): void;

forceUpdate(): void;

reloadEditor(): void;

openBlocks(): void;

openJavaScript(giveFocusOnLoading?: boolean): void;

openSettings(): void;

openSimView(): void;

openPreviousEditor(): void;

switchTypeScript(): void;

openTypeScriptAsync(): Promise<void>;

saveBlocksToTypeScriptAsync(): Promise<string>;

saveFileAsync(): Promise<void>;

loadHeaderAsync(h: pxt.workspace.Header): Promise<void>;

reloadHeaderAsync(): Promise<void>;

importProjectAsync(prj: pxt.workspace.Project, editorState?: pxt.editor.EditorState): Promise<void>;

overrideTypescriptFile(text: string): void;

overrideBlocksFile(text: string): void;

exportAsync(): Promise<string>;

newEmptyProject(name?: string, documentation?: string): void;

newProject(options?: ProjectCreationOptions): void;

createProjectAsync(options: ProjectCreationOptions): Promise<void>;

importExampleAsync(options: ExampleImportOptions): Promise<void>;

showScriptManager(): void;

importProjectDialog(): void;

removeProject(): void;

editText(): void;

pushPullAsync(): Promise<void>;

getPreferredEditor(): string;

saveAndCompile(): void;

updateHeaderName(name: string): void;

updateHeaderNameAsync(name: string): Promise<void>;

compile(): void;

setFile(fn: IFile): void;

setSideFile(fn: IFile): void;

setSideDoc(path: string, blocksEditor?: boolean): void;

setSideMarkdown(md: string): void;

removeFile(fn: IFile, skipConfirm?: boolean): void;

updateFileAsync(name: string, content: string, open?: boolean): Promise<void>;

openHome(): void;

setTutorialStep(step: number): void;

exitTutorial(): void;

completeTutorial(): void;

showTutorialHint(): void;

anonymousPublishAsync(screenshotUri?: string): Promise<string>;

startStopSimulator(clickTrigger?: boolean): void;

stopSimulator(unload?: boolean): void;

restartSimulator(debug?: boolean): void;

startSimulator(debug?: boolean, clickTrigger?: boolean): void;

runSimulator(): void;

isSimulatorRunning(): boolean;

expandSimulator(): void;

collapseSimulator(): void;

toggleSimulatorCollapse(): void;

toggleSimulatorFullscreen(): void;

proxySimulatorMessage(content: string): void;

toggleTrace(intervalSpeed?: number): void;

setTrace(enabled: boolean, intervalSpeed?: number): void;

toggleMute(): void;

openInstructions(): void;

closeFlyout(): void;

printCode(): void;

requestScreenshotAsync(): Promise<string>;

downloadScreenshotAsync(): Promise<void>;

toggleDebugging(): void;

dbgPauseResume(): void;

dbgStepInto(): void;

dbgStepOver(): void;

dbgInsertBreakpoint(): void;

setBannerVisible(b: boolean): void;

typecheckNow(): void;

openExtension(extension: string, url: string, consentRequired?: boolean): void;

handleExtensionRequest(request: ExtensionRequest): void;

fireResize(): void;

updateEditorLogo(left: number, rgba?: string): number;

loadBlocklyAsync(): Promise<void>;

isBlocksEditor(): boolean;

isTextEditor(): boolean;

renderBlocksAsync(req: EditorMessageRenderBlocksRequest): Promise<any>;

toggleHighContrast(): void;

toggleGreenScreen(): void;

pair(): void;

launchFullEditor(): void;

settings: EditorSettings;

isEmbedSimActive(): boolean;

isBlocksActive(): boolean;

isJavaScriptActive(): boolean;

editor: IEditor;

startTutorial(tutorialId: string, tutorialTitle?: string): void;

showLightbox(): void;

hideLightbox(): void;

showReportAbuse(): void;

showLanguagePicker(): void;

showShareDialog(): void;

showAboutDialog(): void;

showImportUrlDialog(): void;

showImportFileDialog(): void;

showImportGithubDialog(): void;

showResetDialog(): void;

showExitAndSaveDialog(): void;

showChooseHwDialog(): void;

showExperimentsDialog(): void;

showPackageDialog(): void;

showBoardDialogAsync(features?: string[], closeIcon?: boolean): Promise<void>;

showModalDialogAsync(options: ModalDialogOptions): Promise<void>;

pushScreenshotHandler(handler: (msg: ScreenshotData) => void): void;

popScreenshotHandler(): void;

}

export interface IHexFileImporter {

id: string;

canImport(data: pxt.cpp.HexFile): boolean;

importAsync(project: IProjectView, data: pxt.cpp.HexFile): Promise<void>;

}

export interface IResourceImporter {

id: string;

canImport(data: File): boolean;

importAsync(project: IProjectView, data: File): Promise<void>;

}

export interface ISettingsProps {

parent: IProjectView;

visible?: boolean;

}

export interface IFieldCustomOptions {

selector: string;

editor: Blockly.FieldCustomConstructor;

text?: string;

validator?: any;

}

export interface ExtensionOptions {

blocklyToolbox: ToolboxDefinition;

monacoToolbox: ToolboxDefinition;

projectView: IProjectView;

}

export interface IToolboxOptions {

blocklyToolbox?: ToolboxDefinition;

monacoToolbox?: ToolboxDefinition;

}

export interface ExtensionResult {

hexFileImporters?: IHexFileImporter[];

resourceImporters?: IResourceImporter[];

beforeCompile?: () => void;

patchCompileResultAsync?: (r: pxtc.CompileResult) => Promise<void>;

deployCoreAsync?: (r: pxtc.CompileResult) => Promise<void>;

saveOnlyAsync?: (r: ts.pxtc.CompileResult) => Promise<void>;

saveProjectAsync?: (project: pxt.cpp.HexFile) => Promise<void>;

showUploadInstructionsAsync?: (fn: string, url: string, confirmAsync: (options: any) => Promise<number>) => Promise<void>;

toolboxOptions?: IToolboxOptions;

blocklyPatch?: (pkgTargetVersion: string, dom: Element) => void;

webUsbPairDialogAsync?: (confirmAsync: (options: any) => Promise<number>) => Promise<number>;

}

export interface FieldExtensionOptions {

}

export interface FieldExtensionResult {

fieldEditors?: IFieldCustomOptions[];

}

export interface ToolboxDefinition {

loops?: ToolboxCategoryDefinition;

logic?: ToolboxCategoryDefinition;

variables?: ToolboxCategoryDefinition;

maths?: ToolboxCategoryDefinition;

text?: ToolboxCategoryDefinition;

arrays?: ToolboxCategoryDefinition;

functions?: ToolboxCategoryDefinition;

}

export interface ToolboxCategoryDefinition {

/**

* The display name for the category

*/

name?: string;

/**

* The icon of this category

*/

icon?: string;

/**

* The color of this category

*/

color?: string;

/**

* The weight of the category relative to other categories in the toolbox

*/

weight?: number;

/**

* Whether or not the category should be placed in the advanced category

*/

advanced?: boolean;

/**

* Blocks to appear in the category. Specifying this field will override

* all existing blocks in the category. The ordering of the blocks is

* determined by the ordering of this array.

*/

blocks?: ToolboxBlockDefinition[];

/**

* Ordering of category groups

*/

groups?: string[],

}

export interface ToolboxBlockDefinition {

/**

* Internal id used to refer to this block or snippet, must be unique

*/

name: string;

/**

* Group label used to categorize block. Blocks are arranged with other

* blocks that share the same group.

*/

group?: string,

/**

* Indicates an advanced API. Advanced APIs appear after basic ones in the

* toolbox

*/

advanced?: boolean;

/**

* The weight for the block. Blocks are arranged in order of they appear in the category

* definition's array but the weight can be specified in the case that other APIs are

* dynamically added to the category (eg. loops.forever())

*/

weight?: number;

/**

* Description of code to appear in the hover text

*/

jsDoc?: string

/**

* Snippet of code to insert when dragged into editor

*/

snippet?: string;

/**

* Name used for highlighting the snippet, uses name if not defined

*/

snippetName?: string;

/**

* Display just the snippet and nothing else. Should be set to true for

* language constructs (eg. for-loops) and to false for function

* calls (eg. Math.random())

*/

snippetOnly?: boolean;

/**

* The return type of the block. This is used to determine the shape of the block rendered.

*/

retType?: string;

/**

* The block definition in XML for the blockly toolbox.

*/

blockXml?: string;

/**

* The Blockly block id used to identify this block.

*/

blockId?: string;

}

export let initExtensionsAsync: (opts: ExtensionOptions) => Promise<ExtensionResult>

= opts => Promise.resolve<ExtensionResult>({});

export let initFieldExtensionsAsync: (opts: FieldExtensionOptions) => Promise<FieldExtensionResult>

= opts => Promise.resolve<FieldExtensionResult>({});

export interface NativeHostMessage {

name?: string;

download?: string;

save?: string;

}

export let HELP_IMAGE_URI = 'data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjYiIGhlaWdodD0iMjYiIHZpZXdCb3g9IjAgMCAyNiAyNiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPGNpcmNsZSBjeD0iMTMiIGN5PSIxMyIgcj0iMTMiIGZpbGw9IndoaXRlIi8+CjxwYXRoIGQ9Ik0xNy45NTIgOS4xODQwMkMxNy45NTIgMTAuMjU2IDE3LjgxNiAxMS4wNzIgMTcuNTQ0IDExLjYzMkMxNy4yODggMTIuMTkyIDE2Ljc1MiAxMi43OTIgMTUuOTM2IDEzLjQzMkMxNS4xMiAxNC4wNzIgMTQuNTc2IDE0LjU4NCAxNC4zMDQgMTQuOTY4QzE0LjA0OCAxNS4zMzYgMTMuOTIgMTUuNzM2IDEzLjkyIDE2LjE2OFYxNi45NkgxMS44MDhDMTEuNDI0IDE2LjQ2NCAxMS4yMzIgMTUuODQgMTEuMjMyIDE1LjA4OEMxMS4yMzIgMTQuNjg4IDExLjM4NCAxNC4yODggMTEuNjg4IDEzLjg4OEMxMS45OTIgMTMuNDg4IDEyLjUzNiAxMi45NjggMTMuMzIgMTIuMzI4QzE0LjEwNCAxMS42NzIgMTQuNjI0IDExLjE2OCAxNC44OCAxMC44MTZDMTUuMTM2IDEwLjQ0OCAxNS4yNjQgOS45NjgwMiAxNS4yNjQgOS4zNzYwMkMxNS4yNjQgOC4yMDgwMiAxNC40MTYgNy42MjQwMiAxMi43MiA3LjYyNDAyQzExLjc2IDcuNjI0MDIgMTAuNzUyIDcuNzM2MDIgOS42OTYgNy45NjAwMkw5LjE0NCA4LjA4MDAyTDkgNi4wODgwMkMxMC40ODggNS41NjAwMiAxMS44NCA1LjI5NjAyIDEzLjA1NiA1LjI5NjAyQzE0LjczNiA1LjI5NjAyIDE1Ljk2OCA1LjYwODAyIDE2Ljc1MiA2LjIzMjAyQzE3LjU1MiA2Ljg0MDAyIDE3Ljk1MiA3LjgyNDAyIDE3Ljk1MiA5LjE4NDAyWk0xMS40IDIyVjE4LjY0SDE0LjE4NFYyMkgxMS40WiIgZmlsbD0iIzU5NUU3NCIvPgo8L3N2Zz4K';

}