rpc4next 0.1.2 → 0.1.4

package/README.md

@@ -40,7 +40,6 @@ export async function GET(
   segmentData: { params: Promise<{ id: string }> }
 ) {
   const { id } = await segmentData.params;
-  // RPCとしてresponseの戻り値の推論が機能するのは、対象となる `route.ts` の HTTPメソッドハンドラ内で`NextResponse.json()` をしている物のみになります
   return NextResponse.json({ name: `User ${id}` });
 }
 ```
@@ -51,8 +50,7 @@ export async function GET(
 
 ### 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 +62,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>
@@ -115,6 +113,41 @@ export default async function Page() {
 
 ---
 
+## ✅ さらに型安全にしたい場合 `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 +158,3 @@ export default async function Page() {
 ## 💼 License
 
 MIT
-
----

package/dist/cli/cli-handler.d.ts

@@ -0,0 +1,2 @@
+import { CliOptions, Logger } from "./types";
+export declare const handleCli: (baseDir: string, outputPath: string, options: CliOptions, logger: Logger) => number;

package/dist/cli/cli-handler.js

@@ -0,0 +1,36 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleCli = void 0;
+const path_1 = __importDefault(require("path"));
+const generator_1 = require("./generator");
+const watcher_1 = require("./watcher");
+const handleCli = (baseDir, outputPath, options, logger) => {
+    const resolvedBaseDir = path_1.default.resolve(baseDir).replace(/\\/g, "/");
+    const resolvedOutputPath = path_1.default.resolve(outputPath).replace(/\\/g, "/");
+    const paramsFileName = typeof options.paramsFile === "string" ? options.paramsFile : null;
+    if (options.paramsFile !== undefined && !paramsFileName) {
+        logger.error("Error: --params-file requires a filename.");
+        return 1;
+    }
+    (0, generator_1.generate)({
+        baseDir: resolvedBaseDir,
+        outputPath: resolvedOutputPath,
+        paramsFileName: options.paramsFile || null,
+        logger,
+    });
+    if (options.watch) {
+        (0, watcher_1.setupWatcher)(resolvedBaseDir, () => {
+            (0, generator_1.generate)({
+                baseDir: resolvedBaseDir,
+                outputPath: resolvedOutputPath,
+                paramsFileName: options.paramsFile || null,
+                logger,
+            });
+        }, logger);
+    }
+    return 0;
+};
+exports.handleCli = handleCli;

package/dist/cli/cli.d.ts

@@ -1,2 +1,2 @@
-#!/usr/bin/env node
-export {};
+import { Logger } from "./types";
+export declare const runCli: (argv: string[], logger?: Logger) => void;

package/dist/cli/cli.js

@@ -1,81 +1,32 @@
-#!/usr/bin/env node
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-const chalk_1 = __importDefault(require("chalk"));
-const chokidar_1 = __importDefault(require("chokidar"));
+exports.runCli = void 0;
 const commander_1 = require("commander");
-const cache_1 = require("./cache");
-const debounce_1 = require("./debounce");
-const generate_path_structure_1 = require("./generate-path-structure");
-const program = new commander_1.Command();
-program
-    .description("Generate RPC client type definitions based on the Next.js path structure.")
-    .argument("<baseDir>", "Base directory containing Next.js paths for type generation")
-    .argument("<outputPath>", "Output path for the generated type definitions")
-    .option("-w, --watch", "Watch mode: regenerate on file changes")
-    .option("--generate-params-types [filename]", "Generate params types file with specified filename")
-    .action((baseDir, outputPath, options) => {
-    const resolvedBaseDir = path_1.default.resolve(baseDir).replace(/\\/g, "/");
-    const resolvedOutputPath = path_1.default.resolve(outputPath).replace(/\\/g, "/");
-    const paramsFileName = typeof options.generateParamsTypes === "string"
-        ? options.generateParamsTypes
-        : null;
-    if (options.generateParamsTypes !== undefined && !paramsFileName) {
-        console.error(chalk_1.default.red("Error: --generate-params-types requires a filename (e.g., params.ts) when specified."));
-        process.exit(1);
-    }
-    const log = (msg) => {
-        const time = new Date().toLocaleTimeString();
-        console.log(`${chalk_1.default.gray(`[${time}]`)} ${msg}`);
-    };
-    const generate = () => {
-        log(chalk_1.default.cyan("Generating..."));
-        const { pathStructure: outputContent, paramsTypes } = (0, generate_path_structure_1.generatePages)(resolvedOutputPath, resolvedBaseDir);
-        fs_1.default.writeFileSync(resolvedOutputPath, outputContent);
-        log(chalk_1.default.green(`RPC client type definitions generated at ${resolvedOutputPath}`));
-        if (paramsFileName) {
-            paramsTypes.forEach(({ paramsType, dirPath }) => {
-                const filePath = `${dirPath}/${paramsFileName}`;
-                fs_1.default.writeFileSync(filePath, paramsType);
-            });
-            log(chalk_1.default.green(`Params type files have been generated as '${paramsFileName}' alongside each route/page.`));
+const cli_handler_1 = require("./cli-handler");
+const logger_1 = require("./logger");
+const runCli = (argv, logger = (0, logger_1.createLogger)()) => {
+    const program = new commander_1.Command();
+    program
+        .description("Generate RPC client type definitions based on the Next.js path structure.")
+        .argument("<baseDir>", "Base directory containing Next.js paths for type generation")
+        .argument("<outputPath>", "Output path for the generated type definitions")
+        .option("-w, --watch", "Watch mode: regenerate on file changes")
+        .option("-p, --params-file [filename]", "Generate params types file with specified filename")
+        .action((baseDir, outputPath, options) => __awaiter(void 0, void 0, void 0, function* () {
+        const exitCode = (0, cli_handler_1.handleCli)(baseDir, outputPath, options, logger);
+        if (!options.watch) {
+            process.exit(exitCode);
         }
-    };
-    generate();
-    if (options.watch) {
-        log(chalk_1.default.yellow(`Watching ${resolvedBaseDir} for changes...`));
-        const isTargetFiles = (path) => path.endsWith("route.ts") || path.endsWith("page.tsx");
-        const changedPaths = new Set();
-        // Once the debounced function starts executing, no new watcher events will be processed until it completes.
-        // This is due to JavaScript's single-threaded event loop: the current debounced function runs to completion,
-        // and any new change events are queued until the execution finishes.
-        const debouncedGenerate = (0, debounce_1.debounce)(() => {
-            changedPaths.forEach((path) => {
-                (0, cache_1.clearVisitedDirsCacheAbove)(path);
-            });
-            changedPaths.clear();
-            (0, cache_1.clearCntCache)();
-            generate();
-        }, 300);
-        const watcher = chokidar_1.default.watch(resolvedBaseDir, {
-            ignoreInitial: true,
-            // If we exclude everything except files using ignored, the watch mode will terminate, so we added "only files" to the exclusion condition.
-            ignored: (path, stats) => !!(stats === null || stats === void 0 ? void 0 : stats.isFile()) && !isTargetFiles(path),
-        });
-        watcher.on("ready", () => {
-            watcher.on("all", (event, path) => {
-                if (isTargetFiles(path)) {
-                    log(`${chalk_1.default.magenta(`[${event}]`)} ${chalk_1.default.blue(path)}`);
-                    changedPaths.add(path);
-                    debouncedGenerate();
-                }
-            });
-        });
-    }
-});
-program.parse(process.argv);
+    }));
+    program.parse(argv);
+};
+exports.runCli = runCli;

package/dist/cli/generator.d.ts

@@ -0,0 +1,7 @@
+import { Logger } from "./types";
+export declare const generate: ({ baseDir, outputPath, paramsFileName, logger, }: {
+    baseDir: string;
+    outputPath: string;
+    paramsFileName: string | null;
+    logger: Logger;
+}) => void;

package/dist/cli/generator.js

@@ -0,0 +1,22 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": 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 = ({ baseDir, outputPath, paramsFileName, logger, }) => {
+    logger.info("Generating...");
+    const { pathStructure, paramsTypes } = (0, generate_path_structure_1.generatePages)(outputPath, baseDir);
+    fs_1.default.writeFileSync(outputPath, pathStructure);
+    logger.success(`Generated types at ${outputPath}`);
+    if (paramsFileName) {
+        paramsTypes.forEach(({ paramsType, dirPath }) => {
+            const filePath = `${dirPath}/${paramsFileName}`;
+            fs_1.default.writeFileSync(filePath, paramsType);
+        });
+        logger.success(`Generated params type at ${paramsFileName}`);
+    }
+};
+exports.generate = generate;

package/dist/cli/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli/index.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const cli_1 = require("./cli");
+(0, cli_1.runCli)(process.argv);

package/dist/cli/logger.d.ts

@@ -0,0 +1,2 @@
+import { Logger } from "./types";
+export declare const createLogger: () => Logger;

package/dist/cli/logger.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createLogger = void 0;
+const createLogger = () => {
+    return {
+        info: (msg) => console.log(msg),
+        success: (msg) => console.log(msg),
+        error: (msg) => console.error(msg),
+    };
+};
+exports.createLogger = createLogger;

package/dist/cli/types.d.ts

@@ -1,2 +1,11 @@
 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;
+    error: (msg: string) => void;
+}
+export interface CliOptions {
+    watch?: boolean;
+    paramsFile?: string;
+}

