@podosoft/podokit 0.2.0 → 0.4.0

package/dist/templates/todo/package.json

@@ -2,12 +2,20 @@
   "name": "{{projectName}}",
   "version": "0.0.0",
   "private": true,
-  "engines": { "node": ">=20" },
-  "workspaces": ["apps/*"],
+  "engines": {
+    "node": ">=20"
+  },
+  "workspaces": [
+    "apps/*",
+    "tests"
+  ],
   "scripts": {
     "dev": "npm run dev --workspaces --if-present",
     "build": "npm run build --workspaces --if-present",
     "lint": "npm run lint --workspaces --if-present",
-    "test": "npm run test --workspaces --if-present"
+    "test": "npm run test --workspaces --if-present",
+    "test:e2e": "npm run test:e2e -w tests",
+    "test:e2e:ui": "npm run test:e2e:ui -w tests",
+    "test:e2e:api": "npm run test:e2e:api -w tests"
   }
 }

package/dist/templates/todo/tests/README.md

@@ -0,0 +1,15 @@
+# tests
+
+End-to-end tests for this app, run with [`@playwright/test`](https://playwright.dev):
+
+```bash
+npm run test:e2e         # all specs (api + ui)
+npm run test:e2e:api     # backend endpoints (request-only)
+npm run test:e2e:ui      # pages (chromium)
+npm run test:e2e:report  # open the HTML report
+```
+
+The suite runs against a live stack (web on `E2E_BASE_URL`, default
+`http://localhost:5173`, proxying `/api/*` to the API). Start PostgreSQL, run the
+auth migration, and start the API + web first. Files ending in `*.api.spec.ts` run
+in the request-only `api` project; `*.ui.spec.ts` run in the chromium `ui` project.

package/dist/templates/todo/tests/api/health.api.spec.ts

@@ -0,0 +1,14 @@
+import { expect, test } from "@playwright/test";
+
+// Health endpoints are public and present in every generated app.
+test("GET /health is public and ok @smoke", async ({ request }) => {
+  const res = await request.get("/api/health");
+  expect(res.ok()).toBeTruthy();
+  expect((await res.json()).status).toBe("ok");
+});
+
+test("GET /health/ready reports the database", async ({ request }) => {
+  const res = await request.get("/api/health/ready");
+  expect(res.status()).toBe(200);
+  expect((await res.json()).status).toBe("ready");
+});

package/dist/templates/todo/tests/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "{{projectName}}-tests",
+  "version": "0.0.0",
+  "private": true,
+  "scripts": {
+    "test:e2e": "playwright test",
+    "test:e2e:ui": "playwright test --project=ui",
+    "test:e2e:api": "playwright test --project=api",
+    "test:e2e:report": "playwright show-report"
+  },
+  "devDependencies": {
+    "@playwright/test": "^1.61.1"
+  }
+}

package/dist/templates/todo/tests/playwright.config.ts

@@ -0,0 +1,25 @@
+import { defineConfig, devices } from "@playwright/test";
+
+// The suite runs against a live stack: web on E2E_BASE_URL (proxying /api/* to
+// the API). Start it first (see docs/testing.md) — locally via the dev harness,
+// in CI via scripts/e2e-ci.mjs. Two projects: `api` (request-only, backend e2e)
+// and `ui` (chromium, pages). Files are routed by suffix (*.api/*.ui.spec.ts).
+const baseURL = process.env.E2E_BASE_URL ?? "http://localhost:5173";
+
+export default defineConfig({
+  testDir: ".",
+  fullyParallel: true,
+  forbidOnly: !!process.env.CI,
+  retries: process.env.CI ? 2 : 0,
+  workers: process.env.CI ? 1 : undefined,
+  reporter: [["list"], ["html", { open: "never" }]],
+  use: {
+    baseURL,
+    trace: "on-first-retry",
+    screenshot: "only-on-failure",
+  },
+  projects: [
+    { name: "api", testMatch: /.*\.api\.spec\.ts/ },
+    { name: "ui", testMatch: /.*\.ui\.spec\.ts/, use: { ...devices["Desktop Chrome"] } },
+  ],
+});

