postgresdk 0.6.1 → 0.6.3

package/README.md

@@ -43,7 +43,7 @@ Get a complete, type-safe SDK with:
 ### 🎯 Client SDK with Full TypeScript Support
 
 ```typescript
-import { SDK } from "./generated/client";
+import { SDK } from "./api/client";
 
 const sdk = new SDK({ 
   baseUrl: "http://localhost:3000",
@@ -89,7 +89,7 @@ const recentBooks = await sdk.books.list({
 ```typescript
 import { Hono } from "hono";
 import { Client } from "pg";
-import { createRouter } from "./generated/server/router";
+import { createRouter } from "./api/server/router";
 
 const app = new Hono();
 const pg = new Client({ connectionString: process.env.DATABASE_URL });
@@ -124,7 +124,7 @@ const book = await sdk.books.create({
 });
 
 // Generated Zod schemas for runtime validation
-import { InsertBooksSchema } from "./generated/server/zod/books";
+import { InsertBooksSchema } from "./api/server/zod/books";
 
 const validated = InsertBooksSchema.parse(requestBody);
 ```
@@ -182,7 +182,7 @@ postgresdk generate
 // Server (Hono)
 import { Hono } from "hono";
 import { Client } from "pg";
-import { registerUsersRoutes } from "./generated/server/routes/users";
+import { registerUsersRoutes } from "./api/server/routes/users";
 
 const app = new Hono();
 const pg = new Client({ connectionString: "..." });
@@ -191,7 +191,7 @@ await pg.connect();
 registerUsersRoutes(app, { pg });
 
 // Client
-import { SDK } from "./generated/client";
+import { SDK } from "./api/client";
 
 const sdk = new SDK({ baseUrl: "http://localhost:3000" });
 
@@ -213,8 +213,8 @@ export default {
   
   // Optional (with defaults)
   schema: "public",                    // Database schema to introspect
-  outServer: "./generated/server",     // Server code output directory  
-  outClient: "./generated/client",     // Client SDK output directory
+  outServer: "./api/server",           // Server code output directory  
+  outClient: "./api/client",           // Client SDK output directory
   softDeleteColumn: null,              // Column name for soft deletes (e.g., "deleted_at")
   includeDepthLimit: 3,                 // Max depth for nested includes
   dateType: "date",                    // "date" | "string" - How to handle timestamps
@@ -507,7 +507,7 @@ Server setup:
 ```typescript
 import { Hono } from "hono";
 import { Client } from "pg";
-import { createRouter } from "./generated/server/router";
+import { createRouter } from "./api/server/router";
 
 const app = new Hono();
 
@@ -540,7 +540,7 @@ Server setup:
 ```typescript
 import { Hono } from "hono";
 import { Pool } from "@neondatabase/serverless";
-import { createRouter } from "./generated/server/router";
+import { createRouter } from "./api/server/router";
 
 const app = new Hono();
 
@@ -577,7 +577,7 @@ For production Node.js deployments, use connection pooling:
 
 ```typescript
 import { Pool } from "pg";
