diff --git a/docs/vanilla.md b/docs/vanilla.md index 9374c89..ac759b4 100644 --- a/docs/vanilla.md +++ b/docs/vanilla.md @@ -32,7 +32,6 @@ Use {@link vanilla.MakeCodeFrameDriver | MakeCodeFrameDriver} class to create a ```js import { - Project, MakeCodeFrameDriver, createMakeCodeURL, } from "@microbit/makecode-embed/vanilla"; diff --git a/src/react/MakeCodeBlocksRendering.tsx b/src/react/MakeCodeBlocksRendering.tsx index ec20c0c..02319f3 100644 --- a/src/react/MakeCodeBlocksRendering.tsx +++ b/src/react/MakeCodeBlocksRendering.tsx @@ -4,11 +4,11 @@ */ import React, { useState, useEffect, ReactNode } from 'react'; import { useMakeCodeRenderBlocksContext } from './MakeCodeRenderBlocksProvider.js'; -import { BlockLayout, Project } from '../vanilla/pxt.js'; +import { BlockLayout, MakeCodeProject } from '../vanilla/pxt.js'; export interface MakeCodeBlocksRenderingProps { className?: string; - code?: string | Project; + code?: string | MakeCodeProject; packageId?: string; package?: string; snippetMode?: boolean; diff --git a/src/react/MakeCodeFrame.tsx b/src/react/MakeCodeFrame.tsx index fab7c4d..9f52aed 100644 --- a/src/react/MakeCodeFrame.tsx +++ b/src/react/MakeCodeFrame.tsx @@ -16,7 +16,7 @@ import { EditorMessageTutorialEventRequest, EditorWorkspaceSaveRequest, EditorWorkspaceSyncRequest, - Project, + MakeCodeProject, ProjectFilters, } from '../vanilla/pxt.js'; @@ -38,7 +38,7 @@ export interface MakeCodeFrameProps // https://github.com/microsoft/pxt-microbit/blob/master/pxtarget.json#L605C6-L605C14 queryParams?: Record; - initialProjects: () => Promise; + initialProjects: () => Promise; controllerId?: string; filters?: ProjectFilters; diff --git a/src/react/index.ts b/src/react/index.ts index be05503..4581050 100644 --- a/src/react/index.ts +++ b/src/react/index.ts @@ -42,7 +42,7 @@ export type { ImportProjectOptions, InfoMessage, LanguageRestriction, - Project, + MakeCodeProject, ProjectCreationOptions, ProjectFilters, RenderBlocksOptions, diff --git a/src/stories/MakeCodeToolbar.tsx b/src/stories/MakeCodeToolbar.tsx index 421b3c9..703ca5c 100644 --- a/src/stories/MakeCodeToolbar.tsx +++ b/src/stories/MakeCodeToolbar.tsx @@ -1,7 +1,7 @@ import { MutableRefObject, RefObject } from 'react'; import { MakeCodeFrameDriver } from '../vanilla/makecode-frame-driver.js'; import { defaultMakeCodeProject } from '../vanilla/examples.js'; -import { Project } from '../vanilla/pxt.js'; +import { MakeCodeProject } from '../vanilla/pxt.js'; const toolbarRowStyle = { fontFamily: 'sans-serif', @@ -16,7 +16,7 @@ const MakeCodeToolbar = ({ savedProjects, }: { driver: RefObject; - savedProjects: MutableRefObject>; + savedProjects: MutableRefObject>; }) => { return (
diff --git a/src/stories/fixtures.ts b/src/stories/fixtures.ts index aea6897..8dd8816 100644 --- a/src/stories/fixtures.ts +++ b/src/stories/fixtures.ts @@ -1,4 +1,4 @@ -import { Project } from '../vanilla/pxt.js'; +import { MakeCodeProject } from '../vanilla/pxt.js'; export const project = { text: { @@ -9,7 +9,7 @@ export const project = { 'pxt.json': '{\n "name": "Untitled",\n "dependencies": {\n "core": "*"\n , "radio": "*"\n },\n "description": "",\n "files": [\n "main.blocks",\n "main.ts",\n "README.md"\n ]\n}', }, -} as Project; +} as MakeCodeProject; export const projectWithLayout = { text: { @@ -63,9 +63,9 @@ export const projectWithLayout = { `, }, -} as Project; +} as MakeCodeProject; -export const projectWithExtensionBlock: Project = { +export const projectWithExtensionBlock: MakeCodeProject = { text: { 'README.md': '', 'main.blocks': @@ -136,7 +136,7 @@ export const initialProject = { }, }; -export const projectWithCustomBlock: Project = { +export const projectWithCustomBlock: MakeCodeProject = { text: { 'README.md': '', 'custom.ts': @@ -149,7 +149,7 @@ export const projectWithCustomBlock: Project = { }, }; -export const projectWithUserLayout: Project = { +export const projectWithUserLayout: MakeCodeProject = { text: { 'README.md': '', 'main.blocks': diff --git a/src/stories/react/MakeCodeBlocksRendering.stories.tsx b/src/stories/react/MakeCodeBlocksRendering.stories.tsx index 90c2a63..a094459 100644 --- a/src/stories/react/MakeCodeBlocksRendering.stories.tsx +++ b/src/stories/react/MakeCodeBlocksRendering.stories.tsx @@ -2,7 +2,7 @@ import { Meta, StoryObj } from '@storybook/react'; import { ReactNode, useState } from 'react'; import MakeCodeBlocksRendering from '../../react/MakeCodeBlocksRendering.js'; import { MakeCodeRenderBlocksProvider } from '../../react/MakeCodeRenderBlocksProvider.js'; -import { BlockLayout, Project } from '../../vanilla/pxt.js'; +import { BlockLayout, MakeCodeProject } from '../../vanilla/pxt.js'; import { initialProject, project, @@ -190,7 +190,7 @@ export const Robust: Story = { return ( - + ); @@ -229,7 +229,7 @@ export const EmptyToBlocksTransition: Story = { name: 'Empty to blocks transition', render: (args) => { const { version } = args; - const [project, setProject] = useState(initialProject); + const [project, setProject] = useState(initialProject); return (
diff --git a/src/stories/react/MakeCodeFrame.stories.tsx b/src/stories/react/MakeCodeFrame.stories.tsx index 627337c..e41b196 100644 --- a/src/stories/react/MakeCodeFrame.stories.tsx +++ b/src/stories/react/MakeCodeFrame.stories.tsx @@ -6,7 +6,7 @@ import { default as MakeCodeFrame, MakeCodeFrameProps, } from '../../react/MakeCodeFrame.js'; -import { Project } from '../../vanilla/pxt.js'; +import { MakeCodeProject } from '../../vanilla/pxt.js'; import { controllerId } from '../config.js'; import StoryWrapper from '../StoryWrapper.js'; import MakeCodeToolbar from '../MakeCodeToolbar.js'; @@ -30,7 +30,7 @@ type Story = StoryObj; const MakeCodeEditorWithControls = ( props: Omit ) => { - const savedProjects = useRef>(new Map()); + const savedProjects = useRef>(new Map()); const ref = useRef(null); const initialProjects = useCallback(async () => { if (savedProjects.current.size === 0) { diff --git a/src/stories/vanilla/makecode-frame-driver.stories.tsx b/src/stories/vanilla/makecode-frame-driver.stories.tsx index e1b4b69..1dac623 100644 --- a/src/stories/vanilla/makecode-frame-driver.stories.tsx +++ b/src/stories/vanilla/makecode-frame-driver.stories.tsx @@ -6,7 +6,7 @@ import { MakeCodeFrameDriver, Options, } from '../../vanilla/makecode-frame-driver.js'; -import { Project } from '../../vanilla/pxt.js'; +import { MakeCodeProject } from '../../vanilla/pxt.js'; import MakeCodeToolbar from '../MakeCodeToolbar.js'; import StoryWrapper from '../StoryWrapper.js'; @@ -17,7 +17,7 @@ interface StoryArgs { controller?: 1 | 2; queryParams?: Record; }; - project?: Project; + project?: MakeCodeProject; callbacks?: Partial; } @@ -30,7 +30,7 @@ export default meta; type Story = StoryObj; const renderEditor = (args: StoryArgs) => { - const savedProjects = useRef>(new Map()); + const savedProjects = useRef>(new Map()); const ref = useRef(null); const cbRef = (div: HTMLElement | null) => { if (!div) { @@ -50,7 +50,7 @@ const renderEditor = (args: StoryArgs) => { iframe.height = '100%'; div.appendChild(iframe); - const savedProjects: Map = new Map(); + const savedProjects: Map = new Map(); // Create and initialise an instance of MakeCodeFrameDriver. ref.current = new MakeCodeFrameDriver( diff --git a/src/stories/vanilla/makecode-render-blocks.stories.tsx b/src/stories/vanilla/makecode-render-blocks.stories.tsx index ef0ba12..03bdd54 100644 --- a/src/stories/vanilla/makecode-render-blocks.stories.tsx +++ b/src/stories/vanilla/makecode-render-blocks.stories.tsx @@ -13,12 +13,12 @@ import { projectWithMelody, projectWithTwoExtensions, } from '../fixtures.js'; -import { Project } from '../../vanilla/pxt.js'; +import { MakeCodeProject } from '../../vanilla/pxt.js'; import StoryWrapper from '../StoryWrapper.js'; interface StoryArgs { options: MakeCodeRenderBlocksOptions | undefined; - project: Project; + project: MakeCodeProject; } const meta: Meta = { diff --git a/src/vanilla/examples.ts b/src/vanilla/examples.ts index 0bb4216..9f5bf1d 100644 --- a/src/vanilla/examples.ts +++ b/src/vanilla/examples.ts @@ -1,6 +1,6 @@ -import { Project } from './pxt.js'; +import { MakeCodeProject } from './pxt.js'; -export const defaultMakeCodeProject: Project = { +export const defaultMakeCodeProject: MakeCodeProject = { text: { 'main.blocks': '\n \n', @@ -11,7 +11,7 @@ export const defaultMakeCodeProject: Project = { }, }; -export const emptyMakeCodeProject: Project = { +export const emptyMakeCodeProject: MakeCodeProject = { text: { 'main.blocks': '\n \n', diff --git a/src/vanilla/index.ts b/src/vanilla/index.ts index 3a689ec..588d0bb 100644 --- a/src/vanilla/index.ts +++ b/src/vanilla/index.ts @@ -38,7 +38,7 @@ export type { LanguageRestriction, PackageConfig, PackageExtension, - Project, + MakeCodeProject, ProjectCreationOptions, ProjectFilters, ProjectTemplate, diff --git a/src/vanilla/makecode-frame-driver.ts b/src/vanilla/makecode-frame-driver.ts index 1358ffe..6fd7e57 100644 --- a/src/vanilla/makecode-frame-driver.ts +++ b/src/vanilla/makecode-frame-driver.ts @@ -29,7 +29,7 @@ import { ImportProjectOptions, InfoMessage, LanguageRestriction, - Project, + MakeCodeProject, ProjectCreationOptions, ProjectFilters, RenderBlocksOptions, @@ -64,7 +64,7 @@ export interface Options { * The projects will receive updates via `onWorkspaceSave` and should be stored keyed by header * id. */ - initialProjects: () => Promise; + initialProjects: () => Promise; /** * Set this to a value representing your app. diff --git a/src/vanilla/makecode-render-blocks.ts b/src/vanilla/makecode-render-blocks.ts index de9fd83..a868694 100644 --- a/src/vanilla/makecode-render-blocks.ts +++ b/src/vanilla/makecode-render-blocks.ts @@ -2,7 +2,7 @@ * MakeCode handling that does not depend on React. */ -import { BlockLayout, Project } from './pxt.js'; +import { BlockLayout, MakeCodeProject } from './pxt.js'; const disposedMessage = 'Disposed'; const makecodeFailedToLoadMessage = 'Failed to load MakeCode to render blocks.'; @@ -22,7 +22,7 @@ export interface MakeCodeRenderBlocksReturn { } export interface RenderBlocksRequest { - code: string | Project; + code: string | MakeCodeProject; options?: { packageId?: string; package?: string; @@ -68,7 +68,7 @@ interface RenderBlocksResponseMessage { type RequestInputType = 'text' | 'blocks'; interface RenderBlocksRequestResponse { - input: Project | string; + input: MakeCodeProject | string; sent: boolean; type: RequestInputType; req: RenderBlocksRequestMessage; @@ -129,7 +129,7 @@ export const createMakeCodeRenderBlocks = ( }; const findBestCode = ( - code: string | Project, + code: string | MakeCodeProject, ignoreBlocks?: boolean ): { type: RequestInputType; code: string } => { if (typeof code === 'string') { diff --git a/src/vanilla/pxt.ts b/src/vanilla/pxt.ts index 0f0183d..93953d2 100644 --- a/src/vanilla/pxt.ts +++ b/src/vanilla/pxt.ts @@ -86,7 +86,7 @@ export interface Header extends InstallHeader { export type ScriptText = Record; -export interface Project { +export interface MakeCodeProject { header?: Header; text?: ScriptText; } @@ -333,7 +333,7 @@ export interface EditorWorkspaceSyncResponse extends EditorMessageResponse { /* * Full list of project, required for init */ - projects: Project[]; + projects: MakeCodeProject[]; // (optional) filtering argument editor?: EditorSyncState; // (optional) controller id, used for determining what the parent controller is @@ -345,12 +345,12 @@ export interface EditorWorkspaceSaveRequest extends EditorMessageRequest { /* * Modified project */ - project: Project; + project: MakeCodeProject; } export interface ImportProjectOptions { // project to load - project: Project; + project: MakeCodeProject; // (optional) filtering argument filters?: ProjectFilters; searchBar?: boolean; @@ -364,7 +364,7 @@ export interface EditorMessageImportProjectRequest export interface ImportExternalProjectOptions { // project to load - project: Project; + project: MakeCodeProject; } export interface EditorMessageImportExternalProjectRequest