package/dist/templates/todo/tests/ui/smoke.ui.spec.ts

@@ -0,0 +1,8 @@
+import { expect, test } from "@playwright/test";
+
+// Module-agnostic: the app responds at "/" (a page or a redirect to it).
+test("app is reachable @smoke", async ({ page }) => {
+  const res = await page.goto("/");
+  expect(res?.status()).toBeLessThan(400);
+  await expect(page.locator("body")).toBeVisible();
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@podosoft/podokit",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "An opinionated but extensible starter toolkit and CLI for full-stack TypeScript apps with NestJS, SvelteKit, TailwindCSS, shadcn-svelte, Docker, and k3s.",
   "license": "Apache-2.0",
   "repository": {
@@ -36,6 +36,6 @@
     "test": "vitest run"
   },
   "dependencies": {
-    "@podosoft/podokit-template-engine": "^0.2.0"
+    "@podosoft/podokit-template-engine": "^0.3.0"
   }
 }

package/dist/templates/fullstack-nest-svelte/apps/api/test/health.e2e-spec.ts

@@ -1,23 +0,0 @@
-import { Test } from "@nestjs/testing";
-import type { INestApplication } from "@nestjs/common";
-import request from "supertest";
-import { HealthModule } from "../src/health/health.module";
-
-describe("Health (e2e)", () => {
-  let app: INestApplication;
-
-  beforeAll(async () => {
-    const moduleRef = await Test.createTestingModule({ imports: [HealthModule] }).compile();
-    app = moduleRef.createNestApplication();
-    await app.init();
-  });
-
-  afterAll(async () => {
-    await app.close();
-  });
-
-  it("GET /health returns ok", async () => {
-    const res = await request(app.getHttpServer()).get("/health").expect(200);
-    expect(res.body.status).toBe("ok");
-  });
-});

package/dist/templates/fullstack-nest-svelte/apps/web/src/routes/api/health/+server.ts

@@ -1,12 +0,0 @@
-import type { RequestHandler } from "@sveltejs/kit";
-import { backendBaseUrl, backendProxyHeaders } from "$lib/server/backend-proxy";
-
-export const GET: RequestHandler = async ({ request }) => {
-  const upstream = await fetch(`${backendBaseUrl()}/health`, {
-    headers: backendProxyHeaders(request),
-  });
-  return new Response(await upstream.text(), {
-    status: upstream.status,
-    headers: { "content-type": "application/json" },
-  });
-};

package/dist/templates/modules/auth-jwt/files/apps/api/src/auth/auth.controller.ts

@@ -1,31 +0,0 @@
-import { Body, Controller, Get, HttpCode, Post, Req, UseGuards } from "@nestjs/common";
-import { ApiBearerAuth, ApiTags } from "@nestjs/swagger";
-import type { Request } from "express";
-import { AuthService } from "./auth.service";
-import { RegisterDto } from "./dto/register.dto";
-import { LoginDto } from "./dto/login.dto";
-import { JwtAuthGuard } from "./jwt-auth.guard";
-
-@ApiTags("auth")
-@Controller("auth")
-export class AuthController {
-  constructor(private readonly auth: AuthService) {}
-
-  @Post("register")
-  register(@Body() dto: RegisterDto) {
-    return this.auth.register(dto);
-  }
-
-  @Post("login")
-  @HttpCode(200)
-  login(@Body() dto: LoginDto) {
-    return this.auth.login(dto);
-  }
-
-  @UseGuards(JwtAuthGuard)
-  @ApiBearerAuth()
-  @Get("me")
-  me(@Req() req: Request): unknown {
-    return req.user;
-  }
-}

package/dist/templates/modules/auth-jwt/files/apps/api/src/auth/auth.module.ts

@@ -1,22 +0,0 @@
-import { Module } from "@nestjs/common";
-import { JwtModule } from "@nestjs/jwt";
-import { PassportModule } from "@nestjs/passport";
-import { TypeOrmModule } from "@nestjs/typeorm";
-import { AuthController } from "./auth.controller";
-import { AuthService } from "./auth.service";
-import { JwtStrategy } from "./jwt.strategy";
-import { User } from "./user.entity";
-
-@Module({
-  imports: [
-    TypeOrmModule.forFeature([User]),
-    PassportModule,
-    JwtModule.register({
-      secret: process.env.JWT_SECRET ?? "change-me-in-production",
-      signOptions: { expiresIn: process.env.JWT_EXPIRES_IN ?? "3600s" },
-    }),
-  ],
-  controllers: [AuthController],
-  providers: [AuthService, JwtStrategy],
-})
-export class AuthModule {}

package/dist/templates/modules/auth-jwt/files/apps/api/src/auth/auth.service.ts

@@ -1,44 +0,0 @@
-import { ConflictException, Injectable, UnauthorizedException } from "@nestjs/common";
-import { JwtService } from "@nestjs/jwt";
-import { InjectRepository } from "@nestjs/typeorm";
-import { Repository } from "typeorm";
-import * as bcrypt from "bcryptjs";
-import { User } from "./user.entity";
-import { RegisterDto } from "./dto/register.dto";
-import { LoginDto } from "./dto/login.dto";
-
-export interface AuthResult {
-  accessToken: string;
-  user: { id: string; email: string };
-}
-
-@Injectable()
-export class AuthService {
-  constructor(
-    @InjectRepository(User) private readonly users: Repository<User>,
-    private readonly jwt: JwtService,
-  ) {}
-
-  async register(dto: RegisterDto): Promise<AuthResult> {
-    const existing = await this.users.findOne({ where: { email: dto.email } });
-    if (existing) {
-      throw new ConflictException("Email already registered");
-    }
-    const passwordHash = await bcrypt.hash(dto.password, 10);
-    const user = await this.users.save(this.users.create({ email: dto.email, passwordHash }));
-    return this.sign(user);
-  }
-
-  async login(dto: LoginDto): Promise<AuthResult> {
-    const user = await this.users.findOne({ where: { email: dto.email } });
-    if (!user || !(await bcrypt.compare(dto.password, user.passwordHash))) {
-      throw new UnauthorizedException("Invalid credentials");
-    }
-    return this.sign(user);
-  }
-
-  private sign(user: User): AuthResult {
-    const accessToken = this.jwt.sign({ sub: user.id, email: user.email });
-    return { accessToken, user: { id: user.id, email: user.email } };
-  }
-}

package/dist/templates/modules/auth-jwt/files/apps/api/src/auth/dto/login.dto.ts

@@ -1,12 +0,0 @@
-import { ApiProperty } from "@nestjs/swagger";
-import { IsEmail, IsString } from "class-validator";
-
-export class LoginDto {
-  @ApiProperty({ example: "user@example.com" })
-  @IsEmail()
-  email!: string;
-
-  @ApiProperty({ example: "password123" })
-  @IsString()
-  password!: string;
-}

package/dist/templates/modules/auth-jwt/files/apps/api/src/auth/dto/register.dto.ts

@@ -1,13 +0,0 @@
-import { ApiProperty } from "@nestjs/swagger";
-import { IsEmail, IsString, MinLength } from "class-validator";
-
-export class RegisterDto {
-  @ApiProperty({ example: "user@example.com" })
-  @IsEmail()
-  email!: string;
-
-  @ApiProperty({ example: "password123", minLength: 8 })
-  @IsString()
-  @MinLength(8)
-  password!: string;
-}

package/dist/templates/modules/auth-jwt/files/apps/api/src/auth/jwt-auth.guard.ts

@@ -1,5 +0,0 @@
-import { Injectable } from "@nestjs/common";
-import { AuthGuard } from "@nestjs/passport";
-
-@Injectable()
-export class JwtAuthGuard extends AuthGuard("jwt") {}

package/dist/templates/modules/auth-jwt/files/apps/api/src/auth/jwt.strategy.ts

@@ -1,23 +0,0 @@
-import { Injectable } from "@nestjs/common";
-import { PassportStrategy } from "@nestjs/passport";
-import { ExtractJwt, Strategy } from "passport-jwt";
-
-export interface JwtPayload {
-  sub: string;
-  email: string;
-}
-
-@Injectable()
-export class JwtStrategy extends PassportStrategy(Strategy) {
-  constructor() {
-    super({
-      jwtFromRequest: ExtractJwt.fromAuthHeaderAsBearerToken(),
-      ignoreExpiration: false,
-      secretOrKey: process.env.JWT_SECRET ?? "change-me-in-production",
-    });
-  }
-
-  validate(payload: JwtPayload): { userId: string; email: string } {
-    return { userId: payload.sub, email: payload.email };
-  }
-}

package/dist/templates/modules/auth-jwt/files/apps/api/src/auth/user.entity.ts

@@ -1,16 +0,0 @@
-import { Column, CreateDateColumn, Entity, PrimaryGeneratedColumn } from "typeorm";
-
-@Entity("users")
-export class User {
-  @PrimaryGeneratedColumn("uuid")
-  id!: string;
-
-  @Column({ type: "varchar", length: 320, unique: true })
-  email!: string;
-
-  @Column({ type: "varchar" })
-  passwordHash!: string;
-
-  @CreateDateColumn({ type: "timestamptz" })
-  createdAt!: Date;
-}

package/dist/templates/modules/auth-jwt/files/apps/api/src/migrations/1720200000000-InitUsers.ts

@@ -1,23 +0,0 @@
-import type { MigrationInterface, QueryRunner } from "typeorm";
-
-export class InitUsers1720200000000 implements MigrationInterface {
-  name = "InitUsers1720200000000";
-
-  async up(queryRunner: QueryRunner): Promise<void> {
-    await queryRunner.query(`CREATE EXTENSION IF NOT EXISTS "pgcrypto"`);
-    await queryRunner.query(`
-      CREATE TABLE "users" (
-        "id" uuid NOT NULL DEFAULT gen_random_uuid(),
-        "email" character varying(320) NOT NULL,
-        "passwordHash" character varying NOT NULL,
-        "createdAt" TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT now(),
-        CONSTRAINT "PK_users_id" PRIMARY KEY ("id"),
-        CONSTRAINT "UQ_users_email" UNIQUE ("email")
-      )
-    `);
-  }
-
-  async down(queryRunner: QueryRunner): Promise<void> {
-    await queryRunner.query(`DROP TABLE "users"`);
-  }
-}

package/dist/templates/modules/auth-jwt/module.manifest.json

@@ -1,31 +0,0 @@
-{
-  "name": "auth-jwt",
-  "description": "JWT auth: register, login, a JWT guard, and a protected /auth/me route (TypeORM users).",
-  "requires": [],
-  "targetApp": "api",
-  "dependencies": {
-    "@nestjs/jwt": "^10.2.0",
-    "@nestjs/passport": "^10.0.3",
-    "bcryptjs": "^2.4.3",
-    "passport": "^0.7.0",
-    "passport-jwt": "^4.0.1"
-  },
-  "devDependencies": {
-    "@types/bcryptjs": "^2.4.6",
-    "@types/passport-jwt": "^4.0.1"
-  },
-  "env": [
-    "# auth-jwt",
-    "JWT_SECRET=change-me-in-production",
-    "JWT_EXPIRES_IN=3600s"
-  ],
-  "inject": [
-    { "file": "apps/api/src/app.module.ts", "marker": "// podokit:imports", "text": "import { AuthModule } from \"./auth/auth.module\";" },
-    { "file": "apps/api/src/app.module.ts", "marker": "// podokit:module-imports", "text": "AuthModule," }
-  ],
-  "instructions": [
-    "Run the users migration:  npm run migration:run -w <app>-api",
-    "Register:  curl -XPOST localhost:3000/auth/register -H 'content-type: application/json' -d '{\"email\":\"a@example.com\",\"password\":\"password123\"}'",
-    "Call the protected route with the returned token:  curl localhost:3000/auth/me -H 'authorization: Bearer <token>'"
-  ]
-}

package/dist/templates/todo/apps/api/test/health.e2e-spec.ts

@@ -1,23 +0,0 @@
-import { Test } from "@nestjs/testing";
-import type { INestApplication } from "@nestjs/common";
-import request from "supertest";
-import { HealthModule } from "../src/health/health.module";
-
-describe("Health (e2e)", () => {
-  let app: INestApplication;
-
-  beforeAll(async () => {
-    const moduleRef = await Test.createTestingModule({ imports: [HealthModule] }).compile();
-    app = moduleRef.createNestApplication();
-    await app.init();
-  });
-
-  afterAll(async () => {
-    await app.close();
-  });
-
-  it("GET /health returns ok", async () => {
-    const res = await request(app.getHttpServer()).get("/health").expect(200);
-    expect(res.body.status).toBe("ok");
-  });
-});

package/dist/templates/todo/apps/web/src/routes/api/health/+server.ts

@@ -1,12 +0,0 @@
-import type { RequestHandler } from "@sveltejs/kit";
-import { backendBaseUrl, backendProxyHeaders } from "$lib/server/backend-proxy";
-
-export const GET: RequestHandler = async ({ request }) => {
-  const upstream = await fetch(`${backendBaseUrl()}/health`, {
-    headers: backendProxyHeaders(request),
-  });
-  return new Response(await upstream.text(), {
-    status: upstream.status,
-    headers: { "content-type": "application/json" },
-  });
-};

package/dist/templates/todo/apps/web/src/routes/api/todos/+server.ts

@@ -1,24 +0,0 @@
-import type { RequestHandler } from "@sveltejs/kit";
-import { backendBaseUrl, backendProxyHeaders } from "$lib/server/backend-proxy";
-
-export const GET: RequestHandler = async ({ request }) => {
-  const upstream = await fetch(`${backendBaseUrl()}/todos`, { headers: backendProxyHeaders(request) });
-  return new Response(await upstream.text(), {
-    status: upstream.status,
-    headers: { "content-type": "application/json" },
-  });
-};
-
-export const POST: RequestHandler = async ({ request }) => {
-  const headers = backendProxyHeaders(request);
-  headers.set("content-type", "application/json");
-  const upstream = await fetch(`${backendBaseUrl()}/todos`, {
-    method: "POST",
-    headers,
-    body: await request.text(),
-  });
-  return new Response(await upstream.text(), {
-    status: upstream.status,
-    headers: { "content-type": "application/json" },
-  });
-};

package/dist/templates/todo/apps/web/src/routes/api/todos/[id]/+server.ts

@@ -1,24 +0,0 @@
-import type { RequestHandler } from "@sveltejs/kit";
-import { backendBaseUrl, backendProxyHeaders } from "$lib/server/backend-proxy";
-
-export const PATCH: RequestHandler = async ({ request, params }) => {
-  const headers = backendProxyHeaders(request);
-  headers.set("content-type", "application/json");
-  const upstream = await fetch(`${backendBaseUrl()}/todos/${params.id}`, {
-    method: "PATCH",
-    headers,
-    body: await request.text(),
-  });
-  return new Response(await upstream.text(), {
-    status: upstream.status,
-    headers: { "content-type": "application/json" },
-  });
-};
-
-export const DELETE: RequestHandler = async ({ request, params }) => {
-  const upstream = await fetch(`${backendBaseUrl()}/todos/${params.id}`, {
-    method: "DELETE",
-    headers: backendProxyHeaders(request),
-  });
-  return new Response(null, { status: upstream.status });
-};