-import { createRouter } from "./generated/server/router";
+import { createRouter } from "./api/server/router";
 
 const pool = new Pool({
   connectionString: process.env.DATABASE_URL,
@@ -627,7 +627,7 @@ postgresdk generates a `createRouter` function that returns a Hono router with a
 import { Hono } from "hono";
 import { serve } from "@hono/node-server";
 import { Client } from "pg";
-import { createRouter } from "./generated/server/router";
+import { createRouter } from "./api/server/router";
 
 const app = new Hono();
 
@@ -650,7 +650,7 @@ The `createRouter` function returns a Hono router that can be mounted anywhere:
 
 ```typescript
 import { Hono } from "hono";
-import { createRouter } from "./generated/server/router";
+import { createRouter } from "./api/server/router";
 
 const app = new Hono();
 
@@ -671,7 +671,7 @@ app.route("/v2", apiRouter);   // Routes will be at /v2/v1/users, /v2/v1/posts,
 If you prefer to register routes directly on your app without a sub-router:
 
 ```typescript
-import { registerAllRoutes } from "./generated/server/router";
+import { registerAllRoutes } from "./api/server/router";
 
 const app = new Hono();
 const pg = new Client({ connectionString: process.env.DATABASE_URL });
@@ -686,7 +686,7 @@ registerAllRoutes(app, { pg });
 You can also import and register individual routes:
 
 ```typescript
-import { registerUsersRoutes, registerPostsRoutes } from "./generated/server/router";
+import { registerUsersRoutes, registerPostsRoutes } from "./api/server/router";
 
 const app = new Hono();
 
@@ -717,8 +717,8 @@ const pg = new Client({ connectionString: process.env.DATABASE_URL });
 await pg.connect();
 
 // All generated routes are prefixed with /v1 by default
-import { registerUsersRoutes } from "./generated/server/routes/users";
-import { registerPostsRoutes } from "./generated/server/routes/posts";
+import { registerUsersRoutes } from "./api/server/routes/users";
+import { registerPostsRoutes } from "./api/server/routes/posts";
 
 registerUsersRoutes(app, { pg });  // Adds /v1/users/*
 registerPostsRoutes(app, { pg });  // Adds /v1/posts/*
@@ -756,7 +756,7 @@ app.use("*", async (c, next) => {
 const pg = new Client({ connectionString: process.env.DATABASE_URL });
 await pg.connect();
 
-import { registerUsersRoutes } from "./generated/server/routes/users";
+import { registerUsersRoutes } from "./api/server/routes/users";
 registerUsersRoutes(app, { pg });
 ```
 
@@ -779,8 +779,8 @@ const pool = new Pool({
 const app = new Hono();
 
 // The generated routes work with both Client and Pool
-import { registerUsersRoutes } from "./generated/server/routes/users";
-import { registerPostsRoutes } from "./generated/server/routes/posts";
+import { registerUsersRoutes } from "./api/server/routes/users";
+import { registerPostsRoutes } from "./api/server/routes/posts";
 
 registerUsersRoutes(app, { pg: pool });
 registerPostsRoutes(app, { pg: pool });
@@ -831,9 +831,9 @@ import { serve } from "@hono/node-server";
 import { Pool } from "pg";
 
 // Import all generated route registrations
-import { registerUsersRoutes } from "./generated/server/routes/users";
-import { registerPostsRoutes } from "./generated/server/routes/posts";
-import { registerCommentsRoutes } from "./generated/server/routes/comments";
+import { registerUsersRoutes } from "./api/server/routes/users";
+import { registerPostsRoutes } from "./api/server/routes/posts";
+import { registerCommentsRoutes } from "./api/server/routes/comments";
 
 // Create app with type safety
 const app = new Hono();
@@ -988,7 +988,7 @@ export default {
   
   tests: {
     generate: true,              // Enable test generation
-    output: "./generated/tests", // Output directory
+    output: "./api/tests",       // Output directory
     framework: "vitest"          // Test framework (vitest, jest, or bun)
   }
 };
@@ -1005,38 +1005,30 @@ When tests are enabled, postgresdk generates:
 
 ### Running Tests with Docker
 
-The generated Docker setup makes it easy to run tests in isolation:
+The generated test setup includes a Docker Compose file and a test runner script:
 
 ```bash
-# Navigate to test directory
-cd generated/tests
-
-# Start test database
-docker-compose up -d
-
-# Wait for database to be ready
-sleep 3
-
-# Set environment variables
-export TEST_DATABASE_URL="postgres://testuser:testpass@localhost:5432/testdb"
-export TEST_API_URL="http://localhost:3000"
-
-# Run your migrations on test database
-# (your migration command here)
-
-# Start your API server
-npm run dev &
-
-# Run tests
-npm test
-
-# Stop database when done
-docker-compose down
-
-# Or use the generated script
-bash run-tests.sh
+# 1. Make the test script executable (first time only)
+chmod +x api/tests/run-tests.sh
+
+# 2. Edit api/tests/run-tests.sh to configure:
+#    - Your API server startup command
+#    - Migration commands (if needed)
+#    - Any other setup specific to your project
+
+# 3. Run the tests
+./api/tests/run-tests.sh
+
+# The script will:
+# - Start a PostgreSQL 17 test database in Docker
+# - Wait for it to be ready
+# - Run your API server (once configured)
+# - Execute the test suite
+# - Provide cleanup instructions
 ```
 
+The test script includes detailed comments and examples for common setups. You'll need to uncomment and customize the API server startup section for your specific project.
+
 ### Customizing Tests
 
 The generated tests are basic and meant as a starting point. Create your own test files for:
@@ -1052,7 +1044,7 @@ Example custom test:
 ```typescript
 // tests/custom/user-workflow.test.ts
 import { describe, it, expect } from 'vitest';
-import { createTestSDK, randomEmail } from '../generated/tests/setup';
+import { createTestSDK, randomEmail } from '../api/tests/setup';
 
 describe('User Registration Workflow', () => {
   const sdk = createTestSDK();

package/dist/cli.js

@@ -535,15 +535,15 @@ export default {
   
   /**
    * Output directory for server-side code (routes, validators, etc.)
-   * @default "./generated/server"
+   * @default "./api/server"
    */
-  // outServer: "./generated/server",
+  // outServer: "./api/server",
   
   /**
    * Output directory for client SDK
-   * @default "./generated/client"
+   * @default "./api/client"
    */
-  // outClient: "./generated/client",
+  // outClient: "./api/client",
   
   // ========== ADVANCED OPTIONS ==========
   
@@ -598,7 +598,7 @@ export default {
    */
   // tests: {
   //   generate: true,
-  //   output: "./generated/tests",
+  //   output: "./api/tests",
   //   framework: "vitest"  // or "jest" or "bun"
   // },
   
@@ -2428,7 +2428,7 @@ version: '3.8'
 
 services:
   postgres:
-    image: postgres:16-alpine
+    image: postgres:17-alpine
     environment:
       POSTGRES_USER: testuser
       POSTGRES_PASSWORD: testpass
@@ -2452,11 +2452,23 @@ function emitTestScript(framework = "vitest") {
   return `#!/bin/bash
 # Test Runner Script
 # 
-# This script sets up and runs tests with a Docker PostgreSQL database
+# This script sets up and runs tests with a Docker PostgreSQL database.
+# 
+# Usage:
+#   chmod +x run-tests.sh  # Make executable (first time only)
+#   ./run-tests.sh
+#
+# Prerequisites:
+#   - Docker installed and running
+#   - Your API server code in the parent directories
+#   - Test framework installed (${framework})
 
 set -e
 
+SCRIPT_DIR="$( cd "$( dirname "\${BASH_SOURCE[0]}" )" && pwd )"
+
 echo "\uD83D\uDC33 Starting test database..."
+cd "$SCRIPT_DIR"
 docker-compose up -d --wait
 
 # Export test database URL
@@ -2465,24 +2477,43 @@ export TEST_API_URL="http://localhost:3000"
 
 # Wait for database to be ready
 echo "⏳ Waiting for database..."
-sleep 2
+sleep 3
 
-# Run migrations if needed (customize this)
-# npm run migrate
+# TODO: Run your migrations on the test database
+# Example:
+# echo "\uD83D\uDCCA Running migrations..."
+# npm run migrate -- --database-url="$TEST_DATABASE_URL"
 
 echo "\uD83D\uDE80 Starting API server..."
-# Start your API server in the background
-# npm run dev &
+echo "⚠️  TODO: Uncomment and customize the API server startup command below:"
+echo ""
+echo "  # Example for Node.js/Bun:"
+echo "  # cd ../.. && npm run dev &"
+echo "  # SERVER_PID=$!"
+echo ""
+echo "  # Example for custom server file:"
+echo "  # cd ../.. && node server.js &"
+echo "  # SERVER_PID=$!"
+echo ""
+echo "  Please edit this script to start your API server."
+echo ""
+# cd ../.. && npm run dev &
 # SERVER_PID=$!
 # sleep 3
 
 echo "\uD83E\uDDEA Running tests..."
-${runCommand} $@
+${runCommand} "$@"
 
 # Cleanup
-# kill $SERVER_PID 2>/dev/null || true
+# if [ ! -z "\${SERVER_PID}" ]; then
+#   echo "\uD83D\uDED1 Stopping API server..."
+#   kill $SERVER_PID 2>/dev/null || true
+# fi
 
 echo "✅ Tests completed!"
+echo ""
+echo "To stop the test database, run:"
+echo "  cd $SCRIPT_DIR && docker-compose down"
 `;
 }
 function getFrameworkImports(framework) {
@@ -2682,8 +2713,8 @@ async function generate(configPath) {
   const model = await introspect(cfg.connectionString, cfg.schema || "public");
   console.log("\uD83D\uDD17 Building relationship graph...");
   const graph = buildGraph(model);
-  const serverDir = cfg.outServer || "./generated/server";
-  const originalClientDir = cfg.outClient || "./generated/client";
+  const serverDir = cfg.outServer || "./api/server";
+  const originalClientDir = cfg.outClient || "./api/client";
   const sameDirectory = serverDir === originalClientDir;
   let clientDir = originalClientDir;
   if (sameDirectory) {
@@ -2692,7 +2723,11 @@ async function generate(configPath) {
   const normDateType = cfg.dateType === "string" ? "string" : "date";
   const serverFramework = cfg.serverFramework || "hono";
   const generateTests = cfg.tests?.generate ?? false;
-  const testDir = cfg.tests?.output || "./generated/tests";
+  const originalTestDir = cfg.tests?.output || "./api/tests";
+  let testDir = originalTestDir;
+  if (generateTests && (originalTestDir === serverDir || originalTestDir === originalClientDir)) {
+    testDir = join(originalTestDir, "tests");
+  }
   const testFramework = cfg.tests?.framework || "vitest";
   console.log("\uD83D\uDCC1 Creating directories...");
   const dirs = [
@@ -2800,9 +2835,12 @@ async function generate(configPath) {
   console.log(`  Server: ${serverDir}`);
   console.log(`  Client: ${sameDirectory ? clientDir + " (in sdk subdir due to same output dir)" : clientDir}`);
   if (generateTests) {
-    console.log(`  Tests: ${testDir}`);
-    console.log(`  \uD83D\uDC33 Run 'cd ${testDir} && docker-compose up -d' to start test database`);
-    console.log(`  \uD83E\uDDEA Run 'bash ${testDir}/run-tests.sh' to execute tests`);
+    const testsInSubdir = originalTestDir === serverDir || originalTestDir === originalClientDir;
+    console.log(`  Tests: ${testsInSubdir ? testDir + " (in tests subdir due to same output dir)" : testDir}`);
+    console.log(`  \uD83D\uDCDD Test setup:`);
+    console.log(`     1. Make script executable: chmod +x ${testDir}/run-tests.sh`);
+    console.log(`     2. Edit the script to configure your API server startup`);
+    console.log(`     3. Run tests: ${testDir}/run-tests.sh`);
   }
 }
 

package/dist/index.js

@@ -2158,7 +2158,7 @@ version: '3.8'
 
 services:
   postgres:
-    image: postgres:16-alpine
+    image: postgres:17-alpine
     environment:
       POSTGRES_USER: testuser
       POSTGRES_PASSWORD: testpass
@@ -2182,11 +2182,23 @@ function emitTestScript(framework = "vitest") {
   return `#!/bin/bash
 # Test Runner Script
 # 
-# This script sets up and runs tests with a Docker PostgreSQL database
+# This script sets up and runs tests with a Docker PostgreSQL database.
+# 
+# Usage:
+#   chmod +x run-tests.sh  # Make executable (first time only)
+#   ./run-tests.sh
+#
+# Prerequisites:
+#   - Docker installed and running
+#   - Your API server code in the parent directories
+#   - Test framework installed (${framework})
 
 set -e
 
+SCRIPT_DIR="$( cd "$( dirname "\${BASH_SOURCE[0]}" )" && pwd )"
+
 echo "\uD83D\uDC33 Starting test database..."
+cd "$SCRIPT_DIR"
 docker-compose up -d --wait
 
 # Export test database URL
@@ -2195,24 +2207,43 @@ export TEST_API_URL="http://localhost:3000"
 
 # Wait for database to be ready
 echo "⏳ Waiting for database..."
-sleep 2
+sleep 3
 
-# Run migrations if needed (customize this)
-# npm run migrate
+# TODO: Run your migrations on the test database
+# Example:
+# echo "\uD83D\uDCCA Running migrations..."
+# npm run migrate -- --database-url="$TEST_DATABASE_URL"
 
 echo "\uD83D\uDE80 Starting API server..."
-# Start your API server in the background
-# npm run dev &
+echo "⚠️  TODO: Uncomment and customize the API server startup command below:"
+echo ""
+echo "  # Example for Node.js/Bun:"
+echo "  # cd ../.. && npm run dev &"
+echo "  # SERVER_PID=$!"
+echo ""
+echo "  # Example for custom server file:"
+echo "  # cd ../.. && node server.js &"
+echo "  # SERVER_PID=$!"
+echo ""
+echo "  Please edit this script to start your API server."
+echo ""
+# cd ../.. && npm run dev &
 # SERVER_PID=$!
 # sleep 3
 
 echo "\uD83E\uDDEA Running tests..."
-${runCommand} $@
+${runCommand} "$@"
 
 # Cleanup
-# kill $SERVER_PID 2>/dev/null || true
+# if [ ! -z "\${SERVER_PID}" ]; then
+#   echo "\uD83D\uDED1 Stopping API server..."
+#   kill $SERVER_PID 2>/dev/null || true
+# fi
 
 echo "✅ Tests completed!"
+echo ""
+echo "To stop the test database, run:"
+echo "  cd $SCRIPT_DIR && docker-compose down"
 `;
 }
 function getFrameworkImports(framework) {
@@ -2412,8 +2443,8 @@ async function generate(configPath) {
   const model = await introspect(cfg.connectionString, cfg.schema || "public");
   console.log("\uD83D\uDD17 Building relationship graph...");
   const graph = buildGraph(model);
-  const serverDir = cfg.outServer || "./generated/server";
-  const originalClientDir = cfg.outClient || "./generated/client";
+  const serverDir = cfg.outServer || "./api/server";
+  const originalClientDir = cfg.outClient || "./api/client";
   const sameDirectory = serverDir === originalClientDir;
   let clientDir = originalClientDir;
   if (sameDirectory) {
@@ -2422,7 +2453,11 @@ async function generate(configPath) {
   const normDateType = cfg.dateType === "string" ? "string" : "date";
   const serverFramework = cfg.serverFramework || "hono";
   const generateTests = cfg.tests?.generate ?? false;
-  const testDir = cfg.tests?.output || "./generated/tests";
+  const originalTestDir = cfg.tests?.output || "./api/tests";
+  let testDir = originalTestDir;
+  if (generateTests && (originalTestDir === serverDir || originalTestDir === originalClientDir)) {
+    testDir = join(originalTestDir, "tests");
+  }
   const testFramework = cfg.tests?.framework || "vitest";
   console.log("\uD83D\uDCC1 Creating directories...");
   const dirs = [
@@ -2530,9 +2565,12 @@ async function generate(configPath) {
   console.log(`  Server: ${serverDir}`);
   console.log(`  Client: ${sameDirectory ? clientDir + " (in sdk subdir due to same output dir)" : clientDir}`);
   if (generateTests) {
-    console.log(`  Tests: ${testDir}`);
-    console.log(`  \uD83D\uDC33 Run 'cd ${testDir} && docker-compose up -d' to start test database`);
-    console.log(`  \uD83E\uDDEA Run 'bash ${testDir}/run-tests.sh' to execute tests`);
+    const testsInSubdir = originalTestDir === serverDir || originalTestDir === originalClientDir;
+    console.log(`  Tests: ${testsInSubdir ? testDir + " (in tests subdir due to same output dir)" : testDir}`);
+    console.log(`  \uD83D\uDCDD Test setup:`);
+    console.log(`     1. Make script executable: chmod +x ${testDir}/run-tests.sh`);
+    console.log(`     2. Edit the script to configure your API server startup`);
+    console.log(`     3. Run tests: ${testDir}/run-tests.sh`);
   }
 }
 export {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "postgresdk",
-  "version": "0.6.1",
+  "version": "0.6.3",
   "description": "Generate a typed server/client SDK from a Postgres schema (includes, Zod, Hono).",
   "type": "module",
   "bin": {