tidewave 0.4.0 → 0.5.1

package/CHANGELOG.md

@@ -1,55 +1,9 @@
 # Changelog
 
-All notable changes to this project will be documented in this file.
+## [0.5.1] - 2025-11-11
 
-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).
+* Add `npx tidewave install` and trim down dependency list.
 
-## [0.1.0] - 2024-08-29
+## [0.5.0] - 2025-11-10
 
-### Added
-
-#### 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
-
-#### 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,23 +1,28 @@
 # Tidewave
 
-> Tidewave Web for Next.js 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:
 
-This package is recommended for JavaScript-powered backends as well as
-JavaScript libraries/applications using a backend as a service (such as
-Supabase). If you are using React with Phoenix, Rails, Django, or another
-server-side framework, [follow the steps here instead](http://hexdocs.pm/tidewave/react.html).
+- Next.js 15/16
 
-This project can also be used as a standalone Model Context Protocol (MCP)
-server for your editors.
+- 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).
+
+This project can also be used through the CLI or as a standalone Model Context
+Protocol (MCP) server for your editors.
 
 ## Installation
 
 ### Next.js
 
-Install it with:
+If you are using Next.js, install Tidewave with:
 
 ```sh
 $ npm install -D tidewave
@@ -39,7 +44,7 @@ export default async function handler(
   res: NextApiResponse,
 ) {
   if (process.env.NODE_ENV === 'development') {
-    const { tidewaveHandler } = await import('tidewave/next-js');
+    const { tidewaveHandler } = await import('tidewave/next-js/handler');
     const handler = await tidewaveHandler();
     return handler(req, res);
   } else {
@@ -58,14 +63,29 @@ export const config = {
 _Note: this uses the **Pages Router**, however it works regardless of the router
 type you use in your application._
 
-Then create (or modify) `middleware.ts` with:
+If you are using Next.js 16+, then create (or modify) `proxy.ts` with:
+
+```typescript
+import { NextRequest, NextResponse } from 'next/server';
+
+export function proxy(req: NextRequest): NextResponse {
+  if (req.nextUrl.pathname.startsWith('/tidewave')) {
+    return NextResponse.rewrite(new URL('/api/tidewave', req.url));
+  }
+
+  // Here you could add your own logic or different middlewares.
+  return NextResponse.next();
+}
+```
+
+For Next.js 15+ and earlier, create (or modify) `middleware.ts` with:
 
 ```typescript
 import { NextRequest, NextResponse } from 'next/server';
 
 export function middleware(req: NextRequest): NextResponse {
   if (req.nextUrl.pathname.startsWith('/tidewave')) {
-    return NextResponse.rewrite(new URL(`/api/tidewave`, req.url));
+    return NextResponse.rewrite(new URL('/api/tidewave', req.url));
   }
 
   // Here you could add your own logic or different middlewares.
@@ -77,20 +97,31 @@ export const config = {
 };
 ```
 
-Finally, we recommend creating the `instrumentation.ts` file below,
-to expose your application's spans, events, and logs to Tidewave/MCP:
+Finally, we expose your application's spans, events, and logs to Tidewave MCP.
+First install the NodeSDK:
+
+```sh
+npm install @opentelemetry/sdk-node
+```
+
+And then create (or modify) a custom `instrumentation.ts` file in the root
+directory of the project (or inside `src` folder if using one):
 
 ```typescript
 // instrumentation.ts
 import { NodeSDK } from '@opentelemetry/sdk-node';
-import { BatchSpanProcessor } from '@opentelemetry/sdk-trace-node';
+import type { SpanProcessor } from '@opentelemetry/sdk-trace-base';
+import type { LogRecordProcessor } from '@opentelemetry/sdk-logs';
 
 export async function register() {
   const runtime = process.env.NEXT_RUNTIME;
   const env = process.env.NODE_ENV;
 
   // Add your app own processes here existing configuration
-  const sdkConfig = {
+  const sdkConfig: {
+    spanProcessors: SpanProcessor[];
+    logRecordProcessors: LogRecordProcessor[];
+  } = {
     spanProcessors: [],
     logRecordProcessors: [],
   };
@@ -110,8 +141,16 @@ 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.
+
 ### React + Vite
 
+If you are building a front-end application, using a backend as a service, such
+as Supabase, or a non-officially supported web framework, we recommend using our
+React + Vite integration.
+
 Install it with:
 
 ```sh
@@ -135,19 +174,32 @@ export default defineConfig({
 });
 ```
 
+Now make sure
+[Tidewave is installed](https://hexdocs.pm/tidewave/installation.html) and you
+are ready to connect Tidewave to your app.
+
+If you are using Supabase or similar, you can prompt Tidewave to use the
+`supabase` CLI so it has complete access to your database. For non-officially
+supported web frameworks, our React + Vite integration allows Tidewave Web to
+perform changes on the front-end, and the agent will be able to modify your
+backend code as usual, but some functionality (such as accessing logs, doing
+database calls, etc) won't be available.
+
 ### Configuration
 
-Next.js' `tidewaveHandler` and Vite's `tidewave` accept the configuration options below:
+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
 
-Tidewave.js also comes with a CLI for developers who want to use it
-as a standalone MCP or query its functionality directly. Note this
-functionality is separate from Tidewave Web.
+Tidewave.js also comes with a CLI for developers who want to use it as a
+standalone MCP or query its functionality directly. Note this functionality is
+separate from Tidewave Web.
 
 ### STDIO MCP