postgresdk 0.6.2 → 0.6.4

package/README.md

@@ -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 api/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:

package/dist/cli.js

@@ -741,7 +741,7 @@ var init_cli_pull = () => {};
 
 // src/index.ts
 var import_config = __toESM(require_config(), 1);
-import { join } from "node:path";
+import { join, relative } from "node:path";
 import { pathToFileURL } from "node:url";
 
 // src/introspect.ts
@@ -2340,15 +2340,15 @@ export async function deleteRecord(
 }
 
 // src/emit-tests.ts
-function emitTableTest(table, framework = "vitest") {
+function emitTableTest(table, clientPath, framework = "vitest") {
   const Type = pascal(table.name);
   const tableName = table.name;
   const imports = getFrameworkImports(framework);
   const sampleData = generateSampleData(table);
   const updateData = generateUpdateData(table);
   return `${imports}
-import { SDK } from '../client';
-import type { Insert${Type}, Update${Type}, Select${Type} } from '../client/types/${tableName}';
+import { SDK } from '${clientPath}';
+import type { Insert${Type}, Update${Type}, Select${Type} } from '${clientPath}/types/${tableName}';
 
 /**
  * Basic tests for ${tableName} table operations
@@ -2371,7 +2371,7 @@ describe('${Type} SDK Operations', () => {
 });
 `;
 }
-function emitTestSetup(framework = "vitest") {
+function emitTestSetup(clientPath, framework = "vitest") {
   return `/**
  * Test Setup and Utilities
  * 
@@ -2390,7 +2390,7 @@ export const TEST_API_KEY = process.env.TEST_API_KEY;
 
 // Utility to create SDK instance
 export function createTestSDK() {
-  const { SDK } = require('../client');
+  const { SDK } = require('${clientPath}');
   return new SDK({
     baseUrl: TEST_API_URL,
     auth: TEST_API_KEY ? { apiKey: TEST_API_KEY } : undefined
@@ -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) {
@@ -2779,9 +2810,10 @@ async function generate(configPath) {
   });
   if (generateTests) {
     console.log("\uD83E\uDDEA Generating tests...");
+    const relativeClientPath = relative(testDir, clientDir);
     files.push({
       path: join(testDir, "setup.ts"),
-      content: emitTestSetup(testFramework)
+      content: emitTestSetup(relativeClientPath, testFramework)
     });
     files.push({
       path: join(testDir, "docker-compose.yml"),
@@ -2794,7 +2826,7 @@ async function generate(configPath) {
     for (const table of Object.values(model.tables)) {
       files.push({
         path: join(testDir, `${table.name}.test.ts`),
-        content: emitTableTest(table, testFramework)
+        content: emitTableTest(table, relativeClientPath, testFramework)
       });
     }
   }
@@ -2806,8 +2838,10 @@ async function generate(configPath) {
   if (generateTests) {
     const testsInSubdir = originalTestDir === serverDir || originalTestDir === originalClientDir;
     console.log(`  Tests: ${testsInSubdir ? testDir + " (in tests subdir due to same output dir)" : 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`);
+    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/emit-tests.d.ts

@@ -2,11 +2,11 @@ import type { Table } from "./introspect";
 /**
  * Generate basic SDK tests for a table
  */
-export declare function emitTableTest(table: Table, framework?: "vitest" | "jest" | "bun"): string;
+export declare function emitTableTest(table: Table, clientPath: string, framework?: "vitest" | "jest" | "bun"): string;
 /**
  * Generate a test setup file
  */
-export declare function emitTestSetup(framework?: "vitest" | "jest" | "bun"): string;
+export declare function emitTestSetup(clientPath: string, framework?: "vitest" | "jest" | "bun"): string;
 /**
  * Generate docker-compose.yml for test database
  */

package/dist/index.js

@@ -471,7 +471,7 @@ var require_config = __commonJS(() => {
 
 // src/index.ts
 var import_config = __toESM(require_config(), 1);
-import { join } from "node:path";
+import { join, relative } from "node:path";
 import { pathToFileURL } from "node:url";
 
 // src/introspect.ts
@@ -2070,15 +2070,15 @@ export async function deleteRecord(
 }
 
 // src/emit-tests.ts
-function emitTableTest(table, framework = "vitest") {
+function emitTableTest(table, clientPath, framework = "vitest") {
   const Type = pascal(table.name);
   const tableName = table.name;
   const imports = getFrameworkImports(framework);
   const sampleData = generateSampleData(table);
   const updateData = generateUpdateData(table);
   return `${imports}
-import { SDK } from '../client';
-import type { Insert${Type}, Update${Type}, Select${Type} } from '../client/types/${tableName}';
+import { SDK } from '${clientPath}';
+import type { Insert${Type}, Update${Type}, Select${Type} } from '${clientPath}/types/${tableName}';
 
 /**
  * Basic tests for ${tableName} table operations
@@ -2101,7 +2101,7 @@ describe('${Type} SDK Operations', () => {
 });
 `;
 }
-function emitTestSetup(framework = "vitest") {
+function emitTestSetup(clientPath, framework = "vitest") {
   return `/**
  * Test Setup and Utilities
  * 
@@ -2120,7 +2120,7 @@ export const TEST_API_KEY = process.env.TEST_API_KEY;
 
 // Utility to create SDK instance
 export function createTestSDK() {
-  const { SDK } = require('../client');
+  const { SDK } = require('${clientPath}');
   return new SDK({
     baseUrl: TEST_API_URL,
     auth: TEST_API_KEY ? { apiKey: TEST_API_KEY } : undefined
@@ -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) {
@@ -2509,9 +2540,10 @@ async function generate(configPath) {
   });
   if (generateTests) {
     console.log("\uD83E\uDDEA Generating tests...");
+    const relativeClientPath = relative(testDir, clientDir);
     files.push({
       path: join(testDir, "setup.ts"),
-      content: emitTestSetup(testFramework)
+      content: emitTestSetup(relativeClientPath, testFramework)
     });
     files.push({
       path: join(testDir, "docker-compose.yml"),
@@ -2524,7 +2556,7 @@ async function generate(configPath) {
     for (const table of Object.values(model.tables)) {
       files.push({
         path: join(testDir, `${table.name}.test.ts`),
-        content: emitTableTest(table, testFramework)
+        content: emitTableTest(table, relativeClientPath, testFramework)
       });
     }
   }
@@ -2536,8 +2568,10 @@ async function generate(configPath) {
   if (generateTests) {
     const testsInSubdir = originalTestDir === serverDir || originalTestDir === originalClientDir;
     console.log(`  Tests: ${testsInSubdir ? testDir + " (in tests subdir due to same output dir)" : 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`);
+    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.2",
+  "version": "0.6.4",
   "description": "Generate a typed server/client SDK from a Postgres schema (includes, Zod, Hono).",
   "type": "module",
   "bin": {