package/dist/cli/watcher.d.ts

@@ -0,0 +1,2 @@
+import { Logger } from "./types";
+export declare const setupWatcher: (baseDir: string, onGenerate: () => void, logger: Logger) => void;

package/dist/cli/watcher.js

@@ -0,0 +1,40 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setupWatcher = void 0;
+const chokidar_1 = __importDefault(require("chokidar"));
+const cache_1 = require("./cache");
+const debounce_1 = require("./debounce");
+const setupWatcher = (baseDir, onGenerate, logger) => {
+    logger.info(`Watching ${baseDir}...`);
+    const isTargetFiles = (path) => path.endsWith("route.ts") || path.endsWith("page.tsx");
+    const changedPaths = new Set();
+    // Once the debounced function starts executing, no new watcher events will be processed until it completes.
+    // This is due to JavaScript's single-threaded event loop: the current debounced function runs to completion,
+    // and any new change events are queued until the execution finishes.
+    const debouncedGenerate = (0, debounce_1.debounce)(() => {
+        changedPaths.forEach((path) => {
+            (0, cache_1.clearVisitedDirsCacheAbove)(path);
+        });
+        changedPaths.clear();
+        (0, cache_1.clearCntCache)();
+        onGenerate();
+    }, 300);
+    const watcher = chokidar_1.default.watch(baseDir, {
+        ignoreInitial: true,
+        // If we exclude everything except files using ignored, the watch mode will terminate, so we added "only files" to the exclusion condition.
+        ignored: (path, stats) => !!(stats === null || stats === void 0 ? void 0 : stats.isFile()) && !isTargetFiles(path),
+    });
+    watcher.on("ready", () => {
+        watcher.on("all", (event, path) => {
+            if (isTargetFiles(path)) {
+                logger.info(`[${event}] ${path}`);
+                changedPaths.add(path);
+                debouncedGenerate();
+            }
+        });
+    });
+};
+exports.setupWatcher = setupWatcher;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rpc4next",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "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",
@@ -24,7 +24,7 @@
     "dist"
   ],
   "bin": {
-    "rpc4next": "dist/cli/cli.js"
+    "rpc4next": "dist/cli/index.js"
   },
   "exports": {
     "./client": {