crudora 0.1.0 → 0.2.0

package/scripts/postinstall.js

@@ -1,136 +1,172 @@
-import fs from 'fs';
-import path from 'path';
-
-// Paths
-const templatePath = path.join(__dirname, '..', 'templates', 'schema.prisma');
-const targetPrismaPath = path.join(process.cwd(), 'prisma', 'schema.prisma');
-const targetEnvPath = path.join(process.cwd(), '.env');
-const targetServerPath = path.join(process.cwd(), 'src', 'server.ts');
-const targetPackagePath = path.join(process.cwd(), 'package.json');
-
-console.log('🚀 Setting up Crudora project...');
-
-// 1. Create prisma directory and schema
-if (!fs.existsSync(path.dirname(targetPrismaPath))) {
-  console.log('📋 Creating Prisma schema...');
-  fs.mkdirSync(path.dirname(targetPrismaPath), { recursive: true });
-  fs.copyFileSync(templatePath, targetPrismaPath);
-  console.log('✅ Prisma schema created at prisma/schema.prisma');
-} else {
-  console.log('📋 Prisma directory already exists, skipping schema creation');
-}
-
-// 2. Create .env file
-if (!fs.existsSync(targetEnvPath)) {
-  console.log('🔧 Creating .env file...');
-  const envContent = `# Database
-DATABASE_URL="file:./dev.db"
-
-# Server
-PORT=3000
-NODE_ENV=development
-
-# API
-API_BASE_PATH="/api"
-`;
-  fs.writeFileSync(targetEnvPath, envContent);
-  console.log('✅ .env file created');
-} else {
-  console.log('🔧 .env file already exists, skipping creation');
-}
-
-// 3. Create basic server setup
-if (!fs.existsSync(targetServerPath)) {
-  console.log('🖥️  Creating server setup...');
-  const serverContent = `const { CrudoraServer } = require('crudora');
-const { PrismaClient } = require('@prisma/client');
-require('dotenv').config();
-
-const prisma = new PrismaClient();
-
-// Example User model (uncomment and modify as needed)
-/*
-class User {
-  static tableName = 'users';
-  static primaryKey = 'id';
-  static timestamps = true;
-  static fillable = ['name', 'email'];
-  static hidden = ['password'];
-}
-*/
-
-const server = new CrudoraServer({
-  port: process.env.PORT || 3000,
-  prisma: prisma,
-  cors: true,
-  basePath: process.env.API_BASE_PATH || '/api'
-});
-
-// Register your models here
-// server.registerModel(User);
-
-// Add custom routes if needed
-server.get('/health', (req, res) => {
-  res.json({ status: 'ok', timestamp: new Date() });
-});
-
-// Generate routes and start server
-server
-  .generateRoutes()
-  .listen(() => {
-    console.log('🚀 Crudora server is running!');
-    console.log(\`📚 API documentation: http://localhost:\${process.env.PORT || 3000}\${process.env.API_BASE_PATH || '/api'}\`);
-  });
-`;
-  fs.writeFileSync(targetServerPath, serverContent);
-  console.log('✅ Server setup created at server.ts');
-} else {
-  console.log('🖥️  server.ts already exists, skipping creation');
-}
-
-// 4. Update package.json scripts (if package.json exists)
-if (fs.existsSync(targetPackagePath)) {
-  try {
-    const packageJson = JSON.parse(fs.readFileSync(targetPackagePath, 'utf8'));
-
-    if (!packageJson.scripts) {
-      packageJson.scripts = {};
-    }
-
-    // Add useful scripts if they don't exist
-    const scriptsToAdd = {
-      'build': 'tsc',
-      'dev': 'ts-node src/server.ts',
-      'start': 'ts-node src/server.ts',
-      'start:prod': 'node dist/index.js',
-      'db:generate': 'prisma generate',
-      'db:push': 'prisma db push',
-      'db:migrate': 'prisma migrate dev',
-      'db:studio': 'prisma studio'
-    };
-
-    let scriptsAdded = false;
-    for (const [scriptName, scriptCommand] of Object.entries(scriptsToAdd)) {
-      if (!packageJson.scripts[scriptName]) {
-        packageJson.scripts[scriptName] = scriptCommand;
-        scriptsAdded = true;
-      }
-    }
-
-    if (scriptsAdded) {
-      fs.writeFileSync(targetPackagePath, JSON.stringify(packageJson, null, 2));
-      console.log('✅ Package.json scripts updated');
-    }
-  } catch (error) {
-    console.log('⚠️  Could not update package.json scripts:', error.message);
-  }
-}
-
-console.log('\n🎉 Crudora setup complete!');
-console.log('\n📝 Next steps:');
-console.log('1. Install dependencies: npm install @prisma/client prisma dotenv');
-console.log('2. Generate Prisma client: npm run db:generate');
-console.log('3. Push database schema: npm run db:push');
-console.log('4. Define your models in server.js');
-console.log('5. Start development server: npm run dev');
-console.log('\n📖 Documentation: https://github.com/suryamsj/crudora#readme');
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+// ─── Skip guards ──────────────────────────────────────────────────────────────
+// Opt-out: set CRUDORA_SKIP_POSTINSTALL=1 in CI pipelines or Docker builds.
+if (process.env.CRUDORA_SKIP_POSTINSTALL) {
+  process.exit(0);
+}
+
+// Many CI systems set CI=true — don't scaffold files into a CI workspace.
+if (process.env.CI) {
+  process.exit(0);
+}
+
+// Running inside node_modules means someone else is installing crudora as a dep.
+// Scaffold into their project root (process.cwd()), not the package directory.
+// Guard: if there's no package.json in cwd, we're probably not in a real project.
+const cwdPkgPath = path.join(process.cwd(), 'package.json');
+if (!fs.existsSync(cwdPkgPath)) {
+  process.exit(0);
+}
+
+// ─── Peer dependency check ────────────────────────────────────────────────────
+try {
+  const cwdPkg = JSON.parse(fs.readFileSync(cwdPkgPath, 'utf-8'));
+  const hasDrizzle =
+    cwdPkg.dependencies?.['drizzle-orm'] ||
+    cwdPkg.devDependencies?.['drizzle-orm'];
+  if (!hasDrizzle) {
+    console.warn(
+      '\n⚠️  Crudora: drizzle-orm is not listed in your dependencies.\n' +
+      '   Run: npm install drizzle-orm\n' +
+      '   Also install the driver for your database:\n' +
+      '     PostgreSQL: npm install pg\n' +
+      '     MySQL:      npm install mysql2\n',
+    );
+  }
+} catch {
+  // Non-fatal — package.json may not be JSON-parseable
+}
+
+const templateDir = path.join(__dirname, '..', 'templates');
+const targetEnvPath = path.join(process.cwd(), '.env');
+const targetServerPath = path.join(process.cwd(), 'src', 'server.ts');
+const targetDrizzleConfig = path.join(process.cwd(), 'drizzle.config.ts');
+const targetSchemaDir = path.join(process.cwd(), 'src', 'db');
+const targetSchemaPath = path.join(targetSchemaDir, 'schema.ts');
+
+console.log('🚀 Setting up Crudora project...');
+
+// 1. Create .env file
+if (!fs.existsSync(targetEnvPath)) {
+  console.log('🔧 Creating .env file...');
+  const envContent = `# Database — choose one based on your dialect
+# PostgreSQL
+DATABASE_URL="postgresql://user:password@localhost:5432/mydb"
+
+# MySQL (uncomment if using MySQL)
+# DATABASE_URL="mysql://user:password@localhost:3306/mydb"
+
+# Server
+PORT=3000
+NODE_ENV=development
+
+# API
+API_BASE_PATH="/api"
+`;
+  fs.writeFileSync(targetEnvPath, envContent);
+  console.log('✅ .env file created');
+} else {
+  console.log('🔧 .env file already exists, skipping creation');
+}
+
+// 2. Create drizzle.config.ts
+if (!fs.existsSync(targetDrizzleConfig)) {
+  console.log('📋 Creating drizzle.config.ts...');
+  fs.copyFileSync(path.join(templateDir, 'drizzle.config.ts'), targetDrizzleConfig);
+  console.log('✅ drizzle.config.ts created');
+} else {
+  console.log('📋 drizzle.config.ts already exists, skipping');
+}
+
+// 3. Create src/db/schema.ts
+if (!fs.existsSync(targetSchemaPath)) {
+  console.log('📋 Creating src/db/schema.ts...');
+  if (!fs.existsSync(targetSchemaDir)) {
+    fs.mkdirSync(targetSchemaDir, { recursive: true });
+  }
+  fs.copyFileSync(path.join(templateDir, 'schema.ts'), targetSchemaPath);
+  console.log('✅ src/db/schema.ts created');
+} else {
+  console.log('📋 src/db/schema.ts already exists, skipping');
+}
+
+// 4. Create basic server setup
+if (!fs.existsSync(targetServerPath)) {
+  console.log('🖥️  Creating server setup...');
+  const serverContent = `import { CrudoraServer, Model, Field } from 'crudora';
+import { drizzle } from 'drizzle-orm/node-postgres';
+import { Pool } from 'pg';
+import 'dotenv/config';
+
+const pool = new Pool({ connectionString: process.env.DATABASE_URL });
+const db = drizzle(pool);
+
+// Example User model (uncomment and modify as needed)
+/*
+class User extends Model {
+  static schema = 'auth';           // optional: database schema
+  static tableName = 'users';
+  static hidden = ['password'];
+
+  @Field({ type: 'uuid', primary: true })
+  id!: string;
+
+  @Field({ type: 'string', required: true, unique: true })
+  email!: string;
+
+  @Field({ type: 'string', required: true })
+  password!: string;
+}
+*/
+
+const server = new CrudoraServer({
+  port: Number(process.env.PORT) || 3000,
+  db,
+  dialect: 'postgresql',
+  cors: true,
+  basePath: process.env.API_BASE_PATH || '/api',
+});
+
+// Register your models here
+// server.registerModel(User);
+
+server.get('/health', (_req, res) => {
+  res.json({ success: true, data: { status: 'ok', timestamp: new Date() } });
+});
+
+server
+  .generateRoutes()
+  .listen(() => {
+    console.log('🚀 Crudora server is running!');
+  });
+`;
+  if (!fs.existsSync(path.dirname(targetServerPath))) {
+    fs.mkdirSync(path.dirname(targetServerPath), { recursive: true });
+  }
+  fs.writeFileSync(targetServerPath, serverContent);
+  console.log('✅ Server setup created at src/server.ts');
+} else {
+  console.log('🖥️  src/server.ts already exists, skipping creation');
+}
+
+console.log('\n🎉 Crudora setup complete!');
+console.log('\n📝 Next steps:');
+console.log('1. Install dependencies: npm install drizzle-orm pg');
+console.log('2. Update DATABASE_URL in .env');
+console.log('3. Define your models in src/server.ts');
+console.log('4. Add these scripts to your package.json:');
+console.log('   "dev":          "ts-node src/server.ts"');
+console.log('   "build":        "tsc"');
+console.log('   "db:generate":  "drizzle-kit generate"');
+console.log('   "db:push":      "drizzle-kit push"');
+console.log('   "db:migrate":   "drizzle-kit migrate"');
+console.log('   "db:studio":    "drizzle-kit studio"');
+console.log('5. Push schema to DB: npx drizzle-kit push');
+console.log('6. Start server: npx ts-node src/server.ts');
+console.log('\n📖 Documentation: https://github.com/suryamsj/crudora#readme');

