@nitrostack/cli 1.0.4 → 1.0.7

package/templates/typescript-oauth/README.md

@@ -1,263 +1,68 @@
 # ✈️ NitroStack Flight Booking
 
-A production-ready NitroStack template showcasing real-time flight search and booking with **Duffel API** integration. Search flights, view details, select seats, and book - all through beautiful interactive widgets.
+A production-ready template showcasing real-time flight search and booking with **Duffel API** integration. Learn how to build complex, authenticated MCP servers with high-impact visual widgets.
 
 ## ✨ Features
 
-### 🔌 **Duffel API Integration**
-- Real-time flight search across 300+ airlines
-- Live pricing and availability
-- Seat selection with cabin maps
-- Booking and order management
+- **Real-time Search** — Powered by the Duffel API (300+ airlines).
+- **Seat Selection** — Interactive visual cabin maps with seat pickers.
+- **Secure Payments** — Simulated secure booking and confirmation flows.
+- **Advanced Auth** — Optional OAuth 2.1 support for protected MCP servers.
 
-### 🎨 **Interactive Widgets**
-- **Airport Search** - Autocomplete airport selection
-- **Flight Search Results** - Compare flights with prices
-- **Flight Details** - Comprehensive flight information
-- **Seat Selection** - Visual cabin map with seat picker
-- **Order Summary** - Complete booking overview
-- **Payment Confirmation** - Secure payment flow
-
-### 🛠️ **MCP Tools**
-- `search_airports` - Find airports by name/code
-- `search_flights` - Search available flights
-- `show_flight_details` - Detailed flight information
-- `select_seats` - Interactive seat selection
-- `create_booking` - Book flights
-- `get_order` - Retrieve booking details
+---
 
 ## 🚀 Quick Start
 
-### Prerequisites
-
-```bash
-# Install NitroStack CLI globally
-npm install -g nitrostack
-
-# Or use npx
-npx nitrostack --version
-```
-
-### 1. Create Your Project
+### 1. Initialize Your Project
 
 ```bash
-# Create a new project
-nitrostack init my-flight-app --template typescript-oauth
+npx nitrostack init my-flight-app --template typescript-oauth
 cd my-flight-app
-
-# Install all dependencies (root + widgets)
-nitrostack install
 ```
 
