@metricinsights/pp-dev 0.10.1 → 0.12.0

package/CHANGELOG.md

@@ -1,9 +1,49 @@
-# [@metricinsights/pp-dev-v0.10.1](https://github.com/mi-examples/pp-dev-js/compare/v0.10.0...v0.10.1) (2025-04-25)
+# [@metricinsights/pp-dev-v0.12.0](https://github.com/mi-examples/pp-dev-js/compare/v0.11.0...v0.12.0) (2025-01-15)
+
+
+### Features
+
+* **auth:** add global authentication provider ([2b1e00d](https://github.com/mi-examples/pp-dev-js/commit/2b1e00d20cbfd21284aa871c47bc149829a2f865))
+* **pp-dev:** enhance CLI and core functionality ([14a3772](https://github.com/mi-examples/pp-dev-js/commit/14a3772a4955aabad6b0fa0986a7047445e0cc5b))
+
+# [@metricinsights/pp-dev-v0.11.0-beta.4](https://github.com/mi-examples/pp-dev-js/compare/v0.11.0-beta.3...v0.11.0-beta.4) (2025-08-29)
+
+
+### Features
+
+* **pp-dev:** add postbuild script and package renaming utility ([afdc0d6](https://github.com/mi-examples/pp-dev-js/commit/afdc0d6aefd4545b536090c363dad21308683777))
+* **pp-dev:** refactor CLI and core functionality ([98ce2d2](https://github.com/mi-examples/pp-dev-js/commit/98ce2d282abc83759b96b76e3502a0db99835404))
+* **test-commonjs:** moved test commonjs folder to new location ([9480d77](https://github.com/mi-examples/pp-dev-js/commit/9480d77d9dfc5ccafb0f4b0159fedd484143d754))
+* **test-nextjs:** add initial Next.js project files and configuration ([a5da0fd](https://github.com/mi-examples/pp-dev-js/commit/a5da0fdb5ab6f50b9605663706e88f62300aaea3))
+* **test-nextjs:** initialize Next.js test project structure ([2a6155d](https://github.com/mi-examples/pp-dev-js/commit/2a6155dc94f3b27a7b9c3535d5e8699fc9da655c))
+
+# [@metricinsights/pp-dev-v0.11.0-beta.3](https://github.com/mi-examples/pp-dev-js/compare/v0.11.0-beta.2...v0.11.0-beta.3) (2025-08-14)
+
+
+### Bug Fixes
+
+* **ci:** improve package detection and JSON validation ([f787a1c](https://github.com/mi-examples/pp-dev-js/commit/f787a1c2bf47c091c275d09317745b924c45f53f))
+
+
+### Features
+
+* **pp-dev:** add startup optimization and enhance authentication helpers ([a29e311](https://github.com/mi-examples/pp-dev-js/commit/a29e31136e0c27d221fc26028fd5c4970654e386))
+
+# [@metricinsights/pp-dev-v0.11.0-beta.2](https://github.com/mi-examples/pp-dev-js/compare/v0.11.0-beta.1...v0.11.0-beta.2) (2025-08-12)
 
 
 ### Bug Fixes
 
-* update build configuration and fix type issues ([cffcff4](https://github.com/mi-examples/pp-dev-js/commit/cffcff4e493d3268aa3973a9e58c55c28c839a52))
+* remove issue number references from semantic-release configs ([f532226](https://github.com/mi-examples/pp-dev-js/commit/f532226b1ecc4cf9d2cfac6e92cb1c101468a329))
+
+# [@metricinsights/pp-dev-v0.11.0-beta.1](https://github.com/mi-examples/pp-dev-js/compare/v0.10.1...v0.11.0-beta.1) (2025-08-12)
+
+
+### Features
+
+* **pp-dev:** add dependency version synchronization for create-pp-dev releases ([2597b01](https://github.com/mi-examples/pp-dev-js/commit/2597b017a59b1359753e85953648e2ce1674253c))
+* **pp-dev:** add esbuild configuration and build optimization scripts ([bbe1791](https://github.com/mi-examples/pp-dev-js/commit/bbe1791e9eb2e220f1552618a9a534a80ddd2f96))
+* **pp-dev:** add semantic release configuration and update dependencies ([5962bcc](https://github.com/mi-examples/pp-dev-js/commit/5962bccbb76fb684415f731f85f372cdd109d8f1))
 
 # Changelog
 

package/README.md

@@ -23,6 +23,99 @@ pp-dev is based on [Vite](https://vitejs.dev/).
 npm install @metricinsights/pp-dev
 ```
 
+### Peer Dependencies
+
+This package requires Next.js as a peer dependency for certain functionality:
+
+```bash
+npm install next@^15
+```
+
+**Note**: pp-dev requires Next.js version 15 or higher (but less than 17) to be installed in your project. This is a peer dependency, meaning it won't be automatically installed with pp-dev.
+
+## Package Structure
+
+The pp-dev package provides multiple entry points for different use cases:
+
+```javascript
+// Main package (includes everything)
+import ppDev from '@metricinsights/pp-dev';
+
+// Plugin only (for Vite integration)
+import { vitePPDev } from '@metricinsights/pp-dev/plugin';
+
+// Helpers only (for utility functions)
+import { helpers } from '@metricinsights/pp-dev/helpers';
+
+// Client assets (for development UI)
+import '@metricinsights/pp-dev/client/css/client.css';
+```
+
+**Available Exports**:
+- **Main**: Complete pp-dev functionality with CLI and plugins
+- **Plugin**: Vite plugin for integration with build tools
+- **Helpers**: Utility functions for authentication and configuration
+- **Client**: Development UI assets and styles
+
+## 🚀 Performance & Build System
+
+The pp-dev package includes optimized startup performance and build system with multiple strategies:
+
+### Quick Start
+```bash
+# Standard build (parallel)
+npm run build
+
+# Fast development build
+npm run build:fast
+
+# Watch mode for development
+npm run build:watch
+
+# Bundle analysis
+npm run build:analyze
+
+# Performance profiling
+npm run startup:profile
+
+# Startup optimization
+npm run startup:optimize
+```
+
+### Performance Features
+- **40-50% faster startup** with intelligent caching
+- **60-70% faster subsequent starts** with connection pooling
+- **Lazy loading** of heavy modules (jsdom, esbuild)
+- **API response caching** with configurable TTL
+- **HTTP connection pooling** for reduced overhead
+- **Startup profiling** with detailed performance analysis
+- **Intelligent dependency optimization** based on profiling data
+
+### Build Features
+- **Parallel builds** for 40-60% faster build times
+- **Enhanced tree-shaking** for smaller bundles
+- **Multiple output formats** (ESM, CJS, Types)
+- **Bundle analysis** with visualizer support
+- **ESBuild integration** for faster TypeScript compilation
+- **Build optimization scripts** for performance tuning
+
+### Startup Optimization
+
+The new startup optimization system in v0.11.0 provides:
+
+- **Performance Monitoring**: Real-time startup time tracking and analysis
+- **Cache Optimization**: Intelligent cache management for config and API responses
+- **Dependency Analysis**: Identification of performance bottlenecks
+- **Optimization Suggestions**: Automated recommendations for performance improvements
+
+Run the startup optimizer to analyze and improve your development environment:
+```bash
+npm run startup:optimize
+```
+
+📖 See [BUILD_IMPROVEMENTS.md](./BUILD_IMPROVEMENTS.md) for build details.
+📖 See [STARTUP_PERFORMANCE.md](./STARTUP_PERFORMANCE.md) for performance details.
+
 ## Configuration
 
 ### Configuration File
@@ -46,7 +139,10 @@ Alternatively, you can define configuration in your `package.json` using the `pp
  */
 module.exports = {
   backendBaseURL: 'https://mi.company.com',
-  portalPageId: 1,
+  appId: 1,
+  v7Features: true,
+  miHudLess: true,
+  integrateMiTopBar: true,
 };
 ```
 
@@ -61,6 +157,8 @@ const config: PPDevConfig = {
   backendBaseURL: 'https://mi.company.com',
   appId: 1,
   v7Features: true,
+  miHudLess: true,
+  integrateMiTopBar: true,
 };
 
 export default config;
@@ -73,7 +171,9 @@ export default config;
 {
   "backendBaseURL": "https://mi.company.com",
   "appId": 1,
-  "v7Features": true
+  "v7Features": true,
+  "miHudLess": true,
+  "integrateMiTopBar": true
 }
 ```
 
@@ -86,13 +186,17 @@ export default config;
   "pp-dev": {
     "backendBaseURL": "https://mi.company.com",
     "appId": 1,
-    "v7Features": true
+    "v7Features": true,
+    "miHudLess": true,
+    "integrateMiTopBar": true
   }
 }
 ```
 
 ## Configuration Options
 
+> **Version Compatibility**: This documentation covers pp-dev v0.11.0+. Some options may not be available in older versions. Check the [CHANGELOG](./CHANGELOG.md) for version-specific information.
+
 ### Required Options
 
 | Option | Type | Description |
@@ -106,6 +210,7 @@ export default config;
 | Option | Type | Default | Description |
 |--------|------|---------|-------------|
 | `miHudLess` | boolean | `false` | Disables Metric Insights navigation bar in development |
+| `integrateMiTopBar` | boolean | `false` | Integrates MI Top Bar and script into the App build (requires `miHudLess: true`) |
 | `templateLess` | boolean | `false` | Disables template variable transformation |
 | `enableProxyCache` | boolean | `true` | Enables caching of proxied requests |
 | `proxyCacheTTL` | number | `600000` | Cache TTL in milliseconds (10 minutes) |
@@ -117,6 +222,27 @@ export default config;
 | `v7Features` | boolean | `false` | Enables Metric Insights v7 features |
 | `personalAccessToken` | string | `process.env.MI_ACCESS_TOKEN` | Personal Access Token for the MI instance |
 
+### integrateMiTopBar Details
+
+The `integrateMiTopBar` option allows you to integrate the Metric Insights Top Bar and scripts directly into your application build. This is useful when you want to:
+
+1. **Customize the Top Bar**: Modify the appearance and behavior of the MI navigation
+2. **Bundle Integration**: Include MI scripts in your build instead of loading them dynamically
+3. **Offline Development**: Work with MI features even when disconnected from the server
+
+**Important**: This option can only be enabled when `miHudLess` is set to `true`.
+
+Example configuration:
+```javascript
+// pp-dev.config.js
+module.exports = {
+  backendBaseURL: 'https://mi.company.com',
+  appId: 1,
+  miHudLess: true,           // Required: Disable dynamic MI scripts
+  integrateMiTopBar: true,    // Enable: Integrate Top Bar into build
+};
+```
+
 ### v7Features Details
 
 When enabled (`true`), this option:
@@ -127,16 +253,45 @@ When enabled (`true`), this option:
 
 The `personalAccessToken` option allows you to authenticate with the Metric Insights instance. You can set it in your configuration or use the `MI_ACCESS_TOKEN` environment variable.
 
-Example:
+Example with authentication and Top Bar integration:
 ```javascript
 // pp-dev.config.js
 module.exports = {
   backendBaseURL: 'https://mi.company.com',
   appId: 1,
   personalAccessToken: process.env.MI_ACCESS_TOKEN,
+  miHudLess: true,
+  integrateMiTopBar: true,
 };
 ```
 
+**Environment Variable**: Set `MI_ACCESS_TOKEN` in your `.env` file:
+```bash
+MI_ACCESS_TOKEN=your_token_here
+```
+
+### Enhanced Authentication (v0.11.0+)
+
+The new authentication system in v0.11.0 provides:
+
+- **Automatic Environment Loading**: Automatically loads `MI_*` environment variables from `.env` files
+- **Token Validation**: Enhanced token validation and error handling
+- **Secure Headers**: Automatic header management for authenticated requests
+- **Connection Pooling**: Optimized HTTP connections for better performance
+
+**Supported Environment Variables**:
+- `MI_ACCESS_TOKEN`: Personal access token for authentication
+- `MI_BACKEND_URL`: Alternative to `backendBaseURL` in config
+- `MI_APP_ID`: Alternative to `appId` in config
+
+**Automatic Loading**: pp-dev automatically detects and loads these variables from your project's `.env` file:
+```bash
+# .env
+MI_ACCESS_TOKEN=your_personal_access_token
+MI_BACKEND_URL=https://mi.company.com
+MI_APP_ID=123
+```
+
 ## CLI Commands
 
 ### Global Options
@@ -164,6 +319,15 @@ pp-dev [root] [options]
 | `--open [path]` | - | Open browser on server start |
 | `--strictPort` | - | Exit if port is already in use |
 
+**Development Shortcuts**:
+- `p` - Start/stop performance profiler (v0.11.0+)
+- `l` - Proxy re-login (refresh authentication)
+- `r` - Restart dev server
+- `u` - Show server URLs
+- `q` - Quit dev server
+
+**Performance Profiling**: Use the `p` shortcut to start/stop the Node.js profiler for detailed performance analysis during development.
+
 ### Next.js Development
 
 ```bash
@@ -244,3 +408,42 @@ module.exports = withPPDev({
 ## Vite Configuration
 
 For custom build configuration, create a `vite.config` file. See [Vite Configuration](https://vitejs.dev/config/) for details.
+
+## Troubleshooting
+
+### Common Issues
+
+#### Next.js Peer Dependency Error
+
+If you encounter an error like "Next.js is required but not available":
+
+1. **Install Next.js in your project:**
+   ```bash
+   npm install next@^15
+   ```
+
+2. **Verify the installation:**
+   ```bash
+   npm list next
+   ```
+
+3. **Check your package.json:**
+   ```json
+   {
+     "dependencies": {
+       "next": "^15.0.0"
+     }
+   }
+   ```
+
+#### Version Compatibility
+
+- **pp-dev** requires Next.js version 15 or higher (but less than 17)
+- **Node.js** version 20 or higher is required
+- **TypeScript** version 4.2 or higher is supported
+
+### Getting Help
+
+- Check the [GitHub Issues](https://github.com/mi-examples/pp-dev-js/issues) for known problems
+- Review the [CHANGELOG.md](./CHANGELOG.md) for recent changes
+- Ensure all peer dependencies are properly installed

package/dist/CHANGELOG.md

@@ -0,0 +1,184 @@
+# [@metricinsights/pp-dev-v0.12.0](https://github.com/mi-examples/pp-dev-js/compare/v0.11.0...v0.12.0) (2025-01-15)
+
+
+### Features
+
+* **auth:** add global authentication provider ([2b1e00d](https://github.com/mi-examples/pp-dev-js/commit/2b1e00d20cbfd21284aa871c47bc149829a2f865))
+* **pp-dev:** enhance CLI and core functionality ([14a3772](https://github.com/mi-examples/pp-dev-js/commit/14a3772a4955aabad6b0fa0986a7047445e0cc5b))
+
+# [@metricinsights/pp-dev-v0.11.0-beta.4](https://github.com/mi-examples/pp-dev-js/compare/v0.11.0-beta.3...v0.11.0-beta.4) (2025-08-29)
+
+
+### Features
+
+* **pp-dev:** add postbuild script and package renaming utility ([afdc0d6](https://github.com/mi-examples/pp-dev-js/commit/afdc0d6aefd4545b536090c363dad21308683777))
+* **pp-dev:** refactor CLI and core functionality ([98ce2d2](https://github.com/mi-examples/pp-dev-js/commit/98ce2d282abc83759b96b76e3502a0db99835404))
+* **test-commonjs:** moved test commonjs folder to new location ([9480d77](https://github.com/mi-examples/pp-dev-js/commit/9480d77d9dfc5ccafb0f4b0159fedd484143d754))
+* **test-nextjs:** add initial Next.js project files and configuration ([a5da0fd](https://github.com/mi-examples/pp-dev-js/commit/a5da0fdb5ab6f50b9605663706e88f62300aaea3))
+* **test-nextjs:** initialize Next.js test project structure ([2a6155d](https://github.com/mi-examples/pp-dev-js/commit/2a6155dc94f3b27a7b9c3535d5e8699fc9da655c))
+
+# [@metricinsights/pp-dev-v0.11.0-beta.3](https://github.com/mi-examples/pp-dev-js/compare/v0.11.0-beta.2...v0.11.0-beta.3) (2025-08-14)
+
+
+### Bug Fixes
+
+* **ci:** improve package detection and JSON validation ([f787a1c](https://github.com/mi-examples/pp-dev-js/commit/f787a1c2bf47c091c275d09317745b924c45f53f))
+
+
+### Features
+
+* **pp-dev:** add startup optimization and enhance authentication helpers ([a29e311](https://github.com/mi-examples/pp-dev-js/commit/a29e31136e0c27d221fc26028fd5c4970654e386))
+
+# [@metricinsights/pp-dev-v0.11.0-beta.2](https://github.com/mi-examples/pp-dev-js/compare/v0.11.0-beta.1...v0.11.0-beta.2) (2025-08-12)
+
+
+### Bug Fixes
+
+* remove issue number references from semantic-release configs ([f532226](https://github.com/mi-examples/pp-dev-js/commit/f532226b1ecc4cf9d2cfac6e92cb1c101468a329))
+
+# [@metricinsights/pp-dev-v0.11.0-beta.1](https://github.com/mi-examples/pp-dev-js/compare/v0.10.1...v0.11.0-beta.1) (2025-08-12)
+
+
+### Features
+
+* **pp-dev:** add dependency version synchronization for create-pp-dev releases ([2597b01](https://github.com/mi-examples/pp-dev-js/commit/2597b017a59b1359753e85953648e2ce1674253c))
+* **pp-dev:** add esbuild configuration and build optimization scripts ([bbe1791](https://github.com/mi-examples/pp-dev-js/commit/bbe1791e9eb2e220f1552618a9a534a80ddd2f96))
+* **pp-dev:** add semantic release configuration and update dependencies ([5962bcc](https://github.com/mi-examples/pp-dev-js/commit/5962bccbb76fb684415f731f85f372cdd109d8f1))
+
+# Changelog
+
+All notable changes to the `@metricinsights/pp-dev` package will be documented in this file.
+
+## [0.10.0] - 2024-03-21
+
+### Changed
+- Removed unused `pino` and `pino-pretty` dependencies
+
+## [0.9.0] - 2025-01-31
+
+### Added
+- Added support for MI v7.1.0 instances
+- Added new API endpoints for v7 instances
+
+## [0.8.0] - 2024-11-15
+
+### Changed
+- Updated package dependencies to latest versions
+- Improved template loading mechanism
+
+## [0.7.0] - 2024-02-28
+
+### Added
+- Added icon font generation tool
+- Added changelog generator for assets
+- Added image optimization tool
+
+### Changed
+- Improved helper logging system
+
+## [0.6.0] - 2024-01-18
+
+### Added
+- Added support for React.js, TypeScript, and Next.js templates
+- Added new npm package structure
+- Added documentation for templates
+
+### Changed
+- Updated template code structure
+- Improved helper info panel
+
+## [0.5.0] - 2023-10-16
+
+### Added
+- Added Next.js support (beta)
+- Added SSL validation support
+- Added shields for package information
+
+### Changed
+- Fixed Next.js dependency versions
+- Improved helper UI
+
+## [0.4.0] - 2023-05-29
+
+### Added
+- Added CI/CD support
+- Added package for CI/CD
+- Added documentation
+
+### Changed
+- Updated publish configuration
+- Improved installation command
+
+## [0.3.3] - 2023-11-14
+
+### Changed
+- Fixed URL parameters handling in helper
+- Improved helper UI
+
+## [0.3.2] - 2023-11-14
+
+### Changed
+- Fixed Next.js dependency versions
+- Improved helper UI
+
+## [0.3.1] - 2023-12-04
+
+### Changed
+- Fixed URL parameters handling in helper
+- Improved helper UI
+
+## [0.3.0] - 2023-11-08
+
+### Added
+- Added Next.js support
+- Added helper info panel
+- Added support for React.js templates
+
+### Changed
+- Improved helper UI
+- Updated template loading mechanism
+
+## [0.2.0] - 2023-05-25
+
+### Added
+- Added support for React.js templates
+- Added helper info panel
+- Added documentation
+
+### Changed
+- Improved template loading mechanism
+- Updated package structure
+
+## [0.1.1] - 2023-05-23
+
+### Changed
+- Fixed template loading issues
+- Improved helper UI
+
+## [0.1.0] - 2023-05-17
+
+### Added
+- Initial release
+- Basic template support
+- Helper UI implementation
+
+## [0.0.3] - 2023-05-17
+
+### Added
+- Added basic template support
+- Added helper UI
+
+### Changed
+- Improved package structure
+
+## [0.0.2] - 2023-05-17
+
+### Added
+- Added basic package structure
+- Added helper implementation
+
+## [0.0.1] - 2023-05-17
+
+### Added
+- Initial package setup
+- Basic helper functionality