From 7f1f45fc8df8237a63e4bc859d76516f6ca87f9e Mon Sep 17 00:00:00 2001 From: Pedro Ferreira <10789765+apedroferreira@users.noreply.github.com> Date: Tue, 6 Aug 2024 10:57:38 +0100 Subject: [PATCH] v0.5.0 (#3898) Co-authored-by: MUI bot <2109932+Janpot@users.noreply.github.com> --- CHANGELOG.md | 48 ++++++++++++++++++- docs/package.json | 2 +- lerna.json | 2 +- packages/create-toolpad-app/package.json | 2 +- packages/create-toolpad-app/src/index.ts | 22 +++++++-- .../create-toolpad-app/tests/index.spec.ts | 2 +- .../eslint-plugin-material-ui/package.json | 2 +- packages/toolpad-core/package.json | 2 +- .../toolpad-studio-components/package.json | 2 +- packages/toolpad-studio-runtime/package.json | 2 +- packages/toolpad-studio/package.json | 2 +- packages/toolpad-utils/package.json | 2 +- playground/nextjs-pages/package.json | 4 +- playground/nextjs/package.json | 2 +- pnpm-lock.yaml | 4 +- test/package.json | 2 +- 16 files changed, 82 insertions(+), 20 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b1696ae2f26..ab8f7b24e6f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,52 @@ # Changelog -## 0.4.0 +## v0.5.0 + + + +_Aug 5, 2024_ + +A big thanks to the 4 contributors who made this release possible. Here are some highlights ✨: + +This is the first production-ready release of Toolpad Core! This version includes: + +- A new SignInPage component +- Updates to the `create-toolpad-app` CLI to bootstrap Toolpad Core projects +- Many documentation updates and improvements + +### Breaking Changes + +The `create-toolpad-app` CLI now by default bootstraps a Toolpad Core project. + +Please use the `--studio` flag to generate a Toolpad Studio project. + +### `@toolpad/core` + +- ​ Add authentication to Toolpad Core (#3609) @bharatkashyap +- ​ Make Core the default project (#3868) @bharatkashyap +- ​ Make navigation item segments optional (#3838) @apedroferreira +- ​ Ensure Material UI v5 compatibility (#3894) @Janpot +- ​ Bring in some fixes from the next update branch (#3866) @Janpot + +### Docs + +- ​ Improve DashboardLayout navigation docs (#3864) @apedroferreira +- ​ Fix Core example (#3847) @bharatkashyap +- ​ Fix issues with DashboardLayout in Toolpad Core homepage (#3893) @apedroferreira +- ​ Fix grid layout in examples (#3848) @Janpot +- ​ Fix missing Studio examples grid (#3897) @bharatkashyap +- ​ Add PageContainer content and make the theme follow the docs theme (#3895) @Janpot +- ​ Improve Core tutorial (#3874) @bharatkashyap +- ​ Core docs edits (#3844) @prakhargupta1 + +### Core + +- ​ Upgrade `inquirer` to `@inquirer/prompts` (#3843) @bharatkashyap +- ​ Export `@mui/toolpad/internals` (#3873) @Janpot + +All contributors of this release in alphabetical order: @apedroferreira, @bharatkashyap, @Janpot, @prakhargupta1 + +## v0.4.0 diff --git a/docs/package.json b/docs/package.json index d0f860b6a6b..495945112bc 100644 --- a/docs/package.json +++ b/docs/package.json @@ -1,6 +1,6 @@ { "name": "docs", - "version": "0.4.0", + "version": "0.5.0", "private": true, "author": "MUI Toolpad", "license": "MIT", diff --git a/lerna.json b/lerna.json index 8e5596fd808..513ad8270fe 100644 --- a/lerna.json +++ b/lerna.json @@ -1,5 +1,5 @@ { "$schema": "node_modules/lerna/schemas/lerna-schema.json", - "version": "0.4.0", + "version": "0.5.0", "npmClient": "pnpm" } diff --git a/packages/create-toolpad-app/package.json b/packages/create-toolpad-app/package.json index edc2e44d9b0..5d85bd62d15 100644 --- a/packages/create-toolpad-app/package.json +++ b/packages/create-toolpad-app/package.json @@ -1,6 +1,6 @@ { "name": "create-toolpad-app", - "version": "0.4.0", + "version": "0.5.0", "keywords": [ "react", "toolpad", diff --git a/packages/create-toolpad-app/src/index.ts b/packages/create-toolpad-app/src/index.ts index b8e6ac01ac5..66f33ba3be2 100644 --- a/packages/create-toolpad-app/src/index.ts +++ b/packages/create-toolpad-app/src/index.ts @@ -171,7 +171,14 @@ const scaffoldStudioProject = async (absolutePath: string, installFlag: boolean) } }; -const scaffoldCoreProject = async (absolutePath: string): Promise => { +interface ScaffoldProjectOptions { + coreVersion?: string; +} + +const scaffoldCoreProject = async ( + absolutePath: string, + { coreVersion }: ScaffoldProjectOptions = {}, +): Promise => { // eslint-disable-next-line no-console console.log(); // eslint-disable-next-line no-console @@ -181,7 +188,10 @@ const scaffoldCoreProject = async (absolutePath: string): Promise => { // eslint-disable-next-line no-console console.log(); const pkg = await findCtaPackageJson(); - const files = generateProject({ name: path.basename(absolutePath), version: pkg.version }); + const files = generateProject({ + name: path.basename(absolutePath), + version: coreVersion || pkg.version, + }); await writeFiles(absolutePath, files); // eslint-disable-next-line no-console @@ -237,6 +247,10 @@ const run = async () => { describe: 'Install dependencies', default: true, }) + .option('core-version', { + type: 'string', + describe: 'Use a specific version of Toolpad Core', + }) .option('example', { type: 'string', describe: @@ -297,7 +311,9 @@ const run = async () => { await scaffoldStudioProject(absolutePath, installFlag); } else { // Otherwise, create a new project with Toolpad Core - await scaffoldCoreProject(absolutePath); + await scaffoldCoreProject(absolutePath, { + coreVersion: args.coreVersion, + }); } const changeDirectoryInstruction = diff --git a/packages/create-toolpad-app/tests/index.spec.ts b/packages/create-toolpad-app/tests/index.spec.ts index d901d5e9a38..b1fbcee2a47 100644 --- a/packages/create-toolpad-app/tests/index.spec.ts +++ b/packages/create-toolpad-app/tests/index.spec.ts @@ -97,7 +97,7 @@ test( 'create-toolpad-app can bootstrap a Toolpad Core app', async () => { testDir = await fs.mkdtemp(path.resolve(os.tmpdir(), './test-app-')); - cp = execa(cliPath, [testDir], { + cp = execa(cliPath, [testDir, '--coreVersion', 'latest'], { cwd: currentDirectory, }); cp.stdout?.pipe(process.stdout); diff --git a/packages/eslint-plugin-material-ui/package.json b/packages/eslint-plugin-material-ui/package.json index d977cf29aa6..43b75206d0f 100644 --- a/packages/eslint-plugin-material-ui/package.json +++ b/packages/eslint-plugin-material-ui/package.json @@ -1,6 +1,6 @@ { "name": "eslint-plugin-material-ui", - "version": "0.4.0", + "version": "0.5.0", "private": true, "description": "Custom eslint rules for MUI.", "main": "src/index.js", diff --git a/packages/toolpad-core/package.json b/packages/toolpad-core/package.json index c1550b11fff..c8ca48c16a9 100644 --- a/packages/toolpad-core/package.json +++ b/packages/toolpad-core/package.json @@ -1,6 +1,6 @@ { "name": "@toolpad/core", - "version": "0.4.0", + "version": "0.5.0", "author": "Toolpad Team", "description": "Dashboard framework powered by MUI.", "main": "./build/index.js", diff --git a/packages/toolpad-studio-components/package.json b/packages/toolpad-studio-components/package.json index 80b9a761f74..bee045d107f 100644 --- a/packages/toolpad-studio-components/package.json +++ b/packages/toolpad-studio-components/package.json @@ -1,6 +1,6 @@ { "name": "@toolpad/studio-components", - "version": "0.4.0", + "version": "0.5.0", "description": "Build MUI apps quickly", "author": "MUI Toolpad team", "homepage": "https://github.com/mui/mui-toolpad#readme", diff --git a/packages/toolpad-studio-runtime/package.json b/packages/toolpad-studio-runtime/package.json index 6e73bc4722b..b423bdd3d53 100644 --- a/packages/toolpad-studio-runtime/package.json +++ b/packages/toolpad-studio-runtime/package.json @@ -1,6 +1,6 @@ { "name": "@toolpad/studio-runtime", - "version": "0.4.0", + "version": "0.5.0", "description": "Build MUI apps quickly", "author": "MUI Toolpad team", "homepage": "https://github.com/mui/mui-toolpad#readme", diff --git a/packages/toolpad-studio/package.json b/packages/toolpad-studio/package.json index e8aed922cb7..f752e3e5879 100644 --- a/packages/toolpad-studio/package.json +++ b/packages/toolpad-studio/package.json @@ -1,6 +1,6 @@ { "name": "@toolpad/studio", - "version": "0.4.0", + "version": "0.5.0", "license": "MIT", "bin": { "toolpad-studio": "./cli.mjs" diff --git a/packages/toolpad-utils/package.json b/packages/toolpad-utils/package.json index 55315162aef..ecd386f2d20 100644 --- a/packages/toolpad-utils/package.json +++ b/packages/toolpad-utils/package.json @@ -1,6 +1,6 @@ { "name": "@toolpad/utils", - "version": "0.4.0", + "version": "0.5.0", "description": "Shared utilities used by Toolpad packages.", "author": "MUI Toolpad team", "homepage": "https://github.com/mui/mui-toolpad#readme", diff --git a/playground/nextjs-pages/package.json b/playground/nextjs-pages/package.json index 2325c25580c..b5fd4c2d52b 100644 --- a/playground/nextjs-pages/package.json +++ b/playground/nextjs-pages/package.json @@ -1,6 +1,6 @@ { "name": "playground-nextjs-pages", - "version": "0.4.0", + "version": "0.5.0", "private": true, "scripts": { "dev": "next dev", @@ -12,12 +12,12 @@ "@mui/icons-material": "5.16.4", "@mui/material": "5.16.4", "@mui/material-nextjs": "5.16.4", - "next-auth": "beta", "@toolpad/core": "workspace:*", "@types/react": "18.3.3", "@types/react-dom": "18.3.0", "eslint-config-next": "14.2.5", "next": "14.2.5", + "next-auth": "beta", "react": "18.3.1", "react-dom": "18.3.1" } diff --git a/playground/nextjs/package.json b/playground/nextjs/package.json index c810313af96..094df867cdb 100644 --- a/playground/nextjs/package.json +++ b/playground/nextjs/package.json @@ -1,6 +1,6 @@ { "name": "playground-nextjs", - "version": "0.4.0", + "version": "0.5.0", "private": true, "scripts": { "dev": "next dev", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index c11434be266..2914cd39d54 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -2071,7 +2071,7 @@ packages: resolution: {integrity: sha512-AAH4lEkpmzFWrGVlHaxJB7RLH21uPQ9+He+eFLWHmF9IuFQVugz8eAsamaW0DXRrTfco5zj1wWtpdcXJUOfsag==} engines: {node: '>=6.9.0'} peerDependencies: - '@babel/core': ^7.24.8 + '@babel/core': ^7.0.0-0 '@babel/preset-typescript@7.24.7': resolution: {integrity: sha512-SyXRe3OdWwIwalxDg5UtJnJQO+YPcTfwiIY2B0Xlddh9o7jpWLvv8X1RthIeDOxQ+O1ML5BLPCONToObyVQVuQ==} @@ -2144,7 +2144,7 @@ packages: '@docsearch/react@3.6.0': resolution: {integrity: sha512-HUFut4ztcVNmqy9gp/wxNbC7pTOHhgVVkHVGCACTuLhUKUhKAF9KYHJtMiLUJxEqiFLQiuri1fWF8zqwM/cu1w==} peerDependencies: - '@types/react': 18.3.3 + '@types/react': '>= 16.8.0 < 19.0.0' react: '>= 16.8.0 < 19.0.0' react-dom: '>= 16.8.0 < 19.0.0' search-insights: '>= 1 < 3' diff --git a/test/package.json b/test/package.json index 0026ebd549f..66dc2f47b4c 100644 --- a/test/package.json +++ b/test/package.json @@ -14,5 +14,5 @@ "recharts": "alpha" }, "type": "module", - "version": "0.4.0" + "version": "0.5.0" }