rpc4next 0.1.3 → 0.1.5

package/README.md

@@ -9,7 +9,7 @@ Inspired by Hono RPC and Pathpida, **rpc4next** automatically generates a type-s
 ## ✨ Features
 
 - ✅ 既存の `app/**/route.ts` および `app/**/page.tsx` を活用するため、新たなハンドラファイルの作成は不要
-- ✅ ルート、パラメータ、リクエストボディ、レスポンスの型安全なクライアント生成
+- ✅ ルート、パラメータ、クエリパラメータ、 リクエストボディ、レスポンスの型安全なクライアント生成
 - ✅ 最小限のセットアップで、カスタムサーバー不要
 - ✅ 動的ルート（`[id]`、`[...slug]` など）に対応
 - ✅ CLI による自動クライアント用型定義生成
@@ -30,29 +30,37 @@ npm install rpc4next
 ### 2. Define API Routes in Next.js
 
 Next.js プロジェクト内の既存の `app/**/route.ts` と `app/**/page.tsx` ファイルをそのまま利用できます。
+さらに、クエリパラメータ（searchParams）の型安全性を有効にするには、対象のファイル内で `Query` または `OptionalQuery` 型を定義し、`export` してください。
 
 ```ts
 // app/api/user/[id]/route.ts
 import { NextRequest, NextResponse } from "next/server";
 
+// searchParams用の型定義
+export type Query = {
+  q: string; // 必須
+  page?: number; // 任意
+};
+
 export async function GET(
   req: NextRequest,
   segmentData: { params: Promise<{ id: string }> }
 ) {
   const { id } = await segmentData.params;
-  // RPCとしてresponseの戻り値の推論が機能するのは、対象となる `route.ts` の HTTPメソッドハンドラ内で`NextResponse.json()` をしている物のみになります
-  return NextResponse.json({ name: `User ${id}` });
+  const q = req.nextUrl.searchParams.get("q");
+  return NextResponse.json({ id, q });
 }
 ```
 
+🚩 Query or OptionalQuery 型を export することで、searchParams の型も自動的にクライアントに反映されます。
+
 - **RPCとしてresponseの戻り値の推論が機能するのは、対象となる `route.ts` の HTTPメソッドハンドラ内で`NextResponse.json()` をしている物のみになります**
 
 ---
 
 ### 3. Generate Type Definitions with CLI
 
-CLI を利用して、Next.js のルート構造から型安全な RPC クライアントの定義を自動生成します。  
-以下のコマンドを実行すると、`route.ts` と `page.tsx` ファイルの両方を走査し、型定義ファイル（outputPathに指定したファイル）が生成されます。
+CLI を利用して、Next.js のルート構造から型安全な RPC クライアントの定義を自動生成します。
 
 ```bash
 npx rpc4next <baseDir> <outputPath>
@@ -64,14 +72,14 @@ npx rpc4next <baseDir> <outputPath>
 #### オプション
 
 - **ウォッチモード**  
-  ファイル変更を検知して自動的に再生成する場合は `--watch` オプションを付けます。
+  ファイル変更を検知して自動的に再生成する場合は `--watch` or `-w` オプションを付けます。
 
   ```bash
   npx rpc4next <baseDir> <outputPath> --watch
   ```
 
 - **パラメータ型ファイルの生成**  
-  各ルートに対して個別のパラメータ型定義ファイルを生成する場合は、`--generate-params-types` オプションにファイル名を指定します。
+  各ルートに対して個別のパラメータ型定義ファイルを生成する場合は、`--params-file` or `-p` オプションにファイル名を指定します。
 
   ```bash
   npx rpc4next <baseDir> <outputPath> --generate-params-types <paramsFileName>