-### 2. Get Your Duffel API Key (Free)
-
-[Duffel](https://duffel.com/) provides a free API for flight search and booking:
-
-1. **Sign up** at [duffel.com](https://duffel.com/) (click "Start now" - it's free!)
-2. Create a free account (no credit card required)
-3. Go to your **Dashboard** → **Developers** → **Access tokens**
-4. Click **"Create token"** to generate your API key
-5. Copy the token (starts with `duffel_test_` for sandbox)
-
-> 💡 **Tip**: The test mode (`duffel_test_*` tokens) gives you access to realistic mock data for development. Production tokens (`duffel_live_*`) connect to real airlines.
-
-### 3. Configure Environment
-
-Copy the example environment file and add your Duffel API key:
+### 2. Install Dependencies
 
 ```bash
-cp .env.example .env
+npm run install:all
 ```
 
-Edit `.env` and update:
-
-```env
-# Duffel API Configuration
-DUFFEL_API_KEY=duffel_test_your_api_key_here
-```
-
-### 4. Run Development Server
-
-```bash
-npm run dev
-```
-
-This starts:
-- **MCP Server** - Hot reloads on code changes
-- **Studio** on http://localhost:3000 - Visual testing environment  
-- **Widget Dev Server** on http://localhost:3001 - Hot module replacement
-
-### 5. Test in Studio
-
-Try these prompts in Studio chat:
-- "Search flights from London to New York for next week"
-- "Show me flight details"
-- "I want to select seats"
-- "Show me flights from JFK to LAX"
-
-## 📁 Project Structure
-
-```
-typescript-oauth/
-├── src/
-│   ├── index.ts                 # Main server entry
-│   ├── app.module.ts            # App module
-│   ├── services/
-│   │   └── duffel.service.ts    # Duffel API client
-│   └── modules/
-│       └── flights/
-│           ├── flights.module.ts    # Module definition
-│           ├── flights.tools.ts     # Search & display tools
-│           ├── flights.prompts.ts   # AI prompts
-│           ├── flights.resources.ts # Static resources
-│           └── booking.tools.ts     # Booking tools
-│   └── widgets/
-│       ├── app/
-│       │   ├── airport-search/      # Airport autocomplete
-│       │   ├── flight-search-results/ # Results list
-│       │   ├── flight-details/      # Flight info
-│       │   ├── seat-selection/      # Seat picker
-│       │   ├── order-summary/       # Booking summary
-│       │   └── payment-confirmation/ # Payment widget
-├── .env.example                 # Environment template
-├── OAUTH_SETUP.md              # OAuth configuration guide
-├── package.json
-└── README.md
-```
-
-## 🔧 Commands
-
-```bash
-# Installation
-npm install              # Install all dependencies (root + widgets)
-nitrostack install       # Same as above
+### 3. Get NitroStudio
 
-# Development
-npm run dev              # Start dev server with Studio
-npm run build            # Build TypeScript and widgets for production
-npm start                # Run production server
+Experience the visual seat selection and flight search as your users would see it.
 
-# Upgrade
-npm run upgrade          # Upgrade nitrostack to latest version
+1. **Download NitroStudio**: [nitrostack.ai/studio](https://nitrostack.ai/studio)
+2. **Open Project**: Launch NitroStudio and select your project folder.
 
-# Widget Management
-npm run widget <command> # Run npm command in widgets directory
-npm run widget add <pkg> # Add a widget dependency
-```
-
-## 🔐 OAuth Setup (Optional)
-
-This template includes OAuth 2.1 authentication support. If you want to protect your MCP server with authentication:
-
-1. Read the detailed guide: **[OAUTH_SETUP.md](./OAUTH_SETUP.md)**
-2. Configure Auth0 (or your OAuth provider)
-3. Update your `.env` with OAuth credentials
-
-> **Note**: OAuth is optional for local development. The template works without it using Duffel's test API.
-
-## 📊 Duffel API Features
-
-### Test Mode vs Live Mode
-
-| Feature | Test Mode (`duffel_test_*`) | Live Mode (`duffel_live_*`) |
-|---------|----------------------------|----------------------------|
-| API Access | ✅ Full access | ✅ Full access |
-| Pricing | Mock data | Real prices |
-| Bookings | Simulated | Real bookings |
-| Credit Card | Not charged | Charged |
-| Rate Limits | Generous | Production limits |
-
-### Supported Airlines
-
-Duffel provides access to 300+ airlines including:
-- Major carriers (British Airways, Lufthansa, Emirates, etc.)
-- Low-cost carriers (Ryanair, EasyJet, Spirit, etc.)
-- Regional airlines
-
-### API Capabilities
-
-- **Search**: Real-time availability and pricing
-- **Ancillaries**: Seats, bags, meals
-- **Booking**: Create and manage orders
-- **Changes**: Modify existing bookings
-- **Cancellations**: Cancel and refund
-
-## 🎨 Widget Features
-
-### Airport Search Widget
-- Autocomplete with IATA codes
-- City and airport name search
-- Recent searches
-
-### Flight Search Results Widget
-- Compare multiple flights
-- Filter by stops, price, time
-- Sort options
-- Airline logos
-
-### Flight Details Widget
-- Complete itinerary
-- Fare breakdown
-- Baggage allowance
-- Flight duration and stops
-
-### Seat Selection Widget
-- Visual cabin map
-- Seat categories (standard, extra legroom, etc.)
-- Price per seat
-- Real-time availability
-
-## 🛠️ Customization
-
-### Adding New Airlines
-
-Duffel handles airline integrations automatically. You don't need to configure individual airlines.
-
-### Modifying Search Parameters
-
-Edit `src/modules/flights/flights.tools.ts` to customize:
-- Default passenger counts
-- Cabin class options
-- Date ranges
-- Result limits
-
-### Styling Widgets
-
-Each widget in `src/widgets/app/` can be customized:
-- Edit page.tsx for layout
-- Add custom CSS
-- Modify component styles
+---
 
-## 📚 Resources
+## ⚙️ Configuration
 
-### Duffel Documentation
-- [Duffel API Docs](https://duffel.com/docs/api)
-- [Duffel SDK (Node.js)](https://github.com/duffel/duffel-api-javascript)
-- [Duffel Postman Collection](https://duffel.com/docs/postman)
+### 1. Duffel API Key
 
-### NitroStack Documentation
-- [NitroStack Docs](https://nitrostack.ai/docs)
-- [Widget Development Guide](https://nitrostack.ai/docs/widgets)
+You need a free Duffel API key to see live flight data:
 
-## 💡 Tips
+1. Sign up at [duffel.com](https://duffel.com/).
+2. Copy your **Test Token** from the dashboard.
+3. Create `.env` from the example:
+   ```bash
+   cp .env.example .env
+   ```
+4. Update `DUFFEL_API_KEY` in your `.env`.
 
-- **Use Test Mode**: Start with `duffel_test_*` tokens for development
-- **Check Rate Limits**: Duffel has rate limits - cache searches when possible
-- **Error Handling**: The template includes comprehensive error handling
-- **Responsive Design**: Widgets are mobile-friendly out of the box
+### 2. OAuth (Optional)
 
-## 📚 Next Steps
+For production scenarios requiring user authentication, refer to [OAUTH_SETUP.md](./OAUTH_SETUP.md).
 
-- Try the **Starter Template** - Learn NitroStack basics
-- Try the **Pizza Shop Template** - Interactive maps with Mapbox
-- Read the [Duffel Getting Started Guide](https://duffel.com/docs/guides/getting-started)
+---
 
-## License
+## 🛠️ Commands
 
-MIT
+- `npm run dev` — Start the development ecosystem.
+- `npm run build` — Bundle TypeScript and widgets for deployment.
+- `npm run upgrade` — Keep NitroStack core up to date.
 
 ---
-
-**Built with ❤️ using NitroStack + Duffel API**
-
-Need help? Check [Duffel Support](https://duffel.com/docs) or [NitroStack Docs](https://nitrostack.ai/docs)
+**Official Resources**
+- [Website](https://nitrostack.ai)
+- [Docs](https://docs.nitrostack.ai)
+- [Duffel API](https://duffel.com/docs)

package/templates/typescript-oauth/package.json

@@ -14,7 +14,7 @@
     "widget": "npm --prefix src/widgets"
   },
   "dependencies": {
-    "nitrostack": "^1",
+    "@nitrostack/core": "^1",
     "zod": "^3.22.4",
     "dotenv": "^16.3.1",
     "@duffel/api": "^4.21.0",

package/templates/typescript-oauth/src/app.module.ts

@@ -1,4 +1,4 @@
-import { McpApp, Module, ConfigModule, OAuthModule } from 'nitrostack';
+import { McpApp, Module, ConfigModule, OAuthModule } from '@nitrostack/core';
 import { FlightsModule } from './modules/flights/flights.module.js';
 import { SystemHealthCheck } from './health/system.health.js';
 

package/templates/typescript-oauth/src/guards/oauth.guard.ts

@@ -1,4 +1,4 @@
-import { Guard, ExecutionContext, OAuthModule, OAuthTokenPayload } from 'nitrostack';
+import { Guard, ExecutionContext, OAuthModule, OAuthTokenPayload } from '@nitrostack/core';
 
 /**
  * OAuth Guard

package/templates/typescript-oauth/src/health/system.health.ts

@@ -1,4 +1,4 @@
-import { HealthCheck, HealthCheckInterface, HealthCheckResult } from 'nitrostack';
+import { HealthCheck, HealthCheckInterface, HealthCheckResult } from '@nitrostack/core';
 
 /**
  * System Health Check

package/templates/typescript-oauth/src/index.ts

@@ -18,7 +18,7 @@
  */
 
 import 'dotenv/config';
-import { McpApplicationFactory } from 'nitrostack';
+import { McpApplicationFactory } from '@nitrostack/core';
 import { AppModule } from './app.module.js';
 
 /**

package/templates/typescript-oauth/src/modules/flights/booking.tools.ts

@@ -1,4 +1,4 @@
-import { ToolDecorator as Tool, Widget, ExecutionContext, z, UseGuards, Injectable } from 'nitrostack';
+import { ToolDecorator as Tool, Widget, ExecutionContext, z, UseGuards, Injectable } from '@nitrostack/core';
 import { OAuthGuard } from '../../guards/oauth.guard.js';
 import { DuffelService } from '../../services/duffel.service.js';
 

package/templates/typescript-oauth/src/modules/flights/flights.module.ts

@@ -1,4 +1,4 @@
-import { Module } from 'nitrostack';
+import { Module } from '@nitrostack/core';
 import { FlightTools } from './flights.tools.js';
 import { BookingTools } from './booking.tools.js';
 import { FlightPrompts } from './flights.prompts.js';

package/templates/typescript-oauth/src/modules/flights/flights.prompts.ts

@@ -1,4 +1,4 @@
-import { PromptDecorator as Prompt, ExecutionContext, Injectable } from 'nitrostack';
+import { PromptDecorator as Prompt, ExecutionContext, Injectable } from '@nitrostack/core';
 import { DuffelService } from '../../services/duffel.service.js';
 
 // Note: Using explicit deps for ESM compatibility

package/templates/typescript-oauth/src/modules/flights/flights.resources.ts

@@ -1,4 +1,4 @@
-import { ResourceDecorator as Resource, ExecutionContext, z, Injectable } from 'nitrostack';
+import { ResourceDecorator as Resource, ExecutionContext, z, Injectable } from '@nitrostack/core';
 import { DuffelService } from '../../services/duffel.service.js';
 
 // Note: Using explicit deps for ESM compatibility

package/templates/typescript-oauth/src/modules/flights/flights.tools.ts

@@ -1,4 +1,4 @@
-import { ToolDecorator as Tool, Widget, ExecutionContext, z, UseGuards, Injectable } from 'nitrostack';
+import { ToolDecorator as Tool, Widget, ExecutionContext, z, UseGuards, Injectable } from '@nitrostack/core';
 import { OAuthGuard } from '../../guards/oauth.guard.js';
 import { DuffelService } from '../../services/duffel.service.js';
 import { format } from 'date-fns';

package/templates/typescript-oauth/src/services/duffel.service.ts

@@ -1,5 +1,5 @@
 import { Duffel } from '@duffel/api';
-import { Injectable } from 'nitrostack';
+import { Injectable } from '@nitrostack/core';
 
 /**
  * Duffel API Service

package/templates/typescript-pizzaz/.env.example

@@ -0,0 +1,8 @@
+# Mapbox Configuration (Optional)
+# =============================================================================
+# The map widget uses Mapbox GL for interactive maps. 
+# Get a free API key at: https://www.mapbox.com/
+# =============================================================================
+
+# Your Mapbox Public Token (starts with pk.)
+NEXT_PUBLIC_MAPBOX_TOKEN=pk.your_mapbox_token_here