turbine-orm 0.3.1 → 0.5.0

package/README.md

@@ -46,6 +46,16 @@ npx turbine init --url postgres://user:pass@localhost:5432/mydb
 npx turbine generate
 ```
 
+Works with both ESM and CommonJS:
+
+```typescript
+// ESM
+import { turbine } from './generated/turbine';
+
+// CommonJS
+const { turbine } = require('./generated/turbine');
+```
+
 This introspects your database and generates a fully-typed client at `./generated/turbine/`.
 
 ```typescript
@@ -167,6 +177,36 @@ const stats = await db.raw<{ day: Date; count: number }>`
 `;
 ```
 
+### Case-insensitive search
+
+```typescript
+const users = await db.users.findMany({
+  where: {
+    email: { contains: 'alice', mode: 'insensitive' },
+  },
+});
+// Generates: WHERE email ILIKE '%alice%'
+```
+
+### Query timeout
+
+```typescript
+const users = await db.users.findMany({
+  where: { orgId: 1 },
+  timeout: 5000, // 5 second timeout
+});
+```
+
+### Default limit
+
+```typescript
+// Set a default limit for all queries on a model
+const db = turbine({
+  connectionString: process.env.DATABASE_URL,
+  defaultLimit: 100,
+});
+```
+
 ### Middleware
 
 ```typescript
@@ -239,9 +279,17 @@ npx turbine generate         # Regenerate typed client
 ### Migration workflow
 
 ```bash
+# Create a new migration
 npx turbine migrate create add_users_table
-# Edit the generated .sql file with UP and DOWN sections
+# -> Creates turbine/migrations/001_add_users_table.sql with UP/DOWN sections
+
+# Apply all pending migrations
 npx turbine migrate up
+
+# Rollback the last applied migration
+npx turbine migrate down
+
+# Check migration status (applied vs pending)
 npx turbine migrate status
 ```
 
@@ -287,8 +335,9 @@ This resolves the entire 3-level object graph in one database round-trip. Prisma
 
 ## Requirements
 
-- Node.js >= 22.0.0
+- Node.js >= 18.0.0
 - PostgreSQL >= 14
+- Works with both ESM (`import`) and CommonJS (`require`)
 
 ## License
 

package/dist/cjs/cli/config.js

@@ -0,0 +1,161 @@
+"use strict";
+/**
+ * turbine-orm CLI — Configuration file support
+ *
+ * Loads turbine.config.ts (or .js/.mjs) via dynamic import.
+ * Falls back to CLI args and environment variables.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadConfig = loadConfig;
+exports.findConfigFile = findConfigFile;
+exports.resolveConfig = resolveConfig;
+exports.configTemplate = configTemplate;
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
+const node_url_1 = require("node:url");
+// ---------------------------------------------------------------------------
+// Config file names, in priority order
+// ---------------------------------------------------------------------------
+const CONFIG_FILES = [
+    'turbine.config.ts',
+    'turbine.config.mts',
+    'turbine.config.js',
+    'turbine.config.mjs',
+];
+// ---------------------------------------------------------------------------
+// Load config
+// ---------------------------------------------------------------------------
+/**
+ * Attempt to load a turbine config file from the current directory.
+ * Returns the config if found, or an empty object.
+ */
+async function loadConfig(cwd) {
+    const dir = cwd ?? process.cwd();
+    for (const filename of CONFIG_FILES) {
+        const filePath = (0, node_path_1.join)(dir, filename);
+        if (!(0, node_fs_1.existsSync)(filePath))
+            continue;
+        try {
+            const absPath = (0, node_path_1.resolve)(filePath);
+            const fileUrl = (0, node_url_1.pathToFileURL)(absPath).href;
+            // For .ts files, we need to rely on Node's --experimental-strip-types
+            // or the tsx loader. Dynamic import handles .js/.mjs natively.
+            const mod = await Promise.resolve(`${fileUrl}`).then(s => __importStar(require(s)));
+            const config = mod.default ?? mod;
+            return config;
+        }
+        catch (err) {
+            // If importing a .ts file fails, try the next one
+            if (filename.endsWith('.ts') || filename.endsWith('.mts')) {
+                continue;
+            }
+            throw new Error(`Failed to load config from ${filename}: ${err instanceof Error ? err.message : String(err)}`);
+        }
+    }
+    return {};
+}
+/**
+ * Find the config file path (for display purposes).
+ * Returns null if no config file is found.
+ */
+function findConfigFile(cwd) {
+    const dir = cwd ?? process.cwd();
+    for (const filename of CONFIG_FILES) {
+        const filePath = (0, node_path_1.join)(dir, filename);
+        if ((0, node_fs_1.existsSync)(filePath))
+            return filePath;
+    }
+    return null;
+}
+/**
+ * Merge config file values with CLI overrides and env vars.
+ * Priority: CLI flags > env vars > config file > defaults.
+ */
+function resolveConfig(fileConfig, overrides) {
+    return {
+        url: overrides.url ??
+            process.env['DATABASE_URL'] ??
+            fileConfig.url ??
+            '',
+        out: overrides.out ?? fileConfig.out ?? './generated/turbine',
+        schema: overrides.schema ?? fileConfig.schema ?? 'public',
+        include: overrides.include ?? fileConfig.include ?? [],
+        exclude: overrides.exclude ?? fileConfig.exclude ?? [],
+        migrationsDir: fileConfig.migrationsDir ?? './turbine/migrations',
+        seedFile: fileConfig.seedFile ?? './turbine/seed.ts',
+        schemaFile: fileConfig.schemaFile ?? './turbine/schema.ts',
+    };
+}
+// ---------------------------------------------------------------------------
+// Config file template (for `turbine init`)
+// ---------------------------------------------------------------------------
+function configTemplate(connectionString) {
+    const url = connectionString ?? 'process.env.DATABASE_URL';
+    const urlLine = connectionString
+        ? `  url: '${connectionString}',`
+        : `  url: process.env.DATABASE_URL,`;
+    return `import type { TurbineCliConfig } from 'turbine-orm/cli';
+
+/**
+ * Turbine configuration
+ * @see https://batadata.com/docs/turbine/config
+ */
+const config: TurbineCliConfig = {
+  /** Postgres connection string */
+${urlLine}
+
+  /** Output directory for generated types + client */
+  out: './generated/turbine',
+
+  /** Postgres schema to introspect (default: public) */
+  schema: 'public',
+
+  /** Tables to exclude from generation */
+  // exclude: ['_migrations', '_sessions'],
+
+  /** Directory for SQL migration files */
+  migrationsDir: './turbine/migrations',
+
+  /** Path to seed file */
+  seedFile: './turbine/seed.ts',
+
+  /** Path to schema builder file (for turbine push) */
+  schemaFile: './turbine/schema.ts',
+};
+
+export default config;
+`;
+}