@@ -104,17 +112,54 @@ export const rpc = createClient<PathStructure>();
 import { rpc } from "@/lib/rpcClient";
 
 export default async function Page() {
-  const res = await rpc.api.user._id("123").$get();
+  const res = await rpc.api.user._id("123").$get({
+    query: { q: "hello", page: 1 },
+  });
   const json = await res.json();
-  return <div>{json.name}</div>;
+  return <div>{json.q}</div>;
 }
 ```
 
 - エディタの補完機能により、利用可能なエンドポイントが自動的に表示されます。
-- リクエストの構造（params, searchParams）はサーバーコードから推論され、レスポンスも型安全に扱えます。
+- リクエストの構造（params, query）はサーバーコードから推論され、レスポンスも型安全に扱えます。
 
 ---
 
+## ✅ さらに型安全にしたい場合 `honolike` + `createRouteHandler` による Next.js の型安全強化
+
+さらに `honolike` をベースとした `createRouteHandler()` を組み合わせることで、
+
+### 📌 主なメリット
+
+1. **レスポンス型安全**
+
+   - ステータス、Content-Type、Body がすべて型で保証される
+   - クライアントは受け取るレスポンス型を完全に推論可能
+
+2. **クライアント側補完強化**
+
+   - `status`, `content-type`, `json()`, `text()` などが適切に補完される
+
+3. **サーバー側 params / query も型安全**
+   - `routeHandlerFactory()` を使えば、`params`, `query` も型推論可能
+
+---
+
+### ✅ 基本的な使い方
+
+```ts
+const createRouteHandler = routeHandlerFactory((err, rc) =>
+  rc.text("error", { status: 400 })
+);
+
+const { POST } = createRouteHandler().post(
+  async (rc) => rc.json("json response"),
+  async (rc) => rc.text("plain text")
+);
+```
+
+これだけで、POST リクエストの返り値が、responseの内容(json,textなど)、status,contenttypeが型付けされるようになります。
+
 ## 🚧 Requirements
 
 - Next.js 14+ (App Router 使用)
@@ -125,5 +170,3 @@ export default async function Page() {
 ## 💼 License
 
 MIT
-
----

package/dist/cli/{route-scanner.js → core/route-scanner.js}

@@ -12,7 +12,7 @@ const cache_1 = require("./cache");
 const constants_1 = require("./constants");
 const scan_utils_1 = require("./scan-utils");
 const type_utils_1 = require("./type-utils");
-const constants_2 = require("../lib/constants");
+const constants_2 = require("../../lib/constants");
 const endPointFileNames = new Set(constants_1.END_POINT_FILE_NAMES);
 const hasTargetFiles = (dirPath) => {
     // Return cached result if available

package/dist/cli/{scan-utils.d.ts → core/scan-utils.d.ts}

@@ -1,4 +1,4 @@
-import { HttpMethod } from "../lib/types";
+import { HttpMethod } from "../../lib/types";
 export declare const createImportAlias: (type: string, key: string) => string;
 export declare const scanFile: <T extends string | undefined>(outputFile: string, inputFile: string, findCallBack: (fileContents: string) => T, typeCallBack: (type: NonNullable<T>, importAlias: string) => string) => {
     importName: string;

package/dist/cli/core/types.d.ts

@@ -0,0 +1,2 @@
+import type { END_POINT_FILE_NAMES } from "./constants";
+export type EndPointFileNames = (typeof END_POINT_FILE_NAMES)[number];

package/dist/cli/core/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cli/generator.js

@@ -5,7 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generate = void 0;
 const fs_1 = __importDefault(require("fs"));
-const generate_path_structure_1 = require("./generate-path-structure");
+const generate_path_structure_1 = require("./core/generate-path-structure");
 const generate = ({ baseDir, outputPath, paramsFileName, logger, }) => {
     logger.info("Generating...");
     const { pathStructure, paramsTypes } = (0, generate_path_structure_1.generatePages)(outputPath, baseDir);

package/dist/cli/types.d.ts

@@ -1,5 +1,3 @@
-import type { END_POINT_FILE_NAMES } from "./constants";
-export type EndPointFileNames = (typeof END_POINT_FILE_NAMES)[number];
 export interface Logger {
     info: (msg: string) => void;
     success: (msg: string) => void;

package/dist/cli/watcher.js

@@ -5,7 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.setupWatcher = void 0;
 const chokidar_1 = __importDefault(require("chokidar"));
-const cache_1 = require("./cache");
+const cache_1 = require("./core/cache");
 const debounce_1 = require("./debounce");
 const setupWatcher = (baseDir, onGenerate, logger) => {
     logger.info(`Watching ${baseDir}...`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rpc4next",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "Inspired by Hono RPC and Pathpida, rpc4next brings a lightweight and intuitive RPC solution to Next.js, making server-client communication seamless",
   "author": "watanabe-1",
   "license": "MIT",