From 5f364f1b0432cc59e7ea568dcf1c68648d6b90e1 Mon Sep 17 00:00:00 2001 From: ymc9 <104139426+ymc9@users.noreply.github.com> Date: Sun, 9 Nov 2025 07:27:10 -0800 Subject: [PATCH 1/2] doc: add package migration to v2-migration doc --- .../_components/PackageUninstall.tsx | 30 +++++++++++++++++++ versioned_docs/version-3.x/migrate-v2.md | 13 ++++++++ 2 files changed, 43 insertions(+) create mode 100644 versioned_docs/version-3.x/_components/PackageUninstall.tsx diff --git a/versioned_docs/version-3.x/_components/PackageUninstall.tsx b/versioned_docs/version-3.x/_components/PackageUninstall.tsx new file mode 100644 index 00000000..b1b1a2ad --- /dev/null +++ b/versioned_docs/version-3.x/_components/PackageUninstall.tsx @@ -0,0 +1,30 @@ +import CodeBlock from '@theme/CodeBlock'; +import TabItem from '@theme/TabItem'; +import Tabs from '@theme/Tabs'; + +interface Props { + dependencies: string[]; +} + +const pkgManagers = [ + { name: 'npm', command: 'npm uninstall' }, + { name: 'pnpm', command: 'pnpm remove' }, + { name: 'bun', command: 'bun remove' }, + { name: 'yarn', command: 'yarn remove' }, +]; + +const PackageInstall = ({ dependencies }: Props) => { + return ( + + {pkgManagers.map((pkg) => ( + + + {`${dependencies?.length ? `${pkg.command} ${dependencies.join(' ')}` : ''}`} + + + ))} + + ); +}; + +export default PackageInstall; diff --git a/versioned_docs/version-3.x/migrate-v2.md b/versioned_docs/version-3.x/migrate-v2.md index 9e9a90aa..dc3592a8 100644 --- a/versioned_docs/version-3.x/migrate-v2.md +++ b/versioned_docs/version-3.x/migrate-v2.md @@ -4,6 +4,7 @@ sidebar_position: 11 --- import PackageInstall from './_components/PackageInstall'; +import PackageUninstall from './_components/PackageUninstall'; # Migrating From ZenStack V2 @@ -40,6 +41,18 @@ Here are a few essential items to verify before preparing your migration: Since ZenStack v3 is no longer based on Prisma ORM, the first step is to replace Prisma dependencies with ZenStack and update the code where `PrismaClient` is created. Please follow the [Prisma Migration Guide](./migrate-prisma.md) for detailed instructions. +## Migrating ZenStack Packages + +As you have seen in the [Prisma Migration Guide](./migrate-prisma.md), all v3 packages are published under the "@next" tag for now. Two most important packages have been renamed: + +- `zenstack`: the CLI package is now named `@zenstackhq/cli` +- `@zenstackhq/runtime`: the ORM runtime package is now named `@zenstackhq/orm` + +Make sure you replace them in your project. + + + + ## Migrating ZModel ### Access Control From 856ef19b2ba2bcd76284d83a21ed7984d2dfa47b Mon Sep 17 00:00:00 2001 From: ymc9 <104139426+ymc9@users.noreply.github.com> Date: Sun, 9 Nov 2025 07:29:58 -0800 Subject: [PATCH 2/2] update --- versioned_docs/version-3.x/_components/PackageUninstall.tsx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/versioned_docs/version-3.x/_components/PackageUninstall.tsx b/versioned_docs/version-3.x/_components/PackageUninstall.tsx index b1b1a2ad..1bbb70e7 100644 --- a/versioned_docs/version-3.x/_components/PackageUninstall.tsx +++ b/versioned_docs/version-3.x/_components/PackageUninstall.tsx @@ -13,7 +13,7 @@ const pkgManagers = [ { name: 'yarn', command: 'yarn remove' }, ]; -const PackageInstall = ({ dependencies }: Props) => { +const PackageUninstall = ({ dependencies }: Props) => { return ( {pkgManagers.map((pkg) => ( @@ -27,4 +27,4 @@ const PackageInstall = ({ dependencies }: Props) => { ); }; -export default PackageInstall; +export default PackageUninstall;