package/templates/.env.example

@@ -1,9 +1,13 @@
-# Database
-DATABASE_URL="file:./dev.db"
-
-# Server
-PORT=3000
-NODE_ENV=development
-
-# API
-API_BASE_PATH="/api"
+# Database — choose one based on your dialect
+# PostgreSQL
+DATABASE_URL="postgresql://user:password@localhost:5432/mydb"
+
+# MySQL (uncomment if using MySQL)
+# DATABASE_URL="mysql://user:password@localhost:3306/mydb"
+
+# Server
+PORT=3000
+NODE_ENV=development
+
+# API
+API_BASE_PATH="/api"

package/templates/drizzle.config.ts

@@ -0,0 +1,10 @@
+import { defineConfig } from 'drizzle-kit';
+
+export default defineConfig({
+  schema: './src/db/schema.ts',
+  out: './drizzle',
+  dialect: 'postgresql', // or 'mysql'
+  dbCredentials: {
+    url: process.env.DATABASE_URL!,
+  },
+});

package/templates/schema.ts

@@ -0,0 +1,23 @@
+// Auto-generated by Crudora — do not edit manually
+// Run: npx crudora generate-schema > src/db/schema.ts
+//
+// Example schema with multiple PostgreSQL schemas:
+//
+// import { pgTable, pgSchema, uuid, varchar, timestamp } from 'drizzle-orm/pg-core';
+//
+// const authSchema = pgSchema('auth');
+//
+// export const usersTable = authSchema.table('users', {
+//   id: uuid('id').primaryKey(),
+//   email: varchar('email', { length: 255 }).notNull().unique(),
+//   password: varchar('password', { length: 255 }).notNull(),
+//   createdAt: timestamp('createdAt', { mode: 'date' }).defaultNow().notNull(),
+//   updatedAt: timestamp('updatedAt', { mode: 'date' }).defaultNow().notNull(),
+// });
+//
+// export const postsTable = pgTable('posts', {
+//   id: uuid('id').primaryKey(),
+//   title: varchar('title', { length: 255 }).notNull(),
+//   createdAt: timestamp('createdAt', { mode: 'date' }).defaultNow().notNull(),
+//   updatedAt: timestamp('updatedAt', { mode: 'date' }).defaultNow().notNull(),
+// });

package/dist/templates/schema.prisma

@@ -1,22 +0,0 @@
-// This is your Prisma schema file,
-// learn more about it in the docs: https://pris.ly/d/prisma-schema
-
-generator client {
-  provider = "prisma-client-js"
-}
-
-datasource db {
-  provider = "sqlite"
-  url      = env("DATABASE_URL")
-}
-
-// Add your models here
-// Example:
-// model User {
-//   id        String   @id @default(uuid())
-//   name      String
-//   email     String   @unique
-//   password  String
-//   createdAt DateTime @default(now())
-//   updatedAt DateTime @updatedAt
-// }

package/templates/schema.prisma

@@ -1,22 +0,0 @@
-// This is your Prisma schema file,
-// learn more about it in the docs: https://pris.ly/d/prisma-schema
-
-generator client {
-  provider = "prisma-client-js"
-}
-
-datasource db {
-  provider = "sqlite"
-  url      = env("DATABASE_URL")
-}
-
-// Add your models here
-// Example:
-// model User {
-//   id        String   @id @default(uuid())
-//   name      String
-//   email     String   @unique
-//   password  String
-//   createdAt DateTime @default(now())
-//   updatedAt DateTime @updatedAt
-// }