@bitrise/bitkit-v2 0.3.223 → 0.3.224

package/README.md

@@ -37,28 +37,40 @@ The hosted Storybook itself is browsable at <https://storybook.services.bitrise.
 - **Built with Chakra UI v3**: Latest Chakra UI features and performance
 - **TypeScript**: Full TypeScript support with auto-generated types
 - **Self-hosted Fonts**: Figtree and Source Code Pro bundled via BitkitProvider
-- **Simple Installation**: Just `npm install @bitrise/bitkit-v2`
+- **Pinned Peer Dependencies**: Bitkit declares Chakra, Emotion and the Chakra CLI as pinned peers so your tree stays deduped
 
 ## Installation
 
 ```bash
-npm install @bitrise/bitkit-v2
+# Runtime peers — required for Bitkit to render
+npm install @bitrise/bitkit-v2 @chakra-ui/react@3.35.0 @emotion/react@11.14.0 @emotion/styled@11.14.1
+
+# Build-time peer — required so the bundled postinstall hook can generate bitkit-specific theme typings
+npm install --save-dev @chakra-ui/cli@3.35.0
 ```
 
-Chakra UI and Emotion are included as regular runtime dependencies of this package, so you do not need to install them separately.
+Chakra UI and Emotion are declared as peer dependencies so the host app owns the single copy of Chakra in the tree. Install them at the exact versions Bitkit pins — any other version (including patch bumps like `3.35.1`) triggers a peer mismatch warning, and a different minor/major may also cause runtime API incompatibility against Bitkit's compiled output. Duplicate Chakra installs only show up if some other transitive dependency drags in a different Chakra version on top of the drift, but when they do they silently break `BitkitProvider`'s theme context, which is exactly the failure mode pinned peers protect against.
+
+`@chakra-ui/cli` is a peer too — Bitkit's `postinstall` hook uses it to generate Chakra theme typings into your project's `node_modules`. Install it as a devDependency in the host app so the hook can find it.
+
+> **Production-only installs (`npm ci --omit=dev`, `pnpm install --prod`, etc.):** because `@chakra-ui/cli` is conventionally installed in the host's `devDependencies`, it will be skipped — your package manager may emit an unmet-peer warning or, with strict peer enforcement (e.g. pnpm's `strict-peer-dependencies=true`), fail the install. The bundled `postinstall` hook itself detects the missing CLI, prints a notice and exits cleanly. Theme typings are a development-time concern, so production environments don't need the CLI; if your prod install is configured for strict peers, either set `strict-peer-dependencies=false` for the deploy step, allow-list `@chakra-ui/cli` as a missing peer, or install the CLI as a regular dependency instead of a devDependency.
 
 ### Requirements
 
 - React 18+ (peer dependency)
 - React DOM 18+ (peer dependency)
+- `@chakra-ui/react` 3.35.0 (peer dependency, pinned)
+- `@emotion/react` 11.14.0 (peer dependency, pinned)
+- `@emotion/styled` 11.14.1 (peer dependency, pinned)
+- `@chakra-ui/cli` 3.35.0 (peer dependency, pinned — used by the bundled `postinstall` typegen hook; install as a devDependency in the host app)
 
 ### Theme typings
 
 Bitkit ships a Chakra UI v3 theme with custom recipes, semantic tokens, and design tokens. For TypeScript autocompletion to recognize bitkit-specific values (e.g. `<BitkitButton variant="ai-primary">`, `colors.purple.60`), Chakra's typegen must run in your project's `node_modules` after install.
 
-This happens automatically via a `postinstall` hook bundled with the package — no setup is required for standard npm installs.
+This happens automatically via a `postinstall` hook bundled with the package, as long as `@chakra-ui/cli` is installed in the host app (it's declared as a peer dependency for this reason).
 
-If the postinstall is skipped (e.g. you ran `npm install --ignore-scripts`, or a CI runner blocks lifecycle scripts), regenerate the typings manually:
+If the postinstall is skipped (e.g. `@chakra-ui/cli` is not installed, you ran `npm install --ignore-scripts`, or a CI runner blocks lifecycle scripts), regenerate the typings manually:
 
 ```bash
 npx chakra typegen node_modules/@bitrise/bitkit-v2/dist/theme/index.js

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@bitrise/bitkit-v2",
   "private": false,
-  "version": "0.3.223",
+  "version": "0.3.224",
   "description": "Bitrise Design System Components built with Chakra UI V3",
   "keywords": [
     "react",
@@ -56,11 +56,19 @@
     "postinstall": "node ./scripts/postinstall.cjs"
   },
   "peerDependencies": {
+    "@chakra-ui/cli": "3.35.0",
+    "@chakra-ui/react": "3.35.0",
+    "@emotion/react": "11.14.0",
+    "@emotion/styled": "11.14.1",
     "react": ">=18",
     "react-dom": ">=18"
   },
   "devDependencies": {
     "@bitrise/eslint-plugin": "^4.1.0",
+    "@chakra-ui/cli": "3.35.0",
+    "@chakra-ui/react": "3.35.0",
+    "@emotion/react": "11.14.0",
+    "@emotion/styled": "11.14.1",
     "@figma-export/cli": "^6.4.0",
     "@figma-export/output-components-as-svg": "^6.4.0",
     "@figma-export/transform-svg-with-svgo": "^6.4.0",
@@ -85,10 +93,6 @@
     "vite-plugin-svgr": "^5.2.0"
   },
   "dependencies": {
-    "@chakra-ui/cli": "^3.35.0",
-    "@chakra-ui/react": "^3.35.0",
-    "@emotion/react": "^11.14.0",
-    "@emotion/styled": "^11.14.1",
     "@fontsource-variable/figtree": "^5.2.10",
     "@fontsource-variable/source-code-pro": "^5.2.7",
     "es-toolkit": "^1.46.1",