tidewave 0.5.0 → 0.5.2

package/CHANGELOG.md

@@ -1,55 +1,14 @@
 # Changelog
 
-All notable changes to this project will be documented in this file.
+## [0.5.2] - 2025-11-12
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+* Make sure chalk and commander are added as dependencies
+* Serve /tidewave and /tidewave/config routes from Vite
 
-## [0.1.0] - 2024-08-29
+## [0.5.1] - 2025-11-11
 
-### Added
+* Add `npx tidewave install` and trim down dependency list.
 
-#### Core Features
-- **MCP Server Support**: STDIO-based Model Context Protocol server for integration with AI coding assistants
-- **Documentation Extraction**: Extract TypeScript/JavaScript documentation and type information for symbols, classes, functions, and methods
-- **Source Location Resolution**: Get source file paths for modules, symbols, and members
-- **Multi-format Support**: Support for local files, npm dependencies, and Node.js builtin modules
+## [0.5.0] - 2025-11-10
 
-#### Module Reference Formats
-- `module:symbol` - Extract documentation for top-level symbols
-- `module:Class#method` - Extract documentation for instance methods
-- `module:Class.method` - Extract documentation for static methods
-- `node:Class#method` - Extract documentation for Node.js builtin instance methods
-- `node:Class.method` - Extract documentation for Node.js builtin static methods
-
-#### CLI Commands
-- `tidewave mcp` - Start the MCP server via STDIO
-- `tidewave docs <module-path>` - Extract documentation for a symbol
-- `tidewave source <module>` - Get the source file path for a module
-
-#### Runtime Support
-- Full support for Node.js with npm/npx
-- Native support for Bun with bunx
-- Support for Deno via npm: protocol
-
-### Fixed
-- Handle source location of symbols and members correctly (#7)
-- Handle prefix option only on CLI layer, not in core extraction (#6)
-- Correctly extract JavaScript/TypeScript symbols, instances, and methods
-- Show interface types correctly
-- Handle falsy values and improve error handling (#1)
-
-### Changed
-- Refactored codebase into modular structure for better maintainability
-- Simplified module resolution and extraction logic
-- Improved TypeScript and Node.js module resolution
-- Changed config flag for project path handling (#3)
-
-### Technical Details
-- Built with TypeScript for type safety
-- Uses TypeScript Compiler API for accurate code analysis
-- Supports ESM modules
-- Includes comprehensive error handling and user-friendly error messages
-- Optimized for use with AI coding assistants through MCP protocol
-
-[0.1.0]: https://github.com/dashbit/tidewave_javascript/releases/tag/v0.1.0
+* Initial release.

package/README.md

@@ -1,13 +1,16 @@
 # Tidewave
 
-> Tidewave Web for Next.js and React+Vite is currently in alpha testing!
+Tidewave is the coding agent for full-stack web app development. Integrate
+Claude Code, OpenAI Codex, and other agents with your web app and web framework
+at every layer, from UI to database. [See our website](https://tidewave.ai) for
+more information.
 
-Tidewave is the coding agent for full-stack web app development.
-[See our website](https://tidewave.ai) for more information.
+This project supports:
 
-If you are using Next.js or you have a React + Vite frontend, talking either to
-a backend as a service (such as Supabase) or a third-party framework, you are in
-the right place!
+- Next.js 15/16
+
+- React + Vite frontends, with either a backend as a service (such as Supabase)
+  or a third-party framework
 
 If you are using React with Django, FastAPI, Flask, Phoenix, or Rails,
 [follow the steps here instead](http://hexdocs.pm/tidewave/react.html).
@@ -21,6 +24,28 @@ Protocol (MCP) server for your editors.
 
 If you are using Next.js, install Tidewave with:
 
+```sh
+$ npx tidewave install
+# or
+$ yarn dlx tidewave install
+# or
+$ pnpm dlx tidewave install
+# or
+$ bunx tidewave install
+```
+
+And you are almost there! Now make sure
+[Tidewave is installed](https://hexdocs.pm/tidewave/installation.html) and you
+are ready to connect Tidewave to your app.
+
+In case the command abovees do not work, you can toggle the manual installation
+instructions below
+
+<details>
+<summary>Show manual installation steps</summary><br />
+
+**1. Add Tidewave as a dependency**
+
 ```sh
 $ npm install -D tidewave
 # or
@@ -31,6 +56,8 @@ $ pnpm add --save-dev tidewave
 $ bun add --dev tidewave
 ```
 
+**2. Create `pages/api/tidewave.ts`**
+
 Then create `pages/api/tidewave.ts` with:
 
 ```typescript
@@ -57,8 +84,7 @@ export const config = {
 };
 ```
 
-_Note: this uses the **Pages Router**, however it works regardless of the router
-type you use in your application._
+**3. Create the proxy.ts or middleware.ts**
 
 If you are using Next.js 16+, then create (or modify) `proxy.ts` with:
 
@@ -94,11 +120,14 @@ export const config = {
 };
 ```
 
+**4. Create instrumentation.ts**
+
 Finally, we expose your application's spans, events, and logs to Tidewave MCP.
 First install the NodeSDK:
 
 ```sh
 npm install @opentelemetry/sdk-node
+npm install -D @opentelemetry/sdk-trace-base @opentelemetry/sdk-logs
 ```
 
 And then create (or modify) a custom `instrumentation.ts` file in the root
@@ -138,9 +167,7 @@ export async function register() {
 }
 ```
 
-Now make sure
-[Tidewave is installed](https://hexdocs.pm/tidewave/installation.html) and you
-are ready to connect Tidewave to your app.
+</details>
 
 ### React + Vite
 
@@ -187,8 +214,9 @@ database calls, etc) won't be available.
 Next.js' `tidewaveHandler` and Vite's `tidewave` accept the configuration
 options below:
 
-- `allow_remote_access:` allow remote connections when true (default false)
-- `allowed_origins:` defaults to the current host/port
+- `allow_remote_access:` allow remote connections when true (default false).
+  Enable this only if you trust your network and you want Tidewave MCP to be
+  accessed from another trusted machine
 - `team`: enable Tidewave Web for teams
 
 ## CLI