@stratum-hq/create 0.4.0 → 0.4.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stratum-hq/create",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "Create a new Stratum multi-tenancy project",
   "keywords": [
     "multi-tenancy",
@@ -16,7 +16,7 @@
     "stratum"
   ],
   "bin": {
-    "create-stratum": "./dist/index.js"
+    "create-stratum": "./dist/bin.js"
   },
   "exports": {
     ".": "./dist/index.js",
@@ -24,7 +24,7 @@
   },
   "type": "module",
   "scripts": {
-    "build": "esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --external:@stratum-hq/* && esbuild src/matrix.ts --bundle --platform=node --format=esm --outfile=dist/matrix.js --external:@stratum-hq/*",
+    "build": "esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --external:@stratum-hq/* && esbuild src/matrix.ts --bundle --platform=node --format=esm --outfile=dist/matrix.js --external:@stratum-hq/* && esbuild src/bin.ts --platform=node --format=esm --outfile=dist/bin.js",
     "typecheck": "tsc --noEmit",
     "lint": "eslint .",
     "test": "vitest run"

package/src/bin.ts

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+
+// The bin calls main() without a check on process.argv[1]. npm runs the bin
+// through a symlink, so a compare of argv[1] with the module path is false.
+import { main } from "./index.js";
+
+main(process.argv.slice(2));

package/src/generators/db-setup.ts

@@ -203,60 +203,120 @@ export default config;
     },
     {
       filename: "src/stratum-knex.ts",
-      content: `// Knex with Stratum tenant-scoped queries
+      content: preset.database === "postgres" ? KNEX_POSTGRES_SCOPE : knexColumnScope(preset.database),
+    },
+  ];
+}
+
+// PostgreSQL does not accept a bind parameter in SET, so the generated code
+// calls set_config. The third argument (is_local = true) ends the setting with
+// the transaction, so a pooled connection never keeps another tenant's ID.
+const KNEX_POSTGRES_SCOPE = `// Knex with Stratum tenant-scoped queries
+import createKnex, { type Knex } from "knex";
+import config from "../knexfile.js";
+
+const knex = createKnex(config);
+
+// Run fn in a transaction that sets app.current_tenant_id, the setting that
+// the RLS policies read. The setting ends with the transaction, so run every
+// tenant query through trx, not through knex.
+export async function withTenantScope<T>(
+  tenantId: string,
+  fn: (trx: Knex.Transaction) => Promise<T>,
+): Promise<T> {
+  return knex.transaction(async (trx) => {
+    await trx.raw("SELECT set_config('app.current_tenant_id', ?, true)", [tenantId]);
+    return fn(trx);
+  });
+}
+
+// Usage:
+// const orders = await withTenantScope(currentTenantId, (trx) => trx("orders").select());
+
+export { knex };
+`;
+
+function knexColumnScope(database: string): string {
+  return `// Knex with Stratum tenant-scoped queries
 import Knex from "knex";
 import config from "../knexfile.js";
 
 const knex = Knex(config);
 
 // Create a tenant-scoped query builder.
-// For RLS strategy, set the session variable before queries.
 export async function withTenantScope(tenantId: string, fn: (db: typeof knex) => Promise<void>) {
-${preset.database === "postgres" ? `  await knex.raw("SET app.current_tenant = ?", [tenantId]);` : `  // For ${preset.database}, scope queries by tenant_id column`}
-  try {
-    await fn(knex);
-  } finally {
-${preset.database === "postgres" ? `    await knex.raw("RESET app.current_tenant");` : `    // Scope cleanup not needed for column-based isolation`}
-  }
+  // For ${database}, scope queries by tenant_id column
+  await fn(knex);
 }
 
 export { knex };
-`,
-    },
-  ];
+`;
+}
+
+// @stratum-hq/mongodb has no Mongoose connection helper. The generated code uses
+// Mongoose directly and copies the tenant names of the @stratum-hq/mongodb
+// adapters, so MongoDatabaseAdapter and MongoCollectionAdapter find the same
+// data, for example for purgeTenantData.
+function generateMongooseSetup(preset: StackPreset): DbSetupFile[] {
+  const tenantAccess =
+    preset.strategy === "collection"
+      ? `// Return the tenant's model for a base collection. The tenant's documents are
+// in the collection {baseCollection}_{tenantSlug}, the name that
+// MongoCollectionAdapter from @stratum-hq/mongodb uses.
+export function getTenantModel<T>(
+  baseCollection: string,
+  schema: mongoose.Schema<T>,
+  tenantSlug: string,
+) {
+  const name = \`\${baseCollection}_\${assertSlug(tenantSlug)}\`;
+  return mainConnection.models[name] ?? mainConnection.model(name, schema, name);
+}
+
+// Usage:
+// const Order = getTenantModel("orders", OrderSchema, "tenant_abc");
+// const orders = await Order.find();`
+      : `// Return a connection to the tenant's own database. The database name is
+// stratum_tenant_{tenantSlug}, the name that MongoDatabaseAdapter from
+// @stratum-hq/mongodb uses. useCache returns the same connection on each call.
+export function getTenantConnection(tenantSlug: string) {
+  return mainConnection.useDb(\`stratum_tenant_\${assertSlug(tenantSlug)}\`, { useCache: true });
 }
 
-function generateMongooseSetup(_preset: StackPreset): DbSetupFile[] {
+// Usage:
+// const conn = getTenantConnection("tenant_abc");
+// const Order = conn.model("Order", OrderSchema);
+// const orders = await Order.find();`;
+
   return [
     {
       filename: "src/stratum-mongoose.ts",
       content: `// Mongoose with Stratum multi-tenant support
 import mongoose from "mongoose";
-import { createTenantConnection } from "@stratum-hq/mongodb";
 
 // Main connection (used for tenant metadata)
 const mainConnection = mongoose.createConnection(
   process.env.MONGODB_URI || "mongodb://localhost:27017/main",
 );
 
-// Create a tenant-scoped connection.
-// Each tenant gets its own database (database-per-tenant strategy)
-// or collection prefix (collection strategy).
-export function getTenantConnection(tenantId: string) {
-  return createTenantConnection(mainConnection, tenantId);
+// A tenant slug becomes part of a MongoDB name, so it must match the Stratum
+// slug rule: a lowercase letter, then lowercase letters, digits or underscores.
+const SLUG_PATTERN = /^[a-z][a-z0-9_]{0,62}$/;
+
+function assertSlug(tenantSlug: string): string {
+  if (!SLUG_PATTERN.test(tenantSlug)) {
+    throw new Error(\`Invalid tenant slug: "\${tenantSlug}"\`);
+  }
+  return tenantSlug;
 }
 
+${tenantAccess}
+
 // Define schemas that work across tenant connections
 export const TenantSchema = new mongoose.Schema({
   name: { type: String, required: true },
   createdAt: { type: Date, default: Date.now },
 });
 
-// Usage:
-// const conn = getTenantConnection("tenant-abc");
-// const Order = conn.model("Order", OrderSchema);
-// const orders = await Order.find();
-
 export { mainConnection };
 `,
     },
@@ -276,7 +336,11 @@ const pool = mysql.createPool({
 });
 
 // Execute a query scoped to a tenant by filtering on tenant_id
-export async function tenantQuery(tenantId: string, sql: string, params: unknown[] = []) {
+export async function tenantQuery(
+  tenantId: string,
+  sql: string,
+  params: (string | number | bigint | boolean | Date | null)[] = [],
+) {
   const [rows] = await pool.execute(sql, [...params, tenantId]);
   return rows;
 }
@@ -302,9 +366,10 @@ const pool = new Pool({
 });
 
 // Create a tenant-scoped pool.
-// Sets app.current_tenant on each connection for RLS enforcement.
+// Each query runs in a transaction that sets app.current_tenant_id, the
+// setting that the RLS policies read.
 export function getTenantPool(tenantId: string) {
-  return createTenantPool(pool, tenantId);
+  return createTenantPool(pool, () => tenantId);
 }
 
 // Usage:

package/src/generators/init-sql.ts

@@ -65,8 +65,11 @@ function generatePostgresInit(projectName: string, dbName: string, strategy: str
 --   ALTER TABLE your_table ENABLE ROW LEVEL SECURITY;
 --   ALTER TABLE your_table FORCE ROW LEVEL SECURITY;
 --   CREATE POLICY tenant_isolation ON your_table
---     USING (tenant_id = current_setting('app.current_tenant_id')::uuid);
+--     USING (tenant_id = NULLIF(current_setting('app.current_tenant_id', true), '')::uuid);
 --
+-- A pooled connection reads the setting as '' after a tenant transaction ends,
+-- or as NULL before the first one. NULLIF makes both return no rows; a bare
+-- ::uuid cast of '' raises an error.
 -- FORCE makes the policy apply to the table owner too; without it, a table
 -- created by the application role is not isolated for that role.
 -- The Stratum db-adapters package sets app.current_tenant_id automatically.

package/src/generators/package-json.ts

@@ -1,16 +1,24 @@
 import type { StackPreset } from "../matrix.js";
+import { rootSources } from "./tsconfig.js";
+import { STRATUM_RANGES } from "../stratum-versions.js";
 
 export function generatePresetPackageJson(projectName: string, preset: StackPreset): string {
   const deps: Record<string, string> = {
-    "@stratum-hq/lib": "^0.2.0",
+    "@stratum-hq/lib": STRATUM_RANGES["@stratum-hq/lib"],
   };
   const devDeps: Record<string, string> = {
     typescript: "^5.3.0",
     "@types/node": "^20.11.0",
   };
+  // NestJS injection needs the decorator metadata that tsc emits and tsx does not.
+  if (preset.framework === "nestjs") {
+    devDeps["tsc-watch"] = "^7.2.0";
+  } else if (preset.framework !== "nextjs") {
+    devDeps["tsx"] = "^4.7.0";
+  }
 
   // Database driver deps
-  addDatabaseDeps(deps, preset);
+  addDatabaseDeps(deps, devDeps, preset);
 
   // ORM deps
   addOrmDeps(deps, devDeps, preset);
@@ -41,9 +49,14 @@ export function generatePresetPackageJson(projectName: string, preset: StackPres
   );
 }
 
-function addDatabaseDeps(deps: Record<string, string>, preset: StackPreset): void {
+function addDatabaseDeps(deps: Record<string, string>, devDeps: Record<string, string>, preset: StackPreset): void {
   switch (preset.database) {
     case "postgres":
+      // The generated code for these ORMs imports pg itself. The strict tsc
+      // build fails with TS7016 when the pg types are not installed.
+      if (preset.orm === "pg" || preset.orm === "prisma" || preset.orm === "drizzle") {
+        devDeps["@types/pg"] = "^8.11.0";
+      }
       if (preset.orm !== "prisma" && preset.orm !== "drizzle" && preset.orm !== "sequelize") {
         deps["pg"] = "^8.11.0";
       }
@@ -139,19 +152,19 @@ function addFrameworkDeps(deps: Record<string, string>, devDeps: Record<string,
 
 function addStratumDeps(deps: Record<string, string>, preset: StackPreset): void {
   if (preset.database === "postgres" && preset.orm !== "mongoose") {
-    deps["@stratum-hq/db-adapters"] = "^0.2.0";
+    deps["@stratum-hq/db-adapters"] = STRATUM_RANGES["@stratum-hq/db-adapters"];
   }
   if (preset.database === "mongodb") {
-    deps["@stratum-hq/mongodb"] = "^0.2.0";
+    deps["@stratum-hq/mongodb"] = STRATUM_RANGES["@stratum-hq/mongodb"];
   }
   if (preset.database === "mysql") {
-    deps["@stratum-hq/mysql"] = "^0.2.0";
+    deps["@stratum-hq/mysql"] = STRATUM_RANGES["@stratum-hq/mysql"];
   }
   if (preset.framework === "hono") {
-    deps["@stratum-hq/hono"] = "^0.2.0";
+    deps["@stratum-hq/hono"] = STRATUM_RANGES["@stratum-hq/hono"];
   }
   if (preset.framework === "nestjs") {
-    deps["@stratum-hq/nestjs"] = "^0.2.0";
+    deps["@stratum-hq/nestjs"] = STRATUM_RANGES["@stratum-hq/nestjs"];
   }
 }
 
@@ -159,10 +172,16 @@ function getScripts(preset: StackPreset): Record<string, string> {
   if (preset.framework === "nextjs") {
     return { dev: "next dev", build: "next build", start: "next start" };
   }
-  if (preset.framework === "nestjs") {
-    return { dev: "node --watch src/main.ts", build: "tsc", start: "node dist/main.js" };
-  }
-  return { dev: "node --watch src/index.js", build: "tsc", start: "node dist/index.js" };
+  const entry = preset.framework === "nestjs" ? "main" : "index";
+  // When tsc compiles from the project root, src/ is emitted to dist/src/.
+  const emittedDir = rootSources(preset).length > 0 ? "dist/src" : "dist";
+  // Node 20 cannot run a .ts file. NestJS compiles with tsc, which keeps the
+  // decorator metadata its injection needs; the other frameworks run through tsx.
+  const dev =
+    preset.framework === "nestjs"
+      ? `tsc-watch --onSuccess "node --env-file=.env ${emittedDir}/${entry}.js"`
+      : `tsx watch --env-file=.env src/${entry}.ts`;
+  return { dev, build: "tsc", start: `node ${emittedDir}/${entry}.js` };
 }
 
 function sortKeys(obj: Record<string, string>): Record<string, string> {

package/src/generators/readme.ts

@@ -1,7 +1,6 @@
 import type { StackPreset } from "../matrix.js";
 
 export function generatePresetReadme(projectName: string, preset: StackPreset): string {
-  const devCmd = getDevCommand(preset);
   const dbStartCmd = getDbStartInfo(preset);
   const dbSetupNote = getDbSetupNote(preset);
 
@@ -37,7 +36,7 @@ ${dbSetupNote}
 ### 4. Run the app
 
 \`\`\`bash
-${devCmd}
+npm run dev
 \`\`\`
 
 ## Multi-tenancy
@@ -50,13 +49,6 @@ See the [Stratum docs](https://github.com/stratum-hq/Stratum) for full reference
 `;
 }
 
-function getDevCommand(preset: StackPreset): string {
-  if (preset.framework === "nextjs") return "npm run dev";
-  if (preset.framework === "nestjs") return "node --env-file=.env src/main.ts";
-  if (preset.framework === "none") return "node --env-file=.env src/index.ts";
-  return "node --env-file=.env src/index.ts";
-}
-
 function getDbStartInfo(preset: StackPreset): string {
   switch (preset.database) {
     case "postgres":
@@ -95,7 +87,7 @@ function getStrategyDescription(strategy: string): string {
   switch (strategy) {
     case "rls":
       return `- **Row-Level Security** -- PostgreSQL RLS policies filter rows by tenant automatically
-- Each query sets \`app.current_tenant\` and RLS enforces isolation
+- Each query sets \`app.current_tenant_id\` and RLS enforces isolation
 - All tenants share one database and schema`;
     case "schema":
       return `- **Schema-per-tenant** -- each tenant gets a dedicated PostgreSQL schema

package/src/generators/tsconfig.ts

@@ -0,0 +1,48 @@
+import type { Framework, StackPreset } from "../matrix.js";
+
+/**
+ * Return the source files that a preset writes at the project root and that code in `src/` imports.
+ *
+ * @param preset - The stack preset of the generated project.
+ */
+export function rootSources(preset: StackPreset): string[] {
+  // The knex CLI reads knexfile.ts from the project root, and src/stratum-knex.ts imports it.
+  return preset.orm === "knex" ? ["knexfile.ts"] : [];
+}
+
+/**
+ * Return the tsconfig.json content for a generated project.
+ *
+ * @param framework - The framework of the project. It adds the compiler options that the framework needs.
+ * @param extraSources - Source files at the project root that code in `src/` imports.
+ *   When there are any, tsc compiles from the project root, so the output of `src/` goes to `dist/src/`.
+ */
+export function generateTsconfig(framework: Framework, extraSources: string[] = []): string {
+  // tsc rejects an imported file outside rootDir with TS6059.
+  const rootDir = extraSources.length > 0 ? "." : "src";
+  return JSON.stringify(
+    {
+      compilerOptions: {
+        target: "ESNext",
+        module: "NodeNext",
+        moduleResolution: "NodeNext",
+        strict: true,
+        outDir: "dist",
+        rootDir,
+        declaration: true,
+        skipLibCheck: true,
+        esModuleInterop: true,
+        ...(framework === "nestjs"
+          ? { experimentalDecorators: true, emitDecoratorMetadata: true }
+          : {}),
+        ...(framework === "nextjs"
+          ? { jsx: "preserve", plugins: [{ name: "next" }] }
+          : {}),
+      },
+      include: ["src", ...extraSources],
+      exclude: ["node_modules", "dist"],
+    },
+    null,
+    2,
+  );
+}

package/src/index.ts

@@ -1,13 +1,12 @@
-#!/usr/bin/env node
-
 import * as fs from "fs";
 import * as path from "path";
 import crypto from "node:crypto";
 import { execSync } from "child_process";
-import { fileURLToPath } from "url";
 import { parsePresetString, isValidPreset } from "./matrix.js";
 import { createPresetProject } from "./preset-project.js";
+import { STRATUM_RANGES } from "./stratum-versions.js";
 import { postgresAppRole, postgresAppRoleSql, POSTGRES_APP_PASSWORD } from "./generators/init-sql.js";
+import { generateTsconfig } from "./generators/tsconfig.js";
 
 // ─── Types ────────────────────────────────────────────────────────────────────
 
@@ -127,7 +126,7 @@ function generatePackageJson(projectName: string, template: Template): string {
   };
 
   const deps = {
-    "@stratum-hq/lib": "^0.2.0",
+    "@stratum-hq/lib": STRATUM_RANGES["@stratum-hq/lib"],
     pg: "^8.11.0",
     ...frameworkDeps[template],
   };
@@ -141,11 +140,13 @@ function generatePackageJson(projectName: string, template: Template): string {
       scripts:
         template === "nextjs"
           ? { dev: "next dev", build: "next build", start: "next start" }
-          : { dev: "node --watch src/index.js", build: "tsc", start: "node dist/index.js" },
+          : // Node 20 cannot run a .ts file, so dev runs the source through tsx.
+            { dev: "tsx watch --env-file=.env src/index.ts", build: "tsc", start: "node dist/index.js" },
       dependencies: deps,
       devDependencies: {
         typescript: "^5.3.0",
         "@types/node": "^20.11.0",
+        ...(template === "nextjs" ? {} : { tsx: "^4.7.0", "@types/pg": "^8.11.0" }),
       },
       engines: {
         node: ">=20.0.0",
@@ -337,9 +338,6 @@ export const config = {
 }
 
 function generateReadme(projectName: string, template: Template): string {
-  const devCmd =
-    template === "nextjs" ? "npm run dev" : "node --env-file=.env src/index.ts";
-
   return `# ${projectName}
 
 A multi-tenant application built with [Stratum](https://github.com/stratum-hq/Stratum).
@@ -368,7 +366,7 @@ npm install
 ### 4. Run the app
 
 \`\`\`bash
-${devCmd}
+npm run dev
 \`\`\`
 
 ## Project structure
@@ -379,7 +377,7 @@ ${projectName}/
 ├── docker-compose.yml
 ├── init.sql          # DB extensions (uuid-ossp, ltree)
 ├── .env.example
-└── package.json
+${template === "nextjs" ? "" : "├── tsconfig.json\n"}└── package.json
 \`\`\`
 
 ## Multi-tenancy
@@ -422,8 +420,10 @@ export function createProject(
   // Server starter file
   if (template === "express") {
     writeFile(path.join(targetDir, "src", "index.ts"), generateExpressServer(projectName));
+    writeFile(path.join(targetDir, "tsconfig.json"), generateTsconfig(template));
   } else if (template === "fastify") {
     writeFile(path.join(targetDir, "src", "index.ts"), generateFastifyServer(projectName));
+    writeFile(path.join(targetDir, "tsconfig.json"), generateTsconfig(template));
   } else if (template === "nextjs") {
     writeFile(path.join(targetDir, "src", "app", "page.tsx"), generateNextjsPage(projectName));
     writeFile(path.join(targetDir, "middleware.ts"), generateNextjsMiddleware());
@@ -520,25 +520,6 @@ export function main(argv: string[]): void {
   if (skipInstall) {
     console.log("  npm install");
   }
-  if (preset) {
-    const parsed = parsePresetString(preset)!;
-    if (parsed.framework === "nextjs") {
-      console.log("  npm run dev");
-    } else if (parsed.framework === "nestjs") {
-      console.log("  node --env-file=.env src/main.ts");
-    } else {
-      console.log("  node --env-file=.env src/index.ts");
-    }
-  } else if (template === "nextjs") {
-    console.log("  npm run dev");
-  } else {
-    console.log("  node --env-file=.env src/index.ts");
-  }
+  console.log("  npm run dev");
   console.log("");
 }
-
-// Run when executed directly (not when imported by tests)
-const __filename = fileURLToPath(import.meta.url);
-if (process.argv[1] === __filename) {
-  main(process.argv.slice(2));
-}

package/src/preset-project.ts

@@ -9,6 +9,7 @@ import { generateDbSetup } from "./generators/db-setup.js";
 import { generateMiddleware } from "./generators/middleware.js";
 import { generatePresetPackageJson } from "./generators/package-json.js";
 import { generatePresetReadme } from "./generators/readme.js";
+import { generateTsconfig, rootSources } from "./generators/tsconfig.js";
 
 function writeFile(filePath: string, content: string): void {
   const dir = path.dirname(filePath);
@@ -114,31 +115,7 @@ export function createPresetProject(
   // tsconfig.json
   writeFile(
     path.join(targetDir, "tsconfig.json"),
-    JSON.stringify(
-      {
-        compilerOptions: {
-          target: "ESNext",
-          module: "NodeNext",
-          moduleResolution: "NodeNext",
-          strict: true,
-          outDir: "dist",
-          rootDir: "src",
-          declaration: true,
-          skipLibCheck: true,
-          esModuleInterop: true,
-          ...(preset.framework === "nestjs"
-            ? { experimentalDecorators: true, emitDecoratorMetadata: true }
-            : {}),
-          ...(preset.framework === "nextjs"
-            ? { jsx: "preserve", plugins: [{ name: "next" }] }
-            : {}),
-        },
-        include: ["src"],
-        exclude: ["node_modules", "dist"],
-      },
-      null,
-      2,
-    ),
+    generateTsconfig(preset.framework, rootSources(preset)),
   );
 
   // npm install

package/src/stratum-versions.ts

@@ -0,0 +1,20 @@
+// esbuild inlines these files when it bundles the CLI, so the published package carries
+// the versions of the workspace it was built from. The ranges are fixed at create's build
+// time. When a pinned package gets a major bump, or a minor bump while at 0.x, release
+// create again, or new projects keep the old range.
+import hono from "../../hono/package.json" with { type: "json" };
+import dbAdapters from "../../db-adapters/package.json" with { type: "json" };
+import lib from "../../lib/package.json" with { type: "json" };
+import mongodb from "../../mongodb/package.json" with { type: "json" };
+import mysql from "../../mysql/package.json" with { type: "json" };
+import nestjs from "../../nestjs/package.json" with { type: "json" };
+
+/** Caret ranges on the current workspace versions of the packages a generated project uses. */
+export const STRATUM_RANGES = {
+  "@stratum-hq/db-adapters": `^${dbAdapters.version}`,
+  "@stratum-hq/hono": `^${hono.version}`,
+  "@stratum-hq/lib": `^${lib.version}`,
+  "@stratum-hq/mongodb": `^${mongodb.version}`,
+  "@stratum-hq/mysql": `^${mysql.version}`,
+  "@stratum-hq/nestjs": `^${nestjs.version}`,
+} as const;

package/turbo.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "https://turbo.build/schema.json",
+  "extends": ["//"],
+  "tasks": {
+    "build": {
+      "inputs": ["$TURBO_DEFAULT$", "$TURBO_ROOT$/packages/*/package.json"]
+    },
+    "typecheck": {
+      "inputs": ["$TURBO_DEFAULT$", "$TURBO_ROOT$/packages/*/package.json"]
+    },
+    "test": {
+      "inputs": [
+        "$TURBO_DEFAULT$",
+        "$TURBO_ROOT$/packages/*/package.json",
+        "$TURBO_ROOT$/packages/{core,db-adapters,mysql,mongodb}/src/**"
+      ]
+    }
+  }
+}